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"
34 #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 /* This is like Vthis_command, except that commands never set it. */
221 Lisp_Object real_this_command
;
223 /* The value of point when the last command was started. */
224 static ptrdiff_t last_point_position
;
226 /* The buffer that was current when the last command was started. */
227 static Lisp_Object last_point_position_buffer
;
229 /* The window that was selected when the last command was started. */
230 static Lisp_Object last_point_position_window
;
232 /* The frame in which the last input event occurred, or Qmacro if the
233 last event came from a macro. We use this to determine when to
234 generate switch-frame events. This may be cleared by functions
235 like Fselect_frame, to make sure that a switch-frame event is
236 generated by the next character. */
237 Lisp_Object internal_last_event_frame
;
239 /* The timestamp of the last input event we received from the X server.
240 X Windows wants this for selection ownership. */
241 Time last_event_timestamp
;
243 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
244 static Lisp_Object Qhandle_select_window
;
245 Lisp_Object QPRIMARY
;
247 static Lisp_Object Qself_insert_command
;
248 static Lisp_Object Qforward_char
;
249 static Lisp_Object Qbackward_char
;
250 Lisp_Object Qundefined
;
251 static Lisp_Object Qtimer_event_handler
;
253 /* read_key_sequence stores here the command definition of the
254 key sequence that it reads. */
255 static Lisp_Object read_key_sequence_cmd
;
256 static Lisp_Object read_key_sequence_remapped
;
258 static Lisp_Object Qinput_method_function
;
260 static Lisp_Object Qdeactivate_mark
;
262 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
264 static Lisp_Object Qecho_area_clear_hook
;
266 /* Hooks to run before and after each command. */
267 static Lisp_Object Qpre_command_hook
;
268 static Lisp_Object Qpost_command_hook
;
270 static Lisp_Object Qdeferred_action_function
;
272 static Lisp_Object Qdelayed_warnings_hook
;
274 static Lisp_Object Qinput_method_exit_on_first_char
;
275 static Lisp_Object Qinput_method_use_echo_area
;
277 static Lisp_Object Qhelp_form_show
;
279 /* File in which we write all commands we read. */
280 static FILE *dribble
;
282 /* Nonzero if input is available. */
285 /* Circular buffer for pre-read keyboard input. */
287 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
289 /* Pointer to next available character in kbd_buffer.
290 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
291 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
292 next available char is in kbd_buffer[0]. */
293 static struct input_event
*kbd_fetch_ptr
;
295 /* Pointer to next place to store character in kbd_buffer. This
296 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
297 character should go in kbd_buffer[0]. */
298 static struct input_event
* volatile kbd_store_ptr
;
300 /* The above pair of variables forms a "queue empty" flag. When we
301 enqueue a non-hook event, we increment kbd_store_ptr. When we
302 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
303 there is input available if the two pointers are not equal.
305 Why not just have a flag set and cleared by the enqueuing and
306 dequeuing functions? Such a flag could be screwed up by interrupts
307 at inopportune times. */
309 /* Symbols to head events. */
310 static Lisp_Object Qmouse_movement
;
311 static Lisp_Object Qscroll_bar_movement
;
312 Lisp_Object Qswitch_frame
;
313 static Lisp_Object Qdelete_frame
;
314 static Lisp_Object Qiconify_frame
;
315 static Lisp_Object Qmake_frame_visible
;
316 static Lisp_Object Qselect_window
;
317 Lisp_Object Qhelp_echo
;
319 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
320 static Lisp_Object Qmouse_fixup_help_message
;
323 /* Symbols to denote kinds of events. */
324 static Lisp_Object Qfunction_key
;
325 Lisp_Object Qmouse_click
;
326 #if defined (WINDOWSNT)
327 Lisp_Object Qlanguage_change
;
329 static Lisp_Object Qdrag_n_drop
;
330 static Lisp_Object Qsave_session
;
332 static Lisp_Object Qdbus_event
;
334 static Lisp_Object Qconfig_changed_event
;
336 /* Lisp_Object Qmouse_movement; - also an event header */
338 /* Properties of event headers. */
339 Lisp_Object Qevent_kind
;
340 static Lisp_Object Qevent_symbol_elements
;
342 /* Menu and tool bar item parts. */
343 static Lisp_Object Qmenu_enable
;
344 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
345 Lisp_Object QCfilter
;
347 /* Non-nil disable property on a command means
348 do not execute it; call disabled-command-function's value instead. */
349 Lisp_Object QCtoggle
, QCradio
;
350 static Lisp_Object QCbutton
, QClabel
;
352 static Lisp_Object QCvert_only
;
354 /* An event header symbol HEAD may have a property named
355 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
356 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
357 mask of modifiers applied to it. If present, this is used to help
358 speed up parse_modifiers. */
359 Lisp_Object Qevent_symbol_element_mask
;
361 /* An unmodified event header BASE may have a property named
362 Qmodifier_cache, which is an alist mapping modifier masks onto
363 modified versions of BASE. If present, this helps speed up
365 static Lisp_Object Qmodifier_cache
;
367 /* Symbols to use for parts of windows. */
368 Lisp_Object Qmode_line
;
369 Lisp_Object Qvertical_line
;
370 static Lisp_Object Qvertical_scroll_bar
;
371 Lisp_Object Qmenu_bar
;
373 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
374 static Lisp_Object
command_loop (void);
375 static Lisp_Object Qextended_command_history
;
376 EMACS_TIME
timer_check (void);
378 static void record_menu_key (Lisp_Object c
);
379 static void echo_now (void);
380 static ptrdiff_t echo_length (void);
382 static Lisp_Object Qpolling_period
;
384 /* Incremented whenever a timer is run. */
387 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
389 EMACS_TIME
*input_available_clear_time
;
391 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
392 Default is 1 if INTERRUPT_INPUT is defined. */
395 /* Nonzero while interrupts are temporarily deferred during redisplay. */
396 int interrupts_deferred
;
398 /* Allow m- file to inhibit use of FIONREAD. */
399 #ifdef BROKEN_FIONREAD
403 /* We are unable to use interrupts if FIONREAD is not available,
404 so flush SIGIO so we won't try. */
405 #if !defined (FIONREAD)
411 /* If we support a window system, turn on the code to poll periodically
412 to detect C-g. It isn't actually used when doing interrupt input. */
413 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
414 #define POLL_FOR_INPUT
417 /* The time when Emacs started being idle. */
419 static EMACS_TIME timer_idleness_start_time
;
421 /* After Emacs stops being idle, this saves the last value
422 of timer_idleness_start_time from when it was idle. */
424 static EMACS_TIME timer_last_idleness_start_time
;
427 /* Global variable declarations. */
429 /* Flags for readable_events. */
430 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
431 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
432 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
434 /* Function for init_keyboard to call with no args (if nonzero). */
435 static void (*keyboard_init_hook
) (void);
437 static int read_avail_input (int);
438 static void get_input_pending (int *, int);
439 static int readable_events (int);
440 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
442 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
444 static Lisp_Object
make_lispy_event (struct input_event
*);
445 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
446 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
447 enum scroll_bar_part
,
448 Lisp_Object
, Lisp_Object
,
451 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
452 Lisp_Object
, const char *const *,
453 Lisp_Object
*, ptrdiff_t);
454 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
455 static int help_char_p (Lisp_Object
);
456 static void save_getcjmp (jmp_buf);
457 static void restore_getcjmp (jmp_buf);
458 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
459 static void clear_event (struct input_event
*);
460 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
461 static void interrupt_signal (int signalnum
);
463 static void input_available_signal (int signo
);
465 static Lisp_Object (Fcommand_execute
) (Lisp_Object
, Lisp_Object
, Lisp_Object
,
467 static void handle_interrupt (void);
468 static void quit_throw_to_read_char (int) NO_RETURN
;
469 static void process_special_events (void);
470 static void timer_start_idle (void);
471 static void timer_stop_idle (void);
472 static void timer_resume_idle (void);
473 static void handle_user_signal (int);
474 static char *find_user_signal_name (int);
475 static int store_user_signal_events (void);
478 /* Add C to the echo string, if echoing is going on.
479 C can be a character, which is printed prettily ("M-C-x" and all that
480 jazz), or a symbol, whose name is printed. */
483 echo_char (Lisp_Object c
)
485 if (current_kboard
->immediate_echo
)
487 int size
= KEY_DESCRIPTION_SIZE
+ 100;
488 char *buffer
= (char *) alloca (size
);
490 Lisp_Object echo_string
;
492 echo_string
= KVAR (current_kboard
, echo_string
);
494 /* If someone has passed us a composite event, use its head symbol. */
499 ptr
= push_key_description (XINT (c
), ptr
, 1);
501 else if (SYMBOLP (c
))
503 Lisp_Object name
= SYMBOL_NAME (c
);
504 int nbytes
= SBYTES (name
);
506 if (size
- (ptr
- buffer
) < nbytes
)
508 int offset
= ptr
- buffer
;
509 size
= max (2 * size
, size
+ nbytes
);
510 buffer
= (char *) alloca (size
);
511 ptr
= buffer
+ offset
;
514 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
515 STRING_MULTIBYTE (name
), 1);
518 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
521 const char *text
= " (Type ? for further options)";
522 int len
= strlen (text
);
524 if (size
- (ptr
- buffer
) < len
)
526 int offset
= ptr
- buffer
;
528 buffer
= (char *) alloca (size
);
529 ptr
= buffer
+ offset
;
532 memcpy (ptr
, text
, len
);
536 /* Replace a dash from echo_dash with a space, otherwise
537 add a space at the end as a separator between keys. */
538 if (STRINGP (echo_string
)
539 && SCHARS (echo_string
) > 1)
541 Lisp_Object last_char
, prev_char
, idx
;
543 idx
= make_number (SCHARS (echo_string
) - 2);
544 prev_char
= Faref (echo_string
, idx
);
546 idx
= make_number (SCHARS (echo_string
) - 1);
547 last_char
= Faref (echo_string
, idx
);
549 /* We test PREV_CHAR to make sure this isn't the echoing
551 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
552 Faset (echo_string
, idx
, make_number (' '));
554 echo_string
= concat2 (echo_string
, build_string (" "));
556 else if (STRINGP (echo_string
))
557 echo_string
= concat2 (echo_string
, build_string (" "));
559 KVAR (current_kboard
, echo_string
)
560 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
566 /* Temporarily add a dash to the end of the echo string if it's not
567 empty, so that it serves as a mini-prompt for the very next character. */
572 /* Do nothing if not echoing at all. */
573 if (NILP (KVAR (current_kboard
, echo_string
)))
576 if (this_command_key_count
== 0)
579 if (!current_kboard
->immediate_echo
580 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
583 /* Do nothing if we just printed a prompt. */
584 if (current_kboard
->echo_after_prompt
585 == SCHARS (KVAR (current_kboard
, echo_string
)))
588 /* Do nothing if we have already put a dash at the end. */
589 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
591 Lisp_Object last_char
, prev_char
, idx
;
593 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
594 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
596 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
597 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
599 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
603 /* Put a dash at the end of the buffer temporarily,
604 but make it go away when the next character is added. */
605 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
610 /* Display the current echo string, and begin echoing if not already
616 if (!current_kboard
->immediate_echo
)
619 current_kboard
->immediate_echo
= 1;
621 for (i
= 0; i
< this_command_key_count
; i
++)
625 /* Set before_command_echo_length to the value that would
626 have been saved before the start of this subcommand in
627 command_loop_1, if we had already been echoing then. */
628 if (i
== this_single_command_key_start
)
629 before_command_echo_length
= echo_length ();
631 c
= XVECTOR (this_command_keys
)->contents
[i
];
632 if (! (EVENT_HAS_PARAMETERS (c
)
633 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
637 /* Set before_command_echo_length to the value that would
638 have been saved before the start of this subcommand in
639 command_loop_1, if we had already been echoing then. */
640 if (this_command_key_count
== this_single_command_key_start
)
641 before_command_echo_length
= echo_length ();
643 /* Put a dash at the end to invite the user to type more. */
648 message3_nolog (KVAR (current_kboard
, echo_string
),
649 SBYTES (KVAR (current_kboard
, echo_string
)),
650 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
653 /* Record in what buffer we echoed, and from which kboard. */
654 echo_message_buffer
= echo_area_buffer
[0];
655 echo_kboard
= current_kboard
;
657 if (waiting_for_input
&& !NILP (Vquit_flag
))
658 quit_throw_to_read_char (0);
661 /* Turn off echoing, for the start of a new command. */
664 cancel_echoing (void)
666 current_kboard
->immediate_echo
= 0;
667 current_kboard
->echo_after_prompt
= -1;
668 KVAR (current_kboard
, echo_string
) = Qnil
;
669 ok_to_echo_at_next_pause
= NULL
;
671 echo_message_buffer
= Qnil
;
674 /* Return the length of the current echo string. */
679 return (STRINGP (KVAR (current_kboard
, echo_string
))
680 ? SCHARS (KVAR (current_kboard
, echo_string
))
684 /* Truncate the current echo message to its first LEN chars.
685 This and echo_char get used by read_key_sequence when the user
686 switches frames while entering a key sequence. */
689 echo_truncate (ptrdiff_t nchars
)
691 if (STRINGP (KVAR (current_kboard
, echo_string
)))
692 KVAR (current_kboard
, echo_string
)
693 = Fsubstring (KVAR (current_kboard
, echo_string
),
694 make_number (0), make_number (nchars
));
695 truncate_echo_area (nchars
);
699 /* Functions for manipulating this_command_keys. */
701 add_command_key (Lisp_Object key
)
703 #if 0 /* Not needed after we made Freset_this_command_lengths
704 do the job immediately. */
705 /* If reset-this-command-length was called recently, obey it now.
706 See the doc string of that function for an explanation of why. */
707 if (before_command_restore_flag
)
709 this_command_key_count
= before_command_key_count_1
;
710 if (this_command_key_count
< this_single_command_key_start
)
711 this_single_command_key_start
= this_command_key_count
;
712 echo_truncate (before_command_echo_length_1
);
713 before_command_restore_flag
= 0;
717 if (this_command_key_count
>= ASIZE (this_command_keys
))
718 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
720 ASET (this_command_keys
, this_command_key_count
, key
);
721 ++this_command_key_count
;
726 recursive_edit_1 (void)
728 ptrdiff_t count
= SPECPDL_INDEX ();
731 if (command_loop_level
> 0)
733 specbind (Qstandard_output
, Qt
);
734 specbind (Qstandard_input
, Qt
);
737 #ifdef HAVE_WINDOW_SYSTEM
738 /* The command loop has started an hourglass timer, so we have to
739 cancel it here, otherwise it will fire because the recursive edit
740 can take some time. Do not check for display_hourglass_p here,
741 because it could already be nil. */
745 /* This function may have been called from a debugger called from
746 within redisplay, for instance by Edebugging a function called
747 from fontification-functions. We want to allow redisplay in
748 the debugging session.
750 The recursive edit is left with a `(throw exit ...)'. The `exit'
751 tag is not caught anywhere in redisplay, i.e. when we leave the
752 recursive edit, the original redisplay leading to the recursive
753 edit will be unwound. The outcome should therefore be safe. */
754 specbind (Qinhibit_redisplay
, Qnil
);
757 val
= command_loop ();
759 Fsignal (Qquit
, Qnil
);
760 /* Handle throw from read_minibuf when using minibuffer
761 while it's active but we're in another window. */
763 xsignal1 (Qerror
, val
);
765 return unbind_to (count
, Qnil
);
768 /* When an auto-save happens, record the "time", and don't do again soon. */
771 record_auto_save (void)
773 last_auto_save
= num_nonmacro_input_events
;
776 /* Make an auto save happen as soon as possible at command level. */
780 force_auto_save_soon (void)
782 last_auto_save
= - auto_save_interval
- 1;
784 record_asynch_buffer_change ();
788 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
789 doc
: /* Invoke the editor command loop recursively.
790 To get out of the recursive edit, a command can do `(throw 'exit nil)';
791 that tells this function to return.
792 Alternatively, `(throw 'exit t)' makes this function signal an error.
793 This function is called by the editor initialization to begin editing. */)
796 ptrdiff_t count
= SPECPDL_INDEX ();
799 /* If we enter while input is blocked, don't lock up here.
800 This may happen through the debugger during redisplay. */
804 command_loop_level
++;
805 update_mode_lines
= 1;
807 if (command_loop_level
808 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
809 buffer
= Fcurrent_buffer ();
813 /* If we leave recursive_edit_1 below with a `throw' for instance,
814 like it is done in the splash screen display, we have to
815 make sure that we restore single_kboard as command_loop_1
816 would have done if it were left normally. */
817 if (command_loop_level
> 0)
818 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
819 record_unwind_protect (recursive_edit_unwind
, buffer
);
822 return unbind_to (count
, Qnil
);
826 recursive_edit_unwind (Lisp_Object buffer
)
828 if (BUFFERP (buffer
))
829 Fset_buffer (buffer
);
831 command_loop_level
--;
832 update_mode_lines
= 1;
837 #if 0 /* These two functions are now replaced with
838 temporarily_switch_to_single_kboard. */
842 #if 0 /* Theory: if there's anything in Vunread_command_events,
843 it will right away be read by read_key_sequence,
844 and then if we do switch KBOARDS, it will go into the side
845 queue then. So we don't need to do anything special here -- rms. */
846 if (CONSP (Vunread_command_events
))
848 current_kboard
->kbd_queue
849 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
850 current_kboard
->kbd_queue_has_data
= 1;
852 Vunread_command_events
= Qnil
;
857 /* Switch to the single-kboard state, making current_kboard
858 the only KBOARD from which further input is accepted. */
861 single_kboard_state ()
867 /* If we're in single_kboard state for kboard KBOARD,
871 not_single_kboard_state (KBOARD
*kboard
)
873 if (kboard
== current_kboard
)
877 /* Maintain a stack of kboards, so other parts of Emacs
878 can switch temporarily to the kboard of a given frame
879 and then revert to the previous status. */
884 struct kboard_stack
*next
;
887 static struct kboard_stack
*kboard_stack
;
890 push_kboard (struct kboard
*k
)
892 struct kboard_stack
*p
893 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
895 p
->next
= kboard_stack
;
896 p
->kboard
= current_kboard
;
906 struct kboard_stack
*p
= kboard_stack
;
908 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
910 if (t
->kboard
== p
->kboard
)
912 current_kboard
= p
->kboard
;
919 /* The terminal we remembered has been deleted. */
920 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
923 kboard_stack
= p
->next
;
927 /* Switch to single_kboard mode, making current_kboard the only KBOARD
928 from which further input is accepted. If F is non-nil, set its
929 KBOARD as the current keyboard.
931 This function uses record_unwind_protect to return to the previous
934 If Emacs is already in single_kboard mode, and F's keyboard is
935 locked, then this function will throw an error. */
938 temporarily_switch_to_single_kboard (struct frame
*f
)
940 int was_locked
= single_kboard
;
943 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
944 /* We can not switch keyboards while in single_kboard mode.
945 In rare cases, Lisp code may call `recursive-edit' (or
946 `read-minibuffer' or `y-or-n-p') after it switched to a
947 locked frame. For example, this is likely to happen
948 when server.el connects to a new terminal while Emacs is in
949 single_kboard mode. It is best to throw an error instead
950 of presenting the user with a frozen screen. */
951 error ("Terminal %d is locked, cannot read from it",
952 FRAME_TERMINAL (f
)->id
);
954 /* This call is unnecessary, but helps
955 `restore_kboard_configuration' discover if somebody changed
956 `current_kboard' behind our back. */
957 push_kboard (current_kboard
);
960 current_kboard
= FRAME_KBOARD (f
);
962 record_unwind_protect (restore_kboard_configuration
,
963 (was_locked
? Qt
: Qnil
));
966 #if 0 /* This function is not needed anymore. */
968 record_single_kboard_state ()
971 push_kboard (current_kboard
);
972 record_unwind_protect (restore_kboard_configuration
,
973 (single_kboard
? Qt
: Qnil
));
978 restore_kboard_configuration (Lisp_Object was_locked
)
980 if (NILP (was_locked
))
984 struct kboard
*prev
= current_kboard
;
987 /* The pop should not change the kboard. */
988 if (single_kboard
&& current_kboard
!= prev
)
995 /* Handle errors that are not handled at inner levels
996 by printing an error message and returning to the editor command loop. */
999 cmd_error (Lisp_Object data
)
1001 Lisp_Object old_level
, old_length
;
1002 char macroerror
[sizeof "After..kbd macro iterations: "
1003 + INT_STRLEN_BOUND (EMACS_INT
)];
1005 #ifdef HAVE_WINDOW_SYSTEM
1006 if (display_hourglass_p
)
1007 cancel_hourglass ();
1010 if (!NILP (executing_kbd_macro
))
1012 if (executing_kbd_macro_iterations
== 1)
1013 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1015 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1016 executing_kbd_macro_iterations
);
1021 Vstandard_output
= Qt
;
1022 Vstandard_input
= Qt
;
1023 Vexecuting_kbd_macro
= Qnil
;
1024 executing_kbd_macro
= Qnil
;
1025 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1026 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1029 /* Avoid unquittable loop if data contains a circular list. */
1030 old_level
= Vprint_level
;
1031 old_length
= Vprint_length
;
1032 XSETFASTINT (Vprint_level
, 10);
1033 XSETFASTINT (Vprint_length
, 10);
1034 cmd_error_internal (data
, macroerror
);
1035 Vprint_level
= old_level
;
1036 Vprint_length
= old_length
;
1040 Vinhibit_quit
= Qnil
;
1041 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1042 if (command_loop_level
== 0 && minibuf_level
== 0)
1043 any_kboard_state ();
1046 return make_number (0);
1049 /* Take actions on handling an error. DATA is the data that describes
1052 CONTEXT is a C-string containing ASCII characters only which
1053 describes the context in which the error happened. If we need to
1054 generalize CONTEXT to allow multibyte characters, make it a Lisp
1058 cmd_error_internal (Lisp_Object data
, const char *context
)
1060 struct frame
*sf
= SELECTED_FRAME ();
1062 /* The immediate context is not interesting for Quits,
1063 since they are asynchronous. */
1064 if (EQ (XCAR (data
), Qquit
))
1065 Vsignaling_function
= Qnil
;
1070 /* Use user's specified output function if any. */
1071 if (!NILP (Vcommand_error_function
))
1072 call3 (Vcommand_error_function
, data
,
1073 context
? build_string (context
) : empty_unibyte_string
,
1074 Vsignaling_function
);
1075 /* If the window system or terminal frame hasn't been initialized
1076 yet, or we're not interactive, write the message to stderr and exit. */
1077 else if (!sf
->glyphs_initialized_p
1078 /* The initial frame is a special non-displaying frame. It
1079 will be current in daemon mode when there are no frames
1080 to display, and in non-daemon mode before the real frame
1081 has finished initializing. If an error is thrown in the
1082 latter case while creating the frame, then the frame
1083 will never be displayed, so the safest thing to do is
1084 write to stderr and quit. In daemon mode, there are
1085 many other potential errors that do not prevent frames
1086 from being created, so continuing as normal is better in
1088 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1091 print_error_message (data
, Qexternal_debugging_output
,
1092 context
, Vsignaling_function
);
1093 Fterpri (Qexternal_debugging_output
);
1094 Fkill_emacs (make_number (-1));
1098 clear_message (1, 0);
1100 message_log_maybe_newline ();
1103 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1106 Vsignaling_function
= Qnil
;
1109 Lisp_Object
command_loop_1 (void);
1110 static Lisp_Object
command_loop_2 (Lisp_Object
);
1111 static Lisp_Object
top_level_1 (Lisp_Object
);
1113 /* Entry to editor-command-loop.
1114 This level has the catches for exiting/returning to editor command loop.
1115 It returns nil to exit recursive edit, t to abort it. */
1120 if (command_loop_level
> 0 || minibuf_level
> 0)
1123 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1124 executing_kbd_macro
= Qnil
;
1130 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1131 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1132 /* Reset single_kboard in case top-level set it while
1133 evaluating an -f option, or we are stuck there for some
1135 any_kboard_state ();
1137 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1138 executing_kbd_macro
= Qnil
;
1140 /* End of file in -batch run causes exit here. */
1146 /* Here we catch errors in execution of commands within the
1147 editing loop, and reenter the editing loop.
1148 When there is an error, cmd_error runs and returns a non-nil
1149 value to us. A value of nil means that command_loop_1 itself
1150 returned due to end of file (or end of kbd macro). */
1153 command_loop_2 (Lisp_Object ignore
)
1155 register Lisp_Object val
;
1158 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1159 while (!NILP (val
));
1167 return Feval (Vtop_level
, Qnil
);
1171 top_level_1 (Lisp_Object ignore
)
1173 /* On entry to the outer level, run the startup file */
1174 if (!NILP (Vtop_level
))
1175 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1176 else if (!NILP (Vpurify_flag
))
1177 message ("Bare impure Emacs (standard Lisp code not loaded)");
1179 message ("Bare Emacs (standard Lisp code not loaded)");
1183 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1184 doc
: /* Exit all recursive editing levels.
1185 This also exits all active minibuffers. */)
1188 #ifdef HAVE_WINDOW_SYSTEM
1189 if (display_hourglass_p
)
1190 cancel_hourglass ();
1193 /* Unblock input if we enter with input blocked. This may happen if
1194 redisplay traps e.g. during tool-bar update with input blocked. */
1195 while (INPUT_BLOCKED_P
)
1198 Fthrow (Qtop_level
, Qnil
);
1201 static Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1202 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1203 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1206 if (command_loop_level
> 0 || minibuf_level
> 0)
1207 Fthrow (Qexit
, Qnil
);
1209 error ("No recursive edit is in progress");
1212 static Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1213 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1214 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1217 if (command_loop_level
> 0 || minibuf_level
> 0)
1220 error ("No recursive edit is in progress");
1223 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1225 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1226 of this function. */
1229 tracking_off (Lisp_Object old_value
)
1231 do_mouse_tracking
= old_value
;
1232 if (NILP (old_value
))
1234 /* Redisplay may have been preempted because there was input
1235 available, and it assumes it will be called again after the
1236 input has been processed. If the only input available was
1237 the sort that we have just disabled, then we need to call
1239 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1241 redisplay_preserve_echo_area (6);
1242 get_input_pending (&input_pending
,
1243 READABLE_EVENTS_DO_TIMERS_NOW
);
1249 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1250 doc
: /* Evaluate BODY with mouse movement events enabled.
1251 Within a `track-mouse' form, mouse motion generates input events that
1252 you can read with `read-event'.
1253 Normally, mouse motion is ignored.
1254 usage: (track-mouse BODY...) */)
1257 ptrdiff_t count
= SPECPDL_INDEX ();
1260 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1262 do_mouse_tracking
= Qt
;
1264 val
= Fprogn (args
);
1265 return unbind_to (count
, val
);
1268 /* If mouse has moved on some frame, return one of those frames.
1272 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1273 after resizing the tool-bar window. */
1275 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1278 int ignore_mouse_drag_p
;
1281 some_mouse_moved (void)
1283 Lisp_Object tail
, frame
;
1285 if (ignore_mouse_drag_p
)
1287 /* ignore_mouse_drag_p = 0; */
1291 FOR_EACH_FRAME (tail
, frame
)
1293 if (XFRAME (frame
)->mouse_moved
)
1294 return XFRAME (frame
);
1300 #endif /* HAVE_MOUSE || HAVE_GPM */
1302 /* This is the actual command reading loop,
1303 sans error-handling encapsulation. */
1305 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1307 void safe_run_hooks (Lisp_Object
);
1308 static void adjust_point_for_property (ptrdiff_t, int);
1310 /* Cancel hourglass from protect_unwind.
1312 #ifdef HAVE_WINDOW_SYSTEM
1314 cancel_hourglass_unwind (Lisp_Object arg
)
1316 cancel_hourglass ();
1321 /* FIXME: This is wrong rather than test window-system, we should call
1322 a new set-selection, which will then dispatch to x-set-selection, or
1323 tty-set-selection, or w32-set-selection, ... */
1324 EXFUN (Fwindow_system
, 1);
1327 command_loop_1 (void)
1330 Lisp_Object keybuf
[30];
1332 EMACS_INT prev_modiff
= 0;
1333 struct buffer
*prev_buffer
= NULL
;
1334 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1335 int was_locked
= single_kboard
;
1337 int already_adjusted
= 0;
1339 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1340 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1341 Vdeactivate_mark
= Qnil
;
1342 waiting_for_input
= 0;
1345 this_command_key_count
= 0;
1346 this_command_key_count_reset
= 0;
1347 this_single_command_key_start
= 0;
1349 if (NILP (Vmemory_full
))
1351 /* Make sure this hook runs after commands that get errors and
1352 throw to top level. */
1353 /* Note that the value cell will never directly contain nil
1354 if the symbol is a local variable. */
1355 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1356 safe_run_hooks (Qpost_command_hook
);
1358 /* If displaying a message, resize the echo area window to fit
1359 that message's size exactly. */
1360 if (!NILP (echo_area_buffer
[0]))
1361 resize_echo_area_exactly ();
1363 /* If there are warnings waiting, process them. */
1364 if (!NILP (Vdelayed_warnings_list
))
1365 safe_run_hooks (Qdelayed_warnings_hook
);
1367 if (!NILP (Vdeferred_action_list
))
1368 safe_run_hooks (Qdeferred_action_function
);
1371 /* Do this after running Vpost_command_hook, for consistency. */
1372 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1373 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1374 if (!CONSP (last_command_event
))
1375 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1379 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1382 /* Make sure the current window's buffer is selected. */
1383 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1384 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1386 /* Display any malloc warning that just came out. Use while because
1387 displaying one warning can cause another. */
1389 while (pending_malloc_warning
)
1390 display_malloc_warning ();
1392 Vdeactivate_mark
= Qnil
;
1394 /* If minibuffer on and echo area in use,
1395 wait a short time and redraw minibuffer. */
1398 && !NILP (echo_area_buffer
[0])
1399 && EQ (minibuf_window
, echo_area_window
)
1400 && NUMBERP (Vminibuffer_message_timeout
))
1402 /* Bind inhibit-quit to t so that C-g gets read in
1403 rather than quitting back to the minibuffer. */
1404 ptrdiff_t count
= SPECPDL_INDEX ();
1405 specbind (Qinhibit_quit
, Qt
);
1407 sit_for (Vminibuffer_message_timeout
, 0, 2);
1409 /* Clear the echo area. */
1411 safe_run_hooks (Qecho_area_clear_hook
);
1413 unbind_to (count
, Qnil
);
1415 /* If a C-g came in before, treat it as input now. */
1416 if (!NILP (Vquit_flag
))
1419 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1424 /* Select the frame that the last event came from. Usually,
1425 switch-frame events will take care of this, but if some lisp
1426 code swallows a switch-frame event, we'll fix things up here.
1427 Is this a good idea? */
1428 if (FRAMEP (internal_last_event_frame
)
1429 && !EQ (internal_last_event_frame
, selected_frame
))
1430 Fselect_frame (internal_last_event_frame
, Qnil
);
1432 /* If it has changed current-menubar from previous value,
1433 really recompute the menubar from the value. */
1434 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1435 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1436 call0 (Qrecompute_lucid_menubar
);
1438 before_command_key_count
= this_command_key_count
;
1439 before_command_echo_length
= echo_length ();
1441 Vthis_command
= Qnil
;
1442 real_this_command
= Qnil
;
1443 Vthis_original_command
= Qnil
;
1444 Vthis_command_keys_shift_translated
= Qnil
;
1446 /* Read next key sequence; i gets its length. */
1447 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1450 /* A filter may have run while we were reading the input. */
1451 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1453 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1454 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1458 /* Now we have read a key sequence of length I,
1459 or else I is 0 and we found end of file. */
1461 if (i
== 0) /* End of file -- happens only in */
1462 return Qnil
; /* a kbd macro, at the end. */
1463 /* -1 means read_key_sequence got a menu that was rejected.
1464 Just loop around and read another command. */
1468 this_command_key_count
= 0;
1469 this_command_key_count_reset
= 0;
1470 this_single_command_key_start
= 0;
1474 last_command_event
= keybuf
[i
- 1];
1476 /* If the previous command tried to force a specific window-start,
1477 forget about that, in case this command moves point far away
1478 from that position. But also throw away beg_unchanged and
1479 end_unchanged information in that case, so that redisplay will
1480 update the whole window properly. */
1481 if (!NILP (XWINDOW (selected_window
)->force_start
))
1484 XWINDOW (selected_window
)->force_start
= Qnil
;
1485 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1486 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1489 cmd
= read_key_sequence_cmd
;
1490 if (!NILP (Vexecuting_kbd_macro
))
1492 if (!NILP (Vquit_flag
))
1494 Vexecuting_kbd_macro
= Qt
;
1495 QUIT
; /* Make some noise. */
1496 /* Will return since macro now empty. */
1500 /* Do redisplay processing after this command except in special
1501 cases identified below. */
1502 prev_buffer
= current_buffer
;
1503 prev_modiff
= MODIFF
;
1504 last_point_position
= PT
;
1505 last_point_position_window
= selected_window
;
1506 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1508 /* By default, we adjust point to a boundary of a region that
1509 has such a property that should be treated intangible
1510 (e.g. composition, display). But, some commands will set
1511 this variable differently. */
1512 Vdisable_point_adjustment
= Qnil
;
1514 /* Process filters and timers may have messed with deactivate-mark.
1515 reset it before we execute the command. */
1516 Vdeactivate_mark
= Qnil
;
1518 /* Remap command through active keymaps. */
1519 Vthis_original_command
= cmd
;
1520 if (!NILP (read_key_sequence_remapped
))
1521 cmd
= read_key_sequence_remapped
;
1523 /* Execute the command. */
1525 Vthis_command
= cmd
;
1526 real_this_command
= cmd
;
1527 safe_run_hooks (Qpre_command_hook
);
1529 already_adjusted
= 0;
1531 if (NILP (Vthis_command
))
1533 /* nil means key is undefined. */
1534 Lisp_Object keys
= Fvector (i
, keybuf
);
1535 keys
= Fkey_description (keys
, Qnil
);
1537 message_with_string ("%s is undefined", keys
, 0);
1538 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1539 update_mode_lines
= 1;
1540 /* If this is a down-mouse event, don't reset prefix-arg;
1541 pass it to the command run by the up event. */
1542 if (EVENT_HAS_PARAMETERS (last_command_event
))
1544 Lisp_Object breakdown
1545 = parse_modifiers (EVENT_HEAD (last_command_event
));
1546 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1547 if (!(modifiers
& down_modifier
))
1548 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1551 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1555 /* Here for a command that isn't executed directly. */
1557 #ifdef HAVE_WINDOW_SYSTEM
1558 ptrdiff_t scount
= SPECPDL_INDEX ();
1560 if (display_hourglass_p
1561 && NILP (Vexecuting_kbd_macro
))
1563 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1568 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1570 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1572 #ifdef HAVE_WINDOW_SYSTEM
1573 /* Do not check display_hourglass_p here, because
1574 Fcommand_execute could change it, but we should cancel
1575 hourglass cursor anyway.
1576 But don't cancel the hourglass within a macro
1577 just because a command in the macro finishes. */
1578 if (NILP (Vexecuting_kbd_macro
))
1579 unbind_to (scount
, Qnil
);
1582 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1584 safe_run_hooks (Qpost_command_hook
);
1586 /* If displaying a message, resize the echo area window to fit
1587 that message's size exactly. */
1588 if (!NILP (echo_area_buffer
[0]))
1589 resize_echo_area_exactly ();
1591 /* If there are warnings waiting, process them. */
1592 if (!NILP (Vdelayed_warnings_list
))
1593 safe_run_hooks (Qdelayed_warnings_hook
);
1595 safe_run_hooks (Qdeferred_action_function
);
1597 /* If there is a prefix argument,
1598 1) We don't want Vlast_command to be ``universal-argument''
1599 (that would be dumb), so don't set Vlast_command,
1600 2) we want to leave echoing on so that the prefix will be
1601 echoed as part of this key sequence, so don't call
1603 3) we want to leave this_command_key_count non-zero, so that
1604 read_char will realize that it is re-reading a character, and
1605 not echo it a second time.
1607 If the command didn't actually create a prefix arg,
1608 but is merely a frame event that is transparent to prefix args,
1609 then the above doesn't apply. */
1610 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1612 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1613 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1614 if (!CONSP (last_command_event
))
1615 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1617 this_command_key_count
= 0;
1618 this_command_key_count_reset
= 0;
1619 this_single_command_key_start
= 0;
1622 if (!NILP (BVAR (current_buffer
, mark_active
))
1623 && !NILP (Vrun_hooks
))
1625 /* In Emacs 22, setting transient-mark-mode to `only' was a
1626 way of turning it on for just one command. This usage is
1627 obsolete, but support it anyway. */
1628 if (EQ (Vtransient_mark_mode
, Qidentity
))
1629 Vtransient_mark_mode
= Qnil
;
1630 else if (EQ (Vtransient_mark_mode
, Qonly
))
1631 Vtransient_mark_mode
= Qidentity
;
1633 if (!NILP (Vdeactivate_mark
))
1634 /* If `select-active-regions' is non-nil, this call to
1635 `deactivate-mark' also sets the PRIMARY selection. */
1636 call0 (Qdeactivate_mark
);
1639 /* Even if not deactivating the mark, set PRIMARY if
1640 `select-active-regions' is non-nil. */
1641 if (!NILP (Fwindow_system (Qnil
))
1642 /* Even if mark_active is non-nil, the actual buffer
1643 marker may not have been set yet (Bug#7044). */
1644 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1645 && (EQ (Vselect_active_regions
, Qonly
)
1646 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1647 : (!NILP (Vselect_active_regions
)
1648 && !NILP (Vtransient_mark_mode
)))
1649 && NILP (Fmemq (Vthis_command
,
1650 Vselection_inhibit_update_commands
)))
1653 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1656 call2 (Qx_set_selection
, QPRIMARY
,
1657 make_buffer_string (beg
, end
, 0));
1659 call2 (Qx_set_selection
, QPRIMARY
,
1660 make_buffer_string (end
, beg
, 0));
1661 /* Don't set empty selections. */
1664 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1666 Lisp_Object hook
= intern ("activate-mark-hook");
1667 Frun_hooks (1, &hook
);
1671 Vsaved_region_selection
= Qnil
;
1676 if (current_buffer
== prev_buffer
1677 && last_point_position
!= PT
1678 && NILP (Vdisable_point_adjustment
)
1679 && NILP (Vglobal_disable_point_adjustment
))
1681 if (last_point_position
> BEGV
1682 && last_point_position
< ZV
1683 && (composition_adjust_point (last_point_position
,
1684 last_point_position
)
1685 != last_point_position
))
1686 /* The last point was temporarily set within a grapheme
1687 cluster to prevent automatic composition. To recover
1688 the automatic composition, we must update the
1690 windows_or_buffers_changed
++;
1691 if (!already_adjusted
)
1692 adjust_point_for_property (last_point_position
,
1693 MODIFF
!= prev_modiff
);
1696 /* Install chars successfully executed in kbd macro. */
1698 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1699 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1700 finalize_kbd_macro_chars ();
1701 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1703 any_kboard_state ();
1708 /* Adjust point to a boundary of a region that has such a property
1709 that should be treated intangible. For the moment, we check
1710 `composition', `display' and `invisible' properties.
1711 LAST_PT is the last position of point. */
1714 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1717 Lisp_Object val
, overlay
, tmp
;
1718 /* When called after buffer modification, we should temporarily
1719 suppress the point adjustment for automatic composition so that a
1720 user can keep inserting another character at point or keep
1721 deleting characters around point. */
1722 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1723 ptrdiff_t orig_pt
= PT
;
1725 /* FIXME: cycling is probably not necessary because these properties
1726 can't be usefully combined anyway. */
1727 while (check_composition
|| check_display
|| check_invisible
)
1729 /* FIXME: check `intangible'. */
1730 if (check_composition
1731 && PT
> BEGV
&& PT
< ZV
1732 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1735 check_display
= check_invisible
= 1;
1737 check_composition
= 0;
1739 && PT
> BEGV
&& PT
< ZV
1740 && !NILP (val
= get_char_property_and_overlay
1741 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1742 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1743 && (!OVERLAYP (overlay
)
1744 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1745 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1746 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1747 && (beg
< PT
/* && end > PT <- It's always the case. */
1748 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1751 SET_PT (PT
< last_pt
1752 ? (STRINGP (val
) && SCHARS (val
) == 0
1753 ? max (beg
- 1, BEGV
)
1756 check_composition
= check_invisible
= 1;
1759 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1761 int inv
, ellipsis
= 0;
1764 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1767 /* FIXME: We should stop if we find a spot between
1768 two runs of `invisible' where inserted text would
1769 be visible. This is important when we have two
1770 invisible boundaries that enclose an area: if the
1771 area is empty, we need this test in order to make
1772 it possible to place point in the middle rather
1773 than skip both boundaries. However, this code
1774 also stops anywhere in a non-sticky text-property,
1775 which breaks (e.g.) Org mode. */
1776 && (val
= get_pos_property (make_number (end
),
1778 TEXT_PROP_MEANS_INVISIBLE (val
))
1780 && !NILP (val
= get_char_property_and_overlay
1781 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1782 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1784 ellipsis
= ellipsis
|| inv
> 1
1785 || (OVERLAYP (overlay
)
1786 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1787 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1788 tmp
= Fnext_single_char_property_change
1789 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1790 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1794 && (val
= get_pos_property (make_number (beg
),
1796 TEXT_PROP_MEANS_INVISIBLE (val
))
1798 && !NILP (val
= get_char_property_and_overlay
1799 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1800 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1802 ellipsis
= ellipsis
|| inv
> 1
1803 || (OVERLAYP (overlay
)
1804 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1805 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1806 tmp
= Fprevious_single_char_property_change
1807 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1808 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1811 /* Move away from the inside area. */
1812 if (beg
< PT
&& end
> PT
)
1814 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1815 /* We haven't moved yet (so we don't need to fear
1816 infinite-looping) and we were outside the range
1817 before (so either end of the range still corresponds
1818 to a move in the right direction): pretend we moved
1819 less than we actually did, so that we still have
1820 more freedom below in choosing which end of the range
1822 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1823 /* We either have moved already or the last point
1824 was already in the range: we don't get to choose
1825 which end of the range we have to go to. */
1826 : (PT
< last_pt
? beg
: end
));
1827 check_composition
= check_display
= 1;
1829 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1830 the point to something other than its argument, due to
1831 point-motion hooks, intangibility, etc. */
1832 xassert (PT
== beg
|| PT
== end
);
1835 /* Pretend the area doesn't exist if the buffer is not
1837 if (!modified
&& !ellipsis
&& beg
< end
)
1839 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1840 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1841 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1842 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1843 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1844 /* We've already moved as far as we can. Trying to go
1845 to the other end would mean moving backwards and thus
1846 could lead to an infinite loop. */
1848 else if (val
= get_pos_property (make_number (PT
),
1850 TEXT_PROP_MEANS_INVISIBLE (val
)
1851 && (val
= get_pos_property
1852 (make_number (PT
== beg
? end
: beg
),
1854 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1855 (check_composition
= check_display
= 1,
1856 SET_PT (PT
== beg
? end
: beg
));
1859 check_invisible
= 0;
1863 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1866 safe_run_hooks_1 (void)
1868 eassert (CONSP (Vinhibit_quit
));
1869 return call0 (XCDR (Vinhibit_quit
));
1872 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1876 safe_run_hooks_error (Lisp_Object error_data
)
1879 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1880 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1881 Lisp_Object args
[4];
1882 args
[0] = build_string ("Error in %s (%s): %S");
1885 args
[3] = error_data
;
1891 Lisp_Object newval
= Qnil
;
1892 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1893 if (EQ (fun
, XCAR (val
)))
1896 newval
= Fcons (XCAR (val
), newval
);
1898 return Fset (hook
, Fnreverse (newval
));
1899 /* Not found in the local part of the hook. Let's look at the global
1902 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1903 : Fdefault_value (hook
));
1904 CONSP (val
); val
= XCDR (val
))
1905 if (EQ (fun
, XCAR (val
)))
1908 newval
= Fcons (XCAR (val
), newval
);
1910 return Fset_default (hook
, Fnreverse (newval
));
1916 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1918 eassert (nargs
== 1);
1919 if (CONSP (Vinhibit_quit
))
1920 XSETCDR (Vinhibit_quit
, args
[0]);
1922 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1924 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1928 /* If we get an error while running the hook, cause the hook variable
1929 to be nil. Also inhibit quits, so that C-g won't cause the hook
1930 to mysteriously evaporate. */
1933 safe_run_hooks (Lisp_Object hook
)
1935 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1936 to its body or to its handlers other than via globals such as
1937 dynamically-bound variables ;-) */
1938 ptrdiff_t count
= SPECPDL_INDEX ();
1939 specbind (Qinhibit_quit
, hook
);
1941 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1943 unbind_to (count
, Qnil
);
1947 /* Nonzero means polling for input is temporarily suppressed. */
1949 int poll_suppress_count
;
1951 /* Asynchronous timer for polling. */
1953 static struct atimer
*poll_timer
;
1956 #ifdef POLL_FOR_INPUT
1958 /* Poll for input, so that we catch a C-g if it comes in. This
1959 function is called from x_make_frame_visible, see comment
1963 poll_for_input_1 (void)
1965 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1966 doing anything dangerous. */
1970 if (interrupt_input_blocked
== 0
1971 && !waiting_for_input
)
1972 read_avail_input (0);
1978 /* Timer callback function for poll_timer. TIMER is equal to
1982 poll_for_input (struct atimer
*timer
)
1984 if (poll_suppress_count
== 0)
1987 interrupt_input_pending
= 1;
1988 pending_signals
= 1;
1990 poll_for_input_1 ();
1995 #endif /* POLL_FOR_INPUT */
1997 /* Begin signals to poll for input, if they are appropriate.
1998 This function is called unconditionally from various places. */
2001 start_polling (void)
2003 #ifdef POLL_FOR_INPUT
2004 /* XXX This condition was (read_socket_hook && !interrupt_input),
2005 but read_socket_hook is not global anymore. Let's pretend that
2007 if (!interrupt_input
)
2009 /* Turn alarm handling on unconditionally. It might have
2010 been turned off in process.c. */
2011 turn_on_atimers (1);
2013 /* If poll timer doesn't exist, are we need one with
2014 a different interval, start a new one. */
2015 if (poll_timer
== NULL
2016 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2018 EMACS_TIME interval
;
2021 cancel_atimer (poll_timer
);
2023 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2024 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2025 poll_for_input
, NULL
);
2028 /* Let the timer's callback function poll for input
2029 if this becomes zero. */
2030 --poll_suppress_count
;
2035 /* Nonzero if we are using polling to handle input asynchronously. */
2038 input_polling_used (void)
2040 #ifdef POLL_FOR_INPUT
2041 /* XXX This condition was (read_socket_hook && !interrupt_input),
2042 but read_socket_hook is not global anymore. Let's pretend that
2044 return !interrupt_input
;
2050 /* Turn off polling. */
2055 #ifdef POLL_FOR_INPUT
2056 /* XXX This condition was (read_socket_hook && !interrupt_input),
2057 but read_socket_hook is not global anymore. Let's pretend that
2059 if (!interrupt_input
)
2060 ++poll_suppress_count
;
2064 /* Set the value of poll_suppress_count to COUNT
2065 and start or stop polling accordingly. */
2068 set_poll_suppress_count (int count
)
2070 #ifdef POLL_FOR_INPUT
2071 if (count
== 0 && poll_suppress_count
!= 0)
2073 poll_suppress_count
= 1;
2076 else if (count
!= 0 && poll_suppress_count
== 0)
2080 poll_suppress_count
= count
;
2084 /* Bind polling_period to a value at least N.
2085 But don't decrease it. */
2088 bind_polling_period (int n
)
2090 #ifdef POLL_FOR_INPUT
2091 int new = polling_period
;
2096 stop_other_atimers (poll_timer
);
2098 specbind (Qpolling_period
, make_number (new));
2099 /* Start a new alarm with the new period. */
2104 /* Apply the control modifier to CHARACTER. */
2107 make_ctrl_char (int c
)
2109 /* Save the upper bits here. */
2110 int upper
= c
& ~0177;
2112 if (! ASCII_BYTE_P (c
))
2113 return c
|= ctrl_modifier
;
2117 /* Everything in the columns containing the upper-case letters
2118 denotes a control character. */
2119 if (c
>= 0100 && c
< 0140)
2123 /* Set the shift modifier for a control char
2124 made from a shifted letter. But only for letters! */
2125 if (oc
>= 'A' && oc
<= 'Z')
2126 c
|= shift_modifier
;
2129 /* The lower-case letters denote control characters too. */
2130 else if (c
>= 'a' && c
<= 'z')
2133 /* Include the bits for control and shift
2134 only if the basic ASCII code can't indicate them. */
2138 /* Replace the high bits. */
2139 c
|= (upper
& ~ctrl_modifier
);
2144 /* Display the help-echo property of the character after the mouse pointer.
2145 Either show it in the echo area, or call show-help-function to display
2146 it by other means (maybe in a tooltip).
2148 If HELP is nil, that means clear the previous help echo.
2150 If HELP is a string, display that string. If HELP is a function,
2151 call it with OBJECT and POS as arguments; the function should
2152 return a help string or nil for none. For all other types of HELP,
2153 evaluate it to obtain a string.
2155 WINDOW is the window in which the help was generated, if any.
2156 It is nil if not in a window.
2158 If OBJECT is a buffer, POS is the position in the buffer where the
2159 `help-echo' text property was found.
2161 If OBJECT is an overlay, that overlay has a `help-echo' property,
2162 and POS is the position in the overlay's buffer under the mouse.
2164 If OBJECT is a string (an overlay string or a string displayed with
2165 the `display' property). POS is the position in that string under
2168 Note: this function may only be called with HELP nil or a string
2169 from X code running asynchronously. */
2172 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2175 if (!NILP (help
) && !STRINGP (help
))
2177 if (FUNCTIONP (help
))
2179 Lisp_Object args
[4];
2184 help
= safe_call (4, args
);
2187 help
= safe_eval (help
);
2189 if (!STRINGP (help
))
2193 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2194 if (!noninteractive
&& STRINGP (help
))
2196 /* The mouse-fixup-help-message Lisp function can call
2197 mouse_position_hook, which resets the mouse_moved flags.
2198 This causes trouble if we are trying to read a mouse motion
2199 event (i.e., if we are inside a `track-mouse' form), so we
2200 restore the mouse_moved flag. */
2201 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2202 help
= call1 (Qmouse_fixup_help_message
, help
);
2208 if (STRINGP (help
) || NILP (help
))
2210 if (!NILP (Vshow_help_function
))
2211 call1 (Vshow_help_function
, help
);
2212 help_echo_showing_p
= STRINGP (help
);
2218 /* Input of single characters from keyboard */
2220 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2221 struct timeval
*end_time
);
2222 static void record_char (Lisp_Object c
);
2224 static Lisp_Object help_form_saved_window_configs
;
2226 read_char_help_form_unwind (Lisp_Object arg
)
2228 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2229 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2230 if (!NILP (window_config
))
2231 Fset_window_configuration (window_config
);
2235 #define STOP_POLLING \
2236 do { if (! polling_stopped_here) stop_polling (); \
2237 polling_stopped_here = 1; } while (0)
2239 #define RESUME_POLLING \
2240 do { if (polling_stopped_here) start_polling (); \
2241 polling_stopped_here = 0; } while (0)
2243 /* read a character from the keyboard; call the redisplay if needed */
2244 /* commandflag 0 means do not autosave, but do redisplay.
2245 -1 means do not redisplay, but do autosave.
2248 /* The arguments MAPS and NMAPS are for menu prompting.
2249 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2251 PREV_EVENT is the previous input event, or nil if we are reading
2252 the first event of a key sequence (or not reading a key sequence).
2253 If PREV_EVENT is t, that is a "magic" value that says
2254 not to run input methods, but in other respects to act as if
2255 not reading a key sequence.
2257 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2258 if we used a mouse menu to read the input, or zero otherwise. If
2259 USED_MOUSE_MENU is null, we don't dereference it.
2261 Value is -2 when we find input on another keyboard. A second call
2262 to read_char will read it.
2264 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2265 specifying the maximum time to wait until. If no input arrives by
2266 that time, stop waiting and return nil.
2268 Value is t if we showed a menu and the user rejected it. */
2271 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2272 Lisp_Object prev_event
,
2273 int *used_mouse_menu
, struct timeval
*end_time
)
2275 volatile Lisp_Object c
;
2277 jmp_buf local_getcjmp
;
2279 volatile int key_already_recorded
= 0;
2280 Lisp_Object tem
, save
;
2281 volatile Lisp_Object previous_echo_area_message
;
2282 volatile Lisp_Object also_record
;
2283 volatile int reread
;
2284 struct gcpro gcpro1
, gcpro2
;
2285 int volatile polling_stopped_here
= 0;
2286 struct kboard
*orig_kboard
= current_kboard
;
2290 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2291 before_command_key_count
= this_command_key_count
;
2292 before_command_echo_length
= echo_length ();
2295 previous_echo_area_message
= Qnil
;
2297 GCPRO2 (c
, previous_echo_area_message
);
2302 if (CONSP (Vunread_post_input_method_events
))
2304 c
= XCAR (Vunread_post_input_method_events
);
2305 Vunread_post_input_method_events
2306 = XCDR (Vunread_post_input_method_events
);
2308 /* Undo what read_char_x_menu_prompt did when it unread
2309 additional keys returned by Fx_popup_menu. */
2311 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2319 if (unread_command_char
!= -1)
2321 XSETINT (c
, unread_command_char
);
2322 unread_command_char
= -1;
2328 if (CONSP (Vunread_command_events
))
2330 int was_disabled
= 0;
2332 c
= XCAR (Vunread_command_events
);
2333 Vunread_command_events
= XCDR (Vunread_command_events
);
2337 /* Undo what sit-for did when it unread additional keys
2338 inside universal-argument. */
2341 && EQ (XCAR (c
), Qt
))
2347 /* Undo what read_char_x_menu_prompt did when it unread
2348 additional keys returned by Fx_popup_menu. */
2350 && EQ (XCDR (c
), Qdisabled
)
2351 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2357 /* If the queued event is something that used the mouse,
2358 set used_mouse_menu accordingly. */
2360 /* Also check was_disabled so last-nonmenu-event won't return
2361 a bad value when submenus are involved. (Bug#447) */
2362 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2363 *used_mouse_menu
= 1;
2365 goto reread_for_input_method
;
2368 if (CONSP (Vunread_input_method_events
))
2370 c
= XCAR (Vunread_input_method_events
);
2371 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2373 /* Undo what read_char_x_menu_prompt did when it unread
2374 additional keys returned by Fx_popup_menu. */
2376 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2380 goto reread_for_input_method
;
2383 this_command_key_count_reset
= 0;
2385 if (!NILP (Vexecuting_kbd_macro
))
2387 /* We set this to Qmacro; since that's not a frame, nobody will
2388 try to switch frames on us, and the selected window will
2391 Since this event came from a macro, it would be misleading to
2392 leave internal_last_event_frame set to wherever the last
2393 real event came from. Normally, a switch-frame event selects
2394 internal_last_event_frame after each command is read, but
2395 events read from a macro should never cause a new frame to be
2397 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2399 /* Exit the macro if we are at the end.
2400 Also, some things replace the macro with t
2401 to force an early exit. */
2402 if (EQ (Vexecuting_kbd_macro
, Qt
)
2403 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2409 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2410 if (STRINGP (Vexecuting_kbd_macro
)
2411 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2412 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2414 executing_kbd_macro_index
++;
2419 if (!NILP (unread_switch_frame
))
2421 c
= unread_switch_frame
;
2422 unread_switch_frame
= Qnil
;
2424 /* This event should make it into this_command_keys, and get echoed
2425 again, so we do not set `reread'. */
2429 /* if redisplay was requested */
2430 if (commandflag
>= 0)
2432 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2434 /* If there is pending input, process any events which are not
2435 user-visible, such as X selection_request events. */
2437 || detect_input_pending_run_timers (0))
2438 swallow_events (0); /* may clear input_pending */
2440 /* Redisplay if no pending input. */
2441 while (!input_pending
)
2443 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2444 redisplay_preserve_echo_area (5);
2449 /* Normal case: no input arrived during redisplay. */
2452 /* Input arrived and pre-empted redisplay.
2453 Process any events which are not user-visible. */
2455 /* If that cleared input_pending, try again to redisplay. */
2458 /* Prevent the redisplay we just did
2459 from messing up echoing of the input after the prompt. */
2460 if (commandflag
== 0 && echo_current
)
2461 echo_message_buffer
= echo_area_buffer
[0];
2465 /* Message turns off echoing unless more keystrokes turn it on again.
2467 The code in 20.x for the condition was
2469 1. echo_area_glyphs && *echo_area_glyphs
2470 2. && echo_area_glyphs != current_kboard->echobuf
2471 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2473 (1) means there's a current message displayed
2475 (2) means it's not the message from echoing from the current
2478 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2479 is set to a non-null value. This is done in read_char and it is
2480 set to echo_area_glyphs after a call to echo_char. That means
2481 ok_to_echo_at_next_pause is either null or
2482 current_kboard->echobuf with the appropriate current_kboard at
2485 So, condition (3) means in clear text ok_to_echo_at_next_pause
2486 must be either null, or the current message isn't from echoing at
2487 all, or it's from echoing from a different kboard than the
2490 if (/* There currently is something in the echo area. */
2491 !NILP (echo_area_buffer
[0])
2492 && (/* And it's either not from echoing. */
2493 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2494 /* Or it's an echo from a different kboard. */
2495 || echo_kboard
!= current_kboard
2496 /* Or we explicitly allow overwriting whatever there is. */
2497 || ok_to_echo_at_next_pause
== NULL
))
2502 /* Try reading a character via menu prompting in the minibuf.
2503 Try this before the sit-for, because the sit-for
2504 would do the wrong thing if we are supposed to do
2505 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2506 after a mouse event so don't try a minibuf menu. */
2508 if (nmaps
> 0 && INTERACTIVE
2509 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2510 /* Don't bring up a menu if we already have another event. */
2511 && NILP (Vunread_command_events
)
2512 && unread_command_char
< 0
2513 && !detect_input_pending_run_timers (0))
2515 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2517 if (INTEGERP (c
) && XINT (c
) == -2)
2518 return c
; /* wrong_kboard_jmpbuf */
2522 key_already_recorded
= 1;
2527 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2528 We will do that below, temporarily for short sections of code,
2529 when appropriate. local_getcjmp must be in effect
2530 around any call to sit_for or kbd_buffer_get_event;
2531 it *must not* be in effect when we call redisplay. */
2533 jmpcount
= SPECPDL_INDEX ();
2534 if (_setjmp (local_getcjmp
))
2536 /* Handle quits while reading the keyboard. */
2537 /* We must have saved the outer value of getcjmp here,
2538 so restore it now. */
2539 restore_getcjmp (save_jump
);
2540 unbind_to (jmpcount
, Qnil
);
2541 XSETINT (c
, quit_char
);
2542 internal_last_event_frame
= selected_frame
;
2543 Vlast_event_frame
= internal_last_event_frame
;
2544 /* If we report the quit char as an event,
2545 don't do so more than once. */
2546 if (!NILP (Vinhibit_quit
))
2550 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2551 if (kb
!= current_kboard
)
2553 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2554 /* We shouldn't get here if we were in single-kboard mode! */
2559 while (CONSP (XCDR (last
)))
2561 if (!NILP (XCDR (last
)))
2565 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2567 XSETCDR (last
, Fcons (c
, Qnil
));
2568 kb
->kbd_queue_has_data
= 1;
2569 current_kboard
= kb
;
2570 /* This is going to exit from read_char
2571 so we had better get rid of this frame's stuff. */
2573 return make_number (-2); /* wrong_kboard_jmpbuf */
2579 /* Start idle timers if no time limit is supplied. We don't do it
2580 if a time limit is supplied to avoid an infinite recursion in the
2581 situation where an idle timer calls `sit-for'. */
2584 timer_start_idle ();
2586 /* If in middle of key sequence and minibuffer not active,
2587 start echoing if enough time elapses. */
2589 if (minibuf_level
== 0
2591 && !current_kboard
->immediate_echo
2592 && this_command_key_count
> 0
2594 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2595 && NILP (Fzerop (Vecho_keystrokes
))
2596 && (/* No message. */
2597 NILP (echo_area_buffer
[0])
2598 /* Or empty message. */
2599 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2600 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2601 /* Or already echoing from same kboard. */
2602 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2603 /* Or not echoing before and echoing allowed. */
2604 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2606 /* After a mouse event, start echoing right away.
2607 This is because we are probably about to display a menu,
2608 and we don't want to delay before doing so. */
2609 if (EVENT_HAS_PARAMETERS (prev_event
))
2615 save_getcjmp (save_jump
);
2616 restore_getcjmp (local_getcjmp
);
2617 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2618 restore_getcjmp (save_jump
);
2620 && ! CONSP (Vunread_command_events
))
2625 /* Maybe auto save due to number of keystrokes. */
2627 if (commandflag
!= 0
2628 && auto_save_interval
> 0
2629 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2630 && !detect_input_pending_run_timers (0))
2632 Fdo_auto_save (Qnil
, Qnil
);
2633 /* Hooks can actually change some buffers in auto save. */
2637 /* Try reading using an X menu.
2638 This is never confused with reading using the minibuf
2639 because the recursive call of read_char in read_char_minibuf_menu_prompt
2640 does not pass on any keymaps. */
2642 if (nmaps
> 0 && INTERACTIVE
2643 && !NILP (prev_event
)
2644 && EVENT_HAS_PARAMETERS (prev_event
)
2645 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2646 && !EQ (XCAR (prev_event
), Qtool_bar
)
2647 /* Don't bring up a menu if we already have another event. */
2648 && NILP (Vunread_command_events
)
2649 && unread_command_char
< 0)
2651 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2653 /* Now that we have read an event, Emacs is not idle. */
2660 /* Maybe autosave and/or garbage collect due to idleness. */
2662 if (INTERACTIVE
&& NILP (c
))
2665 ptrdiff_t buffer_size
;
2667 /* Slow down auto saves logarithmically in size of current buffer,
2668 and garbage collect while we're at it. */
2669 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2670 last_non_minibuf_size
= Z
- BEG
;
2671 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2673 while (buffer_size
> 64)
2674 delay_level
++, buffer_size
-= buffer_size
>> 2;
2675 if (delay_level
< 4) delay_level
= 4;
2676 /* delay_level is 4 for files under around 50k, 7 at 100k,
2677 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2679 /* Auto save if enough time goes by without input. */
2680 if (commandflag
!= 0
2681 && num_nonmacro_input_events
> last_auto_save
2682 && INTEGERP (Vauto_save_timeout
)
2683 && XINT (Vauto_save_timeout
) > 0)
2686 EMACS_INT timeout
= (delay_level
2687 * min (XFASTINT (Vauto_save_timeout
) / 4,
2688 MOST_POSITIVE_FIXNUM
/ delay_level
));
2689 save_getcjmp (save_jump
);
2690 restore_getcjmp (local_getcjmp
);
2691 tem0
= sit_for (make_number (timeout
), 1, 1);
2692 restore_getcjmp (save_jump
);
2695 && ! CONSP (Vunread_command_events
))
2697 Fdo_auto_save (Qnil
, Qnil
);
2699 /* If we have auto-saved and there is still no input
2700 available, garbage collect if there has been enough
2701 consing going on to make it worthwhile. */
2702 if (!detect_input_pending_run_timers (0)
2703 && consing_since_gc
> gc_cons_threshold
/ 2)
2704 Fgarbage_collect ();
2711 /* Notify the caller if an autosave hook, or a timer, sentinel or
2712 filter in the sit_for calls above have changed the current
2713 kboard. This could happen if they use the minibuffer or start a
2714 recursive edit, like the fancy splash screen in server.el's
2715 filter. If this longjmp wasn't here, read_key_sequence would
2716 interpret the next key sequence using the wrong translation
2717 tables and function keymaps. */
2718 if (NILP (c
) && current_kboard
!= orig_kboard
)
2721 return make_number (-2); /* wrong_kboard_jmpbuf */
2724 /* If this has become non-nil here, it has been set by a timer
2725 or sentinel or filter. */
2726 if (CONSP (Vunread_command_events
))
2728 c
= XCAR (Vunread_command_events
);
2729 Vunread_command_events
= XCDR (Vunread_command_events
);
2732 /* Read something from current KBOARD's side queue, if possible. */
2736 if (current_kboard
->kbd_queue_has_data
)
2738 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2740 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2741 KVAR (current_kboard
, kbd_queue
)
2742 = XCDR (KVAR (current_kboard
, kbd_queue
));
2743 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2744 current_kboard
->kbd_queue_has_data
= 0;
2745 input_pending
= readable_events (0);
2746 if (EVENT_HAS_PARAMETERS (c
)
2747 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2748 internal_last_event_frame
= XCAR (XCDR (c
));
2749 Vlast_event_frame
= internal_last_event_frame
;
2753 /* If current_kboard's side queue is empty check the other kboards.
2754 If one of them has data that we have not yet seen here,
2755 switch to it and process the data waiting for it.
2757 Note: if the events queued up for another kboard
2758 have already been seen here, and therefore are not a complete command,
2759 the kbd_queue_has_data field is 0, so we skip that kboard here.
2760 That's to avoid an infinite loop switching between kboards here. */
2761 if (NILP (c
) && !single_kboard
)
2764 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2765 if (kb
->kbd_queue_has_data
)
2767 current_kboard
= kb
;
2768 /* This is going to exit from read_char
2769 so we had better get rid of this frame's stuff. */
2771 return make_number (-2); /* wrong_kboard_jmpbuf */
2779 /* Finally, we read from the main queue,
2780 and if that gives us something we can't use yet, we put it on the
2781 appropriate side queue and try again. */
2785 KBOARD
*kb
IF_LINT (= NULL
);
2790 EMACS_GET_TIME (now
);
2791 if (EMACS_TIME_GE (now
, *end_time
))
2795 /* Actually read a character, waiting if necessary. */
2796 save_getcjmp (save_jump
);
2797 restore_getcjmp (local_getcjmp
);
2799 timer_start_idle ();
2800 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2801 restore_getcjmp (save_jump
);
2803 if (! NILP (c
) && (kb
!= current_kboard
))
2805 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2808 while (CONSP (XCDR (last
)))
2810 if (!NILP (XCDR (last
)))
2814 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2816 XSETCDR (last
, Fcons (c
, Qnil
));
2817 kb
->kbd_queue_has_data
= 1;
2821 current_kboard
= kb
;
2822 /* This is going to exit from read_char
2823 so we had better get rid of this frame's stuff. */
2825 return make_number (-2);
2829 /* Terminate Emacs in batch mode if at eof. */
2830 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2831 Fkill_emacs (make_number (1));
2835 /* Add in any extra modifiers, where appropriate. */
2836 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2837 || ((extra_keyboard_modifiers
& 0177) < ' '
2838 && (extra_keyboard_modifiers
& 0177) != 0))
2839 XSETINT (c
, make_ctrl_char (XINT (c
)));
2841 /* Transfer any other modifier bits directly from
2842 extra_keyboard_modifiers to c. Ignore the actual character code
2843 in the low 16 bits of extra_keyboard_modifiers. */
2844 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2855 if (commandflag
>= 0
2856 && !input_pending
&& !detect_input_pending_run_timers (0))
2864 /* Buffer switch events are only for internal wakeups
2865 so don't show them to the user.
2866 Also, don't record a key if we already did. */
2867 if (BUFFERP (c
) || key_already_recorded
)
2870 /* Process special events within read_char
2871 and loop around to read another event. */
2874 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2879 struct buffer
*prev_buffer
= current_buffer
;
2880 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2881 int was_locked
= single_kboard
;
2882 ptrdiff_t count
= SPECPDL_INDEX ();
2883 record_single_kboard_state ();
2886 last_input_event
= c
;
2887 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2889 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2890 /* We stopped being idle for this event; undo that. This
2891 prevents automatic window selection (under
2892 mouse_autoselect_window from acting as a real input event, for
2893 example banishing the mouse under mouse-avoidance-mode. */
2894 timer_resume_idle ();
2896 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2897 /* Resume allowing input from any kboard, if that was true before. */
2899 any_kboard_state ();
2900 unbind_to (count
, Qnil
);
2903 if (current_buffer
!= prev_buffer
)
2905 /* The command may have changed the keymaps. Pretend there
2906 is input in another keyboard and return. This will
2907 recalculate keymaps. */
2908 c
= make_number (-2);
2915 /* Handle things that only apply to characters. */
2918 /* If kbd_buffer_get_event gave us an EOF, return that. */
2922 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2923 && UNSIGNED_CMP (XFASTINT (c
), <,
2924 SCHARS (KVAR (current_kboard
,
2925 Vkeyboard_translate_table
))))
2926 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2927 && UNSIGNED_CMP (XFASTINT (c
), <,
2928 ASIZE (KVAR (current_kboard
,
2929 Vkeyboard_translate_table
))))
2930 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2934 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2935 /* nil in keyboard-translate-table means no translation. */
2941 /* If this event is a mouse click in the menu bar,
2942 return just menu-bar for now. Modify the mouse click event
2943 so we won't do this twice, then queue it up. */
2944 if (EVENT_HAS_PARAMETERS (c
)
2946 && CONSP (EVENT_START (c
))
2947 && CONSP (XCDR (EVENT_START (c
))))
2951 posn
= POSN_POSN (EVENT_START (c
));
2952 /* Handle menu-bar events:
2953 insert the dummy prefix event `menu-bar'. */
2954 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2956 /* Change menu-bar to (menu-bar) as the event "position". */
2957 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2960 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2965 /* Store these characters into recent_keys, the dribble file if any,
2966 and the keyboard macro being defined, if any. */
2968 if (! NILP (also_record
))
2969 record_char (also_record
);
2971 /* Wipe the echo area.
2972 But first, if we are about to use an input method,
2973 save the echo area contents for it to refer to. */
2975 && ! NILP (Vinput_method_function
)
2976 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2978 previous_echo_area_message
= Fcurrent_message ();
2979 Vinput_method_previous_message
= previous_echo_area_message
;
2982 /* Now wipe the echo area, except for help events which do their
2983 own stuff with the echo area. */
2985 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2986 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2988 if (!NILP (echo_area_buffer
[0]))
2989 safe_run_hooks (Qecho_area_clear_hook
);
2990 clear_message (1, 0);
2993 reread_for_input_method
:
2995 /* Pass this to the input method, if appropriate. */
2997 && ! NILP (Vinput_method_function
)
2998 /* Don't run the input method within a key sequence,
2999 after the first event of the key sequence. */
3000 && NILP (prev_event
)
3001 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3004 ptrdiff_t key_count
;
3005 int key_count_reset
;
3006 struct gcpro gcpro1
;
3007 ptrdiff_t count
= SPECPDL_INDEX ();
3009 /* Save the echo status. */
3010 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3011 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3012 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3013 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3016 if (before_command_restore_flag
)
3018 this_command_key_count
= before_command_key_count_1
;
3019 if (this_command_key_count
< this_single_command_key_start
)
3020 this_single_command_key_start
= this_command_key_count
;
3021 echo_truncate (before_command_echo_length_1
);
3022 before_command_restore_flag
= 0;
3026 /* Save the this_command_keys status. */
3027 key_count
= this_command_key_count
;
3028 key_count_reset
= this_command_key_count_reset
;
3031 keys
= Fcopy_sequence (this_command_keys
);
3036 /* Clear out this_command_keys. */
3037 this_command_key_count
= 0;
3038 this_command_key_count_reset
= 0;
3040 /* Now wipe the echo area. */
3041 if (!NILP (echo_area_buffer
[0]))
3042 safe_run_hooks (Qecho_area_clear_hook
);
3043 clear_message (1, 0);
3046 /* If we are not reading a key sequence,
3047 never use the echo area. */
3050 specbind (Qinput_method_use_echo_area
, Qt
);
3053 /* Call the input method. */
3054 tem
= call1 (Vinput_method_function
, c
);
3056 tem
= unbind_to (count
, tem
);
3058 /* Restore the saved echoing state
3059 and this_command_keys state. */
3060 this_command_key_count
= key_count
;
3061 this_command_key_count_reset
= key_count_reset
;
3063 this_command_keys
= keys
;
3066 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3067 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3068 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3069 if (saved_immediate_echo
)
3074 /* The input method can return no events. */
3077 /* Bring back the previous message, if any. */
3078 if (! NILP (previous_echo_area_message
))
3079 message_with_string ("%s", previous_echo_area_message
, 0);
3082 /* It returned one event or more. */
3084 Vunread_post_input_method_events
3085 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3090 /* Display help if not echoing. */
3091 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3093 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3094 Lisp_Object help
, object
, position
, window
, htem
;
3096 htem
= Fcdr (XCDR (c
));
3099 window
= Fcar (htem
);
3101 object
= Fcar (htem
);
3103 position
= Fcar (htem
);
3105 show_help_echo (help
, window
, object
, position
);
3107 /* We stopped being idle for this event; undo that. */
3109 timer_resume_idle ();
3113 if ((! reread
|| this_command_key_count
== 0
3114 || this_command_key_count_reset
)
3118 /* Don't echo mouse motion events. */
3119 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3120 && NILP (Fzerop (Vecho_keystrokes
))
3121 && ! (EVENT_HAS_PARAMETERS (c
)
3122 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3125 if (! NILP (also_record
))
3126 echo_char (also_record
);
3127 /* Once we reread a character, echoing can happen
3128 the next time we pause to read a new one. */
3129 ok_to_echo_at_next_pause
= current_kboard
;
3132 /* Record this character as part of the current key. */
3133 add_command_key (c
);
3134 if (! NILP (also_record
))
3135 add_command_key (also_record
);
3138 last_input_event
= c
;
3141 /* Process the help character specially if enabled */
3142 if (!NILP (Vhelp_form
) && help_char_p (c
))
3144 ptrdiff_t count
= SPECPDL_INDEX ();
3146 help_form_saved_window_configs
3147 = Fcons (Fcurrent_window_configuration (Qnil
),
3148 help_form_saved_window_configs
);
3149 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3150 call0 (Qhelp_form_show
);
3155 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3156 if (EVENT_HAS_PARAMETERS (c
)
3157 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3158 XSETCAR (help_form_saved_window_configs
, Qnil
);
3160 while (BUFFERP (c
));
3161 /* Remove the help from the frame */
3162 unbind_to (count
, Qnil
);
3165 if (EQ (c
, make_number (040)))
3169 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3170 while (BUFFERP (c
));
3179 /* Record a key that came from a mouse menu.
3180 Record it for echoing, for this-command-keys, and so on. */
3183 record_menu_key (Lisp_Object c
)
3185 /* Wipe the echo area. */
3186 clear_message (1, 0);
3191 before_command_key_count
= this_command_key_count
;
3192 before_command_echo_length
= echo_length ();
3195 /* Don't echo mouse motion events. */
3196 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3197 && NILP (Fzerop (Vecho_keystrokes
)))
3201 /* Once we reread a character, echoing can happen
3202 the next time we pause to read a new one. */
3203 ok_to_echo_at_next_pause
= 0;
3206 /* Record this character as part of the current key. */
3207 add_command_key (c
);
3209 /* Re-reading in the middle of a command */
3210 last_input_event
= c
;
3214 /* Return 1 if should recognize C as "the help character". */
3217 help_char_p (Lisp_Object c
)
3221 if (EQ (c
, Vhelp_char
))
3223 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3224 if (EQ (c
, XCAR (tail
)))
3229 /* Record the input event C in various ways. */
3232 record_char (Lisp_Object c
)
3236 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3238 /* To avoid filling recent_keys with help-echo and mouse-movement
3239 events, we filter out repeated help-echo events, only store the
3240 first and last in a series of mouse-movement events, and don't
3241 store repeated help-echo events which are only separated by
3242 mouse-movement events. */
3244 Lisp_Object ev1
, ev2
, ev3
;
3247 if ((ix1
= recent_keys_index
- 1) < 0)
3248 ix1
= NUM_RECENT_KEYS
- 1;
3249 ev1
= AREF (recent_keys
, ix1
);
3251 if ((ix2
= ix1
- 1) < 0)
3252 ix2
= NUM_RECENT_KEYS
- 1;
3253 ev2
= AREF (recent_keys
, ix2
);
3255 if ((ix3
= ix2
- 1) < 0)
3256 ix3
= NUM_RECENT_KEYS
- 1;
3257 ev3
= AREF (recent_keys
, ix3
);
3259 if (EQ (XCAR (c
), Qhelp_echo
))
3261 /* Don't record `help-echo' in recent_keys unless it shows some help
3262 message, and a different help than the previously recorded
3264 Lisp_Object help
, last_help
;
3266 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3267 if (!STRINGP (help
))
3269 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3270 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3272 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3273 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3274 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3276 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3277 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3278 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3279 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3282 else if (EQ (XCAR (c
), Qmouse_movement
))
3284 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3285 So additional mouse movement events replace the last element. */
3286 Lisp_Object last_window
, window
;
3288 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3289 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3290 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3291 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3292 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3294 ASET (recent_keys
, ix1
, c
);
3300 store_kbd_macro_char (c
);
3304 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3305 ASET (recent_keys
, recent_keys_index
, c
);
3306 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3307 recent_keys_index
= 0;
3309 else if (recorded
< 0)
3311 /* We need to remove one or two events from recent_keys.
3312 To do this, we simply put nil at those events and move the
3313 recent_keys_index backwards over those events. Usually,
3314 users will never see those nil events, as they will be
3315 overwritten by the command keys entered to see recent_keys
3318 while (recorded
++ < 0 && total_keys
> 0)
3320 if (total_keys
< NUM_RECENT_KEYS
)
3322 if (--recent_keys_index
< 0)
3323 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3324 ASET (recent_keys
, recent_keys_index
, Qnil
);
3328 num_nonmacro_input_events
++;
3330 /* Write c to the dribble file. If c is a lispy event, write
3331 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3332 If you, dear reader, have a better idea, you've got the source. :-) */
3338 if (XUINT (c
) < 0x100)
3339 putc (XUINT (c
), dribble
);
3341 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3345 Lisp_Object dribblee
;
3347 /* If it's a structured event, take the event header. */
3348 dribblee
= EVENT_HEAD (c
);
3350 if (SYMBOLP (dribblee
))
3352 putc ('<', dribble
);
3353 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3354 SBYTES (SYMBOL_NAME (dribblee
)),
3356 putc ('>', dribble
);
3365 /* Copy out or in the info on where C-g should throw to.
3366 This is used when running Lisp code from within get_char,
3367 in case get_char is called recursively.
3368 See read_process_output. */
3371 save_getcjmp (jmp_buf temp
)
3373 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3377 restore_getcjmp (jmp_buf temp
)
3379 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3382 /* Low level keyboard/mouse input.
3383 kbd_buffer_store_event places events in kbd_buffer, and
3384 kbd_buffer_get_event retrieves them. */
3386 /* Return true if there are any events in the queue that read-char
3387 would return. If this returns false, a read-char would block. */
3389 readable_events (int flags
)
3391 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3394 /* If the buffer contains only FOCUS_IN_EVENT events, and
3395 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3396 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3398 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3399 #ifdef USE_TOOLKIT_SCROLL_BARS
3400 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3404 struct input_event
*event
;
3406 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3413 #ifdef USE_TOOLKIT_SCROLL_BARS
3414 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3416 event
->kind
== FOCUS_IN_EVENT
)
3417 #ifdef USE_TOOLKIT_SCROLL_BARS
3418 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3419 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3420 && event
->part
== scroll_bar_handle
3421 && event
->modifiers
== 0)
3426 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3429 while (event
!= kbd_store_ptr
);
3435 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3436 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3437 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3442 if (current_kboard
->kbd_queue_has_data
)
3448 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3449 if (kb
->kbd_queue_has_data
)
3455 /* Set this for debugging, to have a way to get out */
3456 int stop_character EXTERNALLY_VISIBLE
;
3459 event_to_kboard (struct input_event
*event
)
3462 frame
= event
->frame_or_window
;
3464 frame
= XCAR (frame
);
3465 else if (WINDOWP (frame
))
3466 frame
= WINDOW_FRAME (XWINDOW (frame
));
3468 /* There are still some events that don't set this field.
3469 For now, just ignore the problem.
3470 Also ignore dead frames here. */
3471 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3474 return FRAME_KBOARD (XFRAME (frame
));
3478 /* Return the number of slots occupied in kbd_buffer. */
3481 kbd_buffer_nr_stored (void)
3483 return kbd_fetch_ptr
== kbd_store_ptr
3485 : (kbd_fetch_ptr
< kbd_store_ptr
3486 ? kbd_store_ptr
- kbd_fetch_ptr
3487 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3488 + (kbd_store_ptr
- kbd_buffer
)));
3490 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3493 kbd_buffer_store_event (register struct input_event
*event
)
3495 kbd_buffer_store_event_hold (event
, 0);
3498 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3500 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3501 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3502 Else, if EVENT is a quit event, store the quit event
3503 in HOLD_QUIT, and return (thus ignoring further events).
3505 This is used in read_avail_input to postpone the processing
3506 of the quit event until all subsequent input events have been
3507 parsed (and discarded).
3511 kbd_buffer_store_event_hold (register struct input_event
*event
,
3512 struct input_event
*hold_quit
)
3514 if (event
->kind
== NO_EVENT
)
3517 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3520 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3522 register int c
= event
->code
& 0377;
3524 if (event
->modifiers
& ctrl_modifier
)
3525 c
= make_ctrl_char (c
);
3527 c
|= (event
->modifiers
3528 & (meta_modifier
| alt_modifier
3529 | hyper_modifier
| super_modifier
));
3533 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3534 struct input_event
*sp
;
3536 if (single_kboard
&& kb
!= current_kboard
)
3538 KVAR (kb
, kbd_queue
)
3539 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3540 Fcons (make_number (c
), Qnil
));
3541 kb
->kbd_queue_has_data
= 1;
3542 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3544 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3547 if (event_to_kboard (sp
) == kb
)
3549 sp
->kind
= NO_EVENT
;
3550 sp
->frame_or_window
= Qnil
;
3559 memcpy (hold_quit
, event
, sizeof (*event
));
3563 /* If this results in a quit_char being returned to Emacs as
3564 input, set Vlast_event_frame properly. If this doesn't
3565 get returned to Emacs as an event, the next event read
3566 will set Vlast_event_frame again, so this is safe to do. */
3570 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3572 focus
= event
->frame_or_window
;
3573 internal_last_event_frame
= focus
;
3574 Vlast_event_frame
= focus
;
3577 last_event_timestamp
= event
->timestamp
;
3578 handle_interrupt ();
3582 if (c
&& c
== stop_character
)
3588 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3589 Just ignore the second one. */
3590 else if (event
->kind
== BUFFER_SWITCH_EVENT
3591 && kbd_fetch_ptr
!= kbd_store_ptr
3592 && ((kbd_store_ptr
== kbd_buffer
3593 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3594 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3597 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3598 kbd_store_ptr
= kbd_buffer
;
3600 /* Don't let the very last slot in the buffer become full,
3601 since that would make the two pointers equal,
3602 and that is indistinguishable from an empty buffer.
3603 Discard the event if it would fill the last slot. */
3604 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3606 *kbd_store_ptr
= *event
;
3609 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3611 /* Don't read keyboard input until we have processed kbd_buffer.
3612 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3613 hold_keyboard_input ();
3615 if (!noninteractive
)
3616 signal (SIGIO
, SIG_IGN
);
3620 #endif /* subprocesses */
3623 /* If we're inside while-no-input, and this event qualifies
3624 as input, set quit-flag to cause an interrupt. */
3625 if (!NILP (Vthrow_on_input
)
3626 && event
->kind
!= FOCUS_IN_EVENT
3627 && event
->kind
!= HELP_EVENT
3628 && event
->kind
!= DEICONIFY_EVENT
)
3630 Vquit_flag
= Vthrow_on_input
;
3631 /* If we're inside a function that wants immediate quits,
3633 if (immediate_quit
&& NILP (Vinhibit_quit
))
3643 /* Put an input event back in the head of the event queue. */
3646 kbd_buffer_unget_event (register struct input_event
*event
)
3648 if (kbd_fetch_ptr
== kbd_buffer
)
3649 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3651 /* Don't let the very last slot in the buffer become full, */
3652 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3655 *kbd_fetch_ptr
= *event
;
3660 /* Generate a HELP_EVENT input_event and store it in the keyboard
3663 HELP is the help form.
3665 FRAME and WINDOW are the frame and window where the help is
3666 generated. OBJECT is the Lisp object where the help was found (a
3667 buffer, a string, an overlay, or nil if neither from a string nor
3668 from a buffer). POS is the position within OBJECT where the help
3672 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3673 Lisp_Object object
, ptrdiff_t pos
)
3675 struct input_event event
;
3679 event
.kind
= HELP_EVENT
;
3680 event
.frame_or_window
= frame
;
3682 event
.x
= WINDOWP (window
) ? window
: frame
;
3685 kbd_buffer_store_event (&event
);
3689 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3692 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3694 struct input_event event
;
3696 event
.kind
= HELP_EVENT
;
3697 event
.frame_or_window
= frame
;
3702 kbd_buffer_store_event (&event
);
3706 /* Discard any mouse events in the event buffer by setting them to
3709 discard_mouse_events (void)
3711 struct input_event
*sp
;
3712 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3714 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3717 if (sp
->kind
== MOUSE_CLICK_EVENT
3718 || sp
->kind
== WHEEL_EVENT
3719 || sp
->kind
== HORIZ_WHEEL_EVENT
3721 || sp
->kind
== GPM_CLICK_EVENT
3723 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3725 sp
->kind
= NO_EVENT
;
3731 /* Return non-zero if there are any real events waiting in the event
3732 buffer, not counting `NO_EVENT's.
3734 If DISCARD is non-zero, discard NO_EVENT events at the front of
3735 the input queue, possibly leaving the input queue empty if there
3736 are no real input events. */
3739 kbd_buffer_events_waiting (int discard
)
3741 struct input_event
*sp
;
3743 for (sp
= kbd_fetch_ptr
;
3744 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3747 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3754 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3758 /* Clear input event EVENT. */
3761 clear_event (struct input_event
*event
)
3763 event
->kind
= NO_EVENT
;
3767 /* Read one event from the event buffer, waiting if necessary.
3768 The value is a Lisp object representing the event.
3769 The value is nil for an event that should be ignored,
3770 or that was handled here.
3771 We always read and discard one event. */
3774 kbd_buffer_get_event (KBOARD
**kbp
,
3775 int *used_mouse_menu
,
3776 struct timeval
*end_time
)
3782 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3784 /* Start reading input again, we have processed enough so we can
3785 accept new events again. */
3786 unhold_keyboard_input ();
3788 if (!noninteractive
)
3789 signal (SIGIO
, input_available_signal
);
3793 #endif /* subprocesses */
3796 /* In case we are running as a daemon, only do this before
3797 detaching from the terminal. */
3798 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3802 *kbp
= current_kboard
;
3806 /* Wait until there is input available. */
3809 /* Break loop if there's an unread command event. Needed in
3810 moused window autoselection which uses a timer to insert such
3812 if (CONSP (Vunread_command_events
))
3815 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3817 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3818 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3822 /* If the quit flag is set, then read_char will return
3823 quit_char, so that counts as "available input." */
3824 if (!NILP (Vquit_flag
))
3825 quit_throw_to_read_char (0);
3827 /* One way or another, wait until input is available; then, if
3828 interrupt handlers have not read it, read it now. */
3830 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3834 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3836 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3837 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3842 EMACS_TIME duration
;
3843 EMACS_GET_TIME (duration
);
3844 if (EMACS_TIME_GE (duration
, *end_time
))
3845 return Qnil
; /* finished waiting */
3848 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3849 wait_reading_process_output (EMACS_SECS (duration
),
3850 EMACS_USECS (duration
),
3851 -1, 1, Qnil
, NULL
, 0);
3855 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3857 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3858 /* Pass 1 for EXPECT since we just waited to have input. */
3859 read_avail_input (1);
3862 if (CONSP (Vunread_command_events
))
3865 first
= XCAR (Vunread_command_events
);
3866 Vunread_command_events
= XCDR (Vunread_command_events
);
3867 *kbp
= current_kboard
;
3871 /* At this point, we know that there is a readable event available
3872 somewhere. If the event queue is empty, then there must be a
3873 mouse movement enabled and available. */
3874 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3876 struct input_event
*event
;
3878 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3882 last_event_timestamp
= event
->timestamp
;
3884 *kbp
= event_to_kboard (event
);
3886 *kbp
= current_kboard
; /* Better than returning null ptr? */
3890 /* These two kinds of events get special handling
3891 and don't actually appear to the command loop.
3892 We return nil for them. */
3893 if (event
->kind
== SELECTION_REQUEST_EVENT
3894 || event
->kind
== SELECTION_CLEAR_EVENT
)
3897 struct input_event copy
;
3899 /* Remove it from the buffer before processing it,
3900 since otherwise swallow_events will see it
3901 and process it again. */
3903 kbd_fetch_ptr
= event
+ 1;
3904 input_pending
= readable_events (0);
3905 x_handle_selection_event (©
);
3907 /* We're getting selection request events, but we don't have
3913 #if defined (HAVE_NS)
3914 else if (event
->kind
== NS_TEXT_EVENT
)
3916 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3917 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3919 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3920 kbd_fetch_ptr
= event
+ 1;
3921 if (used_mouse_menu
)
3922 *used_mouse_menu
= 1;
3926 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3927 || defined (HAVE_NS)
3928 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3930 /* Make an event (delete-frame (FRAME)). */
3931 obj
= Fcons (event
->frame_or_window
, Qnil
);
3932 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3933 kbd_fetch_ptr
= event
+ 1;
3936 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3937 || defined (HAVE_NS)
3938 else if (event
->kind
== ICONIFY_EVENT
)
3940 /* Make an event (iconify-frame (FRAME)). */
3941 obj
= Fcons (event
->frame_or_window
, Qnil
);
3942 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3943 kbd_fetch_ptr
= event
+ 1;
3945 else if (event
->kind
== DEICONIFY_EVENT
)
3947 /* Make an event (make-frame-visible (FRAME)). */
3948 obj
= Fcons (event
->frame_or_window
, Qnil
);
3949 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3950 kbd_fetch_ptr
= event
+ 1;
3953 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3955 /* The value doesn't matter here; only the type is tested. */
3956 XSETBUFFER (obj
, current_buffer
);
3957 kbd_fetch_ptr
= event
+ 1;
3959 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3960 || defined (HAVE_NS) || defined (USE_GTK)
3961 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3963 kbd_fetch_ptr
= event
+ 1;
3964 input_pending
= readable_events (0);
3965 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3966 x_activate_menubar (XFRAME (event
->frame_or_window
));
3969 #if defined (WINDOWSNT)
3970 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3972 /* Make an event (language-change (FRAME CHARSET LCID)). */
3973 obj
= Fcons (event
->frame_or_window
, Qnil
);
3974 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3975 kbd_fetch_ptr
= event
+ 1;
3978 else if (event
->kind
== SAVE_SESSION_EVENT
)
3980 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3981 kbd_fetch_ptr
= event
+ 1;
3983 /* Just discard these, by returning nil.
3984 With MULTI_KBOARD, these events are used as placeholders
3985 when we need to randomly delete events from the queue.
3986 (They shouldn't otherwise be found in the buffer,
3987 but on some machines it appears they do show up
3988 even without MULTI_KBOARD.) */
3989 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3990 mouse events during a popup-menu call. */
3991 else if (event
->kind
== NO_EVENT
)
3992 kbd_fetch_ptr
= event
+ 1;
3993 else if (event
->kind
== HELP_EVENT
)
3995 Lisp_Object object
, position
, help
, frame
, window
;
3997 frame
= event
->frame_or_window
;
3998 object
= event
->arg
;
3999 position
= make_number (event
->code
);
4002 clear_event (event
);
4004 kbd_fetch_ptr
= event
+ 1;
4005 if (!WINDOWP (window
))
4007 obj
= Fcons (Qhelp_echo
,
4008 list5 (frame
, help
, window
, object
, position
));
4010 else if (event
->kind
== FOCUS_IN_EVENT
)
4012 /* Notification of a FocusIn event. The frame receiving the
4013 focus is in event->frame_or_window. Generate a
4014 switch-frame event if necessary. */
4015 Lisp_Object frame
, focus
;
4017 frame
= event
->frame_or_window
;
4018 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4022 if (!EQ (frame
, internal_last_event_frame
)
4023 && !EQ (frame
, selected_frame
))
4024 obj
= make_lispy_switch_frame (frame
);
4025 internal_last_event_frame
= frame
;
4026 kbd_fetch_ptr
= event
+ 1;
4029 else if (event
->kind
== DBUS_EVENT
)
4031 obj
= make_lispy_event (event
);
4032 kbd_fetch_ptr
= event
+ 1;
4035 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4037 obj
= make_lispy_event (event
);
4038 kbd_fetch_ptr
= event
+ 1;
4042 /* If this event is on a different frame, return a switch-frame this
4043 time, and leave the event in the queue for next time. */
4047 frame
= event
->frame_or_window
;
4049 frame
= XCAR (frame
);
4050 else if (WINDOWP (frame
))
4051 frame
= WINDOW_FRAME (XWINDOW (frame
));
4053 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4057 if (! EQ (frame
, internal_last_event_frame
)
4058 && !EQ (frame
, selected_frame
))
4059 obj
= make_lispy_switch_frame (frame
);
4060 internal_last_event_frame
= frame
;
4062 /* If we didn't decide to make a switch-frame event, go ahead
4063 and build a real event from the queue entry. */
4067 obj
= make_lispy_event (event
);
4069 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4070 || defined (HAVE_NS) || defined (USE_GTK)
4071 /* If this was a menu selection, then set the flag to inhibit
4072 writing to last_nonmenu_event. Don't do this if the event
4073 we're returning is (menu-bar), though; that indicates the
4074 beginning of the menu sequence, and we might as well leave
4075 that as the `event with parameters' for this selection. */
4077 && !EQ (event
->frame_or_window
, event
->arg
)
4078 && (event
->kind
== MENU_BAR_EVENT
4079 || event
->kind
== TOOL_BAR_EVENT
))
4080 *used_mouse_menu
= 1;
4083 /* certain system events are non-key events */
4085 && event
->kind
== NS_NONKEY_EVENT
)
4086 *used_mouse_menu
= 1;
4089 /* Wipe out this event, to catch bugs. */
4090 clear_event (event
);
4091 kbd_fetch_ptr
= event
+ 1;
4095 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4096 /* Try generating a mouse motion event. */
4097 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4099 FRAME_PTR f
= some_mouse_moved ();
4100 Lisp_Object bar_window
;
4101 enum scroll_bar_part part
;
4105 *kbp
= current_kboard
;
4106 /* Note that this uses F to determine which terminal to look at.
4107 If there is no valid info, it does not store anything
4108 so x remains nil. */
4111 /* XXX Can f or mouse_position_hook be NULL here? */
4112 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4113 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4118 /* Decide if we should generate a switch-frame event. Don't
4119 generate switch-frame events for motion outside of all Emacs
4125 frame
= FRAME_FOCUS_FRAME (f
);
4127 XSETFRAME (frame
, f
);
4129 if (! EQ (frame
, internal_last_event_frame
)
4130 && !EQ (frame
, selected_frame
))
4131 obj
= make_lispy_switch_frame (frame
);
4132 internal_last_event_frame
= frame
;
4135 /* If we didn't decide to make a switch-frame event, go ahead and
4136 return a mouse-motion event. */
4137 if (!NILP (x
) && NILP (obj
))
4138 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4140 #endif /* HAVE_MOUSE || HAVE GPM */
4142 /* We were promised by the above while loop that there was
4143 something for us to read! */
4146 input_pending
= readable_events (0);
4148 Vlast_event_frame
= internal_last_event_frame
;
4153 /* Process any non-user-visible events (currently X selection events),
4154 without reading any user-visible events. */
4157 process_special_events (void)
4159 struct input_event
*event
;
4161 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4163 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4166 if (event
== kbd_store_ptr
)
4170 /* If we find a stored X selection request, handle it now. */
4171 if (event
->kind
== SELECTION_REQUEST_EVENT
4172 || event
->kind
== SELECTION_CLEAR_EVENT
)
4176 /* Remove the event from the fifo buffer before processing;
4177 otherwise swallow_events called recursively could see it
4178 and process it again. To do this, we move the events
4179 between kbd_fetch_ptr and EVENT one slot to the right,
4182 struct input_event copy
= *event
;
4183 struct input_event
*beg
4184 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4185 ? kbd_buffer
: kbd_fetch_ptr
;
4188 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4189 else if (event
< beg
)
4191 if (event
> kbd_buffer
)
4192 memmove (kbd_buffer
+ 1, kbd_buffer
,
4193 (event
- kbd_buffer
) * sizeof (struct input_event
));
4194 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4195 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4196 memmove (beg
+ 1, beg
,
4197 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4198 * sizeof (struct input_event
));
4201 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4202 kbd_fetch_ptr
= kbd_buffer
+ 1;
4206 /* X wants last_event_timestamp for selection ownership. */
4207 last_event_timestamp
= copy
.timestamp
;
4208 input_pending
= readable_events (0);
4209 x_handle_selection_event (©
);
4211 /* We're getting selection request events, but we don't have
4219 /* Process any events that are not user-visible, run timer events that
4220 are ripe, and return, without reading any user-visible events. */
4223 swallow_events (int do_display
)
4227 process_special_events ();
4229 old_timers_run
= timers_run
;
4230 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4232 if (timers_run
!= old_timers_run
&& do_display
)
4233 redisplay_preserve_echo_area (7);
4236 /* Record the start of when Emacs is idle,
4237 for the sake of running idle-time timers. */
4240 timer_start_idle (void)
4244 /* If we are already in the idle state, do nothing. */
4245 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4248 EMACS_GET_TIME (timer_idleness_start_time
);
4250 timer_last_idleness_start_time
= timer_idleness_start_time
;
4252 /* Mark all idle-time timers as once again candidates for running. */
4253 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4257 timer
= XCAR (timers
);
4259 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4261 XVECTOR (timer
)->contents
[0] = Qnil
;
4265 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4268 timer_stop_idle (void)
4270 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4273 /* Resume idle timer from last idle start time. */
4276 timer_resume_idle (void)
4278 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4281 timer_idleness_start_time
= timer_last_idleness_start_time
;
4284 /* This is only for debugging. */
4285 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4287 /* List of elisp functions to call, delayed because they were generated in
4288 a context where Elisp could not be safely run (e.g. redisplay, signal,
4289 ...). Each element has the form (FUN . ARGS). */
4290 Lisp_Object pending_funcalls
;
4292 /* Check whether a timer has fired. To prevent larger problems we simply
4293 disregard elements that are not proper timers. Do not make a circular
4294 timer list for the time being.
4296 Returns the time to wait until the next timer fires. If a
4297 timer is triggering now, return zero.
4298 If no timer is active, return -1.
4300 If a timer is ripe, we run it, with quitting turned off.
4301 In that case we return 0 to indicate that a new timer_check_2 call
4305 timer_check_2 (void)
4307 EMACS_TIME nexttime
;
4309 EMACS_TIME idleness_now
IF_LINT (= {0});
4310 Lisp_Object timers
, idle_timers
, chosen_timer
;
4311 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4313 EMACS_SET_SECS (nexttime
, -1);
4314 EMACS_SET_USECS (nexttime
, -1);
4316 /* Always consider the ordinary timers. */
4317 timers
= Vtimer_list
;
4318 /* Consider the idle timers only if Emacs is idle. */
4319 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4320 idle_timers
= Vtimer_idle_list
;
4323 chosen_timer
= Qnil
;
4324 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4326 /* First run the code that was delayed. */
4327 while (CONSP (pending_funcalls
))
4329 Lisp_Object funcall
= XCAR (pending_funcalls
);
4330 pending_funcalls
= XCDR (pending_funcalls
);
4331 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4334 if (CONSP (timers
) || CONSP (idle_timers
))
4336 EMACS_GET_TIME (now
);
4337 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4338 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4341 while (CONSP (timers
) || CONSP (idle_timers
))
4343 Lisp_Object
*vector
;
4344 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4345 EMACS_TIME timer_time
, idle_timer_time
;
4346 EMACS_TIME difference
;
4347 EMACS_TIME timer_difference
IF_LINT (= {0});
4348 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4350 /* Skip past invalid timers and timers already handled. */
4353 timer
= XCAR (timers
);
4354 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4356 timers
= XCDR (timers
);
4359 vector
= XVECTOR (timer
)->contents
;
4361 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4362 || !INTEGERP (vector
[3])
4363 || ! NILP (vector
[0]))
4365 timers
= XCDR (timers
);
4369 if (CONSP (idle_timers
))
4371 timer
= XCAR (idle_timers
);
4372 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4374 idle_timers
= XCDR (idle_timers
);
4377 vector
= XVECTOR (timer
)->contents
;
4379 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4380 || !INTEGERP (vector
[3])
4381 || ! NILP (vector
[0]))
4383 idle_timers
= XCDR (idle_timers
);
4388 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4389 based on the next ordinary timer.
4390 TIMER_DIFFERENCE is the distance in time from NOW to when
4391 this timer becomes ripe (negative if it's already ripe). */
4394 timer
= XCAR (timers
);
4395 vector
= XVECTOR (timer
)->contents
;
4396 EMACS_SET_SECS (timer_time
,
4397 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4398 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4399 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4402 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4403 based on the next idle timer. */
4404 if (CONSP (idle_timers
))
4406 idle_timer
= XCAR (idle_timers
);
4407 vector
= XVECTOR (idle_timer
)->contents
;
4408 EMACS_SET_SECS (idle_timer_time
,
4409 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4410 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4411 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4414 /* Decide which timer is the next timer,
4415 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4416 Also step down the list where we found that timer. */
4418 if (CONSP (timers
) && CONSP (idle_timers
))
4421 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4422 if (EMACS_TIME_NEG_P (temp
))
4424 chosen_timer
= timer
;
4425 timers
= XCDR (timers
);
4426 difference
= timer_difference
;
4430 chosen_timer
= idle_timer
;
4431 idle_timers
= XCDR (idle_timers
);
4432 difference
= idle_timer_difference
;
4435 else if (CONSP (timers
))
4437 chosen_timer
= timer
;
4438 timers
= XCDR (timers
);
4439 difference
= timer_difference
;
4443 chosen_timer
= idle_timer
;
4444 idle_timers
= XCDR (idle_timers
);
4445 difference
= idle_timer_difference
;
4447 vector
= XVECTOR (chosen_timer
)->contents
;
4449 /* If timer is ripe, run it if it hasn't been run. */
4450 if (EMACS_TIME_NEG_P (difference
)
4451 || (EMACS_SECS (difference
) == 0
4452 && EMACS_USECS (difference
) == 0))
4454 if (NILP (vector
[0]))
4456 ptrdiff_t count
= SPECPDL_INDEX ();
4457 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4459 /* Mark the timer as triggered to prevent problems if the lisp
4460 code fails to reschedule it right. */
4463 specbind (Qinhibit_quit
, Qt
);
4465 call1 (Qtimer_event_handler
, chosen_timer
);
4466 Vdeactivate_mark
= old_deactivate_mark
;
4468 unbind_to (count
, Qnil
);
4470 /* Since we have handled the event,
4471 we don't need to tell the caller to wake up and do it. */
4472 /* But the caller must still wait for the next timer, so
4473 return 0 to indicate that. */
4476 EMACS_SET_SECS (nexttime
, 0);
4477 EMACS_SET_USECS (nexttime
, 0);
4480 /* When we encounter a timer that is still waiting,
4481 return the amount of time to wait before it is ripe. */
4488 /* No timers are pending in the future. */
4489 /* Return 0 if we generated an event, and -1 if not. */
4495 /* Check whether a timer has fired. To prevent larger problems we simply
4496 disregard elements that are not proper timers. Do not make a circular
4497 timer list for the time being.
4499 Returns the time to wait until the next timer fires.
4500 If no timer is active, return -1.
4502 As long as any timer is ripe, we run it. */
4507 EMACS_TIME nexttime
;
4511 nexttime
= timer_check_2 ();
4513 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4518 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4519 doc
: /* Return the current length of Emacs idleness, or nil.
4520 The value when Emacs is idle is a list of three integers. The first has
4521 the most significant 16 bits of the seconds, while the second has the least
4522 significant 16 bits. The third integer gives the microsecond count.
4524 The value when Emacs is not idle is nil.
4526 The microsecond count is zero on systems that do not provide
4527 resolution finer than a second. */)
4530 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4532 EMACS_TIME now
, idleness_now
;
4534 EMACS_GET_TIME (now
);
4535 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4537 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4538 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4539 make_number (EMACS_USECS (idleness_now
)));
4545 /* Caches for modify_event_symbol. */
4546 static Lisp_Object accent_key_syms
;
4547 static Lisp_Object func_key_syms
;
4548 static Lisp_Object mouse_syms
;
4549 static Lisp_Object wheel_syms
;
4550 static Lisp_Object drag_n_drop_syms
;
4552 /* This is a list of keysym codes for special "accent" characters.
4553 It parallels lispy_accent_keys. */
4555 static const int lispy_accent_codes
[] =
4557 #ifdef XK_dead_circumflex
4562 #ifdef XK_dead_grave
4567 #ifdef XK_dead_tilde
4572 #ifdef XK_dead_diaeresis
4577 #ifdef XK_dead_macron
4582 #ifdef XK_dead_degree
4587 #ifdef XK_dead_acute
4592 #ifdef XK_dead_cedilla
4597 #ifdef XK_dead_breve
4602 #ifdef XK_dead_ogonek
4607 #ifdef XK_dead_caron
4612 #ifdef XK_dead_doubleacute
4613 XK_dead_doubleacute
,
4617 #ifdef XK_dead_abovedot
4622 #ifdef XK_dead_abovering
4632 #ifdef XK_dead_belowdot
4637 #ifdef XK_dead_voiced_sound
4638 XK_dead_voiced_sound
,
4642 #ifdef XK_dead_semivoiced_sound
4643 XK_dead_semivoiced_sound
,
4659 /* This is a list of Lisp names for special "accent" characters.
4660 It parallels lispy_accent_codes. */
4662 static const char *const lispy_accent_keys
[] =
4680 "dead-voiced-sound",
4681 "dead-semivoiced-sound",
4687 #define FUNCTION_KEY_OFFSET 0x0
4689 const char *const lispy_function_keys
[] =
4693 0, /* VK_LBUTTON 0x01 */
4694 0, /* VK_RBUTTON 0x02 */
4695 "cancel", /* VK_CANCEL 0x03 */
4696 0, /* VK_MBUTTON 0x04 */
4698 0, 0, 0, /* 0x05 .. 0x07 */
4700 "backspace", /* VK_BACK 0x08 */
4701 "tab", /* VK_TAB 0x09 */
4703 0, 0, /* 0x0A .. 0x0B */
4705 "clear", /* VK_CLEAR 0x0C */
4706 "return", /* VK_RETURN 0x0D */
4708 0, 0, /* 0x0E .. 0x0F */
4710 0, /* VK_SHIFT 0x10 */
4711 0, /* VK_CONTROL 0x11 */
4712 0, /* VK_MENU 0x12 */
4713 "pause", /* VK_PAUSE 0x13 */
4714 "capslock", /* VK_CAPITAL 0x14 */
4715 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4717 "junja", /* VK_JUNJA 0x17 */
4718 "final", /* VK_FINAL 0x18 */
4719 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4721 "escape", /* VK_ESCAPE 0x1B */
4722 "convert", /* VK_CONVERT 0x1C */
4723 "non-convert", /* VK_NONCONVERT 0x1D */
4724 "accept", /* VK_ACCEPT 0x1E */
4725 "mode-change", /* VK_MODECHANGE 0x1F */
4726 0, /* VK_SPACE 0x20 */
4727 "prior", /* VK_PRIOR 0x21 */
4728 "next", /* VK_NEXT 0x22 */
4729 "end", /* VK_END 0x23 */
4730 "home", /* VK_HOME 0x24 */
4731 "left", /* VK_LEFT 0x25 */
4732 "up", /* VK_UP 0x26 */
4733 "right", /* VK_RIGHT 0x27 */
4734 "down", /* VK_DOWN 0x28 */
4735 "select", /* VK_SELECT 0x29 */
4736 "print", /* VK_PRINT 0x2A */
4737 "execute", /* VK_EXECUTE 0x2B */
4738 "snapshot", /* VK_SNAPSHOT 0x2C */
4739 "insert", /* VK_INSERT 0x2D */
4740 "delete", /* VK_DELETE 0x2E */
4741 "help", /* VK_HELP 0x2F */
4743 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4745 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4747 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4749 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4751 0, 0, 0, 0, 0, 0, 0, 0, 0,
4752 0, 0, 0, 0, 0, 0, 0, 0, 0,
4753 0, 0, 0, 0, 0, 0, 0, 0,
4755 "lwindow", /* VK_LWIN 0x5B */
4756 "rwindow", /* VK_RWIN 0x5C */
4757 "apps", /* VK_APPS 0x5D */
4760 "kp-0", /* VK_NUMPAD0 0x60 */
4761 "kp-1", /* VK_NUMPAD1 0x61 */
4762 "kp-2", /* VK_NUMPAD2 0x62 */
4763 "kp-3", /* VK_NUMPAD3 0x63 */
4764 "kp-4", /* VK_NUMPAD4 0x64 */
4765 "kp-5", /* VK_NUMPAD5 0x65 */
4766 "kp-6", /* VK_NUMPAD6 0x66 */
4767 "kp-7", /* VK_NUMPAD7 0x67 */
4768 "kp-8", /* VK_NUMPAD8 0x68 */
4769 "kp-9", /* VK_NUMPAD9 0x69 */
4770 "kp-multiply", /* VK_MULTIPLY 0x6A */
4771 "kp-add", /* VK_ADD 0x6B */
4772 "kp-separator", /* VK_SEPARATOR 0x6C */
4773 "kp-subtract", /* VK_SUBTRACT 0x6D */
4774 "kp-decimal", /* VK_DECIMAL 0x6E */
4775 "kp-divide", /* VK_DIVIDE 0x6F */
4776 "f1", /* VK_F1 0x70 */
4777 "f2", /* VK_F2 0x71 */
4778 "f3", /* VK_F3 0x72 */
4779 "f4", /* VK_F4 0x73 */
4780 "f5", /* VK_F5 0x74 */
4781 "f6", /* VK_F6 0x75 */
4782 "f7", /* VK_F7 0x76 */
4783 "f8", /* VK_F8 0x77 */
4784 "f9", /* VK_F9 0x78 */
4785 "f10", /* VK_F10 0x79 */
4786 "f11", /* VK_F11 0x7A */
4787 "f12", /* VK_F12 0x7B */
4788 "f13", /* VK_F13 0x7C */
4789 "f14", /* VK_F14 0x7D */
4790 "f15", /* VK_F15 0x7E */
4791 "f16", /* VK_F16 0x7F */
4792 "f17", /* VK_F17 0x80 */
4793 "f18", /* VK_F18 0x81 */
4794 "f19", /* VK_F19 0x82 */
4795 "f20", /* VK_F20 0x83 */
4796 "f21", /* VK_F21 0x84 */
4797 "f22", /* VK_F22 0x85 */
4798 "f23", /* VK_F23 0x86 */
4799 "f24", /* VK_F24 0x87 */
4801 0, 0, 0, 0, /* 0x88 .. 0x8B */
4802 0, 0, 0, 0, /* 0x8C .. 0x8F */
4804 "kp-numlock", /* VK_NUMLOCK 0x90 */
4805 "scroll", /* VK_SCROLL 0x91 */
4806 /* Not sure where the following block comes from.
4807 Windows headers have NEC and Fujitsu specific keys in
4808 this block, but nothing generic. */
4809 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4810 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4811 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4812 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4813 "kp-end", /* VK_NUMPAD_END 0x96 */
4814 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4815 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4816 "kp-up", /* VK_NUMPAD_UP 0x99 */
4817 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4818 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4819 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4820 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4822 0, 0, /* 0x9E .. 0x9F */
4825 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4826 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4827 * No other API or message will distinguish left and right keys this way.
4832 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4833 to enable them selectively, and gives access to a few more functions.
4834 See lispy_multimedia_keys below. */
4835 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4836 0, 0, 0, /* 0xAD .. 0xAF Volume */
4837 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4838 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4840 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4841 0, 0, 0, 0, 0, 0, 0, 0, 0,
4843 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4844 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4845 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4848 "ax", /* VK_OEM_AX 0xE1 */
4849 0, /* VK_OEM_102 0xE2 */
4850 "ico-help", /* VK_ICO_HELP 0xE3 */
4851 "ico-00", /* VK_ICO_00 0xE4 */
4852 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4853 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4854 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4856 "reset", /* VK_OEM_RESET 0xE9 */
4857 "jump", /* VK_OEM_JUMP 0xEA */
4858 "oem-pa1", /* VK_OEM_PA1 0xEB */
4859 "oem-pa2", /* VK_OEM_PA2 0xEC */
4860 "oem-pa3", /* VK_OEM_PA3 0xED */
4861 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4862 "cusel", /* VK_OEM_CUSEL 0xEF */
4863 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4864 "finish", /* VK_OEM_FINISH 0xF1 */
4865 "copy", /* VK_OEM_COPY 0xF2 */
4866 "auto", /* VK_OEM_AUTO 0xF3 */
4867 "enlw", /* VK_OEM_ENLW 0xF4 */
4868 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4869 "attn", /* VK_ATTN 0xF6 */
4870 "crsel", /* VK_CRSEL 0xF7 */
4871 "exsel", /* VK_EXSEL 0xF8 */
4872 "ereof", /* VK_EREOF 0xF9 */
4873 "play", /* VK_PLAY 0xFA */
4874 "zoom", /* VK_ZOOM 0xFB */
4875 "noname", /* VK_NONAME 0xFC */
4876 "pa1", /* VK_PA1 0xFD */
4877 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4881 /* Some of these duplicate the "Media keys" on newer keyboards,
4882 but they are delivered to the application in a different way. */
4883 static const char *const lispy_multimedia_keys
[] =
4891 "browser-favorites",
4928 "toggle-dictate-command",
4934 "media-fast-forward",
4937 "media-channel-down"
4940 #else /* not HAVE_NTGUI */
4942 /* This should be dealt with in XTread_socket now, and that doesn't
4943 depend on the client system having the Kana syms defined. See also
4944 the XK_kana_A case below. */
4947 static const char *const lispy_kana_keys
[] =
4949 /* X Keysym value */
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4952 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4955 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4956 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4957 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4958 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4959 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4960 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4961 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4962 "kana-i", "kana-u", "kana-e", "kana-o",
4963 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4964 "prolongedsound", "kana-A", "kana-I", "kana-U",
4965 "kana-E", "kana-O", "kana-KA", "kana-KI",
4966 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4967 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4968 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4969 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4970 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4971 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4972 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4973 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4974 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4975 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4976 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4977 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4979 #endif /* XK_kana_A */
4982 #define FUNCTION_KEY_OFFSET 0xff00
4984 /* You'll notice that this table is arranged to be conveniently
4985 indexed by X Windows keysym values. */
4986 static const char *const lispy_function_keys
[] =
4988 /* X Keysym value */
4990 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4991 "backspace", "tab", "linefeed", "clear",
4993 0, 0, 0, "pause", /* 0xff10...1f */
4994 0, 0, 0, 0, 0, 0, 0, "escape",
4996 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4997 "romaji", "hiragana", "katakana", "hiragana-katakana",
4998 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4999 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5000 "eisu-toggle", /* 0xff30...3f */
5001 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5002 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5004 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5005 "down", "prior", "next", "end",
5006 "begin", 0, 0, 0, 0, 0, 0, 0,
5007 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5018 "break", /* 0xff6b */
5021 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5022 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5023 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5024 0, 0, 0, 0, 0, 0, 0, 0,
5025 "kp-tab", /* 0xff89 */
5027 "kp-enter", /* 0xff8d */
5029 "kp-f1", /* 0xff91 */
5033 "kp-home", /* 0xff95 */
5038 "kp-prior", /* kp-page-up */
5039 "kp-next", /* kp-page-down */
5045 0, 0, 0, 0, 0, 0, 0, 0, 0,
5046 "kp-multiply", /* 0xffaa */
5051 "kp-divide", /* 0xffaf */
5052 "kp-0", /* 0xffb0 */
5053 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5056 "kp-equal", /* 0xffbd */
5057 "f1", /* 0xffbe */ /* IsFunctionKey */
5059 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5060 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5061 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5062 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5063 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5064 0, 0, 0, 0, 0, 0, 0, 0,
5065 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5066 0, 0, 0, 0, 0, 0, 0, "delete"
5069 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5070 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5072 static const char *const iso_lispy_function_keys
[] =
5074 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5075 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5076 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5077 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5078 "iso-lefttab", /* 0xfe20 */
5079 "iso-move-line-up", "iso-move-line-down",
5080 "iso-partial-line-up", "iso-partial-line-down",
5081 "iso-partial-space-left", "iso-partial-space-right",
5082 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5083 "iso-release-margin-left", "iso-release-margin-right",
5084 "iso-release-both-margins",
5085 "iso-fast-cursor-left", "iso-fast-cursor-right",
5086 "iso-fast-cursor-up", "iso-fast-cursor-down",
5087 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5088 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5091 #endif /* not HAVE_NTGUI */
5093 static Lisp_Object Vlispy_mouse_stem
;
5095 static const char *const lispy_wheel_names
[] =
5097 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5100 /* drag-n-drop events are generated when a set of selected files are
5101 dragged from another application and dropped onto an Emacs window. */
5102 static const char *const lispy_drag_n_drop_names
[] =
5107 /* Scroll bar parts. */
5108 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5109 Lisp_Object Qup
, Qdown
, Qbottom
;
5110 static Lisp_Object Qend_scroll
;
5112 static Lisp_Object Qratio
;
5114 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5115 static Lisp_Object
*const scroll_bar_parts
[] = {
5116 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5117 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5120 /* A vector, indexed by button number, giving the down-going location
5121 of currently depressed buttons, both scroll bar and non-scroll bar.
5123 The elements have the form
5124 (BUTTON-NUMBER MODIFIER-MASK . REST)
5125 where REST is the cdr of a position as it would be reported in the event.
5127 The make_lispy_event function stores positions here to tell the
5128 difference between click and drag events, and to store the starting
5129 location to be included in drag events. */
5131 static Lisp_Object button_down_location
;
5133 /* Information about the most recent up-going button event: Which
5134 button, what location, and what time. */
5136 static int last_mouse_button
;
5137 static int last_mouse_x
;
5138 static int last_mouse_y
;
5139 static Time button_down_time
;
5141 /* The number of clicks in this multiple-click. */
5143 static int double_click_count
;
5145 /* X and Y are frame-relative coordinates for a click or wheel event.
5146 Return a Lisp-style event list. */
5149 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5152 enum window_part part
;
5153 Lisp_Object posn
= Qnil
;
5154 Lisp_Object extra_info
= Qnil
;
5155 /* Coordinate pixel positions to return. */
5156 int xret
= 0, yret
= 0;
5157 /* The window under frame pixel coordinates (x,y) */
5158 Lisp_Object window
= f
5159 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5162 if (WINDOWP (window
))
5164 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5165 struct window
*w
= XWINDOW (window
);
5166 Lisp_Object string_info
= Qnil
;
5167 ptrdiff_t textpos
= -1;
5168 int col
= -1, row
= -1;
5169 int dx
= -1, dy
= -1;
5170 int width
= -1, height
= -1;
5171 Lisp_Object object
= Qnil
;
5173 /* Pixel coordinates relative to the window corner. */
5174 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5175 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5177 /* For text area clicks, return X, Y relative to the corner of
5178 this text area. Note that dX, dY etc are set below, by
5179 buffer_posn_from_coords. */
5180 if (part
== ON_TEXT
)
5182 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5183 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5185 /* For mode line and header line clicks, return X, Y relative to
5186 the left window edge. Use mode_line_string to look for a
5187 string on the click position. */
5188 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5193 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5194 /* Note that mode_line_string takes COL, ROW as pixels and
5195 converts them to characters. */
5198 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5199 &object
, &dx
, &dy
, &width
, &height
);
5200 if (STRINGP (string
))
5201 string_info
= Fcons (string
, make_number (charpos
));
5202 textpos
= (w
== XWINDOW (selected_window
)
5203 && current_buffer
== XBUFFER (w
->buffer
))
5204 ? PT
: XMARKER (w
->pointm
)->charpos
;
5209 /* For fringes and margins, Y is relative to the area's (and the
5210 window's) top edge, while X is meaningless. */
5211 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5216 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5219 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5220 &object
, &dx
, &dy
, &width
, &height
);
5221 if (STRINGP (string
))
5222 string_info
= Fcons (string
, make_number (charpos
));
5223 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5225 else if (part
== ON_LEFT_FRINGE
)
5227 posn
= Qleft_fringe
;
5230 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5231 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5232 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5234 else if (part
== ON_RIGHT_FRINGE
)
5236 posn
= Qright_fringe
;
5239 - window_box_width (w
, LEFT_MARGIN_AREA
)
5240 - window_box_width (w
, TEXT_AREA
)
5241 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5242 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5244 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5246 else if (part
== ON_VERTICAL_BORDER
)
5248 posn
= Qvertical_line
;
5253 /* Nothing special for part == ON_SCROLL_BAR. */
5255 /* For clicks in the text area, fringes, or margins, call
5256 buffer_posn_from_coords to extract TEXTPOS, the buffer
5257 position nearest to the click. */
5260 Lisp_Object string2
, object2
= Qnil
;
5261 struct display_pos p
;
5263 int width2
, height2
;
5264 /* The pixel X coordinate passed to buffer_posn_from_coords
5265 is the X coordinate relative to the text area for
5266 text-area and right-margin clicks, zero otherwise. */
5268 = (part
== ON_TEXT
) ? xret
5269 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5270 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5274 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5275 &object2
, &dx2
, &dy2
,
5277 textpos
= CHARPOS (p
.pos
);
5278 if (col
< 0) col
= x2
;
5279 if (row
< 0) row
= y2
;
5280 if (dx
< 0) dx
= dx2
;
5281 if (dy
< 0) dy
= dy2
;
5282 if (width
< 0) width
= width2
;
5283 if (height
< 0) height
= height2
;
5287 posn
= make_number (textpos
);
5288 if (STRINGP (string2
))
5289 string_info
= Fcons (string2
,
5290 make_number (CHARPOS (p
.string_pos
)));
5296 #ifdef HAVE_WINDOW_SYSTEM
5297 if (IMAGEP (object
))
5299 Lisp_Object image_map
, hotspot
;
5300 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5302 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5304 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5305 posn
= XCAR (hotspot
);
5312 Fcons (make_number (dx
), make_number (dy
)),
5313 Fcons (make_number (width
), make_number (height
)));
5316 extra_info
= Fcons (string_info
,
5317 Fcons (make_number (textpos
),
5318 Fcons (Fcons (make_number (col
),
5323 XSETFRAME (window
, f
);
5327 return Fcons (window
,
5329 Fcons (Fcons (make_number (xret
),
5330 make_number (yret
)),
5331 Fcons (make_number (t
),
5335 /* Given a struct input_event, build the lisp event which represents
5336 it. If EVENT is 0, build a mouse movement event from the mouse
5337 movement buffer, which should have a movement event in it.
5339 Note that events must be passed to this function in the order they
5340 are received; this function stores the location of button presses
5341 in order to build drag events when the button is released. */
5344 make_lispy_event (struct input_event
*event
)
5348 switch (SWITCH_ENUM_CAST (event
->kind
))
5350 /* A simple keystroke. */
5351 case ASCII_KEYSTROKE_EVENT
:
5352 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5354 Lisp_Object lispy_c
;
5355 EMACS_INT c
= event
->code
;
5356 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5359 eassert (c
== event
->code
);
5360 /* Turn ASCII characters into control characters
5362 if (event
->modifiers
& ctrl_modifier
)
5364 c
= make_ctrl_char (c
);
5365 event
->modifiers
&= ~ctrl_modifier
;
5369 /* Add in the other modifier bits. The shift key was taken care
5370 of by the X code. */
5371 c
|= (event
->modifiers
5372 & (meta_modifier
| alt_modifier
5373 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5374 /* Distinguish Shift-SPC from SPC. */
5375 if ((event
->code
) == 040
5376 && event
->modifiers
& shift_modifier
)
5377 c
|= shift_modifier
;
5378 button_down_time
= 0;
5379 XSETFASTINT (lispy_c
, c
);
5384 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5385 except that they are non-key events (last-nonmenu-event is nil). */
5386 case NS_NONKEY_EVENT
:
5389 /* A function key. The symbol may need to have modifier prefixes
5391 case NON_ASCII_KEYSTROKE_EVENT
:
5392 button_down_time
= 0;
5394 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5395 if (event
->code
== lispy_accent_codes
[i
])
5396 return modify_event_symbol (i
,
5398 Qfunction_key
, Qnil
,
5399 lispy_accent_keys
, &accent_key_syms
,
5400 (sizeof (lispy_accent_keys
)
5401 / sizeof (lispy_accent_keys
[0])));
5405 if (event
->code
>= 0x400 && event
->code
< 0x500)
5406 return modify_event_symbol (event
->code
- 0x400,
5407 event
->modifiers
& ~shift_modifier
,
5408 Qfunction_key
, Qnil
,
5409 lispy_kana_keys
, &func_key_syms
,
5410 (sizeof (lispy_kana_keys
)
5411 / sizeof (lispy_kana_keys
[0])));
5412 #endif /* XK_kana_A */
5415 #ifdef ISO_FUNCTION_KEY_OFFSET
5416 if (event
->code
< FUNCTION_KEY_OFFSET
5417 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5418 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5420 Qfunction_key
, Qnil
,
5421 iso_lispy_function_keys
, &func_key_syms
,
5422 (sizeof (iso_lispy_function_keys
)
5423 / sizeof (iso_lispy_function_keys
[0])));
5426 /* Handle system-specific or unknown keysyms. */
5427 if (event
->code
& (1 << 28)
5428 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5429 || (event
->code
- FUNCTION_KEY_OFFSET
5430 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5431 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5433 /* We need to use an alist rather than a vector as the cache
5434 since we can't make a vector long enough. */
5435 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5436 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5437 return modify_event_symbol (event
->code
,
5440 KVAR (current_kboard
, Vsystem_key_alist
),
5441 0, &KVAR (current_kboard
, system_key_syms
),
5445 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5447 Qfunction_key
, Qnil
,
5448 lispy_function_keys
, &func_key_syms
,
5449 (sizeof (lispy_function_keys
)
5450 / sizeof (lispy_function_keys
[0])));
5453 case MULTIMEDIA_KEY_EVENT
:
5454 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5455 / sizeof (lispy_multimedia_keys
[0]))
5456 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5458 return modify_event_symbol (event
->code
, event
->modifiers
,
5459 Qfunction_key
, Qnil
,
5460 lispy_multimedia_keys
, &func_key_syms
,
5461 (sizeof (lispy_multimedia_keys
)
5462 / sizeof (lispy_multimedia_keys
[0])));
5468 /* A mouse click. Figure out where it is, decide whether it's
5469 a press, click or drag, and build the appropriate structure. */
5470 case MOUSE_CLICK_EVENT
:
5471 #ifndef USE_TOOLKIT_SCROLL_BARS
5472 case SCROLL_BAR_CLICK_EVENT
:
5475 int button
= event
->code
;
5477 Lisp_Object position
;
5478 Lisp_Object
*start_pos_ptr
;
5479 Lisp_Object start_pos
;
5483 /* Build the position as appropriate for this mouse click. */
5484 if (event
->kind
== MOUSE_CLICK_EVENT
)
5486 struct frame
*f
= XFRAME (event
->frame_or_window
);
5487 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5491 /* Ignore mouse events that were made on frame that
5492 have been deleted. */
5493 if (! FRAME_LIVE_P (f
))
5496 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5497 /* EVENT->x and EVENT->y are frame-relative pixel
5498 coordinates at this place. Under old redisplay, COLUMN
5499 and ROW are set to frame relative glyph coordinates
5500 which are then used to determine whether this click is
5501 in a menu (non-toolkit version). */
5502 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5503 &column
, &row
, NULL
, 1);
5505 /* In the non-toolkit version, clicks on the menu bar
5506 are ordinary button events in the event buffer.
5507 Distinguish them, and invoke the menu.
5509 (In the toolkit version, the toolkit handles the menu bar
5510 and Emacs doesn't know about it until after the user
5511 makes a selection.) */
5512 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5513 && (event
->modifiers
& down_modifier
))
5515 Lisp_Object items
, item
;
5517 /* Find the menu bar item under `column'. */
5519 items
= FRAME_MENU_BAR_ITEMS (f
);
5520 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5522 Lisp_Object pos
, string
;
5523 string
= AREF (items
, i
+ 1);
5524 pos
= AREF (items
, i
+ 3);
5527 if (column
>= XINT (pos
)
5528 && column
< XINT (pos
) + SCHARS (string
))
5530 item
= AREF (items
, i
);
5535 /* ELisp manual 2.4b says (x y) are window relative but
5536 code says they are frame-relative. */
5538 = Fcons (event
->frame_or_window
,
5540 Fcons (Fcons (event
->x
, event
->y
),
5541 Fcons (make_number (event
->timestamp
),
5544 return Fcons (item
, Fcons (position
, Qnil
));
5546 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5548 position
= make_lispy_position (f
, event
->x
, event
->y
,
5551 #ifndef USE_TOOLKIT_SCROLL_BARS
5554 /* It's a scrollbar click. */
5556 Lisp_Object portion_whole
;
5559 window
= event
->frame_or_window
;
5560 portion_whole
= Fcons (event
->x
, event
->y
);
5561 part
= *scroll_bar_parts
[(int) event
->part
];
5565 Fcons (Qvertical_scroll_bar
,
5566 Fcons (portion_whole
,
5567 Fcons (make_number (event
->timestamp
),
5568 Fcons (part
, Qnil
)))));
5570 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5572 if (button
>= ASIZE (button_down_location
))
5574 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5575 button_down_location
= larger_vector (button_down_location
,
5577 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5580 start_pos_ptr
= &AREF (button_down_location
, button
);
5581 start_pos
= *start_pos_ptr
;
5582 *start_pos_ptr
= Qnil
;
5585 /* On window-system frames, use the value of
5586 double-click-fuzz as is. On other frames, interpret it
5587 as a multiple of 1/8 characters. */
5591 if (WINDOWP (event
->frame_or_window
))
5592 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5593 else if (FRAMEP (event
->frame_or_window
))
5594 f
= XFRAME (event
->frame_or_window
);
5598 if (FRAME_WINDOW_P (f
))
5599 fuzz
= double_click_fuzz
;
5601 fuzz
= double_click_fuzz
/ 8;
5603 is_double
= (button
== last_mouse_button
5604 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5605 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5606 && button_down_time
!= 0
5607 && (EQ (Vdouble_click_time
, Qt
)
5608 || (NATNUMP (Vdouble_click_time
)
5609 && (event
->timestamp
- button_down_time
5610 < XFASTINT (Vdouble_click_time
)))));
5613 last_mouse_button
= button
;
5614 last_mouse_x
= XINT (event
->x
);
5615 last_mouse_y
= XINT (event
->y
);
5617 /* If this is a button press, squirrel away the location, so
5618 we can decide later whether it was a click or a drag. */
5619 if (event
->modifiers
& down_modifier
)
5623 double_click_count
++;
5624 event
->modifiers
|= ((double_click_count
> 2)
5629 double_click_count
= 1;
5630 button_down_time
= event
->timestamp
;
5631 *start_pos_ptr
= Fcopy_alist (position
);
5632 ignore_mouse_drag_p
= 0;
5635 /* Now we're releasing a button - check the co-ordinates to
5636 see if this was a click or a drag. */
5637 else if (event
->modifiers
& up_modifier
)
5639 /* If we did not see a down before this up, ignore the up.
5640 Probably this happened because the down event chose a
5641 menu item. It would be an annoyance to treat the
5642 release of the button that chose the menu item as a
5645 if (!CONSP (start_pos
))
5648 event
->modifiers
&= ~up_modifier
;
5651 Lisp_Object new_down
, down
;
5652 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5654 /* The third element of every position
5655 should be the (x,y) pair. */
5656 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5657 new_down
= Fcar (Fcdr (Fcdr (position
)));
5660 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5662 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5663 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5666 if (ignore_mouse_drag_p
)
5668 event
->modifiers
|= click_modifier
;
5669 ignore_mouse_drag_p
= 0;
5671 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5672 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5673 /* Maybe the mouse has moved a lot, caused scrolling, and
5674 eventually ended up at the same screen position (but
5675 not buffer position) in which case it is a drag, not
5677 /* FIXME: OTOH if the buffer position has changed
5678 because of a timer or process filter rather than
5679 because of mouse movement, it should be considered as
5680 a click. But mouse-drag-region completely ignores
5681 this case and it hasn't caused any real problem, so
5682 it's probably OK to ignore it as well. */
5683 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5684 /* Mouse hasn't moved (much). */
5685 event
->modifiers
|= click_modifier
;
5688 button_down_time
= 0;
5689 event
->modifiers
|= drag_modifier
;
5692 /* Don't check is_double; treat this as multiple
5693 if the down-event was multiple. */
5694 if (double_click_count
> 1)
5695 event
->modifiers
|= ((double_click_count
> 2)
5701 /* Every mouse event should either have the down_modifier or
5702 the up_modifier set. */
5706 /* Get the symbol we should use for the mouse click. */
5709 head
= modify_event_symbol (button
,
5711 Qmouse_click
, Vlispy_mouse_stem
,
5714 ASIZE (mouse_syms
));
5715 if (event
->modifiers
& drag_modifier
)
5720 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5723 Fcons (make_number (double_click_count
),
5733 case HORIZ_WHEEL_EVENT
:
5735 Lisp_Object position
;
5738 /* Build the position as appropriate for this mouse click. */
5739 struct frame
*f
= XFRAME (event
->frame_or_window
);
5741 /* Ignore wheel events that were made on frame that have been
5743 if (! FRAME_LIVE_P (f
))
5746 position
= make_lispy_position (f
, event
->x
, event
->y
,
5749 /* Set double or triple modifiers to indicate the wheel speed. */
5751 /* On window-system frames, use the value of
5752 double-click-fuzz as is. On other frames, interpret it
5753 as a multiple of 1/8 characters. */
5759 if (WINDOWP (event
->frame_or_window
))
5760 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5761 else if (FRAMEP (event
->frame_or_window
))
5762 fr
= XFRAME (event
->frame_or_window
);
5766 fuzz
= FRAME_WINDOW_P (fr
)
5767 ? double_click_fuzz
: double_click_fuzz
/ 8;
5769 if (event
->modifiers
& up_modifier
)
5771 /* Emit a wheel-up event. */
5772 event
->modifiers
&= ~up_modifier
;
5775 else if (event
->modifiers
& down_modifier
)
5777 /* Emit a wheel-down event. */
5778 event
->modifiers
&= ~down_modifier
;
5782 /* Every wheel event should either have the down_modifier or
5783 the up_modifier set. */
5786 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5789 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5790 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5791 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5792 && button_down_time
!= 0
5793 && (EQ (Vdouble_click_time
, Qt
)
5794 || (NATNUMP (Vdouble_click_time
)
5795 && (event
->timestamp
- button_down_time
5796 < XFASTINT (Vdouble_click_time
)))));
5799 double_click_count
++;
5800 event
->modifiers
|= ((double_click_count
> 2)
5806 double_click_count
= 1;
5807 event
->modifiers
|= click_modifier
;
5810 button_down_time
= event
->timestamp
;
5811 /* Use a negative value to distinguish wheel from mouse button. */
5812 last_mouse_button
= - (1 + symbol_num
);
5813 last_mouse_x
= XINT (event
->x
);
5814 last_mouse_y
= XINT (event
->y
);
5816 /* Get the symbol we should use for the wheel event. */
5817 head
= modify_event_symbol (symbol_num
,
5823 ASIZE (wheel_syms
));
5826 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5829 Fcons (make_number (double_click_count
),
5838 #ifdef USE_TOOLKIT_SCROLL_BARS
5840 /* We don't have down and up events if using toolkit scroll bars,
5841 so make this always a click event. Store in the `part' of
5842 the Lisp event a symbol which maps to the following actions:
5844 `above_handle' page up
5845 `below_handle' page down
5849 `bottom' bottom of buffer
5850 `handle' thumb has been dragged.
5851 `end-scroll' end of interaction with scroll bar
5853 The incoming input_event contains in its `part' member an
5854 index of type `enum scroll_bar_part' which we can use as an
5855 index in scroll_bar_parts to get the appropriate symbol. */
5857 case SCROLL_BAR_CLICK_EVENT
:
5859 Lisp_Object position
, head
, window
, portion_whole
, part
;
5861 window
= event
->frame_or_window
;
5862 portion_whole
= Fcons (event
->x
, event
->y
);
5863 part
= *scroll_bar_parts
[(int) event
->part
];
5867 Fcons (Qvertical_scroll_bar
,
5868 Fcons (portion_whole
,
5869 Fcons (make_number (event
->timestamp
),
5870 Fcons (part
, Qnil
)))));
5872 /* Always treat scroll bar events as clicks. */
5873 event
->modifiers
|= click_modifier
;
5874 event
->modifiers
&= ~up_modifier
;
5876 if (event
->code
>= ASIZE (mouse_syms
))
5877 mouse_syms
= larger_vector (mouse_syms
,
5878 event
->code
- ASIZE (mouse_syms
) + 1,
5881 /* Get the symbol we should use for the mouse click. */
5882 head
= modify_event_symbol (event
->code
,
5887 ASIZE (mouse_syms
));
5888 return Fcons (head
, Fcons (position
, Qnil
));
5891 #endif /* USE_TOOLKIT_SCROLL_BARS */
5893 case DRAG_N_DROP_EVENT
:
5896 Lisp_Object head
, position
;
5899 f
= XFRAME (event
->frame_or_window
);
5902 /* Ignore mouse events that were made on frames that
5903 have been deleted. */
5904 if (! FRAME_LIVE_P (f
))
5907 position
= make_lispy_position (f
, event
->x
, event
->y
,
5910 head
= modify_event_symbol (0, event
->modifiers
,
5912 lispy_drag_n_drop_names
,
5913 &drag_n_drop_syms
, 1);
5919 #endif /* HAVE_MOUSE */
5921 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5922 || defined (HAVE_NS) || defined (USE_GTK)
5923 case MENU_BAR_EVENT
:
5924 if (EQ (event
->arg
, event
->frame_or_window
))
5925 /* This is the prefix key. We translate this to
5926 `(menu_bar)' because the code in keyboard.c for menu
5927 events, which we use, relies on this. */
5928 return Fcons (Qmenu_bar
, Qnil
);
5932 case SELECT_WINDOW_EVENT
:
5933 /* Make an event (select-window (WINDOW)). */
5934 return Fcons (Qselect_window
,
5935 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5938 case TOOL_BAR_EVENT
:
5939 if (EQ (event
->arg
, event
->frame_or_window
))
5940 /* This is the prefix key. We translate this to
5941 `(tool_bar)' because the code in keyboard.c for tool bar
5942 events, which we use, relies on this. */
5943 return Fcons (Qtool_bar
, Qnil
);
5944 else if (SYMBOLP (event
->arg
))
5945 return apply_modifiers (event
->modifiers
, event
->arg
);
5948 case USER_SIGNAL_EVENT
:
5949 /* A user signal. */
5951 char *name
= find_user_signal_name (event
->code
);
5954 return intern (name
);
5957 case SAVE_SESSION_EVENT
:
5958 return Qsave_session
;
5963 return Fcons (Qdbus_event
, event
->arg
);
5965 #endif /* HAVE_DBUS */
5967 case CONFIG_CHANGED_EVENT
:
5968 return Fcons (Qconfig_changed_event
,
5970 Fcons (event
->frame_or_window
, Qnil
)));
5972 case GPM_CLICK_EVENT
:
5974 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5975 Lisp_Object head
, position
;
5976 Lisp_Object
*start_pos_ptr
;
5977 Lisp_Object start_pos
;
5978 int button
= event
->code
;
5980 if (button
>= ASIZE (button_down_location
))
5982 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5983 button_down_location
= larger_vector (button_down_location
,
5985 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5988 start_pos_ptr
= &AREF (button_down_location
, button
);
5989 start_pos
= *start_pos_ptr
;
5991 position
= make_lispy_position (f
, event
->x
, event
->y
,
5994 if (event
->modifiers
& down_modifier
)
5995 *start_pos_ptr
= Fcopy_alist (position
);
5996 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5998 if (!CONSP (start_pos
))
6000 event
->modifiers
&= ~up_modifier
;
6003 head
= modify_event_symbol (button
,
6005 Qmouse_click
, Vlispy_mouse_stem
,
6008 ASIZE (mouse_syms
));
6010 if (event
->modifiers
& drag_modifier
)
6015 else if (event
->modifiers
& double_modifier
)
6018 Fcons (make_number (2),
6020 else if (event
->modifiers
& triple_modifier
)
6023 Fcons (make_number (3),
6030 #endif /* HAVE_GPM */
6032 /* The 'kind' field of the event is something we don't recognize. */
6038 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6041 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6042 Lisp_Object x
, Lisp_Object y
, Time t
)
6044 /* Is it a scroll bar movement? */
6045 if (frame
&& ! NILP (bar_window
))
6047 Lisp_Object part_sym
;
6049 part_sym
= *scroll_bar_parts
[(int) part
];
6050 return Fcons (Qscroll_bar_movement
,
6051 Fcons (list5 (bar_window
,
6052 Qvertical_scroll_bar
,
6058 /* Or is it an ordinary mouse movement? */
6061 Lisp_Object position
;
6062 position
= make_lispy_position (frame
, x
, y
, t
);
6063 return list2 (Qmouse_movement
, position
);
6067 #endif /* HAVE_MOUSE || HAVE GPM */
6069 /* Construct a switch frame event. */
6071 make_lispy_switch_frame (Lisp_Object frame
)
6073 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6076 /* Manipulating modifiers. */
6078 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6080 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6081 SYMBOL's name of the end of the modifiers; the string from this
6082 position is the unmodified symbol name.
6084 This doesn't use any caches. */
6087 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6093 CHECK_SYMBOL (symbol
);
6096 name
= SYMBOL_NAME (symbol
);
6098 for (i
= 0; i
< SBYTES (name
) - 1; )
6100 ptrdiff_t this_mod_end
= 0;
6103 /* See if the name continues with a modifier word.
6104 Check that the word appears, but don't check what follows it.
6105 Set this_mod and this_mod_end to record what we find. */
6107 switch (SREF (name
, i
))
6109 #define SINGLE_LETTER_MOD(BIT) \
6110 (this_mod_end = i + 1, this_mod = BIT)
6113 SINGLE_LETTER_MOD (alt_modifier
);
6117 SINGLE_LETTER_MOD (ctrl_modifier
);
6121 SINGLE_LETTER_MOD (hyper_modifier
);
6125 SINGLE_LETTER_MOD (meta_modifier
);
6129 SINGLE_LETTER_MOD (shift_modifier
);
6133 SINGLE_LETTER_MOD (super_modifier
);
6136 #undef SINGLE_LETTER_MOD
6138 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6139 if (i + LEN + 1 <= SBYTES (name) \
6140 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6142 this_mod_end = i + LEN; \
6147 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6148 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6149 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6153 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6155 #undef MULTI_LETTER_MOD
6159 /* If we found no modifier, stop looking for them. */
6160 if (this_mod_end
== 0)
6163 /* Check there is a dash after the modifier, so that it
6164 really is a modifier. */
6165 if (this_mod_end
>= SBYTES (name
)
6166 || SREF (name
, this_mod_end
) != '-')
6169 /* This modifier is real; look for another. */
6170 modifiers
|= this_mod
;
6171 i
= this_mod_end
+ 1;
6174 /* Should we include the `click' modifier? */
6175 if (! (modifiers
& (down_modifier
| drag_modifier
6176 | double_modifier
| triple_modifier
))
6177 && i
+ 7 == SBYTES (name
)
6178 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6179 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6180 modifiers
|= click_modifier
;
6182 if (! (modifiers
& (double_modifier
| triple_modifier
))
6183 && i
+ 6 < SBYTES (name
)
6184 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6185 modifiers
|= click_modifier
;
6193 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6194 prepended to the string BASE[0..BASE_LEN-1].
6195 This doesn't use any caches. */
6197 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6199 /* Since BASE could contain nulls, we can't use intern here; we have
6200 to use Fintern, which expects a genuine Lisp_String, and keeps a
6203 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6209 /* Only the event queue may use the `up' modifier; it should always
6210 be turned into a click or drag event before presented to lisp code. */
6211 if (modifiers
& up_modifier
)
6214 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6215 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6216 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6217 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6218 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6219 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6220 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6221 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6222 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6223 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6224 /* The click modifier is denoted by the absence of other modifiers. */
6228 mod_len
= p
- new_mods
;
6232 Lisp_Object new_name
;
6234 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6235 mod_len
+ base_len_byte
);
6236 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6237 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6239 return Fintern (new_name
, Qnil
);
6244 static const char *const modifier_names
[] =
6246 "up", "down", "drag", "click", "double", "triple", 0, 0,
6247 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6248 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6250 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6252 static Lisp_Object modifier_symbols
;
6254 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6256 lispy_modifier_list (int modifiers
)
6258 Lisp_Object modifier_list
;
6261 modifier_list
= Qnil
;
6262 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6263 if (modifiers
& (1<<i
))
6264 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6267 return modifier_list
;
6271 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6272 where UNMODIFIED is the unmodified form of SYMBOL,
6273 MASK is the set of modifiers present in SYMBOL's name.
6274 This is similar to parse_modifiers_uncached, but uses the cache in
6275 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6276 Qevent_symbol_elements property. */
6278 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6281 parse_modifiers (Lisp_Object symbol
)
6283 Lisp_Object elements
;
6285 if (INTEGERP (symbol
))
6286 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6287 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6289 else if (!SYMBOLP (symbol
))
6292 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6293 if (CONSP (elements
))
6298 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6299 Lisp_Object unmodified
;
6302 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6303 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6306 if (modifiers
& ~INTMASK
)
6308 XSETFASTINT (mask
, modifiers
);
6309 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6311 /* Cache the parsing results on SYMBOL. */
6312 Fput (symbol
, Qevent_symbol_element_mask
,
6314 Fput (symbol
, Qevent_symbol_elements
,
6315 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6317 /* Since we know that SYMBOL is modifiers applied to unmodified,
6318 it would be nice to put that in unmodified's cache.
6319 But we can't, since we're not sure that parse_modifiers is
6326 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6327 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6328 doc
: /* Parse the event symbol. For internal use. */)
6329 (Lisp_Object symbol
)
6331 /* Fill the cache if needed. */
6332 parse_modifiers (symbol
);
6333 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6334 and use the Lispier representation stored on Qevent_symbol_elements
6336 return Fget (symbol
, Qevent_symbol_elements
);
6339 /* Apply the modifiers MODIFIERS to the symbol BASE.
6340 BASE must be unmodified.
6342 This is like apply_modifiers_uncached, but uses BASE's
6343 Qmodifier_cache property, if present. It also builds
6344 Qevent_symbol_elements properties, since it has that info anyway.
6346 apply_modifiers copies the value of BASE's Qevent_kind property to
6347 the modified symbol. */
6349 apply_modifiers (int modifiers
, Lisp_Object base
)
6351 Lisp_Object cache
, idx
, entry
, new_symbol
;
6353 /* Mask out upper bits. We don't know where this value's been. */
6354 modifiers
&= INTMASK
;
6356 if (INTEGERP (base
))
6357 return make_number (XINT (base
) | modifiers
);
6359 /* The click modifier never figures into cache indices. */
6360 cache
= Fget (base
, Qmodifier_cache
);
6361 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6362 entry
= assq_no_quit (idx
, cache
);
6365 new_symbol
= XCDR (entry
);
6368 /* We have to create the symbol ourselves. */
6369 new_symbol
= apply_modifiers_uncached (modifiers
,
6370 SSDATA (SYMBOL_NAME (base
)),
6371 SCHARS (SYMBOL_NAME (base
)),
6372 SBYTES (SYMBOL_NAME (base
)));
6374 /* Add the new symbol to the base's cache. */
6375 entry
= Fcons (idx
, new_symbol
);
6376 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6378 /* We have the parsing info now for free, so we could add it to
6380 XSETFASTINT (idx, modifiers);
6381 Fput (new_symbol, Qevent_symbol_element_mask,
6382 Fcons (base, Fcons (idx, Qnil)));
6383 Fput (new_symbol, Qevent_symbol_elements,
6384 Fcons (base, lispy_modifier_list (modifiers)));
6385 Sadly, this is only correct if `base' is indeed a base event,
6386 which is not necessarily the case. -stef */
6389 /* Make sure this symbol is of the same kind as BASE.
6391 You'd think we could just set this once and for all when we
6392 intern the symbol above, but reorder_modifiers may call us when
6393 BASE's property isn't set right; we can't assume that just
6394 because it has a Qmodifier_cache property it must have its
6395 Qevent_kind set right as well. */
6396 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6400 kind
= Fget (base
, Qevent_kind
);
6402 Fput (new_symbol
, Qevent_kind
, kind
);
6409 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6410 return a symbol with the modifiers placed in the canonical order.
6411 Canonical order is alphabetical, except for down and drag, which
6412 always come last. The 'click' modifier is never written out.
6414 Fdefine_key calls this to make sure that (for example) C-M-foo
6415 and M-C-foo end up being equivalent in the keymap. */
6418 reorder_modifiers (Lisp_Object symbol
)
6420 /* It's hopefully okay to write the code this way, since everything
6421 will soon be in caches, and no consing will be done at all. */
6424 parsed
= parse_modifiers (symbol
);
6425 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6430 /* For handling events, we often want to produce a symbol whose name
6431 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6432 to some base, like the name of a function key or mouse button.
6433 modify_event_symbol produces symbols of this sort.
6435 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6436 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6439 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6440 into symbol names, or a string specifying a name stem used to
6441 construct a symbol name or the form `STEM-N', where N is the decimal
6442 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6443 non-nil; otherwise NAME_TABLE is used.
6445 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6446 persist between calls to modify_event_symbol that it can use to
6447 store a cache of the symbols it's generated for this NAME_TABLE
6448 before. The object stored there may be a vector or an alist.
6450 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6452 MODIFIERS is a set of modifier bits (as given in struct input_events)
6453 whose prefixes should be applied to the symbol name.
6455 SYMBOL_KIND is the value to be placed in the event_kind property of
6456 the returned symbol.
6458 The symbols we create are supposed to have an
6459 `event-symbol-elements' property, which lists the modifiers present
6460 in the symbol's name. */
6463 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6464 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6465 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6468 Lisp_Object symbol_int
;
6470 /* Get rid of the "vendor-specific" bit here. */
6471 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6473 /* Is this a request for a valid symbol? */
6474 if (symbol_num
< 0 || symbol_num
>= table_size
)
6477 if (CONSP (*symbol_table
))
6478 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6480 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6481 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6482 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6483 we've never used that symbol before. */
6486 if (! VECTORP (*symbol_table
)
6487 || ASIZE (*symbol_table
) != table_size
)
6491 XSETFASTINT (size
, table_size
);
6492 *symbol_table
= Fmake_vector (size
, Qnil
);
6495 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6498 /* Have we already used this symbol before? */
6501 /* No; let's create it. */
6502 if (CONSP (name_alist_or_stem
))
6503 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6504 else if (STRINGP (name_alist_or_stem
))
6507 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6508 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6510 SAFE_ALLOCA (buf
, char *, len
);
6511 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6512 XINT (symbol_int
) + 1);
6513 value
= intern (buf
);
6516 else if (name_table
!= 0 && name_table
[symbol_num
])
6517 value
= intern (name_table
[symbol_num
]);
6519 #ifdef HAVE_WINDOW_SYSTEM
6522 char *name
= x_get_keysym_name (symbol_num
);
6524 value
= intern (name
);
6530 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6531 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6532 value
= intern (buf
);
6535 if (CONSP (*symbol_table
))
6536 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6538 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6540 /* Fill in the cache entries for this symbol; this also
6541 builds the Qevent_symbol_elements property, which the user
6543 apply_modifiers (modifiers
& click_modifier
, value
);
6544 Fput (value
, Qevent_kind
, symbol_kind
);
6547 /* Apply modifiers to that symbol. */
6548 return apply_modifiers (modifiers
, value
);
6551 /* Convert a list that represents an event type,
6552 such as (ctrl meta backspace), into the usual representation of that
6553 event type as a number or a symbol. */
6555 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6556 doc
: /* Convert the event description list EVENT-DESC to an event type.
6557 EVENT-DESC should contain one base event type (a character or symbol)
6558 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6559 drag, down, double or triple). The base must be last.
6560 The return value is an event type (a character or symbol) which
6561 has the same base event type and all the specified modifiers. */)
6562 (Lisp_Object event_desc
)
6570 while (CONSP (rest
))
6578 /* Given a symbol, see if it is a modifier name. */
6579 if (SYMBOLP (elt
) && CONSP (rest
))
6580 this = parse_solitary_modifier (elt
);
6584 else if (!NILP (base
))
6585 error ("Two bases given in one event");
6591 /* Let the symbol A refer to the character A. */
6592 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6593 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6595 if (INTEGERP (base
))
6597 /* Turn (shift a) into A. */
6598 if ((modifiers
& shift_modifier
) != 0
6599 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6601 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6602 modifiers
&= ~shift_modifier
;
6605 /* Turn (control a) into C-a. */
6606 if (modifiers
& ctrl_modifier
)
6607 return make_number ((modifiers
& ~ctrl_modifier
)
6608 | make_ctrl_char (XINT (base
)));
6610 return make_number (modifiers
| XINT (base
));
6612 else if (SYMBOLP (base
))
6613 return apply_modifiers (modifiers
, base
);
6616 error ("Invalid base event");
6621 /* Try to recognize SYMBOL as a modifier name.
6622 Return the modifier flag bit, or 0 if not recognized. */
6625 parse_solitary_modifier (Lisp_Object symbol
)
6627 Lisp_Object name
= SYMBOL_NAME (symbol
);
6629 switch (SREF (name
, 0))
6631 #define SINGLE_LETTER_MOD(BIT) \
6632 if (SBYTES (name) == 1) \
6635 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6636 if (LEN == SBYTES (name) \
6637 && ! strncmp (SSDATA (name), NAME, LEN)) \
6641 SINGLE_LETTER_MOD (alt_modifier
);
6645 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6649 SINGLE_LETTER_MOD (ctrl_modifier
);
6653 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6654 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6658 SINGLE_LETTER_MOD (hyper_modifier
);
6662 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6666 SINGLE_LETTER_MOD (meta_modifier
);
6670 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6674 SINGLE_LETTER_MOD (shift_modifier
);
6678 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6679 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6680 SINGLE_LETTER_MOD (super_modifier
);
6684 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6685 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6686 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6690 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6693 #undef SINGLE_LETTER_MOD
6694 #undef MULTI_LETTER_MOD
6700 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6701 Such a list is not valid as an event,
6702 but it can be a Lucid-style event type list. */
6705 lucid_event_type_list_p (Lisp_Object object
)
6709 if (! CONSP (object
))
6712 if (EQ (XCAR (object
), Qhelp_echo
)
6713 || EQ (XCAR (object
), Qvertical_line
)
6714 || EQ (XCAR (object
), Qmode_line
)
6715 || EQ (XCAR (object
), Qheader_line
))
6718 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6722 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6729 /* Store into *addr a value nonzero if terminal input chars are available.
6730 Serves the purpose of ioctl (0, FIONREAD, addr)
6731 but works even if FIONREAD does not exist.
6732 (In fact, this may actually read some input.)
6734 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6735 timer events that are ripe.
6736 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6737 events (FOCUS_IN_EVENT).
6738 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6739 movements and toolkit scroll bar thumb drags. */
6742 get_input_pending (int *addr
, int flags
)
6744 /* First of all, have we already counted some input? */
6745 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6747 /* If input is being read as it arrives, and we have none, there is none. */
6748 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6751 /* Try to read some input and see how much we get. */
6753 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6756 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6759 gobble_input (int expected
)
6762 if (interrupt_input
)
6765 mask
= sigblock (sigmask (SIGIO
));
6766 read_avail_input (expected
);
6770 #ifdef POLL_FOR_INPUT
6771 /* XXX This condition was (read_socket_hook && !interrupt_input),
6772 but read_socket_hook is not global anymore. Let's pretend that
6774 if (!interrupt_input
&& poll_suppress_count
== 0)
6777 mask
= sigblock (sigmask (SIGALRM
));
6778 read_avail_input (expected
);
6784 read_avail_input (expected
);
6787 /* Put a BUFFER_SWITCH_EVENT in the buffer
6788 so that read_key_sequence will notice the new current buffer. */
6791 record_asynch_buffer_change (void)
6793 struct input_event event
;
6797 event
.kind
= BUFFER_SWITCH_EVENT
;
6798 event
.frame_or_window
= Qnil
;
6801 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6802 The purpose of the event is to make read_key_sequence look up the
6803 keymaps again. If we aren't in read_key_sequence, we don't need one,
6804 and the event could cause trouble by messing up (input-pending-p).
6805 Note: Fwaiting_for_user_input_p always returns nil when async
6806 subprocesses aren't supported. */
6807 tem
= Fwaiting_for_user_input_p ();
6811 /* Make sure no interrupt happens while storing the event. */
6813 if (interrupt_input
)
6816 mask
= sigblock (sigmask (SIGIO
));
6817 kbd_buffer_store_event (&event
);
6824 kbd_buffer_store_event (&event
);
6829 /* Read any terminal input already buffered up by the system
6830 into the kbd_buffer, but do not wait.
6832 EXPECTED should be nonzero if the caller knows there is some input.
6834 Returns the number of keyboard chars read, or -1 meaning
6835 this is a bad time to try to read input. */
6838 read_avail_input (int expected
)
6844 /* Store pending user signal events, if any. */
6845 if (store_user_signal_events ())
6848 /* Loop through the available terminals, and call their input hooks. */
6852 struct terminal
*next
= t
->next_terminal
;
6854 if (t
->read_socket_hook
)
6857 struct input_event hold_quit
;
6859 EVENT_INIT (hold_quit
);
6860 hold_quit
.kind
= NO_EVENT
;
6862 /* No need for FIONREAD or fcntl; just say don't wait. */
6863 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6869 if (nr
== -1) /* Not OK to read input now. */
6873 else if (nr
== -2) /* Non-transient error. */
6875 /* The terminal device terminated; it should be closed. */
6877 /* Kill Emacs if this was our last terminal. */
6878 if (!terminal_list
->next_terminal
)
6879 /* Formerly simply reported no input, but that
6880 sometimes led to a failure of Emacs to terminate.
6881 SIGHUP seems appropriate if we can't reach the
6883 /* ??? Is it really right to send the signal just to
6884 this process rather than to the whole process
6885 group? Perhaps on systems with FIONREAD Emacs is
6886 alone in its group. */
6887 kill (getpid (), SIGHUP
);
6889 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6892 XSETTERMINAL (tmp
, t
);
6893 Fdelete_terminal (tmp
, Qnoelisp
);
6897 if (hold_quit
.kind
!= NO_EVENT
)
6898 kbd_buffer_store_event (&hold_quit
);
6907 frame_make_pointer_visible ();
6913 decode_keyboard_code (struct tty_display_info
*tty
,
6914 struct coding_system
*coding
,
6915 unsigned char *buf
, int nbytes
)
6917 unsigned char *src
= buf
;
6918 const unsigned char *p
;
6923 if (tty
->meta_key
!= 2)
6924 for (i
= 0; i
< nbytes
; i
++)
6926 if (coding
->carryover_bytes
> 0)
6928 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6929 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6930 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6931 nbytes
+= coding
->carryover_bytes
;
6933 coding
->destination
= alloca (nbytes
* 4);
6934 coding
->dst_bytes
= nbytes
* 4;
6935 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6936 if (coding
->produced_char
== 0)
6938 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6940 struct input_event event_buf
;
6942 EVENT_INIT (event_buf
);
6943 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6945 (ASCII_CHAR_P (event_buf
.code
)
6946 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6947 /* See the comment in tty_read_avail_input. */
6948 event_buf
.frame_or_window
= tty
->top_frame
;
6949 event_buf
.arg
= Qnil
;
6950 kbd_buffer_store_event (&event_buf
);
6954 /* This is the tty way of reading available input.
6956 Note that each terminal device has its own `struct terminal' object,
6957 and so this function is called once for each individual termcap
6958 terminal. The first parameter indicates which terminal to read from. */
6961 tty_read_avail_input (struct terminal
*terminal
,
6963 struct input_event
*hold_quit
)
6965 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6966 the kbd_buffer can really hold. That may prevent loss
6967 of characters on some systems when input is stuffed at us. */
6968 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6970 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6973 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6975 if (kbd_on_hold_p () || buffer_free
<= 0)
6977 #endif /* subprocesses */
6979 if (!terminal
->name
) /* Don't read from a dead terminal. */
6982 if (terminal
->type
!= output_termcap
6983 && terminal
->type
!= output_msdos_raw
)
6986 /* XXX I think the following code should be moved to separate hook
6987 functions in system-dependent files. */
6990 #else /* not WINDOWSNT */
6991 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6995 return 0; /* The terminal is suspended. */
6998 n_to_read
= dos_keysns ();
7002 cbuf
[0] = dos_keyread ();
7005 #else /* not MSDOS */
7010 struct input_event gpm_hold_quit
;
7011 int gpm
, fd
= gpm_fd
;
7013 EVENT_INIT (gpm_hold_quit
);
7014 gpm_hold_quit
.kind
= NO_EVENT
;
7016 /* gpm==1 if event received.
7017 gpm==0 if the GPM daemon has closed the connection, in which case
7018 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7019 we save it in `fd' so close_gpm can remove it from the
7021 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7022 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7023 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7026 /* Presumably the GPM daemon has closed the connection. */
7028 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7029 kbd_buffer_store_event (&gpm_hold_quit
);
7033 #endif /* HAVE_GPM */
7035 /* Determine how many characters we should *try* to read. */
7037 /* Find out how much input is available. */
7038 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7040 if (! noninteractive
)
7041 return -2; /* Close this terminal. */
7047 if (n_to_read
> sizeof cbuf
)
7048 n_to_read
= sizeof cbuf
;
7049 #else /* no FIONREAD */
7050 #if defined (USG) || defined (CYGWIN)
7051 /* Read some input if available, but don't wait. */
7052 n_to_read
= sizeof cbuf
;
7053 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7060 /* Don't read more than we can store. */
7061 if (n_to_read
> buffer_free
)
7062 n_to_read
= buffer_free
;
7063 #endif /* subprocesses */
7065 /* Now read; for one reason or another, this will not block.
7066 NREAD is set to the number of chars read. */
7069 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7070 /* POSIX infers that processes which are not in the session leader's
7071 process group won't get SIGHUP's at logout time. BSDI adheres to
7072 this part standard and returns -1 from read (0) with errno==EIO
7073 when the control tty is taken away.
7074 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7075 if (nread
== -1 && errno
== EIO
)
7076 return -2; /* Close this terminal. */
7077 #if defined (AIX) && defined (_BSD)
7078 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7079 This looks incorrect, but it isn't, because _BSD causes
7080 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7081 and that causes a value other than 0 when there is no input. */
7083 return -2; /* Close this terminal. */
7087 /* We used to retry the read if it was interrupted.
7088 But this does the wrong thing when O_NDELAY causes
7089 an EAGAIN error. Does anybody know of a situation
7090 where a retry is actually needed? */
7092 nread
< 0 && (errno
== EAGAIN
7106 #if defined (USG) || defined (CYGWIN)
7107 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7108 #endif /* USG or CYGWIN */
7109 #endif /* no FIONREAD */
7114 #endif /* not MSDOS */
7115 #endif /* not WINDOWSNT */
7117 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7118 & CODING_REQUIRE_DECODING_MASK
)
7120 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7123 /* Decode the key sequence except for those with meta
7125 for (i
= from
= 0; ; i
++)
7126 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7128 struct input_event buf
;
7130 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7135 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7136 buf
.modifiers
= meta_modifier
;
7137 buf
.code
= cbuf
[i
] & ~0x80;
7138 /* See the comment below. */
7139 buf
.frame_or_window
= tty
->top_frame
;
7141 kbd_buffer_store_event (&buf
);
7147 for (i
= 0; i
< nread
; i
++)
7149 struct input_event buf
;
7151 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7153 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7154 buf
.modifiers
= meta_modifier
;
7155 if (tty
->meta_key
!= 2)
7159 /* Set the frame corresponding to the active tty. Note that the
7160 value of selected_frame is not reliable here, redisplay tends
7161 to temporarily change it. */
7162 buf
.frame_or_window
= tty
->top_frame
;
7165 kbd_buffer_store_event (&buf
);
7166 /* Don't look at input that follows a C-g too closely.
7167 This reduces lossage due to autorepeat on C-g. */
7168 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7169 && buf
.code
== quit_char
)
7177 handle_async_input (void)
7179 interrupt_input_pending
= 0;
7181 pending_signals
= pending_atimers
;
7183 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7184 doing anything dangerous. */
7191 nread
= read_avail_input (1);
7192 /* -1 means it's not ok to read the input now.
7193 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7194 0 means there was no keyboard input available. */
7205 process_pending_signals (void)
7207 if (interrupt_input_pending
)
7208 handle_async_input ();
7209 do_pending_atimers ();
7213 #ifdef SIGIO /* for entire page */
7214 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7217 input_available_signal (int signo
)
7219 /* Must preserve main program's value of errno. */
7220 int old_errno
= errno
;
7221 SIGNAL_THREAD_CHECK (signo
);
7224 interrupt_input_pending
= 1;
7225 pending_signals
= 1;
7228 if (input_available_clear_time
)
7229 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7232 handle_async_input ();
7239 /* Send ourselves a SIGIO.
7241 This function exists so that the UNBLOCK_INPUT macro in
7242 blockinput.h can have some way to take care of input we put off
7243 dealing with, without assuming that every file which uses
7244 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7246 reinvoke_input_signal (void)
7249 handle_async_input ();
7255 /* User signal events. */
7257 struct user_signal_info
7259 /* Signal number. */
7262 /* Name of the signal. */
7265 /* Number of pending signals. */
7268 struct user_signal_info
*next
;
7271 /* List of user signals. */
7272 static struct user_signal_info
*user_signals
= NULL
;
7275 add_user_signal (int sig
, const char *name
)
7277 struct user_signal_info
*p
;
7279 for (p
= user_signals
; p
; p
= p
->next
)
7281 /* Already added. */
7284 p
= xmalloc (sizeof (struct user_signal_info
));
7286 p
->name
= xstrdup (name
);
7288 p
->next
= user_signals
;
7291 signal (sig
, handle_user_signal
);
7295 handle_user_signal (int sig
)
7297 int old_errno
= errno
;
7298 struct user_signal_info
*p
;
7299 const char *special_event_name
= NULL
;
7301 SIGNAL_THREAD_CHECK (sig
);
7303 if (SYMBOLP (Vdebug_on_event
))
7304 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7306 for (p
= user_signals
; p
; p
= p
->next
)
7309 if (special_event_name
&&
7310 strcmp (special_event_name
, p
->name
) == 0)
7312 /* Enter the debugger in many ways. */
7313 debug_on_next_call
= 1;
7316 Vinhibit_quit
= Qnil
;
7318 /* Eat the event. */
7324 if (interrupt_input
)
7325 kill (getpid (), SIGIO
);
7329 /* Tell wait_reading_process_output that it needs to wake
7330 up and look around. */
7331 if (input_available_clear_time
)
7332 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7341 find_user_signal_name (int sig
)
7343 struct user_signal_info
*p
;
7345 for (p
= user_signals
; p
; p
= p
->next
)
7353 store_user_signal_events (void)
7355 struct user_signal_info
*p
;
7356 struct input_event buf
;
7359 for (p
= user_signals
; p
; p
= p
->next
)
7360 if (p
->npending
> 0)
7366 memset (&buf
, 0, sizeof buf
);
7367 buf
.kind
= USER_SIGNAL_EVENT
;
7368 buf
.frame_or_window
= selected_frame
;
7370 nstored
+= p
->npending
;
7372 mask
= sigblock (sigmask (p
->sig
));
7376 kbd_buffer_store_event (&buf
);
7379 while (p
->npending
> 0);
7387 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7388 static Lisp_Object menu_bar_one_keymap_changed_items
;
7390 /* These variables hold the vector under construction within
7391 menu_bar_items and its subroutines, and the current index
7392 for storing into that vector. */
7393 static Lisp_Object menu_bar_items_vector
;
7394 static int menu_bar_items_index
;
7397 static const char* separator_names
[] = {
7402 "single-dashed-line",
7403 "double-dashed-line",
7405 "shadow-etched-out",
7406 "shadow-etched-in-dash",
7407 "shadow-etched-out-dash",
7408 "shadow-double-etched-in",
7409 "shadow-double-etched-out",
7410 "shadow-double-etched-in-dash",
7411 "shadow-double-etched-out-dash",
7415 /* Return non-zero if LABEL specifies a separator. */
7418 menu_separator_name_p (const char *label
)
7422 else if (strlen (label
) > 3
7423 && strncmp (label
, "--", 2) == 0
7428 for (i
= 0; separator_names
[i
]; ++i
)
7429 if (strcmp (label
, separator_names
[i
]) == 0)
7434 /* It's a separator if it contains only dashes. */
7435 while (*label
== '-')
7437 return (*label
== 0);
7444 /* Return a vector of menu items for a menu bar, appropriate
7445 to the current buffer. Each item has three elements in the vector:
7448 OLD is an old vector we can optionally reuse, or nil. */
7451 menu_bar_items (Lisp_Object old
)
7453 /* The number of keymaps we're scanning right now, and the number of
7454 keymaps we have allocated space for. */
7457 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7458 in the current keymaps, or nil where it is not a prefix. */
7461 Lisp_Object def
, tail
;
7466 /* In order to build the menus, we need to call the keymap
7467 accessors. They all call QUIT. But this function is called
7468 during redisplay, during which a quit is fatal. So inhibit
7469 quitting while building the menus.
7470 We do this instead of specbind because (1) errors will clear it anyway
7471 and (2) this avoids risk of specpdl overflow. */
7472 oquit
= Vinhibit_quit
;
7476 menu_bar_items_vector
= old
;
7478 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7479 menu_bar_items_index
= 0;
7481 /* Build our list of keymaps.
7482 If we recognize a function key and replace its escape sequence in
7483 keybuf with its symbol, or if the sequence starts with a mouse
7484 click and we need to switch buffers, we jump back here to rebuild
7485 the initial keymaps from the current buffer. */
7489 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7490 if (!NILP (Voverriding_local_map_menu_flag
))
7492 /* Yes, use them (if non-nil) as well as the global map. */
7493 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7495 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7496 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7497 if (!NILP (Voverriding_local_map
))
7498 maps
[nmaps
++] = Voverriding_local_map
;
7502 /* No, so use major and minor mode keymaps and keymap property.
7503 Note that menu-bar bindings in the local-map and keymap
7504 properties may not work reliable, as they are only
7505 recognized when the menu-bar (or mode-line) is updated,
7506 which does not normally happen after every command. */
7509 nminor
= current_minor_maps (NULL
, &tmaps
);
7510 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7512 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7513 maps
[nmaps
++] = tem
;
7514 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7516 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7518 maps
[nmaps
++] = current_global_map
;
7521 /* Look up in each map the dummy prefix key `menu-bar'. */
7523 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7524 if (!NILP (maps
[mapno
]))
7526 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7530 menu_bar_one_keymap_changed_items
= Qnil
;
7531 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7535 /* Move to the end those items that should be at the end. */
7537 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7540 int end
= menu_bar_items_index
;
7542 for (i
= 0; i
< end
; i
+= 4)
7543 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7545 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7546 /* Move the item at index I to the end,
7547 shifting all the others forward. */
7548 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7549 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7550 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7551 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7553 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7554 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7555 (end
- i
- 4) * sizeof (Lisp_Object
));
7556 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7557 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7558 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7559 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7564 /* Add nil, nil, nil, nil at the end. */
7566 int i
= menu_bar_items_index
;
7567 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7568 menu_bar_items_vector
=
7569 larger_vector (menu_bar_items_vector
, 4, -1);
7570 /* Add this item. */
7571 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7572 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7573 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7574 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7575 menu_bar_items_index
= i
;
7578 Vinhibit_quit
= oquit
;
7579 return menu_bar_items_vector
;
7582 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7583 If there's already an item for KEY, add this DEF to it. */
7585 Lisp_Object item_properties
;
7588 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7590 struct gcpro gcpro1
;
7594 if (EQ (item
, Qundefined
))
7596 /* If a map has an explicit `undefined' as definition,
7597 discard any previously made menu bar item. */
7599 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7600 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7602 if (menu_bar_items_index
> i
+ 4)
7603 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7604 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7605 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7606 menu_bar_items_index
-= 4;
7610 /* If this keymap has already contributed to this KEY,
7611 don't contribute to it a second time. */
7612 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7613 if (!NILP (tem
) || NILP (item
))
7616 menu_bar_one_keymap_changed_items
7617 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7619 /* We add to menu_bar_one_keymap_changed_items before doing the
7620 parse_menu_item, so that if it turns out it wasn't a menu item,
7621 it still correctly hides any further menu item. */
7623 i
= parse_menu_item (item
, 1);
7628 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7630 /* Find any existing item for this KEY. */
7631 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7632 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7635 /* If we did not find this KEY, add it at the end. */
7636 if (i
== menu_bar_items_index
)
7638 /* If vector is too small, get a bigger one. */
7639 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7640 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7641 /* Add this item. */
7642 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7643 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7644 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7645 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7646 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7647 menu_bar_items_index
= i
;
7649 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7653 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7654 /* If the new and the old items are not both keymaps,
7655 the lookup will only find `item'. */
7656 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7657 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7661 /* This is used as the handler when calling menu_item_eval_property. */
7663 menu_item_eval_property_1 (Lisp_Object arg
)
7665 /* If we got a quit from within the menu computation,
7666 quit all the way out of it. This takes care of C-] in the debugger. */
7667 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7668 Fsignal (Qquit
, Qnil
);
7674 eval_dyn (Lisp_Object form
)
7676 return Feval (form
, Qnil
);
7679 /* Evaluate an expression and return the result (or nil if something
7680 went wrong). Used to evaluate dynamic parts of menu items. */
7682 menu_item_eval_property (Lisp_Object sexpr
)
7684 ptrdiff_t count
= SPECPDL_INDEX ();
7686 specbind (Qinhibit_redisplay
, Qt
);
7687 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7688 menu_item_eval_property_1
);
7689 return unbind_to (count
, val
);
7692 /* This function parses a menu item and leaves the result in the
7693 vector item_properties.
7694 ITEM is a key binding, a possible menu item.
7695 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7697 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7698 parse_menu_item returns true if the item is a menu item and false
7702 parse_menu_item (Lisp_Object item
, int inmenubar
)
7704 Lisp_Object def
, tem
, item_string
, start
;
7706 Lisp_Object keyhint
;
7715 /* Create item_properties vector if necessary. */
7716 if (NILP (item_properties
))
7718 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7720 /* Initialize optional entries. */
7721 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7722 ASET (item_properties
, i
, Qnil
);
7723 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7725 /* Save the item here to protect it from GC. */
7726 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7728 item_string
= XCAR (item
);
7732 if (STRINGP (item_string
))
7734 /* Old format menu item. */
7735 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7737 /* Maybe help string. */
7738 if (CONSP (item
) && STRINGP (XCAR (item
)))
7740 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7745 /* Maybe an obsolete key binding cache. */
7746 if (CONSP (item
) && CONSP (XCAR (item
))
7747 && (NILP (XCAR (XCAR (item
)))
7748 || VECTORP (XCAR (XCAR (item
)))))
7751 /* This is the real definition--the function to run. */
7752 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7754 /* Get enable property, if any. */
7757 tem
= Fget (item
, Qmenu_enable
);
7758 if (!NILP (Venable_disabled_menus_and_buttons
))
7759 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7760 else if (!NILP (tem
))
7761 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7764 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7766 /* New format menu item. */
7767 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7768 start
= XCDR (item
);
7771 /* We have a real binding. */
7772 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7774 item
= XCDR (start
);
7775 /* Is there an obsolete cache list with key equivalences. */
7776 if (CONSP (item
) && CONSP (XCAR (item
)))
7779 /* Parse properties. */
7780 while (CONSP (item
) && CONSP (XCDR (item
)))
7785 if (EQ (tem
, QCenable
))
7787 if (!NILP (Venable_disabled_menus_and_buttons
))
7788 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7790 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7792 else if (EQ (tem
, QCvisible
))
7794 /* If got a visible property and that evaluates to nil
7795 then ignore this item. */
7796 tem
= menu_item_eval_property (XCAR (item
));
7800 else if (EQ (tem
, QChelp
))
7801 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7802 else if (EQ (tem
, QCfilter
))
7804 else if (EQ (tem
, QCkey_sequence
))
7807 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7808 /* Be GC protected. Set keyhint to item instead of tem. */
7811 else if (EQ (tem
, QCkeys
))
7814 if (CONSP (tem
) || STRINGP (tem
))
7815 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7817 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7822 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7824 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7826 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7832 else if (inmenubar
|| !NILP (start
))
7836 return 0; /* not a menu item */
7838 /* If item string is not a string, evaluate it to get string.
7839 If we don't get a string, skip this item. */
7840 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7841 if (!(STRINGP (item_string
)))
7843 item_string
= menu_item_eval_property (item_string
);
7844 if (!STRINGP (item_string
))
7846 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7849 /* If got a filter apply it on definition. */
7850 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7853 def
= menu_item_eval_property (list2 (XCAR (filter
),
7854 list2 (Qquote
, def
)));
7856 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7859 /* Enable or disable selection of item. */
7860 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7863 tem
= menu_item_eval_property (tem
);
7864 if (inmenubar
&& NILP (tem
))
7865 return 0; /* Ignore disabled items in menu bar. */
7866 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7869 /* If we got no definition, this item is just unselectable text which
7870 is OK in a submenu but not in the menubar. */
7872 return (!inmenubar
);
7874 /* See if this is a separate pane or a submenu. */
7875 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7876 tem
= get_keymap (def
, 0, 1);
7877 /* For a subkeymap, just record its details and exit. */
7880 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7881 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7885 /* At the top level in the menu bar, do likewise for commands also.
7886 The menu bar does not display equivalent key bindings anyway.
7887 ITEM_PROPERTY_DEF is already set up properly. */
7891 { /* This is a command. See if there is an equivalent key binding. */
7892 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7894 /* The previous code preferred :key-sequence to :keys, so we
7895 preserve this behavior. */
7896 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7897 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7900 Lisp_Object prefix
= keyeq
;
7901 Lisp_Object keys
= Qnil
;
7905 def
= XCAR (prefix
);
7906 prefix
= XCDR (prefix
);
7909 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7911 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7913 keys
= XCAR (keyhint
);
7914 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7916 /* We have a suggested key. Is it bound to the command? */
7919 /* If the command is an alias for another
7920 (such as lmenu.el set it up), check if the
7921 original command matches the cached command. */
7922 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7927 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7931 tem
= Fkey_description (keys
, Qnil
);
7934 if (STRINGP (XCAR (prefix
)))
7935 tem
= concat2 (XCAR (prefix
), tem
);
7936 if (STRINGP (XCDR (prefix
)))
7937 tem
= concat2 (tem
, XCDR (prefix
));
7939 keyeq
= concat2 (build_string (" "), tem
);
7940 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7946 /* If we have an equivalent key binding, use that. */
7947 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7950 /* Include this when menu help is implemented.
7951 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7952 if (!(NILP (tem) || STRINGP (tem)))
7954 tem = menu_item_eval_property (tem);
7957 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7961 /* Handle radio buttons or toggle boxes. */
7962 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7964 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7965 menu_item_eval_property (tem
));
7972 /***********************************************************************
7974 ***********************************************************************/
7976 /* A vector holding tool bar items while they are parsed in function
7977 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7980 static Lisp_Object tool_bar_items_vector
;
7982 /* A vector holding the result of parse_tool_bar_item. Layout is like
7983 the one for a single item in tool_bar_items_vector. */
7985 static Lisp_Object tool_bar_item_properties
;
7987 /* Next free index in tool_bar_items_vector. */
7989 static int ntool_bar_items
;
7991 /* The symbols `:image' and `:rtl'. */
7993 static Lisp_Object QCimage
;
7994 static Lisp_Object QCrtl
;
7996 /* Function prototypes. */
7998 static void init_tool_bar_items (Lisp_Object
);
7999 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8000 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8001 static void append_tool_bar_item (void);
8004 /* Return a vector of tool bar items for keymaps currently in effect.
8005 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8006 tool bar items found. */
8009 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8018 /* In order to build the menus, we need to call the keymap
8019 accessors. They all call QUIT. But this function is called
8020 during redisplay, during which a quit is fatal. So inhibit
8021 quitting while building the menus. We do this instead of
8022 specbind because (1) errors will clear it anyway and (2) this
8023 avoids risk of specpdl overflow. */
8024 oquit
= Vinhibit_quit
;
8027 /* Initialize tool_bar_items_vector and protect it from GC. */
8028 init_tool_bar_items (reuse
);
8030 /* Build list of keymaps in maps. Set nmaps to the number of maps
8033 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8034 if (!NILP (Voverriding_local_map_menu_flag
))
8036 /* Yes, use them (if non-nil) as well as the global map. */
8037 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8039 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8040 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8041 if (!NILP (Voverriding_local_map
))
8042 maps
[nmaps
++] = Voverriding_local_map
;
8046 /* No, so use major and minor mode keymaps and keymap property.
8047 Note that tool-bar bindings in the local-map and keymap
8048 properties may not work reliable, as they are only
8049 recognized when the tool-bar (or mode-line) is updated,
8050 which does not normally happen after every command. */
8053 nminor
= current_minor_maps (NULL
, &tmaps
);
8054 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8056 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8057 maps
[nmaps
++] = tem
;
8058 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8060 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8063 /* Add global keymap at the end. */
8064 maps
[nmaps
++] = current_global_map
;
8066 /* Process maps in reverse order and look up in each map the prefix
8068 for (i
= nmaps
- 1; i
>= 0; --i
)
8069 if (!NILP (maps
[i
]))
8073 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8075 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8078 Vinhibit_quit
= oquit
;
8079 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8080 return tool_bar_items_vector
;
8084 /* Process the definition of KEY which is DEF. */
8087 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8090 struct gcpro gcpro1
, gcpro2
;
8092 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8096 if (EQ (def
, Qundefined
))
8098 /* If a map has an explicit `undefined' as definition,
8099 discard any previously made item. */
8100 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8102 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8104 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8106 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8107 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8108 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8109 * sizeof (Lisp_Object
)));
8110 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8115 else if (parse_tool_bar_item (key
, def
))
8116 /* Append a new tool bar item to tool_bar_items_vector. Accept
8117 more than one definition for the same key. */
8118 append_tool_bar_item ();
8124 /* Parse a tool bar item specification ITEM for key KEY and return the
8125 result in tool_bar_item_properties. Value is zero if ITEM is
8128 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8130 CAPTION is the caption of the item, If it's not a string, it is
8131 evaluated to get a string.
8133 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8134 as binding are currently ignored.
8136 The following properties are recognized:
8140 FORM is evaluated and specifies whether the tool bar item is
8141 enabled or disabled.
8145 FORM is evaluated and specifies whether the tool bar item is visible.
8147 - `:filter FUNCTION'
8149 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8150 result is stored as the new binding.
8152 - `:button (TYPE SELECTED)'
8154 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8155 and specifies whether the button is selected (pressed) or not.
8159 IMAGES is either a single image specification or a vector of four
8160 image specifications. See enum tool_bar_item_images.
8162 - `:help HELP-STRING'.
8164 Gives a help string to display for the tool bar item.
8166 - `:label LABEL-STRING'.
8168 A text label to show with the tool bar button if labels are enabled. */
8171 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8173 /* Access slot with index IDX of vector tool_bar_item_properties. */
8174 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8176 Lisp_Object filter
= Qnil
;
8177 Lisp_Object caption
;
8178 int i
, have_label
= 0;
8180 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8181 Rule out items that aren't lists, don't start with
8182 `menu-item' or whose rest following `tool-bar-item' is not a
8187 /* As an exception, allow old-style menu separators. */
8188 if (STRINGP (XCAR (item
)))
8189 item
= Fcons (XCAR (item
), Qnil
);
8190 else if (!EQ (XCAR (item
), Qmenu_item
)
8191 || (item
= XCDR (item
), !CONSP (item
)))
8194 /* Create tool_bar_item_properties vector if necessary. Reset it to
8196 if (VECTORP (tool_bar_item_properties
))
8198 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8202 tool_bar_item_properties
8203 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8206 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8207 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8209 /* Get the caption of the item. If the caption is not a string,
8210 evaluate it to get a string. If we don't get a string, skip this
8212 caption
= XCAR (item
);
8213 if (!STRINGP (caption
))
8215 caption
= menu_item_eval_property (caption
);
8216 if (!STRINGP (caption
))
8219 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8221 /* If the rest following the caption is not a list, the menu item is
8222 either a separator, or invalid. */
8226 if (menu_separator_name_p (SSDATA (caption
)))
8228 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8229 #if !defined (USE_GTK) && !defined (HAVE_NS)
8230 /* If we use build_desired_tool_bar_string to render the
8231 tool bar, the separator is rendered as an image. */
8232 PROP (TOOL_BAR_ITEM_IMAGES
)
8233 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8234 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8235 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8236 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8243 /* Store the binding. */
8244 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8247 /* Ignore cached key binding, if any. */
8248 if (CONSP (item
) && CONSP (XCAR (item
)))
8251 /* Process the rest of the properties. */
8252 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8254 Lisp_Object ikey
, value
;
8257 value
= XCAR (XCDR (item
));
8259 if (EQ (ikey
, QCenable
))
8261 /* `:enable FORM'. */
8262 if (!NILP (Venable_disabled_menus_and_buttons
))
8263 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8265 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8267 else if (EQ (ikey
, QCvisible
))
8269 /* `:visible FORM'. If got a visible property and that
8270 evaluates to nil then ignore this item. */
8271 if (NILP (menu_item_eval_property (value
)))
8274 else if (EQ (ikey
, QChelp
))
8275 /* `:help HELP-STRING'. */
8276 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8277 else if (EQ (ikey
, QCvert_only
))
8278 /* `:vert-only t/nil'. */
8279 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8280 else if (EQ (ikey
, QClabel
))
8282 const char *bad_label
= "!!?GARBLED ITEM?!!";
8283 /* `:label LABEL-STRING'. */
8284 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8286 : build_string (bad_label
);
8289 else if (EQ (ikey
, QCfilter
))
8290 /* ':filter FORM'. */
8292 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8294 /* `:button (TYPE . SELECTED)'. */
8295 Lisp_Object type
, selected
;
8297 type
= XCAR (value
);
8298 selected
= XCDR (value
);
8299 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8301 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8302 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8305 else if (EQ (ikey
, QCimage
)
8307 || (VECTORP (value
) && ASIZE (value
) == 4)))
8308 /* Value is either a single image specification or a vector
8309 of 4 such specifications for the different button states. */
8310 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8311 else if (EQ (ikey
, QCrtl
))
8313 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8319 /* Try to make one from caption and key. */
8320 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8321 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8322 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8323 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8325 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8326 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8327 Lisp_Object new_lbl
;
8328 ptrdiff_t caption_len
= strlen (capt
);
8330 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8333 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8335 buf
[caption_len
] = '\0';
8339 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8343 strcpy (buf
, label
);
8345 for (j
= 0; buf
[j
] != '\0'; ++j
)
8353 new_lbl
= Fupcase_initials (build_string (label
));
8354 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8355 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8357 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8361 /* If got a filter apply it on binding. */
8363 PROP (TOOL_BAR_ITEM_BINDING
)
8364 = menu_item_eval_property (list2 (filter
,
8366 PROP (TOOL_BAR_ITEM_BINDING
))));
8368 /* See if the binding is a keymap. Give up if it is. */
8369 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8372 /* Enable or disable selection of item. */
8373 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8374 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8375 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8377 /* Handle radio buttons or toggle boxes. */
8378 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8379 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8380 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8388 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8389 that can be reused. */
8392 init_tool_bar_items (Lisp_Object reuse
)
8394 if (VECTORP (reuse
))
8395 tool_bar_items_vector
= reuse
;
8397 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8398 ntool_bar_items
= 0;
8402 /* Append parsed tool bar item properties from
8403 tool_bar_item_properties */
8406 append_tool_bar_item (void)
8408 Lisp_Object
*to
, *from
;
8411 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8413 /* Enlarge tool_bar_items_vector if necessary. */
8415 tool_bar_items_vector
8416 = larger_vector (tool_bar_items_vector
, incr
, -1);
8418 /* Append entries from tool_bar_item_properties to the end of
8419 tool_bar_items_vector. */
8420 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8421 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8422 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8423 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8430 /* Read a character using menus based on maps in the array MAPS.
8431 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8432 Return t if we displayed a menu but the user rejected it.
8434 PREV_EVENT is the previous input event, or nil if we are reading
8435 the first event of a key sequence.
8437 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8438 if we used a mouse menu to read the input, or zero otherwise. If
8439 USED_MOUSE_MENU is null, we don't dereference it.
8441 The prompting is done based on the prompt-string of the map
8442 and the strings associated with various map elements.
8444 This can be done with X menus or with menus put in the minibuf.
8445 These are done in different ways, depending on how the input will be read.
8446 Menus using X are done after auto-saving in read-char, getting the input
8447 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8448 and do auto-saving in the inner call of read_char. */
8451 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8452 Lisp_Object prev_event
, int *used_mouse_menu
)
8456 if (used_mouse_menu
)
8457 *used_mouse_menu
= 0;
8459 /* Use local over global Menu maps */
8461 if (! menu_prompting
)
8464 /* Optionally disregard all but the global map. */
8465 if (inhibit_local_menu_bar_menus
)
8467 maps
+= (nmaps
- 1);
8472 /* If we got to this point via a mouse click,
8473 use a real menu for mouse selection. */
8474 if (EVENT_HAS_PARAMETERS (prev_event
)
8475 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8476 && !EQ (XCAR (prev_event
), Qtool_bar
))
8478 /* Display the menu and get the selection. */
8479 Lisp_Object
*realmaps
8480 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8482 ptrdiff_t nmaps1
= 0;
8484 /* Use the maps that are not nil. */
8485 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8486 if (!NILP (maps
[mapno
]))
8487 realmaps
[nmaps1
++] = maps
[mapno
];
8489 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8494 record_menu_key (XCAR (value
));
8496 /* If we got multiple events, unread all but
8498 There is no way to prevent those unread events
8499 from showing up later in last_nonmenu_event.
8500 So turn symbol and integer events into lists,
8501 to indicate that they came from a mouse menu,
8502 so that when present in last_nonmenu_event
8503 they won't confuse things. */
8504 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8506 record_menu_key (XCAR (tem
));
8507 if (SYMBOLP (XCAR (tem
))
8508 || INTEGERP (XCAR (tem
)))
8509 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8512 /* If we got more than one event, put all but the first
8513 onto this list to be read later.
8514 Return just the first event now. */
8515 Vunread_command_events
8516 = nconc2 (XCDR (value
), Vunread_command_events
);
8517 value
= XCAR (value
);
8519 else if (NILP (value
))
8521 if (used_mouse_menu
)
8522 *used_mouse_menu
= 1;
8525 #endif /* HAVE_MENUS */
8529 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8530 We make this bigger when necessary, and never free it. */
8531 static char *read_char_minibuf_menu_text
;
8532 /* Size of that buffer. */
8533 static ptrdiff_t read_char_minibuf_menu_width
;
8536 read_char_minibuf_menu_prompt (int commandflag
,
8537 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8540 register Lisp_Object name
;
8542 /* FIXME: Use the minibuffer's frame width. */
8543 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8546 Lisp_Object rest
, vector
;
8552 if (! menu_prompting
)
8555 /* Get the menu name from the first map that has one (a prompt string). */
8556 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8558 name
= Fkeymap_prompt (maps
[mapno
]);
8563 /* If we don't have any menus, just read a character normally. */
8564 if (!STRINGP (name
))
8567 /* Make sure we have a big enough buffer for the menu text. */
8568 width
= max (width
, SBYTES (name
));
8569 if (STRING_BYTES_BOUND
- 4 < width
)
8570 memory_full (SIZE_MAX
);
8571 if (width
+ 4 > read_char_minibuf_menu_width
)
8573 read_char_minibuf_menu_text
8574 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8575 read_char_minibuf_menu_width
= width
+ 4;
8577 menu
= read_char_minibuf_menu_text
;
8579 /* Prompt string always starts with map's prompt, and a space. */
8580 strcpy (menu
, SSDATA (name
));
8581 nlength
= SBYTES (name
);
8582 menu
[nlength
++] = ':';
8583 menu
[nlength
++] = ' ';
8586 /* Start prompting at start of first map. */
8590 /* Present the documented bindings, a line at a time. */
8594 ptrdiff_t i
= nlength
;
8596 Lisp_Object orig_defn_macro
;
8598 /* Loop over elements of map. */
8603 /* If reached end of map, start at beginning of next map. */
8607 /* At end of last map, wrap around to first map if just starting,
8608 or end this line if already have something on it. */
8612 if (notfirst
|| nobindings
) break;
8617 /* Look at the next element of the map. */
8619 elt
= XVECTOR (vector
)->contents
[idx
];
8621 elt
= Fcar_safe (rest
);
8623 if (idx
< 0 && VECTORP (elt
))
8625 /* If we found a dense table in the keymap,
8626 advanced past it, but start scanning its contents. */
8627 rest
= Fcdr_safe (rest
);
8633 /* An ordinary element. */
8634 Lisp_Object event
, tem
;
8638 event
= Fcar_safe (elt
); /* alist */
8639 elt
= Fcdr_safe (elt
);
8643 XSETINT (event
, idx
); /* vector */
8646 /* Ignore the element if it has no prompt string. */
8647 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8649 /* 1 if the char to type matches the string. */
8651 Lisp_Object upcased_event
, downcased_event
;
8652 Lisp_Object desc
= Qnil
;
8654 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8656 upcased_event
= Fupcase (event
);
8657 downcased_event
= Fdowncase (event
);
8658 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8659 || XINT (downcased_event
) == SREF (s
, 0));
8661 desc
= Fsingle_key_description (event
, Qnil
);
8663 #if 0 /* It is redundant to list the equivalent key bindings because
8664 the prefix is what the user has already typed. */
8666 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8668 /* Insert equivalent keybinding. */
8669 s
= concat2 (s
, tem
);
8672 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8673 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8675 /* Insert button prefix. */
8676 Lisp_Object selected
8677 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8678 if (EQ (tem
, QCradio
))
8679 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8681 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8682 s
= concat2 (tem
, s
);
8686 /* If we have room for the prompt string, add it to this line.
8687 If this is the first on the line, always add it. */
8688 if ((SCHARS (s
) + i
+ 2
8689 + (char_matches
? 0 : SCHARS (desc
) + 3))
8693 ptrdiff_t thiswidth
;
8695 /* Punctuate between strings. */
8698 strcpy (menu
+ i
, ", ");
8704 /* If the char to type doesn't match the string's
8705 first char, explicitly show what char to type. */
8708 /* Add as much of string as fits. */
8709 thiswidth
= min (SCHARS (desc
), width
- i
);
8710 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8712 strcpy (menu
+ i
, " = ");
8716 /* Add as much of string as fits. */
8717 thiswidth
= min (SCHARS (s
), width
- i
);
8718 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8724 /* If this element does not fit, end the line now,
8725 and save the element for the next line. */
8726 strcpy (menu
+ i
, "...");
8731 /* Move past this element. */
8732 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8733 /* Handle reaching end of dense table. */
8738 rest
= Fcdr_safe (rest
);
8742 /* Prompt with that and read response. */
8743 message2_nolog (menu
, strlen (menu
),
8744 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8746 /* Make believe its not a keyboard macro in case the help char
8747 is pressed. Help characters are not recorded because menu prompting
8748 is not used on replay.
8750 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8751 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8753 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8754 while (BUFFERP (obj
));
8755 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8757 if (!INTEGERP (obj
))
8759 else if (XINT (obj
) == -2)
8762 if (! EQ (obj
, menu_prompt_more_char
)
8763 && (!INTEGERP (menu_prompt_more_char
)
8764 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8766 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8767 store_kbd_macro_char (obj
);
8770 /* Help char - go round again */
8774 /* Reading key sequences. */
8776 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8777 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8778 keymap, or nil otherwise. Return the index of the first keymap in
8779 which KEY has any binding, or NMAPS if no map has a binding.
8781 If KEY is a meta ASCII character, treat it like meta-prefix-char
8782 followed by the corresponding non-meta character. Keymaps in
8783 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8786 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8789 NEXT may be the same array as CURRENT. */
8792 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8793 Lisp_Object
*defs
, Lisp_Object
*next
)
8795 ptrdiff_t i
, first_binding
;
8797 first_binding
= nmaps
;
8798 for (i
= nmaps
- 1; i
>= 0; i
--)
8800 if (! NILP (current
[i
]))
8802 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8803 if (! NILP (defs
[i
]))
8810 /* Given the set of bindings we've found, produce the next set of maps. */
8811 if (first_binding
< nmaps
)
8812 for (i
= 0; i
< nmaps
; i
++)
8813 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8815 return first_binding
;
8818 /* Structure used to keep track of partial application of key remapping
8819 such as Vfunction_key_map and Vkey_translation_map. */
8820 typedef struct keyremap
8822 /* This is the map originally specified for this use. */
8824 /* This is a submap reached by looking up, in PARENT,
8825 the events from START to END. */
8827 /* Positions [START, END) in the key sequence buffer
8828 are the key that we have scanned so far.
8829 Those events are the ones that we will replace
8830 if PARENT maps them into a key sequence. */
8834 /* Lookup KEY in MAP.
8835 MAP is a keymap mapping keys to key vectors or functions.
8836 If the mapping is a function and DO_FUNCTION is non-zero, then
8837 the function is called with PROMPT as parameter and its return
8838 value is used as the return value of this function (after checking
8839 that it is indeed a vector). */
8842 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8847 next
= access_keymap (map
, key
, 1, 0, 1);
8849 /* Handle symbol with autoload definition. */
8850 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8851 && CONSP (XSYMBOL (next
)->function
)
8852 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8853 do_autoload (XSYMBOL (next
)->function
, next
);
8855 /* Handle a symbol whose function definition is a keymap
8857 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8858 && (ARRAYP (XSYMBOL (next
)->function
)
8859 || KEYMAPP (XSYMBOL (next
)->function
)))
8860 next
= XSYMBOL (next
)->function
;
8862 /* If the keymap gives a function, not an
8863 array, then call the function with one arg and use
8864 its value instead. */
8865 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8870 next
= call1 (next
, prompt
);
8871 /* If the function returned something invalid,
8872 barf--don't ignore it.
8873 (To ignore it safely, we would need to gcpro a bunch of
8874 other variables.) */
8875 if (! (VECTORP (next
) || STRINGP (next
)))
8876 error ("Function %s returns invalid key sequence",
8877 SSDATA (SYMBOL_NAME (tem
)));
8882 /* Do one step of the key remapping used for function-key-map and
8883 key-translation-map:
8884 KEYBUF is the buffer holding the input events.
8885 BUFSIZE is its maximum size.
8886 FKEY is a pointer to the keyremap structure to use.
8887 INPUT is the index of the last element in KEYBUF.
8888 DOIT if non-zero says that the remapping can actually take place.
8889 DIFF is used to return the number of keys added/removed by the remapping.
8890 PARENT is the root of the keymap.
8891 PROMPT is the prompt to use if the remapping happens through a function.
8892 The return value is non-zero if the remapping actually took place. */
8895 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8896 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8898 Lisp_Object next
, key
;
8900 key
= keybuf
[fkey
->end
++];
8902 if (KEYMAPP (fkey
->parent
))
8903 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8907 /* If keybuf[fkey->start..fkey->end] is bound in the
8908 map and we're in a position to do the key remapping, replace it with
8909 the binding and restart with fkey->start at the end. */
8910 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8912 int len
= XFASTINT (Flength (next
));
8915 *diff
= len
- (fkey
->end
- fkey
->start
);
8917 if (bufsize
- input
<= *diff
)
8918 error ("Key sequence too long");
8920 /* Shift the keys that follow fkey->end. */
8922 for (i
= fkey
->end
; i
< input
; i
++)
8923 keybuf
[i
+ *diff
] = keybuf
[i
];
8925 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8926 keybuf
[i
+ *diff
] = keybuf
[i
];
8927 /* Overwrite the old keys with the new ones. */
8928 for (i
= 0; i
< len
; i
++)
8929 keybuf
[fkey
->start
+ i
]
8930 = Faref (next
, make_number (i
));
8932 fkey
->start
= fkey
->end
+= *diff
;
8933 fkey
->map
= fkey
->parent
;
8938 fkey
->map
= get_keymap (next
, 0, 1);
8940 /* If we no longer have a bound suffix, try a new position for
8942 if (!CONSP (fkey
->map
))
8944 fkey
->end
= ++fkey
->start
;
8945 fkey
->map
= fkey
->parent
;
8951 test_undefined (Lisp_Object binding
)
8953 return (EQ (binding
, Qundefined
)
8954 || (!NILP (binding
) && SYMBOLP (binding
)
8955 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8958 /* Read a sequence of keys that ends with a non prefix character,
8959 storing it in KEYBUF, a buffer of size BUFSIZE.
8961 Return the length of the key sequence stored.
8962 Return -1 if the user rejected a command menu.
8964 Echo starting immediately unless `prompt' is 0.
8966 Where a key sequence ends depends on the currently active keymaps.
8967 These include any minor mode keymaps active in the current buffer,
8968 the current buffer's local map, and the global map.
8970 If a key sequence has no other bindings, we check Vfunction_key_map
8971 to see if some trailing subsequence might be the beginning of a
8972 function key's sequence. If so, we try to read the whole function
8973 key, and substitute its symbolic name into the key sequence.
8975 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8976 `double-' events into similar click events, if that would make them
8977 bound. We try to turn `triple-' events first into `double-' events,
8980 If we get a mouse click in a mode line, vertical divider, or other
8981 non-text area, we treat the click as if it were prefixed by the
8982 symbol denoting that area - `mode-line', `vertical-line', or
8985 If the sequence starts with a mouse click, we read the key sequence
8986 with respect to the buffer clicked on, not the current buffer.
8988 If the user switches frames in the midst of a key sequence, we put
8989 off the switch-frame event until later; the next call to
8990 read_char will return it.
8992 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8993 from the selected window's buffer. */
8996 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8997 int dont_downcase_last
, int can_return_switch_frame
,
8998 int fix_current_buffer
)
9000 Lisp_Object from_string
;
9001 ptrdiff_t count
= SPECPDL_INDEX ();
9003 /* How many keys there are in the current key sequence. */
9006 /* The length of the echo buffer when we started reading, and
9007 the length of this_command_keys when we started reading. */
9008 ptrdiff_t echo_start
IF_LINT (= 0);
9009 ptrdiff_t keys_start
;
9011 /* The number of keymaps we're scanning right now, and the number of
9012 keymaps we have allocated space for. */
9014 ptrdiff_t nmaps_allocated
= 0;
9016 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9017 the current keymaps. */
9018 Lisp_Object
*defs
= NULL
;
9020 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9021 in the current keymaps, or nil where it is not a prefix. */
9022 Lisp_Object
*submaps
= NULL
;
9024 /* The local map to start out with at start of key sequence. */
9025 Lisp_Object orig_local_map
;
9027 /* The map from the `keymap' property to start out with at start of
9029 Lisp_Object orig_keymap
;
9031 /* 1 if we have already considered switching to the local-map property
9032 of the place where a mouse click occurred. */
9033 int localized_local_map
= 0;
9035 /* The index in submaps[] of the first keymap that has a binding for
9036 this key sequence. In other words, the lowest i such that
9037 submaps[i] is non-nil. */
9038 ptrdiff_t first_binding
;
9039 /* Index of the first key that has no binding.
9040 It is useless to try fkey.start larger than that. */
9043 /* If t < mock_input, then KEYBUF[t] should be read as the next
9046 We use this to recover after recognizing a function key. Once we
9047 realize that a suffix of the current key sequence is actually a
9048 function key's escape sequence, we replace the suffix with the
9049 function key's binding from Vfunction_key_map. Now keybuf
9050 contains a new and different key sequence, so the echo area,
9051 this_command_keys, and the submaps and defs arrays are wrong. In
9052 this situation, we set mock_input to t, set t to 0, and jump to
9053 restart_sequence; the loop will read keys from keybuf up until
9054 mock_input, thus rebuilding the state; and then it will resume
9055 reading characters from the keyboard. */
9058 /* If the sequence is unbound in submaps[], then
9059 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9060 and fkey.map is its binding.
9062 These might be > t, indicating that all function key scanning
9063 should hold off until t reaches them. We do this when we've just
9064 recognized a function key, to avoid searching for the function
9065 key's again in Vfunction_key_map. */
9068 /* Likewise, for key_translation_map and input-decode-map. */
9069 keyremap keytran
, indec
;
9071 /* Non-zero if we are trying to map a key by changing an upper-case
9072 letter to lower case, or a shifted function key to an unshifted
9074 int shift_translated
= 0;
9076 /* If we receive a `switch-frame' or `select-window' event in the middle of
9077 a key sequence, we put it off for later.
9078 While we're reading, we keep the event here. */
9079 Lisp_Object delayed_switch_frame
;
9081 /* See the comment below... */
9082 #if defined (GOBBLE_FIRST_EVENT)
9083 Lisp_Object first_event
;
9086 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9087 int original_uppercase_position
= -1;
9089 /* Gets around Microsoft compiler limitations. */
9092 struct buffer
*starting_buffer
;
9094 /* List of events for which a fake prefix key has been generated. */
9095 Lisp_Object fake_prefixed_keys
= Qnil
;
9097 #if defined (GOBBLE_FIRST_EVENT)
9101 struct gcpro gcpro1
;
9103 GCPRO1 (fake_prefixed_keys
);
9104 raw_keybuf_count
= 0;
9106 last_nonmenu_event
= Qnil
;
9108 delayed_switch_frame
= Qnil
;
9114 /* Install the string STR as the beginning of the string of
9115 echoing, so that it serves as a prompt for the next
9117 KVAR (current_kboard
, echo_string
) = prompt
;
9118 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9121 else if (cursor_in_echo_area
9122 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9123 && NILP (Fzerop (Vecho_keystrokes
)))
9124 /* This doesn't put in a dash if the echo buffer is empty, so
9125 you don't always see a dash hanging out in the minibuffer. */
9129 /* Record the initial state of the echo area and this_command_keys;
9130 we will need to restore them if we replay a key sequence. */
9132 echo_start
= echo_length ();
9133 keys_start
= this_command_key_count
;
9134 this_single_command_key_start
= keys_start
;
9136 #if defined (GOBBLE_FIRST_EVENT)
9137 /* This doesn't quite work, because some of the things that read_char
9138 does cannot safely be bypassed. It seems too risky to try to make
9141 /* Read the first char of the sequence specially, before setting
9142 up any keymaps, in case a filter runs and switches buffers on us. */
9143 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9145 #endif /* GOBBLE_FIRST_EVENT */
9147 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9148 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9151 /* We jump here when we need to reinitialize fkey and keytran; this
9152 happens if we switch keyboards between rescans. */
9153 replay_entire_sequence
:
9155 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9156 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9157 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9158 indec
.start
= indec
.end
= 0;
9159 fkey
.start
= fkey
.end
= 0;
9160 keytran
.start
= keytran
.end
= 0;
9162 /* We jump here when the key sequence has been thoroughly changed, and
9163 we need to rescan it starting from the beginning. When we jump here,
9164 keybuf[0..mock_input] holds the sequence we should reread. */
9167 starting_buffer
= current_buffer
;
9168 first_unbound
= bufsize
+ 1;
9170 /* Build our list of keymaps.
9171 If we recognize a function key and replace its escape sequence in
9172 keybuf with its symbol, or if the sequence starts with a mouse
9173 click and we need to switch buffers, we jump back here to rebuild
9174 the initial keymaps from the current buffer. */
9177 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9179 if (2 > nmaps_allocated
)
9181 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9182 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9183 nmaps_allocated
= 2;
9185 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9187 else if (!NILP (Voverriding_local_map
))
9189 if (2 > nmaps_allocated
)
9191 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9192 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9193 nmaps_allocated
= 2;
9195 submaps
[nmaps
++] = Voverriding_local_map
;
9203 nminor
= current_minor_maps (0, &maps
);
9204 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9206 if (total
> nmaps_allocated
)
9208 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9209 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9210 nmaps_allocated
= total
;
9213 if (!NILP (orig_keymap
))
9214 submaps
[nmaps
++] = orig_keymap
;
9216 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9220 submaps
[nmaps
++] = orig_local_map
;
9222 submaps
[nmaps
++] = current_global_map
;
9224 /* Find an accurate initial value for first_binding. */
9225 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9226 if (! NILP (submaps
[first_binding
]))
9229 /* Start from the beginning in keybuf. */
9232 /* These are no-ops the first time through, but if we restart, they
9233 revert the echo area and this_command_keys to their original state. */
9234 this_command_key_count
= keys_start
;
9235 if (INTERACTIVE
&& t
< mock_input
)
9236 echo_truncate (echo_start
);
9238 /* If the best binding for the current key sequence is a keymap, or
9239 we may be looking at a function key's escape sequence, keep on
9241 while (first_binding
< nmaps
9242 /* Keep reading as long as there's a prefix binding. */
9243 ? !NILP (submaps
[first_binding
])
9244 /* Don't return in the middle of a possible function key sequence,
9245 if the only bindings we found were via case conversion.
9246 Thus, if ESC O a has a function-key-map translation
9247 and ESC o has a binding, don't return after ESC O,
9248 so that we can translate ESC O plus the next character. */
9249 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9252 int used_mouse_menu
= 0;
9254 /* Where the last real key started. If we need to throw away a
9255 key that has expanded into more than one element of keybuf
9256 (say, a mouse click on the mode line which is being treated
9257 as [mode-line (mouse-...)], then we backtrack to this point
9259 int last_real_key_start
;
9261 /* These variables are analogous to echo_start and keys_start;
9262 while those allow us to restart the entire key sequence,
9263 echo_local_start and keys_local_start allow us to throw away
9265 ptrdiff_t echo_local_start
IF_LINT (= 0);
9266 int keys_local_start
;
9267 ptrdiff_t local_first_binding
;
9269 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9270 eassert (indec
.start
<= indec
.end
);
9271 eassert (fkey
.start
<= fkey
.end
);
9272 eassert (keytran
.start
<= keytran
.end
);
9273 /* key-translation-map is applied *after* function-key-map
9274 which is itself applied *after* input-decode-map. */
9275 eassert (fkey
.end
<= indec
.start
);
9276 eassert (keytran
.end
<= fkey
.start
);
9278 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9279 first_unbound
< keytran
.start
)
9280 { /* The prefix upto first_unbound has no binding and has
9281 no translation left to do either, so we know it's unbound.
9282 If we don't stop now, we risk staying here indefinitely
9283 (if the user keeps entering fkey or keytran prefixes
9284 like C-c ESC ESC ESC ESC ...) */
9286 for (i
= first_unbound
+ 1; i
< t
; i
++)
9287 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9288 mock_input
= t
- first_unbound
- 1;
9289 indec
.end
= indec
.start
-= first_unbound
+ 1;
9290 indec
.map
= indec
.parent
;
9291 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9292 fkey
.map
= fkey
.parent
;
9293 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9294 keytran
.map
= keytran
.parent
;
9295 goto replay_sequence
;
9299 error ("Key sequence too long");
9302 echo_local_start
= echo_length ();
9303 keys_local_start
= this_command_key_count
;
9304 local_first_binding
= first_binding
;
9307 /* These are no-ops, unless we throw away a keystroke below and
9308 jumped back up to replay_key; in that case, these restore the
9309 variables to their original state, allowing us to replay the
9311 if (INTERACTIVE
&& t
< mock_input
)
9312 echo_truncate (echo_local_start
);
9313 this_command_key_count
= keys_local_start
;
9314 first_binding
= local_first_binding
;
9316 /* By default, assume each event is "real". */
9317 last_real_key_start
= t
;
9319 /* Does mock_input indicate that we are re-reading a key sequence? */
9323 add_command_key (key
);
9324 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9325 && NILP (Fzerop (Vecho_keystrokes
)))
9329 /* If not, we should actually read a character. */
9333 KBOARD
*interrupted_kboard
= current_kboard
;
9334 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9335 key
= read_char (NILP (prompt
), nmaps
,
9336 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9337 &used_mouse_menu
, NULL
);
9338 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9339 /* When switching to a new tty (with a new keyboard),
9340 read_char returns the new buffer, rather than -2
9341 (Bug#5095). This is because `terminal-init-xterm'
9342 calls read-char, which eats the wrong_kboard_jmpbuf
9343 return. Any better way to fix this? -- cyd */
9344 || (interrupted_kboard
!= current_kboard
))
9349 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9350 if (k
== interrupted_kboard
)
9355 /* Don't touch interrupted_kboard when it's been
9357 delayed_switch_frame
= Qnil
;
9358 goto replay_entire_sequence
;
9361 if (!NILP (delayed_switch_frame
))
9363 KVAR (interrupted_kboard
, kbd_queue
)
9364 = Fcons (delayed_switch_frame
,
9365 KVAR (interrupted_kboard
, kbd_queue
));
9366 delayed_switch_frame
= Qnil
;
9370 KVAR (interrupted_kboard
, kbd_queue
)
9371 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9373 /* If the side queue is non-empty, ensure it begins with a
9374 switch-frame, so we'll replay it in the right context. */
9375 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9376 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9377 !(EVENT_HAS_PARAMETERS (key
)
9378 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9382 XSETFRAME (frame
, interrupted_frame
);
9383 KVAR (interrupted_kboard
, kbd_queue
)
9384 = Fcons (make_lispy_switch_frame (frame
),
9385 KVAR (interrupted_kboard
, kbd_queue
));
9388 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9389 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9390 goto replay_entire_sequence
;
9394 /* read_char returns t when it shows a menu and the user rejects it.
9398 unbind_to (count
, Qnil
);
9403 /* read_char returns -1 at the end of a macro.
9404 Emacs 18 handles this by returning immediately with a
9405 zero, so that's what we'll do. */
9406 if (INTEGERP (key
) && XINT (key
) == -1)
9409 /* The Microsoft C compiler can't handle the goto that
9415 /* If the current buffer has been changed from under us, the
9416 keymap may have changed, so replay the sequence. */
9419 timer_resume_idle ();
9422 /* Reset the current buffer from the selected window
9423 in case something changed the former and not the latter.
9424 This is to be more consistent with the behavior
9425 of the command_loop_1. */
9426 if (fix_current_buffer
)
9428 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9430 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9431 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9434 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9435 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9436 goto replay_sequence
;
9439 /* If we have a quit that was typed in another frame, and
9440 quit_throw_to_read_char switched buffers,
9441 replay to get the right keymap. */
9443 && XINT (key
) == quit_char
9444 && current_buffer
!= starting_buffer
)
9447 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9451 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9452 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9453 goto replay_sequence
;
9458 if (EVENT_HAS_PARAMETERS (key
)
9459 /* Either a `switch-frame' or a `select-window' event. */
9460 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9462 /* If we're at the beginning of a key sequence, and the caller
9463 says it's okay, go ahead and return this event. If we're
9464 in the midst of a key sequence, delay it until the end. */
9465 if (t
> 0 || !can_return_switch_frame
)
9467 delayed_switch_frame
= key
;
9473 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9477 /* Clicks in non-text areas get prefixed by the symbol
9478 in their CHAR-ADDRESS field. For example, a click on
9479 the mode line is prefixed by the symbol `mode-line'.
9481 Furthermore, key sequences beginning with mouse clicks
9482 are read using the keymaps of the buffer clicked on, not
9483 the current buffer. So we may have to switch the buffer
9486 When we turn one event into two events, we must make sure
9487 that neither of the two looks like the original--so that,
9488 if we replay the events, they won't be expanded again.
9489 If not for this, such reexpansion could happen either here
9490 or when user programs play with this-command-keys. */
9491 if (EVENT_HAS_PARAMETERS (key
))
9496 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9497 if (EQ (kind
, Qmouse_click
))
9499 Lisp_Object window
, posn
;
9501 window
= POSN_WINDOW (EVENT_START (key
));
9502 posn
= POSN_POSN (EVENT_START (key
));
9505 || (!NILP (fake_prefixed_keys
)
9506 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9508 /* We're looking a second time at an event for which
9509 we generated a fake prefix key. Set
9510 last_real_key_start appropriately. */
9512 last_real_key_start
= t
- 1;
9515 if (last_real_key_start
== 0)
9517 /* Key sequences beginning with mouse clicks are
9518 read using the keymaps in the buffer clicked on,
9519 not the current buffer. If we're at the
9520 beginning of a key sequence, switch buffers. */
9521 if (WINDOWP (window
)
9522 && BUFFERP (XWINDOW (window
)->buffer
)
9523 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9525 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9529 /* Arrange to go back to the original buffer once we're
9530 done reading the key sequence. Note that we can't
9531 use save_excursion_{save,restore} here, because they
9532 save point as well as the current buffer; we don't
9533 want to save point, because redisplay may change it,
9534 to accommodate a Fset_window_start or something. We
9535 don't want to do this at the top of the function,
9536 because we may get input from a subprocess which
9537 wants to change the selected window and stuff (say,
9539 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9541 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9543 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9544 orig_local_map
= get_local_map (PT
, current_buffer
,
9546 orig_keymap
= get_local_map (PT
, current_buffer
,
9548 goto replay_sequence
;
9551 /* For a mouse click, get the local text-property keymap
9552 of the place clicked on, rather than point. */
9553 if (CONSP (XCDR (key
))
9554 && ! localized_local_map
)
9556 Lisp_Object map_here
, start
, pos
;
9558 localized_local_map
= 1;
9559 start
= EVENT_START (key
);
9561 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9563 pos
= POSN_BUFFER_POSN (start
);
9565 && XINT (pos
) >= BEGV
9566 && XINT (pos
) <= ZV
)
9568 map_here
= get_local_map (XINT (pos
),
9571 if (!EQ (map_here
, orig_local_map
))
9573 orig_local_map
= map_here
;
9574 ++localized_local_map
;
9577 map_here
= get_local_map (XINT (pos
),
9580 if (!EQ (map_here
, orig_keymap
))
9582 orig_keymap
= map_here
;
9583 ++localized_local_map
;
9586 if (localized_local_map
> 1)
9591 goto replay_sequence
;
9598 /* Expand mode-line and scroll-bar events into two events:
9599 use posn as a fake prefix key. */
9601 && (NILP (fake_prefixed_keys
)
9602 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9604 if (bufsize
- t
<= 1)
9605 error ("Key sequence too long");
9608 keybuf
[t
+ 1] = key
;
9611 /* Record that a fake prefix key has been generated
9612 for KEY. Don't modify the event; this would
9613 prevent proper action when the event is pushed
9614 back into unread-command-events. */
9615 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9617 /* If on a mode line string with a local keymap,
9618 reconsider the key sequence with that keymap. */
9619 if (string
= POSN_STRING (EVENT_START (key
)),
9620 (CONSP (string
) && STRINGP (XCAR (string
))))
9622 Lisp_Object pos
, map
, map2
;
9624 pos
= XCDR (string
);
9625 string
= XCAR (string
);
9627 && XINT (pos
) < SCHARS (string
))
9629 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9631 orig_local_map
= map
;
9632 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9635 if (!NILP (map
) || !NILP (map2
))
9636 goto replay_sequence
;
9642 else if (NILP (from_string
)
9643 && (string
= POSN_STRING (EVENT_START (key
)),
9644 (CONSP (string
) && STRINGP (XCAR (string
)))))
9646 /* For a click on a string, i.e. overlay string or a
9647 string displayed via the `display' property,
9648 consider `local-map' and `keymap' properties of
9650 Lisp_Object pos
, map
, map2
;
9652 pos
= XCDR (string
);
9653 string
= XCAR (string
);
9655 && XINT (pos
) < SCHARS (string
))
9657 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9659 orig_local_map
= map
;
9660 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9664 if (!NILP (map
) || !NILP (map2
))
9666 from_string
= string
;
9669 goto replay_sequence
;
9674 else if (CONSP (XCDR (key
))
9675 && CONSP (EVENT_START (key
))
9676 && CONSP (XCDR (EVENT_START (key
))))
9680 posn
= POSN_POSN (EVENT_START (key
));
9681 /* Handle menu-bar events:
9682 insert the dummy prefix event `menu-bar'. */
9683 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9685 if (bufsize
- t
<= 1)
9686 error ("Key sequence too long");
9690 /* Zap the position in key, so we know that we've
9691 expanded it, and don't try to do so again. */
9692 POSN_SET_POSN (EVENT_START (key
),
9693 Fcons (posn
, Qnil
));
9696 goto replay_sequence
;
9698 else if (CONSP (posn
))
9700 /* We're looking at the second event of a
9701 sequence which we expanded before. Set
9702 last_real_key_start appropriately. */
9703 if (last_real_key_start
== t
&& t
> 0)
9704 last_real_key_start
= t
- 1;
9709 /* We have finally decided that KEY is something we might want
9711 first_binding
= (follow_key (key
,
9712 nmaps
- first_binding
,
9713 submaps
+ first_binding
,
9714 defs
+ first_binding
,
9715 submaps
+ first_binding
)
9718 /* If KEY wasn't bound, we'll try some fallbacks. */
9719 if (first_binding
< nmaps
)
9720 /* This is needed for the following scenario:
9721 event 0: a down-event that gets dropped by calling replay_key.
9722 event 1: some normal prefix like C-h.
9723 After event 0, first_unbound is 0, after event 1 indec.start,
9724 fkey.start, and keytran.start are all 1, so when we see that
9725 C-h is bound, we need to update first_unbound. */
9726 first_unbound
= max (t
+ 1, first_unbound
);
9731 /* Remember the position to put an upper bound on indec.start. */
9732 first_unbound
= min (t
, first_unbound
);
9734 head
= EVENT_HEAD (key
);
9735 if (help_char_p (head
) && t
> 0)
9737 read_key_sequence_cmd
= Vprefix_help_command
;
9739 last_nonmenu_event
= key
;
9740 /* The Microsoft C compiler can't handle the goto that
9748 Lisp_Object breakdown
;
9751 breakdown
= parse_modifiers (head
);
9752 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9753 /* Attempt to reduce an unbound mouse event to a simpler
9754 event that is bound:
9755 Drags reduce to clicks.
9756 Double-clicks reduce to clicks.
9757 Triple-clicks reduce to double-clicks, then to clicks.
9758 Down-clicks are eliminated.
9759 Double-downs reduce to downs, then are eliminated.
9760 Triple-downs reduce to double-downs, then to downs,
9761 then are eliminated. */
9762 if (modifiers
& (down_modifier
| drag_modifier
9763 | double_modifier
| triple_modifier
))
9765 while (modifiers
& (down_modifier
| drag_modifier
9766 | double_modifier
| triple_modifier
))
9768 Lisp_Object new_head
, new_click
;
9769 if (modifiers
& triple_modifier
)
9770 modifiers
^= (double_modifier
| triple_modifier
);
9771 else if (modifiers
& double_modifier
)
9772 modifiers
&= ~double_modifier
;
9773 else if (modifiers
& drag_modifier
)
9774 modifiers
&= ~drag_modifier
;
9777 /* Dispose of this `down' event by simply jumping
9778 back to replay_key, to get another event.
9780 Note that if this event came from mock input,
9781 then just jumping back to replay_key will just
9782 hand it to us again. So we have to wipe out any
9785 We could delete keybuf[t] and shift everything
9786 after that to the left by one spot, but we'd also
9787 have to fix up any variable that points into
9788 keybuf, and shifting isn't really necessary
9791 Adding prefixes for non-textual mouse clicks
9792 creates two characters of mock input, and both
9793 must be thrown away. If we're only looking at
9794 the prefix now, we can just jump back to
9795 replay_key. On the other hand, if we've already
9796 processed the prefix, and now the actual click
9797 itself is giving us trouble, then we've lost the
9798 state of the keymaps we want to backtrack to, and
9799 we need to replay the whole sequence to rebuild
9802 Beyond that, only function key expansion could
9803 create more than two keys, but that should never
9804 generate mouse events, so it's okay to zero
9805 mock_input in that case too.
9807 FIXME: The above paragraph seems just plain
9808 wrong, if you consider things like
9809 xterm-mouse-mode. -stef
9811 Isn't this just the most wonderful code ever? */
9813 /* If mock_input > t + 1, the above simplification
9814 will actually end up dropping keys on the floor.
9815 This is probably OK for now, but even
9816 if mock_input <= t + 1, we need to adjust indec,
9818 Typical case [header-line down-mouse-N]:
9819 mock_input = 2, t = 1, fkey.end = 1,
9820 last_real_key_start = 0. */
9821 if (indec
.end
> last_real_key_start
)
9823 indec
.end
= indec
.start
9824 = min (last_real_key_start
, indec
.start
);
9825 indec
.map
= indec
.parent
;
9826 if (fkey
.end
> last_real_key_start
)
9828 fkey
.end
= fkey
.start
9829 = min (last_real_key_start
, fkey
.start
);
9830 fkey
.map
= fkey
.parent
;
9831 if (keytran
.end
> last_real_key_start
)
9833 keytran
.end
= keytran
.start
9834 = min (last_real_key_start
, keytran
.start
);
9835 keytran
.map
= keytran
.parent
;
9839 if (t
== last_real_key_start
)
9846 mock_input
= last_real_key_start
;
9847 goto replay_sequence
;
9852 = apply_modifiers (modifiers
, XCAR (breakdown
));
9854 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9856 /* Look for a binding for this new key. follow_key
9857 promises that it didn't munge submaps the
9858 last time we called it, since key was unbound. */
9860 = (follow_key (new_click
,
9861 nmaps
- local_first_binding
,
9862 submaps
+ local_first_binding
,
9863 defs
+ local_first_binding
,
9864 submaps
+ local_first_binding
)
9865 + local_first_binding
);
9867 /* If that click is bound, go for it. */
9868 if (first_binding
< nmaps
)
9873 /* Otherwise, we'll leave key set to the drag event. */
9880 /* Normally, last_nonmenu_event gets the previous key we read.
9881 But when a mouse popup menu is being used,
9882 we don't update last_nonmenu_event; it continues to hold the mouse
9883 event that preceded the first level of menu. */
9884 if (!used_mouse_menu
)
9885 last_nonmenu_event
= key
;
9887 /* Record what part of this_command_keys is the current key sequence. */
9888 this_single_command_key_start
= this_command_key_count
- t
;
9890 /* Look for this sequence in input-decode-map.
9891 Scan from indec.end until we find a bound suffix. */
9892 while (indec
.end
< t
)
9894 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9897 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9898 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9903 mock_input
= diff
+ max (t
, mock_input
);
9904 goto replay_sequence
;
9908 if (first_binding
< nmaps
9909 && NILP (submaps
[first_binding
])
9910 && !test_undefined (defs
[first_binding
])
9911 && indec
.start
>= t
)
9912 /* There is a binding and it's not a prefix.
9913 (and it doesn't have any input-decode-map translation pending).
9914 There is thus no function-key in this sequence.
9915 Moving fkey.start is important in this case to allow keytran.start
9916 to go over the sequence before we return (since we keep the
9917 invariant that keytran.end <= fkey.start). */
9920 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9923 /* If the sequence is unbound, see if we can hang a function key
9924 off the end of it. */
9925 /* Continue scan from fkey.end until we find a bound suffix. */
9926 while (fkey
.end
< indec
.start
)
9928 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9931 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9932 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9933 max (t
, mock_input
),
9934 /* If there's a binding (i.e.
9935 first_binding >= nmaps) we don't want
9936 to apply this function-key-mapping. */
9938 && (first_binding
>= nmaps
9939 || test_undefined (defs
[first_binding
])),
9944 mock_input
= diff
+ max (t
, mock_input
);
9945 /* Adjust the input-decode-map counters. */
9947 indec
.start
+= diff
;
9949 goto replay_sequence
;
9953 /* Look for this sequence in key-translation-map.
9954 Scan from keytran.end until we find a bound suffix. */
9955 while (keytran
.end
< fkey
.start
)
9957 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9960 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9961 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9966 mock_input
= diff
+ max (t
, mock_input
);
9967 /* Adjust the function-key-map and input-decode-map counters. */
9969 indec
.start
+= diff
;
9973 goto replay_sequence
;
9977 /* If KEY is not defined in any of the keymaps,
9978 and cannot be part of a function key or translation,
9979 and is an upper case letter
9980 use the corresponding lower-case letter instead. */
9981 if (first_binding
>= nmaps
9982 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9984 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9985 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9986 || (XINT (key
) & shift_modifier
)))
9988 Lisp_Object new_key
;
9990 original_uppercase
= key
;
9991 original_uppercase_position
= t
- 1;
9993 if (XINT (key
) & shift_modifier
)
9994 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9996 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9997 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9999 /* We have to do this unconditionally, regardless of whether
10000 the lower-case char is defined in the keymaps, because they
10001 might get translated through function-key-map. */
10002 keybuf
[t
- 1] = new_key
;
10003 mock_input
= max (t
, mock_input
);
10004 shift_translated
= 1;
10006 goto replay_sequence
;
10008 /* If KEY is not defined in any of the keymaps,
10009 and cannot be part of a function key or translation,
10010 and is a shifted function key,
10011 use the corresponding unshifted function key instead. */
10012 if (first_binding
>= nmaps
10013 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10015 Lisp_Object breakdown
= parse_modifiers (key
);
10017 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10019 if (modifiers
& shift_modifier
10020 /* Treat uppercase keys as shifted. */
10022 && (KEY_TO_CHAR (key
)
10023 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10024 && uppercasep (KEY_TO_CHAR (key
))))
10026 Lisp_Object new_key
10027 = (modifiers
& shift_modifier
10028 ? apply_modifiers (modifiers
& ~shift_modifier
,
10030 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10032 original_uppercase
= key
;
10033 original_uppercase_position
= t
- 1;
10035 /* We have to do this unconditionally, regardless of whether
10036 the lower-case char is defined in the keymaps, because they
10037 might get translated through function-key-map. */
10038 keybuf
[t
- 1] = new_key
;
10039 mock_input
= max (t
, mock_input
);
10040 /* Reset fkey (and consequently keytran) to apply
10041 function-key-map on the result, so that S-backspace is
10042 correctly mapped to DEL (via backspace). OTOH,
10043 input-decode-map doesn't need to go through it again. */
10044 fkey
.start
= fkey
.end
= 0;
10045 keytran
.start
= keytran
.end
= 0;
10046 shift_translated
= 1;
10048 goto replay_sequence
;
10053 read_key_sequence_cmd
= (first_binding
< nmaps
10054 ? defs
[first_binding
]
10056 read_key_sequence_remapped
10057 /* Remap command through active keymaps.
10058 Do the remapping here, before the unbind_to so it uses the keymaps
10059 of the appropriate buffer. */
10060 = SYMBOLP (read_key_sequence_cmd
)
10061 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10064 unread_switch_frame
= delayed_switch_frame
;
10065 unbind_to (count
, Qnil
);
10067 /* Don't downcase the last character if the caller says don't.
10068 Don't downcase it if the result is undefined, either. */
10069 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10071 && t
- 1 == original_uppercase_position
)
10073 keybuf
[t
- 1] = original_uppercase
;
10074 shift_translated
= 0;
10077 if (shift_translated
)
10078 Vthis_command_keys_shift_translated
= Qt
;
10080 /* Occasionally we fabricate events, perhaps by expanding something
10081 according to function-key-map, or by adding a prefix symbol to a
10082 mouse click in the scroll bar or modeline. In this cases, return
10083 the entire generated key sequence, even if we hit an unbound
10084 prefix or a definition before the end. This means that you will
10085 be able to push back the event properly, and also means that
10086 read-key-sequence will always return a logical unit.
10089 for (; t
< mock_input
; t
++)
10091 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10092 && NILP (Fzerop (Vecho_keystrokes
)))
10093 echo_char (keybuf
[t
]);
10094 add_command_key (keybuf
[t
]);
10101 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10102 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10103 The sequence is sufficient to specify a non-prefix command in the
10104 current local and global maps.
10106 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10107 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10108 as a continuation of the previous key.
10110 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10111 convert the last event to lower case. (Normally any upper case event
10112 is converted to lower case if the original event is undefined and the lower
10113 case equivalent is defined.) A non-nil value is appropriate for reading
10114 a key sequence to be defined.
10116 A C-g typed while in this function is treated like any other character,
10117 and `quit-flag' is not set.
10119 If the key sequence starts with a mouse click, then the sequence is read
10120 using the keymaps of the buffer of the window clicked in, not the buffer
10121 of the selected window as normal.
10123 `read-key-sequence' drops unbound button-down events, since you normally
10124 only care about the click or drag events which follow them. If a drag
10125 or multi-click event is unbound, but the corresponding click event would
10126 be bound, `read-key-sequence' turns the event into a click event at the
10127 drag's starting position. This means that you don't have to distinguish
10128 between click and drag, double, or triple events unless you want to.
10130 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10131 lines separating windows, and scroll bars with imaginary keys
10132 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10134 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10135 function will process a switch-frame event if the user switches frames
10136 before typing anything. If the user switches frames in the middle of a
10137 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10138 is nil, then the event will be put off until after the current key sequence.
10140 `read-key-sequence' checks `function-key-map' for function key
10141 sequences, where they wouldn't conflict with ordinary bindings. See
10142 `function-key-map' for more details.
10144 The optional fifth argument CMD-LOOP, if non-nil, means
10145 that this key sequence is being read by something that will
10146 read commands one after another. It should be nil if the caller
10147 will read just one key sequence. */)
10148 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10150 Lisp_Object keybuf
[30];
10152 struct gcpro gcpro1
;
10153 ptrdiff_t count
= SPECPDL_INDEX ();
10155 if (!NILP (prompt
))
10156 CHECK_STRING (prompt
);
10159 specbind (Qinput_method_exit_on_first_char
,
10160 (NILP (cmd_loop
) ? Qt
: Qnil
));
10161 specbind (Qinput_method_use_echo_area
,
10162 (NILP (cmd_loop
) ? Qt
: Qnil
));
10164 memset (keybuf
, 0, sizeof keybuf
);
10165 GCPRO1 (keybuf
[0]);
10166 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10168 if (NILP (continue_echo
))
10170 this_command_key_count
= 0;
10171 this_command_key_count_reset
= 0;
10172 this_single_command_key_start
= 0;
10175 #ifdef HAVE_WINDOW_SYSTEM
10176 if (display_hourglass_p
)
10177 cancel_hourglass ();
10180 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10181 prompt
, ! NILP (dont_downcase_last
),
10182 ! NILP (can_return_switch_frame
), 0);
10184 #if 0 /* The following is fine for code reading a key sequence and
10185 then proceeding with a lengthy computation, but it's not good
10186 for code reading keys in a loop, like an input method. */
10187 #ifdef HAVE_WINDOW_SYSTEM
10188 if (display_hourglass_p
)
10189 start_hourglass ();
10199 return unbind_to (count
, make_event_array (i
, keybuf
));
10202 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10203 Sread_key_sequence_vector
, 1, 5, 0,
10204 doc
: /* Like `read-key-sequence' but always return a vector. */)
10205 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10207 Lisp_Object keybuf
[30];
10209 struct gcpro gcpro1
;
10210 ptrdiff_t count
= SPECPDL_INDEX ();
10212 if (!NILP (prompt
))
10213 CHECK_STRING (prompt
);
10216 specbind (Qinput_method_exit_on_first_char
,
10217 (NILP (cmd_loop
) ? Qt
: Qnil
));
10218 specbind (Qinput_method_use_echo_area
,
10219 (NILP (cmd_loop
) ? Qt
: Qnil
));
10221 memset (keybuf
, 0, sizeof keybuf
);
10222 GCPRO1 (keybuf
[0]);
10223 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10225 if (NILP (continue_echo
))
10227 this_command_key_count
= 0;
10228 this_command_key_count_reset
= 0;
10229 this_single_command_key_start
= 0;
10232 #ifdef HAVE_WINDOW_SYSTEM
10233 if (display_hourglass_p
)
10234 cancel_hourglass ();
10237 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10238 prompt
, ! NILP (dont_downcase_last
),
10239 ! NILP (can_return_switch_frame
), 0);
10241 #ifdef HAVE_WINDOW_SYSTEM
10242 if (display_hourglass_p
)
10243 start_hourglass ();
10252 return unbind_to (count
, Fvector (i
, keybuf
));
10255 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10256 doc
: /* Execute CMD as an editor command.
10257 CMD must be a symbol that satisfies the `commandp' predicate.
10258 Optional second arg RECORD-FLAG non-nil
10259 means unconditionally put this command in `command-history'.
10260 Otherwise, that is done only if an arg is read using the minibuffer.
10261 The argument KEYS specifies the value to use instead of (this-command-keys)
10262 when reading the arguments; if it is nil, (this-command-keys) is used.
10263 The argument SPECIAL, if non-nil, means that this command is executing
10264 a special event, so ignore the prefix argument and don't clear it. */)
10265 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10267 register Lisp_Object final
;
10268 register Lisp_Object tem
;
10269 Lisp_Object prefixarg
;
10271 debug_on_next_call
= 0;
10273 if (NILP (special
))
10275 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10276 Vcurrent_prefix_arg
= prefixarg
;
10277 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10284 tem
= Fget (cmd
, Qdisabled
);
10287 tem
= Fsymbol_value (Qdisabled_command_function
);
10289 return Frun_hooks (1, &Qdisabled_command_function
);
10295 final
= Findirect_function (cmd
, Qnil
);
10297 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10299 struct gcpro gcpro1
, gcpro2
;
10301 GCPRO2 (cmd
, prefixarg
);
10302 do_autoload (final
, cmd
);
10309 if (STRINGP (final
) || VECTORP (final
))
10311 /* If requested, place the macro in the command history. For
10312 other sorts of commands, call-interactively takes care of
10314 if (!NILP (record_flag
))
10317 = Fcons (Fcons (Qexecute_kbd_macro
,
10318 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10321 /* Don't keep command history around forever. */
10322 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10324 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10326 XSETCDR (tem
, Qnil
);
10330 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10333 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10334 /* Don't call Fcall_interactively directly because we want to make
10335 sure the backtrace has an entry for `call-interactively'.
10336 For the same reason, pass `cmd' rather than `final'. */
10337 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10344 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10346 doc
: /* Read function name, then read its arguments and call it.
10348 To pass a numeric argument to the command you are invoking with, specify
10349 the numeric argument to this command.
10351 Noninteractively, the argument PREFIXARG is the prefix argument to
10352 give to the command you invoke, if it asks for an argument. */)
10353 (Lisp_Object prefixarg
)
10355 Lisp_Object function
;
10356 ptrdiff_t saved_last_point_position
;
10357 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10358 Lisp_Object bindings
, value
;
10359 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10360 #ifdef HAVE_WINDOW_SYSTEM
10361 /* The call to Fcompleting_read will start and cancel the hourglass,
10362 but if the hourglass was already scheduled, this means that no
10363 hourglass will be shown for the actual M-x command itself.
10364 So we restart it if it is already scheduled. Note that checking
10365 hourglass_shown_p is not enough, normally the hourglass is not shown,
10366 just scheduled to be shown. */
10367 int hstarted
= hourglass_started ();
10370 saved_keys
= Fvector (this_command_key_count
,
10371 XVECTOR (this_command_keys
)->contents
);
10372 saved_last_point_position_buffer
= last_point_position_buffer
;
10373 saved_last_point_position
= last_point_position
;
10374 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10376 function
= call0 (intern ("read-extended-command"));
10378 #ifdef HAVE_WINDOW_SYSTEM
10379 if (hstarted
) start_hourglass ();
10382 if (STRINGP (function
) && SCHARS (function
) == 0)
10383 error ("No command name given");
10385 /* Set this_command_keys to the concatenation of saved_keys and
10386 function, followed by a RET. */
10391 this_command_key_count
= 0;
10392 this_command_key_count_reset
= 0;
10393 this_single_command_key_start
= 0;
10395 keys
= XVECTOR (saved_keys
)->contents
;
10396 for (i
= 0; i
< ASIZE (saved_keys
); i
++)
10397 add_command_key (keys
[i
]);
10399 for (i
= 0; i
< SCHARS (function
); i
++)
10400 add_command_key (Faref (function
, make_number (i
)));
10402 add_command_key (make_number ('\015'));
10405 last_point_position
= saved_last_point_position
;
10406 last_point_position_buffer
= saved_last_point_position_buffer
;
10410 function
= Fintern (function
, Qnil
);
10411 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10412 Vthis_command
= function
;
10413 real_this_command
= function
;
10415 /* If enabled, show which key runs this command. */
10416 if (!NILP (Vsuggest_key_bindings
)
10417 && NILP (Vexecuting_kbd_macro
)
10418 && SYMBOLP (function
))
10419 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10425 GCPRO3 (bindings
, value
, function
);
10426 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10428 /* If the command has a key binding, print it now. */
10429 if (!NILP (bindings
)
10430 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10433 /* But first wait, and skip the message if there is input. */
10434 Lisp_Object waited
;
10436 /* If this command displayed something in the echo area;
10437 wait a few seconds, then display our suggestion message. */
10438 if (NILP (echo_area_buffer
[0]))
10439 waited
= sit_for (make_number (0), 0, 2);
10440 else if (NUMBERP (Vsuggest_key_bindings
))
10441 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10443 waited
= sit_for (make_number (2), 0, 2);
10445 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10447 Lisp_Object binding
;
10449 int message_p
= push_message ();
10450 ptrdiff_t count
= SPECPDL_INDEX ();
10451 ptrdiff_t newmessage_len
, newmessage_alloc
;
10454 record_unwind_protect (pop_message_unwind
, Qnil
);
10455 binding
= Fkey_description (bindings
, Qnil
);
10457 (sizeof "You can run the command `' with "
10458 + SBYTES (SYMBOL_NAME (function
)) + SBYTES (binding
));
10459 SAFE_ALLOCA (newmessage
, char *, newmessage_alloc
);
10461 esprintf (newmessage
, "You can run the command `%s' with %s",
10462 SDATA (SYMBOL_NAME (function
)),
10464 message2 (newmessage
,
10466 STRING_MULTIBYTE (binding
));
10467 if (NUMBERP (Vsuggest_key_bindings
))
10468 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10470 waited
= sit_for (make_number (2), 0, 2);
10472 if (!NILP (waited
) && message_p
)
10473 restore_message ();
10476 unbind_to (count
, Qnil
);
10480 RETURN_UNGCPRO (value
);
10484 /* Return nonzero if input events are pending. */
10487 detect_input_pending (void)
10489 if (!input_pending
)
10490 get_input_pending (&input_pending
, 0);
10492 return input_pending
;
10495 /* Return nonzero if input events other than mouse movements are
10499 detect_input_pending_ignore_squeezables (void)
10501 if (!input_pending
)
10502 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10504 return input_pending
;
10507 /* Return nonzero if input events are pending, and run any pending timers. */
10510 detect_input_pending_run_timers (int do_display
)
10512 int old_timers_run
= timers_run
;
10514 if (!input_pending
)
10515 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10517 if (old_timers_run
!= timers_run
&& do_display
)
10519 redisplay_preserve_echo_area (8);
10520 /* The following fixes a bug when using lazy-lock with
10521 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10522 from an idle timer function. The symptom of the bug is that
10523 the cursor sometimes doesn't become visible until the next X
10524 event is processed. --gerd. */
10526 Lisp_Object tail
, frame
;
10527 FOR_EACH_FRAME (tail
, frame
)
10528 if (FRAME_RIF (XFRAME (frame
)))
10529 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10533 return input_pending
;
10536 /* This is called in some cases before a possible quit.
10537 It cases the next call to detect_input_pending to recompute input_pending.
10538 So calling this function unnecessarily can't do any harm. */
10541 clear_input_pending (void)
10546 /* Return nonzero if there are pending requeued events.
10547 This isn't used yet. The hope is to make wait_reading_process_output
10548 call it, and return if it runs Lisp code that unreads something.
10549 The problem is, kbd_buffer_get_event needs to be fixed to know what
10550 to do in that case. It isn't trivial. */
10553 requeued_events_pending_p (void)
10555 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10559 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10560 doc
: /* Return t if command input is currently available with no wait.
10561 Actually, the value is nil only if we can be sure that no input is available;
10562 if there is a doubt, the value is t. */)
10565 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10566 || !NILP (Vunread_post_input_method_events
)
10567 || !NILP (Vunread_input_method_events
))
10570 /* Process non-user-visible events (Bug#10195). */
10571 process_special_events ();
10573 get_input_pending (&input_pending
,
10574 READABLE_EVENTS_DO_TIMERS_NOW
10575 | READABLE_EVENTS_FILTER_EVENTS
);
10576 return input_pending
> 0 ? Qt
: Qnil
;
10579 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10580 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10583 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10586 if (total_keys
< NUM_RECENT_KEYS
)
10587 return Fvector (total_keys
, keys
);
10590 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10591 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10592 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10593 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10594 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10599 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10600 doc
: /* Return the key sequence that invoked this command.
10601 However, if the command has called `read-key-sequence', it returns
10602 the last key sequence that has been read.
10603 The value is a string or a vector.
10605 See also `this-command-keys-vector'. */)
10608 return make_event_array (this_command_key_count
,
10609 XVECTOR (this_command_keys
)->contents
);
10612 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10613 doc
: /* Return the key sequence that invoked this command, as a vector.
10614 However, if the command has called `read-key-sequence', it returns
10615 the last key sequence that has been read.
10617 See also `this-command-keys'. */)
10620 return Fvector (this_command_key_count
,
10621 XVECTOR (this_command_keys
)->contents
);
10624 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10625 Sthis_single_command_keys
, 0, 0, 0,
10626 doc
: /* Return the key sequence that invoked this command.
10627 More generally, it returns the last key sequence read, either by
10628 the command loop or by `read-key-sequence'.
10629 Unlike `this-command-keys', this function's value
10630 does not include prefix arguments.
10631 The value is always a vector. */)
10634 return Fvector (this_command_key_count
10635 - this_single_command_key_start
,
10636 (XVECTOR (this_command_keys
)->contents
10637 + this_single_command_key_start
));
10640 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10641 Sthis_single_command_raw_keys
, 0, 0, 0,
10642 doc
: /* Return the raw events that were read for this command.
10643 More generally, it returns the last key sequence read, either by
10644 the command loop or by `read-key-sequence'.
10645 Unlike `this-single-command-keys', this function's value
10646 shows the events before all translations (except for input methods).
10647 The value is always a vector. */)
10650 return Fvector (raw_keybuf_count
,
10651 (XVECTOR (raw_keybuf
)->contents
));
10654 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10655 Sreset_this_command_lengths
, 0, 0, 0,
10656 doc
: /* Make the unread events replace the last command and echo.
10657 Used in `universal-argument-other-key'.
10659 `universal-argument-other-key' rereads the event just typed.
10660 It then gets translated through `function-key-map'.
10661 The translated event has to replace the real events,
10662 both in the value of (this-command-keys) and in echoing.
10663 To achieve this, `universal-argument-other-key' calls
10664 `reset-this-command-lengths', which discards the record of reading
10665 these events the first time. */)
10668 this_command_key_count
= before_command_key_count
;
10669 if (this_command_key_count
< this_single_command_key_start
)
10670 this_single_command_key_start
= this_command_key_count
;
10672 echo_truncate (before_command_echo_length
);
10674 /* Cause whatever we put into unread-command-events
10675 to echo as if it were being freshly read from the keyboard. */
10676 this_command_key_count_reset
= 1;
10681 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10682 Sclear_this_command_keys
, 0, 1, 0,
10683 doc
: /* Clear out the vector that `this-command-keys' returns.
10684 Also clear the record of the last 100 events, unless optional arg
10685 KEEP-RECORD is non-nil. */)
10686 (Lisp_Object keep_record
)
10690 this_command_key_count
= 0;
10691 this_command_key_count_reset
= 0;
10693 if (NILP (keep_record
))
10695 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10696 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10698 recent_keys_index
= 0;
10703 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10704 doc
: /* Return the current depth in recursive edits. */)
10708 /* Wrap around reliably on integer overflow. */
10709 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10710 XSETINT (temp
, sum
);
10714 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10715 "FOpen dribble file: ",
10716 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10717 If FILE is nil, close any open dribble file.
10718 The file will be closed when Emacs exits. */)
10730 file
= Fexpand_file_name (file
, Qnil
);
10731 dribble
= fopen (SSDATA (file
), "w");
10733 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10738 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10739 doc
: /* Discard the contents of the terminal input buffer.
10740 Also end any kbd macro being defined. */)
10743 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10745 /* Discard the last command from the macro. */
10746 Fcancel_kbd_macro_events ();
10750 update_mode_lines
++;
10752 Vunread_command_events
= Qnil
;
10753 unread_command_char
= -1;
10755 discard_tty_input ();
10757 kbd_fetch_ptr
= kbd_store_ptr
;
10763 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10764 doc
: /* Stop Emacs and return to superior process. You can resume later.
10765 If `cannot-suspend' is non-nil, or if the system doesn't support job
10766 control, run a subshell instead.
10768 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10769 to be read as terminal input by Emacs's parent, after suspension.
10771 Before suspending, run the normal hook `suspend-hook'.
10772 After resumption run the normal hook `suspend-resume-hook'.
10774 Some operating systems cannot stop the Emacs process and resume it later.
10775 On such systems, Emacs starts a subshell instead of suspending. */)
10776 (Lisp_Object stuffstring
)
10778 ptrdiff_t count
= SPECPDL_INDEX ();
10779 int old_height
, old_width
;
10781 struct gcpro gcpro1
;
10784 if (tty_list
&& tty_list
->next
)
10785 error ("There are other tty frames open; close them before suspending Emacs");
10787 if (!NILP (stuffstring
))
10788 CHECK_STRING (stuffstring
);
10790 /* Run the functions in suspend-hook. */
10791 hook
= intern ("suspend-hook");
10792 Frun_hooks (1, &hook
);
10794 GCPRO1 (stuffstring
);
10795 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10796 reset_all_sys_modes ();
10797 /* sys_suspend can get an error if it tries to fork a subshell
10798 and the system resources aren't available for that. */
10799 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10801 stuff_buffered_input (stuffstring
);
10802 if (cannot_suspend
)
10806 unbind_to (count
, Qnil
);
10808 /* Check if terminal/window size has changed.
10809 Note that this is not useful when we are running directly
10810 with a window system; but suspend should be disabled in that case. */
10811 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10812 if (width
!= old_width
|| height
!= old_height
)
10813 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10815 /* Run suspend-resume-hook. */
10816 hook
= intern ("suspend-resume-hook");
10817 Frun_hooks (1, &hook
);
10823 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10824 Then in any case stuff anything Emacs has read ahead and not used. */
10827 stuff_buffered_input (Lisp_Object stuffstring
)
10829 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10830 register unsigned char *p
;
10832 if (STRINGP (stuffstring
))
10834 register ptrdiff_t count
;
10836 p
= SDATA (stuffstring
);
10837 count
= SBYTES (stuffstring
);
10838 while (count
-- > 0)
10843 /* Anything we have read ahead, put back for the shell to read. */
10844 /* ?? What should this do when we have multiple keyboards??
10845 Should we ignore anything that was typed in at the "wrong" kboard?
10847 rms: we should stuff everything back into the kboard
10849 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10852 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10853 kbd_fetch_ptr
= kbd_buffer
;
10854 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10855 stuff_char (kbd_fetch_ptr
->code
);
10857 clear_event (kbd_fetch_ptr
);
10861 #endif /* SIGTSTP */
10865 set_waiting_for_input (struct timeval
*time_to_clear
)
10867 input_available_clear_time
= time_to_clear
;
10869 /* Tell handle_interrupt to throw back to read_char, */
10870 waiting_for_input
= 1;
10872 /* If handle_interrupt was called before and buffered a C-g,
10873 make it run again now, to avoid timing error. */
10874 if (!NILP (Vquit_flag
))
10875 quit_throw_to_read_char (0);
10879 clear_waiting_for_input (void)
10881 /* Tell handle_interrupt not to throw back to read_char, */
10882 waiting_for_input
= 0;
10883 input_available_clear_time
= 0;
10886 /* The SIGINT handler.
10888 If we have a frame on the controlling tty, we assume that the
10889 SIGINT was generated by C-g, so we call handle_interrupt.
10890 Otherwise, tell QUIT to kill Emacs. */
10893 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10894 /* compilers complain in signal calls. */
10896 /* Must preserve main program's value of errno. */
10897 int old_errno
= errno
;
10898 struct terminal
*terminal
;
10900 SIGNAL_THREAD_CHECK (signalnum
);
10902 /* See if we have an active terminal on our controlling tty. */
10903 terminal
= get_named_tty ("/dev/tty");
10906 /* If there are no frames there, let's pretend that we are a
10907 well-behaving UN*X program and quit. We must not call Lisp
10908 in a signal handler, so tell QUIT to exit when it is
10910 Vquit_flag
= Qkill_emacs
;
10914 /* Otherwise, the SIGINT was probably generated by C-g. */
10916 /* Set internal_last_event_frame to the top frame of the
10917 controlling tty, if we have a frame there. We disable the
10918 interrupt key on secondary ttys, so the SIGINT must have come
10919 from the controlling tty. */
10920 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10922 handle_interrupt ();
10928 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10929 of the number of times C-g has been requested. If C-g is pressed
10930 enough times, then quit anyway. See bug#6585. */
10931 static int force_quit_count
;
10933 /* This routine is called at interrupt level in response to C-g.
10935 It is called from the SIGINT handler or kbd_buffer_store_event.
10937 If `waiting_for_input' is non zero, then unless `echoing' is
10938 nonzero, immediately throw back to read_char.
10940 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10941 eval to throw, when it gets a chance. If quit-flag is already
10942 non-nil, it stops the job right away. */
10945 handle_interrupt (void)
10951 /* XXX This code needs to be revised for multi-tty support. */
10952 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10954 /* If SIGINT isn't blocked, don't let us be interrupted by
10955 another SIGINT, it might be harmful due to non-reentrancy
10956 in I/O functions. */
10957 sigblock (sigmask (SIGINT
));
10960 reset_all_sys_modes ();
10962 #ifdef SIGTSTP /* Support possible in later USG versions */
10964 * On systems which can suspend the current process and return to the original
10965 * shell, this command causes the user to end up back at the shell.
10966 * The "Auto-save" and "Abort" questions are not asked until
10967 * the user elects to return to emacs, at which point he can save the current
10968 * job and either dump core or continue.
10972 /* Perhaps should really fork an inferior shell?
10973 But that would not provide any way to get back
10974 to the original shell, ever. */
10975 printf ("No support for stopping a process on this operating system;\n");
10976 printf ("you can continue or abort.\n");
10977 #endif /* not SIGTSTP */
10979 /* We must remain inside the screen area when the internal terminal
10980 is used. Note that [Enter] is not echoed by dos. */
10981 cursor_to (SELECTED_FRAME (), 0, 0);
10983 /* It doesn't work to autosave while GC is in progress;
10984 the code used for auto-saving doesn't cope with the mark bit. */
10985 if (!gc_in_progress
)
10987 printf ("Auto-save? (y or n) ");
10989 if (((c
= getchar ()) & ~040) == 'Y')
10991 Fdo_auto_save (Qt
, Qnil
);
10993 printf ("\r\nAuto-save done");
10994 #else /* not MSDOS */
10995 printf ("Auto-save done\n");
10996 #endif /* not MSDOS */
10998 while (c
!= '\n') c
= getchar ();
11002 /* During GC, it must be safe to reenable quitting again. */
11003 Vinhibit_quit
= Qnil
;
11006 #endif /* not MSDOS */
11007 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11008 printf ("but will instead do a real quit after garbage collection ends\r\n");
11013 printf ("\r\nAbort? (y or n) ");
11014 #else /* not MSDOS */
11015 printf ("Abort (and dump core)? (y or n) ");
11016 #endif /* not MSDOS */
11018 if (((c
= getchar ()) & ~040) == 'Y')
11020 while (c
!= '\n') c
= getchar ();
11022 printf ("\r\nContinuing...\r\n");
11023 #else /* not MSDOS */
11024 printf ("Continuing...\n");
11025 #endif /* not MSDOS */
11027 init_all_sys_modes ();
11032 /* If executing a function that wants to be interrupted out of
11033 and the user has not deferred quitting by binding `inhibit-quit'
11034 then quit right away. */
11035 if (immediate_quit
&& NILP (Vinhibit_quit
))
11037 struct gl_state_s saved
;
11038 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11040 immediate_quit
= 0;
11043 GCPRO4 (saved
.object
, saved
.global_code
,
11044 saved
.current_syntax_table
, saved
.old_prop
);
11045 Fsignal (Qquit
, Qnil
);
11046 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11051 { /* Else request quit when it's safe. */
11052 if (NILP (Vquit_flag
))
11053 force_quit_count
= 0;
11054 if (++force_quit_count
== 3)
11056 immediate_quit
= 1;
11057 Vinhibit_quit
= Qnil
;
11063 /* TODO: The longjmp in this call throws the NS event loop integration off,
11064 and it seems to do fine without this. Probably some attention
11065 needs to be paid to the setting of waiting_for_input in
11066 wait_reading_process_output() under HAVE_NS because of the call
11067 to ns_select there (needed because otherwise events aren't picked up
11068 outside of polling since we don't get SIGIO like X and we don't have a
11069 separate event loop thread like W32. */
11071 if (waiting_for_input
&& !echoing
)
11072 quit_throw_to_read_char (1);
11076 /* Handle a C-g by making read_char return C-g. */
11079 quit_throw_to_read_char (int from_signal
)
11081 /* When not called from a signal handler it is safe to call
11083 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
11084 Fkill_emacs (Qnil
);
11087 /* Prevent another signal from doing this before we finish. */
11088 clear_waiting_for_input ();
11091 Vunread_command_events
= Qnil
;
11092 unread_command_char
= -1;
11094 #if 0 /* Currently, sit_for is called from read_char without turning
11095 off polling. And that can call set_waiting_for_input.
11096 It seems to be harmless. */
11097 #ifdef POLL_FOR_INPUT
11098 /* May be > 1 if in recursive minibuffer. */
11099 if (poll_suppress_count
== 0)
11103 if (FRAMEP (internal_last_event_frame
)
11104 && !EQ (internal_last_event_frame
, selected_frame
))
11105 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11108 _longjmp (getcjmp
, 1);
11111 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
11112 Sset_input_interrupt_mode
, 1, 1, 0,
11113 doc
: /* Set interrupt mode of reading keyboard input.
11114 If INTERRUPT is non-nil, Emacs will use input interrupts;
11115 otherwise Emacs uses CBREAK mode.
11117 See also `current-input-mode'. */)
11118 (Lisp_Object interrupt
)
11120 int new_interrupt_input
;
11122 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11123 #ifdef HAVE_X_WINDOWS
11124 if (x_display_list
!= NULL
)
11126 /* When using X, don't give the user a real choice,
11127 because we haven't implemented the mechanisms to support it. */
11128 new_interrupt_input
= 1;
11131 #endif /* HAVE_X_WINDOWS */
11132 new_interrupt_input
= !NILP (interrupt
);
11133 #else /* not SIGIO */
11134 new_interrupt_input
= 0;
11135 #endif /* not SIGIO */
11137 if (new_interrupt_input
!= interrupt_input
)
11139 #ifdef POLL_FOR_INPUT
11143 /* this causes startup screen to be restored and messes with the mouse */
11144 reset_all_sys_modes ();
11145 interrupt_input
= new_interrupt_input
;
11146 init_all_sys_modes ();
11148 interrupt_input
= new_interrupt_input
;
11151 #ifdef POLL_FOR_INPUT
11152 poll_suppress_count
= 1;
11159 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11160 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11161 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11162 C-q in key sequences.
11164 This setting only has an effect on tty terminals and only when
11165 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11167 See also `current-input-mode'. */)
11168 (Lisp_Object flow
, Lisp_Object terminal
)
11170 struct terminal
*t
= get_terminal (terminal
, 1);
11171 struct tty_display_info
*tty
;
11172 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11174 tty
= t
->display_info
.tty
;
11176 if (tty
->flow_control
!= !NILP (flow
))
11179 /* this causes startup screen to be restored and messes with the mouse */
11180 reset_sys_modes (tty
);
11183 tty
->flow_control
= !NILP (flow
);
11186 init_sys_modes (tty
);
11192 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11193 doc
: /* Enable or disable 8-bit input on TERMINAL.
11194 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11195 bit as the Meta modifier.
11197 If META is nil, Emacs will ignore the top bit, on the assumption it is
11200 Otherwise, Emacs will accept and pass through 8-bit input without
11201 specially interpreting the top bit.
11203 This setting only has an effect on tty terminal devices.
11205 Optional parameter TERMINAL specifies the tty terminal device to use.
11206 It may be a terminal object, a frame, or nil for the terminal used by
11207 the currently selected frame.
11209 See also `current-input-mode'. */)
11210 (Lisp_Object meta
, Lisp_Object terminal
)
11212 struct terminal
*t
= get_terminal (terminal
, 1);
11213 struct tty_display_info
*tty
;
11216 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11218 tty
= t
->display_info
.tty
;
11222 else if (EQ (meta
, Qt
))
11227 if (tty
->meta_key
!= new_meta
)
11230 /* this causes startup screen to be restored and messes with the mouse */
11231 reset_sys_modes (tty
);
11234 tty
->meta_key
= new_meta
;
11237 init_sys_modes (tty
);
11243 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11244 doc
: /* Specify character used for quitting.
11245 QUIT must be an ASCII character.
11247 This function only has an effect on the controlling tty of the Emacs
11250 See also `current-input-mode'. */)
11253 struct terminal
*t
= get_named_tty ("/dev/tty");
11254 struct tty_display_info
*tty
;
11255 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11257 tty
= t
->display_info
.tty
;
11259 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11260 error ("QUIT must be an ASCII character");
11263 /* this causes startup screen to be restored and messes with the mouse */
11264 reset_sys_modes (tty
);
11267 /* Don't let this value be out of range. */
11268 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11271 init_sys_modes (tty
);
11277 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11278 doc
: /* Set mode of reading keyboard input.
11279 First arg INTERRUPT non-nil means use input interrupts;
11280 nil means use CBREAK mode.
11281 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11282 (no effect except in CBREAK mode).
11283 Third arg META t means accept 8-bit input (for a Meta key).
11284 META nil means ignore the top bit, on the assumption it is parity.
11285 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11286 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11287 See also `current-input-mode'. */)
11288 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11290 Fset_input_interrupt_mode (interrupt
);
11291 Fset_output_flow_control (flow
, Qnil
);
11292 Fset_input_meta_mode (meta
, Qnil
);
11294 Fset_quit_char (quit
);
11298 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11299 doc
: /* Return information about the way Emacs currently reads keyboard input.
11300 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11301 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11302 nil, Emacs is using CBREAK mode.
11303 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11304 terminal; this does not apply if Emacs uses interrupt-driven input.
11305 META is t if accepting 8-bit input with 8th bit as Meta flag.
11306 META nil means ignoring the top bit, on the assumption it is parity.
11307 META is neither t nor nil if accepting 8-bit input and using
11308 all 8 bits as the character code.
11309 QUIT is the character Emacs currently uses to quit.
11310 The elements of this list correspond to the arguments of
11311 `set-input-mode'. */)
11314 Lisp_Object val
[4];
11315 struct frame
*sf
= XFRAME (selected_frame
);
11317 val
[0] = interrupt_input
? Qt
: Qnil
;
11318 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11320 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11321 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11323 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11330 XSETFASTINT (val
[3], quit_char
);
11332 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11335 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11336 doc
: /* Return position information for pixel coordinates X and Y.
11337 By default, X and Y are relative to text area of the selected window.
11338 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11339 If optional fourth arg WHOLE is non-nil, X is relative to the left
11340 edge of the window.
11342 The return value is similar to a mouse click position:
11343 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11344 IMAGE (DX . DY) (WIDTH . HEIGHT))
11345 The `posn-' functions access elements of such lists. */)
11346 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11351 if (NILP (frame_or_window
))
11352 frame_or_window
= selected_window
;
11354 if (WINDOWP (frame_or_window
))
11358 CHECK_LIVE_WINDOW (frame_or_window
);
11360 w
= XWINDOW (frame_or_window
);
11361 XSETINT (x
, (XINT (x
)
11362 + WINDOW_LEFT_EDGE_X (w
)
11364 ? window_box_left_offset (w
, TEXT_AREA
)
11366 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11367 frame_or_window
= w
->frame
;
11370 CHECK_LIVE_FRAME (frame_or_window
);
11372 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11375 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11376 doc
: /* Return position information for buffer POS in WINDOW.
11377 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11379 Return nil if position is not visible in window. Otherwise,
11380 the return value is similar to that returned by `event-start' for
11381 a mouse click at the upper left corner of the glyph corresponding
11382 to the given buffer position:
11383 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11384 IMAGE (DX . DY) (WIDTH . HEIGHT))
11385 The `posn-' functions access elements of such lists. */)
11386 (Lisp_Object pos
, Lisp_Object window
)
11391 window
= selected_window
;
11393 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11396 Lisp_Object x
= XCAR (tem
);
11397 Lisp_Object y
= XCAR (XCDR (tem
));
11399 /* Point invisible due to hscrolling? */
11402 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11410 * Set up a new kboard object with reasonable initial values.
11413 init_kboard (KBOARD
*kb
)
11415 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11416 KVAR (kb
, Vlast_command
) = Qnil
;
11417 KVAR (kb
, Vreal_last_command
) = Qnil
;
11418 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11419 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11420 KVAR (kb
, Vprefix_arg
) = Qnil
;
11421 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11422 KVAR (kb
, kbd_queue
) = Qnil
;
11423 kb
->kbd_queue_has_data
= 0;
11424 kb
->immediate_echo
= 0;
11425 KVAR (kb
, echo_string
) = Qnil
;
11426 kb
->echo_after_prompt
= -1;
11427 kb
->kbd_macro_buffer
= 0;
11428 kb
->kbd_macro_bufsize
= 0;
11429 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11430 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11431 kb
->reference_count
= 0;
11432 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11433 KVAR (kb
, system_key_syms
) = Qnil
;
11434 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11435 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11436 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11437 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11438 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11442 * Destroy the contents of a kboard object, but not the object itself.
11443 * We use this just before deleting it, or if we're going to initialize
11444 * it a second time.
11447 wipe_kboard (KBOARD
*kb
)
11449 xfree (kb
->kbd_macro_buffer
);
11452 /* Free KB and memory referenced from it. */
11455 delete_kboard (KBOARD
*kb
)
11459 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11462 *kbp
= kb
->next_kboard
;
11464 /* Prevent a dangling reference to KB. */
11465 if (kb
== current_kboard
11466 && FRAMEP (selected_frame
)
11467 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11469 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11471 if (current_kboard
== kb
)
11480 init_keyboard (void)
11482 /* This is correct before outermost invocation of the editor loop */
11483 command_loop_level
= -1;
11484 immediate_quit
= 0;
11485 quit_char
= Ctl ('g');
11486 Vunread_command_events
= Qnil
;
11487 unread_command_char
= -1;
11488 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11490 recent_keys_index
= 0;
11491 kbd_fetch_ptr
= kbd_buffer
;
11492 kbd_store_ptr
= kbd_buffer
;
11493 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11494 do_mouse_tracking
= Qnil
;
11497 interrupt_input_blocked
= 0;
11498 interrupt_input_pending
= 0;
11500 pending_signals
= 0;
11503 /* This means that command_loop_1 won't try to select anything the first
11505 internal_last_event_frame
= Qnil
;
11506 Vlast_event_frame
= internal_last_event_frame
;
11508 current_kboard
= initial_kboard
;
11509 /* Re-initialize the keyboard again. */
11510 wipe_kboard (current_kboard
);
11511 init_kboard (current_kboard
);
11512 /* A value of nil for Vwindow_system normally means a tty, but we also use
11513 it for the initial terminal since there is no window system there. */
11514 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11516 if (!noninteractive
)
11518 /* Before multi-tty support, these handlers used to be installed
11519 only if the current session was a tty session. Now an Emacs
11520 session may have multiple display types, so we always handle
11521 SIGINT. There is special code in interrupt_signal to exit
11522 Emacs on SIGINT when there are no termcap frames on the
11523 controlling terminal. */
11524 signal (SIGINT
, interrupt_signal
);
11526 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11527 SIGQUIT and we can't tell which one it will give us. */
11528 signal (SIGQUIT
, interrupt_signal
);
11529 #endif /* not DOS_NT */
11531 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11533 if (!noninteractive
)
11534 signal (SIGIO
, input_available_signal
);
11537 /* Use interrupt input by default, if it works and noninterrupt input
11538 has deficiencies. */
11540 #ifdef INTERRUPT_INPUT
11541 interrupt_input
= 1;
11543 interrupt_input
= 0;
11549 if (keyboard_init_hook
)
11550 (*keyboard_init_hook
) ();
11552 #ifdef POLL_FOR_INPUT
11554 poll_suppress_count
= 1;
11559 /* This type's only use is in syms_of_keyboard, to initialize the
11560 event header symbols and put properties on them. */
11561 struct event_head
{
11567 static const struct event_head head_table
[] = {
11568 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11569 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11570 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11571 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11572 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11573 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11574 /* `select-window' should be handled just like `switch-frame'
11575 in read_key_sequence. */
11576 {&Qselect_window
, "select-window", &Qswitch_frame
}
11580 syms_of_keyboard (void)
11582 pending_funcalls
= Qnil
;
11583 staticpro (&pending_funcalls
);
11585 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11586 staticpro (&Vlispy_mouse_stem
);
11589 DEFSYM (QCimage
, ":image");
11590 DEFSYM (Qhelp_echo
, "help-echo");
11591 DEFSYM (QCrtl
, ":rtl");
11593 staticpro (&item_properties
);
11594 item_properties
= Qnil
;
11596 staticpro (&tool_bar_item_properties
);
11597 tool_bar_item_properties
= Qnil
;
11598 staticpro (&tool_bar_items_vector
);
11599 tool_bar_items_vector
= Qnil
;
11601 staticpro (&real_this_command
);
11602 real_this_command
= Qnil
;
11604 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11605 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11606 DEFSYM (Qself_insert_command
, "self-insert-command");
11607 DEFSYM (Qforward_char
, "forward-char");
11608 DEFSYM (Qbackward_char
, "backward-char");
11609 DEFSYM (Qdisabled
, "disabled");
11610 DEFSYM (Qundefined
, "undefined");
11611 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11612 DEFSYM (Qpost_command_hook
, "post-command-hook");
11613 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11614 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11615 DEFSYM (Qfunction_key
, "function-key");
11616 DEFSYM (Qmouse_click
, "mouse-click");
11617 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11618 DEFSYM (Qsave_session
, "save-session");
11619 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11620 DEFSYM (Qmenu_enable
, "menu-enable");
11622 #if defined (WINDOWSNT)
11623 DEFSYM (Qlanguage_change
, "language-change");
11627 DEFSYM (Qdbus_event
, "dbus-event");
11630 DEFSYM (QCenable
, ":enable");
11631 DEFSYM (QCvisible
, ":visible");
11632 DEFSYM (QChelp
, ":help");
11633 DEFSYM (QCfilter
, ":filter");
11634 DEFSYM (QCbutton
, ":button");
11635 DEFSYM (QCkeys
, ":keys");
11636 DEFSYM (QCkey_sequence
, ":key-sequence");
11637 DEFSYM (QCtoggle
, ":toggle");
11638 DEFSYM (QCradio
, ":radio");
11639 DEFSYM (QClabel
, ":label");
11640 DEFSYM (QCvert_only
, ":vert-only");
11642 DEFSYM (Qmode_line
, "mode-line");
11643 DEFSYM (Qvertical_line
, "vertical-line");
11644 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11645 DEFSYM (Qmenu_bar
, "menu-bar");
11647 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11648 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11651 DEFSYM (Qabove_handle
, "above-handle");
11652 DEFSYM (Qhandle
, "handle");
11653 DEFSYM (Qbelow_handle
, "below-handle");
11654 DEFSYM (Qup
, "up");
11655 DEFSYM (Qdown
, "down");
11656 DEFSYM (Qtop
, "top");
11657 DEFSYM (Qbottom
, "bottom");
11658 DEFSYM (Qend_scroll
, "end-scroll");
11659 DEFSYM (Qratio
, "ratio");
11661 DEFSYM (Qevent_kind
, "event-kind");
11662 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11663 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11664 DEFSYM (Qmodifier_cache
, "modifier-cache");
11666 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11667 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11669 DEFSYM (Qpolling_period
, "polling-period");
11671 DEFSYM (Qx_set_selection
, "x-set-selection");
11672 DEFSYM (QPRIMARY
, "PRIMARY");
11673 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11674 DEFSYM (Qhandle_select_window
, "handle-select-window");
11676 DEFSYM (Qinput_method_function
, "input-method-function");
11677 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11678 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11680 DEFSYM (Qhelp_form_show
, "help-form-show");
11682 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11683 Fset (Qinput_method_use_echo_area
, Qnil
);
11685 last_point_position_buffer
= Qnil
;
11686 last_point_position_window
= Qnil
;
11690 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11692 for (i
= 0; i
< len
; i
++)
11694 const struct event_head
*p
= &head_table
[i
];
11695 *p
->var
= intern_c_string (p
->name
);
11696 staticpro (p
->var
);
11697 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11698 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11702 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11703 staticpro (&button_down_location
);
11704 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11705 staticpro (&mouse_syms
);
11706 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11707 / sizeof (lispy_wheel_names
[0])),
11709 staticpro (&wheel_syms
);
11713 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11715 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11716 for (i
= 0; i
< len
; i
++)
11717 if (modifier_names
[i
])
11718 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11719 staticpro (&modifier_symbols
);
11722 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11723 staticpro (&recent_keys
);
11725 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11726 staticpro (&this_command_keys
);
11728 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11729 staticpro (&raw_keybuf
);
11731 DEFSYM (Qextended_command_history
, "extended-command-history");
11732 Fset (Qextended_command_history
, Qnil
);
11734 accent_key_syms
= Qnil
;
11735 staticpro (&accent_key_syms
);
11737 func_key_syms
= Qnil
;
11738 staticpro (&func_key_syms
);
11740 drag_n_drop_syms
= Qnil
;
11741 staticpro (&drag_n_drop_syms
);
11743 unread_switch_frame
= Qnil
;
11744 staticpro (&unread_switch_frame
);
11746 internal_last_event_frame
= Qnil
;
11747 staticpro (&internal_last_event_frame
);
11749 read_key_sequence_cmd
= Qnil
;
11750 staticpro (&read_key_sequence_cmd
);
11751 read_key_sequence_remapped
= Qnil
;
11752 staticpro (&read_key_sequence_remapped
);
11754 menu_bar_one_keymap_changed_items
= Qnil
;
11755 staticpro (&menu_bar_one_keymap_changed_items
);
11757 menu_bar_items_vector
= Qnil
;
11758 staticpro (&menu_bar_items_vector
);
11760 help_form_saved_window_configs
= Qnil
;
11761 staticpro (&help_form_saved_window_configs
);
11763 defsubr (&Scurrent_idle_time
);
11764 defsubr (&Sevent_symbol_parse_modifiers
);
11765 defsubr (&Sevent_convert_list
);
11766 defsubr (&Sread_key_sequence
);
11767 defsubr (&Sread_key_sequence_vector
);
11768 defsubr (&Srecursive_edit
);
11769 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11770 defsubr (&Strack_mouse
);
11772 defsubr (&Sinput_pending_p
);
11773 defsubr (&Scommand_execute
);
11774 defsubr (&Srecent_keys
);
11775 defsubr (&Sthis_command_keys
);
11776 defsubr (&Sthis_command_keys_vector
);
11777 defsubr (&Sthis_single_command_keys
);
11778 defsubr (&Sthis_single_command_raw_keys
);
11779 defsubr (&Sreset_this_command_lengths
);
11780 defsubr (&Sclear_this_command_keys
);
11781 defsubr (&Ssuspend_emacs
);
11782 defsubr (&Sabort_recursive_edit
);
11783 defsubr (&Sexit_recursive_edit
);
11784 defsubr (&Srecursion_depth
);
11785 defsubr (&Stop_level
);
11786 defsubr (&Sdiscard_input
);
11787 defsubr (&Sopen_dribble_file
);
11788 defsubr (&Sset_input_interrupt_mode
);
11789 defsubr (&Sset_output_flow_control
);
11790 defsubr (&Sset_input_meta_mode
);
11791 defsubr (&Sset_quit_char
);
11792 defsubr (&Sset_input_mode
);
11793 defsubr (&Scurrent_input_mode
);
11794 defsubr (&Sexecute_extended_command
);
11795 defsubr (&Sposn_at_point
);
11796 defsubr (&Sposn_at_x_y
);
11798 DEFVAR_LISP ("last-command-event", last_command_event
,
11799 doc
: /* Last input event that was part of a command. */);
11801 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11802 doc
: /* Last input event in a command, except for mouse menu events.
11803 Mouse menus give back keys that don't look like mouse events;
11804 this variable holds the actual mouse event that led to the menu,
11805 so that you can determine whether the command was run by mouse or not. */);
11807 DEFVAR_LISP ("last-input-event", last_input_event
,
11808 doc
: /* Last input event. */);
11810 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11811 doc
: /* List of events to be read as the command input.
11812 These events are processed first, before actual keyboard input.
11813 Events read from this list are not normally added to `this-command-keys',
11814 as they will already have been added once as they were read for the first time.
11815 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11816 Vunread_command_events
= Qnil
;
11818 DEFVAR_INT ("unread-command-char", unread_command_char
,
11819 doc
: /* If not -1, an object to be read as next command input event. */);
11821 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11822 doc
: /* List of events to be processed as input by input methods.
11823 These events are processed before `unread-command-events'
11824 and actual keyboard input, but are not given to `input-method-function'. */);
11825 Vunread_post_input_method_events
= Qnil
;
11827 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11828 doc
: /* List of events to be processed as input by input methods.
11829 These events are processed after `unread-command-events', but
11830 before actual keyboard input.
11831 If there's an active input method, the events are given to
11832 `input-method-function'. */);
11833 Vunread_input_method_events
= Qnil
;
11835 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11836 doc
: /* Meta-prefix character code.
11837 Meta-foo as command input turns into this character followed by foo. */);
11838 XSETINT (meta_prefix_char
, 033);
11840 DEFVAR_KBOARD ("last-command", Vlast_command
,
11841 doc
: /* The last command executed.
11842 Normally a symbol with a function definition, but can be whatever was found
11843 in the keymap, or whatever the variable `this-command' was set to by that
11846 The value `mode-exit' is special; it means that the previous command
11847 read an event that told it to exit, and it did so and unread that event.
11848 In other words, the present command is the event that made the previous
11851 The value `kill-region' is special; it means that the previous command
11852 was a kill command.
11854 `last-command' has a separate binding for each terminal device.
11855 See Info node `(elisp)Multiple Terminals'. */);
11857 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11858 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11860 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11861 doc
: /* Last command that may be repeated.
11862 The last command executed that was not bound to an input event.
11863 This is the command `repeat' will try to repeat. */);
11865 DEFVAR_LISP ("this-command", Vthis_command
,
11866 doc
: /* The command now being executed.
11867 The command can set this variable; whatever is put here
11868 will be in `last-command' during the following command. */);
11869 Vthis_command
= Qnil
;
11871 DEFVAR_LISP ("this-command-keys-shift-translated",
11872 Vthis_command_keys_shift_translated
,
11873 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11874 Shift-translation occurs when there is no binding for the key sequence
11875 as entered, but a binding was found by changing an upper-case letter
11876 to lower-case, or a shifted function key to an unshifted one. */);
11877 Vthis_command_keys_shift_translated
= Qnil
;
11879 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11880 doc
: /* The command bound to the current key sequence before remapping.
11881 It equals `this-command' if the original command was not remapped through
11882 any of the active keymaps. Otherwise, the value of `this-command' is the
11883 result of looking up the original command in the active keymaps. */);
11884 Vthis_original_command
= Qnil
;
11886 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11887 doc
: /* Number of input events between auto-saves.
11888 Zero means disable autosaving due to number of characters typed. */);
11889 auto_save_interval
= 300;
11891 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11892 doc
: /* Number of seconds idle time before auto-save.
11893 Zero or nil means disable auto-saving due to idleness.
11894 After auto-saving due to this many seconds of idle time,
11895 Emacs also does a garbage collection if that seems to be warranted. */);
11896 XSETFASTINT (Vauto_save_timeout
, 30);
11898 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11899 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11900 The value may be integer or floating point.
11901 If the value is zero, don't echo at all. */);
11902 Vecho_keystrokes
= make_number (1);
11904 DEFVAR_INT ("polling-period", polling_period
,
11905 doc
: /* Interval between polling for input during Lisp execution.
11906 The reason for polling is to make C-g work to stop a running program.
11907 Polling is needed only when using X windows and SIGIO does not work.
11908 Polling is automatically disabled in all other cases. */);
11909 polling_period
= 2;
11911 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11912 doc
: /* Maximum time between mouse clicks to make a double-click.
11913 Measured in milliseconds. The value nil means disable double-click
11914 recognition; t means double-clicks have no time limit and are detected
11915 by position only. */);
11916 Vdouble_click_time
= make_number (500);
11918 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11919 doc
: /* Maximum mouse movement between clicks to make a double-click.
11920 On window-system frames, value is the number of pixels the mouse may have
11921 moved horizontally or vertically between two clicks to make a double-click.
11922 On non window-system frames, value is interpreted in units of 1/8 characters
11925 This variable is also the threshold for motion of the mouse
11926 to count as a drag. */);
11927 double_click_fuzz
= 3;
11929 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11930 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11931 inhibit_local_menu_bar_menus
= 0;
11933 DEFVAR_INT ("num-input-keys", num_input_keys
,
11934 doc
: /* Number of complete key sequences read as input so far.
11935 This includes key sequences read from keyboard macros.
11936 The number is effectively the number of interactive command invocations. */);
11937 num_input_keys
= 0;
11939 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11940 doc
: /* Number of input events read from the keyboard so far.
11941 This does not include events generated by keyboard macros. */);
11942 num_nonmacro_input_events
= 0;
11944 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11945 doc
: /* The frame in which the most recently read event occurred.
11946 If the last event came from a keyboard macro, this is set to `macro'. */);
11947 Vlast_event_frame
= Qnil
;
11949 /* This variable is set up in sysdep.c. */
11950 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11951 doc
: /* The ERASE character as set by the user with stty. */);
11953 DEFVAR_LISP ("help-char", Vhelp_char
,
11954 doc
: /* Character to recognize as meaning Help.
11955 When it is read, do `(eval help-form)', and display result if it's a string.
11956 If the value of `help-form' is nil, this char can be read normally. */);
11957 XSETINT (Vhelp_char
, Ctl ('H'));
11959 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11960 doc
: /* List of input events to recognize as meaning Help.
11961 These work just like the value of `help-char' (see that). */);
11962 Vhelp_event_list
= Qnil
;
11964 DEFVAR_LISP ("help-form", Vhelp_form
,
11965 doc
: /* Form to execute when character `help-char' is read.
11966 If the form returns a string, that string is displayed.
11967 If `help-form' is nil, the help char is not recognized. */);
11970 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11971 doc
: /* Command to run when `help-char' character follows a prefix key.
11972 This command is used only when there is no actual binding
11973 for that character after that prefix key. */);
11974 Vprefix_help_command
= Qnil
;
11976 DEFVAR_LISP ("top-level", Vtop_level
,
11977 doc
: /* Form to evaluate when Emacs starts up.
11978 Useful to set before you dump a modified Emacs. */);
11981 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11982 doc
: /* Translate table for local keyboard input, or nil.
11983 If non-nil, the value should be a char-table. Each character read
11984 from the keyboard is looked up in this char-table. If the value found
11985 there is non-nil, then it is used instead of the actual input character.
11987 The value can also be a string or vector, but this is considered obsolete.
11988 If it is a string or vector of length N, character codes N and up are left
11989 untranslated. In a vector, an element which is nil means "no translation".
11991 This is applied to the characters supplied to input methods, not their
11992 output. See also `translation-table-for-input'.
11994 This variable has a separate binding for each terminal.
11995 See Info node `(elisp)Multiple Terminals'. */);
11997 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11998 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11999 \(Even if the operating system has support for stopping a process.\) */);
12000 cannot_suspend
= 0;
12002 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
12003 doc
: /* Non-nil means prompt with menus when appropriate.
12004 This is done when reading from a keymap that has a prompt string,
12005 for elements that have prompt strings.
12006 The menu is displayed on the screen
12007 if X menus were enabled at configuration
12008 time and the previous event was a mouse click prefix key.
12009 Otherwise, menu prompting uses the echo area. */);
12010 menu_prompting
= 1;
12012 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
12013 doc
: /* Character to see next line of menu prompt.
12014 Type this character while in a menu prompt to rotate around the lines of it. */);
12015 XSETINT (menu_prompt_more_char
, ' ');
12017 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
12018 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12019 Emacs applies the modifiers of the character stored here to each keyboard
12020 character it reads. For example, after evaluating the expression
12021 (setq extra-keyboard-modifiers ?\\C-x)
12022 all input characters will have the control modifier applied to them.
12024 Note that the character ?\\C-@, equivalent to the integer zero, does
12025 not count as a control character; rather, it counts as a character
12026 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12027 cancels any modification. */);
12028 extra_keyboard_modifiers
= 0;
12030 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
12031 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12032 The command loop sets this to nil before each command,
12033 and tests the value when the command returns.
12034 Buffer modification stores t in this variable. */);
12035 Vdeactivate_mark
= Qnil
;
12036 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
12038 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
12039 doc
: /* Normal hook run before each command is executed.
12040 If an unhandled error happens in running this hook,
12041 the function in which the error occurred is unconditionally removed, since
12042 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
12043 Vpre_command_hook
= Qnil
;
12045 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
12046 doc
: /* Normal hook run after each command is executed.
12047 If an unhandled error happens in running this hook,
12048 the function in which the error occurred is unconditionally removed, since
12049 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
12050 Vpost_command_hook
= Qnil
;
12053 DEFVAR_LISP ("echo-area-clear-hook", ...,
12054 doc
: /* Normal hook run when clearing the echo area. */);
12056 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
12057 Fset (Qecho_area_clear_hook
, Qnil
);
12059 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
12060 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12061 Vlucid_menu_bar_dirty_flag
= Qnil
;
12063 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
12064 doc
: /* List of menu bar items to move to the end of the menu bar.
12065 The elements of the list are event types that may have menu bar bindings. */);
12066 Vmenu_bar_final_items
= Qnil
;
12068 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
12069 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
12070 This is used internally by graphical displays that do not render
12071 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
12072 Vtool_bar_separator_image_expression
= Qnil
;
12074 DEFVAR_KBOARD ("overriding-terminal-local-map",
12075 Voverriding_terminal_local_map
,
12076 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12077 If this variable is non-nil, it is used as a keymap instead of the
12078 buffer's local map, and the minor mode keymaps and text property keymaps.
12079 It also replaces `overriding-local-map'.
12081 This variable is intended to let commands such as `universal-argument'
12082 set up a different keymap for reading the next command.
12084 `overriding-terminal-local-map' has a separate binding for each
12086 See Info node `(elisp)Multiple Terminals'. */);
12088 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
12089 doc
: /* Keymap that overrides all other local keymaps.
12090 If this variable is non-nil, it is used as a keymap--replacing the
12091 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12092 Voverriding_local_map
= Qnil
;
12094 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
12095 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12096 Otherwise, the menu bar continues to reflect the buffer's local map
12097 and the minor mode maps regardless of `overriding-local-map'. */);
12098 Voverriding_local_map_menu_flag
= Qnil
;
12100 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12101 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12102 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12104 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12105 doc
: /* Non-nil means generate motion events for mouse motion. */);
12107 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12108 doc
: /* Alist of system-specific X windows key symbols.
12109 Each element should have the form (N . SYMBOL) where N is the
12110 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12111 and SYMBOL is its name.
12113 `system-key-alist' has a separate binding for each terminal device.
12114 See Info node `(elisp)Multiple Terminals'. */);
12116 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12117 doc
: /* Keymap that translates key sequences to key sequences during input.
12118 This is used mainly for mapping key sequences into some preferred
12119 key events (symbols).
12121 The `read-key-sequence' function replaces any subsequence bound by
12122 `local-function-key-map' with its binding. More precisely, when the
12123 active keymaps have no binding for the current key sequence but
12124 `local-function-key-map' binds a suffix of the sequence to a vector or
12125 string, `read-key-sequence' replaces the matching suffix with its
12126 binding, and continues with the new sequence.
12128 If the binding is a function, it is called with one argument (the prompt)
12129 and its return value (a key sequence) is used.
12131 The events that come from bindings in `local-function-key-map' are not
12132 themselves looked up in `local-function-key-map'.
12134 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12135 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12136 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12137 typing `ESC O P x' would return [f1 x].
12139 `local-function-key-map' has a separate binding for each terminal
12140 device. See Info node `(elisp)Multiple Terminals'. If you need to
12141 define a binding on all terminals, change `function-key-map'
12142 instead. Initially, `local-function-key-map' is an empty keymap that
12143 has `function-key-map' as its parent on all terminal devices. */);
12145 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12146 doc
: /* Keymap that decodes input escape sequences.
12147 This is used mainly for mapping ASCII function key sequences into
12148 real Emacs function key events (symbols).
12150 The `read-key-sequence' function replaces any subsequence bound by
12151 `input-decode-map' with its binding. Contrary to `function-key-map',
12152 this map applies its rebinding regardless of the presence of an ordinary
12153 binding. So it is more like `key-translation-map' except that it applies
12154 before `function-key-map' rather than after.
12156 If the binding is a function, it is called with one argument (the prompt)
12157 and its return value (a key sequence) is used.
12159 The events that come from bindings in `input-decode-map' are not
12160 themselves looked up in `input-decode-map'.
12162 This variable is keyboard-local. */);
12164 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12165 doc
: /* The parent keymap of all `local-function-key-map' instances.
12166 Function key definitions that apply to all terminal devices should go
12167 here. If a mapping is defined in both the current
12168 `local-function-key-map' binding and this variable, then the local
12169 definition will take precedence. */);
12170 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12172 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12173 doc
: /* Keymap of key translations that can override keymaps.
12174 This keymap works like `function-key-map', but comes after that,
12175 and its non-prefix bindings override ordinary bindings.
12176 Another difference is that it is global rather than keyboard-local. */);
12177 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12179 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12180 doc
: /* List of deferred actions to be performed at a later time.
12181 The precise format isn't relevant here; we just check whether it is nil. */);
12182 Vdeferred_action_list
= Qnil
;
12184 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12185 doc
: /* Function to call to handle deferred actions, after each command.
12186 This function is called with no arguments after each command
12187 whenever `deferred-action-list' is non-nil. */);
12188 Vdeferred_action_function
= Qnil
;
12190 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12191 doc
: /* List of warnings to be displayed after this command.
12192 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12193 as per the args of `display-warning' (which see).
12194 If this variable is non-nil, `delayed-warnings-hook' will be run
12195 immediately after running `post-command-hook'. */);
12196 Vdelayed_warnings_list
= Qnil
;
12198 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12199 doc
: /* Non-nil means show the equivalent key-binding when M-x command has one.
12200 The value can be a length of time to show the message for.
12201 If the value is non-nil and not a number, we wait 2 seconds. */);
12202 Vsuggest_key_bindings
= Qt
;
12204 DEFVAR_LISP ("timer-list", Vtimer_list
,
12205 doc
: /* List of active absolute time timers in order of increasing time. */);
12206 Vtimer_list
= Qnil
;
12208 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12209 doc
: /* List of active idle-time timers in order of increasing time. */);
12210 Vtimer_idle_list
= Qnil
;
12212 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12213 doc
: /* If non-nil, the function that implements the current input method.
12214 It's called with one argument, a printing character that was just read.
12215 \(That means a character with code 040...0176.)
12216 Typically this function uses `read-event' to read additional events.
12217 When it does so, it should first bind `input-method-function' to nil
12218 so it will not be called recursively.
12220 The function should return a list of zero or more events
12221 to be used as input. If it wants to put back some events
12222 to be reconsidered, separately, by the input method,
12223 it can add them to the beginning of `unread-command-events'.
12225 The input method function can find in `input-method-previous-message'
12226 the previous echo area message.
12228 The input method function should refer to the variables
12229 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12230 for guidance on what to do. */);
12231 Vinput_method_function
= Qnil
;
12233 DEFVAR_LISP ("input-method-previous-message",
12234 Vinput_method_previous_message
,
12235 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12236 This variable exists because `read-event' clears the echo area
12237 before running the input method. It is nil if there was no message. */);
12238 Vinput_method_previous_message
= Qnil
;
12240 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12241 doc
: /* If non-nil, the function that implements the display of help.
12242 It's called with one argument, the help string to display. */);
12243 Vshow_help_function
= Qnil
;
12245 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12246 doc
: /* If non-nil, suppress point adjustment after executing a command.
12248 After a command is executed, if point is moved into a region that has
12249 special properties (e.g. composition, display), we adjust point to
12250 the boundary of the region. But, when a command sets this variable to
12251 non-nil, we suppress the point adjustment.
12253 This variable is set to nil before reading a command, and is checked
12254 just after executing the command. */);
12255 Vdisable_point_adjustment
= Qnil
;
12257 DEFVAR_LISP ("global-disable-point-adjustment",
12258 Vglobal_disable_point_adjustment
,
12259 doc
: /* If non-nil, always suppress point adjustment.
12261 The default value is nil, in which case, point adjustment are
12262 suppressed only after special commands that set
12263 `disable-point-adjustment' (which see) to non-nil. */);
12264 Vglobal_disable_point_adjustment
= Qnil
;
12266 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12267 doc
: /* How long to display an echo-area message when the minibuffer is active.
12268 If the value is not a number, such messages don't time out. */);
12269 Vminibuffer_message_timeout
= make_number (2);
12271 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12272 doc
: /* If non-nil, any keyboard input throws to this symbol.
12273 The value of that variable is passed to `quit-flag' and later causes a
12274 peculiar kind of quitting. */);
12275 Vthrow_on_input
= Qnil
;
12277 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12278 doc
: /* If non-nil, function to output error messages.
12279 The arguments are the error data, a list of the form
12280 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12281 such as just as `condition-case' would bind its variable to,
12282 the context (a string which normally goes at the start of the message),
12283 and the Lisp function within which the error was signaled. */);
12284 Vcommand_error_function
= Qnil
;
12286 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12287 Venable_disabled_menus_and_buttons
,
12288 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12290 Help functions bind this to allow help on disabled menu items
12291 and tool-bar buttons. */);
12292 Venable_disabled_menus_and_buttons
= Qnil
;
12294 DEFVAR_LISP ("select-active-regions",
12295 Vselect_active_regions
,
12296 doc
: /* If non-nil, an active region automatically sets the primary selection.
12297 If the value is `only', only temporarily active regions (usually made
12298 by mouse-dragging or shift-selection) set the window selection.
12300 This takes effect only when Transient Mark mode is enabled. */);
12301 Vselect_active_regions
= Qt
;
12303 DEFVAR_LISP ("saved-region-selection",
12304 Vsaved_region_selection
,
12305 doc
: /* Contents of active region prior to buffer modification.
12306 If `select-active-regions' is non-nil, Emacs sets this to the
12307 text in the region before modifying the buffer. The next
12308 `deactivate-mark' call uses this to set the window selection. */);
12309 Vsaved_region_selection
= Qnil
;
12311 DEFVAR_LISP ("selection-inhibit-update-commands",
12312 Vselection_inhibit_update_commands
,
12313 doc
: /* List of commands which should not update the selection.
12314 Normally, if `select-active-regions' is non-nil and the mark remains
12315 active after a command (i.e. the mark was not deactivated), the Emacs
12316 command loop sets the selection to the text in the region. However,
12317 if the command is in this list, the selection is not updated. */);
12318 Vselection_inhibit_update_commands
12319 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12321 DEFVAR_LISP ("debug-on-event",
12323 doc
: /* Enter debugger on this event. When Emacs
12324 receives the special event specified by this variable, it will try to
12325 break into the debugger as soon as possible instead of processing the
12326 event normally through `special-event-map'.
12328 Currently, the only supported values for this
12329 variable are `sigusr1' and `sigusr2'. */);
12330 Vdebug_on_event
= intern_c_string ("sigusr2");
12332 /* Create the initial keyboard. */
12333 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12334 init_kboard (initial_kboard
);
12335 /* Vwindow_system is left at t for now. */
12336 initial_kboard
->next_kboard
= all_kboards
;
12337 all_kboards
= initial_kboard
;
12341 keys_of_keyboard (void)
12343 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12344 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12345 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12346 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12347 initial_define_key (meta_map
, 'x', "execute-extended-command");
12349 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12350 "handle-delete-frame");
12351 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12352 "ns-put-working-text");
12353 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12354 "ns-unput-working-text");
12355 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12356 current-prefix-arg, as is done in `handle-switch-frame'.
12357 But `handle-switch-frame is not run from the special-map.
12358 Commands from that map are run in a special way that automatically
12359 preserves the prefix-arg. Restoring the prefix arg here is not just
12360 redundant but harmful:
12362 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12363 - after the first prompt, the exit-minibuffer-hook is run which may
12364 iconify a frame and thus push a `iconify-frame' event.
12365 - after running exit-minibuffer-hook, current-prefix-arg is
12366 restored to the non-nil value it had before the prompt.
12367 - we enter the second prompt.
12368 current-prefix-arg is non-nil, prefix-arg is nil.
12369 - before running the first real event, we run the special iconify-frame
12370 event, but we pass the `special' arg to execute-command so
12371 current-prefix-arg and prefix-arg are left untouched.
12372 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12373 - the next key event will have a spuriously non-nil current-prefix-arg. */
12374 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12376 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12378 /* Handling it at such a low-level causes read_key_sequence to get
12379 * confused because it doesn't realize that the current_buffer was
12380 * changed by read_char.
12382 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12383 * "handle-select-window"); */
12384 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12385 "handle-save-session");
12388 /* Define a special event which is raised for dbus callback
12390 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12391 "dbus-handle-event");
12394 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12398 /* Mark the pointers in the kboard objects.
12399 Called by the Fgarbage_collector. */
12401 mark_kboards (void)
12405 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12407 if (kb
->kbd_macro_buffer
)
12408 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12410 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12411 mark_object (KVAR (kb
, Vlast_command
));
12412 mark_object (KVAR (kb
, Vreal_last_command
));
12413 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12414 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12415 mark_object (KVAR (kb
, Vprefix_arg
));
12416 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12417 mark_object (KVAR (kb
, kbd_queue
));
12418 mark_object (KVAR (kb
, defining_kbd_macro
));
12419 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12420 mark_object (KVAR (kb
, Vsystem_key_alist
));
12421 mark_object (KVAR (kb
, system_key_syms
));
12422 mark_object (KVAR (kb
, Vwindow_system
));
12423 mark_object (KVAR (kb
, Vinput_decode_map
));
12424 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12425 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12426 mark_object (KVAR (kb
, echo_string
));
12429 struct input_event
*event
;
12430 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12432 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12433 event
= kbd_buffer
;
12434 if (event
->kind
!= SELECTION_REQUEST_EVENT
12435 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12437 mark_object (event
->x
);
12438 mark_object (event
->y
);
12440 mark_object (event
->frame_or_window
);
12441 mark_object (event
->arg
);