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 int 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, raw_keybuf_count * 2, Qnil) \
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 static int this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static int before_command_key_count
;
147 static int 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 EMACS_INT 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 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 EMACS_INT 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 int 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 (EMACS_INT
, unsigned, Lisp_Object
,
452 Lisp_Object
, const char *const *,
453 Lisp_Object
*, EMACS_INT
);
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 (EMACS_INT 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
,
719 2 * ASIZE (this_command_keys
),
722 ASET (this_command_keys
, this_command_key_count
, key
);
723 ++this_command_key_count
;
728 recursive_edit_1 (void)
730 int count
= SPECPDL_INDEX ();
733 if (command_loop_level
> 0)
735 specbind (Qstandard_output
, Qt
);
736 specbind (Qstandard_input
, Qt
);
739 #ifdef HAVE_WINDOW_SYSTEM
740 /* The command loop has started an hourglass timer, so we have to
741 cancel it here, otherwise it will fire because the recursive edit
742 can take some time. Do not check for display_hourglass_p here,
743 because it could already be nil. */
747 /* This function may have been called from a debugger called from
748 within redisplay, for instance by Edebugging a function called
749 from fontification-functions. We want to allow redisplay in
750 the debugging session.
752 The recursive edit is left with a `(throw exit ...)'. The `exit'
753 tag is not caught anywhere in redisplay, i.e. when we leave the
754 recursive edit, the original redisplay leading to the recursive
755 edit will be unwound. The outcome should therefore be safe. */
756 specbind (Qinhibit_redisplay
, Qnil
);
759 val
= command_loop ();
761 Fsignal (Qquit
, Qnil
);
762 /* Handle throw from read_minibuf when using minibuffer
763 while it's active but we're in another window. */
765 xsignal1 (Qerror
, val
);
767 return unbind_to (count
, Qnil
);
770 /* When an auto-save happens, record the "time", and don't do again soon. */
773 record_auto_save (void)
775 last_auto_save
= num_nonmacro_input_events
;
778 /* Make an auto save happen as soon as possible at command level. */
782 force_auto_save_soon (void)
784 last_auto_save
= - auto_save_interval
- 1;
786 record_asynch_buffer_change ();
790 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
791 doc
: /* Invoke the editor command loop recursively.
792 To get out of the recursive edit, a command can do `(throw 'exit nil)';
793 that tells this function to return.
794 Alternatively, `(throw 'exit t)' makes this function signal an error.
795 This function is called by the editor initialization to begin editing. */)
798 int count
= SPECPDL_INDEX ();
801 /* If we enter while input is blocked, don't lock up here.
802 This may happen through the debugger during redisplay. */
806 command_loop_level
++;
807 update_mode_lines
= 1;
809 if (command_loop_level
810 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
811 buffer
= Fcurrent_buffer ();
815 /* If we leave recursive_edit_1 below with a `throw' for instance,
816 like it is done in the splash screen display, we have to
817 make sure that we restore single_kboard as command_loop_1
818 would have done if it were left normally. */
819 if (command_loop_level
> 0)
820 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
821 record_unwind_protect (recursive_edit_unwind
, buffer
);
824 return unbind_to (count
, Qnil
);
828 recursive_edit_unwind (Lisp_Object buffer
)
830 if (BUFFERP (buffer
))
831 Fset_buffer (buffer
);
833 command_loop_level
--;
834 update_mode_lines
= 1;
839 #if 0 /* These two functions are now replaced with
840 temporarily_switch_to_single_kboard. */
844 #if 0 /* Theory: if there's anything in Vunread_command_events,
845 it will right away be read by read_key_sequence,
846 and then if we do switch KBOARDS, it will go into the side
847 queue then. So we don't need to do anything special here -- rms. */
848 if (CONSP (Vunread_command_events
))
850 current_kboard
->kbd_queue
851 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
852 current_kboard
->kbd_queue_has_data
= 1;
854 Vunread_command_events
= Qnil
;
859 /* Switch to the single-kboard state, making current_kboard
860 the only KBOARD from which further input is accepted. */
863 single_kboard_state ()
869 /* If we're in single_kboard state for kboard KBOARD,
873 not_single_kboard_state (KBOARD
*kboard
)
875 if (kboard
== current_kboard
)
879 /* Maintain a stack of kboards, so other parts of Emacs
880 can switch temporarily to the kboard of a given frame
881 and then revert to the previous status. */
886 struct kboard_stack
*next
;
889 static struct kboard_stack
*kboard_stack
;
892 push_kboard (struct kboard
*k
)
894 struct kboard_stack
*p
895 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
897 p
->next
= kboard_stack
;
898 p
->kboard
= current_kboard
;
908 struct kboard_stack
*p
= kboard_stack
;
910 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
912 if (t
->kboard
== p
->kboard
)
914 current_kboard
= p
->kboard
;
921 /* The terminal we remembered has been deleted. */
922 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
925 kboard_stack
= p
->next
;
929 /* Switch to single_kboard mode, making current_kboard the only KBOARD
930 from which further input is accepted. If F is non-nil, set its
931 KBOARD as the current keyboard.
933 This function uses record_unwind_protect to return to the previous
936 If Emacs is already in single_kboard mode, and F's keyboard is
937 locked, then this function will throw an error. */
940 temporarily_switch_to_single_kboard (struct frame
*f
)
942 int was_locked
= single_kboard
;
945 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
946 /* We can not switch keyboards while in single_kboard mode.
947 In rare cases, Lisp code may call `recursive-edit' (or
948 `read-minibuffer' or `y-or-n-p') after it switched to a
949 locked frame. For example, this is likely to happen
950 when server.el connects to a new terminal while Emacs is in
951 single_kboard mode. It is best to throw an error instead
952 of presenting the user with a frozen screen. */
953 error ("Terminal %d is locked, cannot read from it",
954 FRAME_TERMINAL (f
)->id
);
956 /* This call is unnecessary, but helps
957 `restore_kboard_configuration' discover if somebody changed
958 `current_kboard' behind our back. */
959 push_kboard (current_kboard
);
962 current_kboard
= FRAME_KBOARD (f
);
964 record_unwind_protect (restore_kboard_configuration
,
965 (was_locked
? Qt
: Qnil
));
968 #if 0 /* This function is not needed anymore. */
970 record_single_kboard_state ()
973 push_kboard (current_kboard
);
974 record_unwind_protect (restore_kboard_configuration
,
975 (single_kboard
? Qt
: Qnil
));
980 restore_kboard_configuration (Lisp_Object was_locked
)
982 if (NILP (was_locked
))
986 struct kboard
*prev
= current_kboard
;
989 /* The pop should not change the kboard. */
990 if (single_kboard
&& current_kboard
!= prev
)
997 /* Handle errors that are not handled at inner levels
998 by printing an error message and returning to the editor command loop. */
1001 cmd_error (Lisp_Object data
)
1003 Lisp_Object old_level
, old_length
;
1004 char macroerror
[sizeof "After..kbd macro iterations: "
1005 + INT_STRLEN_BOUND (EMACS_INT
)];
1007 #ifdef HAVE_WINDOW_SYSTEM
1008 if (display_hourglass_p
)
1009 cancel_hourglass ();
1012 if (!NILP (executing_kbd_macro
))
1014 if (executing_kbd_macro_iterations
== 1)
1015 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1017 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1018 executing_kbd_macro_iterations
);
1023 Vstandard_output
= Qt
;
1024 Vstandard_input
= Qt
;
1025 Vexecuting_kbd_macro
= Qnil
;
1026 executing_kbd_macro
= Qnil
;
1027 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1028 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1031 /* Avoid unquittable loop if data contains a circular list. */
1032 old_level
= Vprint_level
;
1033 old_length
= Vprint_length
;
1034 XSETFASTINT (Vprint_level
, 10);
1035 XSETFASTINT (Vprint_length
, 10);
1036 cmd_error_internal (data
, macroerror
);
1037 Vprint_level
= old_level
;
1038 Vprint_length
= old_length
;
1042 Vinhibit_quit
= Qnil
;
1043 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1044 if (command_loop_level
== 0 && minibuf_level
== 0)
1045 any_kboard_state ();
1048 return make_number (0);
1051 /* Take actions on handling an error. DATA is the data that describes
1054 CONTEXT is a C-string containing ASCII characters only which
1055 describes the context in which the error happened. If we need to
1056 generalize CONTEXT to allow multibyte characters, make it a Lisp
1060 cmd_error_internal (Lisp_Object data
, const char *context
)
1062 struct frame
*sf
= SELECTED_FRAME ();
1064 /* The immediate context is not interesting for Quits,
1065 since they are asynchronous. */
1066 if (EQ (XCAR (data
), Qquit
))
1067 Vsignaling_function
= Qnil
;
1072 /* Use user's specified output function if any. */
1073 if (!NILP (Vcommand_error_function
))
1074 call3 (Vcommand_error_function
, data
,
1075 context
? build_string (context
) : empty_unibyte_string
,
1076 Vsignaling_function
);
1077 /* If the window system or terminal frame hasn't been initialized
1078 yet, or we're not interactive, write the message to stderr and exit. */
1079 else if (!sf
->glyphs_initialized_p
1080 /* The initial frame is a special non-displaying frame. It
1081 will be current in daemon mode when there are no frames
1082 to display, and in non-daemon mode before the real frame
1083 has finished initializing. If an error is thrown in the
1084 latter case while creating the frame, then the frame
1085 will never be displayed, so the safest thing to do is
1086 write to stderr and quit. In daemon mode, there are
1087 many other potential errors that do not prevent frames
1088 from being created, so continuing as normal is better in
1090 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1093 print_error_message (data
, Qexternal_debugging_output
,
1094 context
, Vsignaling_function
);
1095 Fterpri (Qexternal_debugging_output
);
1096 Fkill_emacs (make_number (-1));
1100 clear_message (1, 0);
1102 message_log_maybe_newline ();
1105 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1108 Vsignaling_function
= Qnil
;
1111 Lisp_Object
command_loop_1 (void);
1112 static Lisp_Object
command_loop_2 (Lisp_Object
);
1113 static Lisp_Object
top_level_1 (Lisp_Object
);
1115 /* Entry to editor-command-loop.
1116 This level has the catches for exiting/returning to editor command loop.
1117 It returns nil to exit recursive edit, t to abort it. */
1122 if (command_loop_level
> 0 || minibuf_level
> 0)
1125 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1126 executing_kbd_macro
= Qnil
;
1132 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1133 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1134 /* Reset single_kboard in case top-level set it while
1135 evaluating an -f option, or we are stuck there for some
1137 any_kboard_state ();
1139 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1140 executing_kbd_macro
= Qnil
;
1142 /* End of file in -batch run causes exit here. */
1148 /* Here we catch errors in execution of commands within the
1149 editing loop, and reenter the editing loop.
1150 When there is an error, cmd_error runs and returns a non-nil
1151 value to us. A value of nil means that command_loop_1 itself
1152 returned due to end of file (or end of kbd macro). */
1155 command_loop_2 (Lisp_Object ignore
)
1157 register Lisp_Object val
;
1160 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1161 while (!NILP (val
));
1169 return Feval (Vtop_level
, Qnil
);
1173 top_level_1 (Lisp_Object ignore
)
1175 /* On entry to the outer level, run the startup file */
1176 if (!NILP (Vtop_level
))
1177 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1178 else if (!NILP (Vpurify_flag
))
1179 message ("Bare impure Emacs (standard Lisp code not loaded)");
1181 message ("Bare Emacs (standard Lisp code not loaded)");
1185 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1186 doc
: /* Exit all recursive editing levels.
1187 This also exits all active minibuffers. */)
1190 #ifdef HAVE_WINDOW_SYSTEM
1191 if (display_hourglass_p
)
1192 cancel_hourglass ();
1195 /* Unblock input if we enter with input blocked. This may happen if
1196 redisplay traps e.g. during tool-bar update with input blocked. */
1197 while (INPUT_BLOCKED_P
)
1200 Fthrow (Qtop_level
, Qnil
);
1203 static Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1204 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1205 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1208 if (command_loop_level
> 0 || minibuf_level
> 0)
1209 Fthrow (Qexit
, Qnil
);
1211 error ("No recursive edit is in progress");
1214 static Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1215 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1216 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1219 if (command_loop_level
> 0 || minibuf_level
> 0)
1222 error ("No recursive edit is in progress");
1225 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1227 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1228 of this function. */
1231 tracking_off (Lisp_Object old_value
)
1233 do_mouse_tracking
= old_value
;
1234 if (NILP (old_value
))
1236 /* Redisplay may have been preempted because there was input
1237 available, and it assumes it will be called again after the
1238 input has been processed. If the only input available was
1239 the sort that we have just disabled, then we need to call
1241 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1243 redisplay_preserve_echo_area (6);
1244 get_input_pending (&input_pending
,
1245 READABLE_EVENTS_DO_TIMERS_NOW
);
1251 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1252 doc
: /* Evaluate BODY with mouse movement events enabled.
1253 Within a `track-mouse' form, mouse motion generates input events that
1254 you can read with `read-event'.
1255 Normally, mouse motion is ignored.
1256 usage: (track-mouse BODY...) */)
1259 int count
= SPECPDL_INDEX ();
1262 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1264 do_mouse_tracking
= Qt
;
1266 val
= Fprogn (args
);
1267 return unbind_to (count
, val
);
1270 /* If mouse has moved on some frame, return one of those frames.
1274 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1275 after resizing the tool-bar window. */
1277 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1280 int ignore_mouse_drag_p
;
1283 some_mouse_moved (void)
1285 Lisp_Object tail
, frame
;
1287 if (ignore_mouse_drag_p
)
1289 /* ignore_mouse_drag_p = 0; */
1293 FOR_EACH_FRAME (tail
, frame
)
1295 if (XFRAME (frame
)->mouse_moved
)
1296 return XFRAME (frame
);
1302 #endif /* HAVE_MOUSE || HAVE_GPM */
1304 /* This is the actual command reading loop,
1305 sans error-handling encapsulation. */
1307 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1309 void safe_run_hooks (Lisp_Object
);
1310 static void adjust_point_for_property (EMACS_INT
, int);
1312 /* Cancel hourglass from protect_unwind.
1314 #ifdef HAVE_WINDOW_SYSTEM
1316 cancel_hourglass_unwind (Lisp_Object arg
)
1318 cancel_hourglass ();
1323 /* FIXME: This is wrong rather than test window-system, we should call
1324 a new set-selection, which will then dispatch to x-set-selection, or
1325 tty-set-selection, or w32-set-selection, ... */
1326 EXFUN (Fwindow_system
, 1);
1329 command_loop_1 (void)
1332 Lisp_Object keybuf
[30];
1334 int prev_modiff
= 0;
1335 struct buffer
*prev_buffer
= NULL
;
1336 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1337 int was_locked
= single_kboard
;
1339 int already_adjusted
= 0;
1341 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1342 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1343 Vdeactivate_mark
= Qnil
;
1344 waiting_for_input
= 0;
1347 this_command_key_count
= 0;
1348 this_command_key_count_reset
= 0;
1349 this_single_command_key_start
= 0;
1351 if (NILP (Vmemory_full
))
1353 /* Make sure this hook runs after commands that get errors and
1354 throw to top level. */
1355 /* Note that the value cell will never directly contain nil
1356 if the symbol is a local variable. */
1357 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1358 safe_run_hooks (Qpost_command_hook
);
1360 /* If displaying a message, resize the echo area window to fit
1361 that message's size exactly. */
1362 if (!NILP (echo_area_buffer
[0]))
1363 resize_echo_area_exactly ();
1365 /* If there are warnings waiting, process them. */
1366 if (!NILP (Vdelayed_warnings_list
))
1367 safe_run_hooks (Qdelayed_warnings_hook
);
1369 if (!NILP (Vdeferred_action_list
))
1370 safe_run_hooks (Qdeferred_action_function
);
1373 /* Do this after running Vpost_command_hook, for consistency. */
1374 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1375 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1376 if (!CONSP (last_command_event
))
1377 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1381 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1384 /* Make sure the current window's buffer is selected. */
1385 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1386 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1388 /* Display any malloc warning that just came out. Use while because
1389 displaying one warning can cause another. */
1391 while (pending_malloc_warning
)
1392 display_malloc_warning ();
1394 Vdeactivate_mark
= Qnil
;
1396 /* If minibuffer on and echo area in use,
1397 wait a short time and redraw minibuffer. */
1400 && !NILP (echo_area_buffer
[0])
1401 && EQ (minibuf_window
, echo_area_window
)
1402 && NUMBERP (Vminibuffer_message_timeout
))
1404 /* Bind inhibit-quit to t so that C-g gets read in
1405 rather than quitting back to the minibuffer. */
1406 int count
= SPECPDL_INDEX ();
1407 specbind (Qinhibit_quit
, Qt
);
1409 sit_for (Vminibuffer_message_timeout
, 0, 2);
1411 /* Clear the echo area. */
1413 safe_run_hooks (Qecho_area_clear_hook
);
1415 unbind_to (count
, Qnil
);
1417 /* If a C-g came in before, treat it as input now. */
1418 if (!NILP (Vquit_flag
))
1421 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1426 /* Select the frame that the last event came from. Usually,
1427 switch-frame events will take care of this, but if some lisp
1428 code swallows a switch-frame event, we'll fix things up here.
1429 Is this a good idea? */
1430 if (FRAMEP (internal_last_event_frame
)
1431 && !EQ (internal_last_event_frame
, selected_frame
))
1432 Fselect_frame (internal_last_event_frame
, Qnil
);
1434 /* If it has changed current-menubar from previous value,
1435 really recompute the menubar from the value. */
1436 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1437 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1438 call0 (Qrecompute_lucid_menubar
);
1440 before_command_key_count
= this_command_key_count
;
1441 before_command_echo_length
= echo_length ();
1443 Vthis_command
= Qnil
;
1444 real_this_command
= Qnil
;
1445 Vthis_original_command
= Qnil
;
1446 Vthis_command_keys_shift_translated
= Qnil
;
1448 /* Read next key sequence; i gets its length. */
1449 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1452 /* A filter may have run while we were reading the input. */
1453 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1455 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1456 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1460 /* Now we have read a key sequence of length I,
1461 or else I is 0 and we found end of file. */
1463 if (i
== 0) /* End of file -- happens only in */
1464 return Qnil
; /* a kbd macro, at the end. */
1465 /* -1 means read_key_sequence got a menu that was rejected.
1466 Just loop around and read another command. */
1470 this_command_key_count
= 0;
1471 this_command_key_count_reset
= 0;
1472 this_single_command_key_start
= 0;
1476 last_command_event
= keybuf
[i
- 1];
1478 /* If the previous command tried to force a specific window-start,
1479 forget about that, in case this command moves point far away
1480 from that position. But also throw away beg_unchanged and
1481 end_unchanged information in that case, so that redisplay will
1482 update the whole window properly. */
1483 if (!NILP (XWINDOW (selected_window
)->force_start
))
1486 XWINDOW (selected_window
)->force_start
= Qnil
;
1487 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1488 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1491 cmd
= read_key_sequence_cmd
;
1492 if (!NILP (Vexecuting_kbd_macro
))
1494 if (!NILP (Vquit_flag
))
1496 Vexecuting_kbd_macro
= Qt
;
1497 QUIT
; /* Make some noise. */
1498 /* Will return since macro now empty. */
1502 /* Do redisplay processing after this command except in special
1503 cases identified below. */
1504 prev_buffer
= current_buffer
;
1505 prev_modiff
= MODIFF
;
1506 last_point_position
= PT
;
1507 last_point_position_window
= selected_window
;
1508 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1510 /* By default, we adjust point to a boundary of a region that
1511 has such a property that should be treated intangible
1512 (e.g. composition, display). But, some commands will set
1513 this variable differently. */
1514 Vdisable_point_adjustment
= Qnil
;
1516 /* Process filters and timers may have messed with deactivate-mark.
1517 reset it before we execute the command. */
1518 Vdeactivate_mark
= Qnil
;
1520 /* Remap command through active keymaps. */
1521 Vthis_original_command
= cmd
;
1522 if (!NILP (read_key_sequence_remapped
))
1523 cmd
= read_key_sequence_remapped
;
1525 /* Execute the command. */
1527 Vthis_command
= cmd
;
1528 real_this_command
= cmd
;
1529 safe_run_hooks (Qpre_command_hook
);
1531 already_adjusted
= 0;
1533 if (NILP (Vthis_command
))
1535 /* nil means key is undefined. */
1536 Lisp_Object keys
= Fvector (i
, keybuf
);
1537 keys
= Fkey_description (keys
, Qnil
);
1539 message_with_string ("%s is undefined", keys
, 0);
1540 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1541 update_mode_lines
= 1;
1542 /* If this is a down-mouse event, don't reset prefix-arg;
1543 pass it to the command run by the up event. */
1544 if (EVENT_HAS_PARAMETERS (last_command_event
))
1546 Lisp_Object breakdown
1547 = parse_modifiers (EVENT_HEAD (last_command_event
));
1548 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1549 if (!(modifiers
& down_modifier
))
1550 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1553 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1557 /* Here for a command that isn't executed directly. */
1559 #ifdef HAVE_WINDOW_SYSTEM
1560 int scount
= SPECPDL_INDEX ();
1562 if (display_hourglass_p
1563 && NILP (Vexecuting_kbd_macro
))
1565 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1570 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1572 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1574 #ifdef HAVE_WINDOW_SYSTEM
1575 /* Do not check display_hourglass_p here, because
1576 Fcommand_execute could change it, but we should cancel
1577 hourglass cursor anyway.
1578 But don't cancel the hourglass within a macro
1579 just because a command in the macro finishes. */
1580 if (NILP (Vexecuting_kbd_macro
))
1581 unbind_to (scount
, Qnil
);
1584 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1586 safe_run_hooks (Qpost_command_hook
);
1588 /* If displaying a message, resize the echo area window to fit
1589 that message's size exactly. */
1590 if (!NILP (echo_area_buffer
[0]))
1591 resize_echo_area_exactly ();
1593 /* If there are warnings waiting, process them. */
1594 if (!NILP (Vdelayed_warnings_list
))
1595 safe_run_hooks (Qdelayed_warnings_hook
);
1597 safe_run_hooks (Qdeferred_action_function
);
1599 /* If there is a prefix argument,
1600 1) We don't want Vlast_command to be ``universal-argument''
1601 (that would be dumb), so don't set Vlast_command,
1602 2) we want to leave echoing on so that the prefix will be
1603 echoed as part of this key sequence, so don't call
1605 3) we want to leave this_command_key_count non-zero, so that
1606 read_char will realize that it is re-reading a character, and
1607 not echo it a second time.
1609 If the command didn't actually create a prefix arg,
1610 but is merely a frame event that is transparent to prefix args,
1611 then the above doesn't apply. */
1612 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1614 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1615 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1616 if (!CONSP (last_command_event
))
1617 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1619 this_command_key_count
= 0;
1620 this_command_key_count_reset
= 0;
1621 this_single_command_key_start
= 0;
1624 if (!NILP (BVAR (current_buffer
, mark_active
))
1625 && !NILP (Vrun_hooks
))
1627 /* In Emacs 22, setting transient-mark-mode to `only' was a
1628 way of turning it on for just one command. This usage is
1629 obsolete, but support it anyway. */
1630 if (EQ (Vtransient_mark_mode
, Qidentity
))
1631 Vtransient_mark_mode
= Qnil
;
1632 else if (EQ (Vtransient_mark_mode
, Qonly
))
1633 Vtransient_mark_mode
= Qidentity
;
1635 if (!NILP (Vdeactivate_mark
))
1636 /* If `select-active-regions' is non-nil, this call to
1637 `deactivate-mark' also sets the PRIMARY selection. */
1638 call0 (Qdeactivate_mark
);
1641 /* Even if not deactivating the mark, set PRIMARY if
1642 `select-active-regions' is non-nil. */
1643 if (!NILP (Fwindow_system (Qnil
))
1644 /* Even if mark_active is non-nil, the actual buffer
1645 marker may not have been set yet (Bug#7044). */
1646 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1647 && (EQ (Vselect_active_regions
, Qonly
)
1648 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1649 : (!NILP (Vselect_active_regions
)
1650 && !NILP (Vtransient_mark_mode
)))
1651 && NILP (Fmemq (Vthis_command
,
1652 Vselection_inhibit_update_commands
)))
1655 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1658 call2 (Qx_set_selection
, QPRIMARY
,
1659 make_buffer_string (beg
, end
, 0));
1661 call2 (Qx_set_selection
, QPRIMARY
,
1662 make_buffer_string (end
, beg
, 0));
1663 /* Don't set empty selections. */
1666 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1668 Lisp_Object hook
= intern ("activate-mark-hook");
1669 Frun_hooks (1, &hook
);
1673 Vsaved_region_selection
= Qnil
;
1678 if (current_buffer
== prev_buffer
1679 && last_point_position
!= PT
1680 && NILP (Vdisable_point_adjustment
)
1681 && NILP (Vglobal_disable_point_adjustment
))
1683 if (last_point_position
> BEGV
1684 && last_point_position
< ZV
1685 && (composition_adjust_point (last_point_position
,
1686 last_point_position
)
1687 != last_point_position
))
1688 /* The last point was temporarily set within a grapheme
1689 cluster to prevent automatic composition. To recover
1690 the automatic composition, we must update the
1692 windows_or_buffers_changed
++;
1693 if (!already_adjusted
)
1694 adjust_point_for_property (last_point_position
,
1695 MODIFF
!= prev_modiff
);
1698 /* Install chars successfully executed in kbd macro. */
1700 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1701 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1702 finalize_kbd_macro_chars ();
1703 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1705 any_kboard_state ();
1710 /* Adjust point to a boundary of a region that has such a property
1711 that should be treated intangible. For the moment, we check
1712 `composition', `display' and `invisible' properties.
1713 LAST_PT is the last position of point. */
1716 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1719 Lisp_Object val
, overlay
, tmp
;
1720 /* When called after buffer modification, we should temporarily
1721 suppress the point adjustment for automatic composition so that a
1722 user can keep inserting another character at point or keep
1723 deleting characters around point. */
1724 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1725 EMACS_INT orig_pt
= PT
;
1727 /* FIXME: cycling is probably not necessary because these properties
1728 can't be usefully combined anyway. */
1729 while (check_composition
|| check_display
|| check_invisible
)
1731 /* FIXME: check `intangible'. */
1732 if (check_composition
1733 && PT
> BEGV
&& PT
< ZV
1734 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1737 check_display
= check_invisible
= 1;
1739 check_composition
= 0;
1741 && PT
> BEGV
&& PT
< ZV
1742 && !NILP (val
= get_char_property_and_overlay
1743 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1744 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1745 && (!OVERLAYP (overlay
)
1746 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1747 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1748 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1749 && (beg
< PT
/* && end > PT <- It's always the case. */
1750 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1753 SET_PT (PT
< last_pt
1754 ? (STRINGP (val
) && SCHARS (val
) == 0
1755 ? max (beg
- 1, BEGV
)
1758 check_composition
= check_invisible
= 1;
1761 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1763 int inv
, ellipsis
= 0;
1766 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1769 /* FIXME: We should stop if we find a spot between
1770 two runs of `invisible' where inserted text would
1771 be visible. This is important when we have two
1772 invisible boundaries that enclose an area: if the
1773 area is empty, we need this test in order to make
1774 it possible to place point in the middle rather
1775 than skip both boundaries. However, this code
1776 also stops anywhere in a non-sticky text-property,
1777 which breaks (e.g.) Org mode. */
1778 && (val
= get_pos_property (make_number (end
),
1780 TEXT_PROP_MEANS_INVISIBLE (val
))
1782 && !NILP (val
= get_char_property_and_overlay
1783 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1784 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1786 ellipsis
= ellipsis
|| inv
> 1
1787 || (OVERLAYP (overlay
)
1788 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1789 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1790 tmp
= Fnext_single_char_property_change
1791 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1792 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1796 && (val
= get_pos_property (make_number (beg
),
1798 TEXT_PROP_MEANS_INVISIBLE (val
))
1800 && !NILP (val
= get_char_property_and_overlay
1801 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1802 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1804 ellipsis
= ellipsis
|| inv
> 1
1805 || (OVERLAYP (overlay
)
1806 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1807 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1808 tmp
= Fprevious_single_char_property_change
1809 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1810 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1813 /* Move away from the inside area. */
1814 if (beg
< PT
&& end
> PT
)
1816 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1817 /* We haven't moved yet (so we don't need to fear
1818 infinite-looping) and we were outside the range
1819 before (so either end of the range still corresponds
1820 to a move in the right direction): pretend we moved
1821 less than we actually did, so that we still have
1822 more freedom below in choosing which end of the range
1824 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1825 /* We either have moved already or the last point
1826 was already in the range: we don't get to choose
1827 which end of the range we have to go to. */
1828 : (PT
< last_pt
? beg
: end
));
1829 check_composition
= check_display
= 1;
1831 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1832 the point to something other than its argument, due to
1833 point-motion hooks, intangibility, etc. */
1834 xassert (PT
== beg
|| PT
== end
);
1837 /* Pretend the area doesn't exist if the buffer is not
1839 if (!modified
&& !ellipsis
&& beg
< end
)
1841 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1842 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1843 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1844 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1845 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1846 /* We've already moved as far as we can. Trying to go
1847 to the other end would mean moving backwards and thus
1848 could lead to an infinite loop. */
1850 else if (val
= get_pos_property (make_number (PT
),
1852 TEXT_PROP_MEANS_INVISIBLE (val
)
1853 && (val
= get_pos_property
1854 (make_number (PT
== beg
? end
: beg
),
1856 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1857 (check_composition
= check_display
= 1,
1858 SET_PT (PT
== beg
? end
: beg
));
1861 check_invisible
= 0;
1865 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1868 safe_run_hooks_1 (void)
1870 eassert (CONSP (Vinhibit_quit
));
1871 return call0 (XCDR (Vinhibit_quit
));
1874 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1878 safe_run_hooks_error (Lisp_Object error_data
)
1881 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1882 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1883 Lisp_Object args
[4];
1884 args
[0] = build_string ("Error in %s (%s): %S");
1887 args
[3] = error_data
;
1893 Lisp_Object newval
= Qnil
;
1894 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1895 if (EQ (fun
, XCAR (val
)))
1898 newval
= Fcons (XCAR (val
), newval
);
1900 return Fset (hook
, Fnreverse (newval
));
1901 /* Not found in the local part of the hook. Let's look at the global
1904 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1905 : Fdefault_value (hook
));
1906 CONSP (val
); val
= XCDR (val
))
1907 if (EQ (fun
, XCAR (val
)))
1910 newval
= Fcons (XCAR (val
), newval
);
1912 return Fset_default (hook
, Fnreverse (newval
));
1918 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1920 eassert (nargs
== 1);
1921 if (CONSP (Vinhibit_quit
))
1922 XSETCDR (Vinhibit_quit
, args
[0]);
1924 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1926 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1930 /* If we get an error while running the hook, cause the hook variable
1931 to be nil. Also inhibit quits, so that C-g won't cause the hook
1932 to mysteriously evaporate. */
1935 safe_run_hooks (Lisp_Object hook
)
1937 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1938 to its body or to its handlers other than via globals such as
1939 dynamically-bound variables ;-) */
1940 int count
= SPECPDL_INDEX ();
1941 specbind (Qinhibit_quit
, hook
);
1943 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1945 unbind_to (count
, Qnil
);
1949 /* Nonzero means polling for input is temporarily suppressed. */
1951 int poll_suppress_count
;
1953 /* Asynchronous timer for polling. */
1955 static struct atimer
*poll_timer
;
1958 #ifdef POLL_FOR_INPUT
1960 /* Poll for input, so that we catch a C-g if it comes in. This
1961 function is called from x_make_frame_visible, see comment
1965 poll_for_input_1 (void)
1967 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1968 doing anything dangerous. */
1972 if (interrupt_input_blocked
== 0
1973 && !waiting_for_input
)
1974 read_avail_input (0);
1980 /* Timer callback function for poll_timer. TIMER is equal to
1984 poll_for_input (struct atimer
*timer
)
1986 if (poll_suppress_count
== 0)
1989 interrupt_input_pending
= 1;
1990 pending_signals
= 1;
1992 poll_for_input_1 ();
1997 #endif /* POLL_FOR_INPUT */
1999 /* Begin signals to poll for input, if they are appropriate.
2000 This function is called unconditionally from various places. */
2003 start_polling (void)
2005 #ifdef POLL_FOR_INPUT
2006 /* XXX This condition was (read_socket_hook && !interrupt_input),
2007 but read_socket_hook is not global anymore. Let's pretend that
2009 if (!interrupt_input
)
2011 /* Turn alarm handling on unconditionally. It might have
2012 been turned off in process.c. */
2013 turn_on_atimers (1);
2015 /* If poll timer doesn't exist, are we need one with
2016 a different interval, start a new one. */
2017 if (poll_timer
== NULL
2018 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2020 EMACS_TIME interval
;
2023 cancel_atimer (poll_timer
);
2025 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2026 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2027 poll_for_input
, NULL
);
2030 /* Let the timer's callback function poll for input
2031 if this becomes zero. */
2032 --poll_suppress_count
;
2037 /* Nonzero if we are using polling to handle input asynchronously. */
2040 input_polling_used (void)
2042 #ifdef POLL_FOR_INPUT
2043 /* XXX This condition was (read_socket_hook && !interrupt_input),
2044 but read_socket_hook is not global anymore. Let's pretend that
2046 return !interrupt_input
;
2052 /* Turn off polling. */
2057 #ifdef POLL_FOR_INPUT
2058 /* XXX This condition was (read_socket_hook && !interrupt_input),
2059 but read_socket_hook is not global anymore. Let's pretend that
2061 if (!interrupt_input
)
2062 ++poll_suppress_count
;
2066 /* Set the value of poll_suppress_count to COUNT
2067 and start or stop polling accordingly. */
2070 set_poll_suppress_count (int count
)
2072 #ifdef POLL_FOR_INPUT
2073 if (count
== 0 && poll_suppress_count
!= 0)
2075 poll_suppress_count
= 1;
2078 else if (count
!= 0 && poll_suppress_count
== 0)
2082 poll_suppress_count
= count
;
2086 /* Bind polling_period to a value at least N.
2087 But don't decrease it. */
2090 bind_polling_period (int n
)
2092 #ifdef POLL_FOR_INPUT
2093 int new = polling_period
;
2098 stop_other_atimers (poll_timer
);
2100 specbind (Qpolling_period
, make_number (new));
2101 /* Start a new alarm with the new period. */
2106 /* Apply the control modifier to CHARACTER. */
2109 make_ctrl_char (int c
)
2111 /* Save the upper bits here. */
2112 int upper
= c
& ~0177;
2114 if (! ASCII_BYTE_P (c
))
2115 return c
|= ctrl_modifier
;
2119 /* Everything in the columns containing the upper-case letters
2120 denotes a control character. */
2121 if (c
>= 0100 && c
< 0140)
2125 /* Set the shift modifier for a control char
2126 made from a shifted letter. But only for letters! */
2127 if (oc
>= 'A' && oc
<= 'Z')
2128 c
|= shift_modifier
;
2131 /* The lower-case letters denote control characters too. */
2132 else if (c
>= 'a' && c
<= 'z')
2135 /* Include the bits for control and shift
2136 only if the basic ASCII code can't indicate them. */
2140 /* Replace the high bits. */
2141 c
|= (upper
& ~ctrl_modifier
);
2146 /* Display the help-echo property of the character after the mouse pointer.
2147 Either show it in the echo area, or call show-help-function to display
2148 it by other means (maybe in a tooltip).
2150 If HELP is nil, that means clear the previous help echo.
2152 If HELP is a string, display that string. If HELP is a function,
2153 call it with OBJECT and POS as arguments; the function should
2154 return a help string or nil for none. For all other types of HELP,
2155 evaluate it to obtain a string.
2157 WINDOW is the window in which the help was generated, if any.
2158 It is nil if not in a window.
2160 If OBJECT is a buffer, POS is the position in the buffer where the
2161 `help-echo' text property was found.
2163 If OBJECT is an overlay, that overlay has a `help-echo' property,
2164 and POS is the position in the overlay's buffer under the mouse.
2166 If OBJECT is a string (an overlay string or a string displayed with
2167 the `display' property). POS is the position in that string under
2170 Note: this function may only be called with HELP nil or a string
2171 from X code running asynchronously. */
2174 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2177 if (!NILP (help
) && !STRINGP (help
))
2179 if (FUNCTIONP (help
))
2181 Lisp_Object args
[4];
2186 help
= safe_call (4, args
);
2189 help
= safe_eval (help
);
2191 if (!STRINGP (help
))
2195 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2196 if (!noninteractive
&& STRINGP (help
))
2198 /* The mouse-fixup-help-message Lisp function can call
2199 mouse_position_hook, which resets the mouse_moved flags.
2200 This causes trouble if we are trying to read a mouse motion
2201 event (i.e., if we are inside a `track-mouse' form), so we
2202 restore the mouse_moved flag. */
2203 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2204 help
= call1 (Qmouse_fixup_help_message
, help
);
2210 if (STRINGP (help
) || NILP (help
))
2212 if (!NILP (Vshow_help_function
))
2213 call1 (Vshow_help_function
, help
);
2214 help_echo_showing_p
= STRINGP (help
);
2220 /* Input of single characters from keyboard */
2222 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2223 struct timeval
*end_time
);
2224 static void record_char (Lisp_Object c
);
2226 static Lisp_Object help_form_saved_window_configs
;
2228 read_char_help_form_unwind (Lisp_Object arg
)
2230 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2231 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2232 if (!NILP (window_config
))
2233 Fset_window_configuration (window_config
);
2237 #define STOP_POLLING \
2238 do { if (! polling_stopped_here) stop_polling (); \
2239 polling_stopped_here = 1; } while (0)
2241 #define RESUME_POLLING \
2242 do { if (polling_stopped_here) start_polling (); \
2243 polling_stopped_here = 0; } while (0)
2245 /* read a character from the keyboard; call the redisplay if needed */
2246 /* commandflag 0 means do not autosave, but do redisplay.
2247 -1 means do not redisplay, but do autosave.
2250 /* The arguments MAPS and NMAPS are for menu prompting.
2251 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2253 PREV_EVENT is the previous input event, or nil if we are reading
2254 the first event of a key sequence (or not reading a key sequence).
2255 If PREV_EVENT is t, that is a "magic" value that says
2256 not to run input methods, but in other respects to act as if
2257 not reading a key sequence.
2259 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2260 if we used a mouse menu to read the input, or zero otherwise. If
2261 USED_MOUSE_MENU is null, we don't dereference it.
2263 Value is -2 when we find input on another keyboard. A second call
2264 to read_char will read it.
2266 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2267 specifying the maximum time to wait until. If no input arrives by
2268 that time, stop waiting and return nil.
2270 Value is t if we showed a menu and the user rejected it. */
2273 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2274 Lisp_Object prev_event
,
2275 int *used_mouse_menu
, struct timeval
*end_time
)
2277 volatile Lisp_Object c
;
2279 jmp_buf local_getcjmp
;
2281 volatile int key_already_recorded
= 0;
2282 Lisp_Object tem
, save
;
2283 volatile Lisp_Object previous_echo_area_message
;
2284 volatile Lisp_Object also_record
;
2285 volatile int reread
;
2286 struct gcpro gcpro1
, gcpro2
;
2287 int volatile polling_stopped_here
= 0;
2288 struct kboard
*orig_kboard
= current_kboard
;
2292 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2293 before_command_key_count
= this_command_key_count
;
2294 before_command_echo_length
= echo_length ();
2297 previous_echo_area_message
= Qnil
;
2299 GCPRO2 (c
, previous_echo_area_message
);
2304 if (CONSP (Vunread_post_input_method_events
))
2306 c
= XCAR (Vunread_post_input_method_events
);
2307 Vunread_post_input_method_events
2308 = XCDR (Vunread_post_input_method_events
);
2310 /* Undo what read_char_x_menu_prompt did when it unread
2311 additional keys returned by Fx_popup_menu. */
2313 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2321 if (unread_command_char
!= -1)
2323 XSETINT (c
, unread_command_char
);
2324 unread_command_char
= -1;
2330 if (CONSP (Vunread_command_events
))
2332 int was_disabled
= 0;
2334 c
= XCAR (Vunread_command_events
);
2335 Vunread_command_events
= XCDR (Vunread_command_events
);
2339 /* Undo what sit-for did when it unread additional keys
2340 inside universal-argument. */
2343 && EQ (XCAR (c
), Qt
))
2349 /* Undo what read_char_x_menu_prompt did when it unread
2350 additional keys returned by Fx_popup_menu. */
2352 && EQ (XCDR (c
), Qdisabled
)
2353 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2359 /* If the queued event is something that used the mouse,
2360 set used_mouse_menu accordingly. */
2362 /* Also check was_disabled so last-nonmenu-event won't return
2363 a bad value when submenus are involved. (Bug#447) */
2364 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2365 *used_mouse_menu
= 1;
2367 goto reread_for_input_method
;
2370 if (CONSP (Vunread_input_method_events
))
2372 c
= XCAR (Vunread_input_method_events
);
2373 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2375 /* Undo what read_char_x_menu_prompt did when it unread
2376 additional keys returned by Fx_popup_menu. */
2378 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2382 goto reread_for_input_method
;
2385 this_command_key_count_reset
= 0;
2387 if (!NILP (Vexecuting_kbd_macro
))
2389 /* We set this to Qmacro; since that's not a frame, nobody will
2390 try to switch frames on us, and the selected window will
2393 Since this event came from a macro, it would be misleading to
2394 leave internal_last_event_frame set to wherever the last
2395 real event came from. Normally, a switch-frame event selects
2396 internal_last_event_frame after each command is read, but
2397 events read from a macro should never cause a new frame to be
2399 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2401 /* Exit the macro if we are at the end.
2402 Also, some things replace the macro with t
2403 to force an early exit. */
2404 if (EQ (Vexecuting_kbd_macro
, Qt
)
2405 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2411 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2412 if (STRINGP (Vexecuting_kbd_macro
)
2413 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2414 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2416 executing_kbd_macro_index
++;
2421 if (!NILP (unread_switch_frame
))
2423 c
= unread_switch_frame
;
2424 unread_switch_frame
= Qnil
;
2426 /* This event should make it into this_command_keys, and get echoed
2427 again, so we do not set `reread'. */
2431 /* if redisplay was requested */
2432 if (commandflag
>= 0)
2434 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2436 /* If there is pending input, process any events which are not
2437 user-visible, such as X selection_request events. */
2439 || detect_input_pending_run_timers (0))
2440 swallow_events (0); /* may clear input_pending */
2442 /* Redisplay if no pending input. */
2443 while (!input_pending
)
2445 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2446 redisplay_preserve_echo_area (5);
2451 /* Normal case: no input arrived during redisplay. */
2454 /* Input arrived and pre-empted redisplay.
2455 Process any events which are not user-visible. */
2457 /* If that cleared input_pending, try again to redisplay. */
2460 /* Prevent the redisplay we just did
2461 from messing up echoing of the input after the prompt. */
2462 if (commandflag
== 0 && echo_current
)
2463 echo_message_buffer
= echo_area_buffer
[0];
2467 /* Message turns off echoing unless more keystrokes turn it on again.
2469 The code in 20.x for the condition was
2471 1. echo_area_glyphs && *echo_area_glyphs
2472 2. && echo_area_glyphs != current_kboard->echobuf
2473 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2475 (1) means there's a current message displayed
2477 (2) means it's not the message from echoing from the current
2480 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2481 is set to a non-null value. This is done in read_char and it is
2482 set to echo_area_glyphs after a call to echo_char. That means
2483 ok_to_echo_at_next_pause is either null or
2484 current_kboard->echobuf with the appropriate current_kboard at
2487 So, condition (3) means in clear text ok_to_echo_at_next_pause
2488 must be either null, or the current message isn't from echoing at
2489 all, or it's from echoing from a different kboard than the
2492 if (/* There currently is something in the echo area. */
2493 !NILP (echo_area_buffer
[0])
2494 && (/* And it's either not from echoing. */
2495 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2496 /* Or it's an echo from a different kboard. */
2497 || echo_kboard
!= current_kboard
2498 /* Or we explicitly allow overwriting whatever there is. */
2499 || ok_to_echo_at_next_pause
== NULL
))
2504 /* Try reading a character via menu prompting in the minibuf.
2505 Try this before the sit-for, because the sit-for
2506 would do the wrong thing if we are supposed to do
2507 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2508 after a mouse event so don't try a minibuf menu. */
2510 if (nmaps
> 0 && INTERACTIVE
2511 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2512 /* Don't bring up a menu if we already have another event. */
2513 && NILP (Vunread_command_events
)
2514 && unread_command_char
< 0
2515 && !detect_input_pending_run_timers (0))
2517 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2519 if (INTEGERP (c
) && XINT (c
) == -2)
2520 return c
; /* wrong_kboard_jmpbuf */
2524 key_already_recorded
= 1;
2529 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2530 We will do that below, temporarily for short sections of code,
2531 when appropriate. local_getcjmp must be in effect
2532 around any call to sit_for or kbd_buffer_get_event;
2533 it *must not* be in effect when we call redisplay. */
2535 jmpcount
= SPECPDL_INDEX ();
2536 if (_setjmp (local_getcjmp
))
2538 /* Handle quits while reading the keyboard. */
2539 /* We must have saved the outer value of getcjmp here,
2540 so restore it now. */
2541 restore_getcjmp (save_jump
);
2542 unbind_to (jmpcount
, Qnil
);
2543 XSETINT (c
, quit_char
);
2544 internal_last_event_frame
= selected_frame
;
2545 Vlast_event_frame
= internal_last_event_frame
;
2546 /* If we report the quit char as an event,
2547 don't do so more than once. */
2548 if (!NILP (Vinhibit_quit
))
2552 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2553 if (kb
!= current_kboard
)
2555 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2556 /* We shouldn't get here if we were in single-kboard mode! */
2561 while (CONSP (XCDR (last
)))
2563 if (!NILP (XCDR (last
)))
2567 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2569 XSETCDR (last
, Fcons (c
, Qnil
));
2570 kb
->kbd_queue_has_data
= 1;
2571 current_kboard
= kb
;
2572 /* This is going to exit from read_char
2573 so we had better get rid of this frame's stuff. */
2575 return make_number (-2); /* wrong_kboard_jmpbuf */
2581 /* Start idle timers if no time limit is supplied. We don't do it
2582 if a time limit is supplied to avoid an infinite recursion in the
2583 situation where an idle timer calls `sit-for'. */
2586 timer_start_idle ();
2588 /* If in middle of key sequence and minibuffer not active,
2589 start echoing if enough time elapses. */
2591 if (minibuf_level
== 0
2593 && !current_kboard
->immediate_echo
2594 && this_command_key_count
> 0
2596 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2597 && NILP (Fzerop (Vecho_keystrokes
))
2598 && (/* No message. */
2599 NILP (echo_area_buffer
[0])
2600 /* Or empty message. */
2601 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2602 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2603 /* Or already echoing from same kboard. */
2604 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2605 /* Or not echoing before and echoing allowed. */
2606 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2608 /* After a mouse event, start echoing right away.
2609 This is because we are probably about to display a menu,
2610 and we don't want to delay before doing so. */
2611 if (EVENT_HAS_PARAMETERS (prev_event
))
2617 save_getcjmp (save_jump
);
2618 restore_getcjmp (local_getcjmp
);
2619 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2620 restore_getcjmp (save_jump
);
2622 && ! CONSP (Vunread_command_events
))
2627 /* Maybe auto save due to number of keystrokes. */
2629 if (commandflag
!= 0
2630 && auto_save_interval
> 0
2631 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2632 && !detect_input_pending_run_timers (0))
2634 Fdo_auto_save (Qnil
, Qnil
);
2635 /* Hooks can actually change some buffers in auto save. */
2639 /* Try reading using an X menu.
2640 This is never confused with reading using the minibuf
2641 because the recursive call of read_char in read_char_minibuf_menu_prompt
2642 does not pass on any keymaps. */
2644 if (nmaps
> 0 && INTERACTIVE
2645 && !NILP (prev_event
)
2646 && EVENT_HAS_PARAMETERS (prev_event
)
2647 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2648 && !EQ (XCAR (prev_event
), Qtool_bar
)
2649 /* Don't bring up a menu if we already have another event. */
2650 && NILP (Vunread_command_events
)
2651 && unread_command_char
< 0)
2653 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2655 /* Now that we have read an event, Emacs is not idle. */
2662 /* Maybe autosave and/or garbage collect due to idleness. */
2664 if (INTERACTIVE
&& NILP (c
))
2667 EMACS_INT buffer_size
;
2669 /* Slow down auto saves logarithmically in size of current buffer,
2670 and garbage collect while we're at it. */
2671 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2672 last_non_minibuf_size
= Z
- BEG
;
2673 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2675 while (buffer_size
> 64)
2676 delay_level
++, buffer_size
-= buffer_size
>> 2;
2677 if (delay_level
< 4) delay_level
= 4;
2678 /* delay_level is 4 for files under around 50k, 7 at 100k,
2679 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2681 /* Auto save if enough time goes by without input. */
2682 if (commandflag
!= 0
2683 && num_nonmacro_input_events
> last_auto_save
2684 && INTEGERP (Vauto_save_timeout
)
2685 && XINT (Vauto_save_timeout
) > 0)
2688 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2690 save_getcjmp (save_jump
);
2691 restore_getcjmp (local_getcjmp
);
2692 tem0
= sit_for (make_number (timeout
), 1, 1);
2693 restore_getcjmp (save_jump
);
2696 && ! CONSP (Vunread_command_events
))
2698 Fdo_auto_save (Qnil
, Qnil
);
2700 /* If we have auto-saved and there is still no input
2701 available, garbage collect if there has been enough
2702 consing going on to make it worthwhile. */
2703 if (!detect_input_pending_run_timers (0)
2704 && consing_since_gc
> gc_cons_threshold
/ 2)
2705 Fgarbage_collect ();
2712 /* Notify the caller if an autosave hook, or a timer, sentinel or
2713 filter in the sit_for calls above have changed the current
2714 kboard. This could happen if they use the minibuffer or start a
2715 recursive edit, like the fancy splash screen in server.el's
2716 filter. If this longjmp wasn't here, read_key_sequence would
2717 interpret the next key sequence using the wrong translation
2718 tables and function keymaps. */
2719 if (NILP (c
) && current_kboard
!= orig_kboard
)
2722 return make_number (-2); /* wrong_kboard_jmpbuf */
2725 /* If this has become non-nil here, it has been set by a timer
2726 or sentinel or filter. */
2727 if (CONSP (Vunread_command_events
))
2729 c
= XCAR (Vunread_command_events
);
2730 Vunread_command_events
= XCDR (Vunread_command_events
);
2733 /* Read something from current KBOARD's side queue, if possible. */
2737 if (current_kboard
->kbd_queue_has_data
)
2739 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2741 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2742 KVAR (current_kboard
, kbd_queue
)
2743 = XCDR (KVAR (current_kboard
, kbd_queue
));
2744 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2745 current_kboard
->kbd_queue_has_data
= 0;
2746 input_pending
= readable_events (0);
2747 if (EVENT_HAS_PARAMETERS (c
)
2748 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2749 internal_last_event_frame
= XCAR (XCDR (c
));
2750 Vlast_event_frame
= internal_last_event_frame
;
2754 /* If current_kboard's side queue is empty check the other kboards.
2755 If one of them has data that we have not yet seen here,
2756 switch to it and process the data waiting for it.
2758 Note: if the events queued up for another kboard
2759 have already been seen here, and therefore are not a complete command,
2760 the kbd_queue_has_data field is 0, so we skip that kboard here.
2761 That's to avoid an infinite loop switching between kboards here. */
2762 if (NILP (c
) && !single_kboard
)
2765 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2766 if (kb
->kbd_queue_has_data
)
2768 current_kboard
= kb
;
2769 /* This is going to exit from read_char
2770 so we had better get rid of this frame's stuff. */
2772 return make_number (-2); /* wrong_kboard_jmpbuf */
2780 /* Finally, we read from the main queue,
2781 and if that gives us something we can't use yet, we put it on the
2782 appropriate side queue and try again. */
2786 KBOARD
*kb
IF_LINT (= NULL
);
2791 EMACS_GET_TIME (now
);
2792 if (EMACS_TIME_GE (now
, *end_time
))
2796 /* Actually read a character, waiting if necessary. */
2797 save_getcjmp (save_jump
);
2798 restore_getcjmp (local_getcjmp
);
2800 timer_start_idle ();
2801 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2802 restore_getcjmp (save_jump
);
2804 if (! NILP (c
) && (kb
!= current_kboard
))
2806 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2809 while (CONSP (XCDR (last
)))
2811 if (!NILP (XCDR (last
)))
2815 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2817 XSETCDR (last
, Fcons (c
, Qnil
));
2818 kb
->kbd_queue_has_data
= 1;
2822 current_kboard
= kb
;
2823 /* This is going to exit from read_char
2824 so we had better get rid of this frame's stuff. */
2826 return make_number (-2);
2830 /* Terminate Emacs in batch mode if at eof. */
2831 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2832 Fkill_emacs (make_number (1));
2836 /* Add in any extra modifiers, where appropriate. */
2837 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2838 || ((extra_keyboard_modifiers
& 0177) < ' '
2839 && (extra_keyboard_modifiers
& 0177) != 0))
2840 XSETINT (c
, make_ctrl_char (XINT (c
)));
2842 /* Transfer any other modifier bits directly from
2843 extra_keyboard_modifiers to c. Ignore the actual character code
2844 in the low 16 bits of extra_keyboard_modifiers. */
2845 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2856 if (commandflag
>= 0
2857 && !input_pending
&& !detect_input_pending_run_timers (0))
2865 /* Buffer switch events are only for internal wakeups
2866 so don't show them to the user.
2867 Also, don't record a key if we already did. */
2868 if (BUFFERP (c
) || key_already_recorded
)
2871 /* Process special events within read_char
2872 and loop around to read another event. */
2875 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2880 struct buffer
*prev_buffer
= current_buffer
;
2881 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2882 int was_locked
= single_kboard
;
2883 int count
= SPECPDL_INDEX ();
2884 record_single_kboard_state ();
2887 last_input_event
= c
;
2888 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2890 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2891 /* We stopped being idle for this event; undo that. This
2892 prevents automatic window selection (under
2893 mouse_autoselect_window from acting as a real input event, for
2894 example banishing the mouse under mouse-avoidance-mode. */
2895 timer_resume_idle ();
2897 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2898 /* Resume allowing input from any kboard, if that was true before. */
2900 any_kboard_state ();
2901 unbind_to (count
, Qnil
);
2904 if (current_buffer
!= prev_buffer
)
2906 /* The command may have changed the keymaps. Pretend there
2907 is input in another keyboard and return. This will
2908 recalculate keymaps. */
2909 c
= make_number (-2);
2916 /* Handle things that only apply to characters. */
2919 /* If kbd_buffer_get_event gave us an EOF, return that. */
2923 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2924 && UNSIGNED_CMP (XFASTINT (c
), <,
2925 SCHARS (KVAR (current_kboard
,
2926 Vkeyboard_translate_table
))))
2927 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2928 && UNSIGNED_CMP (XFASTINT (c
), <,
2929 ASIZE (KVAR (current_kboard
,
2930 Vkeyboard_translate_table
))))
2931 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2935 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2936 /* nil in keyboard-translate-table means no translation. */
2942 /* If this event is a mouse click in the menu bar,
2943 return just menu-bar for now. Modify the mouse click event
2944 so we won't do this twice, then queue it up. */
2945 if (EVENT_HAS_PARAMETERS (c
)
2947 && CONSP (EVENT_START (c
))
2948 && CONSP (XCDR (EVENT_START (c
))))
2952 posn
= POSN_POSN (EVENT_START (c
));
2953 /* Handle menu-bar events:
2954 insert the dummy prefix event `menu-bar'. */
2955 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2957 /* Change menu-bar to (menu-bar) as the event "position". */
2958 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2961 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2966 /* Store these characters into recent_keys, the dribble file if any,
2967 and the keyboard macro being defined, if any. */
2969 if (! NILP (also_record
))
2970 record_char (also_record
);
2972 /* Wipe the echo area.
2973 But first, if we are about to use an input method,
2974 save the echo area contents for it to refer to. */
2976 && ! NILP (Vinput_method_function
)
2977 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2979 previous_echo_area_message
= Fcurrent_message ();
2980 Vinput_method_previous_message
= previous_echo_area_message
;
2983 /* Now wipe the echo area, except for help events which do their
2984 own stuff with the echo area. */
2986 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2987 && !(EQ (Qswitch_frame
, XCAR (c
)))
2988 /* Don't wipe echo area for select window events: These might
2989 get delayed via `mouse-autoselect-window' (Bug#11304). */
2990 && !(EQ (Qselect_window
, XCAR (c
)))))
2992 if (!NILP (echo_area_buffer
[0]))
2993 safe_run_hooks (Qecho_area_clear_hook
);
2994 clear_message (1, 0);
2997 reread_for_input_method
:
2999 /* Pass this to the input method, if appropriate. */
3001 && ! NILP (Vinput_method_function
)
3002 /* Don't run the input method within a key sequence,
3003 after the first event of the key sequence. */
3004 && NILP (prev_event
)
3005 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3008 int key_count
, key_count_reset
;
3009 struct gcpro gcpro1
;
3010 int count
= SPECPDL_INDEX ();
3012 /* Save the echo status. */
3013 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3014 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3015 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3016 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3019 if (before_command_restore_flag
)
3021 this_command_key_count
= before_command_key_count_1
;
3022 if (this_command_key_count
< this_single_command_key_start
)
3023 this_single_command_key_start
= this_command_key_count
;
3024 echo_truncate (before_command_echo_length_1
);
3025 before_command_restore_flag
= 0;
3029 /* Save the this_command_keys status. */
3030 key_count
= this_command_key_count
;
3031 key_count_reset
= this_command_key_count_reset
;
3034 keys
= Fcopy_sequence (this_command_keys
);
3039 /* Clear out this_command_keys. */
3040 this_command_key_count
= 0;
3041 this_command_key_count_reset
= 0;
3043 /* Now wipe the echo area. */
3044 if (!NILP (echo_area_buffer
[0]))
3045 safe_run_hooks (Qecho_area_clear_hook
);
3046 clear_message (1, 0);
3049 /* If we are not reading a key sequence,
3050 never use the echo area. */
3053 specbind (Qinput_method_use_echo_area
, Qt
);
3056 /* Call the input method. */
3057 tem
= call1 (Vinput_method_function
, c
);
3059 tem
= unbind_to (count
, tem
);
3061 /* Restore the saved echoing state
3062 and this_command_keys state. */
3063 this_command_key_count
= key_count
;
3064 this_command_key_count_reset
= key_count_reset
;
3066 this_command_keys
= keys
;
3069 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3070 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3071 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3072 if (saved_immediate_echo
)
3077 /* The input method can return no events. */
3080 /* Bring back the previous message, if any. */
3081 if (! NILP (previous_echo_area_message
))
3082 message_with_string ("%s", previous_echo_area_message
, 0);
3085 /* It returned one event or more. */
3087 Vunread_post_input_method_events
3088 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3093 /* Display help if not echoing. */
3094 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3096 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3097 Lisp_Object help
, object
, position
, window
, htem
;
3099 htem
= Fcdr (XCDR (c
));
3102 window
= Fcar (htem
);
3104 object
= Fcar (htem
);
3106 position
= Fcar (htem
);
3108 show_help_echo (help
, window
, object
, position
);
3110 /* We stopped being idle for this event; undo that. */
3112 timer_resume_idle ();
3116 if ((! reread
|| this_command_key_count
== 0
3117 || this_command_key_count_reset
)
3121 /* Don't echo mouse motion events. */
3122 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3123 && NILP (Fzerop (Vecho_keystrokes
))
3124 && ! (EVENT_HAS_PARAMETERS (c
)
3125 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3128 if (! NILP (also_record
))
3129 echo_char (also_record
);
3130 /* Once we reread a character, echoing can happen
3131 the next time we pause to read a new one. */
3132 ok_to_echo_at_next_pause
= current_kboard
;
3135 /* Record this character as part of the current key. */
3136 add_command_key (c
);
3137 if (! NILP (also_record
))
3138 add_command_key (also_record
);
3141 last_input_event
= c
;
3144 /* Process the help character specially if enabled */
3145 if (!NILP (Vhelp_form
) && help_char_p (c
))
3147 int count
= SPECPDL_INDEX ();
3149 help_form_saved_window_configs
3150 = Fcons (Fcurrent_window_configuration (Qnil
),
3151 help_form_saved_window_configs
);
3152 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3153 call0 (Qhelp_form_show
);
3158 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3159 if (EVENT_HAS_PARAMETERS (c
)
3160 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3161 XSETCAR (help_form_saved_window_configs
, Qnil
);
3163 while (BUFFERP (c
));
3164 /* Remove the help from the frame */
3165 unbind_to (count
, Qnil
);
3168 if (EQ (c
, make_number (040)))
3172 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3173 while (BUFFERP (c
));
3182 /* Record a key that came from a mouse menu.
3183 Record it for echoing, for this-command-keys, and so on. */
3186 record_menu_key (Lisp_Object c
)
3188 /* Wipe the echo area. */
3189 clear_message (1, 0);
3194 before_command_key_count
= this_command_key_count
;
3195 before_command_echo_length
= echo_length ();
3198 /* Don't echo mouse motion events. */
3199 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3200 && NILP (Fzerop (Vecho_keystrokes
)))
3204 /* Once we reread a character, echoing can happen
3205 the next time we pause to read a new one. */
3206 ok_to_echo_at_next_pause
= 0;
3209 /* Record this character as part of the current key. */
3210 add_command_key (c
);
3212 /* Re-reading in the middle of a command */
3213 last_input_event
= c
;
3217 /* Return 1 if should recognize C as "the help character". */
3220 help_char_p (Lisp_Object c
)
3224 if (EQ (c
, Vhelp_char
))
3226 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3227 if (EQ (c
, XCAR (tail
)))
3232 /* Record the input event C in various ways. */
3235 record_char (Lisp_Object c
)
3239 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3241 /* To avoid filling recent_keys with help-echo and mouse-movement
3242 events, we filter out repeated help-echo events, only store the
3243 first and last in a series of mouse-movement events, and don't
3244 store repeated help-echo events which are only separated by
3245 mouse-movement events. */
3247 Lisp_Object ev1
, ev2
, ev3
;
3250 if ((ix1
= recent_keys_index
- 1) < 0)
3251 ix1
= NUM_RECENT_KEYS
- 1;
3252 ev1
= AREF (recent_keys
, ix1
);
3254 if ((ix2
= ix1
- 1) < 0)
3255 ix2
= NUM_RECENT_KEYS
- 1;
3256 ev2
= AREF (recent_keys
, ix2
);
3258 if ((ix3
= ix2
- 1) < 0)
3259 ix3
= NUM_RECENT_KEYS
- 1;
3260 ev3
= AREF (recent_keys
, ix3
);
3262 if (EQ (XCAR (c
), Qhelp_echo
))
3264 /* Don't record `help-echo' in recent_keys unless it shows some help
3265 message, and a different help than the previously recorded
3267 Lisp_Object help
, last_help
;
3269 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3270 if (!STRINGP (help
))
3272 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3273 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3275 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3276 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3277 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3279 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3280 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3281 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3282 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3285 else if (EQ (XCAR (c
), Qmouse_movement
))
3287 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3288 So additional mouse movement events replace the last element. */
3289 Lisp_Object last_window
, window
;
3291 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3292 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3293 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3294 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3295 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3297 ASET (recent_keys
, ix1
, c
);
3303 store_kbd_macro_char (c
);
3308 ASET (recent_keys
, recent_keys_index
, c
);
3309 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3310 recent_keys_index
= 0;
3312 else if (recorded
< 0)
3314 /* We need to remove one or two events from recent_keys.
3315 To do this, we simply put nil at those events and move the
3316 recent_keys_index backwards over those events. Usually,
3317 users will never see those nil events, as they will be
3318 overwritten by the command keys entered to see recent_keys
3321 while (recorded
++ < 0 && total_keys
> 0)
3323 if (total_keys
< NUM_RECENT_KEYS
)
3325 if (--recent_keys_index
< 0)
3326 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3327 ASET (recent_keys
, recent_keys_index
, Qnil
);
3331 num_nonmacro_input_events
++;
3333 /* Write c to the dribble file. If c is a lispy event, write
3334 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3335 If you, dear reader, have a better idea, you've got the source. :-) */
3341 if (XUINT (c
) < 0x100)
3342 putc (XUINT (c
), dribble
);
3344 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3348 Lisp_Object dribblee
;
3350 /* If it's a structured event, take the event header. */
3351 dribblee
= EVENT_HEAD (c
);
3353 if (SYMBOLP (dribblee
))
3355 putc ('<', dribble
);
3356 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3357 SBYTES (SYMBOL_NAME (dribblee
)),
3359 putc ('>', dribble
);
3368 /* Copy out or in the info on where C-g should throw to.
3369 This is used when running Lisp code from within get_char,
3370 in case get_char is called recursively.
3371 See read_process_output. */
3374 save_getcjmp (jmp_buf temp
)
3376 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3380 restore_getcjmp (jmp_buf temp
)
3382 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3385 /* Low level keyboard/mouse input.
3386 kbd_buffer_store_event places events in kbd_buffer, and
3387 kbd_buffer_get_event retrieves them. */
3389 /* Return true if there are any events in the queue that read-char
3390 would return. If this returns false, a read-char would block. */
3392 readable_events (int flags
)
3394 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3397 /* If the buffer contains only FOCUS_IN_EVENT events, and
3398 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3399 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3401 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3402 #ifdef USE_TOOLKIT_SCROLL_BARS
3403 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3407 struct input_event
*event
;
3409 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3416 #ifdef USE_TOOLKIT_SCROLL_BARS
3417 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3419 event
->kind
== FOCUS_IN_EVENT
)
3420 #ifdef USE_TOOLKIT_SCROLL_BARS
3421 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3422 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3423 && event
->part
== scroll_bar_handle
3424 && event
->modifiers
== 0)
3429 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3432 while (event
!= kbd_store_ptr
);
3438 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3439 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3440 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3445 if (current_kboard
->kbd_queue_has_data
)
3451 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3452 if (kb
->kbd_queue_has_data
)
3458 /* Set this for debugging, to have a way to get out */
3459 int stop_character EXTERNALLY_VISIBLE
;
3462 event_to_kboard (struct input_event
*event
)
3465 frame
= event
->frame_or_window
;
3467 frame
= XCAR (frame
);
3468 else if (WINDOWP (frame
))
3469 frame
= WINDOW_FRAME (XWINDOW (frame
));
3471 /* There are still some events that don't set this field.
3472 For now, just ignore the problem.
3473 Also ignore dead frames here. */
3474 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3477 return FRAME_KBOARD (XFRAME (frame
));
3481 /* Return the number of slots occupied in kbd_buffer. */
3484 kbd_buffer_nr_stored (void)
3486 return kbd_fetch_ptr
== kbd_store_ptr
3488 : (kbd_fetch_ptr
< kbd_store_ptr
3489 ? kbd_store_ptr
- kbd_fetch_ptr
3490 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3491 + (kbd_store_ptr
- kbd_buffer
)));
3493 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3496 kbd_buffer_store_event (register struct input_event
*event
)
3498 kbd_buffer_store_event_hold (event
, 0);
3501 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3503 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3504 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3505 Else, if EVENT is a quit event, store the quit event
3506 in HOLD_QUIT, and return (thus ignoring further events).
3508 This is used in read_avail_input to postpone the processing
3509 of the quit event until all subsequent input events have been
3510 parsed (and discarded).
3514 kbd_buffer_store_event_hold (register struct input_event
*event
,
3515 struct input_event
*hold_quit
)
3517 if (event
->kind
== NO_EVENT
)
3520 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3523 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3525 register int c
= event
->code
& 0377;
3527 if (event
->modifiers
& ctrl_modifier
)
3528 c
= make_ctrl_char (c
);
3530 c
|= (event
->modifiers
3531 & (meta_modifier
| alt_modifier
3532 | hyper_modifier
| super_modifier
));
3536 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3537 struct input_event
*sp
;
3539 if (single_kboard
&& kb
!= current_kboard
)
3541 KVAR (kb
, kbd_queue
)
3542 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3543 Fcons (make_number (c
), Qnil
));
3544 kb
->kbd_queue_has_data
= 1;
3545 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3547 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3550 if (event_to_kboard (sp
) == kb
)
3552 sp
->kind
= NO_EVENT
;
3553 sp
->frame_or_window
= Qnil
;
3562 memcpy (hold_quit
, event
, sizeof (*event
));
3566 /* If this results in a quit_char being returned to Emacs as
3567 input, set Vlast_event_frame properly. If this doesn't
3568 get returned to Emacs as an event, the next event read
3569 will set Vlast_event_frame again, so this is safe to do. */
3573 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3575 focus
= event
->frame_or_window
;
3576 internal_last_event_frame
= focus
;
3577 Vlast_event_frame
= focus
;
3580 last_event_timestamp
= event
->timestamp
;
3581 handle_interrupt ();
3585 if (c
&& c
== stop_character
)
3591 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3592 Just ignore the second one. */
3593 else if (event
->kind
== BUFFER_SWITCH_EVENT
3594 && kbd_fetch_ptr
!= kbd_store_ptr
3595 && ((kbd_store_ptr
== kbd_buffer
3596 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3597 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3600 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3601 kbd_store_ptr
= kbd_buffer
;
3603 /* Don't let the very last slot in the buffer become full,
3604 since that would make the two pointers equal,
3605 and that is indistinguishable from an empty buffer.
3606 Discard the event if it would fill the last slot. */
3607 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3609 *kbd_store_ptr
= *event
;
3612 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3614 /* Don't read keyboard input until we have processed kbd_buffer.
3615 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3616 hold_keyboard_input ();
3618 if (!noninteractive
)
3619 signal (SIGIO
, SIG_IGN
);
3623 #endif /* subprocesses */
3626 /* If we're inside while-no-input, and this event qualifies
3627 as input, set quit-flag to cause an interrupt. */
3628 if (!NILP (Vthrow_on_input
)
3629 && event
->kind
!= FOCUS_IN_EVENT
3630 && event
->kind
!= HELP_EVENT
3631 && event
->kind
!= DEICONIFY_EVENT
)
3633 Vquit_flag
= Vthrow_on_input
;
3634 /* If we're inside a function that wants immediate quits,
3636 if (immediate_quit
&& NILP (Vinhibit_quit
))
3646 /* Put an input event back in the head of the event queue. */
3649 kbd_buffer_unget_event (register struct input_event
*event
)
3651 if (kbd_fetch_ptr
== kbd_buffer
)
3652 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3654 /* Don't let the very last slot in the buffer become full, */
3655 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3658 *kbd_fetch_ptr
= *event
;
3663 /* Generate a HELP_EVENT input_event and store it in the keyboard
3666 HELP is the help form.
3668 FRAME and WINDOW are the frame and window where the help is
3669 generated. OBJECT is the Lisp object where the help was found (a
3670 buffer, a string, an overlay, or nil if neither from a string nor
3671 from a buffer). POS is the position within OBJECT where the help
3675 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3676 Lisp_Object object
, EMACS_INT pos
)
3678 struct input_event event
;
3682 event
.kind
= HELP_EVENT
;
3683 event
.frame_or_window
= frame
;
3685 event
.x
= WINDOWP (window
) ? window
: frame
;
3688 kbd_buffer_store_event (&event
);
3692 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3695 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3697 struct input_event event
;
3699 event
.kind
= HELP_EVENT
;
3700 event
.frame_or_window
= frame
;
3705 kbd_buffer_store_event (&event
);
3709 /* Discard any mouse events in the event buffer by setting them to
3712 discard_mouse_events (void)
3714 struct input_event
*sp
;
3715 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3717 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3720 if (sp
->kind
== MOUSE_CLICK_EVENT
3721 || sp
->kind
== WHEEL_EVENT
3722 || sp
->kind
== HORIZ_WHEEL_EVENT
3724 || sp
->kind
== GPM_CLICK_EVENT
3726 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3728 sp
->kind
= NO_EVENT
;
3734 /* Return non-zero if there are any real events waiting in the event
3735 buffer, not counting `NO_EVENT's.
3737 If DISCARD is non-zero, discard NO_EVENT events at the front of
3738 the input queue, possibly leaving the input queue empty if there
3739 are no real input events. */
3742 kbd_buffer_events_waiting (int discard
)
3744 struct input_event
*sp
;
3746 for (sp
= kbd_fetch_ptr
;
3747 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3750 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3757 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3761 /* Clear input event EVENT. */
3764 clear_event (struct input_event
*event
)
3766 event
->kind
= NO_EVENT
;
3770 /* Read one event from the event buffer, waiting if necessary.
3771 The value is a Lisp object representing the event.
3772 The value is nil for an event that should be ignored,
3773 or that was handled here.
3774 We always read and discard one event. */
3777 kbd_buffer_get_event (KBOARD
**kbp
,
3778 int *used_mouse_menu
,
3779 struct timeval
*end_time
)
3785 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3787 /* Start reading input again, we have processed enough so we can
3788 accept new events again. */
3789 unhold_keyboard_input ();
3791 if (!noninteractive
)
3792 signal (SIGIO
, input_available_signal
);
3796 #endif /* subprocesses */
3799 /* In case we are running as a daemon, only do this before
3800 detaching from the terminal. */
3801 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3805 *kbp
= current_kboard
;
3809 /* Wait until there is input available. */
3812 /* Break loop if there's an unread command event. Needed in
3813 moused window autoselection which uses a timer to insert such
3815 if (CONSP (Vunread_command_events
))
3818 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3820 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3821 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3825 /* If the quit flag is set, then read_char will return
3826 quit_char, so that counts as "available input." */
3827 if (!NILP (Vquit_flag
))
3828 quit_throw_to_read_char (0);
3830 /* One way or another, wait until input is available; then, if
3831 interrupt handlers have not read it, read it now. */
3833 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3837 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3839 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3840 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3845 EMACS_TIME duration
;
3846 EMACS_GET_TIME (duration
);
3847 if (EMACS_TIME_GE (duration
, *end_time
))
3848 return Qnil
; /* finished waiting */
3851 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3852 wait_reading_process_output (EMACS_SECS (duration
),
3853 EMACS_USECS (duration
),
3854 -1, 1, Qnil
, NULL
, 0);
3858 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3860 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3861 /* Pass 1 for EXPECT since we just waited to have input. */
3862 read_avail_input (1);
3865 if (CONSP (Vunread_command_events
))
3868 first
= XCAR (Vunread_command_events
);
3869 Vunread_command_events
= XCDR (Vunread_command_events
);
3870 *kbp
= current_kboard
;
3874 /* At this point, we know that there is a readable event available
3875 somewhere. If the event queue is empty, then there must be a
3876 mouse movement enabled and available. */
3877 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3879 struct input_event
*event
;
3881 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3885 last_event_timestamp
= event
->timestamp
;
3887 *kbp
= event_to_kboard (event
);
3889 *kbp
= current_kboard
; /* Better than returning null ptr? */
3893 /* These two kinds of events get special handling
3894 and don't actually appear to the command loop.
3895 We return nil for them. */
3896 if (event
->kind
== SELECTION_REQUEST_EVENT
3897 || event
->kind
== SELECTION_CLEAR_EVENT
)
3900 struct input_event copy
;
3902 /* Remove it from the buffer before processing it,
3903 since otherwise swallow_events will see it
3904 and process it again. */
3906 kbd_fetch_ptr
= event
+ 1;
3907 input_pending
= readable_events (0);
3908 x_handle_selection_event (©
);
3910 /* We're getting selection request events, but we don't have
3916 #if defined (HAVE_NS)
3917 else if (event
->kind
== NS_TEXT_EVENT
)
3919 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3920 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3922 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3923 kbd_fetch_ptr
= event
+ 1;
3924 if (used_mouse_menu
)
3925 *used_mouse_menu
= 1;
3929 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3930 || defined (HAVE_NS)
3931 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3933 /* Make an event (delete-frame (FRAME)). */
3934 obj
= Fcons (event
->frame_or_window
, Qnil
);
3935 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3936 kbd_fetch_ptr
= event
+ 1;
3939 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3940 || defined (HAVE_NS)
3941 else if (event
->kind
== ICONIFY_EVENT
)
3943 /* Make an event (iconify-frame (FRAME)). */
3944 obj
= Fcons (event
->frame_or_window
, Qnil
);
3945 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3946 kbd_fetch_ptr
= event
+ 1;
3948 else if (event
->kind
== DEICONIFY_EVENT
)
3950 /* Make an event (make-frame-visible (FRAME)). */
3951 obj
= Fcons (event
->frame_or_window
, Qnil
);
3952 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3953 kbd_fetch_ptr
= event
+ 1;
3956 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3958 /* The value doesn't matter here; only the type is tested. */
3959 XSETBUFFER (obj
, current_buffer
);
3960 kbd_fetch_ptr
= event
+ 1;
3962 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3963 || defined (HAVE_NS) || defined (USE_GTK)
3964 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3966 kbd_fetch_ptr
= event
+ 1;
3967 input_pending
= readable_events (0);
3968 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3969 x_activate_menubar (XFRAME (event
->frame_or_window
));
3972 #if defined (WINDOWSNT)
3973 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3975 /* Make an event (language-change (FRAME CHARSET LCID)). */
3976 obj
= Fcons (event
->frame_or_window
, Qnil
);
3977 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3978 kbd_fetch_ptr
= event
+ 1;
3981 else if (event
->kind
== SAVE_SESSION_EVENT
)
3983 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3984 kbd_fetch_ptr
= event
+ 1;
3986 /* Just discard these, by returning nil.
3987 With MULTI_KBOARD, these events are used as placeholders
3988 when we need to randomly delete events from the queue.
3989 (They shouldn't otherwise be found in the buffer,
3990 but on some machines it appears they do show up
3991 even without MULTI_KBOARD.) */
3992 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3993 mouse events during a popup-menu call. */
3994 else if (event
->kind
== NO_EVENT
)
3995 kbd_fetch_ptr
= event
+ 1;
3996 else if (event
->kind
== HELP_EVENT
)
3998 Lisp_Object object
, position
, help
, frame
, window
;
4000 frame
= event
->frame_or_window
;
4001 object
= event
->arg
;
4002 position
= make_number (event
->code
);
4005 clear_event (event
);
4007 kbd_fetch_ptr
= event
+ 1;
4008 if (!WINDOWP (window
))
4010 obj
= Fcons (Qhelp_echo
,
4011 list5 (frame
, help
, window
, object
, position
));
4013 else if (event
->kind
== FOCUS_IN_EVENT
)
4015 /* Notification of a FocusIn event. The frame receiving the
4016 focus is in event->frame_or_window. Generate a
4017 switch-frame event if necessary. */
4018 Lisp_Object frame
, focus
;
4020 frame
= event
->frame_or_window
;
4021 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4025 if (!EQ (frame
, internal_last_event_frame
)
4026 && !EQ (frame
, selected_frame
))
4027 obj
= make_lispy_switch_frame (frame
);
4028 internal_last_event_frame
= frame
;
4029 kbd_fetch_ptr
= event
+ 1;
4032 else if (event
->kind
== DBUS_EVENT
)
4034 obj
= make_lispy_event (event
);
4035 kbd_fetch_ptr
= event
+ 1;
4038 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4040 obj
= make_lispy_event (event
);
4041 kbd_fetch_ptr
= event
+ 1;
4045 /* If this event is on a different frame, return a switch-frame this
4046 time, and leave the event in the queue for next time. */
4050 frame
= event
->frame_or_window
;
4052 frame
= XCAR (frame
);
4053 else if (WINDOWP (frame
))
4054 frame
= WINDOW_FRAME (XWINDOW (frame
));
4056 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4060 if (! EQ (frame
, internal_last_event_frame
)
4061 && !EQ (frame
, selected_frame
))
4062 obj
= make_lispy_switch_frame (frame
);
4063 internal_last_event_frame
= frame
;
4065 /* If we didn't decide to make a switch-frame event, go ahead
4066 and build a real event from the queue entry. */
4070 obj
= make_lispy_event (event
);
4072 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4073 || defined (HAVE_NS) || defined (USE_GTK)
4074 /* If this was a menu selection, then set the flag to inhibit
4075 writing to last_nonmenu_event. Don't do this if the event
4076 we're returning is (menu-bar), though; that indicates the
4077 beginning of the menu sequence, and we might as well leave
4078 that as the `event with parameters' for this selection. */
4080 && !EQ (event
->frame_or_window
, event
->arg
)
4081 && (event
->kind
== MENU_BAR_EVENT
4082 || event
->kind
== TOOL_BAR_EVENT
))
4083 *used_mouse_menu
= 1;
4086 /* certain system events are non-key events */
4088 && event
->kind
== NS_NONKEY_EVENT
)
4089 *used_mouse_menu
= 1;
4092 /* Wipe out this event, to catch bugs. */
4093 clear_event (event
);
4094 kbd_fetch_ptr
= event
+ 1;
4098 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4099 /* Try generating a mouse motion event. */
4100 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4102 FRAME_PTR f
= some_mouse_moved ();
4103 Lisp_Object bar_window
;
4104 enum scroll_bar_part part
;
4108 *kbp
= current_kboard
;
4109 /* Note that this uses F to determine which terminal to look at.
4110 If there is no valid info, it does not store anything
4111 so x remains nil. */
4114 /* XXX Can f or mouse_position_hook be NULL here? */
4115 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4116 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4121 /* Decide if we should generate a switch-frame event. Don't
4122 generate switch-frame events for motion outside of all Emacs
4128 frame
= FRAME_FOCUS_FRAME (f
);
4130 XSETFRAME (frame
, f
);
4132 if (! EQ (frame
, internal_last_event_frame
)
4133 && !EQ (frame
, selected_frame
))
4134 obj
= make_lispy_switch_frame (frame
);
4135 internal_last_event_frame
= frame
;
4138 /* If we didn't decide to make a switch-frame event, go ahead and
4139 return a mouse-motion event. */
4140 if (!NILP (x
) && NILP (obj
))
4141 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4143 #endif /* HAVE_MOUSE || HAVE GPM */
4145 /* We were promised by the above while loop that there was
4146 something for us to read! */
4149 input_pending
= readable_events (0);
4151 Vlast_event_frame
= internal_last_event_frame
;
4156 /* Process any non-user-visible events (currently X selection events),
4157 without reading any user-visible events. */
4160 process_special_events (void)
4162 struct input_event
*event
;
4164 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4166 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4169 if (event
== kbd_store_ptr
)
4173 /* If we find a stored X selection request, handle it now. */
4174 if (event
->kind
== SELECTION_REQUEST_EVENT
4175 || event
->kind
== SELECTION_CLEAR_EVENT
)
4179 /* Remove the event from the fifo buffer before processing;
4180 otherwise swallow_events called recursively could see it
4181 and process it again. To do this, we move the events
4182 between kbd_fetch_ptr and EVENT one slot to the right,
4185 struct input_event copy
= *event
;
4186 struct input_event
*beg
4187 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4188 ? kbd_buffer
: kbd_fetch_ptr
;
4191 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4192 else if (event
< beg
)
4194 if (event
> kbd_buffer
)
4195 memmove (kbd_buffer
+ 1, kbd_buffer
,
4196 (event
- kbd_buffer
) * sizeof (struct input_event
));
4197 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4198 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4199 memmove (beg
+ 1, beg
,
4200 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4201 * sizeof (struct input_event
));
4204 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4205 kbd_fetch_ptr
= kbd_buffer
+ 1;
4209 /* X wants last_event_timestamp for selection ownership. */
4210 last_event_timestamp
= copy
.timestamp
;
4211 input_pending
= readable_events (0);
4212 x_handle_selection_event (©
);
4214 /* We're getting selection request events, but we don't have
4222 /* Process any events that are not user-visible, run timer events that
4223 are ripe, and return, without reading any user-visible events. */
4226 swallow_events (int do_display
)
4230 process_special_events ();
4232 old_timers_run
= timers_run
;
4233 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4235 if (timers_run
!= old_timers_run
&& do_display
)
4236 redisplay_preserve_echo_area (7);
4239 /* Record the start of when Emacs is idle,
4240 for the sake of running idle-time timers. */
4243 timer_start_idle (void)
4247 /* If we are already in the idle state, do nothing. */
4248 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4251 EMACS_GET_TIME (timer_idleness_start_time
);
4253 timer_last_idleness_start_time
= timer_idleness_start_time
;
4255 /* Mark all idle-time timers as once again candidates for running. */
4256 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4260 timer
= XCAR (timers
);
4262 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4264 XVECTOR (timer
)->contents
[0] = Qnil
;
4268 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4271 timer_stop_idle (void)
4273 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4276 /* Resume idle timer from last idle start time. */
4279 timer_resume_idle (void)
4281 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4284 timer_idleness_start_time
= timer_last_idleness_start_time
;
4287 /* This is only for debugging. */
4288 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4290 /* List of elisp functions to call, delayed because they were generated in
4291 a context where Elisp could not be safely run (e.g. redisplay, signal,
4292 ...). Each element has the form (FUN . ARGS). */
4293 Lisp_Object pending_funcalls
;
4295 /* Check whether a timer has fired. To prevent larger problems we simply
4296 disregard elements that are not proper timers. Do not make a circular
4297 timer list for the time being.
4299 Returns the time to wait until the next timer fires. If a
4300 timer is triggering now, return zero.
4301 If no timer is active, return -1.
4303 If a timer is ripe, we run it, with quitting turned off.
4304 In that case we return 0 to indicate that a new timer_check_2 call
4308 timer_check_2 (void)
4310 EMACS_TIME nexttime
;
4312 EMACS_TIME idleness_now
IF_LINT (= {0});
4313 Lisp_Object timers
, idle_timers
, chosen_timer
;
4314 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4316 EMACS_SET_SECS (nexttime
, -1);
4317 EMACS_SET_USECS (nexttime
, -1);
4319 /* Always consider the ordinary timers. */
4320 timers
= Vtimer_list
;
4321 /* Consider the idle timers only if Emacs is idle. */
4322 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4323 idle_timers
= Vtimer_idle_list
;
4326 chosen_timer
= Qnil
;
4327 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4329 /* First run the code that was delayed. */
4330 while (CONSP (pending_funcalls
))
4332 Lisp_Object funcall
= XCAR (pending_funcalls
);
4333 pending_funcalls
= XCDR (pending_funcalls
);
4334 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4337 if (CONSP (timers
) || CONSP (idle_timers
))
4339 EMACS_GET_TIME (now
);
4340 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4341 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4344 while (CONSP (timers
) || CONSP (idle_timers
))
4346 Lisp_Object
*vector
;
4347 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4348 EMACS_TIME timer_time
, idle_timer_time
;
4349 EMACS_TIME difference
;
4350 EMACS_TIME timer_difference
IF_LINT (= {0});
4351 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4353 /* Skip past invalid timers and timers already handled. */
4356 timer
= XCAR (timers
);
4357 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4359 timers
= XCDR (timers
);
4362 vector
= XVECTOR (timer
)->contents
;
4364 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4365 || !INTEGERP (vector
[3])
4366 || ! NILP (vector
[0]))
4368 timers
= XCDR (timers
);
4372 if (CONSP (idle_timers
))
4374 timer
= XCAR (idle_timers
);
4375 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4377 idle_timers
= XCDR (idle_timers
);
4380 vector
= XVECTOR (timer
)->contents
;
4382 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4383 || !INTEGERP (vector
[3])
4384 || ! NILP (vector
[0]))
4386 idle_timers
= XCDR (idle_timers
);
4391 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4392 based on the next ordinary timer.
4393 TIMER_DIFFERENCE is the distance in time from NOW to when
4394 this timer becomes ripe (negative if it's already ripe). */
4397 timer
= XCAR (timers
);
4398 vector
= XVECTOR (timer
)->contents
;
4399 EMACS_SET_SECS (timer_time
,
4400 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4401 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4402 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4405 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4406 based on the next idle timer. */
4407 if (CONSP (idle_timers
))
4409 idle_timer
= XCAR (idle_timers
);
4410 vector
= XVECTOR (idle_timer
)->contents
;
4411 EMACS_SET_SECS (idle_timer_time
,
4412 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4413 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4414 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4417 /* Decide which timer is the next timer,
4418 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4419 Also step down the list where we found that timer. */
4421 if (CONSP (timers
) && CONSP (idle_timers
))
4424 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4425 if (EMACS_TIME_NEG_P (temp
))
4427 chosen_timer
= timer
;
4428 timers
= XCDR (timers
);
4429 difference
= timer_difference
;
4433 chosen_timer
= idle_timer
;
4434 idle_timers
= XCDR (idle_timers
);
4435 difference
= idle_timer_difference
;
4438 else if (CONSP (timers
))
4440 chosen_timer
= timer
;
4441 timers
= XCDR (timers
);
4442 difference
= timer_difference
;
4446 chosen_timer
= idle_timer
;
4447 idle_timers
= XCDR (idle_timers
);
4448 difference
= idle_timer_difference
;
4450 vector
= XVECTOR (chosen_timer
)->contents
;
4452 /* If timer is ripe, run it if it hasn't been run. */
4453 if (EMACS_TIME_NEG_P (difference
)
4454 || (EMACS_SECS (difference
) == 0
4455 && EMACS_USECS (difference
) == 0))
4457 if (NILP (vector
[0]))
4459 int count
= SPECPDL_INDEX ();
4460 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4462 /* Mark the timer as triggered to prevent problems if the lisp
4463 code fails to reschedule it right. */
4466 specbind (Qinhibit_quit
, Qt
);
4468 call1 (Qtimer_event_handler
, chosen_timer
);
4469 Vdeactivate_mark
= old_deactivate_mark
;
4471 unbind_to (count
, Qnil
);
4473 /* Since we have handled the event,
4474 we don't need to tell the caller to wake up and do it. */
4475 /* But the caller must still wait for the next timer, so
4476 return 0 to indicate that. */
4479 EMACS_SET_SECS (nexttime
, 0);
4480 EMACS_SET_USECS (nexttime
, 0);
4483 /* When we encounter a timer that is still waiting,
4484 return the amount of time to wait before it is ripe. */
4491 /* No timers are pending in the future. */
4492 /* Return 0 if we generated an event, and -1 if not. */
4498 /* Check whether a timer has fired. To prevent larger problems we simply
4499 disregard elements that are not proper timers. Do not make a circular
4500 timer list for the time being.
4502 Returns the time to wait until the next timer fires.
4503 If no timer is active, return -1.
4505 As long as any timer is ripe, we run it. */
4510 EMACS_TIME nexttime
;
4514 nexttime
= timer_check_2 ();
4516 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4521 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4522 doc
: /* Return the current length of Emacs idleness, or nil.
4523 The value when Emacs is idle is a list of three integers. The first has
4524 the most significant 16 bits of the seconds, while the second has the least
4525 significant 16 bits. The third integer gives the microsecond count.
4527 The value when Emacs is not idle is nil.
4529 The microsecond count is zero on systems that do not provide
4530 resolution finer than a second. */)
4533 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4535 EMACS_TIME now
, idleness_now
;
4537 EMACS_GET_TIME (now
);
4538 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4540 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4541 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4542 make_number (EMACS_USECS (idleness_now
)));
4548 /* Caches for modify_event_symbol. */
4549 static Lisp_Object accent_key_syms
;
4550 static Lisp_Object func_key_syms
;
4551 static Lisp_Object mouse_syms
;
4552 static Lisp_Object wheel_syms
;
4553 static Lisp_Object drag_n_drop_syms
;
4555 /* This is a list of keysym codes for special "accent" characters.
4556 It parallels lispy_accent_keys. */
4558 static const int lispy_accent_codes
[] =
4560 #ifdef XK_dead_circumflex
4565 #ifdef XK_dead_grave
4570 #ifdef XK_dead_tilde
4575 #ifdef XK_dead_diaeresis
4580 #ifdef XK_dead_macron
4585 #ifdef XK_dead_degree
4590 #ifdef XK_dead_acute
4595 #ifdef XK_dead_cedilla
4600 #ifdef XK_dead_breve
4605 #ifdef XK_dead_ogonek
4610 #ifdef XK_dead_caron
4615 #ifdef XK_dead_doubleacute
4616 XK_dead_doubleacute
,
4620 #ifdef XK_dead_abovedot
4625 #ifdef XK_dead_abovering
4635 #ifdef XK_dead_belowdot
4640 #ifdef XK_dead_voiced_sound
4641 XK_dead_voiced_sound
,
4645 #ifdef XK_dead_semivoiced_sound
4646 XK_dead_semivoiced_sound
,
4662 /* This is a list of Lisp names for special "accent" characters.
4663 It parallels lispy_accent_codes. */
4665 static const char *const lispy_accent_keys
[] =
4683 "dead-voiced-sound",
4684 "dead-semivoiced-sound",
4690 #define FUNCTION_KEY_OFFSET 0x0
4692 const char *const lispy_function_keys
[] =
4696 0, /* VK_LBUTTON 0x01 */
4697 0, /* VK_RBUTTON 0x02 */
4698 "cancel", /* VK_CANCEL 0x03 */
4699 0, /* VK_MBUTTON 0x04 */
4701 0, 0, 0, /* 0x05 .. 0x07 */
4703 "backspace", /* VK_BACK 0x08 */
4704 "tab", /* VK_TAB 0x09 */
4706 0, 0, /* 0x0A .. 0x0B */
4708 "clear", /* VK_CLEAR 0x0C */
4709 "return", /* VK_RETURN 0x0D */
4711 0, 0, /* 0x0E .. 0x0F */
4713 0, /* VK_SHIFT 0x10 */
4714 0, /* VK_CONTROL 0x11 */
4715 0, /* VK_MENU 0x12 */
4716 "pause", /* VK_PAUSE 0x13 */
4717 "capslock", /* VK_CAPITAL 0x14 */
4718 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4720 "junja", /* VK_JUNJA 0x17 */
4721 "final", /* VK_FINAL 0x18 */
4722 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4724 "escape", /* VK_ESCAPE 0x1B */
4725 "convert", /* VK_CONVERT 0x1C */
4726 "non-convert", /* VK_NONCONVERT 0x1D */
4727 "accept", /* VK_ACCEPT 0x1E */
4728 "mode-change", /* VK_MODECHANGE 0x1F */
4729 0, /* VK_SPACE 0x20 */
4730 "prior", /* VK_PRIOR 0x21 */
4731 "next", /* VK_NEXT 0x22 */
4732 "end", /* VK_END 0x23 */
4733 "home", /* VK_HOME 0x24 */
4734 "left", /* VK_LEFT 0x25 */
4735 "up", /* VK_UP 0x26 */
4736 "right", /* VK_RIGHT 0x27 */
4737 "down", /* VK_DOWN 0x28 */
4738 "select", /* VK_SELECT 0x29 */
4739 "print", /* VK_PRINT 0x2A */
4740 "execute", /* VK_EXECUTE 0x2B */
4741 "snapshot", /* VK_SNAPSHOT 0x2C */
4742 "insert", /* VK_INSERT 0x2D */
4743 "delete", /* VK_DELETE 0x2E */
4744 "help", /* VK_HELP 0x2F */
4746 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4748 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4750 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4752 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4754 0, 0, 0, 0, 0, 0, 0, 0, 0,
4755 0, 0, 0, 0, 0, 0, 0, 0, 0,
4756 0, 0, 0, 0, 0, 0, 0, 0,
4758 "lwindow", /* VK_LWIN 0x5B */
4759 "rwindow", /* VK_RWIN 0x5C */
4760 "apps", /* VK_APPS 0x5D */
4763 "kp-0", /* VK_NUMPAD0 0x60 */
4764 "kp-1", /* VK_NUMPAD1 0x61 */
4765 "kp-2", /* VK_NUMPAD2 0x62 */
4766 "kp-3", /* VK_NUMPAD3 0x63 */
4767 "kp-4", /* VK_NUMPAD4 0x64 */
4768 "kp-5", /* VK_NUMPAD5 0x65 */
4769 "kp-6", /* VK_NUMPAD6 0x66 */
4770 "kp-7", /* VK_NUMPAD7 0x67 */
4771 "kp-8", /* VK_NUMPAD8 0x68 */
4772 "kp-9", /* VK_NUMPAD9 0x69 */
4773 "kp-multiply", /* VK_MULTIPLY 0x6A */
4774 "kp-add", /* VK_ADD 0x6B */
4775 "kp-separator", /* VK_SEPARATOR 0x6C */
4776 "kp-subtract", /* VK_SUBTRACT 0x6D */
4777 "kp-decimal", /* VK_DECIMAL 0x6E */
4778 "kp-divide", /* VK_DIVIDE 0x6F */
4779 "f1", /* VK_F1 0x70 */
4780 "f2", /* VK_F2 0x71 */
4781 "f3", /* VK_F3 0x72 */
4782 "f4", /* VK_F4 0x73 */
4783 "f5", /* VK_F5 0x74 */
4784 "f6", /* VK_F6 0x75 */
4785 "f7", /* VK_F7 0x76 */
4786 "f8", /* VK_F8 0x77 */
4787 "f9", /* VK_F9 0x78 */
4788 "f10", /* VK_F10 0x79 */
4789 "f11", /* VK_F11 0x7A */
4790 "f12", /* VK_F12 0x7B */
4791 "f13", /* VK_F13 0x7C */
4792 "f14", /* VK_F14 0x7D */
4793 "f15", /* VK_F15 0x7E */
4794 "f16", /* VK_F16 0x7F */
4795 "f17", /* VK_F17 0x80 */
4796 "f18", /* VK_F18 0x81 */
4797 "f19", /* VK_F19 0x82 */
4798 "f20", /* VK_F20 0x83 */
4799 "f21", /* VK_F21 0x84 */
4800 "f22", /* VK_F22 0x85 */
4801 "f23", /* VK_F23 0x86 */
4802 "f24", /* VK_F24 0x87 */
4804 0, 0, 0, 0, /* 0x88 .. 0x8B */
4805 0, 0, 0, 0, /* 0x8C .. 0x8F */
4807 "kp-numlock", /* VK_NUMLOCK 0x90 */
4808 "scroll", /* VK_SCROLL 0x91 */
4809 /* Not sure where the following block comes from.
4810 Windows headers have NEC and Fujitsu specific keys in
4811 this block, but nothing generic. */
4812 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4813 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4814 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4815 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4816 "kp-end", /* VK_NUMPAD_END 0x96 */
4817 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4818 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4819 "kp-up", /* VK_NUMPAD_UP 0x99 */
4820 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4821 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4822 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4823 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4825 0, 0, /* 0x9E .. 0x9F */
4828 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4829 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4830 * No other API or message will distinguish left and right keys this way.
4835 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4836 to enable them selectively, and gives access to a few more functions.
4837 See lispy_multimedia_keys below. */
4838 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4839 0, 0, 0, /* 0xAD .. 0xAF Volume */
4840 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4841 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4843 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4844 0, 0, 0, 0, 0, 0, 0, 0, 0,
4846 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4847 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4848 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4851 "ax", /* VK_OEM_AX 0xE1 */
4852 0, /* VK_OEM_102 0xE2 */
4853 "ico-help", /* VK_ICO_HELP 0xE3 */
4854 "ico-00", /* VK_ICO_00 0xE4 */
4855 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4856 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4857 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4859 "reset", /* VK_OEM_RESET 0xE9 */
4860 "jump", /* VK_OEM_JUMP 0xEA */
4861 "oem-pa1", /* VK_OEM_PA1 0xEB */
4862 "oem-pa2", /* VK_OEM_PA2 0xEC */
4863 "oem-pa3", /* VK_OEM_PA3 0xED */
4864 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4865 "cusel", /* VK_OEM_CUSEL 0xEF */
4866 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4867 "finish", /* VK_OEM_FINISH 0xF1 */
4868 "copy", /* VK_OEM_COPY 0xF2 */
4869 "auto", /* VK_OEM_AUTO 0xF3 */
4870 "enlw", /* VK_OEM_ENLW 0xF4 */
4871 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4872 "attn", /* VK_ATTN 0xF6 */
4873 "crsel", /* VK_CRSEL 0xF7 */
4874 "exsel", /* VK_EXSEL 0xF8 */
4875 "ereof", /* VK_EREOF 0xF9 */
4876 "play", /* VK_PLAY 0xFA */
4877 "zoom", /* VK_ZOOM 0xFB */
4878 "noname", /* VK_NONAME 0xFC */
4879 "pa1", /* VK_PA1 0xFD */
4880 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4884 /* Some of these duplicate the "Media keys" on newer keyboards,
4885 but they are delivered to the application in a different way. */
4886 static const char *const lispy_multimedia_keys
[] =
4894 "browser-favorites",
4931 "toggle-dictate-command",
4937 "media-fast-forward",
4940 "media-channel-down"
4943 #else /* not HAVE_NTGUI */
4945 /* This should be dealt with in XTread_socket now, and that doesn't
4946 depend on the client system having the Kana syms defined. See also
4947 the XK_kana_A case below. */
4950 static const char *const lispy_kana_keys
[] =
4952 /* X Keysym value */
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4955 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4956 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4957 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4958 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4959 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4960 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4961 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4962 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4963 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4964 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4965 "kana-i", "kana-u", "kana-e", "kana-o",
4966 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4967 "prolongedsound", "kana-A", "kana-I", "kana-U",
4968 "kana-E", "kana-O", "kana-KA", "kana-KI",
4969 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4970 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4971 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4972 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4973 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4974 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4975 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4976 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4977 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4978 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4979 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4980 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4982 #endif /* XK_kana_A */
4985 #define FUNCTION_KEY_OFFSET 0xff00
4987 /* You'll notice that this table is arranged to be conveniently
4988 indexed by X Windows keysym values. */
4989 static const char *const lispy_function_keys
[] =
4991 /* X Keysym value */
4993 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4994 "backspace", "tab", "linefeed", "clear",
4996 0, 0, 0, "pause", /* 0xff10...1f */
4997 0, 0, 0, 0, 0, 0, 0, "escape",
4999 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5000 "romaji", "hiragana", "katakana", "hiragana-katakana",
5001 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5002 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5003 "eisu-toggle", /* 0xff30...3f */
5004 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5005 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5007 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5008 "down", "prior", "next", "end",
5009 "begin", 0, 0, 0, 0, 0, 0, 0,
5010 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5021 "break", /* 0xff6b */
5024 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5025 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5026 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5027 0, 0, 0, 0, 0, 0, 0, 0,
5028 "kp-tab", /* 0xff89 */
5030 "kp-enter", /* 0xff8d */
5032 "kp-f1", /* 0xff91 */
5036 "kp-home", /* 0xff95 */
5041 "kp-prior", /* kp-page-up */
5042 "kp-next", /* kp-page-down */
5048 0, 0, 0, 0, 0, 0, 0, 0, 0,
5049 "kp-multiply", /* 0xffaa */
5054 "kp-divide", /* 0xffaf */
5055 "kp-0", /* 0xffb0 */
5056 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5059 "kp-equal", /* 0xffbd */
5060 "f1", /* 0xffbe */ /* IsFunctionKey */
5062 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5063 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5064 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5065 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5066 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5067 0, 0, 0, 0, 0, 0, 0, 0,
5068 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5069 0, 0, 0, 0, 0, 0, 0, "delete"
5072 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5073 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5075 static const char *const iso_lispy_function_keys
[] =
5077 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5078 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5079 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5080 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5081 "iso-lefttab", /* 0xfe20 */
5082 "iso-move-line-up", "iso-move-line-down",
5083 "iso-partial-line-up", "iso-partial-line-down",
5084 "iso-partial-space-left", "iso-partial-space-right",
5085 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5086 "iso-release-margin-left", "iso-release-margin-right",
5087 "iso-release-both-margins",
5088 "iso-fast-cursor-left", "iso-fast-cursor-right",
5089 "iso-fast-cursor-up", "iso-fast-cursor-down",
5090 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5091 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5094 #endif /* not HAVE_NTGUI */
5096 static Lisp_Object Vlispy_mouse_stem
;
5098 static const char *const lispy_wheel_names
[] =
5100 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5103 /* drag-n-drop events are generated when a set of selected files are
5104 dragged from another application and dropped onto an Emacs window. */
5105 static const char *const lispy_drag_n_drop_names
[] =
5110 /* Scroll bar parts. */
5111 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5112 Lisp_Object Qup
, Qdown
, Qbottom
;
5113 static Lisp_Object Qend_scroll
;
5115 static Lisp_Object Qratio
;
5117 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5118 static Lisp_Object
*const scroll_bar_parts
[] = {
5119 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5120 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5123 /* A vector, indexed by button number, giving the down-going location
5124 of currently depressed buttons, both scroll bar and non-scroll bar.
5126 The elements have the form
5127 (BUTTON-NUMBER MODIFIER-MASK . REST)
5128 where REST is the cdr of a position as it would be reported in the event.
5130 The make_lispy_event function stores positions here to tell the
5131 difference between click and drag events, and to store the starting
5132 location to be included in drag events. */
5134 static Lisp_Object button_down_location
;
5136 /* Information about the most recent up-going button event: Which
5137 button, what location, and what time. */
5139 static int last_mouse_button
;
5140 static int last_mouse_x
;
5141 static int last_mouse_y
;
5142 static Time button_down_time
;
5144 /* The number of clicks in this multiple-click. */
5146 static int double_click_count
;
5148 /* X and Y are frame-relative coordinates for a click or wheel event.
5149 Return a Lisp-style event list. */
5152 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5155 enum window_part part
;
5156 Lisp_Object posn
= Qnil
;
5157 Lisp_Object extra_info
= Qnil
;
5158 /* Coordinate pixel positions to return. */
5159 int xret
= 0, yret
= 0;
5160 /* The window under frame pixel coordinates (x,y) */
5161 Lisp_Object window
= f
5162 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5165 if (WINDOWP (window
))
5167 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5168 struct window
*w
= XWINDOW (window
);
5169 Lisp_Object string_info
= Qnil
;
5170 EMACS_INT textpos
= -1;
5171 int col
= -1, row
= -1;
5172 int dx
= -1, dy
= -1;
5173 int width
= -1, height
= -1;
5174 Lisp_Object object
= Qnil
;
5176 /* Pixel coordinates relative to the window corner. */
5177 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5178 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5180 /* For text area clicks, return X, Y relative to the corner of
5181 this text area. Note that dX, dY etc are set below, by
5182 buffer_posn_from_coords. */
5183 if (part
== ON_TEXT
)
5185 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5186 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5188 /* For mode line and header line clicks, return X, Y relative to
5189 the left window edge. Use mode_line_string to look for a
5190 string on the click position. */
5191 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5196 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5197 /* Note that mode_line_string takes COL, ROW as pixels and
5198 converts them to characters. */
5201 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5202 &object
, &dx
, &dy
, &width
, &height
);
5203 if (STRINGP (string
))
5204 string_info
= Fcons (string
, make_number (charpos
));
5205 textpos
= (w
== XWINDOW (selected_window
)
5206 && current_buffer
== XBUFFER (w
->buffer
))
5207 ? PT
: XMARKER (w
->pointm
)->charpos
;
5212 /* For fringes and margins, Y is relative to the area's (and the
5213 window's) top edge, while X is meaningless. */
5214 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5219 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5222 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5223 &object
, &dx
, &dy
, &width
, &height
);
5224 if (STRINGP (string
))
5225 string_info
= Fcons (string
, make_number (charpos
));
5226 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5228 else if (part
== ON_LEFT_FRINGE
)
5230 posn
= Qleft_fringe
;
5233 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5234 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5235 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5237 else if (part
== ON_RIGHT_FRINGE
)
5239 posn
= Qright_fringe
;
5242 - window_box_width (w
, LEFT_MARGIN_AREA
)
5243 - window_box_width (w
, TEXT_AREA
)
5244 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5245 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5247 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5249 else if (part
== ON_VERTICAL_BORDER
)
5251 posn
= Qvertical_line
;
5256 /* Nothing special for part == ON_SCROLL_BAR. */
5258 /* For clicks in the text area, fringes, or margins, call
5259 buffer_posn_from_coords to extract TEXTPOS, the buffer
5260 position nearest to the click. */
5263 Lisp_Object string2
, object2
= Qnil
;
5264 struct display_pos p
;
5266 int width2
, height2
;
5267 /* The pixel X coordinate passed to buffer_posn_from_coords
5268 is the X coordinate relative to the text area for
5269 text-area and right-margin clicks, zero otherwise. */
5271 = (part
== ON_TEXT
) ? xret
5272 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5273 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5277 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5278 &object2
, &dx2
, &dy2
,
5280 textpos
= CHARPOS (p
.pos
);
5281 if (col
< 0) col
= x2
;
5282 if (row
< 0) row
= y2
;
5283 if (dx
< 0) dx
= dx2
;
5284 if (dy
< 0) dy
= dy2
;
5285 if (width
< 0) width
= width2
;
5286 if (height
< 0) height
= height2
;
5290 posn
= make_number (textpos
);
5291 if (STRINGP (string2
))
5292 string_info
= Fcons (string2
,
5293 make_number (CHARPOS (p
.string_pos
)));
5299 #ifdef HAVE_WINDOW_SYSTEM
5300 if (IMAGEP (object
))
5302 Lisp_Object image_map
, hotspot
;
5303 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5305 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5307 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5308 posn
= XCAR (hotspot
);
5315 Fcons (make_number (dx
), make_number (dy
)),
5316 Fcons (make_number (width
), make_number (height
)));
5319 extra_info
= Fcons (string_info
,
5320 Fcons (make_number (textpos
),
5321 Fcons (Fcons (make_number (col
),
5326 XSETFRAME (window
, f
);
5330 return Fcons (window
,
5332 Fcons (Fcons (make_number (xret
),
5333 make_number (yret
)),
5334 Fcons (make_number (t
),
5338 /* Given a struct input_event, build the lisp event which represents
5339 it. If EVENT is 0, build a mouse movement event from the mouse
5340 movement buffer, which should have a movement event in it.
5342 Note that events must be passed to this function in the order they
5343 are received; this function stores the location of button presses
5344 in order to build drag events when the button is released. */
5347 make_lispy_event (struct input_event
*event
)
5351 switch (SWITCH_ENUM_CAST (event
->kind
))
5353 /* A simple keystroke. */
5354 case ASCII_KEYSTROKE_EVENT
:
5355 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5357 Lisp_Object lispy_c
;
5358 EMACS_INT c
= event
->code
;
5359 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5362 eassert (c
== event
->code
);
5363 /* Turn ASCII characters into control characters
5365 if (event
->modifiers
& ctrl_modifier
)
5367 c
= make_ctrl_char (c
);
5368 event
->modifiers
&= ~ctrl_modifier
;
5372 /* Add in the other modifier bits. The shift key was taken care
5373 of by the X code. */
5374 c
|= (event
->modifiers
5375 & (meta_modifier
| alt_modifier
5376 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5377 /* Distinguish Shift-SPC from SPC. */
5378 if ((event
->code
) == 040
5379 && event
->modifiers
& shift_modifier
)
5380 c
|= shift_modifier
;
5381 button_down_time
= 0;
5382 XSETFASTINT (lispy_c
, c
);
5387 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5388 except that they are non-key events (last-nonmenu-event is nil). */
5389 case NS_NONKEY_EVENT
:
5392 /* A function key. The symbol may need to have modifier prefixes
5394 case NON_ASCII_KEYSTROKE_EVENT
:
5395 button_down_time
= 0;
5397 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5398 if (event
->code
== lispy_accent_codes
[i
])
5399 return modify_event_symbol (i
,
5401 Qfunction_key
, Qnil
,
5402 lispy_accent_keys
, &accent_key_syms
,
5403 (sizeof (lispy_accent_keys
)
5404 / sizeof (lispy_accent_keys
[0])));
5408 if (event
->code
>= 0x400 && event
->code
< 0x500)
5409 return modify_event_symbol (event
->code
- 0x400,
5410 event
->modifiers
& ~shift_modifier
,
5411 Qfunction_key
, Qnil
,
5412 lispy_kana_keys
, &func_key_syms
,
5413 (sizeof (lispy_kana_keys
)
5414 / sizeof (lispy_kana_keys
[0])));
5415 #endif /* XK_kana_A */
5418 #ifdef ISO_FUNCTION_KEY_OFFSET
5419 if (event
->code
< FUNCTION_KEY_OFFSET
5420 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5421 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5423 Qfunction_key
, Qnil
,
5424 iso_lispy_function_keys
, &func_key_syms
,
5425 (sizeof (iso_lispy_function_keys
)
5426 / sizeof (iso_lispy_function_keys
[0])));
5429 /* Handle system-specific or unknown keysyms. */
5430 if (event
->code
& (1 << 28)
5431 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5432 || (event
->code
- FUNCTION_KEY_OFFSET
5433 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5434 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5436 /* We need to use an alist rather than a vector as the cache
5437 since we can't make a vector long enough. */
5438 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5439 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5440 return modify_event_symbol (event
->code
,
5443 KVAR (current_kboard
, Vsystem_key_alist
),
5444 0, &KVAR (current_kboard
, system_key_syms
),
5445 TYPE_MAXIMUM (EMACS_INT
));
5448 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5450 Qfunction_key
, Qnil
,
5451 lispy_function_keys
, &func_key_syms
,
5452 (sizeof (lispy_function_keys
)
5453 / sizeof (lispy_function_keys
[0])));
5456 case MULTIMEDIA_KEY_EVENT
:
5457 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5458 / sizeof (lispy_multimedia_keys
[0]))
5459 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5461 return modify_event_symbol (event
->code
, event
->modifiers
,
5462 Qfunction_key
, Qnil
,
5463 lispy_multimedia_keys
, &func_key_syms
,
5464 (sizeof (lispy_multimedia_keys
)
5465 / sizeof (lispy_multimedia_keys
[0])));
5471 /* A mouse click. Figure out where it is, decide whether it's
5472 a press, click or drag, and build the appropriate structure. */
5473 case MOUSE_CLICK_EVENT
:
5474 #ifndef USE_TOOLKIT_SCROLL_BARS
5475 case SCROLL_BAR_CLICK_EVENT
:
5478 int button
= event
->code
;
5480 Lisp_Object position
;
5481 Lisp_Object
*start_pos_ptr
;
5482 Lisp_Object start_pos
;
5486 /* Build the position as appropriate for this mouse click. */
5487 if (event
->kind
== MOUSE_CLICK_EVENT
)
5489 struct frame
*f
= XFRAME (event
->frame_or_window
);
5490 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5494 /* Ignore mouse events that were made on frame that
5495 have been deleted. */
5496 if (! FRAME_LIVE_P (f
))
5499 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5500 /* EVENT->x and EVENT->y are frame-relative pixel
5501 coordinates at this place. Under old redisplay, COLUMN
5502 and ROW are set to frame relative glyph coordinates
5503 which are then used to determine whether this click is
5504 in a menu (non-toolkit version). */
5505 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5506 &column
, &row
, NULL
, 1);
5508 /* In the non-toolkit version, clicks on the menu bar
5509 are ordinary button events in the event buffer.
5510 Distinguish them, and invoke the menu.
5512 (In the toolkit version, the toolkit handles the menu bar
5513 and Emacs doesn't know about it until after the user
5514 makes a selection.) */
5515 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5516 && (event
->modifiers
& down_modifier
))
5518 Lisp_Object items
, item
;
5520 /* Find the menu bar item under `column'. */
5522 items
= FRAME_MENU_BAR_ITEMS (f
);
5523 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5525 Lisp_Object pos
, string
;
5526 string
= AREF (items
, i
+ 1);
5527 pos
= AREF (items
, i
+ 3);
5530 if (column
>= XINT (pos
)
5531 && column
< XINT (pos
) + SCHARS (string
))
5533 item
= AREF (items
, i
);
5538 /* ELisp manual 2.4b says (x y) are window relative but
5539 code says they are frame-relative. */
5541 = Fcons (event
->frame_or_window
,
5543 Fcons (Fcons (event
->x
, event
->y
),
5544 Fcons (make_number (event
->timestamp
),
5547 return Fcons (item
, Fcons (position
, Qnil
));
5549 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5551 position
= make_lispy_position (f
, event
->x
, event
->y
,
5554 #ifndef USE_TOOLKIT_SCROLL_BARS
5557 /* It's a scrollbar click. */
5559 Lisp_Object portion_whole
;
5562 window
= event
->frame_or_window
;
5563 portion_whole
= Fcons (event
->x
, event
->y
);
5564 part
= *scroll_bar_parts
[(int) event
->part
];
5568 Fcons (Qvertical_scroll_bar
,
5569 Fcons (portion_whole
,
5570 Fcons (make_number (event
->timestamp
),
5571 Fcons (part
, Qnil
)))));
5573 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5575 if (button
>= ASIZE (button_down_location
))
5577 button_down_location
= larger_vector (button_down_location
,
5579 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5582 start_pos_ptr
= &AREF (button_down_location
, button
);
5583 start_pos
= *start_pos_ptr
;
5584 *start_pos_ptr
= Qnil
;
5587 /* On window-system frames, use the value of
5588 double-click-fuzz as is. On other frames, interpret it
5589 as a multiple of 1/8 characters. */
5593 if (WINDOWP (event
->frame_or_window
))
5594 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5595 else if (FRAMEP (event
->frame_or_window
))
5596 f
= XFRAME (event
->frame_or_window
);
5600 if (FRAME_WINDOW_P (f
))
5601 fuzz
= double_click_fuzz
;
5603 fuzz
= double_click_fuzz
/ 8;
5605 is_double
= (button
== last_mouse_button
5606 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5607 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5608 && button_down_time
!= 0
5609 && (EQ (Vdouble_click_time
, Qt
)
5610 || (NATNUMP (Vdouble_click_time
)
5611 && (event
->timestamp
- button_down_time
5612 < XFASTINT (Vdouble_click_time
)))));
5615 last_mouse_button
= button
;
5616 last_mouse_x
= XINT (event
->x
);
5617 last_mouse_y
= XINT (event
->y
);
5619 /* If this is a button press, squirrel away the location, so
5620 we can decide later whether it was a click or a drag. */
5621 if (event
->modifiers
& down_modifier
)
5625 double_click_count
++;
5626 event
->modifiers
|= ((double_click_count
> 2)
5631 double_click_count
= 1;
5632 button_down_time
= event
->timestamp
;
5633 *start_pos_ptr
= Fcopy_alist (position
);
5634 ignore_mouse_drag_p
= 0;
5637 /* Now we're releasing a button - check the co-ordinates to
5638 see if this was a click or a drag. */
5639 else if (event
->modifiers
& up_modifier
)
5641 /* If we did not see a down before this up, ignore the up.
5642 Probably this happened because the down event chose a
5643 menu item. It would be an annoyance to treat the
5644 release of the button that chose the menu item as a
5647 if (!CONSP (start_pos
))
5650 event
->modifiers
&= ~up_modifier
;
5653 Lisp_Object new_down
, down
;
5654 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5656 /* The third element of every position
5657 should be the (x,y) pair. */
5658 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5659 new_down
= Fcar (Fcdr (Fcdr (position
)));
5662 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5664 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5665 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5668 if (ignore_mouse_drag_p
)
5670 event
->modifiers
|= click_modifier
;
5671 ignore_mouse_drag_p
= 0;
5673 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5674 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5675 /* Maybe the mouse has moved a lot, caused scrolling, and
5676 eventually ended up at the same screen position (but
5677 not buffer position) in which case it is a drag, not
5679 /* FIXME: OTOH if the buffer position has changed
5680 because of a timer or process filter rather than
5681 because of mouse movement, it should be considered as
5682 a click. But mouse-drag-region completely ignores
5683 this case and it hasn't caused any real problem, so
5684 it's probably OK to ignore it as well. */
5685 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5686 /* Mouse hasn't moved (much). */
5687 event
->modifiers
|= click_modifier
;
5690 button_down_time
= 0;
5691 event
->modifiers
|= drag_modifier
;
5694 /* Don't check is_double; treat this as multiple
5695 if the down-event was multiple. */
5696 if (double_click_count
> 1)
5697 event
->modifiers
|= ((double_click_count
> 2)
5703 /* Every mouse event should either have the down_modifier or
5704 the up_modifier set. */
5708 /* Get the symbol we should use for the mouse click. */
5711 head
= modify_event_symbol (button
,
5713 Qmouse_click
, Vlispy_mouse_stem
,
5716 ASIZE (mouse_syms
));
5717 if (event
->modifiers
& drag_modifier
)
5722 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5725 Fcons (make_number (double_click_count
),
5735 case HORIZ_WHEEL_EVENT
:
5737 Lisp_Object position
;
5740 /* Build the position as appropriate for this mouse click. */
5741 struct frame
*f
= XFRAME (event
->frame_or_window
);
5743 /* Ignore wheel events that were made on frame that have been
5745 if (! FRAME_LIVE_P (f
))
5748 position
= make_lispy_position (f
, event
->x
, event
->y
,
5751 /* Set double or triple modifiers to indicate the wheel speed. */
5753 /* On window-system frames, use the value of
5754 double-click-fuzz as is. On other frames, interpret it
5755 as a multiple of 1/8 characters. */
5761 if (WINDOWP (event
->frame_or_window
))
5762 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5763 else if (FRAMEP (event
->frame_or_window
))
5764 fr
= XFRAME (event
->frame_or_window
);
5768 fuzz
= FRAME_WINDOW_P (fr
)
5769 ? double_click_fuzz
: double_click_fuzz
/ 8;
5771 if (event
->modifiers
& up_modifier
)
5773 /* Emit a wheel-up event. */
5774 event
->modifiers
&= ~up_modifier
;
5777 else if (event
->modifiers
& down_modifier
)
5779 /* Emit a wheel-down event. */
5780 event
->modifiers
&= ~down_modifier
;
5784 /* Every wheel event should either have the down_modifier or
5785 the up_modifier set. */
5788 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5791 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5792 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5793 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5794 && button_down_time
!= 0
5795 && (EQ (Vdouble_click_time
, Qt
)
5796 || (NATNUMP (Vdouble_click_time
)
5797 && (event
->timestamp
- button_down_time
5798 < XFASTINT (Vdouble_click_time
)))));
5801 double_click_count
++;
5802 event
->modifiers
|= ((double_click_count
> 2)
5808 double_click_count
= 1;
5809 event
->modifiers
|= click_modifier
;
5812 button_down_time
= event
->timestamp
;
5813 /* Use a negative value to distinguish wheel from mouse button. */
5814 last_mouse_button
= - (1 + symbol_num
);
5815 last_mouse_x
= XINT (event
->x
);
5816 last_mouse_y
= XINT (event
->y
);
5818 /* Get the symbol we should use for the wheel event. */
5819 head
= modify_event_symbol (symbol_num
,
5825 ASIZE (wheel_syms
));
5828 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5831 Fcons (make_number (double_click_count
),
5840 #ifdef USE_TOOLKIT_SCROLL_BARS
5842 /* We don't have down and up events if using toolkit scroll bars,
5843 so make this always a click event. Store in the `part' of
5844 the Lisp event a symbol which maps to the following actions:
5846 `above_handle' page up
5847 `below_handle' page down
5851 `bottom' bottom of buffer
5852 `handle' thumb has been dragged.
5853 `end-scroll' end of interaction with scroll bar
5855 The incoming input_event contains in its `part' member an
5856 index of type `enum scroll_bar_part' which we can use as an
5857 index in scroll_bar_parts to get the appropriate symbol. */
5859 case SCROLL_BAR_CLICK_EVENT
:
5861 Lisp_Object position
, head
, window
, portion_whole
, part
;
5863 window
= event
->frame_or_window
;
5864 portion_whole
= Fcons (event
->x
, event
->y
);
5865 part
= *scroll_bar_parts
[(int) event
->part
];
5869 Fcons (Qvertical_scroll_bar
,
5870 Fcons (portion_whole
,
5871 Fcons (make_number (event
->timestamp
),
5872 Fcons (part
, Qnil
)))));
5874 /* Always treat scroll bar events as clicks. */
5875 event
->modifiers
|= click_modifier
;
5876 event
->modifiers
&= ~up_modifier
;
5878 if (event
->code
>= ASIZE (mouse_syms
))
5879 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
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 button_down_location
= larger_vector (button_down_location
,
5984 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5987 start_pos_ptr
= &AREF (button_down_location
, button
);
5988 start_pos
= *start_pos_ptr
;
5990 position
= make_lispy_position (f
, event
->x
, event
->y
,
5993 if (event
->modifiers
& down_modifier
)
5994 *start_pos_ptr
= Fcopy_alist (position
);
5995 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5997 if (!CONSP (start_pos
))
5999 event
->modifiers
&= ~up_modifier
;
6002 head
= modify_event_symbol (button
,
6004 Qmouse_click
, Vlispy_mouse_stem
,
6007 ASIZE (mouse_syms
));
6009 if (event
->modifiers
& drag_modifier
)
6014 else if (event
->modifiers
& double_modifier
)
6017 Fcons (make_number (2),
6019 else if (event
->modifiers
& triple_modifier
)
6022 Fcons (make_number (3),
6029 #endif /* HAVE_GPM */
6031 /* The 'kind' field of the event is something we don't recognize. */
6037 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6040 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6041 Lisp_Object x
, Lisp_Object y
, Time t
)
6043 /* Is it a scroll bar movement? */
6044 if (frame
&& ! NILP (bar_window
))
6046 Lisp_Object part_sym
;
6048 part_sym
= *scroll_bar_parts
[(int) part
];
6049 return Fcons (Qscroll_bar_movement
,
6050 Fcons (list5 (bar_window
,
6051 Qvertical_scroll_bar
,
6057 /* Or is it an ordinary mouse movement? */
6060 Lisp_Object position
;
6061 position
= make_lispy_position (frame
, x
, y
, t
);
6062 return list2 (Qmouse_movement
, position
);
6066 #endif /* HAVE_MOUSE || HAVE GPM */
6068 /* Construct a switch frame event. */
6070 make_lispy_switch_frame (Lisp_Object frame
)
6072 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6075 /* Manipulating modifiers. */
6077 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6079 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6080 SYMBOL's name of the end of the modifiers; the string from this
6081 position is the unmodified symbol name.
6083 This doesn't use any caches. */
6086 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6092 CHECK_SYMBOL (symbol
);
6095 name
= SYMBOL_NAME (symbol
);
6097 for (i
= 0; i
+2 <= SBYTES (name
); )
6099 EMACS_INT this_mod_end
= 0;
6102 /* See if the name continues with a modifier word.
6103 Check that the word appears, but don't check what follows it.
6104 Set this_mod and this_mod_end to record what we find. */
6106 switch (SREF (name
, i
))
6108 #define SINGLE_LETTER_MOD(BIT) \
6109 (this_mod_end = i + 1, this_mod = BIT)
6112 SINGLE_LETTER_MOD (alt_modifier
);
6116 SINGLE_LETTER_MOD (ctrl_modifier
);
6120 SINGLE_LETTER_MOD (hyper_modifier
);
6124 SINGLE_LETTER_MOD (meta_modifier
);
6128 SINGLE_LETTER_MOD (shift_modifier
);
6132 SINGLE_LETTER_MOD (super_modifier
);
6135 #undef SINGLE_LETTER_MOD
6137 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6138 if (i + LEN + 1 <= SBYTES (name) \
6139 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6141 this_mod_end = i + LEN; \
6146 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6147 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6148 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6152 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6154 #undef MULTI_LETTER_MOD
6158 /* If we found no modifier, stop looking for them. */
6159 if (this_mod_end
== 0)
6162 /* Check there is a dash after the modifier, so that it
6163 really is a modifier. */
6164 if (this_mod_end
>= SBYTES (name
)
6165 || SREF (name
, this_mod_end
) != '-')
6168 /* This modifier is real; look for another. */
6169 modifiers
|= this_mod
;
6170 i
= this_mod_end
+ 1;
6173 /* Should we include the `click' modifier? */
6174 if (! (modifiers
& (down_modifier
| drag_modifier
6175 | double_modifier
| triple_modifier
))
6176 && i
+ 7 == SBYTES (name
)
6177 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6178 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6179 modifiers
|= click_modifier
;
6181 if (! (modifiers
& (double_modifier
| triple_modifier
))
6182 && i
+ 6 < SBYTES (name
)
6183 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6184 modifiers
|= click_modifier
;
6192 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6193 prepended to the string BASE[0..BASE_LEN-1].
6194 This doesn't use any caches. */
6196 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6198 /* Since BASE could contain nulls, we can't use intern here; we have
6199 to use Fintern, which expects a genuine Lisp_String, and keeps a
6202 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6208 /* Only the event queue may use the `up' modifier; it should always
6209 be turned into a click or drag event before presented to lisp code. */
6210 if (modifiers
& up_modifier
)
6213 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6214 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6215 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6216 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6217 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6218 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6219 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6220 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6221 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6222 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6223 /* The click modifier is denoted by the absence of other modifiers. */
6227 mod_len
= p
- new_mods
;
6231 Lisp_Object new_name
;
6233 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6234 mod_len
+ base_len_byte
);
6235 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6236 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6238 return Fintern (new_name
, Qnil
);
6243 static const char *const modifier_names
[] =
6245 "up", "down", "drag", "click", "double", "triple", 0, 0,
6246 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6247 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6249 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6251 static Lisp_Object modifier_symbols
;
6253 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6255 lispy_modifier_list (int modifiers
)
6257 Lisp_Object modifier_list
;
6260 modifier_list
= Qnil
;
6261 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6262 if (modifiers
& (1<<i
))
6263 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6266 return modifier_list
;
6270 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6271 where UNMODIFIED is the unmodified form of SYMBOL,
6272 MASK is the set of modifiers present in SYMBOL's name.
6273 This is similar to parse_modifiers_uncached, but uses the cache in
6274 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6275 Qevent_symbol_elements property. */
6277 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6280 parse_modifiers (Lisp_Object symbol
)
6282 Lisp_Object elements
;
6284 if (INTEGERP (symbol
))
6285 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6286 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6288 else if (!SYMBOLP (symbol
))
6291 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6292 if (CONSP (elements
))
6297 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6298 Lisp_Object unmodified
;
6301 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6302 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6305 if (modifiers
& ~INTMASK
)
6307 XSETFASTINT (mask
, modifiers
);
6308 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6310 /* Cache the parsing results on SYMBOL. */
6311 Fput (symbol
, Qevent_symbol_element_mask
,
6313 Fput (symbol
, Qevent_symbol_elements
,
6314 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6316 /* Since we know that SYMBOL is modifiers applied to unmodified,
6317 it would be nice to put that in unmodified's cache.
6318 But we can't, since we're not sure that parse_modifiers is
6325 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6326 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6327 doc
: /* Parse the event symbol. For internal use. */)
6328 (Lisp_Object symbol
)
6330 /* Fill the cache if needed. */
6331 parse_modifiers (symbol
);
6332 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6333 and use the Lispier representation stored on Qevent_symbol_elements
6335 return Fget (symbol
, Qevent_symbol_elements
);
6338 /* Apply the modifiers MODIFIERS to the symbol BASE.
6339 BASE must be unmodified.
6341 This is like apply_modifiers_uncached, but uses BASE's
6342 Qmodifier_cache property, if present. It also builds
6343 Qevent_symbol_elements properties, since it has that info anyway.
6345 apply_modifiers copies the value of BASE's Qevent_kind property to
6346 the modified symbol. */
6348 apply_modifiers (int modifiers
, Lisp_Object base
)
6350 Lisp_Object cache
, idx
, entry
, new_symbol
;
6352 /* Mask out upper bits. We don't know where this value's been. */
6353 modifiers
&= INTMASK
;
6355 if (INTEGERP (base
))
6356 return make_number (XINT (base
) | modifiers
);
6358 /* The click modifier never figures into cache indices. */
6359 cache
= Fget (base
, Qmodifier_cache
);
6360 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6361 entry
= assq_no_quit (idx
, cache
);
6364 new_symbol
= XCDR (entry
);
6367 /* We have to create the symbol ourselves. */
6368 new_symbol
= apply_modifiers_uncached (modifiers
,
6369 SSDATA (SYMBOL_NAME (base
)),
6370 SCHARS (SYMBOL_NAME (base
)),
6371 SBYTES (SYMBOL_NAME (base
)));
6373 /* Add the new symbol to the base's cache. */
6374 entry
= Fcons (idx
, new_symbol
);
6375 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6377 /* We have the parsing info now for free, so we could add it to
6379 XSETFASTINT (idx, modifiers);
6380 Fput (new_symbol, Qevent_symbol_element_mask,
6381 Fcons (base, Fcons (idx, Qnil)));
6382 Fput (new_symbol, Qevent_symbol_elements,
6383 Fcons (base, lispy_modifier_list (modifiers)));
6384 Sadly, this is only correct if `base' is indeed a base event,
6385 which is not necessarily the case. -stef */
6388 /* Make sure this symbol is of the same kind as BASE.
6390 You'd think we could just set this once and for all when we
6391 intern the symbol above, but reorder_modifiers may call us when
6392 BASE's property isn't set right; we can't assume that just
6393 because it has a Qmodifier_cache property it must have its
6394 Qevent_kind set right as well. */
6395 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6399 kind
= Fget (base
, Qevent_kind
);
6401 Fput (new_symbol
, Qevent_kind
, kind
);
6408 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6409 return a symbol with the modifiers placed in the canonical order.
6410 Canonical order is alphabetical, except for down and drag, which
6411 always come last. The 'click' modifier is never written out.
6413 Fdefine_key calls this to make sure that (for example) C-M-foo
6414 and M-C-foo end up being equivalent in the keymap. */
6417 reorder_modifiers (Lisp_Object symbol
)
6419 /* It's hopefully okay to write the code this way, since everything
6420 will soon be in caches, and no consing will be done at all. */
6423 parsed
= parse_modifiers (symbol
);
6424 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6429 /* For handling events, we often want to produce a symbol whose name
6430 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6431 to some base, like the name of a function key or mouse button.
6432 modify_event_symbol produces symbols of this sort.
6434 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6435 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6438 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6439 into symbol names, or a string specifying a name stem used to
6440 construct a symbol name or the form `STEM-N', where N is the decimal
6441 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6442 non-nil; otherwise NAME_TABLE is used.
6444 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6445 persist between calls to modify_event_symbol that it can use to
6446 store a cache of the symbols it's generated for this NAME_TABLE
6447 before. The object stored there may be a vector or an alist.
6449 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6451 MODIFIERS is a set of modifier bits (as given in struct input_events)
6452 whose prefixes should be applied to the symbol name.
6454 SYMBOL_KIND is the value to be placed in the event_kind property of
6455 the returned symbol.
6457 The symbols we create are supposed to have an
6458 `event-symbol-elements' property, which lists the modifiers present
6459 in the symbol's name. */
6462 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6463 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6464 Lisp_Object
*symbol_table
, EMACS_INT table_size
)
6467 Lisp_Object symbol_int
;
6469 /* Get rid of the "vendor-specific" bit here. */
6470 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6472 /* Is this a request for a valid symbol? */
6473 if (symbol_num
< 0 || symbol_num
>= table_size
)
6476 if (CONSP (*symbol_table
))
6477 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6479 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6480 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6481 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6482 we've never used that symbol before. */
6485 if (! VECTORP (*symbol_table
)
6486 || ASIZE (*symbol_table
) != table_size
)
6490 XSETFASTINT (size
, table_size
);
6491 *symbol_table
= Fmake_vector (size
, Qnil
);
6494 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6497 /* Have we already used this symbol before? */
6500 /* No; let's create it. */
6501 if (CONSP (name_alist_or_stem
))
6502 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6503 else if (STRINGP (name_alist_or_stem
))
6506 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6507 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6509 SAFE_ALLOCA (buf
, char *, len
);
6510 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6511 XINT (symbol_int
) + 1);
6512 value
= intern (buf
);
6515 else if (name_table
!= 0 && name_table
[symbol_num
])
6516 value
= intern (name_table
[symbol_num
]);
6518 #ifdef HAVE_WINDOW_SYSTEM
6521 char *name
= x_get_keysym_name (symbol_num
);
6523 value
= intern (name
);
6529 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6530 sprintf (buf
, "key-%"pI
"d", symbol_num
);
6531 value
= intern (buf
);
6534 if (CONSP (*symbol_table
))
6535 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6537 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6539 /* Fill in the cache entries for this symbol; this also
6540 builds the Qevent_symbol_elements property, which the user
6542 apply_modifiers (modifiers
& click_modifier
, value
);
6543 Fput (value
, Qevent_kind
, symbol_kind
);
6546 /* Apply modifiers to that symbol. */
6547 return apply_modifiers (modifiers
, value
);
6550 /* Convert a list that represents an event type,
6551 such as (ctrl meta backspace), into the usual representation of that
6552 event type as a number or a symbol. */
6554 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6555 doc
: /* Convert the event description list EVENT-DESC to an event type.
6556 EVENT-DESC should contain one base event type (a character or symbol)
6557 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6558 drag, down, double or triple). The base must be last.
6559 The return value is an event type (a character or symbol) which
6560 has the same base event type and all the specified modifiers. */)
6561 (Lisp_Object event_desc
)
6569 while (CONSP (rest
))
6577 /* Given a symbol, see if it is a modifier name. */
6578 if (SYMBOLP (elt
) && CONSP (rest
))
6579 this = parse_solitary_modifier (elt
);
6583 else if (!NILP (base
))
6584 error ("Two bases given in one event");
6590 /* Let the symbol A refer to the character A. */
6591 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6592 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6594 if (INTEGERP (base
))
6596 /* Turn (shift a) into A. */
6597 if ((modifiers
& shift_modifier
) != 0
6598 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6600 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6601 modifiers
&= ~shift_modifier
;
6604 /* Turn (control a) into C-a. */
6605 if (modifiers
& ctrl_modifier
)
6606 return make_number ((modifiers
& ~ctrl_modifier
)
6607 | make_ctrl_char (XINT (base
)));
6609 return make_number (modifiers
| XINT (base
));
6611 else if (SYMBOLP (base
))
6612 return apply_modifiers (modifiers
, base
);
6615 error ("Invalid base event");
6620 /* Try to recognize SYMBOL as a modifier name.
6621 Return the modifier flag bit, or 0 if not recognized. */
6624 parse_solitary_modifier (Lisp_Object symbol
)
6626 Lisp_Object name
= SYMBOL_NAME (symbol
);
6628 switch (SREF (name
, 0))
6630 #define SINGLE_LETTER_MOD(BIT) \
6631 if (SBYTES (name) == 1) \
6634 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6635 if (LEN == SBYTES (name) \
6636 && ! strncmp (SSDATA (name), NAME, LEN)) \
6640 SINGLE_LETTER_MOD (alt_modifier
);
6644 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6648 SINGLE_LETTER_MOD (ctrl_modifier
);
6652 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6653 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6657 SINGLE_LETTER_MOD (hyper_modifier
);
6661 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6665 SINGLE_LETTER_MOD (meta_modifier
);
6669 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6673 SINGLE_LETTER_MOD (shift_modifier
);
6677 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6678 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6679 SINGLE_LETTER_MOD (super_modifier
);
6683 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6684 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6685 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6689 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6692 #undef SINGLE_LETTER_MOD
6693 #undef MULTI_LETTER_MOD
6699 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6700 Such a list is not valid as an event,
6701 but it can be a Lucid-style event type list. */
6704 lucid_event_type_list_p (Lisp_Object object
)
6708 if (! CONSP (object
))
6711 if (EQ (XCAR (object
), Qhelp_echo
)
6712 || EQ (XCAR (object
), Qvertical_line
)
6713 || EQ (XCAR (object
), Qmode_line
)
6714 || EQ (XCAR (object
), Qheader_line
))
6717 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6721 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6728 /* Store into *addr a value nonzero if terminal input chars are available.
6729 Serves the purpose of ioctl (0, FIONREAD, addr)
6730 but works even if FIONREAD does not exist.
6731 (In fact, this may actually read some input.)
6733 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6734 timer events that are ripe.
6735 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6736 events (FOCUS_IN_EVENT).
6737 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6738 movements and toolkit scroll bar thumb drags. */
6741 get_input_pending (int *addr
, int flags
)
6743 /* First of all, have we already counted some input? */
6744 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6746 /* If input is being read as it arrives, and we have none, there is none. */
6747 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6750 /* Try to read some input and see how much we get. */
6752 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6755 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6758 gobble_input (int expected
)
6761 if (interrupt_input
)
6764 mask
= sigblock (sigmask (SIGIO
));
6765 read_avail_input (expected
);
6769 #ifdef POLL_FOR_INPUT
6770 /* XXX This condition was (read_socket_hook && !interrupt_input),
6771 but read_socket_hook is not global anymore. Let's pretend that
6773 if (!interrupt_input
&& poll_suppress_count
== 0)
6776 mask
= sigblock (sigmask (SIGALRM
));
6777 read_avail_input (expected
);
6783 read_avail_input (expected
);
6786 /* Put a BUFFER_SWITCH_EVENT in the buffer
6787 so that read_key_sequence will notice the new current buffer. */
6790 record_asynch_buffer_change (void)
6792 struct input_event event
;
6796 event
.kind
= BUFFER_SWITCH_EVENT
;
6797 event
.frame_or_window
= Qnil
;
6800 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6801 The purpose of the event is to make read_key_sequence look up the
6802 keymaps again. If we aren't in read_key_sequence, we don't need one,
6803 and the event could cause trouble by messing up (input-pending-p).
6804 Note: Fwaiting_for_user_input_p always returns nil when async
6805 subprocesses aren't supported. */
6806 tem
= Fwaiting_for_user_input_p ();
6810 /* Make sure no interrupt happens while storing the event. */
6812 if (interrupt_input
)
6815 mask
= sigblock (sigmask (SIGIO
));
6816 kbd_buffer_store_event (&event
);
6823 kbd_buffer_store_event (&event
);
6828 /* Read any terminal input already buffered up by the system
6829 into the kbd_buffer, but do not wait.
6831 EXPECTED should be nonzero if the caller knows there is some input.
6833 Returns the number of keyboard chars read, or -1 meaning
6834 this is a bad time to try to read input. */
6837 read_avail_input (int expected
)
6843 /* Store pending user signal events, if any. */
6844 if (store_user_signal_events ())
6847 /* Loop through the available terminals, and call their input hooks. */
6851 struct terminal
*next
= t
->next_terminal
;
6853 if (t
->read_socket_hook
)
6856 struct input_event hold_quit
;
6858 EVENT_INIT (hold_quit
);
6859 hold_quit
.kind
= NO_EVENT
;
6861 /* No need for FIONREAD or fcntl; just say don't wait. */
6862 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6868 if (nr
== -1) /* Not OK to read input now. */
6872 else if (nr
== -2) /* Non-transient error. */
6874 /* The terminal device terminated; it should be closed. */
6876 /* Kill Emacs if this was our last terminal. */
6877 if (!terminal_list
->next_terminal
)
6878 /* Formerly simply reported no input, but that
6879 sometimes led to a failure of Emacs to terminate.
6880 SIGHUP seems appropriate if we can't reach the
6882 /* ??? Is it really right to send the signal just to
6883 this process rather than to the whole process
6884 group? Perhaps on systems with FIONREAD Emacs is
6885 alone in its group. */
6886 kill (getpid (), SIGHUP
);
6888 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6891 XSETTERMINAL (tmp
, t
);
6892 Fdelete_terminal (tmp
, Qnoelisp
);
6896 if (hold_quit
.kind
!= NO_EVENT
)
6897 kbd_buffer_store_event (&hold_quit
);
6906 frame_make_pointer_visible ();
6912 decode_keyboard_code (struct tty_display_info
*tty
,
6913 struct coding_system
*coding
,
6914 unsigned char *buf
, int nbytes
)
6916 unsigned char *src
= buf
;
6917 const unsigned char *p
;
6922 if (tty
->meta_key
!= 2)
6923 for (i
= 0; i
< nbytes
; i
++)
6925 if (coding
->carryover_bytes
> 0)
6927 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6928 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6929 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6930 nbytes
+= coding
->carryover_bytes
;
6932 coding
->destination
= alloca (nbytes
* 4);
6933 coding
->dst_bytes
= nbytes
* 4;
6934 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6935 if (coding
->produced_char
== 0)
6937 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6939 struct input_event event_buf
;
6941 EVENT_INIT (event_buf
);
6942 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6944 (ASCII_CHAR_P (event_buf
.code
)
6945 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6946 /* See the comment in tty_read_avail_input. */
6947 event_buf
.frame_or_window
= tty
->top_frame
;
6948 event_buf
.arg
= Qnil
;
6949 kbd_buffer_store_event (&event_buf
);
6953 /* This is the tty way of reading available input.
6955 Note that each terminal device has its own `struct terminal' object,
6956 and so this function is called once for each individual termcap
6957 terminal. The first parameter indicates which terminal to read from. */
6960 tty_read_avail_input (struct terminal
*terminal
,
6962 struct input_event
*hold_quit
)
6964 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6965 the kbd_buffer can really hold. That may prevent loss
6966 of characters on some systems when input is stuffed at us. */
6967 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6969 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6972 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6974 if (kbd_on_hold_p () || buffer_free
<= 0)
6976 #endif /* subprocesses */
6978 if (!terminal
->name
) /* Don't read from a dead terminal. */
6981 if (terminal
->type
!= output_termcap
6982 && terminal
->type
!= output_msdos_raw
)
6985 /* XXX I think the following code should be moved to separate hook
6986 functions in system-dependent files. */
6989 #else /* not WINDOWSNT */
6990 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6994 return 0; /* The terminal is suspended. */
6997 n_to_read
= dos_keysns ();
7001 cbuf
[0] = dos_keyread ();
7004 #else /* not MSDOS */
7009 struct input_event gpm_hold_quit
;
7010 int gpm
, fd
= gpm_fd
;
7012 EVENT_INIT (gpm_hold_quit
);
7013 gpm_hold_quit
.kind
= NO_EVENT
;
7015 /* gpm==1 if event received.
7016 gpm==0 if the GPM daemon has closed the connection, in which case
7017 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7018 we save it in `fd' so close_gpm can remove it from the
7020 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7021 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7022 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7025 /* Presumably the GPM daemon has closed the connection. */
7027 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7028 kbd_buffer_store_event (&gpm_hold_quit
);
7032 #endif /* HAVE_GPM */
7034 /* Determine how many characters we should *try* to read. */
7036 /* Find out how much input is available. */
7037 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7039 if (! noninteractive
)
7040 return -2; /* Close this terminal. */
7046 if (n_to_read
> sizeof cbuf
)
7047 n_to_read
= sizeof cbuf
;
7048 #else /* no FIONREAD */
7049 #if defined (USG) || defined (CYGWIN)
7050 /* Read some input if available, but don't wait. */
7051 n_to_read
= sizeof cbuf
;
7052 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7059 /* Don't read more than we can store. */
7060 if (n_to_read
> buffer_free
)
7061 n_to_read
= buffer_free
;
7062 #endif /* subprocesses */
7064 /* Now read; for one reason or another, this will not block.
7065 NREAD is set to the number of chars read. */
7068 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7069 /* POSIX infers that processes which are not in the session leader's
7070 process group won't get SIGHUP's at logout time. BSDI adheres to
7071 this part standard and returns -1 from read (0) with errno==EIO
7072 when the control tty is taken away.
7073 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7074 if (nread
== -1 && errno
== EIO
)
7075 return -2; /* Close this terminal. */
7076 #if defined (AIX) && defined (_BSD)
7077 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7078 This looks incorrect, but it isn't, because _BSD causes
7079 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7080 and that causes a value other than 0 when there is no input. */
7082 return -2; /* Close this terminal. */
7086 /* We used to retry the read if it was interrupted.
7087 But this does the wrong thing when O_NDELAY causes
7088 an EAGAIN error. Does anybody know of a situation
7089 where a retry is actually needed? */
7091 nread
< 0 && (errno
== EAGAIN
7105 #if defined (USG) || defined (CYGWIN)
7106 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7107 #endif /* USG or CYGWIN */
7108 #endif /* no FIONREAD */
7113 #endif /* not MSDOS */
7114 #endif /* not WINDOWSNT */
7116 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7117 & CODING_REQUIRE_DECODING_MASK
)
7119 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7122 /* Decode the key sequence except for those with meta
7124 for (i
= from
= 0; ; i
++)
7125 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7127 struct input_event buf
;
7129 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7134 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7135 buf
.modifiers
= meta_modifier
;
7136 buf
.code
= cbuf
[i
] & ~0x80;
7137 /* See the comment below. */
7138 buf
.frame_or_window
= tty
->top_frame
;
7140 kbd_buffer_store_event (&buf
);
7146 for (i
= 0; i
< nread
; i
++)
7148 struct input_event buf
;
7150 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7152 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7153 buf
.modifiers
= meta_modifier
;
7154 if (tty
->meta_key
!= 2)
7158 /* Set the frame corresponding to the active tty. Note that the
7159 value of selected_frame is not reliable here, redisplay tends
7160 to temporarily change it. */
7161 buf
.frame_or_window
= tty
->top_frame
;
7164 kbd_buffer_store_event (&buf
);
7165 /* Don't look at input that follows a C-g too closely.
7166 This reduces lossage due to autorepeat on C-g. */
7167 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7168 && buf
.code
== quit_char
)
7175 #if defined SYNC_INPUT || defined SIGIO
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. */
7202 #endif /* SYNC_INPUT || SIGIO */
7206 process_pending_signals (void)
7208 if (interrupt_input_pending
)
7209 handle_async_input ();
7210 do_pending_atimers ();
7214 #ifdef SIGIO /* for entire page */
7215 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7218 input_available_signal (int signo
)
7220 /* Must preserve main program's value of errno. */
7221 int old_errno
= errno
;
7222 SIGNAL_THREAD_CHECK (signo
);
7225 interrupt_input_pending
= 1;
7226 pending_signals
= 1;
7229 if (input_available_clear_time
)
7230 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7233 handle_async_input ();
7240 /* Send ourselves a SIGIO.
7242 This function exists so that the UNBLOCK_INPUT macro in
7243 blockinput.h can have some way to take care of input we put off
7244 dealing with, without assuming that every file which uses
7245 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7247 reinvoke_input_signal (void)
7250 handle_async_input ();
7256 /* User signal events. */
7258 struct user_signal_info
7260 /* Signal number. */
7263 /* Name of the signal. */
7266 /* Number of pending signals. */
7269 struct user_signal_info
*next
;
7272 /* List of user signals. */
7273 static struct user_signal_info
*user_signals
= NULL
;
7276 add_user_signal (int sig
, const char *name
)
7278 struct user_signal_info
*p
;
7280 for (p
= user_signals
; p
; p
= p
->next
)
7282 /* Already added. */
7285 p
= xmalloc (sizeof (struct user_signal_info
));
7287 p
->name
= xstrdup (name
);
7289 p
->next
= user_signals
;
7292 signal (sig
, handle_user_signal
);
7296 handle_user_signal (int sig
)
7298 int old_errno
= errno
;
7299 struct user_signal_info
*p
;
7300 const char *special_event_name
= NULL
;
7302 SIGNAL_THREAD_CHECK (sig
);
7304 if (SYMBOLP (Vdebug_on_event
))
7305 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7307 for (p
= user_signals
; p
; p
= p
->next
)
7310 if (special_event_name
&&
7311 strcmp (special_event_name
, p
->name
) == 0)
7313 /* Enter the debugger in many ways. */
7314 debug_on_next_call
= 1;
7317 Vinhibit_quit
= Qnil
;
7319 /* Eat the event. */
7325 if (interrupt_input
)
7326 kill (getpid (), SIGIO
);
7330 /* Tell wait_reading_process_output that it needs to wake
7331 up and look around. */
7332 if (input_available_clear_time
)
7333 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7342 find_user_signal_name (int sig
)
7344 struct user_signal_info
*p
;
7346 for (p
= user_signals
; p
; p
= p
->next
)
7354 store_user_signal_events (void)
7356 struct user_signal_info
*p
;
7357 struct input_event buf
;
7360 for (p
= user_signals
; p
; p
= p
->next
)
7361 if (p
->npending
> 0)
7367 memset (&buf
, 0, sizeof buf
);
7368 buf
.kind
= USER_SIGNAL_EVENT
;
7369 buf
.frame_or_window
= selected_frame
;
7371 nstored
+= p
->npending
;
7373 mask
= sigblock (sigmask (p
->sig
));
7377 kbd_buffer_store_event (&buf
);
7380 while (p
->npending
> 0);
7388 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7389 static Lisp_Object menu_bar_one_keymap_changed_items
;
7391 /* These variables hold the vector under construction within
7392 menu_bar_items and its subroutines, and the current index
7393 for storing into that vector. */
7394 static Lisp_Object menu_bar_items_vector
;
7395 static int menu_bar_items_index
;
7398 static const char* separator_names
[] = {
7403 "single-dashed-line",
7404 "double-dashed-line",
7406 "shadow-etched-out",
7407 "shadow-etched-in-dash",
7408 "shadow-etched-out-dash",
7409 "shadow-double-etched-in",
7410 "shadow-double-etched-out",
7411 "shadow-double-etched-in-dash",
7412 "shadow-double-etched-out-dash",
7416 /* Return non-zero if LABEL specifies a separator. */
7419 menu_separator_name_p (const char *label
)
7423 else if (strlen (label
) > 3
7424 && strncmp (label
, "--", 2) == 0
7429 for (i
= 0; separator_names
[i
]; ++i
)
7430 if (strcmp (label
, separator_names
[i
]) == 0)
7435 /* It's a separator if it contains only dashes. */
7436 while (*label
== '-')
7438 return (*label
== 0);
7445 /* Return a vector of menu items for a menu bar, appropriate
7446 to the current buffer. Each item has three elements in the vector:
7449 OLD is an old vector we can optionally reuse, or nil. */
7452 menu_bar_items (Lisp_Object old
)
7454 /* The number of keymaps we're scanning right now, and the number of
7455 keymaps we have allocated space for. */
7458 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7459 in the current keymaps, or nil where it is not a prefix. */
7462 Lisp_Object def
, tail
;
7467 /* In order to build the menus, we need to call the keymap
7468 accessors. They all call QUIT. But this function is called
7469 during redisplay, during which a quit is fatal. So inhibit
7470 quitting while building the menus.
7471 We do this instead of specbind because (1) errors will clear it anyway
7472 and (2) this avoids risk of specpdl overflow. */
7473 oquit
= Vinhibit_quit
;
7477 menu_bar_items_vector
= old
;
7479 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7480 menu_bar_items_index
= 0;
7482 /* Build our list of keymaps.
7483 If we recognize a function key and replace its escape sequence in
7484 keybuf with its symbol, or if the sequence starts with a mouse
7485 click and we need to switch buffers, we jump back here to rebuild
7486 the initial keymaps from the current buffer. */
7490 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7491 if (!NILP (Voverriding_local_map_menu_flag
))
7493 /* Yes, use them (if non-nil) as well as the global map. */
7494 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7496 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7497 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7498 if (!NILP (Voverriding_local_map
))
7499 maps
[nmaps
++] = Voverriding_local_map
;
7503 /* No, so use major and minor mode keymaps and keymap property.
7504 Note that menu-bar bindings in the local-map and keymap
7505 properties may not work reliable, as they are only
7506 recognized when the menu-bar (or mode-line) is updated,
7507 which does not normally happen after every command. */
7510 nminor
= current_minor_maps (NULL
, &tmaps
);
7511 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7513 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7514 maps
[nmaps
++] = tem
;
7515 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7517 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7519 maps
[nmaps
++] = current_global_map
;
7522 /* Look up in each map the dummy prefix key `menu-bar'. */
7524 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7525 if (!NILP (maps
[mapno
]))
7527 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7531 menu_bar_one_keymap_changed_items
= Qnil
;
7532 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7536 /* Move to the end those items that should be at the end. */
7538 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7541 int end
= menu_bar_items_index
;
7543 for (i
= 0; i
< end
; i
+= 4)
7544 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7546 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7547 /* Move the item at index I to the end,
7548 shifting all the others forward. */
7549 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7550 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7551 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7552 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7554 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7555 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7556 (end
- i
- 4) * sizeof (Lisp_Object
));
7557 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7558 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7559 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7560 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7565 /* Add nil, nil, nil, nil at the end. */
7567 int i
= menu_bar_items_index
;
7568 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7569 menu_bar_items_vector
=
7570 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7571 /* Add this item. */
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 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7576 menu_bar_items_index
= i
;
7579 Vinhibit_quit
= oquit
;
7580 return menu_bar_items_vector
;
7583 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7584 If there's already an item for KEY, add this DEF to it. */
7586 Lisp_Object item_properties
;
7589 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7591 struct gcpro gcpro1
;
7595 if (EQ (item
, Qundefined
))
7597 /* If a map has an explicit `undefined' as definition,
7598 discard any previously made menu bar item. */
7600 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7601 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7603 if (menu_bar_items_index
> i
+ 4)
7604 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7605 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7606 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7607 menu_bar_items_index
-= 4;
7611 /* If this keymap has already contributed to this KEY,
7612 don't contribute to it a second time. */
7613 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7614 if (!NILP (tem
) || NILP (item
))
7617 menu_bar_one_keymap_changed_items
7618 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7620 /* We add to menu_bar_one_keymap_changed_items before doing the
7621 parse_menu_item, so that if it turns out it wasn't a menu item,
7622 it still correctly hides any further menu item. */
7624 i
= parse_menu_item (item
, 1);
7629 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7631 /* Find any existing item for this KEY. */
7632 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7633 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7636 /* If we did not find this KEY, add it at the end. */
7637 if (i
== menu_bar_items_index
)
7639 /* If vector is too small, get a bigger one. */
7640 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7641 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7642 /* Add this item. */
7643 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7644 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7645 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7646 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7647 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7648 menu_bar_items_index
= i
;
7650 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7654 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7655 /* If the new and the old items are not both keymaps,
7656 the lookup will only find `item'. */
7657 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7658 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7662 /* This is used as the handler when calling menu_item_eval_property. */
7664 menu_item_eval_property_1 (Lisp_Object arg
)
7666 /* If we got a quit from within the menu computation,
7667 quit all the way out of it. This takes care of C-] in the debugger. */
7668 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7669 Fsignal (Qquit
, Qnil
);
7675 eval_dyn (Lisp_Object form
)
7677 return Feval (form
, Qnil
);
7680 /* Evaluate an expression and return the result (or nil if something
7681 went wrong). Used to evaluate dynamic parts of menu items. */
7683 menu_item_eval_property (Lisp_Object sexpr
)
7685 int count
= SPECPDL_INDEX ();
7687 specbind (Qinhibit_redisplay
, Qt
);
7688 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7689 menu_item_eval_property_1
);
7690 return unbind_to (count
, val
);
7693 /* This function parses a menu item and leaves the result in the
7694 vector item_properties.
7695 ITEM is a key binding, a possible menu item.
7696 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7698 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7699 parse_menu_item returns true if the item is a menu item and false
7703 parse_menu_item (Lisp_Object item
, int inmenubar
)
7705 Lisp_Object def
, tem
, item_string
, start
;
7707 Lisp_Object keyhint
;
7716 /* Create item_properties vector if necessary. */
7717 if (NILP (item_properties
))
7719 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7721 /* Initialize optional entries. */
7722 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7723 ASET (item_properties
, i
, Qnil
);
7724 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7726 /* Save the item here to protect it from GC. */
7727 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7729 item_string
= XCAR (item
);
7733 if (STRINGP (item_string
))
7735 /* Old format menu item. */
7736 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7738 /* Maybe help string. */
7739 if (CONSP (item
) && STRINGP (XCAR (item
)))
7741 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7746 /* Maybe an obsolete key binding cache. */
7747 if (CONSP (item
) && CONSP (XCAR (item
))
7748 && (NILP (XCAR (XCAR (item
)))
7749 || VECTORP (XCAR (XCAR (item
)))))
7752 /* This is the real definition--the function to run. */
7753 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7755 /* Get enable property, if any. */
7758 tem
= Fget (item
, Qmenu_enable
);
7759 if (!NILP (Venable_disabled_menus_and_buttons
))
7760 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7761 else if (!NILP (tem
))
7762 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7765 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7767 /* New format menu item. */
7768 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7769 start
= XCDR (item
);
7772 /* We have a real binding. */
7773 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7775 item
= XCDR (start
);
7776 /* Is there an obsolete cache list with key equivalences. */
7777 if (CONSP (item
) && CONSP (XCAR (item
)))
7780 /* Parse properties. */
7781 while (CONSP (item
) && CONSP (XCDR (item
)))
7786 if (EQ (tem
, QCenable
))
7788 if (!NILP (Venable_disabled_menus_and_buttons
))
7789 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7791 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7793 else if (EQ (tem
, QCvisible
))
7795 /* If got a visible property and that evaluates to nil
7796 then ignore this item. */
7797 tem
= menu_item_eval_property (XCAR (item
));
7801 else if (EQ (tem
, QChelp
))
7802 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7803 else if (EQ (tem
, QCfilter
))
7805 else if (EQ (tem
, QCkey_sequence
))
7808 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7809 /* Be GC protected. Set keyhint to item instead of tem. */
7812 else if (EQ (tem
, QCkeys
))
7815 if (CONSP (tem
) || STRINGP (tem
))
7816 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7818 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7823 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7825 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7827 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7833 else if (inmenubar
|| !NILP (start
))
7837 return 0; /* not a menu item */
7839 /* If item string is not a string, evaluate it to get string.
7840 If we don't get a string, skip this item. */
7841 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7842 if (!(STRINGP (item_string
)))
7844 item_string
= menu_item_eval_property (item_string
);
7845 if (!STRINGP (item_string
))
7847 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7850 /* If got a filter apply it on definition. */
7851 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7854 def
= menu_item_eval_property (list2 (XCAR (filter
),
7855 list2 (Qquote
, def
)));
7857 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7860 /* Enable or disable selection of item. */
7861 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7864 tem
= menu_item_eval_property (tem
);
7865 if (inmenubar
&& NILP (tem
))
7866 return 0; /* Ignore disabled items in menu bar. */
7867 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7870 /* If we got no definition, this item is just unselectable text which
7871 is OK in a submenu but not in the menubar. */
7873 return (!inmenubar
);
7875 /* See if this is a separate pane or a submenu. */
7876 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7877 tem
= get_keymap (def
, 0, 1);
7878 /* For a subkeymap, just record its details and exit. */
7881 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7882 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7886 /* At the top level in the menu bar, do likewise for commands also.
7887 The menu bar does not display equivalent key bindings anyway.
7888 ITEM_PROPERTY_DEF is already set up properly. */
7892 { /* This is a command. See if there is an equivalent key binding. */
7893 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7895 /* The previous code preferred :key-sequence to :keys, so we
7896 preserve this behavior. */
7897 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7898 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7901 Lisp_Object prefix
= keyeq
;
7902 Lisp_Object keys
= Qnil
;
7906 def
= XCAR (prefix
);
7907 prefix
= XCDR (prefix
);
7910 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7912 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7914 keys
= XCAR (keyhint
);
7915 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7917 /* We have a suggested key. Is it bound to the command? */
7920 /* If the command is an alias for another
7921 (such as lmenu.el set it up), check if the
7922 original command matches the cached command. */
7923 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7928 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7932 tem
= Fkey_description (keys
, Qnil
);
7935 if (STRINGP (XCAR (prefix
)))
7936 tem
= concat2 (XCAR (prefix
), tem
);
7937 if (STRINGP (XCDR (prefix
)))
7938 tem
= concat2 (tem
, XCDR (prefix
));
7940 keyeq
= concat2 (build_string (" "), tem
);
7941 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7947 /* If we have an equivalent key binding, use that. */
7948 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7951 /* Include this when menu help is implemented.
7952 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7953 if (!(NILP (tem) || STRINGP (tem)))
7955 tem = menu_item_eval_property (tem);
7958 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7962 /* Handle radio buttons or toggle boxes. */
7963 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7965 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7966 menu_item_eval_property (tem
));
7973 /***********************************************************************
7975 ***********************************************************************/
7977 /* A vector holding tool bar items while they are parsed in function
7978 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7981 static Lisp_Object tool_bar_items_vector
;
7983 /* A vector holding the result of parse_tool_bar_item. Layout is like
7984 the one for a single item in tool_bar_items_vector. */
7986 static Lisp_Object tool_bar_item_properties
;
7988 /* Next free index in tool_bar_items_vector. */
7990 static int ntool_bar_items
;
7992 /* The symbols `:image' and `:rtl'. */
7994 static Lisp_Object QCimage
;
7995 static Lisp_Object QCrtl
;
7997 /* Function prototypes. */
7999 static void init_tool_bar_items (Lisp_Object
);
8000 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8001 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8002 static void append_tool_bar_item (void);
8005 /* Return a vector of tool bar items for keymaps currently in effect.
8006 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8007 tool bar items found. */
8010 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8019 /* In order to build the menus, we need to call the keymap
8020 accessors. They all call QUIT. But this function is called
8021 during redisplay, during which a quit is fatal. So inhibit
8022 quitting while building the menus. We do this instead of
8023 specbind because (1) errors will clear it anyway and (2) this
8024 avoids risk of specpdl overflow. */
8025 oquit
= Vinhibit_quit
;
8028 /* Initialize tool_bar_items_vector and protect it from GC. */
8029 init_tool_bar_items (reuse
);
8031 /* Build list of keymaps in maps. Set nmaps to the number of maps
8034 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8035 if (!NILP (Voverriding_local_map_menu_flag
))
8037 /* Yes, use them (if non-nil) as well as the global map. */
8038 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8040 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8041 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8042 if (!NILP (Voverriding_local_map
))
8043 maps
[nmaps
++] = Voverriding_local_map
;
8047 /* No, so use major and minor mode keymaps and keymap property.
8048 Note that tool-bar bindings in the local-map and keymap
8049 properties may not work reliable, as they are only
8050 recognized when the tool-bar (or mode-line) is updated,
8051 which does not normally happen after every command. */
8054 nminor
= current_minor_maps (NULL
, &tmaps
);
8055 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8057 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8058 maps
[nmaps
++] = tem
;
8059 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8061 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8064 /* Add global keymap at the end. */
8065 maps
[nmaps
++] = current_global_map
;
8067 /* Process maps in reverse order and look up in each map the prefix
8069 for (i
= nmaps
- 1; i
>= 0; --i
)
8070 if (!NILP (maps
[i
]))
8074 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8076 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8079 Vinhibit_quit
= oquit
;
8080 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8081 return tool_bar_items_vector
;
8085 /* Process the definition of KEY which is DEF. */
8088 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8091 struct gcpro gcpro1
, gcpro2
;
8093 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8097 if (EQ (def
, Qundefined
))
8099 /* If a map has an explicit `undefined' as definition,
8100 discard any previously made item. */
8101 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8103 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8105 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8107 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8108 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8109 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8110 * sizeof (Lisp_Object
)));
8111 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8116 else if (parse_tool_bar_item (key
, def
))
8117 /* Append a new tool bar item to tool_bar_items_vector. Accept
8118 more than one definition for the same key. */
8119 append_tool_bar_item ();
8125 /* Parse a tool bar item specification ITEM for key KEY and return the
8126 result in tool_bar_item_properties. Value is zero if ITEM is
8129 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8131 CAPTION is the caption of the item, If it's not a string, it is
8132 evaluated to get a string.
8134 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8135 as binding are currently ignored.
8137 The following properties are recognized:
8141 FORM is evaluated and specifies whether the tool bar item is
8142 enabled or disabled.
8146 FORM is evaluated and specifies whether the tool bar item is visible.
8148 - `:filter FUNCTION'
8150 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8151 result is stored as the new binding.
8153 - `:button (TYPE SELECTED)'
8155 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8156 and specifies whether the button is selected (pressed) or not.
8160 IMAGES is either a single image specification or a vector of four
8161 image specifications. See enum tool_bar_item_images.
8163 - `:help HELP-STRING'.
8165 Gives a help string to display for the tool bar item.
8167 - `:label LABEL-STRING'.
8169 A text label to show with the tool bar button if labels are enabled. */
8172 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8174 /* Access slot with index IDX of vector tool_bar_item_properties. */
8175 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8177 Lisp_Object filter
= Qnil
;
8178 Lisp_Object caption
;
8179 int i
, have_label
= 0;
8181 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8182 Rule out items that aren't lists, don't start with
8183 `menu-item' or whose rest following `tool-bar-item' is not a
8188 /* As an exception, allow old-style menu separators. */
8189 if (STRINGP (XCAR (item
)))
8190 item
= Fcons (XCAR (item
), Qnil
);
8191 else if (!EQ (XCAR (item
), Qmenu_item
)
8192 || (item
= XCDR (item
), !CONSP (item
)))
8195 /* Create tool_bar_item_properties vector if necessary. Reset it to
8197 if (VECTORP (tool_bar_item_properties
))
8199 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8203 tool_bar_item_properties
8204 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8207 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8208 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8210 /* Get the caption of the item. If the caption is not a string,
8211 evaluate it to get a string. If we don't get a string, skip this
8213 caption
= XCAR (item
);
8214 if (!STRINGP (caption
))
8216 caption
= menu_item_eval_property (caption
);
8217 if (!STRINGP (caption
))
8220 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8222 /* If the rest following the caption is not a list, the menu item is
8223 either a separator, or invalid. */
8227 if (menu_separator_name_p (SSDATA (caption
)))
8229 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8230 #if !defined (USE_GTK) && !defined (HAVE_NS)
8231 /* If we use build_desired_tool_bar_string to render the
8232 tool bar, the separator is rendered as an image. */
8233 PROP (TOOL_BAR_ITEM_IMAGES
)
8234 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8235 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8236 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8237 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8244 /* Store the binding. */
8245 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8248 /* Ignore cached key binding, if any. */
8249 if (CONSP (item
) && CONSP (XCAR (item
)))
8252 /* Process the rest of the properties. */
8253 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8255 Lisp_Object ikey
, value
;
8258 value
= XCAR (XCDR (item
));
8260 if (EQ (ikey
, QCenable
))
8262 /* `:enable FORM'. */
8263 if (!NILP (Venable_disabled_menus_and_buttons
))
8264 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8266 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8268 else if (EQ (ikey
, QCvisible
))
8270 /* `:visible FORM'. If got a visible property and that
8271 evaluates to nil then ignore this item. */
8272 if (NILP (menu_item_eval_property (value
)))
8275 else if (EQ (ikey
, QChelp
))
8276 /* `:help HELP-STRING'. */
8277 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8278 else if (EQ (ikey
, QCvert_only
))
8279 /* `:vert-only t/nil'. */
8280 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8281 else if (EQ (ikey
, QClabel
))
8283 const char *bad_label
= "!!?GARBLED ITEM?!!";
8284 /* `:label LABEL-STRING'. */
8285 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8287 : build_string (bad_label
);
8290 else if (EQ (ikey
, QCfilter
))
8291 /* ':filter FORM'. */
8293 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8295 /* `:button (TYPE . SELECTED)'. */
8296 Lisp_Object type
, selected
;
8298 type
= XCAR (value
);
8299 selected
= XCDR (value
);
8300 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8302 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8303 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8306 else if (EQ (ikey
, QCimage
)
8308 || (VECTORP (value
) && ASIZE (value
) == 4)))
8309 /* Value is either a single image specification or a vector
8310 of 4 such specifications for the different button states. */
8311 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8312 else if (EQ (ikey
, QCrtl
))
8314 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8320 /* Try to make one from caption and key. */
8321 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8322 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8323 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8324 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8326 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8327 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8328 Lisp_Object new_lbl
;
8329 ptrdiff_t caption_len
= strlen (capt
);
8331 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8334 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8336 buf
[caption_len
] = '\0';
8340 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8344 strcpy (buf
, label
);
8346 for (j
= 0; buf
[j
] != '\0'; ++j
)
8354 new_lbl
= Fupcase_initials (build_string (label
));
8355 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8356 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8358 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8362 /* If got a filter apply it on binding. */
8364 PROP (TOOL_BAR_ITEM_BINDING
)
8365 = menu_item_eval_property (list2 (filter
,
8367 PROP (TOOL_BAR_ITEM_BINDING
))));
8369 /* See if the binding is a keymap. Give up if it is. */
8370 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8373 /* Enable or disable selection of item. */
8374 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8375 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8376 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8378 /* Handle radio buttons or toggle boxes. */
8379 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8380 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8381 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8389 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8390 that can be reused. */
8393 init_tool_bar_items (Lisp_Object reuse
)
8395 if (VECTORP (reuse
))
8396 tool_bar_items_vector
= reuse
;
8398 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8399 ntool_bar_items
= 0;
8403 /* Append parsed tool bar item properties from
8404 tool_bar_item_properties */
8407 append_tool_bar_item (void)
8409 Lisp_Object
*to
, *from
;
8411 /* Enlarge tool_bar_items_vector if necessary. */
8412 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8413 >= ASIZE (tool_bar_items_vector
))
8414 tool_bar_items_vector
8415 = larger_vector (tool_bar_items_vector
,
8416 2 * ASIZE (tool_bar_items_vector
), Qnil
);
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 int 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 int echo_start
IF_LINT (= 0);
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 int 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 int 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 int 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 EMACS_INT 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 int 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 int 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 EMACS_INT 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 Fgarbage_collect. */
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
);