1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
33 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
100 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
101 static int single_kboard
;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled
;
106 static Lisp_Object Qdisabled_command_function
;
108 #define NUM_RECENT_KEYS (300)
110 /* Index for storing next element into recent_keys. */
111 static int recent_keys_index
;
113 /* Total number of elements stored into recent_keys. */
114 static int total_keys
;
116 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
117 static Lisp_Object recent_keys
;
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 ptrdiff_t this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 static int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 static Lisp_Object raw_keybuf
;
134 static int raw_keybuf_count
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
138 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 static ptrdiff_t this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static ptrdiff_t before_command_key_count
;
147 static ptrdiff_t before_command_echo_length
;
149 /* For longjmp to where kbd input is being done. */
151 static jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 int waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
160 /* Non-null means we can start echoing at the next input pause even
161 though there is something in the echo area. */
163 static struct kboard
*ok_to_echo_at_next_pause
;
165 /* The kboard last echoing, or null for none. Reset to 0 in
166 cancel_echoing. If non-null, and a current echo area message
167 exists, and echo_message_buffer is eq to the current message
168 buffer, we know that the message comes from echo_kboard. */
170 struct kboard
*echo_kboard
;
172 /* The buffer used for echoing. Set in echo_now, reset in
175 Lisp_Object echo_message_buffer
;
177 /* Nonzero means C-g should cause immediate error-signal. */
180 /* Character that causes a quit. Normally C-g.
182 If we are running on an ordinary terminal, this must be an ordinary
183 ASCII char, since we want to make it our interrupt character.
185 If we are not running on an ordinary terminal, it still needs to be
186 an ordinary ASCII char. This character needs to be recognized in
187 the input interrupt handler. At this point, the keystroke is
188 represented as a struct input_event, while the desired quit
189 character is specified as a lispy event. The mapping from struct
190 input_events to lispy events cannot run in an interrupt handler,
191 and the reverse mapping is difficult for anything but ASCII
194 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
198 /* Current depth in recursive edits. */
199 EMACS_INT command_loop_level
;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame
;
210 /* Last size recorded for a current buffer which is not a minibuffer. */
211 static ptrdiff_t last_non_minibuf_size
;
213 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
214 uintmax_t num_input_events
;
216 /* Value of num_nonmacro_input_events as of last auto save. */
218 static EMACS_INT last_auto_save
;
220 /* The value of point when the last command was started. */
221 static ptrdiff_t last_point_position
;
223 /* The buffer that was current when the last command was started. */
224 static Lisp_Object last_point_position_buffer
;
226 /* The window that was selected when the last command was started. */
227 static Lisp_Object last_point_position_window
;
229 /* The frame in which the last input event occurred, or Qmacro if the
230 last event came from a macro. We use this to determine when to
231 generate switch-frame events. This may be cleared by functions
232 like Fselect_frame, to make sure that a switch-frame event is
233 generated by the next character. */
234 Lisp_Object internal_last_event_frame
;
236 /* The timestamp of the last input event we received from the X server.
237 X Windows wants this for selection ownership. */
238 Time last_event_timestamp
;
240 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
241 static Lisp_Object Qhandle_select_window
;
242 Lisp_Object QPRIMARY
;
244 static Lisp_Object Qself_insert_command
;
245 static Lisp_Object Qforward_char
;
246 static Lisp_Object Qbackward_char
;
247 Lisp_Object Qundefined
;
248 static Lisp_Object Qtimer_event_handler
;
250 /* read_key_sequence stores here the command definition of the
251 key sequence that it reads. */
252 static Lisp_Object read_key_sequence_cmd
;
253 static Lisp_Object read_key_sequence_remapped
;
255 static Lisp_Object Qinput_method_function
;
257 static Lisp_Object Qdeactivate_mark
;
259 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
261 static Lisp_Object Qecho_area_clear_hook
;
263 /* Hooks to run before and after each command. */
264 static Lisp_Object Qpre_command_hook
;
265 static Lisp_Object Qpost_command_hook
;
267 static Lisp_Object Qdeferred_action_function
;
269 static Lisp_Object Qdelayed_warnings_hook
;
271 static Lisp_Object Qinput_method_exit_on_first_char
;
272 static Lisp_Object Qinput_method_use_echo_area
;
274 static Lisp_Object Qhelp_form_show
;
276 /* File in which we write all commands we read. */
277 static FILE *dribble
;
279 /* Nonzero if input is available. */
282 /* Circular buffer for pre-read keyboard input. */
284 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
286 /* Pointer to next available character in kbd_buffer.
287 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
288 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
289 next available char is in kbd_buffer[0]. */
290 static struct input_event
*kbd_fetch_ptr
;
292 /* Pointer to next place to store character in kbd_buffer. This
293 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
294 character should go in kbd_buffer[0]. */
295 static struct input_event
* volatile kbd_store_ptr
;
297 /* The above pair of variables forms a "queue empty" flag. When we
298 enqueue a non-hook event, we increment kbd_store_ptr. When we
299 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
300 there is input available if the two pointers are not equal.
302 Why not just have a flag set and cleared by the enqueuing and
303 dequeuing functions? Such a flag could be screwed up by interrupts
304 at inopportune times. */
306 /* Symbols to head events. */
307 static Lisp_Object Qmouse_movement
;
308 static Lisp_Object Qscroll_bar_movement
;
309 Lisp_Object Qswitch_frame
;
310 static Lisp_Object Qdelete_frame
;
311 static Lisp_Object Qiconify_frame
;
312 static Lisp_Object Qmake_frame_visible
;
313 static Lisp_Object Qselect_window
;
314 Lisp_Object Qhelp_echo
;
316 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
317 static Lisp_Object Qmouse_fixup_help_message
;
320 /* Symbols to denote kinds of events. */
321 static Lisp_Object Qfunction_key
;
322 Lisp_Object Qmouse_click
;
323 #if defined (WINDOWSNT)
324 Lisp_Object Qlanguage_change
;
326 static Lisp_Object Qdrag_n_drop
;
327 static Lisp_Object Qsave_session
;
329 static Lisp_Object Qdbus_event
;
331 static Lisp_Object Qconfig_changed_event
;
333 /* Lisp_Object Qmouse_movement; - also an event header */
335 /* Properties of event headers. */
336 Lisp_Object Qevent_kind
;
337 static Lisp_Object Qevent_symbol_elements
;
339 /* Menu and tool bar item parts. */
340 static Lisp_Object Qmenu_enable
;
341 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
342 Lisp_Object QCfilter
;
344 /* Non-nil disable property on a command means
345 do not execute it; call disabled-command-function's value instead. */
346 Lisp_Object QCtoggle
, QCradio
;
347 static Lisp_Object QCbutton
, QClabel
;
349 static Lisp_Object QCvert_only
;
351 /* An event header symbol HEAD may have a property named
352 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
353 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
354 mask of modifiers applied to it. If present, this is used to help
355 speed up parse_modifiers. */
356 Lisp_Object Qevent_symbol_element_mask
;
358 /* An unmodified event header BASE may have a property named
359 Qmodifier_cache, which is an alist mapping modifier masks onto
360 modified versions of BASE. If present, this helps speed up
362 static Lisp_Object Qmodifier_cache
;
364 /* Symbols to use for parts of windows. */
365 Lisp_Object Qmode_line
;
366 Lisp_Object Qvertical_line
;
367 static Lisp_Object Qvertical_scroll_bar
;
368 Lisp_Object Qmenu_bar
;
370 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
371 static Lisp_Object
command_loop (void);
372 static Lisp_Object Qextended_command_history
;
373 EMACS_TIME
timer_check (void);
375 static void record_menu_key (Lisp_Object c
);
376 static void echo_now (void);
377 static ptrdiff_t echo_length (void);
379 static Lisp_Object Qpolling_period
;
381 /* Incremented whenever a timer is run. */
384 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
386 EMACS_TIME
*input_available_clear_time
;
388 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
389 Default is 1 if INTERRUPT_INPUT is defined. */
392 /* Nonzero while interrupts are temporarily deferred during redisplay. */
393 int interrupts_deferred
;
395 /* Allow m- file to inhibit use of FIONREAD. */
396 #ifdef BROKEN_FIONREAD
400 /* We are unable to use interrupts if FIONREAD is not available,
401 so flush SIGIO so we won't try. */
402 #if !defined (FIONREAD)
408 /* If we support a window system, turn on the code to poll periodically
409 to detect C-g. It isn't actually used when doing interrupt input. */
410 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
411 #define POLL_FOR_INPUT
414 /* The time when Emacs started being idle. */
416 static EMACS_TIME timer_idleness_start_time
;
418 /* After Emacs stops being idle, this saves the last value
419 of timer_idleness_start_time from when it was idle. */
421 static EMACS_TIME timer_last_idleness_start_time
;
424 /* Global variable declarations. */
426 /* Flags for readable_events. */
427 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
428 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
429 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
431 /* Function for init_keyboard to call with no args (if nonzero). */
432 static void (*keyboard_init_hook
) (void);
434 static int read_avail_input (int);
435 static void get_input_pending (int *, int);
436 static int readable_events (int);
437 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
439 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
441 static Lisp_Object
make_lispy_event (struct input_event
*);
442 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
443 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
444 enum scroll_bar_part
,
445 Lisp_Object
, Lisp_Object
,
448 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
449 Lisp_Object
, const char *const *,
450 Lisp_Object
*, ptrdiff_t);
451 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
452 static int help_char_p (Lisp_Object
);
453 static void save_getcjmp (jmp_buf);
454 static void restore_getcjmp (jmp_buf);
455 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
456 static void clear_event (struct input_event
*);
457 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
458 static void interrupt_signal (int signalnum
);
460 static void input_available_signal (int signo
);
462 static void handle_interrupt (void);
463 static _Noreturn
void quit_throw_to_read_char (int);
464 static void process_special_events (void);
465 static void timer_start_idle (void);
466 static void timer_stop_idle (void);
467 static void timer_resume_idle (void);
468 static void handle_user_signal (int);
469 static char *find_user_signal_name (int);
470 static int store_user_signal_events (void);
473 /* Add C to the echo string, if echoing is going on.
474 C can be a character, which is printed prettily ("M-C-x" and all that
475 jazz), or a symbol, whose name is printed. */
478 echo_char (Lisp_Object c
)
480 if (current_kboard
->immediate_echo
)
482 int size
= KEY_DESCRIPTION_SIZE
+ 100;
483 char *buffer
= (char *) alloca (size
);
485 Lisp_Object echo_string
;
487 echo_string
= KVAR (current_kboard
, echo_string
);
489 /* If someone has passed us a composite event, use its head symbol. */
494 ptr
= push_key_description (XINT (c
), ptr
, 1);
496 else if (SYMBOLP (c
))
498 Lisp_Object name
= SYMBOL_NAME (c
);
499 int nbytes
= SBYTES (name
);
501 if (size
- (ptr
- buffer
) < nbytes
)
503 int offset
= ptr
- buffer
;
504 size
= max (2 * size
, size
+ nbytes
);
505 buffer
= (char *) alloca (size
);
506 ptr
= buffer
+ offset
;
509 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
510 STRING_MULTIBYTE (name
), 1);
513 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
516 const char *text
= " (Type ? for further options)";
517 int len
= strlen (text
);
519 if (size
- (ptr
- buffer
) < len
)
521 int offset
= ptr
- buffer
;
523 buffer
= (char *) alloca (size
);
524 ptr
= buffer
+ offset
;
527 memcpy (ptr
, text
, len
);
531 /* Replace a dash from echo_dash with a space, otherwise
532 add a space at the end as a separator between keys. */
533 if (STRINGP (echo_string
)
534 && SCHARS (echo_string
) > 1)
536 Lisp_Object last_char
, prev_char
, idx
;
538 idx
= make_number (SCHARS (echo_string
) - 2);
539 prev_char
= Faref (echo_string
, idx
);
541 idx
= make_number (SCHARS (echo_string
) - 1);
542 last_char
= Faref (echo_string
, idx
);
544 /* We test PREV_CHAR to make sure this isn't the echoing
546 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
547 Faset (echo_string
, idx
, make_number (' '));
549 echo_string
= concat2 (echo_string
, build_string (" "));
551 else if (STRINGP (echo_string
))
552 echo_string
= concat2 (echo_string
, build_string (" "));
554 KVAR (current_kboard
, echo_string
)
555 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
561 /* Temporarily add a dash to the end of the echo string if it's not
562 empty, so that it serves as a mini-prompt for the very next character. */
567 /* Do nothing if not echoing at all. */
568 if (NILP (KVAR (current_kboard
, echo_string
)))
571 if (this_command_key_count
== 0)
574 if (!current_kboard
->immediate_echo
575 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
578 /* Do nothing if we just printed a prompt. */
579 if (current_kboard
->echo_after_prompt
580 == SCHARS (KVAR (current_kboard
, echo_string
)))
583 /* Do nothing if we have already put a dash at the end. */
584 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
586 Lisp_Object last_char
, prev_char
, idx
;
588 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
589 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
591 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
592 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
594 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
598 /* Put a dash at the end of the buffer temporarily,
599 but make it go away when the next character is added. */
600 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
605 /* Display the current echo string, and begin echoing if not already
611 if (!current_kboard
->immediate_echo
)
614 current_kboard
->immediate_echo
= 1;
616 for (i
= 0; i
< this_command_key_count
; i
++)
620 /* Set before_command_echo_length to the value that would
621 have been saved before the start of this subcommand in
622 command_loop_1, if we had already been echoing then. */
623 if (i
== this_single_command_key_start
)
624 before_command_echo_length
= echo_length ();
626 c
= AREF (this_command_keys
, i
);
627 if (! (EVENT_HAS_PARAMETERS (c
)
628 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
632 /* Set before_command_echo_length to the value that would
633 have been saved before the start of this subcommand in
634 command_loop_1, if we had already been echoing then. */
635 if (this_command_key_count
== this_single_command_key_start
)
636 before_command_echo_length
= echo_length ();
638 /* Put a dash at the end to invite the user to type more. */
643 message3_nolog (KVAR (current_kboard
, echo_string
),
644 SBYTES (KVAR (current_kboard
, echo_string
)),
645 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
648 /* Record in what buffer we echoed, and from which kboard. */
649 echo_message_buffer
= echo_area_buffer
[0];
650 echo_kboard
= current_kboard
;
652 if (waiting_for_input
&& !NILP (Vquit_flag
))
653 quit_throw_to_read_char (0);
656 /* Turn off echoing, for the start of a new command. */
659 cancel_echoing (void)
661 current_kboard
->immediate_echo
= 0;
662 current_kboard
->echo_after_prompt
= -1;
663 KVAR (current_kboard
, echo_string
) = Qnil
;
664 ok_to_echo_at_next_pause
= NULL
;
666 echo_message_buffer
= Qnil
;
669 /* Return the length of the current echo string. */
674 return (STRINGP (KVAR (current_kboard
, echo_string
))
675 ? SCHARS (KVAR (current_kboard
, echo_string
))
679 /* Truncate the current echo message to its first LEN chars.
680 This and echo_char get used by read_key_sequence when the user
681 switches frames while entering a key sequence. */
684 echo_truncate (ptrdiff_t nchars
)
686 if (STRINGP (KVAR (current_kboard
, echo_string
)))
687 KVAR (current_kboard
, echo_string
)
688 = Fsubstring (KVAR (current_kboard
, echo_string
),
689 make_number (0), make_number (nchars
));
690 truncate_echo_area (nchars
);
694 /* Functions for manipulating this_command_keys. */
696 add_command_key (Lisp_Object key
)
698 #if 0 /* Not needed after we made Freset_this_command_lengths
699 do the job immediately. */
700 /* If reset-this-command-length was called recently, obey it now.
701 See the doc string of that function for an explanation of why. */
702 if (before_command_restore_flag
)
704 this_command_key_count
= before_command_key_count_1
;
705 if (this_command_key_count
< this_single_command_key_start
)
706 this_single_command_key_start
= this_command_key_count
;
707 echo_truncate (before_command_echo_length_1
);
708 before_command_restore_flag
= 0;
712 if (this_command_key_count
>= ASIZE (this_command_keys
))
713 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
715 ASET (this_command_keys
, this_command_key_count
, key
);
716 ++this_command_key_count
;
721 recursive_edit_1 (void)
723 ptrdiff_t count
= SPECPDL_INDEX ();
726 if (command_loop_level
> 0)
728 specbind (Qstandard_output
, Qt
);
729 specbind (Qstandard_input
, Qt
);
732 #ifdef HAVE_WINDOW_SYSTEM
733 /* The command loop has started an hourglass timer, so we have to
734 cancel it here, otherwise it will fire because the recursive edit
735 can take some time. Do not check for display_hourglass_p here,
736 because it could already be nil. */
740 /* This function may have been called from a debugger called from
741 within redisplay, for instance by Edebugging a function called
742 from fontification-functions. We want to allow redisplay in
743 the debugging session.
745 The recursive edit is left with a `(throw exit ...)'. The `exit'
746 tag is not caught anywhere in redisplay, i.e. when we leave the
747 recursive edit, the original redisplay leading to the recursive
748 edit will be unwound. The outcome should therefore be safe. */
749 specbind (Qinhibit_redisplay
, Qnil
);
752 val
= command_loop ();
754 Fsignal (Qquit
, Qnil
);
755 /* Handle throw from read_minibuf when using minibuffer
756 while it's active but we're in another window. */
758 xsignal1 (Qerror
, val
);
760 return unbind_to (count
, Qnil
);
763 /* When an auto-save happens, record the "time", and don't do again soon. */
766 record_auto_save (void)
768 last_auto_save
= num_nonmacro_input_events
;
771 /* Make an auto save happen as soon as possible at command level. */
775 force_auto_save_soon (void)
777 last_auto_save
= - auto_save_interval
- 1;
779 record_asynch_buffer_change ();
783 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
784 doc
: /* Invoke the editor command loop recursively.
785 To get out of the recursive edit, a command can do `(throw 'exit nil)';
786 that tells this function to return.
787 Alternatively, `(throw 'exit t)' makes this function signal an error.
788 This function is called by the editor initialization to begin editing. */)
791 ptrdiff_t count
= SPECPDL_INDEX ();
794 /* If we enter while input is blocked, don't lock up here.
795 This may happen through the debugger during redisplay. */
799 command_loop_level
++;
800 update_mode_lines
= 1;
802 if (command_loop_level
803 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
804 buffer
= Fcurrent_buffer ();
808 /* If we leave recursive_edit_1 below with a `throw' for instance,
809 like it is done in the splash screen display, we have to
810 make sure that we restore single_kboard as command_loop_1
811 would have done if it were left normally. */
812 if (command_loop_level
> 0)
813 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
814 record_unwind_protect (recursive_edit_unwind
, buffer
);
817 return unbind_to (count
, Qnil
);
821 recursive_edit_unwind (Lisp_Object buffer
)
823 if (BUFFERP (buffer
))
824 Fset_buffer (buffer
);
826 command_loop_level
--;
827 update_mode_lines
= 1;
832 #if 0 /* These two functions are now replaced with
833 temporarily_switch_to_single_kboard. */
837 #if 0 /* Theory: if there's anything in Vunread_command_events,
838 it will right away be read by read_key_sequence,
839 and then if we do switch KBOARDS, it will go into the side
840 queue then. So we don't need to do anything special here -- rms. */
841 if (CONSP (Vunread_command_events
))
843 current_kboard
->kbd_queue
844 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
845 current_kboard
->kbd_queue_has_data
= 1;
847 Vunread_command_events
= Qnil
;
852 /* Switch to the single-kboard state, making current_kboard
853 the only KBOARD from which further input is accepted. */
856 single_kboard_state ()
862 /* If we're in single_kboard state for kboard KBOARD,
866 not_single_kboard_state (KBOARD
*kboard
)
868 if (kboard
== current_kboard
)
872 /* Maintain a stack of kboards, so other parts of Emacs
873 can switch temporarily to the kboard of a given frame
874 and then revert to the previous status. */
879 struct kboard_stack
*next
;
882 static struct kboard_stack
*kboard_stack
;
885 push_kboard (struct kboard
*k
)
887 struct kboard_stack
*p
= xmalloc (sizeof (struct kboard_stack
));
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 /* FIXME: This is wrong rather than test window-system, we should call
1322 a new set-selection, which will then dispatch to x-set-selection, or
1323 tty-set-selection, or w32-set-selection, ... */
1326 command_loop_1 (void)
1329 Lisp_Object keybuf
[30];
1331 EMACS_INT prev_modiff
= 0;
1332 struct buffer
*prev_buffer
= NULL
;
1333 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1334 int was_locked
= single_kboard
;
1336 int already_adjusted
= 0;
1338 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1339 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1340 Vdeactivate_mark
= Qnil
;
1341 waiting_for_input
= 0;
1344 this_command_key_count
= 0;
1345 this_command_key_count_reset
= 0;
1346 this_single_command_key_start
= 0;
1348 if (NILP (Vmemory_full
))
1350 /* Make sure this hook runs after commands that get errors and
1351 throw to top level. */
1352 /* Note that the value cell will never directly contain nil
1353 if the symbol is a local variable. */
1354 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1355 safe_run_hooks (Qpost_command_hook
);
1357 /* If displaying a message, resize the echo area window to fit
1358 that message's size exactly. */
1359 if (!NILP (echo_area_buffer
[0]))
1360 resize_echo_area_exactly ();
1362 /* If there are warnings waiting, process them. */
1363 if (!NILP (Vdelayed_warnings_list
))
1364 safe_run_hooks (Qdelayed_warnings_hook
);
1366 if (!NILP (Vdeferred_action_list
))
1367 safe_run_hooks (Qdeferred_action_function
);
1370 /* Do this after running Vpost_command_hook, for consistency. */
1371 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1372 KVAR (current_kboard
, Vreal_last_command
) = Vreal_this_command
;
1373 if (!CONSP (last_command_event
))
1374 KVAR (current_kboard
, Vlast_repeatable_command
) = Vreal_this_command
;
1378 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1381 /* Make sure the current window's buffer is selected. */
1382 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1383 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1385 /* Display any malloc warning that just came out. Use while because
1386 displaying one warning can cause another. */
1388 while (pending_malloc_warning
)
1389 display_malloc_warning ();
1391 Vdeactivate_mark
= Qnil
;
1393 /* If minibuffer on and echo area in use,
1394 wait a short time and redraw minibuffer. */
1397 && !NILP (echo_area_buffer
[0])
1398 && EQ (minibuf_window
, echo_area_window
)
1399 && NUMBERP (Vminibuffer_message_timeout
))
1401 /* Bind inhibit-quit to t so that C-g gets read in
1402 rather than quitting back to the minibuffer. */
1403 ptrdiff_t count
= SPECPDL_INDEX ();
1404 specbind (Qinhibit_quit
, Qt
);
1406 sit_for (Vminibuffer_message_timeout
, 0, 2);
1408 /* Clear the echo area. */
1410 safe_run_hooks (Qecho_area_clear_hook
);
1412 unbind_to (count
, Qnil
);
1414 /* If a C-g came in before, treat it as input now. */
1415 if (!NILP (Vquit_flag
))
1418 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1423 /* Select the frame that the last event came from. Usually,
1424 switch-frame events will take care of this, but if some lisp
1425 code swallows a switch-frame event, we'll fix things up here.
1426 Is this a good idea? */
1427 if (FRAMEP (internal_last_event_frame
)
1428 && !EQ (internal_last_event_frame
, selected_frame
))
1429 Fselect_frame (internal_last_event_frame
, Qnil
);
1431 /* If it has changed current-menubar from previous value,
1432 really recompute the menubar from the value. */
1433 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1434 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1435 call0 (Qrecompute_lucid_menubar
);
1437 before_command_key_count
= this_command_key_count
;
1438 before_command_echo_length
= echo_length ();
1440 Vthis_command
= Qnil
;
1441 Vreal_this_command
= Qnil
;
1442 Vthis_original_command
= Qnil
;
1443 Vthis_command_keys_shift_translated
= Qnil
;
1445 /* Read next key sequence; i gets its length. */
1446 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1449 /* A filter may have run while we were reading the input. */
1450 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1452 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1453 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1457 /* Now we have read a key sequence of length I,
1458 or else I is 0 and we found end of file. */
1460 if (i
== 0) /* End of file -- happens only in */
1461 return Qnil
; /* a kbd macro, at the end. */
1462 /* -1 means read_key_sequence got a menu that was rejected.
1463 Just loop around and read another command. */
1467 this_command_key_count
= 0;
1468 this_command_key_count_reset
= 0;
1469 this_single_command_key_start
= 0;
1473 last_command_event
= keybuf
[i
- 1];
1475 /* If the previous command tried to force a specific window-start,
1476 forget about that, in case this command moves point far away
1477 from that position. But also throw away beg_unchanged and
1478 end_unchanged information in that case, so that redisplay will
1479 update the whole window properly. */
1480 if (XWINDOW (selected_window
)->force_start
)
1483 XWINDOW (selected_window
)->force_start
= 0;
1484 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1485 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1488 cmd
= read_key_sequence_cmd
;
1489 if (!NILP (Vexecuting_kbd_macro
))
1491 if (!NILP (Vquit_flag
))
1493 Vexecuting_kbd_macro
= Qt
;
1494 QUIT
; /* Make some noise. */
1495 /* Will return since macro now empty. */
1499 /* Do redisplay processing after this command except in special
1500 cases identified below. */
1501 prev_buffer
= current_buffer
;
1502 prev_modiff
= MODIFF
;
1503 last_point_position
= PT
;
1504 last_point_position_window
= selected_window
;
1505 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1507 /* By default, we adjust point to a boundary of a region that
1508 has such a property that should be treated intangible
1509 (e.g. composition, display). But, some commands will set
1510 this variable differently. */
1511 Vdisable_point_adjustment
= Qnil
;
1513 /* Process filters and timers may have messed with deactivate-mark.
1514 reset it before we execute the command. */
1515 Vdeactivate_mark
= Qnil
;
1517 /* Remap command through active keymaps. */
1518 Vthis_original_command
= cmd
;
1519 if (!NILP (read_key_sequence_remapped
))
1520 cmd
= read_key_sequence_remapped
;
1522 /* Execute the command. */
1524 Vthis_command
= cmd
;
1525 Vreal_this_command
= cmd
;
1526 safe_run_hooks (Qpre_command_hook
);
1528 already_adjusted
= 0;
1530 if (NILP (Vthis_command
))
1532 /* nil means key is undefined. */
1533 Lisp_Object keys
= Fvector (i
, keybuf
);
1534 keys
= Fkey_description (keys
, Qnil
);
1536 message_with_string ("%s is undefined", keys
, 0);
1537 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1538 update_mode_lines
= 1;
1539 /* If this is a down-mouse event, don't reset prefix-arg;
1540 pass it to the command run by the up event. */
1541 if (EVENT_HAS_PARAMETERS (last_command_event
))
1543 Lisp_Object breakdown
1544 = parse_modifiers (EVENT_HEAD (last_command_event
));
1545 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1546 if (!(modifiers
& down_modifier
))
1547 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1550 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1554 /* Here for a command that isn't executed directly. */
1556 #ifdef HAVE_WINDOW_SYSTEM
1557 ptrdiff_t scount
= SPECPDL_INDEX ();
1559 if (display_hourglass_p
1560 && NILP (Vexecuting_kbd_macro
))
1562 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1567 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1569 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1571 #ifdef HAVE_WINDOW_SYSTEM
1572 /* Do not check display_hourglass_p here, because
1573 Fcommand_execute could change it, but we should cancel
1574 hourglass cursor anyway.
1575 But don't cancel the hourglass within a macro
1576 just because a command in the macro finishes. */
1577 if (NILP (Vexecuting_kbd_macro
))
1578 unbind_to (scount
, Qnil
);
1581 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1583 safe_run_hooks (Qpost_command_hook
);
1585 /* If displaying a message, resize the echo area window to fit
1586 that message's size exactly. */
1587 if (!NILP (echo_area_buffer
[0]))
1588 resize_echo_area_exactly ();
1590 /* If there are warnings waiting, process them. */
1591 if (!NILP (Vdelayed_warnings_list
))
1592 safe_run_hooks (Qdelayed_warnings_hook
);
1594 safe_run_hooks (Qdeferred_action_function
);
1596 /* If there is a prefix argument,
1597 1) We don't want Vlast_command to be ``universal-argument''
1598 (that would be dumb), so don't set Vlast_command,
1599 2) we want to leave echoing on so that the prefix will be
1600 echoed as part of this key sequence, so don't call
1602 3) we want to leave this_command_key_count non-zero, so that
1603 read_char will realize that it is re-reading a character, and
1604 not echo it a second time.
1606 If the command didn't actually create a prefix arg,
1607 but is merely a frame event that is transparent to prefix args,
1608 then the above doesn't apply. */
1609 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1610 || CONSP (last_command_event
))
1612 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1613 KVAR (current_kboard
, Vreal_last_command
) = Vreal_this_command
;
1614 if (!CONSP (last_command_event
))
1615 KVAR (current_kboard
, Vlast_repeatable_command
)
1616 = Vreal_this_command
;
1618 this_command_key_count
= 0;
1619 this_command_key_count_reset
= 0;
1620 this_single_command_key_start
= 0;
1623 if (!NILP (BVAR (current_buffer
, mark_active
))
1624 && !NILP (Vrun_hooks
))
1626 /* In Emacs 22, setting transient-mark-mode to `only' was a
1627 way of turning it on for just one command. This usage is
1628 obsolete, but support it anyway. */
1629 if (EQ (Vtransient_mark_mode
, Qidentity
))
1630 Vtransient_mark_mode
= Qnil
;
1631 else if (EQ (Vtransient_mark_mode
, Qonly
))
1632 Vtransient_mark_mode
= Qidentity
;
1634 if (!NILP (Vdeactivate_mark
))
1635 /* If `select-active-regions' is non-nil, this call to
1636 `deactivate-mark' also sets the PRIMARY selection. */
1637 call0 (Qdeactivate_mark
);
1640 /* Even if not deactivating the mark, set PRIMARY if
1641 `select-active-regions' is non-nil. */
1642 if (!NILP (Fwindow_system (Qnil
))
1643 /* Even if mark_active is non-nil, the actual buffer
1644 marker may not have been set yet (Bug#7044). */
1645 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1646 && (EQ (Vselect_active_regions
, Qonly
)
1647 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1648 : (!NILP (Vselect_active_regions
)
1649 && !NILP (Vtransient_mark_mode
)))
1650 && NILP (Fmemq (Vthis_command
,
1651 Vselection_inhibit_update_commands
)))
1654 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1657 call2 (Qx_set_selection
, QPRIMARY
,
1658 make_buffer_string (beg
, end
, 0));
1660 call2 (Qx_set_selection
, QPRIMARY
,
1661 make_buffer_string (end
, beg
, 0));
1662 /* Don't set empty selections. */
1665 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1667 Lisp_Object hook
= intern ("activate-mark-hook");
1668 Frun_hooks (1, &hook
);
1672 Vsaved_region_selection
= Qnil
;
1677 if (current_buffer
== prev_buffer
1678 && last_point_position
!= PT
1679 && NILP (Vdisable_point_adjustment
)
1680 && NILP (Vglobal_disable_point_adjustment
))
1682 if (last_point_position
> BEGV
1683 && last_point_position
< ZV
1684 && (composition_adjust_point (last_point_position
,
1685 last_point_position
)
1686 != last_point_position
))
1687 /* The last point was temporarily set within a grapheme
1688 cluster to prevent automatic composition. To recover
1689 the automatic composition, we must update the
1691 windows_or_buffers_changed
++;
1692 if (!already_adjusted
)
1693 adjust_point_for_property (last_point_position
,
1694 MODIFF
!= prev_modiff
);
1697 /* Install chars successfully executed in kbd macro. */
1699 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1700 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1701 finalize_kbd_macro_chars ();
1702 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1704 any_kboard_state ();
1709 /* Adjust point to a boundary of a region that has such a property
1710 that should be treated intangible. For the moment, we check
1711 `composition', `display' and `invisible' properties.
1712 LAST_PT is the last position of point. */
1715 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1718 Lisp_Object val
, overlay
, tmp
;
1719 /* When called after buffer modification, we should temporarily
1720 suppress the point adjustment for automatic composition so that a
1721 user can keep inserting another character at point or keep
1722 deleting characters around point. */
1723 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1724 ptrdiff_t orig_pt
= PT
;
1726 /* FIXME: cycling is probably not necessary because these properties
1727 can't be usefully combined anyway. */
1728 while (check_composition
|| check_display
|| check_invisible
)
1730 /* FIXME: check `intangible'. */
1731 if (check_composition
1732 && PT
> BEGV
&& PT
< ZV
1733 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1736 check_display
= check_invisible
= 1;
1738 check_composition
= 0;
1740 && PT
> BEGV
&& PT
< ZV
1741 && !NILP (val
= get_char_property_and_overlay
1742 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1743 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1744 && (!OVERLAYP (overlay
)
1745 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1746 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1747 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1748 && (beg
< PT
/* && end > PT <- It's always the case. */
1749 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1752 SET_PT (PT
< last_pt
1753 ? (STRINGP (val
) && SCHARS (val
) == 0
1754 ? max (beg
- 1, BEGV
)
1757 check_composition
= check_invisible
= 1;
1760 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1762 int inv
, ellipsis
= 0;
1765 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1768 /* FIXME: We should stop if we find a spot between
1769 two runs of `invisible' where inserted text would
1770 be visible. This is important when we have two
1771 invisible boundaries that enclose an area: if the
1772 area is empty, we need this test in order to make
1773 it possible to place point in the middle rather
1774 than skip both boundaries. However, this code
1775 also stops anywhere in a non-sticky text-property,
1776 which breaks (e.g.) Org mode. */
1777 && (val
= get_pos_property (make_number (end
),
1779 TEXT_PROP_MEANS_INVISIBLE (val
))
1781 && !NILP (val
= get_char_property_and_overlay
1782 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1783 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1785 ellipsis
= ellipsis
|| inv
> 1
1786 || (OVERLAYP (overlay
)
1787 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1788 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1789 tmp
= Fnext_single_char_property_change
1790 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1791 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1795 && (val
= get_pos_property (make_number (beg
),
1797 TEXT_PROP_MEANS_INVISIBLE (val
))
1799 && !NILP (val
= get_char_property_and_overlay
1800 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1801 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1803 ellipsis
= ellipsis
|| inv
> 1
1804 || (OVERLAYP (overlay
)
1805 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1806 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1807 tmp
= Fprevious_single_char_property_change
1808 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1809 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1812 /* Move away from the inside area. */
1813 if (beg
< PT
&& end
> PT
)
1815 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1816 /* We haven't moved yet (so we don't need to fear
1817 infinite-looping) and we were outside the range
1818 before (so either end of the range still corresponds
1819 to a move in the right direction): pretend we moved
1820 less than we actually did, so that we still have
1821 more freedom below in choosing which end of the range
1823 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1824 /* We either have moved already or the last point
1825 was already in the range: we don't get to choose
1826 which end of the range we have to go to. */
1827 : (PT
< last_pt
? beg
: end
));
1828 check_composition
= check_display
= 1;
1830 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1831 the point to something other than its argument, due to
1832 point-motion hooks, intangibility, etc. */
1833 eassert (PT
== beg
|| PT
== end
);
1836 /* Pretend the area doesn't exist if the buffer is not
1838 if (!modified
&& !ellipsis
&& beg
< end
)
1840 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1841 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1842 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1843 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1844 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1845 /* We've already moved as far as we can. Trying to go
1846 to the other end would mean moving backwards and thus
1847 could lead to an infinite loop. */
1849 else if (val
= get_pos_property (make_number (PT
),
1851 TEXT_PROP_MEANS_INVISIBLE (val
)
1852 && (val
= get_pos_property
1853 (make_number (PT
== beg
? end
: beg
),
1855 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1856 (check_composition
= check_display
= 1,
1857 SET_PT (PT
== beg
? end
: beg
));
1860 check_invisible
= 0;
1864 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1867 safe_run_hooks_1 (void)
1869 eassert (CONSP (Vinhibit_quit
));
1870 return call0 (XCDR (Vinhibit_quit
));
1873 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1877 safe_run_hooks_error (Lisp_Object error_data
)
1880 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1881 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1882 Lisp_Object args
[4];
1883 args
[0] = build_string ("Error in %s (%s): %S");
1886 args
[3] = error_data
;
1892 Lisp_Object newval
= Qnil
;
1893 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1894 if (EQ (fun
, XCAR (val
)))
1897 newval
= Fcons (XCAR (val
), newval
);
1899 return Fset (hook
, Fnreverse (newval
));
1900 /* Not found in the local part of the hook. Let's look at the global
1903 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1904 : Fdefault_value (hook
));
1905 CONSP (val
); val
= XCDR (val
))
1906 if (EQ (fun
, XCAR (val
)))
1909 newval
= Fcons (XCAR (val
), newval
);
1911 return Fset_default (hook
, Fnreverse (newval
));
1917 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1919 eassert (nargs
== 1);
1920 if (CONSP (Vinhibit_quit
))
1921 XSETCDR (Vinhibit_quit
, args
[0]);
1923 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1925 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1929 /* If we get an error while running the hook, cause the hook variable
1930 to be nil. Also inhibit quits, so that C-g won't cause the hook
1931 to mysteriously evaporate. */
1934 safe_run_hooks (Lisp_Object hook
)
1936 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1937 to its body or to its handlers other than via globals such as
1938 dynamically-bound variables ;-) */
1939 ptrdiff_t count
= SPECPDL_INDEX ();
1940 specbind (Qinhibit_quit
, hook
);
1942 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1944 unbind_to (count
, Qnil
);
1948 /* Nonzero means polling for input is temporarily suppressed. */
1950 int poll_suppress_count
;
1952 /* Asynchronous timer for polling. */
1954 static struct atimer
*poll_timer
;
1957 #ifdef POLL_FOR_INPUT
1959 /* Poll for input, so that we catch a C-g if it comes in. This
1960 function is called from x_make_frame_visible, see comment
1964 poll_for_input_1 (void)
1966 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1967 doing anything dangerous. */
1971 if (interrupt_input_blocked
== 0
1972 && !waiting_for_input
)
1973 read_avail_input (0);
1979 /* Timer callback function for poll_timer. TIMER is equal to
1983 poll_for_input (struct atimer
*timer
)
1985 if (poll_suppress_count
== 0)
1988 interrupt_input_pending
= 1;
1989 pending_signals
= 1;
1991 poll_for_input_1 ();
1996 #endif /* POLL_FOR_INPUT */
1998 /* Begin signals to poll for input, if they are appropriate.
1999 This function is called unconditionally from various places. */
2002 start_polling (void)
2004 #ifdef POLL_FOR_INPUT
2005 /* XXX This condition was (read_socket_hook && !interrupt_input),
2006 but read_socket_hook is not global anymore. Let's pretend that
2008 if (!interrupt_input
)
2010 /* Turn alarm handling on unconditionally. It might have
2011 been turned off in process.c. */
2012 turn_on_atimers (1);
2014 /* If poll timer doesn't exist, are we need one with
2015 a different interval, start a new one. */
2016 if (poll_timer
== NULL
2017 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2019 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2020 EMACS_TIME interval
;
2023 cancel_atimer (poll_timer
);
2025 EMACS_SET_SECS_USECS (interval
, period
, 0);
2026 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2027 poll_for_input
, NULL
);
2030 /* Let the timer's callback function poll for input
2031 if this becomes zero. */
2032 --poll_suppress_count
;
2037 /* Nonzero if we are using polling to handle input asynchronously. */
2040 input_polling_used (void)
2042 #ifdef POLL_FOR_INPUT
2043 /* XXX This condition was (read_socket_hook && !interrupt_input),
2044 but read_socket_hook is not global anymore. Let's pretend that
2046 return !interrupt_input
;
2052 /* Turn off polling. */
2057 #ifdef POLL_FOR_INPUT
2058 /* XXX This condition was (read_socket_hook && !interrupt_input),
2059 but read_socket_hook is not global anymore. Let's pretend that
2061 if (!interrupt_input
)
2062 ++poll_suppress_count
;
2066 /* Set the value of poll_suppress_count to COUNT
2067 and start or stop polling accordingly. */
2070 set_poll_suppress_count (int count
)
2072 #ifdef POLL_FOR_INPUT
2073 if (count
== 0 && poll_suppress_count
!= 0)
2075 poll_suppress_count
= 1;
2078 else if (count
!= 0 && poll_suppress_count
== 0)
2082 poll_suppress_count
= count
;
2086 /* Bind polling_period to a value at least N.
2087 But don't decrease it. */
2090 bind_polling_period (int n
)
2092 #ifdef POLL_FOR_INPUT
2093 EMACS_INT
new = polling_period
;
2098 stop_other_atimers (poll_timer
);
2100 specbind (Qpolling_period
, make_number (new));
2101 /* Start a new alarm with the new period. */
2106 /* Apply the control modifier to CHARACTER. */
2109 make_ctrl_char (int c
)
2111 /* Save the upper bits here. */
2112 int upper
= c
& ~0177;
2114 if (! ASCII_BYTE_P (c
))
2115 return c
|= ctrl_modifier
;
2119 /* Everything in the columns containing the upper-case letters
2120 denotes a control character. */
2121 if (c
>= 0100 && c
< 0140)
2125 /* Set the shift modifier for a control char
2126 made from a shifted letter. But only for letters! */
2127 if (oc
>= 'A' && oc
<= 'Z')
2128 c
|= shift_modifier
;
2131 /* The lower-case letters denote control characters too. */
2132 else if (c
>= 'a' && c
<= 'z')
2135 /* Include the bits for control and shift
2136 only if the basic ASCII code can't indicate them. */
2140 /* Replace the high bits. */
2141 c
|= (upper
& ~ctrl_modifier
);
2146 /* Display the help-echo property of the character after the mouse pointer.
2147 Either show it in the echo area, or call show-help-function to display
2148 it by other means (maybe in a tooltip).
2150 If HELP is nil, that means clear the previous help echo.
2152 If HELP is a string, display that string. If HELP is a function,
2153 call it with OBJECT and POS as arguments; the function should
2154 return a help string or nil for none. For all other types of HELP,
2155 evaluate it to obtain a string.
2157 WINDOW is the window in which the help was generated, if any.
2158 It is nil if not in a window.
2160 If OBJECT is a buffer, POS is the position in the buffer where the
2161 `help-echo' text property was found.
2163 If OBJECT is an overlay, that overlay has a `help-echo' property,
2164 and POS is the position in the overlay's buffer under the mouse.
2166 If OBJECT is a string (an overlay string or a string displayed with
2167 the `display' property). POS is the position in that string under
2170 Note: this function may only be called with HELP nil or a string
2171 from X code running asynchronously. */
2174 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2177 if (!NILP (help
) && !STRINGP (help
))
2179 if (FUNCTIONP (help
))
2181 Lisp_Object args
[4];
2186 help
= safe_call (4, args
);
2189 help
= safe_eval (help
);
2191 if (!STRINGP (help
))
2195 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2196 if (!noninteractive
&& STRINGP (help
))
2198 /* The mouse-fixup-help-message Lisp function can call
2199 mouse_position_hook, which resets the mouse_moved flags.
2200 This causes trouble if we are trying to read a mouse motion
2201 event (i.e., if we are inside a `track-mouse' form), so we
2202 restore the mouse_moved flag. */
2203 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2204 help
= call1 (Qmouse_fixup_help_message
, help
);
2210 if (STRINGP (help
) || NILP (help
))
2212 if (!NILP (Vshow_help_function
))
2213 call1 (Vshow_help_function
, help
);
2214 help_echo_showing_p
= STRINGP (help
);
2220 /* Input of single characters from keyboard */
2222 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2223 EMACS_TIME
*end_time
);
2224 static void record_char (Lisp_Object c
);
2226 static Lisp_Object help_form_saved_window_configs
;
2228 read_char_help_form_unwind (Lisp_Object arg
)
2230 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2231 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2232 if (!NILP (window_config
))
2233 Fset_window_configuration (window_config
);
2237 #define STOP_POLLING \
2238 do { if (! polling_stopped_here) stop_polling (); \
2239 polling_stopped_here = 1; } while (0)
2241 #define RESUME_POLLING \
2242 do { if (polling_stopped_here) start_polling (); \
2243 polling_stopped_here = 0; } while (0)
2245 /* read a character from the keyboard; call the redisplay if needed */
2246 /* commandflag 0 means do not autosave, but do redisplay.
2247 -1 means do not redisplay, but do autosave.
2250 /* The arguments MAPS and NMAPS are for menu prompting.
2251 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2253 PREV_EVENT is the previous input event, or nil if we are reading
2254 the first event of a key sequence (or not reading a key sequence).
2255 If PREV_EVENT is t, that is a "magic" value that says
2256 not to run input methods, but in other respects to act as if
2257 not reading a key sequence.
2259 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2260 if we used a mouse menu to read the input, or zero otherwise. If
2261 USED_MOUSE_MENU is null, we don't dereference it.
2263 Value is -2 when we find input on another keyboard. A second call
2264 to read_char will read it.
2266 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2267 specifying the maximum time to wait until. If no input arrives by
2268 that time, stop waiting and return nil.
2270 Value is t if we showed a menu and the user rejected it. */
2273 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2274 Lisp_Object prev_event
,
2275 int *used_mouse_menu
, EMACS_TIME
*end_time
)
2277 volatile Lisp_Object c
;
2279 jmp_buf local_getcjmp
;
2281 volatile int key_already_recorded
= 0;
2282 Lisp_Object tem
, save
;
2283 volatile Lisp_Object previous_echo_area_message
;
2284 volatile Lisp_Object also_record
;
2285 volatile int reread
;
2286 struct gcpro gcpro1
, gcpro2
;
2287 int volatile polling_stopped_here
= 0;
2288 struct kboard
*orig_kboard
= current_kboard
;
2292 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2293 before_command_key_count
= this_command_key_count
;
2294 before_command_echo_length
= echo_length ();
2297 previous_echo_area_message
= Qnil
;
2299 GCPRO2 (c
, previous_echo_area_message
);
2304 if (CONSP (Vunread_post_input_method_events
))
2306 c
= XCAR (Vunread_post_input_method_events
);
2307 Vunread_post_input_method_events
2308 = XCDR (Vunread_post_input_method_events
);
2310 /* Undo what read_char_x_menu_prompt did when it unread
2311 additional keys returned by Fx_popup_menu. */
2313 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2321 if (unread_command_char
!= -1)
2323 XSETINT (c
, unread_command_char
);
2324 unread_command_char
= -1;
2330 if (CONSP (Vunread_command_events
))
2332 int was_disabled
= 0;
2334 c
= XCAR (Vunread_command_events
);
2335 Vunread_command_events
= XCDR (Vunread_command_events
);
2339 /* Undo what sit-for did when it unread additional keys
2340 inside universal-argument. */
2343 && EQ (XCAR (c
), Qt
))
2349 /* Undo what read_char_x_menu_prompt did when it unread
2350 additional keys returned by Fx_popup_menu. */
2352 && EQ (XCDR (c
), Qdisabled
)
2353 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2359 /* If the queued event is something that used the mouse,
2360 set used_mouse_menu accordingly. */
2362 /* Also check was_disabled so last-nonmenu-event won't return
2363 a bad value when submenus are involved. (Bug#447) */
2364 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2365 *used_mouse_menu
= 1;
2367 goto reread_for_input_method
;
2370 if (CONSP (Vunread_input_method_events
))
2372 c
= XCAR (Vunread_input_method_events
);
2373 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2375 /* Undo what read_char_x_menu_prompt did when it unread
2376 additional keys returned by Fx_popup_menu. */
2378 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2382 goto reread_for_input_method
;
2385 this_command_key_count_reset
= 0;
2387 if (!NILP (Vexecuting_kbd_macro
))
2389 /* We set this to Qmacro; since that's not a frame, nobody will
2390 try to switch frames on us, and the selected window will
2393 Since this event came from a macro, it would be misleading to
2394 leave internal_last_event_frame set to wherever the last
2395 real event came from. Normally, a switch-frame event selects
2396 internal_last_event_frame after each command is read, but
2397 events read from a macro should never cause a new frame to be
2399 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2401 /* Exit the macro if we are at the end.
2402 Also, some things replace the macro with t
2403 to force an early exit. */
2404 if (EQ (Vexecuting_kbd_macro
, Qt
)
2405 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2411 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2412 if (STRINGP (Vexecuting_kbd_macro
)
2413 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2414 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2416 executing_kbd_macro_index
++;
2421 if (!NILP (unread_switch_frame
))
2423 c
= unread_switch_frame
;
2424 unread_switch_frame
= Qnil
;
2426 /* This event should make it into this_command_keys, and get echoed
2427 again, so we do not set `reread'. */
2431 /* if redisplay was requested */
2432 if (commandflag
>= 0)
2434 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2436 /* If there is pending input, process any events which are not
2437 user-visible, such as X selection_request events. */
2439 || detect_input_pending_run_timers (0))
2440 swallow_events (0); /* may clear input_pending */
2442 /* Redisplay if no pending input. */
2443 while (!input_pending
)
2445 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2446 redisplay_preserve_echo_area (5);
2451 /* Normal case: no input arrived during redisplay. */
2454 /* Input arrived and pre-empted redisplay.
2455 Process any events which are not user-visible. */
2457 /* If that cleared input_pending, try again to redisplay. */
2460 /* Prevent the redisplay we just did
2461 from messing up echoing of the input after the prompt. */
2462 if (commandflag
== 0 && echo_current
)
2463 echo_message_buffer
= echo_area_buffer
[0];
2467 /* Message turns off echoing unless more keystrokes turn it on again.
2469 The code in 20.x for the condition was
2471 1. echo_area_glyphs && *echo_area_glyphs
2472 2. && echo_area_glyphs != current_kboard->echobuf
2473 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2475 (1) means there's a current message displayed
2477 (2) means it's not the message from echoing from the current
2480 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2481 is set to a non-null value. This is done in read_char and it is
2482 set to echo_area_glyphs after a call to echo_char. That means
2483 ok_to_echo_at_next_pause is either null or
2484 current_kboard->echobuf with the appropriate current_kboard at
2487 So, condition (3) means in clear text ok_to_echo_at_next_pause
2488 must be either null, or the current message isn't from echoing at
2489 all, or it's from echoing from a different kboard than the
2492 if (/* There currently is something in the echo area. */
2493 !NILP (echo_area_buffer
[0])
2494 && (/* And it's either not from echoing. */
2495 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2496 /* Or it's an echo from a different kboard. */
2497 || echo_kboard
!= current_kboard
2498 /* Or we explicitly allow overwriting whatever there is. */
2499 || ok_to_echo_at_next_pause
== NULL
))
2504 /* Try reading a character via menu prompting in the minibuf.
2505 Try this before the sit-for, because the sit-for
2506 would do the wrong thing if we are supposed to do
2507 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2508 after a mouse event so don't try a minibuf menu. */
2510 if (nmaps
> 0 && INTERACTIVE
2511 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2512 /* Don't bring up a menu if we already have another event. */
2513 && NILP (Vunread_command_events
)
2514 && unread_command_char
< 0
2515 && !detect_input_pending_run_timers (0))
2517 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2519 if (INTEGERP (c
) && XINT (c
) == -2)
2520 return c
; /* wrong_kboard_jmpbuf */
2524 key_already_recorded
= 1;
2529 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2530 We will do that below, temporarily for short sections of code,
2531 when appropriate. local_getcjmp must be in effect
2532 around any call to sit_for or kbd_buffer_get_event;
2533 it *must not* be in effect when we call redisplay. */
2535 jmpcount
= SPECPDL_INDEX ();
2536 if (_setjmp (local_getcjmp
))
2538 /* Handle quits while reading the keyboard. */
2539 /* We must have saved the outer value of getcjmp here,
2540 so restore it now. */
2541 restore_getcjmp (save_jump
);
2542 unbind_to (jmpcount
, Qnil
);
2543 XSETINT (c
, quit_char
);
2544 internal_last_event_frame
= selected_frame
;
2545 Vlast_event_frame
= internal_last_event_frame
;
2546 /* If we report the quit char as an event,
2547 don't do so more than once. */
2548 if (!NILP (Vinhibit_quit
))
2552 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2553 if (kb
!= current_kboard
)
2555 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2556 /* We shouldn't get here if we were in single-kboard mode! */
2561 while (CONSP (XCDR (last
)))
2563 if (!NILP (XCDR (last
)))
2567 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2569 XSETCDR (last
, Fcons (c
, Qnil
));
2570 kb
->kbd_queue_has_data
= 1;
2571 current_kboard
= kb
;
2572 /* This is going to exit from read_char
2573 so we had better get rid of this frame's stuff. */
2575 return make_number (-2); /* wrong_kboard_jmpbuf */
2581 /* Start idle timers if no time limit is supplied. We don't do it
2582 if a time limit is supplied to avoid an infinite recursion in the
2583 situation where an idle timer calls `sit-for'. */
2586 timer_start_idle ();
2588 /* If in middle of key sequence and minibuffer not active,
2589 start echoing if enough time elapses. */
2591 if (minibuf_level
== 0
2593 && !current_kboard
->immediate_echo
2594 && this_command_key_count
> 0
2596 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2597 && NILP (Fzerop (Vecho_keystrokes
))
2598 && (/* No message. */
2599 NILP (echo_area_buffer
[0])
2600 /* Or empty message. */
2601 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2602 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2603 /* Or already echoing from same kboard. */
2604 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2605 /* Or not echoing before and echoing allowed. */
2606 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2608 /* After a mouse event, start echoing right away.
2609 This is because we are probably about to display a menu,
2610 and we don't want to delay before doing so. */
2611 if (EVENT_HAS_PARAMETERS (prev_event
))
2617 save_getcjmp (save_jump
);
2618 restore_getcjmp (local_getcjmp
);
2619 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2620 restore_getcjmp (save_jump
);
2622 && ! CONSP (Vunread_command_events
))
2627 /* Maybe auto save due to number of keystrokes. */
2629 if (commandflag
!= 0
2630 && auto_save_interval
> 0
2631 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2632 && !detect_input_pending_run_timers (0))
2634 Fdo_auto_save (Qnil
, Qnil
);
2635 /* Hooks can actually change some buffers in auto save. */
2639 /* Try reading using an X menu.
2640 This is never confused with reading using the minibuf
2641 because the recursive call of read_char in read_char_minibuf_menu_prompt
2642 does not pass on any keymaps. */
2644 if (nmaps
> 0 && INTERACTIVE
2645 && !NILP (prev_event
)
2646 && EVENT_HAS_PARAMETERS (prev_event
)
2647 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2648 && !EQ (XCAR (prev_event
), Qtool_bar
)
2649 /* Don't bring up a menu if we already have another event. */
2650 && NILP (Vunread_command_events
)
2651 && unread_command_char
< 0)
2653 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2655 /* Now that we have read an event, Emacs is not idle. */
2662 /* Maybe autosave and/or garbage collect due to idleness. */
2664 if (INTERACTIVE
&& NILP (c
))
2667 ptrdiff_t buffer_size
;
2669 /* Slow down auto saves logarithmically in size of current buffer,
2670 and garbage collect while we're at it. */
2671 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2672 last_non_minibuf_size
= Z
- BEG
;
2673 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2675 while (buffer_size
> 64)
2676 delay_level
++, buffer_size
-= buffer_size
>> 2;
2677 if (delay_level
< 4) delay_level
= 4;
2678 /* delay_level is 4 for files under around 50k, 7 at 100k,
2679 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2681 /* Auto save if enough time goes by without input. */
2682 if (commandflag
!= 0
2683 && num_nonmacro_input_events
> last_auto_save
2684 && INTEGERP (Vauto_save_timeout
)
2685 && XINT (Vauto_save_timeout
) > 0)
2688 EMACS_INT timeout
= (delay_level
2689 * min (XFASTINT (Vauto_save_timeout
) / 4,
2690 MOST_POSITIVE_FIXNUM
/ delay_level
));
2691 save_getcjmp (save_jump
);
2692 restore_getcjmp (local_getcjmp
);
2693 tem0
= sit_for (make_number (timeout
), 1, 1);
2694 restore_getcjmp (save_jump
);
2697 && ! CONSP (Vunread_command_events
))
2699 Fdo_auto_save (Qnil
, Qnil
);
2701 /* If we have auto-saved and there is still no input
2702 available, garbage collect if there has been enough
2703 consing going on to make it worthwhile. */
2704 if (!detect_input_pending_run_timers (0)
2705 && consing_since_gc
> gc_cons_threshold
/ 2)
2706 Fgarbage_collect ();
2713 /* Notify the caller if an autosave hook, or a timer, sentinel or
2714 filter in the sit_for calls above have changed the current
2715 kboard. This could happen if they use the minibuffer or start a
2716 recursive edit, like the fancy splash screen in server.el's
2717 filter. If this longjmp wasn't here, read_key_sequence would
2718 interpret the next key sequence using the wrong translation
2719 tables and function keymaps. */
2720 if (NILP (c
) && current_kboard
!= orig_kboard
)
2723 return make_number (-2); /* wrong_kboard_jmpbuf */
2726 /* If this has become non-nil here, it has been set by a timer
2727 or sentinel or filter. */
2728 if (CONSP (Vunread_command_events
))
2730 c
= XCAR (Vunread_command_events
);
2731 Vunread_command_events
= XCDR (Vunread_command_events
);
2734 /* Read something from current KBOARD's side queue, if possible. */
2738 if (current_kboard
->kbd_queue_has_data
)
2740 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2742 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2743 KVAR (current_kboard
, kbd_queue
)
2744 = XCDR (KVAR (current_kboard
, kbd_queue
));
2745 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2746 current_kboard
->kbd_queue_has_data
= 0;
2747 input_pending
= readable_events (0);
2748 if (EVENT_HAS_PARAMETERS (c
)
2749 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2750 internal_last_event_frame
= XCAR (XCDR (c
));
2751 Vlast_event_frame
= internal_last_event_frame
;
2755 /* If current_kboard's side queue is empty check the other kboards.
2756 If one of them has data that we have not yet seen here,
2757 switch to it and process the data waiting for it.
2759 Note: if the events queued up for another kboard
2760 have already been seen here, and therefore are not a complete command,
2761 the kbd_queue_has_data field is 0, so we skip that kboard here.
2762 That's to avoid an infinite loop switching between kboards here. */
2763 if (NILP (c
) && !single_kboard
)
2766 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2767 if (kb
->kbd_queue_has_data
)
2769 current_kboard
= kb
;
2770 /* This is going to exit from read_char
2771 so we had better get rid of this frame's stuff. */
2773 return make_number (-2); /* wrong_kboard_jmpbuf */
2781 /* Finally, we read from the main queue,
2782 and if that gives us something we can't use yet, we put it on the
2783 appropriate side queue and try again. */
2787 KBOARD
*kb
IF_LINT (= NULL
);
2792 EMACS_GET_TIME (now
);
2793 if (EMACS_TIME_GE (now
, *end_time
))
2797 /* Actually read a character, waiting if necessary. */
2798 save_getcjmp (save_jump
);
2799 restore_getcjmp (local_getcjmp
);
2801 timer_start_idle ();
2802 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2803 restore_getcjmp (save_jump
);
2805 if (! NILP (c
) && (kb
!= current_kboard
))
2807 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2810 while (CONSP (XCDR (last
)))
2812 if (!NILP (XCDR (last
)))
2816 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2818 XSETCDR (last
, Fcons (c
, Qnil
));
2819 kb
->kbd_queue_has_data
= 1;
2823 current_kboard
= kb
;
2824 /* This is going to exit from read_char
2825 so we had better get rid of this frame's stuff. */
2827 return make_number (-2);
2831 /* Terminate Emacs in batch mode if at eof. */
2832 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2833 Fkill_emacs (make_number (1));
2837 /* Add in any extra modifiers, where appropriate. */
2838 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2839 || ((extra_keyboard_modifiers
& 0177) < ' '
2840 && (extra_keyboard_modifiers
& 0177) != 0))
2841 XSETINT (c
, make_ctrl_char (XINT (c
)));
2843 /* Transfer any other modifier bits directly from
2844 extra_keyboard_modifiers to c. Ignore the actual character code
2845 in the low 16 bits of extra_keyboard_modifiers. */
2846 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2857 if (commandflag
>= 0
2858 && !input_pending
&& !detect_input_pending_run_timers (0))
2866 /* Buffer switch events are only for internal wakeups
2867 so don't show them to the user.
2868 Also, don't record a key if we already did. */
2869 if (BUFFERP (c
) || key_already_recorded
)
2872 /* Process special events within read_char
2873 and loop around to read another event. */
2876 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2881 struct buffer
*prev_buffer
= current_buffer
;
2882 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2883 int was_locked
= single_kboard
;
2884 ptrdiff_t count
= SPECPDL_INDEX ();
2885 record_single_kboard_state ();
2888 last_input_event
= c
;
2889 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2891 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2892 /* We stopped being idle for this event; undo that. This
2893 prevents automatic window selection (under
2894 mouse_autoselect_window from acting as a real input event, for
2895 example banishing the mouse under mouse-avoidance-mode. */
2896 timer_resume_idle ();
2898 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2899 /* Resume allowing input from any kboard, if that was true before. */
2901 any_kboard_state ();
2902 unbind_to (count
, Qnil
);
2905 if (current_buffer
!= prev_buffer
)
2907 /* The command may have changed the keymaps. Pretend there
2908 is input in another keyboard and return. This will
2909 recalculate keymaps. */
2910 c
= make_number (-2);
2917 /* Handle things that only apply to characters. */
2920 /* If kbd_buffer_get_event gave us an EOF, return that. */
2924 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2925 && UNSIGNED_CMP (XFASTINT (c
), <,
2926 SCHARS (KVAR (current_kboard
,
2927 Vkeyboard_translate_table
))))
2928 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2929 && UNSIGNED_CMP (XFASTINT (c
), <,
2930 ASIZE (KVAR (current_kboard
,
2931 Vkeyboard_translate_table
))))
2932 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2936 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2937 /* nil in keyboard-translate-table means no translation. */
2943 /* If this event is a mouse click in the menu bar,
2944 return just menu-bar for now. Modify the mouse click event
2945 so we won't do this twice, then queue it up. */
2946 if (EVENT_HAS_PARAMETERS (c
)
2948 && CONSP (EVENT_START (c
))
2949 && CONSP (XCDR (EVENT_START (c
))))
2953 posn
= POSN_POSN (EVENT_START (c
));
2954 /* Handle menu-bar events:
2955 insert the dummy prefix event `menu-bar'. */
2956 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2958 /* Change menu-bar to (menu-bar) as the event "position". */
2959 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2962 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2967 /* Store these characters into recent_keys, the dribble file if any,
2968 and the keyboard macro being defined, if any. */
2970 if (! NILP (also_record
))
2971 record_char (also_record
);
2973 /* Wipe the echo area.
2974 But first, if we are about to use an input method,
2975 save the echo area contents for it to refer to. */
2977 && ! NILP (Vinput_method_function
)
2978 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2980 previous_echo_area_message
= Fcurrent_message ();
2981 Vinput_method_previous_message
= previous_echo_area_message
;
2984 /* Now wipe the echo area, except for help events which do their
2985 own stuff with the echo area. */
2987 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2988 && !(EQ (Qswitch_frame
, XCAR (c
)))
2989 /* Don't wipe echo area for select window events: These might
2990 get delayed via `mouse-autoselect-window' (Bug#11304). */
2991 && !(EQ (Qselect_window
, XCAR (c
)))))
2993 if (!NILP (echo_area_buffer
[0]))
2995 safe_run_hooks (Qecho_area_clear_hook
);
2996 clear_message (1, 0);
3000 reread_for_input_method
:
3002 /* Pass this to the input method, if appropriate. */
3004 && ! NILP (Vinput_method_function
)
3005 /* Don't run the input method within a key sequence,
3006 after the first event of the key sequence. */
3007 && NILP (prev_event
)
3008 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3011 ptrdiff_t key_count
;
3012 int key_count_reset
;
3013 struct gcpro gcpro1
;
3014 ptrdiff_t count
= SPECPDL_INDEX ();
3016 /* Save the echo status. */
3017 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3018 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3019 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3020 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3023 if (before_command_restore_flag
)
3025 this_command_key_count
= before_command_key_count_1
;
3026 if (this_command_key_count
< this_single_command_key_start
)
3027 this_single_command_key_start
= this_command_key_count
;
3028 echo_truncate (before_command_echo_length_1
);
3029 before_command_restore_flag
= 0;
3033 /* Save the this_command_keys status. */
3034 key_count
= this_command_key_count
;
3035 key_count_reset
= this_command_key_count_reset
;
3038 keys
= Fcopy_sequence (this_command_keys
);
3043 /* Clear out this_command_keys. */
3044 this_command_key_count
= 0;
3045 this_command_key_count_reset
= 0;
3047 /* Now wipe the echo area. */
3048 if (!NILP (echo_area_buffer
[0]))
3049 safe_run_hooks (Qecho_area_clear_hook
);
3050 clear_message (1, 0);
3053 /* If we are not reading a key sequence,
3054 never use the echo area. */
3057 specbind (Qinput_method_use_echo_area
, Qt
);
3060 /* Call the input method. */
3061 tem
= call1 (Vinput_method_function
, c
);
3063 tem
= unbind_to (count
, tem
);
3065 /* Restore the saved echoing state
3066 and this_command_keys state. */
3067 this_command_key_count
= key_count
;
3068 this_command_key_count_reset
= key_count_reset
;
3070 this_command_keys
= keys
;
3073 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3074 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3075 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3076 if (saved_immediate_echo
)
3081 /* The input method can return no events. */
3084 /* Bring back the previous message, if any. */
3085 if (! NILP (previous_echo_area_message
))
3086 message_with_string ("%s", previous_echo_area_message
, 0);
3089 /* It returned one event or more. */
3091 Vunread_post_input_method_events
3092 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3097 /* Display help if not echoing. */
3098 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3100 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3101 Lisp_Object help
, object
, position
, window
, htem
;
3103 htem
= Fcdr (XCDR (c
));
3106 window
= Fcar (htem
);
3108 object
= Fcar (htem
);
3110 position
= Fcar (htem
);
3112 show_help_echo (help
, window
, object
, position
);
3114 /* We stopped being idle for this event; undo that. */
3116 timer_resume_idle ();
3120 if ((! reread
|| this_command_key_count
== 0
3121 || this_command_key_count_reset
)
3125 /* Don't echo mouse motion events. */
3126 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3127 && NILP (Fzerop (Vecho_keystrokes
))
3128 && ! (EVENT_HAS_PARAMETERS (c
)
3129 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3132 if (! NILP (also_record
))
3133 echo_char (also_record
);
3134 /* Once we reread a character, echoing can happen
3135 the next time we pause to read a new one. */
3136 ok_to_echo_at_next_pause
= current_kboard
;
3139 /* Record this character as part of the current key. */
3140 add_command_key (c
);
3141 if (! NILP (also_record
))
3142 add_command_key (also_record
);
3145 last_input_event
= c
;
3148 /* Process the help character specially if enabled */
3149 if (!NILP (Vhelp_form
) && help_char_p (c
))
3151 ptrdiff_t count
= SPECPDL_INDEX ();
3153 help_form_saved_window_configs
3154 = Fcons (Fcurrent_window_configuration (Qnil
),
3155 help_form_saved_window_configs
);
3156 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3157 call0 (Qhelp_form_show
);
3162 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3163 if (EVENT_HAS_PARAMETERS (c
)
3164 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3165 XSETCAR (help_form_saved_window_configs
, Qnil
);
3167 while (BUFFERP (c
));
3168 /* Remove the help from the frame */
3169 unbind_to (count
, Qnil
);
3172 if (EQ (c
, make_number (040)))
3176 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3177 while (BUFFERP (c
));
3186 /* Record a key that came from a mouse menu.
3187 Record it for echoing, for this-command-keys, and so on. */
3190 record_menu_key (Lisp_Object c
)
3192 /* Wipe the echo area. */
3193 clear_message (1, 0);
3198 before_command_key_count
= this_command_key_count
;
3199 before_command_echo_length
= echo_length ();
3202 /* Don't echo mouse motion events. */
3203 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3204 && NILP (Fzerop (Vecho_keystrokes
)))
3208 /* Once we reread a character, echoing can happen
3209 the next time we pause to read a new one. */
3210 ok_to_echo_at_next_pause
= 0;
3213 /* Record this character as part of the current key. */
3214 add_command_key (c
);
3216 /* Re-reading in the middle of a command */
3217 last_input_event
= c
;
3221 /* Return 1 if should recognize C as "the help character". */
3224 help_char_p (Lisp_Object c
)
3228 if (EQ (c
, Vhelp_char
))
3230 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3231 if (EQ (c
, XCAR (tail
)))
3236 /* Record the input event C in various ways. */
3239 record_char (Lisp_Object c
)
3243 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3245 /* To avoid filling recent_keys with help-echo and mouse-movement
3246 events, we filter out repeated help-echo events, only store the
3247 first and last in a series of mouse-movement events, and don't
3248 store repeated help-echo events which are only separated by
3249 mouse-movement events. */
3251 Lisp_Object ev1
, ev2
, ev3
;
3254 if ((ix1
= recent_keys_index
- 1) < 0)
3255 ix1
= NUM_RECENT_KEYS
- 1;
3256 ev1
= AREF (recent_keys
, ix1
);
3258 if ((ix2
= ix1
- 1) < 0)
3259 ix2
= NUM_RECENT_KEYS
- 1;
3260 ev2
= AREF (recent_keys
, ix2
);
3262 if ((ix3
= ix2
- 1) < 0)
3263 ix3
= NUM_RECENT_KEYS
- 1;
3264 ev3
= AREF (recent_keys
, ix3
);
3266 if (EQ (XCAR (c
), Qhelp_echo
))
3268 /* Don't record `help-echo' in recent_keys unless it shows some help
3269 message, and a different help than the previously recorded
3271 Lisp_Object help
, last_help
;
3273 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3274 if (!STRINGP (help
))
3276 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3277 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3279 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3280 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3281 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3283 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3284 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3285 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3286 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3289 else if (EQ (XCAR (c
), Qmouse_movement
))
3291 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3292 So additional mouse movement events replace the last element. */
3293 Lisp_Object last_window
, window
;
3295 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3296 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3297 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3298 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3299 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3301 ASET (recent_keys
, ix1
, c
);
3307 store_kbd_macro_char (c
);
3311 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3312 ASET (recent_keys
, recent_keys_index
, c
);
3313 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3314 recent_keys_index
= 0;
3316 else if (recorded
< 0)
3318 /* We need to remove one or two events from recent_keys.
3319 To do this, we simply put nil at those events and move the
3320 recent_keys_index backwards over those events. Usually,
3321 users will never see those nil events, as they will be
3322 overwritten by the command keys entered to see recent_keys
3325 while (recorded
++ < 0 && total_keys
> 0)
3327 if (total_keys
< NUM_RECENT_KEYS
)
3329 if (--recent_keys_index
< 0)
3330 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3331 ASET (recent_keys
, recent_keys_index
, Qnil
);
3335 num_nonmacro_input_events
++;
3337 /* Write c to the dribble file. If c is a lispy event, write
3338 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3339 If you, dear reader, have a better idea, you've got the source. :-) */
3345 if (XUINT (c
) < 0x100)
3346 putc (XUINT (c
), dribble
);
3348 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3352 Lisp_Object dribblee
;
3354 /* If it's a structured event, take the event header. */
3355 dribblee
= EVENT_HEAD (c
);
3357 if (SYMBOLP (dribblee
))
3359 putc ('<', dribble
);
3360 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3361 SBYTES (SYMBOL_NAME (dribblee
)),
3363 putc ('>', dribble
);
3372 /* Copy out or in the info on where C-g should throw to.
3373 This is used when running Lisp code from within get_char,
3374 in case get_char is called recursively.
3375 See read_process_output. */
3378 save_getcjmp (jmp_buf temp
)
3380 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3384 restore_getcjmp (jmp_buf temp
)
3386 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3389 /* Low level keyboard/mouse input.
3390 kbd_buffer_store_event places events in kbd_buffer, and
3391 kbd_buffer_get_event retrieves them. */
3393 /* Return true if there are any events in the queue that read-char
3394 would return. If this returns false, a read-char would block. */
3396 readable_events (int flags
)
3398 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3401 /* If the buffer contains only FOCUS_IN_EVENT events, and
3402 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3403 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3405 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3406 #ifdef USE_TOOLKIT_SCROLL_BARS
3407 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3411 struct input_event
*event
;
3413 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3420 #ifdef USE_TOOLKIT_SCROLL_BARS
3421 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3423 event
->kind
== FOCUS_IN_EVENT
)
3424 #ifdef USE_TOOLKIT_SCROLL_BARS
3425 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3426 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3427 && event
->part
== scroll_bar_handle
3428 && event
->modifiers
== 0)
3433 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3436 while (event
!= kbd_store_ptr
);
3442 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3443 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3444 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3449 if (current_kboard
->kbd_queue_has_data
)
3455 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3456 if (kb
->kbd_queue_has_data
)
3462 /* Set this for debugging, to have a way to get out */
3463 int stop_character EXTERNALLY_VISIBLE
;
3466 event_to_kboard (struct input_event
*event
)
3469 frame
= event
->frame_or_window
;
3471 frame
= XCAR (frame
);
3472 else if (WINDOWP (frame
))
3473 frame
= WINDOW_FRAME (XWINDOW (frame
));
3475 /* There are still some events that don't set this field.
3476 For now, just ignore the problem.
3477 Also ignore dead frames here. */
3478 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3481 return FRAME_KBOARD (XFRAME (frame
));
3485 /* Return the number of slots occupied in kbd_buffer. */
3488 kbd_buffer_nr_stored (void)
3490 return kbd_fetch_ptr
== kbd_store_ptr
3492 : (kbd_fetch_ptr
< kbd_store_ptr
3493 ? kbd_store_ptr
- kbd_fetch_ptr
3494 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3495 + (kbd_store_ptr
- kbd_buffer
)));
3497 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3500 kbd_buffer_store_event (register struct input_event
*event
)
3502 kbd_buffer_store_event_hold (event
, 0);
3505 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3507 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3508 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3509 Else, if EVENT is a quit event, store the quit event
3510 in HOLD_QUIT, and return (thus ignoring further events).
3512 This is used in read_avail_input to postpone the processing
3513 of the quit event until all subsequent input events have been
3514 parsed (and discarded).
3518 kbd_buffer_store_event_hold (register struct input_event
*event
,
3519 struct input_event
*hold_quit
)
3521 if (event
->kind
== NO_EVENT
)
3524 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3527 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3529 register int c
= event
->code
& 0377;
3531 if (event
->modifiers
& ctrl_modifier
)
3532 c
= make_ctrl_char (c
);
3534 c
|= (event
->modifiers
3535 & (meta_modifier
| alt_modifier
3536 | hyper_modifier
| super_modifier
));
3540 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3541 struct input_event
*sp
;
3543 if (single_kboard
&& kb
!= current_kboard
)
3545 KVAR (kb
, kbd_queue
)
3546 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3547 Fcons (make_number (c
), Qnil
));
3548 kb
->kbd_queue_has_data
= 1;
3549 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3551 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3554 if (event_to_kboard (sp
) == kb
)
3556 sp
->kind
= NO_EVENT
;
3557 sp
->frame_or_window
= Qnil
;
3566 memcpy (hold_quit
, event
, sizeof (*event
));
3570 /* If this results in a quit_char being returned to Emacs as
3571 input, set Vlast_event_frame properly. If this doesn't
3572 get returned to Emacs as an event, the next event read
3573 will set Vlast_event_frame again, so this is safe to do. */
3577 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3579 focus
= event
->frame_or_window
;
3580 internal_last_event_frame
= focus
;
3581 Vlast_event_frame
= focus
;
3584 last_event_timestamp
= event
->timestamp
;
3585 handle_interrupt ();
3589 if (c
&& c
== stop_character
)
3595 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3596 Just ignore the second one. */
3597 else if (event
->kind
== BUFFER_SWITCH_EVENT
3598 && kbd_fetch_ptr
!= kbd_store_ptr
3599 && ((kbd_store_ptr
== kbd_buffer
3600 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3601 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3604 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3605 kbd_store_ptr
= kbd_buffer
;
3607 /* Don't let the very last slot in the buffer become full,
3608 since that would make the two pointers equal,
3609 and that is indistinguishable from an empty buffer.
3610 Discard the event if it would fill the last slot. */
3611 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3613 *kbd_store_ptr
= *event
;
3616 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3618 /* Don't read keyboard input until we have processed kbd_buffer.
3619 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3620 hold_keyboard_input ();
3622 if (!noninteractive
)
3623 signal (SIGIO
, SIG_IGN
);
3627 #endif /* subprocesses */
3630 /* If we're inside while-no-input, and this event qualifies
3631 as input, set quit-flag to cause an interrupt. */
3632 if (!NILP (Vthrow_on_input
)
3633 && event
->kind
!= FOCUS_IN_EVENT
3634 && event
->kind
!= HELP_EVENT
3635 && event
->kind
!= DEICONIFY_EVENT
)
3637 Vquit_flag
= Vthrow_on_input
;
3638 /* If we're inside a function that wants immediate quits,
3640 if (immediate_quit
&& NILP (Vinhibit_quit
))
3650 /* Put an input event back in the head of the event queue. */
3653 kbd_buffer_unget_event (register struct input_event
*event
)
3655 if (kbd_fetch_ptr
== kbd_buffer
)
3656 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3658 /* Don't let the very last slot in the buffer become full, */
3659 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3662 *kbd_fetch_ptr
= *event
;
3667 /* Generate a HELP_EVENT input_event and store it in the keyboard
3670 HELP is the help form.
3672 FRAME and WINDOW are the frame and window where the help is
3673 generated. OBJECT is the Lisp object where the help was found (a
3674 buffer, a string, an overlay, or nil if neither from a string nor
3675 from a buffer). POS is the position within OBJECT where the help
3679 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3680 Lisp_Object object
, ptrdiff_t pos
)
3682 struct input_event event
;
3686 event
.kind
= HELP_EVENT
;
3687 event
.frame_or_window
= frame
;
3689 event
.x
= WINDOWP (window
) ? window
: frame
;
3692 kbd_buffer_store_event (&event
);
3696 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3699 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3701 struct input_event event
;
3703 event
.kind
= HELP_EVENT
;
3704 event
.frame_or_window
= frame
;
3709 kbd_buffer_store_event (&event
);
3713 /* Discard any mouse events in the event buffer by setting them to
3716 discard_mouse_events (void)
3718 struct input_event
*sp
;
3719 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3721 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3724 if (sp
->kind
== MOUSE_CLICK_EVENT
3725 || sp
->kind
== WHEEL_EVENT
3726 || sp
->kind
== HORIZ_WHEEL_EVENT
3728 || sp
->kind
== GPM_CLICK_EVENT
3730 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3732 sp
->kind
= NO_EVENT
;
3738 /* Return non-zero if there are any real events waiting in the event
3739 buffer, not counting `NO_EVENT's.
3741 If DISCARD is non-zero, discard NO_EVENT events at the front of
3742 the input queue, possibly leaving the input queue empty if there
3743 are no real input events. */
3746 kbd_buffer_events_waiting (int discard
)
3748 struct input_event
*sp
;
3750 for (sp
= kbd_fetch_ptr
;
3751 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3754 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3761 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3765 /* Clear input event EVENT. */
3768 clear_event (struct input_event
*event
)
3770 event
->kind
= NO_EVENT
;
3774 /* Read one event from the event buffer, waiting if necessary.
3775 The value is a Lisp object representing the event.
3776 The value is nil for an event that should be ignored,
3777 or that was handled here.
3778 We always read and discard one event. */
3781 kbd_buffer_get_event (KBOARD
**kbp
,
3782 int *used_mouse_menu
,
3783 EMACS_TIME
*end_time
)
3788 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3790 /* Start reading input again, we have processed enough so we can
3791 accept new events again. */
3792 unhold_keyboard_input ();
3794 if (!noninteractive
)
3795 signal (SIGIO
, input_available_signal
);
3799 #endif /* subprocesses */
3801 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3803 /* In case we are running as a daemon, only do this before
3804 detaching from the terminal. */
3805 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3809 *kbp
= current_kboard
;
3812 #endif /* ! HAVE_DBUS */
3814 /* Wait until there is input available. */
3817 /* Break loop if there's an unread command event. Needed in
3818 moused window autoselection which uses a timer to insert such
3820 if (CONSP (Vunread_command_events
))
3823 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3825 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3826 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3830 /* If the quit flag is set, then read_char will return
3831 quit_char, so that counts as "available input." */
3832 if (!NILP (Vquit_flag
))
3833 quit_throw_to_read_char (0);
3835 /* One way or another, wait until input is available; then, if
3836 interrupt handlers have not read it, read it now. */
3838 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3842 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3844 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3845 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3850 EMACS_TIME duration
;
3851 EMACS_GET_TIME (duration
);
3852 if (EMACS_TIME_GE (duration
, *end_time
))
3853 return Qnil
; /* Finished waiting. */
3856 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3857 wait_reading_process_output (min (EMACS_SECS (duration
),
3859 EMACS_NSECS (duration
),
3860 -1, 1, Qnil
, NULL
, 0);
3864 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3866 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3867 /* Pass 1 for EXPECT since we just waited to have input. */
3868 read_avail_input (1);
3871 if (CONSP (Vunread_command_events
))
3874 first
= XCAR (Vunread_command_events
);
3875 Vunread_command_events
= XCDR (Vunread_command_events
);
3876 *kbp
= current_kboard
;
3880 /* At this point, we know that there is a readable event available
3881 somewhere. If the event queue is empty, then there must be a
3882 mouse movement enabled and available. */
3883 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3885 struct input_event
*event
;
3887 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3891 last_event_timestamp
= event
->timestamp
;
3893 *kbp
= event_to_kboard (event
);
3895 *kbp
= current_kboard
; /* Better than returning null ptr? */
3899 /* These two kinds of events get special handling
3900 and don't actually appear to the command loop.
3901 We return nil for them. */
3902 if (event
->kind
== SELECTION_REQUEST_EVENT
3903 || event
->kind
== SELECTION_CLEAR_EVENT
)
3906 struct input_event copy
;
3908 /* Remove it from the buffer before processing it,
3909 since otherwise swallow_events will see it
3910 and process it again. */
3912 kbd_fetch_ptr
= event
+ 1;
3913 input_pending
= readable_events (0);
3914 x_handle_selection_event (©
);
3916 /* We're getting selection request events, but we don't have
3922 #if defined (HAVE_NS)
3923 else if (event
->kind
== NS_TEXT_EVENT
)
3925 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3926 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3928 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3929 kbd_fetch_ptr
= event
+ 1;
3930 if (used_mouse_menu
)
3931 *used_mouse_menu
= 1;
3935 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3936 || defined (HAVE_NS)
3937 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3939 /* Make an event (delete-frame (FRAME)). */
3940 obj
= Fcons (event
->frame_or_window
, Qnil
);
3941 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3942 kbd_fetch_ptr
= event
+ 1;
3945 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3946 || defined (HAVE_NS)
3947 else if (event
->kind
== ICONIFY_EVENT
)
3949 /* Make an event (iconify-frame (FRAME)). */
3950 obj
= Fcons (event
->frame_or_window
, Qnil
);
3951 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3952 kbd_fetch_ptr
= event
+ 1;
3954 else if (event
->kind
== DEICONIFY_EVENT
)
3956 /* Make an event (make-frame-visible (FRAME)). */
3957 obj
= Fcons (event
->frame_or_window
, Qnil
);
3958 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3959 kbd_fetch_ptr
= event
+ 1;
3962 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3964 /* The value doesn't matter here; only the type is tested. */
3965 XSETBUFFER (obj
, current_buffer
);
3966 kbd_fetch_ptr
= event
+ 1;
3968 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3969 || defined (HAVE_NS) || defined (USE_GTK)
3970 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3972 kbd_fetch_ptr
= event
+ 1;
3973 input_pending
= readable_events (0);
3974 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3975 x_activate_menubar (XFRAME (event
->frame_or_window
));
3978 #if defined (WINDOWSNT)
3979 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3981 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3982 obj
= Fcons (Qlanguage_change
,
3983 list3 (event
->frame_or_window
,
3984 make_number (event
->code
),
3985 make_number (event
->modifiers
)));
3986 kbd_fetch_ptr
= event
+ 1;
3989 else if (event
->kind
== SAVE_SESSION_EVENT
)
3991 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3992 kbd_fetch_ptr
= event
+ 1;
3994 /* Just discard these, by returning nil.
3995 With MULTI_KBOARD, these events are used as placeholders
3996 when we need to randomly delete events from the queue.
3997 (They shouldn't otherwise be found in the buffer,
3998 but on some machines it appears they do show up
3999 even without MULTI_KBOARD.) */
4000 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4001 mouse events during a popup-menu call. */
4002 else if (event
->kind
== NO_EVENT
)
4003 kbd_fetch_ptr
= event
+ 1;
4004 else if (event
->kind
== HELP_EVENT
)
4006 Lisp_Object object
, position
, help
, frame
, window
;
4008 frame
= event
->frame_or_window
;
4009 object
= event
->arg
;
4010 position
= make_number (event
->code
);
4013 clear_event (event
);
4015 kbd_fetch_ptr
= event
+ 1;
4016 if (!WINDOWP (window
))
4018 obj
= Fcons (Qhelp_echo
,
4019 list5 (frame
, help
, window
, object
, position
));
4021 else if (event
->kind
== FOCUS_IN_EVENT
)
4023 /* Notification of a FocusIn event. The frame receiving the
4024 focus is in event->frame_or_window. Generate a
4025 switch-frame event if necessary. */
4026 Lisp_Object frame
, focus
;
4028 frame
= event
->frame_or_window
;
4029 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4033 if (!EQ (frame
, internal_last_event_frame
)
4034 && !EQ (frame
, selected_frame
))
4035 obj
= make_lispy_switch_frame (frame
);
4036 internal_last_event_frame
= frame
;
4037 kbd_fetch_ptr
= event
+ 1;
4040 else if (event
->kind
== DBUS_EVENT
)
4042 obj
= make_lispy_event (event
);
4043 kbd_fetch_ptr
= event
+ 1;
4046 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4048 obj
= make_lispy_event (event
);
4049 kbd_fetch_ptr
= event
+ 1;
4053 /* If this event is on a different frame, return a switch-frame this
4054 time, and leave the event in the queue for next time. */
4058 frame
= event
->frame_or_window
;
4060 frame
= XCAR (frame
);
4061 else if (WINDOWP (frame
))
4062 frame
= WINDOW_FRAME (XWINDOW (frame
));
4064 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4068 if (! EQ (frame
, internal_last_event_frame
)
4069 && !EQ (frame
, selected_frame
))
4070 obj
= make_lispy_switch_frame (frame
);
4071 internal_last_event_frame
= frame
;
4073 /* If we didn't decide to make a switch-frame event, go ahead
4074 and build a real event from the queue entry. */
4078 obj
= make_lispy_event (event
);
4080 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4081 || defined (HAVE_NS) || defined (USE_GTK)
4082 /* If this was a menu selection, then set the flag to inhibit
4083 writing to last_nonmenu_event. Don't do this if the event
4084 we're returning is (menu-bar), though; that indicates the
4085 beginning of the menu sequence, and we might as well leave
4086 that as the `event with parameters' for this selection. */
4088 && !EQ (event
->frame_or_window
, event
->arg
)
4089 && (event
->kind
== MENU_BAR_EVENT
4090 || event
->kind
== TOOL_BAR_EVENT
))
4091 *used_mouse_menu
= 1;
4094 /* certain system events are non-key events */
4096 && event
->kind
== NS_NONKEY_EVENT
)
4097 *used_mouse_menu
= 1;
4100 /* Wipe out this event, to catch bugs. */
4101 clear_event (event
);
4102 kbd_fetch_ptr
= event
+ 1;
4106 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4107 /* Try generating a mouse motion event. */
4108 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4110 FRAME_PTR f
= some_mouse_moved ();
4111 Lisp_Object bar_window
;
4112 enum scroll_bar_part part
;
4116 *kbp
= current_kboard
;
4117 /* Note that this uses F to determine which terminal to look at.
4118 If there is no valid info, it does not store anything
4119 so x remains nil. */
4122 /* XXX Can f or mouse_position_hook be NULL here? */
4123 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4124 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4129 /* Decide if we should generate a switch-frame event. Don't
4130 generate switch-frame events for motion outside of all Emacs
4136 frame
= FRAME_FOCUS_FRAME (f
);
4138 XSETFRAME (frame
, f
);
4140 if (! EQ (frame
, internal_last_event_frame
)
4141 && !EQ (frame
, selected_frame
))
4142 obj
= make_lispy_switch_frame (frame
);
4143 internal_last_event_frame
= frame
;
4146 /* If we didn't decide to make a switch-frame event, go ahead and
4147 return a mouse-motion event. */
4148 if (!NILP (x
) && NILP (obj
))
4149 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4151 #endif /* HAVE_MOUSE || HAVE GPM */
4153 /* We were promised by the above while loop that there was
4154 something for us to read! */
4157 input_pending
= readable_events (0);
4159 Vlast_event_frame
= internal_last_event_frame
;
4164 /* Process any non-user-visible events (currently X selection events),
4165 without reading any user-visible events. */
4168 process_special_events (void)
4170 struct input_event
*event
;
4172 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4174 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4177 if (event
== kbd_store_ptr
)
4181 /* If we find a stored X selection request, handle it now. */
4182 if (event
->kind
== SELECTION_REQUEST_EVENT
4183 || event
->kind
== SELECTION_CLEAR_EVENT
)
4187 /* Remove the event from the fifo buffer before processing;
4188 otherwise swallow_events called recursively could see it
4189 and process it again. To do this, we move the events
4190 between kbd_fetch_ptr and EVENT one slot to the right,
4193 struct input_event copy
= *event
;
4194 struct input_event
*beg
4195 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4196 ? kbd_buffer
: kbd_fetch_ptr
;
4199 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4200 else if (event
< beg
)
4202 if (event
> kbd_buffer
)
4203 memmove (kbd_buffer
+ 1, kbd_buffer
,
4204 (event
- kbd_buffer
) * sizeof (struct input_event
));
4205 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4206 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4207 memmove (beg
+ 1, beg
,
4208 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4209 * sizeof (struct input_event
));
4212 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4213 kbd_fetch_ptr
= kbd_buffer
+ 1;
4217 /* X wants last_event_timestamp for selection ownership. */
4218 last_event_timestamp
= copy
.timestamp
;
4219 input_pending
= readable_events (0);
4220 x_handle_selection_event (©
);
4222 /* We're getting selection request events, but we don't have
4230 /* Process any events that are not user-visible, run timer events that
4231 are ripe, and return, without reading any user-visible events. */
4234 swallow_events (int do_display
)
4238 process_special_events ();
4240 old_timers_run
= timers_run
;
4241 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4243 if (timers_run
!= old_timers_run
&& do_display
)
4244 redisplay_preserve_echo_area (7);
4247 /* Record the start of when Emacs is idle,
4248 for the sake of running idle-time timers. */
4251 timer_start_idle (void)
4255 /* If we are already in the idle state, do nothing. */
4256 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4259 EMACS_GET_TIME (timer_idleness_start_time
);
4261 timer_last_idleness_start_time
= timer_idleness_start_time
;
4263 /* Mark all idle-time timers as once again candidates for running. */
4264 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4268 timer
= XCAR (timers
);
4270 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4272 ASET (timer
, 0, Qnil
);
4276 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4279 timer_stop_idle (void)
4281 EMACS_SET_INVALID_TIME (timer_idleness_start_time
);
4284 /* Resume idle timer from last idle start time. */
4287 timer_resume_idle (void)
4289 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4292 timer_idleness_start_time
= timer_last_idleness_start_time
;
4295 /* This is only for debugging. */
4296 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4298 /* List of elisp functions to call, delayed because they were generated in
4299 a context where Elisp could not be safely run (e.g. redisplay, signal,
4300 ...). Each element has the form (FUN . ARGS). */
4301 Lisp_Object pending_funcalls
;
4303 /* If TIMER is a valid timer, return nonzero and place its value into
4304 *RESULT. Otherwise return zero. */
4306 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4308 Lisp_Object
*vector
;
4310 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4312 vector
= XVECTOR (timer
)->contents
;
4313 if (! NILP (vector
[0]))
4316 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[4],
4321 /* Check whether a timer has fired. To prevent larger problems we simply
4322 disregard elements that are not proper timers. Do not make a circular
4323 timer list for the time being.
4325 Returns the time to wait until the next timer fires. If a
4326 timer is triggering now, return zero.
4327 If no timer is active, return -1.
4329 If a timer is ripe, we run it, with quitting turned off.
4330 In that case we return 0 to indicate that a new timer_check_2 call
4334 timer_check_2 (void)
4336 EMACS_TIME nexttime
;
4338 EMACS_TIME idleness_now
;
4339 Lisp_Object timers
, idle_timers
, chosen_timer
;
4340 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4342 EMACS_SET_INVALID_TIME (nexttime
);
4344 /* Always consider the ordinary timers. */
4345 timers
= Vtimer_list
;
4346 /* Consider the idle timers only if Emacs is idle. */
4347 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4348 idle_timers
= Vtimer_idle_list
;
4351 chosen_timer
= Qnil
;
4352 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4354 /* First run the code that was delayed. */
4355 while (CONSP (pending_funcalls
))
4357 Lisp_Object funcall
= XCAR (pending_funcalls
);
4358 pending_funcalls
= XCDR (pending_funcalls
);
4359 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4362 if (CONSP (timers
) || CONSP (idle_timers
))
4364 EMACS_GET_TIME (now
);
4365 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4366 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4368 EMACS_SET_SECS_NSECS (idleness_now
, 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
, idle_timer_difference
;
4378 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4380 EMACS_SET_INVALID_TIME (timer_difference
);
4381 EMACS_SET_INVALID_TIME (idle_timer_difference
);
4383 /* Set TIMER and TIMER_DIFFERENCE
4384 based on the next ordinary timer.
4385 TIMER_DIFFERENCE is the distance in time from NOW to when
4386 this timer becomes ripe (negative if it's already ripe).
4387 Skip past invalid timers and timers already handled. */
4390 timer
= XCAR (timers
);
4391 if (! decode_timer (timer
, &timer_time
))
4393 timers
= XCDR (timers
);
4397 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4399 EMACS_SUB_TIME (timer_difference
, now
, timer_time
);
4401 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4404 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4405 based on the next idle timer. */
4406 if (CONSP (idle_timers
))
4408 idle_timer
= XCAR (idle_timers
);
4409 if (! decode_timer (idle_timer
, &idle_timer_time
))
4411 idle_timers
= XCDR (idle_timers
);
4415 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4416 if (idle_timer_ripe
)
4417 EMACS_SUB_TIME (idle_timer_difference
,
4418 idleness_now
, idle_timer_time
);
4420 EMACS_SUB_TIME (idle_timer_difference
,
4421 idle_timer_time
, idleness_now
);
4424 /* Decide which timer is the next timer,
4425 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4426 Also step down the list where we found that timer. */
4428 if (EMACS_TIME_VALID_P (timer_difference
)
4429 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4430 || idle_timer_ripe
< timer_ripe
4431 || (idle_timer_ripe
== timer_ripe
4433 ? EMACS_TIME_LT (idle_timer_difference
,
4435 : EMACS_TIME_LT (timer_difference
,
4436 idle_timer_difference
)))))
4438 chosen_timer
= timer
;
4439 timers
= XCDR (timers
);
4440 difference
= timer_difference
;
4445 chosen_timer
= idle_timer
;
4446 idle_timers
= XCDR (idle_timers
);
4447 difference
= idle_timer_difference
;
4448 ripe
= idle_timer_ripe
;
4451 /* If timer is ripe, run it if it hasn't been run. */
4454 vector
= XVECTOR (chosen_timer
)->contents
;
4455 if (NILP (vector
[0]))
4457 ptrdiff_t count
= SPECPDL_INDEX ();
4458 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4460 /* Mark the timer as triggered to prevent problems if the lisp
4461 code fails to reschedule it right. */
4464 specbind (Qinhibit_quit
, Qt
);
4466 call1 (Qtimer_event_handler
, chosen_timer
);
4467 Vdeactivate_mark
= old_deactivate_mark
;
4469 unbind_to (count
, Qnil
);
4471 /* Since we have handled the event,
4472 we don't need to tell the caller to wake up and do it. */
4473 /* But the caller must still wait for the next timer, so
4474 return 0 to indicate that. */
4477 EMACS_SET_SECS (nexttime
, 0);
4478 EMACS_SET_USECS (nexttime
, 0);
4481 /* When we encounter a timer that is still waiting,
4482 return the amount of time to wait before it is ripe. */
4489 /* No timers are pending in the future. */
4490 /* Return 0 if we generated an event, and -1 if not. */
4496 /* Check whether a timer has fired. To prevent larger problems we simply
4497 disregard elements that are not proper timers. Do not make a circular
4498 timer list for the time being.
4500 Returns the time to wait until the next timer fires.
4501 If no timer is active, return an invalid value.
4503 As long as any timer is ripe, we run it. */
4508 EMACS_TIME nexttime
;
4512 nexttime
= timer_check_2 ();
4514 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4519 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4520 doc
: /* Return the current length of Emacs idleness, or nil.
4521 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4522 in the same style as (current-time).
4524 The value when Emacs is not idle is nil.
4526 NSEC is a multiple of the system clock resolution. */)
4529 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4531 EMACS_TIME now
, idleness_now
;
4533 EMACS_GET_TIME (now
);
4534 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4536 return make_lisp_time (idleness_now
);
4542 /* Caches for modify_event_symbol. */
4543 static Lisp_Object accent_key_syms
;
4544 static Lisp_Object func_key_syms
;
4545 static Lisp_Object mouse_syms
;
4546 static Lisp_Object wheel_syms
;
4547 static Lisp_Object drag_n_drop_syms
;
4549 /* This is a list of keysym codes for special "accent" characters.
4550 It parallels lispy_accent_keys. */
4552 static const int lispy_accent_codes
[] =
4554 #ifdef XK_dead_circumflex
4559 #ifdef XK_dead_grave
4564 #ifdef XK_dead_tilde
4569 #ifdef XK_dead_diaeresis
4574 #ifdef XK_dead_macron
4579 #ifdef XK_dead_degree
4584 #ifdef XK_dead_acute
4589 #ifdef XK_dead_cedilla
4594 #ifdef XK_dead_breve
4599 #ifdef XK_dead_ogonek
4604 #ifdef XK_dead_caron
4609 #ifdef XK_dead_doubleacute
4610 XK_dead_doubleacute
,
4614 #ifdef XK_dead_abovedot
4619 #ifdef XK_dead_abovering
4629 #ifdef XK_dead_belowdot
4634 #ifdef XK_dead_voiced_sound
4635 XK_dead_voiced_sound
,
4639 #ifdef XK_dead_semivoiced_sound
4640 XK_dead_semivoiced_sound
,
4656 /* This is a list of Lisp names for special "accent" characters.
4657 It parallels lispy_accent_codes. */
4659 static const char *const lispy_accent_keys
[] =
4677 "dead-voiced-sound",
4678 "dead-semivoiced-sound",
4684 #define FUNCTION_KEY_OFFSET 0x0
4686 const char *const lispy_function_keys
[] =
4690 0, /* VK_LBUTTON 0x01 */
4691 0, /* VK_RBUTTON 0x02 */
4692 "cancel", /* VK_CANCEL 0x03 */
4693 0, /* VK_MBUTTON 0x04 */
4695 0, 0, 0, /* 0x05 .. 0x07 */
4697 "backspace", /* VK_BACK 0x08 */
4698 "tab", /* VK_TAB 0x09 */
4700 0, 0, /* 0x0A .. 0x0B */
4702 "clear", /* VK_CLEAR 0x0C */
4703 "return", /* VK_RETURN 0x0D */
4705 0, 0, /* 0x0E .. 0x0F */
4707 0, /* VK_SHIFT 0x10 */
4708 0, /* VK_CONTROL 0x11 */
4709 0, /* VK_MENU 0x12 */
4710 "pause", /* VK_PAUSE 0x13 */
4711 "capslock", /* VK_CAPITAL 0x14 */
4712 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4714 "junja", /* VK_JUNJA 0x17 */
4715 "final", /* VK_FINAL 0x18 */
4716 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4718 "escape", /* VK_ESCAPE 0x1B */
4719 "convert", /* VK_CONVERT 0x1C */
4720 "non-convert", /* VK_NONCONVERT 0x1D */
4721 "accept", /* VK_ACCEPT 0x1E */
4722 "mode-change", /* VK_MODECHANGE 0x1F */
4723 0, /* VK_SPACE 0x20 */
4724 "prior", /* VK_PRIOR 0x21 */
4725 "next", /* VK_NEXT 0x22 */
4726 "end", /* VK_END 0x23 */
4727 "home", /* VK_HOME 0x24 */
4728 "left", /* VK_LEFT 0x25 */
4729 "up", /* VK_UP 0x26 */
4730 "right", /* VK_RIGHT 0x27 */
4731 "down", /* VK_DOWN 0x28 */
4732 "select", /* VK_SELECT 0x29 */
4733 "print", /* VK_PRINT 0x2A */
4734 "execute", /* VK_EXECUTE 0x2B */
4735 "snapshot", /* VK_SNAPSHOT 0x2C */
4736 "insert", /* VK_INSERT 0x2D */
4737 "delete", /* VK_DELETE 0x2E */
4738 "help", /* VK_HELP 0x2F */
4740 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4742 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4744 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4746 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4748 0, 0, 0, 0, 0, 0, 0, 0, 0,
4749 0, 0, 0, 0, 0, 0, 0, 0, 0,
4750 0, 0, 0, 0, 0, 0, 0, 0,
4752 "lwindow", /* VK_LWIN 0x5B */
4753 "rwindow", /* VK_RWIN 0x5C */
4754 "apps", /* VK_APPS 0x5D */
4757 "kp-0", /* VK_NUMPAD0 0x60 */
4758 "kp-1", /* VK_NUMPAD1 0x61 */
4759 "kp-2", /* VK_NUMPAD2 0x62 */
4760 "kp-3", /* VK_NUMPAD3 0x63 */
4761 "kp-4", /* VK_NUMPAD4 0x64 */
4762 "kp-5", /* VK_NUMPAD5 0x65 */
4763 "kp-6", /* VK_NUMPAD6 0x66 */
4764 "kp-7", /* VK_NUMPAD7 0x67 */
4765 "kp-8", /* VK_NUMPAD8 0x68 */
4766 "kp-9", /* VK_NUMPAD9 0x69 */
4767 "kp-multiply", /* VK_MULTIPLY 0x6A */
4768 "kp-add", /* VK_ADD 0x6B */
4769 "kp-separator", /* VK_SEPARATOR 0x6C */
4770 "kp-subtract", /* VK_SUBTRACT 0x6D */
4771 "kp-decimal", /* VK_DECIMAL 0x6E */
4772 "kp-divide", /* VK_DIVIDE 0x6F */
4773 "f1", /* VK_F1 0x70 */
4774 "f2", /* VK_F2 0x71 */
4775 "f3", /* VK_F3 0x72 */
4776 "f4", /* VK_F4 0x73 */
4777 "f5", /* VK_F5 0x74 */
4778 "f6", /* VK_F6 0x75 */
4779 "f7", /* VK_F7 0x76 */
4780 "f8", /* VK_F8 0x77 */
4781 "f9", /* VK_F9 0x78 */
4782 "f10", /* VK_F10 0x79 */
4783 "f11", /* VK_F11 0x7A */
4784 "f12", /* VK_F12 0x7B */
4785 "f13", /* VK_F13 0x7C */
4786 "f14", /* VK_F14 0x7D */
4787 "f15", /* VK_F15 0x7E */
4788 "f16", /* VK_F16 0x7F */
4789 "f17", /* VK_F17 0x80 */
4790 "f18", /* VK_F18 0x81 */
4791 "f19", /* VK_F19 0x82 */
4792 "f20", /* VK_F20 0x83 */
4793 "f21", /* VK_F21 0x84 */
4794 "f22", /* VK_F22 0x85 */
4795 "f23", /* VK_F23 0x86 */
4796 "f24", /* VK_F24 0x87 */
4798 0, 0, 0, 0, /* 0x88 .. 0x8B */
4799 0, 0, 0, 0, /* 0x8C .. 0x8F */
4801 "kp-numlock", /* VK_NUMLOCK 0x90 */
4802 "scroll", /* VK_SCROLL 0x91 */
4803 /* Not sure where the following block comes from.
4804 Windows headers have NEC and Fujitsu specific keys in
4805 this block, but nothing generic. */
4806 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4807 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4808 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4809 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4810 "kp-end", /* VK_NUMPAD_END 0x96 */
4811 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4812 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4813 "kp-up", /* VK_NUMPAD_UP 0x99 */
4814 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4815 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4816 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4817 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4819 0, 0, /* 0x9E .. 0x9F */
4822 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4823 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4824 * No other API or message will distinguish left and right keys this way.
4829 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4830 to enable them selectively, and gives access to a few more functions.
4831 See lispy_multimedia_keys below. */
4832 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4833 0, 0, 0, /* 0xAD .. 0xAF Volume */
4834 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4835 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4837 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4838 0, 0, 0, 0, 0, 0, 0, 0, 0,
4840 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4841 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4842 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4845 "ax", /* VK_OEM_AX 0xE1 */
4846 0, /* VK_OEM_102 0xE2 */
4847 "ico-help", /* VK_ICO_HELP 0xE3 */
4848 "ico-00", /* VK_ICO_00 0xE4 */
4849 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4850 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4851 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4853 "reset", /* VK_OEM_RESET 0xE9 */
4854 "jump", /* VK_OEM_JUMP 0xEA */
4855 "oem-pa1", /* VK_OEM_PA1 0xEB */
4856 "oem-pa2", /* VK_OEM_PA2 0xEC */
4857 "oem-pa3", /* VK_OEM_PA3 0xED */
4858 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4859 "cusel", /* VK_OEM_CUSEL 0xEF */
4860 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4861 "finish", /* VK_OEM_FINISH 0xF1 */
4862 "copy", /* VK_OEM_COPY 0xF2 */
4863 "auto", /* VK_OEM_AUTO 0xF3 */
4864 "enlw", /* VK_OEM_ENLW 0xF4 */
4865 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4866 "attn", /* VK_ATTN 0xF6 */
4867 "crsel", /* VK_CRSEL 0xF7 */
4868 "exsel", /* VK_EXSEL 0xF8 */
4869 "ereof", /* VK_EREOF 0xF9 */
4870 "play", /* VK_PLAY 0xFA */
4871 "zoom", /* VK_ZOOM 0xFB */
4872 "noname", /* VK_NONAME 0xFC */
4873 "pa1", /* VK_PA1 0xFD */
4874 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4878 /* Some of these duplicate the "Media keys" on newer keyboards,
4879 but they are delivered to the application in a different way. */
4880 static const char *const lispy_multimedia_keys
[] =
4888 "browser-favorites",
4925 "toggle-dictate-command",
4931 "media-fast-forward",
4934 "media-channel-down"
4937 #else /* not HAVE_NTGUI */
4939 /* This should be dealt with in XTread_socket now, and that doesn't
4940 depend on the client system having the Kana syms defined. See also
4941 the XK_kana_A case below. */
4944 static const char *const lispy_kana_keys
[] =
4946 /* X Keysym value */
4947 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4948 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4949 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4952 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4955 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4956 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4957 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4958 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4959 "kana-i", "kana-u", "kana-e", "kana-o",
4960 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4961 "prolongedsound", "kana-A", "kana-I", "kana-U",
4962 "kana-E", "kana-O", "kana-KA", "kana-KI",
4963 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4964 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4965 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4966 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4967 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4968 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4969 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4970 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4971 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4972 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4973 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4974 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4976 #endif /* XK_kana_A */
4979 #define FUNCTION_KEY_OFFSET 0xff00
4981 /* You'll notice that this table is arranged to be conveniently
4982 indexed by X Windows keysym values. */
4983 static const char *const lispy_function_keys
[] =
4985 /* X Keysym value */
4987 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4988 "backspace", "tab", "linefeed", "clear",
4990 0, 0, 0, "pause", /* 0xff10...1f */
4991 0, 0, 0, 0, 0, 0, 0, "escape",
4993 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4994 "romaji", "hiragana", "katakana", "hiragana-katakana",
4995 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4996 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4997 "eisu-toggle", /* 0xff30...3f */
4998 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4999 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5001 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5002 "down", "prior", "next", "end",
5003 "begin", 0, 0, 0, 0, 0, 0, 0,
5004 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5015 "break", /* 0xff6b */
5018 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5019 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5020 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5021 0, 0, 0, 0, 0, 0, 0, 0,
5022 "kp-tab", /* 0xff89 */
5024 "kp-enter", /* 0xff8d */
5026 "kp-f1", /* 0xff91 */
5030 "kp-home", /* 0xff95 */
5035 "kp-prior", /* kp-page-up */
5036 "kp-next", /* kp-page-down */
5042 0, 0, 0, 0, 0, 0, 0, 0, 0,
5043 "kp-multiply", /* 0xffaa */
5048 "kp-divide", /* 0xffaf */
5049 "kp-0", /* 0xffb0 */
5050 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5053 "kp-equal", /* 0xffbd */
5054 "f1", /* 0xffbe */ /* IsFunctionKey */
5056 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5057 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5058 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5059 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5060 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5061 0, 0, 0, 0, 0, 0, 0, 0,
5062 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5063 0, 0, 0, 0, 0, 0, 0, "delete"
5066 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5067 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5069 static const char *const iso_lispy_function_keys
[] =
5071 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5072 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5073 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5074 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5075 "iso-lefttab", /* 0xfe20 */
5076 "iso-move-line-up", "iso-move-line-down",
5077 "iso-partial-line-up", "iso-partial-line-down",
5078 "iso-partial-space-left", "iso-partial-space-right",
5079 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5080 "iso-release-margin-left", "iso-release-margin-right",
5081 "iso-release-both-margins",
5082 "iso-fast-cursor-left", "iso-fast-cursor-right",
5083 "iso-fast-cursor-up", "iso-fast-cursor-down",
5084 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5085 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5088 #endif /* not HAVE_NTGUI */
5090 static Lisp_Object Vlispy_mouse_stem
;
5092 static const char *const lispy_wheel_names
[] =
5094 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5097 /* drag-n-drop events are generated when a set of selected files are
5098 dragged from another application and dropped onto an Emacs window. */
5099 static const char *const lispy_drag_n_drop_names
[] =
5104 /* Scroll bar parts. */
5105 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5106 Lisp_Object Qup
, Qdown
, Qbottom
;
5107 static Lisp_Object Qend_scroll
;
5109 static Lisp_Object Qratio
;
5111 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5112 static Lisp_Object
*const scroll_bar_parts
[] = {
5113 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5114 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5117 /* A vector, indexed by button number, giving the down-going location
5118 of currently depressed buttons, both scroll bar and non-scroll bar.
5120 The elements have the form
5121 (BUTTON-NUMBER MODIFIER-MASK . REST)
5122 where REST is the cdr of a position as it would be reported in the event.
5124 The make_lispy_event function stores positions here to tell the
5125 difference between click and drag events, and to store the starting
5126 location to be included in drag events. */
5128 static Lisp_Object button_down_location
;
5130 /* Information about the most recent up-going button event: Which
5131 button, what location, and what time. */
5133 static int last_mouse_button
;
5134 static int last_mouse_x
;
5135 static int last_mouse_y
;
5136 static Time button_down_time
;
5138 /* The number of clicks in this multiple-click. */
5140 static int double_click_count
;
5142 /* X and Y are frame-relative coordinates for a click or wheel event.
5143 Return a Lisp-style event list. */
5146 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5149 enum window_part part
;
5150 Lisp_Object posn
= Qnil
;
5151 Lisp_Object extra_info
= Qnil
;
5152 /* Coordinate pixel positions to return. */
5153 int xret
= 0, yret
= 0;
5154 /* The window under frame pixel coordinates (x,y) */
5155 Lisp_Object window
= f
5156 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5159 if (WINDOWP (window
))
5161 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5162 struct window
*w
= XWINDOW (window
);
5163 Lisp_Object string_info
= Qnil
;
5164 ptrdiff_t textpos
= -1;
5165 int col
= -1, row
= -1;
5166 int dx
= -1, dy
= -1;
5167 int width
= -1, height
= -1;
5168 Lisp_Object object
= Qnil
;
5170 /* Pixel coordinates relative to the window corner. */
5171 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5172 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5174 /* For text area clicks, return X, Y relative to the corner of
5175 this text area. Note that dX, dY etc are set below, by
5176 buffer_posn_from_coords. */
5177 if (part
== ON_TEXT
)
5179 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5180 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5182 /* For mode line and header line clicks, return X, Y relative to
5183 the left window edge. Use mode_line_string to look for a
5184 string on the click position. */
5185 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5190 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5191 /* Note that mode_line_string takes COL, ROW as pixels and
5192 converts them to characters. */
5195 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5196 &object
, &dx
, &dy
, &width
, &height
);
5197 if (STRINGP (string
))
5198 string_info
= Fcons (string
, make_number (charpos
));
5199 textpos
= (w
== XWINDOW (selected_window
)
5200 && current_buffer
== XBUFFER (w
->buffer
))
5201 ? PT
: XMARKER (w
->pointm
)->charpos
;
5206 /* For fringes and margins, Y is relative to the area's (and the
5207 window's) top edge, while X is meaningless. */
5208 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5213 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5216 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5217 &object
, &dx
, &dy
, &width
, &height
);
5218 if (STRINGP (string
))
5219 string_info
= Fcons (string
, make_number (charpos
));
5220 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5222 else if (part
== ON_LEFT_FRINGE
)
5224 posn
= Qleft_fringe
;
5227 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5228 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5229 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5231 else if (part
== ON_RIGHT_FRINGE
)
5233 posn
= Qright_fringe
;
5236 - window_box_width (w
, LEFT_MARGIN_AREA
)
5237 - window_box_width (w
, TEXT_AREA
)
5238 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5239 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5241 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5243 else if (part
== ON_VERTICAL_BORDER
)
5245 posn
= Qvertical_line
;
5250 /* Nothing special for part == ON_SCROLL_BAR. */
5252 /* For clicks in the text area, fringes, or margins, call
5253 buffer_posn_from_coords to extract TEXTPOS, the buffer
5254 position nearest to the click. */
5257 Lisp_Object string2
, object2
= Qnil
;
5258 struct display_pos p
;
5260 int width2
, height2
;
5261 /* The pixel X coordinate passed to buffer_posn_from_coords
5262 is the X coordinate relative to the text area for
5263 text-area and right-margin clicks, zero otherwise. */
5265 = (part
== ON_TEXT
) ? xret
5266 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5267 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5271 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5272 &object2
, &dx2
, &dy2
,
5274 textpos
= CHARPOS (p
.pos
);
5275 if (col
< 0) col
= x2
;
5276 if (row
< 0) row
= y2
;
5277 if (dx
< 0) dx
= dx2
;
5278 if (dy
< 0) dy
= dy2
;
5279 if (width
< 0) width
= width2
;
5280 if (height
< 0) height
= height2
;
5284 posn
= make_number (textpos
);
5285 if (STRINGP (string2
))
5286 string_info
= Fcons (string2
,
5287 make_number (CHARPOS (p
.string_pos
)));
5293 #ifdef HAVE_WINDOW_SYSTEM
5294 if (IMAGEP (object
))
5296 Lisp_Object image_map
, hotspot
;
5297 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5299 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5301 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5302 posn
= XCAR (hotspot
);
5309 Fcons (make_number (dx
), make_number (dy
)),
5310 Fcons (make_number (width
), make_number (height
)));
5313 extra_info
= Fcons (string_info
,
5314 Fcons (make_number (textpos
),
5315 Fcons (Fcons (make_number (col
),
5320 XSETFRAME (window
, f
);
5324 return Fcons (window
,
5326 Fcons (Fcons (make_number (xret
),
5327 make_number (yret
)),
5328 Fcons (make_number (t
),
5332 /* Given a struct input_event, build the lisp event which represents
5333 it. If EVENT is 0, build a mouse movement event from the mouse
5334 movement buffer, which should have a movement event in it.
5336 Note that events must be passed to this function in the order they
5337 are received; this function stores the location of button presses
5338 in order to build drag events when the button is released. */
5341 make_lispy_event (struct input_event
*event
)
5345 switch (SWITCH_ENUM_CAST (event
->kind
))
5347 /* A simple keystroke. */
5348 case ASCII_KEYSTROKE_EVENT
:
5349 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5351 Lisp_Object lispy_c
;
5352 EMACS_INT c
= event
->code
;
5353 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5356 eassert (c
== event
->code
);
5357 /* Turn ASCII characters into control characters
5359 if (event
->modifiers
& ctrl_modifier
)
5361 c
= make_ctrl_char (c
);
5362 event
->modifiers
&= ~ctrl_modifier
;
5366 /* Add in the other modifier bits. The shift key was taken care
5367 of by the X code. */
5368 c
|= (event
->modifiers
5369 & (meta_modifier
| alt_modifier
5370 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5371 /* Distinguish Shift-SPC from SPC. */
5372 if ((event
->code
) == 040
5373 && event
->modifiers
& shift_modifier
)
5374 c
|= shift_modifier
;
5375 button_down_time
= 0;
5376 XSETFASTINT (lispy_c
, c
);
5381 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5382 except that they are non-key events (last-nonmenu-event is nil). */
5383 case NS_NONKEY_EVENT
:
5386 /* A function key. The symbol may need to have modifier prefixes
5388 case NON_ASCII_KEYSTROKE_EVENT
:
5389 button_down_time
= 0;
5391 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5392 if (event
->code
== lispy_accent_codes
[i
])
5393 return modify_event_symbol (i
,
5395 Qfunction_key
, Qnil
,
5396 lispy_accent_keys
, &accent_key_syms
,
5397 (sizeof (lispy_accent_keys
)
5398 / sizeof (lispy_accent_keys
[0])));
5402 if (event
->code
>= 0x400 && event
->code
< 0x500)
5403 return modify_event_symbol (event
->code
- 0x400,
5404 event
->modifiers
& ~shift_modifier
,
5405 Qfunction_key
, Qnil
,
5406 lispy_kana_keys
, &func_key_syms
,
5407 (sizeof (lispy_kana_keys
)
5408 / sizeof (lispy_kana_keys
[0])));
5409 #endif /* XK_kana_A */
5412 #ifdef ISO_FUNCTION_KEY_OFFSET
5413 if (event
->code
< FUNCTION_KEY_OFFSET
5414 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5415 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5417 Qfunction_key
, Qnil
,
5418 iso_lispy_function_keys
, &func_key_syms
,
5419 (sizeof (iso_lispy_function_keys
)
5420 / sizeof (iso_lispy_function_keys
[0])));
5423 /* Handle system-specific or unknown keysyms. */
5424 if (event
->code
& (1 << 28)
5425 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5426 || (event
->code
- FUNCTION_KEY_OFFSET
5427 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5428 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5430 /* We need to use an alist rather than a vector as the cache
5431 since we can't make a vector long enough. */
5432 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5433 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5434 return modify_event_symbol (event
->code
,
5437 KVAR (current_kboard
, Vsystem_key_alist
),
5438 0, &KVAR (current_kboard
, system_key_syms
),
5442 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5444 Qfunction_key
, Qnil
,
5445 lispy_function_keys
, &func_key_syms
,
5446 (sizeof (lispy_function_keys
)
5447 / sizeof (lispy_function_keys
[0])));
5450 case MULTIMEDIA_KEY_EVENT
:
5451 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5452 / sizeof (lispy_multimedia_keys
[0]))
5453 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5455 return modify_event_symbol (event
->code
, event
->modifiers
,
5456 Qfunction_key
, Qnil
,
5457 lispy_multimedia_keys
, &func_key_syms
,
5458 (sizeof (lispy_multimedia_keys
)
5459 / sizeof (lispy_multimedia_keys
[0])));
5465 /* A mouse click. Figure out where it is, decide whether it's
5466 a press, click or drag, and build the appropriate structure. */
5467 case MOUSE_CLICK_EVENT
:
5468 #ifndef USE_TOOLKIT_SCROLL_BARS
5469 case SCROLL_BAR_CLICK_EVENT
:
5472 int button
= event
->code
;
5474 Lisp_Object position
;
5475 Lisp_Object
*start_pos_ptr
;
5476 Lisp_Object start_pos
;
5480 /* Build the position as appropriate for this mouse click. */
5481 if (event
->kind
== MOUSE_CLICK_EVENT
)
5483 struct frame
*f
= XFRAME (event
->frame_or_window
);
5484 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5488 /* Ignore mouse events that were made on frame that
5489 have been deleted. */
5490 if (! FRAME_LIVE_P (f
))
5493 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5494 /* EVENT->x and EVENT->y are frame-relative pixel
5495 coordinates at this place. Under old redisplay, COLUMN
5496 and ROW are set to frame relative glyph coordinates
5497 which are then used to determine whether this click is
5498 in a menu (non-toolkit version). */
5499 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5500 &column
, &row
, NULL
, 1);
5502 /* In the non-toolkit version, clicks on the menu bar
5503 are ordinary button events in the event buffer.
5504 Distinguish them, and invoke the menu.
5506 (In the toolkit version, the toolkit handles the menu bar
5507 and Emacs doesn't know about it until after the user
5508 makes a selection.) */
5509 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5510 && (event
->modifiers
& down_modifier
))
5512 Lisp_Object items
, item
;
5514 /* Find the menu bar item under `column'. */
5516 items
= FRAME_MENU_BAR_ITEMS (f
);
5517 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5519 Lisp_Object pos
, string
;
5520 string
= AREF (items
, i
+ 1);
5521 pos
= AREF (items
, i
+ 3);
5524 if (column
>= XINT (pos
)
5525 && column
< XINT (pos
) + SCHARS (string
))
5527 item
= AREF (items
, i
);
5532 /* ELisp manual 2.4b says (x y) are window relative but
5533 code says they are frame-relative. */
5535 = Fcons (event
->frame_or_window
,
5537 Fcons (Fcons (event
->x
, event
->y
),
5538 Fcons (make_number (event
->timestamp
),
5541 return Fcons (item
, Fcons (position
, Qnil
));
5543 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5545 position
= make_lispy_position (f
, event
->x
, event
->y
,
5548 #ifndef USE_TOOLKIT_SCROLL_BARS
5551 /* It's a scrollbar click. */
5553 Lisp_Object portion_whole
;
5556 window
= event
->frame_or_window
;
5557 portion_whole
= Fcons (event
->x
, event
->y
);
5558 part
= *scroll_bar_parts
[(int) event
->part
];
5562 Fcons (Qvertical_scroll_bar
,
5563 Fcons (portion_whole
,
5564 Fcons (make_number (event
->timestamp
),
5565 Fcons (part
, Qnil
)))));
5567 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5569 if (button
>= ASIZE (button_down_location
))
5571 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5572 button_down_location
= larger_vector (button_down_location
,
5574 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5577 start_pos_ptr
= &AREF (button_down_location
, button
);
5578 start_pos
= *start_pos_ptr
;
5579 *start_pos_ptr
= Qnil
;
5582 /* On window-system frames, use the value of
5583 double-click-fuzz as is. On other frames, interpret it
5584 as a multiple of 1/8 characters. */
5588 if (WINDOWP (event
->frame_or_window
))
5589 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5590 else if (FRAMEP (event
->frame_or_window
))
5591 f
= XFRAME (event
->frame_or_window
);
5595 if (FRAME_WINDOW_P (f
))
5596 fuzz
= double_click_fuzz
;
5598 fuzz
= double_click_fuzz
/ 8;
5600 is_double
= (button
== last_mouse_button
5601 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5602 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5603 && button_down_time
!= 0
5604 && (EQ (Vdouble_click_time
, Qt
)
5605 || (NATNUMP (Vdouble_click_time
)
5606 && (event
->timestamp
- button_down_time
5607 < XFASTINT (Vdouble_click_time
)))));
5610 last_mouse_button
= button
;
5611 last_mouse_x
= XINT (event
->x
);
5612 last_mouse_y
= XINT (event
->y
);
5614 /* If this is a button press, squirrel away the location, so
5615 we can decide later whether it was a click or a drag. */
5616 if (event
->modifiers
& down_modifier
)
5620 double_click_count
++;
5621 event
->modifiers
|= ((double_click_count
> 2)
5626 double_click_count
= 1;
5627 button_down_time
= event
->timestamp
;
5628 *start_pos_ptr
= Fcopy_alist (position
);
5629 ignore_mouse_drag_p
= 0;
5632 /* Now we're releasing a button - check the co-ordinates to
5633 see if this was a click or a drag. */
5634 else if (event
->modifiers
& up_modifier
)
5636 /* If we did not see a down before this up, ignore the up.
5637 Probably this happened because the down event chose a
5638 menu item. It would be an annoyance to treat the
5639 release of the button that chose the menu item as a
5642 if (!CONSP (start_pos
))
5645 event
->modifiers
&= ~up_modifier
;
5648 Lisp_Object new_down
, down
;
5649 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5651 /* The third element of every position
5652 should be the (x,y) pair. */
5653 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5654 new_down
= Fcar (Fcdr (Fcdr (position
)));
5657 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5659 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5660 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5663 if (ignore_mouse_drag_p
)
5665 event
->modifiers
|= click_modifier
;
5666 ignore_mouse_drag_p
= 0;
5668 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5669 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5670 /* Maybe the mouse has moved a lot, caused scrolling, and
5671 eventually ended up at the same screen position (but
5672 not buffer position) in which case it is a drag, not
5674 /* FIXME: OTOH if the buffer position has changed
5675 because of a timer or process filter rather than
5676 because of mouse movement, it should be considered as
5677 a click. But mouse-drag-region completely ignores
5678 this case and it hasn't caused any real problem, so
5679 it's probably OK to ignore it as well. */
5680 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5681 /* Mouse hasn't moved (much). */
5682 event
->modifiers
|= click_modifier
;
5685 button_down_time
= 0;
5686 event
->modifiers
|= drag_modifier
;
5689 /* Don't check is_double; treat this as multiple
5690 if the down-event was multiple. */
5691 if (double_click_count
> 1)
5692 event
->modifiers
|= ((double_click_count
> 2)
5698 /* Every mouse event should either have the down_modifier or
5699 the up_modifier set. */
5703 /* Get the symbol we should use for the mouse click. */
5706 head
= modify_event_symbol (button
,
5708 Qmouse_click
, Vlispy_mouse_stem
,
5711 ASIZE (mouse_syms
));
5712 if (event
->modifiers
& drag_modifier
)
5717 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5720 Fcons (make_number (double_click_count
),
5730 case HORIZ_WHEEL_EVENT
:
5732 Lisp_Object position
;
5735 /* Build the position as appropriate for this mouse click. */
5736 struct frame
*f
= XFRAME (event
->frame_or_window
);
5738 /* Ignore wheel events that were made on frame that have been
5740 if (! FRAME_LIVE_P (f
))
5743 position
= make_lispy_position (f
, event
->x
, event
->y
,
5746 /* Set double or triple modifiers to indicate the wheel speed. */
5748 /* On window-system frames, use the value of
5749 double-click-fuzz as is. On other frames, interpret it
5750 as a multiple of 1/8 characters. */
5756 if (WINDOWP (event
->frame_or_window
))
5757 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5758 else if (FRAMEP (event
->frame_or_window
))
5759 fr
= XFRAME (event
->frame_or_window
);
5763 fuzz
= FRAME_WINDOW_P (fr
)
5764 ? double_click_fuzz
: double_click_fuzz
/ 8;
5766 if (event
->modifiers
& up_modifier
)
5768 /* Emit a wheel-up event. */
5769 event
->modifiers
&= ~up_modifier
;
5772 else if (event
->modifiers
& down_modifier
)
5774 /* Emit a wheel-down event. */
5775 event
->modifiers
&= ~down_modifier
;
5779 /* Every wheel event should either have the down_modifier or
5780 the up_modifier set. */
5783 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5786 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5787 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5788 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5789 && button_down_time
!= 0
5790 && (EQ (Vdouble_click_time
, Qt
)
5791 || (NATNUMP (Vdouble_click_time
)
5792 && (event
->timestamp
- button_down_time
5793 < XFASTINT (Vdouble_click_time
)))));
5796 double_click_count
++;
5797 event
->modifiers
|= ((double_click_count
> 2)
5803 double_click_count
= 1;
5804 event
->modifiers
|= click_modifier
;
5807 button_down_time
= event
->timestamp
;
5808 /* Use a negative value to distinguish wheel from mouse button. */
5809 last_mouse_button
= - (1 + symbol_num
);
5810 last_mouse_x
= XINT (event
->x
);
5811 last_mouse_y
= XINT (event
->y
);
5813 /* Get the symbol we should use for the wheel event. */
5814 head
= modify_event_symbol (symbol_num
,
5820 ASIZE (wheel_syms
));
5823 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5826 Fcons (make_number (double_click_count
),
5835 #ifdef USE_TOOLKIT_SCROLL_BARS
5837 /* We don't have down and up events if using toolkit scroll bars,
5838 so make this always a click event. Store in the `part' of
5839 the Lisp event a symbol which maps to the following actions:
5841 `above_handle' page up
5842 `below_handle' page down
5846 `bottom' bottom of buffer
5847 `handle' thumb has been dragged.
5848 `end-scroll' end of interaction with scroll bar
5850 The incoming input_event contains in its `part' member an
5851 index of type `enum scroll_bar_part' which we can use as an
5852 index in scroll_bar_parts to get the appropriate symbol. */
5854 case SCROLL_BAR_CLICK_EVENT
:
5856 Lisp_Object position
, head
, window
, portion_whole
, part
;
5858 window
= event
->frame_or_window
;
5859 portion_whole
= Fcons (event
->x
, event
->y
);
5860 part
= *scroll_bar_parts
[(int) event
->part
];
5864 Fcons (Qvertical_scroll_bar
,
5865 Fcons (portion_whole
,
5866 Fcons (make_number (event
->timestamp
),
5867 Fcons (part
, Qnil
)))));
5869 /* Always treat scroll bar events as clicks. */
5870 event
->modifiers
|= click_modifier
;
5871 event
->modifiers
&= ~up_modifier
;
5873 if (event
->code
>= ASIZE (mouse_syms
))
5874 mouse_syms
= larger_vector (mouse_syms
,
5875 event
->code
- ASIZE (mouse_syms
) + 1,
5878 /* Get the symbol we should use for the mouse click. */
5879 head
= modify_event_symbol (event
->code
,
5884 ASIZE (mouse_syms
));
5885 return Fcons (head
, Fcons (position
, Qnil
));
5888 #endif /* USE_TOOLKIT_SCROLL_BARS */
5890 case DRAG_N_DROP_EVENT
:
5893 Lisp_Object head
, position
;
5896 f
= XFRAME (event
->frame_or_window
);
5899 /* Ignore mouse events that were made on frames that
5900 have been deleted. */
5901 if (! FRAME_LIVE_P (f
))
5904 position
= make_lispy_position (f
, event
->x
, event
->y
,
5907 head
= modify_event_symbol (0, event
->modifiers
,
5909 lispy_drag_n_drop_names
,
5910 &drag_n_drop_syms
, 1);
5916 #endif /* HAVE_MOUSE */
5918 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5919 || defined (HAVE_NS) || defined (USE_GTK)
5920 case MENU_BAR_EVENT
:
5921 if (EQ (event
->arg
, event
->frame_or_window
))
5922 /* This is the prefix key. We translate this to
5923 `(menu_bar)' because the code in keyboard.c for menu
5924 events, which we use, relies on this. */
5925 return Fcons (Qmenu_bar
, Qnil
);
5929 case SELECT_WINDOW_EVENT
:
5930 /* Make an event (select-window (WINDOW)). */
5931 return Fcons (Qselect_window
,
5932 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5935 case TOOL_BAR_EVENT
:
5936 if (EQ (event
->arg
, event
->frame_or_window
))
5937 /* This is the prefix key. We translate this to
5938 `(tool_bar)' because the code in keyboard.c for tool bar
5939 events, which we use, relies on this. */
5940 return Fcons (Qtool_bar
, Qnil
);
5941 else if (SYMBOLP (event
->arg
))
5942 return apply_modifiers (event
->modifiers
, event
->arg
);
5945 case USER_SIGNAL_EVENT
:
5946 /* A user signal. */
5948 char *name
= find_user_signal_name (event
->code
);
5951 return intern (name
);
5954 case SAVE_SESSION_EVENT
:
5955 return Qsave_session
;
5960 return Fcons (Qdbus_event
, event
->arg
);
5962 #endif /* HAVE_DBUS */
5964 case CONFIG_CHANGED_EVENT
:
5965 return Fcons (Qconfig_changed_event
,
5967 Fcons (event
->frame_or_window
, Qnil
)));
5969 case GPM_CLICK_EVENT
:
5971 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5972 Lisp_Object head
, position
;
5973 Lisp_Object
*start_pos_ptr
;
5974 Lisp_Object start_pos
;
5975 int button
= event
->code
;
5977 if (button
>= ASIZE (button_down_location
))
5979 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5980 button_down_location
= larger_vector (button_down_location
,
5982 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5985 start_pos_ptr
= &AREF (button_down_location
, button
);
5986 start_pos
= *start_pos_ptr
;
5988 position
= make_lispy_position (f
, event
->x
, event
->y
,
5991 if (event
->modifiers
& down_modifier
)
5992 *start_pos_ptr
= Fcopy_alist (position
);
5993 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5995 if (!CONSP (start_pos
))
5997 event
->modifiers
&= ~up_modifier
;
6000 head
= modify_event_symbol (button
,
6002 Qmouse_click
, Vlispy_mouse_stem
,
6005 ASIZE (mouse_syms
));
6007 if (event
->modifiers
& drag_modifier
)
6012 else if (event
->modifiers
& double_modifier
)
6015 Fcons (make_number (2),
6017 else if (event
->modifiers
& triple_modifier
)
6020 Fcons (make_number (3),
6027 #endif /* HAVE_GPM */
6029 /* The 'kind' field of the event is something we don't recognize. */
6035 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6038 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6039 Lisp_Object x
, Lisp_Object y
, Time t
)
6041 /* Is it a scroll bar movement? */
6042 if (frame
&& ! NILP (bar_window
))
6044 Lisp_Object part_sym
;
6046 part_sym
= *scroll_bar_parts
[(int) part
];
6047 return Fcons (Qscroll_bar_movement
,
6048 Fcons (list5 (bar_window
,
6049 Qvertical_scroll_bar
,
6055 /* Or is it an ordinary mouse movement? */
6058 Lisp_Object position
;
6059 position
= make_lispy_position (frame
, x
, y
, t
);
6060 return list2 (Qmouse_movement
, position
);
6064 #endif /* HAVE_MOUSE || HAVE GPM */
6066 /* Construct a switch frame event. */
6068 make_lispy_switch_frame (Lisp_Object frame
)
6070 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6073 /* Manipulating modifiers. */
6075 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6077 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6078 SYMBOL's name of the end of the modifiers; the string from this
6079 position is the unmodified symbol name.
6081 This doesn't use any caches. */
6084 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6090 CHECK_SYMBOL (symbol
);
6093 name
= SYMBOL_NAME (symbol
);
6095 for (i
= 0; i
< SBYTES (name
) - 1; )
6097 ptrdiff_t this_mod_end
= 0;
6100 /* See if the name continues with a modifier word.
6101 Check that the word appears, but don't check what follows it.
6102 Set this_mod and this_mod_end to record what we find. */
6104 switch (SREF (name
, i
))
6106 #define SINGLE_LETTER_MOD(BIT) \
6107 (this_mod_end = i + 1, this_mod = BIT)
6110 SINGLE_LETTER_MOD (alt_modifier
);
6114 SINGLE_LETTER_MOD (ctrl_modifier
);
6118 SINGLE_LETTER_MOD (hyper_modifier
);
6122 SINGLE_LETTER_MOD (meta_modifier
);
6126 SINGLE_LETTER_MOD (shift_modifier
);
6130 SINGLE_LETTER_MOD (super_modifier
);
6133 #undef SINGLE_LETTER_MOD
6135 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6136 if (i + LEN + 1 <= SBYTES (name) \
6137 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6139 this_mod_end = i + LEN; \
6144 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6145 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6146 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6150 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6152 #undef MULTI_LETTER_MOD
6156 /* If we found no modifier, stop looking for them. */
6157 if (this_mod_end
== 0)
6160 /* Check there is a dash after the modifier, so that it
6161 really is a modifier. */
6162 if (this_mod_end
>= SBYTES (name
)
6163 || SREF (name
, this_mod_end
) != '-')
6166 /* This modifier is real; look for another. */
6167 modifiers
|= this_mod
;
6168 i
= this_mod_end
+ 1;
6171 /* Should we include the `click' modifier? */
6172 if (! (modifiers
& (down_modifier
| drag_modifier
6173 | double_modifier
| triple_modifier
))
6174 && i
+ 7 == SBYTES (name
)
6175 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6176 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6177 modifiers
|= click_modifier
;
6179 if (! (modifiers
& (double_modifier
| triple_modifier
))
6180 && i
+ 6 < SBYTES (name
)
6181 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6182 modifiers
|= click_modifier
;
6190 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6191 prepended to the string BASE[0..BASE_LEN-1].
6192 This doesn't use any caches. */
6194 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6196 /* Since BASE could contain nulls, we can't use intern here; we have
6197 to use Fintern, which expects a genuine Lisp_String, and keeps a
6200 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6206 /* Only the event queue may use the `up' modifier; it should always
6207 be turned into a click or drag event before presented to lisp code. */
6208 if (modifiers
& up_modifier
)
6211 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6212 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6213 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6214 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6215 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6216 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6217 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6218 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6219 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6220 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6221 /* The click modifier is denoted by the absence of other modifiers. */
6225 mod_len
= p
- new_mods
;
6229 Lisp_Object new_name
;
6231 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6232 mod_len
+ base_len_byte
);
6233 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6234 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6236 return Fintern (new_name
, Qnil
);
6241 static const char *const modifier_names
[] =
6243 "up", "down", "drag", "click", "double", "triple", 0, 0,
6244 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6245 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6247 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6249 static Lisp_Object modifier_symbols
;
6251 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6253 lispy_modifier_list (int modifiers
)
6255 Lisp_Object modifier_list
;
6258 modifier_list
= Qnil
;
6259 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6260 if (modifiers
& (1<<i
))
6261 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6264 return modifier_list
;
6268 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6269 where UNMODIFIED is the unmodified form of SYMBOL,
6270 MASK is the set of modifiers present in SYMBOL's name.
6271 This is similar to parse_modifiers_uncached, but uses the cache in
6272 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6273 Qevent_symbol_elements property. */
6275 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6278 parse_modifiers (Lisp_Object symbol
)
6280 Lisp_Object elements
;
6282 if (INTEGERP (symbol
))
6283 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6284 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6286 else if (!SYMBOLP (symbol
))
6289 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6290 if (CONSP (elements
))
6295 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6296 Lisp_Object unmodified
;
6299 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6300 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6303 if (modifiers
& ~INTMASK
)
6305 XSETFASTINT (mask
, modifiers
);
6306 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6308 /* Cache the parsing results on SYMBOL. */
6309 Fput (symbol
, Qevent_symbol_element_mask
,
6311 Fput (symbol
, Qevent_symbol_elements
,
6312 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6314 /* Since we know that SYMBOL is modifiers applied to unmodified,
6315 it would be nice to put that in unmodified's cache.
6316 But we can't, since we're not sure that parse_modifiers is
6323 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6324 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6325 doc
: /* Parse the event symbol. For internal use. */)
6326 (Lisp_Object symbol
)
6328 /* Fill the cache if needed. */
6329 parse_modifiers (symbol
);
6330 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6331 and use the Lispier representation stored on Qevent_symbol_elements
6333 return Fget (symbol
, Qevent_symbol_elements
);
6336 /* Apply the modifiers MODIFIERS to the symbol BASE.
6337 BASE must be unmodified.
6339 This is like apply_modifiers_uncached, but uses BASE's
6340 Qmodifier_cache property, if present. It also builds
6341 Qevent_symbol_elements properties, since it has that info anyway.
6343 apply_modifiers copies the value of BASE's Qevent_kind property to
6344 the modified symbol. */
6346 apply_modifiers (int modifiers
, Lisp_Object base
)
6348 Lisp_Object cache
, idx
, entry
, new_symbol
;
6350 /* Mask out upper bits. We don't know where this value's been. */
6351 modifiers
&= INTMASK
;
6353 if (INTEGERP (base
))
6354 return make_number (XINT (base
) | modifiers
);
6356 /* The click modifier never figures into cache indices. */
6357 cache
= Fget (base
, Qmodifier_cache
);
6358 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6359 entry
= assq_no_quit (idx
, cache
);
6362 new_symbol
= XCDR (entry
);
6365 /* We have to create the symbol ourselves. */
6366 new_symbol
= apply_modifiers_uncached (modifiers
,
6367 SSDATA (SYMBOL_NAME (base
)),
6368 SCHARS (SYMBOL_NAME (base
)),
6369 SBYTES (SYMBOL_NAME (base
)));
6371 /* Add the new symbol to the base's cache. */
6372 entry
= Fcons (idx
, new_symbol
);
6373 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6375 /* We have the parsing info now for free, so we could add it to
6377 XSETFASTINT (idx, modifiers);
6378 Fput (new_symbol, Qevent_symbol_element_mask,
6379 Fcons (base, Fcons (idx, Qnil)));
6380 Fput (new_symbol, Qevent_symbol_elements,
6381 Fcons (base, lispy_modifier_list (modifiers)));
6382 Sadly, this is only correct if `base' is indeed a base event,
6383 which is not necessarily the case. -stef */
6386 /* Make sure this symbol is of the same kind as BASE.
6388 You'd think we could just set this once and for all when we
6389 intern the symbol above, but reorder_modifiers may call us when
6390 BASE's property isn't set right; we can't assume that just
6391 because it has a Qmodifier_cache property it must have its
6392 Qevent_kind set right as well. */
6393 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6397 kind
= Fget (base
, Qevent_kind
);
6399 Fput (new_symbol
, Qevent_kind
, kind
);
6406 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6407 return a symbol with the modifiers placed in the canonical order.
6408 Canonical order is alphabetical, except for down and drag, which
6409 always come last. The 'click' modifier is never written out.
6411 Fdefine_key calls this to make sure that (for example) C-M-foo
6412 and M-C-foo end up being equivalent in the keymap. */
6415 reorder_modifiers (Lisp_Object symbol
)
6417 /* It's hopefully okay to write the code this way, since everything
6418 will soon be in caches, and no consing will be done at all. */
6421 parsed
= parse_modifiers (symbol
);
6422 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6427 /* For handling events, we often want to produce a symbol whose name
6428 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6429 to some base, like the name of a function key or mouse button.
6430 modify_event_symbol produces symbols of this sort.
6432 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6433 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6436 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6437 into symbol names, or a string specifying a name stem used to
6438 construct a symbol name or the form `STEM-N', where N is the decimal
6439 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6440 non-nil; otherwise NAME_TABLE is used.
6442 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6443 persist between calls to modify_event_symbol that it can use to
6444 store a cache of the symbols it's generated for this NAME_TABLE
6445 before. The object stored there may be a vector or an alist.
6447 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6449 MODIFIERS is a set of modifier bits (as given in struct input_events)
6450 whose prefixes should be applied to the symbol name.
6452 SYMBOL_KIND is the value to be placed in the event_kind property of
6453 the returned symbol.
6455 The symbols we create are supposed to have an
6456 `event-symbol-elements' property, which lists the modifiers present
6457 in the symbol's name. */
6460 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6461 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6462 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6465 Lisp_Object symbol_int
;
6467 /* Get rid of the "vendor-specific" bit here. */
6468 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6470 /* Is this a request for a valid symbol? */
6471 if (symbol_num
< 0 || symbol_num
>= table_size
)
6474 if (CONSP (*symbol_table
))
6475 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6477 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6478 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6479 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6480 we've never used that symbol before. */
6483 if (! VECTORP (*symbol_table
)
6484 || ASIZE (*symbol_table
) != table_size
)
6488 XSETFASTINT (size
, table_size
);
6489 *symbol_table
= Fmake_vector (size
, Qnil
);
6492 value
= AREF (*symbol_table
, symbol_num
);
6495 /* Have we already used this symbol before? */
6498 /* No; let's create it. */
6499 if (CONSP (name_alist_or_stem
))
6500 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6501 else if (STRINGP (name_alist_or_stem
))
6504 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6505 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6507 SAFE_ALLOCA (buf
, char *, len
);
6508 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6509 XINT (symbol_int
) + 1);
6510 value
= intern (buf
);
6513 else if (name_table
!= 0 && name_table
[symbol_num
])
6514 value
= intern (name_table
[symbol_num
]);
6516 #ifdef HAVE_WINDOW_SYSTEM
6519 char *name
= x_get_keysym_name (symbol_num
);
6521 value
= intern (name
);
6527 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6528 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6529 value
= intern (buf
);
6532 if (CONSP (*symbol_table
))
6533 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6535 ASET (*symbol_table
, symbol_num
, value
);
6537 /* Fill in the cache entries for this symbol; this also
6538 builds the Qevent_symbol_elements property, which the user
6540 apply_modifiers (modifiers
& click_modifier
, value
);
6541 Fput (value
, Qevent_kind
, symbol_kind
);
6544 /* Apply modifiers to that symbol. */
6545 return apply_modifiers (modifiers
, value
);
6548 /* Convert a list that represents an event type,
6549 such as (ctrl meta backspace), into the usual representation of that
6550 event type as a number or a symbol. */
6552 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6553 doc
: /* Convert the event description list EVENT-DESC to an event type.
6554 EVENT-DESC should contain one base event type (a character or symbol)
6555 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6556 drag, down, double or triple). The base must be last.
6557 The return value is an event type (a character or symbol) which
6558 has the same base event type and all the specified modifiers. */)
6559 (Lisp_Object event_desc
)
6567 while (CONSP (rest
))
6575 /* Given a symbol, see if it is a modifier name. */
6576 if (SYMBOLP (elt
) && CONSP (rest
))
6577 this = parse_solitary_modifier (elt
);
6581 else if (!NILP (base
))
6582 error ("Two bases given in one event");
6588 /* Let the symbol A refer to the character A. */
6589 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6590 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6592 if (INTEGERP (base
))
6594 /* Turn (shift a) into A. */
6595 if ((modifiers
& shift_modifier
) != 0
6596 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6598 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6599 modifiers
&= ~shift_modifier
;
6602 /* Turn (control a) into C-a. */
6603 if (modifiers
& ctrl_modifier
)
6604 return make_number ((modifiers
& ~ctrl_modifier
)
6605 | make_ctrl_char (XINT (base
)));
6607 return make_number (modifiers
| XINT (base
));
6609 else if (SYMBOLP (base
))
6610 return apply_modifiers (modifiers
, base
);
6613 error ("Invalid base event");
6618 /* Try to recognize SYMBOL as a modifier name.
6619 Return the modifier flag bit, or 0 if not recognized. */
6622 parse_solitary_modifier (Lisp_Object symbol
)
6624 Lisp_Object name
= SYMBOL_NAME (symbol
);
6626 switch (SREF (name
, 0))
6628 #define SINGLE_LETTER_MOD(BIT) \
6629 if (SBYTES (name) == 1) \
6632 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6633 if (LEN == SBYTES (name) \
6634 && ! strncmp (SSDATA (name), NAME, LEN)) \
6638 SINGLE_LETTER_MOD (alt_modifier
);
6642 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6646 SINGLE_LETTER_MOD (ctrl_modifier
);
6650 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6651 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6655 SINGLE_LETTER_MOD (hyper_modifier
);
6659 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6663 SINGLE_LETTER_MOD (meta_modifier
);
6667 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6671 SINGLE_LETTER_MOD (shift_modifier
);
6675 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6676 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6677 SINGLE_LETTER_MOD (super_modifier
);
6681 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6682 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6683 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6687 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6690 #undef SINGLE_LETTER_MOD
6691 #undef MULTI_LETTER_MOD
6697 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6698 Such a list is not valid as an event,
6699 but it can be a Lucid-style event type list. */
6702 lucid_event_type_list_p (Lisp_Object object
)
6706 if (! CONSP (object
))
6709 if (EQ (XCAR (object
), Qhelp_echo
)
6710 || EQ (XCAR (object
), Qvertical_line
)
6711 || EQ (XCAR (object
), Qmode_line
)
6712 || EQ (XCAR (object
), Qheader_line
))
6715 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6719 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6726 /* Store into *addr a value nonzero if terminal input chars are available.
6727 Serves the purpose of ioctl (0, FIONREAD, addr)
6728 but works even if FIONREAD does not exist.
6729 (In fact, this may actually read some input.)
6731 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6732 timer events that are ripe.
6733 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6734 events (FOCUS_IN_EVENT).
6735 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6736 movements and toolkit scroll bar thumb drags. */
6739 get_input_pending (int *addr
, int flags
)
6741 /* First of all, have we already counted some input? */
6742 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6744 /* If input is being read as it arrives, and we have none, there is none. */
6745 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6748 /* Try to read some input and see how much we get. */
6750 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6753 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6756 gobble_input (int expected
)
6759 if (interrupt_input
)
6762 mask
= sigblock (sigmask (SIGIO
));
6763 read_avail_input (expected
);
6767 #ifdef POLL_FOR_INPUT
6768 /* XXX This condition was (read_socket_hook && !interrupt_input),
6769 but read_socket_hook is not global anymore. Let's pretend that
6771 if (!interrupt_input
&& poll_suppress_count
== 0)
6774 mask
= sigblock (sigmask (SIGALRM
));
6775 read_avail_input (expected
);
6781 read_avail_input (expected
);
6784 /* Put a BUFFER_SWITCH_EVENT in the buffer
6785 so that read_key_sequence will notice the new current buffer. */
6788 record_asynch_buffer_change (void)
6790 struct input_event event
;
6794 event
.kind
= BUFFER_SWITCH_EVENT
;
6795 event
.frame_or_window
= Qnil
;
6798 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6799 The purpose of the event is to make read_key_sequence look up the
6800 keymaps again. If we aren't in read_key_sequence, we don't need one,
6801 and the event could cause trouble by messing up (input-pending-p).
6802 Note: Fwaiting_for_user_input_p always returns nil when async
6803 subprocesses aren't supported. */
6804 tem
= Fwaiting_for_user_input_p ();
6808 /* Make sure no interrupt happens while storing the event. */
6810 if (interrupt_input
)
6813 mask
= sigblock (sigmask (SIGIO
));
6814 kbd_buffer_store_event (&event
);
6821 kbd_buffer_store_event (&event
);
6826 /* Read any terminal input already buffered up by the system
6827 into the kbd_buffer, but do not wait.
6829 EXPECTED should be nonzero if the caller knows there is some input.
6831 Returns the number of keyboard chars read, or -1 meaning
6832 this is a bad time to try to read input. */
6835 read_avail_input (int expected
)
6841 /* Store pending user signal events, if any. */
6842 if (store_user_signal_events ())
6845 /* Loop through the available terminals, and call their input hooks. */
6849 struct terminal
*next
= t
->next_terminal
;
6851 if (t
->read_socket_hook
)
6854 struct input_event hold_quit
;
6856 EVENT_INIT (hold_quit
);
6857 hold_quit
.kind
= NO_EVENT
;
6859 /* No need for FIONREAD or fcntl; just say don't wait. */
6860 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6866 if (nr
== -1) /* Not OK to read input now. */
6870 else if (nr
== -2) /* Non-transient error. */
6872 /* The terminal device terminated; it should be closed. */
6874 /* Kill Emacs if this was our last terminal. */
6875 if (!terminal_list
->next_terminal
)
6876 /* Formerly simply reported no input, but that
6877 sometimes led to a failure of Emacs to terminate.
6878 SIGHUP seems appropriate if we can't reach the
6880 /* ??? Is it really right to send the signal just to
6881 this process rather than to the whole process
6882 group? Perhaps on systems with FIONREAD Emacs is
6883 alone in its group. */
6884 kill (getpid (), SIGHUP
);
6886 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6889 XSETTERMINAL (tmp
, t
);
6890 Fdelete_terminal (tmp
, Qnoelisp
);
6894 if (hold_quit
.kind
!= NO_EVENT
)
6895 kbd_buffer_store_event (&hold_quit
);
6904 frame_make_pointer_visible ();
6910 decode_keyboard_code (struct tty_display_info
*tty
,
6911 struct coding_system
*coding
,
6912 unsigned char *buf
, int nbytes
)
6914 unsigned char *src
= buf
;
6915 const unsigned char *p
;
6920 if (tty
->meta_key
!= 2)
6921 for (i
= 0; i
< nbytes
; i
++)
6923 if (coding
->carryover_bytes
> 0)
6925 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6926 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6927 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6928 nbytes
+= coding
->carryover_bytes
;
6930 coding
->destination
= alloca (nbytes
* 4);
6931 coding
->dst_bytes
= nbytes
* 4;
6932 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6933 if (coding
->produced_char
== 0)
6935 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6937 struct input_event event_buf
;
6939 EVENT_INIT (event_buf
);
6940 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6942 (ASCII_CHAR_P (event_buf
.code
)
6943 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6944 /* See the comment in tty_read_avail_input. */
6945 event_buf
.frame_or_window
= tty
->top_frame
;
6946 event_buf
.arg
= Qnil
;
6947 kbd_buffer_store_event (&event_buf
);
6951 /* This is the tty way of reading available input.
6953 Note that each terminal device has its own `struct terminal' object,
6954 and so this function is called once for each individual termcap
6955 terminal. The first parameter indicates which terminal to read from. */
6958 tty_read_avail_input (struct terminal
*terminal
,
6960 struct input_event
*hold_quit
)
6962 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6963 the kbd_buffer can really hold. That may prevent loss
6964 of characters on some systems when input is stuffed at us. */
6965 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6967 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6970 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6972 if (kbd_on_hold_p () || buffer_free
<= 0)
6974 #endif /* subprocesses */
6976 if (!terminal
->name
) /* Don't read from a dead terminal. */
6979 if (terminal
->type
!= output_termcap
6980 && terminal
->type
!= output_msdos_raw
)
6983 /* XXX I think the following code should be moved to separate hook
6984 functions in system-dependent files. */
6987 #else /* not WINDOWSNT */
6988 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6992 return 0; /* The terminal is suspended. */
6995 n_to_read
= dos_keysns ();
6999 cbuf
[0] = dos_keyread ();
7002 #else /* not MSDOS */
7007 struct input_event gpm_hold_quit
;
7008 int gpm
, fd
= gpm_fd
;
7010 EVENT_INIT (gpm_hold_quit
);
7011 gpm_hold_quit
.kind
= NO_EVENT
;
7013 /* gpm==1 if event received.
7014 gpm==0 if the GPM daemon has closed the connection, in which case
7015 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7016 we save it in `fd' so close_gpm can remove it from the
7018 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7019 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7020 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7023 /* Presumably the GPM daemon has closed the connection. */
7025 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7026 kbd_buffer_store_event (&gpm_hold_quit
);
7030 #endif /* HAVE_GPM */
7032 /* Determine how many characters we should *try* to read. */
7034 /* Find out how much input is available. */
7035 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7037 if (! noninteractive
)
7038 return -2; /* Close this terminal. */
7044 if (n_to_read
> sizeof cbuf
)
7045 n_to_read
= sizeof cbuf
;
7046 #else /* no FIONREAD */
7047 #if defined (USG) || defined (CYGWIN)
7048 /* Read some input if available, but don't wait. */
7049 n_to_read
= sizeof cbuf
;
7050 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7057 /* Don't read more than we can store. */
7058 if (n_to_read
> buffer_free
)
7059 n_to_read
= buffer_free
;
7060 #endif /* subprocesses */
7062 /* Now read; for one reason or another, this will not block.
7063 NREAD is set to the number of chars read. */
7066 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7067 /* POSIX infers that processes which are not in the session leader's
7068 process group won't get SIGHUP's at logout time. BSDI adheres to
7069 this part standard and returns -1 from read (0) with errno==EIO
7070 when the control tty is taken away.
7071 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7072 if (nread
== -1 && errno
== EIO
)
7073 return -2; /* Close this terminal. */
7074 #if defined (AIX) && defined (_BSD)
7075 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7076 This looks incorrect, but it isn't, because _BSD causes
7077 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7078 and that causes a value other than 0 when there is no input. */
7080 return -2; /* Close this terminal. */
7084 /* We used to retry the read if it was interrupted.
7085 But this does the wrong thing when O_NDELAY causes
7086 an EAGAIN error. Does anybody know of a situation
7087 where a retry is actually needed? */
7089 nread
< 0 && (errno
== EAGAIN
7103 #if defined (USG) || defined (CYGWIN)
7104 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7105 #endif /* USG or CYGWIN */
7106 #endif /* no FIONREAD */
7111 #endif /* not MSDOS */
7112 #endif /* not WINDOWSNT */
7114 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7115 & CODING_REQUIRE_DECODING_MASK
)
7117 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7120 /* Decode the key sequence except for those with meta
7122 for (i
= from
= 0; ; i
++)
7123 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7125 struct input_event buf
;
7127 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7132 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7133 buf
.modifiers
= meta_modifier
;
7134 buf
.code
= cbuf
[i
] & ~0x80;
7135 /* See the comment below. */
7136 buf
.frame_or_window
= tty
->top_frame
;
7138 kbd_buffer_store_event (&buf
);
7144 for (i
= 0; i
< nread
; i
++)
7146 struct input_event buf
;
7148 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7150 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7151 buf
.modifiers
= meta_modifier
;
7152 if (tty
->meta_key
!= 2)
7156 /* Set the frame corresponding to the active tty. Note that the
7157 value of selected_frame is not reliable here, redisplay tends
7158 to temporarily change it. */
7159 buf
.frame_or_window
= tty
->top_frame
;
7162 kbd_buffer_store_event (&buf
);
7163 /* Don't look at input that follows a C-g too closely.
7164 This reduces lossage due to autorepeat on C-g. */
7165 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7166 && buf
.code
== quit_char
)
7173 #if defined SYNC_INPUT || defined SIGIO
7175 handle_async_input (void)
7177 interrupt_input_pending
= 0;
7179 pending_signals
= pending_atimers
;
7181 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7182 doing anything dangerous. */
7189 nread
= read_avail_input (1);
7190 /* -1 means it's not ok to read the input now.
7191 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7192 0 means there was no keyboard input available. */
7200 #endif /* SYNC_INPUT || SIGIO */
7204 process_pending_signals (void)
7206 if (interrupt_input_pending
)
7207 handle_async_input ();
7208 do_pending_atimers ();
7212 #ifdef SIGIO /* for entire page */
7213 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7216 input_available_signal (int signo
)
7218 /* Must preserve main program's value of errno. */
7219 int old_errno
= errno
;
7220 SIGNAL_THREAD_CHECK (signo
);
7223 interrupt_input_pending
= 1;
7224 pending_signals
= 1;
7227 if (input_available_clear_time
)
7228 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7231 handle_async_input ();
7238 /* Send ourselves a SIGIO.
7240 This function exists so that the UNBLOCK_INPUT macro in
7241 blockinput.h can have some way to take care of input we put off
7242 dealing with, without assuming that every file which uses
7243 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7245 reinvoke_input_signal (void)
7248 handle_async_input ();
7254 /* User signal events. */
7256 struct user_signal_info
7258 /* Signal number. */
7261 /* Name of the signal. */
7264 /* Number of pending signals. */
7267 struct user_signal_info
*next
;
7270 /* List of user signals. */
7271 static struct user_signal_info
*user_signals
= NULL
;
7274 add_user_signal (int sig
, const char *name
)
7276 struct user_signal_info
*p
;
7278 for (p
= user_signals
; p
; p
= p
->next
)
7280 /* Already added. */
7283 p
= xmalloc (sizeof (struct user_signal_info
));
7285 p
->name
= xstrdup (name
);
7287 p
->next
= user_signals
;
7290 signal (sig
, handle_user_signal
);
7294 handle_user_signal (int sig
)
7296 int old_errno
= errno
;
7297 struct user_signal_info
*p
;
7298 const char *special_event_name
= NULL
;
7300 SIGNAL_THREAD_CHECK (sig
);
7302 if (SYMBOLP (Vdebug_on_event
))
7303 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7305 for (p
= user_signals
; p
; p
= p
->next
)
7308 if (special_event_name
7309 && strcmp (special_event_name
, p
->name
) == 0)
7311 /* Enter the debugger in many ways. */
7312 debug_on_next_call
= 1;
7315 Vinhibit_quit
= Qnil
;
7317 /* Eat the event. */
7323 if (interrupt_input
)
7324 kill (getpid (), SIGIO
);
7328 /* Tell wait_reading_process_output that it needs to wake
7329 up and look around. */
7330 if (input_available_clear_time
)
7331 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7340 find_user_signal_name (int sig
)
7342 struct user_signal_info
*p
;
7344 for (p
= user_signals
; p
; p
= p
->next
)
7352 store_user_signal_events (void)
7354 struct user_signal_info
*p
;
7355 struct input_event buf
;
7358 for (p
= user_signals
; p
; p
= p
->next
)
7359 if (p
->npending
> 0)
7365 memset (&buf
, 0, sizeof buf
);
7366 buf
.kind
= USER_SIGNAL_EVENT
;
7367 buf
.frame_or_window
= selected_frame
;
7369 nstored
+= p
->npending
;
7371 mask
= sigblock (sigmask (p
->sig
));
7375 kbd_buffer_store_event (&buf
);
7378 while (p
->npending
> 0);
7386 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7387 static Lisp_Object menu_bar_one_keymap_changed_items
;
7389 /* These variables hold the vector under construction within
7390 menu_bar_items and its subroutines, and the current index
7391 for storing into that vector. */
7392 static Lisp_Object menu_bar_items_vector
;
7393 static int menu_bar_items_index
;
7396 static const char* separator_names
[] = {
7401 "single-dashed-line",
7402 "double-dashed-line",
7404 "shadow-etched-out",
7405 "shadow-etched-in-dash",
7406 "shadow-etched-out-dash",
7407 "shadow-double-etched-in",
7408 "shadow-double-etched-out",
7409 "shadow-double-etched-in-dash",
7410 "shadow-double-etched-out-dash",
7414 /* Return non-zero if LABEL specifies a separator. */
7417 menu_separator_name_p (const char *label
)
7421 else if (strlen (label
) > 3
7422 && strncmp (label
, "--", 2) == 0
7427 for (i
= 0; separator_names
[i
]; ++i
)
7428 if (strcmp (label
, separator_names
[i
]) == 0)
7433 /* It's a separator if it contains only dashes. */
7434 while (*label
== '-')
7436 return (*label
== 0);
7443 /* Return a vector of menu items for a menu bar, appropriate
7444 to the current buffer. Each item has three elements in the vector:
7447 OLD is an old vector we can optionally reuse, or nil. */
7450 menu_bar_items (Lisp_Object old
)
7452 /* The number of keymaps we're scanning right now, and the number of
7453 keymaps we have allocated space for. */
7456 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7457 in the current keymaps, or nil where it is not a prefix. */
7460 Lisp_Object def
, tail
;
7465 /* In order to build the menus, we need to call the keymap
7466 accessors. They all call QUIT. But this function is called
7467 during redisplay, during which a quit is fatal. So inhibit
7468 quitting while building the menus.
7469 We do this instead of specbind because (1) errors will clear it anyway
7470 and (2) this avoids risk of specpdl overflow. */
7471 oquit
= Vinhibit_quit
;
7475 menu_bar_items_vector
= old
;
7477 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7478 menu_bar_items_index
= 0;
7480 /* Build our list of keymaps.
7481 If we recognize a function key and replace its escape sequence in
7482 keybuf with its symbol, or if the sequence starts with a mouse
7483 click and we need to switch buffers, we jump back here to rebuild
7484 the initial keymaps from the current buffer. */
7488 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7489 if (!NILP (Voverriding_local_map_menu_flag
))
7491 /* Yes, use them (if non-nil) as well as the global map. */
7492 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7494 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7495 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7496 if (!NILP (Voverriding_local_map
))
7497 maps
[nmaps
++] = Voverriding_local_map
;
7501 /* No, so use major and minor mode keymaps and keymap property.
7502 Note that menu-bar bindings in the local-map and keymap
7503 properties may not work reliable, as they are only
7504 recognized when the menu-bar (or mode-line) is updated,
7505 which does not normally happen after every command. */
7508 nminor
= current_minor_maps (NULL
, &tmaps
);
7509 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7511 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7512 maps
[nmaps
++] = tem
;
7513 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7515 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7517 maps
[nmaps
++] = current_global_map
;
7520 /* Look up in each map the dummy prefix key `menu-bar'. */
7522 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7523 if (!NILP (maps
[mapno
]))
7525 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7529 menu_bar_one_keymap_changed_items
= Qnil
;
7530 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7534 /* Move to the end those items that should be at the end. */
7536 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7539 int end
= menu_bar_items_index
;
7541 for (i
= 0; i
< end
; i
+= 4)
7542 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7544 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7545 /* Move the item at index I to the end,
7546 shifting all the others forward. */
7547 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7548 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7549 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7550 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7552 memmove (&AREF (menu_bar_items_vector
, i
),
7553 &AREF (menu_bar_items_vector
, i
+ 4),
7554 (end
- i
- 4) * sizeof (Lisp_Object
));
7555 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7556 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7557 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7558 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7563 /* Add nil, nil, nil, nil at the end. */
7565 int i
= menu_bar_items_index
;
7566 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7567 menu_bar_items_vector
=
7568 larger_vector (menu_bar_items_vector
, 4, -1);
7569 /* Add this item. */
7570 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7571 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7572 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7573 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7574 menu_bar_items_index
= i
;
7577 Vinhibit_quit
= oquit
;
7578 return menu_bar_items_vector
;
7581 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7582 If there's already an item for KEY, add this DEF to it. */
7584 Lisp_Object item_properties
;
7587 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7589 struct gcpro gcpro1
;
7593 if (EQ (item
, Qundefined
))
7595 /* If a map has an explicit `undefined' as definition,
7596 discard any previously made menu bar item. */
7598 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7599 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7601 if (menu_bar_items_index
> i
+ 4)
7602 memmove (&AREF (menu_bar_items_vector
, i
),
7603 &AREF (menu_bar_items_vector
, i
+ 4),
7604 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7605 menu_bar_items_index
-= 4;
7609 /* If this keymap has already contributed to this KEY,
7610 don't contribute to it a second time. */
7611 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7612 if (!NILP (tem
) || NILP (item
))
7615 menu_bar_one_keymap_changed_items
7616 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7618 /* We add to menu_bar_one_keymap_changed_items before doing the
7619 parse_menu_item, so that if it turns out it wasn't a menu item,
7620 it still correctly hides any further menu item. */
7622 i
= parse_menu_item (item
, 1);
7627 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7629 /* Find any existing item for this KEY. */
7630 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7631 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7634 /* If we did not find this KEY, add it at the end. */
7635 if (i
== menu_bar_items_index
)
7637 /* If vector is too small, get a bigger one. */
7638 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7639 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7640 /* Add this item. */
7641 ASET (menu_bar_items_vector
, i
, key
); i
++;
7642 ASET (menu_bar_items_vector
, i
,
7643 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7644 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7645 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7646 menu_bar_items_index
= i
;
7648 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7652 old
= AREF (menu_bar_items_vector
, i
+ 2);
7653 /* If the new and the old items are not both keymaps,
7654 the lookup will only find `item'. */
7655 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7656 ASET (menu_bar_items_vector
, i
+ 2, item
);
7660 /* This is used as the handler when calling menu_item_eval_property. */
7662 menu_item_eval_property_1 (Lisp_Object arg
)
7664 /* If we got a quit from within the menu computation,
7665 quit all the way out of it. This takes care of C-] in the debugger. */
7666 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7667 Fsignal (Qquit
, Qnil
);
7673 eval_dyn (Lisp_Object form
)
7675 return Feval (form
, Qnil
);
7678 /* Evaluate an expression and return the result (or nil if something
7679 went wrong). Used to evaluate dynamic parts of menu items. */
7681 menu_item_eval_property (Lisp_Object sexpr
)
7683 ptrdiff_t count
= SPECPDL_INDEX ();
7685 specbind (Qinhibit_redisplay
, Qt
);
7686 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7687 menu_item_eval_property_1
);
7688 return unbind_to (count
, val
);
7691 /* This function parses a menu item and leaves the result in the
7692 vector item_properties.
7693 ITEM is a key binding, a possible menu item.
7694 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7696 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7697 parse_menu_item returns true if the item is a menu item and false
7701 parse_menu_item (Lisp_Object item
, int inmenubar
)
7703 Lisp_Object def
, tem
, item_string
, start
;
7705 Lisp_Object keyhint
;
7714 /* Create item_properties vector if necessary. */
7715 if (NILP (item_properties
))
7717 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7719 /* Initialize optional entries. */
7720 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7721 ASET (item_properties
, i
, Qnil
);
7722 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7724 /* Save the item here to protect it from GC. */
7725 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7727 item_string
= XCAR (item
);
7731 if (STRINGP (item_string
))
7733 /* Old format menu item. */
7734 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7736 /* Maybe help string. */
7737 if (CONSP (item
) && STRINGP (XCAR (item
)))
7739 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7744 /* Maybe an obsolete key binding cache. */
7745 if (CONSP (item
) && CONSP (XCAR (item
))
7746 && (NILP (XCAR (XCAR (item
)))
7747 || VECTORP (XCAR (XCAR (item
)))))
7750 /* This is the real definition--the function to run. */
7751 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7753 /* Get enable property, if any. */
7756 tem
= Fget (item
, Qmenu_enable
);
7757 if (!NILP (Venable_disabled_menus_and_buttons
))
7758 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7759 else if (!NILP (tem
))
7760 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7763 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7765 /* New format menu item. */
7766 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7767 start
= XCDR (item
);
7770 /* We have a real binding. */
7771 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7773 item
= XCDR (start
);
7774 /* Is there an obsolete cache list with key equivalences. */
7775 if (CONSP (item
) && CONSP (XCAR (item
)))
7778 /* Parse properties. */
7779 while (CONSP (item
) && CONSP (XCDR (item
)))
7784 if (EQ (tem
, QCenable
))
7786 if (!NILP (Venable_disabled_menus_and_buttons
))
7787 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7789 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7791 else if (EQ (tem
, QCvisible
))
7793 /* If got a visible property and that evaluates to nil
7794 then ignore this item. */
7795 tem
= menu_item_eval_property (XCAR (item
));
7799 else if (EQ (tem
, QChelp
))
7800 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7801 else if (EQ (tem
, QCfilter
))
7803 else if (EQ (tem
, QCkey_sequence
))
7806 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7807 /* Be GC protected. Set keyhint to item instead of tem. */
7810 else if (EQ (tem
, QCkeys
))
7813 if (CONSP (tem
) || STRINGP (tem
))
7814 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7816 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7821 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7823 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7825 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7831 else if (inmenubar
|| !NILP (start
))
7835 return 0; /* not a menu item */
7837 /* If item string is not a string, evaluate it to get string.
7838 If we don't get a string, skip this item. */
7839 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7840 if (!(STRINGP (item_string
)))
7842 item_string
= menu_item_eval_property (item_string
);
7843 if (!STRINGP (item_string
))
7845 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7848 /* If got a filter apply it on definition. */
7849 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7852 def
= menu_item_eval_property (list2 (XCAR (filter
),
7853 list2 (Qquote
, def
)));
7855 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7858 /* Enable or disable selection of item. */
7859 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7862 tem
= menu_item_eval_property (tem
);
7863 if (inmenubar
&& NILP (tem
))
7864 return 0; /* Ignore disabled items in menu bar. */
7865 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7868 /* If we got no definition, this item is just unselectable text which
7869 is OK in a submenu but not in the menubar. */
7871 return (!inmenubar
);
7873 /* See if this is a separate pane or a submenu. */
7874 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7875 tem
= get_keymap (def
, 0, 1);
7876 /* For a subkeymap, just record its details and exit. */
7879 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7880 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7884 /* At the top level in the menu bar, do likewise for commands also.
7885 The menu bar does not display equivalent key bindings anyway.
7886 ITEM_PROPERTY_DEF is already set up properly. */
7890 { /* This is a command. See if there is an equivalent key binding. */
7891 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7893 /* The previous code preferred :key-sequence to :keys, so we
7894 preserve this behavior. */
7895 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7896 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7899 Lisp_Object prefix
= keyeq
;
7900 Lisp_Object keys
= Qnil
;
7904 def
= XCAR (prefix
);
7905 prefix
= XCDR (prefix
);
7908 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7910 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7912 keys
= XCAR (keyhint
);
7913 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7915 /* We have a suggested key. Is it bound to the command? */
7918 /* If the command is an alias for another
7919 (such as lmenu.el set it up), check if the
7920 original command matches the cached command. */
7921 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7926 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7930 tem
= Fkey_description (keys
, Qnil
);
7933 if (STRINGP (XCAR (prefix
)))
7934 tem
= concat2 (XCAR (prefix
), tem
);
7935 if (STRINGP (XCDR (prefix
)))
7936 tem
= concat2 (tem
, XCDR (prefix
));
7938 keyeq
= concat2 (build_string (" "), tem
);
7939 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7945 /* If we have an equivalent key binding, use that. */
7946 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7949 /* Include this when menu help is implemented.
7950 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7951 if (!(NILP (tem) || STRINGP (tem)))
7953 tem = menu_item_eval_property (tem);
7956 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7960 /* Handle radio buttons or toggle boxes. */
7961 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7963 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7964 menu_item_eval_property (tem
));
7971 /***********************************************************************
7973 ***********************************************************************/
7975 /* A vector holding tool bar items while they are parsed in function
7976 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7979 static Lisp_Object tool_bar_items_vector
;
7981 /* A vector holding the result of parse_tool_bar_item. Layout is like
7982 the one for a single item in tool_bar_items_vector. */
7984 static Lisp_Object tool_bar_item_properties
;
7986 /* Next free index in tool_bar_items_vector. */
7988 static int ntool_bar_items
;
7990 /* The symbols `:image' and `:rtl'. */
7992 static Lisp_Object QCimage
;
7993 static Lisp_Object QCrtl
;
7995 /* Function prototypes. */
7997 static void init_tool_bar_items (Lisp_Object
);
7998 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7999 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8000 static void append_tool_bar_item (void);
8003 /* Return a vector of tool bar items for keymaps currently in effect.
8004 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8005 tool bar items found. */
8008 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8017 /* In order to build the menus, we need to call the keymap
8018 accessors. They all call QUIT. But this function is called
8019 during redisplay, during which a quit is fatal. So inhibit
8020 quitting while building the menus. We do this instead of
8021 specbind because (1) errors will clear it anyway and (2) this
8022 avoids risk of specpdl overflow. */
8023 oquit
= Vinhibit_quit
;
8026 /* Initialize tool_bar_items_vector and protect it from GC. */
8027 init_tool_bar_items (reuse
);
8029 /* Build list of keymaps in maps. Set nmaps to the number of maps
8032 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8033 if (!NILP (Voverriding_local_map_menu_flag
))
8035 /* Yes, use them (if non-nil) as well as the global map. */
8036 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8038 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8039 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8040 if (!NILP (Voverriding_local_map
))
8041 maps
[nmaps
++] = Voverriding_local_map
;
8045 /* No, so use major and minor mode keymaps and keymap property.
8046 Note that tool-bar bindings in the local-map and keymap
8047 properties may not work reliable, as they are only
8048 recognized when the tool-bar (or mode-line) is updated,
8049 which does not normally happen after every command. */
8052 nminor
= current_minor_maps (NULL
, &tmaps
);
8053 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8055 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8056 maps
[nmaps
++] = tem
;
8057 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8059 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8062 /* Add global keymap at the end. */
8063 maps
[nmaps
++] = current_global_map
;
8065 /* Process maps in reverse order and look up in each map the prefix
8067 for (i
= nmaps
- 1; i
>= 0; --i
)
8068 if (!NILP (maps
[i
]))
8072 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8074 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8077 Vinhibit_quit
= oquit
;
8078 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8079 return tool_bar_items_vector
;
8083 /* Process the definition of KEY which is DEF. */
8086 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8089 struct gcpro gcpro1
, gcpro2
;
8091 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8095 if (EQ (def
, Qundefined
))
8097 /* If a map has an explicit `undefined' as definition,
8098 discard any previously made item. */
8099 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8101 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8103 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8105 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8106 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8107 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8108 * sizeof (Lisp_Object
)));
8109 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8114 else if (parse_tool_bar_item (key
, def
))
8115 /* Append a new tool bar item to tool_bar_items_vector. Accept
8116 more than one definition for the same key. */
8117 append_tool_bar_item ();
8123 /* Parse a tool bar item specification ITEM for key KEY and return the
8124 result in tool_bar_item_properties. Value is zero if ITEM is
8127 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8129 CAPTION is the caption of the item, If it's not a string, it is
8130 evaluated to get a string.
8132 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8133 as binding are currently ignored.
8135 The following properties are recognized:
8139 FORM is evaluated and specifies whether the tool bar item is
8140 enabled or disabled.
8144 FORM is evaluated and specifies whether the tool bar item is visible.
8146 - `:filter FUNCTION'
8148 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8149 result is stored as the new binding.
8151 - `:button (TYPE SELECTED)'
8153 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8154 and specifies whether the button is selected (pressed) or not.
8158 IMAGES is either a single image specification or a vector of four
8159 image specifications. See enum tool_bar_item_images.
8161 - `:help HELP-STRING'.
8163 Gives a help string to display for the tool bar item.
8165 - `:label LABEL-STRING'.
8167 A text label to show with the tool bar button if labels are enabled. */
8170 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8172 /* Access slot with index IDX of vector tool_bar_item_properties. */
8173 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8175 Lisp_Object filter
= Qnil
;
8176 Lisp_Object caption
;
8177 int i
, have_label
= 0;
8179 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8180 Rule out items that aren't lists, don't start with
8181 `menu-item' or whose rest following `tool-bar-item' is not a
8186 /* As an exception, allow old-style menu separators. */
8187 if (STRINGP (XCAR (item
)))
8188 item
= Fcons (XCAR (item
), Qnil
);
8189 else if (!EQ (XCAR (item
), Qmenu_item
)
8190 || (item
= XCDR (item
), !CONSP (item
)))
8193 /* Create tool_bar_item_properties vector if necessary. Reset it to
8195 if (VECTORP (tool_bar_item_properties
))
8197 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8201 tool_bar_item_properties
8202 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8205 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8206 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8208 /* Get the caption of the item. If the caption is not a string,
8209 evaluate it to get a string. If we don't get a string, skip this
8211 caption
= XCAR (item
);
8212 if (!STRINGP (caption
))
8214 caption
= menu_item_eval_property (caption
);
8215 if (!STRINGP (caption
))
8218 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8220 /* If the rest following the caption is not a list, the menu item is
8221 either a separator, or invalid. */
8225 if (menu_separator_name_p (SSDATA (caption
)))
8227 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8228 #if !defined (USE_GTK) && !defined (HAVE_NS)
8229 /* If we use build_desired_tool_bar_string to render the
8230 tool bar, the separator is rendered as an image. */
8231 PROP (TOOL_BAR_ITEM_IMAGES
)
8232 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8233 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8234 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8235 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8242 /* Store the binding. */
8243 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8246 /* Ignore cached key binding, if any. */
8247 if (CONSP (item
) && CONSP (XCAR (item
)))
8250 /* Process the rest of the properties. */
8251 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8253 Lisp_Object ikey
, value
;
8256 value
= XCAR (XCDR (item
));
8258 if (EQ (ikey
, QCenable
))
8260 /* `:enable FORM'. */
8261 if (!NILP (Venable_disabled_menus_and_buttons
))
8262 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8264 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8266 else if (EQ (ikey
, QCvisible
))
8268 /* `:visible FORM'. If got a visible property and that
8269 evaluates to nil then ignore this item. */
8270 if (NILP (menu_item_eval_property (value
)))
8273 else if (EQ (ikey
, QChelp
))
8274 /* `:help HELP-STRING'. */
8275 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8276 else if (EQ (ikey
, QCvert_only
))
8277 /* `:vert-only t/nil'. */
8278 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8279 else if (EQ (ikey
, QClabel
))
8281 const char *bad_label
= "!!?GARBLED ITEM?!!";
8282 /* `:label LABEL-STRING'. */
8283 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8285 : build_string (bad_label
);
8288 else if (EQ (ikey
, QCfilter
))
8289 /* ':filter FORM'. */
8291 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8293 /* `:button (TYPE . SELECTED)'. */
8294 Lisp_Object type
, selected
;
8296 type
= XCAR (value
);
8297 selected
= XCDR (value
);
8298 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8300 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8301 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8304 else if (EQ (ikey
, QCimage
)
8306 || (VECTORP (value
) && ASIZE (value
) == 4)))
8307 /* Value is either a single image specification or a vector
8308 of 4 such specifications for the different button states. */
8309 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8310 else if (EQ (ikey
, QCrtl
))
8312 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8318 /* Try to make one from caption and key. */
8319 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8320 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8321 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8322 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8324 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8325 char *buf
= xmalloc (max_lbl
+ 1);
8326 Lisp_Object new_lbl
;
8327 ptrdiff_t caption_len
= strlen (capt
);
8329 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8332 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8334 buf
[caption_len
] = '\0';
8338 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8342 strcpy (buf
, label
);
8344 for (j
= 0; buf
[j
] != '\0'; ++j
)
8352 new_lbl
= Fupcase_initials (build_string (label
));
8353 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8354 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8356 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8360 /* If got a filter apply it on binding. */
8362 PROP (TOOL_BAR_ITEM_BINDING
)
8363 = menu_item_eval_property (list2 (filter
,
8365 PROP (TOOL_BAR_ITEM_BINDING
))));
8367 /* See if the binding is a keymap. Give up if it is. */
8368 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8371 /* Enable or disable selection of item. */
8372 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8373 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8374 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8376 /* Handle radio buttons or toggle boxes. */
8377 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8378 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8379 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8387 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8388 that can be reused. */
8391 init_tool_bar_items (Lisp_Object reuse
)
8393 if (VECTORP (reuse
))
8394 tool_bar_items_vector
= reuse
;
8396 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8397 ntool_bar_items
= 0;
8401 /* Append parsed tool bar item properties from
8402 tool_bar_item_properties */
8405 append_tool_bar_item (void)
8407 Lisp_Object
*to
, *from
;
8410 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8412 /* Enlarge tool_bar_items_vector if necessary. */
8414 tool_bar_items_vector
8415 = larger_vector (tool_bar_items_vector
, incr
, -1);
8417 /* Append entries from tool_bar_item_properties to the end of
8418 tool_bar_items_vector. */
8419 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8420 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8421 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8422 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8429 /* Read a character using menus based on maps in the array MAPS.
8430 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8431 Return t if we displayed a menu but the user rejected it.
8433 PREV_EVENT is the previous input event, or nil if we are reading
8434 the first event of a key sequence.
8436 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8437 if we used a mouse menu to read the input, or zero otherwise. If
8438 USED_MOUSE_MENU is null, we don't dereference it.
8440 The prompting is done based on the prompt-string of the map
8441 and the strings associated with various map elements.
8443 This can be done with X menus or with menus put in the minibuf.
8444 These are done in different ways, depending on how the input will be read.
8445 Menus using X are done after auto-saving in read-char, getting the input
8446 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8447 and do auto-saving in the inner call of read_char. */
8450 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8451 Lisp_Object prev_event
, int *used_mouse_menu
)
8455 if (used_mouse_menu
)
8456 *used_mouse_menu
= 0;
8458 /* Use local over global Menu maps */
8460 if (! menu_prompting
)
8463 /* Optionally disregard all but the global map. */
8464 if (inhibit_local_menu_bar_menus
)
8466 maps
+= (nmaps
- 1);
8471 /* If we got to this point via a mouse click,
8472 use a real menu for mouse selection. */
8473 if (EVENT_HAS_PARAMETERS (prev_event
)
8474 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8475 && !EQ (XCAR (prev_event
), Qtool_bar
))
8477 /* Display the menu and get the selection. */
8478 Lisp_Object
*realmaps
8479 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8481 ptrdiff_t nmaps1
= 0;
8483 /* Use the maps that are not nil. */
8484 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8485 if (!NILP (maps
[mapno
]))
8486 realmaps
[nmaps1
++] = maps
[mapno
];
8488 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8493 record_menu_key (XCAR (value
));
8495 /* If we got multiple events, unread all but
8497 There is no way to prevent those unread events
8498 from showing up later in last_nonmenu_event.
8499 So turn symbol and integer events into lists,
8500 to indicate that they came from a mouse menu,
8501 so that when present in last_nonmenu_event
8502 they won't confuse things. */
8503 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8505 record_menu_key (XCAR (tem
));
8506 if (SYMBOLP (XCAR (tem
))
8507 || INTEGERP (XCAR (tem
)))
8508 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8511 /* If we got more than one event, put all but the first
8512 onto this list to be read later.
8513 Return just the first event now. */
8514 Vunread_command_events
8515 = nconc2 (XCDR (value
), Vunread_command_events
);
8516 value
= XCAR (value
);
8518 else if (NILP (value
))
8520 if (used_mouse_menu
)
8521 *used_mouse_menu
= 1;
8524 #endif /* HAVE_MENUS */
8528 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8529 We make this bigger when necessary, and never free it. */
8530 static char *read_char_minibuf_menu_text
;
8531 /* Size of that buffer. */
8532 static ptrdiff_t read_char_minibuf_menu_width
;
8535 read_char_minibuf_menu_prompt (int commandflag
,
8536 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8539 register Lisp_Object name
;
8541 /* FIXME: Use the minibuffer's frame width. */
8542 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8545 Lisp_Object rest
, vector
;
8551 if (! menu_prompting
)
8554 /* Get the menu name from the first map that has one (a prompt string). */
8555 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8557 name
= Fkeymap_prompt (maps
[mapno
]);
8562 /* If we don't have any menus, just read a character normally. */
8563 if (!STRINGP (name
))
8566 /* Make sure we have a big enough buffer for the menu text. */
8567 width
= max (width
, SBYTES (name
));
8568 if (STRING_BYTES_BOUND
- 4 < width
)
8569 memory_full (SIZE_MAX
);
8570 if (width
+ 4 > read_char_minibuf_menu_width
)
8572 read_char_minibuf_menu_text
8573 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8574 read_char_minibuf_menu_width
= width
+ 4;
8576 menu
= read_char_minibuf_menu_text
;
8578 /* Prompt string always starts with map's prompt, and a space. */
8579 strcpy (menu
, SSDATA (name
));
8580 nlength
= SBYTES (name
);
8581 menu
[nlength
++] = ':';
8582 menu
[nlength
++] = ' ';
8585 /* Start prompting at start of first map. */
8589 /* Present the documented bindings, a line at a time. */
8593 ptrdiff_t i
= nlength
;
8595 Lisp_Object orig_defn_macro
;
8597 /* Loop over elements of map. */
8602 /* If reached end of map, start at beginning of next map. */
8606 /* At end of last map, wrap around to first map if just starting,
8607 or end this line if already have something on it. */
8611 if (notfirst
|| nobindings
) break;
8616 /* Look at the next element of the map. */
8618 elt
= AREF (vector
, idx
);
8620 elt
= Fcar_safe (rest
);
8622 if (idx
< 0 && VECTORP (elt
))
8624 /* If we found a dense table in the keymap,
8625 advanced past it, but start scanning its contents. */
8626 rest
= Fcdr_safe (rest
);
8632 /* An ordinary element. */
8633 Lisp_Object event
, tem
;
8637 event
= Fcar_safe (elt
); /* alist */
8638 elt
= Fcdr_safe (elt
);
8642 XSETINT (event
, idx
); /* vector */
8645 /* Ignore the element if it has no prompt string. */
8646 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8648 /* 1 if the char to type matches the string. */
8650 Lisp_Object upcased_event
, downcased_event
;
8651 Lisp_Object desc
= Qnil
;
8653 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8655 upcased_event
= Fupcase (event
);
8656 downcased_event
= Fdowncase (event
);
8657 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8658 || XINT (downcased_event
) == SREF (s
, 0));
8660 desc
= Fsingle_key_description (event
, Qnil
);
8662 #if 0 /* It is redundant to list the equivalent key bindings because
8663 the prefix is what the user has already typed. */
8665 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8667 /* Insert equivalent keybinding. */
8668 s
= concat2 (s
, tem
);
8671 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8672 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8674 /* Insert button prefix. */
8675 Lisp_Object selected
8676 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8677 if (EQ (tem
, QCradio
))
8678 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8680 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8681 s
= concat2 (tem
, s
);
8685 /* If we have room for the prompt string, add it to this line.
8686 If this is the first on the line, always add it. */
8687 if ((SCHARS (s
) + i
+ 2
8688 + (char_matches
? 0 : SCHARS (desc
) + 3))
8692 ptrdiff_t thiswidth
;
8694 /* Punctuate between strings. */
8697 strcpy (menu
+ i
, ", ");
8703 /* If the char to type doesn't match the string's
8704 first char, explicitly show what char to type. */
8707 /* Add as much of string as fits. */
8708 thiswidth
= min (SCHARS (desc
), width
- i
);
8709 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8711 strcpy (menu
+ i
, " = ");
8715 /* Add as much of string as fits. */
8716 thiswidth
= min (SCHARS (s
), width
- i
);
8717 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8723 /* If this element does not fit, end the line now,
8724 and save the element for the next line. */
8725 strcpy (menu
+ i
, "...");
8730 /* Move past this element. */
8731 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8732 /* Handle reaching end of dense table. */
8737 rest
= Fcdr_safe (rest
);
8741 /* Prompt with that and read response. */
8742 message2_nolog (menu
, strlen (menu
),
8743 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8745 /* Make believe its not a keyboard macro in case the help char
8746 is pressed. Help characters are not recorded because menu prompting
8747 is not used on replay.
8749 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8750 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8752 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8753 while (BUFFERP (obj
));
8754 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8756 if (!INTEGERP (obj
))
8758 else if (XINT (obj
) == -2)
8761 if (! EQ (obj
, menu_prompt_more_char
)
8762 && (!INTEGERP (menu_prompt_more_char
)
8763 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8765 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8766 store_kbd_macro_char (obj
);
8769 /* Help char - go round again */
8773 /* Reading key sequences. */
8775 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8776 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8777 keymap, or nil otherwise. Return the index of the first keymap in
8778 which KEY has any binding, or NMAPS if no map has a binding.
8780 If KEY is a meta ASCII character, treat it like meta-prefix-char
8781 followed by the corresponding non-meta character. Keymaps in
8782 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8785 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8788 NEXT may be the same array as CURRENT. */
8791 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8792 Lisp_Object
*defs
, Lisp_Object
*next
)
8794 ptrdiff_t i
, first_binding
;
8796 first_binding
= nmaps
;
8797 for (i
= nmaps
- 1; i
>= 0; i
--)
8799 if (! NILP (current
[i
]))
8801 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8802 if (! NILP (defs
[i
]))
8809 /* Given the set of bindings we've found, produce the next set of maps. */
8810 if (first_binding
< nmaps
)
8811 for (i
= 0; i
< nmaps
; i
++)
8812 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8814 return first_binding
;
8817 /* Structure used to keep track of partial application of key remapping
8818 such as Vfunction_key_map and Vkey_translation_map. */
8819 typedef struct keyremap
8821 /* This is the map originally specified for this use. */
8823 /* This is a submap reached by looking up, in PARENT,
8824 the events from START to END. */
8826 /* Positions [START, END) in the key sequence buffer
8827 are the key that we have scanned so far.
8828 Those events are the ones that we will replace
8829 if PARENT maps them into a key sequence. */
8833 /* Lookup KEY in MAP.
8834 MAP is a keymap mapping keys to key vectors or functions.
8835 If the mapping is a function and DO_FUNCTION is non-zero, then
8836 the function is called with PROMPT as parameter and its return
8837 value is used as the return value of this function (after checking
8838 that it is indeed a vector). */
8841 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8846 next
= access_keymap (map
, key
, 1, 0, 1);
8848 /* Handle symbol with autoload definition. */
8849 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8850 && CONSP (XSYMBOL (next
)->function
)
8851 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8852 do_autoload (XSYMBOL (next
)->function
, next
);
8854 /* Handle a symbol whose function definition is a keymap
8856 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8857 && (ARRAYP (XSYMBOL (next
)->function
)
8858 || KEYMAPP (XSYMBOL (next
)->function
)))
8859 next
= XSYMBOL (next
)->function
;
8861 /* If the keymap gives a function, not an
8862 array, then call the function with one arg and use
8863 its value instead. */
8864 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8869 next
= call1 (next
, prompt
);
8870 /* If the function returned something invalid,
8871 barf--don't ignore it.
8872 (To ignore it safely, we would need to gcpro a bunch of
8873 other variables.) */
8874 if (! (VECTORP (next
) || STRINGP (next
)))
8875 error ("Function %s returns invalid key sequence",
8876 SSDATA (SYMBOL_NAME (tem
)));
8881 /* Do one step of the key remapping used for function-key-map and
8882 key-translation-map:
8883 KEYBUF is the buffer holding the input events.
8884 BUFSIZE is its maximum size.
8885 FKEY is a pointer to the keyremap structure to use.
8886 INPUT is the index of the last element in KEYBUF.
8887 DOIT if non-zero says that the remapping can actually take place.
8888 DIFF is used to return the number of keys added/removed by the remapping.
8889 PARENT is the root of the keymap.
8890 PROMPT is the prompt to use if the remapping happens through a function.
8891 The return value is non-zero if the remapping actually took place. */
8894 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8895 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8897 Lisp_Object next
, key
;
8899 key
= keybuf
[fkey
->end
++];
8901 if (KEYMAPP (fkey
->parent
))
8902 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8906 /* If keybuf[fkey->start..fkey->end] is bound in the
8907 map and we're in a position to do the key remapping, replace it with
8908 the binding and restart with fkey->start at the end. */
8909 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8911 int len
= XFASTINT (Flength (next
));
8914 *diff
= len
- (fkey
->end
- fkey
->start
);
8916 if (bufsize
- input
<= *diff
)
8917 error ("Key sequence too long");
8919 /* Shift the keys that follow fkey->end. */
8921 for (i
= fkey
->end
; i
< input
; i
++)
8922 keybuf
[i
+ *diff
] = keybuf
[i
];
8924 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8925 keybuf
[i
+ *diff
] = keybuf
[i
];
8926 /* Overwrite the old keys with the new ones. */
8927 for (i
= 0; i
< len
; i
++)
8928 keybuf
[fkey
->start
+ i
]
8929 = Faref (next
, make_number (i
));
8931 fkey
->start
= fkey
->end
+= *diff
;
8932 fkey
->map
= fkey
->parent
;
8937 fkey
->map
= get_keymap (next
, 0, 1);
8939 /* If we no longer have a bound suffix, try a new position for
8941 if (!CONSP (fkey
->map
))
8943 fkey
->end
= ++fkey
->start
;
8944 fkey
->map
= fkey
->parent
;
8950 test_undefined (Lisp_Object binding
)
8952 return (EQ (binding
, Qundefined
)
8953 || (!NILP (binding
) && SYMBOLP (binding
)
8954 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8957 /* Read a sequence of keys that ends with a non prefix character,
8958 storing it in KEYBUF, a buffer of size BUFSIZE.
8960 Return the length of the key sequence stored.
8961 Return -1 if the user rejected a command menu.
8963 Echo starting immediately unless `prompt' is 0.
8965 Where a key sequence ends depends on the currently active keymaps.
8966 These include any minor mode keymaps active in the current buffer,
8967 the current buffer's local map, and the global map.
8969 If a key sequence has no other bindings, we check Vfunction_key_map
8970 to see if some trailing subsequence might be the beginning of a
8971 function key's sequence. If so, we try to read the whole function
8972 key, and substitute its symbolic name into the key sequence.
8974 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8975 `double-' events into similar click events, if that would make them
8976 bound. We try to turn `triple-' events first into `double-' events,
8979 If we get a mouse click in a mode line, vertical divider, or other
8980 non-text area, we treat the click as if it were prefixed by the
8981 symbol denoting that area - `mode-line', `vertical-line', or
8984 If the sequence starts with a mouse click, we read the key sequence
8985 with respect to the buffer clicked on, not the current buffer.
8987 If the user switches frames in the midst of a key sequence, we put
8988 off the switch-frame event until later; the next call to
8989 read_char will return it.
8991 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8992 from the selected window's buffer. */
8995 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8996 int dont_downcase_last
, int can_return_switch_frame
,
8997 int fix_current_buffer
)
8999 Lisp_Object from_string
;
9000 ptrdiff_t count
= SPECPDL_INDEX ();
9002 /* How many keys there are in the current key sequence. */
9005 /* The length of the echo buffer when we started reading, and
9006 the length of this_command_keys when we started reading. */
9007 ptrdiff_t echo_start
IF_LINT (= 0);
9008 ptrdiff_t keys_start
;
9010 /* The number of keymaps we're scanning right now, and the number of
9011 keymaps we have allocated space for. */
9013 ptrdiff_t nmaps_allocated
= 0;
9015 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9016 the current keymaps. */
9017 Lisp_Object
*defs
= NULL
;
9019 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9020 in the current keymaps, or nil where it is not a prefix. */
9021 Lisp_Object
*submaps
= NULL
;
9023 /* The local map to start out with at start of key sequence. */
9024 Lisp_Object orig_local_map
;
9026 /* The map from the `keymap' property to start out with at start of
9028 Lisp_Object orig_keymap
;
9030 /* 1 if we have already considered switching to the local-map property
9031 of the place where a mouse click occurred. */
9032 int localized_local_map
= 0;
9034 /* The index in submaps[] of the first keymap that has a binding for
9035 this key sequence. In other words, the lowest i such that
9036 submaps[i] is non-nil. */
9037 ptrdiff_t first_binding
;
9038 /* Index of the first key that has no binding.
9039 It is useless to try fkey.start larger than that. */
9042 /* If t < mock_input, then KEYBUF[t] should be read as the next
9045 We use this to recover after recognizing a function key. Once we
9046 realize that a suffix of the current key sequence is actually a
9047 function key's escape sequence, we replace the suffix with the
9048 function key's binding from Vfunction_key_map. Now keybuf
9049 contains a new and different key sequence, so the echo area,
9050 this_command_keys, and the submaps and defs arrays are wrong. In
9051 this situation, we set mock_input to t, set t to 0, and jump to
9052 restart_sequence; the loop will read keys from keybuf up until
9053 mock_input, thus rebuilding the state; and then it will resume
9054 reading characters from the keyboard. */
9057 /* If the sequence is unbound in submaps[], then
9058 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9059 and fkey.map is its binding.
9061 These might be > t, indicating that all function key scanning
9062 should hold off until t reaches them. We do this when we've just
9063 recognized a function key, to avoid searching for the function
9064 key's again in Vfunction_key_map. */
9067 /* Likewise, for key_translation_map and input-decode-map. */
9068 keyremap keytran
, indec
;
9070 /* Non-zero if we are trying to map a key by changing an upper-case
9071 letter to lower case, or a shifted function key to an unshifted
9073 int shift_translated
= 0;
9075 /* If we receive a `switch-frame' or `select-window' event in the middle of
9076 a key sequence, we put it off for later.
9077 While we're reading, we keep the event here. */
9078 Lisp_Object delayed_switch_frame
;
9080 /* See the comment below... */
9081 #if defined (GOBBLE_FIRST_EVENT)
9082 Lisp_Object first_event
;
9085 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9086 int original_uppercase_position
= -1;
9088 /* Gets around Microsoft compiler limitations. */
9091 struct buffer
*starting_buffer
;
9093 /* List of events for which a fake prefix key has been generated. */
9094 Lisp_Object fake_prefixed_keys
= Qnil
;
9096 #if defined (GOBBLE_FIRST_EVENT)
9100 struct gcpro gcpro1
;
9102 GCPRO1 (fake_prefixed_keys
);
9103 raw_keybuf_count
= 0;
9105 last_nonmenu_event
= Qnil
;
9107 delayed_switch_frame
= Qnil
;
9113 /* Install the string STR as the beginning of the string of
9114 echoing, so that it serves as a prompt for the next
9116 KVAR (current_kboard
, echo_string
) = prompt
;
9117 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9120 else if (cursor_in_echo_area
9121 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9122 && NILP (Fzerop (Vecho_keystrokes
)))
9123 /* This doesn't put in a dash if the echo buffer is empty, so
9124 you don't always see a dash hanging out in the minibuffer. */
9128 /* Record the initial state of the echo area and this_command_keys;
9129 we will need to restore them if we replay a key sequence. */
9131 echo_start
= echo_length ();
9132 keys_start
= this_command_key_count
;
9133 this_single_command_key_start
= keys_start
;
9135 #if defined (GOBBLE_FIRST_EVENT)
9136 /* This doesn't quite work, because some of the things that read_char
9137 does cannot safely be bypassed. It seems too risky to try to make
9140 /* Read the first char of the sequence specially, before setting
9141 up any keymaps, in case a filter runs and switches buffers on us. */
9142 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9144 #endif /* GOBBLE_FIRST_EVENT */
9146 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9147 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9150 /* We jump here when we need to reinitialize fkey and keytran; this
9151 happens if we switch keyboards between rescans. */
9152 replay_entire_sequence
:
9154 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9155 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9156 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9157 indec
.start
= indec
.end
= 0;
9158 fkey
.start
= fkey
.end
= 0;
9159 keytran
.start
= keytran
.end
= 0;
9161 /* We jump here when the key sequence has been thoroughly changed, and
9162 we need to rescan it starting from the beginning. When we jump here,
9163 keybuf[0..mock_input] holds the sequence we should reread. */
9166 starting_buffer
= current_buffer
;
9167 first_unbound
= bufsize
+ 1;
9169 /* Build our list of keymaps.
9170 If we recognize a function key and replace its escape sequence in
9171 keybuf with its symbol, or if the sequence starts with a mouse
9172 click and we need to switch buffers, we jump back here to rebuild
9173 the initial keymaps from the current buffer. */
9176 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9178 if (2 > nmaps_allocated
)
9180 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9181 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9182 nmaps_allocated
= 2;
9184 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9186 else if (!NILP (Voverriding_local_map
))
9188 if (2 > nmaps_allocated
)
9190 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9191 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9192 nmaps_allocated
= 2;
9194 submaps
[nmaps
++] = Voverriding_local_map
;
9202 nminor
= current_minor_maps (0, &maps
);
9203 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9205 if (total
> nmaps_allocated
)
9207 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9208 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9209 nmaps_allocated
= total
;
9212 if (!NILP (orig_keymap
))
9213 submaps
[nmaps
++] = orig_keymap
;
9215 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9219 submaps
[nmaps
++] = orig_local_map
;
9221 submaps
[nmaps
++] = current_global_map
;
9223 /* Find an accurate initial value for first_binding. */
9224 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9225 if (! NILP (submaps
[first_binding
]))
9228 /* Start from the beginning in keybuf. */
9231 /* These are no-ops the first time through, but if we restart, they
9232 revert the echo area and this_command_keys to their original state. */
9233 this_command_key_count
= keys_start
;
9234 if (INTERACTIVE
&& t
< mock_input
)
9235 echo_truncate (echo_start
);
9237 /* If the best binding for the current key sequence is a keymap, or
9238 we may be looking at a function key's escape sequence, keep on
9240 while (first_binding
< nmaps
9241 /* Keep reading as long as there's a prefix binding. */
9242 ? !NILP (submaps
[first_binding
])
9243 /* Don't return in the middle of a possible function key sequence,
9244 if the only bindings we found were via case conversion.
9245 Thus, if ESC O a has a function-key-map translation
9246 and ESC o has a binding, don't return after ESC O,
9247 so that we can translate ESC O plus the next character. */
9248 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9251 int used_mouse_menu
= 0;
9253 /* Where the last real key started. If we need to throw away a
9254 key that has expanded into more than one element of keybuf
9255 (say, a mouse click on the mode line which is being treated
9256 as [mode-line (mouse-...)], then we backtrack to this point
9258 int last_real_key_start
;
9260 /* These variables are analogous to echo_start and keys_start;
9261 while those allow us to restart the entire key sequence,
9262 echo_local_start and keys_local_start allow us to throw away
9264 ptrdiff_t echo_local_start
IF_LINT (= 0);
9265 int keys_local_start
;
9266 ptrdiff_t local_first_binding
;
9268 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9269 eassert (indec
.start
<= indec
.end
);
9270 eassert (fkey
.start
<= fkey
.end
);
9271 eassert (keytran
.start
<= keytran
.end
);
9272 /* key-translation-map is applied *after* function-key-map
9273 which is itself applied *after* input-decode-map. */
9274 eassert (fkey
.end
<= indec
.start
);
9275 eassert (keytran
.end
<= fkey
.start
);
9277 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9278 first_unbound
< keytran
.start
)
9279 { /* The prefix upto first_unbound has no binding and has
9280 no translation left to do either, so we know it's unbound.
9281 If we don't stop now, we risk staying here indefinitely
9282 (if the user keeps entering fkey or keytran prefixes
9283 like C-c ESC ESC ESC ESC ...) */
9285 for (i
= first_unbound
+ 1; i
< t
; i
++)
9286 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9287 mock_input
= t
- first_unbound
- 1;
9288 indec
.end
= indec
.start
-= first_unbound
+ 1;
9289 indec
.map
= indec
.parent
;
9290 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9291 fkey
.map
= fkey
.parent
;
9292 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9293 keytran
.map
= keytran
.parent
;
9294 goto replay_sequence
;
9298 error ("Key sequence too long");
9301 echo_local_start
= echo_length ();
9302 keys_local_start
= this_command_key_count
;
9303 local_first_binding
= first_binding
;
9306 /* These are no-ops, unless we throw away a keystroke below and
9307 jumped back up to replay_key; in that case, these restore the
9308 variables to their original state, allowing us to replay the
9310 if (INTERACTIVE
&& t
< mock_input
)
9311 echo_truncate (echo_local_start
);
9312 this_command_key_count
= keys_local_start
;
9313 first_binding
= local_first_binding
;
9315 /* By default, assume each event is "real". */
9316 last_real_key_start
= t
;
9318 /* Does mock_input indicate that we are re-reading a key sequence? */
9322 add_command_key (key
);
9323 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9324 && NILP (Fzerop (Vecho_keystrokes
)))
9328 /* If not, we should actually read a character. */
9332 KBOARD
*interrupted_kboard
= current_kboard
;
9333 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9334 key
= read_char (NILP (prompt
), nmaps
,
9335 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9336 &used_mouse_menu
, NULL
);
9337 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9338 /* When switching to a new tty (with a new keyboard),
9339 read_char returns the new buffer, rather than -2
9340 (Bug#5095). This is because `terminal-init-xterm'
9341 calls read-char, which eats the wrong_kboard_jmpbuf
9342 return. Any better way to fix this? -- cyd */
9343 || (interrupted_kboard
!= current_kboard
))
9348 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9349 if (k
== interrupted_kboard
)
9354 /* Don't touch interrupted_kboard when it's been
9356 delayed_switch_frame
= Qnil
;
9357 goto replay_entire_sequence
;
9360 if (!NILP (delayed_switch_frame
))
9362 KVAR (interrupted_kboard
, kbd_queue
)
9363 = Fcons (delayed_switch_frame
,
9364 KVAR (interrupted_kboard
, kbd_queue
));
9365 delayed_switch_frame
= Qnil
;
9369 KVAR (interrupted_kboard
, kbd_queue
)
9370 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9372 /* If the side queue is non-empty, ensure it begins with a
9373 switch-frame, so we'll replay it in the right context. */
9374 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9375 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9376 !(EVENT_HAS_PARAMETERS (key
)
9377 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9381 XSETFRAME (frame
, interrupted_frame
);
9382 KVAR (interrupted_kboard
, kbd_queue
)
9383 = Fcons (make_lispy_switch_frame (frame
),
9384 KVAR (interrupted_kboard
, kbd_queue
));
9387 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9388 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9389 goto replay_entire_sequence
;
9393 /* read_char returns t when it shows a menu and the user rejects it.
9397 unbind_to (count
, Qnil
);
9402 /* read_char returns -1 at the end of a macro.
9403 Emacs 18 handles this by returning immediately with a
9404 zero, so that's what we'll do. */
9405 if (INTEGERP (key
) && XINT (key
) == -1)
9408 /* The Microsoft C compiler can't handle the goto that
9414 /* If the current buffer has been changed from under us, the
9415 keymap may have changed, so replay the sequence. */
9418 timer_resume_idle ();
9421 /* Reset the current buffer from the selected window
9422 in case something changed the former and not the latter.
9423 This is to be more consistent with the behavior
9424 of the command_loop_1. */
9425 if (fix_current_buffer
)
9427 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9429 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9430 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9433 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9434 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9435 goto replay_sequence
;
9438 /* If we have a quit that was typed in another frame, and
9439 quit_throw_to_read_char switched buffers,
9440 replay to get the right keymap. */
9442 && XINT (key
) == quit_char
9443 && current_buffer
!= starting_buffer
)
9446 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9451 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9452 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9453 goto replay_sequence
;
9458 if (EVENT_HAS_PARAMETERS (key
)
9459 /* Either a `switch-frame' or a `select-window' event. */
9460 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9462 /* If we're at the beginning of a key sequence, and the caller
9463 says it's okay, go ahead and return this event. If we're
9464 in the midst of a key sequence, delay it until the end. */
9465 if (t
> 0 || !can_return_switch_frame
)
9467 delayed_switch_frame
= key
;
9473 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9477 /* Clicks in non-text areas get prefixed by the symbol
9478 in their CHAR-ADDRESS field. For example, a click on
9479 the mode line is prefixed by the symbol `mode-line'.
9481 Furthermore, key sequences beginning with mouse clicks
9482 are read using the keymaps of the buffer clicked on, not
9483 the current buffer. So we may have to switch the buffer
9486 When we turn one event into two events, we must make sure
9487 that neither of the two looks like the original--so that,
9488 if we replay the events, they won't be expanded again.
9489 If not for this, such reexpansion could happen either here
9490 or when user programs play with this-command-keys. */
9491 if (EVENT_HAS_PARAMETERS (key
))
9496 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9497 if (EQ (kind
, Qmouse_click
))
9499 Lisp_Object window
, posn
;
9501 window
= POSN_WINDOW (EVENT_START (key
));
9502 posn
= POSN_POSN (EVENT_START (key
));
9505 || (!NILP (fake_prefixed_keys
)
9506 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9508 /* We're looking a second time at an event for which
9509 we generated a fake prefix key. Set
9510 last_real_key_start appropriately. */
9512 last_real_key_start
= t
- 1;
9515 if (last_real_key_start
== 0)
9517 /* Key sequences beginning with mouse clicks are
9518 read using the keymaps in the buffer clicked on,
9519 not the current buffer. If we're at the
9520 beginning of a key sequence, switch buffers. */
9521 if (WINDOWP (window
)
9522 && BUFFERP (XWINDOW (window
)->buffer
)
9523 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9525 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9530 /* Arrange to go back to the original buffer once we're
9531 done reading the key sequence. Note that we can't
9532 use save_excursion_{save,restore} here, because they
9533 save point as well as the current buffer; we don't
9534 want to save point, because redisplay may change it,
9535 to accommodate a Fset_window_start or something. We
9536 don't want to do this at the top of the function,
9537 because we may get input from a subprocess which
9538 wants to change the selected window and stuff (say,
9540 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9542 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9544 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9545 orig_local_map
= get_local_map (PT
, current_buffer
,
9547 orig_keymap
= get_local_map (PT
, current_buffer
,
9549 goto replay_sequence
;
9552 /* For a mouse click, get the local text-property keymap
9553 of the place clicked on, rather than point. */
9554 if (CONSP (XCDR (key
))
9555 && ! localized_local_map
)
9557 Lisp_Object map_here
, start
, pos
;
9559 localized_local_map
= 1;
9560 start
= EVENT_START (key
);
9562 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9564 pos
= POSN_BUFFER_POSN (start
);
9566 && XINT (pos
) >= BEGV
9567 && XINT (pos
) <= ZV
)
9569 map_here
= get_local_map (XINT (pos
),
9572 if (!EQ (map_here
, orig_local_map
))
9574 orig_local_map
= map_here
;
9575 ++localized_local_map
;
9578 map_here
= get_local_map (XINT (pos
),
9581 if (!EQ (map_here
, orig_keymap
))
9583 orig_keymap
= map_here
;
9584 ++localized_local_map
;
9587 if (localized_local_map
> 1)
9592 goto replay_sequence
;
9599 /* Expand mode-line and scroll-bar events into two events:
9600 use posn as a fake prefix key. */
9602 && (NILP (fake_prefixed_keys
)
9603 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9605 if (bufsize
- t
<= 1)
9606 error ("Key sequence too long");
9609 keybuf
[t
+ 1] = key
;
9612 /* Record that a fake prefix key has been generated
9613 for KEY. Don't modify the event; this would
9614 prevent proper action when the event is pushed
9615 back into unread-command-events. */
9616 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9618 /* If on a mode line string with a local keymap,
9619 reconsider the key sequence with that keymap. */
9620 if (string
= POSN_STRING (EVENT_START (key
)),
9621 (CONSP (string
) && STRINGP (XCAR (string
))))
9623 Lisp_Object pos
, map
, map2
;
9625 pos
= XCDR (string
);
9626 string
= XCAR (string
);
9628 && XINT (pos
) < SCHARS (string
))
9630 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9632 orig_local_map
= map
;
9633 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9636 if (!NILP (map
) || !NILP (map2
))
9637 goto replay_sequence
;
9643 else if (NILP (from_string
)
9644 && (string
= POSN_STRING (EVENT_START (key
)),
9645 (CONSP (string
) && STRINGP (XCAR (string
)))))
9647 /* For a click on a string, i.e. overlay string or a
9648 string displayed via the `display' property,
9649 consider `local-map' and `keymap' properties of
9651 Lisp_Object pos
, map
, map2
;
9653 pos
= XCDR (string
);
9654 string
= XCAR (string
);
9656 && XINT (pos
) < SCHARS (string
))
9658 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9660 orig_local_map
= map
;
9661 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9665 if (!NILP (map
) || !NILP (map2
))
9667 from_string
= string
;
9670 goto replay_sequence
;
9675 else if (CONSP (XCDR (key
))
9676 && CONSP (EVENT_START (key
))
9677 && CONSP (XCDR (EVENT_START (key
))))
9681 posn
= POSN_POSN (EVENT_START (key
));
9682 /* Handle menu-bar events:
9683 insert the dummy prefix event `menu-bar'. */
9684 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9686 if (bufsize
- t
<= 1)
9687 error ("Key sequence too long");
9691 /* Zap the position in key, so we know that we've
9692 expanded it, and don't try to do so again. */
9693 POSN_SET_POSN (EVENT_START (key
),
9694 Fcons (posn
, Qnil
));
9697 goto replay_sequence
;
9699 else if (CONSP (posn
))
9701 /* We're looking at the second event of a
9702 sequence which we expanded before. Set
9703 last_real_key_start appropriately. */
9704 if (last_real_key_start
== t
&& t
> 0)
9705 last_real_key_start
= t
- 1;
9710 /* We have finally decided that KEY is something we might want
9712 first_binding
= (follow_key (key
,
9713 nmaps
- first_binding
,
9714 submaps
+ first_binding
,
9715 defs
+ first_binding
,
9716 submaps
+ first_binding
)
9719 /* If KEY wasn't bound, we'll try some fallbacks. */
9720 if (first_binding
< nmaps
)
9721 /* This is needed for the following scenario:
9722 event 0: a down-event that gets dropped by calling replay_key.
9723 event 1: some normal prefix like C-h.
9724 After event 0, first_unbound is 0, after event 1 indec.start,
9725 fkey.start, and keytran.start are all 1, so when we see that
9726 C-h is bound, we need to update first_unbound. */
9727 first_unbound
= max (t
+ 1, first_unbound
);
9732 /* Remember the position to put an upper bound on indec.start. */
9733 first_unbound
= min (t
, first_unbound
);
9735 head
= EVENT_HEAD (key
);
9736 if (help_char_p (head
) && t
> 0)
9738 read_key_sequence_cmd
= Vprefix_help_command
;
9740 last_nonmenu_event
= key
;
9741 /* The Microsoft C compiler can't handle the goto that
9749 Lisp_Object breakdown
;
9752 breakdown
= parse_modifiers (head
);
9753 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9754 /* Attempt to reduce an unbound mouse event to a simpler
9755 event that is bound:
9756 Drags reduce to clicks.
9757 Double-clicks reduce to clicks.
9758 Triple-clicks reduce to double-clicks, then to clicks.
9759 Down-clicks are eliminated.
9760 Double-downs reduce to downs, then are eliminated.
9761 Triple-downs reduce to double-downs, then to downs,
9762 then are eliminated. */
9763 if (modifiers
& (down_modifier
| drag_modifier
9764 | double_modifier
| triple_modifier
))
9766 while (modifiers
& (down_modifier
| drag_modifier
9767 | double_modifier
| triple_modifier
))
9769 Lisp_Object new_head
, new_click
;
9770 if (modifiers
& triple_modifier
)
9771 modifiers
^= (double_modifier
| triple_modifier
);
9772 else if (modifiers
& double_modifier
)
9773 modifiers
&= ~double_modifier
;
9774 else if (modifiers
& drag_modifier
)
9775 modifiers
&= ~drag_modifier
;
9778 /* Dispose of this `down' event by simply jumping
9779 back to replay_key, to get another event.
9781 Note that if this event came from mock input,
9782 then just jumping back to replay_key will just
9783 hand it to us again. So we have to wipe out any
9786 We could delete keybuf[t] and shift everything
9787 after that to the left by one spot, but we'd also
9788 have to fix up any variable that points into
9789 keybuf, and shifting isn't really necessary
9792 Adding prefixes for non-textual mouse clicks
9793 creates two characters of mock input, and both
9794 must be thrown away. If we're only looking at
9795 the prefix now, we can just jump back to
9796 replay_key. On the other hand, if we've already
9797 processed the prefix, and now the actual click
9798 itself is giving us trouble, then we've lost the
9799 state of the keymaps we want to backtrack to, and
9800 we need to replay the whole sequence to rebuild
9803 Beyond that, only function key expansion could
9804 create more than two keys, but that should never
9805 generate mouse events, so it's okay to zero
9806 mock_input in that case too.
9808 FIXME: The above paragraph seems just plain
9809 wrong, if you consider things like
9810 xterm-mouse-mode. -stef
9812 Isn't this just the most wonderful code ever? */
9814 /* If mock_input > t + 1, the above simplification
9815 will actually end up dropping keys on the floor.
9816 This is probably OK for now, but even
9817 if mock_input <= t + 1, we need to adjust indec,
9819 Typical case [header-line down-mouse-N]:
9820 mock_input = 2, t = 1, fkey.end = 1,
9821 last_real_key_start = 0. */
9822 if (indec
.end
> last_real_key_start
)
9824 indec
.end
= indec
.start
9825 = min (last_real_key_start
, indec
.start
);
9826 indec
.map
= indec
.parent
;
9827 if (fkey
.end
> last_real_key_start
)
9829 fkey
.end
= fkey
.start
9830 = min (last_real_key_start
, fkey
.start
);
9831 fkey
.map
= fkey
.parent
;
9832 if (keytran
.end
> last_real_key_start
)
9834 keytran
.end
= keytran
.start
9835 = min (last_real_key_start
, keytran
.start
);
9836 keytran
.map
= keytran
.parent
;
9840 if (t
== last_real_key_start
)
9847 mock_input
= last_real_key_start
;
9848 goto replay_sequence
;
9853 = apply_modifiers (modifiers
, XCAR (breakdown
));
9855 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9857 /* Look for a binding for this new key. follow_key
9858 promises that it didn't munge submaps the
9859 last time we called it, since key was unbound. */
9861 = (follow_key (new_click
,
9862 nmaps
- local_first_binding
,
9863 submaps
+ local_first_binding
,
9864 defs
+ local_first_binding
,
9865 submaps
+ local_first_binding
)
9866 + local_first_binding
);
9868 /* If that click is bound, go for it. */
9869 if (first_binding
< nmaps
)
9874 /* Otherwise, we'll leave key set to the drag event. */
9881 /* Normally, last_nonmenu_event gets the previous key we read.
9882 But when a mouse popup menu is being used,
9883 we don't update last_nonmenu_event; it continues to hold the mouse
9884 event that preceded the first level of menu. */
9885 if (!used_mouse_menu
)
9886 last_nonmenu_event
= key
;
9888 /* Record what part of this_command_keys is the current key sequence. */
9889 this_single_command_key_start
= this_command_key_count
- t
;
9891 /* Look for this sequence in input-decode-map.
9892 Scan from indec.end until we find a bound suffix. */
9893 while (indec
.end
< t
)
9895 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9898 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9899 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9904 mock_input
= diff
+ max (t
, mock_input
);
9905 goto replay_sequence
;
9909 if (first_binding
< nmaps
9910 && NILP (submaps
[first_binding
])
9911 && !test_undefined (defs
[first_binding
])
9912 && indec
.start
>= t
)
9913 /* There is a binding and it's not a prefix.
9914 (and it doesn't have any input-decode-map translation pending).
9915 There is thus no function-key in this sequence.
9916 Moving fkey.start is important in this case to allow keytran.start
9917 to go over the sequence before we return (since we keep the
9918 invariant that keytran.end <= fkey.start). */
9921 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9924 /* If the sequence is unbound, see if we can hang a function key
9925 off the end of it. */
9926 /* Continue scan from fkey.end until we find a bound suffix. */
9927 while (fkey
.end
< indec
.start
)
9929 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9932 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9933 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9934 max (t
, mock_input
),
9935 /* If there's a binding (i.e.
9936 first_binding >= nmaps) we don't want
9937 to apply this function-key-mapping. */
9939 && (first_binding
>= nmaps
9940 || test_undefined (defs
[first_binding
])),
9945 mock_input
= diff
+ max (t
, mock_input
);
9946 /* Adjust the input-decode-map counters. */
9948 indec
.start
+= diff
;
9950 goto replay_sequence
;
9954 /* Look for this sequence in key-translation-map.
9955 Scan from keytran.end until we find a bound suffix. */
9956 while (keytran
.end
< fkey
.start
)
9958 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9961 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9962 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9967 mock_input
= diff
+ max (t
, mock_input
);
9968 /* Adjust the function-key-map and input-decode-map counters. */
9970 indec
.start
+= diff
;
9974 goto replay_sequence
;
9978 /* If KEY is not defined in any of the keymaps,
9979 and cannot be part of a function key or translation,
9980 and is an upper case letter
9981 use the corresponding lower-case letter instead. */
9982 if (first_binding
>= nmaps
9983 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9985 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9986 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9987 || (XINT (key
) & shift_modifier
)))
9989 Lisp_Object new_key
;
9991 original_uppercase
= key
;
9992 original_uppercase_position
= t
- 1;
9994 if (XINT (key
) & shift_modifier
)
9995 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9997 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9998 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10000 /* We have to do this unconditionally, regardless of whether
10001 the lower-case char is defined in the keymaps, because they
10002 might get translated through function-key-map. */
10003 keybuf
[t
- 1] = new_key
;
10004 mock_input
= max (t
, mock_input
);
10005 shift_translated
= 1;
10007 goto replay_sequence
;
10009 /* If KEY is not defined in any of the keymaps,
10010 and cannot be part of a function key or translation,
10011 and is a shifted function key,
10012 use the corresponding unshifted function key instead. */
10013 if (first_binding
>= nmaps
10014 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10016 Lisp_Object breakdown
= parse_modifiers (key
);
10018 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10020 if (modifiers
& shift_modifier
10021 /* Treat uppercase keys as shifted. */
10023 && (KEY_TO_CHAR (key
)
10024 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10025 && uppercasep (KEY_TO_CHAR (key
))))
10027 Lisp_Object new_key
10028 = (modifiers
& shift_modifier
10029 ? apply_modifiers (modifiers
& ~shift_modifier
,
10031 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10033 original_uppercase
= key
;
10034 original_uppercase_position
= t
- 1;
10036 /* We have to do this unconditionally, regardless of whether
10037 the lower-case char is defined in the keymaps, because they
10038 might get translated through function-key-map. */
10039 keybuf
[t
- 1] = new_key
;
10040 mock_input
= max (t
, mock_input
);
10041 /* Reset fkey (and consequently keytran) to apply
10042 function-key-map on the result, so that S-backspace is
10043 correctly mapped to DEL (via backspace). OTOH,
10044 input-decode-map doesn't need to go through it again. */
10045 fkey
.start
= fkey
.end
= 0;
10046 keytran
.start
= keytran
.end
= 0;
10047 shift_translated
= 1;
10049 goto replay_sequence
;
10054 read_key_sequence_cmd
= (first_binding
< nmaps
10055 ? defs
[first_binding
]
10057 read_key_sequence_remapped
10058 /* Remap command through active keymaps.
10059 Do the remapping here, before the unbind_to so it uses the keymaps
10060 of the appropriate buffer. */
10061 = SYMBOLP (read_key_sequence_cmd
)
10062 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10065 unread_switch_frame
= delayed_switch_frame
;
10066 unbind_to (count
, Qnil
);
10068 /* Don't downcase the last character if the caller says don't.
10069 Don't downcase it if the result is undefined, either. */
10070 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10072 && t
- 1 == original_uppercase_position
)
10074 keybuf
[t
- 1] = original_uppercase
;
10075 shift_translated
= 0;
10078 if (shift_translated
)
10079 Vthis_command_keys_shift_translated
= Qt
;
10081 /* Occasionally we fabricate events, perhaps by expanding something
10082 according to function-key-map, or by adding a prefix symbol to a
10083 mouse click in the scroll bar or modeline. In this cases, return
10084 the entire generated key sequence, even if we hit an unbound
10085 prefix or a definition before the end. This means that you will
10086 be able to push back the event properly, and also means that
10087 read-key-sequence will always return a logical unit.
10090 for (; t
< mock_input
; t
++)
10092 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10093 && NILP (Fzerop (Vecho_keystrokes
)))
10094 echo_char (keybuf
[t
]);
10095 add_command_key (keybuf
[t
]);
10102 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10103 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10104 The sequence is sufficient to specify a non-prefix command in the
10105 current local and global maps.
10107 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10108 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10109 as a continuation of the previous key.
10111 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10112 convert the last event to lower case. (Normally any upper case event
10113 is converted to lower case if the original event is undefined and the lower
10114 case equivalent is defined.) A non-nil value is appropriate for reading
10115 a key sequence to be defined.
10117 A C-g typed while in this function is treated like any other character,
10118 and `quit-flag' is not set.
10120 If the key sequence starts with a mouse click, then the sequence is read
10121 using the keymaps of the buffer of the window clicked in, not the buffer
10122 of the selected window as normal.
10124 `read-key-sequence' drops unbound button-down events, since you normally
10125 only care about the click or drag events which follow them. If a drag
10126 or multi-click event is unbound, but the corresponding click event would
10127 be bound, `read-key-sequence' turns the event into a click event at the
10128 drag's starting position. This means that you don't have to distinguish
10129 between click and drag, double, or triple events unless you want to.
10131 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10132 lines separating windows, and scroll bars with imaginary keys
10133 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10135 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10136 function will process a switch-frame event if the user switches frames
10137 before typing anything. If the user switches frames in the middle of a
10138 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10139 is nil, then the event will be put off until after the current key sequence.
10141 `read-key-sequence' checks `function-key-map' for function key
10142 sequences, where they wouldn't conflict with ordinary bindings. See
10143 `function-key-map' for more details.
10145 The optional fifth argument CMD-LOOP, if non-nil, means
10146 that this key sequence is being read by something that will
10147 read commands one after another. It should be nil if the caller
10148 will read just one key sequence. */)
10149 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10151 Lisp_Object keybuf
[30];
10153 struct gcpro gcpro1
;
10154 ptrdiff_t count
= SPECPDL_INDEX ();
10156 if (!NILP (prompt
))
10157 CHECK_STRING (prompt
);
10160 specbind (Qinput_method_exit_on_first_char
,
10161 (NILP (cmd_loop
) ? Qt
: Qnil
));
10162 specbind (Qinput_method_use_echo_area
,
10163 (NILP (cmd_loop
) ? Qt
: Qnil
));
10165 memset (keybuf
, 0, sizeof keybuf
);
10166 GCPRO1 (keybuf
[0]);
10167 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10169 if (NILP (continue_echo
))
10171 this_command_key_count
= 0;
10172 this_command_key_count_reset
= 0;
10173 this_single_command_key_start
= 0;
10176 #ifdef HAVE_WINDOW_SYSTEM
10177 if (display_hourglass_p
)
10178 cancel_hourglass ();
10181 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10182 prompt
, ! NILP (dont_downcase_last
),
10183 ! NILP (can_return_switch_frame
), 0);
10185 #if 0 /* The following is fine for code reading a key sequence and
10186 then proceeding with a lengthy computation, but it's not good
10187 for code reading keys in a loop, like an input method. */
10188 #ifdef HAVE_WINDOW_SYSTEM
10189 if (display_hourglass_p
)
10190 start_hourglass ();
10200 return unbind_to (count
, make_event_array (i
, keybuf
));
10203 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10204 Sread_key_sequence_vector
, 1, 5, 0,
10205 doc
: /* Like `read-key-sequence' but always return a vector. */)
10206 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10208 Lisp_Object keybuf
[30];
10210 struct gcpro gcpro1
;
10211 ptrdiff_t count
= SPECPDL_INDEX ();
10213 if (!NILP (prompt
))
10214 CHECK_STRING (prompt
);
10217 specbind (Qinput_method_exit_on_first_char
,
10218 (NILP (cmd_loop
) ? Qt
: Qnil
));
10219 specbind (Qinput_method_use_echo_area
,
10220 (NILP (cmd_loop
) ? Qt
: Qnil
));
10222 memset (keybuf
, 0, sizeof keybuf
);
10223 GCPRO1 (keybuf
[0]);
10224 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10226 if (NILP (continue_echo
))
10228 this_command_key_count
= 0;
10229 this_command_key_count_reset
= 0;
10230 this_single_command_key_start
= 0;
10233 #ifdef HAVE_WINDOW_SYSTEM
10234 if (display_hourglass_p
)
10235 cancel_hourglass ();
10238 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10239 prompt
, ! NILP (dont_downcase_last
),
10240 ! NILP (can_return_switch_frame
), 0);
10242 #ifdef HAVE_WINDOW_SYSTEM
10243 if (display_hourglass_p
)
10244 start_hourglass ();
10253 return unbind_to (count
, Fvector (i
, keybuf
));
10256 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10257 doc
: /* Execute CMD as an editor command.
10258 CMD must be a symbol that satisfies the `commandp' predicate.
10259 Optional second arg RECORD-FLAG non-nil
10260 means unconditionally put this command in `command-history'.
10261 Otherwise, that is done only if an arg is read using the minibuffer.
10262 The argument KEYS specifies the value to use instead of (this-command-keys)
10263 when reading the arguments; if it is nil, (this-command-keys) is used.
10264 The argument SPECIAL, if non-nil, means that this command is executing
10265 a special event, so ignore the prefix argument and don't clear it. */)
10266 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10268 register Lisp_Object final
;
10269 register Lisp_Object tem
;
10270 Lisp_Object prefixarg
;
10272 debug_on_next_call
= 0;
10274 if (NILP (special
))
10276 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10277 Vcurrent_prefix_arg
= prefixarg
;
10278 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10285 tem
= Fget (cmd
, Qdisabled
);
10288 tem
= Fsymbol_value (Qdisabled_command_function
);
10290 return Frun_hooks (1, &Qdisabled_command_function
);
10296 final
= Findirect_function (cmd
, Qnil
);
10298 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10300 struct gcpro gcpro1
, gcpro2
;
10302 GCPRO2 (cmd
, prefixarg
);
10303 do_autoload (final
, cmd
);
10310 if (STRINGP (final
) || VECTORP (final
))
10312 /* If requested, place the macro in the command history. For
10313 other sorts of commands, call-interactively takes care of
10315 if (!NILP (record_flag
))
10318 = Fcons (Fcons (Qexecute_kbd_macro
,
10319 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10322 /* Don't keep command history around forever. */
10323 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10325 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10327 XSETCDR (tem
, Qnil
);
10331 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10334 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10335 /* Don't call Fcall_interactively directly because we want to make
10336 sure the backtrace has an entry for `call-interactively'.
10337 For the same reason, pass `cmd' rather than `final'. */
10338 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10345 /* Return nonzero if input events are pending. */
10348 detect_input_pending (void)
10350 if (!input_pending
)
10351 get_input_pending (&input_pending
, 0);
10353 return input_pending
;
10356 /* Return nonzero if input events other than mouse movements are
10360 detect_input_pending_ignore_squeezables (void)
10362 if (!input_pending
)
10363 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10365 return input_pending
;
10368 /* Return nonzero if input events are pending, and run any pending timers. */
10371 detect_input_pending_run_timers (int do_display
)
10373 int old_timers_run
= timers_run
;
10375 if (!input_pending
)
10376 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10378 if (old_timers_run
!= timers_run
&& do_display
)
10380 redisplay_preserve_echo_area (8);
10381 /* The following fixes a bug when using lazy-lock with
10382 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10383 from an idle timer function. The symptom of the bug is that
10384 the cursor sometimes doesn't become visible until the next X
10385 event is processed. --gerd. */
10387 Lisp_Object tail
, frame
;
10388 FOR_EACH_FRAME (tail
, frame
)
10389 if (FRAME_RIF (XFRAME (frame
)))
10390 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10394 return input_pending
;
10397 /* This is called in some cases before a possible quit.
10398 It cases the next call to detect_input_pending to recompute input_pending.
10399 So calling this function unnecessarily can't do any harm. */
10402 clear_input_pending (void)
10407 /* Return nonzero if there are pending requeued events.
10408 This isn't used yet. The hope is to make wait_reading_process_output
10409 call it, and return if it runs Lisp code that unreads something.
10410 The problem is, kbd_buffer_get_event needs to be fixed to know what
10411 to do in that case. It isn't trivial. */
10414 requeued_events_pending_p (void)
10416 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10420 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10421 doc
: /* Return t if command input is currently available with no wait.
10422 Actually, the value is nil only if we can be sure that no input is available;
10423 if there is a doubt, the value is t. */)
10426 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10427 || !NILP (Vunread_post_input_method_events
)
10428 || !NILP (Vunread_input_method_events
))
10431 /* Process non-user-visible events (Bug#10195). */
10432 process_special_events ();
10434 get_input_pending (&input_pending
,
10435 READABLE_EVENTS_DO_TIMERS_NOW
10436 | READABLE_EVENTS_FILTER_EVENTS
);
10437 return input_pending
> 0 ? Qt
: Qnil
;
10440 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10441 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10444 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10447 if (total_keys
< NUM_RECENT_KEYS
)
10448 return Fvector (total_keys
, keys
);
10451 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10452 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10453 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10454 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10455 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10460 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10461 doc
: /* Return the key sequence that invoked this command.
10462 However, if the command has called `read-key-sequence', it returns
10463 the last key sequence that has been read.
10464 The value is a string or a vector.
10466 See also `this-command-keys-vector'. */)
10469 return make_event_array (this_command_key_count
,
10470 XVECTOR (this_command_keys
)->contents
);
10473 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10474 doc
: /* Return the key sequence that invoked this command, as a vector.
10475 However, if the command has called `read-key-sequence', it returns
10476 the last key sequence that has been read.
10478 See also `this-command-keys'. */)
10481 return Fvector (this_command_key_count
,
10482 XVECTOR (this_command_keys
)->contents
);
10485 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10486 Sthis_single_command_keys
, 0, 0, 0,
10487 doc
: /* Return the key sequence that invoked this command.
10488 More generally, it returns the last key sequence read, either by
10489 the command loop or by `read-key-sequence'.
10490 Unlike `this-command-keys', this function's value
10491 does not include prefix arguments.
10492 The value is always a vector. */)
10495 return Fvector (this_command_key_count
10496 - this_single_command_key_start
,
10497 (XVECTOR (this_command_keys
)->contents
10498 + this_single_command_key_start
));
10501 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10502 Sthis_single_command_raw_keys
, 0, 0, 0,
10503 doc
: /* Return the raw events that were read for this command.
10504 More generally, it returns the last key sequence read, either by
10505 the command loop or by `read-key-sequence'.
10506 Unlike `this-single-command-keys', this function's value
10507 shows the events before all translations (except for input methods).
10508 The value is always a vector. */)
10511 return Fvector (raw_keybuf_count
,
10512 (XVECTOR (raw_keybuf
)->contents
));
10515 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10516 Sreset_this_command_lengths
, 0, 0, 0,
10517 doc
: /* Make the unread events replace the last command and echo.
10518 Used in `universal-argument-other-key'.
10520 `universal-argument-other-key' rereads the event just typed.
10521 It then gets translated through `function-key-map'.
10522 The translated event has to replace the real events,
10523 both in the value of (this-command-keys) and in echoing.
10524 To achieve this, `universal-argument-other-key' calls
10525 `reset-this-command-lengths', which discards the record of reading
10526 these events the first time. */)
10529 this_command_key_count
= before_command_key_count
;
10530 if (this_command_key_count
< this_single_command_key_start
)
10531 this_single_command_key_start
= this_command_key_count
;
10533 echo_truncate (before_command_echo_length
);
10535 /* Cause whatever we put into unread-command-events
10536 to echo as if it were being freshly read from the keyboard. */
10537 this_command_key_count_reset
= 1;
10542 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10543 Sclear_this_command_keys
, 0, 1, 0,
10544 doc
: /* Clear out the vector that `this-command-keys' returns.
10545 Also clear the record of the last 100 events, unless optional arg
10546 KEEP-RECORD is non-nil. */)
10547 (Lisp_Object keep_record
)
10551 this_command_key_count
= 0;
10552 this_command_key_count_reset
= 0;
10554 if (NILP (keep_record
))
10556 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10557 ASET (recent_keys
, i
, Qnil
);
10559 recent_keys_index
= 0;
10564 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10565 doc
: /* Return the current depth in recursive edits. */)
10569 /* Wrap around reliably on integer overflow. */
10570 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10571 XSETINT (temp
, sum
);
10575 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10576 "FOpen dribble file: ",
10577 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10578 If FILE is nil, close any open dribble file.
10579 The file will be closed when Emacs exits. */)
10591 file
= Fexpand_file_name (file
, Qnil
);
10592 dribble
= fopen (SSDATA (file
), "w");
10594 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10599 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10600 doc
: /* Discard the contents of the terminal input buffer.
10601 Also end any kbd macro being defined. */)
10604 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10606 /* Discard the last command from the macro. */
10607 Fcancel_kbd_macro_events ();
10611 update_mode_lines
++;
10613 Vunread_command_events
= Qnil
;
10614 unread_command_char
= -1;
10616 discard_tty_input ();
10618 kbd_fetch_ptr
= kbd_store_ptr
;
10624 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10625 doc
: /* Stop Emacs and return to superior process. You can resume later.
10626 If `cannot-suspend' is non-nil, or if the system doesn't support job
10627 control, run a subshell instead.
10629 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10630 to be read as terminal input by Emacs's parent, after suspension.
10632 Before suspending, run the normal hook `suspend-hook'.
10633 After resumption run the normal hook `suspend-resume-hook'.
10635 Some operating systems cannot stop the Emacs process and resume it later.
10636 On such systems, Emacs starts a subshell instead of suspending. */)
10637 (Lisp_Object stuffstring
)
10639 ptrdiff_t count
= SPECPDL_INDEX ();
10640 int old_height
, old_width
;
10642 struct gcpro gcpro1
;
10645 if (tty_list
&& tty_list
->next
)
10646 error ("There are other tty frames open; close them before suspending Emacs");
10648 if (!NILP (stuffstring
))
10649 CHECK_STRING (stuffstring
);
10651 /* Run the functions in suspend-hook. */
10652 hook
= intern ("suspend-hook");
10653 Frun_hooks (1, &hook
);
10655 GCPRO1 (stuffstring
);
10656 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10657 reset_all_sys_modes ();
10658 /* sys_suspend can get an error if it tries to fork a subshell
10659 and the system resources aren't available for that. */
10660 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10662 stuff_buffered_input (stuffstring
);
10663 if (cannot_suspend
)
10667 unbind_to (count
, Qnil
);
10669 /* Check if terminal/window size has changed.
10670 Note that this is not useful when we are running directly
10671 with a window system; but suspend should be disabled in that case. */
10672 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10673 if (width
!= old_width
|| height
!= old_height
)
10674 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10676 /* Run suspend-resume-hook. */
10677 hook
= intern ("suspend-resume-hook");
10678 Frun_hooks (1, &hook
);
10684 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10685 Then in any case stuff anything Emacs has read ahead and not used. */
10688 stuff_buffered_input (Lisp_Object stuffstring
)
10690 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10691 register unsigned char *p
;
10693 if (STRINGP (stuffstring
))
10695 register ptrdiff_t count
;
10697 p
= SDATA (stuffstring
);
10698 count
= SBYTES (stuffstring
);
10699 while (count
-- > 0)
10704 /* Anything we have read ahead, put back for the shell to read. */
10705 /* ?? What should this do when we have multiple keyboards??
10706 Should we ignore anything that was typed in at the "wrong" kboard?
10708 rms: we should stuff everything back into the kboard
10710 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10713 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10714 kbd_fetch_ptr
= kbd_buffer
;
10715 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10716 stuff_char (kbd_fetch_ptr
->code
);
10718 clear_event (kbd_fetch_ptr
);
10722 #endif /* SIGTSTP */
10726 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10728 input_available_clear_time
= time_to_clear
;
10730 /* Tell handle_interrupt to throw back to read_char, */
10731 waiting_for_input
= 1;
10733 /* If handle_interrupt was called before and buffered a C-g,
10734 make it run again now, to avoid timing error. */
10735 if (!NILP (Vquit_flag
))
10736 quit_throw_to_read_char (0);
10740 clear_waiting_for_input (void)
10742 /* Tell handle_interrupt not to throw back to read_char, */
10743 waiting_for_input
= 0;
10744 input_available_clear_time
= 0;
10747 /* The SIGINT handler.
10749 If we have a frame on the controlling tty, we assume that the
10750 SIGINT was generated by C-g, so we call handle_interrupt.
10751 Otherwise, tell QUIT to kill Emacs. */
10754 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10755 /* compilers complain in signal calls. */
10757 /* Must preserve main program's value of errno. */
10758 int old_errno
= errno
;
10759 struct terminal
*terminal
;
10761 SIGNAL_THREAD_CHECK (signalnum
);
10763 /* See if we have an active terminal on our controlling tty. */
10764 terminal
= get_named_tty ("/dev/tty");
10767 /* If there are no frames there, let's pretend that we are a
10768 well-behaving UN*X program and quit. We must not call Lisp
10769 in a signal handler, so tell QUIT to exit when it is
10771 Vquit_flag
= Qkill_emacs
;
10775 /* Otherwise, the SIGINT was probably generated by C-g. */
10777 /* Set internal_last_event_frame to the top frame of the
10778 controlling tty, if we have a frame there. We disable the
10779 interrupt key on secondary ttys, so the SIGINT must have come
10780 from the controlling tty. */
10781 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10783 handle_interrupt ();
10789 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10790 of the number of times C-g has been requested. If C-g is pressed
10791 enough times, then quit anyway. See bug#6585. */
10792 static int force_quit_count
;
10794 /* This routine is called at interrupt level in response to C-g.
10796 It is called from the SIGINT handler or kbd_buffer_store_event.
10798 If `waiting_for_input' is non zero, then unless `echoing' is
10799 nonzero, immediately throw back to read_char.
10801 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10802 eval to throw, when it gets a chance. If quit-flag is already
10803 non-nil, it stops the job right away. */
10806 handle_interrupt (void)
10812 /* XXX This code needs to be revised for multi-tty support. */
10813 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10815 /* If SIGINT isn't blocked, don't let us be interrupted by
10816 another SIGINT, it might be harmful due to non-reentrancy
10817 in I/O functions. */
10818 sigblock (sigmask (SIGINT
));
10821 reset_all_sys_modes ();
10823 #ifdef SIGTSTP /* Support possible in later USG versions */
10825 * On systems which can suspend the current process and return to the original
10826 * shell, this command causes the user to end up back at the shell.
10827 * The "Auto-save" and "Abort" questions are not asked until
10828 * the user elects to return to emacs, at which point he can save the current
10829 * job and either dump core or continue.
10833 /* Perhaps should really fork an inferior shell?
10834 But that would not provide any way to get back
10835 to the original shell, ever. */
10836 printf ("No support for stopping a process on this operating system;\n");
10837 printf ("you can continue or abort.\n");
10838 #endif /* not SIGTSTP */
10840 /* We must remain inside the screen area when the internal terminal
10841 is used. Note that [Enter] is not echoed by dos. */
10842 cursor_to (SELECTED_FRAME (), 0, 0);
10844 /* It doesn't work to autosave while GC is in progress;
10845 the code used for auto-saving doesn't cope with the mark bit. */
10846 if (!gc_in_progress
)
10848 printf ("Auto-save? (y or n) ");
10850 if (((c
= getchar ()) & ~040) == 'Y')
10852 Fdo_auto_save (Qt
, Qnil
);
10854 printf ("\r\nAuto-save done");
10855 #else /* not MSDOS */
10856 printf ("Auto-save done\n");
10857 #endif /* not MSDOS */
10859 while (c
!= '\n') c
= getchar ();
10863 /* During GC, it must be safe to reenable quitting again. */
10864 Vinhibit_quit
= Qnil
;
10867 #endif /* not MSDOS */
10868 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10869 printf ("but will instead do a real quit after garbage collection ends\r\n");
10874 printf ("\r\nAbort? (y or n) ");
10875 #else /* not MSDOS */
10876 printf ("Abort (and dump core)? (y or n) ");
10877 #endif /* not MSDOS */
10879 if (((c
= getchar ()) & ~040) == 'Y')
10881 while (c
!= '\n') c
= getchar ();
10883 printf ("\r\nContinuing...\r\n");
10884 #else /* not MSDOS */
10885 printf ("Continuing...\n");
10886 #endif /* not MSDOS */
10888 init_all_sys_modes ();
10893 /* If executing a function that wants to be interrupted out of
10894 and the user has not deferred quitting by binding `inhibit-quit'
10895 then quit right away. */
10896 if (immediate_quit
&& NILP (Vinhibit_quit
))
10898 struct gl_state_s saved
;
10899 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10901 immediate_quit
= 0;
10904 GCPRO4 (saved
.object
, saved
.global_code
,
10905 saved
.current_syntax_table
, saved
.old_prop
);
10906 Fsignal (Qquit
, Qnil
);
10907 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10912 { /* Else request quit when it's safe. */
10913 if (NILP (Vquit_flag
))
10914 force_quit_count
= 0;
10915 if (++force_quit_count
== 3)
10917 immediate_quit
= 1;
10918 Vinhibit_quit
= Qnil
;
10924 /* TODO: The longjmp in this call throws the NS event loop integration off,
10925 and it seems to do fine without this. Probably some attention
10926 needs to be paid to the setting of waiting_for_input in
10927 wait_reading_process_output() under HAVE_NS because of the call
10928 to ns_select there (needed because otherwise events aren't picked up
10929 outside of polling since we don't get SIGIO like X and we don't have a
10930 separate event loop thread like W32. */
10932 if (waiting_for_input
&& !echoing
)
10933 quit_throw_to_read_char (1);
10937 /* Handle a C-g by making read_char return C-g. */
10940 quit_throw_to_read_char (int from_signal
)
10942 /* When not called from a signal handler it is safe to call
10944 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10945 Fkill_emacs (Qnil
);
10948 /* Prevent another signal from doing this before we finish. */
10949 clear_waiting_for_input ();
10952 Vunread_command_events
= Qnil
;
10953 unread_command_char
= -1;
10955 #if 0 /* Currently, sit_for is called from read_char without turning
10956 off polling. And that can call set_waiting_for_input.
10957 It seems to be harmless. */
10958 #ifdef POLL_FOR_INPUT
10959 /* May be > 1 if in recursive minibuffer. */
10960 if (poll_suppress_count
== 0)
10964 if (FRAMEP (internal_last_event_frame
)
10965 && !EQ (internal_last_event_frame
, selected_frame
))
10966 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10969 _longjmp (getcjmp
, 1);
10972 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10973 Sset_input_interrupt_mode
, 1, 1, 0,
10974 doc
: /* Set interrupt mode of reading keyboard input.
10975 If INTERRUPT is non-nil, Emacs will use input interrupts;
10976 otherwise Emacs uses CBREAK mode.
10978 See also `current-input-mode'. */)
10979 (Lisp_Object interrupt
)
10981 int new_interrupt_input
;
10983 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10984 #ifdef HAVE_X_WINDOWS
10985 if (x_display_list
!= NULL
)
10987 /* When using X, don't give the user a real choice,
10988 because we haven't implemented the mechanisms to support it. */
10989 new_interrupt_input
= 1;
10992 #endif /* HAVE_X_WINDOWS */
10993 new_interrupt_input
= !NILP (interrupt
);
10994 #else /* not SIGIO */
10995 new_interrupt_input
= 0;
10996 #endif /* not SIGIO */
10998 if (new_interrupt_input
!= interrupt_input
)
11000 #ifdef POLL_FOR_INPUT
11004 /* this causes startup screen to be restored and messes with the mouse */
11005 reset_all_sys_modes ();
11006 interrupt_input
= new_interrupt_input
;
11007 init_all_sys_modes ();
11009 interrupt_input
= new_interrupt_input
;
11012 #ifdef POLL_FOR_INPUT
11013 poll_suppress_count
= 1;
11020 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11021 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11022 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11023 C-q in key sequences.
11025 This setting only has an effect on tty terminals and only when
11026 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11028 See also `current-input-mode'. */)
11029 (Lisp_Object flow
, Lisp_Object terminal
)
11031 struct terminal
*t
= get_terminal (terminal
, 1);
11032 struct tty_display_info
*tty
;
11033 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11035 tty
= t
->display_info
.tty
;
11037 if (tty
->flow_control
!= !NILP (flow
))
11040 /* this causes startup screen to be restored and messes with the mouse */
11041 reset_sys_modes (tty
);
11044 tty
->flow_control
= !NILP (flow
);
11047 init_sys_modes (tty
);
11053 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11054 doc
: /* Enable or disable 8-bit input on TERMINAL.
11055 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11056 bit as the Meta modifier.
11058 If META is nil, Emacs will ignore the top bit, on the assumption it is
11061 Otherwise, Emacs will accept and pass through 8-bit input without
11062 specially interpreting the top bit.
11064 This setting only has an effect on tty terminal devices.
11066 Optional parameter TERMINAL specifies the tty terminal device to use.
11067 It may be a terminal object, a frame, or nil for the terminal used by
11068 the currently selected frame.
11070 See also `current-input-mode'. */)
11071 (Lisp_Object meta
, Lisp_Object terminal
)
11073 struct terminal
*t
= get_terminal (terminal
, 1);
11074 struct tty_display_info
*tty
;
11077 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11079 tty
= t
->display_info
.tty
;
11083 else if (EQ (meta
, Qt
))
11088 if (tty
->meta_key
!= new_meta
)
11091 /* this causes startup screen to be restored and messes with the mouse */
11092 reset_sys_modes (tty
);
11095 tty
->meta_key
= new_meta
;
11098 init_sys_modes (tty
);
11104 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11105 doc
: /* Specify character used for quitting.
11106 QUIT must be an ASCII character.
11108 This function only has an effect on the controlling tty of the Emacs
11111 See also `current-input-mode'. */)
11114 struct terminal
*t
= get_named_tty ("/dev/tty");
11115 struct tty_display_info
*tty
;
11116 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11118 tty
= t
->display_info
.tty
;
11120 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11121 error ("QUIT must be an ASCII character");
11124 /* this causes startup screen to be restored and messes with the mouse */
11125 reset_sys_modes (tty
);
11128 /* Don't let this value be out of range. */
11129 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11132 init_sys_modes (tty
);
11138 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11139 doc
: /* Set mode of reading keyboard input.
11140 First arg INTERRUPT non-nil means use input interrupts;
11141 nil means use CBREAK mode.
11142 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11143 (no effect except in CBREAK mode).
11144 Third arg META t means accept 8-bit input (for a Meta key).
11145 META nil means ignore the top bit, on the assumption it is parity.
11146 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11147 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11148 See also `current-input-mode'. */)
11149 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11151 Fset_input_interrupt_mode (interrupt
);
11152 Fset_output_flow_control (flow
, Qnil
);
11153 Fset_input_meta_mode (meta
, Qnil
);
11155 Fset_quit_char (quit
);
11159 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11160 doc
: /* Return information about the way Emacs currently reads keyboard input.
11161 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11162 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11163 nil, Emacs is using CBREAK mode.
11164 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11165 terminal; this does not apply if Emacs uses interrupt-driven input.
11166 META is t if accepting 8-bit input with 8th bit as Meta flag.
11167 META nil means ignoring the top bit, on the assumption it is parity.
11168 META is neither t nor nil if accepting 8-bit input and using
11169 all 8 bits as the character code.
11170 QUIT is the character Emacs currently uses to quit.
11171 The elements of this list correspond to the arguments of
11172 `set-input-mode'. */)
11175 Lisp_Object val
[4];
11176 struct frame
*sf
= XFRAME (selected_frame
);
11178 val
[0] = interrupt_input
? Qt
: Qnil
;
11179 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11181 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11182 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11184 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11191 XSETFASTINT (val
[3], quit_char
);
11193 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11196 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11197 doc
: /* Return position information for pixel coordinates X and Y.
11198 By default, X and Y are relative to text area of the selected window.
11199 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11200 If optional fourth arg WHOLE is non-nil, X is relative to the left
11201 edge of the window.
11203 The return value is similar to a mouse click position:
11204 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11205 IMAGE (DX . DY) (WIDTH . HEIGHT))
11206 The `posn-' functions access elements of such lists. */)
11207 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11212 if (NILP (frame_or_window
))
11213 frame_or_window
= selected_window
;
11215 if (WINDOWP (frame_or_window
))
11219 CHECK_LIVE_WINDOW (frame_or_window
);
11221 w
= XWINDOW (frame_or_window
);
11222 XSETINT (x
, (XINT (x
)
11223 + WINDOW_LEFT_EDGE_X (w
)
11225 ? window_box_left_offset (w
, TEXT_AREA
)
11227 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11228 frame_or_window
= w
->frame
;
11231 CHECK_LIVE_FRAME (frame_or_window
);
11233 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11236 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11237 doc
: /* Return position information for buffer POS in WINDOW.
11238 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11240 Return nil if position is not visible in window. Otherwise,
11241 the return value is similar to that returned by `event-start' for
11242 a mouse click at the upper left corner of the glyph corresponding
11243 to the given buffer position:
11244 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11245 IMAGE (DX . DY) (WIDTH . HEIGHT))
11246 The `posn-' functions access elements of such lists. */)
11247 (Lisp_Object pos
, Lisp_Object window
)
11252 window
= selected_window
;
11254 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11257 Lisp_Object x
= XCAR (tem
);
11258 Lisp_Object y
= XCAR (XCDR (tem
));
11260 /* Point invisible due to hscrolling? */
11263 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11271 * Set up a new kboard object with reasonable initial values.
11274 init_kboard (KBOARD
*kb
)
11276 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11277 KVAR (kb
, Vlast_command
) = Qnil
;
11278 KVAR (kb
, Vreal_last_command
) = Qnil
;
11279 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11280 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11281 KVAR (kb
, Vprefix_arg
) = Qnil
;
11282 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11283 KVAR (kb
, kbd_queue
) = Qnil
;
11284 kb
->kbd_queue_has_data
= 0;
11285 kb
->immediate_echo
= 0;
11286 KVAR (kb
, echo_string
) = Qnil
;
11287 kb
->echo_after_prompt
= -1;
11288 kb
->kbd_macro_buffer
= 0;
11289 kb
->kbd_macro_bufsize
= 0;
11290 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11291 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11292 kb
->reference_count
= 0;
11293 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11294 KVAR (kb
, system_key_syms
) = Qnil
;
11295 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11296 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11297 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11298 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11299 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11303 * Destroy the contents of a kboard object, but not the object itself.
11304 * We use this just before deleting it, or if we're going to initialize
11305 * it a second time.
11308 wipe_kboard (KBOARD
*kb
)
11310 xfree (kb
->kbd_macro_buffer
);
11313 /* Free KB and memory referenced from it. */
11316 delete_kboard (KBOARD
*kb
)
11320 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11323 *kbp
= kb
->next_kboard
;
11325 /* Prevent a dangling reference to KB. */
11326 if (kb
== current_kboard
11327 && FRAMEP (selected_frame
)
11328 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11330 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11332 if (current_kboard
== kb
)
11341 init_keyboard (void)
11343 /* This is correct before outermost invocation of the editor loop */
11344 command_loop_level
= -1;
11345 immediate_quit
= 0;
11346 quit_char
= Ctl ('g');
11347 Vunread_command_events
= Qnil
;
11348 unread_command_char
= -1;
11349 EMACS_SET_INVALID_TIME (timer_idleness_start_time
);
11351 recent_keys_index
= 0;
11352 kbd_fetch_ptr
= kbd_buffer
;
11353 kbd_store_ptr
= kbd_buffer
;
11354 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11355 do_mouse_tracking
= Qnil
;
11358 interrupt_input_blocked
= 0;
11359 interrupt_input_pending
= 0;
11361 pending_signals
= 0;
11364 /* This means that command_loop_1 won't try to select anything the first
11366 internal_last_event_frame
= Qnil
;
11367 Vlast_event_frame
= internal_last_event_frame
;
11369 current_kboard
= initial_kboard
;
11370 /* Re-initialize the keyboard again. */
11371 wipe_kboard (current_kboard
);
11372 init_kboard (current_kboard
);
11373 /* A value of nil for Vwindow_system normally means a tty, but we also use
11374 it for the initial terminal since there is no window system there. */
11375 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11377 if (!noninteractive
)
11379 /* Before multi-tty support, these handlers used to be installed
11380 only if the current session was a tty session. Now an Emacs
11381 session may have multiple display types, so we always handle
11382 SIGINT. There is special code in interrupt_signal to exit
11383 Emacs on SIGINT when there are no termcap frames on the
11384 controlling terminal. */
11385 signal (SIGINT
, interrupt_signal
);
11387 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11388 SIGQUIT and we can't tell which one it will give us. */
11389 signal (SIGQUIT
, interrupt_signal
);
11390 #endif /* not DOS_NT */
11392 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11394 if (!noninteractive
)
11395 signal (SIGIO
, input_available_signal
);
11398 /* Use interrupt input by default, if it works and noninterrupt input
11399 has deficiencies. */
11401 #ifdef INTERRUPT_INPUT
11402 interrupt_input
= 1;
11404 interrupt_input
= 0;
11410 if (keyboard_init_hook
)
11411 (*keyboard_init_hook
) ();
11413 #ifdef POLL_FOR_INPUT
11415 poll_suppress_count
= 1;
11420 /* This type's only use is in syms_of_keyboard, to initialize the
11421 event header symbols and put properties on them. */
11422 struct event_head
{
11428 static const struct event_head head_table
[] = {
11429 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11430 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11431 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11432 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11433 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11434 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11435 /* `select-window' should be handled just like `switch-frame'
11436 in read_key_sequence. */
11437 {&Qselect_window
, "select-window", &Qswitch_frame
}
11441 syms_of_keyboard (void)
11443 pending_funcalls
= Qnil
;
11444 staticpro (&pending_funcalls
);
11446 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11447 staticpro (&Vlispy_mouse_stem
);
11450 DEFSYM (QCimage
, ":image");
11451 DEFSYM (Qhelp_echo
, "help-echo");
11452 DEFSYM (QCrtl
, ":rtl");
11454 staticpro (&item_properties
);
11455 item_properties
= Qnil
;
11457 staticpro (&tool_bar_item_properties
);
11458 tool_bar_item_properties
= Qnil
;
11459 staticpro (&tool_bar_items_vector
);
11460 tool_bar_items_vector
= Qnil
;
11462 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11463 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11464 DEFSYM (Qself_insert_command
, "self-insert-command");
11465 DEFSYM (Qforward_char
, "forward-char");
11466 DEFSYM (Qbackward_char
, "backward-char");
11467 DEFSYM (Qdisabled
, "disabled");
11468 DEFSYM (Qundefined
, "undefined");
11469 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11470 DEFSYM (Qpost_command_hook
, "post-command-hook");
11471 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11472 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11473 DEFSYM (Qfunction_key
, "function-key");
11474 DEFSYM (Qmouse_click
, "mouse-click");
11475 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11476 DEFSYM (Qsave_session
, "save-session");
11477 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11478 DEFSYM (Qmenu_enable
, "menu-enable");
11480 #if defined (WINDOWSNT)
11481 DEFSYM (Qlanguage_change
, "language-change");
11485 DEFSYM (Qdbus_event
, "dbus-event");
11488 DEFSYM (QCenable
, ":enable");
11489 DEFSYM (QCvisible
, ":visible");
11490 DEFSYM (QChelp
, ":help");
11491 DEFSYM (QCfilter
, ":filter");
11492 DEFSYM (QCbutton
, ":button");
11493 DEFSYM (QCkeys
, ":keys");
11494 DEFSYM (QCkey_sequence
, ":key-sequence");
11495 DEFSYM (QCtoggle
, ":toggle");
11496 DEFSYM (QCradio
, ":radio");
11497 DEFSYM (QClabel
, ":label");
11498 DEFSYM (QCvert_only
, ":vert-only");
11500 DEFSYM (Qmode_line
, "mode-line");
11501 DEFSYM (Qvertical_line
, "vertical-line");
11502 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11503 DEFSYM (Qmenu_bar
, "menu-bar");
11505 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11506 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11509 DEFSYM (Qabove_handle
, "above-handle");
11510 DEFSYM (Qhandle
, "handle");
11511 DEFSYM (Qbelow_handle
, "below-handle");
11512 DEFSYM (Qup
, "up");
11513 DEFSYM (Qdown
, "down");
11514 DEFSYM (Qtop
, "top");
11515 DEFSYM (Qbottom
, "bottom");
11516 DEFSYM (Qend_scroll
, "end-scroll");
11517 DEFSYM (Qratio
, "ratio");
11519 DEFSYM (Qevent_kind
, "event-kind");
11520 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11521 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11522 DEFSYM (Qmodifier_cache
, "modifier-cache");
11524 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11525 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11527 DEFSYM (Qpolling_period
, "polling-period");
11529 DEFSYM (Qx_set_selection
, "x-set-selection");
11530 DEFSYM (QPRIMARY
, "PRIMARY");
11531 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11532 DEFSYM (Qhandle_select_window
, "handle-select-window");
11534 DEFSYM (Qinput_method_function
, "input-method-function");
11535 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11536 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11538 DEFSYM (Qhelp_form_show
, "help-form-show");
11540 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11541 Fset (Qinput_method_use_echo_area
, Qnil
);
11543 last_point_position_buffer
= Qnil
;
11544 last_point_position_window
= Qnil
;
11548 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11550 for (i
= 0; i
< len
; i
++)
11552 const struct event_head
*p
= &head_table
[i
];
11553 *p
->var
= intern_c_string (p
->name
);
11554 staticpro (p
->var
);
11555 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11556 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11560 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11561 staticpro (&button_down_location
);
11562 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11563 staticpro (&mouse_syms
);
11564 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11565 / sizeof (lispy_wheel_names
[0])),
11567 staticpro (&wheel_syms
);
11571 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11573 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11574 for (i
= 0; i
< len
; i
++)
11575 if (modifier_names
[i
])
11576 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11577 staticpro (&modifier_symbols
);
11580 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11581 staticpro (&recent_keys
);
11583 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11584 staticpro (&this_command_keys
);
11586 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11587 staticpro (&raw_keybuf
);
11589 DEFSYM (Qextended_command_history
, "extended-command-history");
11590 Fset (Qextended_command_history
, Qnil
);
11592 accent_key_syms
= Qnil
;
11593 staticpro (&accent_key_syms
);
11595 func_key_syms
= Qnil
;
11596 staticpro (&func_key_syms
);
11598 drag_n_drop_syms
= Qnil
;
11599 staticpro (&drag_n_drop_syms
);
11601 unread_switch_frame
= Qnil
;
11602 staticpro (&unread_switch_frame
);
11604 internal_last_event_frame
= Qnil
;
11605 staticpro (&internal_last_event_frame
);
11607 read_key_sequence_cmd
= Qnil
;
11608 staticpro (&read_key_sequence_cmd
);
11609 read_key_sequence_remapped
= Qnil
;
11610 staticpro (&read_key_sequence_remapped
);
11612 menu_bar_one_keymap_changed_items
= Qnil
;
11613 staticpro (&menu_bar_one_keymap_changed_items
);
11615 menu_bar_items_vector
= Qnil
;
11616 staticpro (&menu_bar_items_vector
);
11618 help_form_saved_window_configs
= Qnil
;
11619 staticpro (&help_form_saved_window_configs
);
11621 defsubr (&Scurrent_idle_time
);
11622 defsubr (&Sevent_symbol_parse_modifiers
);
11623 defsubr (&Sevent_convert_list
);
11624 defsubr (&Sread_key_sequence
);
11625 defsubr (&Sread_key_sequence_vector
);
11626 defsubr (&Srecursive_edit
);
11627 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11628 defsubr (&Strack_mouse
);
11630 defsubr (&Sinput_pending_p
);
11631 defsubr (&Scommand_execute
);
11632 defsubr (&Srecent_keys
);
11633 defsubr (&Sthis_command_keys
);
11634 defsubr (&Sthis_command_keys_vector
);
11635 defsubr (&Sthis_single_command_keys
);
11636 defsubr (&Sthis_single_command_raw_keys
);
11637 defsubr (&Sreset_this_command_lengths
);
11638 defsubr (&Sclear_this_command_keys
);
11639 defsubr (&Ssuspend_emacs
);
11640 defsubr (&Sabort_recursive_edit
);
11641 defsubr (&Sexit_recursive_edit
);
11642 defsubr (&Srecursion_depth
);
11643 defsubr (&Stop_level
);
11644 defsubr (&Sdiscard_input
);
11645 defsubr (&Sopen_dribble_file
);
11646 defsubr (&Sset_input_interrupt_mode
);
11647 defsubr (&Sset_output_flow_control
);
11648 defsubr (&Sset_input_meta_mode
);
11649 defsubr (&Sset_quit_char
);
11650 defsubr (&Sset_input_mode
);
11651 defsubr (&Scurrent_input_mode
);
11652 defsubr (&Sposn_at_point
);
11653 defsubr (&Sposn_at_x_y
);
11655 DEFVAR_LISP ("last-command-event", last_command_event
,
11656 doc
: /* Last input event that was part of a command. */);
11658 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11659 doc
: /* Last input event in a command, except for mouse menu events.
11660 Mouse menus give back keys that don't look like mouse events;
11661 this variable holds the actual mouse event that led to the menu,
11662 so that you can determine whether the command was run by mouse or not. */);
11664 DEFVAR_LISP ("last-input-event", last_input_event
,
11665 doc
: /* Last input event. */);
11667 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11668 doc
: /* List of events to be read as the command input.
11669 These events are processed first, before actual keyboard input.
11670 Events read from this list are not normally added to `this-command-keys',
11671 as they will already have been added once as they were read for the first time.
11672 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11673 Vunread_command_events
= Qnil
;
11675 DEFVAR_INT ("unread-command-char", unread_command_char
,
11676 doc
: /* If not -1, an object to be read as next command input event. */);
11678 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11679 doc
: /* List of events to be processed as input by input methods.
11680 These events are processed before `unread-command-events'
11681 and actual keyboard input, but are not given to `input-method-function'. */);
11682 Vunread_post_input_method_events
= Qnil
;
11684 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11685 doc
: /* List of events to be processed as input by input methods.
11686 These events are processed after `unread-command-events', but
11687 before actual keyboard input.
11688 If there's an active input method, the events are given to
11689 `input-method-function'. */);
11690 Vunread_input_method_events
= Qnil
;
11692 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11693 doc
: /* Meta-prefix character code.
11694 Meta-foo as command input turns into this character followed by foo. */);
11695 XSETINT (meta_prefix_char
, 033);
11697 DEFVAR_KBOARD ("last-command", Vlast_command
,
11698 doc
: /* The last command executed.
11699 Normally a symbol with a function definition, but can be whatever was found
11700 in the keymap, or whatever the variable `this-command' was set to by that
11703 The value `mode-exit' is special; it means that the previous command
11704 read an event that told it to exit, and it did so and unread that event.
11705 In other words, the present command is the event that made the previous
11708 The value `kill-region' is special; it means that the previous command
11709 was a kill command.
11711 `last-command' has a separate binding for each terminal device.
11712 See Info node `(elisp)Multiple Terminals'. */);
11714 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11715 doc
: /* Same as `last-command', but never altered by Lisp code.
11716 Taken from the previous value of `real-this-command'. */);
11718 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11719 doc
: /* Last command that may be repeated.
11720 The last command executed that was not bound to an input event.
11721 This is the command `repeat' will try to repeat.
11722 Taken from a previous value of `real-this-command'. */);
11724 DEFVAR_LISP ("this-command", Vthis_command
,
11725 doc
: /* The command now being executed.
11726 The command can set this variable; whatever is put here
11727 will be in `last-command' during the following command. */);
11728 Vthis_command
= Qnil
;
11730 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11731 doc
: /* This is like `this-command', except that commands should never modify it. */);
11732 Vreal_this_command
= Qnil
;
11734 DEFVAR_LISP ("this-command-keys-shift-translated",
11735 Vthis_command_keys_shift_translated
,
11736 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11737 Shift-translation occurs when there is no binding for the key sequence
11738 as entered, but a binding was found by changing an upper-case letter
11739 to lower-case, or a shifted function key to an unshifted one. */);
11740 Vthis_command_keys_shift_translated
= Qnil
;
11742 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11743 doc
: /* The command bound to the current key sequence before remapping.
11744 It equals `this-command' if the original command was not remapped through
11745 any of the active keymaps. Otherwise, the value of `this-command' is the
11746 result of looking up the original command in the active keymaps. */);
11747 Vthis_original_command
= Qnil
;
11749 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11750 doc
: /* Number of input events between auto-saves.
11751 Zero means disable autosaving due to number of characters typed. */);
11752 auto_save_interval
= 300;
11754 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11755 doc
: /* Number of seconds idle time before auto-save.
11756 Zero or nil means disable auto-saving due to idleness.
11757 After auto-saving due to this many seconds of idle time,
11758 Emacs also does a garbage collection if that seems to be warranted. */);
11759 XSETFASTINT (Vauto_save_timeout
, 30);
11761 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11762 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11763 The value may be integer or floating point.
11764 If the value is zero, don't echo at all. */);
11765 Vecho_keystrokes
= make_number (1);
11767 DEFVAR_INT ("polling-period", polling_period
,
11768 doc
: /* Interval between polling for input during Lisp execution.
11769 The reason for polling is to make C-g work to stop a running program.
11770 Polling is needed only when using X windows and SIGIO does not work.
11771 Polling is automatically disabled in all other cases. */);
11772 polling_period
= 2;
11774 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11775 doc
: /* Maximum time between mouse clicks to make a double-click.
11776 Measured in milliseconds. The value nil means disable double-click
11777 recognition; t means double-clicks have no time limit and are detected
11778 by position only. */);
11779 Vdouble_click_time
= make_number (500);
11781 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11782 doc
: /* Maximum mouse movement between clicks to make a double-click.
11783 On window-system frames, value is the number of pixels the mouse may have
11784 moved horizontally or vertically between two clicks to make a double-click.
11785 On non window-system frames, value is interpreted in units of 1/8 characters
11788 This variable is also the threshold for motion of the mouse
11789 to count as a drag. */);
11790 double_click_fuzz
= 3;
11792 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11793 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11794 inhibit_local_menu_bar_menus
= 0;
11796 DEFVAR_INT ("num-input-keys", num_input_keys
,
11797 doc
: /* Number of complete key sequences read as input so far.
11798 This includes key sequences read from keyboard macros.
11799 The number is effectively the number of interactive command invocations. */);
11800 num_input_keys
= 0;
11802 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11803 doc
: /* Number of input events read from the keyboard so far.
11804 This does not include events generated by keyboard macros. */);
11805 num_nonmacro_input_events
= 0;
11807 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11808 doc
: /* The frame in which the most recently read event occurred.
11809 If the last event came from a keyboard macro, this is set to `macro'. */);
11810 Vlast_event_frame
= Qnil
;
11812 /* This variable is set up in sysdep.c. */
11813 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11814 doc
: /* The ERASE character as set by the user with stty. */);
11816 DEFVAR_LISP ("help-char", Vhelp_char
,
11817 doc
: /* Character to recognize as meaning Help.
11818 When it is read, do `(eval help-form)', and display result if it's a string.
11819 If the value of `help-form' is nil, this char can be read normally. */);
11820 XSETINT (Vhelp_char
, Ctl ('H'));
11822 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11823 doc
: /* List of input events to recognize as meaning Help.
11824 These work just like the value of `help-char' (see that). */);
11825 Vhelp_event_list
= Qnil
;
11827 DEFVAR_LISP ("help-form", Vhelp_form
,
11828 doc
: /* Form to execute when character `help-char' is read.
11829 If the form returns a string, that string is displayed.
11830 If `help-form' is nil, the help char is not recognized. */);
11833 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11834 doc
: /* Command to run when `help-char' character follows a prefix key.
11835 This command is used only when there is no actual binding
11836 for that character after that prefix key. */);
11837 Vprefix_help_command
= Qnil
;
11839 DEFVAR_LISP ("top-level", Vtop_level
,
11840 doc
: /* Form to evaluate when Emacs starts up.
11841 Useful to set before you dump a modified Emacs. */);
11844 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11845 doc
: /* Translate table for local keyboard input, or nil.
11846 If non-nil, the value should be a char-table. Each character read
11847 from the keyboard is looked up in this char-table. If the value found
11848 there is non-nil, then it is used instead of the actual input character.
11850 The value can also be a string or vector, but this is considered obsolete.
11851 If it is a string or vector of length N, character codes N and up are left
11852 untranslated. In a vector, an element which is nil means "no translation".
11854 This is applied to the characters supplied to input methods, not their
11855 output. See also `translation-table-for-input'.
11857 This variable has a separate binding for each terminal.
11858 See Info node `(elisp)Multiple Terminals'. */);
11860 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11861 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11862 \(Even if the operating system has support for stopping a process.\) */);
11863 cannot_suspend
= 0;
11865 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11866 doc
: /* Non-nil means prompt with menus when appropriate.
11867 This is done when reading from a keymap that has a prompt string,
11868 for elements that have prompt strings.
11869 The menu is displayed on the screen
11870 if X menus were enabled at configuration
11871 time and the previous event was a mouse click prefix key.
11872 Otherwise, menu prompting uses the echo area. */);
11873 menu_prompting
= 1;
11875 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11876 doc
: /* Character to see next line of menu prompt.
11877 Type this character while in a menu prompt to rotate around the lines of it. */);
11878 XSETINT (menu_prompt_more_char
, ' ');
11880 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11881 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11882 Emacs applies the modifiers of the character stored here to each keyboard
11883 character it reads. For example, after evaluating the expression
11884 (setq extra-keyboard-modifiers ?\\C-x)
11885 all input characters will have the control modifier applied to them.
11887 Note that the character ?\\C-@, equivalent to the integer zero, does
11888 not count as a control character; rather, it counts as a character
11889 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11890 cancels any modification. */);
11891 extra_keyboard_modifiers
= 0;
11893 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11894 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11895 The command loop sets this to nil before each command,
11896 and tests the value when the command returns.
11897 Buffer modification stores t in this variable. */);
11898 Vdeactivate_mark
= Qnil
;
11899 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11901 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11902 doc
: /* Normal hook run before each command is executed.
11903 If an unhandled error happens in running this hook,
11904 the function in which the error occurred is unconditionally removed, since
11905 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11906 Vpre_command_hook
= Qnil
;
11908 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11909 doc
: /* Normal hook run after each command is executed.
11910 If an unhandled error happens in running this hook,
11911 the function in which the error occurred is unconditionally removed, since
11912 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11913 Vpost_command_hook
= Qnil
;
11916 DEFVAR_LISP ("echo-area-clear-hook", ...,
11917 doc
: /* Normal hook run when clearing the echo area. */);
11919 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11920 Fset (Qecho_area_clear_hook
, Qnil
);
11922 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11923 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11924 Vlucid_menu_bar_dirty_flag
= Qnil
;
11926 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11927 doc
: /* List of menu bar items to move to the end of the menu bar.
11928 The elements of the list are event types that may have menu bar bindings. */);
11929 Vmenu_bar_final_items
= Qnil
;
11931 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11932 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11933 This is used internally by graphical displays that do not render
11934 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11935 Vtool_bar_separator_image_expression
= Qnil
;
11937 DEFVAR_KBOARD ("overriding-terminal-local-map",
11938 Voverriding_terminal_local_map
,
11939 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11940 If this variable is non-nil, it is used as a keymap instead of the
11941 buffer's local map, and the minor mode keymaps and text property keymaps.
11942 It also replaces `overriding-local-map'.
11944 This variable is intended to let commands such as `universal-argument'
11945 set up a different keymap for reading the next command.
11947 `overriding-terminal-local-map' has a separate binding for each
11949 See Info node `(elisp)Multiple Terminals'. */);
11951 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11952 doc
: /* Keymap that overrides all other local keymaps.
11953 If this variable is non-nil, it is used as a keymap--replacing the
11954 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11955 Voverriding_local_map
= Qnil
;
11957 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11958 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11959 Otherwise, the menu bar continues to reflect the buffer's local map
11960 and the minor mode maps regardless of `overriding-local-map'. */);
11961 Voverriding_local_map_menu_flag
= Qnil
;
11963 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11964 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11965 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11967 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11968 doc
: /* Non-nil means generate motion events for mouse motion. */);
11970 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11971 doc
: /* Alist of system-specific X windows key symbols.
11972 Each element should have the form (N . SYMBOL) where N is the
11973 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11974 and SYMBOL is its name.
11976 `system-key-alist' has a separate binding for each terminal device.
11977 See Info node `(elisp)Multiple Terminals'. */);
11979 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11980 doc
: /* Keymap that translates key sequences to key sequences during input.
11981 This is used mainly for mapping key sequences into some preferred
11982 key events (symbols).
11984 The `read-key-sequence' function replaces any subsequence bound by
11985 `local-function-key-map' with its binding. More precisely, when the
11986 active keymaps have no binding for the current key sequence but
11987 `local-function-key-map' binds a suffix of the sequence to a vector or
11988 string, `read-key-sequence' replaces the matching suffix with its
11989 binding, and continues with the new sequence.
11991 If the binding is a function, it is called with one argument (the prompt)
11992 and its return value (a key sequence) is used.
11994 The events that come from bindings in `local-function-key-map' are not
11995 themselves looked up in `local-function-key-map'.
11997 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11998 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11999 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12000 typing `ESC O P x' would return [f1 x].
12002 `local-function-key-map' has a separate binding for each terminal
12003 device. See Info node `(elisp)Multiple Terminals'. If you need to
12004 define a binding on all terminals, change `function-key-map'
12005 instead. Initially, `local-function-key-map' is an empty keymap that
12006 has `function-key-map' as its parent on all terminal devices. */);
12008 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12009 doc
: /* Keymap that decodes input escape sequences.
12010 This is used mainly for mapping ASCII function key sequences into
12011 real Emacs function key events (symbols).
12013 The `read-key-sequence' function replaces any subsequence bound by
12014 `input-decode-map' with its binding. Contrary to `function-key-map',
12015 this map applies its rebinding regardless of the presence of an ordinary
12016 binding. So it is more like `key-translation-map' except that it applies
12017 before `function-key-map' rather than after.
12019 If the binding is a function, it is called with one argument (the prompt)
12020 and its return value (a key sequence) is used.
12022 The events that come from bindings in `input-decode-map' are not
12023 themselves looked up in `input-decode-map'.
12025 This variable is keyboard-local. */);
12027 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12028 doc
: /* The parent keymap of all `local-function-key-map' instances.
12029 Function key definitions that apply to all terminal devices should go
12030 here. If a mapping is defined in both the current
12031 `local-function-key-map' binding and this variable, then the local
12032 definition will take precedence. */);
12033 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12035 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12036 doc
: /* Keymap of key translations that can override keymaps.
12037 This keymap works like `function-key-map', but comes after that,
12038 and its non-prefix bindings override ordinary bindings.
12039 Another difference is that it is global rather than keyboard-local. */);
12040 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12042 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12043 doc
: /* List of deferred actions to be performed at a later time.
12044 The precise format isn't relevant here; we just check whether it is nil. */);
12045 Vdeferred_action_list
= Qnil
;
12047 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12048 doc
: /* Function to call to handle deferred actions, after each command.
12049 This function is called with no arguments after each command
12050 whenever `deferred-action-list' is non-nil. */);
12051 Vdeferred_action_function
= Qnil
;
12053 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12054 doc
: /* List of warnings to be displayed after this command.
12055 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12056 as per the args of `display-warning' (which see).
12057 If this variable is non-nil, `delayed-warnings-hook' will be run
12058 immediately after running `post-command-hook'. */);
12059 Vdelayed_warnings_list
= Qnil
;
12061 DEFVAR_LISP ("timer-list", Vtimer_list
,
12062 doc
: /* List of active absolute time timers in order of increasing time. */);
12063 Vtimer_list
= Qnil
;
12065 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12066 doc
: /* List of active idle-time timers in order of increasing time. */);
12067 Vtimer_idle_list
= Qnil
;
12069 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12070 doc
: /* If non-nil, the function that implements the current input method.
12071 It's called with one argument, a printing character that was just read.
12072 \(That means a character with code 040...0176.)
12073 Typically this function uses `read-event' to read additional events.
12074 When it does so, it should first bind `input-method-function' to nil
12075 so it will not be called recursively.
12077 The function should return a list of zero or more events
12078 to be used as input. If it wants to put back some events
12079 to be reconsidered, separately, by the input method,
12080 it can add them to the beginning of `unread-command-events'.
12082 The input method function can find in `input-method-previous-message'
12083 the previous echo area message.
12085 The input method function should refer to the variables
12086 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12087 for guidance on what to do. */);
12088 Vinput_method_function
= Qnil
;
12090 DEFVAR_LISP ("input-method-previous-message",
12091 Vinput_method_previous_message
,
12092 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12093 This variable exists because `read-event' clears the echo area
12094 before running the input method. It is nil if there was no message. */);
12095 Vinput_method_previous_message
= Qnil
;
12097 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12098 doc
: /* If non-nil, the function that implements the display of help.
12099 It's called with one argument, the help string to display. */);
12100 Vshow_help_function
= Qnil
;
12102 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12103 doc
: /* If non-nil, suppress point adjustment after executing a command.
12105 After a command is executed, if point is moved into a region that has
12106 special properties (e.g. composition, display), we adjust point to
12107 the boundary of the region. But, when a command sets this variable to
12108 non-nil, we suppress the point adjustment.
12110 This variable is set to nil before reading a command, and is checked
12111 just after executing the command. */);
12112 Vdisable_point_adjustment
= Qnil
;
12114 DEFVAR_LISP ("global-disable-point-adjustment",
12115 Vglobal_disable_point_adjustment
,
12116 doc
: /* If non-nil, always suppress point adjustment.
12118 The default value is nil, in which case, point adjustment are
12119 suppressed only after special commands that set
12120 `disable-point-adjustment' (which see) to non-nil. */);
12121 Vglobal_disable_point_adjustment
= Qnil
;
12123 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12124 doc
: /* How long to display an echo-area message when the minibuffer is active.
12125 If the value is not a number, such messages don't time out. */);
12126 Vminibuffer_message_timeout
= make_number (2);
12128 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12129 doc
: /* If non-nil, any keyboard input throws to this symbol.
12130 The value of that variable is passed to `quit-flag' and later causes a
12131 peculiar kind of quitting. */);
12132 Vthrow_on_input
= Qnil
;
12134 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12135 doc
: /* If non-nil, function to output error messages.
12136 The arguments are the error data, a list of the form
12137 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12138 such as just as `condition-case' would bind its variable to,
12139 the context (a string which normally goes at the start of the message),
12140 and the Lisp function within which the error was signaled. */);
12141 Vcommand_error_function
= Qnil
;
12143 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12144 Venable_disabled_menus_and_buttons
,
12145 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12147 Help functions bind this to allow help on disabled menu items
12148 and tool-bar buttons. */);
12149 Venable_disabled_menus_and_buttons
= Qnil
;
12151 DEFVAR_LISP ("select-active-regions",
12152 Vselect_active_regions
,
12153 doc
: /* If non-nil, an active region automatically sets the primary selection.
12154 If the value is `only', only temporarily active regions (usually made
12155 by mouse-dragging or shift-selection) set the window selection.
12157 This takes effect only when Transient Mark mode is enabled. */);
12158 Vselect_active_regions
= Qt
;
12160 DEFVAR_LISP ("saved-region-selection",
12161 Vsaved_region_selection
,
12162 doc
: /* Contents of active region prior to buffer modification.
12163 If `select-active-regions' is non-nil, Emacs sets this to the
12164 text in the region before modifying the buffer. The next
12165 `deactivate-mark' call uses this to set the window selection. */);
12166 Vsaved_region_selection
= Qnil
;
12168 DEFVAR_LISP ("selection-inhibit-update-commands",
12169 Vselection_inhibit_update_commands
,
12170 doc
: /* List of commands which should not update the selection.
12171 Normally, if `select-active-regions' is non-nil and the mark remains
12172 active after a command (i.e. the mark was not deactivated), the Emacs
12173 command loop sets the selection to the text in the region. However,
12174 if the command is in this list, the selection is not updated. */);
12175 Vselection_inhibit_update_commands
12176 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12178 DEFVAR_LISP ("debug-on-event",
12180 doc
: /* Enter debugger on this event. When Emacs
12181 receives the special event specified by this variable, it will try to
12182 break into the debugger as soon as possible instead of processing the
12183 event normally through `special-event-map'.
12185 Currently, the only supported values for this
12186 variable are `sigusr1' and `sigusr2'. */);
12187 Vdebug_on_event
= intern_c_string ("sigusr2");
12189 /* Create the initial keyboard. */
12190 initial_kboard
= xmalloc (sizeof (KBOARD
));
12191 init_kboard (initial_kboard
);
12192 /* Vwindow_system is left at t for now. */
12193 initial_kboard
->next_kboard
= all_kboards
;
12194 all_kboards
= initial_kboard
;
12198 keys_of_keyboard (void)
12200 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12201 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12202 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12203 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12204 initial_define_key (meta_map
, 'x', "execute-extended-command");
12206 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12207 "handle-delete-frame");
12208 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12209 "ns-put-working-text");
12210 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12211 "ns-unput-working-text");
12212 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12213 current-prefix-arg, as is done in `handle-switch-frame'.
12214 But `handle-switch-frame is not run from the special-map.
12215 Commands from that map are run in a special way that automatically
12216 preserves the prefix-arg. Restoring the prefix arg here is not just
12217 redundant but harmful:
12219 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12220 - after the first prompt, the exit-minibuffer-hook is run which may
12221 iconify a frame and thus push a `iconify-frame' event.
12222 - after running exit-minibuffer-hook, current-prefix-arg is
12223 restored to the non-nil value it had before the prompt.
12224 - we enter the second prompt.
12225 current-prefix-arg is non-nil, prefix-arg is nil.
12226 - before running the first real event, we run the special iconify-frame
12227 event, but we pass the `special' arg to execute-command so
12228 current-prefix-arg and prefix-arg are left untouched.
12229 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12230 - the next key event will have a spuriously non-nil current-prefix-arg. */
12231 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12233 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12235 /* Handling it at such a low-level causes read_key_sequence to get
12236 * confused because it doesn't realize that the current_buffer was
12237 * changed by read_char.
12239 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12240 * "handle-select-window"); */
12241 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12242 "handle-save-session");
12245 /* Define a special event which is raised for dbus callback
12247 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12248 "dbus-handle-event");
12251 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12255 /* Mark the pointers in the kboard objects.
12256 Called by Fgarbage_collect. */
12258 mark_kboards (void)
12262 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12264 if (kb
->kbd_macro_buffer
)
12265 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12267 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12268 mark_object (KVAR (kb
, Vlast_command
));
12269 mark_object (KVAR (kb
, Vreal_last_command
));
12270 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12271 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12272 mark_object (KVAR (kb
, Vprefix_arg
));
12273 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12274 mark_object (KVAR (kb
, kbd_queue
));
12275 mark_object (KVAR (kb
, defining_kbd_macro
));
12276 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12277 mark_object (KVAR (kb
, Vsystem_key_alist
));
12278 mark_object (KVAR (kb
, system_key_syms
));
12279 mark_object (KVAR (kb
, Vwindow_system
));
12280 mark_object (KVAR (kb
, Vinput_decode_map
));
12281 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12282 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12283 mark_object (KVAR (kb
, echo_string
));
12286 struct input_event
*event
;
12287 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12289 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12290 event
= kbd_buffer
;
12291 if (event
->kind
!= SELECTION_REQUEST_EVENT
12292 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12294 mark_object (event
->x
);
12295 mark_object (event
->y
);
12297 mark_object (event
->frame_or_window
);
12298 mark_object (event
->arg
);