1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
33 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
100 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
101 static int single_kboard
;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled
;
106 static Lisp_Object Qdisabled_command_function
;
108 #define NUM_RECENT_KEYS (300)
110 /* Index for storing next element into recent_keys. */
111 static int recent_keys_index
;
113 /* Total number of elements stored into recent_keys. */
114 static int total_keys
;
116 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
117 static Lisp_Object recent_keys
;
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 ptrdiff_t this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 static int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 static Lisp_Object raw_keybuf
;
134 static int raw_keybuf_count
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
138 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 static ptrdiff_t this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static ptrdiff_t before_command_key_count
;
147 static ptrdiff_t before_command_echo_length
;
149 /* For longjmp to where kbd input is being done. */
151 static jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 int waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
160 /* Non-null means we can start echoing at the next input pause even
161 though there is something in the echo area. */
163 static struct kboard
*ok_to_echo_at_next_pause
;
165 /* The kboard last echoing, or null for none. Reset to 0 in
166 cancel_echoing. If non-null, and a current echo area message
167 exists, and echo_message_buffer is eq to the current message
168 buffer, we know that the message comes from echo_kboard. */
170 struct kboard
*echo_kboard
;
172 /* The buffer used for echoing. Set in echo_now, reset in
175 Lisp_Object echo_message_buffer
;
177 /* Nonzero means C-g should cause immediate error-signal. */
180 /* Character that causes a quit. Normally C-g.
182 If we are running on an ordinary terminal, this must be an ordinary
183 ASCII char, since we want to make it our interrupt character.
185 If we are not running on an ordinary terminal, it still needs to be
186 an ordinary ASCII char. This character needs to be recognized in
187 the input interrupt handler. At this point, the keystroke is
188 represented as a struct input_event, while the desired quit
189 character is specified as a lispy event. The mapping from struct
190 input_events to lispy events cannot run in an interrupt handler,
191 and the reverse mapping is difficult for anything but ASCII
194 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
198 /* Current depth in recursive edits. */
199 EMACS_INT command_loop_level
;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame
;
210 /* Last size recorded for a current buffer which is not a minibuffer. */
211 static ptrdiff_t last_non_minibuf_size
;
213 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
214 uintmax_t num_input_events
;
216 /* Value of num_nonmacro_input_events as of last auto save. */
218 static EMACS_INT last_auto_save
;
220 /* The value of point when the last command was started. */
221 static ptrdiff_t last_point_position
;
223 /* The buffer that was current when the last command was started. */
224 static Lisp_Object last_point_position_buffer
;
226 /* The window that was selected when the last command was started. */
227 static Lisp_Object last_point_position_window
;
229 /* The frame in which the last input event occurred, or Qmacro if the
230 last event came from a macro. We use this to determine when to
231 generate switch-frame events. This may be cleared by functions
232 like Fselect_frame, to make sure that a switch-frame event is
233 generated by the next character. */
234 Lisp_Object internal_last_event_frame
;
236 /* The timestamp of the last input event we received from the X server.
237 X Windows wants this for selection ownership. */
238 Time last_event_timestamp
;
240 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
241 static Lisp_Object Qhandle_select_window
;
242 Lisp_Object QPRIMARY
;
244 static Lisp_Object Qself_insert_command
;
245 static Lisp_Object Qforward_char
;
246 static Lisp_Object Qbackward_char
;
247 Lisp_Object Qundefined
;
248 static Lisp_Object Qtimer_event_handler
;
250 /* read_key_sequence stores here the command definition of the
251 key sequence that it reads. */
252 static Lisp_Object read_key_sequence_cmd
;
253 static Lisp_Object read_key_sequence_remapped
;
255 static Lisp_Object Qinput_method_function
;
257 static Lisp_Object Qdeactivate_mark
;
259 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
261 static Lisp_Object Qecho_area_clear_hook
;
263 /* Hooks to run before and after each command. */
264 static Lisp_Object Qpre_command_hook
;
265 static Lisp_Object Qpost_command_hook
;
267 static Lisp_Object Qdeferred_action_function
;
269 static Lisp_Object Qdelayed_warnings_hook
;
271 static Lisp_Object Qinput_method_exit_on_first_char
;
272 static Lisp_Object Qinput_method_use_echo_area
;
274 static Lisp_Object Qhelp_form_show
;
276 /* File in which we write all commands we read. */
277 static FILE *dribble
;
279 /* Nonzero if input is available. */
282 /* Circular buffer for pre-read keyboard input. */
284 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
286 /* Pointer to next available character in kbd_buffer.
287 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
288 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
289 next available char is in kbd_buffer[0]. */
290 static struct input_event
*kbd_fetch_ptr
;
292 /* Pointer to next place to store character in kbd_buffer. This
293 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
294 character should go in kbd_buffer[0]. */
295 static struct input_event
* volatile kbd_store_ptr
;
297 /* The above pair of variables forms a "queue empty" flag. When we
298 enqueue a non-hook event, we increment kbd_store_ptr. When we
299 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
300 there is input available if the two pointers are not equal.
302 Why not just have a flag set and cleared by the enqueuing and
303 dequeuing functions? Such a flag could be screwed up by interrupts
304 at inopportune times. */
306 /* Symbols to head events. */
307 static Lisp_Object Qmouse_movement
;
308 static Lisp_Object Qscroll_bar_movement
;
309 Lisp_Object Qswitch_frame
;
310 static Lisp_Object Qdelete_frame
;
311 static Lisp_Object Qiconify_frame
;
312 static Lisp_Object Qmake_frame_visible
;
313 static Lisp_Object Qselect_window
;
314 Lisp_Object Qhelp_echo
;
316 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
317 static Lisp_Object Qmouse_fixup_help_message
;
320 /* Symbols to denote kinds of events. */
321 static Lisp_Object Qfunction_key
;
322 Lisp_Object Qmouse_click
;
323 #if defined (WINDOWSNT)
324 Lisp_Object Qlanguage_change
;
326 static Lisp_Object Qdrag_n_drop
;
327 static Lisp_Object Qsave_session
;
329 static Lisp_Object Qdbus_event
;
331 static Lisp_Object Qconfig_changed_event
;
333 /* Lisp_Object Qmouse_movement; - also an event header */
335 /* Properties of event headers. */
336 Lisp_Object Qevent_kind
;
337 static Lisp_Object Qevent_symbol_elements
;
339 /* Menu and tool bar item parts. */
340 static Lisp_Object Qmenu_enable
;
341 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
342 Lisp_Object QCfilter
;
344 /* Non-nil disable property on a command means
345 do not execute it; call disabled-command-function's value instead. */
346 Lisp_Object QCtoggle
, QCradio
;
347 static Lisp_Object QCbutton
, QClabel
;
349 static Lisp_Object QCvert_only
;
351 /* An event header symbol HEAD may have a property named
352 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
353 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
354 mask of modifiers applied to it. If present, this is used to help
355 speed up parse_modifiers. */
356 Lisp_Object Qevent_symbol_element_mask
;
358 /* An unmodified event header BASE may have a property named
359 Qmodifier_cache, which is an alist mapping modifier masks onto
360 modified versions of BASE. If present, this helps speed up
362 static Lisp_Object Qmodifier_cache
;
364 /* Symbols to use for parts of windows. */
365 Lisp_Object Qmode_line
;
366 Lisp_Object Qvertical_line
;
367 static Lisp_Object Qvertical_scroll_bar
;
368 Lisp_Object Qmenu_bar
;
370 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
371 static Lisp_Object
command_loop (void);
372 static Lisp_Object Qextended_command_history
;
373 EMACS_TIME
timer_check (void);
375 static void record_menu_key (Lisp_Object c
);
376 static void echo_now (void);
377 static ptrdiff_t echo_length (void);
379 static Lisp_Object Qpolling_period
;
381 /* Incremented whenever a timer is run. */
384 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
386 EMACS_TIME
*input_available_clear_time
;
388 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
389 Default is 1 if INTERRUPT_INPUT is defined. */
392 /* Nonzero while interrupts are temporarily deferred during redisplay. */
393 int interrupts_deferred
;
395 /* Allow m- file to inhibit use of FIONREAD. */
396 #ifdef BROKEN_FIONREAD
400 /* We are unable to use interrupts if FIONREAD is not available,
401 so flush SIGIO so we won't try. */
402 #if !defined (FIONREAD)
408 /* If we support a window system, turn on the code to poll periodically
409 to detect C-g. It isn't actually used when doing interrupt input. */
410 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
411 #define POLL_FOR_INPUT
414 /* The time when Emacs started being idle. */
416 static EMACS_TIME timer_idleness_start_time
;
418 /* After Emacs stops being idle, this saves the last value
419 of timer_idleness_start_time from when it was idle. */
421 static EMACS_TIME timer_last_idleness_start_time
;
424 /* Global variable declarations. */
426 /* Flags for readable_events. */
427 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
428 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
429 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
431 /* Function for init_keyboard to call with no args (if nonzero). */
432 static void (*keyboard_init_hook
) (void);
434 static int read_avail_input (int);
435 static void get_input_pending (int *, int);
436 static int readable_events (int);
437 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
439 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
441 static Lisp_Object
make_lispy_event (struct input_event
*);
442 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
443 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
444 enum scroll_bar_part
,
445 Lisp_Object
, Lisp_Object
,
448 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
449 Lisp_Object
, const char *const *,
450 Lisp_Object
*, ptrdiff_t);
451 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
452 static int help_char_p (Lisp_Object
);
453 static void save_getcjmp (jmp_buf);
454 static void restore_getcjmp (jmp_buf);
455 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
456 static void clear_event (struct input_event
*);
457 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
458 static void interrupt_signal (int signalnum
);
460 static void input_available_signal (int signo
);
462 static void handle_interrupt (void);
463 static _Noreturn
void quit_throw_to_read_char (int);
464 static void process_special_events (void);
465 static void timer_start_idle (void);
466 static void timer_stop_idle (void);
467 static void timer_resume_idle (void);
468 static void handle_user_signal (int);
469 static char *find_user_signal_name (int);
470 static int store_user_signal_events (void);
473 /* Add C to the echo string, if echoing is going on.
474 C can be a character, which is printed prettily ("M-C-x" and all that
475 jazz), or a symbol, whose name is printed. */
478 echo_char (Lisp_Object c
)
480 if (current_kboard
->immediate_echo
)
482 int size
= KEY_DESCRIPTION_SIZE
+ 100;
483 char *buffer
= alloca (size
);
485 Lisp_Object echo_string
;
487 echo_string
= KVAR (current_kboard
, echo_string
);
489 /* If someone has passed us a composite event, use its head symbol. */
494 ptr
= push_key_description (XINT (c
), ptr
, 1);
496 else if (SYMBOLP (c
))
498 Lisp_Object name
= SYMBOL_NAME (c
);
499 int nbytes
= SBYTES (name
);
501 if (size
- (ptr
- buffer
) < nbytes
)
503 int offset
= ptr
- buffer
;
504 size
= max (2 * size
, size
+ nbytes
);
505 buffer
= alloca (size
);
506 ptr
= buffer
+ offset
;
509 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
510 STRING_MULTIBYTE (name
), 1);
513 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
516 const char *text
= " (Type ? for further options)";
517 int len
= strlen (text
);
519 if (size
- (ptr
- buffer
) < len
)
521 int offset
= ptr
- buffer
;
523 buffer
= alloca (size
);
524 ptr
= buffer
+ offset
;
527 memcpy (ptr
, text
, len
);
531 /* Replace a dash from echo_dash with a space, otherwise
532 add a space at the end as a separator between keys. */
533 if (STRINGP (echo_string
)
534 && SCHARS (echo_string
) > 1)
536 Lisp_Object last_char
, prev_char
, idx
;
538 idx
= make_number (SCHARS (echo_string
) - 2);
539 prev_char
= Faref (echo_string
, idx
);
541 idx
= make_number (SCHARS (echo_string
) - 1);
542 last_char
= Faref (echo_string
, idx
);
544 /* We test PREV_CHAR to make sure this isn't the echoing
546 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
547 Faset (echo_string
, idx
, make_number (' '));
549 echo_string
= concat2 (echo_string
, build_string (" "));
551 else if (STRINGP (echo_string
))
552 echo_string
= concat2 (echo_string
, build_string (" "));
554 KVAR (current_kboard
, echo_string
)
555 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
561 /* Temporarily add a dash to the end of the echo string if it's not
562 empty, so that it serves as a mini-prompt for the very next character. */
567 /* Do nothing if not echoing at all. */
568 if (NILP (KVAR (current_kboard
, echo_string
)))
571 if (this_command_key_count
== 0)
574 if (!current_kboard
->immediate_echo
575 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
578 /* Do nothing if we just printed a prompt. */
579 if (current_kboard
->echo_after_prompt
580 == SCHARS (KVAR (current_kboard
, echo_string
)))
583 /* Do nothing if we have already put a dash at the end. */
584 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
586 Lisp_Object last_char
, prev_char
, idx
;
588 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
589 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
591 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
592 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
594 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
598 /* Put a dash at the end of the buffer temporarily,
599 but make it go away when the next character is added. */
600 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
605 /* Display the current echo string, and begin echoing if not already
611 if (!current_kboard
->immediate_echo
)
614 current_kboard
->immediate_echo
= 1;
616 for (i
= 0; i
< this_command_key_count
; i
++)
620 /* Set before_command_echo_length to the value that would
621 have been saved before the start of this subcommand in
622 command_loop_1, if we had already been echoing then. */
623 if (i
== this_single_command_key_start
)
624 before_command_echo_length
= echo_length ();
626 c
= AREF (this_command_keys
, i
);
627 if (! (EVENT_HAS_PARAMETERS (c
)
628 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
632 /* Set before_command_echo_length to the value that would
633 have been saved before the start of this subcommand in
634 command_loop_1, if we had already been echoing then. */
635 if (this_command_key_count
== this_single_command_key_start
)
636 before_command_echo_length
= echo_length ();
638 /* Put a dash at the end to invite the user to type more. */
643 message3_nolog (KVAR (current_kboard
, echo_string
),
644 SBYTES (KVAR (current_kboard
, echo_string
)),
645 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
648 /* Record in what buffer we echoed, and from which kboard. */
649 echo_message_buffer
= echo_area_buffer
[0];
650 echo_kboard
= current_kboard
;
652 if (waiting_for_input
&& !NILP (Vquit_flag
))
653 quit_throw_to_read_char (0);
656 /* Turn off echoing, for the start of a new command. */
659 cancel_echoing (void)
661 current_kboard
->immediate_echo
= 0;
662 current_kboard
->echo_after_prompt
= -1;
663 KVAR (current_kboard
, echo_string
) = Qnil
;
664 ok_to_echo_at_next_pause
= NULL
;
666 echo_message_buffer
= Qnil
;
669 /* Return the length of the current echo string. */
674 return (STRINGP (KVAR (current_kboard
, echo_string
))
675 ? SCHARS (KVAR (current_kboard
, echo_string
))
679 /* Truncate the current echo message to its first LEN chars.
680 This and echo_char get used by read_key_sequence when the user
681 switches frames while entering a key sequence. */
684 echo_truncate (ptrdiff_t nchars
)
686 if (STRINGP (KVAR (current_kboard
, echo_string
)))
687 KVAR (current_kboard
, echo_string
)
688 = Fsubstring (KVAR (current_kboard
, echo_string
),
689 make_number (0), make_number (nchars
));
690 truncate_echo_area (nchars
);
694 /* Functions for manipulating this_command_keys. */
696 add_command_key (Lisp_Object key
)
698 #if 0 /* Not needed after we made Freset_this_command_lengths
699 do the job immediately. */
700 /* If reset-this-command-length was called recently, obey it now.
701 See the doc string of that function for an explanation of why. */
702 if (before_command_restore_flag
)
704 this_command_key_count
= before_command_key_count_1
;
705 if (this_command_key_count
< this_single_command_key_start
)
706 this_single_command_key_start
= this_command_key_count
;
707 echo_truncate (before_command_echo_length_1
);
708 before_command_restore_flag
= 0;
712 if (this_command_key_count
>= ASIZE (this_command_keys
))
713 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
715 ASET (this_command_keys
, this_command_key_count
, key
);
716 ++this_command_key_count
;
721 recursive_edit_1 (void)
723 ptrdiff_t count
= SPECPDL_INDEX ();
726 if (command_loop_level
> 0)
728 specbind (Qstandard_output
, Qt
);
729 specbind (Qstandard_input
, Qt
);
732 #ifdef HAVE_WINDOW_SYSTEM
733 /* The command loop has started an hourglass timer, so we have to
734 cancel it here, otherwise it will fire because the recursive edit
735 can take some time. Do not check for display_hourglass_p here,
736 because it could already be nil. */
740 /* This function may have been called from a debugger called from
741 within redisplay, for instance by Edebugging a function called
742 from fontification-functions. We want to allow redisplay in
743 the debugging session.
745 The recursive edit is left with a `(throw exit ...)'. The `exit'
746 tag is not caught anywhere in redisplay, i.e. when we leave the
747 recursive edit, the original redisplay leading to the recursive
748 edit will be unwound. The outcome should therefore be safe. */
749 specbind (Qinhibit_redisplay
, Qnil
);
752 val
= command_loop ();
754 Fsignal (Qquit
, Qnil
);
755 /* Handle throw from read_minibuf when using minibuffer
756 while it's active but we're in another window. */
758 xsignal1 (Qerror
, val
);
760 return unbind_to (count
, Qnil
);
763 /* When an auto-save happens, record the "time", and don't do again soon. */
766 record_auto_save (void)
768 last_auto_save
= num_nonmacro_input_events
;
771 /* Make an auto save happen as soon as possible at command level. */
775 force_auto_save_soon (void)
777 last_auto_save
= - auto_save_interval
- 1;
779 record_asynch_buffer_change ();
783 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
784 doc
: /* Invoke the editor command loop recursively.
785 To get out of the recursive edit, a command can do `(throw 'exit nil)';
786 that tells this function to return.
787 Alternatively, `(throw 'exit t)' makes this function signal an error.
788 This function is called by the editor initialization to begin editing. */)
791 ptrdiff_t count
= SPECPDL_INDEX ();
794 /* If we enter while input is blocked, don't lock up here.
795 This may happen through the debugger during redisplay. */
799 command_loop_level
++;
800 update_mode_lines
= 1;
802 if (command_loop_level
803 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
804 buffer
= Fcurrent_buffer ();
808 /* If we leave recursive_edit_1 below with a `throw' for instance,
809 like it is done in the splash screen display, we have to
810 make sure that we restore single_kboard as command_loop_1
811 would have done if it were left normally. */
812 if (command_loop_level
> 0)
813 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
814 record_unwind_protect (recursive_edit_unwind
, buffer
);
817 return unbind_to (count
, Qnil
);
821 recursive_edit_unwind (Lisp_Object buffer
)
823 if (BUFFERP (buffer
))
824 Fset_buffer (buffer
);
826 command_loop_level
--;
827 update_mode_lines
= 1;
832 #if 0 /* These two functions are now replaced with
833 temporarily_switch_to_single_kboard. */
837 #if 0 /* Theory: if there's anything in Vunread_command_events,
838 it will right away be read by read_key_sequence,
839 and then if we do switch KBOARDS, it will go into the side
840 queue then. So we don't need to do anything special here -- rms. */
841 if (CONSP (Vunread_command_events
))
843 current_kboard
->kbd_queue
844 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
845 current_kboard
->kbd_queue_has_data
= 1;
847 Vunread_command_events
= Qnil
;
852 /* Switch to the single-kboard state, making current_kboard
853 the only KBOARD from which further input is accepted. */
856 single_kboard_state ()
862 /* If we're in single_kboard state for kboard KBOARD,
866 not_single_kboard_state (KBOARD
*kboard
)
868 if (kboard
== current_kboard
)
872 /* Maintain a stack of kboards, so other parts of Emacs
873 can switch temporarily to the kboard of a given frame
874 and then revert to the previous status. */
879 struct kboard_stack
*next
;
882 static struct kboard_stack
*kboard_stack
;
885 push_kboard (struct kboard
*k
)
887 struct kboard_stack
*p
= xmalloc (sizeof *p
);
889 p
->next
= kboard_stack
;
890 p
->kboard
= current_kboard
;
900 struct kboard_stack
*p
= kboard_stack
;
902 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
904 if (t
->kboard
== p
->kboard
)
906 current_kboard
= p
->kboard
;
913 /* The terminal we remembered has been deleted. */
914 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
917 kboard_stack
= p
->next
;
921 /* Switch to single_kboard mode, making current_kboard the only KBOARD
922 from which further input is accepted. If F is non-nil, set its
923 KBOARD as the current keyboard.
925 This function uses record_unwind_protect to return to the previous
928 If Emacs is already in single_kboard mode, and F's keyboard is
929 locked, then this function will throw an error. */
932 temporarily_switch_to_single_kboard (struct frame
*f
)
934 int was_locked
= single_kboard
;
937 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
938 /* We can not switch keyboards while in single_kboard mode.
939 In rare cases, Lisp code may call `recursive-edit' (or
940 `read-minibuffer' or `y-or-n-p') after it switched to a
941 locked frame. For example, this is likely to happen
942 when server.el connects to a new terminal while Emacs is in
943 single_kboard mode. It is best to throw an error instead
944 of presenting the user with a frozen screen. */
945 error ("Terminal %d is locked, cannot read from it",
946 FRAME_TERMINAL (f
)->id
);
948 /* This call is unnecessary, but helps
949 `restore_kboard_configuration' discover if somebody changed
950 `current_kboard' behind our back. */
951 push_kboard (current_kboard
);
954 current_kboard
= FRAME_KBOARD (f
);
956 record_unwind_protect (restore_kboard_configuration
,
957 (was_locked
? Qt
: Qnil
));
960 #if 0 /* This function is not needed anymore. */
962 record_single_kboard_state ()
965 push_kboard (current_kboard
);
966 record_unwind_protect (restore_kboard_configuration
,
967 (single_kboard
? Qt
: Qnil
));
972 restore_kboard_configuration (Lisp_Object was_locked
)
974 if (NILP (was_locked
))
978 struct kboard
*prev
= current_kboard
;
981 /* The pop should not change the kboard. */
982 if (single_kboard
&& current_kboard
!= prev
)
989 /* Handle errors that are not handled at inner levels
990 by printing an error message and returning to the editor command loop. */
993 cmd_error (Lisp_Object data
)
995 Lisp_Object old_level
, old_length
;
996 char macroerror
[sizeof "After..kbd macro iterations: "
997 + INT_STRLEN_BOUND (EMACS_INT
)];
999 #ifdef HAVE_WINDOW_SYSTEM
1000 if (display_hourglass_p
)
1001 cancel_hourglass ();
1004 if (!NILP (executing_kbd_macro
))
1006 if (executing_kbd_macro_iterations
== 1)
1007 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1009 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1010 executing_kbd_macro_iterations
);
1015 Vstandard_output
= Qt
;
1016 Vstandard_input
= Qt
;
1017 Vexecuting_kbd_macro
= Qnil
;
1018 executing_kbd_macro
= Qnil
;
1019 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1020 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1023 /* Avoid unquittable loop if data contains a circular list. */
1024 old_level
= Vprint_level
;
1025 old_length
= Vprint_length
;
1026 XSETFASTINT (Vprint_level
, 10);
1027 XSETFASTINT (Vprint_length
, 10);
1028 cmd_error_internal (data
, macroerror
);
1029 Vprint_level
= old_level
;
1030 Vprint_length
= old_length
;
1034 Vinhibit_quit
= Qnil
;
1035 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1036 if (command_loop_level
== 0 && minibuf_level
== 0)
1037 any_kboard_state ();
1040 return make_number (0);
1043 /* Take actions on handling an error. DATA is the data that describes
1046 CONTEXT is a C-string containing ASCII characters only which
1047 describes the context in which the error happened. If we need to
1048 generalize CONTEXT to allow multibyte characters, make it a Lisp
1052 cmd_error_internal (Lisp_Object data
, const char *context
)
1054 struct frame
*sf
= SELECTED_FRAME ();
1056 /* The immediate context is not interesting for Quits,
1057 since they are asynchronous. */
1058 if (EQ (XCAR (data
), Qquit
))
1059 Vsignaling_function
= Qnil
;
1064 /* Use user's specified output function if any. */
1065 if (!NILP (Vcommand_error_function
))
1066 call3 (Vcommand_error_function
, data
,
1067 context
? build_string (context
) : empty_unibyte_string
,
1068 Vsignaling_function
);
1069 /* If the window system or terminal frame hasn't been initialized
1070 yet, or we're not interactive, write the message to stderr and exit. */
1071 else if (!sf
->glyphs_initialized_p
1072 /* The initial frame is a special non-displaying frame. It
1073 will be current in daemon mode when there are no frames
1074 to display, and in non-daemon mode before the real frame
1075 has finished initializing. If an error is thrown in the
1076 latter case while creating the frame, then the frame
1077 will never be displayed, so the safest thing to do is
1078 write to stderr and quit. In daemon mode, there are
1079 many other potential errors that do not prevent frames
1080 from being created, so continuing as normal is better in
1082 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1085 print_error_message (data
, Qexternal_debugging_output
,
1086 context
, Vsignaling_function
);
1087 Fterpri (Qexternal_debugging_output
);
1088 Fkill_emacs (make_number (-1));
1092 clear_message (1, 0);
1094 message_log_maybe_newline ();
1097 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1100 Vsignaling_function
= Qnil
;
1103 Lisp_Object
command_loop_1 (void);
1104 static Lisp_Object
command_loop_2 (Lisp_Object
);
1105 static Lisp_Object
top_level_1 (Lisp_Object
);
1107 /* Entry to editor-command-loop.
1108 This level has the catches for exiting/returning to editor command loop.
1109 It returns nil to exit recursive edit, t to abort it. */
1114 if (command_loop_level
> 0 || minibuf_level
> 0)
1117 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1118 executing_kbd_macro
= Qnil
;
1124 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1125 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1126 /* Reset single_kboard in case top-level set it while
1127 evaluating an -f option, or we are stuck there for some
1129 any_kboard_state ();
1131 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1132 executing_kbd_macro
= Qnil
;
1134 /* End of file in -batch run causes exit here. */
1140 /* Here we catch errors in execution of commands within the
1141 editing loop, and reenter the editing loop.
1142 When there is an error, cmd_error runs and returns a non-nil
1143 value to us. A value of nil means that command_loop_1 itself
1144 returned due to end of file (or end of kbd macro). */
1147 command_loop_2 (Lisp_Object ignore
)
1149 register Lisp_Object val
;
1152 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1153 while (!NILP (val
));
1161 return Feval (Vtop_level
, Qnil
);
1165 top_level_1 (Lisp_Object ignore
)
1167 /* On entry to the outer level, run the startup file */
1168 if (!NILP (Vtop_level
))
1169 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1170 else if (!NILP (Vpurify_flag
))
1171 message ("Bare impure Emacs (standard Lisp code not loaded)");
1173 message ("Bare Emacs (standard Lisp code not loaded)");
1177 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1178 doc
: /* Exit all recursive editing levels.
1179 This also exits all active minibuffers. */)
1182 #ifdef HAVE_WINDOW_SYSTEM
1183 if (display_hourglass_p
)
1184 cancel_hourglass ();
1187 /* Unblock input if we enter with input blocked. This may happen if
1188 redisplay traps e.g. during tool-bar update with input blocked. */
1189 while (INPUT_BLOCKED_P
)
1192 Fthrow (Qtop_level
, Qnil
);
1195 static _Noreturn
void
1196 user_error (const char *msg
)
1198 xsignal1 (Quser_error
, build_string (msg
));
1202 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1203 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1206 if (command_loop_level
> 0 || minibuf_level
> 0)
1207 Fthrow (Qexit
, Qnil
);
1209 user_error ("No recursive edit is in progress");
1213 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1214 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1217 if (command_loop_level
> 0 || minibuf_level
> 0)
1220 user_error ("No recursive edit is in progress");
1223 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1225 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1226 of this function. */
1229 tracking_off (Lisp_Object old_value
)
1231 do_mouse_tracking
= old_value
;
1232 if (NILP (old_value
))
1234 /* Redisplay may have been preempted because there was input
1235 available, and it assumes it will be called again after the
1236 input has been processed. If the only input available was
1237 the sort that we have just disabled, then we need to call
1239 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1241 redisplay_preserve_echo_area (6);
1242 get_input_pending (&input_pending
,
1243 READABLE_EVENTS_DO_TIMERS_NOW
);
1249 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1250 doc
: /* Evaluate BODY with mouse movement events enabled.
1251 Within a `track-mouse' form, mouse motion generates input events that
1252 you can read with `read-event'.
1253 Normally, mouse motion is ignored.
1254 usage: (track-mouse BODY...) */)
1257 ptrdiff_t count
= SPECPDL_INDEX ();
1260 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1262 do_mouse_tracking
= Qt
;
1264 val
= Fprogn (args
);
1265 return unbind_to (count
, val
);
1268 /* If mouse has moved on some frame, return one of those frames.
1272 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1273 after resizing the tool-bar window. */
1275 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1278 int ignore_mouse_drag_p
;
1281 some_mouse_moved (void)
1283 Lisp_Object tail
, frame
;
1285 if (ignore_mouse_drag_p
)
1287 /* ignore_mouse_drag_p = 0; */
1291 FOR_EACH_FRAME (tail
, frame
)
1293 if (XFRAME (frame
)->mouse_moved
)
1294 return XFRAME (frame
);
1300 #endif /* HAVE_MOUSE || HAVE_GPM */
1302 /* This is the actual command reading loop,
1303 sans error-handling encapsulation. */
1305 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1307 void safe_run_hooks (Lisp_Object
);
1308 static void adjust_point_for_property (ptrdiff_t, int);
1310 /* Cancel hourglass from protect_unwind.
1312 #ifdef HAVE_WINDOW_SYSTEM
1314 cancel_hourglass_unwind (Lisp_Object arg
)
1316 cancel_hourglass ();
1321 /* The last boundary auto-added to buffer-undo-list. */
1322 Lisp_Object last_undo_boundary
;
1324 /* FIXME: This is wrong rather than test window-system, we should call
1325 a new set-selection, which will then dispatch to x-set-selection, or
1326 tty-set-selection, or w32-set-selection, ... */
1329 command_loop_1 (void)
1332 Lisp_Object keybuf
[30];
1334 EMACS_INT prev_modiff
= 0;
1335 struct buffer
*prev_buffer
= NULL
;
1336 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1337 int was_locked
= single_kboard
;
1339 int already_adjusted
= 0;
1341 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1342 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1343 Vdeactivate_mark
= Qnil
;
1344 waiting_for_input
= 0;
1347 this_command_key_count
= 0;
1348 this_command_key_count_reset
= 0;
1349 this_single_command_key_start
= 0;
1351 if (NILP (Vmemory_full
))
1353 /* Make sure this hook runs after commands that get errors and
1354 throw to top level. */
1355 /* Note that the value cell will never directly contain nil
1356 if the symbol is a local variable. */
1357 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1358 safe_run_hooks (Qpost_command_hook
);
1360 /* If displaying a message, resize the echo area window to fit
1361 that message's size exactly. */
1362 if (!NILP (echo_area_buffer
[0]))
1363 resize_echo_area_exactly ();
1365 /* If there are warnings waiting, process them. */
1366 if (!NILP (Vdelayed_warnings_list
))
1367 safe_run_hooks (Qdelayed_warnings_hook
);
1369 if (!NILP (Vdeferred_action_list
))
1370 safe_run_hooks (Qdeferred_action_function
);
1373 /* Do this after running Vpost_command_hook, for consistency. */
1374 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1375 KVAR (current_kboard
, Vreal_last_command
) = Vreal_this_command
;
1376 if (!CONSP (last_command_event
))
1377 KVAR (current_kboard
, Vlast_repeatable_command
) = Vreal_this_command
;
1381 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1384 /* Make sure the current window's buffer is selected. */
1385 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1386 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1388 /* Display any malloc warning that just came out. Use while because
1389 displaying one warning can cause another. */
1391 while (pending_malloc_warning
)
1392 display_malloc_warning ();
1394 Vdeactivate_mark
= Qnil
;
1396 /* If minibuffer on and echo area in use,
1397 wait a short time and redraw minibuffer. */
1400 && !NILP (echo_area_buffer
[0])
1401 && EQ (minibuf_window
, echo_area_window
)
1402 && NUMBERP (Vminibuffer_message_timeout
))
1404 /* Bind inhibit-quit to t so that C-g gets read in
1405 rather than quitting back to the minibuffer. */
1406 ptrdiff_t count
= SPECPDL_INDEX ();
1407 specbind (Qinhibit_quit
, Qt
);
1409 sit_for (Vminibuffer_message_timeout
, 0, 2);
1411 /* Clear the echo area. */
1413 safe_run_hooks (Qecho_area_clear_hook
);
1415 unbind_to (count
, Qnil
);
1417 /* If a C-g came in before, treat it as input now. */
1418 if (!NILP (Vquit_flag
))
1421 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1426 /* Select the frame that the last event came from. Usually,
1427 switch-frame events will take care of this, but if some lisp
1428 code swallows a switch-frame event, we'll fix things up here.
1429 Is this a good idea? */
1430 if (FRAMEP (internal_last_event_frame
)
1431 && !EQ (internal_last_event_frame
, selected_frame
))
1432 Fselect_frame (internal_last_event_frame
, Qnil
);
1434 /* If it has changed current-menubar from previous value,
1435 really recompute the menubar from the value. */
1436 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1437 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1438 call0 (Qrecompute_lucid_menubar
);
1440 before_command_key_count
= this_command_key_count
;
1441 before_command_echo_length
= echo_length ();
1443 Vthis_command
= Qnil
;
1444 Vreal_this_command
= Qnil
;
1445 Vthis_original_command
= Qnil
;
1446 Vthis_command_keys_shift_translated
= Qnil
;
1448 /* Read next key sequence; i gets its length. */
1449 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1452 /* A filter may have run while we were reading the input. */
1453 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1455 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1456 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1460 /* Now we have read a key sequence of length I,
1461 or else I is 0 and we found end of file. */
1463 if (i
== 0) /* End of file -- happens only in */
1464 return Qnil
; /* a kbd macro, at the end. */
1465 /* -1 means read_key_sequence got a menu that was rejected.
1466 Just loop around and read another command. */
1470 this_command_key_count
= 0;
1471 this_command_key_count_reset
= 0;
1472 this_single_command_key_start
= 0;
1476 last_command_event
= keybuf
[i
- 1];
1478 /* If the previous command tried to force a specific window-start,
1479 forget about that, in case this command moves point far away
1480 from that position. But also throw away beg_unchanged and
1481 end_unchanged information in that case, so that redisplay will
1482 update the whole window properly. */
1483 if (XWINDOW (selected_window
)->force_start
)
1486 XWINDOW (selected_window
)->force_start
= 0;
1487 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1488 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1491 cmd
= read_key_sequence_cmd
;
1492 if (!NILP (Vexecuting_kbd_macro
))
1494 if (!NILP (Vquit_flag
))
1496 Vexecuting_kbd_macro
= Qt
;
1497 QUIT
; /* Make some noise. */
1498 /* Will return since macro now empty. */
1502 /* Do redisplay processing after this command except in special
1503 cases identified below. */
1504 prev_buffer
= current_buffer
;
1505 prev_modiff
= MODIFF
;
1506 last_point_position
= PT
;
1507 last_point_position_window
= selected_window
;
1508 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1510 /* By default, we adjust point to a boundary of a region that
1511 has such a property that should be treated intangible
1512 (e.g. composition, display). But, some commands will set
1513 this variable differently. */
1514 Vdisable_point_adjustment
= Qnil
;
1516 /* Process filters and timers may have messed with deactivate-mark.
1517 reset it before we execute the command. */
1518 Vdeactivate_mark
= Qnil
;
1520 /* Remap command through active keymaps. */
1521 Vthis_original_command
= cmd
;
1522 if (!NILP (read_key_sequence_remapped
))
1523 cmd
= read_key_sequence_remapped
;
1525 /* Execute the command. */
1527 Vthis_command
= cmd
;
1528 Vreal_this_command
= cmd
;
1529 safe_run_hooks (Qpre_command_hook
);
1531 already_adjusted
= 0;
1533 if (NILP (Vthis_command
))
1535 /* nil means key is undefined. */
1536 Lisp_Object keys
= Fvector (i
, keybuf
);
1537 keys
= Fkey_description (keys
, Qnil
);
1539 message_with_string ("%s is undefined", keys
, 0);
1540 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1541 update_mode_lines
= 1;
1542 /* If this is a down-mouse event, don't reset prefix-arg;
1543 pass it to the command run by the up event. */
1544 if (EVENT_HAS_PARAMETERS (last_command_event
))
1546 Lisp_Object breakdown
1547 = parse_modifiers (EVENT_HEAD (last_command_event
));
1548 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1549 if (!(modifiers
& down_modifier
))
1550 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1553 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1557 /* Here for a command that isn't executed directly. */
1559 #ifdef HAVE_WINDOW_SYSTEM
1560 ptrdiff_t scount
= SPECPDL_INDEX ();
1562 if (display_hourglass_p
1563 && NILP (Vexecuting_kbd_macro
))
1565 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1570 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1572 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1575 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1576 ? Qnil
: BVAR (current_buffer
, undo_list
));
1578 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1580 #ifdef HAVE_WINDOW_SYSTEM
1581 /* Do not check display_hourglass_p here, because
1582 Fcommand_execute could change it, but we should cancel
1583 hourglass cursor anyway.
1584 But don't cancel the hourglass within a macro
1585 just because a command in the macro finishes. */
1586 if (NILP (Vexecuting_kbd_macro
))
1587 unbind_to (scount
, Qnil
);
1590 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1592 safe_run_hooks (Qpost_command_hook
);
1594 /* If displaying a message, resize the echo area window to fit
1595 that message's size exactly. */
1596 if (!NILP (echo_area_buffer
[0]))
1597 resize_echo_area_exactly ();
1599 /* If there are warnings waiting, process them. */
1600 if (!NILP (Vdelayed_warnings_list
))
1601 safe_run_hooks (Qdelayed_warnings_hook
);
1603 safe_run_hooks (Qdeferred_action_function
);
1605 /* If there is a prefix argument,
1606 1) We don't want Vlast_command to be ``universal-argument''
1607 (that would be dumb), so don't set Vlast_command,
1608 2) we want to leave echoing on so that the prefix will be
1609 echoed as part of this key sequence, so don't call
1611 3) we want to leave this_command_key_count non-zero, so that
1612 read_char will realize that it is re-reading a character, and
1613 not echo it a second time.
1615 If the command didn't actually create a prefix arg,
1616 but is merely a frame event that is transparent to prefix args,
1617 then the above doesn't apply. */
1618 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1619 || CONSP (last_command_event
))
1621 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1622 KVAR (current_kboard
, Vreal_last_command
) = Vreal_this_command
;
1623 if (!CONSP (last_command_event
))
1624 KVAR (current_kboard
, Vlast_repeatable_command
)
1625 = Vreal_this_command
;
1627 this_command_key_count
= 0;
1628 this_command_key_count_reset
= 0;
1629 this_single_command_key_start
= 0;
1632 if (!NILP (BVAR (current_buffer
, mark_active
))
1633 && !NILP (Vrun_hooks
))
1635 /* In Emacs 22, setting transient-mark-mode to `only' was a
1636 way of turning it on for just one command. This usage is
1637 obsolete, but support it anyway. */
1638 if (EQ (Vtransient_mark_mode
, Qidentity
))
1639 Vtransient_mark_mode
= Qnil
;
1640 else if (EQ (Vtransient_mark_mode
, Qonly
))
1641 Vtransient_mark_mode
= Qidentity
;
1643 if (!NILP (Vdeactivate_mark
))
1644 /* If `select-active-regions' is non-nil, this call to
1645 `deactivate-mark' also sets the PRIMARY selection. */
1646 call0 (Qdeactivate_mark
);
1649 /* Even if not deactivating the mark, set PRIMARY if
1650 `select-active-regions' is non-nil. */
1651 if (!NILP (Fwindow_system (Qnil
))
1652 /* Even if mark_active is non-nil, the actual buffer
1653 marker may not have been set yet (Bug#7044). */
1654 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1655 && (EQ (Vselect_active_regions
, Qonly
)
1656 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1657 : (!NILP (Vselect_active_regions
)
1658 && !NILP (Vtransient_mark_mode
)))
1659 && NILP (Fmemq (Vthis_command
,
1660 Vselection_inhibit_update_commands
)))
1663 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1666 call2 (Qx_set_selection
, QPRIMARY
,
1667 make_buffer_string (beg
, end
, 0));
1669 call2 (Qx_set_selection
, QPRIMARY
,
1670 make_buffer_string (end
, beg
, 0));
1671 /* Don't set empty selections. */
1674 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1676 Lisp_Object hook
= intern ("activate-mark-hook");
1677 Frun_hooks (1, &hook
);
1681 Vsaved_region_selection
= Qnil
;
1686 if (current_buffer
== prev_buffer
1687 && last_point_position
!= PT
1688 && NILP (Vdisable_point_adjustment
)
1689 && NILP (Vglobal_disable_point_adjustment
))
1691 if (last_point_position
> BEGV
1692 && last_point_position
< ZV
1693 && (composition_adjust_point (last_point_position
,
1694 last_point_position
)
1695 != last_point_position
))
1696 /* The last point was temporarily set within a grapheme
1697 cluster to prevent automatic composition. To recover
1698 the automatic composition, we must update the
1700 windows_or_buffers_changed
++;
1701 if (!already_adjusted
)
1702 adjust_point_for_property (last_point_position
,
1703 MODIFF
!= prev_modiff
);
1706 /* Install chars successfully executed in kbd macro. */
1708 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1709 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1710 finalize_kbd_macro_chars ();
1711 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1713 any_kboard_state ();
1718 /* Adjust point to a boundary of a region that has such a property
1719 that should be treated intangible. For the moment, we check
1720 `composition', `display' and `invisible' properties.
1721 LAST_PT is the last position of point. */
1724 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1727 Lisp_Object val
, overlay
, tmp
;
1728 /* When called after buffer modification, we should temporarily
1729 suppress the point adjustment for automatic composition so that a
1730 user can keep inserting another character at point or keep
1731 deleting characters around point. */
1732 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1733 ptrdiff_t orig_pt
= PT
;
1735 /* FIXME: cycling is probably not necessary because these properties
1736 can't be usefully combined anyway. */
1737 while (check_composition
|| check_display
|| check_invisible
)
1739 /* FIXME: check `intangible'. */
1740 if (check_composition
1741 && PT
> BEGV
&& PT
< ZV
1742 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1745 check_display
= check_invisible
= 1;
1747 check_composition
= 0;
1749 && PT
> BEGV
&& PT
< ZV
1750 && !NILP (val
= get_char_property_and_overlay
1751 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1752 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1753 && (!OVERLAYP (overlay
)
1754 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1755 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1756 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1757 && (beg
< PT
/* && end > PT <- It's always the case. */
1758 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1761 SET_PT (PT
< last_pt
1762 ? (STRINGP (val
) && SCHARS (val
) == 0
1763 ? max (beg
- 1, BEGV
)
1766 check_composition
= check_invisible
= 1;
1769 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1771 int inv
, ellipsis
= 0;
1774 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1777 /* FIXME: We should stop if we find a spot between
1778 two runs of `invisible' where inserted text would
1779 be visible. This is important when we have two
1780 invisible boundaries that enclose an area: if the
1781 area is empty, we need this test in order to make
1782 it possible to place point in the middle rather
1783 than skip both boundaries. However, this code
1784 also stops anywhere in a non-sticky text-property,
1785 which breaks (e.g.) Org mode. */
1786 && (val
= get_pos_property (make_number (end
),
1788 TEXT_PROP_MEANS_INVISIBLE (val
))
1790 && !NILP (val
= get_char_property_and_overlay
1791 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1792 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1794 ellipsis
= ellipsis
|| inv
> 1
1795 || (OVERLAYP (overlay
)
1796 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1797 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1798 tmp
= Fnext_single_char_property_change
1799 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1800 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1804 && (val
= get_pos_property (make_number (beg
),
1806 TEXT_PROP_MEANS_INVISIBLE (val
))
1808 && !NILP (val
= get_char_property_and_overlay
1809 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1810 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1812 ellipsis
= ellipsis
|| inv
> 1
1813 || (OVERLAYP (overlay
)
1814 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1815 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1816 tmp
= Fprevious_single_char_property_change
1817 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1818 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1821 /* Move away from the inside area. */
1822 if (beg
< PT
&& end
> PT
)
1824 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1825 /* We haven't moved yet (so we don't need to fear
1826 infinite-looping) and we were outside the range
1827 before (so either end of the range still corresponds
1828 to a move in the right direction): pretend we moved
1829 less than we actually did, so that we still have
1830 more freedom below in choosing which end of the range
1832 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1833 /* We either have moved already or the last point
1834 was already in the range: we don't get to choose
1835 which end of the range we have to go to. */
1836 : (PT
< last_pt
? beg
: end
));
1837 check_composition
= check_display
= 1;
1839 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1840 the point to something other than its argument, due to
1841 point-motion hooks, intangibility, etc. */
1842 eassert (PT
== beg
|| PT
== end
);
1845 /* Pretend the area doesn't exist if the buffer is not
1847 if (!modified
&& !ellipsis
&& beg
< end
)
1849 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1850 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1851 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1852 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1853 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1854 /* We've already moved as far as we can. Trying to go
1855 to the other end would mean moving backwards and thus
1856 could lead to an infinite loop. */
1858 else if (val
= get_pos_property (make_number (PT
),
1860 TEXT_PROP_MEANS_INVISIBLE (val
)
1861 && (val
= get_pos_property
1862 (make_number (PT
== beg
? end
: beg
),
1864 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1865 (check_composition
= check_display
= 1,
1866 SET_PT (PT
== beg
? end
: beg
));
1869 check_invisible
= 0;
1873 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1876 safe_run_hooks_1 (void)
1878 eassert (CONSP (Vinhibit_quit
));
1879 return call0 (XCDR (Vinhibit_quit
));
1882 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1886 safe_run_hooks_error (Lisp_Object error_data
)
1889 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1890 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1891 Lisp_Object args
[4];
1892 args
[0] = build_string ("Error in %s (%s): %S");
1895 args
[3] = error_data
;
1901 Lisp_Object newval
= Qnil
;
1902 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1903 if (EQ (fun
, XCAR (val
)))
1906 newval
= Fcons (XCAR (val
), newval
);
1908 return Fset (hook
, Fnreverse (newval
));
1909 /* Not found in the local part of the hook. Let's look at the global
1912 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1913 : Fdefault_value (hook
));
1914 CONSP (val
); val
= XCDR (val
))
1915 if (EQ (fun
, XCAR (val
)))
1918 newval
= Fcons (XCAR (val
), newval
);
1920 return Fset_default (hook
, Fnreverse (newval
));
1926 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1928 eassert (nargs
== 1);
1929 if (CONSP (Vinhibit_quit
))
1930 XSETCDR (Vinhibit_quit
, args
[0]);
1932 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1934 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1938 /* If we get an error while running the hook, cause the hook variable
1939 to be nil. Also inhibit quits, so that C-g won't cause the hook
1940 to mysteriously evaporate. */
1943 safe_run_hooks (Lisp_Object hook
)
1945 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1946 to its body or to its handlers other than via globals such as
1947 dynamically-bound variables ;-) */
1948 ptrdiff_t count
= SPECPDL_INDEX ();
1949 specbind (Qinhibit_quit
, hook
);
1951 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1953 unbind_to (count
, Qnil
);
1957 /* Nonzero means polling for input is temporarily suppressed. */
1959 int poll_suppress_count
;
1961 /* Asynchronous timer for polling. */
1963 static struct atimer
*poll_timer
;
1966 #ifdef POLL_FOR_INPUT
1968 /* Poll for input, so that we catch a C-g if it comes in. This
1969 function is called from x_make_frame_visible, see comment
1973 poll_for_input_1 (void)
1975 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1976 doing anything dangerous. */
1980 if (interrupt_input_blocked
== 0
1981 && !waiting_for_input
)
1982 read_avail_input (0);
1988 /* Timer callback function for poll_timer. TIMER is equal to
1992 poll_for_input (struct atimer
*timer
)
1994 if (poll_suppress_count
== 0)
1997 interrupt_input_pending
= 1;
1998 pending_signals
= 1;
2000 poll_for_input_1 ();
2005 #endif /* POLL_FOR_INPUT */
2007 /* Begin signals to poll for input, if they are appropriate.
2008 This function is called unconditionally from various places. */
2011 start_polling (void)
2013 #ifdef POLL_FOR_INPUT
2014 /* XXX This condition was (read_socket_hook && !interrupt_input),
2015 but read_socket_hook is not global anymore. Let's pretend that
2017 if (!interrupt_input
)
2019 /* Turn alarm handling on unconditionally. It might have
2020 been turned off in process.c. */
2021 turn_on_atimers (1);
2023 /* If poll timer doesn't exist, are we need one with
2024 a different interval, start a new one. */
2025 if (poll_timer
== NULL
2026 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2028 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2029 EMACS_TIME interval
= make_emacs_time (period
, 0);
2032 cancel_atimer (poll_timer
);
2034 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2035 poll_for_input
, NULL
);
2038 /* Let the timer's callback function poll for input
2039 if this becomes zero. */
2040 --poll_suppress_count
;
2045 /* Nonzero if we are using polling to handle input asynchronously. */
2048 input_polling_used (void)
2050 #ifdef POLL_FOR_INPUT
2051 /* XXX This condition was (read_socket_hook && !interrupt_input),
2052 but read_socket_hook is not global anymore. Let's pretend that
2054 return !interrupt_input
;
2060 /* Turn off polling. */
2065 #ifdef POLL_FOR_INPUT
2066 /* XXX This condition was (read_socket_hook && !interrupt_input),
2067 but read_socket_hook is not global anymore. Let's pretend that
2069 if (!interrupt_input
)
2070 ++poll_suppress_count
;
2074 /* Set the value of poll_suppress_count to COUNT
2075 and start or stop polling accordingly. */
2078 set_poll_suppress_count (int count
)
2080 #ifdef POLL_FOR_INPUT
2081 if (count
== 0 && poll_suppress_count
!= 0)
2083 poll_suppress_count
= 1;
2086 else if (count
!= 0 && poll_suppress_count
== 0)
2090 poll_suppress_count
= count
;
2094 /* Bind polling_period to a value at least N.
2095 But don't decrease it. */
2098 bind_polling_period (int n
)
2100 #ifdef POLL_FOR_INPUT
2101 EMACS_INT
new = polling_period
;
2106 stop_other_atimers (poll_timer
);
2108 specbind (Qpolling_period
, make_number (new));
2109 /* Start a new alarm with the new period. */
2114 /* Apply the control modifier to CHARACTER. */
2117 make_ctrl_char (int c
)
2119 /* Save the upper bits here. */
2120 int upper
= c
& ~0177;
2122 if (! ASCII_BYTE_P (c
))
2123 return c
|= ctrl_modifier
;
2127 /* Everything in the columns containing the upper-case letters
2128 denotes a control character. */
2129 if (c
>= 0100 && c
< 0140)
2133 /* Set the shift modifier for a control char
2134 made from a shifted letter. But only for letters! */
2135 if (oc
>= 'A' && oc
<= 'Z')
2136 c
|= shift_modifier
;
2139 /* The lower-case letters denote control characters too. */
2140 else if (c
>= 'a' && c
<= 'z')
2143 /* Include the bits for control and shift
2144 only if the basic ASCII code can't indicate them. */
2148 /* Replace the high bits. */
2149 c
|= (upper
& ~ctrl_modifier
);
2154 /* Display the help-echo property of the character after the mouse pointer.
2155 Either show it in the echo area, or call show-help-function to display
2156 it by other means (maybe in a tooltip).
2158 If HELP is nil, that means clear the previous help echo.
2160 If HELP is a string, display that string. If HELP is a function,
2161 call it with OBJECT and POS as arguments; the function should
2162 return a help string or nil for none. For all other types of HELP,
2163 evaluate it to obtain a string.
2165 WINDOW is the window in which the help was generated, if any.
2166 It is nil if not in a window.
2168 If OBJECT is a buffer, POS is the position in the buffer where the
2169 `help-echo' text property was found.
2171 If OBJECT is an overlay, that overlay has a `help-echo' property,
2172 and POS is the position in the overlay's buffer under the mouse.
2174 If OBJECT is a string (an overlay string or a string displayed with
2175 the `display' property). POS is the position in that string under
2178 Note: this function may only be called with HELP nil or a string
2179 from X code running asynchronously. */
2182 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2185 if (!NILP (help
) && !STRINGP (help
))
2187 if (FUNCTIONP (help
))
2189 Lisp_Object args
[4];
2194 help
= safe_call (4, args
);
2197 help
= safe_eval (help
);
2199 if (!STRINGP (help
))
2203 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2204 if (!noninteractive
&& STRINGP (help
))
2206 /* The mouse-fixup-help-message Lisp function can call
2207 mouse_position_hook, which resets the mouse_moved flags.
2208 This causes trouble if we are trying to read a mouse motion
2209 event (i.e., if we are inside a `track-mouse' form), so we
2210 restore the mouse_moved flag. */
2211 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2212 help
= call1 (Qmouse_fixup_help_message
, help
);
2218 if (STRINGP (help
) || NILP (help
))
2220 if (!NILP (Vshow_help_function
))
2221 call1 (Vshow_help_function
, help
);
2222 help_echo_showing_p
= STRINGP (help
);
2228 /* Input of single characters from keyboard */
2230 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2231 EMACS_TIME
*end_time
);
2232 static void record_char (Lisp_Object c
);
2234 static Lisp_Object help_form_saved_window_configs
;
2236 read_char_help_form_unwind (Lisp_Object arg
)
2238 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2239 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2240 if (!NILP (window_config
))
2241 Fset_window_configuration (window_config
);
2245 #define STOP_POLLING \
2246 do { if (! polling_stopped_here) stop_polling (); \
2247 polling_stopped_here = 1; } while (0)
2249 #define RESUME_POLLING \
2250 do { if (polling_stopped_here) start_polling (); \
2251 polling_stopped_here = 0; } while (0)
2253 /* read a character from the keyboard; call the redisplay if needed */
2254 /* commandflag 0 means do not autosave, but do redisplay.
2255 -1 means do not redisplay, but do autosave.
2258 /* The arguments MAPS and NMAPS are for menu prompting.
2259 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2261 PREV_EVENT is the previous input event, or nil if we are reading
2262 the first event of a key sequence (or not reading a key sequence).
2263 If PREV_EVENT is t, that is a "magic" value that says
2264 not to run input methods, but in other respects to act as if
2265 not reading a key sequence.
2267 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2268 if we used a mouse menu to read the input, or zero otherwise. If
2269 USED_MOUSE_MENU is null, we don't dereference it.
2271 Value is -2 when we find input on another keyboard. A second call
2272 to read_char will read it.
2274 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2275 specifying the maximum time to wait until. If no input arrives by
2276 that time, stop waiting and return nil.
2278 Value is t if we showed a menu and the user rejected it. */
2281 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2282 Lisp_Object prev_event
,
2283 int *used_mouse_menu
, EMACS_TIME
*end_time
)
2285 volatile Lisp_Object c
;
2287 jmp_buf local_getcjmp
;
2289 volatile int key_already_recorded
= 0;
2290 Lisp_Object tem
, save
;
2291 volatile Lisp_Object previous_echo_area_message
;
2292 volatile Lisp_Object also_record
;
2293 volatile int reread
;
2294 struct gcpro gcpro1
, gcpro2
;
2295 int volatile polling_stopped_here
= 0;
2296 struct kboard
*orig_kboard
= current_kboard
;
2300 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2301 before_command_key_count
= this_command_key_count
;
2302 before_command_echo_length
= echo_length ();
2305 previous_echo_area_message
= Qnil
;
2307 GCPRO2 (c
, previous_echo_area_message
);
2312 if (CONSP (Vunread_post_input_method_events
))
2314 c
= XCAR (Vunread_post_input_method_events
);
2315 Vunread_post_input_method_events
2316 = XCDR (Vunread_post_input_method_events
);
2318 /* Undo what read_char_x_menu_prompt did when it unread
2319 additional keys returned by Fx_popup_menu. */
2321 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2329 if (unread_command_char
!= -1)
2331 XSETINT (c
, unread_command_char
);
2332 unread_command_char
= -1;
2338 if (CONSP (Vunread_command_events
))
2340 int was_disabled
= 0;
2342 c
= XCAR (Vunread_command_events
);
2343 Vunread_command_events
= XCDR (Vunread_command_events
);
2347 /* Undo what sit-for did when it unread additional keys
2348 inside universal-argument. */
2351 && EQ (XCAR (c
), Qt
))
2357 /* Undo what read_char_x_menu_prompt did when it unread
2358 additional keys returned by Fx_popup_menu. */
2360 && EQ (XCDR (c
), Qdisabled
)
2361 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2367 /* If the queued event is something that used the mouse,
2368 set used_mouse_menu accordingly. */
2370 /* Also check was_disabled so last-nonmenu-event won't return
2371 a bad value when submenus are involved. (Bug#447) */
2372 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2373 *used_mouse_menu
= 1;
2375 goto reread_for_input_method
;
2378 if (CONSP (Vunread_input_method_events
))
2380 c
= XCAR (Vunread_input_method_events
);
2381 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2383 /* Undo what read_char_x_menu_prompt did when it unread
2384 additional keys returned by Fx_popup_menu. */
2386 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2390 goto reread_for_input_method
;
2393 this_command_key_count_reset
= 0;
2395 if (!NILP (Vexecuting_kbd_macro
))
2397 /* We set this to Qmacro; since that's not a frame, nobody will
2398 try to switch frames on us, and the selected window will
2401 Since this event came from a macro, it would be misleading to
2402 leave internal_last_event_frame set to wherever the last
2403 real event came from. Normally, a switch-frame event selects
2404 internal_last_event_frame after each command is read, but
2405 events read from a macro should never cause a new frame to be
2407 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2409 /* Exit the macro if we are at the end.
2410 Also, some things replace the macro with t
2411 to force an early exit. */
2412 if (EQ (Vexecuting_kbd_macro
, Qt
)
2413 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2419 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2420 if (STRINGP (Vexecuting_kbd_macro
)
2421 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2422 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2424 executing_kbd_macro_index
++;
2429 if (!NILP (unread_switch_frame
))
2431 c
= unread_switch_frame
;
2432 unread_switch_frame
= Qnil
;
2434 /* This event should make it into this_command_keys, and get echoed
2435 again, so we do not set `reread'. */
2439 /* if redisplay was requested */
2440 if (commandflag
>= 0)
2442 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2444 /* If there is pending input, process any events which are not
2445 user-visible, such as X selection_request events. */
2447 || detect_input_pending_run_timers (0))
2448 swallow_events (0); /* may clear input_pending */
2450 /* Redisplay if no pending input. */
2451 while (!input_pending
)
2453 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2454 redisplay_preserve_echo_area (5);
2459 /* Normal case: no input arrived during redisplay. */
2462 /* Input arrived and pre-empted redisplay.
2463 Process any events which are not user-visible. */
2465 /* If that cleared input_pending, try again to redisplay. */
2468 /* Prevent the redisplay we just did
2469 from messing up echoing of the input after the prompt. */
2470 if (commandflag
== 0 && echo_current
)
2471 echo_message_buffer
= echo_area_buffer
[0];
2475 /* Message turns off echoing unless more keystrokes turn it on again.
2477 The code in 20.x for the condition was
2479 1. echo_area_glyphs && *echo_area_glyphs
2480 2. && echo_area_glyphs != current_kboard->echobuf
2481 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2483 (1) means there's a current message displayed
2485 (2) means it's not the message from echoing from the current
2488 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2489 is set to a non-null value. This is done in read_char and it is
2490 set to echo_area_glyphs after a call to echo_char. That means
2491 ok_to_echo_at_next_pause is either null or
2492 current_kboard->echobuf with the appropriate current_kboard at
2495 So, condition (3) means in clear text ok_to_echo_at_next_pause
2496 must be either null, or the current message isn't from echoing at
2497 all, or it's from echoing from a different kboard than the
2500 if (/* There currently is something in the echo area. */
2501 !NILP (echo_area_buffer
[0])
2502 && (/* And it's either not from echoing. */
2503 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2504 /* Or it's an echo from a different kboard. */
2505 || echo_kboard
!= current_kboard
2506 /* Or we explicitly allow overwriting whatever there is. */
2507 || ok_to_echo_at_next_pause
== NULL
))
2512 /* Try reading a character via menu prompting in the minibuf.
2513 Try this before the sit-for, because the sit-for
2514 would do the wrong thing if we are supposed to do
2515 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2516 after a mouse event so don't try a minibuf menu. */
2518 if (nmaps
> 0 && INTERACTIVE
2519 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2520 /* Don't bring up a menu if we already have another event. */
2521 && NILP (Vunread_command_events
)
2522 && unread_command_char
< 0
2523 && !detect_input_pending_run_timers (0))
2525 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2527 if (INTEGERP (c
) && XINT (c
) == -2)
2528 return c
; /* wrong_kboard_jmpbuf */
2532 key_already_recorded
= 1;
2537 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2538 We will do that below, temporarily for short sections of code,
2539 when appropriate. local_getcjmp must be in effect
2540 around any call to sit_for or kbd_buffer_get_event;
2541 it *must not* be in effect when we call redisplay. */
2543 jmpcount
= SPECPDL_INDEX ();
2544 if (_setjmp (local_getcjmp
))
2546 /* Handle quits while reading the keyboard. */
2547 /* We must have saved the outer value of getcjmp here,
2548 so restore it now. */
2549 restore_getcjmp (save_jump
);
2550 unbind_to (jmpcount
, Qnil
);
2551 XSETINT (c
, quit_char
);
2552 internal_last_event_frame
= selected_frame
;
2553 Vlast_event_frame
= internal_last_event_frame
;
2554 /* If we report the quit char as an event,
2555 don't do so more than once. */
2556 if (!NILP (Vinhibit_quit
))
2560 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2561 if (kb
!= current_kboard
)
2563 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2564 /* We shouldn't get here if we were in single-kboard mode! */
2569 while (CONSP (XCDR (last
)))
2571 if (!NILP (XCDR (last
)))
2575 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2577 XSETCDR (last
, Fcons (c
, Qnil
));
2578 kb
->kbd_queue_has_data
= 1;
2579 current_kboard
= kb
;
2580 /* This is going to exit from read_char
2581 so we had better get rid of this frame's stuff. */
2583 return make_number (-2); /* wrong_kboard_jmpbuf */
2589 /* Start idle timers if no time limit is supplied. We don't do it
2590 if a time limit is supplied to avoid an infinite recursion in the
2591 situation where an idle timer calls `sit-for'. */
2594 timer_start_idle ();
2596 /* If in middle of key sequence and minibuffer not active,
2597 start echoing if enough time elapses. */
2599 if (minibuf_level
== 0
2601 && !current_kboard
->immediate_echo
2602 && this_command_key_count
> 0
2604 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2605 && NILP (Fzerop (Vecho_keystrokes
))
2606 && (/* No message. */
2607 NILP (echo_area_buffer
[0])
2608 /* Or empty message. */
2609 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2610 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2611 /* Or already echoing from same kboard. */
2612 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2613 /* Or not echoing before and echoing allowed. */
2614 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2616 /* After a mouse event, start echoing right away.
2617 This is because we are probably about to display a menu,
2618 and we don't want to delay before doing so. */
2619 if (EVENT_HAS_PARAMETERS (prev_event
))
2625 save_getcjmp (save_jump
);
2626 restore_getcjmp (local_getcjmp
);
2627 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2628 restore_getcjmp (save_jump
);
2630 && ! CONSP (Vunread_command_events
))
2635 /* Maybe auto save due to number of keystrokes. */
2637 if (commandflag
!= 0
2638 && auto_save_interval
> 0
2639 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2640 && !detect_input_pending_run_timers (0))
2642 Fdo_auto_save (Qnil
, Qnil
);
2643 /* Hooks can actually change some buffers in auto save. */
2647 /* Try reading using an X menu.
2648 This is never confused with reading using the minibuf
2649 because the recursive call of read_char in read_char_minibuf_menu_prompt
2650 does not pass on any keymaps. */
2652 if (nmaps
> 0 && INTERACTIVE
2653 && !NILP (prev_event
)
2654 && EVENT_HAS_PARAMETERS (prev_event
)
2655 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2656 && !EQ (XCAR (prev_event
), Qtool_bar
)
2657 /* Don't bring up a menu if we already have another event. */
2658 && NILP (Vunread_command_events
)
2659 && unread_command_char
< 0)
2661 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2663 /* Now that we have read an event, Emacs is not idle. */
2670 /* Maybe autosave and/or garbage collect due to idleness. */
2672 if (INTERACTIVE
&& NILP (c
))
2675 ptrdiff_t buffer_size
;
2677 /* Slow down auto saves logarithmically in size of current buffer,
2678 and garbage collect while we're at it. */
2679 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2680 last_non_minibuf_size
= Z
- BEG
;
2681 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2683 while (buffer_size
> 64)
2684 delay_level
++, buffer_size
-= buffer_size
>> 2;
2685 if (delay_level
< 4) delay_level
= 4;
2686 /* delay_level is 4 for files under around 50k, 7 at 100k,
2687 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2689 /* Auto save if enough time goes by without input. */
2690 if (commandflag
!= 0
2691 && num_nonmacro_input_events
> last_auto_save
2692 && INTEGERP (Vauto_save_timeout
)
2693 && XINT (Vauto_save_timeout
) > 0)
2696 EMACS_INT timeout
= (delay_level
2697 * min (XFASTINT (Vauto_save_timeout
) / 4,
2698 MOST_POSITIVE_FIXNUM
/ delay_level
));
2699 save_getcjmp (save_jump
);
2700 restore_getcjmp (local_getcjmp
);
2701 tem0
= sit_for (make_number (timeout
), 1, 1);
2702 restore_getcjmp (save_jump
);
2705 && ! CONSP (Vunread_command_events
))
2707 Fdo_auto_save (Qnil
, Qnil
);
2709 /* If we have auto-saved and there is still no input
2710 available, garbage collect if there has been enough
2711 consing going on to make it worthwhile. */
2712 if (!detect_input_pending_run_timers (0)
2713 && consing_since_gc
> gc_cons_threshold
/ 2)
2714 Fgarbage_collect ();
2721 /* Notify the caller if an autosave hook, or a timer, sentinel or
2722 filter in the sit_for calls above have changed the current
2723 kboard. This could happen if they use the minibuffer or start a
2724 recursive edit, like the fancy splash screen in server.el's
2725 filter. If this longjmp wasn't here, read_key_sequence would
2726 interpret the next key sequence using the wrong translation
2727 tables and function keymaps. */
2728 if (NILP (c
) && current_kboard
!= orig_kboard
)
2731 return make_number (-2); /* wrong_kboard_jmpbuf */
2734 /* If this has become non-nil here, it has been set by a timer
2735 or sentinel or filter. */
2736 if (CONSP (Vunread_command_events
))
2738 c
= XCAR (Vunread_command_events
);
2739 Vunread_command_events
= XCDR (Vunread_command_events
);
2742 /* Read something from current KBOARD's side queue, if possible. */
2746 if (current_kboard
->kbd_queue_has_data
)
2748 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2750 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2751 KVAR (current_kboard
, kbd_queue
)
2752 = XCDR (KVAR (current_kboard
, kbd_queue
));
2753 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2754 current_kboard
->kbd_queue_has_data
= 0;
2755 input_pending
= readable_events (0);
2756 if (EVENT_HAS_PARAMETERS (c
)
2757 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2758 internal_last_event_frame
= XCAR (XCDR (c
));
2759 Vlast_event_frame
= internal_last_event_frame
;
2763 /* If current_kboard's side queue is empty check the other kboards.
2764 If one of them has data that we have not yet seen here,
2765 switch to it and process the data waiting for it.
2767 Note: if the events queued up for another kboard
2768 have already been seen here, and therefore are not a complete command,
2769 the kbd_queue_has_data field is 0, so we skip that kboard here.
2770 That's to avoid an infinite loop switching between kboards here. */
2771 if (NILP (c
) && !single_kboard
)
2774 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2775 if (kb
->kbd_queue_has_data
)
2777 current_kboard
= kb
;
2778 /* This is going to exit from read_char
2779 so we had better get rid of this frame's stuff. */
2781 return make_number (-2); /* wrong_kboard_jmpbuf */
2789 /* Finally, we read from the main queue,
2790 and if that gives us something we can't use yet, we put it on the
2791 appropriate side queue and try again. */
2795 KBOARD
*kb
IF_LINT (= NULL
);
2797 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2800 /* Actually read a character, waiting if necessary. */
2801 save_getcjmp (save_jump
);
2802 restore_getcjmp (local_getcjmp
);
2804 timer_start_idle ();
2805 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2806 restore_getcjmp (save_jump
);
2808 if (! NILP (c
) && (kb
!= current_kboard
))
2810 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2813 while (CONSP (XCDR (last
)))
2815 if (!NILP (XCDR (last
)))
2819 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2821 XSETCDR (last
, Fcons (c
, Qnil
));
2822 kb
->kbd_queue_has_data
= 1;
2826 current_kboard
= kb
;
2827 /* This is going to exit from read_char
2828 so we had better get rid of this frame's stuff. */
2830 return make_number (-2);
2834 /* Terminate Emacs in batch mode if at eof. */
2835 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2836 Fkill_emacs (make_number (1));
2840 /* Add in any extra modifiers, where appropriate. */
2841 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2842 || ((extra_keyboard_modifiers
& 0177) < ' '
2843 && (extra_keyboard_modifiers
& 0177) != 0))
2844 XSETINT (c
, make_ctrl_char (XINT (c
)));
2846 /* Transfer any other modifier bits directly from
2847 extra_keyboard_modifiers to c. Ignore the actual character code
2848 in the low 16 bits of extra_keyboard_modifiers. */
2849 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2860 if (commandflag
>= 0
2861 && !input_pending
&& !detect_input_pending_run_timers (0))
2869 /* Buffer switch events are only for internal wakeups
2870 so don't show them to the user.
2871 Also, don't record a key if we already did. */
2872 if (BUFFERP (c
) || key_already_recorded
)
2875 /* Process special events within read_char
2876 and loop around to read another event. */
2879 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2884 struct buffer
*prev_buffer
= current_buffer
;
2885 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2886 int was_locked
= single_kboard
;
2887 ptrdiff_t count
= SPECPDL_INDEX ();
2888 record_single_kboard_state ();
2891 last_input_event
= c
;
2892 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2894 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2895 /* We stopped being idle for this event; undo that. This
2896 prevents automatic window selection (under
2897 mouse_autoselect_window from acting as a real input event, for
2898 example banishing the mouse under mouse-avoidance-mode. */
2899 timer_resume_idle ();
2901 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2902 /* Resume allowing input from any kboard, if that was true before. */
2904 any_kboard_state ();
2905 unbind_to (count
, Qnil
);
2908 if (current_buffer
!= prev_buffer
)
2910 /* The command may have changed the keymaps. Pretend there
2911 is input in another keyboard and return. This will
2912 recalculate keymaps. */
2913 c
= make_number (-2);
2920 /* Handle things that only apply to characters. */
2923 /* If kbd_buffer_get_event gave us an EOF, return that. */
2927 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2928 && UNSIGNED_CMP (XFASTINT (c
), <,
2929 SCHARS (KVAR (current_kboard
,
2930 Vkeyboard_translate_table
))))
2931 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2932 && UNSIGNED_CMP (XFASTINT (c
), <,
2933 ASIZE (KVAR (current_kboard
,
2934 Vkeyboard_translate_table
))))
2935 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2939 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2940 /* nil in keyboard-translate-table means no translation. */
2946 /* If this event is a mouse click in the menu bar,
2947 return just menu-bar for now. Modify the mouse click event
2948 so we won't do this twice, then queue it up. */
2949 if (EVENT_HAS_PARAMETERS (c
)
2951 && CONSP (EVENT_START (c
))
2952 && CONSP (XCDR (EVENT_START (c
))))
2956 posn
= POSN_POSN (EVENT_START (c
));
2957 /* Handle menu-bar events:
2958 insert the dummy prefix event `menu-bar'. */
2959 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2961 /* Change menu-bar to (menu-bar) as the event "position". */
2962 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2965 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2970 /* Store these characters into recent_keys, the dribble file if any,
2971 and the keyboard macro being defined, if any. */
2973 if (! NILP (also_record
))
2974 record_char (also_record
);
2976 /* Wipe the echo area.
2977 But first, if we are about to use an input method,
2978 save the echo area contents for it to refer to. */
2980 && ! NILP (Vinput_method_function
)
2981 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2983 previous_echo_area_message
= Fcurrent_message ();
2984 Vinput_method_previous_message
= previous_echo_area_message
;
2987 /* Now wipe the echo area, except for help events which do their
2988 own stuff with the echo area. */
2990 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2991 && !(EQ (Qswitch_frame
, XCAR (c
)))
2992 /* Don't wipe echo area for select window events: These might
2993 get delayed via `mouse-autoselect-window' (Bug#11304). */
2994 && !(EQ (Qselect_window
, XCAR (c
)))))
2996 if (!NILP (echo_area_buffer
[0]))
2998 safe_run_hooks (Qecho_area_clear_hook
);
2999 clear_message (1, 0);
3003 reread_for_input_method
:
3005 /* Pass this to the input method, if appropriate. */
3007 && ! NILP (Vinput_method_function
)
3008 /* Don't run the input method within a key sequence,
3009 after the first event of the key sequence. */
3010 && NILP (prev_event
)
3011 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3014 ptrdiff_t key_count
;
3015 int key_count_reset
;
3016 struct gcpro gcpro1
;
3017 ptrdiff_t count
= SPECPDL_INDEX ();
3019 /* Save the echo status. */
3020 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3021 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3022 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3023 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3026 if (before_command_restore_flag
)
3028 this_command_key_count
= before_command_key_count_1
;
3029 if (this_command_key_count
< this_single_command_key_start
)
3030 this_single_command_key_start
= this_command_key_count
;
3031 echo_truncate (before_command_echo_length_1
);
3032 before_command_restore_flag
= 0;
3036 /* Save the this_command_keys status. */
3037 key_count
= this_command_key_count
;
3038 key_count_reset
= this_command_key_count_reset
;
3041 keys
= Fcopy_sequence (this_command_keys
);
3046 /* Clear out this_command_keys. */
3047 this_command_key_count
= 0;
3048 this_command_key_count_reset
= 0;
3050 /* Now wipe the echo area. */
3051 if (!NILP (echo_area_buffer
[0]))
3052 safe_run_hooks (Qecho_area_clear_hook
);
3053 clear_message (1, 0);
3056 /* If we are not reading a key sequence,
3057 never use the echo area. */
3060 specbind (Qinput_method_use_echo_area
, Qt
);
3063 /* Call the input method. */
3064 tem
= call1 (Vinput_method_function
, c
);
3066 tem
= unbind_to (count
, tem
);
3068 /* Restore the saved echoing state
3069 and this_command_keys state. */
3070 this_command_key_count
= key_count
;
3071 this_command_key_count_reset
= key_count_reset
;
3073 this_command_keys
= keys
;
3076 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3077 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3078 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3079 if (saved_immediate_echo
)
3084 /* The input method can return no events. */
3087 /* Bring back the previous message, if any. */
3088 if (! NILP (previous_echo_area_message
))
3089 message_with_string ("%s", previous_echo_area_message
, 0);
3092 /* It returned one event or more. */
3094 Vunread_post_input_method_events
3095 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3100 /* Display help if not echoing. */
3101 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3103 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3104 Lisp_Object help
, object
, position
, window
, htem
;
3106 htem
= Fcdr (XCDR (c
));
3109 window
= Fcar (htem
);
3111 object
= Fcar (htem
);
3113 position
= Fcar (htem
);
3115 show_help_echo (help
, window
, object
, position
);
3117 /* We stopped being idle for this event; undo that. */
3119 timer_resume_idle ();
3123 if ((! reread
|| this_command_key_count
== 0
3124 || this_command_key_count_reset
)
3128 /* Don't echo mouse motion events. */
3129 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3130 && NILP (Fzerop (Vecho_keystrokes
))
3131 && ! (EVENT_HAS_PARAMETERS (c
)
3132 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3135 if (! NILP (also_record
))
3136 echo_char (also_record
);
3137 /* Once we reread a character, echoing can happen
3138 the next time we pause to read a new one. */
3139 ok_to_echo_at_next_pause
= current_kboard
;
3142 /* Record this character as part of the current key. */
3143 add_command_key (c
);
3144 if (! NILP (also_record
))
3145 add_command_key (also_record
);
3148 last_input_event
= c
;
3151 /* Process the help character specially if enabled */
3152 if (!NILP (Vhelp_form
) && help_char_p (c
))
3154 ptrdiff_t count
= SPECPDL_INDEX ();
3156 help_form_saved_window_configs
3157 = Fcons (Fcurrent_window_configuration (Qnil
),
3158 help_form_saved_window_configs
);
3159 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3160 call0 (Qhelp_form_show
);
3165 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3166 if (EVENT_HAS_PARAMETERS (c
)
3167 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3168 XSETCAR (help_form_saved_window_configs
, Qnil
);
3170 while (BUFFERP (c
));
3171 /* Remove the help from the frame */
3172 unbind_to (count
, Qnil
);
3175 if (EQ (c
, make_number (040)))
3179 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3180 while (BUFFERP (c
));
3189 /* Record a key that came from a mouse menu.
3190 Record it for echoing, for this-command-keys, and so on. */
3193 record_menu_key (Lisp_Object c
)
3195 /* Wipe the echo area. */
3196 clear_message (1, 0);
3201 before_command_key_count
= this_command_key_count
;
3202 before_command_echo_length
= echo_length ();
3205 /* Don't echo mouse motion events. */
3206 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3207 && NILP (Fzerop (Vecho_keystrokes
)))
3211 /* Once we reread a character, echoing can happen
3212 the next time we pause to read a new one. */
3213 ok_to_echo_at_next_pause
= 0;
3216 /* Record this character as part of the current key. */
3217 add_command_key (c
);
3219 /* Re-reading in the middle of a command */
3220 last_input_event
= c
;
3224 /* Return 1 if should recognize C as "the help character". */
3227 help_char_p (Lisp_Object c
)
3231 if (EQ (c
, Vhelp_char
))
3233 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3234 if (EQ (c
, XCAR (tail
)))
3239 /* Record the input event C in various ways. */
3242 record_char (Lisp_Object c
)
3246 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3248 /* To avoid filling recent_keys with help-echo and mouse-movement
3249 events, we filter out repeated help-echo events, only store the
3250 first and last in a series of mouse-movement events, and don't
3251 store repeated help-echo events which are only separated by
3252 mouse-movement events. */
3254 Lisp_Object ev1
, ev2
, ev3
;
3257 if ((ix1
= recent_keys_index
- 1) < 0)
3258 ix1
= NUM_RECENT_KEYS
- 1;
3259 ev1
= AREF (recent_keys
, ix1
);
3261 if ((ix2
= ix1
- 1) < 0)
3262 ix2
= NUM_RECENT_KEYS
- 1;
3263 ev2
= AREF (recent_keys
, ix2
);
3265 if ((ix3
= ix2
- 1) < 0)
3266 ix3
= NUM_RECENT_KEYS
- 1;
3267 ev3
= AREF (recent_keys
, ix3
);
3269 if (EQ (XCAR (c
), Qhelp_echo
))
3271 /* Don't record `help-echo' in recent_keys unless it shows some help
3272 message, and a different help than the previously recorded
3274 Lisp_Object help
, last_help
;
3276 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3277 if (!STRINGP (help
))
3279 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3280 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3282 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3283 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3284 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3286 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3287 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3288 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3289 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3292 else if (EQ (XCAR (c
), Qmouse_movement
))
3294 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3295 So additional mouse movement events replace the last element. */
3296 Lisp_Object last_window
, window
;
3298 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3299 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3300 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3301 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3302 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3304 ASET (recent_keys
, ix1
, c
);
3310 store_kbd_macro_char (c
);
3314 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3315 ASET (recent_keys
, recent_keys_index
, c
);
3316 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3317 recent_keys_index
= 0;
3319 else if (recorded
< 0)
3321 /* We need to remove one or two events from recent_keys.
3322 To do this, we simply put nil at those events and move the
3323 recent_keys_index backwards over those events. Usually,
3324 users will never see those nil events, as they will be
3325 overwritten by the command keys entered to see recent_keys
3328 while (recorded
++ < 0 && total_keys
> 0)
3330 if (total_keys
< NUM_RECENT_KEYS
)
3332 if (--recent_keys_index
< 0)
3333 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3334 ASET (recent_keys
, recent_keys_index
, Qnil
);
3338 num_nonmacro_input_events
++;
3340 /* Write c to the dribble file. If c is a lispy event, write
3341 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3342 If you, dear reader, have a better idea, you've got the source. :-) */
3348 if (XUINT (c
) < 0x100)
3349 putc (XUINT (c
), dribble
);
3351 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3355 Lisp_Object dribblee
;
3357 /* If it's a structured event, take the event header. */
3358 dribblee
= EVENT_HEAD (c
);
3360 if (SYMBOLP (dribblee
))
3362 putc ('<', dribble
);
3363 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3364 SBYTES (SYMBOL_NAME (dribblee
)),
3366 putc ('>', dribble
);
3375 /* Copy out or in the info on where C-g should throw to.
3376 This is used when running Lisp code from within get_char,
3377 in case get_char is called recursively.
3378 See read_process_output. */
3381 save_getcjmp (jmp_buf temp
)
3383 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3387 restore_getcjmp (jmp_buf temp
)
3389 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3392 /* Low level keyboard/mouse input.
3393 kbd_buffer_store_event places events in kbd_buffer, and
3394 kbd_buffer_get_event retrieves them. */
3396 /* Return true if there are any events in the queue that read-char
3397 would return. If this returns false, a read-char would block. */
3399 readable_events (int flags
)
3401 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3404 /* If the buffer contains only FOCUS_IN_EVENT events, and
3405 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3406 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3408 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3409 #ifdef USE_TOOLKIT_SCROLL_BARS
3410 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3414 struct input_event
*event
;
3416 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3423 #ifdef USE_TOOLKIT_SCROLL_BARS
3424 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3426 event
->kind
== FOCUS_IN_EVENT
)
3427 #ifdef USE_TOOLKIT_SCROLL_BARS
3428 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3429 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3430 && event
->part
== scroll_bar_handle
3431 && event
->modifiers
== 0)
3436 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3439 while (event
!= kbd_store_ptr
);
3445 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3446 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3447 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3452 if (current_kboard
->kbd_queue_has_data
)
3458 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3459 if (kb
->kbd_queue_has_data
)
3465 /* Set this for debugging, to have a way to get out */
3466 int stop_character EXTERNALLY_VISIBLE
;
3469 event_to_kboard (struct input_event
*event
)
3472 frame
= event
->frame_or_window
;
3474 frame
= XCAR (frame
);
3475 else if (WINDOWP (frame
))
3476 frame
= WINDOW_FRAME (XWINDOW (frame
));
3478 /* There are still some events that don't set this field.
3479 For now, just ignore the problem.
3480 Also ignore dead frames here. */
3481 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3484 return FRAME_KBOARD (XFRAME (frame
));
3488 /* Return the number of slots occupied in kbd_buffer. */
3491 kbd_buffer_nr_stored (void)
3493 return kbd_fetch_ptr
== kbd_store_ptr
3495 : (kbd_fetch_ptr
< kbd_store_ptr
3496 ? kbd_store_ptr
- kbd_fetch_ptr
3497 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3498 + (kbd_store_ptr
- kbd_buffer
)));
3500 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3503 kbd_buffer_store_event (register struct input_event
*event
)
3505 kbd_buffer_store_event_hold (event
, 0);
3508 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3510 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3511 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3512 Else, if EVENT is a quit event, store the quit event
3513 in HOLD_QUIT, and return (thus ignoring further events).
3515 This is used in read_avail_input to postpone the processing
3516 of the quit event until all subsequent input events have been
3517 parsed (and discarded).
3521 kbd_buffer_store_event_hold (register struct input_event
*event
,
3522 struct input_event
*hold_quit
)
3524 if (event
->kind
== NO_EVENT
)
3527 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3530 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3532 register int c
= event
->code
& 0377;
3534 if (event
->modifiers
& ctrl_modifier
)
3535 c
= make_ctrl_char (c
);
3537 c
|= (event
->modifiers
3538 & (meta_modifier
| alt_modifier
3539 | hyper_modifier
| super_modifier
));
3543 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3544 struct input_event
*sp
;
3546 if (single_kboard
&& kb
!= current_kboard
)
3548 KVAR (kb
, kbd_queue
)
3549 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3550 Fcons (make_number (c
), Qnil
));
3551 kb
->kbd_queue_has_data
= 1;
3552 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3554 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3557 if (event_to_kboard (sp
) == kb
)
3559 sp
->kind
= NO_EVENT
;
3560 sp
->frame_or_window
= Qnil
;
3569 memcpy (hold_quit
, event
, sizeof (*event
));
3573 /* If this results in a quit_char being returned to Emacs as
3574 input, set Vlast_event_frame properly. If this doesn't
3575 get returned to Emacs as an event, the next event read
3576 will set Vlast_event_frame again, so this is safe to do. */
3580 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3582 focus
= event
->frame_or_window
;
3583 internal_last_event_frame
= focus
;
3584 Vlast_event_frame
= focus
;
3587 last_event_timestamp
= event
->timestamp
;
3588 handle_interrupt ();
3592 if (c
&& c
== stop_character
)
3598 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3599 Just ignore the second one. */
3600 else if (event
->kind
== BUFFER_SWITCH_EVENT
3601 && kbd_fetch_ptr
!= kbd_store_ptr
3602 && ((kbd_store_ptr
== kbd_buffer
3603 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3604 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3607 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3608 kbd_store_ptr
= kbd_buffer
;
3610 /* Don't let the very last slot in the buffer become full,
3611 since that would make the two pointers equal,
3612 and that is indistinguishable from an empty buffer.
3613 Discard the event if it would fill the last slot. */
3614 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3616 *kbd_store_ptr
= *event
;
3619 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3621 /* Don't read keyboard input until we have processed kbd_buffer.
3622 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3623 hold_keyboard_input ();
3625 if (!noninteractive
)
3626 signal (SIGIO
, SIG_IGN
);
3630 #endif /* subprocesses */
3633 /* If we're inside while-no-input, and this event qualifies
3634 as input, set quit-flag to cause an interrupt. */
3635 if (!NILP (Vthrow_on_input
)
3636 && event
->kind
!= FOCUS_IN_EVENT
3637 && event
->kind
!= HELP_EVENT
3638 && event
->kind
!= DEICONIFY_EVENT
)
3640 Vquit_flag
= Vthrow_on_input
;
3641 /* If we're inside a function that wants immediate quits,
3643 if (immediate_quit
&& NILP (Vinhibit_quit
))
3653 /* Put an input event back in the head of the event queue. */
3656 kbd_buffer_unget_event (register struct input_event
*event
)
3658 if (kbd_fetch_ptr
== kbd_buffer
)
3659 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3661 /* Don't let the very last slot in the buffer become full, */
3662 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3665 *kbd_fetch_ptr
= *event
;
3670 /* Generate a HELP_EVENT input_event and store it in the keyboard
3673 HELP is the help form.
3675 FRAME and WINDOW are the frame and window where the help is
3676 generated. OBJECT is the Lisp object where the help was found (a
3677 buffer, a string, an overlay, or nil if neither from a string nor
3678 from a buffer). POS is the position within OBJECT where the help
3682 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3683 Lisp_Object object
, ptrdiff_t pos
)
3685 struct input_event event
;
3689 event
.kind
= HELP_EVENT
;
3690 event
.frame_or_window
= frame
;
3692 event
.x
= WINDOWP (window
) ? window
: frame
;
3695 kbd_buffer_store_event (&event
);
3699 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3702 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3704 struct input_event event
;
3706 event
.kind
= HELP_EVENT
;
3707 event
.frame_or_window
= frame
;
3712 kbd_buffer_store_event (&event
);
3716 /* Discard any mouse events in the event buffer by setting them to
3719 discard_mouse_events (void)
3721 struct input_event
*sp
;
3722 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3724 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3727 if (sp
->kind
== MOUSE_CLICK_EVENT
3728 || sp
->kind
== WHEEL_EVENT
3729 || sp
->kind
== HORIZ_WHEEL_EVENT
3731 || sp
->kind
== GPM_CLICK_EVENT
3733 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3735 sp
->kind
= NO_EVENT
;
3741 /* Return non-zero if there are any real events waiting in the event
3742 buffer, not counting `NO_EVENT's.
3744 If DISCARD is non-zero, discard NO_EVENT events at the front of
3745 the input queue, possibly leaving the input queue empty if there
3746 are no real input events. */
3749 kbd_buffer_events_waiting (int discard
)
3751 struct input_event
*sp
;
3753 for (sp
= kbd_fetch_ptr
;
3754 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3757 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3764 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3768 /* Clear input event EVENT. */
3771 clear_event (struct input_event
*event
)
3773 event
->kind
= NO_EVENT
;
3777 /* Read one event from the event buffer, waiting if necessary.
3778 The value is a Lisp object representing the event.
3779 The value is nil for an event that should be ignored,
3780 or that was handled here.
3781 We always read and discard one event. */
3784 kbd_buffer_get_event (KBOARD
**kbp
,
3785 int *used_mouse_menu
,
3786 EMACS_TIME
*end_time
)
3791 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3793 /* Start reading input again, we have processed enough so we can
3794 accept new events again. */
3795 unhold_keyboard_input ();
3797 if (!noninteractive
)
3798 signal (SIGIO
, input_available_signal
);
3802 #endif /* subprocesses */
3804 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3806 /* In case we are running as a daemon, only do this before
3807 detaching from the terminal. */
3808 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3812 *kbp
= current_kboard
;
3815 #endif /* ! HAVE_DBUS */
3817 /* Wait until there is input available. */
3820 /* Break loop if there's an unread command event. Needed in
3821 moused window autoselection which uses a timer to insert such
3823 if (CONSP (Vunread_command_events
))
3826 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3828 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3829 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3833 /* If the quit flag is set, then read_char will return
3834 quit_char, so that counts as "available input." */
3835 if (!NILP (Vquit_flag
))
3836 quit_throw_to_read_char (0);
3838 /* One way or another, wait until input is available; then, if
3839 interrupt handlers have not read it, read it now. */
3841 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3845 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3847 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3848 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3853 EMACS_TIME now
= current_emacs_time ();
3854 if (EMACS_TIME_LE (*end_time
, now
))
3855 return Qnil
; /* Finished waiting. */
3858 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3859 wait_reading_process_output (min (EMACS_SECS (duration
),
3861 EMACS_NSECS (duration
),
3862 -1, 1, Qnil
, NULL
, 0);
3866 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3868 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3869 /* Pass 1 for EXPECT since we just waited to have input. */
3870 read_avail_input (1);
3873 if (CONSP (Vunread_command_events
))
3876 first
= XCAR (Vunread_command_events
);
3877 Vunread_command_events
= XCDR (Vunread_command_events
);
3878 *kbp
= current_kboard
;
3882 /* At this point, we know that there is a readable event available
3883 somewhere. If the event queue is empty, then there must be a
3884 mouse movement enabled and available. */
3885 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3887 struct input_event
*event
;
3889 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3893 last_event_timestamp
= event
->timestamp
;
3895 *kbp
= event_to_kboard (event
);
3897 *kbp
= current_kboard
; /* Better than returning null ptr? */
3901 /* These two kinds of events get special handling
3902 and don't actually appear to the command loop.
3903 We return nil for them. */
3904 if (event
->kind
== SELECTION_REQUEST_EVENT
3905 || event
->kind
== SELECTION_CLEAR_EVENT
)
3908 struct input_event copy
;
3910 /* Remove it from the buffer before processing it,
3911 since otherwise swallow_events will see it
3912 and process it again. */
3914 kbd_fetch_ptr
= event
+ 1;
3915 input_pending
= readable_events (0);
3916 x_handle_selection_event (©
);
3918 /* We're getting selection request events, but we don't have
3924 #if defined (HAVE_NS)
3925 else if (event
->kind
== NS_TEXT_EVENT
)
3927 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3928 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3930 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3931 kbd_fetch_ptr
= event
+ 1;
3932 if (used_mouse_menu
)
3933 *used_mouse_menu
= 1;
3937 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3938 || defined (HAVE_NS)
3939 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3941 /* Make an event (delete-frame (FRAME)). */
3942 obj
= Fcons (event
->frame_or_window
, Qnil
);
3943 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3944 kbd_fetch_ptr
= event
+ 1;
3947 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3948 || defined (HAVE_NS)
3949 else if (event
->kind
== ICONIFY_EVENT
)
3951 /* Make an event (iconify-frame (FRAME)). */
3952 obj
= Fcons (event
->frame_or_window
, Qnil
);
3953 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3954 kbd_fetch_ptr
= event
+ 1;
3956 else if (event
->kind
== DEICONIFY_EVENT
)
3958 /* Make an event (make-frame-visible (FRAME)). */
3959 obj
= Fcons (event
->frame_or_window
, Qnil
);
3960 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3961 kbd_fetch_ptr
= event
+ 1;
3964 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3966 /* The value doesn't matter here; only the type is tested. */
3967 XSETBUFFER (obj
, current_buffer
);
3968 kbd_fetch_ptr
= event
+ 1;
3970 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3971 || defined (HAVE_NS) || defined (USE_GTK)
3972 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3974 kbd_fetch_ptr
= event
+ 1;
3975 input_pending
= readable_events (0);
3976 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3977 x_activate_menubar (XFRAME (event
->frame_or_window
));
3980 #if defined (WINDOWSNT)
3981 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3983 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3984 obj
= Fcons (Qlanguage_change
,
3985 list3 (event
->frame_or_window
,
3986 make_number (event
->code
),
3987 make_number (event
->modifiers
)));
3988 kbd_fetch_ptr
= event
+ 1;
3991 else if (event
->kind
== SAVE_SESSION_EVENT
)
3993 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3994 kbd_fetch_ptr
= event
+ 1;
3996 /* Just discard these, by returning nil.
3997 With MULTI_KBOARD, these events are used as placeholders
3998 when we need to randomly delete events from the queue.
3999 (They shouldn't otherwise be found in the buffer,
4000 but on some machines it appears they do show up
4001 even without MULTI_KBOARD.) */
4002 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4003 mouse events during a popup-menu call. */
4004 else if (event
->kind
== NO_EVENT
)
4005 kbd_fetch_ptr
= event
+ 1;
4006 else if (event
->kind
== HELP_EVENT
)
4008 Lisp_Object object
, position
, help
, frame
, window
;
4010 frame
= event
->frame_or_window
;
4011 object
= event
->arg
;
4012 position
= make_number (event
->code
);
4015 clear_event (event
);
4017 kbd_fetch_ptr
= event
+ 1;
4018 if (!WINDOWP (window
))
4020 obj
= Fcons (Qhelp_echo
,
4021 list5 (frame
, help
, window
, object
, position
));
4023 else if (event
->kind
== FOCUS_IN_EVENT
)
4025 /* Notification of a FocusIn event. The frame receiving the
4026 focus is in event->frame_or_window. Generate a
4027 switch-frame event if necessary. */
4028 Lisp_Object frame
, focus
;
4030 frame
= event
->frame_or_window
;
4031 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4035 if (!EQ (frame
, internal_last_event_frame
)
4036 && !EQ (frame
, selected_frame
))
4037 obj
= make_lispy_switch_frame (frame
);
4038 internal_last_event_frame
= frame
;
4039 kbd_fetch_ptr
= event
+ 1;
4042 else if (event
->kind
== DBUS_EVENT
)
4044 obj
= make_lispy_event (event
);
4045 kbd_fetch_ptr
= event
+ 1;
4048 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4050 obj
= make_lispy_event (event
);
4051 kbd_fetch_ptr
= event
+ 1;
4055 /* If this event is on a different frame, return a switch-frame this
4056 time, and leave the event in the queue for next time. */
4060 frame
= event
->frame_or_window
;
4062 frame
= XCAR (frame
);
4063 else if (WINDOWP (frame
))
4064 frame
= WINDOW_FRAME (XWINDOW (frame
));
4066 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4070 if (! EQ (frame
, internal_last_event_frame
)
4071 && !EQ (frame
, selected_frame
))
4072 obj
= make_lispy_switch_frame (frame
);
4073 internal_last_event_frame
= frame
;
4075 /* If we didn't decide to make a switch-frame event, go ahead
4076 and build a real event from the queue entry. */
4080 obj
= make_lispy_event (event
);
4082 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4083 || defined (HAVE_NS) || defined (USE_GTK)
4084 /* If this was a menu selection, then set the flag to inhibit
4085 writing to last_nonmenu_event. Don't do this if the event
4086 we're returning is (menu-bar), though; that indicates the
4087 beginning of the menu sequence, and we might as well leave
4088 that as the `event with parameters' for this selection. */
4090 && !EQ (event
->frame_or_window
, event
->arg
)
4091 && (event
->kind
== MENU_BAR_EVENT
4092 || event
->kind
== TOOL_BAR_EVENT
))
4093 *used_mouse_menu
= 1;
4096 /* certain system events are non-key events */
4098 && event
->kind
== NS_NONKEY_EVENT
)
4099 *used_mouse_menu
= 1;
4102 /* Wipe out this event, to catch bugs. */
4103 clear_event (event
);
4104 kbd_fetch_ptr
= event
+ 1;
4108 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4109 /* Try generating a mouse motion event. */
4110 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4112 FRAME_PTR f
= some_mouse_moved ();
4113 Lisp_Object bar_window
;
4114 enum scroll_bar_part part
;
4118 *kbp
= current_kboard
;
4119 /* Note that this uses F to determine which terminal to look at.
4120 If there is no valid info, it does not store anything
4121 so x remains nil. */
4124 /* XXX Can f or mouse_position_hook be NULL here? */
4125 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4126 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4131 /* Decide if we should generate a switch-frame event. Don't
4132 generate switch-frame events for motion outside of all Emacs
4138 frame
= FRAME_FOCUS_FRAME (f
);
4140 XSETFRAME (frame
, f
);
4142 if (! EQ (frame
, internal_last_event_frame
)
4143 && !EQ (frame
, selected_frame
))
4144 obj
= make_lispy_switch_frame (frame
);
4145 internal_last_event_frame
= frame
;
4148 /* If we didn't decide to make a switch-frame event, go ahead and
4149 return a mouse-motion event. */
4150 if (!NILP (x
) && NILP (obj
))
4151 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4153 #endif /* HAVE_MOUSE || HAVE GPM */
4155 /* We were promised by the above while loop that there was
4156 something for us to read! */
4159 input_pending
= readable_events (0);
4161 Vlast_event_frame
= internal_last_event_frame
;
4166 /* Process any non-user-visible events (currently X selection events),
4167 without reading any user-visible events. */
4170 process_special_events (void)
4172 struct input_event
*event
;
4174 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4176 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4179 if (event
== kbd_store_ptr
)
4183 /* If we find a stored X selection request, handle it now. */
4184 if (event
->kind
== SELECTION_REQUEST_EVENT
4185 || event
->kind
== SELECTION_CLEAR_EVENT
)
4189 /* Remove the event from the fifo buffer before processing;
4190 otherwise swallow_events called recursively could see it
4191 and process it again. To do this, we move the events
4192 between kbd_fetch_ptr and EVENT one slot to the right,
4195 struct input_event copy
= *event
;
4196 struct input_event
*beg
4197 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4198 ? kbd_buffer
: kbd_fetch_ptr
;
4201 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4202 else if (event
< beg
)
4204 if (event
> kbd_buffer
)
4205 memmove (kbd_buffer
+ 1, kbd_buffer
,
4206 (event
- kbd_buffer
) * sizeof (struct input_event
));
4207 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4208 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4209 memmove (beg
+ 1, beg
,
4210 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4211 * sizeof (struct input_event
));
4214 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4215 kbd_fetch_ptr
= kbd_buffer
+ 1;
4219 /* X wants last_event_timestamp for selection ownership. */
4220 last_event_timestamp
= copy
.timestamp
;
4221 input_pending
= readable_events (0);
4222 x_handle_selection_event (©
);
4224 /* We're getting selection request events, but we don't have
4232 /* Process any events that are not user-visible, run timer events that
4233 are ripe, and return, without reading any user-visible events. */
4236 swallow_events (int do_display
)
4240 process_special_events ();
4242 old_timers_run
= timers_run
;
4243 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4245 if (timers_run
!= old_timers_run
&& do_display
)
4246 redisplay_preserve_echo_area (7);
4249 /* Record the start of when Emacs is idle,
4250 for the sake of running idle-time timers. */
4253 timer_start_idle (void)
4257 /* If we are already in the idle state, do nothing. */
4258 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4261 timer_idleness_start_time
= current_emacs_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 timer_idleness_start_time
= invalid_emacs_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 nexttime
= invalid_emacs_time ();
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 now
= current_emacs_time ();
4366 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4367 ? sub_emacs_time (now
, timer_idleness_start_time
)
4368 : make_emacs_time (0, 0));
4371 while (CONSP (timers
) || CONSP (idle_timers
))
4373 Lisp_Object
*vector
;
4374 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4375 EMACS_TIME timer_time
, idle_timer_time
;
4376 EMACS_TIME difference
;
4377 EMACS_TIME timer_difference
= invalid_emacs_time ();
4378 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4379 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4381 /* Set TIMER and TIMER_DIFFERENCE
4382 based on the next ordinary timer.
4383 TIMER_DIFFERENCE is the distance in time from NOW to when
4384 this timer becomes ripe (negative if it's already ripe).
4385 Skip past invalid timers and timers already handled. */
4388 timer
= XCAR (timers
);
4389 if (! decode_timer (timer
, &timer_time
))
4391 timers
= XCDR (timers
);
4395 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4396 timer_difference
= (timer_ripe
4397 ? sub_emacs_time (now
, timer_time
)
4398 : sub_emacs_time (timer_time
, now
));
4401 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4402 based on the next idle timer. */
4403 if (CONSP (idle_timers
))
4405 idle_timer
= XCAR (idle_timers
);
4406 if (! decode_timer (idle_timer
, &idle_timer_time
))
4408 idle_timers
= XCDR (idle_timers
);
4412 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4413 idle_timer_difference
=
4415 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4416 : sub_emacs_time (idle_timer_time
, idleness_now
));
4419 /* Decide which timer is the next timer,
4420 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4421 Also step down the list where we found that timer. */
4423 if (EMACS_TIME_VALID_P (timer_difference
)
4424 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4425 || idle_timer_ripe
< timer_ripe
4426 || (idle_timer_ripe
== timer_ripe
4428 ? EMACS_TIME_LT (idle_timer_difference
,
4430 : EMACS_TIME_LT (timer_difference
,
4431 idle_timer_difference
)))))
4433 chosen_timer
= timer
;
4434 timers
= XCDR (timers
);
4435 difference
= timer_difference
;
4440 chosen_timer
= idle_timer
;
4441 idle_timers
= XCDR (idle_timers
);
4442 difference
= idle_timer_difference
;
4443 ripe
= idle_timer_ripe
;
4446 /* If timer is ripe, run it if it hasn't been run. */
4449 vector
= XVECTOR (chosen_timer
)->contents
;
4450 if (NILP (vector
[0]))
4452 ptrdiff_t count
= SPECPDL_INDEX ();
4453 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4455 /* Mark the timer as triggered to prevent problems if the lisp
4456 code fails to reschedule it right. */
4459 specbind (Qinhibit_quit
, Qt
);
4461 call1 (Qtimer_event_handler
, chosen_timer
);
4462 Vdeactivate_mark
= old_deactivate_mark
;
4464 unbind_to (count
, Qnil
);
4466 /* Since we have handled the event,
4467 we don't need to tell the caller to wake up and do it. */
4468 /* But the caller must still wait for the next timer, so
4469 return 0 to indicate that. */
4472 nexttime
= make_emacs_time (0, 0);
4475 /* When we encounter a timer that is still waiting,
4476 return the amount of time to wait before it is ripe. */
4483 /* No timers are pending in the future. */
4484 /* Return 0 if we generated an event, and -1 if not. */
4490 /* Check whether a timer has fired. To prevent larger problems we simply
4491 disregard elements that are not proper timers. Do not make a circular
4492 timer list for the time being.
4494 Returns the time to wait until the next timer fires.
4495 If no timer is active, return an invalid value.
4497 As long as any timer is ripe, we run it. */
4502 EMACS_TIME nexttime
;
4506 nexttime
= timer_check_2 ();
4508 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4513 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4514 doc
: /* Return the current length of Emacs idleness, or nil.
4515 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4516 in the same style as (current-time).
4518 The value when Emacs is not idle is nil.
4520 NSEC is a multiple of the system clock resolution. */)
4523 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4524 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4525 timer_idleness_start_time
));
4530 /* Caches for modify_event_symbol. */
4531 static Lisp_Object accent_key_syms
;
4532 static Lisp_Object func_key_syms
;
4533 static Lisp_Object mouse_syms
;
4534 static Lisp_Object wheel_syms
;
4535 static Lisp_Object drag_n_drop_syms
;
4537 /* This is a list of keysym codes for special "accent" characters.
4538 It parallels lispy_accent_keys. */
4540 static const int lispy_accent_codes
[] =
4542 #ifdef XK_dead_circumflex
4547 #ifdef XK_dead_grave
4552 #ifdef XK_dead_tilde
4557 #ifdef XK_dead_diaeresis
4562 #ifdef XK_dead_macron
4567 #ifdef XK_dead_degree
4572 #ifdef XK_dead_acute
4577 #ifdef XK_dead_cedilla
4582 #ifdef XK_dead_breve
4587 #ifdef XK_dead_ogonek
4592 #ifdef XK_dead_caron
4597 #ifdef XK_dead_doubleacute
4598 XK_dead_doubleacute
,
4602 #ifdef XK_dead_abovedot
4607 #ifdef XK_dead_abovering
4617 #ifdef XK_dead_belowdot
4622 #ifdef XK_dead_voiced_sound
4623 XK_dead_voiced_sound
,
4627 #ifdef XK_dead_semivoiced_sound
4628 XK_dead_semivoiced_sound
,
4644 /* This is a list of Lisp names for special "accent" characters.
4645 It parallels lispy_accent_codes. */
4647 static const char *const lispy_accent_keys
[] =
4665 "dead-voiced-sound",
4666 "dead-semivoiced-sound",
4672 #define FUNCTION_KEY_OFFSET 0x0
4674 const char *const lispy_function_keys
[] =
4678 0, /* VK_LBUTTON 0x01 */
4679 0, /* VK_RBUTTON 0x02 */
4680 "cancel", /* VK_CANCEL 0x03 */
4681 0, /* VK_MBUTTON 0x04 */
4683 0, 0, 0, /* 0x05 .. 0x07 */
4685 "backspace", /* VK_BACK 0x08 */
4686 "tab", /* VK_TAB 0x09 */
4688 0, 0, /* 0x0A .. 0x0B */
4690 "clear", /* VK_CLEAR 0x0C */
4691 "return", /* VK_RETURN 0x0D */
4693 0, 0, /* 0x0E .. 0x0F */
4695 0, /* VK_SHIFT 0x10 */
4696 0, /* VK_CONTROL 0x11 */
4697 0, /* VK_MENU 0x12 */
4698 "pause", /* VK_PAUSE 0x13 */
4699 "capslock", /* VK_CAPITAL 0x14 */
4700 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4702 "junja", /* VK_JUNJA 0x17 */
4703 "final", /* VK_FINAL 0x18 */
4704 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4706 "escape", /* VK_ESCAPE 0x1B */
4707 "convert", /* VK_CONVERT 0x1C */
4708 "non-convert", /* VK_NONCONVERT 0x1D */
4709 "accept", /* VK_ACCEPT 0x1E */
4710 "mode-change", /* VK_MODECHANGE 0x1F */
4711 0, /* VK_SPACE 0x20 */
4712 "prior", /* VK_PRIOR 0x21 */
4713 "next", /* VK_NEXT 0x22 */
4714 "end", /* VK_END 0x23 */
4715 "home", /* VK_HOME 0x24 */
4716 "left", /* VK_LEFT 0x25 */
4717 "up", /* VK_UP 0x26 */
4718 "right", /* VK_RIGHT 0x27 */
4719 "down", /* VK_DOWN 0x28 */
4720 "select", /* VK_SELECT 0x29 */
4721 "print", /* VK_PRINT 0x2A */
4722 "execute", /* VK_EXECUTE 0x2B */
4723 "snapshot", /* VK_SNAPSHOT 0x2C */
4724 "insert", /* VK_INSERT 0x2D */
4725 "delete", /* VK_DELETE 0x2E */
4726 "help", /* VK_HELP 0x2F */
4728 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4730 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4732 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4734 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4736 0, 0, 0, 0, 0, 0, 0, 0, 0,
4737 0, 0, 0, 0, 0, 0, 0, 0, 0,
4738 0, 0, 0, 0, 0, 0, 0, 0,
4740 "lwindow", /* VK_LWIN 0x5B */
4741 "rwindow", /* VK_RWIN 0x5C */
4742 "apps", /* VK_APPS 0x5D */
4745 "kp-0", /* VK_NUMPAD0 0x60 */
4746 "kp-1", /* VK_NUMPAD1 0x61 */
4747 "kp-2", /* VK_NUMPAD2 0x62 */
4748 "kp-3", /* VK_NUMPAD3 0x63 */
4749 "kp-4", /* VK_NUMPAD4 0x64 */
4750 "kp-5", /* VK_NUMPAD5 0x65 */
4751 "kp-6", /* VK_NUMPAD6 0x66 */
4752 "kp-7", /* VK_NUMPAD7 0x67 */
4753 "kp-8", /* VK_NUMPAD8 0x68 */
4754 "kp-9", /* VK_NUMPAD9 0x69 */
4755 "kp-multiply", /* VK_MULTIPLY 0x6A */
4756 "kp-add", /* VK_ADD 0x6B */
4757 "kp-separator", /* VK_SEPARATOR 0x6C */
4758 "kp-subtract", /* VK_SUBTRACT 0x6D */
4759 "kp-decimal", /* VK_DECIMAL 0x6E */
4760 "kp-divide", /* VK_DIVIDE 0x6F */
4761 "f1", /* VK_F1 0x70 */
4762 "f2", /* VK_F2 0x71 */
4763 "f3", /* VK_F3 0x72 */
4764 "f4", /* VK_F4 0x73 */
4765 "f5", /* VK_F5 0x74 */
4766 "f6", /* VK_F6 0x75 */
4767 "f7", /* VK_F7 0x76 */
4768 "f8", /* VK_F8 0x77 */
4769 "f9", /* VK_F9 0x78 */
4770 "f10", /* VK_F10 0x79 */
4771 "f11", /* VK_F11 0x7A */
4772 "f12", /* VK_F12 0x7B */
4773 "f13", /* VK_F13 0x7C */
4774 "f14", /* VK_F14 0x7D */
4775 "f15", /* VK_F15 0x7E */
4776 "f16", /* VK_F16 0x7F */
4777 "f17", /* VK_F17 0x80 */
4778 "f18", /* VK_F18 0x81 */
4779 "f19", /* VK_F19 0x82 */
4780 "f20", /* VK_F20 0x83 */
4781 "f21", /* VK_F21 0x84 */
4782 "f22", /* VK_F22 0x85 */
4783 "f23", /* VK_F23 0x86 */
4784 "f24", /* VK_F24 0x87 */
4786 0, 0, 0, 0, /* 0x88 .. 0x8B */
4787 0, 0, 0, 0, /* 0x8C .. 0x8F */
4789 "kp-numlock", /* VK_NUMLOCK 0x90 */
4790 "scroll", /* VK_SCROLL 0x91 */
4791 /* Not sure where the following block comes from.
4792 Windows headers have NEC and Fujitsu specific keys in
4793 this block, but nothing generic. */
4794 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4795 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4796 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4797 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4798 "kp-end", /* VK_NUMPAD_END 0x96 */
4799 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4800 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4801 "kp-up", /* VK_NUMPAD_UP 0x99 */
4802 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4803 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4804 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4805 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4807 0, 0, /* 0x9E .. 0x9F */
4810 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4811 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4812 * No other API or message will distinguish left and right keys this way.
4817 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4818 to enable them selectively, and gives access to a few more functions.
4819 See lispy_multimedia_keys below. */
4820 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4821 0, 0, 0, /* 0xAD .. 0xAF Volume */
4822 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4823 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4825 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4826 0, 0, 0, 0, 0, 0, 0, 0, 0,
4828 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4829 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4830 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4833 "ax", /* VK_OEM_AX 0xE1 */
4834 0, /* VK_OEM_102 0xE2 */
4835 "ico-help", /* VK_ICO_HELP 0xE3 */
4836 "ico-00", /* VK_ICO_00 0xE4 */
4837 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4838 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4839 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4841 "reset", /* VK_OEM_RESET 0xE9 */
4842 "jump", /* VK_OEM_JUMP 0xEA */
4843 "oem-pa1", /* VK_OEM_PA1 0xEB */
4844 "oem-pa2", /* VK_OEM_PA2 0xEC */
4845 "oem-pa3", /* VK_OEM_PA3 0xED */
4846 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4847 "cusel", /* VK_OEM_CUSEL 0xEF */
4848 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4849 "finish", /* VK_OEM_FINISH 0xF1 */
4850 "copy", /* VK_OEM_COPY 0xF2 */
4851 "auto", /* VK_OEM_AUTO 0xF3 */
4852 "enlw", /* VK_OEM_ENLW 0xF4 */
4853 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4854 "attn", /* VK_ATTN 0xF6 */
4855 "crsel", /* VK_CRSEL 0xF7 */
4856 "exsel", /* VK_EXSEL 0xF8 */
4857 "ereof", /* VK_EREOF 0xF9 */
4858 "play", /* VK_PLAY 0xFA */
4859 "zoom", /* VK_ZOOM 0xFB */
4860 "noname", /* VK_NONAME 0xFC */
4861 "pa1", /* VK_PA1 0xFD */
4862 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4866 /* Some of these duplicate the "Media keys" on newer keyboards,
4867 but they are delivered to the application in a different way. */
4868 static const char *const lispy_multimedia_keys
[] =
4876 "browser-favorites",
4913 "toggle-dictate-command",
4919 "media-fast-forward",
4922 "media-channel-down"
4925 #else /* not HAVE_NTGUI */
4927 /* This should be dealt with in XTread_socket now, and that doesn't
4928 depend on the client system having the Kana syms defined. See also
4929 the XK_kana_A case below. */
4932 static const char *const lispy_kana_keys
[] =
4934 /* X Keysym value */
4935 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4936 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4937 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4938 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4939 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4940 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4941 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4942 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4943 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4944 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4945 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4946 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4947 "kana-i", "kana-u", "kana-e", "kana-o",
4948 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4949 "prolongedsound", "kana-A", "kana-I", "kana-U",
4950 "kana-E", "kana-O", "kana-KA", "kana-KI",
4951 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4952 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4953 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4954 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4955 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4956 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4957 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4958 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4959 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4960 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4961 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4962 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4964 #endif /* XK_kana_A */
4967 #define FUNCTION_KEY_OFFSET 0xff00
4969 /* You'll notice that this table is arranged to be conveniently
4970 indexed by X Windows keysym values. */
4971 static const char *const lispy_function_keys
[] =
4973 /* X Keysym value */
4975 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4976 "backspace", "tab", "linefeed", "clear",
4978 0, 0, 0, "pause", /* 0xff10...1f */
4979 0, 0, 0, 0, 0, 0, 0, "escape",
4981 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4982 "romaji", "hiragana", "katakana", "hiragana-katakana",
4983 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4984 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4985 "eisu-toggle", /* 0xff30...3f */
4986 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4987 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4989 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4990 "down", "prior", "next", "end",
4991 "begin", 0, 0, 0, 0, 0, 0, 0,
4992 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5003 "break", /* 0xff6b */
5006 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5007 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5008 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5009 0, 0, 0, 0, 0, 0, 0, 0,
5010 "kp-tab", /* 0xff89 */
5012 "kp-enter", /* 0xff8d */
5014 "kp-f1", /* 0xff91 */
5018 "kp-home", /* 0xff95 */
5023 "kp-prior", /* kp-page-up */
5024 "kp-next", /* kp-page-down */
5030 0, 0, 0, 0, 0, 0, 0, 0, 0,
5031 "kp-multiply", /* 0xffaa */
5036 "kp-divide", /* 0xffaf */
5037 "kp-0", /* 0xffb0 */
5038 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5041 "kp-equal", /* 0xffbd */
5042 "f1", /* 0xffbe */ /* IsFunctionKey */
5044 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5045 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5046 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5047 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5048 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5049 0, 0, 0, 0, 0, 0, 0, 0,
5050 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5051 0, 0, 0, 0, 0, 0, 0, "delete"
5054 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5055 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5057 static const char *const iso_lispy_function_keys
[] =
5059 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5060 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5061 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5062 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5063 "iso-lefttab", /* 0xfe20 */
5064 "iso-move-line-up", "iso-move-line-down",
5065 "iso-partial-line-up", "iso-partial-line-down",
5066 "iso-partial-space-left", "iso-partial-space-right",
5067 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5068 "iso-release-margin-left", "iso-release-margin-right",
5069 "iso-release-both-margins",
5070 "iso-fast-cursor-left", "iso-fast-cursor-right",
5071 "iso-fast-cursor-up", "iso-fast-cursor-down",
5072 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5073 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5076 #endif /* not HAVE_NTGUI */
5078 static Lisp_Object Vlispy_mouse_stem
;
5080 static const char *const lispy_wheel_names
[] =
5082 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5085 /* drag-n-drop events are generated when a set of selected files are
5086 dragged from another application and dropped onto an Emacs window. */
5087 static const char *const lispy_drag_n_drop_names
[] =
5092 /* Scroll bar parts. */
5093 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5094 Lisp_Object Qup
, Qdown
, Qbottom
;
5095 static Lisp_Object Qend_scroll
;
5097 static Lisp_Object Qratio
;
5099 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5100 static Lisp_Object
*const scroll_bar_parts
[] = {
5101 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5102 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5105 /* A vector, indexed by button number, giving the down-going location
5106 of currently depressed buttons, both scroll bar and non-scroll bar.
5108 The elements have the form
5109 (BUTTON-NUMBER MODIFIER-MASK . REST)
5110 where REST is the cdr of a position as it would be reported in the event.
5112 The make_lispy_event function stores positions here to tell the
5113 difference between click and drag events, and to store the starting
5114 location to be included in drag events. */
5116 static Lisp_Object button_down_location
;
5118 /* Information about the most recent up-going button event: Which
5119 button, what location, and what time. */
5121 static int last_mouse_button
;
5122 static int last_mouse_x
;
5123 static int last_mouse_y
;
5124 static Time button_down_time
;
5126 /* The number of clicks in this multiple-click. */
5128 static int double_click_count
;
5130 /* X and Y are frame-relative coordinates for a click or wheel event.
5131 Return a Lisp-style event list. */
5134 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5137 enum window_part part
;
5138 Lisp_Object posn
= Qnil
;
5139 Lisp_Object extra_info
= Qnil
;
5140 /* Coordinate pixel positions to return. */
5141 int xret
= 0, yret
= 0;
5142 /* The window under frame pixel coordinates (x,y) */
5143 Lisp_Object window
= f
5144 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5147 if (WINDOWP (window
))
5149 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5150 struct window
*w
= XWINDOW (window
);
5151 Lisp_Object string_info
= Qnil
;
5152 ptrdiff_t textpos
= -1;
5153 int col
= -1, row
= -1;
5154 int dx
= -1, dy
= -1;
5155 int width
= -1, height
= -1;
5156 Lisp_Object object
= Qnil
;
5158 /* Pixel coordinates relative to the window corner. */
5159 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5160 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5162 /* For text area clicks, return X, Y relative to the corner of
5163 this text area. Note that dX, dY etc are set below, by
5164 buffer_posn_from_coords. */
5165 if (part
== ON_TEXT
)
5167 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5168 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5170 /* For mode line and header line clicks, return X, Y relative to
5171 the left window edge. Use mode_line_string to look for a
5172 string on the click position. */
5173 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5178 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5179 /* Note that mode_line_string takes COL, ROW as pixels and
5180 converts them to characters. */
5183 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5184 &object
, &dx
, &dy
, &width
, &height
);
5185 if (STRINGP (string
))
5186 string_info
= Fcons (string
, make_number (charpos
));
5187 textpos
= (w
== XWINDOW (selected_window
)
5188 && current_buffer
== XBUFFER (w
->buffer
))
5189 ? PT
: XMARKER (w
->pointm
)->charpos
;
5194 /* For fringes and margins, Y is relative to the area's (and the
5195 window's) top edge, while X is meaningless. */
5196 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5201 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5204 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5205 &object
, &dx
, &dy
, &width
, &height
);
5206 if (STRINGP (string
))
5207 string_info
= Fcons (string
, make_number (charpos
));
5208 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5210 else if (part
== ON_LEFT_FRINGE
)
5212 posn
= Qleft_fringe
;
5215 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5216 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5217 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5219 else if (part
== ON_RIGHT_FRINGE
)
5221 posn
= Qright_fringe
;
5224 - window_box_width (w
, LEFT_MARGIN_AREA
)
5225 - window_box_width (w
, TEXT_AREA
)
5226 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5227 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5229 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5231 else if (part
== ON_VERTICAL_BORDER
)
5233 posn
= Qvertical_line
;
5238 /* Nothing special for part == ON_SCROLL_BAR. */
5240 /* For clicks in the text area, fringes, or margins, call
5241 buffer_posn_from_coords to extract TEXTPOS, the buffer
5242 position nearest to the click. */
5245 Lisp_Object string2
, object2
= Qnil
;
5246 struct display_pos p
;
5248 int width2
, height2
;
5249 /* The pixel X coordinate passed to buffer_posn_from_coords
5250 is the X coordinate relative to the text area for
5251 text-area and right-margin clicks, zero otherwise. */
5253 = (part
== ON_TEXT
) ? xret
5254 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5255 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5259 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5260 &object2
, &dx2
, &dy2
,
5262 textpos
= CHARPOS (p
.pos
);
5263 if (col
< 0) col
= x2
;
5264 if (row
< 0) row
= y2
;
5265 if (dx
< 0) dx
= dx2
;
5266 if (dy
< 0) dy
= dy2
;
5267 if (width
< 0) width
= width2
;
5268 if (height
< 0) height
= height2
;
5272 posn
= make_number (textpos
);
5273 if (STRINGP (string2
))
5274 string_info
= Fcons (string2
,
5275 make_number (CHARPOS (p
.string_pos
)));
5281 #ifdef HAVE_WINDOW_SYSTEM
5282 if (IMAGEP (object
))
5284 Lisp_Object image_map
, hotspot
;
5285 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5287 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5289 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5290 posn
= XCAR (hotspot
);
5297 Fcons (make_number (dx
), make_number (dy
)),
5298 Fcons (make_number (width
), make_number (height
)));
5301 extra_info
= Fcons (string_info
,
5302 Fcons (make_number (textpos
),
5303 Fcons (Fcons (make_number (col
),
5308 XSETFRAME (window
, f
);
5312 return Fcons (window
,
5314 Fcons (Fcons (make_number (xret
),
5315 make_number (yret
)),
5316 Fcons (make_number (t
),
5320 /* Given a struct input_event, build the lisp event which represents
5321 it. If EVENT is 0, build a mouse movement event from the mouse
5322 movement buffer, which should have a movement event in it.
5324 Note that events must be passed to this function in the order they
5325 are received; this function stores the location of button presses
5326 in order to build drag events when the button is released. */
5329 make_lispy_event (struct input_event
*event
)
5333 switch (SWITCH_ENUM_CAST (event
->kind
))
5335 /* A simple keystroke. */
5336 case ASCII_KEYSTROKE_EVENT
:
5337 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5339 Lisp_Object lispy_c
;
5340 EMACS_INT c
= event
->code
;
5341 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5344 eassert (c
== event
->code
);
5345 /* Turn ASCII characters into control characters
5347 if (event
->modifiers
& ctrl_modifier
)
5349 c
= make_ctrl_char (c
);
5350 event
->modifiers
&= ~ctrl_modifier
;
5354 /* Add in the other modifier bits. The shift key was taken care
5355 of by the X code. */
5356 c
|= (event
->modifiers
5357 & (meta_modifier
| alt_modifier
5358 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5359 /* Distinguish Shift-SPC from SPC. */
5360 if ((event
->code
) == 040
5361 && event
->modifiers
& shift_modifier
)
5362 c
|= shift_modifier
;
5363 button_down_time
= 0;
5364 XSETFASTINT (lispy_c
, c
);
5369 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5370 except that they are non-key events (last-nonmenu-event is nil). */
5371 case NS_NONKEY_EVENT
:
5374 /* A function key. The symbol may need to have modifier prefixes
5376 case NON_ASCII_KEYSTROKE_EVENT
:
5377 button_down_time
= 0;
5379 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5380 if (event
->code
== lispy_accent_codes
[i
])
5381 return modify_event_symbol (i
,
5383 Qfunction_key
, Qnil
,
5384 lispy_accent_keys
, &accent_key_syms
,
5385 (sizeof (lispy_accent_keys
)
5386 / sizeof (lispy_accent_keys
[0])));
5390 if (event
->code
>= 0x400 && event
->code
< 0x500)
5391 return modify_event_symbol (event
->code
- 0x400,
5392 event
->modifiers
& ~shift_modifier
,
5393 Qfunction_key
, Qnil
,
5394 lispy_kana_keys
, &func_key_syms
,
5395 (sizeof (lispy_kana_keys
)
5396 / sizeof (lispy_kana_keys
[0])));
5397 #endif /* XK_kana_A */
5400 #ifdef ISO_FUNCTION_KEY_OFFSET
5401 if (event
->code
< FUNCTION_KEY_OFFSET
5402 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5403 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5405 Qfunction_key
, Qnil
,
5406 iso_lispy_function_keys
, &func_key_syms
,
5407 (sizeof (iso_lispy_function_keys
)
5408 / sizeof (iso_lispy_function_keys
[0])));
5411 /* Handle system-specific or unknown keysyms. */
5412 if (event
->code
& (1 << 28)
5413 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5414 || (event
->code
- FUNCTION_KEY_OFFSET
5415 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5416 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5418 /* We need to use an alist rather than a vector as the cache
5419 since we can't make a vector long enough. */
5420 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5421 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5422 return modify_event_symbol (event
->code
,
5425 KVAR (current_kboard
, Vsystem_key_alist
),
5426 0, &KVAR (current_kboard
, system_key_syms
),
5430 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5432 Qfunction_key
, Qnil
,
5433 lispy_function_keys
, &func_key_syms
,
5434 (sizeof (lispy_function_keys
)
5435 / sizeof (lispy_function_keys
[0])));
5438 case MULTIMEDIA_KEY_EVENT
:
5439 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5440 / sizeof (lispy_multimedia_keys
[0]))
5441 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5443 return modify_event_symbol (event
->code
, event
->modifiers
,
5444 Qfunction_key
, Qnil
,
5445 lispy_multimedia_keys
, &func_key_syms
,
5446 (sizeof (lispy_multimedia_keys
)
5447 / sizeof (lispy_multimedia_keys
[0])));
5453 /* A mouse click. Figure out where it is, decide whether it's
5454 a press, click or drag, and build the appropriate structure. */
5455 case MOUSE_CLICK_EVENT
:
5456 #ifndef USE_TOOLKIT_SCROLL_BARS
5457 case SCROLL_BAR_CLICK_EVENT
:
5460 int button
= event
->code
;
5462 Lisp_Object position
;
5463 Lisp_Object
*start_pos_ptr
;
5464 Lisp_Object start_pos
;
5468 /* Build the position as appropriate for this mouse click. */
5469 if (event
->kind
== MOUSE_CLICK_EVENT
)
5471 struct frame
*f
= XFRAME (event
->frame_or_window
);
5472 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5476 /* Ignore mouse events that were made on frame that
5477 have been deleted. */
5478 if (! FRAME_LIVE_P (f
))
5481 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5482 /* EVENT->x and EVENT->y are frame-relative pixel
5483 coordinates at this place. Under old redisplay, COLUMN
5484 and ROW are set to frame relative glyph coordinates
5485 which are then used to determine whether this click is
5486 in a menu (non-toolkit version). */
5487 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5488 &column
, &row
, NULL
, 1);
5490 /* In the non-toolkit version, clicks on the menu bar
5491 are ordinary button events in the event buffer.
5492 Distinguish them, and invoke the menu.
5494 (In the toolkit version, the toolkit handles the menu bar
5495 and Emacs doesn't know about it until after the user
5496 makes a selection.) */
5497 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5498 && (event
->modifiers
& down_modifier
))
5500 Lisp_Object items
, item
;
5502 /* Find the menu bar item under `column'. */
5504 items
= FRAME_MENU_BAR_ITEMS (f
);
5505 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5507 Lisp_Object pos
, string
;
5508 string
= AREF (items
, i
+ 1);
5509 pos
= AREF (items
, i
+ 3);
5512 if (column
>= XINT (pos
)
5513 && column
< XINT (pos
) + SCHARS (string
))
5515 item
= AREF (items
, i
);
5520 /* ELisp manual 2.4b says (x y) are window relative but
5521 code says they are frame-relative. */
5523 = Fcons (event
->frame_or_window
,
5525 Fcons (Fcons (event
->x
, event
->y
),
5526 Fcons (make_number (event
->timestamp
),
5529 return Fcons (item
, Fcons (position
, Qnil
));
5531 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5533 position
= make_lispy_position (f
, event
->x
, event
->y
,
5536 #ifndef USE_TOOLKIT_SCROLL_BARS
5539 /* It's a scrollbar click. */
5541 Lisp_Object portion_whole
;
5544 window
= event
->frame_or_window
;
5545 portion_whole
= Fcons (event
->x
, event
->y
);
5546 part
= *scroll_bar_parts
[(int) event
->part
];
5550 Fcons (Qvertical_scroll_bar
,
5551 Fcons (portion_whole
,
5552 Fcons (make_number (event
->timestamp
),
5553 Fcons (part
, Qnil
)))));
5555 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5557 if (button
>= ASIZE (button_down_location
))
5559 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5560 button_down_location
= larger_vector (button_down_location
,
5562 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5565 start_pos_ptr
= &AREF (button_down_location
, button
);
5566 start_pos
= *start_pos_ptr
;
5567 *start_pos_ptr
= Qnil
;
5570 /* On window-system frames, use the value of
5571 double-click-fuzz as is. On other frames, interpret it
5572 as a multiple of 1/8 characters. */
5576 if (WINDOWP (event
->frame_or_window
))
5577 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5578 else if (FRAMEP (event
->frame_or_window
))
5579 f
= XFRAME (event
->frame_or_window
);
5583 if (FRAME_WINDOW_P (f
))
5584 fuzz
= double_click_fuzz
;
5586 fuzz
= double_click_fuzz
/ 8;
5588 is_double
= (button
== last_mouse_button
5589 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5590 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5591 && button_down_time
!= 0
5592 && (EQ (Vdouble_click_time
, Qt
)
5593 || (NATNUMP (Vdouble_click_time
)
5594 && (event
->timestamp
- button_down_time
5595 < XFASTINT (Vdouble_click_time
)))));
5598 last_mouse_button
= button
;
5599 last_mouse_x
= XINT (event
->x
);
5600 last_mouse_y
= XINT (event
->y
);
5602 /* If this is a button press, squirrel away the location, so
5603 we can decide later whether it was a click or a drag. */
5604 if (event
->modifiers
& down_modifier
)
5608 double_click_count
++;
5609 event
->modifiers
|= ((double_click_count
> 2)
5614 double_click_count
= 1;
5615 button_down_time
= event
->timestamp
;
5616 *start_pos_ptr
= Fcopy_alist (position
);
5617 ignore_mouse_drag_p
= 0;
5620 /* Now we're releasing a button - check the co-ordinates to
5621 see if this was a click or a drag. */
5622 else if (event
->modifiers
& up_modifier
)
5624 /* If we did not see a down before this up, ignore the up.
5625 Probably this happened because the down event chose a
5626 menu item. It would be an annoyance to treat the
5627 release of the button that chose the menu item as a
5630 if (!CONSP (start_pos
))
5633 event
->modifiers
&= ~up_modifier
;
5636 Lisp_Object new_down
, down
;
5637 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5639 /* The third element of every position
5640 should be the (x,y) pair. */
5641 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5642 new_down
= Fcar (Fcdr (Fcdr (position
)));
5645 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5647 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5648 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5651 if (ignore_mouse_drag_p
)
5653 event
->modifiers
|= click_modifier
;
5654 ignore_mouse_drag_p
= 0;
5656 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5657 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5658 /* Maybe the mouse has moved a lot, caused scrolling, and
5659 eventually ended up at the same screen position (but
5660 not buffer position) in which case it is a drag, not
5662 /* FIXME: OTOH if the buffer position has changed
5663 because of a timer or process filter rather than
5664 because of mouse movement, it should be considered as
5665 a click. But mouse-drag-region completely ignores
5666 this case and it hasn't caused any real problem, so
5667 it's probably OK to ignore it as well. */
5668 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5669 /* Mouse hasn't moved (much). */
5670 event
->modifiers
|= click_modifier
;
5673 button_down_time
= 0;
5674 event
->modifiers
|= drag_modifier
;
5677 /* Don't check is_double; treat this as multiple
5678 if the down-event was multiple. */
5679 if (double_click_count
> 1)
5680 event
->modifiers
|= ((double_click_count
> 2)
5686 /* Every mouse event should either have the down_modifier or
5687 the up_modifier set. */
5691 /* Get the symbol we should use for the mouse click. */
5694 head
= modify_event_symbol (button
,
5696 Qmouse_click
, Vlispy_mouse_stem
,
5699 ASIZE (mouse_syms
));
5700 if (event
->modifiers
& drag_modifier
)
5705 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5708 Fcons (make_number (double_click_count
),
5718 case HORIZ_WHEEL_EVENT
:
5720 Lisp_Object position
;
5723 /* Build the position as appropriate for this mouse click. */
5724 struct frame
*f
= XFRAME (event
->frame_or_window
);
5726 /* Ignore wheel events that were made on frame that have been
5728 if (! FRAME_LIVE_P (f
))
5731 position
= make_lispy_position (f
, event
->x
, event
->y
,
5734 /* Set double or triple modifiers to indicate the wheel speed. */
5736 /* On window-system frames, use the value of
5737 double-click-fuzz as is. On other frames, interpret it
5738 as a multiple of 1/8 characters. */
5744 if (WINDOWP (event
->frame_or_window
))
5745 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5746 else if (FRAMEP (event
->frame_or_window
))
5747 fr
= XFRAME (event
->frame_or_window
);
5751 fuzz
= FRAME_WINDOW_P (fr
)
5752 ? double_click_fuzz
: double_click_fuzz
/ 8;
5754 if (event
->modifiers
& up_modifier
)
5756 /* Emit a wheel-up event. */
5757 event
->modifiers
&= ~up_modifier
;
5760 else if (event
->modifiers
& down_modifier
)
5762 /* Emit a wheel-down event. */
5763 event
->modifiers
&= ~down_modifier
;
5767 /* Every wheel event should either have the down_modifier or
5768 the up_modifier set. */
5771 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5774 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5775 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5776 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5777 && button_down_time
!= 0
5778 && (EQ (Vdouble_click_time
, Qt
)
5779 || (NATNUMP (Vdouble_click_time
)
5780 && (event
->timestamp
- button_down_time
5781 < XFASTINT (Vdouble_click_time
)))));
5784 double_click_count
++;
5785 event
->modifiers
|= ((double_click_count
> 2)
5791 double_click_count
= 1;
5792 event
->modifiers
|= click_modifier
;
5795 button_down_time
= event
->timestamp
;
5796 /* Use a negative value to distinguish wheel from mouse button. */
5797 last_mouse_button
= - (1 + symbol_num
);
5798 last_mouse_x
= XINT (event
->x
);
5799 last_mouse_y
= XINT (event
->y
);
5801 /* Get the symbol we should use for the wheel event. */
5802 head
= modify_event_symbol (symbol_num
,
5808 ASIZE (wheel_syms
));
5811 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5814 Fcons (make_number (double_click_count
),
5823 #ifdef USE_TOOLKIT_SCROLL_BARS
5825 /* We don't have down and up events if using toolkit scroll bars,
5826 so make this always a click event. Store in the `part' of
5827 the Lisp event a symbol which maps to the following actions:
5829 `above_handle' page up
5830 `below_handle' page down
5834 `bottom' bottom of buffer
5835 `handle' thumb has been dragged.
5836 `end-scroll' end of interaction with scroll bar
5838 The incoming input_event contains in its `part' member an
5839 index of type `enum scroll_bar_part' which we can use as an
5840 index in scroll_bar_parts to get the appropriate symbol. */
5842 case SCROLL_BAR_CLICK_EVENT
:
5844 Lisp_Object position
, head
, window
, portion_whole
, part
;
5846 window
= event
->frame_or_window
;
5847 portion_whole
= Fcons (event
->x
, event
->y
);
5848 part
= *scroll_bar_parts
[(int) event
->part
];
5852 Fcons (Qvertical_scroll_bar
,
5853 Fcons (portion_whole
,
5854 Fcons (make_number (event
->timestamp
),
5855 Fcons (part
, Qnil
)))));
5857 /* Always treat scroll bar events as clicks. */
5858 event
->modifiers
|= click_modifier
;
5859 event
->modifiers
&= ~up_modifier
;
5861 if (event
->code
>= ASIZE (mouse_syms
))
5862 mouse_syms
= larger_vector (mouse_syms
,
5863 event
->code
- ASIZE (mouse_syms
) + 1,
5866 /* Get the symbol we should use for the mouse click. */
5867 head
= modify_event_symbol (event
->code
,
5872 ASIZE (mouse_syms
));
5873 return Fcons (head
, Fcons (position
, Qnil
));
5876 #endif /* USE_TOOLKIT_SCROLL_BARS */
5878 case DRAG_N_DROP_EVENT
:
5881 Lisp_Object head
, position
;
5884 f
= XFRAME (event
->frame_or_window
);
5887 /* Ignore mouse events that were made on frames that
5888 have been deleted. */
5889 if (! FRAME_LIVE_P (f
))
5892 position
= make_lispy_position (f
, event
->x
, event
->y
,
5895 head
= modify_event_symbol (0, event
->modifiers
,
5897 lispy_drag_n_drop_names
,
5898 &drag_n_drop_syms
, 1);
5904 #endif /* HAVE_MOUSE */
5906 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5907 || defined (HAVE_NS) || defined (USE_GTK)
5908 case MENU_BAR_EVENT
:
5909 if (EQ (event
->arg
, event
->frame_or_window
))
5910 /* This is the prefix key. We translate this to
5911 `(menu_bar)' because the code in keyboard.c for menu
5912 events, which we use, relies on this. */
5913 return Fcons (Qmenu_bar
, Qnil
);
5917 case SELECT_WINDOW_EVENT
:
5918 /* Make an event (select-window (WINDOW)). */
5919 return Fcons (Qselect_window
,
5920 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5923 case TOOL_BAR_EVENT
:
5924 if (EQ (event
->arg
, event
->frame_or_window
))
5925 /* This is the prefix key. We translate this to
5926 `(tool_bar)' because the code in keyboard.c for tool bar
5927 events, which we use, relies on this. */
5928 return Fcons (Qtool_bar
, Qnil
);
5929 else if (SYMBOLP (event
->arg
))
5930 return apply_modifiers (event
->modifiers
, event
->arg
);
5933 case USER_SIGNAL_EVENT
:
5934 /* A user signal. */
5936 char *name
= find_user_signal_name (event
->code
);
5939 return intern (name
);
5942 case SAVE_SESSION_EVENT
:
5943 return Qsave_session
;
5948 return Fcons (Qdbus_event
, event
->arg
);
5950 #endif /* HAVE_DBUS */
5952 case CONFIG_CHANGED_EVENT
:
5953 return Fcons (Qconfig_changed_event
,
5955 Fcons (event
->frame_or_window
, Qnil
)));
5957 case GPM_CLICK_EVENT
:
5959 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5960 Lisp_Object head
, position
;
5961 Lisp_Object
*start_pos_ptr
;
5962 Lisp_Object start_pos
;
5963 int button
= event
->code
;
5965 if (button
>= ASIZE (button_down_location
))
5967 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5968 button_down_location
= larger_vector (button_down_location
,
5970 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5973 start_pos_ptr
= &AREF (button_down_location
, button
);
5974 start_pos
= *start_pos_ptr
;
5976 position
= make_lispy_position (f
, event
->x
, event
->y
,
5979 if (event
->modifiers
& down_modifier
)
5980 *start_pos_ptr
= Fcopy_alist (position
);
5981 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5983 if (!CONSP (start_pos
))
5985 event
->modifiers
&= ~up_modifier
;
5988 head
= modify_event_symbol (button
,
5990 Qmouse_click
, Vlispy_mouse_stem
,
5993 ASIZE (mouse_syms
));
5995 if (event
->modifiers
& drag_modifier
)
6000 else if (event
->modifiers
& double_modifier
)
6003 Fcons (make_number (2),
6005 else if (event
->modifiers
& triple_modifier
)
6008 Fcons (make_number (3),
6015 #endif /* HAVE_GPM */
6017 /* The 'kind' field of the event is something we don't recognize. */
6023 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6026 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6027 Lisp_Object x
, Lisp_Object y
, Time t
)
6029 /* Is it a scroll bar movement? */
6030 if (frame
&& ! NILP (bar_window
))
6032 Lisp_Object part_sym
;
6034 part_sym
= *scroll_bar_parts
[(int) part
];
6035 return Fcons (Qscroll_bar_movement
,
6036 Fcons (list5 (bar_window
,
6037 Qvertical_scroll_bar
,
6043 /* Or is it an ordinary mouse movement? */
6046 Lisp_Object position
;
6047 position
= make_lispy_position (frame
, x
, y
, t
);
6048 return list2 (Qmouse_movement
, position
);
6052 #endif /* HAVE_MOUSE || HAVE GPM */
6054 /* Construct a switch frame event. */
6056 make_lispy_switch_frame (Lisp_Object frame
)
6058 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6061 /* Manipulating modifiers. */
6063 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6065 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6066 SYMBOL's name of the end of the modifiers; the string from this
6067 position is the unmodified symbol name.
6069 This doesn't use any caches. */
6072 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6078 CHECK_SYMBOL (symbol
);
6081 name
= SYMBOL_NAME (symbol
);
6083 for (i
= 0; i
< SBYTES (name
) - 1; )
6085 ptrdiff_t this_mod_end
= 0;
6088 /* See if the name continues with a modifier word.
6089 Check that the word appears, but don't check what follows it.
6090 Set this_mod and this_mod_end to record what we find. */
6092 switch (SREF (name
, i
))
6094 #define SINGLE_LETTER_MOD(BIT) \
6095 (this_mod_end = i + 1, this_mod = BIT)
6098 SINGLE_LETTER_MOD (alt_modifier
);
6102 SINGLE_LETTER_MOD (ctrl_modifier
);
6106 SINGLE_LETTER_MOD (hyper_modifier
);
6110 SINGLE_LETTER_MOD (meta_modifier
);
6114 SINGLE_LETTER_MOD (shift_modifier
);
6118 SINGLE_LETTER_MOD (super_modifier
);
6121 #undef SINGLE_LETTER_MOD
6123 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6124 if (i + LEN + 1 <= SBYTES (name) \
6125 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6127 this_mod_end = i + LEN; \
6132 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6133 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6134 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6138 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6140 #undef MULTI_LETTER_MOD
6144 /* If we found no modifier, stop looking for them. */
6145 if (this_mod_end
== 0)
6148 /* Check there is a dash after the modifier, so that it
6149 really is a modifier. */
6150 if (this_mod_end
>= SBYTES (name
)
6151 || SREF (name
, this_mod_end
) != '-')
6154 /* This modifier is real; look for another. */
6155 modifiers
|= this_mod
;
6156 i
= this_mod_end
+ 1;
6159 /* Should we include the `click' modifier? */
6160 if (! (modifiers
& (down_modifier
| drag_modifier
6161 | double_modifier
| triple_modifier
))
6162 && i
+ 7 == SBYTES (name
)
6163 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6164 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6165 modifiers
|= click_modifier
;
6167 if (! (modifiers
& (double_modifier
| triple_modifier
))
6168 && i
+ 6 < SBYTES (name
)
6169 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6170 modifiers
|= click_modifier
;
6178 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6179 prepended to the string BASE[0..BASE_LEN-1].
6180 This doesn't use any caches. */
6182 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6184 /* Since BASE could contain nulls, we can't use intern here; we have
6185 to use Fintern, which expects a genuine Lisp_String, and keeps a
6187 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6193 /* Only the event queue may use the `up' modifier; it should always
6194 be turned into a click or drag event before presented to lisp code. */
6195 if (modifiers
& up_modifier
)
6198 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6199 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6200 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6201 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6202 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6203 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6204 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6205 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6206 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6207 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6208 /* The click modifier is denoted by the absence of other modifiers. */
6212 mod_len
= p
- new_mods
;
6216 Lisp_Object new_name
;
6218 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6219 mod_len
+ base_len_byte
);
6220 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6221 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6223 return Fintern (new_name
, Qnil
);
6228 static const char *const modifier_names
[] =
6230 "up", "down", "drag", "click", "double", "triple", 0, 0,
6231 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6232 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6234 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6236 static Lisp_Object modifier_symbols
;
6238 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6240 lispy_modifier_list (int modifiers
)
6242 Lisp_Object modifier_list
;
6245 modifier_list
= Qnil
;
6246 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6247 if (modifiers
& (1<<i
))
6248 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6251 return modifier_list
;
6255 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6256 where UNMODIFIED is the unmodified form of SYMBOL,
6257 MASK is the set of modifiers present in SYMBOL's name.
6258 This is similar to parse_modifiers_uncached, but uses the cache in
6259 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6260 Qevent_symbol_elements property. */
6262 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6265 parse_modifiers (Lisp_Object symbol
)
6267 Lisp_Object elements
;
6269 if (INTEGERP (symbol
))
6270 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6271 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6273 else if (!SYMBOLP (symbol
))
6276 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6277 if (CONSP (elements
))
6282 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6283 Lisp_Object unmodified
;
6286 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6287 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6290 if (modifiers
& ~INTMASK
)
6292 XSETFASTINT (mask
, modifiers
);
6293 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6295 /* Cache the parsing results on SYMBOL. */
6296 Fput (symbol
, Qevent_symbol_element_mask
,
6298 Fput (symbol
, Qevent_symbol_elements
,
6299 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6301 /* Since we know that SYMBOL is modifiers applied to unmodified,
6302 it would be nice to put that in unmodified's cache.
6303 But we can't, since we're not sure that parse_modifiers is
6310 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6311 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6312 doc
: /* Parse the event symbol. For internal use. */)
6313 (Lisp_Object symbol
)
6315 /* Fill the cache if needed. */
6316 parse_modifiers (symbol
);
6317 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6318 and use the Lispier representation stored on Qevent_symbol_elements
6320 return Fget (symbol
, Qevent_symbol_elements
);
6323 /* Apply the modifiers MODIFIERS to the symbol BASE.
6324 BASE must be unmodified.
6326 This is like apply_modifiers_uncached, but uses BASE's
6327 Qmodifier_cache property, if present. It also builds
6328 Qevent_symbol_elements properties, since it has that info anyway.
6330 apply_modifiers copies the value of BASE's Qevent_kind property to
6331 the modified symbol. */
6333 apply_modifiers (int modifiers
, Lisp_Object base
)
6335 Lisp_Object cache
, idx
, entry
, new_symbol
;
6337 /* Mask out upper bits. We don't know where this value's been. */
6338 modifiers
&= INTMASK
;
6340 if (INTEGERP (base
))
6341 return make_number (XINT (base
) | modifiers
);
6343 /* The click modifier never figures into cache indices. */
6344 cache
= Fget (base
, Qmodifier_cache
);
6345 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6346 entry
= assq_no_quit (idx
, cache
);
6349 new_symbol
= XCDR (entry
);
6352 /* We have to create the symbol ourselves. */
6353 new_symbol
= apply_modifiers_uncached (modifiers
,
6354 SSDATA (SYMBOL_NAME (base
)),
6355 SCHARS (SYMBOL_NAME (base
)),
6356 SBYTES (SYMBOL_NAME (base
)));
6358 /* Add the new symbol to the base's cache. */
6359 entry
= Fcons (idx
, new_symbol
);
6360 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6362 /* We have the parsing info now for free, so we could add it to
6364 XSETFASTINT (idx, modifiers);
6365 Fput (new_symbol, Qevent_symbol_element_mask,
6366 Fcons (base, Fcons (idx, Qnil)));
6367 Fput (new_symbol, Qevent_symbol_elements,
6368 Fcons (base, lispy_modifier_list (modifiers)));
6369 Sadly, this is only correct if `base' is indeed a base event,
6370 which is not necessarily the case. -stef */
6373 /* Make sure this symbol is of the same kind as BASE.
6375 You'd think we could just set this once and for all when we
6376 intern the symbol above, but reorder_modifiers may call us when
6377 BASE's property isn't set right; we can't assume that just
6378 because it has a Qmodifier_cache property it must have its
6379 Qevent_kind set right as well. */
6380 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6384 kind
= Fget (base
, Qevent_kind
);
6386 Fput (new_symbol
, Qevent_kind
, kind
);
6393 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6394 return a symbol with the modifiers placed in the canonical order.
6395 Canonical order is alphabetical, except for down and drag, which
6396 always come last. The 'click' modifier is never written out.
6398 Fdefine_key calls this to make sure that (for example) C-M-foo
6399 and M-C-foo end up being equivalent in the keymap. */
6402 reorder_modifiers (Lisp_Object symbol
)
6404 /* It's hopefully okay to write the code this way, since everything
6405 will soon be in caches, and no consing will be done at all. */
6408 parsed
= parse_modifiers (symbol
);
6409 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6414 /* For handling events, we often want to produce a symbol whose name
6415 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6416 to some base, like the name of a function key or mouse button.
6417 modify_event_symbol produces symbols of this sort.
6419 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6420 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6423 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6424 into symbol names, or a string specifying a name stem used to
6425 construct a symbol name or the form `STEM-N', where N is the decimal
6426 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6427 non-nil; otherwise NAME_TABLE is used.
6429 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6430 persist between calls to modify_event_symbol that it can use to
6431 store a cache of the symbols it's generated for this NAME_TABLE
6432 before. The object stored there may be a vector or an alist.
6434 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6436 MODIFIERS is a set of modifier bits (as given in struct input_events)
6437 whose prefixes should be applied to the symbol name.
6439 SYMBOL_KIND is the value to be placed in the event_kind property of
6440 the returned symbol.
6442 The symbols we create are supposed to have an
6443 `event-symbol-elements' property, which lists the modifiers present
6444 in the symbol's name. */
6447 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6448 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6449 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6452 Lisp_Object symbol_int
;
6454 /* Get rid of the "vendor-specific" bit here. */
6455 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6457 /* Is this a request for a valid symbol? */
6458 if (symbol_num
< 0 || symbol_num
>= table_size
)
6461 if (CONSP (*symbol_table
))
6462 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6464 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6465 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6466 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6467 we've never used that symbol before. */
6470 if (! VECTORP (*symbol_table
)
6471 || ASIZE (*symbol_table
) != table_size
)
6475 XSETFASTINT (size
, table_size
);
6476 *symbol_table
= Fmake_vector (size
, Qnil
);
6479 value
= AREF (*symbol_table
, symbol_num
);
6482 /* Have we already used this symbol before? */
6485 /* No; let's create it. */
6486 if (CONSP (name_alist_or_stem
))
6487 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6488 else if (STRINGP (name_alist_or_stem
))
6491 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6492 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6494 SAFE_ALLOCA (buf
, char *, len
);
6495 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6496 XINT (symbol_int
) + 1);
6497 value
= intern (buf
);
6500 else if (name_table
!= 0 && name_table
[symbol_num
])
6501 value
= intern (name_table
[symbol_num
]);
6503 #ifdef HAVE_WINDOW_SYSTEM
6506 char *name
= x_get_keysym_name (symbol_num
);
6508 value
= intern (name
);
6514 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6515 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6516 value
= intern (buf
);
6519 if (CONSP (*symbol_table
))
6520 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6522 ASET (*symbol_table
, symbol_num
, value
);
6524 /* Fill in the cache entries for this symbol; this also
6525 builds the Qevent_symbol_elements property, which the user
6527 apply_modifiers (modifiers
& click_modifier
, value
);
6528 Fput (value
, Qevent_kind
, symbol_kind
);
6531 /* Apply modifiers to that symbol. */
6532 return apply_modifiers (modifiers
, value
);
6535 /* Convert a list that represents an event type,
6536 such as (ctrl meta backspace), into the usual representation of that
6537 event type as a number or a symbol. */
6539 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6540 doc
: /* Convert the event description list EVENT-DESC to an event type.
6541 EVENT-DESC should contain one base event type (a character or symbol)
6542 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6543 drag, down, double or triple). The base must be last.
6544 The return value is an event type (a character or symbol) which
6545 has the same base event type and all the specified modifiers. */)
6546 (Lisp_Object event_desc
)
6554 while (CONSP (rest
))
6562 /* Given a symbol, see if it is a modifier name. */
6563 if (SYMBOLP (elt
) && CONSP (rest
))
6564 this = parse_solitary_modifier (elt
);
6568 else if (!NILP (base
))
6569 error ("Two bases given in one event");
6575 /* Let the symbol A refer to the character A. */
6576 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6577 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6579 if (INTEGERP (base
))
6581 /* Turn (shift a) into A. */
6582 if ((modifiers
& shift_modifier
) != 0
6583 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6585 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6586 modifiers
&= ~shift_modifier
;
6589 /* Turn (control a) into C-a. */
6590 if (modifiers
& ctrl_modifier
)
6591 return make_number ((modifiers
& ~ctrl_modifier
)
6592 | make_ctrl_char (XINT (base
)));
6594 return make_number (modifiers
| XINT (base
));
6596 else if (SYMBOLP (base
))
6597 return apply_modifiers (modifiers
, base
);
6600 error ("Invalid base event");
6605 /* Try to recognize SYMBOL as a modifier name.
6606 Return the modifier flag bit, or 0 if not recognized. */
6609 parse_solitary_modifier (Lisp_Object symbol
)
6611 Lisp_Object name
= SYMBOL_NAME (symbol
);
6613 switch (SREF (name
, 0))
6615 #define SINGLE_LETTER_MOD(BIT) \
6616 if (SBYTES (name) == 1) \
6619 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6620 if (LEN == SBYTES (name) \
6621 && ! memcmp (SDATA (name), NAME, LEN)) \
6625 SINGLE_LETTER_MOD (alt_modifier
);
6629 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6633 SINGLE_LETTER_MOD (ctrl_modifier
);
6637 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6638 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6642 SINGLE_LETTER_MOD (hyper_modifier
);
6646 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6650 SINGLE_LETTER_MOD (meta_modifier
);
6654 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6658 SINGLE_LETTER_MOD (shift_modifier
);
6662 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6663 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6664 SINGLE_LETTER_MOD (super_modifier
);
6668 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6669 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6670 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6674 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6677 #undef SINGLE_LETTER_MOD
6678 #undef MULTI_LETTER_MOD
6684 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6685 Such a list is not valid as an event,
6686 but it can be a Lucid-style event type list. */
6689 lucid_event_type_list_p (Lisp_Object object
)
6693 if (! CONSP (object
))
6696 if (EQ (XCAR (object
), Qhelp_echo
)
6697 || EQ (XCAR (object
), Qvertical_line
)
6698 || EQ (XCAR (object
), Qmode_line
)
6699 || EQ (XCAR (object
), Qheader_line
))
6702 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6706 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6713 /* Store into *addr a value nonzero if terminal input chars are available.
6714 Serves the purpose of ioctl (0, FIONREAD, addr)
6715 but works even if FIONREAD does not exist.
6716 (In fact, this may actually read some input.)
6718 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6719 timer events that are ripe.
6720 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6721 events (FOCUS_IN_EVENT).
6722 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6723 movements and toolkit scroll bar thumb drags. */
6726 get_input_pending (int *addr
, int flags
)
6728 /* First of all, have we already counted some input? */
6729 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6731 /* If input is being read as it arrives, and we have none, there is none. */
6732 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6735 /* Try to read some input and see how much we get. */
6737 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6740 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6743 gobble_input (int expected
)
6746 if (interrupt_input
)
6749 mask
= sigblock (sigmask (SIGIO
));
6750 read_avail_input (expected
);
6754 #ifdef POLL_FOR_INPUT
6755 /* XXX This condition was (read_socket_hook && !interrupt_input),
6756 but read_socket_hook is not global anymore. Let's pretend that
6758 if (!interrupt_input
&& poll_suppress_count
== 0)
6761 mask
= sigblock (sigmask (SIGALRM
));
6762 read_avail_input (expected
);
6768 read_avail_input (expected
);
6771 /* Put a BUFFER_SWITCH_EVENT in the buffer
6772 so that read_key_sequence will notice the new current buffer. */
6775 record_asynch_buffer_change (void)
6777 struct input_event event
;
6781 event
.kind
= BUFFER_SWITCH_EVENT
;
6782 event
.frame_or_window
= Qnil
;
6785 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6786 The purpose of the event is to make read_key_sequence look up the
6787 keymaps again. If we aren't in read_key_sequence, we don't need one,
6788 and the event could cause trouble by messing up (input-pending-p).
6789 Note: Fwaiting_for_user_input_p always returns nil when async
6790 subprocesses aren't supported. */
6791 tem
= Fwaiting_for_user_input_p ();
6795 /* Make sure no interrupt happens while storing the event. */
6797 if (interrupt_input
)
6800 mask
= sigblock (sigmask (SIGIO
));
6801 kbd_buffer_store_event (&event
);
6808 kbd_buffer_store_event (&event
);
6813 /* Read any terminal input already buffered up by the system
6814 into the kbd_buffer, but do not wait.
6816 EXPECTED should be nonzero if the caller knows there is some input.
6818 Returns the number of keyboard chars read, or -1 meaning
6819 this is a bad time to try to read input. */
6822 read_avail_input (int expected
)
6828 /* Store pending user signal events, if any. */
6829 if (store_user_signal_events ())
6832 /* Loop through the available terminals, and call their input hooks. */
6836 struct terminal
*next
= t
->next_terminal
;
6838 if (t
->read_socket_hook
)
6841 struct input_event hold_quit
;
6843 EVENT_INIT (hold_quit
);
6844 hold_quit
.kind
= NO_EVENT
;
6846 /* No need for FIONREAD or fcntl; just say don't wait. */
6847 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6853 if (nr
== -1) /* Not OK to read input now. */
6857 else if (nr
== -2) /* Non-transient error. */
6859 /* The terminal device terminated; it should be closed. */
6861 /* Kill Emacs if this was our last terminal. */
6862 if (!terminal_list
->next_terminal
)
6863 /* Formerly simply reported no input, but that
6864 sometimes led to a failure of Emacs to terminate.
6865 SIGHUP seems appropriate if we can't reach the
6867 /* ??? Is it really right to send the signal just to
6868 this process rather than to the whole process
6869 group? Perhaps on systems with FIONREAD Emacs is
6870 alone in its group. */
6871 kill (getpid (), SIGHUP
);
6873 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6876 XSETTERMINAL (tmp
, t
);
6877 Fdelete_terminal (tmp
, Qnoelisp
);
6881 if (hold_quit
.kind
!= NO_EVENT
)
6882 kbd_buffer_store_event (&hold_quit
);
6891 frame_make_pointer_visible ();
6897 decode_keyboard_code (struct tty_display_info
*tty
,
6898 struct coding_system
*coding
,
6899 unsigned char *buf
, int nbytes
)
6901 unsigned char *src
= buf
;
6902 const unsigned char *p
;
6907 if (tty
->meta_key
!= 2)
6908 for (i
= 0; i
< nbytes
; i
++)
6910 if (coding
->carryover_bytes
> 0)
6912 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6913 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6914 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6915 nbytes
+= coding
->carryover_bytes
;
6917 coding
->destination
= alloca (nbytes
* 4);
6918 coding
->dst_bytes
= nbytes
* 4;
6919 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6920 if (coding
->produced_char
== 0)
6922 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6924 struct input_event event_buf
;
6926 EVENT_INIT (event_buf
);
6927 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6929 (ASCII_CHAR_P (event_buf
.code
)
6930 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6931 /* See the comment in tty_read_avail_input. */
6932 event_buf
.frame_or_window
= tty
->top_frame
;
6933 event_buf
.arg
= Qnil
;
6934 kbd_buffer_store_event (&event_buf
);
6938 /* This is the tty way of reading available input.
6940 Note that each terminal device has its own `struct terminal' object,
6941 and so this function is called once for each individual termcap
6942 terminal. The first parameter indicates which terminal to read from. */
6945 tty_read_avail_input (struct terminal
*terminal
,
6947 struct input_event
*hold_quit
)
6949 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6950 the kbd_buffer can really hold. That may prevent loss
6951 of characters on some systems when input is stuffed at us. */
6952 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6954 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6957 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6959 if (kbd_on_hold_p () || buffer_free
<= 0)
6961 #endif /* subprocesses */
6963 if (!terminal
->name
) /* Don't read from a dead terminal. */
6966 if (terminal
->type
!= output_termcap
6967 && terminal
->type
!= output_msdos_raw
)
6970 /* XXX I think the following code should be moved to separate hook
6971 functions in system-dependent files. */
6974 #else /* not WINDOWSNT */
6975 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6979 return 0; /* The terminal is suspended. */
6982 n_to_read
= dos_keysns ();
6986 cbuf
[0] = dos_keyread ();
6989 #else /* not MSDOS */
6994 struct input_event gpm_hold_quit
;
6995 int gpm
, fd
= gpm_fd
;
6997 EVENT_INIT (gpm_hold_quit
);
6998 gpm_hold_quit
.kind
= NO_EVENT
;
7000 /* gpm==1 if event received.
7001 gpm==0 if the GPM daemon has closed the connection, in which case
7002 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7003 we save it in `fd' so close_gpm can remove it from the
7005 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7006 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7007 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7010 /* Presumably the GPM daemon has closed the connection. */
7012 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7013 kbd_buffer_store_event (&gpm_hold_quit
);
7017 #endif /* HAVE_GPM */
7019 /* Determine how many characters we should *try* to read. */
7021 /* Find out how much input is available. */
7022 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7024 if (! noninteractive
)
7025 return -2; /* Close this terminal. */
7031 if (n_to_read
> sizeof cbuf
)
7032 n_to_read
= sizeof cbuf
;
7033 #else /* no FIONREAD */
7034 #if defined (USG) || defined (CYGWIN)
7035 /* Read some input if available, but don't wait. */
7036 n_to_read
= sizeof cbuf
;
7037 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7044 /* Don't read more than we can store. */
7045 if (n_to_read
> buffer_free
)
7046 n_to_read
= buffer_free
;
7047 #endif /* subprocesses */
7049 /* Now read; for one reason or another, this will not block.
7050 NREAD is set to the number of chars read. */
7053 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7054 /* POSIX infers that processes which are not in the session leader's
7055 process group won't get SIGHUP's at logout time. BSDI adheres to
7056 this part standard and returns -1 from read (0) with errno==EIO
7057 when the control tty is taken away.
7058 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7059 if (nread
== -1 && errno
== EIO
)
7060 return -2; /* Close this terminal. */
7061 #if defined (AIX) && defined (_BSD)
7062 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7063 This looks incorrect, but it isn't, because _BSD causes
7064 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7065 and that causes a value other than 0 when there is no input. */
7067 return -2; /* Close this terminal. */
7071 /* We used to retry the read if it was interrupted.
7072 But this does the wrong thing when O_NDELAY causes
7073 an EAGAIN error. Does anybody know of a situation
7074 where a retry is actually needed? */
7076 nread
< 0 && (errno
== EAGAIN
7090 #if defined (USG) || defined (CYGWIN)
7091 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7092 #endif /* USG or CYGWIN */
7093 #endif /* no FIONREAD */
7098 #endif /* not MSDOS */
7099 #endif /* not WINDOWSNT */
7101 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7102 & CODING_REQUIRE_DECODING_MASK
)
7104 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7107 /* Decode the key sequence except for those with meta
7109 for (i
= from
= 0; ; i
++)
7110 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7112 struct input_event buf
;
7114 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7119 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7120 buf
.modifiers
= meta_modifier
;
7121 buf
.code
= cbuf
[i
] & ~0x80;
7122 /* See the comment below. */
7123 buf
.frame_or_window
= tty
->top_frame
;
7125 kbd_buffer_store_event (&buf
);
7131 for (i
= 0; i
< nread
; i
++)
7133 struct input_event buf
;
7135 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7137 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7138 buf
.modifiers
= meta_modifier
;
7139 if (tty
->meta_key
!= 2)
7143 /* Set the frame corresponding to the active tty. Note that the
7144 value of selected_frame is not reliable here, redisplay tends
7145 to temporarily change it. */
7146 buf
.frame_or_window
= tty
->top_frame
;
7149 kbd_buffer_store_event (&buf
);
7150 /* Don't look at input that follows a C-g too closely.
7151 This reduces lossage due to autorepeat on C-g. */
7152 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7153 && buf
.code
== quit_char
)
7160 #if defined SYNC_INPUT || defined SIGIO
7162 handle_async_input (void)
7164 interrupt_input_pending
= 0;
7166 pending_signals
= pending_atimers
;
7168 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7169 doing anything dangerous. */
7176 nread
= read_avail_input (1);
7177 /* -1 means it's not ok to read the input now.
7178 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7179 0 means there was no keyboard input available. */
7187 #endif /* SYNC_INPUT || SIGIO */
7191 process_pending_signals (void)
7193 if (interrupt_input_pending
)
7194 handle_async_input ();
7195 do_pending_atimers ();
7199 #ifdef SIGIO /* for entire page */
7200 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7203 input_available_signal (int signo
)
7205 /* Must preserve main program's value of errno. */
7206 int old_errno
= errno
;
7207 SIGNAL_THREAD_CHECK (signo
);
7210 interrupt_input_pending
= 1;
7211 pending_signals
= 1;
7214 if (input_available_clear_time
)
7215 *input_available_clear_time
= make_emacs_time (0, 0);
7218 handle_async_input ();
7225 /* Send ourselves a SIGIO.
7227 This function exists so that the UNBLOCK_INPUT macro in
7228 blockinput.h can have some way to take care of input we put off
7229 dealing with, without assuming that every file which uses
7230 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7232 reinvoke_input_signal (void)
7235 handle_async_input ();
7241 /* User signal events. */
7243 struct user_signal_info
7245 /* Signal number. */
7248 /* Name of the signal. */
7251 /* Number of pending signals. */
7254 struct user_signal_info
*next
;
7257 /* List of user signals. */
7258 static struct user_signal_info
*user_signals
= NULL
;
7261 add_user_signal (int sig
, const char *name
)
7263 struct user_signal_info
*p
;
7265 for (p
= user_signals
; p
; p
= p
->next
)
7267 /* Already added. */
7270 p
= xmalloc (sizeof *p
);
7272 p
->name
= xstrdup (name
);
7274 p
->next
= user_signals
;
7277 signal (sig
, handle_user_signal
);
7281 handle_user_signal (int sig
)
7283 int old_errno
= errno
;
7284 struct user_signal_info
*p
;
7285 const char *special_event_name
= NULL
;
7287 SIGNAL_THREAD_CHECK (sig
);
7289 if (SYMBOLP (Vdebug_on_event
))
7290 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7292 for (p
= user_signals
; p
; p
= p
->next
)
7295 if (special_event_name
7296 && strcmp (special_event_name
, p
->name
) == 0)
7298 /* Enter the debugger in many ways. */
7299 debug_on_next_call
= 1;
7302 Vinhibit_quit
= Qnil
;
7304 /* Eat the event. */
7310 if (interrupt_input
)
7311 kill (getpid (), SIGIO
);
7315 /* Tell wait_reading_process_output that it needs to wake
7316 up and look around. */
7317 if (input_available_clear_time
)
7318 *input_available_clear_time
= make_emacs_time (0, 0);
7327 find_user_signal_name (int sig
)
7329 struct user_signal_info
*p
;
7331 for (p
= user_signals
; p
; p
= p
->next
)
7339 store_user_signal_events (void)
7341 struct user_signal_info
*p
;
7342 struct input_event buf
;
7345 for (p
= user_signals
; p
; p
= p
->next
)
7346 if (p
->npending
> 0)
7352 memset (&buf
, 0, sizeof buf
);
7353 buf
.kind
= USER_SIGNAL_EVENT
;
7354 buf
.frame_or_window
= selected_frame
;
7356 nstored
+= p
->npending
;
7358 mask
= sigblock (sigmask (p
->sig
));
7362 kbd_buffer_store_event (&buf
);
7365 while (p
->npending
> 0);
7373 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7374 static Lisp_Object menu_bar_one_keymap_changed_items
;
7376 /* These variables hold the vector under construction within
7377 menu_bar_items and its subroutines, and the current index
7378 for storing into that vector. */
7379 static Lisp_Object menu_bar_items_vector
;
7380 static int menu_bar_items_index
;
7383 static const char* separator_names
[] = {
7388 "single-dashed-line",
7389 "double-dashed-line",
7391 "shadow-etched-out",
7392 "shadow-etched-in-dash",
7393 "shadow-etched-out-dash",
7394 "shadow-double-etched-in",
7395 "shadow-double-etched-out",
7396 "shadow-double-etched-in-dash",
7397 "shadow-double-etched-out-dash",
7401 /* Return non-zero if LABEL specifies a separator. */
7404 menu_separator_name_p (const char *label
)
7408 else if (strlen (label
) > 3
7409 && memcmp (label
, "--", 2) == 0
7414 for (i
= 0; separator_names
[i
]; ++i
)
7415 if (strcmp (label
, separator_names
[i
]) == 0)
7420 /* It's a separator if it contains only dashes. */
7421 while (*label
== '-')
7423 return (*label
== 0);
7430 /* Return a vector of menu items for a menu bar, appropriate
7431 to the current buffer. Each item has three elements in the vector:
7434 OLD is an old vector we can optionally reuse, or nil. */
7437 menu_bar_items (Lisp_Object old
)
7439 /* The number of keymaps we're scanning right now, and the number of
7440 keymaps we have allocated space for. */
7443 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7444 in the current keymaps, or nil where it is not a prefix. */
7447 Lisp_Object def
, tail
;
7452 /* In order to build the menus, we need to call the keymap
7453 accessors. They all call QUIT. But this function is called
7454 during redisplay, during which a quit is fatal. So inhibit
7455 quitting while building the menus.
7456 We do this instead of specbind because (1) errors will clear it anyway
7457 and (2) this avoids risk of specpdl overflow. */
7458 oquit
= Vinhibit_quit
;
7462 menu_bar_items_vector
= old
;
7464 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7465 menu_bar_items_index
= 0;
7467 /* Build our list of keymaps.
7468 If we recognize a function key and replace its escape sequence in
7469 keybuf with its symbol, or if the sequence starts with a mouse
7470 click and we need to switch buffers, we jump back here to rebuild
7471 the initial keymaps from the current buffer. */
7475 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7476 if (!NILP (Voverriding_local_map_menu_flag
))
7478 /* Yes, use them (if non-nil) as well as the global map. */
7479 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7481 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7482 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7483 if (!NILP (Voverriding_local_map
))
7484 maps
[nmaps
++] = Voverriding_local_map
;
7488 /* No, so use major and minor mode keymaps and keymap property.
7489 Note that menu-bar bindings in the local-map and keymap
7490 properties may not work reliable, as they are only
7491 recognized when the menu-bar (or mode-line) is updated,
7492 which does not normally happen after every command. */
7495 nminor
= current_minor_maps (NULL
, &tmaps
);
7496 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7498 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7499 maps
[nmaps
++] = tem
;
7500 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7502 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7504 maps
[nmaps
++] = current_global_map
;
7507 /* Look up in each map the dummy prefix key `menu-bar'. */
7509 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7510 if (!NILP (maps
[mapno
]))
7512 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7516 menu_bar_one_keymap_changed_items
= Qnil
;
7517 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7521 /* Move to the end those items that should be at the end. */
7523 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7526 int end
= menu_bar_items_index
;
7528 for (i
= 0; i
< end
; i
+= 4)
7529 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7531 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7532 /* Move the item at index I to the end,
7533 shifting all the others forward. */
7534 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7535 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7536 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7537 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7539 memmove (&AREF (menu_bar_items_vector
, i
),
7540 &AREF (menu_bar_items_vector
, i
+ 4),
7541 (end
- i
- 4) * sizeof (Lisp_Object
));
7542 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7543 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7544 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7545 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7550 /* Add nil, nil, nil, nil at the end. */
7552 int i
= menu_bar_items_index
;
7553 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7554 menu_bar_items_vector
=
7555 larger_vector (menu_bar_items_vector
, 4, -1);
7556 /* Add this item. */
7557 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7558 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7559 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7560 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7561 menu_bar_items_index
= i
;
7564 Vinhibit_quit
= oquit
;
7565 return menu_bar_items_vector
;
7568 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7569 If there's already an item for KEY, add this DEF to it. */
7571 Lisp_Object item_properties
;
7574 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7576 struct gcpro gcpro1
;
7580 if (EQ (item
, Qundefined
))
7582 /* If a map has an explicit `undefined' as definition,
7583 discard any previously made menu bar item. */
7585 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7586 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7588 if (menu_bar_items_index
> i
+ 4)
7589 memmove (&AREF (menu_bar_items_vector
, i
),
7590 &AREF (menu_bar_items_vector
, i
+ 4),
7591 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7592 menu_bar_items_index
-= 4;
7596 /* If this keymap has already contributed to this KEY,
7597 don't contribute to it a second time. */
7598 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7599 if (!NILP (tem
) || NILP (item
))
7602 menu_bar_one_keymap_changed_items
7603 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7605 /* We add to menu_bar_one_keymap_changed_items before doing the
7606 parse_menu_item, so that if it turns out it wasn't a menu item,
7607 it still correctly hides any further menu item. */
7609 i
= parse_menu_item (item
, 1);
7614 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7616 /* Find any existing item for this KEY. */
7617 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7618 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7621 /* If we did not find this KEY, add it at the end. */
7622 if (i
== menu_bar_items_index
)
7624 /* If vector is too small, get a bigger one. */
7625 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7626 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7627 /* Add this item. */
7628 ASET (menu_bar_items_vector
, i
, key
); i
++;
7629 ASET (menu_bar_items_vector
, i
,
7630 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7631 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7632 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7633 menu_bar_items_index
= i
;
7635 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7639 old
= AREF (menu_bar_items_vector
, i
+ 2);
7640 /* If the new and the old items are not both keymaps,
7641 the lookup will only find `item'. */
7642 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7643 ASET (menu_bar_items_vector
, i
+ 2, item
);
7647 /* This is used as the handler when calling menu_item_eval_property. */
7649 menu_item_eval_property_1 (Lisp_Object arg
)
7651 /* If we got a quit from within the menu computation,
7652 quit all the way out of it. This takes care of C-] in the debugger. */
7653 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7654 Fsignal (Qquit
, Qnil
);
7660 eval_dyn (Lisp_Object form
)
7662 return Feval (form
, Qnil
);
7665 /* Evaluate an expression and return the result (or nil if something
7666 went wrong). Used to evaluate dynamic parts of menu items. */
7668 menu_item_eval_property (Lisp_Object sexpr
)
7670 ptrdiff_t count
= SPECPDL_INDEX ();
7672 specbind (Qinhibit_redisplay
, Qt
);
7673 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7674 menu_item_eval_property_1
);
7675 return unbind_to (count
, val
);
7678 /* This function parses a menu item and leaves the result in the
7679 vector item_properties.
7680 ITEM is a key binding, a possible menu item.
7681 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7683 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7684 parse_menu_item returns true if the item is a menu item and false
7688 parse_menu_item (Lisp_Object item
, int inmenubar
)
7690 Lisp_Object def
, tem
, item_string
, start
;
7692 Lisp_Object keyhint
;
7701 /* Create item_properties vector if necessary. */
7702 if (NILP (item_properties
))
7704 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7706 /* Initialize optional entries. */
7707 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7708 ASET (item_properties
, i
, Qnil
);
7709 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7711 /* Save the item here to protect it from GC. */
7712 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7714 item_string
= XCAR (item
);
7718 if (STRINGP (item_string
))
7720 /* Old format menu item. */
7721 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7723 /* Maybe help string. */
7724 if (CONSP (item
) && STRINGP (XCAR (item
)))
7726 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7731 /* Maybe an obsolete key binding cache. */
7732 if (CONSP (item
) && CONSP (XCAR (item
))
7733 && (NILP (XCAR (XCAR (item
)))
7734 || VECTORP (XCAR (XCAR (item
)))))
7737 /* This is the real definition--the function to run. */
7738 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7740 /* Get enable property, if any. */
7743 tem
= Fget (item
, Qmenu_enable
);
7744 if (!NILP (Venable_disabled_menus_and_buttons
))
7745 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7746 else if (!NILP (tem
))
7747 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7750 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7752 /* New format menu item. */
7753 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7754 start
= XCDR (item
);
7757 /* We have a real binding. */
7758 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7760 item
= XCDR (start
);
7761 /* Is there an obsolete cache list with key equivalences. */
7762 if (CONSP (item
) && CONSP (XCAR (item
)))
7765 /* Parse properties. */
7766 while (CONSP (item
) && CONSP (XCDR (item
)))
7771 if (EQ (tem
, QCenable
))
7773 if (!NILP (Venable_disabled_menus_and_buttons
))
7774 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7776 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7778 else if (EQ (tem
, QCvisible
))
7780 /* If got a visible property and that evaluates to nil
7781 then ignore this item. */
7782 tem
= menu_item_eval_property (XCAR (item
));
7786 else if (EQ (tem
, QChelp
))
7787 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7788 else if (EQ (tem
, QCfilter
))
7790 else if (EQ (tem
, QCkey_sequence
))
7793 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7794 /* Be GC protected. Set keyhint to item instead of tem. */
7797 else if (EQ (tem
, QCkeys
))
7800 if (CONSP (tem
) || STRINGP (tem
))
7801 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7803 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7808 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7810 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7812 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7818 else if (inmenubar
|| !NILP (start
))
7822 return 0; /* not a menu item */
7824 /* If item string is not a string, evaluate it to get string.
7825 If we don't get a string, skip this item. */
7826 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7827 if (!(STRINGP (item_string
)))
7829 item_string
= menu_item_eval_property (item_string
);
7830 if (!STRINGP (item_string
))
7832 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7835 /* If got a filter apply it on definition. */
7836 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7839 def
= menu_item_eval_property (list2 (XCAR (filter
),
7840 list2 (Qquote
, def
)));
7842 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7845 /* Enable or disable selection of item. */
7846 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7849 tem
= menu_item_eval_property (tem
);
7850 if (inmenubar
&& NILP (tem
))
7851 return 0; /* Ignore disabled items in menu bar. */
7852 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7855 /* If we got no definition, this item is just unselectable text which
7856 is OK in a submenu but not in the menubar. */
7858 return (!inmenubar
);
7860 /* See if this is a separate pane or a submenu. */
7861 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7862 tem
= get_keymap (def
, 0, 1);
7863 /* For a subkeymap, just record its details and exit. */
7866 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7867 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7871 /* At the top level in the menu bar, do likewise for commands also.
7872 The menu bar does not display equivalent key bindings anyway.
7873 ITEM_PROPERTY_DEF is already set up properly. */
7877 { /* This is a command. See if there is an equivalent key binding. */
7878 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7880 /* The previous code preferred :key-sequence to :keys, so we
7881 preserve this behavior. */
7882 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7883 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7886 Lisp_Object prefix
= keyeq
;
7887 Lisp_Object keys
= Qnil
;
7891 def
= XCAR (prefix
);
7892 prefix
= XCDR (prefix
);
7895 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7897 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7899 keys
= XCAR (keyhint
);
7900 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7902 /* We have a suggested key. Is it bound to the command? */
7905 /* If the command is an alias for another
7906 (such as lmenu.el set it up), check if the
7907 original command matches the cached command. */
7908 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7913 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7917 tem
= Fkey_description (keys
, Qnil
);
7920 if (STRINGP (XCAR (prefix
)))
7921 tem
= concat2 (XCAR (prefix
), tem
);
7922 if (STRINGP (XCDR (prefix
)))
7923 tem
= concat2 (tem
, XCDR (prefix
));
7925 keyeq
= concat2 (build_string (" "), tem
);
7926 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7932 /* If we have an equivalent key binding, use that. */
7933 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7936 /* Include this when menu help is implemented.
7937 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7938 if (!(NILP (tem) || STRINGP (tem)))
7940 tem = menu_item_eval_property (tem);
7943 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7947 /* Handle radio buttons or toggle boxes. */
7948 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7950 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7951 menu_item_eval_property (tem
));
7958 /***********************************************************************
7960 ***********************************************************************/
7962 /* A vector holding tool bar items while they are parsed in function
7963 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7966 static Lisp_Object tool_bar_items_vector
;
7968 /* A vector holding the result of parse_tool_bar_item. Layout is like
7969 the one for a single item in tool_bar_items_vector. */
7971 static Lisp_Object tool_bar_item_properties
;
7973 /* Next free index in tool_bar_items_vector. */
7975 static int ntool_bar_items
;
7977 /* The symbols `:image' and `:rtl'. */
7979 static Lisp_Object QCimage
;
7980 static Lisp_Object QCrtl
;
7982 /* Function prototypes. */
7984 static void init_tool_bar_items (Lisp_Object
);
7985 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7986 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7987 static void append_tool_bar_item (void);
7990 /* Return a vector of tool bar items for keymaps currently in effect.
7991 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7992 tool bar items found. */
7995 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8004 /* In order to build the menus, we need to call the keymap
8005 accessors. They all call QUIT. But this function is called
8006 during redisplay, during which a quit is fatal. So inhibit
8007 quitting while building the menus. We do this instead of
8008 specbind because (1) errors will clear it anyway and (2) this
8009 avoids risk of specpdl overflow. */
8010 oquit
= Vinhibit_quit
;
8013 /* Initialize tool_bar_items_vector and protect it from GC. */
8014 init_tool_bar_items (reuse
);
8016 /* Build list of keymaps in maps. Set nmaps to the number of maps
8019 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8020 if (!NILP (Voverriding_local_map_menu_flag
))
8022 /* Yes, use them (if non-nil) as well as the global map. */
8023 maps
= alloca (3 * sizeof *maps
);
8025 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8026 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8027 if (!NILP (Voverriding_local_map
))
8028 maps
[nmaps
++] = Voverriding_local_map
;
8032 /* No, so use major and minor mode keymaps and keymap property.
8033 Note that tool-bar bindings in the local-map and keymap
8034 properties may not work reliable, as they are only
8035 recognized when the tool-bar (or mode-line) is updated,
8036 which does not normally happen after every command. */
8039 nminor
= current_minor_maps (NULL
, &tmaps
);
8040 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
8042 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8043 maps
[nmaps
++] = tem
;
8044 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8046 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8049 /* Add global keymap at the end. */
8050 maps
[nmaps
++] = current_global_map
;
8052 /* Process maps in reverse order and look up in each map the prefix
8054 for (i
= nmaps
- 1; i
>= 0; --i
)
8055 if (!NILP (maps
[i
]))
8059 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8061 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8064 Vinhibit_quit
= oquit
;
8065 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8066 return tool_bar_items_vector
;
8070 /* Process the definition of KEY which is DEF. */
8073 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8076 struct gcpro gcpro1
, gcpro2
;
8078 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8082 if (EQ (def
, Qundefined
))
8084 /* If a map has an explicit `undefined' as definition,
8085 discard any previously made item. */
8086 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8088 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8090 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8092 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8093 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8094 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8095 * sizeof (Lisp_Object
)));
8096 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8101 else if (parse_tool_bar_item (key
, def
))
8102 /* Append a new tool bar item to tool_bar_items_vector. Accept
8103 more than one definition for the same key. */
8104 append_tool_bar_item ();
8110 /* Parse a tool bar item specification ITEM for key KEY and return the
8111 result in tool_bar_item_properties. Value is zero if ITEM is
8114 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8116 CAPTION is the caption of the item, If it's not a string, it is
8117 evaluated to get a string.
8119 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8120 as binding are currently ignored.
8122 The following properties are recognized:
8126 FORM is evaluated and specifies whether the tool bar item is
8127 enabled or disabled.
8131 FORM is evaluated and specifies whether the tool bar item is visible.
8133 - `:filter FUNCTION'
8135 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8136 result is stored as the new binding.
8138 - `:button (TYPE SELECTED)'
8140 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8141 and specifies whether the button is selected (pressed) or not.
8145 IMAGES is either a single image specification or a vector of four
8146 image specifications. See enum tool_bar_item_images.
8148 - `:help HELP-STRING'.
8150 Gives a help string to display for the tool bar item.
8152 - `:label LABEL-STRING'.
8154 A text label to show with the tool bar button if labels are enabled. */
8157 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8159 /* Access slot with index IDX of vector tool_bar_item_properties. */
8160 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8162 Lisp_Object filter
= Qnil
;
8163 Lisp_Object caption
;
8164 int i
, have_label
= 0;
8166 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8167 Rule out items that aren't lists, don't start with
8168 `menu-item' or whose rest following `tool-bar-item' is not a
8173 /* As an exception, allow old-style menu separators. */
8174 if (STRINGP (XCAR (item
)))
8175 item
= Fcons (XCAR (item
), Qnil
);
8176 else if (!EQ (XCAR (item
), Qmenu_item
)
8177 || (item
= XCDR (item
), !CONSP (item
)))
8180 /* Create tool_bar_item_properties vector if necessary. Reset it to
8182 if (VECTORP (tool_bar_item_properties
))
8184 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8188 tool_bar_item_properties
8189 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8192 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8193 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8195 /* Get the caption of the item. If the caption is not a string,
8196 evaluate it to get a string. If we don't get a string, skip this
8198 caption
= XCAR (item
);
8199 if (!STRINGP (caption
))
8201 caption
= menu_item_eval_property (caption
);
8202 if (!STRINGP (caption
))
8205 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8207 /* If the rest following the caption is not a list, the menu item is
8208 either a separator, or invalid. */
8212 if (menu_separator_name_p (SSDATA (caption
)))
8214 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8215 #if !defined (USE_GTK) && !defined (HAVE_NS)
8216 /* If we use build_desired_tool_bar_string to render the
8217 tool bar, the separator is rendered as an image. */
8218 PROP (TOOL_BAR_ITEM_IMAGES
)
8219 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8220 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8221 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8222 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8229 /* Store the binding. */
8230 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8233 /* Ignore cached key binding, if any. */
8234 if (CONSP (item
) && CONSP (XCAR (item
)))
8237 /* Process the rest of the properties. */
8238 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8240 Lisp_Object ikey
, value
;
8243 value
= XCAR (XCDR (item
));
8245 if (EQ (ikey
, QCenable
))
8247 /* `:enable FORM'. */
8248 if (!NILP (Venable_disabled_menus_and_buttons
))
8249 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8251 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8253 else if (EQ (ikey
, QCvisible
))
8255 /* `:visible FORM'. If got a visible property and that
8256 evaluates to nil then ignore this item. */
8257 if (NILP (menu_item_eval_property (value
)))
8260 else if (EQ (ikey
, QChelp
))
8261 /* `:help HELP-STRING'. */
8262 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8263 else if (EQ (ikey
, QCvert_only
))
8264 /* `:vert-only t/nil'. */
8265 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8266 else if (EQ (ikey
, QClabel
))
8268 const char *bad_label
= "!!?GARBLED ITEM?!!";
8269 /* `:label LABEL-STRING'. */
8270 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8272 : build_string (bad_label
);
8275 else if (EQ (ikey
, QCfilter
))
8276 /* ':filter FORM'. */
8278 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8280 /* `:button (TYPE . SELECTED)'. */
8281 Lisp_Object type
, selected
;
8283 type
= XCAR (value
);
8284 selected
= XCDR (value
);
8285 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8287 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8288 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8291 else if (EQ (ikey
, QCimage
)
8293 || (VECTORP (value
) && ASIZE (value
) == 4)))
8294 /* Value is either a single image specification or a vector
8295 of 4 such specifications for the different button states. */
8296 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8297 else if (EQ (ikey
, QCrtl
))
8299 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8305 /* Try to make one from caption and key. */
8306 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8307 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8308 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8309 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8311 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8312 char *buf
= xmalloc (max_lbl
+ 1);
8313 Lisp_Object new_lbl
;
8314 ptrdiff_t caption_len
= strlen (capt
);
8316 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8319 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8321 buf
[caption_len
] = '\0';
8325 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8329 strcpy (buf
, label
);
8331 for (j
= 0; buf
[j
] != '\0'; ++j
)
8339 new_lbl
= Fupcase_initials (build_string (label
));
8340 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8341 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8343 PROP (TOOL_BAR_ITEM_LABEL
) = empty_unibyte_string
;
8347 /* If got a filter apply it on binding. */
8349 PROP (TOOL_BAR_ITEM_BINDING
)
8350 = menu_item_eval_property (list2 (filter
,
8352 PROP (TOOL_BAR_ITEM_BINDING
))));
8354 /* See if the binding is a keymap. Give up if it is. */
8355 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8358 /* Enable or disable selection of item. */
8359 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8360 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8361 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8363 /* Handle radio buttons or toggle boxes. */
8364 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8365 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8366 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8374 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8375 that can be reused. */
8378 init_tool_bar_items (Lisp_Object reuse
)
8380 if (VECTORP (reuse
))
8381 tool_bar_items_vector
= reuse
;
8383 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8384 ntool_bar_items
= 0;
8388 /* Append parsed tool bar item properties from
8389 tool_bar_item_properties */
8392 append_tool_bar_item (void)
8394 Lisp_Object
*to
, *from
;
8397 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8399 /* Enlarge tool_bar_items_vector if necessary. */
8401 tool_bar_items_vector
8402 = larger_vector (tool_bar_items_vector
, incr
, -1);
8404 /* Append entries from tool_bar_item_properties to the end of
8405 tool_bar_items_vector. */
8406 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8407 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8408 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8409 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8416 /* Read a character using menus based on maps in the array MAPS.
8417 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8418 Return t if we displayed a menu but the user rejected it.
8420 PREV_EVENT is the previous input event, or nil if we are reading
8421 the first event of a key sequence.
8423 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8424 if we used a mouse menu to read the input, or zero otherwise. If
8425 USED_MOUSE_MENU is null, we don't dereference it.
8427 The prompting is done based on the prompt-string of the map
8428 and the strings associated with various map elements.
8430 This can be done with X menus or with menus put in the minibuf.
8431 These are done in different ways, depending on how the input will be read.
8432 Menus using X are done after auto-saving in read-char, getting the input
8433 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8434 and do auto-saving in the inner call of read_char. */
8437 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8438 Lisp_Object prev_event
, int *used_mouse_menu
)
8442 if (used_mouse_menu
)
8443 *used_mouse_menu
= 0;
8445 /* Use local over global Menu maps */
8447 if (! menu_prompting
)
8450 /* Optionally disregard all but the global map. */
8451 if (inhibit_local_menu_bar_menus
)
8453 maps
+= (nmaps
- 1);
8458 /* If we got to this point via a mouse click,
8459 use a real menu for mouse selection. */
8460 if (EVENT_HAS_PARAMETERS (prev_event
)
8461 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8462 && !EQ (XCAR (prev_event
), Qtool_bar
))
8464 /* Display the menu and get the selection. */
8465 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8467 ptrdiff_t nmaps1
= 0;
8469 /* Use the maps that are not nil. */
8470 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8471 if (!NILP (maps
[mapno
]))
8472 realmaps
[nmaps1
++] = maps
[mapno
];
8474 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8479 record_menu_key (XCAR (value
));
8481 /* If we got multiple events, unread all but
8483 There is no way to prevent those unread events
8484 from showing up later in last_nonmenu_event.
8485 So turn symbol and integer events into lists,
8486 to indicate that they came from a mouse menu,
8487 so that when present in last_nonmenu_event
8488 they won't confuse things. */
8489 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8491 record_menu_key (XCAR (tem
));
8492 if (SYMBOLP (XCAR (tem
))
8493 || INTEGERP (XCAR (tem
)))
8494 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8497 /* If we got more than one event, put all but the first
8498 onto this list to be read later.
8499 Return just the first event now. */
8500 Vunread_command_events
8501 = nconc2 (XCDR (value
), Vunread_command_events
);
8502 value
= XCAR (value
);
8504 else if (NILP (value
))
8506 if (used_mouse_menu
)
8507 *used_mouse_menu
= 1;
8510 #endif /* HAVE_MENUS */
8514 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8515 We make this bigger when necessary, and never free it. */
8516 static char *read_char_minibuf_menu_text
;
8517 /* Size of that buffer. */
8518 static ptrdiff_t read_char_minibuf_menu_width
;
8521 read_char_minibuf_menu_prompt (int commandflag
,
8522 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8525 register Lisp_Object name
;
8527 /* FIXME: Use the minibuffer's frame width. */
8528 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8531 Lisp_Object rest
, vector
;
8537 if (! menu_prompting
)
8540 /* Get the menu name from the first map that has one (a prompt string). */
8541 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8543 name
= Fkeymap_prompt (maps
[mapno
]);
8548 /* If we don't have any menus, just read a character normally. */
8549 if (!STRINGP (name
))
8552 /* Make sure we have a big enough buffer for the menu text. */
8553 width
= max (width
, SBYTES (name
));
8554 if (STRING_BYTES_BOUND
- 4 < width
)
8555 memory_full (SIZE_MAX
);
8556 if (width
+ 4 > read_char_minibuf_menu_width
)
8558 read_char_minibuf_menu_text
8559 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8560 read_char_minibuf_menu_width
= width
+ 4;
8562 menu
= read_char_minibuf_menu_text
;
8564 /* Prompt string always starts with map's prompt, and a space. */
8565 strcpy (menu
, SSDATA (name
));
8566 nlength
= SBYTES (name
);
8567 menu
[nlength
++] = ':';
8568 menu
[nlength
++] = ' ';
8571 /* Start prompting at start of first map. */
8575 /* Present the documented bindings, a line at a time. */
8579 ptrdiff_t i
= nlength
;
8581 Lisp_Object orig_defn_macro
;
8583 /* Loop over elements of map. */
8588 /* If reached end of map, start at beginning of next map. */
8592 /* At end of last map, wrap around to first map if just starting,
8593 or end this line if already have something on it. */
8597 if (notfirst
|| nobindings
) break;
8602 /* Look at the next element of the map. */
8604 elt
= AREF (vector
, idx
);
8606 elt
= Fcar_safe (rest
);
8608 if (idx
< 0 && VECTORP (elt
))
8610 /* If we found a dense table in the keymap,
8611 advanced past it, but start scanning its contents. */
8612 rest
= Fcdr_safe (rest
);
8618 /* An ordinary element. */
8619 Lisp_Object event
, tem
;
8623 event
= Fcar_safe (elt
); /* alist */
8624 elt
= Fcdr_safe (elt
);
8628 XSETINT (event
, idx
); /* vector */
8631 /* Ignore the element if it has no prompt string. */
8632 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8634 /* 1 if the char to type matches the string. */
8636 Lisp_Object upcased_event
, downcased_event
;
8637 Lisp_Object desc
= Qnil
;
8639 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8641 upcased_event
= Fupcase (event
);
8642 downcased_event
= Fdowncase (event
);
8643 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8644 || XINT (downcased_event
) == SREF (s
, 0));
8646 desc
= Fsingle_key_description (event
, Qnil
);
8648 #if 0 /* It is redundant to list the equivalent key bindings because
8649 the prefix is what the user has already typed. */
8651 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8653 /* Insert equivalent keybinding. */
8654 s
= concat2 (s
, tem
);
8657 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8658 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8660 /* Insert button prefix. */
8661 Lisp_Object selected
8662 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8663 if (EQ (tem
, QCradio
))
8664 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8666 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8667 s
= concat2 (tem
, s
);
8671 /* If we have room for the prompt string, add it to this line.
8672 If this is the first on the line, always add it. */
8673 if ((SCHARS (s
) + i
+ 2
8674 + (char_matches
? 0 : SCHARS (desc
) + 3))
8678 ptrdiff_t thiswidth
;
8680 /* Punctuate between strings. */
8683 strcpy (menu
+ i
, ", ");
8689 /* If the char to type doesn't match the string's
8690 first char, explicitly show what char to type. */
8693 /* Add as much of string as fits. */
8694 thiswidth
= min (SCHARS (desc
), width
- i
);
8695 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8697 strcpy (menu
+ i
, " = ");
8701 /* Add as much of string as fits. */
8702 thiswidth
= min (SCHARS (s
), width
- i
);
8703 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8709 /* If this element does not fit, end the line now,
8710 and save the element for the next line. */
8711 strcpy (menu
+ i
, "...");
8716 /* Move past this element. */
8717 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8718 /* Handle reaching end of dense table. */
8723 rest
= Fcdr_safe (rest
);
8727 /* Prompt with that and read response. */
8728 message2_nolog (menu
, strlen (menu
),
8729 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8731 /* Make believe its not a keyboard macro in case the help char
8732 is pressed. Help characters are not recorded because menu prompting
8733 is not used on replay.
8735 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8736 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8738 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8739 while (BUFFERP (obj
));
8740 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8742 if (!INTEGERP (obj
))
8744 else if (XINT (obj
) == -2)
8747 if (! EQ (obj
, menu_prompt_more_char
)
8748 && (!INTEGERP (menu_prompt_more_char
)
8749 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8751 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8752 store_kbd_macro_char (obj
);
8755 /* Help char - go round again */
8759 /* Reading key sequences. */
8761 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8762 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8763 keymap, or nil otherwise. Return the index of the first keymap in
8764 which KEY has any binding, or NMAPS if no map has a binding.
8766 If KEY is a meta ASCII character, treat it like meta-prefix-char
8767 followed by the corresponding non-meta character. Keymaps in
8768 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8771 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8774 NEXT may be the same array as CURRENT. */
8777 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8778 Lisp_Object
*defs
, Lisp_Object
*next
)
8780 ptrdiff_t i
, first_binding
;
8782 first_binding
= nmaps
;
8783 for (i
= nmaps
- 1; i
>= 0; i
--)
8785 if (! NILP (current
[i
]))
8787 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8788 if (! NILP (defs
[i
]))
8795 /* Given the set of bindings we've found, produce the next set of maps. */
8796 if (first_binding
< nmaps
)
8797 for (i
= 0; i
< nmaps
; i
++)
8798 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8800 return first_binding
;
8803 /* Structure used to keep track of partial application of key remapping
8804 such as Vfunction_key_map and Vkey_translation_map. */
8805 typedef struct keyremap
8807 /* This is the map originally specified for this use. */
8809 /* This is a submap reached by looking up, in PARENT,
8810 the events from START to END. */
8812 /* Positions [START, END) in the key sequence buffer
8813 are the key that we have scanned so far.
8814 Those events are the ones that we will replace
8815 if PARENT maps them into a key sequence. */
8819 /* Lookup KEY in MAP.
8820 MAP is a keymap mapping keys to key vectors or functions.
8821 If the mapping is a function and DO_FUNCTION is non-zero, then
8822 the function is called with PROMPT as parameter and its return
8823 value is used as the return value of this function (after checking
8824 that it is indeed a vector). */
8827 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8832 next
= access_keymap (map
, key
, 1, 0, 1);
8834 /* Handle symbol with autoload definition. */
8835 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8836 && CONSP (XSYMBOL (next
)->function
)
8837 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8838 do_autoload (XSYMBOL (next
)->function
, next
);
8840 /* Handle a symbol whose function definition is a keymap
8842 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8843 && (ARRAYP (XSYMBOL (next
)->function
)
8844 || KEYMAPP (XSYMBOL (next
)->function
)))
8845 next
= XSYMBOL (next
)->function
;
8847 /* If the keymap gives a function, not an
8848 array, then call the function with one arg and use
8849 its value instead. */
8850 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8855 next
= call1 (next
, prompt
);
8856 /* If the function returned something invalid,
8857 barf--don't ignore it.
8858 (To ignore it safely, we would need to gcpro a bunch of
8859 other variables.) */
8860 if (! (VECTORP (next
) || STRINGP (next
)))
8861 error ("Function %s returns invalid key sequence",
8862 SSDATA (SYMBOL_NAME (tem
)));
8867 /* Do one step of the key remapping used for function-key-map and
8868 key-translation-map:
8869 KEYBUF is the buffer holding the input events.
8870 BUFSIZE is its maximum size.
8871 FKEY is a pointer to the keyremap structure to use.
8872 INPUT is the index of the last element in KEYBUF.
8873 DOIT if non-zero says that the remapping can actually take place.
8874 DIFF is used to return the number of keys added/removed by the remapping.
8875 PARENT is the root of the keymap.
8876 PROMPT is the prompt to use if the remapping happens through a function.
8877 The return value is non-zero if the remapping actually took place. */
8880 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8881 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8883 Lisp_Object next
, key
;
8885 key
= keybuf
[fkey
->end
++];
8887 if (KEYMAPP (fkey
->parent
))
8888 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8892 /* If keybuf[fkey->start..fkey->end] is bound in the
8893 map and we're in a position to do the key remapping, replace it with
8894 the binding and restart with fkey->start at the end. */
8895 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8897 int len
= XFASTINT (Flength (next
));
8900 *diff
= len
- (fkey
->end
- fkey
->start
);
8902 if (bufsize
- input
<= *diff
)
8903 error ("Key sequence too long");
8905 /* Shift the keys that follow fkey->end. */
8907 for (i
= fkey
->end
; i
< input
; i
++)
8908 keybuf
[i
+ *diff
] = keybuf
[i
];
8910 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8911 keybuf
[i
+ *diff
] = keybuf
[i
];
8912 /* Overwrite the old keys with the new ones. */
8913 for (i
= 0; i
< len
; i
++)
8914 keybuf
[fkey
->start
+ i
]
8915 = Faref (next
, make_number (i
));
8917 fkey
->start
= fkey
->end
+= *diff
;
8918 fkey
->map
= fkey
->parent
;
8923 fkey
->map
= get_keymap (next
, 0, 1);
8925 /* If we no longer have a bound suffix, try a new position for
8927 if (!CONSP (fkey
->map
))
8929 fkey
->end
= ++fkey
->start
;
8930 fkey
->map
= fkey
->parent
;
8936 test_undefined (Lisp_Object binding
)
8938 return (EQ (binding
, Qundefined
)
8939 || (!NILP (binding
) && SYMBOLP (binding
)
8940 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8943 /* Read a sequence of keys that ends with a non prefix character,
8944 storing it in KEYBUF, a buffer of size BUFSIZE.
8946 Return the length of the key sequence stored.
8947 Return -1 if the user rejected a command menu.
8949 Echo starting immediately unless `prompt' is 0.
8951 Where a key sequence ends depends on the currently active keymaps.
8952 These include any minor mode keymaps active in the current buffer,
8953 the current buffer's local map, and the global map.
8955 If a key sequence has no other bindings, we check Vfunction_key_map
8956 to see if some trailing subsequence might be the beginning of a
8957 function key's sequence. If so, we try to read the whole function
8958 key, and substitute its symbolic name into the key sequence.
8960 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8961 `double-' events into similar click events, if that would make them
8962 bound. We try to turn `triple-' events first into `double-' events,
8965 If we get a mouse click in a mode line, vertical divider, or other
8966 non-text area, we treat the click as if it were prefixed by the
8967 symbol denoting that area - `mode-line', `vertical-line', or
8970 If the sequence starts with a mouse click, we read the key sequence
8971 with respect to the buffer clicked on, not the current buffer.
8973 If the user switches frames in the midst of a key sequence, we put
8974 off the switch-frame event until later; the next call to
8975 read_char will return it.
8977 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8978 from the selected window's buffer. */
8981 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8982 int dont_downcase_last
, int can_return_switch_frame
,
8983 int fix_current_buffer
)
8985 Lisp_Object from_string
;
8986 ptrdiff_t count
= SPECPDL_INDEX ();
8988 /* How many keys there are in the current key sequence. */
8991 /* The length of the echo buffer when we started reading, and
8992 the length of this_command_keys when we started reading. */
8993 ptrdiff_t echo_start
IF_LINT (= 0);
8994 ptrdiff_t keys_start
;
8996 /* The number of keymaps we're scanning right now, and the number of
8997 keymaps we have allocated space for. */
8999 ptrdiff_t nmaps_allocated
= 0;
9001 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9002 the current keymaps. */
9003 Lisp_Object
*defs
= NULL
;
9005 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9006 in the current keymaps, or nil where it is not a prefix. */
9007 Lisp_Object
*submaps
= NULL
;
9009 /* The local map to start out with at start of key sequence. */
9010 Lisp_Object orig_local_map
;
9012 /* The map from the `keymap' property to start out with at start of
9014 Lisp_Object orig_keymap
;
9016 /* 1 if we have already considered switching to the local-map property
9017 of the place where a mouse click occurred. */
9018 int localized_local_map
= 0;
9020 /* The index in submaps[] of the first keymap that has a binding for
9021 this key sequence. In other words, the lowest i such that
9022 submaps[i] is non-nil. */
9023 ptrdiff_t first_binding
;
9024 /* Index of the first key that has no binding.
9025 It is useless to try fkey.start larger than that. */
9028 /* If t < mock_input, then KEYBUF[t] should be read as the next
9031 We use this to recover after recognizing a function key. Once we
9032 realize that a suffix of the current key sequence is actually a
9033 function key's escape sequence, we replace the suffix with the
9034 function key's binding from Vfunction_key_map. Now keybuf
9035 contains a new and different key sequence, so the echo area,
9036 this_command_keys, and the submaps and defs arrays are wrong. In
9037 this situation, we set mock_input to t, set t to 0, and jump to
9038 restart_sequence; the loop will read keys from keybuf up until
9039 mock_input, thus rebuilding the state; and then it will resume
9040 reading characters from the keyboard. */
9043 /* If the sequence is unbound in submaps[], then
9044 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9045 and fkey.map is its binding.
9047 These might be > t, indicating that all function key scanning
9048 should hold off until t reaches them. We do this when we've just
9049 recognized a function key, to avoid searching for the function
9050 key's again in Vfunction_key_map. */
9053 /* Likewise, for key_translation_map and input-decode-map. */
9054 keyremap keytran
, indec
;
9056 /* Non-zero if we are trying to map a key by changing an upper-case
9057 letter to lower case, or a shifted function key to an unshifted
9059 int shift_translated
= 0;
9061 /* If we receive a `switch-frame' or `select-window' event in the middle of
9062 a key sequence, we put it off for later.
9063 While we're reading, we keep the event here. */
9064 Lisp_Object delayed_switch_frame
;
9066 /* See the comment below... */
9067 #if defined (GOBBLE_FIRST_EVENT)
9068 Lisp_Object first_event
;
9071 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9072 int original_uppercase_position
= -1;
9074 /* Gets around Microsoft compiler limitations. */
9077 struct buffer
*starting_buffer
;
9079 /* List of events for which a fake prefix key has been generated. */
9080 Lisp_Object fake_prefixed_keys
= Qnil
;
9082 #if defined (GOBBLE_FIRST_EVENT)
9086 struct gcpro gcpro1
;
9088 GCPRO1 (fake_prefixed_keys
);
9089 raw_keybuf_count
= 0;
9091 last_nonmenu_event
= Qnil
;
9093 delayed_switch_frame
= Qnil
;
9099 /* Install the string STR as the beginning of the string of
9100 echoing, so that it serves as a prompt for the next
9102 KVAR (current_kboard
, echo_string
) = prompt
;
9103 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9106 else if (cursor_in_echo_area
9107 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9108 && NILP (Fzerop (Vecho_keystrokes
)))
9109 /* This doesn't put in a dash if the echo buffer is empty, so
9110 you don't always see a dash hanging out in the minibuffer. */
9114 /* Record the initial state of the echo area and this_command_keys;
9115 we will need to restore them if we replay a key sequence. */
9117 echo_start
= echo_length ();
9118 keys_start
= this_command_key_count
;
9119 this_single_command_key_start
= keys_start
;
9121 #if defined (GOBBLE_FIRST_EVENT)
9122 /* This doesn't quite work, because some of the things that read_char
9123 does cannot safely be bypassed. It seems too risky to try to make
9126 /* Read the first char of the sequence specially, before setting
9127 up any keymaps, in case a filter runs and switches buffers on us. */
9128 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9130 #endif /* GOBBLE_FIRST_EVENT */
9132 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9133 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9136 /* We jump here when we need to reinitialize fkey and keytran; this
9137 happens if we switch keyboards between rescans. */
9138 replay_entire_sequence
:
9140 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9141 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9142 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9143 indec
.start
= indec
.end
= 0;
9144 fkey
.start
= fkey
.end
= 0;
9145 keytran
.start
= keytran
.end
= 0;
9147 /* We jump here when the key sequence has been thoroughly changed, and
9148 we need to rescan it starting from the beginning. When we jump here,
9149 keybuf[0..mock_input] holds the sequence we should reread. */
9152 starting_buffer
= current_buffer
;
9153 first_unbound
= bufsize
+ 1;
9155 /* Build our list of keymaps.
9156 If we recognize a function key and replace its escape sequence in
9157 keybuf with its symbol, or if the sequence starts with a mouse
9158 click and we need to switch buffers, we jump back here to rebuild
9159 the initial keymaps from the current buffer. */
9162 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9164 if (2 > nmaps_allocated
)
9166 submaps
= alloca (2 * sizeof *submaps
);
9167 defs
= alloca (2 * sizeof *defs
);
9168 nmaps_allocated
= 2;
9170 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9172 else if (!NILP (Voverriding_local_map
))
9174 if (2 > nmaps_allocated
)
9176 submaps
= alloca (2 * sizeof *submaps
);
9177 defs
= alloca (2 * sizeof *defs
);
9178 nmaps_allocated
= 2;
9180 submaps
[nmaps
++] = Voverriding_local_map
;
9188 nminor
= current_minor_maps (0, &maps
);
9189 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9191 if (total
> nmaps_allocated
)
9193 submaps
= alloca (total
* sizeof *submaps
);
9194 defs
= alloca (total
* sizeof *defs
);
9195 nmaps_allocated
= total
;
9198 if (!NILP (orig_keymap
))
9199 submaps
[nmaps
++] = orig_keymap
;
9201 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9205 submaps
[nmaps
++] = orig_local_map
;
9207 submaps
[nmaps
++] = current_global_map
;
9209 /* Find an accurate initial value for first_binding. */
9210 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9211 if (! NILP (submaps
[first_binding
]))
9214 /* Start from the beginning in keybuf. */
9217 /* These are no-ops the first time through, but if we restart, they
9218 revert the echo area and this_command_keys to their original state. */
9219 this_command_key_count
= keys_start
;
9220 if (INTERACTIVE
&& t
< mock_input
)
9221 echo_truncate (echo_start
);
9223 /* If the best binding for the current key sequence is a keymap, or
9224 we may be looking at a function key's escape sequence, keep on
9226 while (first_binding
< nmaps
9227 /* Keep reading as long as there's a prefix binding. */
9228 ? !NILP (submaps
[first_binding
])
9229 /* Don't return in the middle of a possible function key sequence,
9230 if the only bindings we found were via case conversion.
9231 Thus, if ESC O a has a function-key-map translation
9232 and ESC o has a binding, don't return after ESC O,
9233 so that we can translate ESC O plus the next character. */
9234 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9237 int used_mouse_menu
= 0;
9239 /* Where the last real key started. If we need to throw away a
9240 key that has expanded into more than one element of keybuf
9241 (say, a mouse click on the mode line which is being treated
9242 as [mode-line (mouse-...)], then we backtrack to this point
9244 int last_real_key_start
;
9246 /* These variables are analogous to echo_start and keys_start;
9247 while those allow us to restart the entire key sequence,
9248 echo_local_start and keys_local_start allow us to throw away
9250 ptrdiff_t echo_local_start
IF_LINT (= 0);
9251 int keys_local_start
;
9252 ptrdiff_t local_first_binding
;
9254 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9255 eassert (indec
.start
<= indec
.end
);
9256 eassert (fkey
.start
<= fkey
.end
);
9257 eassert (keytran
.start
<= keytran
.end
);
9258 /* key-translation-map is applied *after* function-key-map
9259 which is itself applied *after* input-decode-map. */
9260 eassert (fkey
.end
<= indec
.start
);
9261 eassert (keytran
.end
<= fkey
.start
);
9263 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9264 first_unbound
< keytran
.start
)
9265 { /* The prefix upto first_unbound has no binding and has
9266 no translation left to do either, so we know it's unbound.
9267 If we don't stop now, we risk staying here indefinitely
9268 (if the user keeps entering fkey or keytran prefixes
9269 like C-c ESC ESC ESC ESC ...) */
9271 for (i
= first_unbound
+ 1; i
< t
; i
++)
9272 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9273 mock_input
= t
- first_unbound
- 1;
9274 indec
.end
= indec
.start
-= first_unbound
+ 1;
9275 indec
.map
= indec
.parent
;
9276 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9277 fkey
.map
= fkey
.parent
;
9278 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9279 keytran
.map
= keytran
.parent
;
9280 goto replay_sequence
;
9284 error ("Key sequence too long");
9287 echo_local_start
= echo_length ();
9288 keys_local_start
= this_command_key_count
;
9289 local_first_binding
= first_binding
;
9292 /* These are no-ops, unless we throw away a keystroke below and
9293 jumped back up to replay_key; in that case, these restore the
9294 variables to their original state, allowing us to replay the
9296 if (INTERACTIVE
&& t
< mock_input
)
9297 echo_truncate (echo_local_start
);
9298 this_command_key_count
= keys_local_start
;
9299 first_binding
= local_first_binding
;
9301 /* By default, assume each event is "real". */
9302 last_real_key_start
= t
;
9304 /* Does mock_input indicate that we are re-reading a key sequence? */
9308 add_command_key (key
);
9309 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9310 && NILP (Fzerop (Vecho_keystrokes
)))
9314 /* If not, we should actually read a character. */
9318 KBOARD
*interrupted_kboard
= current_kboard
;
9319 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9320 key
= read_char (NILP (prompt
), nmaps
,
9321 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9322 &used_mouse_menu
, NULL
);
9323 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9324 /* When switching to a new tty (with a new keyboard),
9325 read_char returns the new buffer, rather than -2
9326 (Bug#5095). This is because `terminal-init-xterm'
9327 calls read-char, which eats the wrong_kboard_jmpbuf
9328 return. Any better way to fix this? -- cyd */
9329 || (interrupted_kboard
!= current_kboard
))
9334 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9335 if (k
== interrupted_kboard
)
9340 /* Don't touch interrupted_kboard when it's been
9342 delayed_switch_frame
= Qnil
;
9343 goto replay_entire_sequence
;
9346 if (!NILP (delayed_switch_frame
))
9348 KVAR (interrupted_kboard
, kbd_queue
)
9349 = Fcons (delayed_switch_frame
,
9350 KVAR (interrupted_kboard
, kbd_queue
));
9351 delayed_switch_frame
= Qnil
;
9355 KVAR (interrupted_kboard
, kbd_queue
)
9356 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9358 /* If the side queue is non-empty, ensure it begins with a
9359 switch-frame, so we'll replay it in the right context. */
9360 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9361 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9362 !(EVENT_HAS_PARAMETERS (key
)
9363 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9367 XSETFRAME (frame
, interrupted_frame
);
9368 KVAR (interrupted_kboard
, kbd_queue
)
9369 = Fcons (make_lispy_switch_frame (frame
),
9370 KVAR (interrupted_kboard
, kbd_queue
));
9373 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9374 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9375 goto replay_entire_sequence
;
9379 /* read_char returns t when it shows a menu and the user rejects it.
9383 unbind_to (count
, Qnil
);
9388 /* read_char returns -1 at the end of a macro.
9389 Emacs 18 handles this by returning immediately with a
9390 zero, so that's what we'll do. */
9391 if (INTEGERP (key
) && XINT (key
) == -1)
9394 /* The Microsoft C compiler can't handle the goto that
9400 /* If the current buffer has been changed from under us, the
9401 keymap may have changed, so replay the sequence. */
9404 timer_resume_idle ();
9407 /* Reset the current buffer from the selected window
9408 in case something changed the former and not the latter.
9409 This is to be more consistent with the behavior
9410 of the command_loop_1. */
9411 if (fix_current_buffer
)
9413 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9415 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9416 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9419 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9420 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9421 goto replay_sequence
;
9424 /* If we have a quit that was typed in another frame, and
9425 quit_throw_to_read_char switched buffers,
9426 replay to get the right keymap. */
9428 && XINT (key
) == quit_char
9429 && current_buffer
!= starting_buffer
)
9432 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9437 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9438 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9439 goto replay_sequence
;
9444 if (EVENT_HAS_PARAMETERS (key
)
9445 /* Either a `switch-frame' or a `select-window' event. */
9446 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9448 /* If we're at the beginning of a key sequence, and the caller
9449 says it's okay, go ahead and return this event. If we're
9450 in the midst of a key sequence, delay it until the end. */
9451 if (t
> 0 || !can_return_switch_frame
)
9453 delayed_switch_frame
= key
;
9459 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9463 /* Clicks in non-text areas get prefixed by the symbol
9464 in their CHAR-ADDRESS field. For example, a click on
9465 the mode line is prefixed by the symbol `mode-line'.
9467 Furthermore, key sequences beginning with mouse clicks
9468 are read using the keymaps of the buffer clicked on, not
9469 the current buffer. So we may have to switch the buffer
9472 When we turn one event into two events, we must make sure
9473 that neither of the two looks like the original--so that,
9474 if we replay the events, they won't be expanded again.
9475 If not for this, such reexpansion could happen either here
9476 or when user programs play with this-command-keys. */
9477 if (EVENT_HAS_PARAMETERS (key
))
9482 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9483 if (EQ (kind
, Qmouse_click
))
9485 Lisp_Object window
, posn
;
9487 window
= POSN_WINDOW (EVENT_START (key
));
9488 posn
= POSN_POSN (EVENT_START (key
));
9491 || (!NILP (fake_prefixed_keys
)
9492 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9494 /* We're looking a second time at an event for which
9495 we generated a fake prefix key. Set
9496 last_real_key_start appropriately. */
9498 last_real_key_start
= t
- 1;
9501 if (last_real_key_start
== 0)
9503 /* Key sequences beginning with mouse clicks are
9504 read using the keymaps in the buffer clicked on,
9505 not the current buffer. If we're at the
9506 beginning of a key sequence, switch buffers. */
9507 if (WINDOWP (window
)
9508 && BUFFERP (XWINDOW (window
)->buffer
)
9509 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9511 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9516 /* Arrange to go back to the original buffer once we're
9517 done reading the key sequence. Note that we can't
9518 use save_excursion_{save,restore} here, because they
9519 save point as well as the current buffer; we don't
9520 want to save point, because redisplay may change it,
9521 to accommodate a Fset_window_start or something. We
9522 don't want to do this at the top of the function,
9523 because we may get input from a subprocess which
9524 wants to change the selected window and stuff (say,
9526 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9528 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9530 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9531 orig_local_map
= get_local_map (PT
, current_buffer
,
9533 orig_keymap
= get_local_map (PT
, current_buffer
,
9535 goto replay_sequence
;
9538 /* For a mouse click, get the local text-property keymap
9539 of the place clicked on, rather than point. */
9540 if (CONSP (XCDR (key
))
9541 && ! localized_local_map
)
9543 Lisp_Object map_here
, start
, pos
;
9545 localized_local_map
= 1;
9546 start
= EVENT_START (key
);
9548 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9550 pos
= POSN_BUFFER_POSN (start
);
9552 && XINT (pos
) >= BEGV
9553 && XINT (pos
) <= ZV
)
9555 map_here
= get_local_map (XINT (pos
),
9558 if (!EQ (map_here
, orig_local_map
))
9560 orig_local_map
= map_here
;
9561 ++localized_local_map
;
9564 map_here
= get_local_map (XINT (pos
),
9567 if (!EQ (map_here
, orig_keymap
))
9569 orig_keymap
= map_here
;
9570 ++localized_local_map
;
9573 if (localized_local_map
> 1)
9578 goto replay_sequence
;
9585 /* Expand mode-line and scroll-bar events into two events:
9586 use posn as a fake prefix key. */
9588 && (NILP (fake_prefixed_keys
)
9589 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9591 if (bufsize
- t
<= 1)
9592 error ("Key sequence too long");
9595 keybuf
[t
+ 1] = key
;
9598 /* Record that a fake prefix key has been generated
9599 for KEY. Don't modify the event; this would
9600 prevent proper action when the event is pushed
9601 back into unread-command-events. */
9602 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9604 /* If on a mode line string with a local keymap,
9605 reconsider the key sequence with that keymap. */
9606 if (string
= POSN_STRING (EVENT_START (key
)),
9607 (CONSP (string
) && STRINGP (XCAR (string
))))
9609 Lisp_Object pos
, map
, map2
;
9611 pos
= XCDR (string
);
9612 string
= XCAR (string
);
9614 && XINT (pos
) < SCHARS (string
))
9616 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9618 orig_local_map
= map
;
9619 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9622 if (!NILP (map
) || !NILP (map2
))
9623 goto replay_sequence
;
9629 else if (NILP (from_string
)
9630 && (string
= POSN_STRING (EVENT_START (key
)),
9631 (CONSP (string
) && STRINGP (XCAR (string
)))))
9633 /* For a click on a string, i.e. overlay string or a
9634 string displayed via the `display' property,
9635 consider `local-map' and `keymap' properties of
9637 Lisp_Object pos
, map
, map2
;
9639 pos
= XCDR (string
);
9640 string
= XCAR (string
);
9642 && XINT (pos
) < SCHARS (string
))
9644 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9646 orig_local_map
= map
;
9647 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9651 if (!NILP (map
) || !NILP (map2
))
9653 from_string
= string
;
9656 goto replay_sequence
;
9661 else if (CONSP (XCDR (key
))
9662 && CONSP (EVENT_START (key
))
9663 && CONSP (XCDR (EVENT_START (key
))))
9667 posn
= POSN_POSN (EVENT_START (key
));
9668 /* Handle menu-bar events:
9669 insert the dummy prefix event `menu-bar'. */
9670 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9672 if (bufsize
- t
<= 1)
9673 error ("Key sequence too long");
9677 /* Zap the position in key, so we know that we've
9678 expanded it, and don't try to do so again. */
9679 POSN_SET_POSN (EVENT_START (key
),
9680 Fcons (posn
, Qnil
));
9683 goto replay_sequence
;
9685 else if (CONSP (posn
))
9687 /* We're looking at the second event of a
9688 sequence which we expanded before. Set
9689 last_real_key_start appropriately. */
9690 if (last_real_key_start
== t
&& t
> 0)
9691 last_real_key_start
= t
- 1;
9696 /* We have finally decided that KEY is something we might want
9698 first_binding
= (follow_key (key
,
9699 nmaps
- first_binding
,
9700 submaps
+ first_binding
,
9701 defs
+ first_binding
,
9702 submaps
+ first_binding
)
9705 /* If KEY wasn't bound, we'll try some fallbacks. */
9706 if (first_binding
< nmaps
)
9707 /* This is needed for the following scenario:
9708 event 0: a down-event that gets dropped by calling replay_key.
9709 event 1: some normal prefix like C-h.
9710 After event 0, first_unbound is 0, after event 1 indec.start,
9711 fkey.start, and keytran.start are all 1, so when we see that
9712 C-h is bound, we need to update first_unbound. */
9713 first_unbound
= max (t
+ 1, first_unbound
);
9718 /* Remember the position to put an upper bound on indec.start. */
9719 first_unbound
= min (t
, first_unbound
);
9721 head
= EVENT_HEAD (key
);
9722 if (help_char_p (head
) && t
> 0)
9724 read_key_sequence_cmd
= Vprefix_help_command
;
9726 last_nonmenu_event
= key
;
9727 /* The Microsoft C compiler can't handle the goto that
9735 Lisp_Object breakdown
;
9738 breakdown
= parse_modifiers (head
);
9739 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9740 /* Attempt to reduce an unbound mouse event to a simpler
9741 event that is bound:
9742 Drags reduce to clicks.
9743 Double-clicks reduce to clicks.
9744 Triple-clicks reduce to double-clicks, then to clicks.
9745 Down-clicks are eliminated.
9746 Double-downs reduce to downs, then are eliminated.
9747 Triple-downs reduce to double-downs, then to downs,
9748 then are eliminated. */
9749 if (modifiers
& (down_modifier
| drag_modifier
9750 | double_modifier
| triple_modifier
))
9752 while (modifiers
& (down_modifier
| drag_modifier
9753 | double_modifier
| triple_modifier
))
9755 Lisp_Object new_head
, new_click
;
9756 if (modifiers
& triple_modifier
)
9757 modifiers
^= (double_modifier
| triple_modifier
);
9758 else if (modifiers
& double_modifier
)
9759 modifiers
&= ~double_modifier
;
9760 else if (modifiers
& drag_modifier
)
9761 modifiers
&= ~drag_modifier
;
9764 /* Dispose of this `down' event by simply jumping
9765 back to replay_key, to get another event.
9767 Note that if this event came from mock input,
9768 then just jumping back to replay_key will just
9769 hand it to us again. So we have to wipe out any
9772 We could delete keybuf[t] and shift everything
9773 after that to the left by one spot, but we'd also
9774 have to fix up any variable that points into
9775 keybuf, and shifting isn't really necessary
9778 Adding prefixes for non-textual mouse clicks
9779 creates two characters of mock input, and both
9780 must be thrown away. If we're only looking at
9781 the prefix now, we can just jump back to
9782 replay_key. On the other hand, if we've already
9783 processed the prefix, and now the actual click
9784 itself is giving us trouble, then we've lost the
9785 state of the keymaps we want to backtrack to, and
9786 we need to replay the whole sequence to rebuild
9789 Beyond that, only function key expansion could
9790 create more than two keys, but that should never
9791 generate mouse events, so it's okay to zero
9792 mock_input in that case too.
9794 FIXME: The above paragraph seems just plain
9795 wrong, if you consider things like
9796 xterm-mouse-mode. -stef
9798 Isn't this just the most wonderful code ever? */
9800 /* If mock_input > t + 1, the above simplification
9801 will actually end up dropping keys on the floor.
9802 This is probably OK for now, but even
9803 if mock_input <= t + 1, we need to adjust indec,
9805 Typical case [header-line down-mouse-N]:
9806 mock_input = 2, t = 1, fkey.end = 1,
9807 last_real_key_start = 0. */
9808 if (indec
.end
> last_real_key_start
)
9810 indec
.end
= indec
.start
9811 = min (last_real_key_start
, indec
.start
);
9812 indec
.map
= indec
.parent
;
9813 if (fkey
.end
> last_real_key_start
)
9815 fkey
.end
= fkey
.start
9816 = min (last_real_key_start
, fkey
.start
);
9817 fkey
.map
= fkey
.parent
;
9818 if (keytran
.end
> last_real_key_start
)
9820 keytran
.end
= keytran
.start
9821 = min (last_real_key_start
, keytran
.start
);
9822 keytran
.map
= keytran
.parent
;
9826 if (t
== last_real_key_start
)
9833 mock_input
= last_real_key_start
;
9834 goto replay_sequence
;
9839 = apply_modifiers (modifiers
, XCAR (breakdown
));
9841 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9843 /* Look for a binding for this new key. follow_key
9844 promises that it didn't munge submaps the
9845 last time we called it, since key was unbound. */
9847 = (follow_key (new_click
,
9848 nmaps
- local_first_binding
,
9849 submaps
+ local_first_binding
,
9850 defs
+ local_first_binding
,
9851 submaps
+ local_first_binding
)
9852 + local_first_binding
);
9854 /* If that click is bound, go for it. */
9855 if (first_binding
< nmaps
)
9860 /* Otherwise, we'll leave key set to the drag event. */
9867 /* Normally, last_nonmenu_event gets the previous key we read.
9868 But when a mouse popup menu is being used,
9869 we don't update last_nonmenu_event; it continues to hold the mouse
9870 event that preceded the first level of menu. */
9871 if (!used_mouse_menu
)
9872 last_nonmenu_event
= key
;
9874 /* Record what part of this_command_keys is the current key sequence. */
9875 this_single_command_key_start
= this_command_key_count
- t
;
9877 /* Look for this sequence in input-decode-map.
9878 Scan from indec.end until we find a bound suffix. */
9879 while (indec
.end
< t
)
9881 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9884 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9885 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9890 mock_input
= diff
+ max (t
, mock_input
);
9891 goto replay_sequence
;
9895 if (first_binding
< nmaps
9896 && NILP (submaps
[first_binding
])
9897 && !test_undefined (defs
[first_binding
])
9898 && indec
.start
>= t
)
9899 /* There is a binding and it's not a prefix.
9900 (and it doesn't have any input-decode-map translation pending).
9901 There is thus no function-key in this sequence.
9902 Moving fkey.start is important in this case to allow keytran.start
9903 to go over the sequence before we return (since we keep the
9904 invariant that keytran.end <= fkey.start). */
9907 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9910 /* If the sequence is unbound, see if we can hang a function key
9911 off the end of it. */
9912 /* Continue scan from fkey.end until we find a bound suffix. */
9913 while (fkey
.end
< indec
.start
)
9915 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9918 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9919 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9920 max (t
, mock_input
),
9921 /* If there's a binding (i.e.
9922 first_binding >= nmaps) we don't want
9923 to apply this function-key-mapping. */
9925 && (first_binding
>= nmaps
9926 || test_undefined (defs
[first_binding
])),
9931 mock_input
= diff
+ max (t
, mock_input
);
9932 /* Adjust the input-decode-map counters. */
9934 indec
.start
+= diff
;
9936 goto replay_sequence
;
9940 /* Look for this sequence in key-translation-map.
9941 Scan from keytran.end until we find a bound suffix. */
9942 while (keytran
.end
< fkey
.start
)
9944 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9947 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9948 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9953 mock_input
= diff
+ max (t
, mock_input
);
9954 /* Adjust the function-key-map and input-decode-map counters. */
9956 indec
.start
+= diff
;
9960 goto replay_sequence
;
9964 /* If KEY is not defined in any of the keymaps,
9965 and cannot be part of a function key or translation,
9966 and is an upper case letter
9967 use the corresponding lower-case letter instead. */
9968 if (first_binding
>= nmaps
9969 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9971 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9972 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9973 || (XINT (key
) & shift_modifier
)))
9975 Lisp_Object new_key
;
9977 original_uppercase
= key
;
9978 original_uppercase_position
= t
- 1;
9980 if (XINT (key
) & shift_modifier
)
9981 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9983 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9984 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9986 /* We have to do this unconditionally, regardless of whether
9987 the lower-case char is defined in the keymaps, because they
9988 might get translated through function-key-map. */
9989 keybuf
[t
- 1] = new_key
;
9990 mock_input
= max (t
, mock_input
);
9991 shift_translated
= 1;
9993 goto replay_sequence
;
9995 /* If KEY is not defined in any of the keymaps,
9996 and cannot be part of a function key or translation,
9997 and is a shifted function key,
9998 use the corresponding unshifted function key instead. */
9999 if (first_binding
>= nmaps
10000 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10002 Lisp_Object breakdown
= parse_modifiers (key
);
10004 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10006 if (modifiers
& shift_modifier
10007 /* Treat uppercase keys as shifted. */
10009 && (KEY_TO_CHAR (key
)
10010 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10011 && uppercasep (KEY_TO_CHAR (key
))))
10013 Lisp_Object new_key
10014 = (modifiers
& shift_modifier
10015 ? apply_modifiers (modifiers
& ~shift_modifier
,
10017 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10019 original_uppercase
= key
;
10020 original_uppercase_position
= t
- 1;
10022 /* We have to do this unconditionally, regardless of whether
10023 the lower-case char is defined in the keymaps, because they
10024 might get translated through function-key-map. */
10025 keybuf
[t
- 1] = new_key
;
10026 mock_input
= max (t
, mock_input
);
10027 /* Reset fkey (and consequently keytran) to apply
10028 function-key-map on the result, so that S-backspace is
10029 correctly mapped to DEL (via backspace). OTOH,
10030 input-decode-map doesn't need to go through it again. */
10031 fkey
.start
= fkey
.end
= 0;
10032 keytran
.start
= keytran
.end
= 0;
10033 shift_translated
= 1;
10035 goto replay_sequence
;
10040 read_key_sequence_cmd
= (first_binding
< nmaps
10041 ? defs
[first_binding
]
10043 read_key_sequence_remapped
10044 /* Remap command through active keymaps.
10045 Do the remapping here, before the unbind_to so it uses the keymaps
10046 of the appropriate buffer. */
10047 = SYMBOLP (read_key_sequence_cmd
)
10048 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10051 unread_switch_frame
= delayed_switch_frame
;
10052 unbind_to (count
, Qnil
);
10054 /* Don't downcase the last character if the caller says don't.
10055 Don't downcase it if the result is undefined, either. */
10056 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10058 && t
- 1 == original_uppercase_position
)
10060 keybuf
[t
- 1] = original_uppercase
;
10061 shift_translated
= 0;
10064 if (shift_translated
)
10065 Vthis_command_keys_shift_translated
= Qt
;
10067 /* Occasionally we fabricate events, perhaps by expanding something
10068 according to function-key-map, or by adding a prefix symbol to a
10069 mouse click in the scroll bar or modeline. In this cases, return
10070 the entire generated key sequence, even if we hit an unbound
10071 prefix or a definition before the end. This means that you will
10072 be able to push back the event properly, and also means that
10073 read-key-sequence will always return a logical unit.
10076 for (; t
< mock_input
; t
++)
10078 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10079 && NILP (Fzerop (Vecho_keystrokes
)))
10080 echo_char (keybuf
[t
]);
10081 add_command_key (keybuf
[t
]);
10088 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10089 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10090 The sequence is sufficient to specify a non-prefix command in the
10091 current local and global maps.
10093 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10094 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10095 as a continuation of the previous key.
10097 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10098 convert the last event to lower case. (Normally any upper case event
10099 is converted to lower case if the original event is undefined and the lower
10100 case equivalent is defined.) A non-nil value is appropriate for reading
10101 a key sequence to be defined.
10103 A C-g typed while in this function is treated like any other character,
10104 and `quit-flag' is not set.
10106 If the key sequence starts with a mouse click, then the sequence is read
10107 using the keymaps of the buffer of the window clicked in, not the buffer
10108 of the selected window as normal.
10110 `read-key-sequence' drops unbound button-down events, since you normally
10111 only care about the click or drag events which follow them. If a drag
10112 or multi-click event is unbound, but the corresponding click event would
10113 be bound, `read-key-sequence' turns the event into a click event at the
10114 drag's starting position. This means that you don't have to distinguish
10115 between click and drag, double, or triple events unless you want to.
10117 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10118 lines separating windows, and scroll bars with imaginary keys
10119 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10121 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10122 function will process a switch-frame event if the user switches frames
10123 before typing anything. If the user switches frames in the middle of a
10124 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10125 is nil, then the event will be put off until after the current key sequence.
10127 `read-key-sequence' checks `function-key-map' for function key
10128 sequences, where they wouldn't conflict with ordinary bindings. See
10129 `function-key-map' for more details.
10131 The optional fifth argument CMD-LOOP, if non-nil, means
10132 that this key sequence is being read by something that will
10133 read commands one after another. It should be nil if the caller
10134 will read just one key sequence. */)
10135 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10137 Lisp_Object keybuf
[30];
10139 struct gcpro gcpro1
;
10140 ptrdiff_t count
= SPECPDL_INDEX ();
10142 if (!NILP (prompt
))
10143 CHECK_STRING (prompt
);
10146 specbind (Qinput_method_exit_on_first_char
,
10147 (NILP (cmd_loop
) ? Qt
: Qnil
));
10148 specbind (Qinput_method_use_echo_area
,
10149 (NILP (cmd_loop
) ? Qt
: Qnil
));
10151 memset (keybuf
, 0, sizeof keybuf
);
10152 GCPRO1 (keybuf
[0]);
10153 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10155 if (NILP (continue_echo
))
10157 this_command_key_count
= 0;
10158 this_command_key_count_reset
= 0;
10159 this_single_command_key_start
= 0;
10162 #ifdef HAVE_WINDOW_SYSTEM
10163 if (display_hourglass_p
)
10164 cancel_hourglass ();
10167 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10168 prompt
, ! NILP (dont_downcase_last
),
10169 ! NILP (can_return_switch_frame
), 0);
10171 #if 0 /* The following is fine for code reading a key sequence and
10172 then proceeding with a lengthy computation, but it's not good
10173 for code reading keys in a loop, like an input method. */
10174 #ifdef HAVE_WINDOW_SYSTEM
10175 if (display_hourglass_p
)
10176 start_hourglass ();
10186 return unbind_to (count
, make_event_array (i
, keybuf
));
10189 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10190 Sread_key_sequence_vector
, 1, 5, 0,
10191 doc
: /* Like `read-key-sequence' but always return a vector. */)
10192 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10194 Lisp_Object keybuf
[30];
10196 struct gcpro gcpro1
;
10197 ptrdiff_t count
= SPECPDL_INDEX ();
10199 if (!NILP (prompt
))
10200 CHECK_STRING (prompt
);
10203 specbind (Qinput_method_exit_on_first_char
,
10204 (NILP (cmd_loop
) ? Qt
: Qnil
));
10205 specbind (Qinput_method_use_echo_area
,
10206 (NILP (cmd_loop
) ? Qt
: Qnil
));
10208 memset (keybuf
, 0, sizeof keybuf
);
10209 GCPRO1 (keybuf
[0]);
10210 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10212 if (NILP (continue_echo
))
10214 this_command_key_count
= 0;
10215 this_command_key_count_reset
= 0;
10216 this_single_command_key_start
= 0;
10219 #ifdef HAVE_WINDOW_SYSTEM
10220 if (display_hourglass_p
)
10221 cancel_hourglass ();
10224 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10225 prompt
, ! NILP (dont_downcase_last
),
10226 ! NILP (can_return_switch_frame
), 0);
10228 #ifdef HAVE_WINDOW_SYSTEM
10229 if (display_hourglass_p
)
10230 start_hourglass ();
10239 return unbind_to (count
, Fvector (i
, keybuf
));
10242 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10243 doc
: /* Execute CMD as an editor command.
10244 CMD must be a symbol that satisfies the `commandp' predicate.
10245 Optional second arg RECORD-FLAG non-nil
10246 means unconditionally put this command in `command-history'.
10247 Otherwise, that is done only if an arg is read using the minibuffer.
10248 The argument KEYS specifies the value to use instead of (this-command-keys)
10249 when reading the arguments; if it is nil, (this-command-keys) is used.
10250 The argument SPECIAL, if non-nil, means that this command is executing
10251 a special event, so ignore the prefix argument and don't clear it. */)
10252 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10254 register Lisp_Object final
;
10255 register Lisp_Object tem
;
10256 Lisp_Object prefixarg
;
10258 debug_on_next_call
= 0;
10260 if (NILP (special
))
10262 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10263 Vcurrent_prefix_arg
= prefixarg
;
10264 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10271 tem
= Fget (cmd
, Qdisabled
);
10274 tem
= Fsymbol_value (Qdisabled_command_function
);
10276 return Frun_hooks (1, &Qdisabled_command_function
);
10282 final
= Findirect_function (cmd
, Qnil
);
10284 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10286 struct gcpro gcpro1
, gcpro2
;
10288 GCPRO2 (cmd
, prefixarg
);
10289 do_autoload (final
, cmd
);
10296 if (STRINGP (final
) || VECTORP (final
))
10298 /* If requested, place the macro in the command history. For
10299 other sorts of commands, call-interactively takes care of
10301 if (!NILP (record_flag
))
10304 = Fcons (Fcons (Qexecute_kbd_macro
,
10305 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10308 /* Don't keep command history around forever. */
10309 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10311 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10313 XSETCDR (tem
, Qnil
);
10317 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10320 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10321 /* Don't call Fcall_interactively directly because we want to make
10322 sure the backtrace has an entry for `call-interactively'.
10323 For the same reason, pass `cmd' rather than `final'. */
10324 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10331 /* Return nonzero if input events are pending. */
10334 detect_input_pending (void)
10336 if (!input_pending
)
10337 get_input_pending (&input_pending
, 0);
10339 return input_pending
;
10342 /* Return nonzero if input events other than mouse movements are
10346 detect_input_pending_ignore_squeezables (void)
10348 if (!input_pending
)
10349 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10351 return input_pending
;
10354 /* Return nonzero if input events are pending, and run any pending timers. */
10357 detect_input_pending_run_timers (int do_display
)
10359 int old_timers_run
= timers_run
;
10361 if (!input_pending
)
10362 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10364 if (old_timers_run
!= timers_run
&& do_display
)
10366 redisplay_preserve_echo_area (8);
10367 /* The following fixes a bug when using lazy-lock with
10368 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10369 from an idle timer function. The symptom of the bug is that
10370 the cursor sometimes doesn't become visible until the next X
10371 event is processed. --gerd. */
10373 Lisp_Object tail
, frame
;
10374 FOR_EACH_FRAME (tail
, frame
)
10375 if (FRAME_RIF (XFRAME (frame
)))
10376 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10380 return input_pending
;
10383 /* This is called in some cases before a possible quit.
10384 It cases the next call to detect_input_pending to recompute input_pending.
10385 So calling this function unnecessarily can't do any harm. */
10388 clear_input_pending (void)
10393 /* Return nonzero if there are pending requeued events.
10394 This isn't used yet. The hope is to make wait_reading_process_output
10395 call it, and return if it runs Lisp code that unreads something.
10396 The problem is, kbd_buffer_get_event needs to be fixed to know what
10397 to do in that case. It isn't trivial. */
10400 requeued_events_pending_p (void)
10402 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10406 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10407 doc
: /* Return t if command input is currently available with no wait.
10408 Actually, the value is nil only if we can be sure that no input is available;
10409 if there is a doubt, the value is t. */)
10412 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10413 || !NILP (Vunread_post_input_method_events
)
10414 || !NILP (Vunread_input_method_events
))
10417 /* Process non-user-visible events (Bug#10195). */
10418 process_special_events ();
10420 get_input_pending (&input_pending
,
10421 READABLE_EVENTS_DO_TIMERS_NOW
10422 | READABLE_EVENTS_FILTER_EVENTS
);
10423 return input_pending
> 0 ? Qt
: Qnil
;
10426 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10427 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10430 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10433 if (total_keys
< NUM_RECENT_KEYS
)
10434 return Fvector (total_keys
, keys
);
10437 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10438 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10439 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10440 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10441 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10446 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10447 doc
: /* Return the key sequence that invoked this command.
10448 However, if the command has called `read-key-sequence', it returns
10449 the last key sequence that has been read.
10450 The value is a string or a vector.
10452 See also `this-command-keys-vector'. */)
10455 return make_event_array (this_command_key_count
,
10456 XVECTOR (this_command_keys
)->contents
);
10459 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10460 doc
: /* Return the key sequence that invoked this command, as a vector.
10461 However, if the command has called `read-key-sequence', it returns
10462 the last key sequence that has been read.
10464 See also `this-command-keys'. */)
10467 return Fvector (this_command_key_count
,
10468 XVECTOR (this_command_keys
)->contents
);
10471 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10472 Sthis_single_command_keys
, 0, 0, 0,
10473 doc
: /* Return the key sequence that invoked this command.
10474 More generally, it returns the last key sequence read, either by
10475 the command loop or by `read-key-sequence'.
10476 Unlike `this-command-keys', this function's value
10477 does not include prefix arguments.
10478 The value is always a vector. */)
10481 return Fvector (this_command_key_count
10482 - this_single_command_key_start
,
10483 (XVECTOR (this_command_keys
)->contents
10484 + this_single_command_key_start
));
10487 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10488 Sthis_single_command_raw_keys
, 0, 0, 0,
10489 doc
: /* Return the raw events that were read for this command.
10490 More generally, it returns the last key sequence read, either by
10491 the command loop or by `read-key-sequence'.
10492 Unlike `this-single-command-keys', this function's value
10493 shows the events before all translations (except for input methods).
10494 The value is always a vector. */)
10497 return Fvector (raw_keybuf_count
,
10498 (XVECTOR (raw_keybuf
)->contents
));
10501 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10502 Sreset_this_command_lengths
, 0, 0, 0,
10503 doc
: /* Make the unread events replace the last command and echo.
10504 Used in `universal-argument-other-key'.
10506 `universal-argument-other-key' rereads the event just typed.
10507 It then gets translated through `function-key-map'.
10508 The translated event has to replace the real events,
10509 both in the value of (this-command-keys) and in echoing.
10510 To achieve this, `universal-argument-other-key' calls
10511 `reset-this-command-lengths', which discards the record of reading
10512 these events the first time. */)
10515 this_command_key_count
= before_command_key_count
;
10516 if (this_command_key_count
< this_single_command_key_start
)
10517 this_single_command_key_start
= this_command_key_count
;
10519 echo_truncate (before_command_echo_length
);
10521 /* Cause whatever we put into unread-command-events
10522 to echo as if it were being freshly read from the keyboard. */
10523 this_command_key_count_reset
= 1;
10528 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10529 Sclear_this_command_keys
, 0, 1, 0,
10530 doc
: /* Clear out the vector that `this-command-keys' returns.
10531 Also clear the record of the last 100 events, unless optional arg
10532 KEEP-RECORD is non-nil. */)
10533 (Lisp_Object keep_record
)
10537 this_command_key_count
= 0;
10538 this_command_key_count_reset
= 0;
10540 if (NILP (keep_record
))
10542 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10543 ASET (recent_keys
, i
, Qnil
);
10545 recent_keys_index
= 0;
10550 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10551 doc
: /* Return the current depth in recursive edits. */)
10555 /* Wrap around reliably on integer overflow. */
10556 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10557 XSETINT (temp
, sum
);
10561 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10562 "FOpen dribble file: ",
10563 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10564 If FILE is nil, close any open dribble file.
10565 The file will be closed when Emacs exits. */)
10577 file
= Fexpand_file_name (file
, Qnil
);
10578 dribble
= fopen (SSDATA (file
), "w");
10580 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10585 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10586 doc
: /* Discard the contents of the terminal input buffer.
10587 Also end any kbd macro being defined. */)
10590 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10592 /* Discard the last command from the macro. */
10593 Fcancel_kbd_macro_events ();
10597 update_mode_lines
++;
10599 Vunread_command_events
= Qnil
;
10600 unread_command_char
= -1;
10602 discard_tty_input ();
10604 kbd_fetch_ptr
= kbd_store_ptr
;
10610 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10611 doc
: /* Stop Emacs and return to superior process. You can resume later.
10612 If `cannot-suspend' is non-nil, or if the system doesn't support job
10613 control, run a subshell instead.
10615 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10616 to be read as terminal input by Emacs's parent, after suspension.
10618 Before suspending, run the normal hook `suspend-hook'.
10619 After resumption run the normal hook `suspend-resume-hook'.
10621 Some operating systems cannot stop the Emacs process and resume it later.
10622 On such systems, Emacs starts a subshell instead of suspending. */)
10623 (Lisp_Object stuffstring
)
10625 ptrdiff_t count
= SPECPDL_INDEX ();
10626 int old_height
, old_width
;
10628 struct gcpro gcpro1
;
10631 if (tty_list
&& tty_list
->next
)
10632 error ("There are other tty frames open; close them before suspending Emacs");
10634 if (!NILP (stuffstring
))
10635 CHECK_STRING (stuffstring
);
10637 /* Run the functions in suspend-hook. */
10638 hook
= intern ("suspend-hook");
10639 Frun_hooks (1, &hook
);
10641 GCPRO1 (stuffstring
);
10642 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10643 reset_all_sys_modes ();
10644 /* sys_suspend can get an error if it tries to fork a subshell
10645 and the system resources aren't available for that. */
10646 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10648 stuff_buffered_input (stuffstring
);
10649 if (cannot_suspend
)
10653 unbind_to (count
, Qnil
);
10655 /* Check if terminal/window size has changed.
10656 Note that this is not useful when we are running directly
10657 with a window system; but suspend should be disabled in that case. */
10658 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10659 if (width
!= old_width
|| height
!= old_height
)
10660 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10662 /* Run suspend-resume-hook. */
10663 hook
= intern ("suspend-resume-hook");
10664 Frun_hooks (1, &hook
);
10670 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10671 Then in any case stuff anything Emacs has read ahead and not used. */
10674 stuff_buffered_input (Lisp_Object stuffstring
)
10676 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10677 register unsigned char *p
;
10679 if (STRINGP (stuffstring
))
10681 register ptrdiff_t count
;
10683 p
= SDATA (stuffstring
);
10684 count
= SBYTES (stuffstring
);
10685 while (count
-- > 0)
10690 /* Anything we have read ahead, put back for the shell to read. */
10691 /* ?? What should this do when we have multiple keyboards??
10692 Should we ignore anything that was typed in at the "wrong" kboard?
10694 rms: we should stuff everything back into the kboard
10696 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10699 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10700 kbd_fetch_ptr
= kbd_buffer
;
10701 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10702 stuff_char (kbd_fetch_ptr
->code
);
10704 clear_event (kbd_fetch_ptr
);
10708 #endif /* SIGTSTP */
10712 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10714 input_available_clear_time
= time_to_clear
;
10716 /* Tell handle_interrupt to throw back to read_char, */
10717 waiting_for_input
= 1;
10719 /* If handle_interrupt was called before and buffered a C-g,
10720 make it run again now, to avoid timing error. */
10721 if (!NILP (Vquit_flag
))
10722 quit_throw_to_read_char (0);
10726 clear_waiting_for_input (void)
10728 /* Tell handle_interrupt not to throw back to read_char, */
10729 waiting_for_input
= 0;
10730 input_available_clear_time
= 0;
10733 /* The SIGINT handler.
10735 If we have a frame on the controlling tty, we assume that the
10736 SIGINT was generated by C-g, so we call handle_interrupt.
10737 Otherwise, tell QUIT to kill Emacs. */
10740 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10741 /* compilers complain in signal calls. */
10743 /* Must preserve main program's value of errno. */
10744 int old_errno
= errno
;
10745 struct terminal
*terminal
;
10747 SIGNAL_THREAD_CHECK (signalnum
);
10749 /* See if we have an active terminal on our controlling tty. */
10750 terminal
= get_named_tty ("/dev/tty");
10753 /* If there are no frames there, let's pretend that we are a
10754 well-behaving UN*X program and quit. We must not call Lisp
10755 in a signal handler, so tell QUIT to exit when it is
10757 Vquit_flag
= Qkill_emacs
;
10761 /* Otherwise, the SIGINT was probably generated by C-g. */
10763 /* Set internal_last_event_frame to the top frame of the
10764 controlling tty, if we have a frame there. We disable the
10765 interrupt key on secondary ttys, so the SIGINT must have come
10766 from the controlling tty. */
10767 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10769 handle_interrupt ();
10775 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10776 of the number of times C-g has been requested. If C-g is pressed
10777 enough times, then quit anyway. See bug#6585. */
10778 static int force_quit_count
;
10780 /* This routine is called at interrupt level in response to C-g.
10782 It is called from the SIGINT handler or kbd_buffer_store_event.
10784 If `waiting_for_input' is non zero, then unless `echoing' is
10785 nonzero, immediately throw back to read_char.
10787 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10788 eval to throw, when it gets a chance. If quit-flag is already
10789 non-nil, it stops the job right away. */
10792 handle_interrupt (void)
10798 /* XXX This code needs to be revised for multi-tty support. */
10799 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10801 /* If SIGINT isn't blocked, don't let us be interrupted by
10802 another SIGINT, it might be harmful due to non-reentrancy
10803 in I/O functions. */
10804 sigblock (sigmask (SIGINT
));
10807 reset_all_sys_modes ();
10809 #ifdef SIGTSTP /* Support possible in later USG versions */
10811 * On systems which can suspend the current process and return to the original
10812 * shell, this command causes the user to end up back at the shell.
10813 * The "Auto-save" and "Abort" questions are not asked until
10814 * the user elects to return to emacs, at which point he can save the current
10815 * job and either dump core or continue.
10819 /* Perhaps should really fork an inferior shell?
10820 But that would not provide any way to get back
10821 to the original shell, ever. */
10822 printf ("No support for stopping a process on this operating system;\n");
10823 printf ("you can continue or abort.\n");
10824 #endif /* not SIGTSTP */
10826 /* We must remain inside the screen area when the internal terminal
10827 is used. Note that [Enter] is not echoed by dos. */
10828 cursor_to (SELECTED_FRAME (), 0, 0);
10830 /* It doesn't work to autosave while GC is in progress;
10831 the code used for auto-saving doesn't cope with the mark bit. */
10832 if (!gc_in_progress
)
10834 printf ("Auto-save? (y or n) ");
10836 if (((c
= getchar ()) & ~040) == 'Y')
10838 Fdo_auto_save (Qt
, Qnil
);
10840 printf ("\r\nAuto-save done");
10841 #else /* not MSDOS */
10842 printf ("Auto-save done\n");
10843 #endif /* not MSDOS */
10845 while (c
!= '\n') c
= getchar ();
10849 /* During GC, it must be safe to reenable quitting again. */
10850 Vinhibit_quit
= Qnil
;
10853 #endif /* not MSDOS */
10854 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10855 printf ("but will instead do a real quit after garbage collection ends\r\n");
10860 printf ("\r\nAbort? (y or n) ");
10861 #else /* not MSDOS */
10862 printf ("Abort (and dump core)? (y or n) ");
10863 #endif /* not MSDOS */
10865 if (((c
= getchar ()) & ~040) == 'Y')
10867 while (c
!= '\n') c
= getchar ();
10869 printf ("\r\nContinuing...\r\n");
10870 #else /* not MSDOS */
10871 printf ("Continuing...\n");
10872 #endif /* not MSDOS */
10874 init_all_sys_modes ();
10879 /* If executing a function that wants to be interrupted out of
10880 and the user has not deferred quitting by binding `inhibit-quit'
10881 then quit right away. */
10882 if (immediate_quit
&& NILP (Vinhibit_quit
))
10884 struct gl_state_s saved
;
10885 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10887 immediate_quit
= 0;
10890 GCPRO4 (saved
.object
, saved
.global_code
,
10891 saved
.current_syntax_table
, saved
.old_prop
);
10892 Fsignal (Qquit
, Qnil
);
10893 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10898 { /* Else request quit when it's safe. */
10899 if (NILP (Vquit_flag
))
10900 force_quit_count
= 0;
10901 if (++force_quit_count
== 3)
10903 immediate_quit
= 1;
10904 Vinhibit_quit
= Qnil
;
10910 /* TODO: The longjmp in this call throws the NS event loop integration off,
10911 and it seems to do fine without this. Probably some attention
10912 needs to be paid to the setting of waiting_for_input in
10913 wait_reading_process_output() under HAVE_NS because of the call
10914 to ns_select there (needed because otherwise events aren't picked up
10915 outside of polling since we don't get SIGIO like X and we don't have a
10916 separate event loop thread like W32. */
10918 if (waiting_for_input
&& !echoing
)
10919 quit_throw_to_read_char (1);
10923 /* Handle a C-g by making read_char return C-g. */
10926 quit_throw_to_read_char (int from_signal
)
10928 /* When not called from a signal handler it is safe to call
10930 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10931 Fkill_emacs (Qnil
);
10934 /* Prevent another signal from doing this before we finish. */
10935 clear_waiting_for_input ();
10938 Vunread_command_events
= Qnil
;
10939 unread_command_char
= -1;
10941 #if 0 /* Currently, sit_for is called from read_char without turning
10942 off polling. And that can call set_waiting_for_input.
10943 It seems to be harmless. */
10944 #ifdef POLL_FOR_INPUT
10945 /* May be > 1 if in recursive minibuffer. */
10946 if (poll_suppress_count
== 0)
10950 if (FRAMEP (internal_last_event_frame
)
10951 && !EQ (internal_last_event_frame
, selected_frame
))
10952 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10955 _longjmp (getcjmp
, 1);
10958 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10959 Sset_input_interrupt_mode
, 1, 1, 0,
10960 doc
: /* Set interrupt mode of reading keyboard input.
10961 If INTERRUPT is non-nil, Emacs will use input interrupts;
10962 otherwise Emacs uses CBREAK mode.
10964 See also `current-input-mode'. */)
10965 (Lisp_Object interrupt
)
10967 int new_interrupt_input
;
10969 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10970 #ifdef HAVE_X_WINDOWS
10971 if (x_display_list
!= NULL
)
10973 /* When using X, don't give the user a real choice,
10974 because we haven't implemented the mechanisms to support it. */
10975 new_interrupt_input
= 1;
10978 #endif /* HAVE_X_WINDOWS */
10979 new_interrupt_input
= !NILP (interrupt
);
10980 #else /* not SIGIO */
10981 new_interrupt_input
= 0;
10982 #endif /* not SIGIO */
10984 if (new_interrupt_input
!= interrupt_input
)
10986 #ifdef POLL_FOR_INPUT
10990 /* this causes startup screen to be restored and messes with the mouse */
10991 reset_all_sys_modes ();
10992 interrupt_input
= new_interrupt_input
;
10993 init_all_sys_modes ();
10995 interrupt_input
= new_interrupt_input
;
10998 #ifdef POLL_FOR_INPUT
10999 poll_suppress_count
= 1;
11006 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11007 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11008 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11009 C-q in key sequences.
11011 This setting only has an effect on tty terminals and only when
11012 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11014 See also `current-input-mode'. */)
11015 (Lisp_Object flow
, Lisp_Object terminal
)
11017 struct terminal
*t
= get_terminal (terminal
, 1);
11018 struct tty_display_info
*tty
;
11019 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11021 tty
= t
->display_info
.tty
;
11023 if (tty
->flow_control
!= !NILP (flow
))
11026 /* this causes startup screen to be restored and messes with the mouse */
11027 reset_sys_modes (tty
);
11030 tty
->flow_control
= !NILP (flow
);
11033 init_sys_modes (tty
);
11039 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11040 doc
: /* Enable or disable 8-bit input on TERMINAL.
11041 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11042 bit as the Meta modifier.
11044 If META is nil, Emacs will ignore the top bit, on the assumption it is
11047 Otherwise, Emacs will accept and pass through 8-bit input without
11048 specially interpreting the top bit.
11050 This setting only has an effect on tty terminal devices.
11052 Optional parameter TERMINAL specifies the tty terminal device to use.
11053 It may be a terminal object, a frame, or nil for the terminal used by
11054 the currently selected frame.
11056 See also `current-input-mode'. */)
11057 (Lisp_Object meta
, Lisp_Object terminal
)
11059 struct terminal
*t
= get_terminal (terminal
, 1);
11060 struct tty_display_info
*tty
;
11063 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11065 tty
= t
->display_info
.tty
;
11069 else if (EQ (meta
, Qt
))
11074 if (tty
->meta_key
!= new_meta
)
11077 /* this causes startup screen to be restored and messes with the mouse */
11078 reset_sys_modes (tty
);
11081 tty
->meta_key
= new_meta
;
11084 init_sys_modes (tty
);
11090 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11091 doc
: /* Specify character used for quitting.
11092 QUIT must be an ASCII character.
11094 This function only has an effect on the controlling tty of the Emacs
11097 See also `current-input-mode'. */)
11100 struct terminal
*t
= get_named_tty ("/dev/tty");
11101 struct tty_display_info
*tty
;
11102 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11104 tty
= t
->display_info
.tty
;
11106 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11107 error ("QUIT must be an ASCII character");
11110 /* this causes startup screen to be restored and messes with the mouse */
11111 reset_sys_modes (tty
);
11114 /* Don't let this value be out of range. */
11115 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11118 init_sys_modes (tty
);
11124 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11125 doc
: /* Set mode of reading keyboard input.
11126 First arg INTERRUPT non-nil means use input interrupts;
11127 nil means use CBREAK mode.
11128 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11129 (no effect except in CBREAK mode).
11130 Third arg META t means accept 8-bit input (for a Meta key).
11131 META nil means ignore the top bit, on the assumption it is parity.
11132 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11133 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11134 See also `current-input-mode'. */)
11135 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11137 Fset_input_interrupt_mode (interrupt
);
11138 Fset_output_flow_control (flow
, Qnil
);
11139 Fset_input_meta_mode (meta
, Qnil
);
11141 Fset_quit_char (quit
);
11145 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11146 doc
: /* Return information about the way Emacs currently reads keyboard input.
11147 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11148 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11149 nil, Emacs is using CBREAK mode.
11150 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11151 terminal; this does not apply if Emacs uses interrupt-driven input.
11152 META is t if accepting 8-bit input with 8th bit as Meta flag.
11153 META nil means ignoring the top bit, on the assumption it is parity.
11154 META is neither t nor nil if accepting 8-bit input and using
11155 all 8 bits as the character code.
11156 QUIT is the character Emacs currently uses to quit.
11157 The elements of this list correspond to the arguments of
11158 `set-input-mode'. */)
11161 Lisp_Object val
[4];
11162 struct frame
*sf
= XFRAME (selected_frame
);
11164 val
[0] = interrupt_input
? Qt
: Qnil
;
11165 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11167 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11168 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11170 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11177 XSETFASTINT (val
[3], quit_char
);
11179 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11182 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11183 doc
: /* Return position information for pixel coordinates X and Y.
11184 By default, X and Y are relative to text area of the selected window.
11185 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11186 If optional fourth arg WHOLE is non-nil, X is relative to the left
11187 edge of the window.
11189 The return value is similar to a mouse click position:
11190 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11191 IMAGE (DX . DY) (WIDTH . HEIGHT))
11192 The `posn-' functions access elements of such lists. */)
11193 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11198 if (NILP (frame_or_window
))
11199 frame_or_window
= selected_window
;
11201 if (WINDOWP (frame_or_window
))
11205 CHECK_LIVE_WINDOW (frame_or_window
);
11207 w
= XWINDOW (frame_or_window
);
11208 XSETINT (x
, (XINT (x
)
11209 + WINDOW_LEFT_EDGE_X (w
)
11211 ? window_box_left_offset (w
, TEXT_AREA
)
11213 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11214 frame_or_window
= w
->frame
;
11217 CHECK_LIVE_FRAME (frame_or_window
);
11219 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11222 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11223 doc
: /* Return position information for buffer POS in WINDOW.
11224 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11226 Return nil if position is not visible in window. Otherwise,
11227 the return value is similar to that returned by `event-start' for
11228 a mouse click at the upper left corner of the glyph corresponding
11229 to the given buffer position:
11230 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11231 IMAGE (DX . DY) (WIDTH . HEIGHT))
11232 The `posn-' functions access elements of such lists. */)
11233 (Lisp_Object pos
, Lisp_Object window
)
11238 window
= selected_window
;
11240 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11243 Lisp_Object x
= XCAR (tem
);
11244 Lisp_Object y
= XCAR (XCDR (tem
));
11246 /* Point invisible due to hscrolling? */
11249 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11257 * Set up a new kboard object with reasonable initial values.
11260 init_kboard (KBOARD
*kb
)
11262 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11263 KVAR (kb
, Vlast_command
) = Qnil
;
11264 KVAR (kb
, Vreal_last_command
) = Qnil
;
11265 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11266 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11267 KVAR (kb
, Vprefix_arg
) = Qnil
;
11268 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11269 KVAR (kb
, kbd_queue
) = Qnil
;
11270 kb
->kbd_queue_has_data
= 0;
11271 kb
->immediate_echo
= 0;
11272 KVAR (kb
, echo_string
) = Qnil
;
11273 kb
->echo_after_prompt
= -1;
11274 kb
->kbd_macro_buffer
= 0;
11275 kb
->kbd_macro_bufsize
= 0;
11276 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11277 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11278 kb
->reference_count
= 0;
11279 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11280 KVAR (kb
, system_key_syms
) = Qnil
;
11281 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11282 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11283 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11284 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11285 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11289 * Destroy the contents of a kboard object, but not the object itself.
11290 * We use this just before deleting it, or if we're going to initialize
11291 * it a second time.
11294 wipe_kboard (KBOARD
*kb
)
11296 xfree (kb
->kbd_macro_buffer
);
11299 /* Free KB and memory referenced from it. */
11302 delete_kboard (KBOARD
*kb
)
11306 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11309 *kbp
= kb
->next_kboard
;
11311 /* Prevent a dangling reference to KB. */
11312 if (kb
== current_kboard
11313 && FRAMEP (selected_frame
)
11314 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11316 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11318 if (current_kboard
== kb
)
11327 init_keyboard (void)
11329 /* This is correct before outermost invocation of the editor loop */
11330 command_loop_level
= -1;
11331 immediate_quit
= 0;
11332 quit_char
= Ctl ('g');
11333 Vunread_command_events
= Qnil
;
11334 unread_command_char
= -1;
11335 timer_idleness_start_time
= invalid_emacs_time ();
11337 recent_keys_index
= 0;
11338 kbd_fetch_ptr
= kbd_buffer
;
11339 kbd_store_ptr
= kbd_buffer
;
11340 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11341 do_mouse_tracking
= Qnil
;
11344 interrupt_input_blocked
= 0;
11345 interrupt_input_pending
= 0;
11347 pending_signals
= 0;
11350 /* This means that command_loop_1 won't try to select anything the first
11352 internal_last_event_frame
= Qnil
;
11353 Vlast_event_frame
= internal_last_event_frame
;
11355 current_kboard
= initial_kboard
;
11356 /* Re-initialize the keyboard again. */
11357 wipe_kboard (current_kboard
);
11358 init_kboard (current_kboard
);
11359 /* A value of nil for Vwindow_system normally means a tty, but we also use
11360 it for the initial terminal since there is no window system there. */
11361 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11363 if (!noninteractive
)
11365 /* Before multi-tty support, these handlers used to be installed
11366 only if the current session was a tty session. Now an Emacs
11367 session may have multiple display types, so we always handle
11368 SIGINT. There is special code in interrupt_signal to exit
11369 Emacs on SIGINT when there are no termcap frames on the
11370 controlling terminal. */
11371 signal (SIGINT
, interrupt_signal
);
11373 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11374 SIGQUIT and we can't tell which one it will give us. */
11375 signal (SIGQUIT
, interrupt_signal
);
11376 #endif /* not DOS_NT */
11378 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11380 if (!noninteractive
)
11381 signal (SIGIO
, input_available_signal
);
11384 /* Use interrupt input by default, if it works and noninterrupt input
11385 has deficiencies. */
11387 #ifdef INTERRUPT_INPUT
11388 interrupt_input
= 1;
11390 interrupt_input
= 0;
11396 if (keyboard_init_hook
)
11397 (*keyboard_init_hook
) ();
11399 #ifdef POLL_FOR_INPUT
11401 poll_suppress_count
= 1;
11406 /* This type's only use is in syms_of_keyboard, to initialize the
11407 event header symbols and put properties on them. */
11408 struct event_head
{
11414 static const struct event_head head_table
[] = {
11415 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11416 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11417 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11418 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11419 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11420 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11421 /* `select-window' should be handled just like `switch-frame'
11422 in read_key_sequence. */
11423 {&Qselect_window
, "select-window", &Qswitch_frame
}
11427 syms_of_keyboard (void)
11429 pending_funcalls
= Qnil
;
11430 staticpro (&pending_funcalls
);
11432 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11433 staticpro (&Vlispy_mouse_stem
);
11436 DEFSYM (QCimage
, ":image");
11437 DEFSYM (Qhelp_echo
, "help-echo");
11438 DEFSYM (QCrtl
, ":rtl");
11440 staticpro (&item_properties
);
11441 item_properties
= Qnil
;
11443 staticpro (&tool_bar_item_properties
);
11444 tool_bar_item_properties
= Qnil
;
11445 staticpro (&tool_bar_items_vector
);
11446 tool_bar_items_vector
= Qnil
;
11448 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11449 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11450 DEFSYM (Qself_insert_command
, "self-insert-command");
11451 DEFSYM (Qforward_char
, "forward-char");
11452 DEFSYM (Qbackward_char
, "backward-char");
11453 DEFSYM (Qdisabled
, "disabled");
11454 DEFSYM (Qundefined
, "undefined");
11455 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11456 DEFSYM (Qpost_command_hook
, "post-command-hook");
11457 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11458 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11459 DEFSYM (Qfunction_key
, "function-key");
11460 DEFSYM (Qmouse_click
, "mouse-click");
11461 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11462 DEFSYM (Qsave_session
, "save-session");
11463 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11464 DEFSYM (Qmenu_enable
, "menu-enable");
11466 #if defined (WINDOWSNT)
11467 DEFSYM (Qlanguage_change
, "language-change");
11471 DEFSYM (Qdbus_event
, "dbus-event");
11474 DEFSYM (QCenable
, ":enable");
11475 DEFSYM (QCvisible
, ":visible");
11476 DEFSYM (QChelp
, ":help");
11477 DEFSYM (QCfilter
, ":filter");
11478 DEFSYM (QCbutton
, ":button");
11479 DEFSYM (QCkeys
, ":keys");
11480 DEFSYM (QCkey_sequence
, ":key-sequence");
11481 DEFSYM (QCtoggle
, ":toggle");
11482 DEFSYM (QCradio
, ":radio");
11483 DEFSYM (QClabel
, ":label");
11484 DEFSYM (QCvert_only
, ":vert-only");
11486 DEFSYM (Qmode_line
, "mode-line");
11487 DEFSYM (Qvertical_line
, "vertical-line");
11488 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11489 DEFSYM (Qmenu_bar
, "menu-bar");
11491 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11492 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11495 DEFSYM (Qabove_handle
, "above-handle");
11496 DEFSYM (Qhandle
, "handle");
11497 DEFSYM (Qbelow_handle
, "below-handle");
11498 DEFSYM (Qup
, "up");
11499 DEFSYM (Qdown
, "down");
11500 DEFSYM (Qtop
, "top");
11501 DEFSYM (Qbottom
, "bottom");
11502 DEFSYM (Qend_scroll
, "end-scroll");
11503 DEFSYM (Qratio
, "ratio");
11505 DEFSYM (Qevent_kind
, "event-kind");
11506 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11507 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11508 DEFSYM (Qmodifier_cache
, "modifier-cache");
11510 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11511 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11513 DEFSYM (Qpolling_period
, "polling-period");
11515 DEFSYM (Qx_set_selection
, "x-set-selection");
11516 DEFSYM (QPRIMARY
, "PRIMARY");
11517 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11518 DEFSYM (Qhandle_select_window
, "handle-select-window");
11520 DEFSYM (Qinput_method_function
, "input-method-function");
11521 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11522 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11524 DEFSYM (Qhelp_form_show
, "help-form-show");
11526 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11527 Fset (Qinput_method_use_echo_area
, Qnil
);
11529 last_point_position_buffer
= Qnil
;
11530 last_point_position_window
= Qnil
;
11534 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11536 for (i
= 0; i
< len
; i
++)
11538 const struct event_head
*p
= &head_table
[i
];
11539 *p
->var
= intern_c_string (p
->name
);
11540 staticpro (p
->var
);
11541 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11542 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11546 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11547 staticpro (&button_down_location
);
11548 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11549 staticpro (&mouse_syms
);
11550 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11551 / sizeof (lispy_wheel_names
[0])),
11553 staticpro (&wheel_syms
);
11557 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11559 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11560 for (i
= 0; i
< len
; i
++)
11561 if (modifier_names
[i
])
11562 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11563 staticpro (&modifier_symbols
);
11566 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11567 staticpro (&recent_keys
);
11569 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11570 staticpro (&this_command_keys
);
11572 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11573 staticpro (&raw_keybuf
);
11575 DEFSYM (Qextended_command_history
, "extended-command-history");
11576 Fset (Qextended_command_history
, Qnil
);
11578 accent_key_syms
= Qnil
;
11579 staticpro (&accent_key_syms
);
11581 func_key_syms
= Qnil
;
11582 staticpro (&func_key_syms
);
11584 drag_n_drop_syms
= Qnil
;
11585 staticpro (&drag_n_drop_syms
);
11587 unread_switch_frame
= Qnil
;
11588 staticpro (&unread_switch_frame
);
11590 internal_last_event_frame
= Qnil
;
11591 staticpro (&internal_last_event_frame
);
11593 read_key_sequence_cmd
= Qnil
;
11594 staticpro (&read_key_sequence_cmd
);
11595 read_key_sequence_remapped
= Qnil
;
11596 staticpro (&read_key_sequence_remapped
);
11598 menu_bar_one_keymap_changed_items
= Qnil
;
11599 staticpro (&menu_bar_one_keymap_changed_items
);
11601 menu_bar_items_vector
= Qnil
;
11602 staticpro (&menu_bar_items_vector
);
11604 help_form_saved_window_configs
= Qnil
;
11605 staticpro (&help_form_saved_window_configs
);
11607 defsubr (&Scurrent_idle_time
);
11608 defsubr (&Sevent_symbol_parse_modifiers
);
11609 defsubr (&Sevent_convert_list
);
11610 defsubr (&Sread_key_sequence
);
11611 defsubr (&Sread_key_sequence_vector
);
11612 defsubr (&Srecursive_edit
);
11613 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11614 defsubr (&Strack_mouse
);
11616 defsubr (&Sinput_pending_p
);
11617 defsubr (&Scommand_execute
);
11618 defsubr (&Srecent_keys
);
11619 defsubr (&Sthis_command_keys
);
11620 defsubr (&Sthis_command_keys_vector
);
11621 defsubr (&Sthis_single_command_keys
);
11622 defsubr (&Sthis_single_command_raw_keys
);
11623 defsubr (&Sreset_this_command_lengths
);
11624 defsubr (&Sclear_this_command_keys
);
11625 defsubr (&Ssuspend_emacs
);
11626 defsubr (&Sabort_recursive_edit
);
11627 defsubr (&Sexit_recursive_edit
);
11628 defsubr (&Srecursion_depth
);
11629 defsubr (&Stop_level
);
11630 defsubr (&Sdiscard_input
);
11631 defsubr (&Sopen_dribble_file
);
11632 defsubr (&Sset_input_interrupt_mode
);
11633 defsubr (&Sset_output_flow_control
);
11634 defsubr (&Sset_input_meta_mode
);
11635 defsubr (&Sset_quit_char
);
11636 defsubr (&Sset_input_mode
);
11637 defsubr (&Scurrent_input_mode
);
11638 defsubr (&Sposn_at_point
);
11639 defsubr (&Sposn_at_x_y
);
11641 DEFVAR_LISP ("last-command-event", last_command_event
,
11642 doc
: /* Last input event that was part of a command. */);
11644 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11645 doc
: /* Last input event in a command, except for mouse menu events.
11646 Mouse menus give back keys that don't look like mouse events;
11647 this variable holds the actual mouse event that led to the menu,
11648 so that you can determine whether the command was run by mouse or not. */);
11650 DEFVAR_LISP ("last-input-event", last_input_event
,
11651 doc
: /* Last input event. */);
11653 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11654 doc
: /* List of events to be read as the command input.
11655 These events are processed first, before actual keyboard input.
11656 Events read from this list are not normally added to `this-command-keys',
11657 as they will already have been added once as they were read for the first time.
11658 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11659 Vunread_command_events
= Qnil
;
11661 DEFVAR_INT ("unread-command-char", unread_command_char
,
11662 doc
: /* If not -1, an object to be read as next command input event. */);
11664 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11665 doc
: /* List of events to be processed as input by input methods.
11666 These events are processed before `unread-command-events'
11667 and actual keyboard input, but are not given to `input-method-function'. */);
11668 Vunread_post_input_method_events
= Qnil
;
11670 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11671 doc
: /* List of events to be processed as input by input methods.
11672 These events are processed after `unread-command-events', but
11673 before actual keyboard input.
11674 If there's an active input method, the events are given to
11675 `input-method-function'. */);
11676 Vunread_input_method_events
= Qnil
;
11678 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11679 doc
: /* Meta-prefix character code.
11680 Meta-foo as command input turns into this character followed by foo. */);
11681 XSETINT (meta_prefix_char
, 033);
11683 DEFVAR_KBOARD ("last-command", Vlast_command
,
11684 doc
: /* The last command executed.
11685 Normally a symbol with a function definition, but can be whatever was found
11686 in the keymap, or whatever the variable `this-command' was set to by that
11689 The value `mode-exit' is special; it means that the previous command
11690 read an event that told it to exit, and it did so and unread that event.
11691 In other words, the present command is the event that made the previous
11694 The value `kill-region' is special; it means that the previous command
11695 was a kill command.
11697 `last-command' has a separate binding for each terminal device.
11698 See Info node `(elisp)Multiple Terminals'. */);
11700 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11701 doc
: /* Same as `last-command', but never altered by Lisp code.
11702 Taken from the previous value of `real-this-command'. */);
11704 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11705 doc
: /* Last command that may be repeated.
11706 The last command executed that was not bound to an input event.
11707 This is the command `repeat' will try to repeat.
11708 Taken from a previous value of `real-this-command'. */);
11710 DEFVAR_LISP ("this-command", Vthis_command
,
11711 doc
: /* The command now being executed.
11712 The command can set this variable; whatever is put here
11713 will be in `last-command' during the following command. */);
11714 Vthis_command
= Qnil
;
11716 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11717 doc
: /* This is like `this-command', except that commands should never modify it. */);
11718 Vreal_this_command
= Qnil
;
11720 DEFVAR_LISP ("this-command-keys-shift-translated",
11721 Vthis_command_keys_shift_translated
,
11722 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11723 Shift-translation occurs when there is no binding for the key sequence
11724 as entered, but a binding was found by changing an upper-case letter
11725 to lower-case, or a shifted function key to an unshifted one. */);
11726 Vthis_command_keys_shift_translated
= Qnil
;
11728 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11729 doc
: /* The command bound to the current key sequence before remapping.
11730 It equals `this-command' if the original command was not remapped through
11731 any of the active keymaps. Otherwise, the value of `this-command' is the
11732 result of looking up the original command in the active keymaps. */);
11733 Vthis_original_command
= Qnil
;
11735 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11736 doc
: /* Number of input events between auto-saves.
11737 Zero means disable autosaving due to number of characters typed. */);
11738 auto_save_interval
= 300;
11740 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11741 doc
: /* Number of seconds idle time before auto-save.
11742 Zero or nil means disable auto-saving due to idleness.
11743 After auto-saving due to this many seconds of idle time,
11744 Emacs also does a garbage collection if that seems to be warranted. */);
11745 XSETFASTINT (Vauto_save_timeout
, 30);
11747 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11748 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11749 The value may be integer or floating point.
11750 If the value is zero, don't echo at all. */);
11751 Vecho_keystrokes
= make_number (1);
11753 DEFVAR_INT ("polling-period", polling_period
,
11754 doc
: /* Interval between polling for input during Lisp execution.
11755 The reason for polling is to make C-g work to stop a running program.
11756 Polling is needed only when using X windows and SIGIO does not work.
11757 Polling is automatically disabled in all other cases. */);
11758 polling_period
= 2;
11760 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11761 doc
: /* Maximum time between mouse clicks to make a double-click.
11762 Measured in milliseconds. The value nil means disable double-click
11763 recognition; t means double-clicks have no time limit and are detected
11764 by position only. */);
11765 Vdouble_click_time
= make_number (500);
11767 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11768 doc
: /* Maximum mouse movement between clicks to make a double-click.
11769 On window-system frames, value is the number of pixels the mouse may have
11770 moved horizontally or vertically between two clicks to make a double-click.
11771 On non window-system frames, value is interpreted in units of 1/8 characters
11774 This variable is also the threshold for motion of the mouse
11775 to count as a drag. */);
11776 double_click_fuzz
= 3;
11778 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11779 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11780 inhibit_local_menu_bar_menus
= 0;
11782 DEFVAR_INT ("num-input-keys", num_input_keys
,
11783 doc
: /* Number of complete key sequences read as input so far.
11784 This includes key sequences read from keyboard macros.
11785 The number is effectively the number of interactive command invocations. */);
11786 num_input_keys
= 0;
11788 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11789 doc
: /* Number of input events read from the keyboard so far.
11790 This does not include events generated by keyboard macros. */);
11791 num_nonmacro_input_events
= 0;
11793 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11794 doc
: /* The frame in which the most recently read event occurred.
11795 If the last event came from a keyboard macro, this is set to `macro'. */);
11796 Vlast_event_frame
= Qnil
;
11798 /* This variable is set up in sysdep.c. */
11799 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11800 doc
: /* The ERASE character as set by the user with stty. */);
11802 DEFVAR_LISP ("help-char", Vhelp_char
,
11803 doc
: /* Character to recognize as meaning Help.
11804 When it is read, do `(eval help-form)', and display result if it's a string.
11805 If the value of `help-form' is nil, this char can be read normally. */);
11806 XSETINT (Vhelp_char
, Ctl ('H'));
11808 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11809 doc
: /* List of input events to recognize as meaning Help.
11810 These work just like the value of `help-char' (see that). */);
11811 Vhelp_event_list
= Qnil
;
11813 DEFVAR_LISP ("help-form", Vhelp_form
,
11814 doc
: /* Form to execute when character `help-char' is read.
11815 If the form returns a string, that string is displayed.
11816 If `help-form' is nil, the help char is not recognized. */);
11819 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11820 doc
: /* Command to run when `help-char' character follows a prefix key.
11821 This command is used only when there is no actual binding
11822 for that character after that prefix key. */);
11823 Vprefix_help_command
= Qnil
;
11825 DEFVAR_LISP ("top-level", Vtop_level
,
11826 doc
: /* Form to evaluate when Emacs starts up.
11827 Useful to set before you dump a modified Emacs. */);
11830 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11831 doc
: /* Translate table for local keyboard input, or nil.
11832 If non-nil, the value should be a char-table. Each character read
11833 from the keyboard is looked up in this char-table. If the value found
11834 there is non-nil, then it is used instead of the actual input character.
11836 The value can also be a string or vector, but this is considered obsolete.
11837 If it is a string or vector of length N, character codes N and up are left
11838 untranslated. In a vector, an element which is nil means "no translation".
11840 This is applied to the characters supplied to input methods, not their
11841 output. See also `translation-table-for-input'.
11843 This variable has a separate binding for each terminal.
11844 See Info node `(elisp)Multiple Terminals'. */);
11846 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11847 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11848 \(Even if the operating system has support for stopping a process.\) */);
11849 cannot_suspend
= 0;
11851 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11852 doc
: /* Non-nil means prompt with menus when appropriate.
11853 This is done when reading from a keymap that has a prompt string,
11854 for elements that have prompt strings.
11855 The menu is displayed on the screen
11856 if X menus were enabled at configuration
11857 time and the previous event was a mouse click prefix key.
11858 Otherwise, menu prompting uses the echo area. */);
11859 menu_prompting
= 1;
11861 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11862 doc
: /* Character to see next line of menu prompt.
11863 Type this character while in a menu prompt to rotate around the lines of it. */);
11864 XSETINT (menu_prompt_more_char
, ' ');
11866 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11867 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11868 Emacs applies the modifiers of the character stored here to each keyboard
11869 character it reads. For example, after evaluating the expression
11870 (setq extra-keyboard-modifiers ?\\C-x)
11871 all input characters will have the control modifier applied to them.
11873 Note that the character ?\\C-@, equivalent to the integer zero, does
11874 not count as a control character; rather, it counts as a character
11875 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11876 cancels any modification. */);
11877 extra_keyboard_modifiers
= 0;
11879 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11880 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11881 The command loop sets this to nil before each command,
11882 and tests the value when the command returns.
11883 Buffer modification stores t in this variable. */);
11884 Vdeactivate_mark
= Qnil
;
11885 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11887 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11888 doc
: /* Normal hook run before each command is executed.
11889 If an unhandled error happens in running this hook,
11890 the function in which the error occurred is unconditionally removed, since
11891 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11892 Vpre_command_hook
= Qnil
;
11894 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11895 doc
: /* Normal hook run after each command is executed.
11896 If an unhandled error happens in running this hook,
11897 the function in which the error occurred is unconditionally removed, since
11898 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11899 Vpost_command_hook
= Qnil
;
11902 DEFVAR_LISP ("echo-area-clear-hook", ...,
11903 doc
: /* Normal hook run when clearing the echo area. */);
11905 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11906 Fset (Qecho_area_clear_hook
, Qnil
);
11908 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11909 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11910 Vlucid_menu_bar_dirty_flag
= Qnil
;
11912 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11913 doc
: /* List of menu bar items to move to the end of the menu bar.
11914 The elements of the list are event types that may have menu bar bindings. */);
11915 Vmenu_bar_final_items
= Qnil
;
11917 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11918 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11919 This is used internally by graphical displays that do not render
11920 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11921 Vtool_bar_separator_image_expression
= Qnil
;
11923 DEFVAR_KBOARD ("overriding-terminal-local-map",
11924 Voverriding_terminal_local_map
,
11925 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11926 If this variable is non-nil, it is used as a keymap instead of the
11927 buffer's local map, and the minor mode keymaps and text property keymaps.
11928 It also replaces `overriding-local-map'.
11930 This variable is intended to let commands such as `universal-argument'
11931 set up a different keymap for reading the next command.
11933 `overriding-terminal-local-map' has a separate binding for each
11935 See Info node `(elisp)Multiple Terminals'. */);
11937 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11938 doc
: /* Keymap that overrides all other local keymaps.
11939 If this variable is non-nil, it is used as a keymap--replacing the
11940 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11941 Voverriding_local_map
= Qnil
;
11943 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11944 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11945 Otherwise, the menu bar continues to reflect the buffer's local map
11946 and the minor mode maps regardless of `overriding-local-map'. */);
11947 Voverriding_local_map_menu_flag
= Qnil
;
11949 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11950 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11951 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11953 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11954 doc
: /* Non-nil means generate motion events for mouse motion. */);
11956 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11957 doc
: /* Alist of system-specific X windows key symbols.
11958 Each element should have the form (N . SYMBOL) where N is the
11959 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11960 and SYMBOL is its name.
11962 `system-key-alist' has a separate binding for each terminal device.
11963 See Info node `(elisp)Multiple Terminals'. */);
11965 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11966 doc
: /* Keymap that translates key sequences to key sequences during input.
11967 This is used mainly for mapping key sequences into some preferred
11968 key events (symbols).
11970 The `read-key-sequence' function replaces any subsequence bound by
11971 `local-function-key-map' with its binding. More precisely, when the
11972 active keymaps have no binding for the current key sequence but
11973 `local-function-key-map' binds a suffix of the sequence to a vector or
11974 string, `read-key-sequence' replaces the matching suffix with its
11975 binding, and continues with the new sequence.
11977 If the binding is a function, it is called with one argument (the prompt)
11978 and its return value (a key sequence) is used.
11980 The events that come from bindings in `local-function-key-map' are not
11981 themselves looked up in `local-function-key-map'.
11983 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11984 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11985 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11986 typing `ESC O P x' would return [f1 x].
11988 `local-function-key-map' has a separate binding for each terminal
11989 device. See Info node `(elisp)Multiple Terminals'. If you need to
11990 define a binding on all terminals, change `function-key-map'
11991 instead. Initially, `local-function-key-map' is an empty keymap that
11992 has `function-key-map' as its parent on all terminal devices. */);
11994 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11995 doc
: /* Keymap that decodes input escape sequences.
11996 This is used mainly for mapping ASCII function key sequences into
11997 real Emacs function key events (symbols).
11999 The `read-key-sequence' function replaces any subsequence bound by
12000 `input-decode-map' with its binding. Contrary to `function-key-map',
12001 this map applies its rebinding regardless of the presence of an ordinary
12002 binding. So it is more like `key-translation-map' except that it applies
12003 before `function-key-map' rather than after.
12005 If the binding is a function, it is called with one argument (the prompt)
12006 and its return value (a key sequence) is used.
12008 The events that come from bindings in `input-decode-map' are not
12009 themselves looked up in `input-decode-map'.
12011 This variable is keyboard-local. */);
12013 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12014 doc
: /* The parent keymap of all `local-function-key-map' instances.
12015 Function key definitions that apply to all terminal devices should go
12016 here. If a mapping is defined in both the current
12017 `local-function-key-map' binding and this variable, then the local
12018 definition will take precedence. */);
12019 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12021 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12022 doc
: /* Keymap of key translations that can override keymaps.
12023 This keymap works like `function-key-map', but comes after that,
12024 and its non-prefix bindings override ordinary bindings.
12025 Another difference is that it is global rather than keyboard-local. */);
12026 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12028 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12029 doc
: /* List of deferred actions to be performed at a later time.
12030 The precise format isn't relevant here; we just check whether it is nil. */);
12031 Vdeferred_action_list
= Qnil
;
12033 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12034 doc
: /* Function to call to handle deferred actions, after each command.
12035 This function is called with no arguments after each command
12036 whenever `deferred-action-list' is non-nil. */);
12037 Vdeferred_action_function
= Qnil
;
12039 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12040 doc
: /* List of warnings to be displayed after this command.
12041 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12042 as per the args of `display-warning' (which see).
12043 If this variable is non-nil, `delayed-warnings-hook' will be run
12044 immediately after running `post-command-hook'. */);
12045 Vdelayed_warnings_list
= Qnil
;
12047 DEFVAR_LISP ("timer-list", Vtimer_list
,
12048 doc
: /* List of active absolute time timers in order of increasing time. */);
12049 Vtimer_list
= Qnil
;
12051 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12052 doc
: /* List of active idle-time timers in order of increasing time. */);
12053 Vtimer_idle_list
= Qnil
;
12055 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12056 doc
: /* If non-nil, the function that implements the current input method.
12057 It's called with one argument, a printing character that was just read.
12058 \(That means a character with code 040...0176.)
12059 Typically this function uses `read-event' to read additional events.
12060 When it does so, it should first bind `input-method-function' to nil
12061 so it will not be called recursively.
12063 The function should return a list of zero or more events
12064 to be used as input. If it wants to put back some events
12065 to be reconsidered, separately, by the input method,
12066 it can add them to the beginning of `unread-command-events'.
12068 The input method function can find in `input-method-previous-message'
12069 the previous echo area message.
12071 The input method function should refer to the variables
12072 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12073 for guidance on what to do. */);
12074 Vinput_method_function
= Qnil
;
12076 DEFVAR_LISP ("input-method-previous-message",
12077 Vinput_method_previous_message
,
12078 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12079 This variable exists because `read-event' clears the echo area
12080 before running the input method. It is nil if there was no message. */);
12081 Vinput_method_previous_message
= Qnil
;
12083 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12084 doc
: /* If non-nil, the function that implements the display of help.
12085 It's called with one argument, the help string to display. */);
12086 Vshow_help_function
= Qnil
;
12088 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12089 doc
: /* If non-nil, suppress point adjustment after executing a command.
12091 After a command is executed, if point is moved into a region that has
12092 special properties (e.g. composition, display), we adjust point to
12093 the boundary of the region. But, when a command sets this variable to
12094 non-nil, we suppress the point adjustment.
12096 This variable is set to nil before reading a command, and is checked
12097 just after executing the command. */);
12098 Vdisable_point_adjustment
= Qnil
;
12100 DEFVAR_LISP ("global-disable-point-adjustment",
12101 Vglobal_disable_point_adjustment
,
12102 doc
: /* If non-nil, always suppress point adjustment.
12104 The default value is nil, in which case, point adjustment are
12105 suppressed only after special commands that set
12106 `disable-point-adjustment' (which see) to non-nil. */);
12107 Vglobal_disable_point_adjustment
= Qnil
;
12109 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12110 doc
: /* How long to display an echo-area message when the minibuffer is active.
12111 If the value is not a number, such messages don't time out. */);
12112 Vminibuffer_message_timeout
= make_number (2);
12114 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12115 doc
: /* If non-nil, any keyboard input throws to this symbol.
12116 The value of that variable is passed to `quit-flag' and later causes a
12117 peculiar kind of quitting. */);
12118 Vthrow_on_input
= Qnil
;
12120 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12121 doc
: /* If non-nil, function to output error messages.
12122 The arguments are the error data, a list of the form
12123 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12124 such as just as `condition-case' would bind its variable to,
12125 the context (a string which normally goes at the start of the message),
12126 and the Lisp function within which the error was signaled. */);
12127 Vcommand_error_function
= Qnil
;
12129 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12130 Venable_disabled_menus_and_buttons
,
12131 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12133 Help functions bind this to allow help on disabled menu items
12134 and tool-bar buttons. */);
12135 Venable_disabled_menus_and_buttons
= Qnil
;
12137 DEFVAR_LISP ("select-active-regions",
12138 Vselect_active_regions
,
12139 doc
: /* If non-nil, an active region automatically sets the primary selection.
12140 If the value is `only', only temporarily active regions (usually made
12141 by mouse-dragging or shift-selection) set the window selection.
12143 This takes effect only when Transient Mark mode is enabled. */);
12144 Vselect_active_regions
= Qt
;
12146 DEFVAR_LISP ("saved-region-selection",
12147 Vsaved_region_selection
,
12148 doc
: /* Contents of active region prior to buffer modification.
12149 If `select-active-regions' is non-nil, Emacs sets this to the
12150 text in the region before modifying the buffer. The next
12151 `deactivate-mark' call uses this to set the window selection. */);
12152 Vsaved_region_selection
= Qnil
;
12154 DEFVAR_LISP ("selection-inhibit-update-commands",
12155 Vselection_inhibit_update_commands
,
12156 doc
: /* List of commands which should not update the selection.
12157 Normally, if `select-active-regions' is non-nil and the mark remains
12158 active after a command (i.e. the mark was not deactivated), the Emacs
12159 command loop sets the selection to the text in the region. However,
12160 if the command is in this list, the selection is not updated. */);
12161 Vselection_inhibit_update_commands
12162 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12164 DEFVAR_LISP ("debug-on-event",
12166 doc
: /* Enter debugger on this event. When Emacs
12167 receives the special event specified by this variable, it will try to
12168 break into the debugger as soon as possible instead of processing the
12169 event normally through `special-event-map'.
12171 Currently, the only supported values for this
12172 variable are `sigusr1' and `sigusr2'. */);
12173 Vdebug_on_event
= intern_c_string ("sigusr2");
12175 /* Create the initial keyboard. */
12176 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12177 init_kboard (initial_kboard
);
12178 /* Vwindow_system is left at t for now. */
12179 initial_kboard
->next_kboard
= all_kboards
;
12180 all_kboards
= initial_kboard
;
12184 keys_of_keyboard (void)
12186 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12187 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12188 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12189 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12190 initial_define_key (meta_map
, 'x', "execute-extended-command");
12192 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12193 "handle-delete-frame");
12194 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12195 "ns-put-working-text");
12196 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12197 "ns-unput-working-text");
12198 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12199 current-prefix-arg, as is done in `handle-switch-frame'.
12200 But `handle-switch-frame is not run from the special-map.
12201 Commands from that map are run in a special way that automatically
12202 preserves the prefix-arg. Restoring the prefix arg here is not just
12203 redundant but harmful:
12205 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12206 - after the first prompt, the exit-minibuffer-hook is run which may
12207 iconify a frame and thus push a `iconify-frame' event.
12208 - after running exit-minibuffer-hook, current-prefix-arg is
12209 restored to the non-nil value it had before the prompt.
12210 - we enter the second prompt.
12211 current-prefix-arg is non-nil, prefix-arg is nil.
12212 - before running the first real event, we run the special iconify-frame
12213 event, but we pass the `special' arg to execute-command so
12214 current-prefix-arg and prefix-arg are left untouched.
12215 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12216 - the next key event will have a spuriously non-nil current-prefix-arg. */
12217 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12219 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12221 /* Handling it at such a low-level causes read_key_sequence to get
12222 * confused because it doesn't realize that the current_buffer was
12223 * changed by read_char.
12225 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12226 * "handle-select-window"); */
12227 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12228 "handle-save-session");
12231 /* Define a special event which is raised for dbus callback
12233 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12234 "dbus-handle-event");
12237 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12241 /* Mark the pointers in the kboard objects.
12242 Called by Fgarbage_collect. */
12244 mark_kboards (void)
12248 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12250 if (kb
->kbd_macro_buffer
)
12251 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12253 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12254 mark_object (KVAR (kb
, Vlast_command
));
12255 mark_object (KVAR (kb
, Vreal_last_command
));
12256 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12257 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12258 mark_object (KVAR (kb
, Vprefix_arg
));
12259 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12260 mark_object (KVAR (kb
, kbd_queue
));
12261 mark_object (KVAR (kb
, defining_kbd_macro
));
12262 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12263 mark_object (KVAR (kb
, Vsystem_key_alist
));
12264 mark_object (KVAR (kb
, system_key_syms
));
12265 mark_object (KVAR (kb
, Vwindow_system
));
12266 mark_object (KVAR (kb
, Vinput_decode_map
));
12267 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12268 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12269 mark_object (KVAR (kb
, echo_string
));
12272 struct input_event
*event
;
12273 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12275 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12276 event
= kbd_buffer
;
12277 if (event
->kind
!= SELECTION_REQUEST_EVENT
12278 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12280 mark_object (event
->x
);
12281 mark_object (event
->y
);
12283 mark_object (event
->frame_or_window
);
12284 mark_object (event
->arg
);