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
= (char *) 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
= (char *) 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
= (char *) alloca (size
);
524 ptr
= buffer
+ offset
;
527 memcpy (ptr
, text
, len
);
531 /* Replace a dash from echo_dash with a space, otherwise
532 add a space at the end as a separator between keys. */
533 if (STRINGP (echo_string
)
534 && SCHARS (echo_string
) > 1)
536 Lisp_Object last_char
, prev_char
, idx
;
538 idx
= make_number (SCHARS (echo_string
) - 2);
539 prev_char
= Faref (echo_string
, idx
);
541 idx
= make_number (SCHARS (echo_string
) - 1);
542 last_char
= Faref (echo_string
, idx
);
544 /* We test PREV_CHAR to make sure this isn't the echoing
546 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
547 Faset (echo_string
, idx
, make_number (' '));
549 echo_string
= concat2 (echo_string
, build_string (" "));
551 else if (STRINGP (echo_string
))
552 echo_string
= concat2 (echo_string
, build_string (" "));
554 KVAR (current_kboard
, echo_string
)
555 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
561 /* Temporarily add a dash to the end of the echo string if it's not
562 empty, so that it serves as a mini-prompt for the very next character. */
567 /* Do nothing if not echoing at all. */
568 if (NILP (KVAR (current_kboard
, echo_string
)))
571 if (this_command_key_count
== 0)
574 if (!current_kboard
->immediate_echo
575 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
578 /* Do nothing if we just printed a prompt. */
579 if (current_kboard
->echo_after_prompt
580 == SCHARS (KVAR (current_kboard
, echo_string
)))
583 /* Do nothing if we have already put a dash at the end. */
584 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
586 Lisp_Object last_char
, prev_char
, idx
;
588 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
589 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
591 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
592 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
594 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
598 /* Put a dash at the end of the buffer temporarily,
599 but make it go away when the next character is added. */
600 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
605 /* Display the current echo string, and begin echoing if not already
611 if (!current_kboard
->immediate_echo
)
614 current_kboard
->immediate_echo
= 1;
616 for (i
= 0; i
< this_command_key_count
; i
++)
620 /* Set before_command_echo_length to the value that would
621 have been saved before the start of this subcommand in
622 command_loop_1, if we had already been echoing then. */
623 if (i
== this_single_command_key_start
)
624 before_command_echo_length
= echo_length ();
626 c
= AREF (this_command_keys
, i
);
627 if (! (EVENT_HAS_PARAMETERS (c
)
628 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
632 /* Set before_command_echo_length to the value that would
633 have been saved before the start of this subcommand in
634 command_loop_1, if we had already been echoing then. */
635 if (this_command_key_count
== this_single_command_key_start
)
636 before_command_echo_length
= echo_length ();
638 /* Put a dash at the end to invite the user to type more. */
643 message3_nolog (KVAR (current_kboard
, echo_string
),
644 SBYTES (KVAR (current_kboard
, echo_string
)),
645 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
648 /* Record in what buffer we echoed, and from which kboard. */
649 echo_message_buffer
= echo_area_buffer
[0];
650 echo_kboard
= current_kboard
;
652 if (waiting_for_input
&& !NILP (Vquit_flag
))
653 quit_throw_to_read_char (0);
656 /* Turn off echoing, for the start of a new command. */
659 cancel_echoing (void)
661 current_kboard
->immediate_echo
= 0;
662 current_kboard
->echo_after_prompt
= -1;
663 KVAR (current_kboard
, echo_string
) = Qnil
;
664 ok_to_echo_at_next_pause
= NULL
;
666 echo_message_buffer
= Qnil
;
669 /* Return the length of the current echo string. */
674 return (STRINGP (KVAR (current_kboard
, echo_string
))
675 ? SCHARS (KVAR (current_kboard
, echo_string
))
679 /* Truncate the current echo message to its first LEN chars.
680 This and echo_char get used by read_key_sequence when the user
681 switches frames while entering a key sequence. */
684 echo_truncate (ptrdiff_t nchars
)
686 if (STRINGP (KVAR (current_kboard
, echo_string
)))
687 KVAR (current_kboard
, echo_string
)
688 = Fsubstring (KVAR (current_kboard
, echo_string
),
689 make_number (0), make_number (nchars
));
690 truncate_echo_area (nchars
);
694 /* Functions for manipulating this_command_keys. */
696 add_command_key (Lisp_Object key
)
698 #if 0 /* Not needed after we made Freset_this_command_lengths
699 do the job immediately. */
700 /* If reset-this-command-length was called recently, obey it now.
701 See the doc string of that function for an explanation of why. */
702 if (before_command_restore_flag
)
704 this_command_key_count
= before_command_key_count_1
;
705 if (this_command_key_count
< this_single_command_key_start
)
706 this_single_command_key_start
= this_command_key_count
;
707 echo_truncate (before_command_echo_length_1
);
708 before_command_restore_flag
= 0;
712 if (this_command_key_count
>= ASIZE (this_command_keys
))
713 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
715 ASET (this_command_keys
, this_command_key_count
, key
);
716 ++this_command_key_count
;
721 recursive_edit_1 (void)
723 ptrdiff_t count
= SPECPDL_INDEX ();
726 if (command_loop_level
> 0)
728 specbind (Qstandard_output
, Qt
);
729 specbind (Qstandard_input
, Qt
);
732 #ifdef HAVE_WINDOW_SYSTEM
733 /* The command loop has started an hourglass timer, so we have to
734 cancel it here, otherwise it will fire because the recursive edit
735 can take some time. Do not check for display_hourglass_p here,
736 because it could already be nil. */
740 /* This function may have been called from a debugger called from
741 within redisplay, for instance by Edebugging a function called
742 from fontification-functions. We want to allow redisplay in
743 the debugging session.
745 The recursive edit is left with a `(throw exit ...)'. The `exit'
746 tag is not caught anywhere in redisplay, i.e. when we leave the
747 recursive edit, the original redisplay leading to the recursive
748 edit will be unwound. The outcome should therefore be safe. */
749 specbind (Qinhibit_redisplay
, Qnil
);
752 val
= command_loop ();
754 Fsignal (Qquit
, Qnil
);
755 /* Handle throw from read_minibuf when using minibuffer
756 while it's active but we're in another window. */
758 xsignal1 (Qerror
, val
);
760 return unbind_to (count
, Qnil
);
763 /* When an auto-save happens, record the "time", and don't do again soon. */
766 record_auto_save (void)
768 last_auto_save
= num_nonmacro_input_events
;
771 /* Make an auto save happen as soon as possible at command level. */
775 force_auto_save_soon (void)
777 last_auto_save
= - auto_save_interval
- 1;
779 record_asynch_buffer_change ();
783 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
784 doc
: /* Invoke the editor command loop recursively.
785 To get out of the recursive edit, a command can do `(throw 'exit nil)';
786 that tells this function to return.
787 Alternatively, `(throw 'exit t)' makes this function signal an error.
788 This function is called by the editor initialization to begin editing. */)
791 ptrdiff_t count
= SPECPDL_INDEX ();
794 /* If we enter while input is blocked, don't lock up here.
795 This may happen through the debugger during redisplay. */
799 command_loop_level
++;
800 update_mode_lines
= 1;
802 if (command_loop_level
803 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
804 buffer
= Fcurrent_buffer ();
808 /* If we leave recursive_edit_1 below with a `throw' for instance,
809 like it is done in the splash screen display, we have to
810 make sure that we restore single_kboard as command_loop_1
811 would have done if it were left normally. */
812 if (command_loop_level
> 0)
813 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
814 record_unwind_protect (recursive_edit_unwind
, buffer
);
817 return unbind_to (count
, Qnil
);
821 recursive_edit_unwind (Lisp_Object buffer
)
823 if (BUFFERP (buffer
))
824 Fset_buffer (buffer
);
826 command_loop_level
--;
827 update_mode_lines
= 1;
832 #if 0 /* These two functions are now replaced with
833 temporarily_switch_to_single_kboard. */
837 #if 0 /* Theory: if there's anything in Vunread_command_events,
838 it will right away be read by read_key_sequence,
839 and then if we do switch KBOARDS, it will go into the side
840 queue then. So we don't need to do anything special here -- rms. */
841 if (CONSP (Vunread_command_events
))
843 current_kboard
->kbd_queue
844 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
845 current_kboard
->kbd_queue_has_data
= 1;
847 Vunread_command_events
= Qnil
;
852 /* Switch to the single-kboard state, making current_kboard
853 the only KBOARD from which further input is accepted. */
856 single_kboard_state ()
862 /* If we're in single_kboard state for kboard KBOARD,
866 not_single_kboard_state (KBOARD
*kboard
)
868 if (kboard
== current_kboard
)
872 /* Maintain a stack of kboards, so other parts of Emacs
873 can switch temporarily to the kboard of a given frame
874 and then revert to the previous status. */
879 struct kboard_stack
*next
;
882 static struct kboard_stack
*kboard_stack
;
885 push_kboard (struct kboard
*k
)
887 struct kboard_stack
*p
888 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
890 p
->next
= kboard_stack
;
891 p
->kboard
= current_kboard
;
901 struct kboard_stack
*p
= kboard_stack
;
903 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
905 if (t
->kboard
== p
->kboard
)
907 current_kboard
= p
->kboard
;
914 /* The terminal we remembered has been deleted. */
915 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
918 kboard_stack
= p
->next
;
922 /* Switch to single_kboard mode, making current_kboard the only KBOARD
923 from which further input is accepted. If F is non-nil, set its
924 KBOARD as the current keyboard.
926 This function uses record_unwind_protect to return to the previous
929 If Emacs is already in single_kboard mode, and F's keyboard is
930 locked, then this function will throw an error. */
933 temporarily_switch_to_single_kboard (struct frame
*f
)
935 int was_locked
= single_kboard
;
938 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
939 /* We can not switch keyboards while in single_kboard mode.
940 In rare cases, Lisp code may call `recursive-edit' (or
941 `read-minibuffer' or `y-or-n-p') after it switched to a
942 locked frame. For example, this is likely to happen
943 when server.el connects to a new terminal while Emacs is in
944 single_kboard mode. It is best to throw an error instead
945 of presenting the user with a frozen screen. */
946 error ("Terminal %d is locked, cannot read from it",
947 FRAME_TERMINAL (f
)->id
);
949 /* This call is unnecessary, but helps
950 `restore_kboard_configuration' discover if somebody changed
951 `current_kboard' behind our back. */
952 push_kboard (current_kboard
);
955 current_kboard
= FRAME_KBOARD (f
);
957 record_unwind_protect (restore_kboard_configuration
,
958 (was_locked
? Qt
: Qnil
));
961 #if 0 /* This function is not needed anymore. */
963 record_single_kboard_state ()
966 push_kboard (current_kboard
);
967 record_unwind_protect (restore_kboard_configuration
,
968 (single_kboard
? Qt
: Qnil
));
973 restore_kboard_configuration (Lisp_Object was_locked
)
975 if (NILP (was_locked
))
979 struct kboard
*prev
= current_kboard
;
982 /* The pop should not change the kboard. */
983 if (single_kboard
&& current_kboard
!= prev
)
990 /* Handle errors that are not handled at inner levels
991 by printing an error message and returning to the editor command loop. */
994 cmd_error (Lisp_Object data
)
996 Lisp_Object old_level
, old_length
;
997 char macroerror
[sizeof "After..kbd macro iterations: "
998 + INT_STRLEN_BOUND (EMACS_INT
)];
1000 #ifdef HAVE_WINDOW_SYSTEM
1001 if (display_hourglass_p
)
1002 cancel_hourglass ();
1005 if (!NILP (executing_kbd_macro
))
1007 if (executing_kbd_macro_iterations
== 1)
1008 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1010 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1011 executing_kbd_macro_iterations
);
1016 Vstandard_output
= Qt
;
1017 Vstandard_input
= Qt
;
1018 Vexecuting_kbd_macro
= Qnil
;
1019 executing_kbd_macro
= Qnil
;
1020 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1021 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1024 /* Avoid unquittable loop if data contains a circular list. */
1025 old_level
= Vprint_level
;
1026 old_length
= Vprint_length
;
1027 XSETFASTINT (Vprint_level
, 10);
1028 XSETFASTINT (Vprint_length
, 10);
1029 cmd_error_internal (data
, macroerror
);
1030 Vprint_level
= old_level
;
1031 Vprint_length
= old_length
;
1035 Vinhibit_quit
= Qnil
;
1036 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1037 if (command_loop_level
== 0 && minibuf_level
== 0)
1038 any_kboard_state ();
1041 return make_number (0);
1044 /* Take actions on handling an error. DATA is the data that describes
1047 CONTEXT is a C-string containing ASCII characters only which
1048 describes the context in which the error happened. If we need to
1049 generalize CONTEXT to allow multibyte characters, make it a Lisp
1053 cmd_error_internal (Lisp_Object data
, const char *context
)
1055 struct frame
*sf
= SELECTED_FRAME ();
1057 /* The immediate context is not interesting for Quits,
1058 since they are asynchronous. */
1059 if (EQ (XCAR (data
), Qquit
))
1060 Vsignaling_function
= Qnil
;
1065 /* Use user's specified output function if any. */
1066 if (!NILP (Vcommand_error_function
))
1067 call3 (Vcommand_error_function
, data
,
1068 context
? build_string (context
) : empty_unibyte_string
,
1069 Vsignaling_function
);
1070 /* If the window system or terminal frame hasn't been initialized
1071 yet, or we're not interactive, write the message to stderr and exit. */
1072 else if (!sf
->glyphs_initialized_p
1073 /* The initial frame is a special non-displaying frame. It
1074 will be current in daemon mode when there are no frames
1075 to display, and in non-daemon mode before the real frame
1076 has finished initializing. If an error is thrown in the
1077 latter case while creating the frame, then the frame
1078 will never be displayed, so the safest thing to do is
1079 write to stderr and quit. In daemon mode, there are
1080 many other potential errors that do not prevent frames
1081 from being created, so continuing as normal is better in
1083 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1086 print_error_message (data
, Qexternal_debugging_output
,
1087 context
, Vsignaling_function
);
1088 Fterpri (Qexternal_debugging_output
);
1089 Fkill_emacs (make_number (-1));
1093 clear_message (1, 0);
1095 message_log_maybe_newline ();
1098 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1101 Vsignaling_function
= Qnil
;
1104 Lisp_Object
command_loop_1 (void);
1105 static Lisp_Object
command_loop_2 (Lisp_Object
);
1106 static Lisp_Object
top_level_1 (Lisp_Object
);
1108 /* Entry to editor-command-loop.
1109 This level has the catches for exiting/returning to editor command loop.
1110 It returns nil to exit recursive edit, t to abort it. */
1115 if (command_loop_level
> 0 || minibuf_level
> 0)
1118 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1119 executing_kbd_macro
= Qnil
;
1125 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1126 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1127 /* Reset single_kboard in case top-level set it while
1128 evaluating an -f option, or we are stuck there for some
1130 any_kboard_state ();
1132 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1133 executing_kbd_macro
= Qnil
;
1135 /* End of file in -batch run causes exit here. */
1141 /* Here we catch errors in execution of commands within the
1142 editing loop, and reenter the editing loop.
1143 When there is an error, cmd_error runs and returns a non-nil
1144 value to us. A value of nil means that command_loop_1 itself
1145 returned due to end of file (or end of kbd macro). */
1148 command_loop_2 (Lisp_Object ignore
)
1150 register Lisp_Object val
;
1153 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1154 while (!NILP (val
));
1162 return Feval (Vtop_level
, Qnil
);
1166 top_level_1 (Lisp_Object ignore
)
1168 /* On entry to the outer level, run the startup file */
1169 if (!NILP (Vtop_level
))
1170 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1171 else if (!NILP (Vpurify_flag
))
1172 message ("Bare impure Emacs (standard Lisp code not loaded)");
1174 message ("Bare Emacs (standard Lisp code not loaded)");
1178 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1179 doc
: /* Exit all recursive editing levels.
1180 This also exits all active minibuffers. */)
1183 #ifdef HAVE_WINDOW_SYSTEM
1184 if (display_hourglass_p
)
1185 cancel_hourglass ();
1188 /* Unblock input if we enter with input blocked. This may happen if
1189 redisplay traps e.g. during tool-bar update with input blocked. */
1190 while (INPUT_BLOCKED_P
)
1193 Fthrow (Qtop_level
, Qnil
);
1196 static _Noreturn
void
1197 user_error (const char *msg
)
1199 xsignal1 (Quser_error
, build_string (msg
));
1203 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1204 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1207 if (command_loop_level
> 0 || minibuf_level
> 0)
1208 Fthrow (Qexit
, Qnil
);
1210 user_error ("No recursive edit is in progress");
1214 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1215 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1218 if (command_loop_level
> 0 || minibuf_level
> 0)
1221 user_error ("No recursive edit is in progress");
1224 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1226 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1227 of this function. */
1230 tracking_off (Lisp_Object old_value
)
1232 do_mouse_tracking
= old_value
;
1233 if (NILP (old_value
))
1235 /* Redisplay may have been preempted because there was input
1236 available, and it assumes it will be called again after the
1237 input has been processed. If the only input available was
1238 the sort that we have just disabled, then we need to call
1240 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1242 redisplay_preserve_echo_area (6);
1243 get_input_pending (&input_pending
,
1244 READABLE_EVENTS_DO_TIMERS_NOW
);
1250 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1251 doc
: /* Evaluate BODY with mouse movement events enabled.
1252 Within a `track-mouse' form, mouse motion generates input events that
1253 you can read with `read-event'.
1254 Normally, mouse motion is ignored.
1255 usage: (track-mouse BODY...) */)
1258 ptrdiff_t count
= SPECPDL_INDEX ();
1261 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1263 do_mouse_tracking
= Qt
;
1265 val
= Fprogn (args
);
1266 return unbind_to (count
, val
);
1269 /* If mouse has moved on some frame, return one of those frames.
1273 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1274 after resizing the tool-bar window. */
1276 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1279 int ignore_mouse_drag_p
;
1282 some_mouse_moved (void)
1284 Lisp_Object tail
, frame
;
1286 if (ignore_mouse_drag_p
)
1288 /* ignore_mouse_drag_p = 0; */
1292 FOR_EACH_FRAME (tail
, frame
)
1294 if (XFRAME (frame
)->mouse_moved
)
1295 return XFRAME (frame
);
1301 #endif /* HAVE_MOUSE || HAVE_GPM */
1303 /* This is the actual command reading loop,
1304 sans error-handling encapsulation. */
1306 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1308 void safe_run_hooks (Lisp_Object
);
1309 static void adjust_point_for_property (ptrdiff_t, int);
1311 /* Cancel hourglass from protect_unwind.
1313 #ifdef HAVE_WINDOW_SYSTEM
1315 cancel_hourglass_unwind (Lisp_Object arg
)
1317 cancel_hourglass ();
1322 /* FIXME: This is wrong rather than test window-system, we should call
1323 a new set-selection, which will then dispatch to x-set-selection, or
1324 tty-set-selection, or w32-set-selection, ... */
1327 command_loop_1 (void)
1330 Lisp_Object keybuf
[30];
1332 EMACS_INT prev_modiff
= 0;
1333 struct buffer
*prev_buffer
= NULL
;
1334 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1335 int was_locked
= single_kboard
;
1337 int already_adjusted
= 0;
1339 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1340 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1341 Vdeactivate_mark
= Qnil
;
1342 waiting_for_input
= 0;
1345 this_command_key_count
= 0;
1346 this_command_key_count_reset
= 0;
1347 this_single_command_key_start
= 0;
1349 if (NILP (Vmemory_full
))
1351 /* Make sure this hook runs after commands that get errors and
1352 throw to top level. */
1353 /* Note that the value cell will never directly contain nil
1354 if the symbol is a local variable. */
1355 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1356 safe_run_hooks (Qpost_command_hook
);
1358 /* If displaying a message, resize the echo area window to fit
1359 that message's size exactly. */
1360 if (!NILP (echo_area_buffer
[0]))
1361 resize_echo_area_exactly ();
1363 /* If there are warnings waiting, process them. */
1364 if (!NILP (Vdelayed_warnings_list
))
1365 safe_run_hooks (Qdelayed_warnings_hook
);
1367 if (!NILP (Vdeferred_action_list
))
1368 safe_run_hooks (Qdeferred_action_function
);
1371 /* Do this after running Vpost_command_hook, for consistency. */
1372 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1373 KVAR (current_kboard
, Vreal_last_command
) = Vreal_this_command
;
1374 if (!CONSP (last_command_event
))
1375 KVAR (current_kboard
, Vlast_repeatable_command
) = Vreal_this_command
;
1379 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1382 /* Make sure the current window's buffer is selected. */
1383 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1384 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1386 /* Display any malloc warning that just came out. Use while because
1387 displaying one warning can cause another. */
1389 while (pending_malloc_warning
)
1390 display_malloc_warning ();
1392 Vdeactivate_mark
= Qnil
;
1394 /* If minibuffer on and echo area in use,
1395 wait a short time and redraw minibuffer. */
1398 && !NILP (echo_area_buffer
[0])
1399 && EQ (minibuf_window
, echo_area_window
)
1400 && NUMBERP (Vminibuffer_message_timeout
))
1402 /* Bind inhibit-quit to t so that C-g gets read in
1403 rather than quitting back to the minibuffer. */
1404 ptrdiff_t count
= SPECPDL_INDEX ();
1405 specbind (Qinhibit_quit
, Qt
);
1407 sit_for (Vminibuffer_message_timeout
, 0, 2);
1409 /* Clear the echo area. */
1411 safe_run_hooks (Qecho_area_clear_hook
);
1413 unbind_to (count
, Qnil
);
1415 /* If a C-g came in before, treat it as input now. */
1416 if (!NILP (Vquit_flag
))
1419 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1424 /* Select the frame that the last event came from. Usually,
1425 switch-frame events will take care of this, but if some lisp
1426 code swallows a switch-frame event, we'll fix things up here.
1427 Is this a good idea? */
1428 if (FRAMEP (internal_last_event_frame
)
1429 && !EQ (internal_last_event_frame
, selected_frame
))
1430 Fselect_frame (internal_last_event_frame
, Qnil
);
1432 /* If it has changed current-menubar from previous value,
1433 really recompute the menubar from the value. */
1434 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1435 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1436 call0 (Qrecompute_lucid_menubar
);
1438 before_command_key_count
= this_command_key_count
;
1439 before_command_echo_length
= echo_length ();
1441 Vthis_command
= Qnil
;
1442 Vreal_this_command
= Qnil
;
1443 Vthis_original_command
= Qnil
;
1444 Vthis_command_keys_shift_translated
= Qnil
;
1446 /* Read next key sequence; i gets its length. */
1447 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1450 /* A filter may have run while we were reading the input. */
1451 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1453 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1454 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1458 /* Now we have read a key sequence of length I,
1459 or else I is 0 and we found end of file. */
1461 if (i
== 0) /* End of file -- happens only in */
1462 return Qnil
; /* a kbd macro, at the end. */
1463 /* -1 means read_key_sequence got a menu that was rejected.
1464 Just loop around and read another command. */
1468 this_command_key_count
= 0;
1469 this_command_key_count_reset
= 0;
1470 this_single_command_key_start
= 0;
1474 last_command_event
= keybuf
[i
- 1];
1476 /* If the previous command tried to force a specific window-start,
1477 forget about that, in case this command moves point far away
1478 from that position. But also throw away beg_unchanged and
1479 end_unchanged information in that case, so that redisplay will
1480 update the whole window properly. */
1481 if (XWINDOW (selected_window
)->force_start
)
1484 XWINDOW (selected_window
)->force_start
= 0;
1485 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1486 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1489 cmd
= read_key_sequence_cmd
;
1490 if (!NILP (Vexecuting_kbd_macro
))
1492 if (!NILP (Vquit_flag
))
1494 Vexecuting_kbd_macro
= Qt
;
1495 QUIT
; /* Make some noise. */
1496 /* Will return since macro now empty. */
1500 /* Do redisplay processing after this command except in special
1501 cases identified below. */
1502 prev_buffer
= current_buffer
;
1503 prev_modiff
= MODIFF
;
1504 last_point_position
= PT
;
1505 last_point_position_window
= selected_window
;
1506 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1508 /* By default, we adjust point to a boundary of a region that
1509 has such a property that should be treated intangible
1510 (e.g. composition, display). But, some commands will set
1511 this variable differently. */
1512 Vdisable_point_adjustment
= Qnil
;
1514 /* Process filters and timers may have messed with deactivate-mark.
1515 reset it before we execute the command. */
1516 Vdeactivate_mark
= Qnil
;
1518 /* Remap command through active keymaps. */
1519 Vthis_original_command
= cmd
;
1520 if (!NILP (read_key_sequence_remapped
))
1521 cmd
= read_key_sequence_remapped
;
1523 /* Execute the command. */
1525 Vthis_command
= cmd
;
1526 Vreal_this_command
= cmd
;
1527 safe_run_hooks (Qpre_command_hook
);
1529 already_adjusted
= 0;
1531 if (NILP (Vthis_command
))
1533 /* nil means key is undefined. */
1534 Lisp_Object keys
= Fvector (i
, keybuf
);
1535 keys
= Fkey_description (keys
, Qnil
);
1537 message_with_string ("%s is undefined", keys
, 0);
1538 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1539 update_mode_lines
= 1;
1540 /* If this is a down-mouse event, don't reset prefix-arg;
1541 pass it to the command run by the up event. */
1542 if (EVENT_HAS_PARAMETERS (last_command_event
))
1544 Lisp_Object breakdown
1545 = parse_modifiers (EVENT_HEAD (last_command_event
));
1546 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1547 if (!(modifiers
& down_modifier
))
1548 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1551 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1555 /* Here for a command that isn't executed directly. */
1557 #ifdef HAVE_WINDOW_SYSTEM
1558 ptrdiff_t scount
= SPECPDL_INDEX ();
1560 if (display_hourglass_p
1561 && NILP (Vexecuting_kbd_macro
))
1563 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1568 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1570 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1572 #ifdef HAVE_WINDOW_SYSTEM
1573 /* Do not check display_hourglass_p here, because
1574 Fcommand_execute could change it, but we should cancel
1575 hourglass cursor anyway.
1576 But don't cancel the hourglass within a macro
1577 just because a command in the macro finishes. */
1578 if (NILP (Vexecuting_kbd_macro
))
1579 unbind_to (scount
, Qnil
);
1582 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1584 safe_run_hooks (Qpost_command_hook
);
1586 /* If displaying a message, resize the echo area window to fit
1587 that message's size exactly. */
1588 if (!NILP (echo_area_buffer
[0]))
1589 resize_echo_area_exactly ();
1591 /* If there are warnings waiting, process them. */
1592 if (!NILP (Vdelayed_warnings_list
))
1593 safe_run_hooks (Qdelayed_warnings_hook
);
1595 safe_run_hooks (Qdeferred_action_function
);
1597 /* If there is a prefix argument,
1598 1) We don't want Vlast_command to be ``universal-argument''
1599 (that would be dumb), so don't set Vlast_command,
1600 2) we want to leave echoing on so that the prefix will be
1601 echoed as part of this key sequence, so don't call
1603 3) we want to leave this_command_key_count non-zero, so that
1604 read_char will realize that it is re-reading a character, and
1605 not echo it a second time.
1607 If the command didn't actually create a prefix arg,
1608 but is merely a frame event that is transparent to prefix args,
1609 then the above doesn't apply. */
1610 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1611 || CONSP (last_command_event
))
1613 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1614 KVAR (current_kboard
, Vreal_last_command
) = Vreal_this_command
;
1615 if (!CONSP (last_command_event
))
1616 KVAR (current_kboard
, Vlast_repeatable_command
)
1617 = Vreal_this_command
;
1619 this_command_key_count
= 0;
1620 this_command_key_count_reset
= 0;
1621 this_single_command_key_start
= 0;
1624 if (!NILP (BVAR (current_buffer
, mark_active
))
1625 && !NILP (Vrun_hooks
))
1627 /* In Emacs 22, setting transient-mark-mode to `only' was a
1628 way of turning it on for just one command. This usage is
1629 obsolete, but support it anyway. */
1630 if (EQ (Vtransient_mark_mode
, Qidentity
))
1631 Vtransient_mark_mode
= Qnil
;
1632 else if (EQ (Vtransient_mark_mode
, Qonly
))
1633 Vtransient_mark_mode
= Qidentity
;
1635 if (!NILP (Vdeactivate_mark
))
1636 /* If `select-active-regions' is non-nil, this call to
1637 `deactivate-mark' also sets the PRIMARY selection. */
1638 call0 (Qdeactivate_mark
);
1641 /* Even if not deactivating the mark, set PRIMARY if
1642 `select-active-regions' is non-nil. */
1643 if (!NILP (Fwindow_system (Qnil
))
1644 /* Even if mark_active is non-nil, the actual buffer
1645 marker may not have been set yet (Bug#7044). */
1646 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1647 && (EQ (Vselect_active_regions
, Qonly
)
1648 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1649 : (!NILP (Vselect_active_regions
)
1650 && !NILP (Vtransient_mark_mode
)))
1651 && NILP (Fmemq (Vthis_command
,
1652 Vselection_inhibit_update_commands
)))
1655 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1658 call2 (Qx_set_selection
, QPRIMARY
,
1659 make_buffer_string (beg
, end
, 0));
1661 call2 (Qx_set_selection
, QPRIMARY
,
1662 make_buffer_string (end
, beg
, 0));
1663 /* Don't set empty selections. */
1666 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1668 Lisp_Object hook
= intern ("activate-mark-hook");
1669 Frun_hooks (1, &hook
);
1673 Vsaved_region_selection
= Qnil
;
1678 if (current_buffer
== prev_buffer
1679 && last_point_position
!= PT
1680 && NILP (Vdisable_point_adjustment
)
1681 && NILP (Vglobal_disable_point_adjustment
))
1683 if (last_point_position
> BEGV
1684 && last_point_position
< ZV
1685 && (composition_adjust_point (last_point_position
,
1686 last_point_position
)
1687 != last_point_position
))
1688 /* The last point was temporarily set within a grapheme
1689 cluster to prevent automatic composition. To recover
1690 the automatic composition, we must update the
1692 windows_or_buffers_changed
++;
1693 if (!already_adjusted
)
1694 adjust_point_for_property (last_point_position
,
1695 MODIFF
!= prev_modiff
);
1698 /* Install chars successfully executed in kbd macro. */
1700 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1701 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1702 finalize_kbd_macro_chars ();
1703 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1705 any_kboard_state ();
1710 /* Adjust point to a boundary of a region that has such a property
1711 that should be treated intangible. For the moment, we check
1712 `composition', `display' and `invisible' properties.
1713 LAST_PT is the last position of point. */
1716 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1719 Lisp_Object val
, overlay
, tmp
;
1720 /* When called after buffer modification, we should temporarily
1721 suppress the point adjustment for automatic composition so that a
1722 user can keep inserting another character at point or keep
1723 deleting characters around point. */
1724 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1725 ptrdiff_t orig_pt
= PT
;
1727 /* FIXME: cycling is probably not necessary because these properties
1728 can't be usefully combined anyway. */
1729 while (check_composition
|| check_display
|| check_invisible
)
1731 /* FIXME: check `intangible'. */
1732 if (check_composition
1733 && PT
> BEGV
&& PT
< ZV
1734 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1737 check_display
= check_invisible
= 1;
1739 check_composition
= 0;
1741 && PT
> BEGV
&& PT
< ZV
1742 && !NILP (val
= get_char_property_and_overlay
1743 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1744 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1745 && (!OVERLAYP (overlay
)
1746 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1747 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1748 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1749 && (beg
< PT
/* && end > PT <- It's always the case. */
1750 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1753 SET_PT (PT
< last_pt
1754 ? (STRINGP (val
) && SCHARS (val
) == 0
1755 ? max (beg
- 1, BEGV
)
1758 check_composition
= check_invisible
= 1;
1761 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1763 int inv
, ellipsis
= 0;
1766 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1769 /* FIXME: We should stop if we find a spot between
1770 two runs of `invisible' where inserted text would
1771 be visible. This is important when we have two
1772 invisible boundaries that enclose an area: if the
1773 area is empty, we need this test in order to make
1774 it possible to place point in the middle rather
1775 than skip both boundaries. However, this code
1776 also stops anywhere in a non-sticky text-property,
1777 which breaks (e.g.) Org mode. */
1778 && (val
= get_pos_property (make_number (end
),
1780 TEXT_PROP_MEANS_INVISIBLE (val
))
1782 && !NILP (val
= get_char_property_and_overlay
1783 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1784 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1786 ellipsis
= ellipsis
|| inv
> 1
1787 || (OVERLAYP (overlay
)
1788 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1789 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1790 tmp
= Fnext_single_char_property_change
1791 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1792 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1796 && (val
= get_pos_property (make_number (beg
),
1798 TEXT_PROP_MEANS_INVISIBLE (val
))
1800 && !NILP (val
= get_char_property_and_overlay
1801 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1802 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1804 ellipsis
= ellipsis
|| inv
> 1
1805 || (OVERLAYP (overlay
)
1806 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1807 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1808 tmp
= Fprevious_single_char_property_change
1809 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1810 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1813 /* Move away from the inside area. */
1814 if (beg
< PT
&& end
> PT
)
1816 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1817 /* We haven't moved yet (so we don't need to fear
1818 infinite-looping) and we were outside the range
1819 before (so either end of the range still corresponds
1820 to a move in the right direction): pretend we moved
1821 less than we actually did, so that we still have
1822 more freedom below in choosing which end of the range
1824 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1825 /* We either have moved already or the last point
1826 was already in the range: we don't get to choose
1827 which end of the range we have to go to. */
1828 : (PT
< last_pt
? beg
: end
));
1829 check_composition
= check_display
= 1;
1831 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1832 the point to something other than its argument, due to
1833 point-motion hooks, intangibility, etc. */
1834 eassert (PT
== beg
|| PT
== end
);
1837 /* Pretend the area doesn't exist if the buffer is not
1839 if (!modified
&& !ellipsis
&& beg
< end
)
1841 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1842 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1843 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1844 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1845 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1846 /* We've already moved as far as we can. Trying to go
1847 to the other end would mean moving backwards and thus
1848 could lead to an infinite loop. */
1850 else if (val
= get_pos_property (make_number (PT
),
1852 TEXT_PROP_MEANS_INVISIBLE (val
)
1853 && (val
= get_pos_property
1854 (make_number (PT
== beg
? end
: beg
),
1856 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1857 (check_composition
= check_display
= 1,
1858 SET_PT (PT
== beg
? end
: beg
));
1861 check_invisible
= 0;
1865 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1868 safe_run_hooks_1 (void)
1870 eassert (CONSP (Vinhibit_quit
));
1871 return call0 (XCDR (Vinhibit_quit
));
1874 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1878 safe_run_hooks_error (Lisp_Object error_data
)
1881 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1882 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1883 Lisp_Object args
[4];
1884 args
[0] = build_string ("Error in %s (%s): %S");
1887 args
[3] = error_data
;
1893 Lisp_Object newval
= Qnil
;
1894 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1895 if (EQ (fun
, XCAR (val
)))
1898 newval
= Fcons (XCAR (val
), newval
);
1900 return Fset (hook
, Fnreverse (newval
));
1901 /* Not found in the local part of the hook. Let's look at the global
1904 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1905 : Fdefault_value (hook
));
1906 CONSP (val
); val
= XCDR (val
))
1907 if (EQ (fun
, XCAR (val
)))
1910 newval
= Fcons (XCAR (val
), newval
);
1912 return Fset_default (hook
, Fnreverse (newval
));
1918 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1920 eassert (nargs
== 1);
1921 if (CONSP (Vinhibit_quit
))
1922 XSETCDR (Vinhibit_quit
, args
[0]);
1924 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1926 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1930 /* If we get an error while running the hook, cause the hook variable
1931 to be nil. Also inhibit quits, so that C-g won't cause the hook
1932 to mysteriously evaporate. */
1935 safe_run_hooks (Lisp_Object hook
)
1937 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1938 to its body or to its handlers other than via globals such as
1939 dynamically-bound variables ;-) */
1940 ptrdiff_t count
= SPECPDL_INDEX ();
1941 specbind (Qinhibit_quit
, hook
);
1943 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1945 unbind_to (count
, Qnil
);
1949 /* Nonzero means polling for input is temporarily suppressed. */
1951 int poll_suppress_count
;
1953 /* Asynchronous timer for polling. */
1955 static struct atimer
*poll_timer
;
1958 #ifdef POLL_FOR_INPUT
1960 /* Poll for input, so that we catch a C-g if it comes in. This
1961 function is called from x_make_frame_visible, see comment
1965 poll_for_input_1 (void)
1967 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1968 doing anything dangerous. */
1972 if (interrupt_input_blocked
== 0
1973 && !waiting_for_input
)
1974 read_avail_input (0);
1980 /* Timer callback function for poll_timer. TIMER is equal to
1984 poll_for_input (struct atimer
*timer
)
1986 if (poll_suppress_count
== 0)
1989 interrupt_input_pending
= 1;
1990 pending_signals
= 1;
1992 poll_for_input_1 ();
1997 #endif /* POLL_FOR_INPUT */
1999 /* Begin signals to poll for input, if they are appropriate.
2000 This function is called unconditionally from various places. */
2003 start_polling (void)
2005 #ifdef POLL_FOR_INPUT
2006 /* XXX This condition was (read_socket_hook && !interrupt_input),
2007 but read_socket_hook is not global anymore. Let's pretend that
2009 if (!interrupt_input
)
2011 /* Turn alarm handling on unconditionally. It might have
2012 been turned off in process.c. */
2013 turn_on_atimers (1);
2015 /* If poll timer doesn't exist, are we need one with
2016 a different interval, start a new one. */
2017 if (poll_timer
== NULL
2018 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2020 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2021 EMACS_TIME interval
;
2024 cancel_atimer (poll_timer
);
2026 EMACS_SET_SECS_USECS (interval
, period
, 0);
2027 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2028 poll_for_input
, NULL
);
2031 /* Let the timer's callback function poll for input
2032 if this becomes zero. */
2033 --poll_suppress_count
;
2038 /* Nonzero if we are using polling to handle input asynchronously. */
2041 input_polling_used (void)
2043 #ifdef POLL_FOR_INPUT
2044 /* XXX This condition was (read_socket_hook && !interrupt_input),
2045 but read_socket_hook is not global anymore. Let's pretend that
2047 return !interrupt_input
;
2053 /* Turn off polling. */
2058 #ifdef POLL_FOR_INPUT
2059 /* XXX This condition was (read_socket_hook && !interrupt_input),
2060 but read_socket_hook is not global anymore. Let's pretend that
2062 if (!interrupt_input
)
2063 ++poll_suppress_count
;
2067 /* Set the value of poll_suppress_count to COUNT
2068 and start or stop polling accordingly. */
2071 set_poll_suppress_count (int count
)
2073 #ifdef POLL_FOR_INPUT
2074 if (count
== 0 && poll_suppress_count
!= 0)
2076 poll_suppress_count
= 1;
2079 else if (count
!= 0 && poll_suppress_count
== 0)
2083 poll_suppress_count
= count
;
2087 /* Bind polling_period to a value at least N.
2088 But don't decrease it. */
2091 bind_polling_period (int n
)
2093 #ifdef POLL_FOR_INPUT
2094 EMACS_INT
new = polling_period
;
2099 stop_other_atimers (poll_timer
);
2101 specbind (Qpolling_period
, make_number (new));
2102 /* Start a new alarm with the new period. */
2107 /* Apply the control modifier to CHARACTER. */
2110 make_ctrl_char (int c
)
2112 /* Save the upper bits here. */
2113 int upper
= c
& ~0177;
2115 if (! ASCII_BYTE_P (c
))
2116 return c
|= ctrl_modifier
;
2120 /* Everything in the columns containing the upper-case letters
2121 denotes a control character. */
2122 if (c
>= 0100 && c
< 0140)
2126 /* Set the shift modifier for a control char
2127 made from a shifted letter. But only for letters! */
2128 if (oc
>= 'A' && oc
<= 'Z')
2129 c
|= shift_modifier
;
2132 /* The lower-case letters denote control characters too. */
2133 else if (c
>= 'a' && c
<= 'z')
2136 /* Include the bits for control and shift
2137 only if the basic ASCII code can't indicate them. */
2141 /* Replace the high bits. */
2142 c
|= (upper
& ~ctrl_modifier
);
2147 /* Display the help-echo property of the character after the mouse pointer.
2148 Either show it in the echo area, or call show-help-function to display
2149 it by other means (maybe in a tooltip).
2151 If HELP is nil, that means clear the previous help echo.
2153 If HELP is a string, display that string. If HELP is a function,
2154 call it with OBJECT and POS as arguments; the function should
2155 return a help string or nil for none. For all other types of HELP,
2156 evaluate it to obtain a string.
2158 WINDOW is the window in which the help was generated, if any.
2159 It is nil if not in a window.
2161 If OBJECT is a buffer, POS is the position in the buffer where the
2162 `help-echo' text property was found.
2164 If OBJECT is an overlay, that overlay has a `help-echo' property,
2165 and POS is the position in the overlay's buffer under the mouse.
2167 If OBJECT is a string (an overlay string or a string displayed with
2168 the `display' property). POS is the position in that string under
2171 Note: this function may only be called with HELP nil or a string
2172 from X code running asynchronously. */
2175 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2178 if (!NILP (help
) && !STRINGP (help
))
2180 if (FUNCTIONP (help
))
2182 Lisp_Object args
[4];
2187 help
= safe_call (4, args
);
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
);
2702 /* If we have auto-saved and there is still no input
2703 available, garbage collect if there has been enough
2704 consing going on to make it worthwhile. */
2705 if (!detect_input_pending_run_timers (0)
2706 && consing_since_gc
> gc_cons_threshold
/ 2)
2707 Fgarbage_collect ();
2714 /* Notify the caller if an autosave hook, or a timer, sentinel or
2715 filter in the sit_for calls above have changed the current
2716 kboard. This could happen if they use the minibuffer or start a
2717 recursive edit, like the fancy splash screen in server.el's
2718 filter. If this longjmp wasn't here, read_key_sequence would
2719 interpret the next key sequence using the wrong translation
2720 tables and function keymaps. */
2721 if (NILP (c
) && current_kboard
!= orig_kboard
)
2724 return make_number (-2); /* wrong_kboard_jmpbuf */
2727 /* If this has become non-nil here, it has been set by a timer
2728 or sentinel or filter. */
2729 if (CONSP (Vunread_command_events
))
2731 c
= XCAR (Vunread_command_events
);
2732 Vunread_command_events
= XCDR (Vunread_command_events
);
2735 /* Read something from current KBOARD's side queue, if possible. */
2739 if (current_kboard
->kbd_queue_has_data
)
2741 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2743 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2744 KVAR (current_kboard
, kbd_queue
)
2745 = XCDR (KVAR (current_kboard
, kbd_queue
));
2746 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2747 current_kboard
->kbd_queue_has_data
= 0;
2748 input_pending
= readable_events (0);
2749 if (EVENT_HAS_PARAMETERS (c
)
2750 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2751 internal_last_event_frame
= XCAR (XCDR (c
));
2752 Vlast_event_frame
= internal_last_event_frame
;
2756 /* If current_kboard's side queue is empty check the other kboards.
2757 If one of them has data that we have not yet seen here,
2758 switch to it and process the data waiting for it.
2760 Note: if the events queued up for another kboard
2761 have already been seen here, and therefore are not a complete command,
2762 the kbd_queue_has_data field is 0, so we skip that kboard here.
2763 That's to avoid an infinite loop switching between kboards here. */
2764 if (NILP (c
) && !single_kboard
)
2767 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2768 if (kb
->kbd_queue_has_data
)
2770 current_kboard
= kb
;
2771 /* This is going to exit from read_char
2772 so we had better get rid of this frame's stuff. */
2774 return make_number (-2); /* wrong_kboard_jmpbuf */
2782 /* Finally, we read from the main queue,
2783 and if that gives us something we can't use yet, we put it on the
2784 appropriate side queue and try again. */
2788 KBOARD
*kb
IF_LINT (= NULL
);
2793 EMACS_GET_TIME (now
);
2794 if (EMACS_TIME_GE (now
, *end_time
))
2798 /* Actually read a character, waiting if necessary. */
2799 save_getcjmp (save_jump
);
2800 restore_getcjmp (local_getcjmp
);
2802 timer_start_idle ();
2803 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2804 restore_getcjmp (save_jump
);
2806 if (! NILP (c
) && (kb
!= current_kboard
))
2808 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2811 while (CONSP (XCDR (last
)))
2813 if (!NILP (XCDR (last
)))
2817 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2819 XSETCDR (last
, Fcons (c
, Qnil
));
2820 kb
->kbd_queue_has_data
= 1;
2824 current_kboard
= kb
;
2825 /* This is going to exit from read_char
2826 so we had better get rid of this frame's stuff. */
2828 return make_number (-2);
2832 /* Terminate Emacs in batch mode if at eof. */
2833 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2834 Fkill_emacs (make_number (1));
2838 /* Add in any extra modifiers, where appropriate. */
2839 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2840 || ((extra_keyboard_modifiers
& 0177) < ' '
2841 && (extra_keyboard_modifiers
& 0177) != 0))
2842 XSETINT (c
, make_ctrl_char (XINT (c
)));
2844 /* Transfer any other modifier bits directly from
2845 extra_keyboard_modifiers to c. Ignore the actual character code
2846 in the low 16 bits of extra_keyboard_modifiers. */
2847 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2858 if (commandflag
>= 0
2859 && !input_pending
&& !detect_input_pending_run_timers (0))
2867 /* Buffer switch events are only for internal wakeups
2868 so don't show them to the user.
2869 Also, don't record a key if we already did. */
2870 if (BUFFERP (c
) || key_already_recorded
)
2873 /* Process special events within read_char
2874 and loop around to read another event. */
2877 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2882 struct buffer
*prev_buffer
= current_buffer
;
2883 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2884 int was_locked
= single_kboard
;
2885 ptrdiff_t count
= SPECPDL_INDEX ();
2886 record_single_kboard_state ();
2889 last_input_event
= c
;
2890 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2892 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2893 /* We stopped being idle for this event; undo that. This
2894 prevents automatic window selection (under
2895 mouse_autoselect_window from acting as a real input event, for
2896 example banishing the mouse under mouse-avoidance-mode. */
2897 timer_resume_idle ();
2899 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2900 /* Resume allowing input from any kboard, if that was true before. */
2902 any_kboard_state ();
2903 unbind_to (count
, Qnil
);
2906 if (current_buffer
!= prev_buffer
)
2908 /* The command may have changed the keymaps. Pretend there
2909 is input in another keyboard and return. This will
2910 recalculate keymaps. */
2911 c
= make_number (-2);
2918 /* Handle things that only apply to characters. */
2921 /* If kbd_buffer_get_event gave us an EOF, return that. */
2925 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2926 && UNSIGNED_CMP (XFASTINT (c
), <,
2927 SCHARS (KVAR (current_kboard
,
2928 Vkeyboard_translate_table
))))
2929 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2930 && UNSIGNED_CMP (XFASTINT (c
), <,
2931 ASIZE (KVAR (current_kboard
,
2932 Vkeyboard_translate_table
))))
2933 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2937 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2938 /* nil in keyboard-translate-table means no translation. */
2944 /* If this event is a mouse click in the menu bar,
2945 return just menu-bar for now. Modify the mouse click event
2946 so we won't do this twice, then queue it up. */
2947 if (EVENT_HAS_PARAMETERS (c
)
2949 && CONSP (EVENT_START (c
))
2950 && CONSP (XCDR (EVENT_START (c
))))
2954 posn
= POSN_POSN (EVENT_START (c
));
2955 /* Handle menu-bar events:
2956 insert the dummy prefix event `menu-bar'. */
2957 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2959 /* Change menu-bar to (menu-bar) as the event "position". */
2960 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2963 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2968 /* Store these characters into recent_keys, the dribble file if any,
2969 and the keyboard macro being defined, if any. */
2971 if (! NILP (also_record
))
2972 record_char (also_record
);
2974 /* Wipe the echo area.
2975 But first, if we are about to use an input method,
2976 save the echo area contents for it to refer to. */
2978 && ! NILP (Vinput_method_function
)
2979 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2981 previous_echo_area_message
= Fcurrent_message ();
2982 Vinput_method_previous_message
= previous_echo_area_message
;
2985 /* Now wipe the echo area, except for help events which do their
2986 own stuff with the echo area. */
2988 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2989 && !(EQ (Qswitch_frame
, XCAR (c
)))
2990 /* Don't wipe echo area for select window events: These might
2991 get delayed via `mouse-autoselect-window' (Bug#11304). */
2992 && !(EQ (Qselect_window
, XCAR (c
)))))
2994 if (!NILP (echo_area_buffer
[0]))
2996 safe_run_hooks (Qecho_area_clear_hook
);
2997 clear_message (1, 0);
3001 reread_for_input_method
:
3003 /* Pass this to the input method, if appropriate. */
3005 && ! NILP (Vinput_method_function
)
3006 /* Don't run the input method within a key sequence,
3007 after the first event of the key sequence. */
3008 && NILP (prev_event
)
3009 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3012 ptrdiff_t key_count
;
3013 int key_count_reset
;
3014 struct gcpro gcpro1
;
3015 ptrdiff_t count
= SPECPDL_INDEX ();
3017 /* Save the echo status. */
3018 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3019 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3020 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3021 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3024 if (before_command_restore_flag
)
3026 this_command_key_count
= before_command_key_count_1
;
3027 if (this_command_key_count
< this_single_command_key_start
)
3028 this_single_command_key_start
= this_command_key_count
;
3029 echo_truncate (before_command_echo_length_1
);
3030 before_command_restore_flag
= 0;
3034 /* Save the this_command_keys status. */
3035 key_count
= this_command_key_count
;
3036 key_count_reset
= this_command_key_count_reset
;
3039 keys
= Fcopy_sequence (this_command_keys
);
3044 /* Clear out this_command_keys. */
3045 this_command_key_count
= 0;
3046 this_command_key_count_reset
= 0;
3048 /* Now wipe the echo area. */
3049 if (!NILP (echo_area_buffer
[0]))
3050 safe_run_hooks (Qecho_area_clear_hook
);
3051 clear_message (1, 0);
3054 /* If we are not reading a key sequence,
3055 never use the echo area. */
3058 specbind (Qinput_method_use_echo_area
, Qt
);
3061 /* Call the input method. */
3062 tem
= call1 (Vinput_method_function
, c
);
3064 tem
= unbind_to (count
, tem
);
3066 /* Restore the saved echoing state
3067 and this_command_keys state. */
3068 this_command_key_count
= key_count
;
3069 this_command_key_count_reset
= key_count_reset
;
3071 this_command_keys
= keys
;
3074 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3075 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3076 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3077 if (saved_immediate_echo
)
3082 /* The input method can return no events. */
3085 /* Bring back the previous message, if any. */
3086 if (! NILP (previous_echo_area_message
))
3087 message_with_string ("%s", previous_echo_area_message
, 0);
3090 /* It returned one event or more. */
3092 Vunread_post_input_method_events
3093 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3098 /* Display help if not echoing. */
3099 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3101 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3102 Lisp_Object help
, object
, position
, window
, htem
;
3104 htem
= Fcdr (XCDR (c
));
3107 window
= Fcar (htem
);
3109 object
= Fcar (htem
);
3111 position
= Fcar (htem
);
3113 show_help_echo (help
, window
, object
, position
);
3115 /* We stopped being idle for this event; undo that. */
3117 timer_resume_idle ();
3121 if ((! reread
|| this_command_key_count
== 0
3122 || this_command_key_count_reset
)
3126 /* Don't echo mouse motion events. */
3127 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3128 && NILP (Fzerop (Vecho_keystrokes
))
3129 && ! (EVENT_HAS_PARAMETERS (c
)
3130 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3133 if (! NILP (also_record
))
3134 echo_char (also_record
);
3135 /* Once we reread a character, echoing can happen
3136 the next time we pause to read a new one. */
3137 ok_to_echo_at_next_pause
= current_kboard
;
3140 /* Record this character as part of the current key. */
3141 add_command_key (c
);
3142 if (! NILP (also_record
))
3143 add_command_key (also_record
);
3146 last_input_event
= c
;
3149 /* Process the help character specially if enabled */
3150 if (!NILP (Vhelp_form
) && help_char_p (c
))
3152 ptrdiff_t count
= SPECPDL_INDEX ();
3154 help_form_saved_window_configs
3155 = Fcons (Fcurrent_window_configuration (Qnil
),
3156 help_form_saved_window_configs
);
3157 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3158 call0 (Qhelp_form_show
);
3163 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3164 if (EVENT_HAS_PARAMETERS (c
)
3165 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3166 XSETCAR (help_form_saved_window_configs
, Qnil
);
3168 while (BUFFERP (c
));
3169 /* Remove the help from the frame */
3170 unbind_to (count
, Qnil
);
3173 if (EQ (c
, make_number (040)))
3177 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3178 while (BUFFERP (c
));
3187 /* Record a key that came from a mouse menu.
3188 Record it for echoing, for this-command-keys, and so on. */
3191 record_menu_key (Lisp_Object c
)
3193 /* Wipe the echo area. */
3194 clear_message (1, 0);
3199 before_command_key_count
= this_command_key_count
;
3200 before_command_echo_length
= echo_length ();
3203 /* Don't echo mouse motion events. */
3204 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3205 && NILP (Fzerop (Vecho_keystrokes
)))
3209 /* Once we reread a character, echoing can happen
3210 the next time we pause to read a new one. */
3211 ok_to_echo_at_next_pause
= 0;
3214 /* Record this character as part of the current key. */
3215 add_command_key (c
);
3217 /* Re-reading in the middle of a command */
3218 last_input_event
= c
;
3222 /* Return 1 if should recognize C as "the help character". */
3225 help_char_p (Lisp_Object c
)
3229 if (EQ (c
, Vhelp_char
))
3231 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3232 if (EQ (c
, XCAR (tail
)))
3237 /* Record the input event C in various ways. */
3240 record_char (Lisp_Object c
)
3244 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3246 /* To avoid filling recent_keys with help-echo and mouse-movement
3247 events, we filter out repeated help-echo events, only store the
3248 first and last in a series of mouse-movement events, and don't
3249 store repeated help-echo events which are only separated by
3250 mouse-movement events. */
3252 Lisp_Object ev1
, ev2
, ev3
;
3255 if ((ix1
= recent_keys_index
- 1) < 0)
3256 ix1
= NUM_RECENT_KEYS
- 1;
3257 ev1
= AREF (recent_keys
, ix1
);
3259 if ((ix2
= ix1
- 1) < 0)
3260 ix2
= NUM_RECENT_KEYS
- 1;
3261 ev2
= AREF (recent_keys
, ix2
);
3263 if ((ix3
= ix2
- 1) < 0)
3264 ix3
= NUM_RECENT_KEYS
- 1;
3265 ev3
= AREF (recent_keys
, ix3
);
3267 if (EQ (XCAR (c
), Qhelp_echo
))
3269 /* Don't record `help-echo' in recent_keys unless it shows some help
3270 message, and a different help than the previously recorded
3272 Lisp_Object help
, last_help
;
3274 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3275 if (!STRINGP (help
))
3277 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3278 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3280 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3281 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3282 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3284 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3285 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3286 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3287 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3290 else if (EQ (XCAR (c
), Qmouse_movement
))
3292 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3293 So additional mouse movement events replace the last element. */
3294 Lisp_Object last_window
, window
;
3296 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3297 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3298 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3299 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3300 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3302 ASET (recent_keys
, ix1
, c
);
3308 store_kbd_macro_char (c
);
3312 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3313 ASET (recent_keys
, recent_keys_index
, c
);
3314 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3315 recent_keys_index
= 0;
3317 else if (recorded
< 0)
3319 /* We need to remove one or two events from recent_keys.
3320 To do this, we simply put nil at those events and move the
3321 recent_keys_index backwards over those events. Usually,
3322 users will never see those nil events, as they will be
3323 overwritten by the command keys entered to see recent_keys
3326 while (recorded
++ < 0 && total_keys
> 0)
3328 if (total_keys
< NUM_RECENT_KEYS
)
3330 if (--recent_keys_index
< 0)
3331 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3332 ASET (recent_keys
, recent_keys_index
, Qnil
);
3336 num_nonmacro_input_events
++;
3338 /* Write c to the dribble file. If c is a lispy event, write
3339 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3340 If you, dear reader, have a better idea, you've got the source. :-) */
3346 if (XUINT (c
) < 0x100)
3347 putc (XUINT (c
), dribble
);
3349 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3353 Lisp_Object dribblee
;
3355 /* If it's a structured event, take the event header. */
3356 dribblee
= EVENT_HEAD (c
);
3358 if (SYMBOLP (dribblee
))
3360 putc ('<', dribble
);
3361 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3362 SBYTES (SYMBOL_NAME (dribblee
)),
3364 putc ('>', dribble
);
3373 /* Copy out or in the info on where C-g should throw to.
3374 This is used when running Lisp code from within get_char,
3375 in case get_char is called recursively.
3376 See read_process_output. */
3379 save_getcjmp (jmp_buf temp
)
3381 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3385 restore_getcjmp (jmp_buf temp
)
3387 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3390 /* Low level keyboard/mouse input.
3391 kbd_buffer_store_event places events in kbd_buffer, and
3392 kbd_buffer_get_event retrieves them. */
3394 /* Return true if there are any events in the queue that read-char
3395 would return. If this returns false, a read-char would block. */
3397 readable_events (int flags
)
3399 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3402 /* If the buffer contains only FOCUS_IN_EVENT events, and
3403 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3404 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3406 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3407 #ifdef USE_TOOLKIT_SCROLL_BARS
3408 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3412 struct input_event
*event
;
3414 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3421 #ifdef USE_TOOLKIT_SCROLL_BARS
3422 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3424 event
->kind
== FOCUS_IN_EVENT
)
3425 #ifdef USE_TOOLKIT_SCROLL_BARS
3426 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3427 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3428 && event
->part
== scroll_bar_handle
3429 && event
->modifiers
== 0)
3434 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3437 while (event
!= kbd_store_ptr
);
3443 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3444 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3445 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3450 if (current_kboard
->kbd_queue_has_data
)
3456 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3457 if (kb
->kbd_queue_has_data
)
3463 /* Set this for debugging, to have a way to get out */
3464 int stop_character EXTERNALLY_VISIBLE
;
3467 event_to_kboard (struct input_event
*event
)
3470 frame
= event
->frame_or_window
;
3472 frame
= XCAR (frame
);
3473 else if (WINDOWP (frame
))
3474 frame
= WINDOW_FRAME (XWINDOW (frame
));
3476 /* There are still some events that don't set this field.
3477 For now, just ignore the problem.
3478 Also ignore dead frames here. */
3479 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3482 return FRAME_KBOARD (XFRAME (frame
));
3486 /* Return the number of slots occupied in kbd_buffer. */
3489 kbd_buffer_nr_stored (void)
3491 return kbd_fetch_ptr
== kbd_store_ptr
3493 : (kbd_fetch_ptr
< kbd_store_ptr
3494 ? kbd_store_ptr
- kbd_fetch_ptr
3495 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3496 + (kbd_store_ptr
- kbd_buffer
)));
3498 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3501 kbd_buffer_store_event (register struct input_event
*event
)
3503 kbd_buffer_store_event_hold (event
, 0);
3506 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3508 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3509 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3510 Else, if EVENT is a quit event, store the quit event
3511 in HOLD_QUIT, and return (thus ignoring further events).
3513 This is used in read_avail_input to postpone the processing
3514 of the quit event until all subsequent input events have been
3515 parsed (and discarded).
3519 kbd_buffer_store_event_hold (register struct input_event
*event
,
3520 struct input_event
*hold_quit
)
3522 if (event
->kind
== NO_EVENT
)
3525 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3528 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3530 register int c
= event
->code
& 0377;
3532 if (event
->modifiers
& ctrl_modifier
)
3533 c
= make_ctrl_char (c
);
3535 c
|= (event
->modifiers
3536 & (meta_modifier
| alt_modifier
3537 | hyper_modifier
| super_modifier
));
3541 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3542 struct input_event
*sp
;
3544 if (single_kboard
&& kb
!= current_kboard
)
3546 KVAR (kb
, kbd_queue
)
3547 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3548 Fcons (make_number (c
), Qnil
));
3549 kb
->kbd_queue_has_data
= 1;
3550 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3552 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3555 if (event_to_kboard (sp
) == kb
)
3557 sp
->kind
= NO_EVENT
;
3558 sp
->frame_or_window
= Qnil
;
3567 memcpy (hold_quit
, event
, sizeof (*event
));
3571 /* If this results in a quit_char being returned to Emacs as
3572 input, set Vlast_event_frame properly. If this doesn't
3573 get returned to Emacs as an event, the next event read
3574 will set Vlast_event_frame again, so this is safe to do. */
3578 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3580 focus
= event
->frame_or_window
;
3581 internal_last_event_frame
= focus
;
3582 Vlast_event_frame
= focus
;
3585 last_event_timestamp
= event
->timestamp
;
3586 handle_interrupt ();
3590 if (c
&& c
== stop_character
)
3596 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3597 Just ignore the second one. */
3598 else if (event
->kind
== BUFFER_SWITCH_EVENT
3599 && kbd_fetch_ptr
!= kbd_store_ptr
3600 && ((kbd_store_ptr
== kbd_buffer
3601 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3602 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3605 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3606 kbd_store_ptr
= kbd_buffer
;
3608 /* Don't let the very last slot in the buffer become full,
3609 since that would make the two pointers equal,
3610 and that is indistinguishable from an empty buffer.
3611 Discard the event if it would fill the last slot. */
3612 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3614 *kbd_store_ptr
= *event
;
3617 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3619 /* Don't read keyboard input until we have processed kbd_buffer.
3620 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3621 hold_keyboard_input ();
3623 if (!noninteractive
)
3624 signal (SIGIO
, SIG_IGN
);
3628 #endif /* subprocesses */
3631 /* If we're inside while-no-input, and this event qualifies
3632 as input, set quit-flag to cause an interrupt. */
3633 if (!NILP (Vthrow_on_input
)
3634 && event
->kind
!= FOCUS_IN_EVENT
3635 && event
->kind
!= HELP_EVENT
3636 && event
->kind
!= DEICONIFY_EVENT
)
3638 Vquit_flag
= Vthrow_on_input
;
3639 /* If we're inside a function that wants immediate quits,
3641 if (immediate_quit
&& NILP (Vinhibit_quit
))
3651 /* Put an input event back in the head of the event queue. */
3654 kbd_buffer_unget_event (register struct input_event
*event
)
3656 if (kbd_fetch_ptr
== kbd_buffer
)
3657 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3659 /* Don't let the very last slot in the buffer become full, */
3660 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3663 *kbd_fetch_ptr
= *event
;
3668 /* Generate a HELP_EVENT input_event and store it in the keyboard
3671 HELP is the help form.
3673 FRAME and WINDOW are the frame and window where the help is
3674 generated. OBJECT is the Lisp object where the help was found (a
3675 buffer, a string, an overlay, or nil if neither from a string nor
3676 from a buffer). POS is the position within OBJECT where the help
3680 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3681 Lisp_Object object
, ptrdiff_t pos
)
3683 struct input_event event
;
3687 event
.kind
= HELP_EVENT
;
3688 event
.frame_or_window
= frame
;
3690 event
.x
= WINDOWP (window
) ? window
: frame
;
3693 kbd_buffer_store_event (&event
);
3697 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3700 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3702 struct input_event event
;
3704 event
.kind
= HELP_EVENT
;
3705 event
.frame_or_window
= frame
;
3710 kbd_buffer_store_event (&event
);
3714 /* Discard any mouse events in the event buffer by setting them to
3717 discard_mouse_events (void)
3719 struct input_event
*sp
;
3720 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3722 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3725 if (sp
->kind
== MOUSE_CLICK_EVENT
3726 || sp
->kind
== WHEEL_EVENT
3727 || sp
->kind
== HORIZ_WHEEL_EVENT
3729 || sp
->kind
== GPM_CLICK_EVENT
3731 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3733 sp
->kind
= NO_EVENT
;
3739 /* Return non-zero if there are any real events waiting in the event
3740 buffer, not counting `NO_EVENT's.
3742 If DISCARD is non-zero, discard NO_EVENT events at the front of
3743 the input queue, possibly leaving the input queue empty if there
3744 are no real input events. */
3747 kbd_buffer_events_waiting (int discard
)
3749 struct input_event
*sp
;
3751 for (sp
= kbd_fetch_ptr
;
3752 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3755 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3762 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3766 /* Clear input event EVENT. */
3769 clear_event (struct input_event
*event
)
3771 event
->kind
= NO_EVENT
;
3775 /* Read one event from the event buffer, waiting if necessary.
3776 The value is a Lisp object representing the event.
3777 The value is nil for an event that should be ignored,
3778 or that was handled here.
3779 We always read and discard one event. */
3782 kbd_buffer_get_event (KBOARD
**kbp
,
3783 int *used_mouse_menu
,
3784 EMACS_TIME
*end_time
)
3789 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3791 /* Start reading input again, we have processed enough so we can
3792 accept new events again. */
3793 unhold_keyboard_input ();
3795 if (!noninteractive
)
3796 signal (SIGIO
, input_available_signal
);
3800 #endif /* subprocesses */
3802 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3804 /* In case we are running as a daemon, only do this before
3805 detaching from the terminal. */
3806 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3810 *kbp
= current_kboard
;
3813 #endif /* ! HAVE_DBUS */
3815 /* Wait until there is input available. */
3818 /* Break loop if there's an unread command event. Needed in
3819 moused window autoselection which uses a timer to insert such
3821 if (CONSP (Vunread_command_events
))
3824 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3826 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3827 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3831 /* If the quit flag is set, then read_char will return
3832 quit_char, so that counts as "available input." */
3833 if (!NILP (Vquit_flag
))
3834 quit_throw_to_read_char (0);
3836 /* One way or another, wait until input is available; then, if
3837 interrupt handlers have not read it, read it now. */
3839 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3843 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3845 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3846 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3851 EMACS_TIME duration
;
3852 EMACS_GET_TIME (duration
);
3853 if (EMACS_TIME_GE (duration
, *end_time
))
3854 return Qnil
; /* Finished waiting. */
3857 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3858 wait_reading_process_output (min (EMACS_SECS (duration
),
3860 EMACS_NSECS (duration
),
3861 -1, 1, Qnil
, NULL
, 0);
3865 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3867 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3868 /* Pass 1 for EXPECT since we just waited to have input. */
3869 read_avail_input (1);
3872 if (CONSP (Vunread_command_events
))
3875 first
= XCAR (Vunread_command_events
);
3876 Vunread_command_events
= XCDR (Vunread_command_events
);
3877 *kbp
= current_kboard
;
3881 /* At this point, we know that there is a readable event available
3882 somewhere. If the event queue is empty, then there must be a
3883 mouse movement enabled and available. */
3884 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3886 struct input_event
*event
;
3888 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3892 last_event_timestamp
= event
->timestamp
;
3894 *kbp
= event_to_kboard (event
);
3896 *kbp
= current_kboard
; /* Better than returning null ptr? */
3900 /* These two kinds of events get special handling
3901 and don't actually appear to the command loop.
3902 We return nil for them. */
3903 if (event
->kind
== SELECTION_REQUEST_EVENT
3904 || event
->kind
== SELECTION_CLEAR_EVENT
)
3907 struct input_event copy
;
3909 /* Remove it from the buffer before processing it,
3910 since otherwise swallow_events will see it
3911 and process it again. */
3913 kbd_fetch_ptr
= event
+ 1;
3914 input_pending
= readable_events (0);
3915 x_handle_selection_event (©
);
3917 /* We're getting selection request events, but we don't have
3923 #if defined (HAVE_NS)
3924 else if (event
->kind
== NS_TEXT_EVENT
)
3926 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3927 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3929 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3930 kbd_fetch_ptr
= event
+ 1;
3931 if (used_mouse_menu
)
3932 *used_mouse_menu
= 1;
3936 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3937 || defined (HAVE_NS)
3938 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3940 /* Make an event (delete-frame (FRAME)). */
3941 obj
= Fcons (event
->frame_or_window
, Qnil
);
3942 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3943 kbd_fetch_ptr
= event
+ 1;
3946 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3947 || defined (HAVE_NS)
3948 else if (event
->kind
== ICONIFY_EVENT
)
3950 /* Make an event (iconify-frame (FRAME)). */
3951 obj
= Fcons (event
->frame_or_window
, Qnil
);
3952 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3953 kbd_fetch_ptr
= event
+ 1;
3955 else if (event
->kind
== DEICONIFY_EVENT
)
3957 /* Make an event (make-frame-visible (FRAME)). */
3958 obj
= Fcons (event
->frame_or_window
, Qnil
);
3959 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3960 kbd_fetch_ptr
= event
+ 1;
3963 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3965 /* The value doesn't matter here; only the type is tested. */
3966 XSETBUFFER (obj
, current_buffer
);
3967 kbd_fetch_ptr
= event
+ 1;
3969 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3970 || defined (HAVE_NS) || defined (USE_GTK)
3971 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3973 kbd_fetch_ptr
= event
+ 1;
3974 input_pending
= readable_events (0);
3975 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3976 x_activate_menubar (XFRAME (event
->frame_or_window
));
3979 #if defined (WINDOWSNT)
3980 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3982 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3983 obj
= Fcons (Qlanguage_change
,
3984 list3 (event
->frame_or_window
,
3985 make_number (event
->code
),
3986 make_number (event
->modifiers
)));
3987 kbd_fetch_ptr
= event
+ 1;
3990 else if (event
->kind
== SAVE_SESSION_EVENT
)
3992 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3993 kbd_fetch_ptr
= event
+ 1;
3995 /* Just discard these, by returning nil.
3996 With MULTI_KBOARD, these events are used as placeholders
3997 when we need to randomly delete events from the queue.
3998 (They shouldn't otherwise be found in the buffer,
3999 but on some machines it appears they do show up
4000 even without MULTI_KBOARD.) */
4001 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4002 mouse events during a popup-menu call. */
4003 else if (event
->kind
== NO_EVENT
)
4004 kbd_fetch_ptr
= event
+ 1;
4005 else if (event
->kind
== HELP_EVENT
)
4007 Lisp_Object object
, position
, help
, frame
, window
;
4009 frame
= event
->frame_or_window
;
4010 object
= event
->arg
;
4011 position
= make_number (event
->code
);
4014 clear_event (event
);
4016 kbd_fetch_ptr
= event
+ 1;
4017 if (!WINDOWP (window
))
4019 obj
= Fcons (Qhelp_echo
,
4020 list5 (frame
, help
, window
, object
, position
));
4022 else if (event
->kind
== FOCUS_IN_EVENT
)
4024 /* Notification of a FocusIn event. The frame receiving the
4025 focus is in event->frame_or_window. Generate a
4026 switch-frame event if necessary. */
4027 Lisp_Object frame
, focus
;
4029 frame
= event
->frame_or_window
;
4030 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4034 if (!EQ (frame
, internal_last_event_frame
)
4035 && !EQ (frame
, selected_frame
))
4036 obj
= make_lispy_switch_frame (frame
);
4037 internal_last_event_frame
= frame
;
4038 kbd_fetch_ptr
= event
+ 1;
4041 else if (event
->kind
== DBUS_EVENT
)
4043 obj
= make_lispy_event (event
);
4044 kbd_fetch_ptr
= event
+ 1;
4047 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4049 obj
= make_lispy_event (event
);
4050 kbd_fetch_ptr
= event
+ 1;
4054 /* If this event is on a different frame, return a switch-frame this
4055 time, and leave the event in the queue for next time. */
4059 frame
= event
->frame_or_window
;
4061 frame
= XCAR (frame
);
4062 else if (WINDOWP (frame
))
4063 frame
= WINDOW_FRAME (XWINDOW (frame
));
4065 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4069 if (! EQ (frame
, internal_last_event_frame
)
4070 && !EQ (frame
, selected_frame
))
4071 obj
= make_lispy_switch_frame (frame
);
4072 internal_last_event_frame
= frame
;
4074 /* If we didn't decide to make a switch-frame event, go ahead
4075 and build a real event from the queue entry. */
4079 obj
= make_lispy_event (event
);
4081 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4082 || defined (HAVE_NS) || defined (USE_GTK)
4083 /* If this was a menu selection, then set the flag to inhibit
4084 writing to last_nonmenu_event. Don't do this if the event
4085 we're returning is (menu-bar), though; that indicates the
4086 beginning of the menu sequence, and we might as well leave
4087 that as the `event with parameters' for this selection. */
4089 && !EQ (event
->frame_or_window
, event
->arg
)
4090 && (event
->kind
== MENU_BAR_EVENT
4091 || event
->kind
== TOOL_BAR_EVENT
))
4092 *used_mouse_menu
= 1;
4095 /* certain system events are non-key events */
4097 && event
->kind
== NS_NONKEY_EVENT
)
4098 *used_mouse_menu
= 1;
4101 /* Wipe out this event, to catch bugs. */
4102 clear_event (event
);
4103 kbd_fetch_ptr
= event
+ 1;
4107 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4108 /* Try generating a mouse motion event. */
4109 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4111 FRAME_PTR f
= some_mouse_moved ();
4112 Lisp_Object bar_window
;
4113 enum scroll_bar_part part
;
4117 *kbp
= current_kboard
;
4118 /* Note that this uses F to determine which terminal to look at.
4119 If there is no valid info, it does not store anything
4120 so x remains nil. */
4123 /* XXX Can f or mouse_position_hook be NULL here? */
4124 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4125 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4130 /* Decide if we should generate a switch-frame event. Don't
4131 generate switch-frame events for motion outside of all Emacs
4137 frame
= FRAME_FOCUS_FRAME (f
);
4139 XSETFRAME (frame
, f
);
4141 if (! EQ (frame
, internal_last_event_frame
)
4142 && !EQ (frame
, selected_frame
))
4143 obj
= make_lispy_switch_frame (frame
);
4144 internal_last_event_frame
= frame
;
4147 /* If we didn't decide to make a switch-frame event, go ahead and
4148 return a mouse-motion event. */
4149 if (!NILP (x
) && NILP (obj
))
4150 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4152 #endif /* HAVE_MOUSE || HAVE GPM */
4154 /* We were promised by the above while loop that there was
4155 something for us to read! */
4158 input_pending
= readable_events (0);
4160 Vlast_event_frame
= internal_last_event_frame
;
4165 /* Process any non-user-visible events (currently X selection events),
4166 without reading any user-visible events. */
4169 process_special_events (void)
4171 struct input_event
*event
;
4173 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4175 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4178 if (event
== kbd_store_ptr
)
4182 /* If we find a stored X selection request, handle it now. */
4183 if (event
->kind
== SELECTION_REQUEST_EVENT
4184 || event
->kind
== SELECTION_CLEAR_EVENT
)
4188 /* Remove the event from the fifo buffer before processing;
4189 otherwise swallow_events called recursively could see it
4190 and process it again. To do this, we move the events
4191 between kbd_fetch_ptr and EVENT one slot to the right,
4194 struct input_event copy
= *event
;
4195 struct input_event
*beg
4196 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4197 ? kbd_buffer
: kbd_fetch_ptr
;
4200 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4201 else if (event
< beg
)
4203 if (event
> kbd_buffer
)
4204 memmove (kbd_buffer
+ 1, kbd_buffer
,
4205 (event
- kbd_buffer
) * sizeof (struct input_event
));
4206 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4207 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4208 memmove (beg
+ 1, beg
,
4209 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4210 * sizeof (struct input_event
));
4213 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4214 kbd_fetch_ptr
= kbd_buffer
+ 1;
4218 /* X wants last_event_timestamp for selection ownership. */
4219 last_event_timestamp
= copy
.timestamp
;
4220 input_pending
= readable_events (0);
4221 x_handle_selection_event (©
);
4223 /* We're getting selection request events, but we don't have
4231 /* Process any events that are not user-visible, run timer events that
4232 are ripe, and return, without reading any user-visible events. */
4235 swallow_events (int do_display
)
4239 process_special_events ();
4241 old_timers_run
= timers_run
;
4242 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4244 if (timers_run
!= old_timers_run
&& do_display
)
4245 redisplay_preserve_echo_area (7);
4248 /* Record the start of when Emacs is idle,
4249 for the sake of running idle-time timers. */
4252 timer_start_idle (void)
4256 /* If we are already in the idle state, do nothing. */
4257 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4260 EMACS_GET_TIME (timer_idleness_start_time
);
4262 timer_last_idleness_start_time
= timer_idleness_start_time
;
4264 /* Mark all idle-time timers as once again candidates for running. */
4265 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4269 timer
= XCAR (timers
);
4271 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4273 ASET (timer
, 0, Qnil
);
4277 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4280 timer_stop_idle (void)
4282 EMACS_SET_INVALID_TIME (timer_idleness_start_time
);
4285 /* Resume idle timer from last idle start time. */
4288 timer_resume_idle (void)
4290 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4293 timer_idleness_start_time
= timer_last_idleness_start_time
;
4296 /* This is only for debugging. */
4297 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4299 /* List of elisp functions to call, delayed because they were generated in
4300 a context where Elisp could not be safely run (e.g. redisplay, signal,
4301 ...). Each element has the form (FUN . ARGS). */
4302 Lisp_Object pending_funcalls
;
4304 /* If TIMER is a valid timer, return nonzero and place its value into
4305 *RESULT. Otherwise return zero. */
4307 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4309 Lisp_Object
*vector
;
4311 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4313 vector
= XVECTOR (timer
)->contents
;
4314 if (! NILP (vector
[0]))
4317 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[4],
4322 /* Check whether a timer has fired. To prevent larger problems we simply
4323 disregard elements that are not proper timers. Do not make a circular
4324 timer list for the time being.
4326 Returns the time to wait until the next timer fires. If a
4327 timer is triggering now, return zero.
4328 If no timer is active, return -1.
4330 If a timer is ripe, we run it, with quitting turned off.
4331 In that case we return 0 to indicate that a new timer_check_2 call
4335 timer_check_2 (void)
4337 EMACS_TIME nexttime
;
4339 EMACS_TIME idleness_now
;
4340 Lisp_Object timers
, idle_timers
, chosen_timer
;
4341 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4343 EMACS_SET_INVALID_TIME (nexttime
);
4345 /* Always consider the ordinary timers. */
4346 timers
= Vtimer_list
;
4347 /* Consider the idle timers only if Emacs is idle. */
4348 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4349 idle_timers
= Vtimer_idle_list
;
4352 chosen_timer
= Qnil
;
4353 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4355 /* First run the code that was delayed. */
4356 while (CONSP (pending_funcalls
))
4358 Lisp_Object funcall
= XCAR (pending_funcalls
);
4359 pending_funcalls
= XCDR (pending_funcalls
);
4360 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4363 if (CONSP (timers
) || CONSP (idle_timers
))
4365 EMACS_GET_TIME (now
);
4366 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4367 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4369 EMACS_SET_SECS_NSECS (idleness_now
, 0, 0);
4372 while (CONSP (timers
) || CONSP (idle_timers
))
4374 Lisp_Object
*vector
;
4375 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4376 EMACS_TIME timer_time
, idle_timer_time
;
4377 EMACS_TIME difference
;
4378 EMACS_TIME timer_difference
, idle_timer_difference
;
4379 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4381 EMACS_SET_INVALID_TIME (timer_difference
);
4382 EMACS_SET_INVALID_TIME (idle_timer_difference
);
4384 /* Set TIMER and TIMER_DIFFERENCE
4385 based on the next ordinary timer.
4386 TIMER_DIFFERENCE is the distance in time from NOW to when
4387 this timer becomes ripe (negative if it's already ripe).
4388 Skip past invalid timers and timers already handled. */
4391 timer
= XCAR (timers
);
4392 if (! decode_timer (timer
, &timer_time
))
4394 timers
= XCDR (timers
);
4398 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4400 EMACS_SUB_TIME (timer_difference
, now
, timer_time
);
4402 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4405 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4406 based on the next idle timer. */
4407 if (CONSP (idle_timers
))
4409 idle_timer
= XCAR (idle_timers
);
4410 if (! decode_timer (idle_timer
, &idle_timer_time
))
4412 idle_timers
= XCDR (idle_timers
);
4416 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4417 if (idle_timer_ripe
)
4418 EMACS_SUB_TIME (idle_timer_difference
,
4419 idleness_now
, idle_timer_time
);
4421 EMACS_SUB_TIME (idle_timer_difference
,
4422 idle_timer_time
, idleness_now
);
4425 /* Decide which timer is the next timer,
4426 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4427 Also step down the list where we found that timer. */
4429 if (EMACS_TIME_VALID_P (timer_difference
)
4430 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4431 || idle_timer_ripe
< timer_ripe
4432 || (idle_timer_ripe
== timer_ripe
4434 ? EMACS_TIME_LT (idle_timer_difference
,
4436 : EMACS_TIME_LT (timer_difference
,
4437 idle_timer_difference
)))))
4439 chosen_timer
= timer
;
4440 timers
= XCDR (timers
);
4441 difference
= timer_difference
;
4446 chosen_timer
= idle_timer
;
4447 idle_timers
= XCDR (idle_timers
);
4448 difference
= idle_timer_difference
;
4449 ripe
= idle_timer_ripe
;
4452 /* If timer is ripe, run it if it hasn't been run. */
4455 vector
= XVECTOR (chosen_timer
)->contents
;
4456 if (NILP (vector
[0]))
4458 ptrdiff_t count
= SPECPDL_INDEX ();
4459 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4461 /* Mark the timer as triggered to prevent problems if the lisp
4462 code fails to reschedule it right. */
4465 specbind (Qinhibit_quit
, Qt
);
4467 call1 (Qtimer_event_handler
, chosen_timer
);
4468 Vdeactivate_mark
= old_deactivate_mark
;
4470 unbind_to (count
, Qnil
);
4472 /* Since we have handled the event,
4473 we don't need to tell the caller to wake up and do it. */
4474 /* But the caller must still wait for the next timer, so
4475 return 0 to indicate that. */
4478 EMACS_SET_SECS (nexttime
, 0);
4479 EMACS_SET_USECS (nexttime
, 0);
4482 /* When we encounter a timer that is still waiting,
4483 return the amount of time to wait before it is ripe. */
4490 /* No timers are pending in the future. */
4491 /* Return 0 if we generated an event, and -1 if not. */
4497 /* Check whether a timer has fired. To prevent larger problems we simply
4498 disregard elements that are not proper timers. Do not make a circular
4499 timer list for the time being.
4501 Returns the time to wait until the next timer fires.
4502 If no timer is active, return an invalid value.
4504 As long as any timer is ripe, we run it. */
4509 EMACS_TIME nexttime
;
4513 nexttime
= timer_check_2 ();
4515 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4520 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4521 doc
: /* Return the current length of Emacs idleness, or nil.
4522 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4523 in the same style as (current-time).
4525 The value when Emacs is not idle is nil.
4527 NSEC is a multiple of the system clock resolution. */)
4530 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4532 EMACS_TIME now
, idleness_now
;
4534 EMACS_GET_TIME (now
);
4535 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4537 return make_lisp_time (idleness_now
);
4543 /* Caches for modify_event_symbol. */
4544 static Lisp_Object accent_key_syms
;
4545 static Lisp_Object func_key_syms
;
4546 static Lisp_Object mouse_syms
;
4547 static Lisp_Object wheel_syms
;
4548 static Lisp_Object drag_n_drop_syms
;
4550 /* This is a list of keysym codes for special "accent" characters.
4551 It parallels lispy_accent_keys. */
4553 static const int lispy_accent_codes
[] =
4555 #ifdef XK_dead_circumflex
4560 #ifdef XK_dead_grave
4565 #ifdef XK_dead_tilde
4570 #ifdef XK_dead_diaeresis
4575 #ifdef XK_dead_macron
4580 #ifdef XK_dead_degree
4585 #ifdef XK_dead_acute
4590 #ifdef XK_dead_cedilla
4595 #ifdef XK_dead_breve
4600 #ifdef XK_dead_ogonek
4605 #ifdef XK_dead_caron
4610 #ifdef XK_dead_doubleacute
4611 XK_dead_doubleacute
,
4615 #ifdef XK_dead_abovedot
4620 #ifdef XK_dead_abovering
4630 #ifdef XK_dead_belowdot
4635 #ifdef XK_dead_voiced_sound
4636 XK_dead_voiced_sound
,
4640 #ifdef XK_dead_semivoiced_sound
4641 XK_dead_semivoiced_sound
,
4657 /* This is a list of Lisp names for special "accent" characters.
4658 It parallels lispy_accent_codes. */
4660 static const char *const lispy_accent_keys
[] =
4678 "dead-voiced-sound",
4679 "dead-semivoiced-sound",
4685 #define FUNCTION_KEY_OFFSET 0x0
4687 const char *const lispy_function_keys
[] =
4691 0, /* VK_LBUTTON 0x01 */
4692 0, /* VK_RBUTTON 0x02 */
4693 "cancel", /* VK_CANCEL 0x03 */
4694 0, /* VK_MBUTTON 0x04 */
4696 0, 0, 0, /* 0x05 .. 0x07 */
4698 "backspace", /* VK_BACK 0x08 */
4699 "tab", /* VK_TAB 0x09 */
4701 0, 0, /* 0x0A .. 0x0B */
4703 "clear", /* VK_CLEAR 0x0C */
4704 "return", /* VK_RETURN 0x0D */
4706 0, 0, /* 0x0E .. 0x0F */
4708 0, /* VK_SHIFT 0x10 */
4709 0, /* VK_CONTROL 0x11 */
4710 0, /* VK_MENU 0x12 */
4711 "pause", /* VK_PAUSE 0x13 */
4712 "capslock", /* VK_CAPITAL 0x14 */
4713 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4715 "junja", /* VK_JUNJA 0x17 */
4716 "final", /* VK_FINAL 0x18 */
4717 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4719 "escape", /* VK_ESCAPE 0x1B */
4720 "convert", /* VK_CONVERT 0x1C */
4721 "non-convert", /* VK_NONCONVERT 0x1D */
4722 "accept", /* VK_ACCEPT 0x1E */
4723 "mode-change", /* VK_MODECHANGE 0x1F */
4724 0, /* VK_SPACE 0x20 */
4725 "prior", /* VK_PRIOR 0x21 */
4726 "next", /* VK_NEXT 0x22 */
4727 "end", /* VK_END 0x23 */
4728 "home", /* VK_HOME 0x24 */
4729 "left", /* VK_LEFT 0x25 */
4730 "up", /* VK_UP 0x26 */
4731 "right", /* VK_RIGHT 0x27 */
4732 "down", /* VK_DOWN 0x28 */
4733 "select", /* VK_SELECT 0x29 */
4734 "print", /* VK_PRINT 0x2A */
4735 "execute", /* VK_EXECUTE 0x2B */
4736 "snapshot", /* VK_SNAPSHOT 0x2C */
4737 "insert", /* VK_INSERT 0x2D */
4738 "delete", /* VK_DELETE 0x2E */
4739 "help", /* VK_HELP 0x2F */
4741 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4743 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4745 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4747 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4749 0, 0, 0, 0, 0, 0, 0, 0, 0,
4750 0, 0, 0, 0, 0, 0, 0, 0, 0,
4751 0, 0, 0, 0, 0, 0, 0, 0,
4753 "lwindow", /* VK_LWIN 0x5B */
4754 "rwindow", /* VK_RWIN 0x5C */
4755 "apps", /* VK_APPS 0x5D */
4758 "kp-0", /* VK_NUMPAD0 0x60 */
4759 "kp-1", /* VK_NUMPAD1 0x61 */
4760 "kp-2", /* VK_NUMPAD2 0x62 */
4761 "kp-3", /* VK_NUMPAD3 0x63 */
4762 "kp-4", /* VK_NUMPAD4 0x64 */
4763 "kp-5", /* VK_NUMPAD5 0x65 */
4764 "kp-6", /* VK_NUMPAD6 0x66 */
4765 "kp-7", /* VK_NUMPAD7 0x67 */
4766 "kp-8", /* VK_NUMPAD8 0x68 */
4767 "kp-9", /* VK_NUMPAD9 0x69 */
4768 "kp-multiply", /* VK_MULTIPLY 0x6A */
4769 "kp-add", /* VK_ADD 0x6B */
4770 "kp-separator", /* VK_SEPARATOR 0x6C */
4771 "kp-subtract", /* VK_SUBTRACT 0x6D */
4772 "kp-decimal", /* VK_DECIMAL 0x6E */
4773 "kp-divide", /* VK_DIVIDE 0x6F */
4774 "f1", /* VK_F1 0x70 */
4775 "f2", /* VK_F2 0x71 */
4776 "f3", /* VK_F3 0x72 */
4777 "f4", /* VK_F4 0x73 */
4778 "f5", /* VK_F5 0x74 */
4779 "f6", /* VK_F6 0x75 */
4780 "f7", /* VK_F7 0x76 */
4781 "f8", /* VK_F8 0x77 */
4782 "f9", /* VK_F9 0x78 */
4783 "f10", /* VK_F10 0x79 */
4784 "f11", /* VK_F11 0x7A */
4785 "f12", /* VK_F12 0x7B */
4786 "f13", /* VK_F13 0x7C */
4787 "f14", /* VK_F14 0x7D */
4788 "f15", /* VK_F15 0x7E */
4789 "f16", /* VK_F16 0x7F */
4790 "f17", /* VK_F17 0x80 */
4791 "f18", /* VK_F18 0x81 */
4792 "f19", /* VK_F19 0x82 */
4793 "f20", /* VK_F20 0x83 */
4794 "f21", /* VK_F21 0x84 */
4795 "f22", /* VK_F22 0x85 */
4796 "f23", /* VK_F23 0x86 */
4797 "f24", /* VK_F24 0x87 */
4799 0, 0, 0, 0, /* 0x88 .. 0x8B */
4800 0, 0, 0, 0, /* 0x8C .. 0x8F */
4802 "kp-numlock", /* VK_NUMLOCK 0x90 */
4803 "scroll", /* VK_SCROLL 0x91 */
4804 /* Not sure where the following block comes from.
4805 Windows headers have NEC and Fujitsu specific keys in
4806 this block, but nothing generic. */
4807 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4808 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4809 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4810 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4811 "kp-end", /* VK_NUMPAD_END 0x96 */
4812 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4813 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4814 "kp-up", /* VK_NUMPAD_UP 0x99 */
4815 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4816 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4817 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4818 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4820 0, 0, /* 0x9E .. 0x9F */
4823 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4824 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4825 * No other API or message will distinguish left and right keys this way.
4830 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4831 to enable them selectively, and gives access to a few more functions.
4832 See lispy_multimedia_keys below. */
4833 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4834 0, 0, 0, /* 0xAD .. 0xAF Volume */
4835 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4836 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4838 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4839 0, 0, 0, 0, 0, 0, 0, 0, 0,
4841 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4842 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4843 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4846 "ax", /* VK_OEM_AX 0xE1 */
4847 0, /* VK_OEM_102 0xE2 */
4848 "ico-help", /* VK_ICO_HELP 0xE3 */
4849 "ico-00", /* VK_ICO_00 0xE4 */
4850 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4851 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4852 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4854 "reset", /* VK_OEM_RESET 0xE9 */
4855 "jump", /* VK_OEM_JUMP 0xEA */
4856 "oem-pa1", /* VK_OEM_PA1 0xEB */
4857 "oem-pa2", /* VK_OEM_PA2 0xEC */
4858 "oem-pa3", /* VK_OEM_PA3 0xED */
4859 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4860 "cusel", /* VK_OEM_CUSEL 0xEF */
4861 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4862 "finish", /* VK_OEM_FINISH 0xF1 */
4863 "copy", /* VK_OEM_COPY 0xF2 */
4864 "auto", /* VK_OEM_AUTO 0xF3 */
4865 "enlw", /* VK_OEM_ENLW 0xF4 */
4866 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4867 "attn", /* VK_ATTN 0xF6 */
4868 "crsel", /* VK_CRSEL 0xF7 */
4869 "exsel", /* VK_EXSEL 0xF8 */
4870 "ereof", /* VK_EREOF 0xF9 */
4871 "play", /* VK_PLAY 0xFA */
4872 "zoom", /* VK_ZOOM 0xFB */
4873 "noname", /* VK_NONAME 0xFC */
4874 "pa1", /* VK_PA1 0xFD */
4875 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4879 /* Some of these duplicate the "Media keys" on newer keyboards,
4880 but they are delivered to the application in a different way. */
4881 static const char *const lispy_multimedia_keys
[] =
4889 "browser-favorites",
4926 "toggle-dictate-command",
4932 "media-fast-forward",
4935 "media-channel-down"
4938 #else /* not HAVE_NTGUI */
4940 /* This should be dealt with in XTread_socket now, and that doesn't
4941 depend on the client system having the Kana syms defined. See also
4942 the XK_kana_A case below. */
4945 static const char *const lispy_kana_keys
[] =
4947 /* X Keysym value */
4948 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4949 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4952 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4955 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4956 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4957 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4958 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4959 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4960 "kana-i", "kana-u", "kana-e", "kana-o",
4961 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4962 "prolongedsound", "kana-A", "kana-I", "kana-U",
4963 "kana-E", "kana-O", "kana-KA", "kana-KI",
4964 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4965 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4966 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4967 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4968 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4969 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4970 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4971 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4972 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4973 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4974 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4975 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4977 #endif /* XK_kana_A */
4980 #define FUNCTION_KEY_OFFSET 0xff00
4982 /* You'll notice that this table is arranged to be conveniently
4983 indexed by X Windows keysym values. */
4984 static const char *const lispy_function_keys
[] =
4986 /* X Keysym value */
4988 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4989 "backspace", "tab", "linefeed", "clear",
4991 0, 0, 0, "pause", /* 0xff10...1f */
4992 0, 0, 0, 0, 0, 0, 0, "escape",
4994 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4995 "romaji", "hiragana", "katakana", "hiragana-katakana",
4996 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4997 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4998 "eisu-toggle", /* 0xff30...3f */
4999 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5000 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5002 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5003 "down", "prior", "next", "end",
5004 "begin", 0, 0, 0, 0, 0, 0, 0,
5005 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5016 "break", /* 0xff6b */
5019 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5020 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5021 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5022 0, 0, 0, 0, 0, 0, 0, 0,
5023 "kp-tab", /* 0xff89 */
5025 "kp-enter", /* 0xff8d */
5027 "kp-f1", /* 0xff91 */
5031 "kp-home", /* 0xff95 */
5036 "kp-prior", /* kp-page-up */
5037 "kp-next", /* kp-page-down */
5043 0, 0, 0, 0, 0, 0, 0, 0, 0,
5044 "kp-multiply", /* 0xffaa */
5049 "kp-divide", /* 0xffaf */
5050 "kp-0", /* 0xffb0 */
5051 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5054 "kp-equal", /* 0xffbd */
5055 "f1", /* 0xffbe */ /* IsFunctionKey */
5057 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5058 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5059 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5060 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5061 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5062 0, 0, 0, 0, 0, 0, 0, 0,
5063 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5064 0, 0, 0, 0, 0, 0, 0, "delete"
5067 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5068 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5070 static const char *const iso_lispy_function_keys
[] =
5072 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5073 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5074 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5075 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5076 "iso-lefttab", /* 0xfe20 */
5077 "iso-move-line-up", "iso-move-line-down",
5078 "iso-partial-line-up", "iso-partial-line-down",
5079 "iso-partial-space-left", "iso-partial-space-right",
5080 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5081 "iso-release-margin-left", "iso-release-margin-right",
5082 "iso-release-both-margins",
5083 "iso-fast-cursor-left", "iso-fast-cursor-right",
5084 "iso-fast-cursor-up", "iso-fast-cursor-down",
5085 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5086 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5089 #endif /* not HAVE_NTGUI */
5091 static Lisp_Object Vlispy_mouse_stem
;
5093 static const char *const lispy_wheel_names
[] =
5095 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5098 /* drag-n-drop events are generated when a set of selected files are
5099 dragged from another application and dropped onto an Emacs window. */
5100 static const char *const lispy_drag_n_drop_names
[] =
5105 /* Scroll bar parts. */
5106 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5107 Lisp_Object Qup
, Qdown
, Qbottom
;
5108 static Lisp_Object Qend_scroll
;
5110 static Lisp_Object Qratio
;
5112 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5113 static Lisp_Object
*const scroll_bar_parts
[] = {
5114 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5115 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5118 /* A vector, indexed by button number, giving the down-going location
5119 of currently depressed buttons, both scroll bar and non-scroll bar.
5121 The elements have the form
5122 (BUTTON-NUMBER MODIFIER-MASK . REST)
5123 where REST is the cdr of a position as it would be reported in the event.
5125 The make_lispy_event function stores positions here to tell the
5126 difference between click and drag events, and to store the starting
5127 location to be included in drag events. */
5129 static Lisp_Object button_down_location
;
5131 /* Information about the most recent up-going button event: Which
5132 button, what location, and what time. */
5134 static int last_mouse_button
;
5135 static int last_mouse_x
;
5136 static int last_mouse_y
;
5137 static Time button_down_time
;
5139 /* The number of clicks in this multiple-click. */
5141 static int double_click_count
;
5143 /* X and Y are frame-relative coordinates for a click or wheel event.
5144 Return a Lisp-style event list. */
5147 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5150 enum window_part part
;
5151 Lisp_Object posn
= Qnil
;
5152 Lisp_Object extra_info
= Qnil
;
5153 /* Coordinate pixel positions to return. */
5154 int xret
= 0, yret
= 0;
5155 /* The window under frame pixel coordinates (x,y) */
5156 Lisp_Object window
= f
5157 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5160 if (WINDOWP (window
))
5162 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5163 struct window
*w
= XWINDOW (window
);
5164 Lisp_Object string_info
= Qnil
;
5165 ptrdiff_t textpos
= -1;
5166 int col
= -1, row
= -1;
5167 int dx
= -1, dy
= -1;
5168 int width
= -1, height
= -1;
5169 Lisp_Object object
= Qnil
;
5171 /* Pixel coordinates relative to the window corner. */
5172 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5173 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5175 /* For text area clicks, return X, Y relative to the corner of
5176 this text area. Note that dX, dY etc are set below, by
5177 buffer_posn_from_coords. */
5178 if (part
== ON_TEXT
)
5180 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5181 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5183 /* For mode line and header line clicks, return X, Y relative to
5184 the left window edge. Use mode_line_string to look for a
5185 string on the click position. */
5186 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5191 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5192 /* Note that mode_line_string takes COL, ROW as pixels and
5193 converts them to characters. */
5196 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5197 &object
, &dx
, &dy
, &width
, &height
);
5198 if (STRINGP (string
))
5199 string_info
= Fcons (string
, make_number (charpos
));
5200 textpos
= (w
== XWINDOW (selected_window
)
5201 && current_buffer
== XBUFFER (w
->buffer
))
5202 ? PT
: XMARKER (w
->pointm
)->charpos
;
5207 /* For fringes and margins, Y is relative to the area's (and the
5208 window's) top edge, while X is meaningless. */
5209 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5214 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5217 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5218 &object
, &dx
, &dy
, &width
, &height
);
5219 if (STRINGP (string
))
5220 string_info
= Fcons (string
, make_number (charpos
));
5221 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5223 else if (part
== ON_LEFT_FRINGE
)
5225 posn
= Qleft_fringe
;
5228 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5229 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5230 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5232 else if (part
== ON_RIGHT_FRINGE
)
5234 posn
= Qright_fringe
;
5237 - window_box_width (w
, LEFT_MARGIN_AREA
)
5238 - window_box_width (w
, TEXT_AREA
)
5239 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5240 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5242 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5244 else if (part
== ON_VERTICAL_BORDER
)
5246 posn
= Qvertical_line
;
5251 /* Nothing special for part == ON_SCROLL_BAR. */
5253 /* For clicks in the text area, fringes, or margins, call
5254 buffer_posn_from_coords to extract TEXTPOS, the buffer
5255 position nearest to the click. */
5258 Lisp_Object string2
, object2
= Qnil
;
5259 struct display_pos p
;
5261 int width2
, height2
;
5262 /* The pixel X coordinate passed to buffer_posn_from_coords
5263 is the X coordinate relative to the text area for
5264 text-area and right-margin clicks, zero otherwise. */
5266 = (part
== ON_TEXT
) ? xret
5267 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5268 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5272 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5273 &object2
, &dx2
, &dy2
,
5275 textpos
= CHARPOS (p
.pos
);
5276 if (col
< 0) col
= x2
;
5277 if (row
< 0) row
= y2
;
5278 if (dx
< 0) dx
= dx2
;
5279 if (dy
< 0) dy
= dy2
;
5280 if (width
< 0) width
= width2
;
5281 if (height
< 0) height
= height2
;
5285 posn
= make_number (textpos
);
5286 if (STRINGP (string2
))
5287 string_info
= Fcons (string2
,
5288 make_number (CHARPOS (p
.string_pos
)));
5294 #ifdef HAVE_WINDOW_SYSTEM
5295 if (IMAGEP (object
))
5297 Lisp_Object image_map
, hotspot
;
5298 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5300 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5302 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5303 posn
= XCAR (hotspot
);
5310 Fcons (make_number (dx
), make_number (dy
)),
5311 Fcons (make_number (width
), make_number (height
)));
5314 extra_info
= Fcons (string_info
,
5315 Fcons (make_number (textpos
),
5316 Fcons (Fcons (make_number (col
),
5321 XSETFRAME (window
, f
);
5325 return Fcons (window
,
5327 Fcons (Fcons (make_number (xret
),
5328 make_number (yret
)),
5329 Fcons (make_number (t
),
5333 /* Given a struct input_event, build the lisp event which represents
5334 it. If EVENT is 0, build a mouse movement event from the mouse
5335 movement buffer, which should have a movement event in it.
5337 Note that events must be passed to this function in the order they
5338 are received; this function stores the location of button presses
5339 in order to build drag events when the button is released. */
5342 make_lispy_event (struct input_event
*event
)
5346 switch (SWITCH_ENUM_CAST (event
->kind
))
5348 /* A simple keystroke. */
5349 case ASCII_KEYSTROKE_EVENT
:
5350 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5352 Lisp_Object lispy_c
;
5353 EMACS_INT c
= event
->code
;
5354 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5357 eassert (c
== event
->code
);
5358 /* Turn ASCII characters into control characters
5360 if (event
->modifiers
& ctrl_modifier
)
5362 c
= make_ctrl_char (c
);
5363 event
->modifiers
&= ~ctrl_modifier
;
5367 /* Add in the other modifier bits. The shift key was taken care
5368 of by the X code. */
5369 c
|= (event
->modifiers
5370 & (meta_modifier
| alt_modifier
5371 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5372 /* Distinguish Shift-SPC from SPC. */
5373 if ((event
->code
) == 040
5374 && event
->modifiers
& shift_modifier
)
5375 c
|= shift_modifier
;
5376 button_down_time
= 0;
5377 XSETFASTINT (lispy_c
, c
);
5382 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5383 except that they are non-key events (last-nonmenu-event is nil). */
5384 case NS_NONKEY_EVENT
:
5387 /* A function key. The symbol may need to have modifier prefixes
5389 case NON_ASCII_KEYSTROKE_EVENT
:
5390 button_down_time
= 0;
5392 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5393 if (event
->code
== lispy_accent_codes
[i
])
5394 return modify_event_symbol (i
,
5396 Qfunction_key
, Qnil
,
5397 lispy_accent_keys
, &accent_key_syms
,
5398 (sizeof (lispy_accent_keys
)
5399 / sizeof (lispy_accent_keys
[0])));
5403 if (event
->code
>= 0x400 && event
->code
< 0x500)
5404 return modify_event_symbol (event
->code
- 0x400,
5405 event
->modifiers
& ~shift_modifier
,
5406 Qfunction_key
, Qnil
,
5407 lispy_kana_keys
, &func_key_syms
,
5408 (sizeof (lispy_kana_keys
)
5409 / sizeof (lispy_kana_keys
[0])));
5410 #endif /* XK_kana_A */
5413 #ifdef ISO_FUNCTION_KEY_OFFSET
5414 if (event
->code
< FUNCTION_KEY_OFFSET
5415 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5416 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5418 Qfunction_key
, Qnil
,
5419 iso_lispy_function_keys
, &func_key_syms
,
5420 (sizeof (iso_lispy_function_keys
)
5421 / sizeof (iso_lispy_function_keys
[0])));
5424 /* Handle system-specific or unknown keysyms. */
5425 if (event
->code
& (1 << 28)
5426 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5427 || (event
->code
- FUNCTION_KEY_OFFSET
5428 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5429 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5431 /* We need to use an alist rather than a vector as the cache
5432 since we can't make a vector long enough. */
5433 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5434 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5435 return modify_event_symbol (event
->code
,
5438 KVAR (current_kboard
, Vsystem_key_alist
),
5439 0, &KVAR (current_kboard
, system_key_syms
),
5443 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5445 Qfunction_key
, Qnil
,
5446 lispy_function_keys
, &func_key_syms
,
5447 (sizeof (lispy_function_keys
)
5448 / sizeof (lispy_function_keys
[0])));
5451 case MULTIMEDIA_KEY_EVENT
:
5452 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5453 / sizeof (lispy_multimedia_keys
[0]))
5454 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5456 return modify_event_symbol (event
->code
, event
->modifiers
,
5457 Qfunction_key
, Qnil
,
5458 lispy_multimedia_keys
, &func_key_syms
,
5459 (sizeof (lispy_multimedia_keys
)
5460 / sizeof (lispy_multimedia_keys
[0])));
5466 /* A mouse click. Figure out where it is, decide whether it's
5467 a press, click or drag, and build the appropriate structure. */
5468 case MOUSE_CLICK_EVENT
:
5469 #ifndef USE_TOOLKIT_SCROLL_BARS
5470 case SCROLL_BAR_CLICK_EVENT
:
5473 int button
= event
->code
;
5475 Lisp_Object position
;
5476 Lisp_Object
*start_pos_ptr
;
5477 Lisp_Object start_pos
;
5481 /* Build the position as appropriate for this mouse click. */
5482 if (event
->kind
== MOUSE_CLICK_EVENT
)
5484 struct frame
*f
= XFRAME (event
->frame_or_window
);
5485 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5489 /* Ignore mouse events that were made on frame that
5490 have been deleted. */
5491 if (! FRAME_LIVE_P (f
))
5494 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5495 /* EVENT->x and EVENT->y are frame-relative pixel
5496 coordinates at this place. Under old redisplay, COLUMN
5497 and ROW are set to frame relative glyph coordinates
5498 which are then used to determine whether this click is
5499 in a menu (non-toolkit version). */
5500 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5501 &column
, &row
, NULL
, 1);
5503 /* In the non-toolkit version, clicks on the menu bar
5504 are ordinary button events in the event buffer.
5505 Distinguish them, and invoke the menu.
5507 (In the toolkit version, the toolkit handles the menu bar
5508 and Emacs doesn't know about it until after the user
5509 makes a selection.) */
5510 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5511 && (event
->modifiers
& down_modifier
))
5513 Lisp_Object items
, item
;
5515 /* Find the menu bar item under `column'. */
5517 items
= FRAME_MENU_BAR_ITEMS (f
);
5518 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5520 Lisp_Object pos
, string
;
5521 string
= AREF (items
, i
+ 1);
5522 pos
= AREF (items
, i
+ 3);
5525 if (column
>= XINT (pos
)
5526 && column
< XINT (pos
) + SCHARS (string
))
5528 item
= AREF (items
, i
);
5533 /* ELisp manual 2.4b says (x y) are window relative but
5534 code says they are frame-relative. */
5536 = Fcons (event
->frame_or_window
,
5538 Fcons (Fcons (event
->x
, event
->y
),
5539 Fcons (make_number (event
->timestamp
),
5542 return Fcons (item
, Fcons (position
, Qnil
));
5544 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5546 position
= make_lispy_position (f
, event
->x
, event
->y
,
5549 #ifndef USE_TOOLKIT_SCROLL_BARS
5552 /* It's a scrollbar click. */
5554 Lisp_Object portion_whole
;
5557 window
= event
->frame_or_window
;
5558 portion_whole
= Fcons (event
->x
, event
->y
);
5559 part
= *scroll_bar_parts
[(int) event
->part
];
5563 Fcons (Qvertical_scroll_bar
,
5564 Fcons (portion_whole
,
5565 Fcons (make_number (event
->timestamp
),
5566 Fcons (part
, Qnil
)))));
5568 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5570 if (button
>= ASIZE (button_down_location
))
5572 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5573 button_down_location
= larger_vector (button_down_location
,
5575 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5578 start_pos_ptr
= &AREF (button_down_location
, button
);
5579 start_pos
= *start_pos_ptr
;
5580 *start_pos_ptr
= Qnil
;
5583 /* On window-system frames, use the value of
5584 double-click-fuzz as is. On other frames, interpret it
5585 as a multiple of 1/8 characters. */
5589 if (WINDOWP (event
->frame_or_window
))
5590 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5591 else if (FRAMEP (event
->frame_or_window
))
5592 f
= XFRAME (event
->frame_or_window
);
5596 if (FRAME_WINDOW_P (f
))
5597 fuzz
= double_click_fuzz
;
5599 fuzz
= double_click_fuzz
/ 8;
5601 is_double
= (button
== last_mouse_button
5602 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5603 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5604 && button_down_time
!= 0
5605 && (EQ (Vdouble_click_time
, Qt
)
5606 || (NATNUMP (Vdouble_click_time
)
5607 && (event
->timestamp
- button_down_time
5608 < XFASTINT (Vdouble_click_time
)))));
5611 last_mouse_button
= button
;
5612 last_mouse_x
= XINT (event
->x
);
5613 last_mouse_y
= XINT (event
->y
);
5615 /* If this is a button press, squirrel away the location, so
5616 we can decide later whether it was a click or a drag. */
5617 if (event
->modifiers
& down_modifier
)
5621 double_click_count
++;
5622 event
->modifiers
|= ((double_click_count
> 2)
5627 double_click_count
= 1;
5628 button_down_time
= event
->timestamp
;
5629 *start_pos_ptr
= Fcopy_alist (position
);
5630 ignore_mouse_drag_p
= 0;
5633 /* Now we're releasing a button - check the co-ordinates to
5634 see if this was a click or a drag. */
5635 else if (event
->modifiers
& up_modifier
)
5637 /* If we did not see a down before this up, ignore the up.
5638 Probably this happened because the down event chose a
5639 menu item. It would be an annoyance to treat the
5640 release of the button that chose the menu item as a
5643 if (!CONSP (start_pos
))
5646 event
->modifiers
&= ~up_modifier
;
5649 Lisp_Object new_down
, down
;
5650 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5652 /* The third element of every position
5653 should be the (x,y) pair. */
5654 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5655 new_down
= Fcar (Fcdr (Fcdr (position
)));
5658 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5660 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5661 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5664 if (ignore_mouse_drag_p
)
5666 event
->modifiers
|= click_modifier
;
5667 ignore_mouse_drag_p
= 0;
5669 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5670 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5671 /* Maybe the mouse has moved a lot, caused scrolling, and
5672 eventually ended up at the same screen position (but
5673 not buffer position) in which case it is a drag, not
5675 /* FIXME: OTOH if the buffer position has changed
5676 because of a timer or process filter rather than
5677 because of mouse movement, it should be considered as
5678 a click. But mouse-drag-region completely ignores
5679 this case and it hasn't caused any real problem, so
5680 it's probably OK to ignore it as well. */
5681 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5682 /* Mouse hasn't moved (much). */
5683 event
->modifiers
|= click_modifier
;
5686 button_down_time
= 0;
5687 event
->modifiers
|= drag_modifier
;
5690 /* Don't check is_double; treat this as multiple
5691 if the down-event was multiple. */
5692 if (double_click_count
> 1)
5693 event
->modifiers
|= ((double_click_count
> 2)
5699 /* Every mouse event should either have the down_modifier or
5700 the up_modifier set. */
5704 /* Get the symbol we should use for the mouse click. */
5707 head
= modify_event_symbol (button
,
5709 Qmouse_click
, Vlispy_mouse_stem
,
5712 ASIZE (mouse_syms
));
5713 if (event
->modifiers
& drag_modifier
)
5718 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5721 Fcons (make_number (double_click_count
),
5731 case HORIZ_WHEEL_EVENT
:
5733 Lisp_Object position
;
5736 /* Build the position as appropriate for this mouse click. */
5737 struct frame
*f
= XFRAME (event
->frame_or_window
);
5739 /* Ignore wheel events that were made on frame that have been
5741 if (! FRAME_LIVE_P (f
))
5744 position
= make_lispy_position (f
, event
->x
, event
->y
,
5747 /* Set double or triple modifiers to indicate the wheel speed. */
5749 /* On window-system frames, use the value of
5750 double-click-fuzz as is. On other frames, interpret it
5751 as a multiple of 1/8 characters. */
5757 if (WINDOWP (event
->frame_or_window
))
5758 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5759 else if (FRAMEP (event
->frame_or_window
))
5760 fr
= XFRAME (event
->frame_or_window
);
5764 fuzz
= FRAME_WINDOW_P (fr
)
5765 ? double_click_fuzz
: double_click_fuzz
/ 8;
5767 if (event
->modifiers
& up_modifier
)
5769 /* Emit a wheel-up event. */
5770 event
->modifiers
&= ~up_modifier
;
5773 else if (event
->modifiers
& down_modifier
)
5775 /* Emit a wheel-down event. */
5776 event
->modifiers
&= ~down_modifier
;
5780 /* Every wheel event should either have the down_modifier or
5781 the up_modifier set. */
5784 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5787 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5788 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5789 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5790 && button_down_time
!= 0
5791 && (EQ (Vdouble_click_time
, Qt
)
5792 || (NATNUMP (Vdouble_click_time
)
5793 && (event
->timestamp
- button_down_time
5794 < XFASTINT (Vdouble_click_time
)))));
5797 double_click_count
++;
5798 event
->modifiers
|= ((double_click_count
> 2)
5804 double_click_count
= 1;
5805 event
->modifiers
|= click_modifier
;
5808 button_down_time
= event
->timestamp
;
5809 /* Use a negative value to distinguish wheel from mouse button. */
5810 last_mouse_button
= - (1 + symbol_num
);
5811 last_mouse_x
= XINT (event
->x
);
5812 last_mouse_y
= XINT (event
->y
);
5814 /* Get the symbol we should use for the wheel event. */
5815 head
= modify_event_symbol (symbol_num
,
5821 ASIZE (wheel_syms
));
5824 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5827 Fcons (make_number (double_click_count
),
5836 #ifdef USE_TOOLKIT_SCROLL_BARS
5838 /* We don't have down and up events if using toolkit scroll bars,
5839 so make this always a click event. Store in the `part' of
5840 the Lisp event a symbol which maps to the following actions:
5842 `above_handle' page up
5843 `below_handle' page down
5847 `bottom' bottom of buffer
5848 `handle' thumb has been dragged.
5849 `end-scroll' end of interaction with scroll bar
5851 The incoming input_event contains in its `part' member an
5852 index of type `enum scroll_bar_part' which we can use as an
5853 index in scroll_bar_parts to get the appropriate symbol. */
5855 case SCROLL_BAR_CLICK_EVENT
:
5857 Lisp_Object position
, head
, window
, portion_whole
, part
;
5859 window
= event
->frame_or_window
;
5860 portion_whole
= Fcons (event
->x
, event
->y
);
5861 part
= *scroll_bar_parts
[(int) event
->part
];
5865 Fcons (Qvertical_scroll_bar
,
5866 Fcons (portion_whole
,
5867 Fcons (make_number (event
->timestamp
),
5868 Fcons (part
, Qnil
)))));
5870 /* Always treat scroll bar events as clicks. */
5871 event
->modifiers
|= click_modifier
;
5872 event
->modifiers
&= ~up_modifier
;
5874 if (event
->code
>= ASIZE (mouse_syms
))
5875 mouse_syms
= larger_vector (mouse_syms
,
5876 event
->code
- ASIZE (mouse_syms
) + 1,
5879 /* Get the symbol we should use for the mouse click. */
5880 head
= modify_event_symbol (event
->code
,
5885 ASIZE (mouse_syms
));
5886 return Fcons (head
, Fcons (position
, Qnil
));
5889 #endif /* USE_TOOLKIT_SCROLL_BARS */
5891 case DRAG_N_DROP_EVENT
:
5894 Lisp_Object head
, position
;
5897 f
= XFRAME (event
->frame_or_window
);
5900 /* Ignore mouse events that were made on frames that
5901 have been deleted. */
5902 if (! FRAME_LIVE_P (f
))
5905 position
= make_lispy_position (f
, event
->x
, event
->y
,
5908 head
= modify_event_symbol (0, event
->modifiers
,
5910 lispy_drag_n_drop_names
,
5911 &drag_n_drop_syms
, 1);
5917 #endif /* HAVE_MOUSE */
5919 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5920 || defined (HAVE_NS) || defined (USE_GTK)
5921 case MENU_BAR_EVENT
:
5922 if (EQ (event
->arg
, event
->frame_or_window
))
5923 /* This is the prefix key. We translate this to
5924 `(menu_bar)' because the code in keyboard.c for menu
5925 events, which we use, relies on this. */
5926 return Fcons (Qmenu_bar
, Qnil
);
5930 case SELECT_WINDOW_EVENT
:
5931 /* Make an event (select-window (WINDOW)). */
5932 return Fcons (Qselect_window
,
5933 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5936 case TOOL_BAR_EVENT
:
5937 if (EQ (event
->arg
, event
->frame_or_window
))
5938 /* This is the prefix key. We translate this to
5939 `(tool_bar)' because the code in keyboard.c for tool bar
5940 events, which we use, relies on this. */
5941 return Fcons (Qtool_bar
, Qnil
);
5942 else if (SYMBOLP (event
->arg
))
5943 return apply_modifiers (event
->modifiers
, event
->arg
);
5946 case USER_SIGNAL_EVENT
:
5947 /* A user signal. */
5949 char *name
= find_user_signal_name (event
->code
);
5952 return intern (name
);
5955 case SAVE_SESSION_EVENT
:
5956 return Qsave_session
;
5961 return Fcons (Qdbus_event
, event
->arg
);
5963 #endif /* HAVE_DBUS */
5965 case CONFIG_CHANGED_EVENT
:
5966 return Fcons (Qconfig_changed_event
,
5968 Fcons (event
->frame_or_window
, Qnil
)));
5970 case GPM_CLICK_EVENT
:
5972 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5973 Lisp_Object head
, position
;
5974 Lisp_Object
*start_pos_ptr
;
5975 Lisp_Object start_pos
;
5976 int button
= event
->code
;
5978 if (button
>= ASIZE (button_down_location
))
5980 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5981 button_down_location
= larger_vector (button_down_location
,
5983 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5986 start_pos_ptr
= &AREF (button_down_location
, button
);
5987 start_pos
= *start_pos_ptr
;
5989 position
= make_lispy_position (f
, event
->x
, event
->y
,
5992 if (event
->modifiers
& down_modifier
)
5993 *start_pos_ptr
= Fcopy_alist (position
);
5994 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5996 if (!CONSP (start_pos
))
5998 event
->modifiers
&= ~up_modifier
;
6001 head
= modify_event_symbol (button
,
6003 Qmouse_click
, Vlispy_mouse_stem
,
6006 ASIZE (mouse_syms
));
6008 if (event
->modifiers
& drag_modifier
)
6013 else if (event
->modifiers
& double_modifier
)
6016 Fcons (make_number (2),
6018 else if (event
->modifiers
& triple_modifier
)
6021 Fcons (make_number (3),
6028 #endif /* HAVE_GPM */
6030 /* The 'kind' field of the event is something we don't recognize. */
6036 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6039 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6040 Lisp_Object x
, Lisp_Object y
, Time t
)
6042 /* Is it a scroll bar movement? */
6043 if (frame
&& ! NILP (bar_window
))
6045 Lisp_Object part_sym
;
6047 part_sym
= *scroll_bar_parts
[(int) part
];
6048 return Fcons (Qscroll_bar_movement
,
6049 Fcons (list5 (bar_window
,
6050 Qvertical_scroll_bar
,
6056 /* Or is it an ordinary mouse movement? */
6059 Lisp_Object position
;
6060 position
= make_lispy_position (frame
, x
, y
, t
);
6061 return list2 (Qmouse_movement
, position
);
6065 #endif /* HAVE_MOUSE || HAVE GPM */
6067 /* Construct a switch frame event. */
6069 make_lispy_switch_frame (Lisp_Object frame
)
6071 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6074 /* Manipulating modifiers. */
6076 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6078 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6079 SYMBOL's name of the end of the modifiers; the string from this
6080 position is the unmodified symbol name.
6082 This doesn't use any caches. */
6085 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6091 CHECK_SYMBOL (symbol
);
6094 name
= SYMBOL_NAME (symbol
);
6096 for (i
= 0; i
< SBYTES (name
) - 1; )
6098 ptrdiff_t this_mod_end
= 0;
6101 /* See if the name continues with a modifier word.
6102 Check that the word appears, but don't check what follows it.
6103 Set this_mod and this_mod_end to record what we find. */
6105 switch (SREF (name
, i
))
6107 #define SINGLE_LETTER_MOD(BIT) \
6108 (this_mod_end = i + 1, this_mod = BIT)
6111 SINGLE_LETTER_MOD (alt_modifier
);
6115 SINGLE_LETTER_MOD (ctrl_modifier
);
6119 SINGLE_LETTER_MOD (hyper_modifier
);
6123 SINGLE_LETTER_MOD (meta_modifier
);
6127 SINGLE_LETTER_MOD (shift_modifier
);
6131 SINGLE_LETTER_MOD (super_modifier
);
6134 #undef SINGLE_LETTER_MOD
6136 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6137 if (i + LEN + 1 <= SBYTES (name) \
6138 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6140 this_mod_end = i + LEN; \
6145 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6146 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6147 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6151 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6153 #undef MULTI_LETTER_MOD
6157 /* If we found no modifier, stop looking for them. */
6158 if (this_mod_end
== 0)
6161 /* Check there is a dash after the modifier, so that it
6162 really is a modifier. */
6163 if (this_mod_end
>= SBYTES (name
)
6164 || SREF (name
, this_mod_end
) != '-')
6167 /* This modifier is real; look for another. */
6168 modifiers
|= this_mod
;
6169 i
= this_mod_end
+ 1;
6172 /* Should we include the `click' modifier? */
6173 if (! (modifiers
& (down_modifier
| drag_modifier
6174 | double_modifier
| triple_modifier
))
6175 && i
+ 7 == SBYTES (name
)
6176 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6177 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6178 modifiers
|= click_modifier
;
6180 if (! (modifiers
& (double_modifier
| triple_modifier
))
6181 && i
+ 6 < SBYTES (name
)
6182 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6183 modifiers
|= click_modifier
;
6191 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6192 prepended to the string BASE[0..BASE_LEN-1].
6193 This doesn't use any caches. */
6195 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6197 /* Since BASE could contain nulls, we can't use intern here; we have
6198 to use Fintern, which expects a genuine Lisp_String, and keeps a
6201 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6207 /* Only the event queue may use the `up' modifier; it should always
6208 be turned into a click or drag event before presented to lisp code. */
6209 if (modifiers
& up_modifier
)
6212 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6213 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6214 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6215 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6216 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6217 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6218 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6219 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6220 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6221 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6222 /* The click modifier is denoted by the absence of other modifiers. */
6226 mod_len
= p
- new_mods
;
6230 Lisp_Object new_name
;
6232 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6233 mod_len
+ base_len_byte
);
6234 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6235 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6237 return Fintern (new_name
, Qnil
);
6242 static const char *const modifier_names
[] =
6244 "up", "down", "drag", "click", "double", "triple", 0, 0,
6245 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6246 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6248 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6250 static Lisp_Object modifier_symbols
;
6252 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6254 lispy_modifier_list (int modifiers
)
6256 Lisp_Object modifier_list
;
6259 modifier_list
= Qnil
;
6260 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6261 if (modifiers
& (1<<i
))
6262 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6265 return modifier_list
;
6269 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6270 where UNMODIFIED is the unmodified form of SYMBOL,
6271 MASK is the set of modifiers present in SYMBOL's name.
6272 This is similar to parse_modifiers_uncached, but uses the cache in
6273 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6274 Qevent_symbol_elements property. */
6276 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6279 parse_modifiers (Lisp_Object symbol
)
6281 Lisp_Object elements
;
6283 if (INTEGERP (symbol
))
6284 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6285 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6287 else if (!SYMBOLP (symbol
))
6290 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6291 if (CONSP (elements
))
6296 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6297 Lisp_Object unmodified
;
6300 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6301 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6304 if (modifiers
& ~INTMASK
)
6306 XSETFASTINT (mask
, modifiers
);
6307 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6309 /* Cache the parsing results on SYMBOL. */
6310 Fput (symbol
, Qevent_symbol_element_mask
,
6312 Fput (symbol
, Qevent_symbol_elements
,
6313 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6315 /* Since we know that SYMBOL is modifiers applied to unmodified,
6316 it would be nice to put that in unmodified's cache.
6317 But we can't, since we're not sure that parse_modifiers is
6324 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6325 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6326 doc
: /* Parse the event symbol. For internal use. */)
6327 (Lisp_Object symbol
)
6329 /* Fill the cache if needed. */
6330 parse_modifiers (symbol
);
6331 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6332 and use the Lispier representation stored on Qevent_symbol_elements
6334 return Fget (symbol
, Qevent_symbol_elements
);
6337 /* Apply the modifiers MODIFIERS to the symbol BASE.
6338 BASE must be unmodified.
6340 This is like apply_modifiers_uncached, but uses BASE's
6341 Qmodifier_cache property, if present. It also builds
6342 Qevent_symbol_elements properties, since it has that info anyway.
6344 apply_modifiers copies the value of BASE's Qevent_kind property to
6345 the modified symbol. */
6347 apply_modifiers (int modifiers
, Lisp_Object base
)
6349 Lisp_Object cache
, idx
, entry
, new_symbol
;
6351 /* Mask out upper bits. We don't know where this value's been. */
6352 modifiers
&= INTMASK
;
6354 if (INTEGERP (base
))
6355 return make_number (XINT (base
) | modifiers
);
6357 /* The click modifier never figures into cache indices. */
6358 cache
= Fget (base
, Qmodifier_cache
);
6359 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6360 entry
= assq_no_quit (idx
, cache
);
6363 new_symbol
= XCDR (entry
);
6366 /* We have to create the symbol ourselves. */
6367 new_symbol
= apply_modifiers_uncached (modifiers
,
6368 SSDATA (SYMBOL_NAME (base
)),
6369 SCHARS (SYMBOL_NAME (base
)),
6370 SBYTES (SYMBOL_NAME (base
)));
6372 /* Add the new symbol to the base's cache. */
6373 entry
= Fcons (idx
, new_symbol
);
6374 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6376 /* We have the parsing info now for free, so we could add it to
6378 XSETFASTINT (idx, modifiers);
6379 Fput (new_symbol, Qevent_symbol_element_mask,
6380 Fcons (base, Fcons (idx, Qnil)));
6381 Fput (new_symbol, Qevent_symbol_elements,
6382 Fcons (base, lispy_modifier_list (modifiers)));
6383 Sadly, this is only correct if `base' is indeed a base event,
6384 which is not necessarily the case. -stef */
6387 /* Make sure this symbol is of the same kind as BASE.
6389 You'd think we could just set this once and for all when we
6390 intern the symbol above, but reorder_modifiers may call us when
6391 BASE's property isn't set right; we can't assume that just
6392 because it has a Qmodifier_cache property it must have its
6393 Qevent_kind set right as well. */
6394 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6398 kind
= Fget (base
, Qevent_kind
);
6400 Fput (new_symbol
, Qevent_kind
, kind
);
6407 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6408 return a symbol with the modifiers placed in the canonical order.
6409 Canonical order is alphabetical, except for down and drag, which
6410 always come last. The 'click' modifier is never written out.
6412 Fdefine_key calls this to make sure that (for example) C-M-foo
6413 and M-C-foo end up being equivalent in the keymap. */
6416 reorder_modifiers (Lisp_Object symbol
)
6418 /* It's hopefully okay to write the code this way, since everything
6419 will soon be in caches, and no consing will be done at all. */
6422 parsed
= parse_modifiers (symbol
);
6423 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6428 /* For handling events, we often want to produce a symbol whose name
6429 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6430 to some base, like the name of a function key or mouse button.
6431 modify_event_symbol produces symbols of this sort.
6433 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6434 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6437 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6438 into symbol names, or a string specifying a name stem used to
6439 construct a symbol name or the form `STEM-N', where N is the decimal
6440 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6441 non-nil; otherwise NAME_TABLE is used.
6443 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6444 persist between calls to modify_event_symbol that it can use to
6445 store a cache of the symbols it's generated for this NAME_TABLE
6446 before. The object stored there may be a vector or an alist.
6448 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6450 MODIFIERS is a set of modifier bits (as given in struct input_events)
6451 whose prefixes should be applied to the symbol name.
6453 SYMBOL_KIND is the value to be placed in the event_kind property of
6454 the returned symbol.
6456 The symbols we create are supposed to have an
6457 `event-symbol-elements' property, which lists the modifiers present
6458 in the symbol's name. */
6461 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6462 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6463 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6466 Lisp_Object symbol_int
;
6468 /* Get rid of the "vendor-specific" bit here. */
6469 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6471 /* Is this a request for a valid symbol? */
6472 if (symbol_num
< 0 || symbol_num
>= table_size
)
6475 if (CONSP (*symbol_table
))
6476 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6478 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6479 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6480 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6481 we've never used that symbol before. */
6484 if (! VECTORP (*symbol_table
)
6485 || ASIZE (*symbol_table
) != table_size
)
6489 XSETFASTINT (size
, table_size
);
6490 *symbol_table
= Fmake_vector (size
, Qnil
);
6493 value
= AREF (*symbol_table
, symbol_num
);
6496 /* Have we already used this symbol before? */
6499 /* No; let's create it. */
6500 if (CONSP (name_alist_or_stem
))
6501 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6502 else if (STRINGP (name_alist_or_stem
))
6505 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6506 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6508 SAFE_ALLOCA (buf
, char *, len
);
6509 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6510 XINT (symbol_int
) + 1);
6511 value
= intern (buf
);
6514 else if (name_table
!= 0 && name_table
[symbol_num
])
6515 value
= intern (name_table
[symbol_num
]);
6517 #ifdef HAVE_WINDOW_SYSTEM
6520 char *name
= x_get_keysym_name (symbol_num
);
6522 value
= intern (name
);
6528 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6529 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6530 value
= intern (buf
);
6533 if (CONSP (*symbol_table
))
6534 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6536 ASET (*symbol_table
, symbol_num
, value
);
6538 /* Fill in the cache entries for this symbol; this also
6539 builds the Qevent_symbol_elements property, which the user
6541 apply_modifiers (modifiers
& click_modifier
, value
);
6542 Fput (value
, Qevent_kind
, symbol_kind
);
6545 /* Apply modifiers to that symbol. */
6546 return apply_modifiers (modifiers
, value
);
6549 /* Convert a list that represents an event type,
6550 such as (ctrl meta backspace), into the usual representation of that
6551 event type as a number or a symbol. */
6553 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6554 doc
: /* Convert the event description list EVENT-DESC to an event type.
6555 EVENT-DESC should contain one base event type (a character or symbol)
6556 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6557 drag, down, double or triple). The base must be last.
6558 The return value is an event type (a character or symbol) which
6559 has the same base event type and all the specified modifiers. */)
6560 (Lisp_Object event_desc
)
6568 while (CONSP (rest
))
6576 /* Given a symbol, see if it is a modifier name. */
6577 if (SYMBOLP (elt
) && CONSP (rest
))
6578 this = parse_solitary_modifier (elt
);
6582 else if (!NILP (base
))
6583 error ("Two bases given in one event");
6589 /* Let the symbol A refer to the character A. */
6590 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6591 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6593 if (INTEGERP (base
))
6595 /* Turn (shift a) into A. */
6596 if ((modifiers
& shift_modifier
) != 0
6597 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6599 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6600 modifiers
&= ~shift_modifier
;
6603 /* Turn (control a) into C-a. */
6604 if (modifiers
& ctrl_modifier
)
6605 return make_number ((modifiers
& ~ctrl_modifier
)
6606 | make_ctrl_char (XINT (base
)));
6608 return make_number (modifiers
| XINT (base
));
6610 else if (SYMBOLP (base
))
6611 return apply_modifiers (modifiers
, base
);
6614 error ("Invalid base event");
6619 /* Try to recognize SYMBOL as a modifier name.
6620 Return the modifier flag bit, or 0 if not recognized. */
6623 parse_solitary_modifier (Lisp_Object symbol
)
6625 Lisp_Object name
= SYMBOL_NAME (symbol
);
6627 switch (SREF (name
, 0))
6629 #define SINGLE_LETTER_MOD(BIT) \
6630 if (SBYTES (name) == 1) \
6633 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6634 if (LEN == SBYTES (name) \
6635 && ! strncmp (SSDATA (name), NAME, LEN)) \
6639 SINGLE_LETTER_MOD (alt_modifier
);
6643 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6647 SINGLE_LETTER_MOD (ctrl_modifier
);
6651 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6652 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6656 SINGLE_LETTER_MOD (hyper_modifier
);
6660 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6664 SINGLE_LETTER_MOD (meta_modifier
);
6668 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6672 SINGLE_LETTER_MOD (shift_modifier
);
6676 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6677 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6678 SINGLE_LETTER_MOD (super_modifier
);
6682 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6683 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6684 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6688 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6691 #undef SINGLE_LETTER_MOD
6692 #undef MULTI_LETTER_MOD
6698 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6699 Such a list is not valid as an event,
6700 but it can be a Lucid-style event type list. */
6703 lucid_event_type_list_p (Lisp_Object object
)
6707 if (! CONSP (object
))
6710 if (EQ (XCAR (object
), Qhelp_echo
)
6711 || EQ (XCAR (object
), Qvertical_line
)
6712 || EQ (XCAR (object
), Qmode_line
)
6713 || EQ (XCAR (object
), Qheader_line
))
6716 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6720 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6727 /* Store into *addr a value nonzero if terminal input chars are available.
6728 Serves the purpose of ioctl (0, FIONREAD, addr)
6729 but works even if FIONREAD does not exist.
6730 (In fact, this may actually read some input.)
6732 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6733 timer events that are ripe.
6734 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6735 events (FOCUS_IN_EVENT).
6736 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6737 movements and toolkit scroll bar thumb drags. */
6740 get_input_pending (int *addr
, int flags
)
6742 /* First of all, have we already counted some input? */
6743 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6745 /* If input is being read as it arrives, and we have none, there is none. */
6746 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6749 /* Try to read some input and see how much we get. */
6751 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6754 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6757 gobble_input (int expected
)
6760 if (interrupt_input
)
6763 mask
= sigblock (sigmask (SIGIO
));
6764 read_avail_input (expected
);
6768 #ifdef POLL_FOR_INPUT
6769 /* XXX This condition was (read_socket_hook && !interrupt_input),
6770 but read_socket_hook is not global anymore. Let's pretend that
6772 if (!interrupt_input
&& poll_suppress_count
== 0)
6775 mask
= sigblock (sigmask (SIGALRM
));
6776 read_avail_input (expected
);
6782 read_avail_input (expected
);
6785 /* Put a BUFFER_SWITCH_EVENT in the buffer
6786 so that read_key_sequence will notice the new current buffer. */
6789 record_asynch_buffer_change (void)
6791 struct input_event event
;
6795 event
.kind
= BUFFER_SWITCH_EVENT
;
6796 event
.frame_or_window
= Qnil
;
6799 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6800 The purpose of the event is to make read_key_sequence look up the
6801 keymaps again. If we aren't in read_key_sequence, we don't need one,
6802 and the event could cause trouble by messing up (input-pending-p).
6803 Note: Fwaiting_for_user_input_p always returns nil when async
6804 subprocesses aren't supported. */
6805 tem
= Fwaiting_for_user_input_p ();
6809 /* Make sure no interrupt happens while storing the event. */
6811 if (interrupt_input
)
6814 mask
= sigblock (sigmask (SIGIO
));
6815 kbd_buffer_store_event (&event
);
6822 kbd_buffer_store_event (&event
);
6827 /* Read any terminal input already buffered up by the system
6828 into the kbd_buffer, but do not wait.
6830 EXPECTED should be nonzero if the caller knows there is some input.
6832 Returns the number of keyboard chars read, or -1 meaning
6833 this is a bad time to try to read input. */
6836 read_avail_input (int expected
)
6842 /* Store pending user signal events, if any. */
6843 if (store_user_signal_events ())
6846 /* Loop through the available terminals, and call their input hooks. */
6850 struct terminal
*next
= t
->next_terminal
;
6852 if (t
->read_socket_hook
)
6855 struct input_event hold_quit
;
6857 EVENT_INIT (hold_quit
);
6858 hold_quit
.kind
= NO_EVENT
;
6860 /* No need for FIONREAD or fcntl; just say don't wait. */
6861 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6867 if (nr
== -1) /* Not OK to read input now. */
6871 else if (nr
== -2) /* Non-transient error. */
6873 /* The terminal device terminated; it should be closed. */
6875 /* Kill Emacs if this was our last terminal. */
6876 if (!terminal_list
->next_terminal
)
6877 /* Formerly simply reported no input, but that
6878 sometimes led to a failure of Emacs to terminate.
6879 SIGHUP seems appropriate if we can't reach the
6881 /* ??? Is it really right to send the signal just to
6882 this process rather than to the whole process
6883 group? Perhaps on systems with FIONREAD Emacs is
6884 alone in its group. */
6885 kill (getpid (), SIGHUP
);
6887 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6890 XSETTERMINAL (tmp
, t
);
6891 Fdelete_terminal (tmp
, Qnoelisp
);
6895 if (hold_quit
.kind
!= NO_EVENT
)
6896 kbd_buffer_store_event (&hold_quit
);
6905 frame_make_pointer_visible ();
6911 decode_keyboard_code (struct tty_display_info
*tty
,
6912 struct coding_system
*coding
,
6913 unsigned char *buf
, int nbytes
)
6915 unsigned char *src
= buf
;
6916 const unsigned char *p
;
6921 if (tty
->meta_key
!= 2)
6922 for (i
= 0; i
< nbytes
; i
++)
6924 if (coding
->carryover_bytes
> 0)
6926 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6927 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6928 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6929 nbytes
+= coding
->carryover_bytes
;
6931 coding
->destination
= alloca (nbytes
* 4);
6932 coding
->dst_bytes
= nbytes
* 4;
6933 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6934 if (coding
->produced_char
== 0)
6936 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6938 struct input_event event_buf
;
6940 EVENT_INIT (event_buf
);
6941 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6943 (ASCII_CHAR_P (event_buf
.code
)
6944 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6945 /* See the comment in tty_read_avail_input. */
6946 event_buf
.frame_or_window
= tty
->top_frame
;
6947 event_buf
.arg
= Qnil
;
6948 kbd_buffer_store_event (&event_buf
);
6952 /* This is the tty way of reading available input.
6954 Note that each terminal device has its own `struct terminal' object,
6955 and so this function is called once for each individual termcap
6956 terminal. The first parameter indicates which terminal to read from. */
6959 tty_read_avail_input (struct terminal
*terminal
,
6961 struct input_event
*hold_quit
)
6963 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6964 the kbd_buffer can really hold. That may prevent loss
6965 of characters on some systems when input is stuffed at us. */
6966 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6968 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6971 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6973 if (kbd_on_hold_p () || buffer_free
<= 0)
6975 #endif /* subprocesses */
6977 if (!terminal
->name
) /* Don't read from a dead terminal. */
6980 if (terminal
->type
!= output_termcap
6981 && terminal
->type
!= output_msdos_raw
)
6984 /* XXX I think the following code should be moved to separate hook
6985 functions in system-dependent files. */
6988 #else /* not WINDOWSNT */
6989 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6993 return 0; /* The terminal is suspended. */
6996 n_to_read
= dos_keysns ();
7000 cbuf
[0] = dos_keyread ();
7003 #else /* not MSDOS */
7008 struct input_event gpm_hold_quit
;
7009 int gpm
, fd
= gpm_fd
;
7011 EVENT_INIT (gpm_hold_quit
);
7012 gpm_hold_quit
.kind
= NO_EVENT
;
7014 /* gpm==1 if event received.
7015 gpm==0 if the GPM daemon has closed the connection, in which case
7016 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7017 we save it in `fd' so close_gpm can remove it from the
7019 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7020 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7021 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7024 /* Presumably the GPM daemon has closed the connection. */
7026 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7027 kbd_buffer_store_event (&gpm_hold_quit
);
7031 #endif /* HAVE_GPM */
7033 /* Determine how many characters we should *try* to read. */
7035 /* Find out how much input is available. */
7036 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7038 if (! noninteractive
)
7039 return -2; /* Close this terminal. */
7045 if (n_to_read
> sizeof cbuf
)
7046 n_to_read
= sizeof cbuf
;
7047 #else /* no FIONREAD */
7048 #if defined (USG) || defined (CYGWIN)
7049 /* Read some input if available, but don't wait. */
7050 n_to_read
= sizeof cbuf
;
7051 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7058 /* Don't read more than we can store. */
7059 if (n_to_read
> buffer_free
)
7060 n_to_read
= buffer_free
;
7061 #endif /* subprocesses */
7063 /* Now read; for one reason or another, this will not block.
7064 NREAD is set to the number of chars read. */
7067 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7068 /* POSIX infers that processes which are not in the session leader's
7069 process group won't get SIGHUP's at logout time. BSDI adheres to
7070 this part standard and returns -1 from read (0) with errno==EIO
7071 when the control tty is taken away.
7072 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7073 if (nread
== -1 && errno
== EIO
)
7074 return -2; /* Close this terminal. */
7075 #if defined (AIX) && defined (_BSD)
7076 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7077 This looks incorrect, but it isn't, because _BSD causes
7078 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7079 and that causes a value other than 0 when there is no input. */
7081 return -2; /* Close this terminal. */
7085 /* We used to retry the read if it was interrupted.
7086 But this does the wrong thing when O_NDELAY causes
7087 an EAGAIN error. Does anybody know of a situation
7088 where a retry is actually needed? */
7090 nread
< 0 && (errno
== EAGAIN
7104 #if defined (USG) || defined (CYGWIN)
7105 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7106 #endif /* USG or CYGWIN */
7107 #endif /* no FIONREAD */
7112 #endif /* not MSDOS */
7113 #endif /* not WINDOWSNT */
7115 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7116 & CODING_REQUIRE_DECODING_MASK
)
7118 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7121 /* Decode the key sequence except for those with meta
7123 for (i
= from
= 0; ; i
++)
7124 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7126 struct input_event buf
;
7128 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7133 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7134 buf
.modifiers
= meta_modifier
;
7135 buf
.code
= cbuf
[i
] & ~0x80;
7136 /* See the comment below. */
7137 buf
.frame_or_window
= tty
->top_frame
;
7139 kbd_buffer_store_event (&buf
);
7145 for (i
= 0; i
< nread
; i
++)
7147 struct input_event buf
;
7149 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7151 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7152 buf
.modifiers
= meta_modifier
;
7153 if (tty
->meta_key
!= 2)
7157 /* Set the frame corresponding to the active tty. Note that the
7158 value of selected_frame is not reliable here, redisplay tends
7159 to temporarily change it. */
7160 buf
.frame_or_window
= tty
->top_frame
;
7163 kbd_buffer_store_event (&buf
);
7164 /* Don't look at input that follows a C-g too closely.
7165 This reduces lossage due to autorepeat on C-g. */
7166 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7167 && buf
.code
== quit_char
)
7174 #if defined SYNC_INPUT || defined SIGIO
7176 handle_async_input (void)
7178 interrupt_input_pending
= 0;
7180 pending_signals
= pending_atimers
;
7182 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7183 doing anything dangerous. */
7190 nread
= read_avail_input (1);
7191 /* -1 means it's not ok to read the input now.
7192 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7193 0 means there was no keyboard input available. */
7201 #endif /* SYNC_INPUT || SIGIO */
7205 process_pending_signals (void)
7207 if (interrupt_input_pending
)
7208 handle_async_input ();
7209 do_pending_atimers ();
7213 #ifdef SIGIO /* for entire page */
7214 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7217 input_available_signal (int signo
)
7219 /* Must preserve main program's value of errno. */
7220 int old_errno
= errno
;
7221 SIGNAL_THREAD_CHECK (signo
);
7224 interrupt_input_pending
= 1;
7225 pending_signals
= 1;
7228 if (input_available_clear_time
)
7229 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7232 handle_async_input ();
7239 /* Send ourselves a SIGIO.
7241 This function exists so that the UNBLOCK_INPUT macro in
7242 blockinput.h can have some way to take care of input we put off
7243 dealing with, without assuming that every file which uses
7244 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7246 reinvoke_input_signal (void)
7249 handle_async_input ();
7255 /* User signal events. */
7257 struct user_signal_info
7259 /* Signal number. */
7262 /* Name of the signal. */
7265 /* Number of pending signals. */
7268 struct user_signal_info
*next
;
7271 /* List of user signals. */
7272 static struct user_signal_info
*user_signals
= NULL
;
7275 add_user_signal (int sig
, const char *name
)
7277 struct user_signal_info
*p
;
7279 for (p
= user_signals
; p
; p
= p
->next
)
7281 /* Already added. */
7284 p
= xmalloc (sizeof (struct user_signal_info
));
7286 p
->name
= xstrdup (name
);
7288 p
->next
= user_signals
;
7291 signal (sig
, handle_user_signal
);
7295 handle_user_signal (int sig
)
7297 int old_errno
= errno
;
7298 struct user_signal_info
*p
;
7299 const char *special_event_name
= NULL
;
7301 SIGNAL_THREAD_CHECK (sig
);
7303 if (SYMBOLP (Vdebug_on_event
))
7304 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7306 for (p
= user_signals
; p
; p
= p
->next
)
7309 if (special_event_name
7310 && strcmp (special_event_name
, p
->name
) == 0)
7312 /* Enter the debugger in many ways. */
7313 debug_on_next_call
= 1;
7316 Vinhibit_quit
= Qnil
;
7318 /* Eat the event. */
7324 if (interrupt_input
)
7325 kill (getpid (), SIGIO
);
7329 /* Tell wait_reading_process_output that it needs to wake
7330 up and look around. */
7331 if (input_available_clear_time
)
7332 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7341 find_user_signal_name (int sig
)
7343 struct user_signal_info
*p
;
7345 for (p
= user_signals
; p
; p
= p
->next
)
7353 store_user_signal_events (void)
7355 struct user_signal_info
*p
;
7356 struct input_event buf
;
7359 for (p
= user_signals
; p
; p
= p
->next
)
7360 if (p
->npending
> 0)
7366 memset (&buf
, 0, sizeof buf
);
7367 buf
.kind
= USER_SIGNAL_EVENT
;
7368 buf
.frame_or_window
= selected_frame
;
7370 nstored
+= p
->npending
;
7372 mask
= sigblock (sigmask (p
->sig
));
7376 kbd_buffer_store_event (&buf
);
7379 while (p
->npending
> 0);
7387 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7388 static Lisp_Object menu_bar_one_keymap_changed_items
;
7390 /* These variables hold the vector under construction within
7391 menu_bar_items and its subroutines, and the current index
7392 for storing into that vector. */
7393 static Lisp_Object menu_bar_items_vector
;
7394 static int menu_bar_items_index
;
7397 static const char* separator_names
[] = {
7402 "single-dashed-line",
7403 "double-dashed-line",
7405 "shadow-etched-out",
7406 "shadow-etched-in-dash",
7407 "shadow-etched-out-dash",
7408 "shadow-double-etched-in",
7409 "shadow-double-etched-out",
7410 "shadow-double-etched-in-dash",
7411 "shadow-double-etched-out-dash",
7415 /* Return non-zero if LABEL specifies a separator. */
7418 menu_separator_name_p (const char *label
)
7422 else if (strlen (label
) > 3
7423 && strncmp (label
, "--", 2) == 0
7428 for (i
= 0; separator_names
[i
]; ++i
)
7429 if (strcmp (label
, separator_names
[i
]) == 0)
7434 /* It's a separator if it contains only dashes. */
7435 while (*label
== '-')
7437 return (*label
== 0);
7444 /* Return a vector of menu items for a menu bar, appropriate
7445 to the current buffer. Each item has three elements in the vector:
7448 OLD is an old vector we can optionally reuse, or nil. */
7451 menu_bar_items (Lisp_Object old
)
7453 /* The number of keymaps we're scanning right now, and the number of
7454 keymaps we have allocated space for. */
7457 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7458 in the current keymaps, or nil where it is not a prefix. */
7461 Lisp_Object def
, tail
;
7466 /* In order to build the menus, we need to call the keymap
7467 accessors. They all call QUIT. But this function is called
7468 during redisplay, during which a quit is fatal. So inhibit
7469 quitting while building the menus.
7470 We do this instead of specbind because (1) errors will clear it anyway
7471 and (2) this avoids risk of specpdl overflow. */
7472 oquit
= Vinhibit_quit
;
7476 menu_bar_items_vector
= old
;
7478 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7479 menu_bar_items_index
= 0;
7481 /* Build our list of keymaps.
7482 If we recognize a function key and replace its escape sequence in
7483 keybuf with its symbol, or if the sequence starts with a mouse
7484 click and we need to switch buffers, we jump back here to rebuild
7485 the initial keymaps from the current buffer. */
7489 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7490 if (!NILP (Voverriding_local_map_menu_flag
))
7492 /* Yes, use them (if non-nil) as well as the global map. */
7493 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7495 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7496 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7497 if (!NILP (Voverriding_local_map
))
7498 maps
[nmaps
++] = Voverriding_local_map
;
7502 /* No, so use major and minor mode keymaps and keymap property.
7503 Note that menu-bar bindings in the local-map and keymap
7504 properties may not work reliable, as they are only
7505 recognized when the menu-bar (or mode-line) is updated,
7506 which does not normally happen after every command. */
7509 nminor
= current_minor_maps (NULL
, &tmaps
);
7510 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7512 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7513 maps
[nmaps
++] = tem
;
7514 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7516 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7518 maps
[nmaps
++] = current_global_map
;
7521 /* Look up in each map the dummy prefix key `menu-bar'. */
7523 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7524 if (!NILP (maps
[mapno
]))
7526 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7530 menu_bar_one_keymap_changed_items
= Qnil
;
7531 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7535 /* Move to the end those items that should be at the end. */
7537 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7540 int end
= menu_bar_items_index
;
7542 for (i
= 0; i
< end
; i
+= 4)
7543 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7545 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7546 /* Move the item at index I to the end,
7547 shifting all the others forward. */
7548 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7549 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7550 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7551 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7553 memmove (&AREF (menu_bar_items_vector
, i
),
7554 &AREF (menu_bar_items_vector
, i
+ 4),
7555 (end
- i
- 4) * sizeof (Lisp_Object
));
7556 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7557 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7558 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7559 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7564 /* Add nil, nil, nil, nil at the end. */
7566 int i
= menu_bar_items_index
;
7567 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7568 menu_bar_items_vector
=
7569 larger_vector (menu_bar_items_vector
, 4, -1);
7570 /* Add this item. */
7571 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7572 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7573 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7574 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7575 menu_bar_items_index
= i
;
7578 Vinhibit_quit
= oquit
;
7579 return menu_bar_items_vector
;
7582 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7583 If there's already an item for KEY, add this DEF to it. */
7585 Lisp_Object item_properties
;
7588 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7590 struct gcpro gcpro1
;
7594 if (EQ (item
, Qundefined
))
7596 /* If a map has an explicit `undefined' as definition,
7597 discard any previously made menu bar item. */
7599 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7600 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7602 if (menu_bar_items_index
> i
+ 4)
7603 memmove (&AREF (menu_bar_items_vector
, i
),
7604 &AREF (menu_bar_items_vector
, i
+ 4),
7605 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7606 menu_bar_items_index
-= 4;
7610 /* If this keymap has already contributed to this KEY,
7611 don't contribute to it a second time. */
7612 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7613 if (!NILP (tem
) || NILP (item
))
7616 menu_bar_one_keymap_changed_items
7617 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7619 /* We add to menu_bar_one_keymap_changed_items before doing the
7620 parse_menu_item, so that if it turns out it wasn't a menu item,
7621 it still correctly hides any further menu item. */
7623 i
= parse_menu_item (item
, 1);
7628 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7630 /* Find any existing item for this KEY. */
7631 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7632 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7635 /* If we did not find this KEY, add it at the end. */
7636 if (i
== menu_bar_items_index
)
7638 /* If vector is too small, get a bigger one. */
7639 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7640 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7641 /* Add this item. */
7642 ASET (menu_bar_items_vector
, i
, key
); i
++;
7643 ASET (menu_bar_items_vector
, i
,
7644 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7645 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7646 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7647 menu_bar_items_index
= i
;
7649 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7653 old
= AREF (menu_bar_items_vector
, i
+ 2);
7654 /* If the new and the old items are not both keymaps,
7655 the lookup will only find `item'. */
7656 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7657 ASET (menu_bar_items_vector
, i
+ 2, item
);
7661 /* This is used as the handler when calling menu_item_eval_property. */
7663 menu_item_eval_property_1 (Lisp_Object arg
)
7665 /* If we got a quit from within the menu computation,
7666 quit all the way out of it. This takes care of C-] in the debugger. */
7667 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7668 Fsignal (Qquit
, Qnil
);
7674 eval_dyn (Lisp_Object form
)
7676 return Feval (form
, Qnil
);
7679 /* Evaluate an expression and return the result (or nil if something
7680 went wrong). Used to evaluate dynamic parts of menu items. */
7682 menu_item_eval_property (Lisp_Object sexpr
)
7684 ptrdiff_t count
= SPECPDL_INDEX ();
7686 specbind (Qinhibit_redisplay
, Qt
);
7687 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7688 menu_item_eval_property_1
);
7689 return unbind_to (count
, val
);
7692 /* This function parses a menu item and leaves the result in the
7693 vector item_properties.
7694 ITEM is a key binding, a possible menu item.
7695 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7697 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7698 parse_menu_item returns true if the item is a menu item and false
7702 parse_menu_item (Lisp_Object item
, int inmenubar
)
7704 Lisp_Object def
, tem
, item_string
, start
;
7706 Lisp_Object keyhint
;
7715 /* Create item_properties vector if necessary. */
7716 if (NILP (item_properties
))
7718 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7720 /* Initialize optional entries. */
7721 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7722 ASET (item_properties
, i
, Qnil
);
7723 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7725 /* Save the item here to protect it from GC. */
7726 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7728 item_string
= XCAR (item
);
7732 if (STRINGP (item_string
))
7734 /* Old format menu item. */
7735 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7737 /* Maybe help string. */
7738 if (CONSP (item
) && STRINGP (XCAR (item
)))
7740 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7745 /* Maybe an obsolete key binding cache. */
7746 if (CONSP (item
) && CONSP (XCAR (item
))
7747 && (NILP (XCAR (XCAR (item
)))
7748 || VECTORP (XCAR (XCAR (item
)))))
7751 /* This is the real definition--the function to run. */
7752 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7754 /* Get enable property, if any. */
7757 tem
= Fget (item
, Qmenu_enable
);
7758 if (!NILP (Venable_disabled_menus_and_buttons
))
7759 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7760 else if (!NILP (tem
))
7761 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7764 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7766 /* New format menu item. */
7767 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7768 start
= XCDR (item
);
7771 /* We have a real binding. */
7772 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7774 item
= XCDR (start
);
7775 /* Is there an obsolete cache list with key equivalences. */
7776 if (CONSP (item
) && CONSP (XCAR (item
)))
7779 /* Parse properties. */
7780 while (CONSP (item
) && CONSP (XCDR (item
)))
7785 if (EQ (tem
, QCenable
))
7787 if (!NILP (Venable_disabled_menus_and_buttons
))
7788 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7790 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7792 else if (EQ (tem
, QCvisible
))
7794 /* If got a visible property and that evaluates to nil
7795 then ignore this item. */
7796 tem
= menu_item_eval_property (XCAR (item
));
7800 else if (EQ (tem
, QChelp
))
7801 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7802 else if (EQ (tem
, QCfilter
))
7804 else if (EQ (tem
, QCkey_sequence
))
7807 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7808 /* Be GC protected. Set keyhint to item instead of tem. */
7811 else if (EQ (tem
, QCkeys
))
7814 if (CONSP (tem
) || STRINGP (tem
))
7815 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7817 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7822 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7824 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7826 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7832 else if (inmenubar
|| !NILP (start
))
7836 return 0; /* not a menu item */
7838 /* If item string is not a string, evaluate it to get string.
7839 If we don't get a string, skip this item. */
7840 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7841 if (!(STRINGP (item_string
)))
7843 item_string
= menu_item_eval_property (item_string
);
7844 if (!STRINGP (item_string
))
7846 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7849 /* If got a filter apply it on definition. */
7850 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7853 def
= menu_item_eval_property (list2 (XCAR (filter
),
7854 list2 (Qquote
, def
)));
7856 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7859 /* Enable or disable selection of item. */
7860 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7863 tem
= menu_item_eval_property (tem
);
7864 if (inmenubar
&& NILP (tem
))
7865 return 0; /* Ignore disabled items in menu bar. */
7866 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7869 /* If we got no definition, this item is just unselectable text which
7870 is OK in a submenu but not in the menubar. */
7872 return (!inmenubar
);
7874 /* See if this is a separate pane or a submenu. */
7875 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7876 tem
= get_keymap (def
, 0, 1);
7877 /* For a subkeymap, just record its details and exit. */
7880 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7881 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7885 /* At the top level in the menu bar, do likewise for commands also.
7886 The menu bar does not display equivalent key bindings anyway.
7887 ITEM_PROPERTY_DEF is already set up properly. */
7891 { /* This is a command. See if there is an equivalent key binding. */
7892 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7894 /* The previous code preferred :key-sequence to :keys, so we
7895 preserve this behavior. */
7896 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7897 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7900 Lisp_Object prefix
= keyeq
;
7901 Lisp_Object keys
= Qnil
;
7905 def
= XCAR (prefix
);
7906 prefix
= XCDR (prefix
);
7909 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7911 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7913 keys
= XCAR (keyhint
);
7914 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7916 /* We have a suggested key. Is it bound to the command? */
7919 /* If the command is an alias for another
7920 (such as lmenu.el set it up), check if the
7921 original command matches the cached command. */
7922 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7927 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7931 tem
= Fkey_description (keys
, Qnil
);
7934 if (STRINGP (XCAR (prefix
)))
7935 tem
= concat2 (XCAR (prefix
), tem
);
7936 if (STRINGP (XCDR (prefix
)))
7937 tem
= concat2 (tem
, XCDR (prefix
));
7939 keyeq
= concat2 (build_string (" "), tem
);
7940 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7946 /* If we have an equivalent key binding, use that. */
7947 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7950 /* Include this when menu help is implemented.
7951 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7952 if (!(NILP (tem) || STRINGP (tem)))
7954 tem = menu_item_eval_property (tem);
7957 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7961 /* Handle radio buttons or toggle boxes. */
7962 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7964 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7965 menu_item_eval_property (tem
));
7972 /***********************************************************************
7974 ***********************************************************************/
7976 /* A vector holding tool bar items while they are parsed in function
7977 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7980 static Lisp_Object tool_bar_items_vector
;
7982 /* A vector holding the result of parse_tool_bar_item. Layout is like
7983 the one for a single item in tool_bar_items_vector. */
7985 static Lisp_Object tool_bar_item_properties
;
7987 /* Next free index in tool_bar_items_vector. */
7989 static int ntool_bar_items
;
7991 /* The symbols `:image' and `:rtl'. */
7993 static Lisp_Object QCimage
;
7994 static Lisp_Object QCrtl
;
7996 /* Function prototypes. */
7998 static void init_tool_bar_items (Lisp_Object
);
7999 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8000 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8001 static void append_tool_bar_item (void);
8004 /* Return a vector of tool bar items for keymaps currently in effect.
8005 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8006 tool bar items found. */
8009 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8018 /* In order to build the menus, we need to call the keymap
8019 accessors. They all call QUIT. But this function is called
8020 during redisplay, during which a quit is fatal. So inhibit
8021 quitting while building the menus. We do this instead of
8022 specbind because (1) errors will clear it anyway and (2) this
8023 avoids risk of specpdl overflow. */
8024 oquit
= Vinhibit_quit
;
8027 /* Initialize tool_bar_items_vector and protect it from GC. */
8028 init_tool_bar_items (reuse
);
8030 /* Build list of keymaps in maps. Set nmaps to the number of maps
8033 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8034 if (!NILP (Voverriding_local_map_menu_flag
))
8036 /* Yes, use them (if non-nil) as well as the global map. */
8037 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8039 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8040 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8041 if (!NILP (Voverriding_local_map
))
8042 maps
[nmaps
++] = Voverriding_local_map
;
8046 /* No, so use major and minor mode keymaps and keymap property.
8047 Note that tool-bar bindings in the local-map and keymap
8048 properties may not work reliable, as they are only
8049 recognized when the tool-bar (or mode-line) is updated,
8050 which does not normally happen after every command. */
8053 nminor
= current_minor_maps (NULL
, &tmaps
);
8054 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8056 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8057 maps
[nmaps
++] = tem
;
8058 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8060 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8063 /* Add global keymap at the end. */
8064 maps
[nmaps
++] = current_global_map
;
8066 /* Process maps in reverse order and look up in each map the prefix
8068 for (i
= nmaps
- 1; i
>= 0; --i
)
8069 if (!NILP (maps
[i
]))
8073 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8075 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8078 Vinhibit_quit
= oquit
;
8079 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8080 return tool_bar_items_vector
;
8084 /* Process the definition of KEY which is DEF. */
8087 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8090 struct gcpro gcpro1
, gcpro2
;
8092 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8096 if (EQ (def
, Qundefined
))
8098 /* If a map has an explicit `undefined' as definition,
8099 discard any previously made item. */
8100 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8102 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8104 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8106 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8107 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8108 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8109 * sizeof (Lisp_Object
)));
8110 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8115 else if (parse_tool_bar_item (key
, def
))
8116 /* Append a new tool bar item to tool_bar_items_vector. Accept
8117 more than one definition for the same key. */
8118 append_tool_bar_item ();
8124 /* Parse a tool bar item specification ITEM for key KEY and return the
8125 result in tool_bar_item_properties. Value is zero if ITEM is
8128 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8130 CAPTION is the caption of the item, If it's not a string, it is
8131 evaluated to get a string.
8133 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8134 as binding are currently ignored.
8136 The following properties are recognized:
8140 FORM is evaluated and specifies whether the tool bar item is
8141 enabled or disabled.
8145 FORM is evaluated and specifies whether the tool bar item is visible.
8147 - `:filter FUNCTION'
8149 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8150 result is stored as the new binding.
8152 - `:button (TYPE SELECTED)'
8154 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8155 and specifies whether the button is selected (pressed) or not.
8159 IMAGES is either a single image specification or a vector of four
8160 image specifications. See enum tool_bar_item_images.
8162 - `:help HELP-STRING'.
8164 Gives a help string to display for the tool bar item.
8166 - `:label LABEL-STRING'.
8168 A text label to show with the tool bar button if labels are enabled. */
8171 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8173 /* Access slot with index IDX of vector tool_bar_item_properties. */
8174 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8176 Lisp_Object filter
= Qnil
;
8177 Lisp_Object caption
;
8178 int i
, have_label
= 0;
8180 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8181 Rule out items that aren't lists, don't start with
8182 `menu-item' or whose rest following `tool-bar-item' is not a
8187 /* As an exception, allow old-style menu separators. */
8188 if (STRINGP (XCAR (item
)))
8189 item
= Fcons (XCAR (item
), Qnil
);
8190 else if (!EQ (XCAR (item
), Qmenu_item
)
8191 || (item
= XCDR (item
), !CONSP (item
)))
8194 /* Create tool_bar_item_properties vector if necessary. Reset it to
8196 if (VECTORP (tool_bar_item_properties
))
8198 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8202 tool_bar_item_properties
8203 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8206 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8207 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8209 /* Get the caption of the item. If the caption is not a string,
8210 evaluate it to get a string. If we don't get a string, skip this
8212 caption
= XCAR (item
);
8213 if (!STRINGP (caption
))
8215 caption
= menu_item_eval_property (caption
);
8216 if (!STRINGP (caption
))
8219 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8221 /* If the rest following the caption is not a list, the menu item is
8222 either a separator, or invalid. */
8226 if (menu_separator_name_p (SSDATA (caption
)))
8228 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8229 #if !defined (USE_GTK) && !defined (HAVE_NS)
8230 /* If we use build_desired_tool_bar_string to render the
8231 tool bar, the separator is rendered as an image. */
8232 PROP (TOOL_BAR_ITEM_IMAGES
)
8233 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8234 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8235 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8236 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8243 /* Store the binding. */
8244 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8247 /* Ignore cached key binding, if any. */
8248 if (CONSP (item
) && CONSP (XCAR (item
)))
8251 /* Process the rest of the properties. */
8252 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8254 Lisp_Object ikey
, value
;
8257 value
= XCAR (XCDR (item
));
8259 if (EQ (ikey
, QCenable
))
8261 /* `:enable FORM'. */
8262 if (!NILP (Venable_disabled_menus_and_buttons
))
8263 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8265 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8267 else if (EQ (ikey
, QCvisible
))
8269 /* `:visible FORM'. If got a visible property and that
8270 evaluates to nil then ignore this item. */
8271 if (NILP (menu_item_eval_property (value
)))
8274 else if (EQ (ikey
, QChelp
))
8275 /* `:help HELP-STRING'. */
8276 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8277 else if (EQ (ikey
, QCvert_only
))
8278 /* `:vert-only t/nil'. */
8279 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8280 else if (EQ (ikey
, QClabel
))
8282 const char *bad_label
= "!!?GARBLED ITEM?!!";
8283 /* `:label LABEL-STRING'. */
8284 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8286 : build_string (bad_label
);
8289 else if (EQ (ikey
, QCfilter
))
8290 /* ':filter FORM'. */
8292 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8294 /* `:button (TYPE . SELECTED)'. */
8295 Lisp_Object type
, selected
;
8297 type
= XCAR (value
);
8298 selected
= XCDR (value
);
8299 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8301 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8302 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8305 else if (EQ (ikey
, QCimage
)
8307 || (VECTORP (value
) && ASIZE (value
) == 4)))
8308 /* Value is either a single image specification or a vector
8309 of 4 such specifications for the different button states. */
8310 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8311 else if (EQ (ikey
, QCrtl
))
8313 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8319 /* Try to make one from caption and key. */
8320 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8321 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8322 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8323 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8325 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8326 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8327 Lisp_Object new_lbl
;
8328 ptrdiff_t caption_len
= strlen (capt
);
8330 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8333 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8335 buf
[caption_len
] = '\0';
8339 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8343 strcpy (buf
, label
);
8345 for (j
= 0; buf
[j
] != '\0'; ++j
)
8353 new_lbl
= Fupcase_initials (build_string (label
));
8354 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8355 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8357 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8361 /* If got a filter apply it on binding. */
8363 PROP (TOOL_BAR_ITEM_BINDING
)
8364 = menu_item_eval_property (list2 (filter
,
8366 PROP (TOOL_BAR_ITEM_BINDING
))));
8368 /* See if the binding is a keymap. Give up if it is. */
8369 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8372 /* Enable or disable selection of item. */
8373 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8374 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8375 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8377 /* Handle radio buttons or toggle boxes. */
8378 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8379 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8380 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8388 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8389 that can be reused. */
8392 init_tool_bar_items (Lisp_Object reuse
)
8394 if (VECTORP (reuse
))
8395 tool_bar_items_vector
= reuse
;
8397 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8398 ntool_bar_items
= 0;
8402 /* Append parsed tool bar item properties from
8403 tool_bar_item_properties */
8406 append_tool_bar_item (void)
8408 Lisp_Object
*to
, *from
;
8411 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8413 /* Enlarge tool_bar_items_vector if necessary. */
8415 tool_bar_items_vector
8416 = larger_vector (tool_bar_items_vector
, incr
, -1);
8418 /* Append entries from tool_bar_item_properties to the end of
8419 tool_bar_items_vector. */
8420 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8421 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8422 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8423 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8430 /* Read a character using menus based on maps in the array MAPS.
8431 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8432 Return t if we displayed a menu but the user rejected it.
8434 PREV_EVENT is the previous input event, or nil if we are reading
8435 the first event of a key sequence.
8437 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8438 if we used a mouse menu to read the input, or zero otherwise. If
8439 USED_MOUSE_MENU is null, we don't dereference it.
8441 The prompting is done based on the prompt-string of the map
8442 and the strings associated with various map elements.
8444 This can be done with X menus or with menus put in the minibuf.
8445 These are done in different ways, depending on how the input will be read.
8446 Menus using X are done after auto-saving in read-char, getting the input
8447 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8448 and do auto-saving in the inner call of read_char. */
8451 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8452 Lisp_Object prev_event
, int *used_mouse_menu
)
8456 if (used_mouse_menu
)
8457 *used_mouse_menu
= 0;
8459 /* Use local over global Menu maps */
8461 if (! menu_prompting
)
8464 /* Optionally disregard all but the global map. */
8465 if (inhibit_local_menu_bar_menus
)
8467 maps
+= (nmaps
- 1);
8472 /* If we got to this point via a mouse click,
8473 use a real menu for mouse selection. */
8474 if (EVENT_HAS_PARAMETERS (prev_event
)
8475 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8476 && !EQ (XCAR (prev_event
), Qtool_bar
))
8478 /* Display the menu and get the selection. */
8479 Lisp_Object
*realmaps
8480 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8482 ptrdiff_t nmaps1
= 0;
8484 /* Use the maps that are not nil. */
8485 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8486 if (!NILP (maps
[mapno
]))
8487 realmaps
[nmaps1
++] = maps
[mapno
];
8489 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8494 record_menu_key (XCAR (value
));
8496 /* If we got multiple events, unread all but
8498 There is no way to prevent those unread events
8499 from showing up later in last_nonmenu_event.
8500 So turn symbol and integer events into lists,
8501 to indicate that they came from a mouse menu,
8502 so that when present in last_nonmenu_event
8503 they won't confuse things. */
8504 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8506 record_menu_key (XCAR (tem
));
8507 if (SYMBOLP (XCAR (tem
))
8508 || INTEGERP (XCAR (tem
)))
8509 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8512 /* If we got more than one event, put all but the first
8513 onto this list to be read later.
8514 Return just the first event now. */
8515 Vunread_command_events
8516 = nconc2 (XCDR (value
), Vunread_command_events
);
8517 value
= XCAR (value
);
8519 else if (NILP (value
))
8521 if (used_mouse_menu
)
8522 *used_mouse_menu
= 1;
8525 #endif /* HAVE_MENUS */
8529 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8530 We make this bigger when necessary, and never free it. */
8531 static char *read_char_minibuf_menu_text
;
8532 /* Size of that buffer. */
8533 static ptrdiff_t read_char_minibuf_menu_width
;
8536 read_char_minibuf_menu_prompt (int commandflag
,
8537 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8540 register Lisp_Object name
;
8542 /* FIXME: Use the minibuffer's frame width. */
8543 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8546 Lisp_Object rest
, vector
;
8552 if (! menu_prompting
)
8555 /* Get the menu name from the first map that has one (a prompt string). */
8556 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8558 name
= Fkeymap_prompt (maps
[mapno
]);
8563 /* If we don't have any menus, just read a character normally. */
8564 if (!STRINGP (name
))
8567 /* Make sure we have a big enough buffer for the menu text. */
8568 width
= max (width
, SBYTES (name
));
8569 if (STRING_BYTES_BOUND
- 4 < width
)
8570 memory_full (SIZE_MAX
);
8571 if (width
+ 4 > read_char_minibuf_menu_width
)
8573 read_char_minibuf_menu_text
8574 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8575 read_char_minibuf_menu_width
= width
+ 4;
8577 menu
= read_char_minibuf_menu_text
;
8579 /* Prompt string always starts with map's prompt, and a space. */
8580 strcpy (menu
, SSDATA (name
));
8581 nlength
= SBYTES (name
);
8582 menu
[nlength
++] = ':';
8583 menu
[nlength
++] = ' ';
8586 /* Start prompting at start of first map. */
8590 /* Present the documented bindings, a line at a time. */
8594 ptrdiff_t i
= nlength
;
8596 Lisp_Object orig_defn_macro
;
8598 /* Loop over elements of map. */
8603 /* If reached end of map, start at beginning of next map. */
8607 /* At end of last map, wrap around to first map if just starting,
8608 or end this line if already have something on it. */
8612 if (notfirst
|| nobindings
) break;
8617 /* Look at the next element of the map. */
8619 elt
= AREF (vector
, idx
);
8621 elt
= Fcar_safe (rest
);
8623 if (idx
< 0 && VECTORP (elt
))
8625 /* If we found a dense table in the keymap,
8626 advanced past it, but start scanning its contents. */
8627 rest
= Fcdr_safe (rest
);
8633 /* An ordinary element. */
8634 Lisp_Object event
, tem
;
8638 event
= Fcar_safe (elt
); /* alist */
8639 elt
= Fcdr_safe (elt
);
8643 XSETINT (event
, idx
); /* vector */
8646 /* Ignore the element if it has no prompt string. */
8647 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8649 /* 1 if the char to type matches the string. */
8651 Lisp_Object upcased_event
, downcased_event
;
8652 Lisp_Object desc
= Qnil
;
8654 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8656 upcased_event
= Fupcase (event
);
8657 downcased_event
= Fdowncase (event
);
8658 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8659 || XINT (downcased_event
) == SREF (s
, 0));
8661 desc
= Fsingle_key_description (event
, Qnil
);
8663 #if 0 /* It is redundant to list the equivalent key bindings because
8664 the prefix is what the user has already typed. */
8666 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8668 /* Insert equivalent keybinding. */
8669 s
= concat2 (s
, tem
);
8672 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8673 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8675 /* Insert button prefix. */
8676 Lisp_Object selected
8677 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8678 if (EQ (tem
, QCradio
))
8679 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8681 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8682 s
= concat2 (tem
, s
);
8686 /* If we have room for the prompt string, add it to this line.
8687 If this is the first on the line, always add it. */
8688 if ((SCHARS (s
) + i
+ 2
8689 + (char_matches
? 0 : SCHARS (desc
) + 3))
8693 ptrdiff_t thiswidth
;
8695 /* Punctuate between strings. */
8698 strcpy (menu
+ i
, ", ");
8704 /* If the char to type doesn't match the string's
8705 first char, explicitly show what char to type. */
8708 /* Add as much of string as fits. */
8709 thiswidth
= min (SCHARS (desc
), width
- i
);
8710 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8712 strcpy (menu
+ i
, " = ");
8716 /* Add as much of string as fits. */
8717 thiswidth
= min (SCHARS (s
), width
- i
);
8718 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8724 /* If this element does not fit, end the line now,
8725 and save the element for the next line. */
8726 strcpy (menu
+ i
, "...");
8731 /* Move past this element. */
8732 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8733 /* Handle reaching end of dense table. */
8738 rest
= Fcdr_safe (rest
);
8742 /* Prompt with that and read response. */
8743 message2_nolog (menu
, strlen (menu
),
8744 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8746 /* Make believe its not a keyboard macro in case the help char
8747 is pressed. Help characters are not recorded because menu prompting
8748 is not used on replay.
8750 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8751 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8753 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8754 while (BUFFERP (obj
));
8755 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8757 if (!INTEGERP (obj
))
8759 else if (XINT (obj
) == -2)
8762 if (! EQ (obj
, menu_prompt_more_char
)
8763 && (!INTEGERP (menu_prompt_more_char
)
8764 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8766 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8767 store_kbd_macro_char (obj
);
8770 /* Help char - go round again */
8774 /* Reading key sequences. */
8776 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8777 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8778 keymap, or nil otherwise. Return the index of the first keymap in
8779 which KEY has any binding, or NMAPS if no map has a binding.
8781 If KEY is a meta ASCII character, treat it like meta-prefix-char
8782 followed by the corresponding non-meta character. Keymaps in
8783 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8786 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8789 NEXT may be the same array as CURRENT. */
8792 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8793 Lisp_Object
*defs
, Lisp_Object
*next
)
8795 ptrdiff_t i
, first_binding
;
8797 first_binding
= nmaps
;
8798 for (i
= nmaps
- 1; i
>= 0; i
--)
8800 if (! NILP (current
[i
]))
8802 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8803 if (! NILP (defs
[i
]))
8810 /* Given the set of bindings we've found, produce the next set of maps. */
8811 if (first_binding
< nmaps
)
8812 for (i
= 0; i
< nmaps
; i
++)
8813 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8815 return first_binding
;
8818 /* Structure used to keep track of partial application of key remapping
8819 such as Vfunction_key_map and Vkey_translation_map. */
8820 typedef struct keyremap
8822 /* This is the map originally specified for this use. */
8824 /* This is a submap reached by looking up, in PARENT,
8825 the events from START to END. */
8827 /* Positions [START, END) in the key sequence buffer
8828 are the key that we have scanned so far.
8829 Those events are the ones that we will replace
8830 if PARENT maps them into a key sequence. */
8834 /* Lookup KEY in MAP.
8835 MAP is a keymap mapping keys to key vectors or functions.
8836 If the mapping is a function and DO_FUNCTION is non-zero, then
8837 the function is called with PROMPT as parameter and its return
8838 value is used as the return value of this function (after checking
8839 that it is indeed a vector). */
8842 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8847 next
= access_keymap (map
, key
, 1, 0, 1);
8849 /* Handle symbol with autoload definition. */
8850 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8851 && CONSP (XSYMBOL (next
)->function
)
8852 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8853 do_autoload (XSYMBOL (next
)->function
, next
);
8855 /* Handle a symbol whose function definition is a keymap
8857 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8858 && (ARRAYP (XSYMBOL (next
)->function
)
8859 || KEYMAPP (XSYMBOL (next
)->function
)))
8860 next
= XSYMBOL (next
)->function
;
8862 /* If the keymap gives a function, not an
8863 array, then call the function with one arg and use
8864 its value instead. */
8865 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8870 next
= call1 (next
, prompt
);
8871 /* If the function returned something invalid,
8872 barf--don't ignore it.
8873 (To ignore it safely, we would need to gcpro a bunch of
8874 other variables.) */
8875 if (! (VECTORP (next
) || STRINGP (next
)))
8876 error ("Function %s returns invalid key sequence",
8877 SSDATA (SYMBOL_NAME (tem
)));
8882 /* Do one step of the key remapping used for function-key-map and
8883 key-translation-map:
8884 KEYBUF is the buffer holding the input events.
8885 BUFSIZE is its maximum size.
8886 FKEY is a pointer to the keyremap structure to use.
8887 INPUT is the index of the last element in KEYBUF.
8888 DOIT if non-zero says that the remapping can actually take place.
8889 DIFF is used to return the number of keys added/removed by the remapping.
8890 PARENT is the root of the keymap.
8891 PROMPT is the prompt to use if the remapping happens through a function.
8892 The return value is non-zero if the remapping actually took place. */
8895 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8896 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8898 Lisp_Object next
, key
;
8900 key
= keybuf
[fkey
->end
++];
8902 if (KEYMAPP (fkey
->parent
))
8903 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8907 /* If keybuf[fkey->start..fkey->end] is bound in the
8908 map and we're in a position to do the key remapping, replace it with
8909 the binding and restart with fkey->start at the end. */
8910 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8912 int len
= XFASTINT (Flength (next
));
8915 *diff
= len
- (fkey
->end
- fkey
->start
);
8917 if (bufsize
- input
<= *diff
)
8918 error ("Key sequence too long");
8920 /* Shift the keys that follow fkey->end. */
8922 for (i
= fkey
->end
; i
< input
; i
++)
8923 keybuf
[i
+ *diff
] = keybuf
[i
];
8925 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8926 keybuf
[i
+ *diff
] = keybuf
[i
];
8927 /* Overwrite the old keys with the new ones. */
8928 for (i
= 0; i
< len
; i
++)
8929 keybuf
[fkey
->start
+ i
]
8930 = Faref (next
, make_number (i
));
8932 fkey
->start
= fkey
->end
+= *diff
;
8933 fkey
->map
= fkey
->parent
;
8938 fkey
->map
= get_keymap (next
, 0, 1);
8940 /* If we no longer have a bound suffix, try a new position for
8942 if (!CONSP (fkey
->map
))
8944 fkey
->end
= ++fkey
->start
;
8945 fkey
->map
= fkey
->parent
;
8951 test_undefined (Lisp_Object binding
)
8953 return (EQ (binding
, Qundefined
)
8954 || (!NILP (binding
) && SYMBOLP (binding
)
8955 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8958 /* Read a sequence of keys that ends with a non prefix character,
8959 storing it in KEYBUF, a buffer of size BUFSIZE.
8961 Return the length of the key sequence stored.
8962 Return -1 if the user rejected a command menu.
8964 Echo starting immediately unless `prompt' is 0.
8966 Where a key sequence ends depends on the currently active keymaps.
8967 These include any minor mode keymaps active in the current buffer,
8968 the current buffer's local map, and the global map.
8970 If a key sequence has no other bindings, we check Vfunction_key_map
8971 to see if some trailing subsequence might be the beginning of a
8972 function key's sequence. If so, we try to read the whole function
8973 key, and substitute its symbolic name into the key sequence.
8975 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8976 `double-' events into similar click events, if that would make them
8977 bound. We try to turn `triple-' events first into `double-' events,
8980 If we get a mouse click in a mode line, vertical divider, or other
8981 non-text area, we treat the click as if it were prefixed by the
8982 symbol denoting that area - `mode-line', `vertical-line', or
8985 If the sequence starts with a mouse click, we read the key sequence
8986 with respect to the buffer clicked on, not the current buffer.
8988 If the user switches frames in the midst of a key sequence, we put
8989 off the switch-frame event until later; the next call to
8990 read_char will return it.
8992 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8993 from the selected window's buffer. */
8996 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8997 int dont_downcase_last
, int can_return_switch_frame
,
8998 int fix_current_buffer
)
9000 Lisp_Object from_string
;
9001 ptrdiff_t count
= SPECPDL_INDEX ();
9003 /* How many keys there are in the current key sequence. */
9006 /* The length of the echo buffer when we started reading, and
9007 the length of this_command_keys when we started reading. */
9008 ptrdiff_t echo_start
IF_LINT (= 0);
9009 ptrdiff_t keys_start
;
9011 /* The number of keymaps we're scanning right now, and the number of
9012 keymaps we have allocated space for. */
9014 ptrdiff_t nmaps_allocated
= 0;
9016 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9017 the current keymaps. */
9018 Lisp_Object
*defs
= NULL
;
9020 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9021 in the current keymaps, or nil where it is not a prefix. */
9022 Lisp_Object
*submaps
= NULL
;
9024 /* The local map to start out with at start of key sequence. */
9025 Lisp_Object orig_local_map
;
9027 /* The map from the `keymap' property to start out with at start of
9029 Lisp_Object orig_keymap
;
9031 /* 1 if we have already considered switching to the local-map property
9032 of the place where a mouse click occurred. */
9033 int localized_local_map
= 0;
9035 /* The index in submaps[] of the first keymap that has a binding for
9036 this key sequence. In other words, the lowest i such that
9037 submaps[i] is non-nil. */
9038 ptrdiff_t first_binding
;
9039 /* Index of the first key that has no binding.
9040 It is useless to try fkey.start larger than that. */
9043 /* If t < mock_input, then KEYBUF[t] should be read as the next
9046 We use this to recover after recognizing a function key. Once we
9047 realize that a suffix of the current key sequence is actually a
9048 function key's escape sequence, we replace the suffix with the
9049 function key's binding from Vfunction_key_map. Now keybuf
9050 contains a new and different key sequence, so the echo area,
9051 this_command_keys, and the submaps and defs arrays are wrong. In
9052 this situation, we set mock_input to t, set t to 0, and jump to
9053 restart_sequence; the loop will read keys from keybuf up until
9054 mock_input, thus rebuilding the state; and then it will resume
9055 reading characters from the keyboard. */
9058 /* If the sequence is unbound in submaps[], then
9059 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9060 and fkey.map is its binding.
9062 These might be > t, indicating that all function key scanning
9063 should hold off until t reaches them. We do this when we've just
9064 recognized a function key, to avoid searching for the function
9065 key's again in Vfunction_key_map. */
9068 /* Likewise, for key_translation_map and input-decode-map. */
9069 keyremap keytran
, indec
;
9071 /* Non-zero if we are trying to map a key by changing an upper-case
9072 letter to lower case, or a shifted function key to an unshifted
9074 int shift_translated
= 0;
9076 /* If we receive a `switch-frame' or `select-window' event in the middle of
9077 a key sequence, we put it off for later.
9078 While we're reading, we keep the event here. */
9079 Lisp_Object delayed_switch_frame
;
9081 /* See the comment below... */
9082 #if defined (GOBBLE_FIRST_EVENT)
9083 Lisp_Object first_event
;
9086 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9087 int original_uppercase_position
= -1;
9089 /* Gets around Microsoft compiler limitations. */
9092 struct buffer
*starting_buffer
;
9094 /* List of events for which a fake prefix key has been generated. */
9095 Lisp_Object fake_prefixed_keys
= Qnil
;
9097 #if defined (GOBBLE_FIRST_EVENT)
9101 struct gcpro gcpro1
;
9103 GCPRO1 (fake_prefixed_keys
);
9104 raw_keybuf_count
= 0;
9106 last_nonmenu_event
= Qnil
;
9108 delayed_switch_frame
= Qnil
;
9114 /* Install the string STR as the beginning of the string of
9115 echoing, so that it serves as a prompt for the next
9117 KVAR (current_kboard
, echo_string
) = prompt
;
9118 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9121 else if (cursor_in_echo_area
9122 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9123 && NILP (Fzerop (Vecho_keystrokes
)))
9124 /* This doesn't put in a dash if the echo buffer is empty, so
9125 you don't always see a dash hanging out in the minibuffer. */
9129 /* Record the initial state of the echo area and this_command_keys;
9130 we will need to restore them if we replay a key sequence. */
9132 echo_start
= echo_length ();
9133 keys_start
= this_command_key_count
;
9134 this_single_command_key_start
= keys_start
;
9136 #if defined (GOBBLE_FIRST_EVENT)
9137 /* This doesn't quite work, because some of the things that read_char
9138 does cannot safely be bypassed. It seems too risky to try to make
9141 /* Read the first char of the sequence specially, before setting
9142 up any keymaps, in case a filter runs and switches buffers on us. */
9143 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9145 #endif /* GOBBLE_FIRST_EVENT */
9147 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9148 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9151 /* We jump here when we need to reinitialize fkey and keytran; this
9152 happens if we switch keyboards between rescans. */
9153 replay_entire_sequence
:
9155 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9156 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9157 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9158 indec
.start
= indec
.end
= 0;
9159 fkey
.start
= fkey
.end
= 0;
9160 keytran
.start
= keytran
.end
= 0;
9162 /* We jump here when the key sequence has been thoroughly changed, and
9163 we need to rescan it starting from the beginning. When we jump here,
9164 keybuf[0..mock_input] holds the sequence we should reread. */
9167 starting_buffer
= current_buffer
;
9168 first_unbound
= bufsize
+ 1;
9170 /* Build our list of keymaps.
9171 If we recognize a function key and replace its escape sequence in
9172 keybuf with its symbol, or if the sequence starts with a mouse
9173 click and we need to switch buffers, we jump back here to rebuild
9174 the initial keymaps from the current buffer. */
9177 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9179 if (2 > nmaps_allocated
)
9181 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9182 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9183 nmaps_allocated
= 2;
9185 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9187 else if (!NILP (Voverriding_local_map
))
9189 if (2 > nmaps_allocated
)
9191 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9192 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9193 nmaps_allocated
= 2;
9195 submaps
[nmaps
++] = Voverriding_local_map
;
9203 nminor
= current_minor_maps (0, &maps
);
9204 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9206 if (total
> nmaps_allocated
)
9208 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9209 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9210 nmaps_allocated
= total
;
9213 if (!NILP (orig_keymap
))
9214 submaps
[nmaps
++] = orig_keymap
;
9216 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9220 submaps
[nmaps
++] = orig_local_map
;
9222 submaps
[nmaps
++] = current_global_map
;
9224 /* Find an accurate initial value for first_binding. */
9225 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9226 if (! NILP (submaps
[first_binding
]))
9229 /* Start from the beginning in keybuf. */
9232 /* These are no-ops the first time through, but if we restart, they
9233 revert the echo area and this_command_keys to their original state. */
9234 this_command_key_count
= keys_start
;
9235 if (INTERACTIVE
&& t
< mock_input
)
9236 echo_truncate (echo_start
);
9238 /* If the best binding for the current key sequence is a keymap, or
9239 we may be looking at a function key's escape sequence, keep on
9241 while (first_binding
< nmaps
9242 /* Keep reading as long as there's a prefix binding. */
9243 ? !NILP (submaps
[first_binding
])
9244 /* Don't return in the middle of a possible function key sequence,
9245 if the only bindings we found were via case conversion.
9246 Thus, if ESC O a has a function-key-map translation
9247 and ESC o has a binding, don't return after ESC O,
9248 so that we can translate ESC O plus the next character. */
9249 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9252 int used_mouse_menu
= 0;
9254 /* Where the last real key started. If we need to throw away a
9255 key that has expanded into more than one element of keybuf
9256 (say, a mouse click on the mode line which is being treated
9257 as [mode-line (mouse-...)], then we backtrack to this point
9259 int last_real_key_start
;
9261 /* These variables are analogous to echo_start and keys_start;
9262 while those allow us to restart the entire key sequence,
9263 echo_local_start and keys_local_start allow us to throw away
9265 ptrdiff_t echo_local_start
IF_LINT (= 0);
9266 int keys_local_start
;
9267 ptrdiff_t local_first_binding
;
9269 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9270 eassert (indec
.start
<= indec
.end
);
9271 eassert (fkey
.start
<= fkey
.end
);
9272 eassert (keytran
.start
<= keytran
.end
);
9273 /* key-translation-map is applied *after* function-key-map
9274 which is itself applied *after* input-decode-map. */
9275 eassert (fkey
.end
<= indec
.start
);
9276 eassert (keytran
.end
<= fkey
.start
);
9278 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9279 first_unbound
< keytran
.start
)
9280 { /* The prefix upto first_unbound has no binding and has
9281 no translation left to do either, so we know it's unbound.
9282 If we don't stop now, we risk staying here indefinitely
9283 (if the user keeps entering fkey or keytran prefixes
9284 like C-c ESC ESC ESC ESC ...) */
9286 for (i
= first_unbound
+ 1; i
< t
; i
++)
9287 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9288 mock_input
= t
- first_unbound
- 1;
9289 indec
.end
= indec
.start
-= first_unbound
+ 1;
9290 indec
.map
= indec
.parent
;
9291 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9292 fkey
.map
= fkey
.parent
;
9293 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9294 keytran
.map
= keytran
.parent
;
9295 goto replay_sequence
;
9299 error ("Key sequence too long");
9302 echo_local_start
= echo_length ();
9303 keys_local_start
= this_command_key_count
;
9304 local_first_binding
= first_binding
;
9307 /* These are no-ops, unless we throw away a keystroke below and
9308 jumped back up to replay_key; in that case, these restore the
9309 variables to their original state, allowing us to replay the
9311 if (INTERACTIVE
&& t
< mock_input
)
9312 echo_truncate (echo_local_start
);
9313 this_command_key_count
= keys_local_start
;
9314 first_binding
= local_first_binding
;
9316 /* By default, assume each event is "real". */
9317 last_real_key_start
= t
;
9319 /* Does mock_input indicate that we are re-reading a key sequence? */
9323 add_command_key (key
);
9324 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9325 && NILP (Fzerop (Vecho_keystrokes
)))
9329 /* If not, we should actually read a character. */
9333 KBOARD
*interrupted_kboard
= current_kboard
;
9334 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9335 key
= read_char (NILP (prompt
), nmaps
,
9336 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9337 &used_mouse_menu
, NULL
);
9338 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9339 /* When switching to a new tty (with a new keyboard),
9340 read_char returns the new buffer, rather than -2
9341 (Bug#5095). This is because `terminal-init-xterm'
9342 calls read-char, which eats the wrong_kboard_jmpbuf
9343 return. Any better way to fix this? -- cyd */
9344 || (interrupted_kboard
!= current_kboard
))
9349 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9350 if (k
== interrupted_kboard
)
9355 /* Don't touch interrupted_kboard when it's been
9357 delayed_switch_frame
= Qnil
;
9358 goto replay_entire_sequence
;
9361 if (!NILP (delayed_switch_frame
))
9363 KVAR (interrupted_kboard
, kbd_queue
)
9364 = Fcons (delayed_switch_frame
,
9365 KVAR (interrupted_kboard
, kbd_queue
));
9366 delayed_switch_frame
= Qnil
;
9370 KVAR (interrupted_kboard
, kbd_queue
)
9371 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9373 /* If the side queue is non-empty, ensure it begins with a
9374 switch-frame, so we'll replay it in the right context. */
9375 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9376 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9377 !(EVENT_HAS_PARAMETERS (key
)
9378 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9382 XSETFRAME (frame
, interrupted_frame
);
9383 KVAR (interrupted_kboard
, kbd_queue
)
9384 = Fcons (make_lispy_switch_frame (frame
),
9385 KVAR (interrupted_kboard
, kbd_queue
));
9388 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9389 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9390 goto replay_entire_sequence
;
9394 /* read_char returns t when it shows a menu and the user rejects it.
9398 unbind_to (count
, Qnil
);
9403 /* read_char returns -1 at the end of a macro.
9404 Emacs 18 handles this by returning immediately with a
9405 zero, so that's what we'll do. */
9406 if (INTEGERP (key
) && XINT (key
) == -1)
9409 /* The Microsoft C compiler can't handle the goto that
9415 /* If the current buffer has been changed from under us, the
9416 keymap may have changed, so replay the sequence. */
9419 timer_resume_idle ();
9422 /* Reset the current buffer from the selected window
9423 in case something changed the former and not the latter.
9424 This is to be more consistent with the behavior
9425 of the command_loop_1. */
9426 if (fix_current_buffer
)
9428 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9430 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9431 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9434 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9435 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9436 goto replay_sequence
;
9439 /* If we have a quit that was typed in another frame, and
9440 quit_throw_to_read_char switched buffers,
9441 replay to get the right keymap. */
9443 && XINT (key
) == quit_char
9444 && current_buffer
!= starting_buffer
)
9447 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9452 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9453 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9454 goto replay_sequence
;
9459 if (EVENT_HAS_PARAMETERS (key
)
9460 /* Either a `switch-frame' or a `select-window' event. */
9461 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9463 /* If we're at the beginning of a key sequence, and the caller
9464 says it's okay, go ahead and return this event. If we're
9465 in the midst of a key sequence, delay it until the end. */
9466 if (t
> 0 || !can_return_switch_frame
)
9468 delayed_switch_frame
= key
;
9474 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9478 /* Clicks in non-text areas get prefixed by the symbol
9479 in their CHAR-ADDRESS field. For example, a click on
9480 the mode line is prefixed by the symbol `mode-line'.
9482 Furthermore, key sequences beginning with mouse clicks
9483 are read using the keymaps of the buffer clicked on, not
9484 the current buffer. So we may have to switch the buffer
9487 When we turn one event into two events, we must make sure
9488 that neither of the two looks like the original--so that,
9489 if we replay the events, they won't be expanded again.
9490 If not for this, such reexpansion could happen either here
9491 or when user programs play with this-command-keys. */
9492 if (EVENT_HAS_PARAMETERS (key
))
9497 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9498 if (EQ (kind
, Qmouse_click
))
9500 Lisp_Object window
, posn
;
9502 window
= POSN_WINDOW (EVENT_START (key
));
9503 posn
= POSN_POSN (EVENT_START (key
));
9506 || (!NILP (fake_prefixed_keys
)
9507 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9509 /* We're looking a second time at an event for which
9510 we generated a fake prefix key. Set
9511 last_real_key_start appropriately. */
9513 last_real_key_start
= t
- 1;
9516 if (last_real_key_start
== 0)
9518 /* Key sequences beginning with mouse clicks are
9519 read using the keymaps in the buffer clicked on,
9520 not the current buffer. If we're at the
9521 beginning of a key sequence, switch buffers. */
9522 if (WINDOWP (window
)
9523 && BUFFERP (XWINDOW (window
)->buffer
)
9524 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9526 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9531 /* Arrange to go back to the original buffer once we're
9532 done reading the key sequence. Note that we can't
9533 use save_excursion_{save,restore} here, because they
9534 save point as well as the current buffer; we don't
9535 want to save point, because redisplay may change it,
9536 to accommodate a Fset_window_start or something. We
9537 don't want to do this at the top of the function,
9538 because we may get input from a subprocess which
9539 wants to change the selected window and stuff (say,
9541 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9543 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9545 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9546 orig_local_map
= get_local_map (PT
, current_buffer
,
9548 orig_keymap
= get_local_map (PT
, current_buffer
,
9550 goto replay_sequence
;
9553 /* For a mouse click, get the local text-property keymap
9554 of the place clicked on, rather than point. */
9555 if (CONSP (XCDR (key
))
9556 && ! localized_local_map
)
9558 Lisp_Object map_here
, start
, pos
;
9560 localized_local_map
= 1;
9561 start
= EVENT_START (key
);
9563 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9565 pos
= POSN_BUFFER_POSN (start
);
9567 && XINT (pos
) >= BEGV
9568 && XINT (pos
) <= ZV
)
9570 map_here
= get_local_map (XINT (pos
),
9573 if (!EQ (map_here
, orig_local_map
))
9575 orig_local_map
= map_here
;
9576 ++localized_local_map
;
9579 map_here
= get_local_map (XINT (pos
),
9582 if (!EQ (map_here
, orig_keymap
))
9584 orig_keymap
= map_here
;
9585 ++localized_local_map
;
9588 if (localized_local_map
> 1)
9593 goto replay_sequence
;
9600 /* Expand mode-line and scroll-bar events into two events:
9601 use posn as a fake prefix key. */
9603 && (NILP (fake_prefixed_keys
)
9604 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9606 if (bufsize
- t
<= 1)
9607 error ("Key sequence too long");
9610 keybuf
[t
+ 1] = key
;
9613 /* Record that a fake prefix key has been generated
9614 for KEY. Don't modify the event; this would
9615 prevent proper action when the event is pushed
9616 back into unread-command-events. */
9617 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9619 /* If on a mode line string with a local keymap,
9620 reconsider the key sequence with that keymap. */
9621 if (string
= POSN_STRING (EVENT_START (key
)),
9622 (CONSP (string
) && STRINGP (XCAR (string
))))
9624 Lisp_Object pos
, map
, map2
;
9626 pos
= XCDR (string
);
9627 string
= XCAR (string
);
9629 && XINT (pos
) < SCHARS (string
))
9631 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9633 orig_local_map
= map
;
9634 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9637 if (!NILP (map
) || !NILP (map2
))
9638 goto replay_sequence
;
9644 else if (NILP (from_string
)
9645 && (string
= POSN_STRING (EVENT_START (key
)),
9646 (CONSP (string
) && STRINGP (XCAR (string
)))))
9648 /* For a click on a string, i.e. overlay string or a
9649 string displayed via the `display' property,
9650 consider `local-map' and `keymap' properties of
9652 Lisp_Object pos
, map
, map2
;
9654 pos
= XCDR (string
);
9655 string
= XCAR (string
);
9657 && XINT (pos
) < SCHARS (string
))
9659 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9661 orig_local_map
= map
;
9662 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9666 if (!NILP (map
) || !NILP (map2
))
9668 from_string
= string
;
9671 goto replay_sequence
;
9676 else if (CONSP (XCDR (key
))
9677 && CONSP (EVENT_START (key
))
9678 && CONSP (XCDR (EVENT_START (key
))))
9682 posn
= POSN_POSN (EVENT_START (key
));
9683 /* Handle menu-bar events:
9684 insert the dummy prefix event `menu-bar'. */
9685 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9687 if (bufsize
- t
<= 1)
9688 error ("Key sequence too long");
9692 /* Zap the position in key, so we know that we've
9693 expanded it, and don't try to do so again. */
9694 POSN_SET_POSN (EVENT_START (key
),
9695 Fcons (posn
, Qnil
));
9698 goto replay_sequence
;
9700 else if (CONSP (posn
))
9702 /* We're looking at the second event of a
9703 sequence which we expanded before. Set
9704 last_real_key_start appropriately. */
9705 if (last_real_key_start
== t
&& t
> 0)
9706 last_real_key_start
= t
- 1;
9711 /* We have finally decided that KEY is something we might want
9713 first_binding
= (follow_key (key
,
9714 nmaps
- first_binding
,
9715 submaps
+ first_binding
,
9716 defs
+ first_binding
,
9717 submaps
+ first_binding
)
9720 /* If KEY wasn't bound, we'll try some fallbacks. */
9721 if (first_binding
< nmaps
)
9722 /* This is needed for the following scenario:
9723 event 0: a down-event that gets dropped by calling replay_key.
9724 event 1: some normal prefix like C-h.
9725 After event 0, first_unbound is 0, after event 1 indec.start,
9726 fkey.start, and keytran.start are all 1, so when we see that
9727 C-h is bound, we need to update first_unbound. */
9728 first_unbound
= max (t
+ 1, first_unbound
);
9733 /* Remember the position to put an upper bound on indec.start. */
9734 first_unbound
= min (t
, first_unbound
);
9736 head
= EVENT_HEAD (key
);
9737 if (help_char_p (head
) && t
> 0)
9739 read_key_sequence_cmd
= Vprefix_help_command
;
9741 last_nonmenu_event
= key
;
9742 /* The Microsoft C compiler can't handle the goto that
9750 Lisp_Object breakdown
;
9753 breakdown
= parse_modifiers (head
);
9754 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9755 /* Attempt to reduce an unbound mouse event to a simpler
9756 event that is bound:
9757 Drags reduce to clicks.
9758 Double-clicks reduce to clicks.
9759 Triple-clicks reduce to double-clicks, then to clicks.
9760 Down-clicks are eliminated.
9761 Double-downs reduce to downs, then are eliminated.
9762 Triple-downs reduce to double-downs, then to downs,
9763 then are eliminated. */
9764 if (modifiers
& (down_modifier
| drag_modifier
9765 | double_modifier
| triple_modifier
))
9767 while (modifiers
& (down_modifier
| drag_modifier
9768 | double_modifier
| triple_modifier
))
9770 Lisp_Object new_head
, new_click
;
9771 if (modifiers
& triple_modifier
)
9772 modifiers
^= (double_modifier
| triple_modifier
);
9773 else if (modifiers
& double_modifier
)
9774 modifiers
&= ~double_modifier
;
9775 else if (modifiers
& drag_modifier
)
9776 modifiers
&= ~drag_modifier
;
9779 /* Dispose of this `down' event by simply jumping
9780 back to replay_key, to get another event.
9782 Note that if this event came from mock input,
9783 then just jumping back to replay_key will just
9784 hand it to us again. So we have to wipe out any
9787 We could delete keybuf[t] and shift everything
9788 after that to the left by one spot, but we'd also
9789 have to fix up any variable that points into
9790 keybuf, and shifting isn't really necessary
9793 Adding prefixes for non-textual mouse clicks
9794 creates two characters of mock input, and both
9795 must be thrown away. If we're only looking at
9796 the prefix now, we can just jump back to
9797 replay_key. On the other hand, if we've already
9798 processed the prefix, and now the actual click
9799 itself is giving us trouble, then we've lost the
9800 state of the keymaps we want to backtrack to, and
9801 we need to replay the whole sequence to rebuild
9804 Beyond that, only function key expansion could
9805 create more than two keys, but that should never
9806 generate mouse events, so it's okay to zero
9807 mock_input in that case too.
9809 FIXME: The above paragraph seems just plain
9810 wrong, if you consider things like
9811 xterm-mouse-mode. -stef
9813 Isn't this just the most wonderful code ever? */
9815 /* If mock_input > t + 1, the above simplification
9816 will actually end up dropping keys on the floor.
9817 This is probably OK for now, but even
9818 if mock_input <= t + 1, we need to adjust indec,
9820 Typical case [header-line down-mouse-N]:
9821 mock_input = 2, t = 1, fkey.end = 1,
9822 last_real_key_start = 0. */
9823 if (indec
.end
> last_real_key_start
)
9825 indec
.end
= indec
.start
9826 = min (last_real_key_start
, indec
.start
);
9827 indec
.map
= indec
.parent
;
9828 if (fkey
.end
> last_real_key_start
)
9830 fkey
.end
= fkey
.start
9831 = min (last_real_key_start
, fkey
.start
);
9832 fkey
.map
= fkey
.parent
;
9833 if (keytran
.end
> last_real_key_start
)
9835 keytran
.end
= keytran
.start
9836 = min (last_real_key_start
, keytran
.start
);
9837 keytran
.map
= keytran
.parent
;
9841 if (t
== last_real_key_start
)
9848 mock_input
= last_real_key_start
;
9849 goto replay_sequence
;
9854 = apply_modifiers (modifiers
, XCAR (breakdown
));
9856 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9858 /* Look for a binding for this new key. follow_key
9859 promises that it didn't munge submaps the
9860 last time we called it, since key was unbound. */
9862 = (follow_key (new_click
,
9863 nmaps
- local_first_binding
,
9864 submaps
+ local_first_binding
,
9865 defs
+ local_first_binding
,
9866 submaps
+ local_first_binding
)
9867 + local_first_binding
);
9869 /* If that click is bound, go for it. */
9870 if (first_binding
< nmaps
)
9875 /* Otherwise, we'll leave key set to the drag event. */
9882 /* Normally, last_nonmenu_event gets the previous key we read.
9883 But when a mouse popup menu is being used,
9884 we don't update last_nonmenu_event; it continues to hold the mouse
9885 event that preceded the first level of menu. */
9886 if (!used_mouse_menu
)
9887 last_nonmenu_event
= key
;
9889 /* Record what part of this_command_keys is the current key sequence. */
9890 this_single_command_key_start
= this_command_key_count
- t
;
9892 /* Look for this sequence in input-decode-map.
9893 Scan from indec.end until we find a bound suffix. */
9894 while (indec
.end
< t
)
9896 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9899 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9900 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9905 mock_input
= diff
+ max (t
, mock_input
);
9906 goto replay_sequence
;
9910 if (first_binding
< nmaps
9911 && NILP (submaps
[first_binding
])
9912 && !test_undefined (defs
[first_binding
])
9913 && indec
.start
>= t
)
9914 /* There is a binding and it's not a prefix.
9915 (and it doesn't have any input-decode-map translation pending).
9916 There is thus no function-key in this sequence.
9917 Moving fkey.start is important in this case to allow keytran.start
9918 to go over the sequence before we return (since we keep the
9919 invariant that keytran.end <= fkey.start). */
9922 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9925 /* If the sequence is unbound, see if we can hang a function key
9926 off the end of it. */
9927 /* Continue scan from fkey.end until we find a bound suffix. */
9928 while (fkey
.end
< indec
.start
)
9930 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9933 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9934 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9935 max (t
, mock_input
),
9936 /* If there's a binding (i.e.
9937 first_binding >= nmaps) we don't want
9938 to apply this function-key-mapping. */
9940 && (first_binding
>= nmaps
9941 || test_undefined (defs
[first_binding
])),
9946 mock_input
= diff
+ max (t
, mock_input
);
9947 /* Adjust the input-decode-map counters. */
9949 indec
.start
+= diff
;
9951 goto replay_sequence
;
9955 /* Look for this sequence in key-translation-map.
9956 Scan from keytran.end until we find a bound suffix. */
9957 while (keytran
.end
< fkey
.start
)
9959 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9962 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9963 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9968 mock_input
= diff
+ max (t
, mock_input
);
9969 /* Adjust the function-key-map and input-decode-map counters. */
9971 indec
.start
+= diff
;
9975 goto replay_sequence
;
9979 /* If KEY is not defined in any of the keymaps,
9980 and cannot be part of a function key or translation,
9981 and is an upper case letter
9982 use the corresponding lower-case letter instead. */
9983 if (first_binding
>= nmaps
9984 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9986 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9987 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9988 || (XINT (key
) & shift_modifier
)))
9990 Lisp_Object new_key
;
9992 original_uppercase
= key
;
9993 original_uppercase_position
= t
- 1;
9995 if (XINT (key
) & shift_modifier
)
9996 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9998 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9999 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10001 /* We have to do this unconditionally, regardless of whether
10002 the lower-case char is defined in the keymaps, because they
10003 might get translated through function-key-map. */
10004 keybuf
[t
- 1] = new_key
;
10005 mock_input
= max (t
, mock_input
);
10006 shift_translated
= 1;
10008 goto replay_sequence
;
10010 /* If KEY is not defined in any of the keymaps,
10011 and cannot be part of a function key or translation,
10012 and is a shifted function key,
10013 use the corresponding unshifted function key instead. */
10014 if (first_binding
>= nmaps
10015 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10017 Lisp_Object breakdown
= parse_modifiers (key
);
10019 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10021 if (modifiers
& shift_modifier
10022 /* Treat uppercase keys as shifted. */
10024 && (KEY_TO_CHAR (key
)
10025 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10026 && uppercasep (KEY_TO_CHAR (key
))))
10028 Lisp_Object new_key
10029 = (modifiers
& shift_modifier
10030 ? apply_modifiers (modifiers
& ~shift_modifier
,
10032 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10034 original_uppercase
= key
;
10035 original_uppercase_position
= t
- 1;
10037 /* We have to do this unconditionally, regardless of whether
10038 the lower-case char is defined in the keymaps, because they
10039 might get translated through function-key-map. */
10040 keybuf
[t
- 1] = new_key
;
10041 mock_input
= max (t
, mock_input
);
10042 /* Reset fkey (and consequently keytran) to apply
10043 function-key-map on the result, so that S-backspace is
10044 correctly mapped to DEL (via backspace). OTOH,
10045 input-decode-map doesn't need to go through it again. */
10046 fkey
.start
= fkey
.end
= 0;
10047 keytran
.start
= keytran
.end
= 0;
10048 shift_translated
= 1;
10050 goto replay_sequence
;
10055 read_key_sequence_cmd
= (first_binding
< nmaps
10056 ? defs
[first_binding
]
10058 read_key_sequence_remapped
10059 /* Remap command through active keymaps.
10060 Do the remapping here, before the unbind_to so it uses the keymaps
10061 of the appropriate buffer. */
10062 = SYMBOLP (read_key_sequence_cmd
)
10063 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10066 unread_switch_frame
= delayed_switch_frame
;
10067 unbind_to (count
, Qnil
);
10069 /* Don't downcase the last character if the caller says don't.
10070 Don't downcase it if the result is undefined, either. */
10071 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10073 && t
- 1 == original_uppercase_position
)
10075 keybuf
[t
- 1] = original_uppercase
;
10076 shift_translated
= 0;
10079 if (shift_translated
)
10080 Vthis_command_keys_shift_translated
= Qt
;
10082 /* Occasionally we fabricate events, perhaps by expanding something
10083 according to function-key-map, or by adding a prefix symbol to a
10084 mouse click in the scroll bar or modeline. In this cases, return
10085 the entire generated key sequence, even if we hit an unbound
10086 prefix or a definition before the end. This means that you will
10087 be able to push back the event properly, and also means that
10088 read-key-sequence will always return a logical unit.
10091 for (; t
< mock_input
; t
++)
10093 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10094 && NILP (Fzerop (Vecho_keystrokes
)))
10095 echo_char (keybuf
[t
]);
10096 add_command_key (keybuf
[t
]);
10103 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10104 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10105 The sequence is sufficient to specify a non-prefix command in the
10106 current local and global maps.
10108 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10109 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10110 as a continuation of the previous key.
10112 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10113 convert the last event to lower case. (Normally any upper case event
10114 is converted to lower case if the original event is undefined and the lower
10115 case equivalent is defined.) A non-nil value is appropriate for reading
10116 a key sequence to be defined.
10118 A C-g typed while in this function is treated like any other character,
10119 and `quit-flag' is not set.
10121 If the key sequence starts with a mouse click, then the sequence is read
10122 using the keymaps of the buffer of the window clicked in, not the buffer
10123 of the selected window as normal.
10125 `read-key-sequence' drops unbound button-down events, since you normally
10126 only care about the click or drag events which follow them. If a drag
10127 or multi-click event is unbound, but the corresponding click event would
10128 be bound, `read-key-sequence' turns the event into a click event at the
10129 drag's starting position. This means that you don't have to distinguish
10130 between click and drag, double, or triple events unless you want to.
10132 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10133 lines separating windows, and scroll bars with imaginary keys
10134 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10136 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10137 function will process a switch-frame event if the user switches frames
10138 before typing anything. If the user switches frames in the middle of a
10139 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10140 is nil, then the event will be put off until after the current key sequence.
10142 `read-key-sequence' checks `function-key-map' for function key
10143 sequences, where they wouldn't conflict with ordinary bindings. See
10144 `function-key-map' for more details.
10146 The optional fifth argument CMD-LOOP, if non-nil, means
10147 that this key sequence is being read by something that will
10148 read commands one after another. It should be nil if the caller
10149 will read just one key sequence. */)
10150 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10152 Lisp_Object keybuf
[30];
10154 struct gcpro gcpro1
;
10155 ptrdiff_t count
= SPECPDL_INDEX ();
10157 if (!NILP (prompt
))
10158 CHECK_STRING (prompt
);
10161 specbind (Qinput_method_exit_on_first_char
,
10162 (NILP (cmd_loop
) ? Qt
: Qnil
));
10163 specbind (Qinput_method_use_echo_area
,
10164 (NILP (cmd_loop
) ? Qt
: Qnil
));
10166 memset (keybuf
, 0, sizeof keybuf
);
10167 GCPRO1 (keybuf
[0]);
10168 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10170 if (NILP (continue_echo
))
10172 this_command_key_count
= 0;
10173 this_command_key_count_reset
= 0;
10174 this_single_command_key_start
= 0;
10177 #ifdef HAVE_WINDOW_SYSTEM
10178 if (display_hourglass_p
)
10179 cancel_hourglass ();
10182 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10183 prompt
, ! NILP (dont_downcase_last
),
10184 ! NILP (can_return_switch_frame
), 0);
10186 #if 0 /* The following is fine for code reading a key sequence and
10187 then proceeding with a lengthy computation, but it's not good
10188 for code reading keys in a loop, like an input method. */
10189 #ifdef HAVE_WINDOW_SYSTEM
10190 if (display_hourglass_p
)
10191 start_hourglass ();
10201 return unbind_to (count
, make_event_array (i
, keybuf
));
10204 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10205 Sread_key_sequence_vector
, 1, 5, 0,
10206 doc
: /* Like `read-key-sequence' but always return a vector. */)
10207 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10209 Lisp_Object keybuf
[30];
10211 struct gcpro gcpro1
;
10212 ptrdiff_t count
= SPECPDL_INDEX ();
10214 if (!NILP (prompt
))
10215 CHECK_STRING (prompt
);
10218 specbind (Qinput_method_exit_on_first_char
,
10219 (NILP (cmd_loop
) ? Qt
: Qnil
));
10220 specbind (Qinput_method_use_echo_area
,
10221 (NILP (cmd_loop
) ? Qt
: Qnil
));
10223 memset (keybuf
, 0, sizeof keybuf
);
10224 GCPRO1 (keybuf
[0]);
10225 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10227 if (NILP (continue_echo
))
10229 this_command_key_count
= 0;
10230 this_command_key_count_reset
= 0;
10231 this_single_command_key_start
= 0;
10234 #ifdef HAVE_WINDOW_SYSTEM
10235 if (display_hourglass_p
)
10236 cancel_hourglass ();
10239 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10240 prompt
, ! NILP (dont_downcase_last
),
10241 ! NILP (can_return_switch_frame
), 0);
10243 #ifdef HAVE_WINDOW_SYSTEM
10244 if (display_hourglass_p
)
10245 start_hourglass ();
10254 return unbind_to (count
, Fvector (i
, keybuf
));
10257 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10258 doc
: /* Execute CMD as an editor command.
10259 CMD must be a symbol that satisfies the `commandp' predicate.
10260 Optional second arg RECORD-FLAG non-nil
10261 means unconditionally put this command in `command-history'.
10262 Otherwise, that is done only if an arg is read using the minibuffer.
10263 The argument KEYS specifies the value to use instead of (this-command-keys)
10264 when reading the arguments; if it is nil, (this-command-keys) is used.
10265 The argument SPECIAL, if non-nil, means that this command is executing
10266 a special event, so ignore the prefix argument and don't clear it. */)
10267 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10269 register Lisp_Object final
;
10270 register Lisp_Object tem
;
10271 Lisp_Object prefixarg
;
10273 debug_on_next_call
= 0;
10275 if (NILP (special
))
10277 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10278 Vcurrent_prefix_arg
= prefixarg
;
10279 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10286 tem
= Fget (cmd
, Qdisabled
);
10289 tem
= Fsymbol_value (Qdisabled_command_function
);
10291 return Frun_hooks (1, &Qdisabled_command_function
);
10297 final
= Findirect_function (cmd
, Qnil
);
10299 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10301 struct gcpro gcpro1
, gcpro2
;
10303 GCPRO2 (cmd
, prefixarg
);
10304 do_autoload (final
, cmd
);
10311 if (STRINGP (final
) || VECTORP (final
))
10313 /* If requested, place the macro in the command history. For
10314 other sorts of commands, call-interactively takes care of
10316 if (!NILP (record_flag
))
10319 = Fcons (Fcons (Qexecute_kbd_macro
,
10320 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10323 /* Don't keep command history around forever. */
10324 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10326 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10328 XSETCDR (tem
, Qnil
);
10332 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10335 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10336 /* Don't call Fcall_interactively directly because we want to make
10337 sure the backtrace has an entry for `call-interactively'.
10338 For the same reason, pass `cmd' rather than `final'. */
10339 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10346 /* Return nonzero if input events are pending. */
10349 detect_input_pending (void)
10351 if (!input_pending
)
10352 get_input_pending (&input_pending
, 0);
10354 return input_pending
;
10357 /* Return nonzero if input events other than mouse movements are
10361 detect_input_pending_ignore_squeezables (void)
10363 if (!input_pending
)
10364 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10366 return input_pending
;
10369 /* Return nonzero if input events are pending, and run any pending timers. */
10372 detect_input_pending_run_timers (int do_display
)
10374 int old_timers_run
= timers_run
;
10376 if (!input_pending
)
10377 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10379 if (old_timers_run
!= timers_run
&& do_display
)
10381 redisplay_preserve_echo_area (8);
10382 /* The following fixes a bug when using lazy-lock with
10383 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10384 from an idle timer function. The symptom of the bug is that
10385 the cursor sometimes doesn't become visible until the next X
10386 event is processed. --gerd. */
10388 Lisp_Object tail
, frame
;
10389 FOR_EACH_FRAME (tail
, frame
)
10390 if (FRAME_RIF (XFRAME (frame
)))
10391 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10395 return input_pending
;
10398 /* This is called in some cases before a possible quit.
10399 It cases the next call to detect_input_pending to recompute input_pending.
10400 So calling this function unnecessarily can't do any harm. */
10403 clear_input_pending (void)
10408 /* Return nonzero if there are pending requeued events.
10409 This isn't used yet. The hope is to make wait_reading_process_output
10410 call it, and return if it runs Lisp code that unreads something.
10411 The problem is, kbd_buffer_get_event needs to be fixed to know what
10412 to do in that case. It isn't trivial. */
10415 requeued_events_pending_p (void)
10417 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10421 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10422 doc
: /* Return t if command input is currently available with no wait.
10423 Actually, the value is nil only if we can be sure that no input is available;
10424 if there is a doubt, the value is t. */)
10427 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10428 || !NILP (Vunread_post_input_method_events
)
10429 || !NILP (Vunread_input_method_events
))
10432 /* Process non-user-visible events (Bug#10195). */
10433 process_special_events ();
10435 get_input_pending (&input_pending
,
10436 READABLE_EVENTS_DO_TIMERS_NOW
10437 | READABLE_EVENTS_FILTER_EVENTS
);
10438 return input_pending
> 0 ? Qt
: Qnil
;
10441 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10442 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10445 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10448 if (total_keys
< NUM_RECENT_KEYS
)
10449 return Fvector (total_keys
, keys
);
10452 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10453 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10454 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10455 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10456 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10461 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10462 doc
: /* Return the key sequence that invoked this command.
10463 However, if the command has called `read-key-sequence', it returns
10464 the last key sequence that has been read.
10465 The value is a string or a vector.
10467 See also `this-command-keys-vector'. */)
10470 return make_event_array (this_command_key_count
,
10471 XVECTOR (this_command_keys
)->contents
);
10474 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10475 doc
: /* Return the key sequence that invoked this command, as a vector.
10476 However, if the command has called `read-key-sequence', it returns
10477 the last key sequence that has been read.
10479 See also `this-command-keys'. */)
10482 return Fvector (this_command_key_count
,
10483 XVECTOR (this_command_keys
)->contents
);
10486 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10487 Sthis_single_command_keys
, 0, 0, 0,
10488 doc
: /* Return the key sequence that invoked this command.
10489 More generally, it returns the last key sequence read, either by
10490 the command loop or by `read-key-sequence'.
10491 Unlike `this-command-keys', this function's value
10492 does not include prefix arguments.
10493 The value is always a vector. */)
10496 return Fvector (this_command_key_count
10497 - this_single_command_key_start
,
10498 (XVECTOR (this_command_keys
)->contents
10499 + this_single_command_key_start
));
10502 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10503 Sthis_single_command_raw_keys
, 0, 0, 0,
10504 doc
: /* Return the raw events that were read for this command.
10505 More generally, it returns the last key sequence read, either by
10506 the command loop or by `read-key-sequence'.
10507 Unlike `this-single-command-keys', this function's value
10508 shows the events before all translations (except for input methods).
10509 The value is always a vector. */)
10512 return Fvector (raw_keybuf_count
,
10513 (XVECTOR (raw_keybuf
)->contents
));
10516 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10517 Sreset_this_command_lengths
, 0, 0, 0,
10518 doc
: /* Make the unread events replace the last command and echo.
10519 Used in `universal-argument-other-key'.
10521 `universal-argument-other-key' rereads the event just typed.
10522 It then gets translated through `function-key-map'.
10523 The translated event has to replace the real events,
10524 both in the value of (this-command-keys) and in echoing.
10525 To achieve this, `universal-argument-other-key' calls
10526 `reset-this-command-lengths', which discards the record of reading
10527 these events the first time. */)
10530 this_command_key_count
= before_command_key_count
;
10531 if (this_command_key_count
< this_single_command_key_start
)
10532 this_single_command_key_start
= this_command_key_count
;
10534 echo_truncate (before_command_echo_length
);
10536 /* Cause whatever we put into unread-command-events
10537 to echo as if it were being freshly read from the keyboard. */
10538 this_command_key_count_reset
= 1;
10543 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10544 Sclear_this_command_keys
, 0, 1, 0,
10545 doc
: /* Clear out the vector that `this-command-keys' returns.
10546 Also clear the record of the last 100 events, unless optional arg
10547 KEEP-RECORD is non-nil. */)
10548 (Lisp_Object keep_record
)
10552 this_command_key_count
= 0;
10553 this_command_key_count_reset
= 0;
10555 if (NILP (keep_record
))
10557 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10558 ASET (recent_keys
, i
, Qnil
);
10560 recent_keys_index
= 0;
10565 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10566 doc
: /* Return the current depth in recursive edits. */)
10570 /* Wrap around reliably on integer overflow. */
10571 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10572 XSETINT (temp
, sum
);
10576 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10577 "FOpen dribble file: ",
10578 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10579 If FILE is nil, close any open dribble file.
10580 The file will be closed when Emacs exits. */)
10592 file
= Fexpand_file_name (file
, Qnil
);
10593 dribble
= fopen (SSDATA (file
), "w");
10595 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10600 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10601 doc
: /* Discard the contents of the terminal input buffer.
10602 Also end any kbd macro being defined. */)
10605 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10607 /* Discard the last command from the macro. */
10608 Fcancel_kbd_macro_events ();
10612 update_mode_lines
++;
10614 Vunread_command_events
= Qnil
;
10615 unread_command_char
= -1;
10617 discard_tty_input ();
10619 kbd_fetch_ptr
= kbd_store_ptr
;
10625 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10626 doc
: /* Stop Emacs and return to superior process. You can resume later.
10627 If `cannot-suspend' is non-nil, or if the system doesn't support job
10628 control, run a subshell instead.
10630 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10631 to be read as terminal input by Emacs's parent, after suspension.
10633 Before suspending, run the normal hook `suspend-hook'.
10634 After resumption run the normal hook `suspend-resume-hook'.
10636 Some operating systems cannot stop the Emacs process and resume it later.
10637 On such systems, Emacs starts a subshell instead of suspending. */)
10638 (Lisp_Object stuffstring
)
10640 ptrdiff_t count
= SPECPDL_INDEX ();
10641 int old_height
, old_width
;
10643 struct gcpro gcpro1
;
10646 if (tty_list
&& tty_list
->next
)
10647 error ("There are other tty frames open; close them before suspending Emacs");
10649 if (!NILP (stuffstring
))
10650 CHECK_STRING (stuffstring
);
10652 /* Run the functions in suspend-hook. */
10653 hook
= intern ("suspend-hook");
10654 Frun_hooks (1, &hook
);
10656 GCPRO1 (stuffstring
);
10657 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10658 reset_all_sys_modes ();
10659 /* sys_suspend can get an error if it tries to fork a subshell
10660 and the system resources aren't available for that. */
10661 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10663 stuff_buffered_input (stuffstring
);
10664 if (cannot_suspend
)
10668 unbind_to (count
, Qnil
);
10670 /* Check if terminal/window size has changed.
10671 Note that this is not useful when we are running directly
10672 with a window system; but suspend should be disabled in that case. */
10673 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10674 if (width
!= old_width
|| height
!= old_height
)
10675 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10677 /* Run suspend-resume-hook. */
10678 hook
= intern ("suspend-resume-hook");
10679 Frun_hooks (1, &hook
);
10685 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10686 Then in any case stuff anything Emacs has read ahead and not used. */
10689 stuff_buffered_input (Lisp_Object stuffstring
)
10691 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10692 register unsigned char *p
;
10694 if (STRINGP (stuffstring
))
10696 register ptrdiff_t count
;
10698 p
= SDATA (stuffstring
);
10699 count
= SBYTES (stuffstring
);
10700 while (count
-- > 0)
10705 /* Anything we have read ahead, put back for the shell to read. */
10706 /* ?? What should this do when we have multiple keyboards??
10707 Should we ignore anything that was typed in at the "wrong" kboard?
10709 rms: we should stuff everything back into the kboard
10711 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10714 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10715 kbd_fetch_ptr
= kbd_buffer
;
10716 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10717 stuff_char (kbd_fetch_ptr
->code
);
10719 clear_event (kbd_fetch_ptr
);
10723 #endif /* SIGTSTP */
10727 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10729 input_available_clear_time
= time_to_clear
;
10731 /* Tell handle_interrupt to throw back to read_char, */
10732 waiting_for_input
= 1;
10734 /* If handle_interrupt was called before and buffered a C-g,
10735 make it run again now, to avoid timing error. */
10736 if (!NILP (Vquit_flag
))
10737 quit_throw_to_read_char (0);
10741 clear_waiting_for_input (void)
10743 /* Tell handle_interrupt not to throw back to read_char, */
10744 waiting_for_input
= 0;
10745 input_available_clear_time
= 0;
10748 /* The SIGINT handler.
10750 If we have a frame on the controlling tty, we assume that the
10751 SIGINT was generated by C-g, so we call handle_interrupt.
10752 Otherwise, tell QUIT to kill Emacs. */
10755 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10756 /* compilers complain in signal calls. */
10758 /* Must preserve main program's value of errno. */
10759 int old_errno
= errno
;
10760 struct terminal
*terminal
;
10762 SIGNAL_THREAD_CHECK (signalnum
);
10764 /* See if we have an active terminal on our controlling tty. */
10765 terminal
= get_named_tty ("/dev/tty");
10768 /* If there are no frames there, let's pretend that we are a
10769 well-behaving UN*X program and quit. We must not call Lisp
10770 in a signal handler, so tell QUIT to exit when it is
10772 Vquit_flag
= Qkill_emacs
;
10776 /* Otherwise, the SIGINT was probably generated by C-g. */
10778 /* Set internal_last_event_frame to the top frame of the
10779 controlling tty, if we have a frame there. We disable the
10780 interrupt key on secondary ttys, so the SIGINT must have come
10781 from the controlling tty. */
10782 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10784 handle_interrupt ();
10790 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10791 of the number of times C-g has been requested. If C-g is pressed
10792 enough times, then quit anyway. See bug#6585. */
10793 static int force_quit_count
;
10795 /* This routine is called at interrupt level in response to C-g.
10797 It is called from the SIGINT handler or kbd_buffer_store_event.
10799 If `waiting_for_input' is non zero, then unless `echoing' is
10800 nonzero, immediately throw back to read_char.
10802 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10803 eval to throw, when it gets a chance. If quit-flag is already
10804 non-nil, it stops the job right away. */
10807 handle_interrupt (void)
10813 /* XXX This code needs to be revised for multi-tty support. */
10814 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10816 /* If SIGINT isn't blocked, don't let us be interrupted by
10817 another SIGINT, it might be harmful due to non-reentrancy
10818 in I/O functions. */
10819 sigblock (sigmask (SIGINT
));
10822 reset_all_sys_modes ();
10824 #ifdef SIGTSTP /* Support possible in later USG versions */
10826 * On systems which can suspend the current process and return to the original
10827 * shell, this command causes the user to end up back at the shell.
10828 * The "Auto-save" and "Abort" questions are not asked until
10829 * the user elects to return to emacs, at which point he can save the current
10830 * job and either dump core or continue.
10834 /* Perhaps should really fork an inferior shell?
10835 But that would not provide any way to get back
10836 to the original shell, ever. */
10837 printf ("No support for stopping a process on this operating system;\n");
10838 printf ("you can continue or abort.\n");
10839 #endif /* not SIGTSTP */
10841 /* We must remain inside the screen area when the internal terminal
10842 is used. Note that [Enter] is not echoed by dos. */
10843 cursor_to (SELECTED_FRAME (), 0, 0);
10845 /* It doesn't work to autosave while GC is in progress;
10846 the code used for auto-saving doesn't cope with the mark bit. */
10847 if (!gc_in_progress
)
10849 printf ("Auto-save? (y or n) ");
10851 if (((c
= getchar ()) & ~040) == 'Y')
10853 Fdo_auto_save (Qt
, Qnil
);
10855 printf ("\r\nAuto-save done");
10856 #else /* not MSDOS */
10857 printf ("Auto-save done\n");
10858 #endif /* not MSDOS */
10860 while (c
!= '\n') c
= getchar ();
10864 /* During GC, it must be safe to reenable quitting again. */
10865 Vinhibit_quit
= Qnil
;
10868 #endif /* not MSDOS */
10869 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10870 printf ("but will instead do a real quit after garbage collection ends\r\n");
10875 printf ("\r\nAbort? (y or n) ");
10876 #else /* not MSDOS */
10877 printf ("Abort (and dump core)? (y or n) ");
10878 #endif /* not MSDOS */
10880 if (((c
= getchar ()) & ~040) == 'Y')
10882 while (c
!= '\n') c
= getchar ();
10884 printf ("\r\nContinuing...\r\n");
10885 #else /* not MSDOS */
10886 printf ("Continuing...\n");
10887 #endif /* not MSDOS */
10889 init_all_sys_modes ();
10894 /* If executing a function that wants to be interrupted out of
10895 and the user has not deferred quitting by binding `inhibit-quit'
10896 then quit right away. */
10897 if (immediate_quit
&& NILP (Vinhibit_quit
))
10899 struct gl_state_s saved
;
10900 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10902 immediate_quit
= 0;
10905 GCPRO4 (saved
.object
, saved
.global_code
,
10906 saved
.current_syntax_table
, saved
.old_prop
);
10907 Fsignal (Qquit
, Qnil
);
10908 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10913 { /* Else request quit when it's safe. */
10914 if (NILP (Vquit_flag
))
10915 force_quit_count
= 0;
10916 if (++force_quit_count
== 3)
10918 immediate_quit
= 1;
10919 Vinhibit_quit
= Qnil
;
10925 /* TODO: The longjmp in this call throws the NS event loop integration off,
10926 and it seems to do fine without this. Probably some attention
10927 needs to be paid to the setting of waiting_for_input in
10928 wait_reading_process_output() under HAVE_NS because of the call
10929 to ns_select there (needed because otherwise events aren't picked up
10930 outside of polling since we don't get SIGIO like X and we don't have a
10931 separate event loop thread like W32. */
10933 if (waiting_for_input
&& !echoing
)
10934 quit_throw_to_read_char (1);
10938 /* Handle a C-g by making read_char return C-g. */
10941 quit_throw_to_read_char (int from_signal
)
10943 /* When not called from a signal handler it is safe to call
10945 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10946 Fkill_emacs (Qnil
);
10949 /* Prevent another signal from doing this before we finish. */
10950 clear_waiting_for_input ();
10953 Vunread_command_events
= Qnil
;
10954 unread_command_char
= -1;
10956 #if 0 /* Currently, sit_for is called from read_char without turning
10957 off polling. And that can call set_waiting_for_input.
10958 It seems to be harmless. */
10959 #ifdef POLL_FOR_INPUT
10960 /* May be > 1 if in recursive minibuffer. */
10961 if (poll_suppress_count
== 0)
10965 if (FRAMEP (internal_last_event_frame
)
10966 && !EQ (internal_last_event_frame
, selected_frame
))
10967 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10970 _longjmp (getcjmp
, 1);
10973 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10974 Sset_input_interrupt_mode
, 1, 1, 0,
10975 doc
: /* Set interrupt mode of reading keyboard input.
10976 If INTERRUPT is non-nil, Emacs will use input interrupts;
10977 otherwise Emacs uses CBREAK mode.
10979 See also `current-input-mode'. */)
10980 (Lisp_Object interrupt
)
10982 int new_interrupt_input
;
10984 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10985 #ifdef HAVE_X_WINDOWS
10986 if (x_display_list
!= NULL
)
10988 /* When using X, don't give the user a real choice,
10989 because we haven't implemented the mechanisms to support it. */
10990 new_interrupt_input
= 1;
10993 #endif /* HAVE_X_WINDOWS */
10994 new_interrupt_input
= !NILP (interrupt
);
10995 #else /* not SIGIO */
10996 new_interrupt_input
= 0;
10997 #endif /* not SIGIO */
10999 if (new_interrupt_input
!= interrupt_input
)
11001 #ifdef POLL_FOR_INPUT
11005 /* this causes startup screen to be restored and messes with the mouse */
11006 reset_all_sys_modes ();
11007 interrupt_input
= new_interrupt_input
;
11008 init_all_sys_modes ();
11010 interrupt_input
= new_interrupt_input
;
11013 #ifdef POLL_FOR_INPUT
11014 poll_suppress_count
= 1;
11021 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11022 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11023 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11024 C-q in key sequences.
11026 This setting only has an effect on tty terminals and only when
11027 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11029 See also `current-input-mode'. */)
11030 (Lisp_Object flow
, Lisp_Object terminal
)
11032 struct terminal
*t
= get_terminal (terminal
, 1);
11033 struct tty_display_info
*tty
;
11034 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11036 tty
= t
->display_info
.tty
;
11038 if (tty
->flow_control
!= !NILP (flow
))
11041 /* this causes startup screen to be restored and messes with the mouse */
11042 reset_sys_modes (tty
);
11045 tty
->flow_control
= !NILP (flow
);
11048 init_sys_modes (tty
);
11054 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11055 doc
: /* Enable or disable 8-bit input on TERMINAL.
11056 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11057 bit as the Meta modifier.
11059 If META is nil, Emacs will ignore the top bit, on the assumption it is
11062 Otherwise, Emacs will accept and pass through 8-bit input without
11063 specially interpreting the top bit.
11065 This setting only has an effect on tty terminal devices.
11067 Optional parameter TERMINAL specifies the tty terminal device to use.
11068 It may be a terminal object, a frame, or nil for the terminal used by
11069 the currently selected frame.
11071 See also `current-input-mode'. */)
11072 (Lisp_Object meta
, Lisp_Object terminal
)
11074 struct terminal
*t
= get_terminal (terminal
, 1);
11075 struct tty_display_info
*tty
;
11078 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11080 tty
= t
->display_info
.tty
;
11084 else if (EQ (meta
, Qt
))
11089 if (tty
->meta_key
!= new_meta
)
11092 /* this causes startup screen to be restored and messes with the mouse */
11093 reset_sys_modes (tty
);
11096 tty
->meta_key
= new_meta
;
11099 init_sys_modes (tty
);
11105 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11106 doc
: /* Specify character used for quitting.
11107 QUIT must be an ASCII character.
11109 This function only has an effect on the controlling tty of the Emacs
11112 See also `current-input-mode'. */)
11115 struct terminal
*t
= get_named_tty ("/dev/tty");
11116 struct tty_display_info
*tty
;
11117 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11119 tty
= t
->display_info
.tty
;
11121 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11122 error ("QUIT must be an ASCII character");
11125 /* this causes startup screen to be restored and messes with the mouse */
11126 reset_sys_modes (tty
);
11129 /* Don't let this value be out of range. */
11130 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11133 init_sys_modes (tty
);
11139 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11140 doc
: /* Set mode of reading keyboard input.
11141 First arg INTERRUPT non-nil means use input interrupts;
11142 nil means use CBREAK mode.
11143 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11144 (no effect except in CBREAK mode).
11145 Third arg META t means accept 8-bit input (for a Meta key).
11146 META nil means ignore the top bit, on the assumption it is parity.
11147 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11148 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11149 See also `current-input-mode'. */)
11150 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11152 Fset_input_interrupt_mode (interrupt
);
11153 Fset_output_flow_control (flow
, Qnil
);
11154 Fset_input_meta_mode (meta
, Qnil
);
11156 Fset_quit_char (quit
);
11160 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11161 doc
: /* Return information about the way Emacs currently reads keyboard input.
11162 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11163 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11164 nil, Emacs is using CBREAK mode.
11165 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11166 terminal; this does not apply if Emacs uses interrupt-driven input.
11167 META is t if accepting 8-bit input with 8th bit as Meta flag.
11168 META nil means ignoring the top bit, on the assumption it is parity.
11169 META is neither t nor nil if accepting 8-bit input and using
11170 all 8 bits as the character code.
11171 QUIT is the character Emacs currently uses to quit.
11172 The elements of this list correspond to the arguments of
11173 `set-input-mode'. */)
11176 Lisp_Object val
[4];
11177 struct frame
*sf
= XFRAME (selected_frame
);
11179 val
[0] = interrupt_input
? Qt
: Qnil
;
11180 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11182 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11183 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11185 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11192 XSETFASTINT (val
[3], quit_char
);
11194 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11197 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11198 doc
: /* Return position information for pixel coordinates X and Y.
11199 By default, X and Y are relative to text area of the selected window.
11200 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11201 If optional fourth arg WHOLE is non-nil, X is relative to the left
11202 edge of the window.
11204 The return value is similar to a mouse click position:
11205 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11206 IMAGE (DX . DY) (WIDTH . HEIGHT))
11207 The `posn-' functions access elements of such lists. */)
11208 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11213 if (NILP (frame_or_window
))
11214 frame_or_window
= selected_window
;
11216 if (WINDOWP (frame_or_window
))
11220 CHECK_LIVE_WINDOW (frame_or_window
);
11222 w
= XWINDOW (frame_or_window
);
11223 XSETINT (x
, (XINT (x
)
11224 + WINDOW_LEFT_EDGE_X (w
)
11226 ? window_box_left_offset (w
, TEXT_AREA
)
11228 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11229 frame_or_window
= w
->frame
;
11232 CHECK_LIVE_FRAME (frame_or_window
);
11234 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11237 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11238 doc
: /* Return position information for buffer POS in WINDOW.
11239 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11241 Return nil if position is not visible in window. Otherwise,
11242 the return value is similar to that returned by `event-start' for
11243 a mouse click at the upper left corner of the glyph corresponding
11244 to the given buffer position:
11245 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11246 IMAGE (DX . DY) (WIDTH . HEIGHT))
11247 The `posn-' functions access elements of such lists. */)
11248 (Lisp_Object pos
, Lisp_Object window
)
11253 window
= selected_window
;
11255 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11258 Lisp_Object x
= XCAR (tem
);
11259 Lisp_Object y
= XCAR (XCDR (tem
));
11261 /* Point invisible due to hscrolling? */
11264 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11272 * Set up a new kboard object with reasonable initial values.
11275 init_kboard (KBOARD
*kb
)
11277 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11278 KVAR (kb
, Vlast_command
) = Qnil
;
11279 KVAR (kb
, Vreal_last_command
) = Qnil
;
11280 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11281 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11282 KVAR (kb
, Vprefix_arg
) = Qnil
;
11283 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11284 KVAR (kb
, kbd_queue
) = Qnil
;
11285 kb
->kbd_queue_has_data
= 0;
11286 kb
->immediate_echo
= 0;
11287 KVAR (kb
, echo_string
) = Qnil
;
11288 kb
->echo_after_prompt
= -1;
11289 kb
->kbd_macro_buffer
= 0;
11290 kb
->kbd_macro_bufsize
= 0;
11291 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11292 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11293 kb
->reference_count
= 0;
11294 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11295 KVAR (kb
, system_key_syms
) = Qnil
;
11296 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11297 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11298 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11299 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11300 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11304 * Destroy the contents of a kboard object, but not the object itself.
11305 * We use this just before deleting it, or if we're going to initialize
11306 * it a second time.
11309 wipe_kboard (KBOARD
*kb
)
11311 xfree (kb
->kbd_macro_buffer
);
11314 /* Free KB and memory referenced from it. */
11317 delete_kboard (KBOARD
*kb
)
11321 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11324 *kbp
= kb
->next_kboard
;
11326 /* Prevent a dangling reference to KB. */
11327 if (kb
== current_kboard
11328 && FRAMEP (selected_frame
)
11329 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11331 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11333 if (current_kboard
== kb
)
11342 init_keyboard (void)
11344 /* This is correct before outermost invocation of the editor loop */
11345 command_loop_level
= -1;
11346 immediate_quit
= 0;
11347 quit_char
= Ctl ('g');
11348 Vunread_command_events
= Qnil
;
11349 unread_command_char
= -1;
11350 EMACS_SET_INVALID_TIME (timer_idleness_start_time
);
11352 recent_keys_index
= 0;
11353 kbd_fetch_ptr
= kbd_buffer
;
11354 kbd_store_ptr
= kbd_buffer
;
11355 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11356 do_mouse_tracking
= Qnil
;
11359 interrupt_input_blocked
= 0;
11360 interrupt_input_pending
= 0;
11362 pending_signals
= 0;
11365 /* This means that command_loop_1 won't try to select anything the first
11367 internal_last_event_frame
= Qnil
;
11368 Vlast_event_frame
= internal_last_event_frame
;
11370 current_kboard
= initial_kboard
;
11371 /* Re-initialize the keyboard again. */
11372 wipe_kboard (current_kboard
);
11373 init_kboard (current_kboard
);
11374 /* A value of nil for Vwindow_system normally means a tty, but we also use
11375 it for the initial terminal since there is no window system there. */
11376 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11378 if (!noninteractive
)
11380 /* Before multi-tty support, these handlers used to be installed
11381 only if the current session was a tty session. Now an Emacs
11382 session may have multiple display types, so we always handle
11383 SIGINT. There is special code in interrupt_signal to exit
11384 Emacs on SIGINT when there are no termcap frames on the
11385 controlling terminal. */
11386 signal (SIGINT
, interrupt_signal
);
11388 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11389 SIGQUIT and we can't tell which one it will give us. */
11390 signal (SIGQUIT
, interrupt_signal
);
11391 #endif /* not DOS_NT */
11393 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11395 if (!noninteractive
)
11396 signal (SIGIO
, input_available_signal
);
11399 /* Use interrupt input by default, if it works and noninterrupt input
11400 has deficiencies. */
11402 #ifdef INTERRUPT_INPUT
11403 interrupt_input
= 1;
11405 interrupt_input
= 0;
11411 if (keyboard_init_hook
)
11412 (*keyboard_init_hook
) ();
11414 #ifdef POLL_FOR_INPUT
11416 poll_suppress_count
= 1;
11421 /* This type's only use is in syms_of_keyboard, to initialize the
11422 event header symbols and put properties on them. */
11423 struct event_head
{
11429 static const struct event_head head_table
[] = {
11430 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11431 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11432 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11433 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11434 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11435 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11436 /* `select-window' should be handled just like `switch-frame'
11437 in read_key_sequence. */
11438 {&Qselect_window
, "select-window", &Qswitch_frame
}
11442 syms_of_keyboard (void)
11444 pending_funcalls
= Qnil
;
11445 staticpro (&pending_funcalls
);
11447 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11448 staticpro (&Vlispy_mouse_stem
);
11451 DEFSYM (QCimage
, ":image");
11452 DEFSYM (Qhelp_echo
, "help-echo");
11453 DEFSYM (QCrtl
, ":rtl");
11455 staticpro (&item_properties
);
11456 item_properties
= Qnil
;
11458 staticpro (&tool_bar_item_properties
);
11459 tool_bar_item_properties
= Qnil
;
11460 staticpro (&tool_bar_items_vector
);
11461 tool_bar_items_vector
= Qnil
;
11463 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11464 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11465 DEFSYM (Qself_insert_command
, "self-insert-command");
11466 DEFSYM (Qforward_char
, "forward-char");
11467 DEFSYM (Qbackward_char
, "backward-char");
11468 DEFSYM (Qdisabled
, "disabled");
11469 DEFSYM (Qundefined
, "undefined");
11470 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11471 DEFSYM (Qpost_command_hook
, "post-command-hook");
11472 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11473 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11474 DEFSYM (Qfunction_key
, "function-key");
11475 DEFSYM (Qmouse_click
, "mouse-click");
11476 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11477 DEFSYM (Qsave_session
, "save-session");
11478 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11479 DEFSYM (Qmenu_enable
, "menu-enable");
11481 #if defined (WINDOWSNT)
11482 DEFSYM (Qlanguage_change
, "language-change");
11486 DEFSYM (Qdbus_event
, "dbus-event");
11489 DEFSYM (QCenable
, ":enable");
11490 DEFSYM (QCvisible
, ":visible");
11491 DEFSYM (QChelp
, ":help");
11492 DEFSYM (QCfilter
, ":filter");
11493 DEFSYM (QCbutton
, ":button");
11494 DEFSYM (QCkeys
, ":keys");
11495 DEFSYM (QCkey_sequence
, ":key-sequence");
11496 DEFSYM (QCtoggle
, ":toggle");
11497 DEFSYM (QCradio
, ":radio");
11498 DEFSYM (QClabel
, ":label");
11499 DEFSYM (QCvert_only
, ":vert-only");
11501 DEFSYM (Qmode_line
, "mode-line");
11502 DEFSYM (Qvertical_line
, "vertical-line");
11503 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11504 DEFSYM (Qmenu_bar
, "menu-bar");
11506 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11507 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11510 DEFSYM (Qabove_handle
, "above-handle");
11511 DEFSYM (Qhandle
, "handle");
11512 DEFSYM (Qbelow_handle
, "below-handle");
11513 DEFSYM (Qup
, "up");
11514 DEFSYM (Qdown
, "down");
11515 DEFSYM (Qtop
, "top");
11516 DEFSYM (Qbottom
, "bottom");
11517 DEFSYM (Qend_scroll
, "end-scroll");
11518 DEFSYM (Qratio
, "ratio");
11520 DEFSYM (Qevent_kind
, "event-kind");
11521 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11522 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11523 DEFSYM (Qmodifier_cache
, "modifier-cache");
11525 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11526 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11528 DEFSYM (Qpolling_period
, "polling-period");
11530 DEFSYM (Qx_set_selection
, "x-set-selection");
11531 DEFSYM (QPRIMARY
, "PRIMARY");
11532 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11533 DEFSYM (Qhandle_select_window
, "handle-select-window");
11535 DEFSYM (Qinput_method_function
, "input-method-function");
11536 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11537 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11539 DEFSYM (Qhelp_form_show
, "help-form-show");
11541 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11542 Fset (Qinput_method_use_echo_area
, Qnil
);
11544 last_point_position_buffer
= Qnil
;
11545 last_point_position_window
= Qnil
;
11549 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11551 for (i
= 0; i
< len
; i
++)
11553 const struct event_head
*p
= &head_table
[i
];
11554 *p
->var
= intern_c_string (p
->name
);
11555 staticpro (p
->var
);
11556 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11557 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11561 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11562 staticpro (&button_down_location
);
11563 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11564 staticpro (&mouse_syms
);
11565 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11566 / sizeof (lispy_wheel_names
[0])),
11568 staticpro (&wheel_syms
);
11572 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11574 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11575 for (i
= 0; i
< len
; i
++)
11576 if (modifier_names
[i
])
11577 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11578 staticpro (&modifier_symbols
);
11581 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11582 staticpro (&recent_keys
);
11584 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11585 staticpro (&this_command_keys
);
11587 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11588 staticpro (&raw_keybuf
);
11590 DEFSYM (Qextended_command_history
, "extended-command-history");
11591 Fset (Qextended_command_history
, Qnil
);
11593 accent_key_syms
= Qnil
;
11594 staticpro (&accent_key_syms
);
11596 func_key_syms
= Qnil
;
11597 staticpro (&func_key_syms
);
11599 drag_n_drop_syms
= Qnil
;
11600 staticpro (&drag_n_drop_syms
);
11602 unread_switch_frame
= Qnil
;
11603 staticpro (&unread_switch_frame
);
11605 internal_last_event_frame
= Qnil
;
11606 staticpro (&internal_last_event_frame
);
11608 read_key_sequence_cmd
= Qnil
;
11609 staticpro (&read_key_sequence_cmd
);
11610 read_key_sequence_remapped
= Qnil
;
11611 staticpro (&read_key_sequence_remapped
);
11613 menu_bar_one_keymap_changed_items
= Qnil
;
11614 staticpro (&menu_bar_one_keymap_changed_items
);
11616 menu_bar_items_vector
= Qnil
;
11617 staticpro (&menu_bar_items_vector
);
11619 help_form_saved_window_configs
= Qnil
;
11620 staticpro (&help_form_saved_window_configs
);
11622 defsubr (&Scurrent_idle_time
);
11623 defsubr (&Sevent_symbol_parse_modifiers
);
11624 defsubr (&Sevent_convert_list
);
11625 defsubr (&Sread_key_sequence
);
11626 defsubr (&Sread_key_sequence_vector
);
11627 defsubr (&Srecursive_edit
);
11628 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11629 defsubr (&Strack_mouse
);
11631 defsubr (&Sinput_pending_p
);
11632 defsubr (&Scommand_execute
);
11633 defsubr (&Srecent_keys
);
11634 defsubr (&Sthis_command_keys
);
11635 defsubr (&Sthis_command_keys_vector
);
11636 defsubr (&Sthis_single_command_keys
);
11637 defsubr (&Sthis_single_command_raw_keys
);
11638 defsubr (&Sreset_this_command_lengths
);
11639 defsubr (&Sclear_this_command_keys
);
11640 defsubr (&Ssuspend_emacs
);
11641 defsubr (&Sabort_recursive_edit
);
11642 defsubr (&Sexit_recursive_edit
);
11643 defsubr (&Srecursion_depth
);
11644 defsubr (&Stop_level
);
11645 defsubr (&Sdiscard_input
);
11646 defsubr (&Sopen_dribble_file
);
11647 defsubr (&Sset_input_interrupt_mode
);
11648 defsubr (&Sset_output_flow_control
);
11649 defsubr (&Sset_input_meta_mode
);
11650 defsubr (&Sset_quit_char
);
11651 defsubr (&Sset_input_mode
);
11652 defsubr (&Scurrent_input_mode
);
11653 defsubr (&Sposn_at_point
);
11654 defsubr (&Sposn_at_x_y
);
11656 DEFVAR_LISP ("last-command-event", last_command_event
,
11657 doc
: /* Last input event that was part of a command. */);
11659 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11660 doc
: /* Last input event in a command, except for mouse menu events.
11661 Mouse menus give back keys that don't look like mouse events;
11662 this variable holds the actual mouse event that led to the menu,
11663 so that you can determine whether the command was run by mouse or not. */);
11665 DEFVAR_LISP ("last-input-event", last_input_event
,
11666 doc
: /* Last input event. */);
11668 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11669 doc
: /* List of events to be read as the command input.
11670 These events are processed first, before actual keyboard input.
11671 Events read from this list are not normally added to `this-command-keys',
11672 as they will already have been added once as they were read for the first time.
11673 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11674 Vunread_command_events
= Qnil
;
11676 DEFVAR_INT ("unread-command-char", unread_command_char
,
11677 doc
: /* If not -1, an object to be read as next command input event. */);
11679 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11680 doc
: /* List of events to be processed as input by input methods.
11681 These events are processed before `unread-command-events'
11682 and actual keyboard input, but are not given to `input-method-function'. */);
11683 Vunread_post_input_method_events
= Qnil
;
11685 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11686 doc
: /* List of events to be processed as input by input methods.
11687 These events are processed after `unread-command-events', but
11688 before actual keyboard input.
11689 If there's an active input method, the events are given to
11690 `input-method-function'. */);
11691 Vunread_input_method_events
= Qnil
;
11693 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11694 doc
: /* Meta-prefix character code.
11695 Meta-foo as command input turns into this character followed by foo. */);
11696 XSETINT (meta_prefix_char
, 033);
11698 DEFVAR_KBOARD ("last-command", Vlast_command
,
11699 doc
: /* The last command executed.
11700 Normally a symbol with a function definition, but can be whatever was found
11701 in the keymap, or whatever the variable `this-command' was set to by that
11704 The value `mode-exit' is special; it means that the previous command
11705 read an event that told it to exit, and it did so and unread that event.
11706 In other words, the present command is the event that made the previous
11709 The value `kill-region' is special; it means that the previous command
11710 was a kill command.
11712 `last-command' has a separate binding for each terminal device.
11713 See Info node `(elisp)Multiple Terminals'. */);
11715 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11716 doc
: /* Same as `last-command', but never altered by Lisp code.
11717 Taken from the previous value of `real-this-command'. */);
11719 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11720 doc
: /* Last command that may be repeated.
11721 The last command executed that was not bound to an input event.
11722 This is the command `repeat' will try to repeat.
11723 Taken from a previous value of `real-this-command'. */);
11725 DEFVAR_LISP ("this-command", Vthis_command
,
11726 doc
: /* The command now being executed.
11727 The command can set this variable; whatever is put here
11728 will be in `last-command' during the following command. */);
11729 Vthis_command
= Qnil
;
11731 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11732 doc
: /* This is like `this-command', except that commands should never modify it. */);
11733 Vreal_this_command
= Qnil
;
11735 DEFVAR_LISP ("this-command-keys-shift-translated",
11736 Vthis_command_keys_shift_translated
,
11737 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11738 Shift-translation occurs when there is no binding for the key sequence
11739 as entered, but a binding was found by changing an upper-case letter
11740 to lower-case, or a shifted function key to an unshifted one. */);
11741 Vthis_command_keys_shift_translated
= Qnil
;
11743 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11744 doc
: /* The command bound to the current key sequence before remapping.
11745 It equals `this-command' if the original command was not remapped through
11746 any of the active keymaps. Otherwise, the value of `this-command' is the
11747 result of looking up the original command in the active keymaps. */);
11748 Vthis_original_command
= Qnil
;
11750 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11751 doc
: /* Number of input events between auto-saves.
11752 Zero means disable autosaving due to number of characters typed. */);
11753 auto_save_interval
= 300;
11755 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11756 doc
: /* Number of seconds idle time before auto-save.
11757 Zero or nil means disable auto-saving due to idleness.
11758 After auto-saving due to this many seconds of idle time,
11759 Emacs also does a garbage collection if that seems to be warranted. */);
11760 XSETFASTINT (Vauto_save_timeout
, 30);
11762 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11763 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11764 The value may be integer or floating point.
11765 If the value is zero, don't echo at all. */);
11766 Vecho_keystrokes
= make_number (1);
11768 DEFVAR_INT ("polling-period", polling_period
,
11769 doc
: /* Interval between polling for input during Lisp execution.
11770 The reason for polling is to make C-g work to stop a running program.
11771 Polling is needed only when using X windows and SIGIO does not work.
11772 Polling is automatically disabled in all other cases. */);
11773 polling_period
= 2;
11775 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11776 doc
: /* Maximum time between mouse clicks to make a double-click.
11777 Measured in milliseconds. The value nil means disable double-click
11778 recognition; t means double-clicks have no time limit and are detected
11779 by position only. */);
11780 Vdouble_click_time
= make_number (500);
11782 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11783 doc
: /* Maximum mouse movement between clicks to make a double-click.
11784 On window-system frames, value is the number of pixels the mouse may have
11785 moved horizontally or vertically between two clicks to make a double-click.
11786 On non window-system frames, value is interpreted in units of 1/8 characters
11789 This variable is also the threshold for motion of the mouse
11790 to count as a drag. */);
11791 double_click_fuzz
= 3;
11793 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11794 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11795 inhibit_local_menu_bar_menus
= 0;
11797 DEFVAR_INT ("num-input-keys", num_input_keys
,
11798 doc
: /* Number of complete key sequences read as input so far.
11799 This includes key sequences read from keyboard macros.
11800 The number is effectively the number of interactive command invocations. */);
11801 num_input_keys
= 0;
11803 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11804 doc
: /* Number of input events read from the keyboard so far.
11805 This does not include events generated by keyboard macros. */);
11806 num_nonmacro_input_events
= 0;
11808 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11809 doc
: /* The frame in which the most recently read event occurred.
11810 If the last event came from a keyboard macro, this is set to `macro'. */);
11811 Vlast_event_frame
= Qnil
;
11813 /* This variable is set up in sysdep.c. */
11814 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11815 doc
: /* The ERASE character as set by the user with stty. */);
11817 DEFVAR_LISP ("help-char", Vhelp_char
,
11818 doc
: /* Character to recognize as meaning Help.
11819 When it is read, do `(eval help-form)', and display result if it's a string.
11820 If the value of `help-form' is nil, this char can be read normally. */);
11821 XSETINT (Vhelp_char
, Ctl ('H'));
11823 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11824 doc
: /* List of input events to recognize as meaning Help.
11825 These work just like the value of `help-char' (see that). */);
11826 Vhelp_event_list
= Qnil
;
11828 DEFVAR_LISP ("help-form", Vhelp_form
,
11829 doc
: /* Form to execute when character `help-char' is read.
11830 If the form returns a string, that string is displayed.
11831 If `help-form' is nil, the help char is not recognized. */);
11834 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11835 doc
: /* Command to run when `help-char' character follows a prefix key.
11836 This command is used only when there is no actual binding
11837 for that character after that prefix key. */);
11838 Vprefix_help_command
= Qnil
;
11840 DEFVAR_LISP ("top-level", Vtop_level
,
11841 doc
: /* Form to evaluate when Emacs starts up.
11842 Useful to set before you dump a modified Emacs. */);
11845 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11846 doc
: /* Translate table for local keyboard input, or nil.
11847 If non-nil, the value should be a char-table. Each character read
11848 from the keyboard is looked up in this char-table. If the value found
11849 there is non-nil, then it is used instead of the actual input character.
11851 The value can also be a string or vector, but this is considered obsolete.
11852 If it is a string or vector of length N, character codes N and up are left
11853 untranslated. In a vector, an element which is nil means "no translation".
11855 This is applied to the characters supplied to input methods, not their
11856 output. See also `translation-table-for-input'.
11858 This variable has a separate binding for each terminal.
11859 See Info node `(elisp)Multiple Terminals'. */);
11861 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11862 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11863 \(Even if the operating system has support for stopping a process.\) */);
11864 cannot_suspend
= 0;
11866 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11867 doc
: /* Non-nil means prompt with menus when appropriate.
11868 This is done when reading from a keymap that has a prompt string,
11869 for elements that have prompt strings.
11870 The menu is displayed on the screen
11871 if X menus were enabled at configuration
11872 time and the previous event was a mouse click prefix key.
11873 Otherwise, menu prompting uses the echo area. */);
11874 menu_prompting
= 1;
11876 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11877 doc
: /* Character to see next line of menu prompt.
11878 Type this character while in a menu prompt to rotate around the lines of it. */);
11879 XSETINT (menu_prompt_more_char
, ' ');
11881 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11882 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11883 Emacs applies the modifiers of the character stored here to each keyboard
11884 character it reads. For example, after evaluating the expression
11885 (setq extra-keyboard-modifiers ?\\C-x)
11886 all input characters will have the control modifier applied to them.
11888 Note that the character ?\\C-@, equivalent to the integer zero, does
11889 not count as a control character; rather, it counts as a character
11890 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11891 cancels any modification. */);
11892 extra_keyboard_modifiers
= 0;
11894 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11895 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11896 The command loop sets this to nil before each command,
11897 and tests the value when the command returns.
11898 Buffer modification stores t in this variable. */);
11899 Vdeactivate_mark
= Qnil
;
11900 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11902 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11903 doc
: /* Normal hook run before each command is executed.
11904 If an unhandled error happens in running this hook,
11905 the function in which the error occurred is unconditionally removed, since
11906 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11907 Vpre_command_hook
= Qnil
;
11909 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11910 doc
: /* Normal hook run after each command is executed.
11911 If an unhandled error happens in running this hook,
11912 the function in which the error occurred is unconditionally removed, since
11913 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11914 Vpost_command_hook
= Qnil
;
11917 DEFVAR_LISP ("echo-area-clear-hook", ...,
11918 doc
: /* Normal hook run when clearing the echo area. */);
11920 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11921 Fset (Qecho_area_clear_hook
, Qnil
);
11923 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11924 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11925 Vlucid_menu_bar_dirty_flag
= Qnil
;
11927 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11928 doc
: /* List of menu bar items to move to the end of the menu bar.
11929 The elements of the list are event types that may have menu bar bindings. */);
11930 Vmenu_bar_final_items
= Qnil
;
11932 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11933 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11934 This is used internally by graphical displays that do not render
11935 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11936 Vtool_bar_separator_image_expression
= Qnil
;
11938 DEFVAR_KBOARD ("overriding-terminal-local-map",
11939 Voverriding_terminal_local_map
,
11940 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11941 If this variable is non-nil, it is used as a keymap instead of the
11942 buffer's local map, and the minor mode keymaps and text property keymaps.
11943 It also replaces `overriding-local-map'.
11945 This variable is intended to let commands such as `universal-argument'
11946 set up a different keymap for reading the next command.
11948 `overriding-terminal-local-map' has a separate binding for each
11950 See Info node `(elisp)Multiple Terminals'. */);
11952 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11953 doc
: /* Keymap that overrides all other local keymaps.
11954 If this variable is non-nil, it is used as a keymap--replacing the
11955 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11956 Voverriding_local_map
= Qnil
;
11958 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11959 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11960 Otherwise, the menu bar continues to reflect the buffer's local map
11961 and the minor mode maps regardless of `overriding-local-map'. */);
11962 Voverriding_local_map_menu_flag
= Qnil
;
11964 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11965 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11966 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11968 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11969 doc
: /* Non-nil means generate motion events for mouse motion. */);
11971 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11972 doc
: /* Alist of system-specific X windows key symbols.
11973 Each element should have the form (N . SYMBOL) where N is the
11974 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11975 and SYMBOL is its name.
11977 `system-key-alist' has a separate binding for each terminal device.
11978 See Info node `(elisp)Multiple Terminals'. */);
11980 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11981 doc
: /* Keymap that translates key sequences to key sequences during input.
11982 This is used mainly for mapping key sequences into some preferred
11983 key events (symbols).
11985 The `read-key-sequence' function replaces any subsequence bound by
11986 `local-function-key-map' with its binding. More precisely, when the
11987 active keymaps have no binding for the current key sequence but
11988 `local-function-key-map' binds a suffix of the sequence to a vector or
11989 string, `read-key-sequence' replaces the matching suffix with its
11990 binding, and continues with the new sequence.
11992 If the binding is a function, it is called with one argument (the prompt)
11993 and its return value (a key sequence) is used.
11995 The events that come from bindings in `local-function-key-map' are not
11996 themselves looked up in `local-function-key-map'.
11998 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11999 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12000 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12001 typing `ESC O P x' would return [f1 x].
12003 `local-function-key-map' has a separate binding for each terminal
12004 device. See Info node `(elisp)Multiple Terminals'. If you need to
12005 define a binding on all terminals, change `function-key-map'
12006 instead. Initially, `local-function-key-map' is an empty keymap that
12007 has `function-key-map' as its parent on all terminal devices. */);
12009 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12010 doc
: /* Keymap that decodes input escape sequences.
12011 This is used mainly for mapping ASCII function key sequences into
12012 real Emacs function key events (symbols).
12014 The `read-key-sequence' function replaces any subsequence bound by
12015 `input-decode-map' with its binding. Contrary to `function-key-map',
12016 this map applies its rebinding regardless of the presence of an ordinary
12017 binding. So it is more like `key-translation-map' except that it applies
12018 before `function-key-map' rather than after.
12020 If the binding is a function, it is called with one argument (the prompt)
12021 and its return value (a key sequence) is used.
12023 The events that come from bindings in `input-decode-map' are not
12024 themselves looked up in `input-decode-map'.
12026 This variable is keyboard-local. */);
12028 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12029 doc
: /* The parent keymap of all `local-function-key-map' instances.
12030 Function key definitions that apply to all terminal devices should go
12031 here. If a mapping is defined in both the current
12032 `local-function-key-map' binding and this variable, then the local
12033 definition will take precedence. */);
12034 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12036 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12037 doc
: /* Keymap of key translations that can override keymaps.
12038 This keymap works like `function-key-map', but comes after that,
12039 and its non-prefix bindings override ordinary bindings.
12040 Another difference is that it is global rather than keyboard-local. */);
12041 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12043 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12044 doc
: /* List of deferred actions to be performed at a later time.
12045 The precise format isn't relevant here; we just check whether it is nil. */);
12046 Vdeferred_action_list
= Qnil
;
12048 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12049 doc
: /* Function to call to handle deferred actions, after each command.
12050 This function is called with no arguments after each command
12051 whenever `deferred-action-list' is non-nil. */);
12052 Vdeferred_action_function
= Qnil
;
12054 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12055 doc
: /* List of warnings to be displayed after this command.
12056 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12057 as per the args of `display-warning' (which see).
12058 If this variable is non-nil, `delayed-warnings-hook' will be run
12059 immediately after running `post-command-hook'. */);
12060 Vdelayed_warnings_list
= Qnil
;
12062 DEFVAR_LISP ("timer-list", Vtimer_list
,
12063 doc
: /* List of active absolute time timers in order of increasing time. */);
12064 Vtimer_list
= Qnil
;
12066 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12067 doc
: /* List of active idle-time timers in order of increasing time. */);
12068 Vtimer_idle_list
= Qnil
;
12070 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12071 doc
: /* If non-nil, the function that implements the current input method.
12072 It's called with one argument, a printing character that was just read.
12073 \(That means a character with code 040...0176.)
12074 Typically this function uses `read-event' to read additional events.
12075 When it does so, it should first bind `input-method-function' to nil
12076 so it will not be called recursively.
12078 The function should return a list of zero or more events
12079 to be used as input. If it wants to put back some events
12080 to be reconsidered, separately, by the input method,
12081 it can add them to the beginning of `unread-command-events'.
12083 The input method function can find in `input-method-previous-message'
12084 the previous echo area message.
12086 The input method function should refer to the variables
12087 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12088 for guidance on what to do. */);
12089 Vinput_method_function
= Qnil
;
12091 DEFVAR_LISP ("input-method-previous-message",
12092 Vinput_method_previous_message
,
12093 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12094 This variable exists because `read-event' clears the echo area
12095 before running the input method. It is nil if there was no message. */);
12096 Vinput_method_previous_message
= Qnil
;
12098 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12099 doc
: /* If non-nil, the function that implements the display of help.
12100 It's called with one argument, the help string to display. */);
12101 Vshow_help_function
= Qnil
;
12103 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12104 doc
: /* If non-nil, suppress point adjustment after executing a command.
12106 After a command is executed, if point is moved into a region that has
12107 special properties (e.g. composition, display), we adjust point to
12108 the boundary of the region. But, when a command sets this variable to
12109 non-nil, we suppress the point adjustment.
12111 This variable is set to nil before reading a command, and is checked
12112 just after executing the command. */);
12113 Vdisable_point_adjustment
= Qnil
;
12115 DEFVAR_LISP ("global-disable-point-adjustment",
12116 Vglobal_disable_point_adjustment
,
12117 doc
: /* If non-nil, always suppress point adjustment.
12119 The default value is nil, in which case, point adjustment are
12120 suppressed only after special commands that set
12121 `disable-point-adjustment' (which see) to non-nil. */);
12122 Vglobal_disable_point_adjustment
= Qnil
;
12124 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12125 doc
: /* How long to display an echo-area message when the minibuffer is active.
12126 If the value is not a number, such messages don't time out. */);
12127 Vminibuffer_message_timeout
= make_number (2);
12129 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12130 doc
: /* If non-nil, any keyboard input throws to this symbol.
12131 The value of that variable is passed to `quit-flag' and later causes a
12132 peculiar kind of quitting. */);
12133 Vthrow_on_input
= Qnil
;
12135 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12136 doc
: /* If non-nil, function to output error messages.
12137 The arguments are the error data, a list of the form
12138 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12139 such as just as `condition-case' would bind its variable to,
12140 the context (a string which normally goes at the start of the message),
12141 and the Lisp function within which the error was signaled. */);
12142 Vcommand_error_function
= Qnil
;
12144 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12145 Venable_disabled_menus_and_buttons
,
12146 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12148 Help functions bind this to allow help on disabled menu items
12149 and tool-bar buttons. */);
12150 Venable_disabled_menus_and_buttons
= Qnil
;
12152 DEFVAR_LISP ("select-active-regions",
12153 Vselect_active_regions
,
12154 doc
: /* If non-nil, an active region automatically sets the primary selection.
12155 If the value is `only', only temporarily active regions (usually made
12156 by mouse-dragging or shift-selection) set the window selection.
12158 This takes effect only when Transient Mark mode is enabled. */);
12159 Vselect_active_regions
= Qt
;
12161 DEFVAR_LISP ("saved-region-selection",
12162 Vsaved_region_selection
,
12163 doc
: /* Contents of active region prior to buffer modification.
12164 If `select-active-regions' is non-nil, Emacs sets this to the
12165 text in the region before modifying the buffer. The next
12166 `deactivate-mark' call uses this to set the window selection. */);
12167 Vsaved_region_selection
= Qnil
;
12169 DEFVAR_LISP ("selection-inhibit-update-commands",
12170 Vselection_inhibit_update_commands
,
12171 doc
: /* List of commands which should not update the selection.
12172 Normally, if `select-active-regions' is non-nil and the mark remains
12173 active after a command (i.e. the mark was not deactivated), the Emacs
12174 command loop sets the selection to the text in the region. However,
12175 if the command is in this list, the selection is not updated. */);
12176 Vselection_inhibit_update_commands
12177 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12179 DEFVAR_LISP ("debug-on-event",
12181 doc
: /* Enter debugger on this event. When Emacs
12182 receives the special event specified by this variable, it will try to
12183 break into the debugger as soon as possible instead of processing the
12184 event normally through `special-event-map'.
12186 Currently, the only supported values for this
12187 variable are `sigusr1' and `sigusr2'. */);
12188 Vdebug_on_event
= intern_c_string ("sigusr2");
12190 /* Create the initial keyboard. */
12191 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12192 init_kboard (initial_kboard
);
12193 /* Vwindow_system is left at t for now. */
12194 initial_kboard
->next_kboard
= all_kboards
;
12195 all_kboards
= initial_kboard
;
12199 keys_of_keyboard (void)
12201 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12202 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12203 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12204 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12205 initial_define_key (meta_map
, 'x', "execute-extended-command");
12207 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12208 "handle-delete-frame");
12209 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12210 "ns-put-working-text");
12211 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12212 "ns-unput-working-text");
12213 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12214 current-prefix-arg, as is done in `handle-switch-frame'.
12215 But `handle-switch-frame is not run from the special-map.
12216 Commands from that map are run in a special way that automatically
12217 preserves the prefix-arg. Restoring the prefix arg here is not just
12218 redundant but harmful:
12220 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12221 - after the first prompt, the exit-minibuffer-hook is run which may
12222 iconify a frame and thus push a `iconify-frame' event.
12223 - after running exit-minibuffer-hook, current-prefix-arg is
12224 restored to the non-nil value it had before the prompt.
12225 - we enter the second prompt.
12226 current-prefix-arg is non-nil, prefix-arg is nil.
12227 - before running the first real event, we run the special iconify-frame
12228 event, but we pass the `special' arg to execute-command so
12229 current-prefix-arg and prefix-arg are left untouched.
12230 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12231 - the next key event will have a spuriously non-nil current-prefix-arg. */
12232 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12234 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12236 /* Handling it at such a low-level causes read_key_sequence to get
12237 * confused because it doesn't realize that the current_buffer was
12238 * changed by read_char.
12240 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12241 * "handle-select-window"); */
12242 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12243 "handle-save-session");
12246 /* Define a special event which is raised for dbus callback
12248 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12249 "dbus-handle-event");
12252 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12256 /* Mark the pointers in the kboard objects.
12257 Called by Fgarbage_collect. */
12259 mark_kboards (void)
12263 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12265 if (kb
->kbd_macro_buffer
)
12266 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12268 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12269 mark_object (KVAR (kb
, Vlast_command
));
12270 mark_object (KVAR (kb
, Vreal_last_command
));
12271 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12272 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12273 mark_object (KVAR (kb
, Vprefix_arg
));
12274 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12275 mark_object (KVAR (kb
, kbd_queue
));
12276 mark_object (KVAR (kb
, defining_kbd_macro
));
12277 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12278 mark_object (KVAR (kb
, Vsystem_key_alist
));
12279 mark_object (KVAR (kb
, system_key_syms
));
12280 mark_object (KVAR (kb
, Vwindow_system
));
12281 mark_object (KVAR (kb
, Vinput_decode_map
));
12282 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12283 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12284 mark_object (KVAR (kb
, echo_string
));
12287 struct input_event
*event
;
12288 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12290 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12291 event
= kbd_buffer
;
12292 if (event
->kind
!= SELECTION_REQUEST_EVENT
12293 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12295 mark_object (event
->x
);
12296 mark_object (event
->y
);
12298 mark_object (event
->frame_or_window
);
12299 mark_object (event
->arg
);