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 Lisp_Object (Fcommand_execute
) (Lisp_Object
, Lisp_Object
, Lisp_Object
,
464 static void handle_interrupt (void);
465 static _Noreturn
void quit_throw_to_read_char (int);
466 static void process_special_events (void);
467 static void timer_start_idle (void);
468 static void timer_stop_idle (void);
469 static void timer_resume_idle (void);
470 static void handle_user_signal (int);
471 static char *find_user_signal_name (int);
472 static int store_user_signal_events (void);
475 /* Add C to the echo string, if echoing is going on.
476 C can be a character, which is printed prettily ("M-C-x" and all that
477 jazz), or a symbol, whose name is printed. */
480 echo_char (Lisp_Object c
)
482 if (current_kboard
->immediate_echo
)
484 int size
= KEY_DESCRIPTION_SIZE
+ 100;
485 char *buffer
= (char *) alloca (size
);
487 Lisp_Object echo_string
;
489 echo_string
= KVAR (current_kboard
, echo_string
);
491 /* If someone has passed us a composite event, use its head symbol. */
496 ptr
= push_key_description (XINT (c
), ptr
, 1);
498 else if (SYMBOLP (c
))
500 Lisp_Object name
= SYMBOL_NAME (c
);
501 int nbytes
= SBYTES (name
);
503 if (size
- (ptr
- buffer
) < nbytes
)
505 int offset
= ptr
- buffer
;
506 size
= max (2 * size
, size
+ nbytes
);
507 buffer
= (char *) alloca (size
);
508 ptr
= buffer
+ offset
;
511 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
512 STRING_MULTIBYTE (name
), 1);
515 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
518 const char *text
= " (Type ? for further options)";
519 int len
= strlen (text
);
521 if (size
- (ptr
- buffer
) < len
)
523 int offset
= ptr
- buffer
;
525 buffer
= (char *) alloca (size
);
526 ptr
= buffer
+ offset
;
529 memcpy (ptr
, text
, len
);
533 /* Replace a dash from echo_dash with a space, otherwise
534 add a space at the end as a separator between keys. */
535 if (STRINGP (echo_string
)
536 && SCHARS (echo_string
) > 1)
538 Lisp_Object last_char
, prev_char
, idx
;
540 idx
= make_number (SCHARS (echo_string
) - 2);
541 prev_char
= Faref (echo_string
, idx
);
543 idx
= make_number (SCHARS (echo_string
) - 1);
544 last_char
= Faref (echo_string
, idx
);
546 /* We test PREV_CHAR to make sure this isn't the echoing
548 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
549 Faset (echo_string
, idx
, make_number (' '));
551 echo_string
= concat2 (echo_string
, build_string (" "));
553 else if (STRINGP (echo_string
))
554 echo_string
= concat2 (echo_string
, build_string (" "));
556 KVAR (current_kboard
, echo_string
)
557 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
563 /* Temporarily add a dash to the end of the echo string if it's not
564 empty, so that it serves as a mini-prompt for the very next character. */
569 /* Do nothing if not echoing at all. */
570 if (NILP (KVAR (current_kboard
, echo_string
)))
573 if (this_command_key_count
== 0)
576 if (!current_kboard
->immediate_echo
577 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
580 /* Do nothing if we just printed a prompt. */
581 if (current_kboard
->echo_after_prompt
582 == SCHARS (KVAR (current_kboard
, echo_string
)))
585 /* Do nothing if we have already put a dash at the end. */
586 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
588 Lisp_Object last_char
, prev_char
, idx
;
590 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
591 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
593 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
594 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
596 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
600 /* Put a dash at the end of the buffer temporarily,
601 but make it go away when the next character is added. */
602 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
607 /* Display the current echo string, and begin echoing if not already
613 if (!current_kboard
->immediate_echo
)
616 current_kboard
->immediate_echo
= 1;
618 for (i
= 0; i
< this_command_key_count
; i
++)
622 /* Set before_command_echo_length to the value that would
623 have been saved before the start of this subcommand in
624 command_loop_1, if we had already been echoing then. */
625 if (i
== this_single_command_key_start
)
626 before_command_echo_length
= echo_length ();
628 c
= AREF (this_command_keys
, i
);
629 if (! (EVENT_HAS_PARAMETERS (c
)
630 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
634 /* Set before_command_echo_length to the value that would
635 have been saved before the start of this subcommand in
636 command_loop_1, if we had already been echoing then. */
637 if (this_command_key_count
== this_single_command_key_start
)
638 before_command_echo_length
= echo_length ();
640 /* Put a dash at the end to invite the user to type more. */
645 message3_nolog (KVAR (current_kboard
, echo_string
),
646 SBYTES (KVAR (current_kboard
, echo_string
)),
647 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
650 /* Record in what buffer we echoed, and from which kboard. */
651 echo_message_buffer
= echo_area_buffer
[0];
652 echo_kboard
= current_kboard
;
654 if (waiting_for_input
&& !NILP (Vquit_flag
))
655 quit_throw_to_read_char (0);
658 /* Turn off echoing, for the start of a new command. */
661 cancel_echoing (void)
663 current_kboard
->immediate_echo
= 0;
664 current_kboard
->echo_after_prompt
= -1;
665 KVAR (current_kboard
, echo_string
) = Qnil
;
666 ok_to_echo_at_next_pause
= NULL
;
668 echo_message_buffer
= Qnil
;
671 /* Return the length of the current echo string. */
676 return (STRINGP (KVAR (current_kboard
, echo_string
))
677 ? SCHARS (KVAR (current_kboard
, echo_string
))
681 /* Truncate the current echo message to its first LEN chars.
682 This and echo_char get used by read_key_sequence when the user
683 switches frames while entering a key sequence. */
686 echo_truncate (ptrdiff_t nchars
)
688 if (STRINGP (KVAR (current_kboard
, echo_string
)))
689 KVAR (current_kboard
, echo_string
)
690 = Fsubstring (KVAR (current_kboard
, echo_string
),
691 make_number (0), make_number (nchars
));
692 truncate_echo_area (nchars
);
696 /* Functions for manipulating this_command_keys. */
698 add_command_key (Lisp_Object key
)
700 #if 0 /* Not needed after we made Freset_this_command_lengths
701 do the job immediately. */
702 /* If reset-this-command-length was called recently, obey it now.
703 See the doc string of that function for an explanation of why. */
704 if (before_command_restore_flag
)
706 this_command_key_count
= before_command_key_count_1
;
707 if (this_command_key_count
< this_single_command_key_start
)
708 this_single_command_key_start
= this_command_key_count
;
709 echo_truncate (before_command_echo_length_1
);
710 before_command_restore_flag
= 0;
714 if (this_command_key_count
>= ASIZE (this_command_keys
))
715 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
717 ASET (this_command_keys
, this_command_key_count
, key
);
718 ++this_command_key_count
;
723 recursive_edit_1 (void)
725 ptrdiff_t count
= SPECPDL_INDEX ();
728 if (command_loop_level
> 0)
730 specbind (Qstandard_output
, Qt
);
731 specbind (Qstandard_input
, Qt
);
734 #ifdef HAVE_WINDOW_SYSTEM
735 /* The command loop has started an hourglass timer, so we have to
736 cancel it here, otherwise it will fire because the recursive edit
737 can take some time. Do not check for display_hourglass_p here,
738 because it could already be nil. */
742 /* This function may have been called from a debugger called from
743 within redisplay, for instance by Edebugging a function called
744 from fontification-functions. We want to allow redisplay in
745 the debugging session.
747 The recursive edit is left with a `(throw exit ...)'. The `exit'
748 tag is not caught anywhere in redisplay, i.e. when we leave the
749 recursive edit, the original redisplay leading to the recursive
750 edit will be unwound. The outcome should therefore be safe. */
751 specbind (Qinhibit_redisplay
, Qnil
);
754 val
= command_loop ();
756 Fsignal (Qquit
, Qnil
);
757 /* Handle throw from read_minibuf when using minibuffer
758 while it's active but we're in another window. */
760 xsignal1 (Qerror
, val
);
762 return unbind_to (count
, Qnil
);
765 /* When an auto-save happens, record the "time", and don't do again soon. */
768 record_auto_save (void)
770 last_auto_save
= num_nonmacro_input_events
;
773 /* Make an auto save happen as soon as possible at command level. */
777 force_auto_save_soon (void)
779 last_auto_save
= - auto_save_interval
- 1;
781 record_asynch_buffer_change ();
785 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
786 doc
: /* Invoke the editor command loop recursively.
787 To get out of the recursive edit, a command can do `(throw 'exit nil)';
788 that tells this function to return.
789 Alternatively, `(throw 'exit t)' makes this function signal an error.
790 This function is called by the editor initialization to begin editing. */)
793 ptrdiff_t count
= SPECPDL_INDEX ();
796 /* If we enter while input is blocked, don't lock up here.
797 This may happen through the debugger during redisplay. */
801 command_loop_level
++;
802 update_mode_lines
= 1;
804 if (command_loop_level
805 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
806 buffer
= Fcurrent_buffer ();
810 /* If we leave recursive_edit_1 below with a `throw' for instance,
811 like it is done in the splash screen display, we have to
812 make sure that we restore single_kboard as command_loop_1
813 would have done if it were left normally. */
814 if (command_loop_level
> 0)
815 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
816 record_unwind_protect (recursive_edit_unwind
, buffer
);
819 return unbind_to (count
, Qnil
);
823 recursive_edit_unwind (Lisp_Object buffer
)
825 if (BUFFERP (buffer
))
826 Fset_buffer (buffer
);
828 command_loop_level
--;
829 update_mode_lines
= 1;
834 #if 0 /* These two functions are now replaced with
835 temporarily_switch_to_single_kboard. */
839 #if 0 /* Theory: if there's anything in Vunread_command_events,
840 it will right away be read by read_key_sequence,
841 and then if we do switch KBOARDS, it will go into the side
842 queue then. So we don't need to do anything special here -- rms. */
843 if (CONSP (Vunread_command_events
))
845 current_kboard
->kbd_queue
846 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
847 current_kboard
->kbd_queue_has_data
= 1;
849 Vunread_command_events
= Qnil
;
854 /* Switch to the single-kboard state, making current_kboard
855 the only KBOARD from which further input is accepted. */
858 single_kboard_state ()
864 /* If we're in single_kboard state for kboard KBOARD,
868 not_single_kboard_state (KBOARD
*kboard
)
870 if (kboard
== current_kboard
)
874 /* Maintain a stack of kboards, so other parts of Emacs
875 can switch temporarily to the kboard of a given frame
876 and then revert to the previous status. */
881 struct kboard_stack
*next
;
884 static struct kboard_stack
*kboard_stack
;
887 push_kboard (struct kboard
*k
)
889 struct kboard_stack
*p
890 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
892 p
->next
= kboard_stack
;
893 p
->kboard
= current_kboard
;
903 struct kboard_stack
*p
= kboard_stack
;
905 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
907 if (t
->kboard
== p
->kboard
)
909 current_kboard
= p
->kboard
;
916 /* The terminal we remembered has been deleted. */
917 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
920 kboard_stack
= p
->next
;
924 /* Switch to single_kboard mode, making current_kboard the only KBOARD
925 from which further input is accepted. If F is non-nil, set its
926 KBOARD as the current keyboard.
928 This function uses record_unwind_protect to return to the previous
931 If Emacs is already in single_kboard mode, and F's keyboard is
932 locked, then this function will throw an error. */
935 temporarily_switch_to_single_kboard (struct frame
*f
)
937 int was_locked
= single_kboard
;
940 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
941 /* We can not switch keyboards while in single_kboard mode.
942 In rare cases, Lisp code may call `recursive-edit' (or
943 `read-minibuffer' or `y-or-n-p') after it switched to a
944 locked frame. For example, this is likely to happen
945 when server.el connects to a new terminal while Emacs is in
946 single_kboard mode. It is best to throw an error instead
947 of presenting the user with a frozen screen. */
948 error ("Terminal %d is locked, cannot read from it",
949 FRAME_TERMINAL (f
)->id
);
951 /* This call is unnecessary, but helps
952 `restore_kboard_configuration' discover if somebody changed
953 `current_kboard' behind our back. */
954 push_kboard (current_kboard
);
957 current_kboard
= FRAME_KBOARD (f
);
959 record_unwind_protect (restore_kboard_configuration
,
960 (was_locked
? Qt
: Qnil
));
963 #if 0 /* This function is not needed anymore. */
965 record_single_kboard_state ()
968 push_kboard (current_kboard
);
969 record_unwind_protect (restore_kboard_configuration
,
970 (single_kboard
? Qt
: Qnil
));
975 restore_kboard_configuration (Lisp_Object was_locked
)
977 if (NILP (was_locked
))
981 struct kboard
*prev
= current_kboard
;
984 /* The pop should not change the kboard. */
985 if (single_kboard
&& current_kboard
!= prev
)
992 /* Handle errors that are not handled at inner levels
993 by printing an error message and returning to the editor command loop. */
996 cmd_error (Lisp_Object data
)
998 Lisp_Object old_level
, old_length
;
999 char macroerror
[sizeof "After..kbd macro iterations: "
1000 + INT_STRLEN_BOUND (EMACS_INT
)];
1002 #ifdef HAVE_WINDOW_SYSTEM
1003 if (display_hourglass_p
)
1004 cancel_hourglass ();
1007 if (!NILP (executing_kbd_macro
))
1009 if (executing_kbd_macro_iterations
== 1)
1010 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1012 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1013 executing_kbd_macro_iterations
);
1018 Vstandard_output
= Qt
;
1019 Vstandard_input
= Qt
;
1020 Vexecuting_kbd_macro
= Qnil
;
1021 executing_kbd_macro
= Qnil
;
1022 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1023 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1026 /* Avoid unquittable loop if data contains a circular list. */
1027 old_level
= Vprint_level
;
1028 old_length
= Vprint_length
;
1029 XSETFASTINT (Vprint_level
, 10);
1030 XSETFASTINT (Vprint_length
, 10);
1031 cmd_error_internal (data
, macroerror
);
1032 Vprint_level
= old_level
;
1033 Vprint_length
= old_length
;
1037 Vinhibit_quit
= Qnil
;
1038 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1039 if (command_loop_level
== 0 && minibuf_level
== 0)
1040 any_kboard_state ();
1043 return make_number (0);
1046 /* Take actions on handling an error. DATA is the data that describes
1049 CONTEXT is a C-string containing ASCII characters only which
1050 describes the context in which the error happened. If we need to
1051 generalize CONTEXT to allow multibyte characters, make it a Lisp
1055 cmd_error_internal (Lisp_Object data
, const char *context
)
1057 struct frame
*sf
= SELECTED_FRAME ();
1059 /* The immediate context is not interesting for Quits,
1060 since they are asynchronous. */
1061 if (EQ (XCAR (data
), Qquit
))
1062 Vsignaling_function
= Qnil
;
1067 /* Use user's specified output function if any. */
1068 if (!NILP (Vcommand_error_function
))
1069 call3 (Vcommand_error_function
, data
,
1070 context
? build_string (context
) : empty_unibyte_string
,
1071 Vsignaling_function
);
1072 /* If the window system or terminal frame hasn't been initialized
1073 yet, or we're not interactive, write the message to stderr and exit. */
1074 else if (!sf
->glyphs_initialized_p
1075 /* The initial frame is a special non-displaying frame. It
1076 will be current in daemon mode when there are no frames
1077 to display, and in non-daemon mode before the real frame
1078 has finished initializing. If an error is thrown in the
1079 latter case while creating the frame, then the frame
1080 will never be displayed, so the safest thing to do is
1081 write to stderr and quit. In daemon mode, there are
1082 many other potential errors that do not prevent frames
1083 from being created, so continuing as normal is better in
1085 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1088 print_error_message (data
, Qexternal_debugging_output
,
1089 context
, Vsignaling_function
);
1090 Fterpri (Qexternal_debugging_output
);
1091 Fkill_emacs (make_number (-1));
1095 clear_message (1, 0);
1097 message_log_maybe_newline ();
1100 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1103 Vsignaling_function
= Qnil
;
1106 Lisp_Object
command_loop_1 (void);
1107 static Lisp_Object
command_loop_2 (Lisp_Object
);
1108 static Lisp_Object
top_level_1 (Lisp_Object
);
1110 /* Entry to editor-command-loop.
1111 This level has the catches for exiting/returning to editor command loop.
1112 It returns nil to exit recursive edit, t to abort it. */
1117 if (command_loop_level
> 0 || minibuf_level
> 0)
1120 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1121 executing_kbd_macro
= Qnil
;
1127 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1128 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1129 /* Reset single_kboard in case top-level set it while
1130 evaluating an -f option, or we are stuck there for some
1132 any_kboard_state ();
1134 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1135 executing_kbd_macro
= Qnil
;
1137 /* End of file in -batch run causes exit here. */
1143 /* Here we catch errors in execution of commands within the
1144 editing loop, and reenter the editing loop.
1145 When there is an error, cmd_error runs and returns a non-nil
1146 value to us. A value of nil means that command_loop_1 itself
1147 returned due to end of file (or end of kbd macro). */
1150 command_loop_2 (Lisp_Object ignore
)
1152 register Lisp_Object val
;
1155 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1156 while (!NILP (val
));
1164 return Feval (Vtop_level
, Qnil
);
1168 top_level_1 (Lisp_Object ignore
)
1170 /* On entry to the outer level, run the startup file */
1171 if (!NILP (Vtop_level
))
1172 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1173 else if (!NILP (Vpurify_flag
))
1174 message ("Bare impure Emacs (standard Lisp code not loaded)");
1176 message ("Bare Emacs (standard Lisp code not loaded)");
1180 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1181 doc
: /* Exit all recursive editing levels.
1182 This also exits all active minibuffers. */)
1185 #ifdef HAVE_WINDOW_SYSTEM
1186 if (display_hourglass_p
)
1187 cancel_hourglass ();
1190 /* Unblock input if we enter with input blocked. This may happen if
1191 redisplay traps e.g. during tool-bar update with input blocked. */
1192 while (INPUT_BLOCKED_P
)
1195 Fthrow (Qtop_level
, Qnil
);
1198 static _Noreturn
void
1199 user_error (const char *msg
)
1201 xsignal1 (Quser_error
, build_string (msg
));
1205 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1206 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1209 if (command_loop_level
> 0 || minibuf_level
> 0)
1210 Fthrow (Qexit
, Qnil
);
1212 user_error ("No recursive edit is in progress");
1216 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1217 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1220 if (command_loop_level
> 0 || minibuf_level
> 0)
1223 user_error ("No recursive edit is in progress");
1226 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1228 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1229 of this function. */
1232 tracking_off (Lisp_Object old_value
)
1234 do_mouse_tracking
= old_value
;
1235 if (NILP (old_value
))
1237 /* Redisplay may have been preempted because there was input
1238 available, and it assumes it will be called again after the
1239 input has been processed. If the only input available was
1240 the sort that we have just disabled, then we need to call
1242 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1244 redisplay_preserve_echo_area (6);
1245 get_input_pending (&input_pending
,
1246 READABLE_EVENTS_DO_TIMERS_NOW
);
1252 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1253 doc
: /* Evaluate BODY with mouse movement events enabled.
1254 Within a `track-mouse' form, mouse motion generates input events that
1255 you can read with `read-event'.
1256 Normally, mouse motion is ignored.
1257 usage: (track-mouse BODY...) */)
1260 ptrdiff_t count
= SPECPDL_INDEX ();
1263 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1265 do_mouse_tracking
= Qt
;
1267 val
= Fprogn (args
);
1268 return unbind_to (count
, val
);
1271 /* If mouse has moved on some frame, return one of those frames.
1275 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1276 after resizing the tool-bar window. */
1278 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1281 int ignore_mouse_drag_p
;
1284 some_mouse_moved (void)
1286 Lisp_Object tail
, frame
;
1288 if (ignore_mouse_drag_p
)
1290 /* ignore_mouse_drag_p = 0; */
1294 FOR_EACH_FRAME (tail
, frame
)
1296 if (XFRAME (frame
)->mouse_moved
)
1297 return XFRAME (frame
);
1303 #endif /* HAVE_MOUSE || HAVE_GPM */
1305 /* This is the actual command reading loop,
1306 sans error-handling encapsulation. */
1308 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1310 void safe_run_hooks (Lisp_Object
);
1311 static void adjust_point_for_property (ptrdiff_t, int);
1313 /* Cancel hourglass from protect_unwind.
1315 #ifdef HAVE_WINDOW_SYSTEM
1317 cancel_hourglass_unwind (Lisp_Object arg
)
1319 cancel_hourglass ();
1324 /* FIXME: This is wrong rather than test window-system, we should call
1325 a new set-selection, which will then dispatch to x-set-selection, or
1326 tty-set-selection, or w32-set-selection, ... */
1327 EXFUN (Fwindow_system
, 1);
1330 command_loop_1 (void)
1333 Lisp_Object keybuf
[30];
1335 EMACS_INT prev_modiff
= 0;
1336 struct buffer
*prev_buffer
= NULL
;
1337 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1338 int was_locked
= single_kboard
;
1340 int already_adjusted
= 0;
1342 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1343 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1344 Vdeactivate_mark
= Qnil
;
1345 waiting_for_input
= 0;
1348 this_command_key_count
= 0;
1349 this_command_key_count_reset
= 0;
1350 this_single_command_key_start
= 0;
1352 if (NILP (Vmemory_full
))
1354 /* Make sure this hook runs after commands that get errors and
1355 throw to top level. */
1356 /* Note that the value cell will never directly contain nil
1357 if the symbol is a local variable. */
1358 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1359 safe_run_hooks (Qpost_command_hook
);
1361 /* If displaying a message, resize the echo area window to fit
1362 that message's size exactly. */
1363 if (!NILP (echo_area_buffer
[0]))
1364 resize_echo_area_exactly ();
1366 /* If there are warnings waiting, process them. */
1367 if (!NILP (Vdelayed_warnings_list
))
1368 safe_run_hooks (Qdelayed_warnings_hook
);
1370 if (!NILP (Vdeferred_action_list
))
1371 safe_run_hooks (Qdeferred_action_function
);
1374 /* Do this after running Vpost_command_hook, for consistency. */
1375 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1376 KVAR (current_kboard
, Vreal_last_command
) = Vreal_this_command
;
1377 if (!CONSP (last_command_event
))
1378 KVAR (current_kboard
, Vlast_repeatable_command
) = Vreal_this_command
;
1382 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1385 /* Make sure the current window's buffer is selected. */
1386 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1387 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1389 /* Display any malloc warning that just came out. Use while because
1390 displaying one warning can cause another. */
1392 while (pending_malloc_warning
)
1393 display_malloc_warning ();
1395 Vdeactivate_mark
= Qnil
;
1397 /* If minibuffer on and echo area in use,
1398 wait a short time and redraw minibuffer. */
1401 && !NILP (echo_area_buffer
[0])
1402 && EQ (minibuf_window
, echo_area_window
)
1403 && NUMBERP (Vminibuffer_message_timeout
))
1405 /* Bind inhibit-quit to t so that C-g gets read in
1406 rather than quitting back to the minibuffer. */
1407 ptrdiff_t count
= SPECPDL_INDEX ();
1408 specbind (Qinhibit_quit
, Qt
);
1410 sit_for (Vminibuffer_message_timeout
, 0, 2);
1412 /* Clear the echo area. */
1414 safe_run_hooks (Qecho_area_clear_hook
);
1416 unbind_to (count
, Qnil
);
1418 /* If a C-g came in before, treat it as input now. */
1419 if (!NILP (Vquit_flag
))
1422 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1427 /* Select the frame that the last event came from. Usually,
1428 switch-frame events will take care of this, but if some lisp
1429 code swallows a switch-frame event, we'll fix things up here.
1430 Is this a good idea? */
1431 if (FRAMEP (internal_last_event_frame
)
1432 && !EQ (internal_last_event_frame
, selected_frame
))
1433 Fselect_frame (internal_last_event_frame
, Qnil
);
1435 /* If it has changed current-menubar from previous value,
1436 really recompute the menubar from the value. */
1437 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1438 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1439 call0 (Qrecompute_lucid_menubar
);
1441 before_command_key_count
= this_command_key_count
;
1442 before_command_echo_length
= echo_length ();
1444 Vthis_command
= Qnil
;
1445 Vreal_this_command
= Qnil
;
1446 Vthis_original_command
= Qnil
;
1447 Vthis_command_keys_shift_translated
= Qnil
;
1449 /* Read next key sequence; i gets its length. */
1450 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1453 /* A filter may have run while we were reading the input. */
1454 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1456 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1457 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1461 /* Now we have read a key sequence of length I,
1462 or else I is 0 and we found end of file. */
1464 if (i
== 0) /* End of file -- happens only in */
1465 return Qnil
; /* a kbd macro, at the end. */
1466 /* -1 means read_key_sequence got a menu that was rejected.
1467 Just loop around and read another command. */
1471 this_command_key_count
= 0;
1472 this_command_key_count_reset
= 0;
1473 this_single_command_key_start
= 0;
1477 last_command_event
= keybuf
[i
- 1];
1479 /* If the previous command tried to force a specific window-start,
1480 forget about that, in case this command moves point far away
1481 from that position. But also throw away beg_unchanged and
1482 end_unchanged information in that case, so that redisplay will
1483 update the whole window properly. */
1484 if (XWINDOW (selected_window
)->force_start
)
1487 XWINDOW (selected_window
)->force_start
= 0;
1488 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1489 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1492 cmd
= read_key_sequence_cmd
;
1493 if (!NILP (Vexecuting_kbd_macro
))
1495 if (!NILP (Vquit_flag
))
1497 Vexecuting_kbd_macro
= Qt
;
1498 QUIT
; /* Make some noise. */
1499 /* Will return since macro now empty. */
1503 /* Do redisplay processing after this command except in special
1504 cases identified below. */
1505 prev_buffer
= current_buffer
;
1506 prev_modiff
= MODIFF
;
1507 last_point_position
= PT
;
1508 last_point_position_window
= selected_window
;
1509 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1511 /* By default, we adjust point to a boundary of a region that
1512 has such a property that should be treated intangible
1513 (e.g. composition, display). But, some commands will set
1514 this variable differently. */
1515 Vdisable_point_adjustment
= Qnil
;
1517 /* Process filters and timers may have messed with deactivate-mark.
1518 reset it before we execute the command. */
1519 Vdeactivate_mark
= Qnil
;
1521 /* Remap command through active keymaps. */
1522 Vthis_original_command
= cmd
;
1523 if (!NILP (read_key_sequence_remapped
))
1524 cmd
= read_key_sequence_remapped
;
1526 /* Execute the command. */
1528 Vthis_command
= cmd
;
1529 Vreal_this_command
= cmd
;
1530 safe_run_hooks (Qpre_command_hook
);
1532 already_adjusted
= 0;
1534 if (NILP (Vthis_command
))
1536 /* nil means key is undefined. */
1537 Lisp_Object keys
= Fvector (i
, keybuf
);
1538 keys
= Fkey_description (keys
, Qnil
);
1540 message_with_string ("%s is undefined", keys
, 0);
1541 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1542 update_mode_lines
= 1;
1543 /* If this is a down-mouse event, don't reset prefix-arg;
1544 pass it to the command run by the up event. */
1545 if (EVENT_HAS_PARAMETERS (last_command_event
))
1547 Lisp_Object breakdown
1548 = parse_modifiers (EVENT_HEAD (last_command_event
));
1549 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1550 if (!(modifiers
& down_modifier
))
1551 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1554 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1558 /* Here for a command that isn't executed directly. */
1560 #ifdef HAVE_WINDOW_SYSTEM
1561 ptrdiff_t scount
= SPECPDL_INDEX ();
1563 if (display_hourglass_p
1564 && NILP (Vexecuting_kbd_macro
))
1566 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1571 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1573 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1575 #ifdef HAVE_WINDOW_SYSTEM
1576 /* Do not check display_hourglass_p here, because
1577 Fcommand_execute could change it, but we should cancel
1578 hourglass cursor anyway.
1579 But don't cancel the hourglass within a macro
1580 just because a command in the macro finishes. */
1581 if (NILP (Vexecuting_kbd_macro
))
1582 unbind_to (scount
, Qnil
);
1585 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1587 safe_run_hooks (Qpost_command_hook
);
1589 /* If displaying a message, resize the echo area window to fit
1590 that message's size exactly. */
1591 if (!NILP (echo_area_buffer
[0]))
1592 resize_echo_area_exactly ();
1594 /* If there are warnings waiting, process them. */
1595 if (!NILP (Vdelayed_warnings_list
))
1596 safe_run_hooks (Qdelayed_warnings_hook
);
1598 safe_run_hooks (Qdeferred_action_function
);
1600 /* If there is a prefix argument,
1601 1) We don't want Vlast_command to be ``universal-argument''
1602 (that would be dumb), so don't set Vlast_command,
1603 2) we want to leave echoing on so that the prefix will be
1604 echoed as part of this key sequence, so don't call
1606 3) we want to leave this_command_key_count non-zero, so that
1607 read_char will realize that it is re-reading a character, and
1608 not echo it a second time.
1610 If the command didn't actually create a prefix arg,
1611 but is merely a frame event that is transparent to prefix args,
1612 then the above doesn't apply. */
1613 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1614 || CONSP (last_command_event
))
1616 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1617 KVAR (current_kboard
, Vreal_last_command
) = Vreal_this_command
;
1618 if (!CONSP (last_command_event
))
1619 KVAR (current_kboard
, Vlast_repeatable_command
)
1620 = Vreal_this_command
;
1622 this_command_key_count
= 0;
1623 this_command_key_count_reset
= 0;
1624 this_single_command_key_start
= 0;
1627 if (!NILP (BVAR (current_buffer
, mark_active
))
1628 && !NILP (Vrun_hooks
))
1630 /* In Emacs 22, setting transient-mark-mode to `only' was a
1631 way of turning it on for just one command. This usage is
1632 obsolete, but support it anyway. */
1633 if (EQ (Vtransient_mark_mode
, Qidentity
))
1634 Vtransient_mark_mode
= Qnil
;
1635 else if (EQ (Vtransient_mark_mode
, Qonly
))
1636 Vtransient_mark_mode
= Qidentity
;
1638 if (!NILP (Vdeactivate_mark
))
1639 /* If `select-active-regions' is non-nil, this call to
1640 `deactivate-mark' also sets the PRIMARY selection. */
1641 call0 (Qdeactivate_mark
);
1644 /* Even if not deactivating the mark, set PRIMARY if
1645 `select-active-regions' is non-nil. */
1646 if (!NILP (Fwindow_system (Qnil
))
1647 /* Even if mark_active is non-nil, the actual buffer
1648 marker may not have been set yet (Bug#7044). */
1649 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1650 && (EQ (Vselect_active_regions
, Qonly
)
1651 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1652 : (!NILP (Vselect_active_regions
)
1653 && !NILP (Vtransient_mark_mode
)))
1654 && NILP (Fmemq (Vthis_command
,
1655 Vselection_inhibit_update_commands
)))
1658 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1661 call2 (Qx_set_selection
, QPRIMARY
,
1662 make_buffer_string (beg
, end
, 0));
1664 call2 (Qx_set_selection
, QPRIMARY
,
1665 make_buffer_string (end
, beg
, 0));
1666 /* Don't set empty selections. */
1669 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1671 Lisp_Object hook
= intern ("activate-mark-hook");
1672 Frun_hooks (1, &hook
);
1676 Vsaved_region_selection
= Qnil
;
1681 if (current_buffer
== prev_buffer
1682 && last_point_position
!= PT
1683 && NILP (Vdisable_point_adjustment
)
1684 && NILP (Vglobal_disable_point_adjustment
))
1686 if (last_point_position
> BEGV
1687 && last_point_position
< ZV
1688 && (composition_adjust_point (last_point_position
,
1689 last_point_position
)
1690 != last_point_position
))
1691 /* The last point was temporarily set within a grapheme
1692 cluster to prevent automatic composition. To recover
1693 the automatic composition, we must update the
1695 windows_or_buffers_changed
++;
1696 if (!already_adjusted
)
1697 adjust_point_for_property (last_point_position
,
1698 MODIFF
!= prev_modiff
);
1701 /* Install chars successfully executed in kbd macro. */
1703 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1704 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1705 finalize_kbd_macro_chars ();
1706 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1708 any_kboard_state ();
1713 /* Adjust point to a boundary of a region that has such a property
1714 that should be treated intangible. For the moment, we check
1715 `composition', `display' and `invisible' properties.
1716 LAST_PT is the last position of point. */
1719 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1722 Lisp_Object val
, overlay
, tmp
;
1723 /* When called after buffer modification, we should temporarily
1724 suppress the point adjustment for automatic composition so that a
1725 user can keep inserting another character at point or keep
1726 deleting characters around point. */
1727 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1728 ptrdiff_t orig_pt
= PT
;
1730 /* FIXME: cycling is probably not necessary because these properties
1731 can't be usefully combined anyway. */
1732 while (check_composition
|| check_display
|| check_invisible
)
1734 /* FIXME: check `intangible'. */
1735 if (check_composition
1736 && PT
> BEGV
&& PT
< ZV
1737 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1740 check_display
= check_invisible
= 1;
1742 check_composition
= 0;
1744 && PT
> BEGV
&& PT
< ZV
1745 && !NILP (val
= get_char_property_and_overlay
1746 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1747 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1748 && (!OVERLAYP (overlay
)
1749 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1750 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1751 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1752 && (beg
< PT
/* && end > PT <- It's always the case. */
1753 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1756 SET_PT (PT
< last_pt
1757 ? (STRINGP (val
) && SCHARS (val
) == 0
1758 ? max (beg
- 1, BEGV
)
1761 check_composition
= check_invisible
= 1;
1764 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1766 int inv
, ellipsis
= 0;
1769 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1772 /* FIXME: We should stop if we find a spot between
1773 two runs of `invisible' where inserted text would
1774 be visible. This is important when we have two
1775 invisible boundaries that enclose an area: if the
1776 area is empty, we need this test in order to make
1777 it possible to place point in the middle rather
1778 than skip both boundaries. However, this code
1779 also stops anywhere in a non-sticky text-property,
1780 which breaks (e.g.) Org mode. */
1781 && (val
= get_pos_property (make_number (end
),
1783 TEXT_PROP_MEANS_INVISIBLE (val
))
1785 && !NILP (val
= get_char_property_and_overlay
1786 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1787 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1789 ellipsis
= ellipsis
|| inv
> 1
1790 || (OVERLAYP (overlay
)
1791 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1792 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1793 tmp
= Fnext_single_char_property_change
1794 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1795 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1799 && (val
= get_pos_property (make_number (beg
),
1801 TEXT_PROP_MEANS_INVISIBLE (val
))
1803 && !NILP (val
= get_char_property_and_overlay
1804 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1805 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1807 ellipsis
= ellipsis
|| inv
> 1
1808 || (OVERLAYP (overlay
)
1809 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1810 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1811 tmp
= Fprevious_single_char_property_change
1812 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1813 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1816 /* Move away from the inside area. */
1817 if (beg
< PT
&& end
> PT
)
1819 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1820 /* We haven't moved yet (so we don't need to fear
1821 infinite-looping) and we were outside the range
1822 before (so either end of the range still corresponds
1823 to a move in the right direction): pretend we moved
1824 less than we actually did, so that we still have
1825 more freedom below in choosing which end of the range
1827 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1828 /* We either have moved already or the last point
1829 was already in the range: we don't get to choose
1830 which end of the range we have to go to. */
1831 : (PT
< last_pt
? beg
: end
));
1832 check_composition
= check_display
= 1;
1834 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1835 the point to something other than its argument, due to
1836 point-motion hooks, intangibility, etc. */
1837 xassert (PT
== beg
|| PT
== end
);
1840 /* Pretend the area doesn't exist if the buffer is not
1842 if (!modified
&& !ellipsis
&& beg
< end
)
1844 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1845 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1846 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1847 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1848 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1849 /* We've already moved as far as we can. Trying to go
1850 to the other end would mean moving backwards and thus
1851 could lead to an infinite loop. */
1853 else if (val
= get_pos_property (make_number (PT
),
1855 TEXT_PROP_MEANS_INVISIBLE (val
)
1856 && (val
= get_pos_property
1857 (make_number (PT
== beg
? end
: beg
),
1859 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1860 (check_composition
= check_display
= 1,
1861 SET_PT (PT
== beg
? end
: beg
));
1864 check_invisible
= 0;
1868 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1871 safe_run_hooks_1 (void)
1873 eassert (CONSP (Vinhibit_quit
));
1874 return call0 (XCDR (Vinhibit_quit
));
1877 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1881 safe_run_hooks_error (Lisp_Object error_data
)
1884 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1885 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1886 Lisp_Object args
[4];
1887 args
[0] = build_string ("Error in %s (%s): %S");
1890 args
[3] = error_data
;
1896 Lisp_Object newval
= Qnil
;
1897 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1898 if (EQ (fun
, XCAR (val
)))
1901 newval
= Fcons (XCAR (val
), newval
);
1903 return Fset (hook
, Fnreverse (newval
));
1904 /* Not found in the local part of the hook. Let's look at the global
1907 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1908 : Fdefault_value (hook
));
1909 CONSP (val
); val
= XCDR (val
))
1910 if (EQ (fun
, XCAR (val
)))
1913 newval
= Fcons (XCAR (val
), newval
);
1915 return Fset_default (hook
, Fnreverse (newval
));
1921 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1923 eassert (nargs
== 1);
1924 if (CONSP (Vinhibit_quit
))
1925 XSETCDR (Vinhibit_quit
, args
[0]);
1927 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1929 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1933 /* If we get an error while running the hook, cause the hook variable
1934 to be nil. Also inhibit quits, so that C-g won't cause the hook
1935 to mysteriously evaporate. */
1938 safe_run_hooks (Lisp_Object hook
)
1940 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1941 to its body or to its handlers other than via globals such as
1942 dynamically-bound variables ;-) */
1943 ptrdiff_t count
= SPECPDL_INDEX ();
1944 specbind (Qinhibit_quit
, hook
);
1946 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1948 unbind_to (count
, Qnil
);
1952 /* Nonzero means polling for input is temporarily suppressed. */
1954 int poll_suppress_count
;
1956 /* Asynchronous timer for polling. */
1958 static struct atimer
*poll_timer
;
1961 #ifdef POLL_FOR_INPUT
1963 /* Poll for input, so that we catch a C-g if it comes in. This
1964 function is called from x_make_frame_visible, see comment
1968 poll_for_input_1 (void)
1970 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1971 doing anything dangerous. */
1975 if (interrupt_input_blocked
== 0
1976 && !waiting_for_input
)
1977 read_avail_input (0);
1983 /* Timer callback function for poll_timer. TIMER is equal to
1987 poll_for_input (struct atimer
*timer
)
1989 if (poll_suppress_count
== 0)
1992 interrupt_input_pending
= 1;
1993 pending_signals
= 1;
1995 poll_for_input_1 ();
2000 #endif /* POLL_FOR_INPUT */
2002 /* Begin signals to poll for input, if they are appropriate.
2003 This function is called unconditionally from various places. */
2006 start_polling (void)
2008 #ifdef POLL_FOR_INPUT
2009 /* XXX This condition was (read_socket_hook && !interrupt_input),
2010 but read_socket_hook is not global anymore. Let's pretend that
2012 if (!interrupt_input
)
2014 /* Turn alarm handling on unconditionally. It might have
2015 been turned off in process.c. */
2016 turn_on_atimers (1);
2018 /* If poll timer doesn't exist, are we need one with
2019 a different interval, start a new one. */
2020 if (poll_timer
== NULL
2021 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2023 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2024 EMACS_TIME interval
;
2027 cancel_atimer (poll_timer
);
2029 EMACS_SET_SECS_USECS (interval
, period
, 0);
2030 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2031 poll_for_input
, NULL
);
2034 /* Let the timer's callback function poll for input
2035 if this becomes zero. */
2036 --poll_suppress_count
;
2041 /* Nonzero if we are using polling to handle input asynchronously. */
2044 input_polling_used (void)
2046 #ifdef POLL_FOR_INPUT
2047 /* XXX This condition was (read_socket_hook && !interrupt_input),
2048 but read_socket_hook is not global anymore. Let's pretend that
2050 return !interrupt_input
;
2056 /* Turn off polling. */
2061 #ifdef POLL_FOR_INPUT
2062 /* XXX This condition was (read_socket_hook && !interrupt_input),
2063 but read_socket_hook is not global anymore. Let's pretend that
2065 if (!interrupt_input
)
2066 ++poll_suppress_count
;
2070 /* Set the value of poll_suppress_count to COUNT
2071 and start or stop polling accordingly. */
2074 set_poll_suppress_count (int count
)
2076 #ifdef POLL_FOR_INPUT
2077 if (count
== 0 && poll_suppress_count
!= 0)
2079 poll_suppress_count
= 1;
2082 else if (count
!= 0 && poll_suppress_count
== 0)
2086 poll_suppress_count
= count
;
2090 /* Bind polling_period to a value at least N.
2091 But don't decrease it. */
2094 bind_polling_period (int n
)
2096 #ifdef POLL_FOR_INPUT
2097 EMACS_INT
new = polling_period
;
2102 stop_other_atimers (poll_timer
);
2104 specbind (Qpolling_period
, make_number (new));
2105 /* Start a new alarm with the new period. */
2110 /* Apply the control modifier to CHARACTER. */
2113 make_ctrl_char (int c
)
2115 /* Save the upper bits here. */
2116 int upper
= c
& ~0177;
2118 if (! ASCII_BYTE_P (c
))
2119 return c
|= ctrl_modifier
;
2123 /* Everything in the columns containing the upper-case letters
2124 denotes a control character. */
2125 if (c
>= 0100 && c
< 0140)
2129 /* Set the shift modifier for a control char
2130 made from a shifted letter. But only for letters! */
2131 if (oc
>= 'A' && oc
<= 'Z')
2132 c
|= shift_modifier
;
2135 /* The lower-case letters denote control characters too. */
2136 else if (c
>= 'a' && c
<= 'z')
2139 /* Include the bits for control and shift
2140 only if the basic ASCII code can't indicate them. */
2144 /* Replace the high bits. */
2145 c
|= (upper
& ~ctrl_modifier
);
2150 /* Display the help-echo property of the character after the mouse pointer.
2151 Either show it in the echo area, or call show-help-function to display
2152 it by other means (maybe in a tooltip).
2154 If HELP is nil, that means clear the previous help echo.
2156 If HELP is a string, display that string. If HELP is a function,
2157 call it with OBJECT and POS as arguments; the function should
2158 return a help string or nil for none. For all other types of HELP,
2159 evaluate it to obtain a string.
2161 WINDOW is the window in which the help was generated, if any.
2162 It is nil if not in a window.
2164 If OBJECT is a buffer, POS is the position in the buffer where the
2165 `help-echo' text property was found.
2167 If OBJECT is an overlay, that overlay has a `help-echo' property,
2168 and POS is the position in the overlay's buffer under the mouse.
2170 If OBJECT is a string (an overlay string or a string displayed with
2171 the `display' property). POS is the position in that string under
2174 Note: this function may only be called with HELP nil or a string
2175 from X code running asynchronously. */
2178 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2181 if (!NILP (help
) && !STRINGP (help
))
2183 if (FUNCTIONP (help
))
2185 Lisp_Object args
[4];
2190 help
= safe_call (4, args
);
2193 help
= safe_eval (help
);
2195 if (!STRINGP (help
))
2199 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2200 if (!noninteractive
&& STRINGP (help
))
2202 /* The mouse-fixup-help-message Lisp function can call
2203 mouse_position_hook, which resets the mouse_moved flags.
2204 This causes trouble if we are trying to read a mouse motion
2205 event (i.e., if we are inside a `track-mouse' form), so we
2206 restore the mouse_moved flag. */
2207 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2208 help
= call1 (Qmouse_fixup_help_message
, help
);
2214 if (STRINGP (help
) || NILP (help
))
2216 if (!NILP (Vshow_help_function
))
2217 call1 (Vshow_help_function
, help
);
2218 help_echo_showing_p
= STRINGP (help
);
2224 /* Input of single characters from keyboard */
2226 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2227 EMACS_TIME
*end_time
);
2228 static void record_char (Lisp_Object c
);
2230 static Lisp_Object help_form_saved_window_configs
;
2232 read_char_help_form_unwind (Lisp_Object arg
)
2234 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2235 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2236 if (!NILP (window_config
))
2237 Fset_window_configuration (window_config
);
2241 #define STOP_POLLING \
2242 do { if (! polling_stopped_here) stop_polling (); \
2243 polling_stopped_here = 1; } while (0)
2245 #define RESUME_POLLING \
2246 do { if (polling_stopped_here) start_polling (); \
2247 polling_stopped_here = 0; } while (0)
2249 /* read a character from the keyboard; call the redisplay if needed */
2250 /* commandflag 0 means do not autosave, but do redisplay.
2251 -1 means do not redisplay, but do autosave.
2254 /* The arguments MAPS and NMAPS are for menu prompting.
2255 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2257 PREV_EVENT is the previous input event, or nil if we are reading
2258 the first event of a key sequence (or not reading a key sequence).
2259 If PREV_EVENT is t, that is a "magic" value that says
2260 not to run input methods, but in other respects to act as if
2261 not reading a key sequence.
2263 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2264 if we used a mouse menu to read the input, or zero otherwise. If
2265 USED_MOUSE_MENU is null, we don't dereference it.
2267 Value is -2 when we find input on another keyboard. A second call
2268 to read_char will read it.
2270 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2271 specifying the maximum time to wait until. If no input arrives by
2272 that time, stop waiting and return nil.
2274 Value is t if we showed a menu and the user rejected it. */
2277 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2278 Lisp_Object prev_event
,
2279 int *used_mouse_menu
, EMACS_TIME
*end_time
)
2281 volatile Lisp_Object c
;
2283 jmp_buf local_getcjmp
;
2285 volatile int key_already_recorded
= 0;
2286 Lisp_Object tem
, save
;
2287 volatile Lisp_Object previous_echo_area_message
;
2288 volatile Lisp_Object also_record
;
2289 volatile int reread
;
2290 struct gcpro gcpro1
, gcpro2
;
2291 int volatile polling_stopped_here
= 0;
2292 struct kboard
*orig_kboard
= current_kboard
;
2296 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2297 before_command_key_count
= this_command_key_count
;
2298 before_command_echo_length
= echo_length ();
2301 previous_echo_area_message
= Qnil
;
2303 GCPRO2 (c
, previous_echo_area_message
);
2308 if (CONSP (Vunread_post_input_method_events
))
2310 c
= XCAR (Vunread_post_input_method_events
);
2311 Vunread_post_input_method_events
2312 = XCDR (Vunread_post_input_method_events
);
2314 /* Undo what read_char_x_menu_prompt did when it unread
2315 additional keys returned by Fx_popup_menu. */
2317 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2325 if (unread_command_char
!= -1)
2327 XSETINT (c
, unread_command_char
);
2328 unread_command_char
= -1;
2334 if (CONSP (Vunread_command_events
))
2336 int was_disabled
= 0;
2338 c
= XCAR (Vunread_command_events
);
2339 Vunread_command_events
= XCDR (Vunread_command_events
);
2343 /* Undo what sit-for did when it unread additional keys
2344 inside universal-argument. */
2347 && EQ (XCAR (c
), Qt
))
2353 /* Undo what read_char_x_menu_prompt did when it unread
2354 additional keys returned by Fx_popup_menu. */
2356 && EQ (XCDR (c
), Qdisabled
)
2357 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2363 /* If the queued event is something that used the mouse,
2364 set used_mouse_menu accordingly. */
2366 /* Also check was_disabled so last-nonmenu-event won't return
2367 a bad value when submenus are involved. (Bug#447) */
2368 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2369 *used_mouse_menu
= 1;
2371 goto reread_for_input_method
;
2374 if (CONSP (Vunread_input_method_events
))
2376 c
= XCAR (Vunread_input_method_events
);
2377 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2379 /* Undo what read_char_x_menu_prompt did when it unread
2380 additional keys returned by Fx_popup_menu. */
2382 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2386 goto reread_for_input_method
;
2389 this_command_key_count_reset
= 0;
2391 if (!NILP (Vexecuting_kbd_macro
))
2393 /* We set this to Qmacro; since that's not a frame, nobody will
2394 try to switch frames on us, and the selected window will
2397 Since this event came from a macro, it would be misleading to
2398 leave internal_last_event_frame set to wherever the last
2399 real event came from. Normally, a switch-frame event selects
2400 internal_last_event_frame after each command is read, but
2401 events read from a macro should never cause a new frame to be
2403 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2405 /* Exit the macro if we are at the end.
2406 Also, some things replace the macro with t
2407 to force an early exit. */
2408 if (EQ (Vexecuting_kbd_macro
, Qt
)
2409 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2415 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2416 if (STRINGP (Vexecuting_kbd_macro
)
2417 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2418 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2420 executing_kbd_macro_index
++;
2425 if (!NILP (unread_switch_frame
))
2427 c
= unread_switch_frame
;
2428 unread_switch_frame
= Qnil
;
2430 /* This event should make it into this_command_keys, and get echoed
2431 again, so we do not set `reread'. */
2435 /* if redisplay was requested */
2436 if (commandflag
>= 0)
2438 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2440 /* If there is pending input, process any events which are not
2441 user-visible, such as X selection_request events. */
2443 || detect_input_pending_run_timers (0))
2444 swallow_events (0); /* may clear input_pending */
2446 /* Redisplay if no pending input. */
2447 while (!input_pending
)
2449 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2450 redisplay_preserve_echo_area (5);
2455 /* Normal case: no input arrived during redisplay. */
2458 /* Input arrived and pre-empted redisplay.
2459 Process any events which are not user-visible. */
2461 /* If that cleared input_pending, try again to redisplay. */
2464 /* Prevent the redisplay we just did
2465 from messing up echoing of the input after the prompt. */
2466 if (commandflag
== 0 && echo_current
)
2467 echo_message_buffer
= echo_area_buffer
[0];
2471 /* Message turns off echoing unless more keystrokes turn it on again.
2473 The code in 20.x for the condition was
2475 1. echo_area_glyphs && *echo_area_glyphs
2476 2. && echo_area_glyphs != current_kboard->echobuf
2477 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2479 (1) means there's a current message displayed
2481 (2) means it's not the message from echoing from the current
2484 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2485 is set to a non-null value. This is done in read_char and it is
2486 set to echo_area_glyphs after a call to echo_char. That means
2487 ok_to_echo_at_next_pause is either null or
2488 current_kboard->echobuf with the appropriate current_kboard at
2491 So, condition (3) means in clear text ok_to_echo_at_next_pause
2492 must be either null, or the current message isn't from echoing at
2493 all, or it's from echoing from a different kboard than the
2496 if (/* There currently is something in the echo area. */
2497 !NILP (echo_area_buffer
[0])
2498 && (/* And it's either not from echoing. */
2499 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2500 /* Or it's an echo from a different kboard. */
2501 || echo_kboard
!= current_kboard
2502 /* Or we explicitly allow overwriting whatever there is. */
2503 || ok_to_echo_at_next_pause
== NULL
))
2508 /* Try reading a character via menu prompting in the minibuf.
2509 Try this before the sit-for, because the sit-for
2510 would do the wrong thing if we are supposed to do
2511 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2512 after a mouse event so don't try a minibuf menu. */
2514 if (nmaps
> 0 && INTERACTIVE
2515 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2516 /* Don't bring up a menu if we already have another event. */
2517 && NILP (Vunread_command_events
)
2518 && unread_command_char
< 0
2519 && !detect_input_pending_run_timers (0))
2521 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2523 if (INTEGERP (c
) && XINT (c
) == -2)
2524 return c
; /* wrong_kboard_jmpbuf */
2528 key_already_recorded
= 1;
2533 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2534 We will do that below, temporarily for short sections of code,
2535 when appropriate. local_getcjmp must be in effect
2536 around any call to sit_for or kbd_buffer_get_event;
2537 it *must not* be in effect when we call redisplay. */
2539 jmpcount
= SPECPDL_INDEX ();
2540 if (_setjmp (local_getcjmp
))
2542 /* Handle quits while reading the keyboard. */
2543 /* We must have saved the outer value of getcjmp here,
2544 so restore it now. */
2545 restore_getcjmp (save_jump
);
2546 unbind_to (jmpcount
, Qnil
);
2547 XSETINT (c
, quit_char
);
2548 internal_last_event_frame
= selected_frame
;
2549 Vlast_event_frame
= internal_last_event_frame
;
2550 /* If we report the quit char as an event,
2551 don't do so more than once. */
2552 if (!NILP (Vinhibit_quit
))
2556 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2557 if (kb
!= current_kboard
)
2559 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2560 /* We shouldn't get here if we were in single-kboard mode! */
2565 while (CONSP (XCDR (last
)))
2567 if (!NILP (XCDR (last
)))
2571 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2573 XSETCDR (last
, Fcons (c
, Qnil
));
2574 kb
->kbd_queue_has_data
= 1;
2575 current_kboard
= kb
;
2576 /* This is going to exit from read_char
2577 so we had better get rid of this frame's stuff. */
2579 return make_number (-2); /* wrong_kboard_jmpbuf */
2585 /* Start idle timers if no time limit is supplied. We don't do it
2586 if a time limit is supplied to avoid an infinite recursion in the
2587 situation where an idle timer calls `sit-for'. */
2590 timer_start_idle ();
2592 /* If in middle of key sequence and minibuffer not active,
2593 start echoing if enough time elapses. */
2595 if (minibuf_level
== 0
2597 && !current_kboard
->immediate_echo
2598 && this_command_key_count
> 0
2600 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2601 && NILP (Fzerop (Vecho_keystrokes
))
2602 && (/* No message. */
2603 NILP (echo_area_buffer
[0])
2604 /* Or empty message. */
2605 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2606 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2607 /* Or already echoing from same kboard. */
2608 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2609 /* Or not echoing before and echoing allowed. */
2610 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2612 /* After a mouse event, start echoing right away.
2613 This is because we are probably about to display a menu,
2614 and we don't want to delay before doing so. */
2615 if (EVENT_HAS_PARAMETERS (prev_event
))
2621 save_getcjmp (save_jump
);
2622 restore_getcjmp (local_getcjmp
);
2623 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2624 restore_getcjmp (save_jump
);
2626 && ! CONSP (Vunread_command_events
))
2631 /* Maybe auto save due to number of keystrokes. */
2633 if (commandflag
!= 0
2634 && auto_save_interval
> 0
2635 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2636 && !detect_input_pending_run_timers (0))
2638 Fdo_auto_save (Qnil
, Qnil
);
2639 /* Hooks can actually change some buffers in auto save. */
2643 /* Try reading using an X menu.
2644 This is never confused with reading using the minibuf
2645 because the recursive call of read_char in read_char_minibuf_menu_prompt
2646 does not pass on any keymaps. */
2648 if (nmaps
> 0 && INTERACTIVE
2649 && !NILP (prev_event
)
2650 && EVENT_HAS_PARAMETERS (prev_event
)
2651 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2652 && !EQ (XCAR (prev_event
), Qtool_bar
)
2653 /* Don't bring up a menu if we already have another event. */
2654 && NILP (Vunread_command_events
)
2655 && unread_command_char
< 0)
2657 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2659 /* Now that we have read an event, Emacs is not idle. */
2666 /* Maybe autosave and/or garbage collect due to idleness. */
2668 if (INTERACTIVE
&& NILP (c
))
2671 ptrdiff_t buffer_size
;
2673 /* Slow down auto saves logarithmically in size of current buffer,
2674 and garbage collect while we're at it. */
2675 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2676 last_non_minibuf_size
= Z
- BEG
;
2677 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2679 while (buffer_size
> 64)
2680 delay_level
++, buffer_size
-= buffer_size
>> 2;
2681 if (delay_level
< 4) delay_level
= 4;
2682 /* delay_level is 4 for files under around 50k, 7 at 100k,
2683 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2685 /* Auto save if enough time goes by without input. */
2686 if (commandflag
!= 0
2687 && num_nonmacro_input_events
> last_auto_save
2688 && INTEGERP (Vauto_save_timeout
)
2689 && XINT (Vauto_save_timeout
) > 0)
2692 EMACS_INT timeout
= (delay_level
2693 * min (XFASTINT (Vauto_save_timeout
) / 4,
2694 MOST_POSITIVE_FIXNUM
/ delay_level
));
2695 save_getcjmp (save_jump
);
2696 restore_getcjmp (local_getcjmp
);
2697 tem0
= sit_for (make_number (timeout
), 1, 1);
2698 restore_getcjmp (save_jump
);
2701 && ! CONSP (Vunread_command_events
))
2703 Fdo_auto_save (Qnil
, Qnil
);
2705 /* If we have auto-saved and there is still no input
2706 available, garbage collect if there has been enough
2707 consing going on to make it worthwhile. */
2708 if (!detect_input_pending_run_timers (0)
2709 && consing_since_gc
> gc_cons_threshold
/ 2)
2710 Fgarbage_collect ();
2717 /* Notify the caller if an autosave hook, or a timer, sentinel or
2718 filter in the sit_for calls above have changed the current
2719 kboard. This could happen if they use the minibuffer or start a
2720 recursive edit, like the fancy splash screen in server.el's
2721 filter. If this longjmp wasn't here, read_key_sequence would
2722 interpret the next key sequence using the wrong translation
2723 tables and function keymaps. */
2724 if (NILP (c
) && current_kboard
!= orig_kboard
)
2727 return make_number (-2); /* wrong_kboard_jmpbuf */
2730 /* If this has become non-nil here, it has been set by a timer
2731 or sentinel or filter. */
2732 if (CONSP (Vunread_command_events
))
2734 c
= XCAR (Vunread_command_events
);
2735 Vunread_command_events
= XCDR (Vunread_command_events
);
2738 /* Read something from current KBOARD's side queue, if possible. */
2742 if (current_kboard
->kbd_queue_has_data
)
2744 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2746 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2747 KVAR (current_kboard
, kbd_queue
)
2748 = XCDR (KVAR (current_kboard
, kbd_queue
));
2749 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2750 current_kboard
->kbd_queue_has_data
= 0;
2751 input_pending
= readable_events (0);
2752 if (EVENT_HAS_PARAMETERS (c
)
2753 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2754 internal_last_event_frame
= XCAR (XCDR (c
));
2755 Vlast_event_frame
= internal_last_event_frame
;
2759 /* If current_kboard's side queue is empty check the other kboards.
2760 If one of them has data that we have not yet seen here,
2761 switch to it and process the data waiting for it.
2763 Note: if the events queued up for another kboard
2764 have already been seen here, and therefore are not a complete command,
2765 the kbd_queue_has_data field is 0, so we skip that kboard here.
2766 That's to avoid an infinite loop switching between kboards here. */
2767 if (NILP (c
) && !single_kboard
)
2770 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2771 if (kb
->kbd_queue_has_data
)
2773 current_kboard
= kb
;
2774 /* This is going to exit from read_char
2775 so we had better get rid of this frame's stuff. */
2777 return make_number (-2); /* wrong_kboard_jmpbuf */
2785 /* Finally, we read from the main queue,
2786 and if that gives us something we can't use yet, we put it on the
2787 appropriate side queue and try again. */
2791 KBOARD
*kb
IF_LINT (= NULL
);
2796 EMACS_GET_TIME (now
);
2797 if (EMACS_TIME_GE (now
, *end_time
))
2801 /* Actually read a character, waiting if necessary. */
2802 save_getcjmp (save_jump
);
2803 restore_getcjmp (local_getcjmp
);
2805 timer_start_idle ();
2806 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2807 restore_getcjmp (save_jump
);
2809 if (! NILP (c
) && (kb
!= current_kboard
))
2811 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2814 while (CONSP (XCDR (last
)))
2816 if (!NILP (XCDR (last
)))
2820 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2822 XSETCDR (last
, Fcons (c
, Qnil
));
2823 kb
->kbd_queue_has_data
= 1;
2827 current_kboard
= kb
;
2828 /* This is going to exit from read_char
2829 so we had better get rid of this frame's stuff. */
2831 return make_number (-2);
2835 /* Terminate Emacs in batch mode if at eof. */
2836 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2837 Fkill_emacs (make_number (1));
2841 /* Add in any extra modifiers, where appropriate. */
2842 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2843 || ((extra_keyboard_modifiers
& 0177) < ' '
2844 && (extra_keyboard_modifiers
& 0177) != 0))
2845 XSETINT (c
, make_ctrl_char (XINT (c
)));
2847 /* Transfer any other modifier bits directly from
2848 extra_keyboard_modifiers to c. Ignore the actual character code
2849 in the low 16 bits of extra_keyboard_modifiers. */
2850 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2861 if (commandflag
>= 0
2862 && !input_pending
&& !detect_input_pending_run_timers (0))
2870 /* Buffer switch events are only for internal wakeups
2871 so don't show them to the user.
2872 Also, don't record a key if we already did. */
2873 if (BUFFERP (c
) || key_already_recorded
)
2876 /* Process special events within read_char
2877 and loop around to read another event. */
2880 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2885 struct buffer
*prev_buffer
= current_buffer
;
2886 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2887 int was_locked
= single_kboard
;
2888 ptrdiff_t count
= SPECPDL_INDEX ();
2889 record_single_kboard_state ();
2892 last_input_event
= c
;
2893 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2895 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2896 /* We stopped being idle for this event; undo that. This
2897 prevents automatic window selection (under
2898 mouse_autoselect_window from acting as a real input event, for
2899 example banishing the mouse under mouse-avoidance-mode. */
2900 timer_resume_idle ();
2902 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2903 /* Resume allowing input from any kboard, if that was true before. */
2905 any_kboard_state ();
2906 unbind_to (count
, Qnil
);
2909 if (current_buffer
!= prev_buffer
)
2911 /* The command may have changed the keymaps. Pretend there
2912 is input in another keyboard and return. This will
2913 recalculate keymaps. */
2914 c
= make_number (-2);
2921 /* Handle things that only apply to characters. */
2924 /* If kbd_buffer_get_event gave us an EOF, return that. */
2928 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2929 && UNSIGNED_CMP (XFASTINT (c
), <,
2930 SCHARS (KVAR (current_kboard
,
2931 Vkeyboard_translate_table
))))
2932 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2933 && UNSIGNED_CMP (XFASTINT (c
), <,
2934 ASIZE (KVAR (current_kboard
,
2935 Vkeyboard_translate_table
))))
2936 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2940 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2941 /* nil in keyboard-translate-table means no translation. */
2947 /* If this event is a mouse click in the menu bar,
2948 return just menu-bar for now. Modify the mouse click event
2949 so we won't do this twice, then queue it up. */
2950 if (EVENT_HAS_PARAMETERS (c
)
2952 && CONSP (EVENT_START (c
))
2953 && CONSP (XCDR (EVENT_START (c
))))
2957 posn
= POSN_POSN (EVENT_START (c
));
2958 /* Handle menu-bar events:
2959 insert the dummy prefix event `menu-bar'. */
2960 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2962 /* Change menu-bar to (menu-bar) as the event "position". */
2963 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2966 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2971 /* Store these characters into recent_keys, the dribble file if any,
2972 and the keyboard macro being defined, if any. */
2974 if (! NILP (also_record
))
2975 record_char (also_record
);
2977 /* Wipe the echo area.
2978 But first, if we are about to use an input method,
2979 save the echo area contents for it to refer to. */
2981 && ! NILP (Vinput_method_function
)
2982 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2984 previous_echo_area_message
= Fcurrent_message ();
2985 Vinput_method_previous_message
= previous_echo_area_message
;
2988 /* Now wipe the echo area, except for help events which do their
2989 own stuff with the echo area. */
2991 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2992 && !(EQ (Qswitch_frame
, XCAR (c
)))
2993 /* Don't wipe echo area for select window events: These might
2994 get delayed via `mouse-autoselect-window' (Bug#11304). */
2995 && !(EQ (Qselect_window
, XCAR (c
)))))
2997 if (!NILP (echo_area_buffer
[0]))
2999 safe_run_hooks (Qecho_area_clear_hook
);
3000 clear_message (1, 0);
3004 reread_for_input_method
:
3006 /* Pass this to the input method, if appropriate. */
3008 && ! NILP (Vinput_method_function
)
3009 /* Don't run the input method within a key sequence,
3010 after the first event of the key sequence. */
3011 && NILP (prev_event
)
3012 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3015 ptrdiff_t key_count
;
3016 int key_count_reset
;
3017 struct gcpro gcpro1
;
3018 ptrdiff_t count
= SPECPDL_INDEX ();
3020 /* Save the echo status. */
3021 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3022 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3023 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3024 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3027 if (before_command_restore_flag
)
3029 this_command_key_count
= before_command_key_count_1
;
3030 if (this_command_key_count
< this_single_command_key_start
)
3031 this_single_command_key_start
= this_command_key_count
;
3032 echo_truncate (before_command_echo_length_1
);
3033 before_command_restore_flag
= 0;
3037 /* Save the this_command_keys status. */
3038 key_count
= this_command_key_count
;
3039 key_count_reset
= this_command_key_count_reset
;
3042 keys
= Fcopy_sequence (this_command_keys
);
3047 /* Clear out this_command_keys. */
3048 this_command_key_count
= 0;
3049 this_command_key_count_reset
= 0;
3051 /* Now wipe the echo area. */
3052 if (!NILP (echo_area_buffer
[0]))
3053 safe_run_hooks (Qecho_area_clear_hook
);
3054 clear_message (1, 0);
3057 /* If we are not reading a key sequence,
3058 never use the echo area. */
3061 specbind (Qinput_method_use_echo_area
, Qt
);
3064 /* Call the input method. */
3065 tem
= call1 (Vinput_method_function
, c
);
3067 tem
= unbind_to (count
, tem
);
3069 /* Restore the saved echoing state
3070 and this_command_keys state. */
3071 this_command_key_count
= key_count
;
3072 this_command_key_count_reset
= key_count_reset
;
3074 this_command_keys
= keys
;
3077 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3078 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3079 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3080 if (saved_immediate_echo
)
3085 /* The input method can return no events. */
3088 /* Bring back the previous message, if any. */
3089 if (! NILP (previous_echo_area_message
))
3090 message_with_string ("%s", previous_echo_area_message
, 0);
3093 /* It returned one event or more. */
3095 Vunread_post_input_method_events
3096 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3101 /* Display help if not echoing. */
3102 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3104 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3105 Lisp_Object help
, object
, position
, window
, htem
;
3107 htem
= Fcdr (XCDR (c
));
3110 window
= Fcar (htem
);
3112 object
= Fcar (htem
);
3114 position
= Fcar (htem
);
3116 show_help_echo (help
, window
, object
, position
);
3118 /* We stopped being idle for this event; undo that. */
3120 timer_resume_idle ();
3124 if ((! reread
|| this_command_key_count
== 0
3125 || this_command_key_count_reset
)
3129 /* Don't echo mouse motion events. */
3130 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3131 && NILP (Fzerop (Vecho_keystrokes
))
3132 && ! (EVENT_HAS_PARAMETERS (c
)
3133 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3136 if (! NILP (also_record
))
3137 echo_char (also_record
);
3138 /* Once we reread a character, echoing can happen
3139 the next time we pause to read a new one. */
3140 ok_to_echo_at_next_pause
= current_kboard
;
3143 /* Record this character as part of the current key. */
3144 add_command_key (c
);
3145 if (! NILP (also_record
))
3146 add_command_key (also_record
);
3149 last_input_event
= c
;
3152 /* Process the help character specially if enabled */
3153 if (!NILP (Vhelp_form
) && help_char_p (c
))
3155 ptrdiff_t count
= SPECPDL_INDEX ();
3157 help_form_saved_window_configs
3158 = Fcons (Fcurrent_window_configuration (Qnil
),
3159 help_form_saved_window_configs
);
3160 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3161 call0 (Qhelp_form_show
);
3166 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3167 if (EVENT_HAS_PARAMETERS (c
)
3168 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3169 XSETCAR (help_form_saved_window_configs
, Qnil
);
3171 while (BUFFERP (c
));
3172 /* Remove the help from the frame */
3173 unbind_to (count
, Qnil
);
3176 if (EQ (c
, make_number (040)))
3180 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3181 while (BUFFERP (c
));
3190 /* Record a key that came from a mouse menu.
3191 Record it for echoing, for this-command-keys, and so on. */
3194 record_menu_key (Lisp_Object c
)
3196 /* Wipe the echo area. */
3197 clear_message (1, 0);
3202 before_command_key_count
= this_command_key_count
;
3203 before_command_echo_length
= echo_length ();
3206 /* Don't echo mouse motion events. */
3207 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3208 && NILP (Fzerop (Vecho_keystrokes
)))
3212 /* Once we reread a character, echoing can happen
3213 the next time we pause to read a new one. */
3214 ok_to_echo_at_next_pause
= 0;
3217 /* Record this character as part of the current key. */
3218 add_command_key (c
);
3220 /* Re-reading in the middle of a command */
3221 last_input_event
= c
;
3225 /* Return 1 if should recognize C as "the help character". */
3228 help_char_p (Lisp_Object c
)
3232 if (EQ (c
, Vhelp_char
))
3234 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3235 if (EQ (c
, XCAR (tail
)))
3240 /* Record the input event C in various ways. */
3243 record_char (Lisp_Object c
)
3247 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3249 /* To avoid filling recent_keys with help-echo and mouse-movement
3250 events, we filter out repeated help-echo events, only store the
3251 first and last in a series of mouse-movement events, and don't
3252 store repeated help-echo events which are only separated by
3253 mouse-movement events. */
3255 Lisp_Object ev1
, ev2
, ev3
;
3258 if ((ix1
= recent_keys_index
- 1) < 0)
3259 ix1
= NUM_RECENT_KEYS
- 1;
3260 ev1
= AREF (recent_keys
, ix1
);
3262 if ((ix2
= ix1
- 1) < 0)
3263 ix2
= NUM_RECENT_KEYS
- 1;
3264 ev2
= AREF (recent_keys
, ix2
);
3266 if ((ix3
= ix2
- 1) < 0)
3267 ix3
= NUM_RECENT_KEYS
- 1;
3268 ev3
= AREF (recent_keys
, ix3
);
3270 if (EQ (XCAR (c
), Qhelp_echo
))
3272 /* Don't record `help-echo' in recent_keys unless it shows some help
3273 message, and a different help than the previously recorded
3275 Lisp_Object help
, last_help
;
3277 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3278 if (!STRINGP (help
))
3280 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3281 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3283 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3284 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3285 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3287 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3288 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3289 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3290 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3293 else if (EQ (XCAR (c
), Qmouse_movement
))
3295 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3296 So additional mouse movement events replace the last element. */
3297 Lisp_Object last_window
, window
;
3299 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3300 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3301 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3302 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3303 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3305 ASET (recent_keys
, ix1
, c
);
3311 store_kbd_macro_char (c
);
3315 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3316 ASET (recent_keys
, recent_keys_index
, c
);
3317 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3318 recent_keys_index
= 0;
3320 else if (recorded
< 0)
3322 /* We need to remove one or two events from recent_keys.
3323 To do this, we simply put nil at those events and move the
3324 recent_keys_index backwards over those events. Usually,
3325 users will never see those nil events, as they will be
3326 overwritten by the command keys entered to see recent_keys
3329 while (recorded
++ < 0 && total_keys
> 0)
3331 if (total_keys
< NUM_RECENT_KEYS
)
3333 if (--recent_keys_index
< 0)
3334 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3335 ASET (recent_keys
, recent_keys_index
, Qnil
);
3339 num_nonmacro_input_events
++;
3341 /* Write c to the dribble file. If c is a lispy event, write
3342 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3343 If you, dear reader, have a better idea, you've got the source. :-) */
3349 if (XUINT (c
) < 0x100)
3350 putc (XUINT (c
), dribble
);
3352 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3356 Lisp_Object dribblee
;
3358 /* If it's a structured event, take the event header. */
3359 dribblee
= EVENT_HEAD (c
);
3361 if (SYMBOLP (dribblee
))
3363 putc ('<', dribble
);
3364 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3365 SBYTES (SYMBOL_NAME (dribblee
)),
3367 putc ('>', dribble
);
3376 /* Copy out or in the info on where C-g should throw to.
3377 This is used when running Lisp code from within get_char,
3378 in case get_char is called recursively.
3379 See read_process_output. */
3382 save_getcjmp (jmp_buf temp
)
3384 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3388 restore_getcjmp (jmp_buf temp
)
3390 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3393 /* Low level keyboard/mouse input.
3394 kbd_buffer_store_event places events in kbd_buffer, and
3395 kbd_buffer_get_event retrieves them. */
3397 /* Return true if there are any events in the queue that read-char
3398 would return. If this returns false, a read-char would block. */
3400 readable_events (int flags
)
3402 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3405 /* If the buffer contains only FOCUS_IN_EVENT events, and
3406 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3407 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3409 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3410 #ifdef USE_TOOLKIT_SCROLL_BARS
3411 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3415 struct input_event
*event
;
3417 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3424 #ifdef USE_TOOLKIT_SCROLL_BARS
3425 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3427 event
->kind
== FOCUS_IN_EVENT
)
3428 #ifdef USE_TOOLKIT_SCROLL_BARS
3429 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3430 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3431 && event
->part
== scroll_bar_handle
3432 && event
->modifiers
== 0)
3437 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3440 while (event
!= kbd_store_ptr
);
3446 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3447 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3448 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3453 if (current_kboard
->kbd_queue_has_data
)
3459 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3460 if (kb
->kbd_queue_has_data
)
3466 /* Set this for debugging, to have a way to get out */
3467 int stop_character EXTERNALLY_VISIBLE
;
3470 event_to_kboard (struct input_event
*event
)
3473 frame
= event
->frame_or_window
;
3475 frame
= XCAR (frame
);
3476 else if (WINDOWP (frame
))
3477 frame
= WINDOW_FRAME (XWINDOW (frame
));
3479 /* There are still some events that don't set this field.
3480 For now, just ignore the problem.
3481 Also ignore dead frames here. */
3482 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3485 return FRAME_KBOARD (XFRAME (frame
));
3489 /* Return the number of slots occupied in kbd_buffer. */
3492 kbd_buffer_nr_stored (void)
3494 return kbd_fetch_ptr
== kbd_store_ptr
3496 : (kbd_fetch_ptr
< kbd_store_ptr
3497 ? kbd_store_ptr
- kbd_fetch_ptr
3498 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3499 + (kbd_store_ptr
- kbd_buffer
)));
3501 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3504 kbd_buffer_store_event (register struct input_event
*event
)
3506 kbd_buffer_store_event_hold (event
, 0);
3509 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3511 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3512 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3513 Else, if EVENT is a quit event, store the quit event
3514 in HOLD_QUIT, and return (thus ignoring further events).
3516 This is used in read_avail_input to postpone the processing
3517 of the quit event until all subsequent input events have been
3518 parsed (and discarded).
3522 kbd_buffer_store_event_hold (register struct input_event
*event
,
3523 struct input_event
*hold_quit
)
3525 if (event
->kind
== NO_EVENT
)
3528 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3531 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3533 register int c
= event
->code
& 0377;
3535 if (event
->modifiers
& ctrl_modifier
)
3536 c
= make_ctrl_char (c
);
3538 c
|= (event
->modifiers
3539 & (meta_modifier
| alt_modifier
3540 | hyper_modifier
| super_modifier
));
3544 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3545 struct input_event
*sp
;
3547 if (single_kboard
&& kb
!= current_kboard
)
3549 KVAR (kb
, kbd_queue
)
3550 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3551 Fcons (make_number (c
), Qnil
));
3552 kb
->kbd_queue_has_data
= 1;
3553 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3555 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3558 if (event_to_kboard (sp
) == kb
)
3560 sp
->kind
= NO_EVENT
;
3561 sp
->frame_or_window
= Qnil
;
3570 memcpy (hold_quit
, event
, sizeof (*event
));
3574 /* If this results in a quit_char being returned to Emacs as
3575 input, set Vlast_event_frame properly. If this doesn't
3576 get returned to Emacs as an event, the next event read
3577 will set Vlast_event_frame again, so this is safe to do. */
3581 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3583 focus
= event
->frame_or_window
;
3584 internal_last_event_frame
= focus
;
3585 Vlast_event_frame
= focus
;
3588 last_event_timestamp
= event
->timestamp
;
3589 handle_interrupt ();
3593 if (c
&& c
== stop_character
)
3599 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3600 Just ignore the second one. */
3601 else if (event
->kind
== BUFFER_SWITCH_EVENT
3602 && kbd_fetch_ptr
!= kbd_store_ptr
3603 && ((kbd_store_ptr
== kbd_buffer
3604 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3605 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3608 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3609 kbd_store_ptr
= kbd_buffer
;
3611 /* Don't let the very last slot in the buffer become full,
3612 since that would make the two pointers equal,
3613 and that is indistinguishable from an empty buffer.
3614 Discard the event if it would fill the last slot. */
3615 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3617 *kbd_store_ptr
= *event
;
3620 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3622 /* Don't read keyboard input until we have processed kbd_buffer.
3623 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3624 hold_keyboard_input ();
3626 if (!noninteractive
)
3627 signal (SIGIO
, SIG_IGN
);
3631 #endif /* subprocesses */
3634 /* If we're inside while-no-input, and this event qualifies
3635 as input, set quit-flag to cause an interrupt. */
3636 if (!NILP (Vthrow_on_input
)
3637 && event
->kind
!= FOCUS_IN_EVENT
3638 && event
->kind
!= HELP_EVENT
3639 && event
->kind
!= DEICONIFY_EVENT
)
3641 Vquit_flag
= Vthrow_on_input
;
3642 /* If we're inside a function that wants immediate quits,
3644 if (immediate_quit
&& NILP (Vinhibit_quit
))
3654 /* Put an input event back in the head of the event queue. */
3657 kbd_buffer_unget_event (register struct input_event
*event
)
3659 if (kbd_fetch_ptr
== kbd_buffer
)
3660 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3662 /* Don't let the very last slot in the buffer become full, */
3663 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3666 *kbd_fetch_ptr
= *event
;
3671 /* Generate a HELP_EVENT input_event and store it in the keyboard
3674 HELP is the help form.
3676 FRAME and WINDOW are the frame and window where the help is
3677 generated. OBJECT is the Lisp object where the help was found (a
3678 buffer, a string, an overlay, or nil if neither from a string nor
3679 from a buffer). POS is the position within OBJECT where the help
3683 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3684 Lisp_Object object
, ptrdiff_t pos
)
3686 struct input_event event
;
3690 event
.kind
= HELP_EVENT
;
3691 event
.frame_or_window
= frame
;
3693 event
.x
= WINDOWP (window
) ? window
: frame
;
3696 kbd_buffer_store_event (&event
);
3700 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3703 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3705 struct input_event event
;
3707 event
.kind
= HELP_EVENT
;
3708 event
.frame_or_window
= frame
;
3713 kbd_buffer_store_event (&event
);
3717 /* Discard any mouse events in the event buffer by setting them to
3720 discard_mouse_events (void)
3722 struct input_event
*sp
;
3723 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3725 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3728 if (sp
->kind
== MOUSE_CLICK_EVENT
3729 || sp
->kind
== WHEEL_EVENT
3730 || sp
->kind
== HORIZ_WHEEL_EVENT
3732 || sp
->kind
== GPM_CLICK_EVENT
3734 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3736 sp
->kind
= NO_EVENT
;
3742 /* Return non-zero if there are any real events waiting in the event
3743 buffer, not counting `NO_EVENT's.
3745 If DISCARD is non-zero, discard NO_EVENT events at the front of
3746 the input queue, possibly leaving the input queue empty if there
3747 are no real input events. */
3750 kbd_buffer_events_waiting (int discard
)
3752 struct input_event
*sp
;
3754 for (sp
= kbd_fetch_ptr
;
3755 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3758 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3765 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3769 /* Clear input event EVENT. */
3772 clear_event (struct input_event
*event
)
3774 event
->kind
= NO_EVENT
;
3778 /* Read one event from the event buffer, waiting if necessary.
3779 The value is a Lisp object representing the event.
3780 The value is nil for an event that should be ignored,
3781 or that was handled here.
3782 We always read and discard one event. */
3785 kbd_buffer_get_event (KBOARD
**kbp
,
3786 int *used_mouse_menu
,
3787 EMACS_TIME
*end_time
)
3792 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3794 /* Start reading input again, we have processed enough so we can
3795 accept new events again. */
3796 unhold_keyboard_input ();
3798 if (!noninteractive
)
3799 signal (SIGIO
, input_available_signal
);
3803 #endif /* subprocesses */
3805 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3807 /* In case we are running as a daemon, only do this before
3808 detaching from the terminal. */
3809 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3813 *kbp
= current_kboard
;
3816 #endif /* ! HAVE_DBUS */
3818 /* Wait until there is input available. */
3821 /* Break loop if there's an unread command event. Needed in
3822 moused window autoselection which uses a timer to insert such
3824 if (CONSP (Vunread_command_events
))
3827 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3829 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3830 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3834 /* If the quit flag is set, then read_char will return
3835 quit_char, so that counts as "available input." */
3836 if (!NILP (Vquit_flag
))
3837 quit_throw_to_read_char (0);
3839 /* One way or another, wait until input is available; then, if
3840 interrupt handlers have not read it, read it now. */
3842 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3846 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3848 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3849 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3854 EMACS_TIME duration
;
3855 EMACS_GET_TIME (duration
);
3856 if (EMACS_TIME_GE (duration
, *end_time
))
3857 return Qnil
; /* finished waiting */
3860 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3861 wait_reading_process_output (min (EMACS_SECS (duration
),
3863 EMACS_NSECS (duration
),
3864 -1, 1, Qnil
, NULL
, 0);
3868 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3870 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3871 /* Pass 1 for EXPECT since we just waited to have input. */
3872 read_avail_input (1);
3875 if (CONSP (Vunread_command_events
))
3878 first
= XCAR (Vunread_command_events
);
3879 Vunread_command_events
= XCDR (Vunread_command_events
);
3880 *kbp
= current_kboard
;
3884 /* At this point, we know that there is a readable event available
3885 somewhere. If the event queue is empty, then there must be a
3886 mouse movement enabled and available. */
3887 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3889 struct input_event
*event
;
3891 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3895 last_event_timestamp
= event
->timestamp
;
3897 *kbp
= event_to_kboard (event
);
3899 *kbp
= current_kboard
; /* Better than returning null ptr? */
3903 /* These two kinds of events get special handling
3904 and don't actually appear to the command loop.
3905 We return nil for them. */
3906 if (event
->kind
== SELECTION_REQUEST_EVENT
3907 || event
->kind
== SELECTION_CLEAR_EVENT
)
3910 struct input_event copy
;
3912 /* Remove it from the buffer before processing it,
3913 since otherwise swallow_events will see it
3914 and process it again. */
3916 kbd_fetch_ptr
= event
+ 1;
3917 input_pending
= readable_events (0);
3918 x_handle_selection_event (©
);
3920 /* We're getting selection request events, but we don't have
3926 #if defined (HAVE_NS)
3927 else if (event
->kind
== NS_TEXT_EVENT
)
3929 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3930 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3932 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3933 kbd_fetch_ptr
= event
+ 1;
3934 if (used_mouse_menu
)
3935 *used_mouse_menu
= 1;
3939 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3940 || defined (HAVE_NS)
3941 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3943 /* Make an event (delete-frame (FRAME)). */
3944 obj
= Fcons (event
->frame_or_window
, Qnil
);
3945 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3946 kbd_fetch_ptr
= event
+ 1;
3949 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3950 || defined (HAVE_NS)
3951 else if (event
->kind
== ICONIFY_EVENT
)
3953 /* Make an event (iconify-frame (FRAME)). */
3954 obj
= Fcons (event
->frame_or_window
, Qnil
);
3955 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3956 kbd_fetch_ptr
= event
+ 1;
3958 else if (event
->kind
== DEICONIFY_EVENT
)
3960 /* Make an event (make-frame-visible (FRAME)). */
3961 obj
= Fcons (event
->frame_or_window
, Qnil
);
3962 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3963 kbd_fetch_ptr
= event
+ 1;
3966 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3968 /* The value doesn't matter here; only the type is tested. */
3969 XSETBUFFER (obj
, current_buffer
);
3970 kbd_fetch_ptr
= event
+ 1;
3972 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3973 || defined (HAVE_NS) || defined (USE_GTK)
3974 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3976 kbd_fetch_ptr
= event
+ 1;
3977 input_pending
= readable_events (0);
3978 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3979 x_activate_menubar (XFRAME (event
->frame_or_window
));
3982 #if defined (WINDOWSNT)
3983 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3985 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3986 obj
= Fcons (Qlanguage_change
,
3987 list3 (event
->frame_or_window
,
3988 make_number (event
->code
),
3989 make_number (event
->modifiers
)));
3990 kbd_fetch_ptr
= event
+ 1;
3993 else if (event
->kind
== SAVE_SESSION_EVENT
)
3995 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3996 kbd_fetch_ptr
= event
+ 1;
3998 /* Just discard these, by returning nil.
3999 With MULTI_KBOARD, these events are used as placeholders
4000 when we need to randomly delete events from the queue.
4001 (They shouldn't otherwise be found in the buffer,
4002 but on some machines it appears they do show up
4003 even without MULTI_KBOARD.) */
4004 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4005 mouse events during a popup-menu call. */
4006 else if (event
->kind
== NO_EVENT
)
4007 kbd_fetch_ptr
= event
+ 1;
4008 else if (event
->kind
== HELP_EVENT
)
4010 Lisp_Object object
, position
, help
, frame
, window
;
4012 frame
= event
->frame_or_window
;
4013 object
= event
->arg
;
4014 position
= make_number (event
->code
);
4017 clear_event (event
);
4019 kbd_fetch_ptr
= event
+ 1;
4020 if (!WINDOWP (window
))
4022 obj
= Fcons (Qhelp_echo
,
4023 list5 (frame
, help
, window
, object
, position
));
4025 else if (event
->kind
== FOCUS_IN_EVENT
)
4027 /* Notification of a FocusIn event. The frame receiving the
4028 focus is in event->frame_or_window. Generate a
4029 switch-frame event if necessary. */
4030 Lisp_Object frame
, focus
;
4032 frame
= event
->frame_or_window
;
4033 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4037 if (!EQ (frame
, internal_last_event_frame
)
4038 && !EQ (frame
, selected_frame
))
4039 obj
= make_lispy_switch_frame (frame
);
4040 internal_last_event_frame
= frame
;
4041 kbd_fetch_ptr
= event
+ 1;
4044 else if (event
->kind
== DBUS_EVENT
)
4046 obj
= make_lispy_event (event
);
4047 kbd_fetch_ptr
= event
+ 1;
4050 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4052 obj
= make_lispy_event (event
);
4053 kbd_fetch_ptr
= event
+ 1;
4057 /* If this event is on a different frame, return a switch-frame this
4058 time, and leave the event in the queue for next time. */
4062 frame
= event
->frame_or_window
;
4064 frame
= XCAR (frame
);
4065 else if (WINDOWP (frame
))
4066 frame
= WINDOW_FRAME (XWINDOW (frame
));
4068 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4072 if (! EQ (frame
, internal_last_event_frame
)
4073 && !EQ (frame
, selected_frame
))
4074 obj
= make_lispy_switch_frame (frame
);
4075 internal_last_event_frame
= frame
;
4077 /* If we didn't decide to make a switch-frame event, go ahead
4078 and build a real event from the queue entry. */
4082 obj
= make_lispy_event (event
);
4084 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4085 || defined (HAVE_NS) || defined (USE_GTK)
4086 /* If this was a menu selection, then set the flag to inhibit
4087 writing to last_nonmenu_event. Don't do this if the event
4088 we're returning is (menu-bar), though; that indicates the
4089 beginning of the menu sequence, and we might as well leave
4090 that as the `event with parameters' for this selection. */
4092 && !EQ (event
->frame_or_window
, event
->arg
)
4093 && (event
->kind
== MENU_BAR_EVENT
4094 || event
->kind
== TOOL_BAR_EVENT
))
4095 *used_mouse_menu
= 1;
4098 /* certain system events are non-key events */
4100 && event
->kind
== NS_NONKEY_EVENT
)
4101 *used_mouse_menu
= 1;
4104 /* Wipe out this event, to catch bugs. */
4105 clear_event (event
);
4106 kbd_fetch_ptr
= event
+ 1;
4110 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4111 /* Try generating a mouse motion event. */
4112 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4114 FRAME_PTR f
= some_mouse_moved ();
4115 Lisp_Object bar_window
;
4116 enum scroll_bar_part part
;
4120 *kbp
= current_kboard
;
4121 /* Note that this uses F to determine which terminal to look at.
4122 If there is no valid info, it does not store anything
4123 so x remains nil. */
4126 /* XXX Can f or mouse_position_hook be NULL here? */
4127 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4128 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4133 /* Decide if we should generate a switch-frame event. Don't
4134 generate switch-frame events for motion outside of all Emacs
4140 frame
= FRAME_FOCUS_FRAME (f
);
4142 XSETFRAME (frame
, f
);
4144 if (! EQ (frame
, internal_last_event_frame
)
4145 && !EQ (frame
, selected_frame
))
4146 obj
= make_lispy_switch_frame (frame
);
4147 internal_last_event_frame
= frame
;
4150 /* If we didn't decide to make a switch-frame event, go ahead and
4151 return a mouse-motion event. */
4152 if (!NILP (x
) && NILP (obj
))
4153 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4155 #endif /* HAVE_MOUSE || HAVE GPM */
4157 /* We were promised by the above while loop that there was
4158 something for us to read! */
4161 input_pending
= readable_events (0);
4163 Vlast_event_frame
= internal_last_event_frame
;
4168 /* Process any non-user-visible events (currently X selection events),
4169 without reading any user-visible events. */
4172 process_special_events (void)
4174 struct input_event
*event
;
4176 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4178 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4181 if (event
== kbd_store_ptr
)
4185 /* If we find a stored X selection request, handle it now. */
4186 if (event
->kind
== SELECTION_REQUEST_EVENT
4187 || event
->kind
== SELECTION_CLEAR_EVENT
)
4191 /* Remove the event from the fifo buffer before processing;
4192 otherwise swallow_events called recursively could see it
4193 and process it again. To do this, we move the events
4194 between kbd_fetch_ptr and EVENT one slot to the right,
4197 struct input_event copy
= *event
;
4198 struct input_event
*beg
4199 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4200 ? kbd_buffer
: kbd_fetch_ptr
;
4203 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4204 else if (event
< beg
)
4206 if (event
> kbd_buffer
)
4207 memmove (kbd_buffer
+ 1, kbd_buffer
,
4208 (event
- kbd_buffer
) * sizeof (struct input_event
));
4209 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4210 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4211 memmove (beg
+ 1, beg
,
4212 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4213 * sizeof (struct input_event
));
4216 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4217 kbd_fetch_ptr
= kbd_buffer
+ 1;
4221 /* X wants last_event_timestamp for selection ownership. */
4222 last_event_timestamp
= copy
.timestamp
;
4223 input_pending
= readable_events (0);
4224 x_handle_selection_event (©
);
4226 /* We're getting selection request events, but we don't have
4234 /* Process any events that are not user-visible, run timer events that
4235 are ripe, and return, without reading any user-visible events. */
4238 swallow_events (int do_display
)
4242 process_special_events ();
4244 old_timers_run
= timers_run
;
4245 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4247 if (timers_run
!= old_timers_run
&& do_display
)
4248 redisplay_preserve_echo_area (7);
4251 /* Record the start of when Emacs is idle,
4252 for the sake of running idle-time timers. */
4255 timer_start_idle (void)
4259 /* If we are already in the idle state, do nothing. */
4260 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4263 EMACS_GET_TIME (timer_idleness_start_time
);
4265 timer_last_idleness_start_time
= timer_idleness_start_time
;
4267 /* Mark all idle-time timers as once again candidates for running. */
4268 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4272 timer
= XCAR (timers
);
4274 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4276 ASET (timer
, 0, Qnil
);
4280 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4283 timer_stop_idle (void)
4285 EMACS_SET_INVALID_TIME (timer_idleness_start_time
);
4288 /* Resume idle timer from last idle start time. */
4291 timer_resume_idle (void)
4293 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4296 timer_idleness_start_time
= timer_last_idleness_start_time
;
4299 /* This is only for debugging. */
4300 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4302 /* List of elisp functions to call, delayed because they were generated in
4303 a context where Elisp could not be safely run (e.g. redisplay, signal,
4304 ...). Each element has the form (FUN . ARGS). */
4305 Lisp_Object pending_funcalls
;
4307 /* If TIMER is a valid timer, return nonzero and place its value into
4308 *RESULT. Otherwise return zero. */
4310 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4312 Lisp_Object
*vector
;
4314 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4316 vector
= XVECTOR (timer
)->contents
;
4317 if (! NILP (vector
[0]))
4320 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[4],
4325 /* Check whether a timer has fired. To prevent larger problems we simply
4326 disregard elements that are not proper timers. Do not make a circular
4327 timer list for the time being.
4329 Returns the time to wait until the next timer fires. If a
4330 timer is triggering now, return zero.
4331 If no timer is active, return -1.
4333 If a timer is ripe, we run it, with quitting turned off.
4334 In that case we return 0 to indicate that a new timer_check_2 call
4338 timer_check_2 (void)
4340 EMACS_TIME nexttime
;
4342 EMACS_TIME idleness_now
;
4343 Lisp_Object timers
, idle_timers
, chosen_timer
;
4344 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4346 EMACS_SET_INVALID_TIME (nexttime
);
4348 /* Always consider the ordinary timers. */
4349 timers
= Vtimer_list
;
4350 /* Consider the idle timers only if Emacs is idle. */
4351 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4352 idle_timers
= Vtimer_idle_list
;
4355 chosen_timer
= Qnil
;
4356 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4358 /* First run the code that was delayed. */
4359 while (CONSP (pending_funcalls
))
4361 Lisp_Object funcall
= XCAR (pending_funcalls
);
4362 pending_funcalls
= XCDR (pending_funcalls
);
4363 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4366 if (CONSP (timers
) || CONSP (idle_timers
))
4368 EMACS_GET_TIME (now
);
4369 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4370 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4372 EMACS_SET_SECS_NSECS (idleness_now
, 0, 0);
4375 while (CONSP (timers
) || CONSP (idle_timers
))
4377 Lisp_Object
*vector
;
4378 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4379 EMACS_TIME timer_time
, idle_timer_time
;
4380 EMACS_TIME difference
;
4381 EMACS_TIME timer_difference
, idle_timer_difference
;
4382 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4384 EMACS_SET_INVALID_TIME (timer_difference
);
4385 EMACS_SET_INVALID_TIME (idle_timer_difference
);
4387 /* Set TIMER and TIMER_DIFFERENCE
4388 based on the next ordinary timer.
4389 TIMER_DIFFERENCE is the distance in time from NOW to when
4390 this timer becomes ripe (negative if it's already ripe).
4391 Skip past invalid timers and timers already handled. */
4394 timer
= XCAR (timers
);
4395 if (! decode_timer (timer
, &timer_time
))
4397 timers
= XCDR (timers
);
4401 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4403 EMACS_SUB_TIME (timer_difference
, now
, timer_time
);
4405 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4408 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4409 based on the next idle timer. */
4410 if (CONSP (idle_timers
))
4412 idle_timer
= XCAR (idle_timers
);
4413 if (! decode_timer (idle_timer
, &idle_timer_time
))
4415 idle_timers
= XCDR (idle_timers
);
4419 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4420 if (idle_timer_ripe
)
4421 EMACS_SUB_TIME (idle_timer_difference
,
4422 idleness_now
, idle_timer_time
);
4424 EMACS_SUB_TIME (idle_timer_difference
,
4425 idle_timer_time
, idleness_now
);
4428 /* Decide which timer is the next timer,
4429 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4430 Also step down the list where we found that timer. */
4432 if (EMACS_TIME_VALID_P (timer_difference
)
4433 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4434 || idle_timer_ripe
< timer_ripe
4435 || (idle_timer_ripe
== timer_ripe
4437 ? EMACS_TIME_LT (idle_timer_difference
,
4439 : EMACS_TIME_LT (timer_difference
,
4440 idle_timer_difference
)))))
4442 chosen_timer
= timer
;
4443 timers
= XCDR (timers
);
4444 difference
= timer_difference
;
4449 chosen_timer
= idle_timer
;
4450 idle_timers
= XCDR (idle_timers
);
4451 difference
= idle_timer_difference
;
4452 ripe
= idle_timer_ripe
;
4455 /* If timer is ripe, run it if it hasn't been run. */
4458 vector
= XVECTOR (chosen_timer
)->contents
;
4459 if (NILP (vector
[0]))
4461 ptrdiff_t count
= SPECPDL_INDEX ();
4462 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4464 /* Mark the timer as triggered to prevent problems if the lisp
4465 code fails to reschedule it right. */
4468 specbind (Qinhibit_quit
, Qt
);
4470 call1 (Qtimer_event_handler
, chosen_timer
);
4471 Vdeactivate_mark
= old_deactivate_mark
;
4473 unbind_to (count
, Qnil
);
4475 /* Since we have handled the event,
4476 we don't need to tell the caller to wake up and do it. */
4477 /* But the caller must still wait for the next timer, so
4478 return 0 to indicate that. */
4481 EMACS_SET_SECS (nexttime
, 0);
4482 EMACS_SET_USECS (nexttime
, 0);
4485 /* When we encounter a timer that is still waiting,
4486 return the amount of time to wait before it is ripe. */
4493 /* No timers are pending in the future. */
4494 /* Return 0 if we generated an event, and -1 if not. */
4500 /* Check whether a timer has fired. To prevent larger problems we simply
4501 disregard elements that are not proper timers. Do not make a circular
4502 timer list for the time being.
4504 Returns the time to wait until the next timer fires.
4505 If no timer is active, return an invalid value.
4507 As long as any timer is ripe, we run it. */
4512 EMACS_TIME nexttime
;
4516 nexttime
= timer_check_2 ();
4518 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4523 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4524 doc
: /* Return the current length of Emacs idleness, or nil.
4525 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4526 in the same style as (current-time).
4528 The value when Emacs is not idle is nil.
4530 NSEC is a multiple of the system clock resolution. */)
4533 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4535 EMACS_TIME now
, idleness_now
;
4537 EMACS_GET_TIME (now
);
4538 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4540 return make_lisp_time (idleness_now
);
4546 /* Caches for modify_event_symbol. */
4547 static Lisp_Object accent_key_syms
;
4548 static Lisp_Object func_key_syms
;
4549 static Lisp_Object mouse_syms
;
4550 static Lisp_Object wheel_syms
;
4551 static Lisp_Object drag_n_drop_syms
;
4553 /* This is a list of keysym codes for special "accent" characters.
4554 It parallels lispy_accent_keys. */
4556 static const int lispy_accent_codes
[] =
4558 #ifdef XK_dead_circumflex
4563 #ifdef XK_dead_grave
4568 #ifdef XK_dead_tilde
4573 #ifdef XK_dead_diaeresis
4578 #ifdef XK_dead_macron
4583 #ifdef XK_dead_degree
4588 #ifdef XK_dead_acute
4593 #ifdef XK_dead_cedilla
4598 #ifdef XK_dead_breve
4603 #ifdef XK_dead_ogonek
4608 #ifdef XK_dead_caron
4613 #ifdef XK_dead_doubleacute
4614 XK_dead_doubleacute
,
4618 #ifdef XK_dead_abovedot
4623 #ifdef XK_dead_abovering
4633 #ifdef XK_dead_belowdot
4638 #ifdef XK_dead_voiced_sound
4639 XK_dead_voiced_sound
,
4643 #ifdef XK_dead_semivoiced_sound
4644 XK_dead_semivoiced_sound
,
4660 /* This is a list of Lisp names for special "accent" characters.
4661 It parallels lispy_accent_codes. */
4663 static const char *const lispy_accent_keys
[] =
4681 "dead-voiced-sound",
4682 "dead-semivoiced-sound",
4688 #define FUNCTION_KEY_OFFSET 0x0
4690 const char *const lispy_function_keys
[] =
4694 0, /* VK_LBUTTON 0x01 */
4695 0, /* VK_RBUTTON 0x02 */
4696 "cancel", /* VK_CANCEL 0x03 */
4697 0, /* VK_MBUTTON 0x04 */
4699 0, 0, 0, /* 0x05 .. 0x07 */
4701 "backspace", /* VK_BACK 0x08 */
4702 "tab", /* VK_TAB 0x09 */
4704 0, 0, /* 0x0A .. 0x0B */
4706 "clear", /* VK_CLEAR 0x0C */
4707 "return", /* VK_RETURN 0x0D */
4709 0, 0, /* 0x0E .. 0x0F */
4711 0, /* VK_SHIFT 0x10 */
4712 0, /* VK_CONTROL 0x11 */
4713 0, /* VK_MENU 0x12 */
4714 "pause", /* VK_PAUSE 0x13 */
4715 "capslock", /* VK_CAPITAL 0x14 */
4716 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4718 "junja", /* VK_JUNJA 0x17 */
4719 "final", /* VK_FINAL 0x18 */
4720 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4722 "escape", /* VK_ESCAPE 0x1B */
4723 "convert", /* VK_CONVERT 0x1C */
4724 "non-convert", /* VK_NONCONVERT 0x1D */
4725 "accept", /* VK_ACCEPT 0x1E */
4726 "mode-change", /* VK_MODECHANGE 0x1F */
4727 0, /* VK_SPACE 0x20 */
4728 "prior", /* VK_PRIOR 0x21 */
4729 "next", /* VK_NEXT 0x22 */
4730 "end", /* VK_END 0x23 */
4731 "home", /* VK_HOME 0x24 */
4732 "left", /* VK_LEFT 0x25 */
4733 "up", /* VK_UP 0x26 */
4734 "right", /* VK_RIGHT 0x27 */
4735 "down", /* VK_DOWN 0x28 */
4736 "select", /* VK_SELECT 0x29 */
4737 "print", /* VK_PRINT 0x2A */
4738 "execute", /* VK_EXECUTE 0x2B */
4739 "snapshot", /* VK_SNAPSHOT 0x2C */
4740 "insert", /* VK_INSERT 0x2D */
4741 "delete", /* VK_DELETE 0x2E */
4742 "help", /* VK_HELP 0x2F */
4744 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4746 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4748 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4750 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4752 0, 0, 0, 0, 0, 0, 0, 0, 0,
4753 0, 0, 0, 0, 0, 0, 0, 0, 0,
4754 0, 0, 0, 0, 0, 0, 0, 0,
4756 "lwindow", /* VK_LWIN 0x5B */
4757 "rwindow", /* VK_RWIN 0x5C */
4758 "apps", /* VK_APPS 0x5D */
4761 "kp-0", /* VK_NUMPAD0 0x60 */
4762 "kp-1", /* VK_NUMPAD1 0x61 */
4763 "kp-2", /* VK_NUMPAD2 0x62 */
4764 "kp-3", /* VK_NUMPAD3 0x63 */
4765 "kp-4", /* VK_NUMPAD4 0x64 */
4766 "kp-5", /* VK_NUMPAD5 0x65 */
4767 "kp-6", /* VK_NUMPAD6 0x66 */
4768 "kp-7", /* VK_NUMPAD7 0x67 */
4769 "kp-8", /* VK_NUMPAD8 0x68 */
4770 "kp-9", /* VK_NUMPAD9 0x69 */
4771 "kp-multiply", /* VK_MULTIPLY 0x6A */
4772 "kp-add", /* VK_ADD 0x6B */
4773 "kp-separator", /* VK_SEPARATOR 0x6C */
4774 "kp-subtract", /* VK_SUBTRACT 0x6D */
4775 "kp-decimal", /* VK_DECIMAL 0x6E */
4776 "kp-divide", /* VK_DIVIDE 0x6F */
4777 "f1", /* VK_F1 0x70 */
4778 "f2", /* VK_F2 0x71 */
4779 "f3", /* VK_F3 0x72 */
4780 "f4", /* VK_F4 0x73 */
4781 "f5", /* VK_F5 0x74 */
4782 "f6", /* VK_F6 0x75 */
4783 "f7", /* VK_F7 0x76 */
4784 "f8", /* VK_F8 0x77 */
4785 "f9", /* VK_F9 0x78 */
4786 "f10", /* VK_F10 0x79 */
4787 "f11", /* VK_F11 0x7A */
4788 "f12", /* VK_F12 0x7B */
4789 "f13", /* VK_F13 0x7C */
4790 "f14", /* VK_F14 0x7D */
4791 "f15", /* VK_F15 0x7E */
4792 "f16", /* VK_F16 0x7F */
4793 "f17", /* VK_F17 0x80 */
4794 "f18", /* VK_F18 0x81 */
4795 "f19", /* VK_F19 0x82 */
4796 "f20", /* VK_F20 0x83 */
4797 "f21", /* VK_F21 0x84 */
4798 "f22", /* VK_F22 0x85 */
4799 "f23", /* VK_F23 0x86 */
4800 "f24", /* VK_F24 0x87 */
4802 0, 0, 0, 0, /* 0x88 .. 0x8B */
4803 0, 0, 0, 0, /* 0x8C .. 0x8F */
4805 "kp-numlock", /* VK_NUMLOCK 0x90 */
4806 "scroll", /* VK_SCROLL 0x91 */
4807 /* Not sure where the following block comes from.
4808 Windows headers have NEC and Fujitsu specific keys in
4809 this block, but nothing generic. */
4810 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4811 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4812 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4813 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4814 "kp-end", /* VK_NUMPAD_END 0x96 */
4815 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4816 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4817 "kp-up", /* VK_NUMPAD_UP 0x99 */
4818 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4819 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4820 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4821 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4823 0, 0, /* 0x9E .. 0x9F */
4826 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4827 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4828 * No other API or message will distinguish left and right keys this way.
4833 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4834 to enable them selectively, and gives access to a few more functions.
4835 See lispy_multimedia_keys below. */
4836 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4837 0, 0, 0, /* 0xAD .. 0xAF Volume */
4838 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4839 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4841 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4842 0, 0, 0, 0, 0, 0, 0, 0, 0,
4844 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4845 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4846 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4849 "ax", /* VK_OEM_AX 0xE1 */
4850 0, /* VK_OEM_102 0xE2 */
4851 "ico-help", /* VK_ICO_HELP 0xE3 */
4852 "ico-00", /* VK_ICO_00 0xE4 */
4853 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4854 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4855 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4857 "reset", /* VK_OEM_RESET 0xE9 */
4858 "jump", /* VK_OEM_JUMP 0xEA */
4859 "oem-pa1", /* VK_OEM_PA1 0xEB */
4860 "oem-pa2", /* VK_OEM_PA2 0xEC */
4861 "oem-pa3", /* VK_OEM_PA3 0xED */
4862 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4863 "cusel", /* VK_OEM_CUSEL 0xEF */
4864 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4865 "finish", /* VK_OEM_FINISH 0xF1 */
4866 "copy", /* VK_OEM_COPY 0xF2 */
4867 "auto", /* VK_OEM_AUTO 0xF3 */
4868 "enlw", /* VK_OEM_ENLW 0xF4 */
4869 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4870 "attn", /* VK_ATTN 0xF6 */
4871 "crsel", /* VK_CRSEL 0xF7 */
4872 "exsel", /* VK_EXSEL 0xF8 */
4873 "ereof", /* VK_EREOF 0xF9 */
4874 "play", /* VK_PLAY 0xFA */
4875 "zoom", /* VK_ZOOM 0xFB */
4876 "noname", /* VK_NONAME 0xFC */
4877 "pa1", /* VK_PA1 0xFD */
4878 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4882 /* Some of these duplicate the "Media keys" on newer keyboards,
4883 but they are delivered to the application in a different way. */
4884 static const char *const lispy_multimedia_keys
[] =
4892 "browser-favorites",
4929 "toggle-dictate-command",
4935 "media-fast-forward",
4938 "media-channel-down"
4941 #else /* not HAVE_NTGUI */
4943 /* This should be dealt with in XTread_socket now, and that doesn't
4944 depend on the client system having the Kana syms defined. See also
4945 the XK_kana_A case below. */
4948 static const char *const lispy_kana_keys
[] =
4950 /* X Keysym value */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4952 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4955 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4956 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4957 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4958 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4959 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4960 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4961 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4962 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4963 "kana-i", "kana-u", "kana-e", "kana-o",
4964 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4965 "prolongedsound", "kana-A", "kana-I", "kana-U",
4966 "kana-E", "kana-O", "kana-KA", "kana-KI",
4967 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4968 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4969 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4970 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4971 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4972 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4973 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4974 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4975 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4976 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4977 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4978 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4980 #endif /* XK_kana_A */
4983 #define FUNCTION_KEY_OFFSET 0xff00
4985 /* You'll notice that this table is arranged to be conveniently
4986 indexed by X Windows keysym values. */
4987 static const char *const lispy_function_keys
[] =
4989 /* X Keysym value */
4991 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4992 "backspace", "tab", "linefeed", "clear",
4994 0, 0, 0, "pause", /* 0xff10...1f */
4995 0, 0, 0, 0, 0, 0, 0, "escape",
4997 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4998 "romaji", "hiragana", "katakana", "hiragana-katakana",
4999 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5000 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5001 "eisu-toggle", /* 0xff30...3f */
5002 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5003 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5005 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5006 "down", "prior", "next", "end",
5007 "begin", 0, 0, 0, 0, 0, 0, 0,
5008 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5019 "break", /* 0xff6b */
5022 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5023 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5024 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5025 0, 0, 0, 0, 0, 0, 0, 0,
5026 "kp-tab", /* 0xff89 */
5028 "kp-enter", /* 0xff8d */
5030 "kp-f1", /* 0xff91 */
5034 "kp-home", /* 0xff95 */
5039 "kp-prior", /* kp-page-up */
5040 "kp-next", /* kp-page-down */
5046 0, 0, 0, 0, 0, 0, 0, 0, 0,
5047 "kp-multiply", /* 0xffaa */
5052 "kp-divide", /* 0xffaf */
5053 "kp-0", /* 0xffb0 */
5054 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5057 "kp-equal", /* 0xffbd */
5058 "f1", /* 0xffbe */ /* IsFunctionKey */
5060 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5061 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5062 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5063 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5064 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5065 0, 0, 0, 0, 0, 0, 0, 0,
5066 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5067 0, 0, 0, 0, 0, 0, 0, "delete"
5070 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5071 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5073 static const char *const iso_lispy_function_keys
[] =
5075 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5076 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5077 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5078 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5079 "iso-lefttab", /* 0xfe20 */
5080 "iso-move-line-up", "iso-move-line-down",
5081 "iso-partial-line-up", "iso-partial-line-down",
5082 "iso-partial-space-left", "iso-partial-space-right",
5083 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5084 "iso-release-margin-left", "iso-release-margin-right",
5085 "iso-release-both-margins",
5086 "iso-fast-cursor-left", "iso-fast-cursor-right",
5087 "iso-fast-cursor-up", "iso-fast-cursor-down",
5088 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5089 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5092 #endif /* not HAVE_NTGUI */
5094 static Lisp_Object Vlispy_mouse_stem
;
5096 static const char *const lispy_wheel_names
[] =
5098 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5101 /* drag-n-drop events are generated when a set of selected files are
5102 dragged from another application and dropped onto an Emacs window. */
5103 static const char *const lispy_drag_n_drop_names
[] =
5108 /* Scroll bar parts. */
5109 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5110 Lisp_Object Qup
, Qdown
, Qbottom
;
5111 static Lisp_Object Qend_scroll
;
5113 static Lisp_Object Qratio
;
5115 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5116 static Lisp_Object
*const scroll_bar_parts
[] = {
5117 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5118 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5121 /* A vector, indexed by button number, giving the down-going location
5122 of currently depressed buttons, both scroll bar and non-scroll bar.
5124 The elements have the form
5125 (BUTTON-NUMBER MODIFIER-MASK . REST)
5126 where REST is the cdr of a position as it would be reported in the event.
5128 The make_lispy_event function stores positions here to tell the
5129 difference between click and drag events, and to store the starting
5130 location to be included in drag events. */
5132 static Lisp_Object button_down_location
;
5134 /* Information about the most recent up-going button event: Which
5135 button, what location, and what time. */
5137 static int last_mouse_button
;
5138 static int last_mouse_x
;
5139 static int last_mouse_y
;
5140 static Time button_down_time
;
5142 /* The number of clicks in this multiple-click. */
5144 static int double_click_count
;
5146 /* X and Y are frame-relative coordinates for a click or wheel event.
5147 Return a Lisp-style event list. */
5150 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5153 enum window_part part
;
5154 Lisp_Object posn
= Qnil
;
5155 Lisp_Object extra_info
= Qnil
;
5156 /* Coordinate pixel positions to return. */
5157 int xret
= 0, yret
= 0;
5158 /* The window under frame pixel coordinates (x,y) */
5159 Lisp_Object window
= f
5160 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5163 if (WINDOWP (window
))
5165 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5166 struct window
*w
= XWINDOW (window
);
5167 Lisp_Object string_info
= Qnil
;
5168 ptrdiff_t textpos
= -1;
5169 int col
= -1, row
= -1;
5170 int dx
= -1, dy
= -1;
5171 int width
= -1, height
= -1;
5172 Lisp_Object object
= Qnil
;
5174 /* Pixel coordinates relative to the window corner. */
5175 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5176 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5178 /* For text area clicks, return X, Y relative to the corner of
5179 this text area. Note that dX, dY etc are set below, by
5180 buffer_posn_from_coords. */
5181 if (part
== ON_TEXT
)
5183 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5184 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5186 /* For mode line and header line clicks, return X, Y relative to
5187 the left window edge. Use mode_line_string to look for a
5188 string on the click position. */
5189 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5194 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5195 /* Note that mode_line_string takes COL, ROW as pixels and
5196 converts them to characters. */
5199 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5200 &object
, &dx
, &dy
, &width
, &height
);
5201 if (STRINGP (string
))
5202 string_info
= Fcons (string
, make_number (charpos
));
5203 textpos
= (w
== XWINDOW (selected_window
)
5204 && current_buffer
== XBUFFER (w
->buffer
))
5205 ? PT
: XMARKER (w
->pointm
)->charpos
;
5210 /* For fringes and margins, Y is relative to the area's (and the
5211 window's) top edge, while X is meaningless. */
5212 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5217 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5220 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5221 &object
, &dx
, &dy
, &width
, &height
);
5222 if (STRINGP (string
))
5223 string_info
= Fcons (string
, make_number (charpos
));
5224 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5226 else if (part
== ON_LEFT_FRINGE
)
5228 posn
= Qleft_fringe
;
5231 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5232 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5233 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5235 else if (part
== ON_RIGHT_FRINGE
)
5237 posn
= Qright_fringe
;
5240 - window_box_width (w
, LEFT_MARGIN_AREA
)
5241 - window_box_width (w
, TEXT_AREA
)
5242 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5243 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5245 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5247 else if (part
== ON_VERTICAL_BORDER
)
5249 posn
= Qvertical_line
;
5254 /* Nothing special for part == ON_SCROLL_BAR. */
5256 /* For clicks in the text area, fringes, or margins, call
5257 buffer_posn_from_coords to extract TEXTPOS, the buffer
5258 position nearest to the click. */
5261 Lisp_Object string2
, object2
= Qnil
;
5262 struct display_pos p
;
5264 int width2
, height2
;
5265 /* The pixel X coordinate passed to buffer_posn_from_coords
5266 is the X coordinate relative to the text area for
5267 text-area and right-margin clicks, zero otherwise. */
5269 = (part
== ON_TEXT
) ? xret
5270 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5271 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5275 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5276 &object2
, &dx2
, &dy2
,
5278 textpos
= CHARPOS (p
.pos
);
5279 if (col
< 0) col
= x2
;
5280 if (row
< 0) row
= y2
;
5281 if (dx
< 0) dx
= dx2
;
5282 if (dy
< 0) dy
= dy2
;
5283 if (width
< 0) width
= width2
;
5284 if (height
< 0) height
= height2
;
5288 posn
= make_number (textpos
);
5289 if (STRINGP (string2
))
5290 string_info
= Fcons (string2
,
5291 make_number (CHARPOS (p
.string_pos
)));
5297 #ifdef HAVE_WINDOW_SYSTEM
5298 if (IMAGEP (object
))
5300 Lisp_Object image_map
, hotspot
;
5301 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5303 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5305 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5306 posn
= XCAR (hotspot
);
5313 Fcons (make_number (dx
), make_number (dy
)),
5314 Fcons (make_number (width
), make_number (height
)));
5317 extra_info
= Fcons (string_info
,
5318 Fcons (make_number (textpos
),
5319 Fcons (Fcons (make_number (col
),
5324 XSETFRAME (window
, f
);
5328 return Fcons (window
,
5330 Fcons (Fcons (make_number (xret
),
5331 make_number (yret
)),
5332 Fcons (make_number (t
),
5336 /* Given a struct input_event, build the lisp event which represents
5337 it. If EVENT is 0, build a mouse movement event from the mouse
5338 movement buffer, which should have a movement event in it.
5340 Note that events must be passed to this function in the order they
5341 are received; this function stores the location of button presses
5342 in order to build drag events when the button is released. */
5345 make_lispy_event (struct input_event
*event
)
5349 switch (SWITCH_ENUM_CAST (event
->kind
))
5351 /* A simple keystroke. */
5352 case ASCII_KEYSTROKE_EVENT
:
5353 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5355 Lisp_Object lispy_c
;
5356 EMACS_INT c
= event
->code
;
5357 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5360 eassert (c
== event
->code
);
5361 /* Turn ASCII characters into control characters
5363 if (event
->modifiers
& ctrl_modifier
)
5365 c
= make_ctrl_char (c
);
5366 event
->modifiers
&= ~ctrl_modifier
;
5370 /* Add in the other modifier bits. The shift key was taken care
5371 of by the X code. */
5372 c
|= (event
->modifiers
5373 & (meta_modifier
| alt_modifier
5374 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5375 /* Distinguish Shift-SPC from SPC. */
5376 if ((event
->code
) == 040
5377 && event
->modifiers
& shift_modifier
)
5378 c
|= shift_modifier
;
5379 button_down_time
= 0;
5380 XSETFASTINT (lispy_c
, c
);
5385 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5386 except that they are non-key events (last-nonmenu-event is nil). */
5387 case NS_NONKEY_EVENT
:
5390 /* A function key. The symbol may need to have modifier prefixes
5392 case NON_ASCII_KEYSTROKE_EVENT
:
5393 button_down_time
= 0;
5395 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5396 if (event
->code
== lispy_accent_codes
[i
])
5397 return modify_event_symbol (i
,
5399 Qfunction_key
, Qnil
,
5400 lispy_accent_keys
, &accent_key_syms
,
5401 (sizeof (lispy_accent_keys
)
5402 / sizeof (lispy_accent_keys
[0])));
5406 if (event
->code
>= 0x400 && event
->code
< 0x500)
5407 return modify_event_symbol (event
->code
- 0x400,
5408 event
->modifiers
& ~shift_modifier
,
5409 Qfunction_key
, Qnil
,
5410 lispy_kana_keys
, &func_key_syms
,
5411 (sizeof (lispy_kana_keys
)
5412 / sizeof (lispy_kana_keys
[0])));
5413 #endif /* XK_kana_A */
5416 #ifdef ISO_FUNCTION_KEY_OFFSET
5417 if (event
->code
< FUNCTION_KEY_OFFSET
5418 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5419 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5421 Qfunction_key
, Qnil
,
5422 iso_lispy_function_keys
, &func_key_syms
,
5423 (sizeof (iso_lispy_function_keys
)
5424 / sizeof (iso_lispy_function_keys
[0])));
5427 /* Handle system-specific or unknown keysyms. */
5428 if (event
->code
& (1 << 28)
5429 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5430 || (event
->code
- FUNCTION_KEY_OFFSET
5431 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5432 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5434 /* We need to use an alist rather than a vector as the cache
5435 since we can't make a vector long enough. */
5436 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5437 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5438 return modify_event_symbol (event
->code
,
5441 KVAR (current_kboard
, Vsystem_key_alist
),
5442 0, &KVAR (current_kboard
, system_key_syms
),
5446 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5448 Qfunction_key
, Qnil
,
5449 lispy_function_keys
, &func_key_syms
,
5450 (sizeof (lispy_function_keys
)
5451 / sizeof (lispy_function_keys
[0])));
5454 case MULTIMEDIA_KEY_EVENT
:
5455 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5456 / sizeof (lispy_multimedia_keys
[0]))
5457 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5459 return modify_event_symbol (event
->code
, event
->modifiers
,
5460 Qfunction_key
, Qnil
,
5461 lispy_multimedia_keys
, &func_key_syms
,
5462 (sizeof (lispy_multimedia_keys
)
5463 / sizeof (lispy_multimedia_keys
[0])));
5469 /* A mouse click. Figure out where it is, decide whether it's
5470 a press, click or drag, and build the appropriate structure. */
5471 case MOUSE_CLICK_EVENT
:
5472 #ifndef USE_TOOLKIT_SCROLL_BARS
5473 case SCROLL_BAR_CLICK_EVENT
:
5476 int button
= event
->code
;
5478 Lisp_Object position
;
5479 Lisp_Object
*start_pos_ptr
;
5480 Lisp_Object start_pos
;
5484 /* Build the position as appropriate for this mouse click. */
5485 if (event
->kind
== MOUSE_CLICK_EVENT
)
5487 struct frame
*f
= XFRAME (event
->frame_or_window
);
5488 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5492 /* Ignore mouse events that were made on frame that
5493 have been deleted. */
5494 if (! FRAME_LIVE_P (f
))
5497 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5498 /* EVENT->x and EVENT->y are frame-relative pixel
5499 coordinates at this place. Under old redisplay, COLUMN
5500 and ROW are set to frame relative glyph coordinates
5501 which are then used to determine whether this click is
5502 in a menu (non-toolkit version). */
5503 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5504 &column
, &row
, NULL
, 1);
5506 /* In the non-toolkit version, clicks on the menu bar
5507 are ordinary button events in the event buffer.
5508 Distinguish them, and invoke the menu.
5510 (In the toolkit version, the toolkit handles the menu bar
5511 and Emacs doesn't know about it until after the user
5512 makes a selection.) */
5513 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5514 && (event
->modifiers
& down_modifier
))
5516 Lisp_Object items
, item
;
5518 /* Find the menu bar item under `column'. */
5520 items
= FRAME_MENU_BAR_ITEMS (f
);
5521 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5523 Lisp_Object pos
, string
;
5524 string
= AREF (items
, i
+ 1);
5525 pos
= AREF (items
, i
+ 3);
5528 if (column
>= XINT (pos
)
5529 && column
< XINT (pos
) + SCHARS (string
))
5531 item
= AREF (items
, i
);
5536 /* ELisp manual 2.4b says (x y) are window relative but
5537 code says they are frame-relative. */
5539 = Fcons (event
->frame_or_window
,
5541 Fcons (Fcons (event
->x
, event
->y
),
5542 Fcons (make_number (event
->timestamp
),
5545 return Fcons (item
, Fcons (position
, Qnil
));
5547 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5549 position
= make_lispy_position (f
, event
->x
, event
->y
,
5552 #ifndef USE_TOOLKIT_SCROLL_BARS
5555 /* It's a scrollbar click. */
5557 Lisp_Object portion_whole
;
5560 window
= event
->frame_or_window
;
5561 portion_whole
= Fcons (event
->x
, event
->y
);
5562 part
= *scroll_bar_parts
[(int) event
->part
];
5566 Fcons (Qvertical_scroll_bar
,
5567 Fcons (portion_whole
,
5568 Fcons (make_number (event
->timestamp
),
5569 Fcons (part
, Qnil
)))));
5571 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5573 if (button
>= ASIZE (button_down_location
))
5575 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5576 button_down_location
= larger_vector (button_down_location
,
5578 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5581 start_pos_ptr
= &AREF (button_down_location
, button
);
5582 start_pos
= *start_pos_ptr
;
5583 *start_pos_ptr
= Qnil
;
5586 /* On window-system frames, use the value of
5587 double-click-fuzz as is. On other frames, interpret it
5588 as a multiple of 1/8 characters. */
5592 if (WINDOWP (event
->frame_or_window
))
5593 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5594 else if (FRAMEP (event
->frame_or_window
))
5595 f
= XFRAME (event
->frame_or_window
);
5599 if (FRAME_WINDOW_P (f
))
5600 fuzz
= double_click_fuzz
;
5602 fuzz
= double_click_fuzz
/ 8;
5604 is_double
= (button
== last_mouse_button
5605 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5606 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5607 && button_down_time
!= 0
5608 && (EQ (Vdouble_click_time
, Qt
)
5609 || (NATNUMP (Vdouble_click_time
)
5610 && (event
->timestamp
- button_down_time
5611 < XFASTINT (Vdouble_click_time
)))));
5614 last_mouse_button
= button
;
5615 last_mouse_x
= XINT (event
->x
);
5616 last_mouse_y
= XINT (event
->y
);
5618 /* If this is a button press, squirrel away the location, so
5619 we can decide later whether it was a click or a drag. */
5620 if (event
->modifiers
& down_modifier
)
5624 double_click_count
++;
5625 event
->modifiers
|= ((double_click_count
> 2)
5630 double_click_count
= 1;
5631 button_down_time
= event
->timestamp
;
5632 *start_pos_ptr
= Fcopy_alist (position
);
5633 ignore_mouse_drag_p
= 0;
5636 /* Now we're releasing a button - check the co-ordinates to
5637 see if this was a click or a drag. */
5638 else if (event
->modifiers
& up_modifier
)
5640 /* If we did not see a down before this up, ignore the up.
5641 Probably this happened because the down event chose a
5642 menu item. It would be an annoyance to treat the
5643 release of the button that chose the menu item as a
5646 if (!CONSP (start_pos
))
5649 event
->modifiers
&= ~up_modifier
;
5652 Lisp_Object new_down
, down
;
5653 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5655 /* The third element of every position
5656 should be the (x,y) pair. */
5657 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5658 new_down
= Fcar (Fcdr (Fcdr (position
)));
5661 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5663 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5664 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5667 if (ignore_mouse_drag_p
)
5669 event
->modifiers
|= click_modifier
;
5670 ignore_mouse_drag_p
= 0;
5672 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5673 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5674 /* Maybe the mouse has moved a lot, caused scrolling, and
5675 eventually ended up at the same screen position (but
5676 not buffer position) in which case it is a drag, not
5678 /* FIXME: OTOH if the buffer position has changed
5679 because of a timer or process filter rather than
5680 because of mouse movement, it should be considered as
5681 a click. But mouse-drag-region completely ignores
5682 this case and it hasn't caused any real problem, so
5683 it's probably OK to ignore it as well. */
5684 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5685 /* Mouse hasn't moved (much). */
5686 event
->modifiers
|= click_modifier
;
5689 button_down_time
= 0;
5690 event
->modifiers
|= drag_modifier
;
5693 /* Don't check is_double; treat this as multiple
5694 if the down-event was multiple. */
5695 if (double_click_count
> 1)
5696 event
->modifiers
|= ((double_click_count
> 2)
5702 /* Every mouse event should either have the down_modifier or
5703 the up_modifier set. */
5707 /* Get the symbol we should use for the mouse click. */
5710 head
= modify_event_symbol (button
,
5712 Qmouse_click
, Vlispy_mouse_stem
,
5715 ASIZE (mouse_syms
));
5716 if (event
->modifiers
& drag_modifier
)
5721 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5724 Fcons (make_number (double_click_count
),
5734 case HORIZ_WHEEL_EVENT
:
5736 Lisp_Object position
;
5739 /* Build the position as appropriate for this mouse click. */
5740 struct frame
*f
= XFRAME (event
->frame_or_window
);
5742 /* Ignore wheel events that were made on frame that have been
5744 if (! FRAME_LIVE_P (f
))
5747 position
= make_lispy_position (f
, event
->x
, event
->y
,
5750 /* Set double or triple modifiers to indicate the wheel speed. */
5752 /* On window-system frames, use the value of
5753 double-click-fuzz as is. On other frames, interpret it
5754 as a multiple of 1/8 characters. */
5760 if (WINDOWP (event
->frame_or_window
))
5761 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5762 else if (FRAMEP (event
->frame_or_window
))
5763 fr
= XFRAME (event
->frame_or_window
);
5767 fuzz
= FRAME_WINDOW_P (fr
)
5768 ? double_click_fuzz
: double_click_fuzz
/ 8;
5770 if (event
->modifiers
& up_modifier
)
5772 /* Emit a wheel-up event. */
5773 event
->modifiers
&= ~up_modifier
;
5776 else if (event
->modifiers
& down_modifier
)
5778 /* Emit a wheel-down event. */
5779 event
->modifiers
&= ~down_modifier
;
5783 /* Every wheel event should either have the down_modifier or
5784 the up_modifier set. */
5787 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5790 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5791 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5792 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5793 && button_down_time
!= 0
5794 && (EQ (Vdouble_click_time
, Qt
)
5795 || (NATNUMP (Vdouble_click_time
)
5796 && (event
->timestamp
- button_down_time
5797 < XFASTINT (Vdouble_click_time
)))));
5800 double_click_count
++;
5801 event
->modifiers
|= ((double_click_count
> 2)
5807 double_click_count
= 1;
5808 event
->modifiers
|= click_modifier
;
5811 button_down_time
= event
->timestamp
;
5812 /* Use a negative value to distinguish wheel from mouse button. */
5813 last_mouse_button
= - (1 + symbol_num
);
5814 last_mouse_x
= XINT (event
->x
);
5815 last_mouse_y
= XINT (event
->y
);
5817 /* Get the symbol we should use for the wheel event. */
5818 head
= modify_event_symbol (symbol_num
,
5824 ASIZE (wheel_syms
));
5827 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5830 Fcons (make_number (double_click_count
),
5839 #ifdef USE_TOOLKIT_SCROLL_BARS
5841 /* We don't have down and up events if using toolkit scroll bars,
5842 so make this always a click event. Store in the `part' of
5843 the Lisp event a symbol which maps to the following actions:
5845 `above_handle' page up
5846 `below_handle' page down
5850 `bottom' bottom of buffer
5851 `handle' thumb has been dragged.
5852 `end-scroll' end of interaction with scroll bar
5854 The incoming input_event contains in its `part' member an
5855 index of type `enum scroll_bar_part' which we can use as an
5856 index in scroll_bar_parts to get the appropriate symbol. */
5858 case SCROLL_BAR_CLICK_EVENT
:
5860 Lisp_Object position
, head
, window
, portion_whole
, part
;
5862 window
= event
->frame_or_window
;
5863 portion_whole
= Fcons (event
->x
, event
->y
);
5864 part
= *scroll_bar_parts
[(int) event
->part
];
5868 Fcons (Qvertical_scroll_bar
,
5869 Fcons (portion_whole
,
5870 Fcons (make_number (event
->timestamp
),
5871 Fcons (part
, Qnil
)))));
5873 /* Always treat scroll bar events as clicks. */
5874 event
->modifiers
|= click_modifier
;
5875 event
->modifiers
&= ~up_modifier
;
5877 if (event
->code
>= ASIZE (mouse_syms
))
5878 mouse_syms
= larger_vector (mouse_syms
,
5879 event
->code
- ASIZE (mouse_syms
) + 1,
5882 /* Get the symbol we should use for the mouse click. */
5883 head
= modify_event_symbol (event
->code
,
5888 ASIZE (mouse_syms
));
5889 return Fcons (head
, Fcons (position
, Qnil
));
5892 #endif /* USE_TOOLKIT_SCROLL_BARS */
5894 case DRAG_N_DROP_EVENT
:
5897 Lisp_Object head
, position
;
5900 f
= XFRAME (event
->frame_or_window
);
5903 /* Ignore mouse events that were made on frames that
5904 have been deleted. */
5905 if (! FRAME_LIVE_P (f
))
5908 position
= make_lispy_position (f
, event
->x
, event
->y
,
5911 head
= modify_event_symbol (0, event
->modifiers
,
5913 lispy_drag_n_drop_names
,
5914 &drag_n_drop_syms
, 1);
5920 #endif /* HAVE_MOUSE */
5922 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5923 || defined (HAVE_NS) || defined (USE_GTK)
5924 case MENU_BAR_EVENT
:
5925 if (EQ (event
->arg
, event
->frame_or_window
))
5926 /* This is the prefix key. We translate this to
5927 `(menu_bar)' because the code in keyboard.c for menu
5928 events, which we use, relies on this. */
5929 return Fcons (Qmenu_bar
, Qnil
);
5933 case SELECT_WINDOW_EVENT
:
5934 /* Make an event (select-window (WINDOW)). */
5935 return Fcons (Qselect_window
,
5936 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5939 case TOOL_BAR_EVENT
:
5940 if (EQ (event
->arg
, event
->frame_or_window
))
5941 /* This is the prefix key. We translate this to
5942 `(tool_bar)' because the code in keyboard.c for tool bar
5943 events, which we use, relies on this. */
5944 return Fcons (Qtool_bar
, Qnil
);
5945 else if (SYMBOLP (event
->arg
))
5946 return apply_modifiers (event
->modifiers
, event
->arg
);
5949 case USER_SIGNAL_EVENT
:
5950 /* A user signal. */
5952 char *name
= find_user_signal_name (event
->code
);
5955 return intern (name
);
5958 case SAVE_SESSION_EVENT
:
5959 return Qsave_session
;
5964 return Fcons (Qdbus_event
, event
->arg
);
5966 #endif /* HAVE_DBUS */
5968 case CONFIG_CHANGED_EVENT
:
5969 return Fcons (Qconfig_changed_event
,
5971 Fcons (event
->frame_or_window
, Qnil
)));
5973 case GPM_CLICK_EVENT
:
5975 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5976 Lisp_Object head
, position
;
5977 Lisp_Object
*start_pos_ptr
;
5978 Lisp_Object start_pos
;
5979 int button
= event
->code
;
5981 if (button
>= ASIZE (button_down_location
))
5983 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5984 button_down_location
= larger_vector (button_down_location
,
5986 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5989 start_pos_ptr
= &AREF (button_down_location
, button
);
5990 start_pos
= *start_pos_ptr
;
5992 position
= make_lispy_position (f
, event
->x
, event
->y
,
5995 if (event
->modifiers
& down_modifier
)
5996 *start_pos_ptr
= Fcopy_alist (position
);
5997 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5999 if (!CONSP (start_pos
))
6001 event
->modifiers
&= ~up_modifier
;
6004 head
= modify_event_symbol (button
,
6006 Qmouse_click
, Vlispy_mouse_stem
,
6009 ASIZE (mouse_syms
));
6011 if (event
->modifiers
& drag_modifier
)
6016 else if (event
->modifiers
& double_modifier
)
6019 Fcons (make_number (2),
6021 else if (event
->modifiers
& triple_modifier
)
6024 Fcons (make_number (3),
6031 #endif /* HAVE_GPM */
6033 /* The 'kind' field of the event is something we don't recognize. */
6039 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6042 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6043 Lisp_Object x
, Lisp_Object y
, Time t
)
6045 /* Is it a scroll bar movement? */
6046 if (frame
&& ! NILP (bar_window
))
6048 Lisp_Object part_sym
;
6050 part_sym
= *scroll_bar_parts
[(int) part
];
6051 return Fcons (Qscroll_bar_movement
,
6052 Fcons (list5 (bar_window
,
6053 Qvertical_scroll_bar
,
6059 /* Or is it an ordinary mouse movement? */
6062 Lisp_Object position
;
6063 position
= make_lispy_position (frame
, x
, y
, t
);
6064 return list2 (Qmouse_movement
, position
);
6068 #endif /* HAVE_MOUSE || HAVE GPM */
6070 /* Construct a switch frame event. */
6072 make_lispy_switch_frame (Lisp_Object frame
)
6074 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6077 /* Manipulating modifiers. */
6079 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6081 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6082 SYMBOL's name of the end of the modifiers; the string from this
6083 position is the unmodified symbol name.
6085 This doesn't use any caches. */
6088 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6094 CHECK_SYMBOL (symbol
);
6097 name
= SYMBOL_NAME (symbol
);
6099 for (i
= 0; i
< SBYTES (name
) - 1; )
6101 ptrdiff_t this_mod_end
= 0;
6104 /* See if the name continues with a modifier word.
6105 Check that the word appears, but don't check what follows it.
6106 Set this_mod and this_mod_end to record what we find. */
6108 switch (SREF (name
, i
))
6110 #define SINGLE_LETTER_MOD(BIT) \
6111 (this_mod_end = i + 1, this_mod = BIT)
6114 SINGLE_LETTER_MOD (alt_modifier
);
6118 SINGLE_LETTER_MOD (ctrl_modifier
);
6122 SINGLE_LETTER_MOD (hyper_modifier
);
6126 SINGLE_LETTER_MOD (meta_modifier
);
6130 SINGLE_LETTER_MOD (shift_modifier
);
6134 SINGLE_LETTER_MOD (super_modifier
);
6137 #undef SINGLE_LETTER_MOD
6139 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6140 if (i + LEN + 1 <= SBYTES (name) \
6141 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6143 this_mod_end = i + LEN; \
6148 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6149 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6150 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6154 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6156 #undef MULTI_LETTER_MOD
6160 /* If we found no modifier, stop looking for them. */
6161 if (this_mod_end
== 0)
6164 /* Check there is a dash after the modifier, so that it
6165 really is a modifier. */
6166 if (this_mod_end
>= SBYTES (name
)
6167 || SREF (name
, this_mod_end
) != '-')
6170 /* This modifier is real; look for another. */
6171 modifiers
|= this_mod
;
6172 i
= this_mod_end
+ 1;
6175 /* Should we include the `click' modifier? */
6176 if (! (modifiers
& (down_modifier
| drag_modifier
6177 | double_modifier
| triple_modifier
))
6178 && i
+ 7 == SBYTES (name
)
6179 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6180 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6181 modifiers
|= click_modifier
;
6183 if (! (modifiers
& (double_modifier
| triple_modifier
))
6184 && i
+ 6 < SBYTES (name
)
6185 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6186 modifiers
|= click_modifier
;
6194 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6195 prepended to the string BASE[0..BASE_LEN-1].
6196 This doesn't use any caches. */
6198 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6200 /* Since BASE could contain nulls, we can't use intern here; we have
6201 to use Fintern, which expects a genuine Lisp_String, and keeps a
6204 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6210 /* Only the event queue may use the `up' modifier; it should always
6211 be turned into a click or drag event before presented to lisp code. */
6212 if (modifiers
& up_modifier
)
6215 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6216 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6217 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6218 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6219 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6220 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6221 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6222 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6223 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6224 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6225 /* The click modifier is denoted by the absence of other modifiers. */
6229 mod_len
= p
- new_mods
;
6233 Lisp_Object new_name
;
6235 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6236 mod_len
+ base_len_byte
);
6237 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6238 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6240 return Fintern (new_name
, Qnil
);
6245 static const char *const modifier_names
[] =
6247 "up", "down", "drag", "click", "double", "triple", 0, 0,
6248 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6249 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6251 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6253 static Lisp_Object modifier_symbols
;
6255 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6257 lispy_modifier_list (int modifiers
)
6259 Lisp_Object modifier_list
;
6262 modifier_list
= Qnil
;
6263 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6264 if (modifiers
& (1<<i
))
6265 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6268 return modifier_list
;
6272 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6273 where UNMODIFIED is the unmodified form of SYMBOL,
6274 MASK is the set of modifiers present in SYMBOL's name.
6275 This is similar to parse_modifiers_uncached, but uses the cache in
6276 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6277 Qevent_symbol_elements property. */
6279 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6282 parse_modifiers (Lisp_Object symbol
)
6284 Lisp_Object elements
;
6286 if (INTEGERP (symbol
))
6287 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6288 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6290 else if (!SYMBOLP (symbol
))
6293 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6294 if (CONSP (elements
))
6299 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6300 Lisp_Object unmodified
;
6303 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6304 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6307 if (modifiers
& ~INTMASK
)
6309 XSETFASTINT (mask
, modifiers
);
6310 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6312 /* Cache the parsing results on SYMBOL. */
6313 Fput (symbol
, Qevent_symbol_element_mask
,
6315 Fput (symbol
, Qevent_symbol_elements
,
6316 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6318 /* Since we know that SYMBOL is modifiers applied to unmodified,
6319 it would be nice to put that in unmodified's cache.
6320 But we can't, since we're not sure that parse_modifiers is
6327 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6328 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6329 doc
: /* Parse the event symbol. For internal use. */)
6330 (Lisp_Object symbol
)
6332 /* Fill the cache if needed. */
6333 parse_modifiers (symbol
);
6334 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6335 and use the Lispier representation stored on Qevent_symbol_elements
6337 return Fget (symbol
, Qevent_symbol_elements
);
6340 /* Apply the modifiers MODIFIERS to the symbol BASE.
6341 BASE must be unmodified.
6343 This is like apply_modifiers_uncached, but uses BASE's
6344 Qmodifier_cache property, if present. It also builds
6345 Qevent_symbol_elements properties, since it has that info anyway.
6347 apply_modifiers copies the value of BASE's Qevent_kind property to
6348 the modified symbol. */
6350 apply_modifiers (int modifiers
, Lisp_Object base
)
6352 Lisp_Object cache
, idx
, entry
, new_symbol
;
6354 /* Mask out upper bits. We don't know where this value's been. */
6355 modifiers
&= INTMASK
;
6357 if (INTEGERP (base
))
6358 return make_number (XINT (base
) | modifiers
);
6360 /* The click modifier never figures into cache indices. */
6361 cache
= Fget (base
, Qmodifier_cache
);
6362 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6363 entry
= assq_no_quit (idx
, cache
);
6366 new_symbol
= XCDR (entry
);
6369 /* We have to create the symbol ourselves. */
6370 new_symbol
= apply_modifiers_uncached (modifiers
,
6371 SSDATA (SYMBOL_NAME (base
)),
6372 SCHARS (SYMBOL_NAME (base
)),
6373 SBYTES (SYMBOL_NAME (base
)));
6375 /* Add the new symbol to the base's cache. */
6376 entry
= Fcons (idx
, new_symbol
);
6377 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6379 /* We have the parsing info now for free, so we could add it to
6381 XSETFASTINT (idx, modifiers);
6382 Fput (new_symbol, Qevent_symbol_element_mask,
6383 Fcons (base, Fcons (idx, Qnil)));
6384 Fput (new_symbol, Qevent_symbol_elements,
6385 Fcons (base, lispy_modifier_list (modifiers)));
6386 Sadly, this is only correct if `base' is indeed a base event,
6387 which is not necessarily the case. -stef */
6390 /* Make sure this symbol is of the same kind as BASE.
6392 You'd think we could just set this once and for all when we
6393 intern the symbol above, but reorder_modifiers may call us when
6394 BASE's property isn't set right; we can't assume that just
6395 because it has a Qmodifier_cache property it must have its
6396 Qevent_kind set right as well. */
6397 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6401 kind
= Fget (base
, Qevent_kind
);
6403 Fput (new_symbol
, Qevent_kind
, kind
);
6410 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6411 return a symbol with the modifiers placed in the canonical order.
6412 Canonical order is alphabetical, except for down and drag, which
6413 always come last. The 'click' modifier is never written out.
6415 Fdefine_key calls this to make sure that (for example) C-M-foo
6416 and M-C-foo end up being equivalent in the keymap. */
6419 reorder_modifiers (Lisp_Object symbol
)
6421 /* It's hopefully okay to write the code this way, since everything
6422 will soon be in caches, and no consing will be done at all. */
6425 parsed
= parse_modifiers (symbol
);
6426 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6431 /* For handling events, we often want to produce a symbol whose name
6432 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6433 to some base, like the name of a function key or mouse button.
6434 modify_event_symbol produces symbols of this sort.
6436 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6437 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6440 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6441 into symbol names, or a string specifying a name stem used to
6442 construct a symbol name or the form `STEM-N', where N is the decimal
6443 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6444 non-nil; otherwise NAME_TABLE is used.
6446 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6447 persist between calls to modify_event_symbol that it can use to
6448 store a cache of the symbols it's generated for this NAME_TABLE
6449 before. The object stored there may be a vector or an alist.
6451 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6453 MODIFIERS is a set of modifier bits (as given in struct input_events)
6454 whose prefixes should be applied to the symbol name.
6456 SYMBOL_KIND is the value to be placed in the event_kind property of
6457 the returned symbol.
6459 The symbols we create are supposed to have an
6460 `event-symbol-elements' property, which lists the modifiers present
6461 in the symbol's name. */
6464 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6465 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6466 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6469 Lisp_Object symbol_int
;
6471 /* Get rid of the "vendor-specific" bit here. */
6472 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6474 /* Is this a request for a valid symbol? */
6475 if (symbol_num
< 0 || symbol_num
>= table_size
)
6478 if (CONSP (*symbol_table
))
6479 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6481 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6482 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6483 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6484 we've never used that symbol before. */
6487 if (! VECTORP (*symbol_table
)
6488 || ASIZE (*symbol_table
) != table_size
)
6492 XSETFASTINT (size
, table_size
);
6493 *symbol_table
= Fmake_vector (size
, Qnil
);
6496 value
= AREF (*symbol_table
, symbol_num
);
6499 /* Have we already used this symbol before? */
6502 /* No; let's create it. */
6503 if (CONSP (name_alist_or_stem
))
6504 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6505 else if (STRINGP (name_alist_or_stem
))
6508 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6509 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6511 SAFE_ALLOCA (buf
, char *, len
);
6512 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6513 XINT (symbol_int
) + 1);
6514 value
= intern (buf
);
6517 else if (name_table
!= 0 && name_table
[symbol_num
])
6518 value
= intern (name_table
[symbol_num
]);
6520 #ifdef HAVE_WINDOW_SYSTEM
6523 char *name
= x_get_keysym_name (symbol_num
);
6525 value
= intern (name
);
6531 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6532 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6533 value
= intern (buf
);
6536 if (CONSP (*symbol_table
))
6537 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6539 ASET (*symbol_table
, symbol_num
, value
);
6541 /* Fill in the cache entries for this symbol; this also
6542 builds the Qevent_symbol_elements property, which the user
6544 apply_modifiers (modifiers
& click_modifier
, value
);
6545 Fput (value
, Qevent_kind
, symbol_kind
);
6548 /* Apply modifiers to that symbol. */
6549 return apply_modifiers (modifiers
, value
);
6552 /* Convert a list that represents an event type,
6553 such as (ctrl meta backspace), into the usual representation of that
6554 event type as a number or a symbol. */
6556 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6557 doc
: /* Convert the event description list EVENT-DESC to an event type.
6558 EVENT-DESC should contain one base event type (a character or symbol)
6559 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6560 drag, down, double or triple). The base must be last.
6561 The return value is an event type (a character or symbol) which
6562 has the same base event type and all the specified modifiers. */)
6563 (Lisp_Object event_desc
)
6571 while (CONSP (rest
))
6579 /* Given a symbol, see if it is a modifier name. */
6580 if (SYMBOLP (elt
) && CONSP (rest
))
6581 this = parse_solitary_modifier (elt
);
6585 else if (!NILP (base
))
6586 error ("Two bases given in one event");
6592 /* Let the symbol A refer to the character A. */
6593 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6594 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6596 if (INTEGERP (base
))
6598 /* Turn (shift a) into A. */
6599 if ((modifiers
& shift_modifier
) != 0
6600 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6602 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6603 modifiers
&= ~shift_modifier
;
6606 /* Turn (control a) into C-a. */
6607 if (modifiers
& ctrl_modifier
)
6608 return make_number ((modifiers
& ~ctrl_modifier
)
6609 | make_ctrl_char (XINT (base
)));
6611 return make_number (modifiers
| XINT (base
));
6613 else if (SYMBOLP (base
))
6614 return apply_modifiers (modifiers
, base
);
6617 error ("Invalid base event");
6622 /* Try to recognize SYMBOL as a modifier name.
6623 Return the modifier flag bit, or 0 if not recognized. */
6626 parse_solitary_modifier (Lisp_Object symbol
)
6628 Lisp_Object name
= SYMBOL_NAME (symbol
);
6630 switch (SREF (name
, 0))
6632 #define SINGLE_LETTER_MOD(BIT) \
6633 if (SBYTES (name) == 1) \
6636 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6637 if (LEN == SBYTES (name) \
6638 && ! strncmp (SSDATA (name), NAME, LEN)) \
6642 SINGLE_LETTER_MOD (alt_modifier
);
6646 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6650 SINGLE_LETTER_MOD (ctrl_modifier
);
6654 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6655 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6659 SINGLE_LETTER_MOD (hyper_modifier
);
6663 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6667 SINGLE_LETTER_MOD (meta_modifier
);
6671 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6675 SINGLE_LETTER_MOD (shift_modifier
);
6679 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6680 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6681 SINGLE_LETTER_MOD (super_modifier
);
6685 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6686 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6687 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6691 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6694 #undef SINGLE_LETTER_MOD
6695 #undef MULTI_LETTER_MOD
6701 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6702 Such a list is not valid as an event,
6703 but it can be a Lucid-style event type list. */
6706 lucid_event_type_list_p (Lisp_Object object
)
6710 if (! CONSP (object
))
6713 if (EQ (XCAR (object
), Qhelp_echo
)
6714 || EQ (XCAR (object
), Qvertical_line
)
6715 || EQ (XCAR (object
), Qmode_line
)
6716 || EQ (XCAR (object
), Qheader_line
))
6719 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6723 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6730 /* Store into *addr a value nonzero if terminal input chars are available.
6731 Serves the purpose of ioctl (0, FIONREAD, addr)
6732 but works even if FIONREAD does not exist.
6733 (In fact, this may actually read some input.)
6735 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6736 timer events that are ripe.
6737 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6738 events (FOCUS_IN_EVENT).
6739 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6740 movements and toolkit scroll bar thumb drags. */
6743 get_input_pending (int *addr
, int flags
)
6745 /* First of all, have we already counted some input? */
6746 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6748 /* If input is being read as it arrives, and we have none, there is none. */
6749 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6752 /* Try to read some input and see how much we get. */
6754 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6757 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6760 gobble_input (int expected
)
6763 if (interrupt_input
)
6766 mask
= sigblock (sigmask (SIGIO
));
6767 read_avail_input (expected
);
6771 #ifdef POLL_FOR_INPUT
6772 /* XXX This condition was (read_socket_hook && !interrupt_input),
6773 but read_socket_hook is not global anymore. Let's pretend that
6775 if (!interrupt_input
&& poll_suppress_count
== 0)
6778 mask
= sigblock (sigmask (SIGALRM
));
6779 read_avail_input (expected
);
6785 read_avail_input (expected
);
6788 /* Put a BUFFER_SWITCH_EVENT in the buffer
6789 so that read_key_sequence will notice the new current buffer. */
6792 record_asynch_buffer_change (void)
6794 struct input_event event
;
6798 event
.kind
= BUFFER_SWITCH_EVENT
;
6799 event
.frame_or_window
= Qnil
;
6802 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6803 The purpose of the event is to make read_key_sequence look up the
6804 keymaps again. If we aren't in read_key_sequence, we don't need one,
6805 and the event could cause trouble by messing up (input-pending-p).
6806 Note: Fwaiting_for_user_input_p always returns nil when async
6807 subprocesses aren't supported. */
6808 tem
= Fwaiting_for_user_input_p ();
6812 /* Make sure no interrupt happens while storing the event. */
6814 if (interrupt_input
)
6817 mask
= sigblock (sigmask (SIGIO
));
6818 kbd_buffer_store_event (&event
);
6825 kbd_buffer_store_event (&event
);
6830 /* Read any terminal input already buffered up by the system
6831 into the kbd_buffer, but do not wait.
6833 EXPECTED should be nonzero if the caller knows there is some input.
6835 Returns the number of keyboard chars read, or -1 meaning
6836 this is a bad time to try to read input. */
6839 read_avail_input (int expected
)
6845 /* Store pending user signal events, if any. */
6846 if (store_user_signal_events ())
6849 /* Loop through the available terminals, and call their input hooks. */
6853 struct terminal
*next
= t
->next_terminal
;
6855 if (t
->read_socket_hook
)
6858 struct input_event hold_quit
;
6860 EVENT_INIT (hold_quit
);
6861 hold_quit
.kind
= NO_EVENT
;
6863 /* No need for FIONREAD or fcntl; just say don't wait. */
6864 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6870 if (nr
== -1) /* Not OK to read input now. */
6874 else if (nr
== -2) /* Non-transient error. */
6876 /* The terminal device terminated; it should be closed. */
6878 /* Kill Emacs if this was our last terminal. */
6879 if (!terminal_list
->next_terminal
)
6880 /* Formerly simply reported no input, but that
6881 sometimes led to a failure of Emacs to terminate.
6882 SIGHUP seems appropriate if we can't reach the
6884 /* ??? Is it really right to send the signal just to
6885 this process rather than to the whole process
6886 group? Perhaps on systems with FIONREAD Emacs is
6887 alone in its group. */
6888 kill (getpid (), SIGHUP
);
6890 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6893 XSETTERMINAL (tmp
, t
);
6894 Fdelete_terminal (tmp
, Qnoelisp
);
6898 if (hold_quit
.kind
!= NO_EVENT
)
6899 kbd_buffer_store_event (&hold_quit
);
6908 frame_make_pointer_visible ();
6914 decode_keyboard_code (struct tty_display_info
*tty
,
6915 struct coding_system
*coding
,
6916 unsigned char *buf
, int nbytes
)
6918 unsigned char *src
= buf
;
6919 const unsigned char *p
;
6924 if (tty
->meta_key
!= 2)
6925 for (i
= 0; i
< nbytes
; i
++)
6927 if (coding
->carryover_bytes
> 0)
6929 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6930 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6931 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6932 nbytes
+= coding
->carryover_bytes
;
6934 coding
->destination
= alloca (nbytes
* 4);
6935 coding
->dst_bytes
= nbytes
* 4;
6936 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6937 if (coding
->produced_char
== 0)
6939 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6941 struct input_event event_buf
;
6943 EVENT_INIT (event_buf
);
6944 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6946 (ASCII_CHAR_P (event_buf
.code
)
6947 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6948 /* See the comment in tty_read_avail_input. */
6949 event_buf
.frame_or_window
= tty
->top_frame
;
6950 event_buf
.arg
= Qnil
;
6951 kbd_buffer_store_event (&event_buf
);
6955 /* This is the tty way of reading available input.
6957 Note that each terminal device has its own `struct terminal' object,
6958 and so this function is called once for each individual termcap
6959 terminal. The first parameter indicates which terminal to read from. */
6962 tty_read_avail_input (struct terminal
*terminal
,
6964 struct input_event
*hold_quit
)
6966 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6967 the kbd_buffer can really hold. That may prevent loss
6968 of characters on some systems when input is stuffed at us. */
6969 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6971 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6974 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6976 if (kbd_on_hold_p () || buffer_free
<= 0)
6978 #endif /* subprocesses */
6980 if (!terminal
->name
) /* Don't read from a dead terminal. */
6983 if (terminal
->type
!= output_termcap
6984 && terminal
->type
!= output_msdos_raw
)
6987 /* XXX I think the following code should be moved to separate hook
6988 functions in system-dependent files. */
6991 #else /* not WINDOWSNT */
6992 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6996 return 0; /* The terminal is suspended. */
6999 n_to_read
= dos_keysns ();
7003 cbuf
[0] = dos_keyread ();
7006 #else /* not MSDOS */
7011 struct input_event gpm_hold_quit
;
7012 int gpm
, fd
= gpm_fd
;
7014 EVENT_INIT (gpm_hold_quit
);
7015 gpm_hold_quit
.kind
= NO_EVENT
;
7017 /* gpm==1 if event received.
7018 gpm==0 if the GPM daemon has closed the connection, in which case
7019 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7020 we save it in `fd' so close_gpm can remove it from the
7022 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7023 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7024 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7027 /* Presumably the GPM daemon has closed the connection. */
7029 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7030 kbd_buffer_store_event (&gpm_hold_quit
);
7034 #endif /* HAVE_GPM */
7036 /* Determine how many characters we should *try* to read. */
7038 /* Find out how much input is available. */
7039 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7041 if (! noninteractive
)
7042 return -2; /* Close this terminal. */
7048 if (n_to_read
> sizeof cbuf
)
7049 n_to_read
= sizeof cbuf
;
7050 #else /* no FIONREAD */
7051 #if defined (USG) || defined (CYGWIN)
7052 /* Read some input if available, but don't wait. */
7053 n_to_read
= sizeof cbuf
;
7054 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7061 /* Don't read more than we can store. */
7062 if (n_to_read
> buffer_free
)
7063 n_to_read
= buffer_free
;
7064 #endif /* subprocesses */
7066 /* Now read; for one reason or another, this will not block.
7067 NREAD is set to the number of chars read. */
7070 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7071 /* POSIX infers that processes which are not in the session leader's
7072 process group won't get SIGHUP's at logout time. BSDI adheres to
7073 this part standard and returns -1 from read (0) with errno==EIO
7074 when the control tty is taken away.
7075 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7076 if (nread
== -1 && errno
== EIO
)
7077 return -2; /* Close this terminal. */
7078 #if defined (AIX) && defined (_BSD)
7079 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7080 This looks incorrect, but it isn't, because _BSD causes
7081 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7082 and that causes a value other than 0 when there is no input. */
7084 return -2; /* Close this terminal. */
7088 /* We used to retry the read if it was interrupted.
7089 But this does the wrong thing when O_NDELAY causes
7090 an EAGAIN error. Does anybody know of a situation
7091 where a retry is actually needed? */
7093 nread
< 0 && (errno
== EAGAIN
7107 #if defined (USG) || defined (CYGWIN)
7108 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7109 #endif /* USG or CYGWIN */
7110 #endif /* no FIONREAD */
7115 #endif /* not MSDOS */
7116 #endif /* not WINDOWSNT */
7118 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7119 & CODING_REQUIRE_DECODING_MASK
)
7121 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7124 /* Decode the key sequence except for those with meta
7126 for (i
= from
= 0; ; i
++)
7127 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7129 struct input_event buf
;
7131 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7136 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7137 buf
.modifiers
= meta_modifier
;
7138 buf
.code
= cbuf
[i
] & ~0x80;
7139 /* See the comment below. */
7140 buf
.frame_or_window
= tty
->top_frame
;
7142 kbd_buffer_store_event (&buf
);
7148 for (i
= 0; i
< nread
; i
++)
7150 struct input_event buf
;
7152 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7154 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7155 buf
.modifiers
= meta_modifier
;
7156 if (tty
->meta_key
!= 2)
7160 /* Set the frame corresponding to the active tty. Note that the
7161 value of selected_frame is not reliable here, redisplay tends
7162 to temporarily change it. */
7163 buf
.frame_or_window
= tty
->top_frame
;
7166 kbd_buffer_store_event (&buf
);
7167 /* Don't look at input that follows a C-g too closely.
7168 This reduces lossage due to autorepeat on C-g. */
7169 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7170 && buf
.code
== quit_char
)
7177 #if defined SYNC_INPUT || defined SIGIO
7179 handle_async_input (void)
7181 interrupt_input_pending
= 0;
7183 pending_signals
= pending_atimers
;
7185 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7186 doing anything dangerous. */
7193 nread
= read_avail_input (1);
7194 /* -1 means it's not ok to read the input now.
7195 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7196 0 means there was no keyboard input available. */
7204 #endif /* SYNC_INPUT || SIGIO */
7208 process_pending_signals (void)
7210 if (interrupt_input_pending
)
7211 handle_async_input ();
7212 do_pending_atimers ();
7216 #ifdef SIGIO /* for entire page */
7217 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7220 input_available_signal (int signo
)
7222 /* Must preserve main program's value of errno. */
7223 int old_errno
= errno
;
7224 SIGNAL_THREAD_CHECK (signo
);
7227 interrupt_input_pending
= 1;
7228 pending_signals
= 1;
7231 if (input_available_clear_time
)
7232 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7235 handle_async_input ();
7242 /* Send ourselves a SIGIO.
7244 This function exists so that the UNBLOCK_INPUT macro in
7245 blockinput.h can have some way to take care of input we put off
7246 dealing with, without assuming that every file which uses
7247 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7249 reinvoke_input_signal (void)
7252 handle_async_input ();
7258 /* User signal events. */
7260 struct user_signal_info
7262 /* Signal number. */
7265 /* Name of the signal. */
7268 /* Number of pending signals. */
7271 struct user_signal_info
*next
;
7274 /* List of user signals. */
7275 static struct user_signal_info
*user_signals
= NULL
;
7278 add_user_signal (int sig
, const char *name
)
7280 struct user_signal_info
*p
;
7282 for (p
= user_signals
; p
; p
= p
->next
)
7284 /* Already added. */
7287 p
= xmalloc (sizeof (struct user_signal_info
));
7289 p
->name
= xstrdup (name
);
7291 p
->next
= user_signals
;
7294 signal (sig
, handle_user_signal
);
7298 handle_user_signal (int sig
)
7300 int old_errno
= errno
;
7301 struct user_signal_info
*p
;
7302 const char *special_event_name
= NULL
;
7304 SIGNAL_THREAD_CHECK (sig
);
7306 if (SYMBOLP (Vdebug_on_event
))
7307 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7309 for (p
= user_signals
; p
; p
= p
->next
)
7312 if (special_event_name
&&
7313 strcmp (special_event_name
, p
->name
) == 0)
7315 /* Enter the debugger in many ways. */
7316 debug_on_next_call
= 1;
7319 Vinhibit_quit
= Qnil
;
7321 /* Eat the event. */
7327 if (interrupt_input
)
7328 kill (getpid (), SIGIO
);
7332 /* Tell wait_reading_process_output that it needs to wake
7333 up and look around. */
7334 if (input_available_clear_time
)
7335 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7344 find_user_signal_name (int sig
)
7346 struct user_signal_info
*p
;
7348 for (p
= user_signals
; p
; p
= p
->next
)
7356 store_user_signal_events (void)
7358 struct user_signal_info
*p
;
7359 struct input_event buf
;
7362 for (p
= user_signals
; p
; p
= p
->next
)
7363 if (p
->npending
> 0)
7369 memset (&buf
, 0, sizeof buf
);
7370 buf
.kind
= USER_SIGNAL_EVENT
;
7371 buf
.frame_or_window
= selected_frame
;
7373 nstored
+= p
->npending
;
7375 mask
= sigblock (sigmask (p
->sig
));
7379 kbd_buffer_store_event (&buf
);
7382 while (p
->npending
> 0);
7390 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7391 static Lisp_Object menu_bar_one_keymap_changed_items
;
7393 /* These variables hold the vector under construction within
7394 menu_bar_items and its subroutines, and the current index
7395 for storing into that vector. */
7396 static Lisp_Object menu_bar_items_vector
;
7397 static int menu_bar_items_index
;
7400 static const char* separator_names
[] = {
7405 "single-dashed-line",
7406 "double-dashed-line",
7408 "shadow-etched-out",
7409 "shadow-etched-in-dash",
7410 "shadow-etched-out-dash",
7411 "shadow-double-etched-in",
7412 "shadow-double-etched-out",
7413 "shadow-double-etched-in-dash",
7414 "shadow-double-etched-out-dash",
7418 /* Return non-zero if LABEL specifies a separator. */
7421 menu_separator_name_p (const char *label
)
7425 else if (strlen (label
) > 3
7426 && strncmp (label
, "--", 2) == 0
7431 for (i
= 0; separator_names
[i
]; ++i
)
7432 if (strcmp (label
, separator_names
[i
]) == 0)
7437 /* It's a separator if it contains only dashes. */
7438 while (*label
== '-')
7440 return (*label
== 0);
7447 /* Return a vector of menu items for a menu bar, appropriate
7448 to the current buffer. Each item has three elements in the vector:
7451 OLD is an old vector we can optionally reuse, or nil. */
7454 menu_bar_items (Lisp_Object old
)
7456 /* The number of keymaps we're scanning right now, and the number of
7457 keymaps we have allocated space for. */
7460 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7461 in the current keymaps, or nil where it is not a prefix. */
7464 Lisp_Object def
, tail
;
7469 /* In order to build the menus, we need to call the keymap
7470 accessors. They all call QUIT. But this function is called
7471 during redisplay, during which a quit is fatal. So inhibit
7472 quitting while building the menus.
7473 We do this instead of specbind because (1) errors will clear it anyway
7474 and (2) this avoids risk of specpdl overflow. */
7475 oquit
= Vinhibit_quit
;
7479 menu_bar_items_vector
= old
;
7481 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7482 menu_bar_items_index
= 0;
7484 /* Build our list of keymaps.
7485 If we recognize a function key and replace its escape sequence in
7486 keybuf with its symbol, or if the sequence starts with a mouse
7487 click and we need to switch buffers, we jump back here to rebuild
7488 the initial keymaps from the current buffer. */
7492 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7493 if (!NILP (Voverriding_local_map_menu_flag
))
7495 /* Yes, use them (if non-nil) as well as the global map. */
7496 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7498 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7499 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7500 if (!NILP (Voverriding_local_map
))
7501 maps
[nmaps
++] = Voverriding_local_map
;
7505 /* No, so use major and minor mode keymaps and keymap property.
7506 Note that menu-bar bindings in the local-map and keymap
7507 properties may not work reliable, as they are only
7508 recognized when the menu-bar (or mode-line) is updated,
7509 which does not normally happen after every command. */
7512 nminor
= current_minor_maps (NULL
, &tmaps
);
7513 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7515 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7516 maps
[nmaps
++] = tem
;
7517 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7519 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7521 maps
[nmaps
++] = current_global_map
;
7524 /* Look up in each map the dummy prefix key `menu-bar'. */
7526 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7527 if (!NILP (maps
[mapno
]))
7529 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7533 menu_bar_one_keymap_changed_items
= Qnil
;
7534 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7538 /* Move to the end those items that should be at the end. */
7540 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7543 int end
= menu_bar_items_index
;
7545 for (i
= 0; i
< end
; i
+= 4)
7546 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7548 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7549 /* Move the item at index I to the end,
7550 shifting all the others forward. */
7551 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7552 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7553 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7554 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7556 memmove (&AREF (menu_bar_items_vector
, i
),
7557 &AREF (menu_bar_items_vector
, i
+ 4),
7558 (end
- i
- 4) * sizeof (Lisp_Object
));
7559 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7560 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7561 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7562 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7567 /* Add nil, nil, nil, nil at the end. */
7569 int i
= menu_bar_items_index
;
7570 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7571 menu_bar_items_vector
=
7572 larger_vector (menu_bar_items_vector
, 4, -1);
7573 /* Add this item. */
7574 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7575 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7576 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7577 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7578 menu_bar_items_index
= i
;
7581 Vinhibit_quit
= oquit
;
7582 return menu_bar_items_vector
;
7585 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7586 If there's already an item for KEY, add this DEF to it. */
7588 Lisp_Object item_properties
;
7591 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7593 struct gcpro gcpro1
;
7597 if (EQ (item
, Qundefined
))
7599 /* If a map has an explicit `undefined' as definition,
7600 discard any previously made menu bar item. */
7602 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7603 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7605 if (menu_bar_items_index
> i
+ 4)
7606 memmove (&AREF (menu_bar_items_vector
, i
),
7607 &AREF (menu_bar_items_vector
, i
+ 4),
7608 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7609 menu_bar_items_index
-= 4;
7613 /* If this keymap has already contributed to this KEY,
7614 don't contribute to it a second time. */
7615 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7616 if (!NILP (tem
) || NILP (item
))
7619 menu_bar_one_keymap_changed_items
7620 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7622 /* We add to menu_bar_one_keymap_changed_items before doing the
7623 parse_menu_item, so that if it turns out it wasn't a menu item,
7624 it still correctly hides any further menu item. */
7626 i
= parse_menu_item (item
, 1);
7631 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7633 /* Find any existing item for this KEY. */
7634 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7635 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7638 /* If we did not find this KEY, add it at the end. */
7639 if (i
== menu_bar_items_index
)
7641 /* If vector is too small, get a bigger one. */
7642 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7643 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7644 /* Add this item. */
7645 ASET (menu_bar_items_vector
, i
, key
); i
++;
7646 ASET (menu_bar_items_vector
, i
,
7647 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7648 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7649 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7650 menu_bar_items_index
= i
;
7652 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7656 old
= AREF (menu_bar_items_vector
, i
+ 2);
7657 /* If the new and the old items are not both keymaps,
7658 the lookup will only find `item'. */
7659 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7660 ASET (menu_bar_items_vector
, i
+ 2, item
);
7664 /* This is used as the handler when calling menu_item_eval_property. */
7666 menu_item_eval_property_1 (Lisp_Object arg
)
7668 /* If we got a quit from within the menu computation,
7669 quit all the way out of it. This takes care of C-] in the debugger. */
7670 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7671 Fsignal (Qquit
, Qnil
);
7677 eval_dyn (Lisp_Object form
)
7679 return Feval (form
, Qnil
);
7682 /* Evaluate an expression and return the result (or nil if something
7683 went wrong). Used to evaluate dynamic parts of menu items. */
7685 menu_item_eval_property (Lisp_Object sexpr
)
7687 ptrdiff_t count
= SPECPDL_INDEX ();
7689 specbind (Qinhibit_redisplay
, Qt
);
7690 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7691 menu_item_eval_property_1
);
7692 return unbind_to (count
, val
);
7695 /* This function parses a menu item and leaves the result in the
7696 vector item_properties.
7697 ITEM is a key binding, a possible menu item.
7698 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7700 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7701 parse_menu_item returns true if the item is a menu item and false
7705 parse_menu_item (Lisp_Object item
, int inmenubar
)
7707 Lisp_Object def
, tem
, item_string
, start
;
7709 Lisp_Object keyhint
;
7718 /* Create item_properties vector if necessary. */
7719 if (NILP (item_properties
))
7721 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7723 /* Initialize optional entries. */
7724 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7725 ASET (item_properties
, i
, Qnil
);
7726 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7728 /* Save the item here to protect it from GC. */
7729 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7731 item_string
= XCAR (item
);
7735 if (STRINGP (item_string
))
7737 /* Old format menu item. */
7738 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7740 /* Maybe help string. */
7741 if (CONSP (item
) && STRINGP (XCAR (item
)))
7743 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7748 /* Maybe an obsolete key binding cache. */
7749 if (CONSP (item
) && CONSP (XCAR (item
))
7750 && (NILP (XCAR (XCAR (item
)))
7751 || VECTORP (XCAR (XCAR (item
)))))
7754 /* This is the real definition--the function to run. */
7755 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7757 /* Get enable property, if any. */
7760 tem
= Fget (item
, Qmenu_enable
);
7761 if (!NILP (Venable_disabled_menus_and_buttons
))
7762 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7763 else if (!NILP (tem
))
7764 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7767 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7769 /* New format menu item. */
7770 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7771 start
= XCDR (item
);
7774 /* We have a real binding. */
7775 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7777 item
= XCDR (start
);
7778 /* Is there an obsolete cache list with key equivalences. */
7779 if (CONSP (item
) && CONSP (XCAR (item
)))
7782 /* Parse properties. */
7783 while (CONSP (item
) && CONSP (XCDR (item
)))
7788 if (EQ (tem
, QCenable
))
7790 if (!NILP (Venable_disabled_menus_and_buttons
))
7791 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7793 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7795 else if (EQ (tem
, QCvisible
))
7797 /* If got a visible property and that evaluates to nil
7798 then ignore this item. */
7799 tem
= menu_item_eval_property (XCAR (item
));
7803 else if (EQ (tem
, QChelp
))
7804 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7805 else if (EQ (tem
, QCfilter
))
7807 else if (EQ (tem
, QCkey_sequence
))
7810 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7811 /* Be GC protected. Set keyhint to item instead of tem. */
7814 else if (EQ (tem
, QCkeys
))
7817 if (CONSP (tem
) || STRINGP (tem
))
7818 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7820 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7825 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7827 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7829 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7835 else if (inmenubar
|| !NILP (start
))
7839 return 0; /* not a menu item */
7841 /* If item string is not a string, evaluate it to get string.
7842 If we don't get a string, skip this item. */
7843 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7844 if (!(STRINGP (item_string
)))
7846 item_string
= menu_item_eval_property (item_string
);
7847 if (!STRINGP (item_string
))
7849 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7852 /* If got a filter apply it on definition. */
7853 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7856 def
= menu_item_eval_property (list2 (XCAR (filter
),
7857 list2 (Qquote
, def
)));
7859 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7862 /* Enable or disable selection of item. */
7863 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7866 tem
= menu_item_eval_property (tem
);
7867 if (inmenubar
&& NILP (tem
))
7868 return 0; /* Ignore disabled items in menu bar. */
7869 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7872 /* If we got no definition, this item is just unselectable text which
7873 is OK in a submenu but not in the menubar. */
7875 return (!inmenubar
);
7877 /* See if this is a separate pane or a submenu. */
7878 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7879 tem
= get_keymap (def
, 0, 1);
7880 /* For a subkeymap, just record its details and exit. */
7883 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7884 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7888 /* At the top level in the menu bar, do likewise for commands also.
7889 The menu bar does not display equivalent key bindings anyway.
7890 ITEM_PROPERTY_DEF is already set up properly. */
7894 { /* This is a command. See if there is an equivalent key binding. */
7895 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7897 /* The previous code preferred :key-sequence to :keys, so we
7898 preserve this behavior. */
7899 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7900 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7903 Lisp_Object prefix
= keyeq
;
7904 Lisp_Object keys
= Qnil
;
7908 def
= XCAR (prefix
);
7909 prefix
= XCDR (prefix
);
7912 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7914 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7916 keys
= XCAR (keyhint
);
7917 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7919 /* We have a suggested key. Is it bound to the command? */
7922 /* If the command is an alias for another
7923 (such as lmenu.el set it up), check if the
7924 original command matches the cached command. */
7925 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7930 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7934 tem
= Fkey_description (keys
, Qnil
);
7937 if (STRINGP (XCAR (prefix
)))
7938 tem
= concat2 (XCAR (prefix
), tem
);
7939 if (STRINGP (XCDR (prefix
)))
7940 tem
= concat2 (tem
, XCDR (prefix
));
7942 keyeq
= concat2 (build_string (" "), tem
);
7943 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7949 /* If we have an equivalent key binding, use that. */
7950 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7953 /* Include this when menu help is implemented.
7954 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7955 if (!(NILP (tem) || STRINGP (tem)))
7957 tem = menu_item_eval_property (tem);
7960 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7964 /* Handle radio buttons or toggle boxes. */
7965 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7967 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7968 menu_item_eval_property (tem
));
7975 /***********************************************************************
7977 ***********************************************************************/
7979 /* A vector holding tool bar items while they are parsed in function
7980 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7983 static Lisp_Object tool_bar_items_vector
;
7985 /* A vector holding the result of parse_tool_bar_item. Layout is like
7986 the one for a single item in tool_bar_items_vector. */
7988 static Lisp_Object tool_bar_item_properties
;
7990 /* Next free index in tool_bar_items_vector. */
7992 static int ntool_bar_items
;
7994 /* The symbols `:image' and `:rtl'. */
7996 static Lisp_Object QCimage
;
7997 static Lisp_Object QCrtl
;
7999 /* Function prototypes. */
8001 static void init_tool_bar_items (Lisp_Object
);
8002 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8003 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8004 static void append_tool_bar_item (void);
8007 /* Return a vector of tool bar items for keymaps currently in effect.
8008 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8009 tool bar items found. */
8012 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8021 /* In order to build the menus, we need to call the keymap
8022 accessors. They all call QUIT. But this function is called
8023 during redisplay, during which a quit is fatal. So inhibit
8024 quitting while building the menus. We do this instead of
8025 specbind because (1) errors will clear it anyway and (2) this
8026 avoids risk of specpdl overflow. */
8027 oquit
= Vinhibit_quit
;
8030 /* Initialize tool_bar_items_vector and protect it from GC. */
8031 init_tool_bar_items (reuse
);
8033 /* Build list of keymaps in maps. Set nmaps to the number of maps
8036 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8037 if (!NILP (Voverriding_local_map_menu_flag
))
8039 /* Yes, use them (if non-nil) as well as the global map. */
8040 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8042 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8043 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8044 if (!NILP (Voverriding_local_map
))
8045 maps
[nmaps
++] = Voverriding_local_map
;
8049 /* No, so use major and minor mode keymaps and keymap property.
8050 Note that tool-bar bindings in the local-map and keymap
8051 properties may not work reliable, as they are only
8052 recognized when the tool-bar (or mode-line) is updated,
8053 which does not normally happen after every command. */
8056 nminor
= current_minor_maps (NULL
, &tmaps
);
8057 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8059 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8060 maps
[nmaps
++] = tem
;
8061 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8063 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8066 /* Add global keymap at the end. */
8067 maps
[nmaps
++] = current_global_map
;
8069 /* Process maps in reverse order and look up in each map the prefix
8071 for (i
= nmaps
- 1; i
>= 0; --i
)
8072 if (!NILP (maps
[i
]))
8076 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8078 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8081 Vinhibit_quit
= oquit
;
8082 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8083 return tool_bar_items_vector
;
8087 /* Process the definition of KEY which is DEF. */
8090 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8093 struct gcpro gcpro1
, gcpro2
;
8095 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8099 if (EQ (def
, Qundefined
))
8101 /* If a map has an explicit `undefined' as definition,
8102 discard any previously made item. */
8103 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8105 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8107 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8109 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8110 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8111 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8112 * sizeof (Lisp_Object
)));
8113 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8118 else if (parse_tool_bar_item (key
, def
))
8119 /* Append a new tool bar item to tool_bar_items_vector. Accept
8120 more than one definition for the same key. */
8121 append_tool_bar_item ();
8127 /* Parse a tool bar item specification ITEM for key KEY and return the
8128 result in tool_bar_item_properties. Value is zero if ITEM is
8131 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8133 CAPTION is the caption of the item, If it's not a string, it is
8134 evaluated to get a string.
8136 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8137 as binding are currently ignored.
8139 The following properties are recognized:
8143 FORM is evaluated and specifies whether the tool bar item is
8144 enabled or disabled.
8148 FORM is evaluated and specifies whether the tool bar item is visible.
8150 - `:filter FUNCTION'
8152 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8153 result is stored as the new binding.
8155 - `:button (TYPE SELECTED)'
8157 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8158 and specifies whether the button is selected (pressed) or not.
8162 IMAGES is either a single image specification or a vector of four
8163 image specifications. See enum tool_bar_item_images.
8165 - `:help HELP-STRING'.
8167 Gives a help string to display for the tool bar item.
8169 - `:label LABEL-STRING'.
8171 A text label to show with the tool bar button if labels are enabled. */
8174 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8176 /* Access slot with index IDX of vector tool_bar_item_properties. */
8177 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8179 Lisp_Object filter
= Qnil
;
8180 Lisp_Object caption
;
8181 int i
, have_label
= 0;
8183 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8184 Rule out items that aren't lists, don't start with
8185 `menu-item' or whose rest following `tool-bar-item' is not a
8190 /* As an exception, allow old-style menu separators. */
8191 if (STRINGP (XCAR (item
)))
8192 item
= Fcons (XCAR (item
), Qnil
);
8193 else if (!EQ (XCAR (item
), Qmenu_item
)
8194 || (item
= XCDR (item
), !CONSP (item
)))
8197 /* Create tool_bar_item_properties vector if necessary. Reset it to
8199 if (VECTORP (tool_bar_item_properties
))
8201 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8205 tool_bar_item_properties
8206 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8209 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8210 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8212 /* Get the caption of the item. If the caption is not a string,
8213 evaluate it to get a string. If we don't get a string, skip this
8215 caption
= XCAR (item
);
8216 if (!STRINGP (caption
))
8218 caption
= menu_item_eval_property (caption
);
8219 if (!STRINGP (caption
))
8222 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8224 /* If the rest following the caption is not a list, the menu item is
8225 either a separator, or invalid. */
8229 if (menu_separator_name_p (SSDATA (caption
)))
8231 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8232 #if !defined (USE_GTK) && !defined (HAVE_NS)
8233 /* If we use build_desired_tool_bar_string to render the
8234 tool bar, the separator is rendered as an image. */
8235 PROP (TOOL_BAR_ITEM_IMAGES
)
8236 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8237 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8238 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8239 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8246 /* Store the binding. */
8247 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8250 /* Ignore cached key binding, if any. */
8251 if (CONSP (item
) && CONSP (XCAR (item
)))
8254 /* Process the rest of the properties. */
8255 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8257 Lisp_Object ikey
, value
;
8260 value
= XCAR (XCDR (item
));
8262 if (EQ (ikey
, QCenable
))
8264 /* `:enable FORM'. */
8265 if (!NILP (Venable_disabled_menus_and_buttons
))
8266 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8268 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8270 else if (EQ (ikey
, QCvisible
))
8272 /* `:visible FORM'. If got a visible property and that
8273 evaluates to nil then ignore this item. */
8274 if (NILP (menu_item_eval_property (value
)))
8277 else if (EQ (ikey
, QChelp
))
8278 /* `:help HELP-STRING'. */
8279 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8280 else if (EQ (ikey
, QCvert_only
))
8281 /* `:vert-only t/nil'. */
8282 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8283 else if (EQ (ikey
, QClabel
))
8285 const char *bad_label
= "!!?GARBLED ITEM?!!";
8286 /* `:label LABEL-STRING'. */
8287 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8289 : build_string (bad_label
);
8292 else if (EQ (ikey
, QCfilter
))
8293 /* ':filter FORM'. */
8295 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8297 /* `:button (TYPE . SELECTED)'. */
8298 Lisp_Object type
, selected
;
8300 type
= XCAR (value
);
8301 selected
= XCDR (value
);
8302 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8304 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8305 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8308 else if (EQ (ikey
, QCimage
)
8310 || (VECTORP (value
) && ASIZE (value
) == 4)))
8311 /* Value is either a single image specification or a vector
8312 of 4 such specifications for the different button states. */
8313 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8314 else if (EQ (ikey
, QCrtl
))
8316 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8322 /* Try to make one from caption and key. */
8323 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8324 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8325 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8326 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8328 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8329 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8330 Lisp_Object new_lbl
;
8331 ptrdiff_t caption_len
= strlen (capt
);
8333 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8336 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8338 buf
[caption_len
] = '\0';
8342 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8346 strcpy (buf
, label
);
8348 for (j
= 0; buf
[j
] != '\0'; ++j
)
8356 new_lbl
= Fupcase_initials (build_string (label
));
8357 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8358 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8360 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8364 /* If got a filter apply it on binding. */
8366 PROP (TOOL_BAR_ITEM_BINDING
)
8367 = menu_item_eval_property (list2 (filter
,
8369 PROP (TOOL_BAR_ITEM_BINDING
))));
8371 /* See if the binding is a keymap. Give up if it is. */
8372 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8375 /* Enable or disable selection of item. */
8376 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8377 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8378 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8380 /* Handle radio buttons or toggle boxes. */
8381 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8382 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8383 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8391 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8392 that can be reused. */
8395 init_tool_bar_items (Lisp_Object reuse
)
8397 if (VECTORP (reuse
))
8398 tool_bar_items_vector
= reuse
;
8400 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8401 ntool_bar_items
= 0;
8405 /* Append parsed tool bar item properties from
8406 tool_bar_item_properties */
8409 append_tool_bar_item (void)
8411 Lisp_Object
*to
, *from
;
8414 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8416 /* Enlarge tool_bar_items_vector if necessary. */
8418 tool_bar_items_vector
8419 = larger_vector (tool_bar_items_vector
, incr
, -1);
8421 /* Append entries from tool_bar_item_properties to the end of
8422 tool_bar_items_vector. */
8423 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8424 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8425 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8426 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8433 /* Read a character using menus based on maps in the array MAPS.
8434 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8435 Return t if we displayed a menu but the user rejected it.
8437 PREV_EVENT is the previous input event, or nil if we are reading
8438 the first event of a key sequence.
8440 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8441 if we used a mouse menu to read the input, or zero otherwise. If
8442 USED_MOUSE_MENU is null, we don't dereference it.
8444 The prompting is done based on the prompt-string of the map
8445 and the strings associated with various map elements.
8447 This can be done with X menus or with menus put in the minibuf.
8448 These are done in different ways, depending on how the input will be read.
8449 Menus using X are done after auto-saving in read-char, getting the input
8450 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8451 and do auto-saving in the inner call of read_char. */
8454 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8455 Lisp_Object prev_event
, int *used_mouse_menu
)
8459 if (used_mouse_menu
)
8460 *used_mouse_menu
= 0;
8462 /* Use local over global Menu maps */
8464 if (! menu_prompting
)
8467 /* Optionally disregard all but the global map. */
8468 if (inhibit_local_menu_bar_menus
)
8470 maps
+= (nmaps
- 1);
8475 /* If we got to this point via a mouse click,
8476 use a real menu for mouse selection. */
8477 if (EVENT_HAS_PARAMETERS (prev_event
)
8478 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8479 && !EQ (XCAR (prev_event
), Qtool_bar
))
8481 /* Display the menu and get the selection. */
8482 Lisp_Object
*realmaps
8483 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8485 ptrdiff_t nmaps1
= 0;
8487 /* Use the maps that are not nil. */
8488 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8489 if (!NILP (maps
[mapno
]))
8490 realmaps
[nmaps1
++] = maps
[mapno
];
8492 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8497 record_menu_key (XCAR (value
));
8499 /* If we got multiple events, unread all but
8501 There is no way to prevent those unread events
8502 from showing up later in last_nonmenu_event.
8503 So turn symbol and integer events into lists,
8504 to indicate that they came from a mouse menu,
8505 so that when present in last_nonmenu_event
8506 they won't confuse things. */
8507 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8509 record_menu_key (XCAR (tem
));
8510 if (SYMBOLP (XCAR (tem
))
8511 || INTEGERP (XCAR (tem
)))
8512 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8515 /* If we got more than one event, put all but the first
8516 onto this list to be read later.
8517 Return just the first event now. */
8518 Vunread_command_events
8519 = nconc2 (XCDR (value
), Vunread_command_events
);
8520 value
= XCAR (value
);
8522 else if (NILP (value
))
8524 if (used_mouse_menu
)
8525 *used_mouse_menu
= 1;
8528 #endif /* HAVE_MENUS */
8532 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8533 We make this bigger when necessary, and never free it. */
8534 static char *read_char_minibuf_menu_text
;
8535 /* Size of that buffer. */
8536 static ptrdiff_t read_char_minibuf_menu_width
;
8539 read_char_minibuf_menu_prompt (int commandflag
,
8540 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8543 register Lisp_Object name
;
8545 /* FIXME: Use the minibuffer's frame width. */
8546 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8549 Lisp_Object rest
, vector
;
8555 if (! menu_prompting
)
8558 /* Get the menu name from the first map that has one (a prompt string). */
8559 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8561 name
= Fkeymap_prompt (maps
[mapno
]);
8566 /* If we don't have any menus, just read a character normally. */
8567 if (!STRINGP (name
))
8570 /* Make sure we have a big enough buffer for the menu text. */
8571 width
= max (width
, SBYTES (name
));
8572 if (STRING_BYTES_BOUND
- 4 < width
)
8573 memory_full (SIZE_MAX
);
8574 if (width
+ 4 > read_char_minibuf_menu_width
)
8576 read_char_minibuf_menu_text
8577 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8578 read_char_minibuf_menu_width
= width
+ 4;
8580 menu
= read_char_minibuf_menu_text
;
8582 /* Prompt string always starts with map's prompt, and a space. */
8583 strcpy (menu
, SSDATA (name
));
8584 nlength
= SBYTES (name
);
8585 menu
[nlength
++] = ':';
8586 menu
[nlength
++] = ' ';
8589 /* Start prompting at start of first map. */
8593 /* Present the documented bindings, a line at a time. */
8597 ptrdiff_t i
= nlength
;
8599 Lisp_Object orig_defn_macro
;
8601 /* Loop over elements of map. */
8606 /* If reached end of map, start at beginning of next map. */
8610 /* At end of last map, wrap around to first map if just starting,
8611 or end this line if already have something on it. */
8615 if (notfirst
|| nobindings
) break;
8620 /* Look at the next element of the map. */
8622 elt
= AREF (vector
, idx
);
8624 elt
= Fcar_safe (rest
);
8626 if (idx
< 0 && VECTORP (elt
))
8628 /* If we found a dense table in the keymap,
8629 advanced past it, but start scanning its contents. */
8630 rest
= Fcdr_safe (rest
);
8636 /* An ordinary element. */
8637 Lisp_Object event
, tem
;
8641 event
= Fcar_safe (elt
); /* alist */
8642 elt
= Fcdr_safe (elt
);
8646 XSETINT (event
, idx
); /* vector */
8649 /* Ignore the element if it has no prompt string. */
8650 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8652 /* 1 if the char to type matches the string. */
8654 Lisp_Object upcased_event
, downcased_event
;
8655 Lisp_Object desc
= Qnil
;
8657 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8659 upcased_event
= Fupcase (event
);
8660 downcased_event
= Fdowncase (event
);
8661 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8662 || XINT (downcased_event
) == SREF (s
, 0));
8664 desc
= Fsingle_key_description (event
, Qnil
);
8666 #if 0 /* It is redundant to list the equivalent key bindings because
8667 the prefix is what the user has already typed. */
8669 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8671 /* Insert equivalent keybinding. */
8672 s
= concat2 (s
, tem
);
8675 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8676 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8678 /* Insert button prefix. */
8679 Lisp_Object selected
8680 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8681 if (EQ (tem
, QCradio
))
8682 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8684 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8685 s
= concat2 (tem
, s
);
8689 /* If we have room for the prompt string, add it to this line.
8690 If this is the first on the line, always add it. */
8691 if ((SCHARS (s
) + i
+ 2
8692 + (char_matches
? 0 : SCHARS (desc
) + 3))
8696 ptrdiff_t thiswidth
;
8698 /* Punctuate between strings. */
8701 strcpy (menu
+ i
, ", ");
8707 /* If the char to type doesn't match the string's
8708 first char, explicitly show what char to type. */
8711 /* Add as much of string as fits. */
8712 thiswidth
= min (SCHARS (desc
), width
- i
);
8713 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8715 strcpy (menu
+ i
, " = ");
8719 /* Add as much of string as fits. */
8720 thiswidth
= min (SCHARS (s
), width
- i
);
8721 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8727 /* If this element does not fit, end the line now,
8728 and save the element for the next line. */
8729 strcpy (menu
+ i
, "...");
8734 /* Move past this element. */
8735 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8736 /* Handle reaching end of dense table. */
8741 rest
= Fcdr_safe (rest
);
8745 /* Prompt with that and read response. */
8746 message2_nolog (menu
, strlen (menu
),
8747 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8749 /* Make believe its not a keyboard macro in case the help char
8750 is pressed. Help characters are not recorded because menu prompting
8751 is not used on replay.
8753 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8754 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8756 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8757 while (BUFFERP (obj
));
8758 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8760 if (!INTEGERP (obj
))
8762 else if (XINT (obj
) == -2)
8765 if (! EQ (obj
, menu_prompt_more_char
)
8766 && (!INTEGERP (menu_prompt_more_char
)
8767 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8769 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8770 store_kbd_macro_char (obj
);
8773 /* Help char - go round again */
8777 /* Reading key sequences. */
8779 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8780 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8781 keymap, or nil otherwise. Return the index of the first keymap in
8782 which KEY has any binding, or NMAPS if no map has a binding.
8784 If KEY is a meta ASCII character, treat it like meta-prefix-char
8785 followed by the corresponding non-meta character. Keymaps in
8786 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8789 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8792 NEXT may be the same array as CURRENT. */
8795 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8796 Lisp_Object
*defs
, Lisp_Object
*next
)
8798 ptrdiff_t i
, first_binding
;
8800 first_binding
= nmaps
;
8801 for (i
= nmaps
- 1; i
>= 0; i
--)
8803 if (! NILP (current
[i
]))
8805 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8806 if (! NILP (defs
[i
]))
8813 /* Given the set of bindings we've found, produce the next set of maps. */
8814 if (first_binding
< nmaps
)
8815 for (i
= 0; i
< nmaps
; i
++)
8816 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8818 return first_binding
;
8821 /* Structure used to keep track of partial application of key remapping
8822 such as Vfunction_key_map and Vkey_translation_map. */
8823 typedef struct keyremap
8825 /* This is the map originally specified for this use. */
8827 /* This is a submap reached by looking up, in PARENT,
8828 the events from START to END. */
8830 /* Positions [START, END) in the key sequence buffer
8831 are the key that we have scanned so far.
8832 Those events are the ones that we will replace
8833 if PARENT maps them into a key sequence. */
8837 /* Lookup KEY in MAP.
8838 MAP is a keymap mapping keys to key vectors or functions.
8839 If the mapping is a function and DO_FUNCTION is non-zero, then
8840 the function is called with PROMPT as parameter and its return
8841 value is used as the return value of this function (after checking
8842 that it is indeed a vector). */
8845 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8850 next
= access_keymap (map
, key
, 1, 0, 1);
8852 /* Handle symbol with autoload definition. */
8853 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8854 && CONSP (XSYMBOL (next
)->function
)
8855 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8856 do_autoload (XSYMBOL (next
)->function
, next
);
8858 /* Handle a symbol whose function definition is a keymap
8860 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8861 && (ARRAYP (XSYMBOL (next
)->function
)
8862 || KEYMAPP (XSYMBOL (next
)->function
)))
8863 next
= XSYMBOL (next
)->function
;
8865 /* If the keymap gives a function, not an
8866 array, then call the function with one arg and use
8867 its value instead. */
8868 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8873 next
= call1 (next
, prompt
);
8874 /* If the function returned something invalid,
8875 barf--don't ignore it.
8876 (To ignore it safely, we would need to gcpro a bunch of
8877 other variables.) */
8878 if (! (VECTORP (next
) || STRINGP (next
)))
8879 error ("Function %s returns invalid key sequence",
8880 SSDATA (SYMBOL_NAME (tem
)));
8885 /* Do one step of the key remapping used for function-key-map and
8886 key-translation-map:
8887 KEYBUF is the buffer holding the input events.
8888 BUFSIZE is its maximum size.
8889 FKEY is a pointer to the keyremap structure to use.
8890 INPUT is the index of the last element in KEYBUF.
8891 DOIT if non-zero says that the remapping can actually take place.
8892 DIFF is used to return the number of keys added/removed by the remapping.
8893 PARENT is the root of the keymap.
8894 PROMPT is the prompt to use if the remapping happens through a function.
8895 The return value is non-zero if the remapping actually took place. */
8898 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8899 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8901 Lisp_Object next
, key
;
8903 key
= keybuf
[fkey
->end
++];
8905 if (KEYMAPP (fkey
->parent
))
8906 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8910 /* If keybuf[fkey->start..fkey->end] is bound in the
8911 map and we're in a position to do the key remapping, replace it with
8912 the binding and restart with fkey->start at the end. */
8913 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8915 int len
= XFASTINT (Flength (next
));
8918 *diff
= len
- (fkey
->end
- fkey
->start
);
8920 if (bufsize
- input
<= *diff
)
8921 error ("Key sequence too long");
8923 /* Shift the keys that follow fkey->end. */
8925 for (i
= fkey
->end
; i
< input
; i
++)
8926 keybuf
[i
+ *diff
] = keybuf
[i
];
8928 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8929 keybuf
[i
+ *diff
] = keybuf
[i
];
8930 /* Overwrite the old keys with the new ones. */
8931 for (i
= 0; i
< len
; i
++)
8932 keybuf
[fkey
->start
+ i
]
8933 = Faref (next
, make_number (i
));
8935 fkey
->start
= fkey
->end
+= *diff
;
8936 fkey
->map
= fkey
->parent
;
8941 fkey
->map
= get_keymap (next
, 0, 1);
8943 /* If we no longer have a bound suffix, try a new position for
8945 if (!CONSP (fkey
->map
))
8947 fkey
->end
= ++fkey
->start
;
8948 fkey
->map
= fkey
->parent
;
8954 test_undefined (Lisp_Object binding
)
8956 return (EQ (binding
, Qundefined
)
8957 || (!NILP (binding
) && SYMBOLP (binding
)
8958 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8961 /* Read a sequence of keys that ends with a non prefix character,
8962 storing it in KEYBUF, a buffer of size BUFSIZE.
8964 Return the length of the key sequence stored.
8965 Return -1 if the user rejected a command menu.
8967 Echo starting immediately unless `prompt' is 0.
8969 Where a key sequence ends depends on the currently active keymaps.
8970 These include any minor mode keymaps active in the current buffer,
8971 the current buffer's local map, and the global map.
8973 If a key sequence has no other bindings, we check Vfunction_key_map
8974 to see if some trailing subsequence might be the beginning of a
8975 function key's sequence. If so, we try to read the whole function
8976 key, and substitute its symbolic name into the key sequence.
8978 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8979 `double-' events into similar click events, if that would make them
8980 bound. We try to turn `triple-' events first into `double-' events,
8983 If we get a mouse click in a mode line, vertical divider, or other
8984 non-text area, we treat the click as if it were prefixed by the
8985 symbol denoting that area - `mode-line', `vertical-line', or
8988 If the sequence starts with a mouse click, we read the key sequence
8989 with respect to the buffer clicked on, not the current buffer.
8991 If the user switches frames in the midst of a key sequence, we put
8992 off the switch-frame event until later; the next call to
8993 read_char will return it.
8995 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8996 from the selected window's buffer. */
8999 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9000 int dont_downcase_last
, int can_return_switch_frame
,
9001 int fix_current_buffer
)
9003 Lisp_Object from_string
;
9004 ptrdiff_t count
= SPECPDL_INDEX ();
9006 /* How many keys there are in the current key sequence. */
9009 /* The length of the echo buffer when we started reading, and
9010 the length of this_command_keys when we started reading. */
9011 ptrdiff_t echo_start
IF_LINT (= 0);
9012 ptrdiff_t keys_start
;
9014 /* The number of keymaps we're scanning right now, and the number of
9015 keymaps we have allocated space for. */
9017 ptrdiff_t nmaps_allocated
= 0;
9019 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9020 the current keymaps. */
9021 Lisp_Object
*defs
= NULL
;
9023 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9024 in the current keymaps, or nil where it is not a prefix. */
9025 Lisp_Object
*submaps
= NULL
;
9027 /* The local map to start out with at start of key sequence. */
9028 Lisp_Object orig_local_map
;
9030 /* The map from the `keymap' property to start out with at start of
9032 Lisp_Object orig_keymap
;
9034 /* 1 if we have already considered switching to the local-map property
9035 of the place where a mouse click occurred. */
9036 int localized_local_map
= 0;
9038 /* The index in submaps[] of the first keymap that has a binding for
9039 this key sequence. In other words, the lowest i such that
9040 submaps[i] is non-nil. */
9041 ptrdiff_t first_binding
;
9042 /* Index of the first key that has no binding.
9043 It is useless to try fkey.start larger than that. */
9046 /* If t < mock_input, then KEYBUF[t] should be read as the next
9049 We use this to recover after recognizing a function key. Once we
9050 realize that a suffix of the current key sequence is actually a
9051 function key's escape sequence, we replace the suffix with the
9052 function key's binding from Vfunction_key_map. Now keybuf
9053 contains a new and different key sequence, so the echo area,
9054 this_command_keys, and the submaps and defs arrays are wrong. In
9055 this situation, we set mock_input to t, set t to 0, and jump to
9056 restart_sequence; the loop will read keys from keybuf up until
9057 mock_input, thus rebuilding the state; and then it will resume
9058 reading characters from the keyboard. */
9061 /* If the sequence is unbound in submaps[], then
9062 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9063 and fkey.map is its binding.
9065 These might be > t, indicating that all function key scanning
9066 should hold off until t reaches them. We do this when we've just
9067 recognized a function key, to avoid searching for the function
9068 key's again in Vfunction_key_map. */
9071 /* Likewise, for key_translation_map and input-decode-map. */
9072 keyremap keytran
, indec
;
9074 /* Non-zero if we are trying to map a key by changing an upper-case
9075 letter to lower case, or a shifted function key to an unshifted
9077 int shift_translated
= 0;
9079 /* If we receive a `switch-frame' or `select-window' event in the middle of
9080 a key sequence, we put it off for later.
9081 While we're reading, we keep the event here. */
9082 Lisp_Object delayed_switch_frame
;
9084 /* See the comment below... */
9085 #if defined (GOBBLE_FIRST_EVENT)
9086 Lisp_Object first_event
;
9089 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9090 int original_uppercase_position
= -1;
9092 /* Gets around Microsoft compiler limitations. */
9095 struct buffer
*starting_buffer
;
9097 /* List of events for which a fake prefix key has been generated. */
9098 Lisp_Object fake_prefixed_keys
= Qnil
;
9100 #if defined (GOBBLE_FIRST_EVENT)
9104 struct gcpro gcpro1
;
9106 GCPRO1 (fake_prefixed_keys
);
9107 raw_keybuf_count
= 0;
9109 last_nonmenu_event
= Qnil
;
9111 delayed_switch_frame
= Qnil
;
9117 /* Install the string STR as the beginning of the string of
9118 echoing, so that it serves as a prompt for the next
9120 KVAR (current_kboard
, echo_string
) = prompt
;
9121 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9124 else if (cursor_in_echo_area
9125 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9126 && NILP (Fzerop (Vecho_keystrokes
)))
9127 /* This doesn't put in a dash if the echo buffer is empty, so
9128 you don't always see a dash hanging out in the minibuffer. */
9132 /* Record the initial state of the echo area and this_command_keys;
9133 we will need to restore them if we replay a key sequence. */
9135 echo_start
= echo_length ();
9136 keys_start
= this_command_key_count
;
9137 this_single_command_key_start
= keys_start
;
9139 #if defined (GOBBLE_FIRST_EVENT)
9140 /* This doesn't quite work, because some of the things that read_char
9141 does cannot safely be bypassed. It seems too risky to try to make
9144 /* Read the first char of the sequence specially, before setting
9145 up any keymaps, in case a filter runs and switches buffers on us. */
9146 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9148 #endif /* GOBBLE_FIRST_EVENT */
9150 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9151 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9154 /* We jump here when we need to reinitialize fkey and keytran; this
9155 happens if we switch keyboards between rescans. */
9156 replay_entire_sequence
:
9158 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9159 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9160 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9161 indec
.start
= indec
.end
= 0;
9162 fkey
.start
= fkey
.end
= 0;
9163 keytran
.start
= keytran
.end
= 0;
9165 /* We jump here when the key sequence has been thoroughly changed, and
9166 we need to rescan it starting from the beginning. When we jump here,
9167 keybuf[0..mock_input] holds the sequence we should reread. */
9170 starting_buffer
= current_buffer
;
9171 first_unbound
= bufsize
+ 1;
9173 /* Build our list of keymaps.
9174 If we recognize a function key and replace its escape sequence in
9175 keybuf with its symbol, or if the sequence starts with a mouse
9176 click and we need to switch buffers, we jump back here to rebuild
9177 the initial keymaps from the current buffer. */
9180 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9182 if (2 > nmaps_allocated
)
9184 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9185 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9186 nmaps_allocated
= 2;
9188 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9190 else if (!NILP (Voverriding_local_map
))
9192 if (2 > nmaps_allocated
)
9194 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9195 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9196 nmaps_allocated
= 2;
9198 submaps
[nmaps
++] = Voverriding_local_map
;
9206 nminor
= current_minor_maps (0, &maps
);
9207 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9209 if (total
> nmaps_allocated
)
9211 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9212 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9213 nmaps_allocated
= total
;
9216 if (!NILP (orig_keymap
))
9217 submaps
[nmaps
++] = orig_keymap
;
9219 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9223 submaps
[nmaps
++] = orig_local_map
;
9225 submaps
[nmaps
++] = current_global_map
;
9227 /* Find an accurate initial value for first_binding. */
9228 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9229 if (! NILP (submaps
[first_binding
]))
9232 /* Start from the beginning in keybuf. */
9235 /* These are no-ops the first time through, but if we restart, they
9236 revert the echo area and this_command_keys to their original state. */
9237 this_command_key_count
= keys_start
;
9238 if (INTERACTIVE
&& t
< mock_input
)
9239 echo_truncate (echo_start
);
9241 /* If the best binding for the current key sequence is a keymap, or
9242 we may be looking at a function key's escape sequence, keep on
9244 while (first_binding
< nmaps
9245 /* Keep reading as long as there's a prefix binding. */
9246 ? !NILP (submaps
[first_binding
])
9247 /* Don't return in the middle of a possible function key sequence,
9248 if the only bindings we found were via case conversion.
9249 Thus, if ESC O a has a function-key-map translation
9250 and ESC o has a binding, don't return after ESC O,
9251 so that we can translate ESC O plus the next character. */
9252 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9255 int used_mouse_menu
= 0;
9257 /* Where the last real key started. If we need to throw away a
9258 key that has expanded into more than one element of keybuf
9259 (say, a mouse click on the mode line which is being treated
9260 as [mode-line (mouse-...)], then we backtrack to this point
9262 int last_real_key_start
;
9264 /* These variables are analogous to echo_start and keys_start;
9265 while those allow us to restart the entire key sequence,
9266 echo_local_start and keys_local_start allow us to throw away
9268 ptrdiff_t echo_local_start
IF_LINT (= 0);
9269 int keys_local_start
;
9270 ptrdiff_t local_first_binding
;
9272 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9273 eassert (indec
.start
<= indec
.end
);
9274 eassert (fkey
.start
<= fkey
.end
);
9275 eassert (keytran
.start
<= keytran
.end
);
9276 /* key-translation-map is applied *after* function-key-map
9277 which is itself applied *after* input-decode-map. */
9278 eassert (fkey
.end
<= indec
.start
);
9279 eassert (keytran
.end
<= fkey
.start
);
9281 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9282 first_unbound
< keytran
.start
)
9283 { /* The prefix upto first_unbound has no binding and has
9284 no translation left to do either, so we know it's unbound.
9285 If we don't stop now, we risk staying here indefinitely
9286 (if the user keeps entering fkey or keytran prefixes
9287 like C-c ESC ESC ESC ESC ...) */
9289 for (i
= first_unbound
+ 1; i
< t
; i
++)
9290 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9291 mock_input
= t
- first_unbound
- 1;
9292 indec
.end
= indec
.start
-= first_unbound
+ 1;
9293 indec
.map
= indec
.parent
;
9294 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9295 fkey
.map
= fkey
.parent
;
9296 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9297 keytran
.map
= keytran
.parent
;
9298 goto replay_sequence
;
9302 error ("Key sequence too long");
9305 echo_local_start
= echo_length ();
9306 keys_local_start
= this_command_key_count
;
9307 local_first_binding
= first_binding
;
9310 /* These are no-ops, unless we throw away a keystroke below and
9311 jumped back up to replay_key; in that case, these restore the
9312 variables to their original state, allowing us to replay the
9314 if (INTERACTIVE
&& t
< mock_input
)
9315 echo_truncate (echo_local_start
);
9316 this_command_key_count
= keys_local_start
;
9317 first_binding
= local_first_binding
;
9319 /* By default, assume each event is "real". */
9320 last_real_key_start
= t
;
9322 /* Does mock_input indicate that we are re-reading a key sequence? */
9326 add_command_key (key
);
9327 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9328 && NILP (Fzerop (Vecho_keystrokes
)))
9332 /* If not, we should actually read a character. */
9336 KBOARD
*interrupted_kboard
= current_kboard
;
9337 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9338 key
= read_char (NILP (prompt
), nmaps
,
9339 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9340 &used_mouse_menu
, NULL
);
9341 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9342 /* When switching to a new tty (with a new keyboard),
9343 read_char returns the new buffer, rather than -2
9344 (Bug#5095). This is because `terminal-init-xterm'
9345 calls read-char, which eats the wrong_kboard_jmpbuf
9346 return. Any better way to fix this? -- cyd */
9347 || (interrupted_kboard
!= current_kboard
))
9352 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9353 if (k
== interrupted_kboard
)
9358 /* Don't touch interrupted_kboard when it's been
9360 delayed_switch_frame
= Qnil
;
9361 goto replay_entire_sequence
;
9364 if (!NILP (delayed_switch_frame
))
9366 KVAR (interrupted_kboard
, kbd_queue
)
9367 = Fcons (delayed_switch_frame
,
9368 KVAR (interrupted_kboard
, kbd_queue
));
9369 delayed_switch_frame
= Qnil
;
9373 KVAR (interrupted_kboard
, kbd_queue
)
9374 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9376 /* If the side queue is non-empty, ensure it begins with a
9377 switch-frame, so we'll replay it in the right context. */
9378 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9379 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9380 !(EVENT_HAS_PARAMETERS (key
)
9381 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9385 XSETFRAME (frame
, interrupted_frame
);
9386 KVAR (interrupted_kboard
, kbd_queue
)
9387 = Fcons (make_lispy_switch_frame (frame
),
9388 KVAR (interrupted_kboard
, kbd_queue
));
9391 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9392 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9393 goto replay_entire_sequence
;
9397 /* read_char returns t when it shows a menu and the user rejects it.
9401 unbind_to (count
, Qnil
);
9406 /* read_char returns -1 at the end of a macro.
9407 Emacs 18 handles this by returning immediately with a
9408 zero, so that's what we'll do. */
9409 if (INTEGERP (key
) && XINT (key
) == -1)
9412 /* The Microsoft C compiler can't handle the goto that
9418 /* If the current buffer has been changed from under us, the
9419 keymap may have changed, so replay the sequence. */
9422 timer_resume_idle ();
9425 /* Reset the current buffer from the selected window
9426 in case something changed the former and not the latter.
9427 This is to be more consistent with the behavior
9428 of the command_loop_1. */
9429 if (fix_current_buffer
)
9431 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9433 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9434 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9437 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9438 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9439 goto replay_sequence
;
9442 /* If we have a quit that was typed in another frame, and
9443 quit_throw_to_read_char switched buffers,
9444 replay to get the right keymap. */
9446 && XINT (key
) == quit_char
9447 && current_buffer
!= starting_buffer
)
9450 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9455 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9456 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9457 goto replay_sequence
;
9462 if (EVENT_HAS_PARAMETERS (key
)
9463 /* Either a `switch-frame' or a `select-window' event. */
9464 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9466 /* If we're at the beginning of a key sequence, and the caller
9467 says it's okay, go ahead and return this event. If we're
9468 in the midst of a key sequence, delay it until the end. */
9469 if (t
> 0 || !can_return_switch_frame
)
9471 delayed_switch_frame
= key
;
9477 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9481 /* Clicks in non-text areas get prefixed by the symbol
9482 in their CHAR-ADDRESS field. For example, a click on
9483 the mode line is prefixed by the symbol `mode-line'.
9485 Furthermore, key sequences beginning with mouse clicks
9486 are read using the keymaps of the buffer clicked on, not
9487 the current buffer. So we may have to switch the buffer
9490 When we turn one event into two events, we must make sure
9491 that neither of the two looks like the original--so that,
9492 if we replay the events, they won't be expanded again.
9493 If not for this, such reexpansion could happen either here
9494 or when user programs play with this-command-keys. */
9495 if (EVENT_HAS_PARAMETERS (key
))
9500 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9501 if (EQ (kind
, Qmouse_click
))
9503 Lisp_Object window
, posn
;
9505 window
= POSN_WINDOW (EVENT_START (key
));
9506 posn
= POSN_POSN (EVENT_START (key
));
9509 || (!NILP (fake_prefixed_keys
)
9510 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9512 /* We're looking a second time at an event for which
9513 we generated a fake prefix key. Set
9514 last_real_key_start appropriately. */
9516 last_real_key_start
= t
- 1;
9519 if (last_real_key_start
== 0)
9521 /* Key sequences beginning with mouse clicks are
9522 read using the keymaps in the buffer clicked on,
9523 not the current buffer. If we're at the
9524 beginning of a key sequence, switch buffers. */
9525 if (WINDOWP (window
)
9526 && BUFFERP (XWINDOW (window
)->buffer
)
9527 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9529 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9534 /* Arrange to go back to the original buffer once we're
9535 done reading the key sequence. Note that we can't
9536 use save_excursion_{save,restore} here, because they
9537 save point as well as the current buffer; we don't
9538 want to save point, because redisplay may change it,
9539 to accommodate a Fset_window_start or something. We
9540 don't want to do this at the top of the function,
9541 because we may get input from a subprocess which
9542 wants to change the selected window and stuff (say,
9544 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9546 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9548 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9549 orig_local_map
= get_local_map (PT
, current_buffer
,
9551 orig_keymap
= get_local_map (PT
, current_buffer
,
9553 goto replay_sequence
;
9556 /* For a mouse click, get the local text-property keymap
9557 of the place clicked on, rather than point. */
9558 if (CONSP (XCDR (key
))
9559 && ! localized_local_map
)
9561 Lisp_Object map_here
, start
, pos
;
9563 localized_local_map
= 1;
9564 start
= EVENT_START (key
);
9566 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9568 pos
= POSN_BUFFER_POSN (start
);
9570 && XINT (pos
) >= BEGV
9571 && XINT (pos
) <= ZV
)
9573 map_here
= get_local_map (XINT (pos
),
9576 if (!EQ (map_here
, orig_local_map
))
9578 orig_local_map
= map_here
;
9579 ++localized_local_map
;
9582 map_here
= get_local_map (XINT (pos
),
9585 if (!EQ (map_here
, orig_keymap
))
9587 orig_keymap
= map_here
;
9588 ++localized_local_map
;
9591 if (localized_local_map
> 1)
9596 goto replay_sequence
;
9603 /* Expand mode-line and scroll-bar events into two events:
9604 use posn as a fake prefix key. */
9606 && (NILP (fake_prefixed_keys
)
9607 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9609 if (bufsize
- t
<= 1)
9610 error ("Key sequence too long");
9613 keybuf
[t
+ 1] = key
;
9616 /* Record that a fake prefix key has been generated
9617 for KEY. Don't modify the event; this would
9618 prevent proper action when the event is pushed
9619 back into unread-command-events. */
9620 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9622 /* If on a mode line string with a local keymap,
9623 reconsider the key sequence with that keymap. */
9624 if (string
= POSN_STRING (EVENT_START (key
)),
9625 (CONSP (string
) && STRINGP (XCAR (string
))))
9627 Lisp_Object pos
, map
, map2
;
9629 pos
= XCDR (string
);
9630 string
= XCAR (string
);
9632 && XINT (pos
) < SCHARS (string
))
9634 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9636 orig_local_map
= map
;
9637 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9640 if (!NILP (map
) || !NILP (map2
))
9641 goto replay_sequence
;
9647 else if (NILP (from_string
)
9648 && (string
= POSN_STRING (EVENT_START (key
)),
9649 (CONSP (string
) && STRINGP (XCAR (string
)))))
9651 /* For a click on a string, i.e. overlay string or a
9652 string displayed via the `display' property,
9653 consider `local-map' and `keymap' properties of
9655 Lisp_Object pos
, map
, map2
;
9657 pos
= XCDR (string
);
9658 string
= XCAR (string
);
9660 && XINT (pos
) < SCHARS (string
))
9662 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9664 orig_local_map
= map
;
9665 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9669 if (!NILP (map
) || !NILP (map2
))
9671 from_string
= string
;
9674 goto replay_sequence
;
9679 else if (CONSP (XCDR (key
))
9680 && CONSP (EVENT_START (key
))
9681 && CONSP (XCDR (EVENT_START (key
))))
9685 posn
= POSN_POSN (EVENT_START (key
));
9686 /* Handle menu-bar events:
9687 insert the dummy prefix event `menu-bar'. */
9688 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9690 if (bufsize
- t
<= 1)
9691 error ("Key sequence too long");
9695 /* Zap the position in key, so we know that we've
9696 expanded it, and don't try to do so again. */
9697 POSN_SET_POSN (EVENT_START (key
),
9698 Fcons (posn
, Qnil
));
9701 goto replay_sequence
;
9703 else if (CONSP (posn
))
9705 /* We're looking at the second event of a
9706 sequence which we expanded before. Set
9707 last_real_key_start appropriately. */
9708 if (last_real_key_start
== t
&& t
> 0)
9709 last_real_key_start
= t
- 1;
9714 /* We have finally decided that KEY is something we might want
9716 first_binding
= (follow_key (key
,
9717 nmaps
- first_binding
,
9718 submaps
+ first_binding
,
9719 defs
+ first_binding
,
9720 submaps
+ first_binding
)
9723 /* If KEY wasn't bound, we'll try some fallbacks. */
9724 if (first_binding
< nmaps
)
9725 /* This is needed for the following scenario:
9726 event 0: a down-event that gets dropped by calling replay_key.
9727 event 1: some normal prefix like C-h.
9728 After event 0, first_unbound is 0, after event 1 indec.start,
9729 fkey.start, and keytran.start are all 1, so when we see that
9730 C-h is bound, we need to update first_unbound. */
9731 first_unbound
= max (t
+ 1, first_unbound
);
9736 /* Remember the position to put an upper bound on indec.start. */
9737 first_unbound
= min (t
, first_unbound
);
9739 head
= EVENT_HEAD (key
);
9740 if (help_char_p (head
) && t
> 0)
9742 read_key_sequence_cmd
= Vprefix_help_command
;
9744 last_nonmenu_event
= key
;
9745 /* The Microsoft C compiler can't handle the goto that
9753 Lisp_Object breakdown
;
9756 breakdown
= parse_modifiers (head
);
9757 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9758 /* Attempt to reduce an unbound mouse event to a simpler
9759 event that is bound:
9760 Drags reduce to clicks.
9761 Double-clicks reduce to clicks.
9762 Triple-clicks reduce to double-clicks, then to clicks.
9763 Down-clicks are eliminated.
9764 Double-downs reduce to downs, then are eliminated.
9765 Triple-downs reduce to double-downs, then to downs,
9766 then are eliminated. */
9767 if (modifiers
& (down_modifier
| drag_modifier
9768 | double_modifier
| triple_modifier
))
9770 while (modifiers
& (down_modifier
| drag_modifier
9771 | double_modifier
| triple_modifier
))
9773 Lisp_Object new_head
, new_click
;
9774 if (modifiers
& triple_modifier
)
9775 modifiers
^= (double_modifier
| triple_modifier
);
9776 else if (modifiers
& double_modifier
)
9777 modifiers
&= ~double_modifier
;
9778 else if (modifiers
& drag_modifier
)
9779 modifiers
&= ~drag_modifier
;
9782 /* Dispose of this `down' event by simply jumping
9783 back to replay_key, to get another event.
9785 Note that if this event came from mock input,
9786 then just jumping back to replay_key will just
9787 hand it to us again. So we have to wipe out any
9790 We could delete keybuf[t] and shift everything
9791 after that to the left by one spot, but we'd also
9792 have to fix up any variable that points into
9793 keybuf, and shifting isn't really necessary
9796 Adding prefixes for non-textual mouse clicks
9797 creates two characters of mock input, and both
9798 must be thrown away. If we're only looking at
9799 the prefix now, we can just jump back to
9800 replay_key. On the other hand, if we've already
9801 processed the prefix, and now the actual click
9802 itself is giving us trouble, then we've lost the
9803 state of the keymaps we want to backtrack to, and
9804 we need to replay the whole sequence to rebuild
9807 Beyond that, only function key expansion could
9808 create more than two keys, but that should never
9809 generate mouse events, so it's okay to zero
9810 mock_input in that case too.
9812 FIXME: The above paragraph seems just plain
9813 wrong, if you consider things like
9814 xterm-mouse-mode. -stef
9816 Isn't this just the most wonderful code ever? */
9818 /* If mock_input > t + 1, the above simplification
9819 will actually end up dropping keys on the floor.
9820 This is probably OK for now, but even
9821 if mock_input <= t + 1, we need to adjust indec,
9823 Typical case [header-line down-mouse-N]:
9824 mock_input = 2, t = 1, fkey.end = 1,
9825 last_real_key_start = 0. */
9826 if (indec
.end
> last_real_key_start
)
9828 indec
.end
= indec
.start
9829 = min (last_real_key_start
, indec
.start
);
9830 indec
.map
= indec
.parent
;
9831 if (fkey
.end
> last_real_key_start
)
9833 fkey
.end
= fkey
.start
9834 = min (last_real_key_start
, fkey
.start
);
9835 fkey
.map
= fkey
.parent
;
9836 if (keytran
.end
> last_real_key_start
)
9838 keytran
.end
= keytran
.start
9839 = min (last_real_key_start
, keytran
.start
);
9840 keytran
.map
= keytran
.parent
;
9844 if (t
== last_real_key_start
)
9851 mock_input
= last_real_key_start
;
9852 goto replay_sequence
;
9857 = apply_modifiers (modifiers
, XCAR (breakdown
));
9859 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9861 /* Look for a binding for this new key. follow_key
9862 promises that it didn't munge submaps the
9863 last time we called it, since key was unbound. */
9865 = (follow_key (new_click
,
9866 nmaps
- local_first_binding
,
9867 submaps
+ local_first_binding
,
9868 defs
+ local_first_binding
,
9869 submaps
+ local_first_binding
)
9870 + local_first_binding
);
9872 /* If that click is bound, go for it. */
9873 if (first_binding
< nmaps
)
9878 /* Otherwise, we'll leave key set to the drag event. */
9885 /* Normally, last_nonmenu_event gets the previous key we read.
9886 But when a mouse popup menu is being used,
9887 we don't update last_nonmenu_event; it continues to hold the mouse
9888 event that preceded the first level of menu. */
9889 if (!used_mouse_menu
)
9890 last_nonmenu_event
= key
;
9892 /* Record what part of this_command_keys is the current key sequence. */
9893 this_single_command_key_start
= this_command_key_count
- t
;
9895 /* Look for this sequence in input-decode-map.
9896 Scan from indec.end until we find a bound suffix. */
9897 while (indec
.end
< t
)
9899 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9902 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9903 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9908 mock_input
= diff
+ max (t
, mock_input
);
9909 goto replay_sequence
;
9913 if (first_binding
< nmaps
9914 && NILP (submaps
[first_binding
])
9915 && !test_undefined (defs
[first_binding
])
9916 && indec
.start
>= t
)
9917 /* There is a binding and it's not a prefix.
9918 (and it doesn't have any input-decode-map translation pending).
9919 There is thus no function-key in this sequence.
9920 Moving fkey.start is important in this case to allow keytran.start
9921 to go over the sequence before we return (since we keep the
9922 invariant that keytran.end <= fkey.start). */
9925 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9928 /* If the sequence is unbound, see if we can hang a function key
9929 off the end of it. */
9930 /* Continue scan from fkey.end until we find a bound suffix. */
9931 while (fkey
.end
< indec
.start
)
9933 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9936 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9937 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9938 max (t
, mock_input
),
9939 /* If there's a binding (i.e.
9940 first_binding >= nmaps) we don't want
9941 to apply this function-key-mapping. */
9943 && (first_binding
>= nmaps
9944 || test_undefined (defs
[first_binding
])),
9949 mock_input
= diff
+ max (t
, mock_input
);
9950 /* Adjust the input-decode-map counters. */
9952 indec
.start
+= diff
;
9954 goto replay_sequence
;
9958 /* Look for this sequence in key-translation-map.
9959 Scan from keytran.end until we find a bound suffix. */
9960 while (keytran
.end
< fkey
.start
)
9962 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9965 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9966 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9971 mock_input
= diff
+ max (t
, mock_input
);
9972 /* Adjust the function-key-map and input-decode-map counters. */
9974 indec
.start
+= diff
;
9978 goto replay_sequence
;
9982 /* If KEY is not defined in any of the keymaps,
9983 and cannot be part of a function key or translation,
9984 and is an upper case letter
9985 use the corresponding lower-case letter instead. */
9986 if (first_binding
>= nmaps
9987 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9989 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9990 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9991 || (XINT (key
) & shift_modifier
)))
9993 Lisp_Object new_key
;
9995 original_uppercase
= key
;
9996 original_uppercase_position
= t
- 1;
9998 if (XINT (key
) & shift_modifier
)
9999 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10001 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10002 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10004 /* We have to do this unconditionally, regardless of whether
10005 the lower-case char is defined in the keymaps, because they
10006 might get translated through function-key-map. */
10007 keybuf
[t
- 1] = new_key
;
10008 mock_input
= max (t
, mock_input
);
10009 shift_translated
= 1;
10011 goto replay_sequence
;
10013 /* If KEY is not defined in any of the keymaps,
10014 and cannot be part of a function key or translation,
10015 and is a shifted function key,
10016 use the corresponding unshifted function key instead. */
10017 if (first_binding
>= nmaps
10018 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10020 Lisp_Object breakdown
= parse_modifiers (key
);
10022 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10024 if (modifiers
& shift_modifier
10025 /* Treat uppercase keys as shifted. */
10027 && (KEY_TO_CHAR (key
)
10028 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10029 && uppercasep (KEY_TO_CHAR (key
))))
10031 Lisp_Object new_key
10032 = (modifiers
& shift_modifier
10033 ? apply_modifiers (modifiers
& ~shift_modifier
,
10035 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10037 original_uppercase
= key
;
10038 original_uppercase_position
= t
- 1;
10040 /* We have to do this unconditionally, regardless of whether
10041 the lower-case char is defined in the keymaps, because they
10042 might get translated through function-key-map. */
10043 keybuf
[t
- 1] = new_key
;
10044 mock_input
= max (t
, mock_input
);
10045 /* Reset fkey (and consequently keytran) to apply
10046 function-key-map on the result, so that S-backspace is
10047 correctly mapped to DEL (via backspace). OTOH,
10048 input-decode-map doesn't need to go through it again. */
10049 fkey
.start
= fkey
.end
= 0;
10050 keytran
.start
= keytran
.end
= 0;
10051 shift_translated
= 1;
10053 goto replay_sequence
;
10058 read_key_sequence_cmd
= (first_binding
< nmaps
10059 ? defs
[first_binding
]
10061 read_key_sequence_remapped
10062 /* Remap command through active keymaps.
10063 Do the remapping here, before the unbind_to so it uses the keymaps
10064 of the appropriate buffer. */
10065 = SYMBOLP (read_key_sequence_cmd
)
10066 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10069 unread_switch_frame
= delayed_switch_frame
;
10070 unbind_to (count
, Qnil
);
10072 /* Don't downcase the last character if the caller says don't.
10073 Don't downcase it if the result is undefined, either. */
10074 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10076 && t
- 1 == original_uppercase_position
)
10078 keybuf
[t
- 1] = original_uppercase
;
10079 shift_translated
= 0;
10082 if (shift_translated
)
10083 Vthis_command_keys_shift_translated
= Qt
;
10085 /* Occasionally we fabricate events, perhaps by expanding something
10086 according to function-key-map, or by adding a prefix symbol to a
10087 mouse click in the scroll bar or modeline. In this cases, return
10088 the entire generated key sequence, even if we hit an unbound
10089 prefix or a definition before the end. This means that you will
10090 be able to push back the event properly, and also means that
10091 read-key-sequence will always return a logical unit.
10094 for (; t
< mock_input
; t
++)
10096 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10097 && NILP (Fzerop (Vecho_keystrokes
)))
10098 echo_char (keybuf
[t
]);
10099 add_command_key (keybuf
[t
]);
10106 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10107 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10108 The sequence is sufficient to specify a non-prefix command in the
10109 current local and global maps.
10111 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10112 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10113 as a continuation of the previous key.
10115 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10116 convert the last event to lower case. (Normally any upper case event
10117 is converted to lower case if the original event is undefined and the lower
10118 case equivalent is defined.) A non-nil value is appropriate for reading
10119 a key sequence to be defined.
10121 A C-g typed while in this function is treated like any other character,
10122 and `quit-flag' is not set.
10124 If the key sequence starts with a mouse click, then the sequence is read
10125 using the keymaps of the buffer of the window clicked in, not the buffer
10126 of the selected window as normal.
10128 `read-key-sequence' drops unbound button-down events, since you normally
10129 only care about the click or drag events which follow them. If a drag
10130 or multi-click event is unbound, but the corresponding click event would
10131 be bound, `read-key-sequence' turns the event into a click event at the
10132 drag's starting position. This means that you don't have to distinguish
10133 between click and drag, double, or triple events unless you want to.
10135 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10136 lines separating windows, and scroll bars with imaginary keys
10137 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10139 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10140 function will process a switch-frame event if the user switches frames
10141 before typing anything. If the user switches frames in the middle of a
10142 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10143 is nil, then the event will be put off until after the current key sequence.
10145 `read-key-sequence' checks `function-key-map' for function key
10146 sequences, where they wouldn't conflict with ordinary bindings. See
10147 `function-key-map' for more details.
10149 The optional fifth argument CMD-LOOP, if non-nil, means
10150 that this key sequence is being read by something that will
10151 read commands one after another. It should be nil if the caller
10152 will read just one key sequence. */)
10153 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10155 Lisp_Object keybuf
[30];
10157 struct gcpro gcpro1
;
10158 ptrdiff_t count
= SPECPDL_INDEX ();
10160 if (!NILP (prompt
))
10161 CHECK_STRING (prompt
);
10164 specbind (Qinput_method_exit_on_first_char
,
10165 (NILP (cmd_loop
) ? Qt
: Qnil
));
10166 specbind (Qinput_method_use_echo_area
,
10167 (NILP (cmd_loop
) ? Qt
: Qnil
));
10169 memset (keybuf
, 0, sizeof keybuf
);
10170 GCPRO1 (keybuf
[0]);
10171 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10173 if (NILP (continue_echo
))
10175 this_command_key_count
= 0;
10176 this_command_key_count_reset
= 0;
10177 this_single_command_key_start
= 0;
10180 #ifdef HAVE_WINDOW_SYSTEM
10181 if (display_hourglass_p
)
10182 cancel_hourglass ();
10185 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10186 prompt
, ! NILP (dont_downcase_last
),
10187 ! NILP (can_return_switch_frame
), 0);
10189 #if 0 /* The following is fine for code reading a key sequence and
10190 then proceeding with a lengthy computation, but it's not good
10191 for code reading keys in a loop, like an input method. */
10192 #ifdef HAVE_WINDOW_SYSTEM
10193 if (display_hourglass_p
)
10194 start_hourglass ();
10204 return unbind_to (count
, make_event_array (i
, keybuf
));
10207 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10208 Sread_key_sequence_vector
, 1, 5, 0,
10209 doc
: /* Like `read-key-sequence' but always return a vector. */)
10210 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10212 Lisp_Object keybuf
[30];
10214 struct gcpro gcpro1
;
10215 ptrdiff_t count
= SPECPDL_INDEX ();
10217 if (!NILP (prompt
))
10218 CHECK_STRING (prompt
);
10221 specbind (Qinput_method_exit_on_first_char
,
10222 (NILP (cmd_loop
) ? Qt
: Qnil
));
10223 specbind (Qinput_method_use_echo_area
,
10224 (NILP (cmd_loop
) ? Qt
: Qnil
));
10226 memset (keybuf
, 0, sizeof keybuf
);
10227 GCPRO1 (keybuf
[0]);
10228 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10230 if (NILP (continue_echo
))
10232 this_command_key_count
= 0;
10233 this_command_key_count_reset
= 0;
10234 this_single_command_key_start
= 0;
10237 #ifdef HAVE_WINDOW_SYSTEM
10238 if (display_hourglass_p
)
10239 cancel_hourglass ();
10242 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10243 prompt
, ! NILP (dont_downcase_last
),
10244 ! NILP (can_return_switch_frame
), 0);
10246 #ifdef HAVE_WINDOW_SYSTEM
10247 if (display_hourglass_p
)
10248 start_hourglass ();
10257 return unbind_to (count
, Fvector (i
, keybuf
));
10260 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10261 doc
: /* Execute CMD as an editor command.
10262 CMD must be a symbol that satisfies the `commandp' predicate.
10263 Optional second arg RECORD-FLAG non-nil
10264 means unconditionally put this command in `command-history'.
10265 Otherwise, that is done only if an arg is read using the minibuffer.
10266 The argument KEYS specifies the value to use instead of (this-command-keys)
10267 when reading the arguments; if it is nil, (this-command-keys) is used.
10268 The argument SPECIAL, if non-nil, means that this command is executing
10269 a special event, so ignore the prefix argument and don't clear it. */)
10270 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10272 register Lisp_Object final
;
10273 register Lisp_Object tem
;
10274 Lisp_Object prefixarg
;
10276 debug_on_next_call
= 0;
10278 if (NILP (special
))
10280 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10281 Vcurrent_prefix_arg
= prefixarg
;
10282 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10289 tem
= Fget (cmd
, Qdisabled
);
10292 tem
= Fsymbol_value (Qdisabled_command_function
);
10294 return Frun_hooks (1, &Qdisabled_command_function
);
10300 final
= Findirect_function (cmd
, Qnil
);
10302 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10304 struct gcpro gcpro1
, gcpro2
;
10306 GCPRO2 (cmd
, prefixarg
);
10307 do_autoload (final
, cmd
);
10314 if (STRINGP (final
) || VECTORP (final
))
10316 /* If requested, place the macro in the command history. For
10317 other sorts of commands, call-interactively takes care of
10319 if (!NILP (record_flag
))
10322 = Fcons (Fcons (Qexecute_kbd_macro
,
10323 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10326 /* Don't keep command history around forever. */
10327 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10329 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10331 XSETCDR (tem
, Qnil
);
10335 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10338 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10339 /* Don't call Fcall_interactively directly because we want to make
10340 sure the backtrace has an entry for `call-interactively'.
10341 For the same reason, pass `cmd' rather than `final'. */
10342 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10349 /* Return nonzero if input events are pending. */
10352 detect_input_pending (void)
10354 if (!input_pending
)
10355 get_input_pending (&input_pending
, 0);
10357 return input_pending
;
10360 /* Return nonzero if input events other than mouse movements are
10364 detect_input_pending_ignore_squeezables (void)
10366 if (!input_pending
)
10367 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10369 return input_pending
;
10372 /* Return nonzero if input events are pending, and run any pending timers. */
10375 detect_input_pending_run_timers (int do_display
)
10377 int old_timers_run
= timers_run
;
10379 if (!input_pending
)
10380 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10382 if (old_timers_run
!= timers_run
&& do_display
)
10384 redisplay_preserve_echo_area (8);
10385 /* The following fixes a bug when using lazy-lock with
10386 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10387 from an idle timer function. The symptom of the bug is that
10388 the cursor sometimes doesn't become visible until the next X
10389 event is processed. --gerd. */
10391 Lisp_Object tail
, frame
;
10392 FOR_EACH_FRAME (tail
, frame
)
10393 if (FRAME_RIF (XFRAME (frame
)))
10394 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10398 return input_pending
;
10401 /* This is called in some cases before a possible quit.
10402 It cases the next call to detect_input_pending to recompute input_pending.
10403 So calling this function unnecessarily can't do any harm. */
10406 clear_input_pending (void)
10411 /* Return nonzero if there are pending requeued events.
10412 This isn't used yet. The hope is to make wait_reading_process_output
10413 call it, and return if it runs Lisp code that unreads something.
10414 The problem is, kbd_buffer_get_event needs to be fixed to know what
10415 to do in that case. It isn't trivial. */
10418 requeued_events_pending_p (void)
10420 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10424 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10425 doc
: /* Return t if command input is currently available with no wait.
10426 Actually, the value is nil only if we can be sure that no input is available;
10427 if there is a doubt, the value is t. */)
10430 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10431 || !NILP (Vunread_post_input_method_events
)
10432 || !NILP (Vunread_input_method_events
))
10435 /* Process non-user-visible events (Bug#10195). */
10436 process_special_events ();
10438 get_input_pending (&input_pending
,
10439 READABLE_EVENTS_DO_TIMERS_NOW
10440 | READABLE_EVENTS_FILTER_EVENTS
);
10441 return input_pending
> 0 ? Qt
: Qnil
;
10444 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10445 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10448 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10451 if (total_keys
< NUM_RECENT_KEYS
)
10452 return Fvector (total_keys
, keys
);
10455 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10456 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10457 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10458 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10459 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10464 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10465 doc
: /* Return the key sequence that invoked this command.
10466 However, if the command has called `read-key-sequence', it returns
10467 the last key sequence that has been read.
10468 The value is a string or a vector.
10470 See also `this-command-keys-vector'. */)
10473 return make_event_array (this_command_key_count
,
10474 XVECTOR (this_command_keys
)->contents
);
10477 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10478 doc
: /* Return the key sequence that invoked this command, as a vector.
10479 However, if the command has called `read-key-sequence', it returns
10480 the last key sequence that has been read.
10482 See also `this-command-keys'. */)
10485 return Fvector (this_command_key_count
,
10486 XVECTOR (this_command_keys
)->contents
);
10489 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10490 Sthis_single_command_keys
, 0, 0, 0,
10491 doc
: /* Return the key sequence that invoked this command.
10492 More generally, it returns the last key sequence read, either by
10493 the command loop or by `read-key-sequence'.
10494 Unlike `this-command-keys', this function's value
10495 does not include prefix arguments.
10496 The value is always a vector. */)
10499 return Fvector (this_command_key_count
10500 - this_single_command_key_start
,
10501 (XVECTOR (this_command_keys
)->contents
10502 + this_single_command_key_start
));
10505 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10506 Sthis_single_command_raw_keys
, 0, 0, 0,
10507 doc
: /* Return the raw events that were read for this command.
10508 More generally, it returns the last key sequence read, either by
10509 the command loop or by `read-key-sequence'.
10510 Unlike `this-single-command-keys', this function's value
10511 shows the events before all translations (except for input methods).
10512 The value is always a vector. */)
10515 return Fvector (raw_keybuf_count
,
10516 (XVECTOR (raw_keybuf
)->contents
));
10519 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10520 Sreset_this_command_lengths
, 0, 0, 0,
10521 doc
: /* Make the unread events replace the last command and echo.
10522 Used in `universal-argument-other-key'.
10524 `universal-argument-other-key' rereads the event just typed.
10525 It then gets translated through `function-key-map'.
10526 The translated event has to replace the real events,
10527 both in the value of (this-command-keys) and in echoing.
10528 To achieve this, `universal-argument-other-key' calls
10529 `reset-this-command-lengths', which discards the record of reading
10530 these events the first time. */)
10533 this_command_key_count
= before_command_key_count
;
10534 if (this_command_key_count
< this_single_command_key_start
)
10535 this_single_command_key_start
= this_command_key_count
;
10537 echo_truncate (before_command_echo_length
);
10539 /* Cause whatever we put into unread-command-events
10540 to echo as if it were being freshly read from the keyboard. */
10541 this_command_key_count_reset
= 1;
10546 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10547 Sclear_this_command_keys
, 0, 1, 0,
10548 doc
: /* Clear out the vector that `this-command-keys' returns.
10549 Also clear the record of the last 100 events, unless optional arg
10550 KEEP-RECORD is non-nil. */)
10551 (Lisp_Object keep_record
)
10555 this_command_key_count
= 0;
10556 this_command_key_count_reset
= 0;
10558 if (NILP (keep_record
))
10560 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10561 ASET (recent_keys
, i
, Qnil
);
10563 recent_keys_index
= 0;
10568 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10569 doc
: /* Return the current depth in recursive edits. */)
10573 /* Wrap around reliably on integer overflow. */
10574 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10575 XSETINT (temp
, sum
);
10579 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10580 "FOpen dribble file: ",
10581 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10582 If FILE is nil, close any open dribble file.
10583 The file will be closed when Emacs exits. */)
10595 file
= Fexpand_file_name (file
, Qnil
);
10596 dribble
= fopen (SSDATA (file
), "w");
10598 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10603 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10604 doc
: /* Discard the contents of the terminal input buffer.
10605 Also end any kbd macro being defined. */)
10608 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10610 /* Discard the last command from the macro. */
10611 Fcancel_kbd_macro_events ();
10615 update_mode_lines
++;
10617 Vunread_command_events
= Qnil
;
10618 unread_command_char
= -1;
10620 discard_tty_input ();
10622 kbd_fetch_ptr
= kbd_store_ptr
;
10628 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10629 doc
: /* Stop Emacs and return to superior process. You can resume later.
10630 If `cannot-suspend' is non-nil, or if the system doesn't support job
10631 control, run a subshell instead.
10633 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10634 to be read as terminal input by Emacs's parent, after suspension.
10636 Before suspending, run the normal hook `suspend-hook'.
10637 After resumption run the normal hook `suspend-resume-hook'.
10639 Some operating systems cannot stop the Emacs process and resume it later.
10640 On such systems, Emacs starts a subshell instead of suspending. */)
10641 (Lisp_Object stuffstring
)
10643 ptrdiff_t count
= SPECPDL_INDEX ();
10644 int old_height
, old_width
;
10646 struct gcpro gcpro1
;
10649 if (tty_list
&& tty_list
->next
)
10650 error ("There are other tty frames open; close them before suspending Emacs");
10652 if (!NILP (stuffstring
))
10653 CHECK_STRING (stuffstring
);
10655 /* Run the functions in suspend-hook. */
10656 hook
= intern ("suspend-hook");
10657 Frun_hooks (1, &hook
);
10659 GCPRO1 (stuffstring
);
10660 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10661 reset_all_sys_modes ();
10662 /* sys_suspend can get an error if it tries to fork a subshell
10663 and the system resources aren't available for that. */
10664 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10666 stuff_buffered_input (stuffstring
);
10667 if (cannot_suspend
)
10671 unbind_to (count
, Qnil
);
10673 /* Check if terminal/window size has changed.
10674 Note that this is not useful when we are running directly
10675 with a window system; but suspend should be disabled in that case. */
10676 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10677 if (width
!= old_width
|| height
!= old_height
)
10678 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10680 /* Run suspend-resume-hook. */
10681 hook
= intern ("suspend-resume-hook");
10682 Frun_hooks (1, &hook
);
10688 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10689 Then in any case stuff anything Emacs has read ahead and not used. */
10692 stuff_buffered_input (Lisp_Object stuffstring
)
10694 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10695 register unsigned char *p
;
10697 if (STRINGP (stuffstring
))
10699 register ptrdiff_t count
;
10701 p
= SDATA (stuffstring
);
10702 count
= SBYTES (stuffstring
);
10703 while (count
-- > 0)
10708 /* Anything we have read ahead, put back for the shell to read. */
10709 /* ?? What should this do when we have multiple keyboards??
10710 Should we ignore anything that was typed in at the "wrong" kboard?
10712 rms: we should stuff everything back into the kboard
10714 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10717 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10718 kbd_fetch_ptr
= kbd_buffer
;
10719 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10720 stuff_char (kbd_fetch_ptr
->code
);
10722 clear_event (kbd_fetch_ptr
);
10726 #endif /* SIGTSTP */
10730 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10732 input_available_clear_time
= time_to_clear
;
10734 /* Tell handle_interrupt to throw back to read_char, */
10735 waiting_for_input
= 1;
10737 /* If handle_interrupt was called before and buffered a C-g,
10738 make it run again now, to avoid timing error. */
10739 if (!NILP (Vquit_flag
))
10740 quit_throw_to_read_char (0);
10744 clear_waiting_for_input (void)
10746 /* Tell handle_interrupt not to throw back to read_char, */
10747 waiting_for_input
= 0;
10748 input_available_clear_time
= 0;
10751 /* The SIGINT handler.
10753 If we have a frame on the controlling tty, we assume that the
10754 SIGINT was generated by C-g, so we call handle_interrupt.
10755 Otherwise, tell QUIT to kill Emacs. */
10758 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10759 /* compilers complain in signal calls. */
10761 /* Must preserve main program's value of errno. */
10762 int old_errno
= errno
;
10763 struct terminal
*terminal
;
10765 SIGNAL_THREAD_CHECK (signalnum
);
10767 /* See if we have an active terminal on our controlling tty. */
10768 terminal
= get_named_tty ("/dev/tty");
10771 /* If there are no frames there, let's pretend that we are a
10772 well-behaving UN*X program and quit. We must not call Lisp
10773 in a signal handler, so tell QUIT to exit when it is
10775 Vquit_flag
= Qkill_emacs
;
10779 /* Otherwise, the SIGINT was probably generated by C-g. */
10781 /* Set internal_last_event_frame to the top frame of the
10782 controlling tty, if we have a frame there. We disable the
10783 interrupt key on secondary ttys, so the SIGINT must have come
10784 from the controlling tty. */
10785 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10787 handle_interrupt ();
10793 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10794 of the number of times C-g has been requested. If C-g is pressed
10795 enough times, then quit anyway. See bug#6585. */
10796 static int force_quit_count
;
10798 /* This routine is called at interrupt level in response to C-g.
10800 It is called from the SIGINT handler or kbd_buffer_store_event.
10802 If `waiting_for_input' is non zero, then unless `echoing' is
10803 nonzero, immediately throw back to read_char.
10805 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10806 eval to throw, when it gets a chance. If quit-flag is already
10807 non-nil, it stops the job right away. */
10810 handle_interrupt (void)
10816 /* XXX This code needs to be revised for multi-tty support. */
10817 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10819 /* If SIGINT isn't blocked, don't let us be interrupted by
10820 another SIGINT, it might be harmful due to non-reentrancy
10821 in I/O functions. */
10822 sigblock (sigmask (SIGINT
));
10825 reset_all_sys_modes ();
10827 #ifdef SIGTSTP /* Support possible in later USG versions */
10829 * On systems which can suspend the current process and return to the original
10830 * shell, this command causes the user to end up back at the shell.
10831 * The "Auto-save" and "Abort" questions are not asked until
10832 * the user elects to return to emacs, at which point he can save the current
10833 * job and either dump core or continue.
10837 /* Perhaps should really fork an inferior shell?
10838 But that would not provide any way to get back
10839 to the original shell, ever. */
10840 printf ("No support for stopping a process on this operating system;\n");
10841 printf ("you can continue or abort.\n");
10842 #endif /* not SIGTSTP */
10844 /* We must remain inside the screen area when the internal terminal
10845 is used. Note that [Enter] is not echoed by dos. */
10846 cursor_to (SELECTED_FRAME (), 0, 0);
10848 /* It doesn't work to autosave while GC is in progress;
10849 the code used for auto-saving doesn't cope with the mark bit. */
10850 if (!gc_in_progress
)
10852 printf ("Auto-save? (y or n) ");
10854 if (((c
= getchar ()) & ~040) == 'Y')
10856 Fdo_auto_save (Qt
, Qnil
);
10858 printf ("\r\nAuto-save done");
10859 #else /* not MSDOS */
10860 printf ("Auto-save done\n");
10861 #endif /* not MSDOS */
10863 while (c
!= '\n') c
= getchar ();
10867 /* During GC, it must be safe to reenable quitting again. */
10868 Vinhibit_quit
= Qnil
;
10871 #endif /* not MSDOS */
10872 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10873 printf ("but will instead do a real quit after garbage collection ends\r\n");
10878 printf ("\r\nAbort? (y or n) ");
10879 #else /* not MSDOS */
10880 printf ("Abort (and dump core)? (y or n) ");
10881 #endif /* not MSDOS */
10883 if (((c
= getchar ()) & ~040) == 'Y')
10885 while (c
!= '\n') c
= getchar ();
10887 printf ("\r\nContinuing...\r\n");
10888 #else /* not MSDOS */
10889 printf ("Continuing...\n");
10890 #endif /* not MSDOS */
10892 init_all_sys_modes ();
10897 /* If executing a function that wants to be interrupted out of
10898 and the user has not deferred quitting by binding `inhibit-quit'
10899 then quit right away. */
10900 if (immediate_quit
&& NILP (Vinhibit_quit
))
10902 struct gl_state_s saved
;
10903 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10905 immediate_quit
= 0;
10908 GCPRO4 (saved
.object
, saved
.global_code
,
10909 saved
.current_syntax_table
, saved
.old_prop
);
10910 Fsignal (Qquit
, Qnil
);
10911 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10916 { /* Else request quit when it's safe. */
10917 if (NILP (Vquit_flag
))
10918 force_quit_count
= 0;
10919 if (++force_quit_count
== 3)
10921 immediate_quit
= 1;
10922 Vinhibit_quit
= Qnil
;
10928 /* TODO: The longjmp in this call throws the NS event loop integration off,
10929 and it seems to do fine without this. Probably some attention
10930 needs to be paid to the setting of waiting_for_input in
10931 wait_reading_process_output() under HAVE_NS because of the call
10932 to ns_select there (needed because otherwise events aren't picked up
10933 outside of polling since we don't get SIGIO like X and we don't have a
10934 separate event loop thread like W32. */
10936 if (waiting_for_input
&& !echoing
)
10937 quit_throw_to_read_char (1);
10941 /* Handle a C-g by making read_char return C-g. */
10944 quit_throw_to_read_char (int from_signal
)
10946 /* When not called from a signal handler it is safe to call
10948 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10949 Fkill_emacs (Qnil
);
10952 /* Prevent another signal from doing this before we finish. */
10953 clear_waiting_for_input ();
10956 Vunread_command_events
= Qnil
;
10957 unread_command_char
= -1;
10959 #if 0 /* Currently, sit_for is called from read_char without turning
10960 off polling. And that can call set_waiting_for_input.
10961 It seems to be harmless. */
10962 #ifdef POLL_FOR_INPUT
10963 /* May be > 1 if in recursive minibuffer. */
10964 if (poll_suppress_count
== 0)
10968 if (FRAMEP (internal_last_event_frame
)
10969 && !EQ (internal_last_event_frame
, selected_frame
))
10970 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10973 _longjmp (getcjmp
, 1);
10976 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10977 Sset_input_interrupt_mode
, 1, 1, 0,
10978 doc
: /* Set interrupt mode of reading keyboard input.
10979 If INTERRUPT is non-nil, Emacs will use input interrupts;
10980 otherwise Emacs uses CBREAK mode.
10982 See also `current-input-mode'. */)
10983 (Lisp_Object interrupt
)
10985 int new_interrupt_input
;
10987 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10988 #ifdef HAVE_X_WINDOWS
10989 if (x_display_list
!= NULL
)
10991 /* When using X, don't give the user a real choice,
10992 because we haven't implemented the mechanisms to support it. */
10993 new_interrupt_input
= 1;
10996 #endif /* HAVE_X_WINDOWS */
10997 new_interrupt_input
= !NILP (interrupt
);
10998 #else /* not SIGIO */
10999 new_interrupt_input
= 0;
11000 #endif /* not SIGIO */
11002 if (new_interrupt_input
!= interrupt_input
)
11004 #ifdef POLL_FOR_INPUT
11008 /* this causes startup screen to be restored and messes with the mouse */
11009 reset_all_sys_modes ();
11010 interrupt_input
= new_interrupt_input
;
11011 init_all_sys_modes ();
11013 interrupt_input
= new_interrupt_input
;
11016 #ifdef POLL_FOR_INPUT
11017 poll_suppress_count
= 1;
11024 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11025 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11026 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11027 C-q in key sequences.
11029 This setting only has an effect on tty terminals and only when
11030 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11032 See also `current-input-mode'. */)
11033 (Lisp_Object flow
, Lisp_Object terminal
)
11035 struct terminal
*t
= get_terminal (terminal
, 1);
11036 struct tty_display_info
*tty
;
11037 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11039 tty
= t
->display_info
.tty
;
11041 if (tty
->flow_control
!= !NILP (flow
))
11044 /* this causes startup screen to be restored and messes with the mouse */
11045 reset_sys_modes (tty
);
11048 tty
->flow_control
= !NILP (flow
);
11051 init_sys_modes (tty
);
11057 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11058 doc
: /* Enable or disable 8-bit input on TERMINAL.
11059 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11060 bit as the Meta modifier.
11062 If META is nil, Emacs will ignore the top bit, on the assumption it is
11065 Otherwise, Emacs will accept and pass through 8-bit input without
11066 specially interpreting the top bit.
11068 This setting only has an effect on tty terminal devices.
11070 Optional parameter TERMINAL specifies the tty terminal device to use.
11071 It may be a terminal object, a frame, or nil for the terminal used by
11072 the currently selected frame.
11074 See also `current-input-mode'. */)
11075 (Lisp_Object meta
, Lisp_Object terminal
)
11077 struct terminal
*t
= get_terminal (terminal
, 1);
11078 struct tty_display_info
*tty
;
11081 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11083 tty
= t
->display_info
.tty
;
11087 else if (EQ (meta
, Qt
))
11092 if (tty
->meta_key
!= new_meta
)
11095 /* this causes startup screen to be restored and messes with the mouse */
11096 reset_sys_modes (tty
);
11099 tty
->meta_key
= new_meta
;
11102 init_sys_modes (tty
);
11108 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11109 doc
: /* Specify character used for quitting.
11110 QUIT must be an ASCII character.
11112 This function only has an effect on the controlling tty of the Emacs
11115 See also `current-input-mode'. */)
11118 struct terminal
*t
= get_named_tty ("/dev/tty");
11119 struct tty_display_info
*tty
;
11120 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11122 tty
= t
->display_info
.tty
;
11124 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11125 error ("QUIT must be an ASCII character");
11128 /* this causes startup screen to be restored and messes with the mouse */
11129 reset_sys_modes (tty
);
11132 /* Don't let this value be out of range. */
11133 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11136 init_sys_modes (tty
);
11142 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11143 doc
: /* Set mode of reading keyboard input.
11144 First arg INTERRUPT non-nil means use input interrupts;
11145 nil means use CBREAK mode.
11146 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11147 (no effect except in CBREAK mode).
11148 Third arg META t means accept 8-bit input (for a Meta key).
11149 META nil means ignore the top bit, on the assumption it is parity.
11150 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11151 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11152 See also `current-input-mode'. */)
11153 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11155 Fset_input_interrupt_mode (interrupt
);
11156 Fset_output_flow_control (flow
, Qnil
);
11157 Fset_input_meta_mode (meta
, Qnil
);
11159 Fset_quit_char (quit
);
11163 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11164 doc
: /* Return information about the way Emacs currently reads keyboard input.
11165 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11166 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11167 nil, Emacs is using CBREAK mode.
11168 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11169 terminal; this does not apply if Emacs uses interrupt-driven input.
11170 META is t if accepting 8-bit input with 8th bit as Meta flag.
11171 META nil means ignoring the top bit, on the assumption it is parity.
11172 META is neither t nor nil if accepting 8-bit input and using
11173 all 8 bits as the character code.
11174 QUIT is the character Emacs currently uses to quit.
11175 The elements of this list correspond to the arguments of
11176 `set-input-mode'. */)
11179 Lisp_Object val
[4];
11180 struct frame
*sf
= XFRAME (selected_frame
);
11182 val
[0] = interrupt_input
? Qt
: Qnil
;
11183 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11185 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11186 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11188 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11195 XSETFASTINT (val
[3], quit_char
);
11197 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11200 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11201 doc
: /* Return position information for pixel coordinates X and Y.
11202 By default, X and Y are relative to text area of the selected window.
11203 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11204 If optional fourth arg WHOLE is non-nil, X is relative to the left
11205 edge of the window.
11207 The return value is similar to a mouse click position:
11208 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11209 IMAGE (DX . DY) (WIDTH . HEIGHT))
11210 The `posn-' functions access elements of such lists. */)
11211 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11216 if (NILP (frame_or_window
))
11217 frame_or_window
= selected_window
;
11219 if (WINDOWP (frame_or_window
))
11223 CHECK_LIVE_WINDOW (frame_or_window
);
11225 w
= XWINDOW (frame_or_window
);
11226 XSETINT (x
, (XINT (x
)
11227 + WINDOW_LEFT_EDGE_X (w
)
11229 ? window_box_left_offset (w
, TEXT_AREA
)
11231 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11232 frame_or_window
= w
->frame
;
11235 CHECK_LIVE_FRAME (frame_or_window
);
11237 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11240 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11241 doc
: /* Return position information for buffer POS in WINDOW.
11242 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11244 Return nil if position is not visible in window. Otherwise,
11245 the return value is similar to that returned by `event-start' for
11246 a mouse click at the upper left corner of the glyph corresponding
11247 to the given buffer position:
11248 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11249 IMAGE (DX . DY) (WIDTH . HEIGHT))
11250 The `posn-' functions access elements of such lists. */)
11251 (Lisp_Object pos
, Lisp_Object window
)
11256 window
= selected_window
;
11258 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11261 Lisp_Object x
= XCAR (tem
);
11262 Lisp_Object y
= XCAR (XCDR (tem
));
11264 /* Point invisible due to hscrolling? */
11267 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11275 * Set up a new kboard object with reasonable initial values.
11278 init_kboard (KBOARD
*kb
)
11280 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11281 KVAR (kb
, Vlast_command
) = Qnil
;
11282 KVAR (kb
, Vreal_last_command
) = Qnil
;
11283 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11284 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11285 KVAR (kb
, Vprefix_arg
) = Qnil
;
11286 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11287 KVAR (kb
, kbd_queue
) = Qnil
;
11288 kb
->kbd_queue_has_data
= 0;
11289 kb
->immediate_echo
= 0;
11290 KVAR (kb
, echo_string
) = Qnil
;
11291 kb
->echo_after_prompt
= -1;
11292 kb
->kbd_macro_buffer
= 0;
11293 kb
->kbd_macro_bufsize
= 0;
11294 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11295 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11296 kb
->reference_count
= 0;
11297 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11298 KVAR (kb
, system_key_syms
) = Qnil
;
11299 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11300 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11301 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11302 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11303 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11307 * Destroy the contents of a kboard object, but not the object itself.
11308 * We use this just before deleting it, or if we're going to initialize
11309 * it a second time.
11312 wipe_kboard (KBOARD
*kb
)
11314 xfree (kb
->kbd_macro_buffer
);
11317 /* Free KB and memory referenced from it. */
11320 delete_kboard (KBOARD
*kb
)
11324 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11327 *kbp
= kb
->next_kboard
;
11329 /* Prevent a dangling reference to KB. */
11330 if (kb
== current_kboard
11331 && FRAMEP (selected_frame
)
11332 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11334 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11336 if (current_kboard
== kb
)
11345 init_keyboard (void)
11347 /* This is correct before outermost invocation of the editor loop */
11348 command_loop_level
= -1;
11349 immediate_quit
= 0;
11350 quit_char
= Ctl ('g');
11351 Vunread_command_events
= Qnil
;
11352 unread_command_char
= -1;
11353 EMACS_SET_INVALID_TIME (timer_idleness_start_time
);
11355 recent_keys_index
= 0;
11356 kbd_fetch_ptr
= kbd_buffer
;
11357 kbd_store_ptr
= kbd_buffer
;
11358 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11359 do_mouse_tracking
= Qnil
;
11362 interrupt_input_blocked
= 0;
11363 interrupt_input_pending
= 0;
11365 pending_signals
= 0;
11368 /* This means that command_loop_1 won't try to select anything the first
11370 internal_last_event_frame
= Qnil
;
11371 Vlast_event_frame
= internal_last_event_frame
;
11373 current_kboard
= initial_kboard
;
11374 /* Re-initialize the keyboard again. */
11375 wipe_kboard (current_kboard
);
11376 init_kboard (current_kboard
);
11377 /* A value of nil for Vwindow_system normally means a tty, but we also use
11378 it for the initial terminal since there is no window system there. */
11379 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11381 if (!noninteractive
)
11383 /* Before multi-tty support, these handlers used to be installed
11384 only if the current session was a tty session. Now an Emacs
11385 session may have multiple display types, so we always handle
11386 SIGINT. There is special code in interrupt_signal to exit
11387 Emacs on SIGINT when there are no termcap frames on the
11388 controlling terminal. */
11389 signal (SIGINT
, interrupt_signal
);
11391 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11392 SIGQUIT and we can't tell which one it will give us. */
11393 signal (SIGQUIT
, interrupt_signal
);
11394 #endif /* not DOS_NT */
11396 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11398 if (!noninteractive
)
11399 signal (SIGIO
, input_available_signal
);
11402 /* Use interrupt input by default, if it works and noninterrupt input
11403 has deficiencies. */
11405 #ifdef INTERRUPT_INPUT
11406 interrupt_input
= 1;
11408 interrupt_input
= 0;
11414 if (keyboard_init_hook
)
11415 (*keyboard_init_hook
) ();
11417 #ifdef POLL_FOR_INPUT
11419 poll_suppress_count
= 1;
11424 /* This type's only use is in syms_of_keyboard, to initialize the
11425 event header symbols and put properties on them. */
11426 struct event_head
{
11432 static const struct event_head head_table
[] = {
11433 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11434 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11435 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11436 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11437 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11438 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11439 /* `select-window' should be handled just like `switch-frame'
11440 in read_key_sequence. */
11441 {&Qselect_window
, "select-window", &Qswitch_frame
}
11445 syms_of_keyboard (void)
11447 pending_funcalls
= Qnil
;
11448 staticpro (&pending_funcalls
);
11450 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11451 staticpro (&Vlispy_mouse_stem
);
11454 DEFSYM (QCimage
, ":image");
11455 DEFSYM (Qhelp_echo
, "help-echo");
11456 DEFSYM (QCrtl
, ":rtl");
11458 staticpro (&item_properties
);
11459 item_properties
= Qnil
;
11461 staticpro (&tool_bar_item_properties
);
11462 tool_bar_item_properties
= Qnil
;
11463 staticpro (&tool_bar_items_vector
);
11464 tool_bar_items_vector
= Qnil
;
11466 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11467 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11468 DEFSYM (Qself_insert_command
, "self-insert-command");
11469 DEFSYM (Qforward_char
, "forward-char");
11470 DEFSYM (Qbackward_char
, "backward-char");
11471 DEFSYM (Qdisabled
, "disabled");
11472 DEFSYM (Qundefined
, "undefined");
11473 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11474 DEFSYM (Qpost_command_hook
, "post-command-hook");
11475 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11476 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11477 DEFSYM (Qfunction_key
, "function-key");
11478 DEFSYM (Qmouse_click
, "mouse-click");
11479 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11480 DEFSYM (Qsave_session
, "save-session");
11481 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11482 DEFSYM (Qmenu_enable
, "menu-enable");
11484 #if defined (WINDOWSNT)
11485 DEFSYM (Qlanguage_change
, "language-change");
11489 DEFSYM (Qdbus_event
, "dbus-event");
11492 DEFSYM (QCenable
, ":enable");
11493 DEFSYM (QCvisible
, ":visible");
11494 DEFSYM (QChelp
, ":help");
11495 DEFSYM (QCfilter
, ":filter");
11496 DEFSYM (QCbutton
, ":button");
11497 DEFSYM (QCkeys
, ":keys");
11498 DEFSYM (QCkey_sequence
, ":key-sequence");
11499 DEFSYM (QCtoggle
, ":toggle");
11500 DEFSYM (QCradio
, ":radio");
11501 DEFSYM (QClabel
, ":label");
11502 DEFSYM (QCvert_only
, ":vert-only");
11504 DEFSYM (Qmode_line
, "mode-line");
11505 DEFSYM (Qvertical_line
, "vertical-line");
11506 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11507 DEFSYM (Qmenu_bar
, "menu-bar");
11509 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11510 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11513 DEFSYM (Qabove_handle
, "above-handle");
11514 DEFSYM (Qhandle
, "handle");
11515 DEFSYM (Qbelow_handle
, "below-handle");
11516 DEFSYM (Qup
, "up");
11517 DEFSYM (Qdown
, "down");
11518 DEFSYM (Qtop
, "top");
11519 DEFSYM (Qbottom
, "bottom");
11520 DEFSYM (Qend_scroll
, "end-scroll");
11521 DEFSYM (Qratio
, "ratio");
11523 DEFSYM (Qevent_kind
, "event-kind");
11524 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11525 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11526 DEFSYM (Qmodifier_cache
, "modifier-cache");
11528 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11529 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11531 DEFSYM (Qpolling_period
, "polling-period");
11533 DEFSYM (Qx_set_selection
, "x-set-selection");
11534 DEFSYM (QPRIMARY
, "PRIMARY");
11535 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11536 DEFSYM (Qhandle_select_window
, "handle-select-window");
11538 DEFSYM (Qinput_method_function
, "input-method-function");
11539 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11540 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11542 DEFSYM (Qhelp_form_show
, "help-form-show");
11544 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11545 Fset (Qinput_method_use_echo_area
, Qnil
);
11547 last_point_position_buffer
= Qnil
;
11548 last_point_position_window
= Qnil
;
11552 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11554 for (i
= 0; i
< len
; i
++)
11556 const struct event_head
*p
= &head_table
[i
];
11557 *p
->var
= intern_c_string (p
->name
);
11558 staticpro (p
->var
);
11559 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11560 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11564 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11565 staticpro (&button_down_location
);
11566 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11567 staticpro (&mouse_syms
);
11568 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11569 / sizeof (lispy_wheel_names
[0])),
11571 staticpro (&wheel_syms
);
11575 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11577 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11578 for (i
= 0; i
< len
; i
++)
11579 if (modifier_names
[i
])
11580 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11581 staticpro (&modifier_symbols
);
11584 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11585 staticpro (&recent_keys
);
11587 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11588 staticpro (&this_command_keys
);
11590 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11591 staticpro (&raw_keybuf
);
11593 DEFSYM (Qextended_command_history
, "extended-command-history");
11594 Fset (Qextended_command_history
, Qnil
);
11596 accent_key_syms
= Qnil
;
11597 staticpro (&accent_key_syms
);
11599 func_key_syms
= Qnil
;
11600 staticpro (&func_key_syms
);
11602 drag_n_drop_syms
= Qnil
;
11603 staticpro (&drag_n_drop_syms
);
11605 unread_switch_frame
= Qnil
;
11606 staticpro (&unread_switch_frame
);
11608 internal_last_event_frame
= Qnil
;
11609 staticpro (&internal_last_event_frame
);
11611 read_key_sequence_cmd
= Qnil
;
11612 staticpro (&read_key_sequence_cmd
);
11613 read_key_sequence_remapped
= Qnil
;
11614 staticpro (&read_key_sequence_remapped
);
11616 menu_bar_one_keymap_changed_items
= Qnil
;
11617 staticpro (&menu_bar_one_keymap_changed_items
);
11619 menu_bar_items_vector
= Qnil
;
11620 staticpro (&menu_bar_items_vector
);
11622 help_form_saved_window_configs
= Qnil
;
11623 staticpro (&help_form_saved_window_configs
);
11625 defsubr (&Scurrent_idle_time
);
11626 defsubr (&Sevent_symbol_parse_modifiers
);
11627 defsubr (&Sevent_convert_list
);
11628 defsubr (&Sread_key_sequence
);
11629 defsubr (&Sread_key_sequence_vector
);
11630 defsubr (&Srecursive_edit
);
11631 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11632 defsubr (&Strack_mouse
);
11634 defsubr (&Sinput_pending_p
);
11635 defsubr (&Scommand_execute
);
11636 defsubr (&Srecent_keys
);
11637 defsubr (&Sthis_command_keys
);
11638 defsubr (&Sthis_command_keys_vector
);
11639 defsubr (&Sthis_single_command_keys
);
11640 defsubr (&Sthis_single_command_raw_keys
);
11641 defsubr (&Sreset_this_command_lengths
);
11642 defsubr (&Sclear_this_command_keys
);
11643 defsubr (&Ssuspend_emacs
);
11644 defsubr (&Sabort_recursive_edit
);
11645 defsubr (&Sexit_recursive_edit
);
11646 defsubr (&Srecursion_depth
);
11647 defsubr (&Stop_level
);
11648 defsubr (&Sdiscard_input
);
11649 defsubr (&Sopen_dribble_file
);
11650 defsubr (&Sset_input_interrupt_mode
);
11651 defsubr (&Sset_output_flow_control
);
11652 defsubr (&Sset_input_meta_mode
);
11653 defsubr (&Sset_quit_char
);
11654 defsubr (&Sset_input_mode
);
11655 defsubr (&Scurrent_input_mode
);
11656 defsubr (&Sposn_at_point
);
11657 defsubr (&Sposn_at_x_y
);
11659 DEFVAR_LISP ("last-command-event", last_command_event
,
11660 doc
: /* Last input event that was part of a command. */);
11662 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11663 doc
: /* Last input event in a command, except for mouse menu events.
11664 Mouse menus give back keys that don't look like mouse events;
11665 this variable holds the actual mouse event that led to the menu,
11666 so that you can determine whether the command was run by mouse or not. */);
11668 DEFVAR_LISP ("last-input-event", last_input_event
,
11669 doc
: /* Last input event. */);
11671 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11672 doc
: /* List of events to be read as the command input.
11673 These events are processed first, before actual keyboard input.
11674 Events read from this list are not normally added to `this-command-keys',
11675 as they will already have been added once as they were read for the first time.
11676 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11677 Vunread_command_events
= Qnil
;
11679 DEFVAR_INT ("unread-command-char", unread_command_char
,
11680 doc
: /* If not -1, an object to be read as next command input event. */);
11682 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11683 doc
: /* List of events to be processed as input by input methods.
11684 These events are processed before `unread-command-events'
11685 and actual keyboard input, but are not given to `input-method-function'. */);
11686 Vunread_post_input_method_events
= Qnil
;
11688 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11689 doc
: /* List of events to be processed as input by input methods.
11690 These events are processed after `unread-command-events', but
11691 before actual keyboard input.
11692 If there's an active input method, the events are given to
11693 `input-method-function'. */);
11694 Vunread_input_method_events
= Qnil
;
11696 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11697 doc
: /* Meta-prefix character code.
11698 Meta-foo as command input turns into this character followed by foo. */);
11699 XSETINT (meta_prefix_char
, 033);
11701 DEFVAR_KBOARD ("last-command", Vlast_command
,
11702 doc
: /* The last command executed.
11703 Normally a symbol with a function definition, but can be whatever was found
11704 in the keymap, or whatever the variable `this-command' was set to by that
11707 The value `mode-exit' is special; it means that the previous command
11708 read an event that told it to exit, and it did so and unread that event.
11709 In other words, the present command is the event that made the previous
11712 The value `kill-region' is special; it means that the previous command
11713 was a kill command.
11715 `last-command' has a separate binding for each terminal device.
11716 See Info node `(elisp)Multiple Terminals'. */);
11718 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11719 doc
: /* Same as `last-command', but never altered by Lisp code.
11720 Taken from the previous value of `real-this-command'. */);
11722 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11723 doc
: /* Last command that may be repeated.
11724 The last command executed that was not bound to an input event.
11725 This is the command `repeat' will try to repeat.
11726 Taken from a previous value of `real-this-command'. */);
11728 DEFVAR_LISP ("this-command", Vthis_command
,
11729 doc
: /* The command now being executed.
11730 The command can set this variable; whatever is put here
11731 will be in `last-command' during the following command. */);
11732 Vthis_command
= Qnil
;
11734 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11735 doc
: /* This is like `this-command', except that commands should never modify it. */);
11736 Vreal_this_command
= Qnil
;
11738 DEFVAR_LISP ("this-command-keys-shift-translated",
11739 Vthis_command_keys_shift_translated
,
11740 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11741 Shift-translation occurs when there is no binding for the key sequence
11742 as entered, but a binding was found by changing an upper-case letter
11743 to lower-case, or a shifted function key to an unshifted one. */);
11744 Vthis_command_keys_shift_translated
= Qnil
;
11746 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11747 doc
: /* The command bound to the current key sequence before remapping.
11748 It equals `this-command' if the original command was not remapped through
11749 any of the active keymaps. Otherwise, the value of `this-command' is the
11750 result of looking up the original command in the active keymaps. */);
11751 Vthis_original_command
= Qnil
;
11753 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11754 doc
: /* Number of input events between auto-saves.
11755 Zero means disable autosaving due to number of characters typed. */);
11756 auto_save_interval
= 300;
11758 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11759 doc
: /* Number of seconds idle time before auto-save.
11760 Zero or nil means disable auto-saving due to idleness.
11761 After auto-saving due to this many seconds of idle time,
11762 Emacs also does a garbage collection if that seems to be warranted. */);
11763 XSETFASTINT (Vauto_save_timeout
, 30);
11765 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11766 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11767 The value may be integer or floating point.
11768 If the value is zero, don't echo at all. */);
11769 Vecho_keystrokes
= make_number (1);
11771 DEFVAR_INT ("polling-period", polling_period
,
11772 doc
: /* Interval between polling for input during Lisp execution.
11773 The reason for polling is to make C-g work to stop a running program.
11774 Polling is needed only when using X windows and SIGIO does not work.
11775 Polling is automatically disabled in all other cases. */);
11776 polling_period
= 2;
11778 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11779 doc
: /* Maximum time between mouse clicks to make a double-click.
11780 Measured in milliseconds. The value nil means disable double-click
11781 recognition; t means double-clicks have no time limit and are detected
11782 by position only. */);
11783 Vdouble_click_time
= make_number (500);
11785 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11786 doc
: /* Maximum mouse movement between clicks to make a double-click.
11787 On window-system frames, value is the number of pixels the mouse may have
11788 moved horizontally or vertically between two clicks to make a double-click.
11789 On non window-system frames, value is interpreted in units of 1/8 characters
11792 This variable is also the threshold for motion of the mouse
11793 to count as a drag. */);
11794 double_click_fuzz
= 3;
11796 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11797 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11798 inhibit_local_menu_bar_menus
= 0;
11800 DEFVAR_INT ("num-input-keys", num_input_keys
,
11801 doc
: /* Number of complete key sequences read as input so far.
11802 This includes key sequences read from keyboard macros.
11803 The number is effectively the number of interactive command invocations. */);
11804 num_input_keys
= 0;
11806 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11807 doc
: /* Number of input events read from the keyboard so far.
11808 This does not include events generated by keyboard macros. */);
11809 num_nonmacro_input_events
= 0;
11811 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11812 doc
: /* The frame in which the most recently read event occurred.
11813 If the last event came from a keyboard macro, this is set to `macro'. */);
11814 Vlast_event_frame
= Qnil
;
11816 /* This variable is set up in sysdep.c. */
11817 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11818 doc
: /* The ERASE character as set by the user with stty. */);
11820 DEFVAR_LISP ("help-char", Vhelp_char
,
11821 doc
: /* Character to recognize as meaning Help.
11822 When it is read, do `(eval help-form)', and display result if it's a string.
11823 If the value of `help-form' is nil, this char can be read normally. */);
11824 XSETINT (Vhelp_char
, Ctl ('H'));
11826 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11827 doc
: /* List of input events to recognize as meaning Help.
11828 These work just like the value of `help-char' (see that). */);
11829 Vhelp_event_list
= Qnil
;
11831 DEFVAR_LISP ("help-form", Vhelp_form
,
11832 doc
: /* Form to execute when character `help-char' is read.
11833 If the form returns a string, that string is displayed.
11834 If `help-form' is nil, the help char is not recognized. */);
11837 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11838 doc
: /* Command to run when `help-char' character follows a prefix key.
11839 This command is used only when there is no actual binding
11840 for that character after that prefix key. */);
11841 Vprefix_help_command
= Qnil
;
11843 DEFVAR_LISP ("top-level", Vtop_level
,
11844 doc
: /* Form to evaluate when Emacs starts up.
11845 Useful to set before you dump a modified Emacs. */);
11848 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11849 doc
: /* Translate table for local keyboard input, or nil.
11850 If non-nil, the value should be a char-table. Each character read
11851 from the keyboard is looked up in this char-table. If the value found
11852 there is non-nil, then it is used instead of the actual input character.
11854 The value can also be a string or vector, but this is considered obsolete.
11855 If it is a string or vector of length N, character codes N and up are left
11856 untranslated. In a vector, an element which is nil means "no translation".
11858 This is applied to the characters supplied to input methods, not their
11859 output. See also `translation-table-for-input'.
11861 This variable has a separate binding for each terminal.
11862 See Info node `(elisp)Multiple Terminals'. */);
11864 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11865 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11866 \(Even if the operating system has support for stopping a process.\) */);
11867 cannot_suspend
= 0;
11869 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11870 doc
: /* Non-nil means prompt with menus when appropriate.
11871 This is done when reading from a keymap that has a prompt string,
11872 for elements that have prompt strings.
11873 The menu is displayed on the screen
11874 if X menus were enabled at configuration
11875 time and the previous event was a mouse click prefix key.
11876 Otherwise, menu prompting uses the echo area. */);
11877 menu_prompting
= 1;
11879 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11880 doc
: /* Character to see next line of menu prompt.
11881 Type this character while in a menu prompt to rotate around the lines of it. */);
11882 XSETINT (menu_prompt_more_char
, ' ');
11884 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11885 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11886 Emacs applies the modifiers of the character stored here to each keyboard
11887 character it reads. For example, after evaluating the expression
11888 (setq extra-keyboard-modifiers ?\\C-x)
11889 all input characters will have the control modifier applied to them.
11891 Note that the character ?\\C-@, equivalent to the integer zero, does
11892 not count as a control character; rather, it counts as a character
11893 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11894 cancels any modification. */);
11895 extra_keyboard_modifiers
= 0;
11897 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11898 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11899 The command loop sets this to nil before each command,
11900 and tests the value when the command returns.
11901 Buffer modification stores t in this variable. */);
11902 Vdeactivate_mark
= Qnil
;
11903 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11905 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11906 doc
: /* Normal hook run before each command is executed.
11907 If an unhandled error happens in running this hook,
11908 the function in which the error occurred is unconditionally removed, since
11909 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11910 Vpre_command_hook
= Qnil
;
11912 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11913 doc
: /* Normal hook run after each command is executed.
11914 If an unhandled error happens in running this hook,
11915 the function in which the error occurred is unconditionally removed, since
11916 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11917 Vpost_command_hook
= Qnil
;
11920 DEFVAR_LISP ("echo-area-clear-hook", ...,
11921 doc
: /* Normal hook run when clearing the echo area. */);
11923 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11924 Fset (Qecho_area_clear_hook
, Qnil
);
11926 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11927 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11928 Vlucid_menu_bar_dirty_flag
= Qnil
;
11930 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11931 doc
: /* List of menu bar items to move to the end of the menu bar.
11932 The elements of the list are event types that may have menu bar bindings. */);
11933 Vmenu_bar_final_items
= Qnil
;
11935 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11936 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11937 This is used internally by graphical displays that do not render
11938 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11939 Vtool_bar_separator_image_expression
= Qnil
;
11941 DEFVAR_KBOARD ("overriding-terminal-local-map",
11942 Voverriding_terminal_local_map
,
11943 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11944 If this variable is non-nil, it is used as a keymap instead of the
11945 buffer's local map, and the minor mode keymaps and text property keymaps.
11946 It also replaces `overriding-local-map'.
11948 This variable is intended to let commands such as `universal-argument'
11949 set up a different keymap for reading the next command.
11951 `overriding-terminal-local-map' has a separate binding for each
11953 See Info node `(elisp)Multiple Terminals'. */);
11955 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11956 doc
: /* Keymap that overrides all other local keymaps.
11957 If this variable is non-nil, it is used as a keymap--replacing the
11958 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11959 Voverriding_local_map
= Qnil
;
11961 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11962 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11963 Otherwise, the menu bar continues to reflect the buffer's local map
11964 and the minor mode maps regardless of `overriding-local-map'. */);
11965 Voverriding_local_map_menu_flag
= Qnil
;
11967 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11968 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11969 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11971 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11972 doc
: /* Non-nil means generate motion events for mouse motion. */);
11974 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11975 doc
: /* Alist of system-specific X windows key symbols.
11976 Each element should have the form (N . SYMBOL) where N is the
11977 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11978 and SYMBOL is its name.
11980 `system-key-alist' has a separate binding for each terminal device.
11981 See Info node `(elisp)Multiple Terminals'. */);
11983 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11984 doc
: /* Keymap that translates key sequences to key sequences during input.
11985 This is used mainly for mapping key sequences into some preferred
11986 key events (symbols).
11988 The `read-key-sequence' function replaces any subsequence bound by
11989 `local-function-key-map' with its binding. More precisely, when the
11990 active keymaps have no binding for the current key sequence but
11991 `local-function-key-map' binds a suffix of the sequence to a vector or
11992 string, `read-key-sequence' replaces the matching suffix with its
11993 binding, and continues with the new sequence.
11995 If the binding is a function, it is called with one argument (the prompt)
11996 and its return value (a key sequence) is used.
11998 The events that come from bindings in `local-function-key-map' are not
11999 themselves looked up in `local-function-key-map'.
12001 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12002 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12003 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12004 typing `ESC O P x' would return [f1 x].
12006 `local-function-key-map' has a separate binding for each terminal
12007 device. See Info node `(elisp)Multiple Terminals'. If you need to
12008 define a binding on all terminals, change `function-key-map'
12009 instead. Initially, `local-function-key-map' is an empty keymap that
12010 has `function-key-map' as its parent on all terminal devices. */);
12012 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12013 doc
: /* Keymap that decodes input escape sequences.
12014 This is used mainly for mapping ASCII function key sequences into
12015 real Emacs function key events (symbols).
12017 The `read-key-sequence' function replaces any subsequence bound by
12018 `input-decode-map' with its binding. Contrary to `function-key-map',
12019 this map applies its rebinding regardless of the presence of an ordinary
12020 binding. So it is more like `key-translation-map' except that it applies
12021 before `function-key-map' rather than after.
12023 If the binding is a function, it is called with one argument (the prompt)
12024 and its return value (a key sequence) is used.
12026 The events that come from bindings in `input-decode-map' are not
12027 themselves looked up in `input-decode-map'.
12029 This variable is keyboard-local. */);
12031 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12032 doc
: /* The parent keymap of all `local-function-key-map' instances.
12033 Function key definitions that apply to all terminal devices should go
12034 here. If a mapping is defined in both the current
12035 `local-function-key-map' binding and this variable, then the local
12036 definition will take precedence. */);
12037 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12039 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12040 doc
: /* Keymap of key translations that can override keymaps.
12041 This keymap works like `function-key-map', but comes after that,
12042 and its non-prefix bindings override ordinary bindings.
12043 Another difference is that it is global rather than keyboard-local. */);
12044 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12046 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12047 doc
: /* List of deferred actions to be performed at a later time.
12048 The precise format isn't relevant here; we just check whether it is nil. */);
12049 Vdeferred_action_list
= Qnil
;
12051 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12052 doc
: /* Function to call to handle deferred actions, after each command.
12053 This function is called with no arguments after each command
12054 whenever `deferred-action-list' is non-nil. */);
12055 Vdeferred_action_function
= Qnil
;
12057 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12058 doc
: /* List of warnings to be displayed after this command.
12059 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12060 as per the args of `display-warning' (which see).
12061 If this variable is non-nil, `delayed-warnings-hook' will be run
12062 immediately after running `post-command-hook'. */);
12063 Vdelayed_warnings_list
= Qnil
;
12065 DEFVAR_LISP ("timer-list", Vtimer_list
,
12066 doc
: /* List of active absolute time timers in order of increasing time. */);
12067 Vtimer_list
= Qnil
;
12069 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12070 doc
: /* List of active idle-time timers in order of increasing time. */);
12071 Vtimer_idle_list
= Qnil
;
12073 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12074 doc
: /* If non-nil, the function that implements the current input method.
12075 It's called with one argument, a printing character that was just read.
12076 \(That means a character with code 040...0176.)
12077 Typically this function uses `read-event' to read additional events.
12078 When it does so, it should first bind `input-method-function' to nil
12079 so it will not be called recursively.
12081 The function should return a list of zero or more events
12082 to be used as input. If it wants to put back some events
12083 to be reconsidered, separately, by the input method,
12084 it can add them to the beginning of `unread-command-events'.
12086 The input method function can find in `input-method-previous-message'
12087 the previous echo area message.
12089 The input method function should refer to the variables
12090 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12091 for guidance on what to do. */);
12092 Vinput_method_function
= Qnil
;
12094 DEFVAR_LISP ("input-method-previous-message",
12095 Vinput_method_previous_message
,
12096 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12097 This variable exists because `read-event' clears the echo area
12098 before running the input method. It is nil if there was no message. */);
12099 Vinput_method_previous_message
= Qnil
;
12101 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12102 doc
: /* If non-nil, the function that implements the display of help.
12103 It's called with one argument, the help string to display. */);
12104 Vshow_help_function
= Qnil
;
12106 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12107 doc
: /* If non-nil, suppress point adjustment after executing a command.
12109 After a command is executed, if point is moved into a region that has
12110 special properties (e.g. composition, display), we adjust point to
12111 the boundary of the region. But, when a command sets this variable to
12112 non-nil, we suppress the point adjustment.
12114 This variable is set to nil before reading a command, and is checked
12115 just after executing the command. */);
12116 Vdisable_point_adjustment
= Qnil
;
12118 DEFVAR_LISP ("global-disable-point-adjustment",
12119 Vglobal_disable_point_adjustment
,
12120 doc
: /* If non-nil, always suppress point adjustment.
12122 The default value is nil, in which case, point adjustment are
12123 suppressed only after special commands that set
12124 `disable-point-adjustment' (which see) to non-nil. */);
12125 Vglobal_disable_point_adjustment
= Qnil
;
12127 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12128 doc
: /* How long to display an echo-area message when the minibuffer is active.
12129 If the value is not a number, such messages don't time out. */);
12130 Vminibuffer_message_timeout
= make_number (2);
12132 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12133 doc
: /* If non-nil, any keyboard input throws to this symbol.
12134 The value of that variable is passed to `quit-flag' and later causes a
12135 peculiar kind of quitting. */);
12136 Vthrow_on_input
= Qnil
;
12138 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12139 doc
: /* If non-nil, function to output error messages.
12140 The arguments are the error data, a list of the form
12141 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12142 such as just as `condition-case' would bind its variable to,
12143 the context (a string which normally goes at the start of the message),
12144 and the Lisp function within which the error was signaled. */);
12145 Vcommand_error_function
= Qnil
;
12147 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12148 Venable_disabled_menus_and_buttons
,
12149 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12151 Help functions bind this to allow help on disabled menu items
12152 and tool-bar buttons. */);
12153 Venable_disabled_menus_and_buttons
= Qnil
;
12155 DEFVAR_LISP ("select-active-regions",
12156 Vselect_active_regions
,
12157 doc
: /* If non-nil, an active region automatically sets the primary selection.
12158 If the value is `only', only temporarily active regions (usually made
12159 by mouse-dragging or shift-selection) set the window selection.
12161 This takes effect only when Transient Mark mode is enabled. */);
12162 Vselect_active_regions
= Qt
;
12164 DEFVAR_LISP ("saved-region-selection",
12165 Vsaved_region_selection
,
12166 doc
: /* Contents of active region prior to buffer modification.
12167 If `select-active-regions' is non-nil, Emacs sets this to the
12168 text in the region before modifying the buffer. The next
12169 `deactivate-mark' call uses this to set the window selection. */);
12170 Vsaved_region_selection
= Qnil
;
12172 DEFVAR_LISP ("selection-inhibit-update-commands",
12173 Vselection_inhibit_update_commands
,
12174 doc
: /* List of commands which should not update the selection.
12175 Normally, if `select-active-regions' is non-nil and the mark remains
12176 active after a command (i.e. the mark was not deactivated), the Emacs
12177 command loop sets the selection to the text in the region. However,
12178 if the command is in this list, the selection is not updated. */);
12179 Vselection_inhibit_update_commands
12180 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12182 DEFVAR_LISP ("debug-on-event",
12184 doc
: /* Enter debugger on this event. When Emacs
12185 receives the special event specified by this variable, it will try to
12186 break into the debugger as soon as possible instead of processing the
12187 event normally through `special-event-map'.
12189 Currently, the only supported values for this
12190 variable are `sigusr1' and `sigusr2'. */);
12191 Vdebug_on_event
= intern_c_string ("sigusr2");
12193 /* Create the initial keyboard. */
12194 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12195 init_kboard (initial_kboard
);
12196 /* Vwindow_system is left at t for now. */
12197 initial_kboard
->next_kboard
= all_kboards
;
12198 all_kboards
= initial_kboard
;
12202 keys_of_keyboard (void)
12204 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12205 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12206 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12207 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12208 initial_define_key (meta_map
, 'x', "execute-extended-command");
12210 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12211 "handle-delete-frame");
12212 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12213 "ns-put-working-text");
12214 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12215 "ns-unput-working-text");
12216 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12217 current-prefix-arg, as is done in `handle-switch-frame'.
12218 But `handle-switch-frame is not run from the special-map.
12219 Commands from that map are run in a special way that automatically
12220 preserves the prefix-arg. Restoring the prefix arg here is not just
12221 redundant but harmful:
12223 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12224 - after the first prompt, the exit-minibuffer-hook is run which may
12225 iconify a frame and thus push a `iconify-frame' event.
12226 - after running exit-minibuffer-hook, current-prefix-arg is
12227 restored to the non-nil value it had before the prompt.
12228 - we enter the second prompt.
12229 current-prefix-arg is non-nil, prefix-arg is nil.
12230 - before running the first real event, we run the special iconify-frame
12231 event, but we pass the `special' arg to execute-command so
12232 current-prefix-arg and prefix-arg are left untouched.
12233 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12234 - the next key event will have a spuriously non-nil current-prefix-arg. */
12235 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12237 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12239 /* Handling it at such a low-level causes read_key_sequence to get
12240 * confused because it doesn't realize that the current_buffer was
12241 * changed by read_char.
12243 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12244 * "handle-select-window"); */
12245 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12246 "handle-save-session");
12249 /* Define a special event which is raised for dbus callback
12251 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12252 "dbus-handle-event");
12255 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12259 /* Mark the pointers in the kboard objects.
12260 Called by Fgarbage_collect. */
12262 mark_kboards (void)
12266 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12268 if (kb
->kbd_macro_buffer
)
12269 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12271 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12272 mark_object (KVAR (kb
, Vlast_command
));
12273 mark_object (KVAR (kb
, Vreal_last_command
));
12274 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12275 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12276 mark_object (KVAR (kb
, Vprefix_arg
));
12277 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12278 mark_object (KVAR (kb
, kbd_queue
));
12279 mark_object (KVAR (kb
, defining_kbd_macro
));
12280 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12281 mark_object (KVAR (kb
, Vsystem_key_alist
));
12282 mark_object (KVAR (kb
, system_key_syms
));
12283 mark_object (KVAR (kb
, Vwindow_system
));
12284 mark_object (KVAR (kb
, Vinput_decode_map
));
12285 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12286 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12287 mark_object (KVAR (kb
, echo_string
));
12290 struct input_event
*event
;
12291 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12293 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12294 event
= kbd_buffer
;
12295 if (event
->kind
!= SELECTION_REQUEST_EVENT
12296 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12298 mark_object (event
->x
);
12299 mark_object (event
->y
);
12301 mark_object (event
->frame_or_window
);
12302 mark_object (event
->arg
);