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 void user_error (const char*) NO_RETURN
;
1204 static void user_error (const char *msg
)
1206 xsignal1 (Quser_error
, build_string (msg
));
1209 static Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1210 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1211 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1214 if (command_loop_level
> 0 || minibuf_level
> 0)
1215 Fthrow (Qexit
, Qnil
);
1217 user_error ("No recursive edit is in progress");
1220 static Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1221 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1222 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1225 if (command_loop_level
> 0 || minibuf_level
> 0)
1228 user_error ("No recursive edit is in progress");
1231 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1233 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1234 of this function. */
1237 tracking_off (Lisp_Object old_value
)
1239 do_mouse_tracking
= old_value
;
1240 if (NILP (old_value
))
1242 /* Redisplay may have been preempted because there was input
1243 available, and it assumes it will be called again after the
1244 input has been processed. If the only input available was
1245 the sort that we have just disabled, then we need to call
1247 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1249 redisplay_preserve_echo_area (6);
1250 get_input_pending (&input_pending
,
1251 READABLE_EVENTS_DO_TIMERS_NOW
);
1257 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1258 doc
: /* Evaluate BODY with mouse movement events enabled.
1259 Within a `track-mouse' form, mouse motion generates input events that
1260 you can read with `read-event'.
1261 Normally, mouse motion is ignored.
1262 usage: (track-mouse BODY...) */)
1265 int count
= SPECPDL_INDEX ();
1268 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1270 do_mouse_tracking
= Qt
;
1272 val
= Fprogn (args
);
1273 return unbind_to (count
, val
);
1276 /* If mouse has moved on some frame, return one of those frames.
1280 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1281 after resizing the tool-bar window. */
1283 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1286 int ignore_mouse_drag_p
;
1289 some_mouse_moved (void)
1291 Lisp_Object tail
, frame
;
1293 if (ignore_mouse_drag_p
)
1295 /* ignore_mouse_drag_p = 0; */
1299 FOR_EACH_FRAME (tail
, frame
)
1301 if (XFRAME (frame
)->mouse_moved
)
1302 return XFRAME (frame
);
1308 #endif /* HAVE_MOUSE || HAVE_GPM */
1310 /* This is the actual command reading loop,
1311 sans error-handling encapsulation. */
1313 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1315 void safe_run_hooks (Lisp_Object
);
1316 static void adjust_point_for_property (EMACS_INT
, int);
1318 /* Cancel hourglass from protect_unwind.
1320 #ifdef HAVE_WINDOW_SYSTEM
1322 cancel_hourglass_unwind (Lisp_Object arg
)
1324 cancel_hourglass ();
1329 /* FIXME: This is wrong rather than test window-system, we should call
1330 a new set-selection, which will then dispatch to x-set-selection, or
1331 tty-set-selection, or w32-set-selection, ... */
1332 EXFUN (Fwindow_system
, 1);
1335 command_loop_1 (void)
1338 Lisp_Object keybuf
[30];
1340 int prev_modiff
= 0;
1341 struct buffer
*prev_buffer
= NULL
;
1342 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1343 int was_locked
= single_kboard
;
1345 int already_adjusted
= 0;
1347 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1348 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1349 Vdeactivate_mark
= Qnil
;
1350 waiting_for_input
= 0;
1353 this_command_key_count
= 0;
1354 this_command_key_count_reset
= 0;
1355 this_single_command_key_start
= 0;
1357 if (NILP (Vmemory_full
))
1359 /* Make sure this hook runs after commands that get errors and
1360 throw to top level. */
1361 /* Note that the value cell will never directly contain nil
1362 if the symbol is a local variable. */
1363 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1364 safe_run_hooks (Qpost_command_hook
);
1366 /* If displaying a message, resize the echo area window to fit
1367 that message's size exactly. */
1368 if (!NILP (echo_area_buffer
[0]))
1369 resize_echo_area_exactly ();
1371 /* If there are warnings waiting, process them. */
1372 if (!NILP (Vdelayed_warnings_list
))
1373 safe_run_hooks (Qdelayed_warnings_hook
);
1375 if (!NILP (Vdeferred_action_list
))
1376 safe_run_hooks (Qdeferred_action_function
);
1379 /* Do this after running Vpost_command_hook, for consistency. */
1380 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1381 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1382 if (!CONSP (last_command_event
))
1383 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1387 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1390 /* Make sure the current window's buffer is selected. */
1391 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1392 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1394 /* Display any malloc warning that just came out. Use while because
1395 displaying one warning can cause another. */
1397 while (pending_malloc_warning
)
1398 display_malloc_warning ();
1400 Vdeactivate_mark
= Qnil
;
1402 /* If minibuffer on and echo area in use,
1403 wait a short time and redraw minibuffer. */
1406 && !NILP (echo_area_buffer
[0])
1407 && EQ (minibuf_window
, echo_area_window
)
1408 && NUMBERP (Vminibuffer_message_timeout
))
1410 /* Bind inhibit-quit to t so that C-g gets read in
1411 rather than quitting back to the minibuffer. */
1412 int count
= SPECPDL_INDEX ();
1413 specbind (Qinhibit_quit
, Qt
);
1415 sit_for (Vminibuffer_message_timeout
, 0, 2);
1417 /* Clear the echo area. */
1419 safe_run_hooks (Qecho_area_clear_hook
);
1421 unbind_to (count
, Qnil
);
1423 /* If a C-g came in before, treat it as input now. */
1424 if (!NILP (Vquit_flag
))
1427 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1432 /* Select the frame that the last event came from. Usually,
1433 switch-frame events will take care of this, but if some lisp
1434 code swallows a switch-frame event, we'll fix things up here.
1435 Is this a good idea? */
1436 if (FRAMEP (internal_last_event_frame
)
1437 && !EQ (internal_last_event_frame
, selected_frame
))
1438 Fselect_frame (internal_last_event_frame
, Qnil
);
1440 /* If it has changed current-menubar from previous value,
1441 really recompute the menubar from the value. */
1442 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1443 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1444 call0 (Qrecompute_lucid_menubar
);
1446 before_command_key_count
= this_command_key_count
;
1447 before_command_echo_length
= echo_length ();
1449 Vthis_command
= Qnil
;
1450 real_this_command
= Qnil
;
1451 Vthis_original_command
= Qnil
;
1452 Vthis_command_keys_shift_translated
= Qnil
;
1454 /* Read next key sequence; i gets its length. */
1455 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1458 /* A filter may have run while we were reading the input. */
1459 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1461 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1462 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1466 /* Now we have read a key sequence of length I,
1467 or else I is 0 and we found end of file. */
1469 if (i
== 0) /* End of file -- happens only in */
1470 return Qnil
; /* a kbd macro, at the end. */
1471 /* -1 means read_key_sequence got a menu that was rejected.
1472 Just loop around and read another command. */
1476 this_command_key_count
= 0;
1477 this_command_key_count_reset
= 0;
1478 this_single_command_key_start
= 0;
1482 last_command_event
= keybuf
[i
- 1];
1484 /* If the previous command tried to force a specific window-start,
1485 forget about that, in case this command moves point far away
1486 from that position. But also throw away beg_unchanged and
1487 end_unchanged information in that case, so that redisplay will
1488 update the whole window properly. */
1489 if (!NILP (XWINDOW (selected_window
)->force_start
))
1492 XWINDOW (selected_window
)->force_start
= Qnil
;
1493 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1494 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1497 cmd
= read_key_sequence_cmd
;
1498 if (!NILP (Vexecuting_kbd_macro
))
1500 if (!NILP (Vquit_flag
))
1502 Vexecuting_kbd_macro
= Qt
;
1503 QUIT
; /* Make some noise. */
1504 /* Will return since macro now empty. */
1508 /* Do redisplay processing after this command except in special
1509 cases identified below. */
1510 prev_buffer
= current_buffer
;
1511 prev_modiff
= MODIFF
;
1512 last_point_position
= PT
;
1513 last_point_position_window
= selected_window
;
1514 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1516 /* By default, we adjust point to a boundary of a region that
1517 has such a property that should be treated intangible
1518 (e.g. composition, display). But, some commands will set
1519 this variable differently. */
1520 Vdisable_point_adjustment
= Qnil
;
1522 /* Process filters and timers may have messed with deactivate-mark.
1523 reset it before we execute the command. */
1524 Vdeactivate_mark
= Qnil
;
1526 /* Remap command through active keymaps. */
1527 Vthis_original_command
= cmd
;
1528 if (!NILP (read_key_sequence_remapped
))
1529 cmd
= read_key_sequence_remapped
;
1531 /* Execute the command. */
1533 Vthis_command
= cmd
;
1534 real_this_command
= cmd
;
1535 safe_run_hooks (Qpre_command_hook
);
1537 already_adjusted
= 0;
1539 if (NILP (Vthis_command
))
1541 /* nil means key is undefined. */
1542 Lisp_Object keys
= Fvector (i
, keybuf
);
1543 keys
= Fkey_description (keys
, Qnil
);
1545 message_with_string ("%s is undefined", keys
, 0);
1546 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1547 update_mode_lines
= 1;
1548 /* If this is a down-mouse event, don't reset prefix-arg;
1549 pass it to the command run by the up event. */
1550 if (EVENT_HAS_PARAMETERS (last_command_event
))
1552 Lisp_Object breakdown
1553 = parse_modifiers (EVENT_HEAD (last_command_event
));
1554 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1555 if (!(modifiers
& down_modifier
))
1556 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1559 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1563 /* Here for a command that isn't executed directly. */
1565 #ifdef HAVE_WINDOW_SYSTEM
1566 int scount
= SPECPDL_INDEX ();
1568 if (display_hourglass_p
1569 && NILP (Vexecuting_kbd_macro
))
1571 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1576 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1578 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1580 #ifdef HAVE_WINDOW_SYSTEM
1581 /* Do not check display_hourglass_p here, because
1582 Fcommand_execute could change it, but we should cancel
1583 hourglass cursor anyway.
1584 But don't cancel the hourglass within a macro
1585 just because a command in the macro finishes. */
1586 if (NILP (Vexecuting_kbd_macro
))
1587 unbind_to (scount
, Qnil
);
1590 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1592 safe_run_hooks (Qpost_command_hook
);
1594 /* If displaying a message, resize the echo area window to fit
1595 that message's size exactly. */
1596 if (!NILP (echo_area_buffer
[0]))
1597 resize_echo_area_exactly ();
1599 /* If there are warnings waiting, process them. */
1600 if (!NILP (Vdelayed_warnings_list
))
1601 safe_run_hooks (Qdelayed_warnings_hook
);
1603 safe_run_hooks (Qdeferred_action_function
);
1605 /* If there is a prefix argument,
1606 1) We don't want Vlast_command to be ``universal-argument''
1607 (that would be dumb), so don't set Vlast_command,
1608 2) we want to leave echoing on so that the prefix will be
1609 echoed as part of this key sequence, so don't call
1611 3) we want to leave this_command_key_count non-zero, so that
1612 read_char will realize that it is re-reading a character, and
1613 not echo it a second time.
1615 If the command didn't actually create a prefix arg,
1616 but is merely a frame event that is transparent to prefix args,
1617 then the above doesn't apply. */
1618 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1620 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1621 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1622 if (!CONSP (last_command_event
))
1623 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1625 this_command_key_count
= 0;
1626 this_command_key_count_reset
= 0;
1627 this_single_command_key_start
= 0;
1630 if (!NILP (BVAR (current_buffer
, mark_active
))
1631 && !NILP (Vrun_hooks
))
1633 /* In Emacs 22, setting transient-mark-mode to `only' was a
1634 way of turning it on for just one command. This usage is
1635 obsolete, but support it anyway. */
1636 if (EQ (Vtransient_mark_mode
, Qidentity
))
1637 Vtransient_mark_mode
= Qnil
;
1638 else if (EQ (Vtransient_mark_mode
, Qonly
))
1639 Vtransient_mark_mode
= Qidentity
;
1641 if (!NILP (Vdeactivate_mark
))
1642 /* If `select-active-regions' is non-nil, this call to
1643 `deactivate-mark' also sets the PRIMARY selection. */
1644 call0 (Qdeactivate_mark
);
1647 /* Even if not deactivating the mark, set PRIMARY if
1648 `select-active-regions' is non-nil. */
1649 if (!NILP (Fwindow_system (Qnil
))
1650 /* Even if mark_active is non-nil, the actual buffer
1651 marker may not have been set yet (Bug#7044). */
1652 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1653 && (EQ (Vselect_active_regions
, Qonly
)
1654 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1655 : (!NILP (Vselect_active_regions
)
1656 && !NILP (Vtransient_mark_mode
)))
1657 && NILP (Fmemq (Vthis_command
,
1658 Vselection_inhibit_update_commands
)))
1661 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1664 call2 (Qx_set_selection
, QPRIMARY
,
1665 make_buffer_string (beg
, end
, 0));
1667 call2 (Qx_set_selection
, QPRIMARY
,
1668 make_buffer_string (end
, beg
, 0));
1669 /* Don't set empty selections. */
1672 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1674 Lisp_Object hook
= intern ("activate-mark-hook");
1675 Frun_hooks (1, &hook
);
1679 Vsaved_region_selection
= Qnil
;
1684 if (current_buffer
== prev_buffer
1685 && last_point_position
!= PT
1686 && NILP (Vdisable_point_adjustment
)
1687 && NILP (Vglobal_disable_point_adjustment
))
1689 if (last_point_position
> BEGV
1690 && last_point_position
< ZV
1691 && (composition_adjust_point (last_point_position
,
1692 last_point_position
)
1693 != last_point_position
))
1694 /* The last point was temporarily set within a grapheme
1695 cluster to prevent automatic composition. To recover
1696 the automatic composition, we must update the
1698 windows_or_buffers_changed
++;
1699 if (!already_adjusted
)
1700 adjust_point_for_property (last_point_position
,
1701 MODIFF
!= prev_modiff
);
1704 /* Install chars successfully executed in kbd macro. */
1706 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1707 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1708 finalize_kbd_macro_chars ();
1709 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1711 any_kboard_state ();
1716 /* Adjust point to a boundary of a region that has such a property
1717 that should be treated intangible. For the moment, we check
1718 `composition', `display' and `invisible' properties.
1719 LAST_PT is the last position of point. */
1722 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1725 Lisp_Object val
, overlay
, tmp
;
1726 /* When called after buffer modification, we should temporarily
1727 suppress the point adjustment for automatic composition so that a
1728 user can keep inserting another character at point or keep
1729 deleting characters around point. */
1730 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1731 EMACS_INT orig_pt
= PT
;
1733 /* FIXME: cycling is probably not necessary because these properties
1734 can't be usefully combined anyway. */
1735 while (check_composition
|| check_display
|| check_invisible
)
1737 /* FIXME: check `intangible'. */
1738 if (check_composition
1739 && PT
> BEGV
&& PT
< ZV
1740 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1743 check_display
= check_invisible
= 1;
1745 check_composition
= 0;
1747 && PT
> BEGV
&& PT
< ZV
1748 && !NILP (val
= get_char_property_and_overlay
1749 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1750 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1751 && (!OVERLAYP (overlay
)
1752 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1753 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1754 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1755 && (beg
< PT
/* && end > PT <- It's always the case. */
1756 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1759 SET_PT (PT
< last_pt
1760 ? (STRINGP (val
) && SCHARS (val
) == 0
1761 ? max (beg
- 1, BEGV
)
1764 check_composition
= check_invisible
= 1;
1767 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1769 int inv
, ellipsis
= 0;
1772 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1775 /* FIXME: We should stop if we find a spot between
1776 two runs of `invisible' where inserted text would
1777 be visible. This is important when we have two
1778 invisible boundaries that enclose an area: if the
1779 area is empty, we need this test in order to make
1780 it possible to place point in the middle rather
1781 than skip both boundaries. However, this code
1782 also stops anywhere in a non-sticky text-property,
1783 which breaks (e.g.) Org mode. */
1784 && (val
= get_pos_property (make_number (end
),
1786 TEXT_PROP_MEANS_INVISIBLE (val
))
1788 && !NILP (val
= get_char_property_and_overlay
1789 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1790 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1792 ellipsis
= ellipsis
|| inv
> 1
1793 || (OVERLAYP (overlay
)
1794 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1795 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1796 tmp
= Fnext_single_char_property_change
1797 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1798 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1802 && (val
= get_pos_property (make_number (beg
),
1804 TEXT_PROP_MEANS_INVISIBLE (val
))
1806 && !NILP (val
= get_char_property_and_overlay
1807 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1808 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1810 ellipsis
= ellipsis
|| inv
> 1
1811 || (OVERLAYP (overlay
)
1812 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1813 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1814 tmp
= Fprevious_single_char_property_change
1815 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1816 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1819 /* Move away from the inside area. */
1820 if (beg
< PT
&& end
> PT
)
1822 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1823 /* We haven't moved yet (so we don't need to fear
1824 infinite-looping) and we were outside the range
1825 before (so either end of the range still corresponds
1826 to a move in the right direction): pretend we moved
1827 less than we actually did, so that we still have
1828 more freedom below in choosing which end of the range
1830 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1831 /* We either have moved already or the last point
1832 was already in the range: we don't get to choose
1833 which end of the range we have to go to. */
1834 : (PT
< last_pt
? beg
: end
));
1835 check_composition
= check_display
= 1;
1837 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1838 the point to something other than its argument, due to
1839 point-motion hooks, intangibility, etc. */
1840 xassert (PT
== beg
|| PT
== end
);
1843 /* Pretend the area doesn't exist if the buffer is not
1845 if (!modified
&& !ellipsis
&& beg
< end
)
1847 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1848 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1849 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1850 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1851 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1852 /* We've already moved as far as we can. Trying to go
1853 to the other end would mean moving backwards and thus
1854 could lead to an infinite loop. */
1856 else if (val
= get_pos_property (make_number (PT
),
1858 TEXT_PROP_MEANS_INVISIBLE (val
)
1859 && (val
= get_pos_property
1860 (make_number (PT
== beg
? end
: beg
),
1862 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1863 (check_composition
= check_display
= 1,
1864 SET_PT (PT
== beg
? end
: beg
));
1867 check_invisible
= 0;
1871 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1874 safe_run_hooks_1 (void)
1876 eassert (CONSP (Vinhibit_quit
));
1877 return call0 (XCDR (Vinhibit_quit
));
1880 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1884 safe_run_hooks_error (Lisp_Object error_data
)
1887 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1888 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1889 Lisp_Object args
[4];
1890 args
[0] = build_string ("Error in %s (%s): %S");
1893 args
[3] = error_data
;
1899 Lisp_Object newval
= Qnil
;
1900 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1901 if (EQ (fun
, XCAR (val
)))
1904 newval
= Fcons (XCAR (val
), newval
);
1906 return Fset (hook
, Fnreverse (newval
));
1907 /* Not found in the local part of the hook. Let's look at the global
1910 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1911 : Fdefault_value (hook
));
1912 CONSP (val
); val
= XCDR (val
))
1913 if (EQ (fun
, XCAR (val
)))
1916 newval
= Fcons (XCAR (val
), newval
);
1918 return Fset_default (hook
, Fnreverse (newval
));
1924 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1926 eassert (nargs
== 1);
1927 if (CONSP (Vinhibit_quit
))
1928 XSETCDR (Vinhibit_quit
, args
[0]);
1930 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1932 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1936 /* If we get an error while running the hook, cause the hook variable
1937 to be nil. Also inhibit quits, so that C-g won't cause the hook
1938 to mysteriously evaporate. */
1941 safe_run_hooks (Lisp_Object hook
)
1943 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1944 to its body or to its handlers other than via globals such as
1945 dynamically-bound variables ;-) */
1946 int count
= SPECPDL_INDEX ();
1947 specbind (Qinhibit_quit
, hook
);
1949 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1951 unbind_to (count
, Qnil
);
1955 /* Nonzero means polling for input is temporarily suppressed. */
1957 int poll_suppress_count
;
1959 /* Asynchronous timer for polling. */
1961 static struct atimer
*poll_timer
;
1964 #ifdef POLL_FOR_INPUT
1966 /* Poll for input, so that we catch a C-g if it comes in. This
1967 function is called from x_make_frame_visible, see comment
1971 poll_for_input_1 (void)
1973 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1974 doing anything dangerous. */
1978 if (interrupt_input_blocked
== 0
1979 && !waiting_for_input
)
1980 read_avail_input (0);
1986 /* Timer callback function for poll_timer. TIMER is equal to
1990 poll_for_input (struct atimer
*timer
)
1992 if (poll_suppress_count
== 0)
1995 interrupt_input_pending
= 1;
1996 pending_signals
= 1;
1998 poll_for_input_1 ();
2003 #endif /* POLL_FOR_INPUT */
2005 /* Begin signals to poll for input, if they are appropriate.
2006 This function is called unconditionally from various places. */
2009 start_polling (void)
2011 #ifdef POLL_FOR_INPUT
2012 /* XXX This condition was (read_socket_hook && !interrupt_input),
2013 but read_socket_hook is not global anymore. Let's pretend that
2015 if (!interrupt_input
)
2017 /* Turn alarm handling on unconditionally. It might have
2018 been turned off in process.c. */
2019 turn_on_atimers (1);
2021 /* If poll timer doesn't exist, are we need one with
2022 a different interval, start a new one. */
2023 if (poll_timer
== NULL
2024 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2026 EMACS_TIME interval
;
2029 cancel_atimer (poll_timer
);
2031 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2032 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2033 poll_for_input
, NULL
);
2036 /* Let the timer's callback function poll for input
2037 if this becomes zero. */
2038 --poll_suppress_count
;
2043 /* Nonzero if we are using polling to handle input asynchronously. */
2046 input_polling_used (void)
2048 #ifdef POLL_FOR_INPUT
2049 /* XXX This condition was (read_socket_hook && !interrupt_input),
2050 but read_socket_hook is not global anymore. Let's pretend that
2052 return !interrupt_input
;
2058 /* Turn off polling. */
2063 #ifdef POLL_FOR_INPUT
2064 /* XXX This condition was (read_socket_hook && !interrupt_input),
2065 but read_socket_hook is not global anymore. Let's pretend that
2067 if (!interrupt_input
)
2068 ++poll_suppress_count
;
2072 /* Set the value of poll_suppress_count to COUNT
2073 and start or stop polling accordingly. */
2076 set_poll_suppress_count (int count
)
2078 #ifdef POLL_FOR_INPUT
2079 if (count
== 0 && poll_suppress_count
!= 0)
2081 poll_suppress_count
= 1;
2084 else if (count
!= 0 && poll_suppress_count
== 0)
2088 poll_suppress_count
= count
;
2092 /* Bind polling_period to a value at least N.
2093 But don't decrease it. */
2096 bind_polling_period (int n
)
2098 #ifdef POLL_FOR_INPUT
2099 int new = polling_period
;
2104 stop_other_atimers (poll_timer
);
2106 specbind (Qpolling_period
, make_number (new));
2107 /* Start a new alarm with the new period. */
2112 /* Apply the control modifier to CHARACTER. */
2115 make_ctrl_char (int c
)
2117 /* Save the upper bits here. */
2118 int upper
= c
& ~0177;
2120 if (! ASCII_BYTE_P (c
))
2121 return c
|= ctrl_modifier
;
2125 /* Everything in the columns containing the upper-case letters
2126 denotes a control character. */
2127 if (c
>= 0100 && c
< 0140)
2131 /* Set the shift modifier for a control char
2132 made from a shifted letter. But only for letters! */
2133 if (oc
>= 'A' && oc
<= 'Z')
2134 c
|= shift_modifier
;
2137 /* The lower-case letters denote control characters too. */
2138 else if (c
>= 'a' && c
<= 'z')
2141 /* Include the bits for control and shift
2142 only if the basic ASCII code can't indicate them. */
2146 /* Replace the high bits. */
2147 c
|= (upper
& ~ctrl_modifier
);
2152 /* Display the help-echo property of the character after the mouse pointer.
2153 Either show it in the echo area, or call show-help-function to display
2154 it by other means (maybe in a tooltip).
2156 If HELP is nil, that means clear the previous help echo.
2158 If HELP is a string, display that string. If HELP is a function,
2159 call it with OBJECT and POS as arguments; the function should
2160 return a help string or nil for none. For all other types of HELP,
2161 evaluate it to obtain a string.
2163 WINDOW is the window in which the help was generated, if any.
2164 It is nil if not in a window.
2166 If OBJECT is a buffer, POS is the position in the buffer where the
2167 `help-echo' text property was found.
2169 If OBJECT is an overlay, that overlay has a `help-echo' property,
2170 and POS is the position in the overlay's buffer under the mouse.
2172 If OBJECT is a string (an overlay string or a string displayed with
2173 the `display' property). POS is the position in that string under
2176 Note: this function may only be called with HELP nil or a string
2177 from X code running asynchronously. */
2180 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2183 if (!NILP (help
) && !STRINGP (help
))
2185 if (FUNCTIONP (help
))
2187 Lisp_Object args
[4];
2192 help
= safe_call (4, args
);
2195 help
= safe_eval (help
);
2197 if (!STRINGP (help
))
2201 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2202 if (!noninteractive
&& STRINGP (help
))
2204 /* The mouse-fixup-help-message Lisp function can call
2205 mouse_position_hook, which resets the mouse_moved flags.
2206 This causes trouble if we are trying to read a mouse motion
2207 event (i.e., if we are inside a `track-mouse' form), so we
2208 restore the mouse_moved flag. */
2209 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2210 help
= call1 (Qmouse_fixup_help_message
, help
);
2216 if (STRINGP (help
) || NILP (help
))
2218 if (!NILP (Vshow_help_function
))
2219 call1 (Vshow_help_function
, help
);
2220 help_echo_showing_p
= STRINGP (help
);
2226 /* Input of single characters from keyboard */
2228 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2229 struct timeval
*end_time
);
2230 static void record_char (Lisp_Object c
);
2232 static Lisp_Object help_form_saved_window_configs
;
2234 read_char_help_form_unwind (Lisp_Object arg
)
2236 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2237 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2238 if (!NILP (window_config
))
2239 Fset_window_configuration (window_config
);
2243 #define STOP_POLLING \
2244 do { if (! polling_stopped_here) stop_polling (); \
2245 polling_stopped_here = 1; } while (0)
2247 #define RESUME_POLLING \
2248 do { if (polling_stopped_here) start_polling (); \
2249 polling_stopped_here = 0; } while (0)
2251 /* read a character from the keyboard; call the redisplay if needed */
2252 /* commandflag 0 means do not autosave, but do redisplay.
2253 -1 means do not redisplay, but do autosave.
2256 /* The arguments MAPS and NMAPS are for menu prompting.
2257 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2259 PREV_EVENT is the previous input event, or nil if we are reading
2260 the first event of a key sequence (or not reading a key sequence).
2261 If PREV_EVENT is t, that is a "magic" value that says
2262 not to run input methods, but in other respects to act as if
2263 not reading a key sequence.
2265 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2266 if we used a mouse menu to read the input, or zero otherwise. If
2267 USED_MOUSE_MENU is null, we don't dereference it.
2269 Value is -2 when we find input on another keyboard. A second call
2270 to read_char will read it.
2272 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2273 specifying the maximum time to wait until. If no input arrives by
2274 that time, stop waiting and return nil.
2276 Value is t if we showed a menu and the user rejected it. */
2279 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2280 Lisp_Object prev_event
,
2281 int *used_mouse_menu
, struct timeval
*end_time
)
2283 volatile Lisp_Object c
;
2285 jmp_buf local_getcjmp
;
2287 volatile int key_already_recorded
= 0;
2288 Lisp_Object tem
, save
;
2289 volatile Lisp_Object previous_echo_area_message
;
2290 volatile Lisp_Object also_record
;
2291 volatile int reread
;
2292 struct gcpro gcpro1
, gcpro2
;
2293 int volatile polling_stopped_here
= 0;
2294 struct kboard
*orig_kboard
= current_kboard
;
2298 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2299 before_command_key_count
= this_command_key_count
;
2300 before_command_echo_length
= echo_length ();
2303 previous_echo_area_message
= Qnil
;
2305 GCPRO2 (c
, previous_echo_area_message
);
2310 if (CONSP (Vunread_post_input_method_events
))
2312 c
= XCAR (Vunread_post_input_method_events
);
2313 Vunread_post_input_method_events
2314 = XCDR (Vunread_post_input_method_events
);
2316 /* Undo what read_char_x_menu_prompt did when it unread
2317 additional keys returned by Fx_popup_menu. */
2319 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2327 if (unread_command_char
!= -1)
2329 XSETINT (c
, unread_command_char
);
2330 unread_command_char
= -1;
2336 if (CONSP (Vunread_command_events
))
2338 int was_disabled
= 0;
2340 c
= XCAR (Vunread_command_events
);
2341 Vunread_command_events
= XCDR (Vunread_command_events
);
2345 /* Undo what sit-for did when it unread additional keys
2346 inside universal-argument. */
2349 && EQ (XCAR (c
), Qt
))
2355 /* Undo what read_char_x_menu_prompt did when it unread
2356 additional keys returned by Fx_popup_menu. */
2358 && EQ (XCDR (c
), Qdisabled
)
2359 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2365 /* If the queued event is something that used the mouse,
2366 set used_mouse_menu accordingly. */
2368 /* Also check was_disabled so last-nonmenu-event won't return
2369 a bad value when submenus are involved. (Bug#447) */
2370 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2371 *used_mouse_menu
= 1;
2373 goto reread_for_input_method
;
2376 if (CONSP (Vunread_input_method_events
))
2378 c
= XCAR (Vunread_input_method_events
);
2379 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2381 /* Undo what read_char_x_menu_prompt did when it unread
2382 additional keys returned by Fx_popup_menu. */
2384 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2388 goto reread_for_input_method
;
2391 this_command_key_count_reset
= 0;
2393 if (!NILP (Vexecuting_kbd_macro
))
2395 /* We set this to Qmacro; since that's not a frame, nobody will
2396 try to switch frames on us, and the selected window will
2399 Since this event came from a macro, it would be misleading to
2400 leave internal_last_event_frame set to wherever the last
2401 real event came from. Normally, a switch-frame event selects
2402 internal_last_event_frame after each command is read, but
2403 events read from a macro should never cause a new frame to be
2405 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2407 /* Exit the macro if we are at the end.
2408 Also, some things replace the macro with t
2409 to force an early exit. */
2410 if (EQ (Vexecuting_kbd_macro
, Qt
)
2411 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2417 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2418 if (STRINGP (Vexecuting_kbd_macro
)
2419 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2420 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2422 executing_kbd_macro_index
++;
2427 if (!NILP (unread_switch_frame
))
2429 c
= unread_switch_frame
;
2430 unread_switch_frame
= Qnil
;
2432 /* This event should make it into this_command_keys, and get echoed
2433 again, so we do not set `reread'. */
2437 /* if redisplay was requested */
2438 if (commandflag
>= 0)
2440 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2442 /* If there is pending input, process any events which are not
2443 user-visible, such as X selection_request events. */
2445 || detect_input_pending_run_timers (0))
2446 swallow_events (0); /* may clear input_pending */
2448 /* Redisplay if no pending input. */
2449 while (!input_pending
)
2451 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2452 redisplay_preserve_echo_area (5);
2457 /* Normal case: no input arrived during redisplay. */
2460 /* Input arrived and pre-empted redisplay.
2461 Process any events which are not user-visible. */
2463 /* If that cleared input_pending, try again to redisplay. */
2466 /* Prevent the redisplay we just did
2467 from messing up echoing of the input after the prompt. */
2468 if (commandflag
== 0 && echo_current
)
2469 echo_message_buffer
= echo_area_buffer
[0];
2473 /* Message turns off echoing unless more keystrokes turn it on again.
2475 The code in 20.x for the condition was
2477 1. echo_area_glyphs && *echo_area_glyphs
2478 2. && echo_area_glyphs != current_kboard->echobuf
2479 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2481 (1) means there's a current message displayed
2483 (2) means it's not the message from echoing from the current
2486 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2487 is set to a non-null value. This is done in read_char and it is
2488 set to echo_area_glyphs after a call to echo_char. That means
2489 ok_to_echo_at_next_pause is either null or
2490 current_kboard->echobuf with the appropriate current_kboard at
2493 So, condition (3) means in clear text ok_to_echo_at_next_pause
2494 must be either null, or the current message isn't from echoing at
2495 all, or it's from echoing from a different kboard than the
2498 if (/* There currently is something in the echo area. */
2499 !NILP (echo_area_buffer
[0])
2500 && (/* And it's either not from echoing. */
2501 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2502 /* Or it's an echo from a different kboard. */
2503 || echo_kboard
!= current_kboard
2504 /* Or we explicitly allow overwriting whatever there is. */
2505 || ok_to_echo_at_next_pause
== NULL
))
2510 /* Try reading a character via menu prompting in the minibuf.
2511 Try this before the sit-for, because the sit-for
2512 would do the wrong thing if we are supposed to do
2513 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2514 after a mouse event so don't try a minibuf menu. */
2516 if (nmaps
> 0 && INTERACTIVE
2517 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2518 /* Don't bring up a menu if we already have another event. */
2519 && NILP (Vunread_command_events
)
2520 && unread_command_char
< 0
2521 && !detect_input_pending_run_timers (0))
2523 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2525 if (INTEGERP (c
) && XINT (c
) == -2)
2526 return c
; /* wrong_kboard_jmpbuf */
2530 key_already_recorded
= 1;
2535 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2536 We will do that below, temporarily for short sections of code,
2537 when appropriate. local_getcjmp must be in effect
2538 around any call to sit_for or kbd_buffer_get_event;
2539 it *must not* be in effect when we call redisplay. */
2541 jmpcount
= SPECPDL_INDEX ();
2542 if (_setjmp (local_getcjmp
))
2544 /* Handle quits while reading the keyboard. */
2545 /* We must have saved the outer value of getcjmp here,
2546 so restore it now. */
2547 restore_getcjmp (save_jump
);
2548 unbind_to (jmpcount
, Qnil
);
2549 XSETINT (c
, quit_char
);
2550 internal_last_event_frame
= selected_frame
;
2551 Vlast_event_frame
= internal_last_event_frame
;
2552 /* If we report the quit char as an event,
2553 don't do so more than once. */
2554 if (!NILP (Vinhibit_quit
))
2558 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2559 if (kb
!= current_kboard
)
2561 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2562 /* We shouldn't get here if we were in single-kboard mode! */
2567 while (CONSP (XCDR (last
)))
2569 if (!NILP (XCDR (last
)))
2573 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2575 XSETCDR (last
, Fcons (c
, Qnil
));
2576 kb
->kbd_queue_has_data
= 1;
2577 current_kboard
= kb
;
2578 /* This is going to exit from read_char
2579 so we had better get rid of this frame's stuff. */
2581 return make_number (-2); /* wrong_kboard_jmpbuf */
2587 /* Start idle timers if no time limit is supplied. We don't do it
2588 if a time limit is supplied to avoid an infinite recursion in the
2589 situation where an idle timer calls `sit-for'. */
2592 timer_start_idle ();
2594 /* If in middle of key sequence and minibuffer not active,
2595 start echoing if enough time elapses. */
2597 if (minibuf_level
== 0
2599 && !current_kboard
->immediate_echo
2600 && this_command_key_count
> 0
2602 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2603 && NILP (Fzerop (Vecho_keystrokes
))
2604 && (/* No message. */
2605 NILP (echo_area_buffer
[0])
2606 /* Or empty message. */
2607 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2608 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2609 /* Or already echoing from same kboard. */
2610 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2611 /* Or not echoing before and echoing allowed. */
2612 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2614 /* After a mouse event, start echoing right away.
2615 This is because we are probably about to display a menu,
2616 and we don't want to delay before doing so. */
2617 if (EVENT_HAS_PARAMETERS (prev_event
))
2623 save_getcjmp (save_jump
);
2624 restore_getcjmp (local_getcjmp
);
2625 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2626 restore_getcjmp (save_jump
);
2628 && ! CONSP (Vunread_command_events
))
2633 /* Maybe auto save due to number of keystrokes. */
2635 if (commandflag
!= 0
2636 && auto_save_interval
> 0
2637 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2638 && !detect_input_pending_run_timers (0))
2640 Fdo_auto_save (Qnil
, Qnil
);
2641 /* Hooks can actually change some buffers in auto save. */
2645 /* Try reading using an X menu.
2646 This is never confused with reading using the minibuf
2647 because the recursive call of read_char in read_char_minibuf_menu_prompt
2648 does not pass on any keymaps. */
2650 if (nmaps
> 0 && INTERACTIVE
2651 && !NILP (prev_event
)
2652 && EVENT_HAS_PARAMETERS (prev_event
)
2653 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2654 && !EQ (XCAR (prev_event
), Qtool_bar
)
2655 /* Don't bring up a menu if we already have another event. */
2656 && NILP (Vunread_command_events
)
2657 && unread_command_char
< 0)
2659 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2661 /* Now that we have read an event, Emacs is not idle. */
2668 /* Maybe autosave and/or garbage collect due to idleness. */
2670 if (INTERACTIVE
&& NILP (c
))
2673 EMACS_INT buffer_size
;
2675 /* Slow down auto saves logarithmically in size of current buffer,
2676 and garbage collect while we're at it. */
2677 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2678 last_non_minibuf_size
= Z
- BEG
;
2679 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2681 while (buffer_size
> 64)
2682 delay_level
++, buffer_size
-= buffer_size
>> 2;
2683 if (delay_level
< 4) delay_level
= 4;
2684 /* delay_level is 4 for files under around 50k, 7 at 100k,
2685 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2687 /* Auto save if enough time goes by without input. */
2688 if (commandflag
!= 0
2689 && num_nonmacro_input_events
> last_auto_save
2690 && INTEGERP (Vauto_save_timeout
)
2691 && XINT (Vauto_save_timeout
) > 0)
2694 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2696 save_getcjmp (save_jump
);
2697 restore_getcjmp (local_getcjmp
);
2698 tem0
= sit_for (make_number (timeout
), 1, 1);
2699 restore_getcjmp (save_jump
);
2702 && ! CONSP (Vunread_command_events
))
2704 Fdo_auto_save (Qnil
, Qnil
);
2706 /* If we have auto-saved and there is still no input
2707 available, garbage collect if there has been enough
2708 consing going on to make it worthwhile. */
2709 if (!detect_input_pending_run_timers (0)
2710 && consing_since_gc
> gc_cons_threshold
/ 2)
2711 Fgarbage_collect ();
2718 /* Notify the caller if an autosave hook, or a timer, sentinel or
2719 filter in the sit_for calls above have changed the current
2720 kboard. This could happen if they use the minibuffer or start a
2721 recursive edit, like the fancy splash screen in server.el's
2722 filter. If this longjmp wasn't here, read_key_sequence would
2723 interpret the next key sequence using the wrong translation
2724 tables and function keymaps. */
2725 if (NILP (c
) && current_kboard
!= orig_kboard
)
2728 return make_number (-2); /* wrong_kboard_jmpbuf */
2731 /* If this has become non-nil here, it has been set by a timer
2732 or sentinel or filter. */
2733 if (CONSP (Vunread_command_events
))
2735 c
= XCAR (Vunread_command_events
);
2736 Vunread_command_events
= XCDR (Vunread_command_events
);
2739 /* Read something from current KBOARD's side queue, if possible. */
2743 if (current_kboard
->kbd_queue_has_data
)
2745 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2747 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2748 KVAR (current_kboard
, kbd_queue
)
2749 = XCDR (KVAR (current_kboard
, kbd_queue
));
2750 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2751 current_kboard
->kbd_queue_has_data
= 0;
2752 input_pending
= readable_events (0);
2753 if (EVENT_HAS_PARAMETERS (c
)
2754 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2755 internal_last_event_frame
= XCAR (XCDR (c
));
2756 Vlast_event_frame
= internal_last_event_frame
;
2760 /* If current_kboard's side queue is empty check the other kboards.
2761 If one of them has data that we have not yet seen here,
2762 switch to it and process the data waiting for it.
2764 Note: if the events queued up for another kboard
2765 have already been seen here, and therefore are not a complete command,
2766 the kbd_queue_has_data field is 0, so we skip that kboard here.
2767 That's to avoid an infinite loop switching between kboards here. */
2768 if (NILP (c
) && !single_kboard
)
2771 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2772 if (kb
->kbd_queue_has_data
)
2774 current_kboard
= kb
;
2775 /* This is going to exit from read_char
2776 so we had better get rid of this frame's stuff. */
2778 return make_number (-2); /* wrong_kboard_jmpbuf */
2786 /* Finally, we read from the main queue,
2787 and if that gives us something we can't use yet, we put it on the
2788 appropriate side queue and try again. */
2792 KBOARD
*kb
IF_LINT (= NULL
);
2797 EMACS_GET_TIME (now
);
2798 if (EMACS_TIME_GE (now
, *end_time
))
2802 /* Actually read a character, waiting if necessary. */
2803 save_getcjmp (save_jump
);
2804 restore_getcjmp (local_getcjmp
);
2806 timer_start_idle ();
2807 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2808 restore_getcjmp (save_jump
);
2810 if (! NILP (c
) && (kb
!= current_kboard
))
2812 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2815 while (CONSP (XCDR (last
)))
2817 if (!NILP (XCDR (last
)))
2821 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2823 XSETCDR (last
, Fcons (c
, Qnil
));
2824 kb
->kbd_queue_has_data
= 1;
2828 current_kboard
= kb
;
2829 /* This is going to exit from read_char
2830 so we had better get rid of this frame's stuff. */
2832 return make_number (-2);
2836 /* Terminate Emacs in batch mode if at eof. */
2837 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2838 Fkill_emacs (make_number (1));
2842 /* Add in any extra modifiers, where appropriate. */
2843 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2844 || ((extra_keyboard_modifiers
& 0177) < ' '
2845 && (extra_keyboard_modifiers
& 0177) != 0))
2846 XSETINT (c
, make_ctrl_char (XINT (c
)));
2848 /* Transfer any other modifier bits directly from
2849 extra_keyboard_modifiers to c. Ignore the actual character code
2850 in the low 16 bits of extra_keyboard_modifiers. */
2851 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2862 if (commandflag
>= 0
2863 && !input_pending
&& !detect_input_pending_run_timers (0))
2871 /* Buffer switch events are only for internal wakeups
2872 so don't show them to the user.
2873 Also, don't record a key if we already did. */
2874 if (BUFFERP (c
) || key_already_recorded
)
2877 /* Process special events within read_char
2878 and loop around to read another event. */
2881 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2886 struct buffer
*prev_buffer
= current_buffer
;
2887 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2888 int was_locked
= single_kboard
;
2889 int count
= SPECPDL_INDEX ();
2890 record_single_kboard_state ();
2893 last_input_event
= c
;
2894 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2896 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2897 /* We stopped being idle for this event; undo that. This
2898 prevents automatic window selection (under
2899 mouse_autoselect_window from acting as a real input event, for
2900 example banishing the mouse under mouse-avoidance-mode. */
2901 timer_resume_idle ();
2903 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2904 /* Resume allowing input from any kboard, if that was true before. */
2906 any_kboard_state ();
2907 unbind_to (count
, Qnil
);
2910 if (current_buffer
!= prev_buffer
)
2912 /* The command may have changed the keymaps. Pretend there
2913 is input in another keyboard and return. This will
2914 recalculate keymaps. */
2915 c
= make_number (-2);
2922 /* Handle things that only apply to characters. */
2925 /* If kbd_buffer_get_event gave us an EOF, return that. */
2929 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2930 && UNSIGNED_CMP (XFASTINT (c
), <,
2931 SCHARS (KVAR (current_kboard
,
2932 Vkeyboard_translate_table
))))
2933 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2934 && UNSIGNED_CMP (XFASTINT (c
), <,
2935 ASIZE (KVAR (current_kboard
,
2936 Vkeyboard_translate_table
))))
2937 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2941 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2942 /* nil in keyboard-translate-table means no translation. */
2948 /* If this event is a mouse click in the menu bar,
2949 return just menu-bar for now. Modify the mouse click event
2950 so we won't do this twice, then queue it up. */
2951 if (EVENT_HAS_PARAMETERS (c
)
2953 && CONSP (EVENT_START (c
))
2954 && CONSP (XCDR (EVENT_START (c
))))
2958 posn
= POSN_POSN (EVENT_START (c
));
2959 /* Handle menu-bar events:
2960 insert the dummy prefix event `menu-bar'. */
2961 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2963 /* Change menu-bar to (menu-bar) as the event "position". */
2964 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2967 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2972 /* Store these characters into recent_keys, the dribble file if any,
2973 and the keyboard macro being defined, if any. */
2975 if (! NILP (also_record
))
2976 record_char (also_record
);
2978 /* Wipe the echo area.
2979 But first, if we are about to use an input method,
2980 save the echo area contents for it to refer to. */
2982 && ! NILP (Vinput_method_function
)
2983 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2985 previous_echo_area_message
= Fcurrent_message ();
2986 Vinput_method_previous_message
= previous_echo_area_message
;
2989 /* Now wipe the echo area, except for help events which do their
2990 own stuff with the echo area. */
2992 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2993 && !(EQ (Qswitch_frame
, XCAR (c
)))
2994 /* Don't wipe echo area for select window events: These might
2995 get delayed via `mouse-autoselect-window' (Bug#11304). */
2996 && !(EQ (Qselect_window
, XCAR (c
)))))
2998 if (!NILP (echo_area_buffer
[0]))
3000 safe_run_hooks (Qecho_area_clear_hook
);
3001 clear_message (1, 0);
3005 reread_for_input_method
:
3007 /* Pass this to the input method, if appropriate. */
3009 && ! NILP (Vinput_method_function
)
3010 /* Don't run the input method within a key sequence,
3011 after the first event of the key sequence. */
3012 && NILP (prev_event
)
3013 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3016 int key_count
, key_count_reset
;
3017 struct gcpro gcpro1
;
3018 int count
= SPECPDL_INDEX ();
3020 /* Save the echo status. */
3021 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3022 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3023 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3024 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3027 if (before_command_restore_flag
)
3029 this_command_key_count
= before_command_key_count_1
;
3030 if (this_command_key_count
< this_single_command_key_start
)
3031 this_single_command_key_start
= this_command_key_count
;
3032 echo_truncate (before_command_echo_length_1
);
3033 before_command_restore_flag
= 0;
3037 /* Save the this_command_keys status. */
3038 key_count
= this_command_key_count
;
3039 key_count_reset
= this_command_key_count_reset
;
3042 keys
= Fcopy_sequence (this_command_keys
);
3047 /* Clear out this_command_keys. */
3048 this_command_key_count
= 0;
3049 this_command_key_count_reset
= 0;
3051 /* Now wipe the echo area. */
3052 if (!NILP (echo_area_buffer
[0]))
3053 safe_run_hooks (Qecho_area_clear_hook
);
3054 clear_message (1, 0);
3057 /* If we are not reading a key sequence,
3058 never use the echo area. */
3061 specbind (Qinput_method_use_echo_area
, Qt
);
3064 /* Call the input method. */
3065 tem
= call1 (Vinput_method_function
, c
);
3067 tem
= unbind_to (count
, tem
);
3069 /* Restore the saved echoing state
3070 and this_command_keys state. */
3071 this_command_key_count
= key_count
;
3072 this_command_key_count_reset
= key_count_reset
;
3074 this_command_keys
= keys
;
3077 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3078 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3079 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3080 if (saved_immediate_echo
)
3085 /* The input method can return no events. */
3088 /* Bring back the previous message, if any. */
3089 if (! NILP (previous_echo_area_message
))
3090 message_with_string ("%s", previous_echo_area_message
, 0);
3093 /* It returned one event or more. */
3095 Vunread_post_input_method_events
3096 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3101 /* Display help if not echoing. */
3102 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3104 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3105 Lisp_Object help
, object
, position
, window
, htem
;
3107 htem
= Fcdr (XCDR (c
));
3110 window
= Fcar (htem
);
3112 object
= Fcar (htem
);
3114 position
= Fcar (htem
);
3116 show_help_echo (help
, window
, object
, position
);
3118 /* We stopped being idle for this event; undo that. */
3120 timer_resume_idle ();
3124 if ((! reread
|| this_command_key_count
== 0
3125 || this_command_key_count_reset
)
3129 /* Don't echo mouse motion events. */
3130 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3131 && NILP (Fzerop (Vecho_keystrokes
))
3132 && ! (EVENT_HAS_PARAMETERS (c
)
3133 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3136 if (! NILP (also_record
))
3137 echo_char (also_record
);
3138 /* Once we reread a character, echoing can happen
3139 the next time we pause to read a new one. */
3140 ok_to_echo_at_next_pause
= current_kboard
;
3143 /* Record this character as part of the current key. */
3144 add_command_key (c
);
3145 if (! NILP (also_record
))
3146 add_command_key (also_record
);
3149 last_input_event
= c
;
3152 /* Process the help character specially if enabled */
3153 if (!NILP (Vhelp_form
) && help_char_p (c
))
3155 int count
= SPECPDL_INDEX ();
3157 help_form_saved_window_configs
3158 = Fcons (Fcurrent_window_configuration (Qnil
),
3159 help_form_saved_window_configs
);
3160 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3161 call0 (Qhelp_form_show
);
3166 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3167 if (EVENT_HAS_PARAMETERS (c
)
3168 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3169 XSETCAR (help_form_saved_window_configs
, Qnil
);
3171 while (BUFFERP (c
));
3172 /* Remove the help from the frame */
3173 unbind_to (count
, Qnil
);
3176 if (EQ (c
, make_number (040)))
3180 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3181 while (BUFFERP (c
));
3190 /* Record a key that came from a mouse menu.
3191 Record it for echoing, for this-command-keys, and so on. */
3194 record_menu_key (Lisp_Object c
)
3196 /* Wipe the echo area. */
3197 clear_message (1, 0);
3202 before_command_key_count
= this_command_key_count
;
3203 before_command_echo_length
= echo_length ();
3206 /* Don't echo mouse motion events. */
3207 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3208 && NILP (Fzerop (Vecho_keystrokes
)))
3212 /* Once we reread a character, echoing can happen
3213 the next time we pause to read a new one. */
3214 ok_to_echo_at_next_pause
= 0;
3217 /* Record this character as part of the current key. */
3218 add_command_key (c
);
3220 /* Re-reading in the middle of a command */
3221 last_input_event
= c
;
3225 /* Return 1 if should recognize C as "the help character". */
3228 help_char_p (Lisp_Object c
)
3232 if (EQ (c
, Vhelp_char
))
3234 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3235 if (EQ (c
, XCAR (tail
)))
3240 /* Record the input event C in various ways. */
3243 record_char (Lisp_Object c
)
3247 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3249 /* To avoid filling recent_keys with help-echo and mouse-movement
3250 events, we filter out repeated help-echo events, only store the
3251 first and last in a series of mouse-movement events, and don't
3252 store repeated help-echo events which are only separated by
3253 mouse-movement events. */
3255 Lisp_Object ev1
, ev2
, ev3
;
3258 if ((ix1
= recent_keys_index
- 1) < 0)
3259 ix1
= NUM_RECENT_KEYS
- 1;
3260 ev1
= AREF (recent_keys
, ix1
);
3262 if ((ix2
= ix1
- 1) < 0)
3263 ix2
= NUM_RECENT_KEYS
- 1;
3264 ev2
= AREF (recent_keys
, ix2
);
3266 if ((ix3
= ix2
- 1) < 0)
3267 ix3
= NUM_RECENT_KEYS
- 1;
3268 ev3
= AREF (recent_keys
, ix3
);
3270 if (EQ (XCAR (c
), Qhelp_echo
))
3272 /* Don't record `help-echo' in recent_keys unless it shows some help
3273 message, and a different help than the previously recorded
3275 Lisp_Object help
, last_help
;
3277 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3278 if (!STRINGP (help
))
3280 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3281 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3283 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3284 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3285 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3287 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3288 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3289 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3290 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3293 else if (EQ (XCAR (c
), Qmouse_movement
))
3295 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3296 So additional mouse movement events replace the last element. */
3297 Lisp_Object last_window
, window
;
3299 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3300 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3301 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3302 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3303 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3305 ASET (recent_keys
, ix1
, c
);
3311 store_kbd_macro_char (c
);
3316 ASET (recent_keys
, recent_keys_index
, c
);
3317 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3318 recent_keys_index
= 0;
3320 else if (recorded
< 0)
3322 /* We need to remove one or two events from recent_keys.
3323 To do this, we simply put nil at those events and move the
3324 recent_keys_index backwards over those events. Usually,
3325 users will never see those nil events, as they will be
3326 overwritten by the command keys entered to see recent_keys
3329 while (recorded
++ < 0 && total_keys
> 0)
3331 if (total_keys
< NUM_RECENT_KEYS
)
3333 if (--recent_keys_index
< 0)
3334 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3335 ASET (recent_keys
, recent_keys_index
, Qnil
);
3339 num_nonmacro_input_events
++;
3341 /* Write c to the dribble file. If c is a lispy event, write
3342 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3343 If you, dear reader, have a better idea, you've got the source. :-) */
3349 if (XUINT (c
) < 0x100)
3350 putc (XUINT (c
), dribble
);
3352 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3356 Lisp_Object dribblee
;
3358 /* If it's a structured event, take the event header. */
3359 dribblee
= EVENT_HEAD (c
);
3361 if (SYMBOLP (dribblee
))
3363 putc ('<', dribble
);
3364 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3365 SBYTES (SYMBOL_NAME (dribblee
)),
3367 putc ('>', dribble
);
3376 /* Copy out or in the info on where C-g should throw to.
3377 This is used when running Lisp code from within get_char,
3378 in case get_char is called recursively.
3379 See read_process_output. */
3382 save_getcjmp (jmp_buf temp
)
3384 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3388 restore_getcjmp (jmp_buf temp
)
3390 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3393 /* Low level keyboard/mouse input.
3394 kbd_buffer_store_event places events in kbd_buffer, and
3395 kbd_buffer_get_event retrieves them. */
3397 /* Return true if there are any events in the queue that read-char
3398 would return. If this returns false, a read-char would block. */
3400 readable_events (int flags
)
3402 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3405 /* If the buffer contains only FOCUS_IN_EVENT events, and
3406 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3407 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3409 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3410 #ifdef USE_TOOLKIT_SCROLL_BARS
3411 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3415 struct input_event
*event
;
3417 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3424 #ifdef USE_TOOLKIT_SCROLL_BARS
3425 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3427 event
->kind
== FOCUS_IN_EVENT
)
3428 #ifdef USE_TOOLKIT_SCROLL_BARS
3429 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3430 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3431 && event
->part
== scroll_bar_handle
3432 && event
->modifiers
== 0)
3437 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3440 while (event
!= kbd_store_ptr
);
3446 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3447 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3448 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3453 if (current_kboard
->kbd_queue_has_data
)
3459 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3460 if (kb
->kbd_queue_has_data
)
3466 /* Set this for debugging, to have a way to get out */
3467 int stop_character EXTERNALLY_VISIBLE
;
3470 event_to_kboard (struct input_event
*event
)
3473 frame
= event
->frame_or_window
;
3475 frame
= XCAR (frame
);
3476 else if (WINDOWP (frame
))
3477 frame
= WINDOW_FRAME (XWINDOW (frame
));
3479 /* There are still some events that don't set this field.
3480 For now, just ignore the problem.
3481 Also ignore dead frames here. */
3482 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3485 return FRAME_KBOARD (XFRAME (frame
));
3489 /* Return the number of slots occupied in kbd_buffer. */
3492 kbd_buffer_nr_stored (void)
3494 return kbd_fetch_ptr
== kbd_store_ptr
3496 : (kbd_fetch_ptr
< kbd_store_ptr
3497 ? kbd_store_ptr
- kbd_fetch_ptr
3498 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3499 + (kbd_store_ptr
- kbd_buffer
)));
3501 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3504 kbd_buffer_store_event (register struct input_event
*event
)
3506 kbd_buffer_store_event_hold (event
, 0);
3509 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3511 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3512 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3513 Else, if EVENT is a quit event, store the quit event
3514 in HOLD_QUIT, and return (thus ignoring further events).
3516 This is used in read_avail_input to postpone the processing
3517 of the quit event until all subsequent input events have been
3518 parsed (and discarded).
3522 kbd_buffer_store_event_hold (register struct input_event
*event
,
3523 struct input_event
*hold_quit
)
3525 if (event
->kind
== NO_EVENT
)
3528 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3531 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3533 register int c
= event
->code
& 0377;
3535 if (event
->modifiers
& ctrl_modifier
)
3536 c
= make_ctrl_char (c
);
3538 c
|= (event
->modifiers
3539 & (meta_modifier
| alt_modifier
3540 | hyper_modifier
| super_modifier
));
3544 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3545 struct input_event
*sp
;
3547 if (single_kboard
&& kb
!= current_kboard
)
3549 KVAR (kb
, kbd_queue
)
3550 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3551 Fcons (make_number (c
), Qnil
));
3552 kb
->kbd_queue_has_data
= 1;
3553 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3555 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3558 if (event_to_kboard (sp
) == kb
)
3560 sp
->kind
= NO_EVENT
;
3561 sp
->frame_or_window
= Qnil
;
3570 memcpy (hold_quit
, event
, sizeof (*event
));
3574 /* If this results in a quit_char being returned to Emacs as
3575 input, set Vlast_event_frame properly. If this doesn't
3576 get returned to Emacs as an event, the next event read
3577 will set Vlast_event_frame again, so this is safe to do. */
3581 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3583 focus
= event
->frame_or_window
;
3584 internal_last_event_frame
= focus
;
3585 Vlast_event_frame
= focus
;
3588 last_event_timestamp
= event
->timestamp
;
3589 handle_interrupt ();
3593 if (c
&& c
== stop_character
)
3599 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3600 Just ignore the second one. */
3601 else if (event
->kind
== BUFFER_SWITCH_EVENT
3602 && kbd_fetch_ptr
!= kbd_store_ptr
3603 && ((kbd_store_ptr
== kbd_buffer
3604 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3605 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3608 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3609 kbd_store_ptr
= kbd_buffer
;
3611 /* Don't let the very last slot in the buffer become full,
3612 since that would make the two pointers equal,
3613 and that is indistinguishable from an empty buffer.
3614 Discard the event if it would fill the last slot. */
3615 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3617 *kbd_store_ptr
= *event
;
3620 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3622 /* Don't read keyboard input until we have processed kbd_buffer.
3623 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3624 hold_keyboard_input ();
3626 if (!noninteractive
)
3627 signal (SIGIO
, SIG_IGN
);
3631 #endif /* subprocesses */
3634 /* If we're inside while-no-input, and this event qualifies
3635 as input, set quit-flag to cause an interrupt. */
3636 if (!NILP (Vthrow_on_input
)
3637 && event
->kind
!= FOCUS_IN_EVENT
3638 && event
->kind
!= HELP_EVENT
3639 && event
->kind
!= DEICONIFY_EVENT
)
3641 Vquit_flag
= Vthrow_on_input
;
3642 /* If we're inside a function that wants immediate quits,
3644 if (immediate_quit
&& NILP (Vinhibit_quit
))
3654 /* Put an input event back in the head of the event queue. */
3657 kbd_buffer_unget_event (register struct input_event
*event
)
3659 if (kbd_fetch_ptr
== kbd_buffer
)
3660 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3662 /* Don't let the very last slot in the buffer become full, */
3663 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3666 *kbd_fetch_ptr
= *event
;
3671 /* Generate a HELP_EVENT input_event and store it in the keyboard
3674 HELP is the help form.
3676 FRAME and WINDOW are the frame and window where the help is
3677 generated. OBJECT is the Lisp object where the help was found (a
3678 buffer, a string, an overlay, or nil if neither from a string nor
3679 from a buffer). POS is the position within OBJECT where the help
3683 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3684 Lisp_Object object
, EMACS_INT pos
)
3686 struct input_event event
;
3690 event
.kind
= HELP_EVENT
;
3691 event
.frame_or_window
= frame
;
3693 event
.x
= WINDOWP (window
) ? window
: frame
;
3696 kbd_buffer_store_event (&event
);
3700 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3703 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3705 struct input_event event
;
3707 event
.kind
= HELP_EVENT
;
3708 event
.frame_or_window
= frame
;
3713 kbd_buffer_store_event (&event
);
3717 /* Discard any mouse events in the event buffer by setting them to
3720 discard_mouse_events (void)
3722 struct input_event
*sp
;
3723 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3725 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3728 if (sp
->kind
== MOUSE_CLICK_EVENT
3729 || sp
->kind
== WHEEL_EVENT
3730 || sp
->kind
== HORIZ_WHEEL_EVENT
3732 || sp
->kind
== GPM_CLICK_EVENT
3734 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3736 sp
->kind
= NO_EVENT
;
3742 /* Return non-zero if there are any real events waiting in the event
3743 buffer, not counting `NO_EVENT's.
3745 If DISCARD is non-zero, discard NO_EVENT events at the front of
3746 the input queue, possibly leaving the input queue empty if there
3747 are no real input events. */
3750 kbd_buffer_events_waiting (int discard
)
3752 struct input_event
*sp
;
3754 for (sp
= kbd_fetch_ptr
;
3755 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3758 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3765 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3769 /* Clear input event EVENT. */
3772 clear_event (struct input_event
*event
)
3774 event
->kind
= NO_EVENT
;
3778 /* Read one event from the event buffer, waiting if necessary.
3779 The value is a Lisp object representing the event.
3780 The value is nil for an event that should be ignored,
3781 or that was handled here.
3782 We always read and discard one event. */
3785 kbd_buffer_get_event (KBOARD
**kbp
,
3786 int *used_mouse_menu
,
3787 struct timeval
*end_time
)
3793 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3795 /* Start reading input again, we have processed enough so we can
3796 accept new events again. */
3797 unhold_keyboard_input ();
3799 if (!noninteractive
)
3800 signal (SIGIO
, input_available_signal
);
3804 #endif /* subprocesses */
3806 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3808 /* In case we are running as a daemon, only do this before
3809 detaching from the terminal. */
3810 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3814 *kbp
= current_kboard
;
3817 #endif /* ! HAVE_DBUS */
3819 /* Wait until there is input available. */
3822 /* Break loop if there's an unread command event. Needed in
3823 moused window autoselection which uses a timer to insert such
3825 if (CONSP (Vunread_command_events
))
3828 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3830 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3831 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3835 /* If the quit flag is set, then read_char will return
3836 quit_char, so that counts as "available input." */
3837 if (!NILP (Vquit_flag
))
3838 quit_throw_to_read_char (0);
3840 /* One way or another, wait until input is available; then, if
3841 interrupt handlers have not read it, read it now. */
3843 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3847 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3849 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3850 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3855 EMACS_TIME duration
;
3856 EMACS_GET_TIME (duration
);
3857 if (EMACS_TIME_GE (duration
, *end_time
))
3858 return Qnil
; /* finished waiting */
3861 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3862 wait_reading_process_output (EMACS_SECS (duration
),
3863 EMACS_USECS (duration
),
3864 -1, 1, Qnil
, NULL
, 0);
3868 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3870 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3871 /* Pass 1 for EXPECT since we just waited to have input. */
3872 read_avail_input (1);
3875 if (CONSP (Vunread_command_events
))
3878 first
= XCAR (Vunread_command_events
);
3879 Vunread_command_events
= XCDR (Vunread_command_events
);
3880 *kbp
= current_kboard
;
3884 /* At this point, we know that there is a readable event available
3885 somewhere. If the event queue is empty, then there must be a
3886 mouse movement enabled and available. */
3887 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3889 struct input_event
*event
;
3891 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3895 last_event_timestamp
= event
->timestamp
;
3897 *kbp
= event_to_kboard (event
);
3899 *kbp
= current_kboard
; /* Better than returning null ptr? */
3903 /* These two kinds of events get special handling
3904 and don't actually appear to the command loop.
3905 We return nil for them. */
3906 if (event
->kind
== SELECTION_REQUEST_EVENT
3907 || event
->kind
== SELECTION_CLEAR_EVENT
)
3910 struct input_event copy
;
3912 /* Remove it from the buffer before processing it,
3913 since otherwise swallow_events will see it
3914 and process it again. */
3916 kbd_fetch_ptr
= event
+ 1;
3917 input_pending
= readable_events (0);
3918 x_handle_selection_event (©
);
3920 /* We're getting selection request events, but we don't have
3926 #if defined (HAVE_NS)
3927 else if (event
->kind
== NS_TEXT_EVENT
)
3929 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3930 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3932 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3933 kbd_fetch_ptr
= event
+ 1;
3934 if (used_mouse_menu
)
3935 *used_mouse_menu
= 1;
3939 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3940 || defined (HAVE_NS)
3941 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3943 /* Make an event (delete-frame (FRAME)). */
3944 obj
= Fcons (event
->frame_or_window
, Qnil
);
3945 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3946 kbd_fetch_ptr
= event
+ 1;
3949 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3950 || defined (HAVE_NS)
3951 else if (event
->kind
== ICONIFY_EVENT
)
3953 /* Make an event (iconify-frame (FRAME)). */
3954 obj
= Fcons (event
->frame_or_window
, Qnil
);
3955 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3956 kbd_fetch_ptr
= event
+ 1;
3958 else if (event
->kind
== DEICONIFY_EVENT
)
3960 /* Make an event (make-frame-visible (FRAME)). */
3961 obj
= Fcons (event
->frame_or_window
, Qnil
);
3962 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3963 kbd_fetch_ptr
= event
+ 1;
3966 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3968 /* The value doesn't matter here; only the type is tested. */
3969 XSETBUFFER (obj
, current_buffer
);
3970 kbd_fetch_ptr
= event
+ 1;
3972 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3973 || defined (HAVE_NS) || defined (USE_GTK)
3974 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3976 kbd_fetch_ptr
= event
+ 1;
3977 input_pending
= readable_events (0);
3978 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3979 x_activate_menubar (XFRAME (event
->frame_or_window
));
3982 #if defined (WINDOWSNT)
3983 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3985 /* Make an event (language-change (FRAME CHARSET LCID)). */
3986 obj
= Fcons (event
->frame_or_window
, Qnil
);
3987 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3988 kbd_fetch_ptr
= event
+ 1;
3991 else if (event
->kind
== SAVE_SESSION_EVENT
)
3993 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3994 kbd_fetch_ptr
= event
+ 1;
3996 /* Just discard these, by returning nil.
3997 With MULTI_KBOARD, these events are used as placeholders
3998 when we need to randomly delete events from the queue.
3999 (They shouldn't otherwise be found in the buffer,
4000 but on some machines it appears they do show up
4001 even without MULTI_KBOARD.) */
4002 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4003 mouse events during a popup-menu call. */
4004 else if (event
->kind
== NO_EVENT
)
4005 kbd_fetch_ptr
= event
+ 1;
4006 else if (event
->kind
== HELP_EVENT
)
4008 Lisp_Object object
, position
, help
, frame
, window
;
4010 frame
= event
->frame_or_window
;
4011 object
= event
->arg
;
4012 position
= make_number (event
->code
);
4015 clear_event (event
);
4017 kbd_fetch_ptr
= event
+ 1;
4018 if (!WINDOWP (window
))
4020 obj
= Fcons (Qhelp_echo
,
4021 list5 (frame
, help
, window
, object
, position
));
4023 else if (event
->kind
== FOCUS_IN_EVENT
)
4025 /* Notification of a FocusIn event. The frame receiving the
4026 focus is in event->frame_or_window. Generate a
4027 switch-frame event if necessary. */
4028 Lisp_Object frame
, focus
;
4030 frame
= event
->frame_or_window
;
4031 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4035 if (!EQ (frame
, internal_last_event_frame
)
4036 && !EQ (frame
, selected_frame
))
4037 obj
= make_lispy_switch_frame (frame
);
4038 internal_last_event_frame
= frame
;
4039 kbd_fetch_ptr
= event
+ 1;
4042 else if (event
->kind
== DBUS_EVENT
)
4044 obj
= make_lispy_event (event
);
4045 kbd_fetch_ptr
= event
+ 1;
4048 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4050 obj
= make_lispy_event (event
);
4051 kbd_fetch_ptr
= event
+ 1;
4055 /* If this event is on a different frame, return a switch-frame this
4056 time, and leave the event in the queue for next time. */
4060 frame
= event
->frame_or_window
;
4062 frame
= XCAR (frame
);
4063 else if (WINDOWP (frame
))
4064 frame
= WINDOW_FRAME (XWINDOW (frame
));
4066 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4070 if (! EQ (frame
, internal_last_event_frame
)
4071 && !EQ (frame
, selected_frame
))
4072 obj
= make_lispy_switch_frame (frame
);
4073 internal_last_event_frame
= frame
;
4075 /* If we didn't decide to make a switch-frame event, go ahead
4076 and build a real event from the queue entry. */
4080 obj
= make_lispy_event (event
);
4082 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4083 || defined (HAVE_NS) || defined (USE_GTK)
4084 /* If this was a menu selection, then set the flag to inhibit
4085 writing to last_nonmenu_event. Don't do this if the event
4086 we're returning is (menu-bar), though; that indicates the
4087 beginning of the menu sequence, and we might as well leave
4088 that as the `event with parameters' for this selection. */
4090 && !EQ (event
->frame_or_window
, event
->arg
)
4091 && (event
->kind
== MENU_BAR_EVENT
4092 || event
->kind
== TOOL_BAR_EVENT
))
4093 *used_mouse_menu
= 1;
4096 /* certain system events are non-key events */
4098 && event
->kind
== NS_NONKEY_EVENT
)
4099 *used_mouse_menu
= 1;
4102 /* Wipe out this event, to catch bugs. */
4103 clear_event (event
);
4104 kbd_fetch_ptr
= event
+ 1;
4108 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4109 /* Try generating a mouse motion event. */
4110 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4112 FRAME_PTR f
= some_mouse_moved ();
4113 Lisp_Object bar_window
;
4114 enum scroll_bar_part part
;
4118 *kbp
= current_kboard
;
4119 /* Note that this uses F to determine which terminal to look at.
4120 If there is no valid info, it does not store anything
4121 so x remains nil. */
4124 /* XXX Can f or mouse_position_hook be NULL here? */
4125 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4126 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4131 /* Decide if we should generate a switch-frame event. Don't
4132 generate switch-frame events for motion outside of all Emacs
4138 frame
= FRAME_FOCUS_FRAME (f
);
4140 XSETFRAME (frame
, f
);
4142 if (! EQ (frame
, internal_last_event_frame
)
4143 && !EQ (frame
, selected_frame
))
4144 obj
= make_lispy_switch_frame (frame
);
4145 internal_last_event_frame
= frame
;
4148 /* If we didn't decide to make a switch-frame event, go ahead and
4149 return a mouse-motion event. */
4150 if (!NILP (x
) && NILP (obj
))
4151 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4153 #endif /* HAVE_MOUSE || HAVE GPM */
4155 /* We were promised by the above while loop that there was
4156 something for us to read! */
4159 input_pending
= readable_events (0);
4161 Vlast_event_frame
= internal_last_event_frame
;
4166 /* Process any non-user-visible events (currently X selection events),
4167 without reading any user-visible events. */
4170 process_special_events (void)
4172 struct input_event
*event
;
4174 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4176 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4179 if (event
== kbd_store_ptr
)
4183 /* If we find a stored X selection request, handle it now. */
4184 if (event
->kind
== SELECTION_REQUEST_EVENT
4185 || event
->kind
== SELECTION_CLEAR_EVENT
)
4189 /* Remove the event from the fifo buffer before processing;
4190 otherwise swallow_events called recursively could see it
4191 and process it again. To do this, we move the events
4192 between kbd_fetch_ptr and EVENT one slot to the right,
4195 struct input_event copy
= *event
;
4196 struct input_event
*beg
4197 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4198 ? kbd_buffer
: kbd_fetch_ptr
;
4201 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4202 else if (event
< beg
)
4204 if (event
> kbd_buffer
)
4205 memmove (kbd_buffer
+ 1, kbd_buffer
,
4206 (event
- kbd_buffer
) * sizeof (struct input_event
));
4207 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4208 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4209 memmove (beg
+ 1, beg
,
4210 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4211 * sizeof (struct input_event
));
4214 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4215 kbd_fetch_ptr
= kbd_buffer
+ 1;
4219 /* X wants last_event_timestamp for selection ownership. */
4220 last_event_timestamp
= copy
.timestamp
;
4221 input_pending
= readable_events (0);
4222 x_handle_selection_event (©
);
4224 /* We're getting selection request events, but we don't have
4232 /* Process any events that are not user-visible, run timer events that
4233 are ripe, and return, without reading any user-visible events. */
4236 swallow_events (int do_display
)
4240 process_special_events ();
4242 old_timers_run
= timers_run
;
4243 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4245 if (timers_run
!= old_timers_run
&& do_display
)
4246 redisplay_preserve_echo_area (7);
4249 /* Record the start of when Emacs is idle,
4250 for the sake of running idle-time timers. */
4253 timer_start_idle (void)
4257 /* If we are already in the idle state, do nothing. */
4258 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4261 EMACS_GET_TIME (timer_idleness_start_time
);
4263 timer_last_idleness_start_time
= timer_idleness_start_time
;
4265 /* Mark all idle-time timers as once again candidates for running. */
4266 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4270 timer
= XCAR (timers
);
4272 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4274 XVECTOR (timer
)->contents
[0] = Qnil
;
4278 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4281 timer_stop_idle (void)
4283 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4286 /* Resume idle timer from last idle start time. */
4289 timer_resume_idle (void)
4291 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4294 timer_idleness_start_time
= timer_last_idleness_start_time
;
4297 /* This is only for debugging. */
4298 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4300 /* List of elisp functions to call, delayed because they were generated in
4301 a context where Elisp could not be safely run (e.g. redisplay, signal,
4302 ...). Each element has the form (FUN . ARGS). */
4303 Lisp_Object pending_funcalls
;
4305 /* Check whether a timer has fired. To prevent larger problems we simply
4306 disregard elements that are not proper timers. Do not make a circular
4307 timer list for the time being.
4309 Returns the time to wait until the next timer fires. If a
4310 timer is triggering now, return zero.
4311 If no timer is active, return -1.
4313 If a timer is ripe, we run it, with quitting turned off.
4314 In that case we return 0 to indicate that a new timer_check_2 call
4318 timer_check_2 (void)
4320 EMACS_TIME nexttime
;
4322 EMACS_TIME idleness_now
IF_LINT (= {0});
4323 Lisp_Object timers
, idle_timers
, chosen_timer
;
4324 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4326 EMACS_SET_SECS (nexttime
, -1);
4327 EMACS_SET_USECS (nexttime
, -1);
4329 /* Always consider the ordinary timers. */
4330 timers
= Vtimer_list
;
4331 /* Consider the idle timers only if Emacs is idle. */
4332 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4333 idle_timers
= Vtimer_idle_list
;
4336 chosen_timer
= Qnil
;
4337 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4339 /* First run the code that was delayed. */
4340 while (CONSP (pending_funcalls
))
4342 Lisp_Object funcall
= XCAR (pending_funcalls
);
4343 pending_funcalls
= XCDR (pending_funcalls
);
4344 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4347 if (CONSP (timers
) || CONSP (idle_timers
))
4349 EMACS_GET_TIME (now
);
4350 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4351 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4354 while (CONSP (timers
) || CONSP (idle_timers
))
4356 Lisp_Object
*vector
;
4357 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4358 EMACS_TIME timer_time
, idle_timer_time
;
4359 EMACS_TIME difference
;
4360 EMACS_TIME timer_difference
IF_LINT (= {0});
4361 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4363 /* Skip past invalid timers and timers already handled. */
4366 timer
= XCAR (timers
);
4367 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4369 timers
= XCDR (timers
);
4372 vector
= XVECTOR (timer
)->contents
;
4374 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4375 || !INTEGERP (vector
[3])
4376 || ! NILP (vector
[0]))
4378 timers
= XCDR (timers
);
4382 if (CONSP (idle_timers
))
4384 timer
= XCAR (idle_timers
);
4385 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4387 idle_timers
= XCDR (idle_timers
);
4390 vector
= XVECTOR (timer
)->contents
;
4392 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4393 || !INTEGERP (vector
[3])
4394 || ! NILP (vector
[0]))
4396 idle_timers
= XCDR (idle_timers
);
4401 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4402 based on the next ordinary timer.
4403 TIMER_DIFFERENCE is the distance in time from NOW to when
4404 this timer becomes ripe (negative if it's already ripe). */
4407 timer
= XCAR (timers
);
4408 vector
= XVECTOR (timer
)->contents
;
4409 EMACS_SET_SECS (timer_time
,
4410 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4411 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4412 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4415 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4416 based on the next idle timer. */
4417 if (CONSP (idle_timers
))
4419 idle_timer
= XCAR (idle_timers
);
4420 vector
= XVECTOR (idle_timer
)->contents
;
4421 EMACS_SET_SECS (idle_timer_time
,
4422 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4423 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4424 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4427 /* Decide which timer is the next timer,
4428 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4429 Also step down the list where we found that timer. */
4431 if (CONSP (timers
) && CONSP (idle_timers
))
4434 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4435 if (EMACS_TIME_NEG_P (temp
))
4437 chosen_timer
= timer
;
4438 timers
= XCDR (timers
);
4439 difference
= timer_difference
;
4443 chosen_timer
= idle_timer
;
4444 idle_timers
= XCDR (idle_timers
);
4445 difference
= idle_timer_difference
;
4448 else if (CONSP (timers
))
4450 chosen_timer
= timer
;
4451 timers
= XCDR (timers
);
4452 difference
= timer_difference
;
4456 chosen_timer
= idle_timer
;
4457 idle_timers
= XCDR (idle_timers
);
4458 difference
= idle_timer_difference
;
4460 vector
= XVECTOR (chosen_timer
)->contents
;
4462 /* If timer is ripe, run it if it hasn't been run. */
4463 if (EMACS_TIME_NEG_P (difference
)
4464 || (EMACS_SECS (difference
) == 0
4465 && EMACS_USECS (difference
) == 0))
4467 if (NILP (vector
[0]))
4469 int count
= SPECPDL_INDEX ();
4470 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4472 /* Mark the timer as triggered to prevent problems if the lisp
4473 code fails to reschedule it right. */
4476 specbind (Qinhibit_quit
, Qt
);
4478 call1 (Qtimer_event_handler
, chosen_timer
);
4479 Vdeactivate_mark
= old_deactivate_mark
;
4481 unbind_to (count
, Qnil
);
4483 /* Since we have handled the event,
4484 we don't need to tell the caller to wake up and do it. */
4485 /* But the caller must still wait for the next timer, so
4486 return 0 to indicate that. */
4489 EMACS_SET_SECS (nexttime
, 0);
4490 EMACS_SET_USECS (nexttime
, 0);
4493 /* When we encounter a timer that is still waiting,
4494 return the amount of time to wait before it is ripe. */
4501 /* No timers are pending in the future. */
4502 /* Return 0 if we generated an event, and -1 if not. */
4508 /* Check whether a timer has fired. To prevent larger problems we simply
4509 disregard elements that are not proper timers. Do not make a circular
4510 timer list for the time being.
4512 Returns the time to wait until the next timer fires.
4513 If no timer is active, return -1.
4515 As long as any timer is ripe, we run it. */
4520 EMACS_TIME nexttime
;
4524 nexttime
= timer_check_2 ();
4526 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4531 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4532 doc
: /* Return the current length of Emacs idleness, or nil.
4533 The value when Emacs is idle is a list of three integers. The first has
4534 the most significant 16 bits of the seconds, while the second has the least
4535 significant 16 bits. The third integer gives the microsecond count.
4537 The value when Emacs is not idle is nil.
4539 The microsecond count is zero on systems that do not provide
4540 resolution finer than a second. */)
4543 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4545 EMACS_TIME now
, idleness_now
;
4547 EMACS_GET_TIME (now
);
4548 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4550 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4551 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4552 make_number (EMACS_USECS (idleness_now
)));
4558 /* Caches for modify_event_symbol. */
4559 static Lisp_Object accent_key_syms
;
4560 static Lisp_Object func_key_syms
;
4561 static Lisp_Object mouse_syms
;
4562 static Lisp_Object wheel_syms
;
4563 static Lisp_Object drag_n_drop_syms
;
4565 /* This is a list of keysym codes for special "accent" characters.
4566 It parallels lispy_accent_keys. */
4568 static const int lispy_accent_codes
[] =
4570 #ifdef XK_dead_circumflex
4575 #ifdef XK_dead_grave
4580 #ifdef XK_dead_tilde
4585 #ifdef XK_dead_diaeresis
4590 #ifdef XK_dead_macron
4595 #ifdef XK_dead_degree
4600 #ifdef XK_dead_acute
4605 #ifdef XK_dead_cedilla
4610 #ifdef XK_dead_breve
4615 #ifdef XK_dead_ogonek
4620 #ifdef XK_dead_caron
4625 #ifdef XK_dead_doubleacute
4626 XK_dead_doubleacute
,
4630 #ifdef XK_dead_abovedot
4635 #ifdef XK_dead_abovering
4645 #ifdef XK_dead_belowdot
4650 #ifdef XK_dead_voiced_sound
4651 XK_dead_voiced_sound
,
4655 #ifdef XK_dead_semivoiced_sound
4656 XK_dead_semivoiced_sound
,
4672 /* This is a list of Lisp names for special "accent" characters.
4673 It parallels lispy_accent_codes. */
4675 static const char *const lispy_accent_keys
[] =
4693 "dead-voiced-sound",
4694 "dead-semivoiced-sound",
4700 #define FUNCTION_KEY_OFFSET 0x0
4702 const char *const lispy_function_keys
[] =
4706 0, /* VK_LBUTTON 0x01 */
4707 0, /* VK_RBUTTON 0x02 */
4708 "cancel", /* VK_CANCEL 0x03 */
4709 0, /* VK_MBUTTON 0x04 */
4711 0, 0, 0, /* 0x05 .. 0x07 */
4713 "backspace", /* VK_BACK 0x08 */
4714 "tab", /* VK_TAB 0x09 */
4716 0, 0, /* 0x0A .. 0x0B */
4718 "clear", /* VK_CLEAR 0x0C */
4719 "return", /* VK_RETURN 0x0D */
4721 0, 0, /* 0x0E .. 0x0F */
4723 0, /* VK_SHIFT 0x10 */
4724 0, /* VK_CONTROL 0x11 */
4725 0, /* VK_MENU 0x12 */
4726 "pause", /* VK_PAUSE 0x13 */
4727 "capslock", /* VK_CAPITAL 0x14 */
4728 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4730 "junja", /* VK_JUNJA 0x17 */
4731 "final", /* VK_FINAL 0x18 */
4732 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4734 "escape", /* VK_ESCAPE 0x1B */
4735 "convert", /* VK_CONVERT 0x1C */
4736 "non-convert", /* VK_NONCONVERT 0x1D */
4737 "accept", /* VK_ACCEPT 0x1E */
4738 "mode-change", /* VK_MODECHANGE 0x1F */
4739 0, /* VK_SPACE 0x20 */
4740 "prior", /* VK_PRIOR 0x21 */
4741 "next", /* VK_NEXT 0x22 */
4742 "end", /* VK_END 0x23 */
4743 "home", /* VK_HOME 0x24 */
4744 "left", /* VK_LEFT 0x25 */
4745 "up", /* VK_UP 0x26 */
4746 "right", /* VK_RIGHT 0x27 */
4747 "down", /* VK_DOWN 0x28 */
4748 "select", /* VK_SELECT 0x29 */
4749 "print", /* VK_PRINT 0x2A */
4750 "execute", /* VK_EXECUTE 0x2B */
4751 "snapshot", /* VK_SNAPSHOT 0x2C */
4752 "insert", /* VK_INSERT 0x2D */
4753 "delete", /* VK_DELETE 0x2E */
4754 "help", /* VK_HELP 0x2F */
4756 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4758 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4760 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4762 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4764 0, 0, 0, 0, 0, 0, 0, 0, 0,
4765 0, 0, 0, 0, 0, 0, 0, 0, 0,
4766 0, 0, 0, 0, 0, 0, 0, 0,
4768 "lwindow", /* VK_LWIN 0x5B */
4769 "rwindow", /* VK_RWIN 0x5C */
4770 "apps", /* VK_APPS 0x5D */
4773 "kp-0", /* VK_NUMPAD0 0x60 */
4774 "kp-1", /* VK_NUMPAD1 0x61 */
4775 "kp-2", /* VK_NUMPAD2 0x62 */
4776 "kp-3", /* VK_NUMPAD3 0x63 */
4777 "kp-4", /* VK_NUMPAD4 0x64 */
4778 "kp-5", /* VK_NUMPAD5 0x65 */
4779 "kp-6", /* VK_NUMPAD6 0x66 */
4780 "kp-7", /* VK_NUMPAD7 0x67 */
4781 "kp-8", /* VK_NUMPAD8 0x68 */
4782 "kp-9", /* VK_NUMPAD9 0x69 */
4783 "kp-multiply", /* VK_MULTIPLY 0x6A */
4784 "kp-add", /* VK_ADD 0x6B */
4785 "kp-separator", /* VK_SEPARATOR 0x6C */
4786 "kp-subtract", /* VK_SUBTRACT 0x6D */
4787 "kp-decimal", /* VK_DECIMAL 0x6E */
4788 "kp-divide", /* VK_DIVIDE 0x6F */
4789 "f1", /* VK_F1 0x70 */
4790 "f2", /* VK_F2 0x71 */
4791 "f3", /* VK_F3 0x72 */
4792 "f4", /* VK_F4 0x73 */
4793 "f5", /* VK_F5 0x74 */
4794 "f6", /* VK_F6 0x75 */
4795 "f7", /* VK_F7 0x76 */
4796 "f8", /* VK_F8 0x77 */
4797 "f9", /* VK_F9 0x78 */
4798 "f10", /* VK_F10 0x79 */
4799 "f11", /* VK_F11 0x7A */
4800 "f12", /* VK_F12 0x7B */
4801 "f13", /* VK_F13 0x7C */
4802 "f14", /* VK_F14 0x7D */
4803 "f15", /* VK_F15 0x7E */
4804 "f16", /* VK_F16 0x7F */
4805 "f17", /* VK_F17 0x80 */
4806 "f18", /* VK_F18 0x81 */
4807 "f19", /* VK_F19 0x82 */
4808 "f20", /* VK_F20 0x83 */
4809 "f21", /* VK_F21 0x84 */
4810 "f22", /* VK_F22 0x85 */
4811 "f23", /* VK_F23 0x86 */
4812 "f24", /* VK_F24 0x87 */
4814 0, 0, 0, 0, /* 0x88 .. 0x8B */
4815 0, 0, 0, 0, /* 0x8C .. 0x8F */
4817 "kp-numlock", /* VK_NUMLOCK 0x90 */
4818 "scroll", /* VK_SCROLL 0x91 */
4819 /* Not sure where the following block comes from.
4820 Windows headers have NEC and Fujitsu specific keys in
4821 this block, but nothing generic. */
4822 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4823 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4824 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4825 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4826 "kp-end", /* VK_NUMPAD_END 0x96 */
4827 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4828 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4829 "kp-up", /* VK_NUMPAD_UP 0x99 */
4830 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4831 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4832 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4833 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4835 0, 0, /* 0x9E .. 0x9F */
4838 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4839 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4840 * No other API or message will distinguish left and right keys this way.
4845 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4846 to enable them selectively, and gives access to a few more functions.
4847 See lispy_multimedia_keys below. */
4848 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4849 0, 0, 0, /* 0xAD .. 0xAF Volume */
4850 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4851 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4853 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4854 0, 0, 0, 0, 0, 0, 0, 0, 0,
4856 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4857 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4858 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4861 "ax", /* VK_OEM_AX 0xE1 */
4862 0, /* VK_OEM_102 0xE2 */
4863 "ico-help", /* VK_ICO_HELP 0xE3 */
4864 "ico-00", /* VK_ICO_00 0xE4 */
4865 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4866 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4867 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4869 "reset", /* VK_OEM_RESET 0xE9 */
4870 "jump", /* VK_OEM_JUMP 0xEA */
4871 "oem-pa1", /* VK_OEM_PA1 0xEB */
4872 "oem-pa2", /* VK_OEM_PA2 0xEC */
4873 "oem-pa3", /* VK_OEM_PA3 0xED */
4874 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4875 "cusel", /* VK_OEM_CUSEL 0xEF */
4876 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4877 "finish", /* VK_OEM_FINISH 0xF1 */
4878 "copy", /* VK_OEM_COPY 0xF2 */
4879 "auto", /* VK_OEM_AUTO 0xF3 */
4880 "enlw", /* VK_OEM_ENLW 0xF4 */
4881 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4882 "attn", /* VK_ATTN 0xF6 */
4883 "crsel", /* VK_CRSEL 0xF7 */
4884 "exsel", /* VK_EXSEL 0xF8 */
4885 "ereof", /* VK_EREOF 0xF9 */
4886 "play", /* VK_PLAY 0xFA */
4887 "zoom", /* VK_ZOOM 0xFB */
4888 "noname", /* VK_NONAME 0xFC */
4889 "pa1", /* VK_PA1 0xFD */
4890 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4894 /* Some of these duplicate the "Media keys" on newer keyboards,
4895 but they are delivered to the application in a different way. */
4896 static const char *const lispy_multimedia_keys
[] =
4904 "browser-favorites",
4941 "toggle-dictate-command",
4947 "media-fast-forward",
4950 "media-channel-down"
4953 #else /* not HAVE_NTGUI */
4955 /* This should be dealt with in XTread_socket now, and that doesn't
4956 depend on the client system having the Kana syms defined. See also
4957 the XK_kana_A case below. */
4960 static const char *const lispy_kana_keys
[] =
4962 /* X Keysym value */
4963 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4964 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4965 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4966 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4967 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4968 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4969 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4970 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4971 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4972 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4973 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4974 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4975 "kana-i", "kana-u", "kana-e", "kana-o",
4976 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4977 "prolongedsound", "kana-A", "kana-I", "kana-U",
4978 "kana-E", "kana-O", "kana-KA", "kana-KI",
4979 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4980 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4981 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4982 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4983 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4984 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4985 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4986 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4987 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4988 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4989 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4990 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4992 #endif /* XK_kana_A */
4995 #define FUNCTION_KEY_OFFSET 0xff00
4997 /* You'll notice that this table is arranged to be conveniently
4998 indexed by X Windows keysym values. */
4999 static const char *const lispy_function_keys
[] =
5001 /* X Keysym value */
5003 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5004 "backspace", "tab", "linefeed", "clear",
5006 0, 0, 0, "pause", /* 0xff10...1f */
5007 0, 0, 0, 0, 0, 0, 0, "escape",
5009 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5010 "romaji", "hiragana", "katakana", "hiragana-katakana",
5011 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5012 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5013 "eisu-toggle", /* 0xff30...3f */
5014 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5015 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5017 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5018 "down", "prior", "next", "end",
5019 "begin", 0, 0, 0, 0, 0, 0, 0,
5020 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5031 "break", /* 0xff6b */
5034 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5035 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5036 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5037 0, 0, 0, 0, 0, 0, 0, 0,
5038 "kp-tab", /* 0xff89 */
5040 "kp-enter", /* 0xff8d */
5042 "kp-f1", /* 0xff91 */
5046 "kp-home", /* 0xff95 */
5051 "kp-prior", /* kp-page-up */
5052 "kp-next", /* kp-page-down */
5058 0, 0, 0, 0, 0, 0, 0, 0, 0,
5059 "kp-multiply", /* 0xffaa */
5064 "kp-divide", /* 0xffaf */
5065 "kp-0", /* 0xffb0 */
5066 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5069 "kp-equal", /* 0xffbd */
5070 "f1", /* 0xffbe */ /* IsFunctionKey */
5072 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5073 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5074 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5075 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5076 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5077 0, 0, 0, 0, 0, 0, 0, 0,
5078 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5079 0, 0, 0, 0, 0, 0, 0, "delete"
5082 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5083 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5085 static const char *const iso_lispy_function_keys
[] =
5087 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5088 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5089 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5090 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5091 "iso-lefttab", /* 0xfe20 */
5092 "iso-move-line-up", "iso-move-line-down",
5093 "iso-partial-line-up", "iso-partial-line-down",
5094 "iso-partial-space-left", "iso-partial-space-right",
5095 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5096 "iso-release-margin-left", "iso-release-margin-right",
5097 "iso-release-both-margins",
5098 "iso-fast-cursor-left", "iso-fast-cursor-right",
5099 "iso-fast-cursor-up", "iso-fast-cursor-down",
5100 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5101 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5104 #endif /* not HAVE_NTGUI */
5106 static Lisp_Object Vlispy_mouse_stem
;
5108 static const char *const lispy_wheel_names
[] =
5110 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5113 /* drag-n-drop events are generated when a set of selected files are
5114 dragged from another application and dropped onto an Emacs window. */
5115 static const char *const lispy_drag_n_drop_names
[] =
5120 /* Scroll bar parts. */
5121 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5122 Lisp_Object Qup
, Qdown
, Qbottom
;
5123 static Lisp_Object Qend_scroll
;
5125 static Lisp_Object Qratio
;
5127 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5128 static Lisp_Object
*const scroll_bar_parts
[] = {
5129 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5130 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5133 /* A vector, indexed by button number, giving the down-going location
5134 of currently depressed buttons, both scroll bar and non-scroll bar.
5136 The elements have the form
5137 (BUTTON-NUMBER MODIFIER-MASK . REST)
5138 where REST is the cdr of a position as it would be reported in the event.
5140 The make_lispy_event function stores positions here to tell the
5141 difference between click and drag events, and to store the starting
5142 location to be included in drag events. */
5144 static Lisp_Object button_down_location
;
5146 /* Information about the most recent up-going button event: Which
5147 button, what location, and what time. */
5149 static int last_mouse_button
;
5150 static int last_mouse_x
;
5151 static int last_mouse_y
;
5152 static Time button_down_time
;
5154 /* The number of clicks in this multiple-click. */
5156 static int double_click_count
;
5158 /* X and Y are frame-relative coordinates for a click or wheel event.
5159 Return a Lisp-style event list. */
5162 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5165 enum window_part part
;
5166 Lisp_Object posn
= Qnil
;
5167 Lisp_Object extra_info
= Qnil
;
5168 /* Coordinate pixel positions to return. */
5169 int xret
= 0, yret
= 0;
5170 /* The window under frame pixel coordinates (x,y) */
5171 Lisp_Object window
= f
5172 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5175 if (WINDOWP (window
))
5177 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5178 struct window
*w
= XWINDOW (window
);
5179 Lisp_Object string_info
= Qnil
;
5180 EMACS_INT textpos
= -1;
5181 int col
= -1, row
= -1;
5182 int dx
= -1, dy
= -1;
5183 int width
= -1, height
= -1;
5184 Lisp_Object object
= Qnil
;
5186 /* Pixel coordinates relative to the window corner. */
5187 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5188 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5190 /* For text area clicks, return X, Y relative to the corner of
5191 this text area. Note that dX, dY etc are set below, by
5192 buffer_posn_from_coords. */
5193 if (part
== ON_TEXT
)
5195 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5196 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5198 /* For mode line and header line clicks, return X, Y relative to
5199 the left window edge. Use mode_line_string to look for a
5200 string on the click position. */
5201 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5206 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5207 /* Note that mode_line_string takes COL, ROW as pixels and
5208 converts them to characters. */
5211 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5212 &object
, &dx
, &dy
, &width
, &height
);
5213 if (STRINGP (string
))
5214 string_info
= Fcons (string
, make_number (charpos
));
5215 textpos
= (w
== XWINDOW (selected_window
)
5216 && current_buffer
== XBUFFER (w
->buffer
))
5217 ? PT
: XMARKER (w
->pointm
)->charpos
;
5222 /* For fringes and margins, Y is relative to the area's (and the
5223 window's) top edge, while X is meaningless. */
5224 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5229 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5232 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5233 &object
, &dx
, &dy
, &width
, &height
);
5234 if (STRINGP (string
))
5235 string_info
= Fcons (string
, make_number (charpos
));
5236 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5238 else if (part
== ON_LEFT_FRINGE
)
5240 posn
= Qleft_fringe
;
5243 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5244 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5245 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5247 else if (part
== ON_RIGHT_FRINGE
)
5249 posn
= Qright_fringe
;
5252 - window_box_width (w
, LEFT_MARGIN_AREA
)
5253 - window_box_width (w
, TEXT_AREA
)
5254 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5255 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5257 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5259 else if (part
== ON_VERTICAL_BORDER
)
5261 posn
= Qvertical_line
;
5266 /* Nothing special for part == ON_SCROLL_BAR. */
5268 /* For clicks in the text area, fringes, or margins, call
5269 buffer_posn_from_coords to extract TEXTPOS, the buffer
5270 position nearest to the click. */
5273 Lisp_Object string2
, object2
= Qnil
;
5274 struct display_pos p
;
5276 int width2
, height2
;
5277 /* The pixel X coordinate passed to buffer_posn_from_coords
5278 is the X coordinate relative to the text area for
5279 text-area and right-margin clicks, zero otherwise. */
5281 = (part
== ON_TEXT
) ? xret
5282 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5283 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5287 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5288 &object2
, &dx2
, &dy2
,
5290 textpos
= CHARPOS (p
.pos
);
5291 if (col
< 0) col
= x2
;
5292 if (row
< 0) row
= y2
;
5293 if (dx
< 0) dx
= dx2
;
5294 if (dy
< 0) dy
= dy2
;
5295 if (width
< 0) width
= width2
;
5296 if (height
< 0) height
= height2
;
5300 posn
= make_number (textpos
);
5301 if (STRINGP (string2
))
5302 string_info
= Fcons (string2
,
5303 make_number (CHARPOS (p
.string_pos
)));
5309 #ifdef HAVE_WINDOW_SYSTEM
5310 if (IMAGEP (object
))
5312 Lisp_Object image_map
, hotspot
;
5313 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5315 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5317 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5318 posn
= XCAR (hotspot
);
5325 Fcons (make_number (dx
), make_number (dy
)),
5326 Fcons (make_number (width
), make_number (height
)));
5329 extra_info
= Fcons (string_info
,
5330 Fcons (make_number (textpos
),
5331 Fcons (Fcons (make_number (col
),
5336 XSETFRAME (window
, f
);
5340 return Fcons (window
,
5342 Fcons (Fcons (make_number (xret
),
5343 make_number (yret
)),
5344 Fcons (make_number (t
),
5348 /* Given a struct input_event, build the lisp event which represents
5349 it. If EVENT is 0, build a mouse movement event from the mouse
5350 movement buffer, which should have a movement event in it.
5352 Note that events must be passed to this function in the order they
5353 are received; this function stores the location of button presses
5354 in order to build drag events when the button is released. */
5357 make_lispy_event (struct input_event
*event
)
5361 switch (SWITCH_ENUM_CAST (event
->kind
))
5363 /* A simple keystroke. */
5364 case ASCII_KEYSTROKE_EVENT
:
5365 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5367 Lisp_Object lispy_c
;
5368 EMACS_INT c
= event
->code
;
5369 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5372 eassert (c
== event
->code
);
5373 /* Turn ASCII characters into control characters
5375 if (event
->modifiers
& ctrl_modifier
)
5377 c
= make_ctrl_char (c
);
5378 event
->modifiers
&= ~ctrl_modifier
;
5382 /* Add in the other modifier bits. The shift key was taken care
5383 of by the X code. */
5384 c
|= (event
->modifiers
5385 & (meta_modifier
| alt_modifier
5386 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5387 /* Distinguish Shift-SPC from SPC. */
5388 if ((event
->code
) == 040
5389 && event
->modifiers
& shift_modifier
)
5390 c
|= shift_modifier
;
5391 button_down_time
= 0;
5392 XSETFASTINT (lispy_c
, c
);
5397 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5398 except that they are non-key events (last-nonmenu-event is nil). */
5399 case NS_NONKEY_EVENT
:
5402 /* A function key. The symbol may need to have modifier prefixes
5404 case NON_ASCII_KEYSTROKE_EVENT
:
5405 button_down_time
= 0;
5407 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5408 if (event
->code
== lispy_accent_codes
[i
])
5409 return modify_event_symbol (i
,
5411 Qfunction_key
, Qnil
,
5412 lispy_accent_keys
, &accent_key_syms
,
5413 (sizeof (lispy_accent_keys
)
5414 / sizeof (lispy_accent_keys
[0])));
5418 if (event
->code
>= 0x400 && event
->code
< 0x500)
5419 return modify_event_symbol (event
->code
- 0x400,
5420 event
->modifiers
& ~shift_modifier
,
5421 Qfunction_key
, Qnil
,
5422 lispy_kana_keys
, &func_key_syms
,
5423 (sizeof (lispy_kana_keys
)
5424 / sizeof (lispy_kana_keys
[0])));
5425 #endif /* XK_kana_A */
5428 #ifdef ISO_FUNCTION_KEY_OFFSET
5429 if (event
->code
< FUNCTION_KEY_OFFSET
5430 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5431 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5433 Qfunction_key
, Qnil
,
5434 iso_lispy_function_keys
, &func_key_syms
,
5435 (sizeof (iso_lispy_function_keys
)
5436 / sizeof (iso_lispy_function_keys
[0])));
5439 /* Handle system-specific or unknown keysyms. */
5440 if (event
->code
& (1 << 28)
5441 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5442 || (event
->code
- FUNCTION_KEY_OFFSET
5443 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5444 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5446 /* We need to use an alist rather than a vector as the cache
5447 since we can't make a vector long enough. */
5448 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5449 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5450 return modify_event_symbol (event
->code
,
5453 KVAR (current_kboard
, Vsystem_key_alist
),
5454 0, &KVAR (current_kboard
, system_key_syms
),
5455 TYPE_MAXIMUM (EMACS_INT
));
5458 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5460 Qfunction_key
, Qnil
,
5461 lispy_function_keys
, &func_key_syms
,
5462 (sizeof (lispy_function_keys
)
5463 / sizeof (lispy_function_keys
[0])));
5466 case MULTIMEDIA_KEY_EVENT
:
5467 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5468 / sizeof (lispy_multimedia_keys
[0]))
5469 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5471 return modify_event_symbol (event
->code
, event
->modifiers
,
5472 Qfunction_key
, Qnil
,
5473 lispy_multimedia_keys
, &func_key_syms
,
5474 (sizeof (lispy_multimedia_keys
)
5475 / sizeof (lispy_multimedia_keys
[0])));
5481 /* A mouse click. Figure out where it is, decide whether it's
5482 a press, click or drag, and build the appropriate structure. */
5483 case MOUSE_CLICK_EVENT
:
5484 #ifndef USE_TOOLKIT_SCROLL_BARS
5485 case SCROLL_BAR_CLICK_EVENT
:
5488 int button
= event
->code
;
5490 Lisp_Object position
;
5491 Lisp_Object
*start_pos_ptr
;
5492 Lisp_Object start_pos
;
5496 /* Build the position as appropriate for this mouse click. */
5497 if (event
->kind
== MOUSE_CLICK_EVENT
)
5499 struct frame
*f
= XFRAME (event
->frame_or_window
);
5500 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5504 /* Ignore mouse events that were made on frame that
5505 have been deleted. */
5506 if (! FRAME_LIVE_P (f
))
5509 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5510 /* EVENT->x and EVENT->y are frame-relative pixel
5511 coordinates at this place. Under old redisplay, COLUMN
5512 and ROW are set to frame relative glyph coordinates
5513 which are then used to determine whether this click is
5514 in a menu (non-toolkit version). */
5515 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5516 &column
, &row
, NULL
, 1);
5518 /* In the non-toolkit version, clicks on the menu bar
5519 are ordinary button events in the event buffer.
5520 Distinguish them, and invoke the menu.
5522 (In the toolkit version, the toolkit handles the menu bar
5523 and Emacs doesn't know about it until after the user
5524 makes a selection.) */
5525 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5526 && (event
->modifiers
& down_modifier
))
5528 Lisp_Object items
, item
;
5530 /* Find the menu bar item under `column'. */
5532 items
= FRAME_MENU_BAR_ITEMS (f
);
5533 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5535 Lisp_Object pos
, string
;
5536 string
= AREF (items
, i
+ 1);
5537 pos
= AREF (items
, i
+ 3);
5540 if (column
>= XINT (pos
)
5541 && column
< XINT (pos
) + SCHARS (string
))
5543 item
= AREF (items
, i
);
5548 /* ELisp manual 2.4b says (x y) are window relative but
5549 code says they are frame-relative. */
5551 = Fcons (event
->frame_or_window
,
5553 Fcons (Fcons (event
->x
, event
->y
),
5554 Fcons (make_number (event
->timestamp
),
5557 return Fcons (item
, Fcons (position
, Qnil
));
5559 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5561 position
= make_lispy_position (f
, event
->x
, event
->y
,
5564 #ifndef USE_TOOLKIT_SCROLL_BARS
5567 /* It's a scrollbar click. */
5569 Lisp_Object portion_whole
;
5572 window
= event
->frame_or_window
;
5573 portion_whole
= Fcons (event
->x
, event
->y
);
5574 part
= *scroll_bar_parts
[(int) event
->part
];
5578 Fcons (Qvertical_scroll_bar
,
5579 Fcons (portion_whole
,
5580 Fcons (make_number (event
->timestamp
),
5581 Fcons (part
, Qnil
)))));
5583 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5585 if (button
>= ASIZE (button_down_location
))
5587 button_down_location
= larger_vector (button_down_location
,
5589 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5592 start_pos_ptr
= &AREF (button_down_location
, button
);
5593 start_pos
= *start_pos_ptr
;
5594 *start_pos_ptr
= Qnil
;
5597 /* On window-system frames, use the value of
5598 double-click-fuzz as is. On other frames, interpret it
5599 as a multiple of 1/8 characters. */
5603 if (WINDOWP (event
->frame_or_window
))
5604 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5605 else if (FRAMEP (event
->frame_or_window
))
5606 f
= XFRAME (event
->frame_or_window
);
5610 if (FRAME_WINDOW_P (f
))
5611 fuzz
= double_click_fuzz
;
5613 fuzz
= double_click_fuzz
/ 8;
5615 is_double
= (button
== last_mouse_button
5616 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5617 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5618 && button_down_time
!= 0
5619 && (EQ (Vdouble_click_time
, Qt
)
5620 || (NATNUMP (Vdouble_click_time
)
5621 && (event
->timestamp
- button_down_time
5622 < XFASTINT (Vdouble_click_time
)))));
5625 last_mouse_button
= button
;
5626 last_mouse_x
= XINT (event
->x
);
5627 last_mouse_y
= XINT (event
->y
);
5629 /* If this is a button press, squirrel away the location, so
5630 we can decide later whether it was a click or a drag. */
5631 if (event
->modifiers
& down_modifier
)
5635 double_click_count
++;
5636 event
->modifiers
|= ((double_click_count
> 2)
5641 double_click_count
= 1;
5642 button_down_time
= event
->timestamp
;
5643 *start_pos_ptr
= Fcopy_alist (position
);
5644 ignore_mouse_drag_p
= 0;
5647 /* Now we're releasing a button - check the co-ordinates to
5648 see if this was a click or a drag. */
5649 else if (event
->modifiers
& up_modifier
)
5651 /* If we did not see a down before this up, ignore the up.
5652 Probably this happened because the down event chose a
5653 menu item. It would be an annoyance to treat the
5654 release of the button that chose the menu item as a
5657 if (!CONSP (start_pos
))
5660 event
->modifiers
&= ~up_modifier
;
5663 Lisp_Object new_down
, down
;
5664 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5666 /* The third element of every position
5667 should be the (x,y) pair. */
5668 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5669 new_down
= Fcar (Fcdr (Fcdr (position
)));
5672 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5674 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5675 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5678 if (ignore_mouse_drag_p
)
5680 event
->modifiers
|= click_modifier
;
5681 ignore_mouse_drag_p
= 0;
5683 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5684 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5685 /* Maybe the mouse has moved a lot, caused scrolling, and
5686 eventually ended up at the same screen position (but
5687 not buffer position) in which case it is a drag, not
5689 /* FIXME: OTOH if the buffer position has changed
5690 because of a timer or process filter rather than
5691 because of mouse movement, it should be considered as
5692 a click. But mouse-drag-region completely ignores
5693 this case and it hasn't caused any real problem, so
5694 it's probably OK to ignore it as well. */
5695 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5696 /* Mouse hasn't moved (much). */
5697 event
->modifiers
|= click_modifier
;
5700 button_down_time
= 0;
5701 event
->modifiers
|= drag_modifier
;
5704 /* Don't check is_double; treat this as multiple
5705 if the down-event was multiple. */
5706 if (double_click_count
> 1)
5707 event
->modifiers
|= ((double_click_count
> 2)
5713 /* Every mouse event should either have the down_modifier or
5714 the up_modifier set. */
5718 /* Get the symbol we should use for the mouse click. */
5721 head
= modify_event_symbol (button
,
5723 Qmouse_click
, Vlispy_mouse_stem
,
5726 ASIZE (mouse_syms
));
5727 if (event
->modifiers
& drag_modifier
)
5732 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5735 Fcons (make_number (double_click_count
),
5745 case HORIZ_WHEEL_EVENT
:
5747 Lisp_Object position
;
5750 /* Build the position as appropriate for this mouse click. */
5751 struct frame
*f
= XFRAME (event
->frame_or_window
);
5753 /* Ignore wheel events that were made on frame that have been
5755 if (! FRAME_LIVE_P (f
))
5758 position
= make_lispy_position (f
, event
->x
, event
->y
,
5761 /* Set double or triple modifiers to indicate the wheel speed. */
5763 /* On window-system frames, use the value of
5764 double-click-fuzz as is. On other frames, interpret it
5765 as a multiple of 1/8 characters. */
5771 if (WINDOWP (event
->frame_or_window
))
5772 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5773 else if (FRAMEP (event
->frame_or_window
))
5774 fr
= XFRAME (event
->frame_or_window
);
5778 fuzz
= FRAME_WINDOW_P (fr
)
5779 ? double_click_fuzz
: double_click_fuzz
/ 8;
5781 if (event
->modifiers
& up_modifier
)
5783 /* Emit a wheel-up event. */
5784 event
->modifiers
&= ~up_modifier
;
5787 else if (event
->modifiers
& down_modifier
)
5789 /* Emit a wheel-down event. */
5790 event
->modifiers
&= ~down_modifier
;
5794 /* Every wheel event should either have the down_modifier or
5795 the up_modifier set. */
5798 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5801 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5802 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5803 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5804 && button_down_time
!= 0
5805 && (EQ (Vdouble_click_time
, Qt
)
5806 || (NATNUMP (Vdouble_click_time
)
5807 && (event
->timestamp
- button_down_time
5808 < XFASTINT (Vdouble_click_time
)))));
5811 double_click_count
++;
5812 event
->modifiers
|= ((double_click_count
> 2)
5818 double_click_count
= 1;
5819 event
->modifiers
|= click_modifier
;
5822 button_down_time
= event
->timestamp
;
5823 /* Use a negative value to distinguish wheel from mouse button. */
5824 last_mouse_button
= - (1 + symbol_num
);
5825 last_mouse_x
= XINT (event
->x
);
5826 last_mouse_y
= XINT (event
->y
);
5828 /* Get the symbol we should use for the wheel event. */
5829 head
= modify_event_symbol (symbol_num
,
5835 ASIZE (wheel_syms
));
5838 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5841 Fcons (make_number (double_click_count
),
5850 #ifdef USE_TOOLKIT_SCROLL_BARS
5852 /* We don't have down and up events if using toolkit scroll bars,
5853 so make this always a click event. Store in the `part' of
5854 the Lisp event a symbol which maps to the following actions:
5856 `above_handle' page up
5857 `below_handle' page down
5861 `bottom' bottom of buffer
5862 `handle' thumb has been dragged.
5863 `end-scroll' end of interaction with scroll bar
5865 The incoming input_event contains in its `part' member an
5866 index of type `enum scroll_bar_part' which we can use as an
5867 index in scroll_bar_parts to get the appropriate symbol. */
5869 case SCROLL_BAR_CLICK_EVENT
:
5871 Lisp_Object position
, head
, window
, portion_whole
, part
;
5873 window
= event
->frame_or_window
;
5874 portion_whole
= Fcons (event
->x
, event
->y
);
5875 part
= *scroll_bar_parts
[(int) event
->part
];
5879 Fcons (Qvertical_scroll_bar
,
5880 Fcons (portion_whole
,
5881 Fcons (make_number (event
->timestamp
),
5882 Fcons (part
, Qnil
)))));
5884 /* Always treat scroll bar events as clicks. */
5885 event
->modifiers
|= click_modifier
;
5886 event
->modifiers
&= ~up_modifier
;
5888 if (event
->code
>= ASIZE (mouse_syms
))
5889 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5891 /* Get the symbol we should use for the mouse click. */
5892 head
= modify_event_symbol (event
->code
,
5897 ASIZE (mouse_syms
));
5898 return Fcons (head
, Fcons (position
, Qnil
));
5901 #endif /* USE_TOOLKIT_SCROLL_BARS */
5903 case DRAG_N_DROP_EVENT
:
5906 Lisp_Object head
, position
;
5909 f
= XFRAME (event
->frame_or_window
);
5912 /* Ignore mouse events that were made on frames that
5913 have been deleted. */
5914 if (! FRAME_LIVE_P (f
))
5917 position
= make_lispy_position (f
, event
->x
, event
->y
,
5920 head
= modify_event_symbol (0, event
->modifiers
,
5922 lispy_drag_n_drop_names
,
5923 &drag_n_drop_syms
, 1);
5929 #endif /* HAVE_MOUSE */
5931 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5932 || defined (HAVE_NS) || defined (USE_GTK)
5933 case MENU_BAR_EVENT
:
5934 if (EQ (event
->arg
, event
->frame_or_window
))
5935 /* This is the prefix key. We translate this to
5936 `(menu_bar)' because the code in keyboard.c for menu
5937 events, which we use, relies on this. */
5938 return Fcons (Qmenu_bar
, Qnil
);
5942 case SELECT_WINDOW_EVENT
:
5943 /* Make an event (select-window (WINDOW)). */
5944 return Fcons (Qselect_window
,
5945 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5948 case TOOL_BAR_EVENT
:
5949 if (EQ (event
->arg
, event
->frame_or_window
))
5950 /* This is the prefix key. We translate this to
5951 `(tool_bar)' because the code in keyboard.c for tool bar
5952 events, which we use, relies on this. */
5953 return Fcons (Qtool_bar
, Qnil
);
5954 else if (SYMBOLP (event
->arg
))
5955 return apply_modifiers (event
->modifiers
, event
->arg
);
5958 case USER_SIGNAL_EVENT
:
5959 /* A user signal. */
5961 char *name
= find_user_signal_name (event
->code
);
5964 return intern (name
);
5967 case SAVE_SESSION_EVENT
:
5968 return Qsave_session
;
5973 return Fcons (Qdbus_event
, event
->arg
);
5975 #endif /* HAVE_DBUS */
5977 case CONFIG_CHANGED_EVENT
:
5978 return Fcons (Qconfig_changed_event
,
5980 Fcons (event
->frame_or_window
, Qnil
)));
5982 case GPM_CLICK_EVENT
:
5984 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5985 Lisp_Object head
, position
;
5986 Lisp_Object
*start_pos_ptr
;
5987 Lisp_Object start_pos
;
5988 int button
= event
->code
;
5990 if (button
>= ASIZE (button_down_location
))
5992 button_down_location
= larger_vector (button_down_location
,
5994 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5997 start_pos_ptr
= &AREF (button_down_location
, button
);
5998 start_pos
= *start_pos_ptr
;
6000 position
= make_lispy_position (f
, event
->x
, event
->y
,
6003 if (event
->modifiers
& down_modifier
)
6004 *start_pos_ptr
= Fcopy_alist (position
);
6005 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6007 if (!CONSP (start_pos
))
6009 event
->modifiers
&= ~up_modifier
;
6012 head
= modify_event_symbol (button
,
6014 Qmouse_click
, Vlispy_mouse_stem
,
6017 ASIZE (mouse_syms
));
6019 if (event
->modifiers
& drag_modifier
)
6024 else if (event
->modifiers
& double_modifier
)
6027 Fcons (make_number (2),
6029 else if (event
->modifiers
& triple_modifier
)
6032 Fcons (make_number (3),
6039 #endif /* HAVE_GPM */
6041 /* The 'kind' field of the event is something we don't recognize. */
6047 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6050 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6051 Lisp_Object x
, Lisp_Object y
, Time t
)
6053 /* Is it a scroll bar movement? */
6054 if (frame
&& ! NILP (bar_window
))
6056 Lisp_Object part_sym
;
6058 part_sym
= *scroll_bar_parts
[(int) part
];
6059 return Fcons (Qscroll_bar_movement
,
6060 Fcons (list5 (bar_window
,
6061 Qvertical_scroll_bar
,
6067 /* Or is it an ordinary mouse movement? */
6070 Lisp_Object position
;
6071 position
= make_lispy_position (frame
, x
, y
, t
);
6072 return list2 (Qmouse_movement
, position
);
6076 #endif /* HAVE_MOUSE || HAVE GPM */
6078 /* Construct a switch frame event. */
6080 make_lispy_switch_frame (Lisp_Object frame
)
6082 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6085 /* Manipulating modifiers. */
6087 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6089 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6090 SYMBOL's name of the end of the modifiers; the string from this
6091 position is the unmodified symbol name.
6093 This doesn't use any caches. */
6096 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6102 CHECK_SYMBOL (symbol
);
6105 name
= SYMBOL_NAME (symbol
);
6107 for (i
= 0; i
+2 <= SBYTES (name
); )
6109 EMACS_INT this_mod_end
= 0;
6112 /* See if the name continues with a modifier word.
6113 Check that the word appears, but don't check what follows it.
6114 Set this_mod and this_mod_end to record what we find. */
6116 switch (SREF (name
, i
))
6118 #define SINGLE_LETTER_MOD(BIT) \
6119 (this_mod_end = i + 1, this_mod = BIT)
6122 SINGLE_LETTER_MOD (alt_modifier
);
6126 SINGLE_LETTER_MOD (ctrl_modifier
);
6130 SINGLE_LETTER_MOD (hyper_modifier
);
6134 SINGLE_LETTER_MOD (meta_modifier
);
6138 SINGLE_LETTER_MOD (shift_modifier
);
6142 SINGLE_LETTER_MOD (super_modifier
);
6145 #undef SINGLE_LETTER_MOD
6147 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6148 if (i + LEN + 1 <= SBYTES (name) \
6149 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6151 this_mod_end = i + LEN; \
6156 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6157 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6158 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6162 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6164 #undef MULTI_LETTER_MOD
6168 /* If we found no modifier, stop looking for them. */
6169 if (this_mod_end
== 0)
6172 /* Check there is a dash after the modifier, so that it
6173 really is a modifier. */
6174 if (this_mod_end
>= SBYTES (name
)
6175 || SREF (name
, this_mod_end
) != '-')
6178 /* This modifier is real; look for another. */
6179 modifiers
|= this_mod
;
6180 i
= this_mod_end
+ 1;
6183 /* Should we include the `click' modifier? */
6184 if (! (modifiers
& (down_modifier
| drag_modifier
6185 | double_modifier
| triple_modifier
))
6186 && i
+ 7 == SBYTES (name
)
6187 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6188 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6189 modifiers
|= click_modifier
;
6191 if (! (modifiers
& (double_modifier
| triple_modifier
))
6192 && i
+ 6 < SBYTES (name
)
6193 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6194 modifiers
|= click_modifier
;
6202 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6203 prepended to the string BASE[0..BASE_LEN-1].
6204 This doesn't use any caches. */
6206 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6208 /* Since BASE could contain nulls, we can't use intern here; we have
6209 to use Fintern, which expects a genuine Lisp_String, and keeps a
6212 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6218 /* Only the event queue may use the `up' modifier; it should always
6219 be turned into a click or drag event before presented to lisp code. */
6220 if (modifiers
& up_modifier
)
6223 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6224 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6225 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6226 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6227 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6228 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6229 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6230 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6231 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6232 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6233 /* The click modifier is denoted by the absence of other modifiers. */
6237 mod_len
= p
- new_mods
;
6241 Lisp_Object new_name
;
6243 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6244 mod_len
+ base_len_byte
);
6245 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6246 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6248 return Fintern (new_name
, Qnil
);
6253 static const char *const modifier_names
[] =
6255 "up", "down", "drag", "click", "double", "triple", 0, 0,
6256 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6257 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6259 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6261 static Lisp_Object modifier_symbols
;
6263 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6265 lispy_modifier_list (int modifiers
)
6267 Lisp_Object modifier_list
;
6270 modifier_list
= Qnil
;
6271 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6272 if (modifiers
& (1<<i
))
6273 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6276 return modifier_list
;
6280 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6281 where UNMODIFIED is the unmodified form of SYMBOL,
6282 MASK is the set of modifiers present in SYMBOL's name.
6283 This is similar to parse_modifiers_uncached, but uses the cache in
6284 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6285 Qevent_symbol_elements property. */
6287 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6290 parse_modifiers (Lisp_Object symbol
)
6292 Lisp_Object elements
;
6294 if (INTEGERP (symbol
))
6295 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6296 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6298 else if (!SYMBOLP (symbol
))
6301 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6302 if (CONSP (elements
))
6307 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6308 Lisp_Object unmodified
;
6311 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6312 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6315 if (modifiers
& ~INTMASK
)
6317 XSETFASTINT (mask
, modifiers
);
6318 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6320 /* Cache the parsing results on SYMBOL. */
6321 Fput (symbol
, Qevent_symbol_element_mask
,
6323 Fput (symbol
, Qevent_symbol_elements
,
6324 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6326 /* Since we know that SYMBOL is modifiers applied to unmodified,
6327 it would be nice to put that in unmodified's cache.
6328 But we can't, since we're not sure that parse_modifiers is
6335 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6336 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6337 doc
: /* Parse the event symbol. For internal use. */)
6338 (Lisp_Object symbol
)
6340 /* Fill the cache if needed. */
6341 parse_modifiers (symbol
);
6342 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6343 and use the Lispier representation stored on Qevent_symbol_elements
6345 return Fget (symbol
, Qevent_symbol_elements
);
6348 /* Apply the modifiers MODIFIERS to the symbol BASE.
6349 BASE must be unmodified.
6351 This is like apply_modifiers_uncached, but uses BASE's
6352 Qmodifier_cache property, if present. It also builds
6353 Qevent_symbol_elements properties, since it has that info anyway.
6355 apply_modifiers copies the value of BASE's Qevent_kind property to
6356 the modified symbol. */
6358 apply_modifiers (int modifiers
, Lisp_Object base
)
6360 Lisp_Object cache
, idx
, entry
, new_symbol
;
6362 /* Mask out upper bits. We don't know where this value's been. */
6363 modifiers
&= INTMASK
;
6365 if (INTEGERP (base
))
6366 return make_number (XINT (base
) | modifiers
);
6368 /* The click modifier never figures into cache indices. */
6369 cache
= Fget (base
, Qmodifier_cache
);
6370 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6371 entry
= assq_no_quit (idx
, cache
);
6374 new_symbol
= XCDR (entry
);
6377 /* We have to create the symbol ourselves. */
6378 new_symbol
= apply_modifiers_uncached (modifiers
,
6379 SSDATA (SYMBOL_NAME (base
)),
6380 SCHARS (SYMBOL_NAME (base
)),
6381 SBYTES (SYMBOL_NAME (base
)));
6383 /* Add the new symbol to the base's cache. */
6384 entry
= Fcons (idx
, new_symbol
);
6385 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6387 /* We have the parsing info now for free, so we could add it to
6389 XSETFASTINT (idx, modifiers);
6390 Fput (new_symbol, Qevent_symbol_element_mask,
6391 Fcons (base, Fcons (idx, Qnil)));
6392 Fput (new_symbol, Qevent_symbol_elements,
6393 Fcons (base, lispy_modifier_list (modifiers)));
6394 Sadly, this is only correct if `base' is indeed a base event,
6395 which is not necessarily the case. -stef */
6398 /* Make sure this symbol is of the same kind as BASE.
6400 You'd think we could just set this once and for all when we
6401 intern the symbol above, but reorder_modifiers may call us when
6402 BASE's property isn't set right; we can't assume that just
6403 because it has a Qmodifier_cache property it must have its
6404 Qevent_kind set right as well. */
6405 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6409 kind
= Fget (base
, Qevent_kind
);
6411 Fput (new_symbol
, Qevent_kind
, kind
);
6418 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6419 return a symbol with the modifiers placed in the canonical order.
6420 Canonical order is alphabetical, except for down and drag, which
6421 always come last. The 'click' modifier is never written out.
6423 Fdefine_key calls this to make sure that (for example) C-M-foo
6424 and M-C-foo end up being equivalent in the keymap. */
6427 reorder_modifiers (Lisp_Object symbol
)
6429 /* It's hopefully okay to write the code this way, since everything
6430 will soon be in caches, and no consing will be done at all. */
6433 parsed
= parse_modifiers (symbol
);
6434 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6439 /* For handling events, we often want to produce a symbol whose name
6440 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6441 to some base, like the name of a function key or mouse button.
6442 modify_event_symbol produces symbols of this sort.
6444 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6445 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6448 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6449 into symbol names, or a string specifying a name stem used to
6450 construct a symbol name or the form `STEM-N', where N is the decimal
6451 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6452 non-nil; otherwise NAME_TABLE is used.
6454 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6455 persist between calls to modify_event_symbol that it can use to
6456 store a cache of the symbols it's generated for this NAME_TABLE
6457 before. The object stored there may be a vector or an alist.
6459 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6461 MODIFIERS is a set of modifier bits (as given in struct input_events)
6462 whose prefixes should be applied to the symbol name.
6464 SYMBOL_KIND is the value to be placed in the event_kind property of
6465 the returned symbol.
6467 The symbols we create are supposed to have an
6468 `event-symbol-elements' property, which lists the modifiers present
6469 in the symbol's name. */
6472 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6473 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6474 Lisp_Object
*symbol_table
, EMACS_INT table_size
)
6477 Lisp_Object symbol_int
;
6479 /* Get rid of the "vendor-specific" bit here. */
6480 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6482 /* Is this a request for a valid symbol? */
6483 if (symbol_num
< 0 || symbol_num
>= table_size
)
6486 if (CONSP (*symbol_table
))
6487 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6489 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6490 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6491 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6492 we've never used that symbol before. */
6495 if (! VECTORP (*symbol_table
)
6496 || ASIZE (*symbol_table
) != table_size
)
6500 XSETFASTINT (size
, table_size
);
6501 *symbol_table
= Fmake_vector (size
, Qnil
);
6504 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6507 /* Have we already used this symbol before? */
6510 /* No; let's create it. */
6511 if (CONSP (name_alist_or_stem
))
6512 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6513 else if (STRINGP (name_alist_or_stem
))
6516 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6517 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6519 SAFE_ALLOCA (buf
, char *, len
);
6520 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6521 XINT (symbol_int
) + 1);
6522 value
= intern (buf
);
6525 else if (name_table
!= 0 && name_table
[symbol_num
])
6526 value
= intern (name_table
[symbol_num
]);
6528 #ifdef HAVE_WINDOW_SYSTEM
6531 char *name
= x_get_keysym_name (symbol_num
);
6533 value
= intern (name
);
6539 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6540 sprintf (buf
, "key-%"pI
"d", symbol_num
);
6541 value
= intern (buf
);
6544 if (CONSP (*symbol_table
))
6545 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6547 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6549 /* Fill in the cache entries for this symbol; this also
6550 builds the Qevent_symbol_elements property, which the user
6552 apply_modifiers (modifiers
& click_modifier
, value
);
6553 Fput (value
, Qevent_kind
, symbol_kind
);
6556 /* Apply modifiers to that symbol. */
6557 return apply_modifiers (modifiers
, value
);
6560 /* Convert a list that represents an event type,
6561 such as (ctrl meta backspace), into the usual representation of that
6562 event type as a number or a symbol. */
6564 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6565 doc
: /* Convert the event description list EVENT-DESC to an event type.
6566 EVENT-DESC should contain one base event type (a character or symbol)
6567 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6568 drag, down, double or triple). The base must be last.
6569 The return value is an event type (a character or symbol) which
6570 has the same base event type and all the specified modifiers. */)
6571 (Lisp_Object event_desc
)
6579 while (CONSP (rest
))
6587 /* Given a symbol, see if it is a modifier name. */
6588 if (SYMBOLP (elt
) && CONSP (rest
))
6589 this = parse_solitary_modifier (elt
);
6593 else if (!NILP (base
))
6594 error ("Two bases given in one event");
6600 /* Let the symbol A refer to the character A. */
6601 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6602 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6604 if (INTEGERP (base
))
6606 /* Turn (shift a) into A. */
6607 if ((modifiers
& shift_modifier
) != 0
6608 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6610 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6611 modifiers
&= ~shift_modifier
;
6614 /* Turn (control a) into C-a. */
6615 if (modifiers
& ctrl_modifier
)
6616 return make_number ((modifiers
& ~ctrl_modifier
)
6617 | make_ctrl_char (XINT (base
)));
6619 return make_number (modifiers
| XINT (base
));
6621 else if (SYMBOLP (base
))
6622 return apply_modifiers (modifiers
, base
);
6625 error ("Invalid base event");
6630 /* Try to recognize SYMBOL as a modifier name.
6631 Return the modifier flag bit, or 0 if not recognized. */
6634 parse_solitary_modifier (Lisp_Object symbol
)
6636 Lisp_Object name
= SYMBOL_NAME (symbol
);
6638 switch (SREF (name
, 0))
6640 #define SINGLE_LETTER_MOD(BIT) \
6641 if (SBYTES (name) == 1) \
6644 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6645 if (LEN == SBYTES (name) \
6646 && ! strncmp (SSDATA (name), NAME, LEN)) \
6650 SINGLE_LETTER_MOD (alt_modifier
);
6654 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6658 SINGLE_LETTER_MOD (ctrl_modifier
);
6662 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6663 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6667 SINGLE_LETTER_MOD (hyper_modifier
);
6671 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6675 SINGLE_LETTER_MOD (meta_modifier
);
6679 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6683 SINGLE_LETTER_MOD (shift_modifier
);
6687 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6688 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6689 SINGLE_LETTER_MOD (super_modifier
);
6693 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6694 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6695 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6699 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6702 #undef SINGLE_LETTER_MOD
6703 #undef MULTI_LETTER_MOD
6709 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6710 Such a list is not valid as an event,
6711 but it can be a Lucid-style event type list. */
6714 lucid_event_type_list_p (Lisp_Object object
)
6718 if (! CONSP (object
))
6721 if (EQ (XCAR (object
), Qhelp_echo
)
6722 || EQ (XCAR (object
), Qvertical_line
)
6723 || EQ (XCAR (object
), Qmode_line
)
6724 || EQ (XCAR (object
), Qheader_line
))
6727 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6731 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6738 /* Store into *addr a value nonzero if terminal input chars are available.
6739 Serves the purpose of ioctl (0, FIONREAD, addr)
6740 but works even if FIONREAD does not exist.
6741 (In fact, this may actually read some input.)
6743 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6744 timer events that are ripe.
6745 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6746 events (FOCUS_IN_EVENT).
6747 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6748 movements and toolkit scroll bar thumb drags. */
6751 get_input_pending (int *addr
, int flags
)
6753 /* First of all, have we already counted some input? */
6754 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6756 /* If input is being read as it arrives, and we have none, there is none. */
6757 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6760 /* Try to read some input and see how much we get. */
6762 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6765 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6768 gobble_input (int expected
)
6771 if (interrupt_input
)
6774 mask
= sigblock (sigmask (SIGIO
));
6775 read_avail_input (expected
);
6779 #ifdef POLL_FOR_INPUT
6780 /* XXX This condition was (read_socket_hook && !interrupt_input),
6781 but read_socket_hook is not global anymore. Let's pretend that
6783 if (!interrupt_input
&& poll_suppress_count
== 0)
6786 mask
= sigblock (sigmask (SIGALRM
));
6787 read_avail_input (expected
);
6793 read_avail_input (expected
);
6796 /* Put a BUFFER_SWITCH_EVENT in the buffer
6797 so that read_key_sequence will notice the new current buffer. */
6800 record_asynch_buffer_change (void)
6802 struct input_event event
;
6806 event
.kind
= BUFFER_SWITCH_EVENT
;
6807 event
.frame_or_window
= Qnil
;
6810 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6811 The purpose of the event is to make read_key_sequence look up the
6812 keymaps again. If we aren't in read_key_sequence, we don't need one,
6813 and the event could cause trouble by messing up (input-pending-p).
6814 Note: Fwaiting_for_user_input_p always returns nil when async
6815 subprocesses aren't supported. */
6816 tem
= Fwaiting_for_user_input_p ();
6820 /* Make sure no interrupt happens while storing the event. */
6822 if (interrupt_input
)
6825 mask
= sigblock (sigmask (SIGIO
));
6826 kbd_buffer_store_event (&event
);
6833 kbd_buffer_store_event (&event
);
6838 /* Read any terminal input already buffered up by the system
6839 into the kbd_buffer, but do not wait.
6841 EXPECTED should be nonzero if the caller knows there is some input.
6843 Returns the number of keyboard chars read, or -1 meaning
6844 this is a bad time to try to read input. */
6847 read_avail_input (int expected
)
6853 /* Store pending user signal events, if any. */
6854 if (store_user_signal_events ())
6857 /* Loop through the available terminals, and call their input hooks. */
6861 struct terminal
*next
= t
->next_terminal
;
6863 if (t
->read_socket_hook
)
6866 struct input_event hold_quit
;
6868 EVENT_INIT (hold_quit
);
6869 hold_quit
.kind
= NO_EVENT
;
6871 /* No need for FIONREAD or fcntl; just say don't wait. */
6872 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6878 if (nr
== -1) /* Not OK to read input now. */
6882 else if (nr
== -2) /* Non-transient error. */
6884 /* The terminal device terminated; it should be closed. */
6886 /* Kill Emacs if this was our last terminal. */
6887 if (!terminal_list
->next_terminal
)
6888 /* Formerly simply reported no input, but that
6889 sometimes led to a failure of Emacs to terminate.
6890 SIGHUP seems appropriate if we can't reach the
6892 /* ??? Is it really right to send the signal just to
6893 this process rather than to the whole process
6894 group? Perhaps on systems with FIONREAD Emacs is
6895 alone in its group. */
6896 kill (getpid (), SIGHUP
);
6898 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6901 XSETTERMINAL (tmp
, t
);
6902 Fdelete_terminal (tmp
, Qnoelisp
);
6906 if (hold_quit
.kind
!= NO_EVENT
)
6907 kbd_buffer_store_event (&hold_quit
);
6916 frame_make_pointer_visible ();
6922 decode_keyboard_code (struct tty_display_info
*tty
,
6923 struct coding_system
*coding
,
6924 unsigned char *buf
, int nbytes
)
6926 unsigned char *src
= buf
;
6927 const unsigned char *p
;
6932 if (tty
->meta_key
!= 2)
6933 for (i
= 0; i
< nbytes
; i
++)
6935 if (coding
->carryover_bytes
> 0)
6937 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6938 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6939 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6940 nbytes
+= coding
->carryover_bytes
;
6942 coding
->destination
= alloca (nbytes
* 4);
6943 coding
->dst_bytes
= nbytes
* 4;
6944 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6945 if (coding
->produced_char
== 0)
6947 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6949 struct input_event event_buf
;
6951 EVENT_INIT (event_buf
);
6952 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6954 (ASCII_CHAR_P (event_buf
.code
)
6955 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6956 /* See the comment in tty_read_avail_input. */
6957 event_buf
.frame_or_window
= tty
->top_frame
;
6958 event_buf
.arg
= Qnil
;
6959 kbd_buffer_store_event (&event_buf
);
6963 /* This is the tty way of reading available input.
6965 Note that each terminal device has its own `struct terminal' object,
6966 and so this function is called once for each individual termcap
6967 terminal. The first parameter indicates which terminal to read from. */
6970 tty_read_avail_input (struct terminal
*terminal
,
6972 struct input_event
*hold_quit
)
6974 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6975 the kbd_buffer can really hold. That may prevent loss
6976 of characters on some systems when input is stuffed at us. */
6977 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6979 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6982 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6984 if (kbd_on_hold_p () || buffer_free
<= 0)
6986 #endif /* subprocesses */
6988 if (!terminal
->name
) /* Don't read from a dead terminal. */
6991 if (terminal
->type
!= output_termcap
6992 && terminal
->type
!= output_msdos_raw
)
6995 /* XXX I think the following code should be moved to separate hook
6996 functions in system-dependent files. */
6999 #else /* not WINDOWSNT */
7000 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7004 return 0; /* The terminal is suspended. */
7007 n_to_read
= dos_keysns ();
7011 cbuf
[0] = dos_keyread ();
7014 #else /* not MSDOS */
7019 struct input_event gpm_hold_quit
;
7020 int gpm
, fd
= gpm_fd
;
7022 EVENT_INIT (gpm_hold_quit
);
7023 gpm_hold_quit
.kind
= NO_EVENT
;
7025 /* gpm==1 if event received.
7026 gpm==0 if the GPM daemon has closed the connection, in which case
7027 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7028 we save it in `fd' so close_gpm can remove it from the
7030 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7031 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7032 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7035 /* Presumably the GPM daemon has closed the connection. */
7037 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7038 kbd_buffer_store_event (&gpm_hold_quit
);
7042 #endif /* HAVE_GPM */
7044 /* Determine how many characters we should *try* to read. */
7046 /* Find out how much input is available. */
7047 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7049 if (! noninteractive
)
7050 return -2; /* Close this terminal. */
7056 if (n_to_read
> sizeof cbuf
)
7057 n_to_read
= sizeof cbuf
;
7058 #else /* no FIONREAD */
7059 #if defined (USG) || defined (CYGWIN)
7060 /* Read some input if available, but don't wait. */
7061 n_to_read
= sizeof cbuf
;
7062 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7069 /* Don't read more than we can store. */
7070 if (n_to_read
> buffer_free
)
7071 n_to_read
= buffer_free
;
7072 #endif /* subprocesses */
7074 /* Now read; for one reason or another, this will not block.
7075 NREAD is set to the number of chars read. */
7078 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7079 /* POSIX infers that processes which are not in the session leader's
7080 process group won't get SIGHUP's at logout time. BSDI adheres to
7081 this part standard and returns -1 from read (0) with errno==EIO
7082 when the control tty is taken away.
7083 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7084 if (nread
== -1 && errno
== EIO
)
7085 return -2; /* Close this terminal. */
7086 #if defined (AIX) && defined (_BSD)
7087 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7088 This looks incorrect, but it isn't, because _BSD causes
7089 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7090 and that causes a value other than 0 when there is no input. */
7092 return -2; /* Close this terminal. */
7096 /* We used to retry the read if it was interrupted.
7097 But this does the wrong thing when O_NDELAY causes
7098 an EAGAIN error. Does anybody know of a situation
7099 where a retry is actually needed? */
7101 nread
< 0 && (errno
== EAGAIN
7115 #if defined (USG) || defined (CYGWIN)
7116 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7117 #endif /* USG or CYGWIN */
7118 #endif /* no FIONREAD */
7123 #endif /* not MSDOS */
7124 #endif /* not WINDOWSNT */
7126 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7127 & CODING_REQUIRE_DECODING_MASK
)
7129 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7132 /* Decode the key sequence except for those with meta
7134 for (i
= from
= 0; ; i
++)
7135 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7137 struct input_event buf
;
7139 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7144 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7145 buf
.modifiers
= meta_modifier
;
7146 buf
.code
= cbuf
[i
] & ~0x80;
7147 /* See the comment below. */
7148 buf
.frame_or_window
= tty
->top_frame
;
7150 kbd_buffer_store_event (&buf
);
7156 for (i
= 0; i
< nread
; i
++)
7158 struct input_event buf
;
7160 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7162 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7163 buf
.modifiers
= meta_modifier
;
7164 if (tty
->meta_key
!= 2)
7168 /* Set the frame corresponding to the active tty. Note that the
7169 value of selected_frame is not reliable here, redisplay tends
7170 to temporarily change it. */
7171 buf
.frame_or_window
= tty
->top_frame
;
7174 kbd_buffer_store_event (&buf
);
7175 /* Don't look at input that follows a C-g too closely.
7176 This reduces lossage due to autorepeat on C-g. */
7177 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7178 && buf
.code
== quit_char
)
7185 #if defined SYNC_INPUT || defined SIGIO
7187 handle_async_input (void)
7189 interrupt_input_pending
= 0;
7191 pending_signals
= pending_atimers
;
7193 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7194 doing anything dangerous. */
7201 nread
= read_avail_input (1);
7202 /* -1 means it's not ok to read the input now.
7203 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7204 0 means there was no keyboard input available. */
7212 #endif /* SYNC_INPUT || SIGIO */
7216 process_pending_signals (void)
7218 if (interrupt_input_pending
)
7219 handle_async_input ();
7220 do_pending_atimers ();
7224 #ifdef SIGIO /* for entire page */
7225 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7228 input_available_signal (int signo
)
7230 /* Must preserve main program's value of errno. */
7231 int old_errno
= errno
;
7232 SIGNAL_THREAD_CHECK (signo
);
7235 interrupt_input_pending
= 1;
7236 pending_signals
= 1;
7239 if (input_available_clear_time
)
7240 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7243 handle_async_input ();
7250 /* Send ourselves a SIGIO.
7252 This function exists so that the UNBLOCK_INPUT macro in
7253 blockinput.h can have some way to take care of input we put off
7254 dealing with, without assuming that every file which uses
7255 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7257 reinvoke_input_signal (void)
7260 handle_async_input ();
7266 /* User signal events. */
7268 struct user_signal_info
7270 /* Signal number. */
7273 /* Name of the signal. */
7276 /* Number of pending signals. */
7279 struct user_signal_info
*next
;
7282 /* List of user signals. */
7283 static struct user_signal_info
*user_signals
= NULL
;
7286 add_user_signal (int sig
, const char *name
)
7288 struct user_signal_info
*p
;
7290 for (p
= user_signals
; p
; p
= p
->next
)
7292 /* Already added. */
7295 p
= xmalloc (sizeof (struct user_signal_info
));
7297 p
->name
= xstrdup (name
);
7299 p
->next
= user_signals
;
7302 signal (sig
, handle_user_signal
);
7306 handle_user_signal (int sig
)
7308 int old_errno
= errno
;
7309 struct user_signal_info
*p
;
7310 const char *special_event_name
= NULL
;
7312 SIGNAL_THREAD_CHECK (sig
);
7314 if (SYMBOLP (Vdebug_on_event
))
7315 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7317 for (p
= user_signals
; p
; p
= p
->next
)
7320 if (special_event_name
&&
7321 strcmp (special_event_name
, p
->name
) == 0)
7323 /* Enter the debugger in many ways. */
7324 debug_on_next_call
= 1;
7327 Vinhibit_quit
= Qnil
;
7329 /* Eat the event. */
7335 if (interrupt_input
)
7336 kill (getpid (), SIGIO
);
7340 /* Tell wait_reading_process_output that it needs to wake
7341 up and look around. */
7342 if (input_available_clear_time
)
7343 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7352 find_user_signal_name (int sig
)
7354 struct user_signal_info
*p
;
7356 for (p
= user_signals
; p
; p
= p
->next
)
7364 store_user_signal_events (void)
7366 struct user_signal_info
*p
;
7367 struct input_event buf
;
7370 for (p
= user_signals
; p
; p
= p
->next
)
7371 if (p
->npending
> 0)
7377 memset (&buf
, 0, sizeof buf
);
7378 buf
.kind
= USER_SIGNAL_EVENT
;
7379 buf
.frame_or_window
= selected_frame
;
7381 nstored
+= p
->npending
;
7383 mask
= sigblock (sigmask (p
->sig
));
7387 kbd_buffer_store_event (&buf
);
7390 while (p
->npending
> 0);
7398 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7399 static Lisp_Object menu_bar_one_keymap_changed_items
;
7401 /* These variables hold the vector under construction within
7402 menu_bar_items and its subroutines, and the current index
7403 for storing into that vector. */
7404 static Lisp_Object menu_bar_items_vector
;
7405 static int menu_bar_items_index
;
7408 static const char* separator_names
[] = {
7413 "single-dashed-line",
7414 "double-dashed-line",
7416 "shadow-etched-out",
7417 "shadow-etched-in-dash",
7418 "shadow-etched-out-dash",
7419 "shadow-double-etched-in",
7420 "shadow-double-etched-out",
7421 "shadow-double-etched-in-dash",
7422 "shadow-double-etched-out-dash",
7426 /* Return non-zero if LABEL specifies a separator. */
7429 menu_separator_name_p (const char *label
)
7433 else if (strlen (label
) > 3
7434 && strncmp (label
, "--", 2) == 0
7439 for (i
= 0; separator_names
[i
]; ++i
)
7440 if (strcmp (label
, separator_names
[i
]) == 0)
7445 /* It's a separator if it contains only dashes. */
7446 while (*label
== '-')
7448 return (*label
== 0);
7455 /* Return a vector of menu items for a menu bar, appropriate
7456 to the current buffer. Each item has three elements in the vector:
7459 OLD is an old vector we can optionally reuse, or nil. */
7462 menu_bar_items (Lisp_Object old
)
7464 /* The number of keymaps we're scanning right now, and the number of
7465 keymaps we have allocated space for. */
7468 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7469 in the current keymaps, or nil where it is not a prefix. */
7472 Lisp_Object def
, tail
;
7477 /* In order to build the menus, we need to call the keymap
7478 accessors. They all call QUIT. But this function is called
7479 during redisplay, during which a quit is fatal. So inhibit
7480 quitting while building the menus.
7481 We do this instead of specbind because (1) errors will clear it anyway
7482 and (2) this avoids risk of specpdl overflow. */
7483 oquit
= Vinhibit_quit
;
7487 menu_bar_items_vector
= old
;
7489 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7490 menu_bar_items_index
= 0;
7492 /* Build our list of keymaps.
7493 If we recognize a function key and replace its escape sequence in
7494 keybuf with its symbol, or if the sequence starts with a mouse
7495 click and we need to switch buffers, we jump back here to rebuild
7496 the initial keymaps from the current buffer. */
7500 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7501 if (!NILP (Voverriding_local_map_menu_flag
))
7503 /* Yes, use them (if non-nil) as well as the global map. */
7504 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7506 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7507 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7508 if (!NILP (Voverriding_local_map
))
7509 maps
[nmaps
++] = Voverriding_local_map
;
7513 /* No, so use major and minor mode keymaps and keymap property.
7514 Note that menu-bar bindings in the local-map and keymap
7515 properties may not work reliable, as they are only
7516 recognized when the menu-bar (or mode-line) is updated,
7517 which does not normally happen after every command. */
7520 nminor
= current_minor_maps (NULL
, &tmaps
);
7521 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7523 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7524 maps
[nmaps
++] = tem
;
7525 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7527 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7529 maps
[nmaps
++] = current_global_map
;
7532 /* Look up in each map the dummy prefix key `menu-bar'. */
7534 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7535 if (!NILP (maps
[mapno
]))
7537 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7541 menu_bar_one_keymap_changed_items
= Qnil
;
7542 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7546 /* Move to the end those items that should be at the end. */
7548 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7551 int end
= menu_bar_items_index
;
7553 for (i
= 0; i
< end
; i
+= 4)
7554 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7556 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7557 /* Move the item at index I to the end,
7558 shifting all the others forward. */
7559 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7560 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7561 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7562 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7564 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7565 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7566 (end
- i
- 4) * sizeof (Lisp_Object
));
7567 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7568 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7569 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7570 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7575 /* Add nil, nil, nil, nil at the end. */
7577 int i
= menu_bar_items_index
;
7578 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7579 menu_bar_items_vector
=
7580 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7581 /* Add this item. */
7582 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7583 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7584 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7585 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7586 menu_bar_items_index
= i
;
7589 Vinhibit_quit
= oquit
;
7590 return menu_bar_items_vector
;
7593 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7594 If there's already an item for KEY, add this DEF to it. */
7596 Lisp_Object item_properties
;
7599 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7601 struct gcpro gcpro1
;
7605 if (EQ (item
, Qundefined
))
7607 /* If a map has an explicit `undefined' as definition,
7608 discard any previously made menu bar item. */
7610 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7611 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7613 if (menu_bar_items_index
> i
+ 4)
7614 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7615 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7616 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7617 menu_bar_items_index
-= 4;
7621 /* If this keymap has already contributed to this KEY,
7622 don't contribute to it a second time. */
7623 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7624 if (!NILP (tem
) || NILP (item
))
7627 menu_bar_one_keymap_changed_items
7628 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7630 /* We add to menu_bar_one_keymap_changed_items before doing the
7631 parse_menu_item, so that if it turns out it wasn't a menu item,
7632 it still correctly hides any further menu item. */
7634 i
= parse_menu_item (item
, 1);
7639 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7641 /* Find any existing item for this KEY. */
7642 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7643 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7646 /* If we did not find this KEY, add it at the end. */
7647 if (i
== menu_bar_items_index
)
7649 /* If vector is too small, get a bigger one. */
7650 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7651 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7652 /* Add this item. */
7653 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7654 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7655 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7656 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7657 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7658 menu_bar_items_index
= i
;
7660 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7664 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7665 /* If the new and the old items are not both keymaps,
7666 the lookup will only find `item'. */
7667 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7668 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7672 /* This is used as the handler when calling menu_item_eval_property. */
7674 menu_item_eval_property_1 (Lisp_Object arg
)
7676 /* If we got a quit from within the menu computation,
7677 quit all the way out of it. This takes care of C-] in the debugger. */
7678 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7679 Fsignal (Qquit
, Qnil
);
7685 eval_dyn (Lisp_Object form
)
7687 return Feval (form
, Qnil
);
7690 /* Evaluate an expression and return the result (or nil if something
7691 went wrong). Used to evaluate dynamic parts of menu items. */
7693 menu_item_eval_property (Lisp_Object sexpr
)
7695 int count
= SPECPDL_INDEX ();
7697 specbind (Qinhibit_redisplay
, Qt
);
7698 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7699 menu_item_eval_property_1
);
7700 return unbind_to (count
, val
);
7703 /* This function parses a menu item and leaves the result in the
7704 vector item_properties.
7705 ITEM is a key binding, a possible menu item.
7706 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7708 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7709 parse_menu_item returns true if the item is a menu item and false
7713 parse_menu_item (Lisp_Object item
, int inmenubar
)
7715 Lisp_Object def
, tem
, item_string
, start
;
7717 Lisp_Object keyhint
;
7726 /* Create item_properties vector if necessary. */
7727 if (NILP (item_properties
))
7729 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7731 /* Initialize optional entries. */
7732 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7733 ASET (item_properties
, i
, Qnil
);
7734 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7736 /* Save the item here to protect it from GC. */
7737 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7739 item_string
= XCAR (item
);
7743 if (STRINGP (item_string
))
7745 /* Old format menu item. */
7746 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7748 /* Maybe help string. */
7749 if (CONSP (item
) && STRINGP (XCAR (item
)))
7751 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7756 /* Maybe an obsolete key binding cache. */
7757 if (CONSP (item
) && CONSP (XCAR (item
))
7758 && (NILP (XCAR (XCAR (item
)))
7759 || VECTORP (XCAR (XCAR (item
)))))
7762 /* This is the real definition--the function to run. */
7763 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7765 /* Get enable property, if any. */
7768 tem
= Fget (item
, Qmenu_enable
);
7769 if (!NILP (Venable_disabled_menus_and_buttons
))
7770 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7771 else if (!NILP (tem
))
7772 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7775 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7777 /* New format menu item. */
7778 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7779 start
= XCDR (item
);
7782 /* We have a real binding. */
7783 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7785 item
= XCDR (start
);
7786 /* Is there an obsolete cache list with key equivalences. */
7787 if (CONSP (item
) && CONSP (XCAR (item
)))
7790 /* Parse properties. */
7791 while (CONSP (item
) && CONSP (XCDR (item
)))
7796 if (EQ (tem
, QCenable
))
7798 if (!NILP (Venable_disabled_menus_and_buttons
))
7799 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7801 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7803 else if (EQ (tem
, QCvisible
))
7805 /* If got a visible property and that evaluates to nil
7806 then ignore this item. */
7807 tem
= menu_item_eval_property (XCAR (item
));
7811 else if (EQ (tem
, QChelp
))
7812 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7813 else if (EQ (tem
, QCfilter
))
7815 else if (EQ (tem
, QCkey_sequence
))
7818 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7819 /* Be GC protected. Set keyhint to item instead of tem. */
7822 else if (EQ (tem
, QCkeys
))
7825 if (CONSP (tem
) || STRINGP (tem
))
7826 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7828 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7833 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7835 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7837 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7843 else if (inmenubar
|| !NILP (start
))
7847 return 0; /* not a menu item */
7849 /* If item string is not a string, evaluate it to get string.
7850 If we don't get a string, skip this item. */
7851 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7852 if (!(STRINGP (item_string
)))
7854 item_string
= menu_item_eval_property (item_string
);
7855 if (!STRINGP (item_string
))
7857 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7860 /* If got a filter apply it on definition. */
7861 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7864 def
= menu_item_eval_property (list2 (XCAR (filter
),
7865 list2 (Qquote
, def
)));
7867 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7870 /* Enable or disable selection of item. */
7871 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7874 tem
= menu_item_eval_property (tem
);
7875 if (inmenubar
&& NILP (tem
))
7876 return 0; /* Ignore disabled items in menu bar. */
7877 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7880 /* If we got no definition, this item is just unselectable text which
7881 is OK in a submenu but not in the menubar. */
7883 return (!inmenubar
);
7885 /* See if this is a separate pane or a submenu. */
7886 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7887 tem
= get_keymap (def
, 0, 1);
7888 /* For a subkeymap, just record its details and exit. */
7891 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7892 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7896 /* At the top level in the menu bar, do likewise for commands also.
7897 The menu bar does not display equivalent key bindings anyway.
7898 ITEM_PROPERTY_DEF is already set up properly. */
7902 { /* This is a command. See if there is an equivalent key binding. */
7903 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7905 /* The previous code preferred :key-sequence to :keys, so we
7906 preserve this behavior. */
7907 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7908 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7911 Lisp_Object prefix
= keyeq
;
7912 Lisp_Object keys
= Qnil
;
7916 def
= XCAR (prefix
);
7917 prefix
= XCDR (prefix
);
7920 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7922 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7924 keys
= XCAR (keyhint
);
7925 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7927 /* We have a suggested key. Is it bound to the command? */
7930 /* If the command is an alias for another
7931 (such as lmenu.el set it up), check if the
7932 original command matches the cached command. */
7933 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7938 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7942 tem
= Fkey_description (keys
, Qnil
);
7945 if (STRINGP (XCAR (prefix
)))
7946 tem
= concat2 (XCAR (prefix
), tem
);
7947 if (STRINGP (XCDR (prefix
)))
7948 tem
= concat2 (tem
, XCDR (prefix
));
7950 keyeq
= concat2 (build_string (" "), tem
);
7951 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7957 /* If we have an equivalent key binding, use that. */
7958 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7961 /* Include this when menu help is implemented.
7962 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7963 if (!(NILP (tem) || STRINGP (tem)))
7965 tem = menu_item_eval_property (tem);
7968 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7972 /* Handle radio buttons or toggle boxes. */
7973 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7975 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7976 menu_item_eval_property (tem
));
7983 /***********************************************************************
7985 ***********************************************************************/
7987 /* A vector holding tool bar items while they are parsed in function
7988 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7991 static Lisp_Object tool_bar_items_vector
;
7993 /* A vector holding the result of parse_tool_bar_item. Layout is like
7994 the one for a single item in tool_bar_items_vector. */
7996 static Lisp_Object tool_bar_item_properties
;
7998 /* Next free index in tool_bar_items_vector. */
8000 static int ntool_bar_items
;
8002 /* The symbols `:image' and `:rtl'. */
8004 static Lisp_Object QCimage
;
8005 static Lisp_Object QCrtl
;
8007 /* Function prototypes. */
8009 static void init_tool_bar_items (Lisp_Object
);
8010 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8011 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8012 static void append_tool_bar_item (void);
8015 /* Return a vector of tool bar items for keymaps currently in effect.
8016 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8017 tool bar items found. */
8020 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8029 /* In order to build the menus, we need to call the keymap
8030 accessors. They all call QUIT. But this function is called
8031 during redisplay, during which a quit is fatal. So inhibit
8032 quitting while building the menus. We do this instead of
8033 specbind because (1) errors will clear it anyway and (2) this
8034 avoids risk of specpdl overflow. */
8035 oquit
= Vinhibit_quit
;
8038 /* Initialize tool_bar_items_vector and protect it from GC. */
8039 init_tool_bar_items (reuse
);
8041 /* Build list of keymaps in maps. Set nmaps to the number of maps
8044 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8045 if (!NILP (Voverriding_local_map_menu_flag
))
8047 /* Yes, use them (if non-nil) as well as the global map. */
8048 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8050 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8051 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8052 if (!NILP (Voverriding_local_map
))
8053 maps
[nmaps
++] = Voverriding_local_map
;
8057 /* No, so use major and minor mode keymaps and keymap property.
8058 Note that tool-bar bindings in the local-map and keymap
8059 properties may not work reliable, as they are only
8060 recognized when the tool-bar (or mode-line) is updated,
8061 which does not normally happen after every command. */
8064 nminor
= current_minor_maps (NULL
, &tmaps
);
8065 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8067 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8068 maps
[nmaps
++] = tem
;
8069 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8071 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8074 /* Add global keymap at the end. */
8075 maps
[nmaps
++] = current_global_map
;
8077 /* Process maps in reverse order and look up in each map the prefix
8079 for (i
= nmaps
- 1; i
>= 0; --i
)
8080 if (!NILP (maps
[i
]))
8084 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8086 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8089 Vinhibit_quit
= oquit
;
8090 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8091 return tool_bar_items_vector
;
8095 /* Process the definition of KEY which is DEF. */
8098 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8101 struct gcpro gcpro1
, gcpro2
;
8103 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8107 if (EQ (def
, Qundefined
))
8109 /* If a map has an explicit `undefined' as definition,
8110 discard any previously made item. */
8111 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8113 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8115 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8117 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8118 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8119 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8120 * sizeof (Lisp_Object
)));
8121 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8126 else if (parse_tool_bar_item (key
, def
))
8127 /* Append a new tool bar item to tool_bar_items_vector. Accept
8128 more than one definition for the same key. */
8129 append_tool_bar_item ();
8135 /* Parse a tool bar item specification ITEM for key KEY and return the
8136 result in tool_bar_item_properties. Value is zero if ITEM is
8139 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8141 CAPTION is the caption of the item, If it's not a string, it is
8142 evaluated to get a string.
8144 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8145 as binding are currently ignored.
8147 The following properties are recognized:
8151 FORM is evaluated and specifies whether the tool bar item is
8152 enabled or disabled.
8156 FORM is evaluated and specifies whether the tool bar item is visible.
8158 - `:filter FUNCTION'
8160 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8161 result is stored as the new binding.
8163 - `:button (TYPE SELECTED)'
8165 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8166 and specifies whether the button is selected (pressed) or not.
8170 IMAGES is either a single image specification or a vector of four
8171 image specifications. See enum tool_bar_item_images.
8173 - `:help HELP-STRING'.
8175 Gives a help string to display for the tool bar item.
8177 - `:label LABEL-STRING'.
8179 A text label to show with the tool bar button if labels are enabled. */
8182 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8184 /* Access slot with index IDX of vector tool_bar_item_properties. */
8185 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8187 Lisp_Object filter
= Qnil
;
8188 Lisp_Object caption
;
8189 int i
, have_label
= 0;
8191 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8192 Rule out items that aren't lists, don't start with
8193 `menu-item' or whose rest following `tool-bar-item' is not a
8198 /* As an exception, allow old-style menu separators. */
8199 if (STRINGP (XCAR (item
)))
8200 item
= Fcons (XCAR (item
), Qnil
);
8201 else if (!EQ (XCAR (item
), Qmenu_item
)
8202 || (item
= XCDR (item
), !CONSP (item
)))
8205 /* Create tool_bar_item_properties vector if necessary. Reset it to
8207 if (VECTORP (tool_bar_item_properties
))
8209 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8213 tool_bar_item_properties
8214 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8217 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8218 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8220 /* Get the caption of the item. If the caption is not a string,
8221 evaluate it to get a string. If we don't get a string, skip this
8223 caption
= XCAR (item
);
8224 if (!STRINGP (caption
))
8226 caption
= menu_item_eval_property (caption
);
8227 if (!STRINGP (caption
))
8230 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8232 /* If the rest following the caption is not a list, the menu item is
8233 either a separator, or invalid. */
8237 if (menu_separator_name_p (SSDATA (caption
)))
8239 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8240 #if !defined (USE_GTK) && !defined (HAVE_NS)
8241 /* If we use build_desired_tool_bar_string to render the
8242 tool bar, the separator is rendered as an image. */
8243 PROP (TOOL_BAR_ITEM_IMAGES
)
8244 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8245 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8246 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8247 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8254 /* Store the binding. */
8255 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8258 /* Ignore cached key binding, if any. */
8259 if (CONSP (item
) && CONSP (XCAR (item
)))
8262 /* Process the rest of the properties. */
8263 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8265 Lisp_Object ikey
, value
;
8268 value
= XCAR (XCDR (item
));
8270 if (EQ (ikey
, QCenable
))
8272 /* `:enable FORM'. */
8273 if (!NILP (Venable_disabled_menus_and_buttons
))
8274 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8276 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8278 else if (EQ (ikey
, QCvisible
))
8280 /* `:visible FORM'. If got a visible property and that
8281 evaluates to nil then ignore this item. */
8282 if (NILP (menu_item_eval_property (value
)))
8285 else if (EQ (ikey
, QChelp
))
8286 /* `:help HELP-STRING'. */
8287 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8288 else if (EQ (ikey
, QCvert_only
))
8289 /* `:vert-only t/nil'. */
8290 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8291 else if (EQ (ikey
, QClabel
))
8293 const char *bad_label
= "!!?GARBLED ITEM?!!";
8294 /* `:label LABEL-STRING'. */
8295 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8297 : build_string (bad_label
);
8300 else if (EQ (ikey
, QCfilter
))
8301 /* ':filter FORM'. */
8303 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8305 /* `:button (TYPE . SELECTED)'. */
8306 Lisp_Object type
, selected
;
8308 type
= XCAR (value
);
8309 selected
= XCDR (value
);
8310 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8312 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8313 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8316 else if (EQ (ikey
, QCimage
)
8318 || (VECTORP (value
) && ASIZE (value
) == 4)))
8319 /* Value is either a single image specification or a vector
8320 of 4 such specifications for the different button states. */
8321 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8322 else if (EQ (ikey
, QCrtl
))
8324 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8330 /* Try to make one from caption and key. */
8331 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8332 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8333 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8334 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8336 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8337 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8338 Lisp_Object new_lbl
;
8339 ptrdiff_t caption_len
= strlen (capt
);
8341 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8344 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8346 buf
[caption_len
] = '\0';
8350 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8354 strcpy (buf
, label
);
8356 for (j
= 0; buf
[j
] != '\0'; ++j
)
8364 new_lbl
= Fupcase_initials (build_string (label
));
8365 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8366 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8368 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8372 /* If got a filter apply it on binding. */
8374 PROP (TOOL_BAR_ITEM_BINDING
)
8375 = menu_item_eval_property (list2 (filter
,
8377 PROP (TOOL_BAR_ITEM_BINDING
))));
8379 /* See if the binding is a keymap. Give up if it is. */
8380 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8383 /* Enable or disable selection of item. */
8384 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8385 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8386 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8388 /* Handle radio buttons or toggle boxes. */
8389 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8390 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8391 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8399 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8400 that can be reused. */
8403 init_tool_bar_items (Lisp_Object reuse
)
8405 if (VECTORP (reuse
))
8406 tool_bar_items_vector
= reuse
;
8408 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8409 ntool_bar_items
= 0;
8413 /* Append parsed tool bar item properties from
8414 tool_bar_item_properties */
8417 append_tool_bar_item (void)
8419 Lisp_Object
*to
, *from
;
8421 /* Enlarge tool_bar_items_vector if necessary. */
8422 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8423 >= ASIZE (tool_bar_items_vector
))
8424 tool_bar_items_vector
8425 = larger_vector (tool_bar_items_vector
,
8426 2 * ASIZE (tool_bar_items_vector
), Qnil
);
8428 /* Append entries from tool_bar_item_properties to the end of
8429 tool_bar_items_vector. */
8430 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8431 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8432 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8433 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8440 /* Read a character using menus based on maps in the array MAPS.
8441 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8442 Return t if we displayed a menu but the user rejected it.
8444 PREV_EVENT is the previous input event, or nil if we are reading
8445 the first event of a key sequence.
8447 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8448 if we used a mouse menu to read the input, or zero otherwise. If
8449 USED_MOUSE_MENU is null, we don't dereference it.
8451 The prompting is done based on the prompt-string of the map
8452 and the strings associated with various map elements.
8454 This can be done with X menus or with menus put in the minibuf.
8455 These are done in different ways, depending on how the input will be read.
8456 Menus using X are done after auto-saving in read-char, getting the input
8457 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8458 and do auto-saving in the inner call of read_char. */
8461 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8462 Lisp_Object prev_event
, int *used_mouse_menu
)
8466 if (used_mouse_menu
)
8467 *used_mouse_menu
= 0;
8469 /* Use local over global Menu maps */
8471 if (! menu_prompting
)
8474 /* Optionally disregard all but the global map. */
8475 if (inhibit_local_menu_bar_menus
)
8477 maps
+= (nmaps
- 1);
8482 /* If we got to this point via a mouse click,
8483 use a real menu for mouse selection. */
8484 if (EVENT_HAS_PARAMETERS (prev_event
)
8485 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8486 && !EQ (XCAR (prev_event
), Qtool_bar
))
8488 /* Display the menu and get the selection. */
8489 Lisp_Object
*realmaps
8490 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8492 ptrdiff_t nmaps1
= 0;
8494 /* Use the maps that are not nil. */
8495 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8496 if (!NILP (maps
[mapno
]))
8497 realmaps
[nmaps1
++] = maps
[mapno
];
8499 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8504 record_menu_key (XCAR (value
));
8506 /* If we got multiple events, unread all but
8508 There is no way to prevent those unread events
8509 from showing up later in last_nonmenu_event.
8510 So turn symbol and integer events into lists,
8511 to indicate that they came from a mouse menu,
8512 so that when present in last_nonmenu_event
8513 they won't confuse things. */
8514 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8516 record_menu_key (XCAR (tem
));
8517 if (SYMBOLP (XCAR (tem
))
8518 || INTEGERP (XCAR (tem
)))
8519 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8522 /* If we got more than one event, put all but the first
8523 onto this list to be read later.
8524 Return just the first event now. */
8525 Vunread_command_events
8526 = nconc2 (XCDR (value
), Vunread_command_events
);
8527 value
= XCAR (value
);
8529 else if (NILP (value
))
8531 if (used_mouse_menu
)
8532 *used_mouse_menu
= 1;
8535 #endif /* HAVE_MENUS */
8539 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8540 We make this bigger when necessary, and never free it. */
8541 static char *read_char_minibuf_menu_text
;
8542 /* Size of that buffer. */
8543 static ptrdiff_t read_char_minibuf_menu_width
;
8546 read_char_minibuf_menu_prompt (int commandflag
,
8547 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8550 register Lisp_Object name
;
8552 /* FIXME: Use the minibuffer's frame width. */
8553 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8556 Lisp_Object rest
, vector
;
8562 if (! menu_prompting
)
8565 /* Get the menu name from the first map that has one (a prompt string). */
8566 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8568 name
= Fkeymap_prompt (maps
[mapno
]);
8573 /* If we don't have any menus, just read a character normally. */
8574 if (!STRINGP (name
))
8577 /* Make sure we have a big enough buffer for the menu text. */
8578 width
= max (width
, SBYTES (name
));
8579 if (STRING_BYTES_BOUND
- 4 < width
)
8580 memory_full (SIZE_MAX
);
8581 if (width
+ 4 > read_char_minibuf_menu_width
)
8583 read_char_minibuf_menu_text
8584 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8585 read_char_minibuf_menu_width
= width
+ 4;
8587 menu
= read_char_minibuf_menu_text
;
8589 /* Prompt string always starts with map's prompt, and a space. */
8590 strcpy (menu
, SSDATA (name
));
8591 nlength
= SBYTES (name
);
8592 menu
[nlength
++] = ':';
8593 menu
[nlength
++] = ' ';
8596 /* Start prompting at start of first map. */
8600 /* Present the documented bindings, a line at a time. */
8604 ptrdiff_t i
= nlength
;
8606 Lisp_Object orig_defn_macro
;
8608 /* Loop over elements of map. */
8613 /* If reached end of map, start at beginning of next map. */
8617 /* At end of last map, wrap around to first map if just starting,
8618 or end this line if already have something on it. */
8622 if (notfirst
|| nobindings
) break;
8627 /* Look at the next element of the map. */
8629 elt
= XVECTOR (vector
)->contents
[idx
];
8631 elt
= Fcar_safe (rest
);
8633 if (idx
< 0 && VECTORP (elt
))
8635 /* If we found a dense table in the keymap,
8636 advanced past it, but start scanning its contents. */
8637 rest
= Fcdr_safe (rest
);
8643 /* An ordinary element. */
8644 Lisp_Object event
, tem
;
8648 event
= Fcar_safe (elt
); /* alist */
8649 elt
= Fcdr_safe (elt
);
8653 XSETINT (event
, idx
); /* vector */
8656 /* Ignore the element if it has no prompt string. */
8657 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8659 /* 1 if the char to type matches the string. */
8661 Lisp_Object upcased_event
, downcased_event
;
8662 Lisp_Object desc
= Qnil
;
8664 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8666 upcased_event
= Fupcase (event
);
8667 downcased_event
= Fdowncase (event
);
8668 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8669 || XINT (downcased_event
) == SREF (s
, 0));
8671 desc
= Fsingle_key_description (event
, Qnil
);
8673 #if 0 /* It is redundant to list the equivalent key bindings because
8674 the prefix is what the user has already typed. */
8676 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8678 /* Insert equivalent keybinding. */
8679 s
= concat2 (s
, tem
);
8682 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8683 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8685 /* Insert button prefix. */
8686 Lisp_Object selected
8687 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8688 if (EQ (tem
, QCradio
))
8689 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8691 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8692 s
= concat2 (tem
, s
);
8696 /* If we have room for the prompt string, add it to this line.
8697 If this is the first on the line, always add it. */
8698 if ((SCHARS (s
) + i
+ 2
8699 + (char_matches
? 0 : SCHARS (desc
) + 3))
8703 ptrdiff_t thiswidth
;
8705 /* Punctuate between strings. */
8708 strcpy (menu
+ i
, ", ");
8714 /* If the char to type doesn't match the string's
8715 first char, explicitly show what char to type. */
8718 /* Add as much of string as fits. */
8719 thiswidth
= min (SCHARS (desc
), width
- i
);
8720 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8722 strcpy (menu
+ i
, " = ");
8726 /* Add as much of string as fits. */
8727 thiswidth
= min (SCHARS (s
), width
- i
);
8728 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8734 /* If this element does not fit, end the line now,
8735 and save the element for the next line. */
8736 strcpy (menu
+ i
, "...");
8741 /* Move past this element. */
8742 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8743 /* Handle reaching end of dense table. */
8748 rest
= Fcdr_safe (rest
);
8752 /* Prompt with that and read response. */
8753 message2_nolog (menu
, strlen (menu
),
8754 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8756 /* Make believe its not a keyboard macro in case the help char
8757 is pressed. Help characters are not recorded because menu prompting
8758 is not used on replay.
8760 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8761 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8763 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8764 while (BUFFERP (obj
));
8765 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8767 if (!INTEGERP (obj
))
8769 else if (XINT (obj
) == -2)
8772 if (! EQ (obj
, menu_prompt_more_char
)
8773 && (!INTEGERP (menu_prompt_more_char
)
8774 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8776 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8777 store_kbd_macro_char (obj
);
8780 /* Help char - go round again */
8784 /* Reading key sequences. */
8786 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8787 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8788 keymap, or nil otherwise. Return the index of the first keymap in
8789 which KEY has any binding, or NMAPS if no map has a binding.
8791 If KEY is a meta ASCII character, treat it like meta-prefix-char
8792 followed by the corresponding non-meta character. Keymaps in
8793 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8796 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8799 NEXT may be the same array as CURRENT. */
8802 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8803 Lisp_Object
*defs
, Lisp_Object
*next
)
8805 ptrdiff_t i
, first_binding
;
8807 first_binding
= nmaps
;
8808 for (i
= nmaps
- 1; i
>= 0; i
--)
8810 if (! NILP (current
[i
]))
8812 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8813 if (! NILP (defs
[i
]))
8820 /* Given the set of bindings we've found, produce the next set of maps. */
8821 if (first_binding
< nmaps
)
8822 for (i
= 0; i
< nmaps
; i
++)
8823 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8825 return first_binding
;
8828 /* Structure used to keep track of partial application of key remapping
8829 such as Vfunction_key_map and Vkey_translation_map. */
8830 typedef struct keyremap
8832 /* This is the map originally specified for this use. */
8834 /* This is a submap reached by looking up, in PARENT,
8835 the events from START to END. */
8837 /* Positions [START, END) in the key sequence buffer
8838 are the key that we have scanned so far.
8839 Those events are the ones that we will replace
8840 if PARENT maps them into a key sequence. */
8844 /* Lookup KEY in MAP.
8845 MAP is a keymap mapping keys to key vectors or functions.
8846 If the mapping is a function and DO_FUNCTION is non-zero, then
8847 the function is called with PROMPT as parameter and its return
8848 value is used as the return value of this function (after checking
8849 that it is indeed a vector). */
8852 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8857 next
= access_keymap (map
, key
, 1, 0, 1);
8859 /* Handle symbol with autoload definition. */
8860 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8861 && CONSP (XSYMBOL (next
)->function
)
8862 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8863 do_autoload (XSYMBOL (next
)->function
, next
);
8865 /* Handle a symbol whose function definition is a keymap
8867 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8868 && (ARRAYP (XSYMBOL (next
)->function
)
8869 || KEYMAPP (XSYMBOL (next
)->function
)))
8870 next
= XSYMBOL (next
)->function
;
8872 /* If the keymap gives a function, not an
8873 array, then call the function with one arg and use
8874 its value instead. */
8875 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8880 next
= call1 (next
, prompt
);
8881 /* If the function returned something invalid,
8882 barf--don't ignore it.
8883 (To ignore it safely, we would need to gcpro a bunch of
8884 other variables.) */
8885 if (! (VECTORP (next
) || STRINGP (next
)))
8886 error ("Function %s returns invalid key sequence",
8887 SSDATA (SYMBOL_NAME (tem
)));
8892 /* Do one step of the key remapping used for function-key-map and
8893 key-translation-map:
8894 KEYBUF is the buffer holding the input events.
8895 BUFSIZE is its maximum size.
8896 FKEY is a pointer to the keyremap structure to use.
8897 INPUT is the index of the last element in KEYBUF.
8898 DOIT if non-zero says that the remapping can actually take place.
8899 DIFF is used to return the number of keys added/removed by the remapping.
8900 PARENT is the root of the keymap.
8901 PROMPT is the prompt to use if the remapping happens through a function.
8902 The return value is non-zero if the remapping actually took place. */
8905 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8906 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8908 Lisp_Object next
, key
;
8910 key
= keybuf
[fkey
->end
++];
8912 if (KEYMAPP (fkey
->parent
))
8913 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8917 /* If keybuf[fkey->start..fkey->end] is bound in the
8918 map and we're in a position to do the key remapping, replace it with
8919 the binding and restart with fkey->start at the end. */
8920 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8922 int len
= XFASTINT (Flength (next
));
8925 *diff
= len
- (fkey
->end
- fkey
->start
);
8927 if (bufsize
- input
<= *diff
)
8928 error ("Key sequence too long");
8930 /* Shift the keys that follow fkey->end. */
8932 for (i
= fkey
->end
; i
< input
; i
++)
8933 keybuf
[i
+ *diff
] = keybuf
[i
];
8935 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8936 keybuf
[i
+ *diff
] = keybuf
[i
];
8937 /* Overwrite the old keys with the new ones. */
8938 for (i
= 0; i
< len
; i
++)
8939 keybuf
[fkey
->start
+ i
]
8940 = Faref (next
, make_number (i
));
8942 fkey
->start
= fkey
->end
+= *diff
;
8943 fkey
->map
= fkey
->parent
;
8948 fkey
->map
= get_keymap (next
, 0, 1);
8950 /* If we no longer have a bound suffix, try a new position for
8952 if (!CONSP (fkey
->map
))
8954 fkey
->end
= ++fkey
->start
;
8955 fkey
->map
= fkey
->parent
;
8961 test_undefined (Lisp_Object binding
)
8963 return (EQ (binding
, Qundefined
)
8964 || (!NILP (binding
) && SYMBOLP (binding
)
8965 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8968 /* Read a sequence of keys that ends with a non prefix character,
8969 storing it in KEYBUF, a buffer of size BUFSIZE.
8971 Return the length of the key sequence stored.
8972 Return -1 if the user rejected a command menu.
8974 Echo starting immediately unless `prompt' is 0.
8976 Where a key sequence ends depends on the currently active keymaps.
8977 These include any minor mode keymaps active in the current buffer,
8978 the current buffer's local map, and the global map.
8980 If a key sequence has no other bindings, we check Vfunction_key_map
8981 to see if some trailing subsequence might be the beginning of a
8982 function key's sequence. If so, we try to read the whole function
8983 key, and substitute its symbolic name into the key sequence.
8985 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8986 `double-' events into similar click events, if that would make them
8987 bound. We try to turn `triple-' events first into `double-' events,
8990 If we get a mouse click in a mode line, vertical divider, or other
8991 non-text area, we treat the click as if it were prefixed by the
8992 symbol denoting that area - `mode-line', `vertical-line', or
8995 If the sequence starts with a mouse click, we read the key sequence
8996 with respect to the buffer clicked on, not the current buffer.
8998 If the user switches frames in the midst of a key sequence, we put
8999 off the switch-frame event until later; the next call to
9000 read_char will return it.
9002 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9003 from the selected window's buffer. */
9006 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9007 int dont_downcase_last
, int can_return_switch_frame
,
9008 int fix_current_buffer
)
9010 Lisp_Object from_string
;
9011 int count
= SPECPDL_INDEX ();
9013 /* How many keys there are in the current key sequence. */
9016 /* The length of the echo buffer when we started reading, and
9017 the length of this_command_keys when we started reading. */
9018 int echo_start
IF_LINT (= 0);
9021 /* The number of keymaps we're scanning right now, and the number of
9022 keymaps we have allocated space for. */
9024 ptrdiff_t nmaps_allocated
= 0;
9026 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9027 the current keymaps. */
9028 Lisp_Object
*defs
= NULL
;
9030 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9031 in the current keymaps, or nil where it is not a prefix. */
9032 Lisp_Object
*submaps
= NULL
;
9034 /* The local map to start out with at start of key sequence. */
9035 Lisp_Object orig_local_map
;
9037 /* The map from the `keymap' property to start out with at start of
9039 Lisp_Object orig_keymap
;
9041 /* 1 if we have already considered switching to the local-map property
9042 of the place where a mouse click occurred. */
9043 int localized_local_map
= 0;
9045 /* The index in submaps[] of the first keymap that has a binding for
9046 this key sequence. In other words, the lowest i such that
9047 submaps[i] is non-nil. */
9048 ptrdiff_t first_binding
;
9049 /* Index of the first key that has no binding.
9050 It is useless to try fkey.start larger than that. */
9053 /* If t < mock_input, then KEYBUF[t] should be read as the next
9056 We use this to recover after recognizing a function key. Once we
9057 realize that a suffix of the current key sequence is actually a
9058 function key's escape sequence, we replace the suffix with the
9059 function key's binding from Vfunction_key_map. Now keybuf
9060 contains a new and different key sequence, so the echo area,
9061 this_command_keys, and the submaps and defs arrays are wrong. In
9062 this situation, we set mock_input to t, set t to 0, and jump to
9063 restart_sequence; the loop will read keys from keybuf up until
9064 mock_input, thus rebuilding the state; and then it will resume
9065 reading characters from the keyboard. */
9068 /* If the sequence is unbound in submaps[], then
9069 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9070 and fkey.map is its binding.
9072 These might be > t, indicating that all function key scanning
9073 should hold off until t reaches them. We do this when we've just
9074 recognized a function key, to avoid searching for the function
9075 key's again in Vfunction_key_map. */
9078 /* Likewise, for key_translation_map and input-decode-map. */
9079 keyremap keytran
, indec
;
9081 /* Non-zero if we are trying to map a key by changing an upper-case
9082 letter to lower case, or a shifted function key to an unshifted
9084 int shift_translated
= 0;
9086 /* If we receive a `switch-frame' or `select-window' event in the middle of
9087 a key sequence, we put it off for later.
9088 While we're reading, we keep the event here. */
9089 Lisp_Object delayed_switch_frame
;
9091 /* See the comment below... */
9092 #if defined (GOBBLE_FIRST_EVENT)
9093 Lisp_Object first_event
;
9096 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9097 int original_uppercase_position
= -1;
9099 /* Gets around Microsoft compiler limitations. */
9102 struct buffer
*starting_buffer
;
9104 /* List of events for which a fake prefix key has been generated. */
9105 Lisp_Object fake_prefixed_keys
= Qnil
;
9107 #if defined (GOBBLE_FIRST_EVENT)
9111 struct gcpro gcpro1
;
9113 GCPRO1 (fake_prefixed_keys
);
9114 raw_keybuf_count
= 0;
9116 last_nonmenu_event
= Qnil
;
9118 delayed_switch_frame
= Qnil
;
9124 /* Install the string STR as the beginning of the string of
9125 echoing, so that it serves as a prompt for the next
9127 KVAR (current_kboard
, echo_string
) = prompt
;
9128 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9131 else if (cursor_in_echo_area
9132 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9133 && NILP (Fzerop (Vecho_keystrokes
)))
9134 /* This doesn't put in a dash if the echo buffer is empty, so
9135 you don't always see a dash hanging out in the minibuffer. */
9139 /* Record the initial state of the echo area and this_command_keys;
9140 we will need to restore them if we replay a key sequence. */
9142 echo_start
= echo_length ();
9143 keys_start
= this_command_key_count
;
9144 this_single_command_key_start
= keys_start
;
9146 #if defined (GOBBLE_FIRST_EVENT)
9147 /* This doesn't quite work, because some of the things that read_char
9148 does cannot safely be bypassed. It seems too risky to try to make
9151 /* Read the first char of the sequence specially, before setting
9152 up any keymaps, in case a filter runs and switches buffers on us. */
9153 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9155 #endif /* GOBBLE_FIRST_EVENT */
9157 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9158 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9161 /* We jump here when we need to reinitialize fkey and keytran; this
9162 happens if we switch keyboards between rescans. */
9163 replay_entire_sequence
:
9165 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9166 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9167 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9168 indec
.start
= indec
.end
= 0;
9169 fkey
.start
= fkey
.end
= 0;
9170 keytran
.start
= keytran
.end
= 0;
9172 /* We jump here when the key sequence has been thoroughly changed, and
9173 we need to rescan it starting from the beginning. When we jump here,
9174 keybuf[0..mock_input] holds the sequence we should reread. */
9177 starting_buffer
= current_buffer
;
9178 first_unbound
= bufsize
+ 1;
9180 /* Build our list of keymaps.
9181 If we recognize a function key and replace its escape sequence in
9182 keybuf with its symbol, or if the sequence starts with a mouse
9183 click and we need to switch buffers, we jump back here to rebuild
9184 the initial keymaps from the current buffer. */
9187 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_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
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9197 else if (!NILP (Voverriding_local_map
))
9199 if (2 > nmaps_allocated
)
9201 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9202 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9203 nmaps_allocated
= 2;
9205 submaps
[nmaps
++] = Voverriding_local_map
;
9213 nminor
= current_minor_maps (0, &maps
);
9214 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9216 if (total
> nmaps_allocated
)
9218 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9219 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9220 nmaps_allocated
= total
;
9223 if (!NILP (orig_keymap
))
9224 submaps
[nmaps
++] = orig_keymap
;
9226 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9230 submaps
[nmaps
++] = orig_local_map
;
9232 submaps
[nmaps
++] = current_global_map
;
9234 /* Find an accurate initial value for first_binding. */
9235 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9236 if (! NILP (submaps
[first_binding
]))
9239 /* Start from the beginning in keybuf. */
9242 /* These are no-ops the first time through, but if we restart, they
9243 revert the echo area and this_command_keys to their original state. */
9244 this_command_key_count
= keys_start
;
9245 if (INTERACTIVE
&& t
< mock_input
)
9246 echo_truncate (echo_start
);
9248 /* If the best binding for the current key sequence is a keymap, or
9249 we may be looking at a function key's escape sequence, keep on
9251 while (first_binding
< nmaps
9252 /* Keep reading as long as there's a prefix binding. */
9253 ? !NILP (submaps
[first_binding
])
9254 /* Don't return in the middle of a possible function key sequence,
9255 if the only bindings we found were via case conversion.
9256 Thus, if ESC O a has a function-key-map translation
9257 and ESC o has a binding, don't return after ESC O,
9258 so that we can translate ESC O plus the next character. */
9259 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9262 int used_mouse_menu
= 0;
9264 /* Where the last real key started. If we need to throw away a
9265 key that has expanded into more than one element of keybuf
9266 (say, a mouse click on the mode line which is being treated
9267 as [mode-line (mouse-...)], then we backtrack to this point
9269 int last_real_key_start
;
9271 /* These variables are analogous to echo_start and keys_start;
9272 while those allow us to restart the entire key sequence,
9273 echo_local_start and keys_local_start allow us to throw away
9275 int echo_local_start
IF_LINT (= 0);
9276 int keys_local_start
;
9277 ptrdiff_t local_first_binding
;
9279 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9280 eassert (indec
.start
<= indec
.end
);
9281 eassert (fkey
.start
<= fkey
.end
);
9282 eassert (keytran
.start
<= keytran
.end
);
9283 /* key-translation-map is applied *after* function-key-map
9284 which is itself applied *after* input-decode-map. */
9285 eassert (fkey
.end
<= indec
.start
);
9286 eassert (keytran
.end
<= fkey
.start
);
9288 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9289 first_unbound
< keytran
.start
)
9290 { /* The prefix upto first_unbound has no binding and has
9291 no translation left to do either, so we know it's unbound.
9292 If we don't stop now, we risk staying here indefinitely
9293 (if the user keeps entering fkey or keytran prefixes
9294 like C-c ESC ESC ESC ESC ...) */
9296 for (i
= first_unbound
+ 1; i
< t
; i
++)
9297 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9298 mock_input
= t
- first_unbound
- 1;
9299 indec
.end
= indec
.start
-= first_unbound
+ 1;
9300 indec
.map
= indec
.parent
;
9301 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9302 fkey
.map
= fkey
.parent
;
9303 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9304 keytran
.map
= keytran
.parent
;
9305 goto replay_sequence
;
9309 error ("Key sequence too long");
9312 echo_local_start
= echo_length ();
9313 keys_local_start
= this_command_key_count
;
9314 local_first_binding
= first_binding
;
9317 /* These are no-ops, unless we throw away a keystroke below and
9318 jumped back up to replay_key; in that case, these restore the
9319 variables to their original state, allowing us to replay the
9321 if (INTERACTIVE
&& t
< mock_input
)
9322 echo_truncate (echo_local_start
);
9323 this_command_key_count
= keys_local_start
;
9324 first_binding
= local_first_binding
;
9326 /* By default, assume each event is "real". */
9327 last_real_key_start
= t
;
9329 /* Does mock_input indicate that we are re-reading a key sequence? */
9333 add_command_key (key
);
9334 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9335 && NILP (Fzerop (Vecho_keystrokes
)))
9339 /* If not, we should actually read a character. */
9343 KBOARD
*interrupted_kboard
= current_kboard
;
9344 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9345 key
= read_char (NILP (prompt
), nmaps
,
9346 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9347 &used_mouse_menu
, NULL
);
9348 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9349 /* When switching to a new tty (with a new keyboard),
9350 read_char returns the new buffer, rather than -2
9351 (Bug#5095). This is because `terminal-init-xterm'
9352 calls read-char, which eats the wrong_kboard_jmpbuf
9353 return. Any better way to fix this? -- cyd */
9354 || (interrupted_kboard
!= current_kboard
))
9359 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9360 if (k
== interrupted_kboard
)
9365 /* Don't touch interrupted_kboard when it's been
9367 delayed_switch_frame
= Qnil
;
9368 goto replay_entire_sequence
;
9371 if (!NILP (delayed_switch_frame
))
9373 KVAR (interrupted_kboard
, kbd_queue
)
9374 = Fcons (delayed_switch_frame
,
9375 KVAR (interrupted_kboard
, kbd_queue
));
9376 delayed_switch_frame
= Qnil
;
9380 KVAR (interrupted_kboard
, kbd_queue
)
9381 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9383 /* If the side queue is non-empty, ensure it begins with a
9384 switch-frame, so we'll replay it in the right context. */
9385 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9386 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9387 !(EVENT_HAS_PARAMETERS (key
)
9388 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9392 XSETFRAME (frame
, interrupted_frame
);
9393 KVAR (interrupted_kboard
, kbd_queue
)
9394 = Fcons (make_lispy_switch_frame (frame
),
9395 KVAR (interrupted_kboard
, kbd_queue
));
9398 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9399 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9400 goto replay_entire_sequence
;
9404 /* read_char returns t when it shows a menu and the user rejects it.
9408 unbind_to (count
, Qnil
);
9413 /* read_char returns -1 at the end of a macro.
9414 Emacs 18 handles this by returning immediately with a
9415 zero, so that's what we'll do. */
9416 if (INTEGERP (key
) && XINT (key
) == -1)
9419 /* The Microsoft C compiler can't handle the goto that
9425 /* If the current buffer has been changed from under us, the
9426 keymap may have changed, so replay the sequence. */
9429 timer_resume_idle ();
9432 /* Reset the current buffer from the selected window
9433 in case something changed the former and not the latter.
9434 This is to be more consistent with the behavior
9435 of the command_loop_1. */
9436 if (fix_current_buffer
)
9438 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9440 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9441 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9444 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9445 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9446 goto replay_sequence
;
9449 /* If we have a quit that was typed in another frame, and
9450 quit_throw_to_read_char switched buffers,
9451 replay to get the right keymap. */
9453 && XINT (key
) == quit_char
9454 && current_buffer
!= starting_buffer
)
9457 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9461 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9462 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9463 goto replay_sequence
;
9468 if (EVENT_HAS_PARAMETERS (key
)
9469 /* Either a `switch-frame' or a `select-window' event. */
9470 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9472 /* If we're at the beginning of a key sequence, and the caller
9473 says it's okay, go ahead and return this event. If we're
9474 in the midst of a key sequence, delay it until the end. */
9475 if (t
> 0 || !can_return_switch_frame
)
9477 delayed_switch_frame
= key
;
9483 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9487 /* Clicks in non-text areas get prefixed by the symbol
9488 in their CHAR-ADDRESS field. For example, a click on
9489 the mode line is prefixed by the symbol `mode-line'.
9491 Furthermore, key sequences beginning with mouse clicks
9492 are read using the keymaps of the buffer clicked on, not
9493 the current buffer. So we may have to switch the buffer
9496 When we turn one event into two events, we must make sure
9497 that neither of the two looks like the original--so that,
9498 if we replay the events, they won't be expanded again.
9499 If not for this, such reexpansion could happen either here
9500 or when user programs play with this-command-keys. */
9501 if (EVENT_HAS_PARAMETERS (key
))
9506 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9507 if (EQ (kind
, Qmouse_click
))
9509 Lisp_Object window
, posn
;
9511 window
= POSN_WINDOW (EVENT_START (key
));
9512 posn
= POSN_POSN (EVENT_START (key
));
9515 || (!NILP (fake_prefixed_keys
)
9516 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9518 /* We're looking a second time at an event for which
9519 we generated a fake prefix key. Set
9520 last_real_key_start appropriately. */
9522 last_real_key_start
= t
- 1;
9525 if (last_real_key_start
== 0)
9527 /* Key sequences beginning with mouse clicks are
9528 read using the keymaps in the buffer clicked on,
9529 not the current buffer. If we're at the
9530 beginning of a key sequence, switch buffers. */
9531 if (WINDOWP (window
)
9532 && BUFFERP (XWINDOW (window
)->buffer
)
9533 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9535 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9539 /* Arrange to go back to the original buffer once we're
9540 done reading the key sequence. Note that we can't
9541 use save_excursion_{save,restore} here, because they
9542 save point as well as the current buffer; we don't
9543 want to save point, because redisplay may change it,
9544 to accommodate a Fset_window_start or something. We
9545 don't want to do this at the top of the function,
9546 because we may get input from a subprocess which
9547 wants to change the selected window and stuff (say,
9549 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9551 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9553 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9554 orig_local_map
= get_local_map (PT
, current_buffer
,
9556 orig_keymap
= get_local_map (PT
, current_buffer
,
9558 goto replay_sequence
;
9561 /* For a mouse click, get the local text-property keymap
9562 of the place clicked on, rather than point. */
9563 if (CONSP (XCDR (key
))
9564 && ! localized_local_map
)
9566 Lisp_Object map_here
, start
, pos
;
9568 localized_local_map
= 1;
9569 start
= EVENT_START (key
);
9571 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9573 pos
= POSN_BUFFER_POSN (start
);
9575 && XINT (pos
) >= BEGV
9576 && XINT (pos
) <= ZV
)
9578 map_here
= get_local_map (XINT (pos
),
9581 if (!EQ (map_here
, orig_local_map
))
9583 orig_local_map
= map_here
;
9584 ++localized_local_map
;
9587 map_here
= get_local_map (XINT (pos
),
9590 if (!EQ (map_here
, orig_keymap
))
9592 orig_keymap
= map_here
;
9593 ++localized_local_map
;
9596 if (localized_local_map
> 1)
9601 goto replay_sequence
;
9608 /* Expand mode-line and scroll-bar events into two events:
9609 use posn as a fake prefix key. */
9611 && (NILP (fake_prefixed_keys
)
9612 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9614 if (bufsize
- t
<= 1)
9615 error ("Key sequence too long");
9618 keybuf
[t
+ 1] = key
;
9621 /* Record that a fake prefix key has been generated
9622 for KEY. Don't modify the event; this would
9623 prevent proper action when the event is pushed
9624 back into unread-command-events. */
9625 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9627 /* If on a mode line string with a local keymap,
9628 reconsider the key sequence with that keymap. */
9629 if (string
= POSN_STRING (EVENT_START (key
)),
9630 (CONSP (string
) && STRINGP (XCAR (string
))))
9632 Lisp_Object pos
, map
, map2
;
9634 pos
= XCDR (string
);
9635 string
= XCAR (string
);
9637 && XINT (pos
) < SCHARS (string
))
9639 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9641 orig_local_map
= map
;
9642 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9645 if (!NILP (map
) || !NILP (map2
))
9646 goto replay_sequence
;
9652 else if (NILP (from_string
)
9653 && (string
= POSN_STRING (EVENT_START (key
)),
9654 (CONSP (string
) && STRINGP (XCAR (string
)))))
9656 /* For a click on a string, i.e. overlay string or a
9657 string displayed via the `display' property,
9658 consider `local-map' and `keymap' properties of
9660 Lisp_Object pos
, map
, map2
;
9662 pos
= XCDR (string
);
9663 string
= XCAR (string
);
9665 && XINT (pos
) < SCHARS (string
))
9667 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9669 orig_local_map
= map
;
9670 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9674 if (!NILP (map
) || !NILP (map2
))
9676 from_string
= string
;
9679 goto replay_sequence
;
9684 else if (CONSP (XCDR (key
))
9685 && CONSP (EVENT_START (key
))
9686 && CONSP (XCDR (EVENT_START (key
))))
9690 posn
= POSN_POSN (EVENT_START (key
));
9691 /* Handle menu-bar events:
9692 insert the dummy prefix event `menu-bar'. */
9693 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9695 if (bufsize
- t
<= 1)
9696 error ("Key sequence too long");
9700 /* Zap the position in key, so we know that we've
9701 expanded it, and don't try to do so again. */
9702 POSN_SET_POSN (EVENT_START (key
),
9703 Fcons (posn
, Qnil
));
9706 goto replay_sequence
;
9708 else if (CONSP (posn
))
9710 /* We're looking at the second event of a
9711 sequence which we expanded before. Set
9712 last_real_key_start appropriately. */
9713 if (last_real_key_start
== t
&& t
> 0)
9714 last_real_key_start
= t
- 1;
9719 /* We have finally decided that KEY is something we might want
9721 first_binding
= (follow_key (key
,
9722 nmaps
- first_binding
,
9723 submaps
+ first_binding
,
9724 defs
+ first_binding
,
9725 submaps
+ first_binding
)
9728 /* If KEY wasn't bound, we'll try some fallbacks. */
9729 if (first_binding
< nmaps
)
9730 /* This is needed for the following scenario:
9731 event 0: a down-event that gets dropped by calling replay_key.
9732 event 1: some normal prefix like C-h.
9733 After event 0, first_unbound is 0, after event 1 indec.start,
9734 fkey.start, and keytran.start are all 1, so when we see that
9735 C-h is bound, we need to update first_unbound. */
9736 first_unbound
= max (t
+ 1, first_unbound
);
9741 /* Remember the position to put an upper bound on indec.start. */
9742 first_unbound
= min (t
, first_unbound
);
9744 head
= EVENT_HEAD (key
);
9745 if (help_char_p (head
) && t
> 0)
9747 read_key_sequence_cmd
= Vprefix_help_command
;
9749 last_nonmenu_event
= key
;
9750 /* The Microsoft C compiler can't handle the goto that
9758 Lisp_Object breakdown
;
9761 breakdown
= parse_modifiers (head
);
9762 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9763 /* Attempt to reduce an unbound mouse event to a simpler
9764 event that is bound:
9765 Drags reduce to clicks.
9766 Double-clicks reduce to clicks.
9767 Triple-clicks reduce to double-clicks, then to clicks.
9768 Down-clicks are eliminated.
9769 Double-downs reduce to downs, then are eliminated.
9770 Triple-downs reduce to double-downs, then to downs,
9771 then are eliminated. */
9772 if (modifiers
& (down_modifier
| drag_modifier
9773 | double_modifier
| triple_modifier
))
9775 while (modifiers
& (down_modifier
| drag_modifier
9776 | double_modifier
| triple_modifier
))
9778 Lisp_Object new_head
, new_click
;
9779 if (modifiers
& triple_modifier
)
9780 modifiers
^= (double_modifier
| triple_modifier
);
9781 else if (modifiers
& double_modifier
)
9782 modifiers
&= ~double_modifier
;
9783 else if (modifiers
& drag_modifier
)
9784 modifiers
&= ~drag_modifier
;
9787 /* Dispose of this `down' event by simply jumping
9788 back to replay_key, to get another event.
9790 Note that if this event came from mock input,
9791 then just jumping back to replay_key will just
9792 hand it to us again. So we have to wipe out any
9795 We could delete keybuf[t] and shift everything
9796 after that to the left by one spot, but we'd also
9797 have to fix up any variable that points into
9798 keybuf, and shifting isn't really necessary
9801 Adding prefixes for non-textual mouse clicks
9802 creates two characters of mock input, and both
9803 must be thrown away. If we're only looking at
9804 the prefix now, we can just jump back to
9805 replay_key. On the other hand, if we've already
9806 processed the prefix, and now the actual click
9807 itself is giving us trouble, then we've lost the
9808 state of the keymaps we want to backtrack to, and
9809 we need to replay the whole sequence to rebuild
9812 Beyond that, only function key expansion could
9813 create more than two keys, but that should never
9814 generate mouse events, so it's okay to zero
9815 mock_input in that case too.
9817 FIXME: The above paragraph seems just plain
9818 wrong, if you consider things like
9819 xterm-mouse-mode. -stef
9821 Isn't this just the most wonderful code ever? */
9823 /* If mock_input > t + 1, the above simplification
9824 will actually end up dropping keys on the floor.
9825 This is probably OK for now, but even
9826 if mock_input <= t + 1, we need to adjust indec,
9828 Typical case [header-line down-mouse-N]:
9829 mock_input = 2, t = 1, fkey.end = 1,
9830 last_real_key_start = 0. */
9831 if (indec
.end
> last_real_key_start
)
9833 indec
.end
= indec
.start
9834 = min (last_real_key_start
, indec
.start
);
9835 indec
.map
= indec
.parent
;
9836 if (fkey
.end
> last_real_key_start
)
9838 fkey
.end
= fkey
.start
9839 = min (last_real_key_start
, fkey
.start
);
9840 fkey
.map
= fkey
.parent
;
9841 if (keytran
.end
> last_real_key_start
)
9843 keytran
.end
= keytran
.start
9844 = min (last_real_key_start
, keytran
.start
);
9845 keytran
.map
= keytran
.parent
;
9849 if (t
== last_real_key_start
)
9856 mock_input
= last_real_key_start
;
9857 goto replay_sequence
;
9862 = apply_modifiers (modifiers
, XCAR (breakdown
));
9864 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9866 /* Look for a binding for this new key. follow_key
9867 promises that it didn't munge submaps the
9868 last time we called it, since key was unbound. */
9870 = (follow_key (new_click
,
9871 nmaps
- local_first_binding
,
9872 submaps
+ local_first_binding
,
9873 defs
+ local_first_binding
,
9874 submaps
+ local_first_binding
)
9875 + local_first_binding
);
9877 /* If that click is bound, go for it. */
9878 if (first_binding
< nmaps
)
9883 /* Otherwise, we'll leave key set to the drag event. */
9890 /* Normally, last_nonmenu_event gets the previous key we read.
9891 But when a mouse popup menu is being used,
9892 we don't update last_nonmenu_event; it continues to hold the mouse
9893 event that preceded the first level of menu. */
9894 if (!used_mouse_menu
)
9895 last_nonmenu_event
= key
;
9897 /* Record what part of this_command_keys is the current key sequence. */
9898 this_single_command_key_start
= this_command_key_count
- t
;
9900 /* Look for this sequence in input-decode-map.
9901 Scan from indec.end until we find a bound suffix. */
9902 while (indec
.end
< t
)
9904 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9907 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9908 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9913 mock_input
= diff
+ max (t
, mock_input
);
9914 goto replay_sequence
;
9918 if (first_binding
< nmaps
9919 && NILP (submaps
[first_binding
])
9920 && !test_undefined (defs
[first_binding
])
9921 && indec
.start
>= t
)
9922 /* There is a binding and it's not a prefix.
9923 (and it doesn't have any input-decode-map translation pending).
9924 There is thus no function-key in this sequence.
9925 Moving fkey.start is important in this case to allow keytran.start
9926 to go over the sequence before we return (since we keep the
9927 invariant that keytran.end <= fkey.start). */
9930 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9933 /* If the sequence is unbound, see if we can hang a function key
9934 off the end of it. */
9935 /* Continue scan from fkey.end until we find a bound suffix. */
9936 while (fkey
.end
< indec
.start
)
9938 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9941 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9942 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9943 max (t
, mock_input
),
9944 /* If there's a binding (i.e.
9945 first_binding >= nmaps) we don't want
9946 to apply this function-key-mapping. */
9948 && (first_binding
>= nmaps
9949 || test_undefined (defs
[first_binding
])),
9954 mock_input
= diff
+ max (t
, mock_input
);
9955 /* Adjust the input-decode-map counters. */
9957 indec
.start
+= diff
;
9959 goto replay_sequence
;
9963 /* Look for this sequence in key-translation-map.
9964 Scan from keytran.end until we find a bound suffix. */
9965 while (keytran
.end
< fkey
.start
)
9967 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9970 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9971 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9976 mock_input
= diff
+ max (t
, mock_input
);
9977 /* Adjust the function-key-map and input-decode-map counters. */
9979 indec
.start
+= diff
;
9983 goto replay_sequence
;
9987 /* If KEY is not defined in any of the keymaps,
9988 and cannot be part of a function key or translation,
9989 and is an upper case letter
9990 use the corresponding lower-case letter instead. */
9991 if (first_binding
>= nmaps
9992 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9994 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9995 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9996 || (XINT (key
) & shift_modifier
)))
9998 Lisp_Object new_key
;
10000 original_uppercase
= key
;
10001 original_uppercase_position
= t
- 1;
10003 if (XINT (key
) & shift_modifier
)
10004 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10006 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10007 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10009 /* We have to do this unconditionally, regardless of whether
10010 the lower-case char is defined in the keymaps, because they
10011 might get translated through function-key-map. */
10012 keybuf
[t
- 1] = new_key
;
10013 mock_input
= max (t
, mock_input
);
10014 shift_translated
= 1;
10016 goto replay_sequence
;
10018 /* If KEY is not defined in any of the keymaps,
10019 and cannot be part of a function key or translation,
10020 and is a shifted function key,
10021 use the corresponding unshifted function key instead. */
10022 if (first_binding
>= nmaps
10023 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10025 Lisp_Object breakdown
= parse_modifiers (key
);
10027 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10029 if (modifiers
& shift_modifier
10030 /* Treat uppercase keys as shifted. */
10032 && (KEY_TO_CHAR (key
)
10033 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10034 && uppercasep (KEY_TO_CHAR (key
))))
10036 Lisp_Object new_key
10037 = (modifiers
& shift_modifier
10038 ? apply_modifiers (modifiers
& ~shift_modifier
,
10040 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10042 original_uppercase
= key
;
10043 original_uppercase_position
= t
- 1;
10045 /* We have to do this unconditionally, regardless of whether
10046 the lower-case char is defined in the keymaps, because they
10047 might get translated through function-key-map. */
10048 keybuf
[t
- 1] = new_key
;
10049 mock_input
= max (t
, mock_input
);
10050 /* Reset fkey (and consequently keytran) to apply
10051 function-key-map on the result, so that S-backspace is
10052 correctly mapped to DEL (via backspace). OTOH,
10053 input-decode-map doesn't need to go through it again. */
10054 fkey
.start
= fkey
.end
= 0;
10055 keytran
.start
= keytran
.end
= 0;
10056 shift_translated
= 1;
10058 goto replay_sequence
;
10063 read_key_sequence_cmd
= (first_binding
< nmaps
10064 ? defs
[first_binding
]
10066 read_key_sequence_remapped
10067 /* Remap command through active keymaps.
10068 Do the remapping here, before the unbind_to so it uses the keymaps
10069 of the appropriate buffer. */
10070 = SYMBOLP (read_key_sequence_cmd
)
10071 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10074 unread_switch_frame
= delayed_switch_frame
;
10075 unbind_to (count
, Qnil
);
10077 /* Don't downcase the last character if the caller says don't.
10078 Don't downcase it if the result is undefined, either. */
10079 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10081 && t
- 1 == original_uppercase_position
)
10083 keybuf
[t
- 1] = original_uppercase
;
10084 shift_translated
= 0;
10087 if (shift_translated
)
10088 Vthis_command_keys_shift_translated
= Qt
;
10090 /* Occasionally we fabricate events, perhaps by expanding something
10091 according to function-key-map, or by adding a prefix symbol to a
10092 mouse click in the scroll bar or modeline. In this cases, return
10093 the entire generated key sequence, even if we hit an unbound
10094 prefix or a definition before the end. This means that you will
10095 be able to push back the event properly, and also means that
10096 read-key-sequence will always return a logical unit.
10099 for (; t
< mock_input
; t
++)
10101 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10102 && NILP (Fzerop (Vecho_keystrokes
)))
10103 echo_char (keybuf
[t
]);
10104 add_command_key (keybuf
[t
]);
10111 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10112 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10113 The sequence is sufficient to specify a non-prefix command in the
10114 current local and global maps.
10116 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10117 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10118 as a continuation of the previous key.
10120 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10121 convert the last event to lower case. (Normally any upper case event
10122 is converted to lower case if the original event is undefined and the lower
10123 case equivalent is defined.) A non-nil value is appropriate for reading
10124 a key sequence to be defined.
10126 A C-g typed while in this function is treated like any other character,
10127 and `quit-flag' is not set.
10129 If the key sequence starts with a mouse click, then the sequence is read
10130 using the keymaps of the buffer of the window clicked in, not the buffer
10131 of the selected window as normal.
10133 `read-key-sequence' drops unbound button-down events, since you normally
10134 only care about the click or drag events which follow them. If a drag
10135 or multi-click event is unbound, but the corresponding click event would
10136 be bound, `read-key-sequence' turns the event into a click event at the
10137 drag's starting position. This means that you don't have to distinguish
10138 between click and drag, double, or triple events unless you want to.
10140 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10141 lines separating windows, and scroll bars with imaginary keys
10142 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10144 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10145 function will process a switch-frame event if the user switches frames
10146 before typing anything. If the user switches frames in the middle of a
10147 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10148 is nil, then the event will be put off until after the current key sequence.
10150 `read-key-sequence' checks `function-key-map' for function key
10151 sequences, where they wouldn't conflict with ordinary bindings. See
10152 `function-key-map' for more details.
10154 The optional fifth argument CMD-LOOP, if non-nil, means
10155 that this key sequence is being read by something that will
10156 read commands one after another. It should be nil if the caller
10157 will read just one key sequence. */)
10158 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10160 Lisp_Object keybuf
[30];
10162 struct gcpro gcpro1
;
10163 int count
= SPECPDL_INDEX ();
10165 if (!NILP (prompt
))
10166 CHECK_STRING (prompt
);
10169 specbind (Qinput_method_exit_on_first_char
,
10170 (NILP (cmd_loop
) ? Qt
: Qnil
));
10171 specbind (Qinput_method_use_echo_area
,
10172 (NILP (cmd_loop
) ? Qt
: Qnil
));
10174 memset (keybuf
, 0, sizeof keybuf
);
10175 GCPRO1 (keybuf
[0]);
10176 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10178 if (NILP (continue_echo
))
10180 this_command_key_count
= 0;
10181 this_command_key_count_reset
= 0;
10182 this_single_command_key_start
= 0;
10185 #ifdef HAVE_WINDOW_SYSTEM
10186 if (display_hourglass_p
)
10187 cancel_hourglass ();
10190 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10191 prompt
, ! NILP (dont_downcase_last
),
10192 ! NILP (can_return_switch_frame
), 0);
10194 #if 0 /* The following is fine for code reading a key sequence and
10195 then proceeding with a lengthy computation, but it's not good
10196 for code reading keys in a loop, like an input method. */
10197 #ifdef HAVE_WINDOW_SYSTEM
10198 if (display_hourglass_p
)
10199 start_hourglass ();
10209 return unbind_to (count
, make_event_array (i
, keybuf
));
10212 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10213 Sread_key_sequence_vector
, 1, 5, 0,
10214 doc
: /* Like `read-key-sequence' but always return a vector. */)
10215 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10217 Lisp_Object keybuf
[30];
10219 struct gcpro gcpro1
;
10220 int count
= SPECPDL_INDEX ();
10222 if (!NILP (prompt
))
10223 CHECK_STRING (prompt
);
10226 specbind (Qinput_method_exit_on_first_char
,
10227 (NILP (cmd_loop
) ? Qt
: Qnil
));
10228 specbind (Qinput_method_use_echo_area
,
10229 (NILP (cmd_loop
) ? Qt
: Qnil
));
10231 memset (keybuf
, 0, sizeof keybuf
);
10232 GCPRO1 (keybuf
[0]);
10233 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10235 if (NILP (continue_echo
))
10237 this_command_key_count
= 0;
10238 this_command_key_count_reset
= 0;
10239 this_single_command_key_start
= 0;
10242 #ifdef HAVE_WINDOW_SYSTEM
10243 if (display_hourglass_p
)
10244 cancel_hourglass ();
10247 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10248 prompt
, ! NILP (dont_downcase_last
),
10249 ! NILP (can_return_switch_frame
), 0);
10251 #ifdef HAVE_WINDOW_SYSTEM
10252 if (display_hourglass_p
)
10253 start_hourglass ();
10262 return unbind_to (count
, Fvector (i
, keybuf
));
10265 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10266 doc
: /* Execute CMD as an editor command.
10267 CMD must be a symbol that satisfies the `commandp' predicate.
10268 Optional second arg RECORD-FLAG non-nil
10269 means unconditionally put this command in `command-history'.
10270 Otherwise, that is done only if an arg is read using the minibuffer.
10271 The argument KEYS specifies the value to use instead of (this-command-keys)
10272 when reading the arguments; if it is nil, (this-command-keys) is used.
10273 The argument SPECIAL, if non-nil, means that this command is executing
10274 a special event, so ignore the prefix argument and don't clear it. */)
10275 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10277 register Lisp_Object final
;
10278 register Lisp_Object tem
;
10279 Lisp_Object prefixarg
;
10281 debug_on_next_call
= 0;
10283 if (NILP (special
))
10285 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10286 Vcurrent_prefix_arg
= prefixarg
;
10287 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10294 tem
= Fget (cmd
, Qdisabled
);
10297 tem
= Fsymbol_value (Qdisabled_command_function
);
10299 return Frun_hooks (1, &Qdisabled_command_function
);
10305 final
= Findirect_function (cmd
, Qnil
);
10307 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10309 struct gcpro gcpro1
, gcpro2
;
10311 GCPRO2 (cmd
, prefixarg
);
10312 do_autoload (final
, cmd
);
10319 if (STRINGP (final
) || VECTORP (final
))
10321 /* If requested, place the macro in the command history. For
10322 other sorts of commands, call-interactively takes care of
10324 if (!NILP (record_flag
))
10327 = Fcons (Fcons (Qexecute_kbd_macro
,
10328 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10331 /* Don't keep command history around forever. */
10332 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10334 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10336 XSETCDR (tem
, Qnil
);
10340 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10343 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10344 /* Don't call Fcall_interactively directly because we want to make
10345 sure the backtrace has an entry for `call-interactively'.
10346 For the same reason, pass `cmd' rather than `final'. */
10347 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10354 /* Return nonzero if input events are pending. */
10357 detect_input_pending (void)
10359 if (!input_pending
)
10360 get_input_pending (&input_pending
, 0);
10362 return input_pending
;
10365 /* Return nonzero if input events other than mouse movements are
10369 detect_input_pending_ignore_squeezables (void)
10371 if (!input_pending
)
10372 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10374 return input_pending
;
10377 /* Return nonzero if input events are pending, and run any pending timers. */
10380 detect_input_pending_run_timers (int do_display
)
10382 int old_timers_run
= timers_run
;
10384 if (!input_pending
)
10385 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10387 if (old_timers_run
!= timers_run
&& do_display
)
10389 redisplay_preserve_echo_area (8);
10390 /* The following fixes a bug when using lazy-lock with
10391 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10392 from an idle timer function. The symptom of the bug is that
10393 the cursor sometimes doesn't become visible until the next X
10394 event is processed. --gerd. */
10396 Lisp_Object tail
, frame
;
10397 FOR_EACH_FRAME (tail
, frame
)
10398 if (FRAME_RIF (XFRAME (frame
)))
10399 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10403 return input_pending
;
10406 /* This is called in some cases before a possible quit.
10407 It cases the next call to detect_input_pending to recompute input_pending.
10408 So calling this function unnecessarily can't do any harm. */
10411 clear_input_pending (void)
10416 /* Return nonzero if there are pending requeued events.
10417 This isn't used yet. The hope is to make wait_reading_process_output
10418 call it, and return if it runs Lisp code that unreads something.
10419 The problem is, kbd_buffer_get_event needs to be fixed to know what
10420 to do in that case. It isn't trivial. */
10423 requeued_events_pending_p (void)
10425 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10429 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10430 doc
: /* Return t if command input is currently available with no wait.
10431 Actually, the value is nil only if we can be sure that no input is available;
10432 if there is a doubt, the value is t. */)
10435 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10436 || !NILP (Vunread_post_input_method_events
)
10437 || !NILP (Vunread_input_method_events
))
10440 /* Process non-user-visible events (Bug#10195). */
10441 process_special_events ();
10443 get_input_pending (&input_pending
,
10444 READABLE_EVENTS_DO_TIMERS_NOW
10445 | READABLE_EVENTS_FILTER_EVENTS
);
10446 return input_pending
> 0 ? Qt
: Qnil
;
10449 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10450 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10453 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10456 if (total_keys
< NUM_RECENT_KEYS
)
10457 return Fvector (total_keys
, keys
);
10460 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10461 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10462 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10463 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10464 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10469 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10470 doc
: /* Return the key sequence that invoked this command.
10471 However, if the command has called `read-key-sequence', it returns
10472 the last key sequence that has been read.
10473 The value is a string or a vector.
10475 See also `this-command-keys-vector'. */)
10478 return make_event_array (this_command_key_count
,
10479 XVECTOR (this_command_keys
)->contents
);
10482 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10483 doc
: /* Return the key sequence that invoked this command, as a vector.
10484 However, if the command has called `read-key-sequence', it returns
10485 the last key sequence that has been read.
10487 See also `this-command-keys'. */)
10490 return Fvector (this_command_key_count
,
10491 XVECTOR (this_command_keys
)->contents
);
10494 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10495 Sthis_single_command_keys
, 0, 0, 0,
10496 doc
: /* Return the key sequence that invoked this command.
10497 More generally, it returns the last key sequence read, either by
10498 the command loop or by `read-key-sequence'.
10499 Unlike `this-command-keys', this function's value
10500 does not include prefix arguments.
10501 The value is always a vector. */)
10504 return Fvector (this_command_key_count
10505 - this_single_command_key_start
,
10506 (XVECTOR (this_command_keys
)->contents
10507 + this_single_command_key_start
));
10510 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10511 Sthis_single_command_raw_keys
, 0, 0, 0,
10512 doc
: /* Return the raw events that were read for this command.
10513 More generally, it returns the last key sequence read, either by
10514 the command loop or by `read-key-sequence'.
10515 Unlike `this-single-command-keys', this function's value
10516 shows the events before all translations (except for input methods).
10517 The value is always a vector. */)
10520 return Fvector (raw_keybuf_count
,
10521 (XVECTOR (raw_keybuf
)->contents
));
10524 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10525 Sreset_this_command_lengths
, 0, 0, 0,
10526 doc
: /* Make the unread events replace the last command and echo.
10527 Used in `universal-argument-other-key'.
10529 `universal-argument-other-key' rereads the event just typed.
10530 It then gets translated through `function-key-map'.
10531 The translated event has to replace the real events,
10532 both in the value of (this-command-keys) and in echoing.
10533 To achieve this, `universal-argument-other-key' calls
10534 `reset-this-command-lengths', which discards the record of reading
10535 these events the first time. */)
10538 this_command_key_count
= before_command_key_count
;
10539 if (this_command_key_count
< this_single_command_key_start
)
10540 this_single_command_key_start
= this_command_key_count
;
10542 echo_truncate (before_command_echo_length
);
10544 /* Cause whatever we put into unread-command-events
10545 to echo as if it were being freshly read from the keyboard. */
10546 this_command_key_count_reset
= 1;
10551 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10552 Sclear_this_command_keys
, 0, 1, 0,
10553 doc
: /* Clear out the vector that `this-command-keys' returns.
10554 Also clear the record of the last 100 events, unless optional arg
10555 KEEP-RECORD is non-nil. */)
10556 (Lisp_Object keep_record
)
10560 this_command_key_count
= 0;
10561 this_command_key_count_reset
= 0;
10563 if (NILP (keep_record
))
10565 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10566 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10568 recent_keys_index
= 0;
10573 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10574 doc
: /* Return the current depth in recursive edits. */)
10578 /* Wrap around reliably on integer overflow. */
10579 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10580 XSETINT (temp
, sum
);
10584 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10585 "FOpen dribble file: ",
10586 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10587 If FILE is nil, close any open dribble file.
10588 The file will be closed when Emacs exits. */)
10600 file
= Fexpand_file_name (file
, Qnil
);
10601 dribble
= fopen (SSDATA (file
), "w");
10603 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10608 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10609 doc
: /* Discard the contents of the terminal input buffer.
10610 Also end any kbd macro being defined. */)
10613 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10615 /* Discard the last command from the macro. */
10616 Fcancel_kbd_macro_events ();
10620 update_mode_lines
++;
10622 Vunread_command_events
= Qnil
;
10623 unread_command_char
= -1;
10625 discard_tty_input ();
10627 kbd_fetch_ptr
= kbd_store_ptr
;
10633 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10634 doc
: /* Stop Emacs and return to superior process. You can resume later.
10635 If `cannot-suspend' is non-nil, or if the system doesn't support job
10636 control, run a subshell instead.
10638 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10639 to be read as terminal input by Emacs's parent, after suspension.
10641 Before suspending, run the normal hook `suspend-hook'.
10642 After resumption run the normal hook `suspend-resume-hook'.
10644 Some operating systems cannot stop the Emacs process and resume it later.
10645 On such systems, Emacs starts a subshell instead of suspending. */)
10646 (Lisp_Object stuffstring
)
10648 int count
= SPECPDL_INDEX ();
10649 int old_height
, old_width
;
10651 struct gcpro gcpro1
;
10654 if (tty_list
&& tty_list
->next
)
10655 error ("There are other tty frames open; close them before suspending Emacs");
10657 if (!NILP (stuffstring
))
10658 CHECK_STRING (stuffstring
);
10660 /* Run the functions in suspend-hook. */
10661 hook
= intern ("suspend-hook");
10662 Frun_hooks (1, &hook
);
10664 GCPRO1 (stuffstring
);
10665 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10666 reset_all_sys_modes ();
10667 /* sys_suspend can get an error if it tries to fork a subshell
10668 and the system resources aren't available for that. */
10669 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10671 stuff_buffered_input (stuffstring
);
10672 if (cannot_suspend
)
10676 unbind_to (count
, Qnil
);
10678 /* Check if terminal/window size has changed.
10679 Note that this is not useful when we are running directly
10680 with a window system; but suspend should be disabled in that case. */
10681 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10682 if (width
!= old_width
|| height
!= old_height
)
10683 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10685 /* Run suspend-resume-hook. */
10686 hook
= intern ("suspend-resume-hook");
10687 Frun_hooks (1, &hook
);
10693 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10694 Then in any case stuff anything Emacs has read ahead and not used. */
10697 stuff_buffered_input (Lisp_Object stuffstring
)
10699 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10700 register unsigned char *p
;
10702 if (STRINGP (stuffstring
))
10704 register EMACS_INT count
;
10706 p
= SDATA (stuffstring
);
10707 count
= SBYTES (stuffstring
);
10708 while (count
-- > 0)
10713 /* Anything we have read ahead, put back for the shell to read. */
10714 /* ?? What should this do when we have multiple keyboards??
10715 Should we ignore anything that was typed in at the "wrong" kboard?
10717 rms: we should stuff everything back into the kboard
10719 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10722 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10723 kbd_fetch_ptr
= kbd_buffer
;
10724 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10725 stuff_char (kbd_fetch_ptr
->code
);
10727 clear_event (kbd_fetch_ptr
);
10731 #endif /* SIGTSTP */
10735 set_waiting_for_input (struct timeval
*time_to_clear
)
10737 input_available_clear_time
= time_to_clear
;
10739 /* Tell handle_interrupt to throw back to read_char, */
10740 waiting_for_input
= 1;
10742 /* If handle_interrupt was called before and buffered a C-g,
10743 make it run again now, to avoid timing error. */
10744 if (!NILP (Vquit_flag
))
10745 quit_throw_to_read_char (0);
10749 clear_waiting_for_input (void)
10751 /* Tell handle_interrupt not to throw back to read_char, */
10752 waiting_for_input
= 0;
10753 input_available_clear_time
= 0;
10756 /* The SIGINT handler.
10758 If we have a frame on the controlling tty, we assume that the
10759 SIGINT was generated by C-g, so we call handle_interrupt.
10760 Otherwise, tell QUIT to kill Emacs. */
10763 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10764 /* compilers complain in signal calls. */
10766 /* Must preserve main program's value of errno. */
10767 int old_errno
= errno
;
10768 struct terminal
*terminal
;
10770 SIGNAL_THREAD_CHECK (signalnum
);
10772 /* See if we have an active terminal on our controlling tty. */
10773 terminal
= get_named_tty ("/dev/tty");
10776 /* If there are no frames there, let's pretend that we are a
10777 well-behaving UN*X program and quit. We must not call Lisp
10778 in a signal handler, so tell QUIT to exit when it is
10780 Vquit_flag
= Qkill_emacs
;
10784 /* Otherwise, the SIGINT was probably generated by C-g. */
10786 /* Set internal_last_event_frame to the top frame of the
10787 controlling tty, if we have a frame there. We disable the
10788 interrupt key on secondary ttys, so the SIGINT must have come
10789 from the controlling tty. */
10790 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10792 handle_interrupt ();
10798 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10799 of the number of times C-g has been requested. If C-g is pressed
10800 enough times, then quit anyway. See bug#6585. */
10801 static int force_quit_count
;
10803 /* This routine is called at interrupt level in response to C-g.
10805 It is called from the SIGINT handler or kbd_buffer_store_event.
10807 If `waiting_for_input' is non zero, then unless `echoing' is
10808 nonzero, immediately throw back to read_char.
10810 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10811 eval to throw, when it gets a chance. If quit-flag is already
10812 non-nil, it stops the job right away. */
10815 handle_interrupt (void)
10821 /* XXX This code needs to be revised for multi-tty support. */
10822 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10824 /* If SIGINT isn't blocked, don't let us be interrupted by
10825 another SIGINT, it might be harmful due to non-reentrancy
10826 in I/O functions. */
10827 sigblock (sigmask (SIGINT
));
10830 reset_all_sys_modes ();
10832 #ifdef SIGTSTP /* Support possible in later USG versions */
10834 * On systems which can suspend the current process and return to the original
10835 * shell, this command causes the user to end up back at the shell.
10836 * The "Auto-save" and "Abort" questions are not asked until
10837 * the user elects to return to emacs, at which point he can save the current
10838 * job and either dump core or continue.
10842 /* Perhaps should really fork an inferior shell?
10843 But that would not provide any way to get back
10844 to the original shell, ever. */
10845 printf ("No support for stopping a process on this operating system;\n");
10846 printf ("you can continue or abort.\n");
10847 #endif /* not SIGTSTP */
10849 /* We must remain inside the screen area when the internal terminal
10850 is used. Note that [Enter] is not echoed by dos. */
10851 cursor_to (SELECTED_FRAME (), 0, 0);
10853 /* It doesn't work to autosave while GC is in progress;
10854 the code used for auto-saving doesn't cope with the mark bit. */
10855 if (!gc_in_progress
)
10857 printf ("Auto-save? (y or n) ");
10859 if (((c
= getchar ()) & ~040) == 'Y')
10861 Fdo_auto_save (Qt
, Qnil
);
10863 printf ("\r\nAuto-save done");
10864 #else /* not MSDOS */
10865 printf ("Auto-save done\n");
10866 #endif /* not MSDOS */
10868 while (c
!= '\n') c
= getchar ();
10872 /* During GC, it must be safe to reenable quitting again. */
10873 Vinhibit_quit
= Qnil
;
10876 #endif /* not MSDOS */
10877 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10878 printf ("but will instead do a real quit after garbage collection ends\r\n");
10883 printf ("\r\nAbort? (y or n) ");
10884 #else /* not MSDOS */
10885 printf ("Abort (and dump core)? (y or n) ");
10886 #endif /* not MSDOS */
10888 if (((c
= getchar ()) & ~040) == 'Y')
10890 while (c
!= '\n') c
= getchar ();
10892 printf ("\r\nContinuing...\r\n");
10893 #else /* not MSDOS */
10894 printf ("Continuing...\n");
10895 #endif /* not MSDOS */
10897 init_all_sys_modes ();
10902 /* If executing a function that wants to be interrupted out of
10903 and the user has not deferred quitting by binding `inhibit-quit'
10904 then quit right away. */
10905 if (immediate_quit
&& NILP (Vinhibit_quit
))
10907 struct gl_state_s saved
;
10908 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10910 immediate_quit
= 0;
10913 GCPRO4 (saved
.object
, saved
.global_code
,
10914 saved
.current_syntax_table
, saved
.old_prop
);
10915 Fsignal (Qquit
, Qnil
);
10916 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10921 { /* Else request quit when it's safe. */
10922 if (NILP (Vquit_flag
))
10923 force_quit_count
= 0;
10924 if (++force_quit_count
== 3)
10926 immediate_quit
= 1;
10927 Vinhibit_quit
= Qnil
;
10933 /* TODO: The longjmp in this call throws the NS event loop integration off,
10934 and it seems to do fine without this. Probably some attention
10935 needs to be paid to the setting of waiting_for_input in
10936 wait_reading_process_output() under HAVE_NS because of the call
10937 to ns_select there (needed because otherwise events aren't picked up
10938 outside of polling since we don't get SIGIO like X and we don't have a
10939 separate event loop thread like W32. */
10941 if (waiting_for_input
&& !echoing
)
10942 quit_throw_to_read_char (1);
10946 /* Handle a C-g by making read_char return C-g. */
10949 quit_throw_to_read_char (int from_signal
)
10951 /* When not called from a signal handler it is safe to call
10953 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10954 Fkill_emacs (Qnil
);
10957 /* Prevent another signal from doing this before we finish. */
10958 clear_waiting_for_input ();
10961 Vunread_command_events
= Qnil
;
10962 unread_command_char
= -1;
10964 #if 0 /* Currently, sit_for is called from read_char without turning
10965 off polling. And that can call set_waiting_for_input.
10966 It seems to be harmless. */
10967 #ifdef POLL_FOR_INPUT
10968 /* May be > 1 if in recursive minibuffer. */
10969 if (poll_suppress_count
== 0)
10973 if (FRAMEP (internal_last_event_frame
)
10974 && !EQ (internal_last_event_frame
, selected_frame
))
10975 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10978 _longjmp (getcjmp
, 1);
10981 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10982 Sset_input_interrupt_mode
, 1, 1, 0,
10983 doc
: /* Set interrupt mode of reading keyboard input.
10984 If INTERRUPT is non-nil, Emacs will use input interrupts;
10985 otherwise Emacs uses CBREAK mode.
10987 See also `current-input-mode'. */)
10988 (Lisp_Object interrupt
)
10990 int new_interrupt_input
;
10992 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10993 #ifdef HAVE_X_WINDOWS
10994 if (x_display_list
!= NULL
)
10996 /* When using X, don't give the user a real choice,
10997 because we haven't implemented the mechanisms to support it. */
10998 new_interrupt_input
= 1;
11001 #endif /* HAVE_X_WINDOWS */
11002 new_interrupt_input
= !NILP (interrupt
);
11003 #else /* not SIGIO */
11004 new_interrupt_input
= 0;
11005 #endif /* not SIGIO */
11007 if (new_interrupt_input
!= interrupt_input
)
11009 #ifdef POLL_FOR_INPUT
11013 /* this causes startup screen to be restored and messes with the mouse */
11014 reset_all_sys_modes ();
11015 interrupt_input
= new_interrupt_input
;
11016 init_all_sys_modes ();
11018 interrupt_input
= new_interrupt_input
;
11021 #ifdef POLL_FOR_INPUT
11022 poll_suppress_count
= 1;
11029 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11030 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11031 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11032 C-q in key sequences.
11034 This setting only has an effect on tty terminals and only when
11035 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11037 See also `current-input-mode'. */)
11038 (Lisp_Object flow
, Lisp_Object terminal
)
11040 struct terminal
*t
= get_terminal (terminal
, 1);
11041 struct tty_display_info
*tty
;
11042 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11044 tty
= t
->display_info
.tty
;
11046 if (tty
->flow_control
!= !NILP (flow
))
11049 /* this causes startup screen to be restored and messes with the mouse */
11050 reset_sys_modes (tty
);
11053 tty
->flow_control
= !NILP (flow
);
11056 init_sys_modes (tty
);
11062 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11063 doc
: /* Enable or disable 8-bit input on TERMINAL.
11064 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11065 bit as the Meta modifier.
11067 If META is nil, Emacs will ignore the top bit, on the assumption it is
11070 Otherwise, Emacs will accept and pass through 8-bit input without
11071 specially interpreting the top bit.
11073 This setting only has an effect on tty terminal devices.
11075 Optional parameter TERMINAL specifies the tty terminal device to use.
11076 It may be a terminal object, a frame, or nil for the terminal used by
11077 the currently selected frame.
11079 See also `current-input-mode'. */)
11080 (Lisp_Object meta
, Lisp_Object terminal
)
11082 struct terminal
*t
= get_terminal (terminal
, 1);
11083 struct tty_display_info
*tty
;
11086 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11088 tty
= t
->display_info
.tty
;
11092 else if (EQ (meta
, Qt
))
11097 if (tty
->meta_key
!= new_meta
)
11100 /* this causes startup screen to be restored and messes with the mouse */
11101 reset_sys_modes (tty
);
11104 tty
->meta_key
= new_meta
;
11107 init_sys_modes (tty
);
11113 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11114 doc
: /* Specify character used for quitting.
11115 QUIT must be an ASCII character.
11117 This function only has an effect on the controlling tty of the Emacs
11120 See also `current-input-mode'. */)
11123 struct terminal
*t
= get_named_tty ("/dev/tty");
11124 struct tty_display_info
*tty
;
11125 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11127 tty
= t
->display_info
.tty
;
11129 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11130 error ("QUIT must be an ASCII character");
11133 /* this causes startup screen to be restored and messes with the mouse */
11134 reset_sys_modes (tty
);
11137 /* Don't let this value be out of range. */
11138 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11141 init_sys_modes (tty
);
11147 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11148 doc
: /* Set mode of reading keyboard input.
11149 First arg INTERRUPT non-nil means use input interrupts;
11150 nil means use CBREAK mode.
11151 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11152 (no effect except in CBREAK mode).
11153 Third arg META t means accept 8-bit input (for a Meta key).
11154 META nil means ignore the top bit, on the assumption it is parity.
11155 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11156 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11157 See also `current-input-mode'. */)
11158 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11160 Fset_input_interrupt_mode (interrupt
);
11161 Fset_output_flow_control (flow
, Qnil
);
11162 Fset_input_meta_mode (meta
, Qnil
);
11164 Fset_quit_char (quit
);
11168 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11169 doc
: /* Return information about the way Emacs currently reads keyboard input.
11170 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11171 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11172 nil, Emacs is using CBREAK mode.
11173 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11174 terminal; this does not apply if Emacs uses interrupt-driven input.
11175 META is t if accepting 8-bit input with 8th bit as Meta flag.
11176 META nil means ignoring the top bit, on the assumption it is parity.
11177 META is neither t nor nil if accepting 8-bit input and using
11178 all 8 bits as the character code.
11179 QUIT is the character Emacs currently uses to quit.
11180 The elements of this list correspond to the arguments of
11181 `set-input-mode'. */)
11184 Lisp_Object val
[4];
11185 struct frame
*sf
= XFRAME (selected_frame
);
11187 val
[0] = interrupt_input
? Qt
: Qnil
;
11188 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11190 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11191 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11193 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11200 XSETFASTINT (val
[3], quit_char
);
11202 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11205 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11206 doc
: /* Return position information for pixel coordinates X and Y.
11207 By default, X and Y are relative to text area of the selected window.
11208 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11209 If optional fourth arg WHOLE is non-nil, X is relative to the left
11210 edge of the window.
11212 The return value is similar to a mouse click position:
11213 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11214 IMAGE (DX . DY) (WIDTH . HEIGHT))
11215 The `posn-' functions access elements of such lists. */)
11216 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11221 if (NILP (frame_or_window
))
11222 frame_or_window
= selected_window
;
11224 if (WINDOWP (frame_or_window
))
11228 CHECK_LIVE_WINDOW (frame_or_window
);
11230 w
= XWINDOW (frame_or_window
);
11231 XSETINT (x
, (XINT (x
)
11232 + WINDOW_LEFT_EDGE_X (w
)
11234 ? window_box_left_offset (w
, TEXT_AREA
)
11236 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11237 frame_or_window
= w
->frame
;
11240 CHECK_LIVE_FRAME (frame_or_window
);
11242 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11245 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11246 doc
: /* Return position information for buffer POS in WINDOW.
11247 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11249 Return nil if position is not visible in window. Otherwise,
11250 the return value is similar to that returned by `event-start' for
11251 a mouse click at the upper left corner of the glyph corresponding
11252 to the given buffer position:
11253 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11254 IMAGE (DX . DY) (WIDTH . HEIGHT))
11255 The `posn-' functions access elements of such lists. */)
11256 (Lisp_Object pos
, Lisp_Object window
)
11261 window
= selected_window
;
11263 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11266 Lisp_Object x
= XCAR (tem
);
11267 Lisp_Object y
= XCAR (XCDR (tem
));
11269 /* Point invisible due to hscrolling? */
11272 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11280 * Set up a new kboard object with reasonable initial values.
11283 init_kboard (KBOARD
*kb
)
11285 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11286 KVAR (kb
, Vlast_command
) = Qnil
;
11287 KVAR (kb
, Vreal_last_command
) = Qnil
;
11288 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11289 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11290 KVAR (kb
, Vprefix_arg
) = Qnil
;
11291 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11292 KVAR (kb
, kbd_queue
) = Qnil
;
11293 kb
->kbd_queue_has_data
= 0;
11294 kb
->immediate_echo
= 0;
11295 KVAR (kb
, echo_string
) = Qnil
;
11296 kb
->echo_after_prompt
= -1;
11297 kb
->kbd_macro_buffer
= 0;
11298 kb
->kbd_macro_bufsize
= 0;
11299 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11300 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11301 kb
->reference_count
= 0;
11302 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11303 KVAR (kb
, system_key_syms
) = Qnil
;
11304 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11305 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11306 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11307 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11308 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11312 * Destroy the contents of a kboard object, but not the object itself.
11313 * We use this just before deleting it, or if we're going to initialize
11314 * it a second time.
11317 wipe_kboard (KBOARD
*kb
)
11319 xfree (kb
->kbd_macro_buffer
);
11322 /* Free KB and memory referenced from it. */
11325 delete_kboard (KBOARD
*kb
)
11329 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11332 *kbp
= kb
->next_kboard
;
11334 /* Prevent a dangling reference to KB. */
11335 if (kb
== current_kboard
11336 && FRAMEP (selected_frame
)
11337 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11339 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11341 if (current_kboard
== kb
)
11350 init_keyboard (void)
11352 /* This is correct before outermost invocation of the editor loop */
11353 command_loop_level
= -1;
11354 immediate_quit
= 0;
11355 quit_char
= Ctl ('g');
11356 Vunread_command_events
= Qnil
;
11357 unread_command_char
= -1;
11358 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11360 recent_keys_index
= 0;
11361 kbd_fetch_ptr
= kbd_buffer
;
11362 kbd_store_ptr
= kbd_buffer
;
11363 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11364 do_mouse_tracking
= Qnil
;
11367 interrupt_input_blocked
= 0;
11368 interrupt_input_pending
= 0;
11370 pending_signals
= 0;
11373 /* This means that command_loop_1 won't try to select anything the first
11375 internal_last_event_frame
= Qnil
;
11376 Vlast_event_frame
= internal_last_event_frame
;
11378 current_kboard
= initial_kboard
;
11379 /* Re-initialize the keyboard again. */
11380 wipe_kboard (current_kboard
);
11381 init_kboard (current_kboard
);
11382 /* A value of nil for Vwindow_system normally means a tty, but we also use
11383 it for the initial terminal since there is no window system there. */
11384 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11386 if (!noninteractive
)
11388 /* Before multi-tty support, these handlers used to be installed
11389 only if the current session was a tty session. Now an Emacs
11390 session may have multiple display types, so we always handle
11391 SIGINT. There is special code in interrupt_signal to exit
11392 Emacs on SIGINT when there are no termcap frames on the
11393 controlling terminal. */
11394 signal (SIGINT
, interrupt_signal
);
11396 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11397 SIGQUIT and we can't tell which one it will give us. */
11398 signal (SIGQUIT
, interrupt_signal
);
11399 #endif /* not DOS_NT */
11401 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11403 if (!noninteractive
)
11404 signal (SIGIO
, input_available_signal
);
11407 /* Use interrupt input by default, if it works and noninterrupt input
11408 has deficiencies. */
11410 #ifdef INTERRUPT_INPUT
11411 interrupt_input
= 1;
11413 interrupt_input
= 0;
11419 if (keyboard_init_hook
)
11420 (*keyboard_init_hook
) ();
11422 #ifdef POLL_FOR_INPUT
11424 poll_suppress_count
= 1;
11429 /* This type's only use is in syms_of_keyboard, to initialize the
11430 event header symbols and put properties on them. */
11431 struct event_head
{
11437 static const struct event_head head_table
[] = {
11438 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11439 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11440 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11441 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11442 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11443 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11444 /* `select-window' should be handled just like `switch-frame'
11445 in read_key_sequence. */
11446 {&Qselect_window
, "select-window", &Qswitch_frame
}
11450 syms_of_keyboard (void)
11452 pending_funcalls
= Qnil
;
11453 staticpro (&pending_funcalls
);
11455 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11456 staticpro (&Vlispy_mouse_stem
);
11459 DEFSYM (QCimage
, ":image");
11460 DEFSYM (Qhelp_echo
, "help-echo");
11461 DEFSYM (QCrtl
, ":rtl");
11463 staticpro (&item_properties
);
11464 item_properties
= Qnil
;
11466 staticpro (&tool_bar_item_properties
);
11467 tool_bar_item_properties
= Qnil
;
11468 staticpro (&tool_bar_items_vector
);
11469 tool_bar_items_vector
= Qnil
;
11471 staticpro (&real_this_command
);
11472 real_this_command
= Qnil
;
11474 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11475 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11476 DEFSYM (Qself_insert_command
, "self-insert-command");
11477 DEFSYM (Qforward_char
, "forward-char");
11478 DEFSYM (Qbackward_char
, "backward-char");
11479 DEFSYM (Qdisabled
, "disabled");
11480 DEFSYM (Qundefined
, "undefined");
11481 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11482 DEFSYM (Qpost_command_hook
, "post-command-hook");
11483 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11484 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11485 DEFSYM (Qfunction_key
, "function-key");
11486 DEFSYM (Qmouse_click
, "mouse-click");
11487 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11488 DEFSYM (Qsave_session
, "save-session");
11489 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11490 DEFSYM (Qmenu_enable
, "menu-enable");
11492 #if defined (WINDOWSNT)
11493 DEFSYM (Qlanguage_change
, "language-change");
11497 DEFSYM (Qdbus_event
, "dbus-event");
11500 DEFSYM (QCenable
, ":enable");
11501 DEFSYM (QCvisible
, ":visible");
11502 DEFSYM (QChelp
, ":help");
11503 DEFSYM (QCfilter
, ":filter");
11504 DEFSYM (QCbutton
, ":button");
11505 DEFSYM (QCkeys
, ":keys");
11506 DEFSYM (QCkey_sequence
, ":key-sequence");
11507 DEFSYM (QCtoggle
, ":toggle");
11508 DEFSYM (QCradio
, ":radio");
11509 DEFSYM (QClabel
, ":label");
11510 DEFSYM (QCvert_only
, ":vert-only");
11512 DEFSYM (Qmode_line
, "mode-line");
11513 DEFSYM (Qvertical_line
, "vertical-line");
11514 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11515 DEFSYM (Qmenu_bar
, "menu-bar");
11517 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11518 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11521 DEFSYM (Qabove_handle
, "above-handle");
11522 DEFSYM (Qhandle
, "handle");
11523 DEFSYM (Qbelow_handle
, "below-handle");
11524 DEFSYM (Qup
, "up");
11525 DEFSYM (Qdown
, "down");
11526 DEFSYM (Qtop
, "top");
11527 DEFSYM (Qbottom
, "bottom");
11528 DEFSYM (Qend_scroll
, "end-scroll");
11529 DEFSYM (Qratio
, "ratio");
11531 DEFSYM (Qevent_kind
, "event-kind");
11532 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11533 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11534 DEFSYM (Qmodifier_cache
, "modifier-cache");
11536 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11537 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11539 DEFSYM (Qpolling_period
, "polling-period");
11541 DEFSYM (Qx_set_selection
, "x-set-selection");
11542 DEFSYM (QPRIMARY
, "PRIMARY");
11543 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11544 DEFSYM (Qhandle_select_window
, "handle-select-window");
11546 DEFSYM (Qinput_method_function
, "input-method-function");
11547 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11548 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11550 DEFSYM (Qhelp_form_show
, "help-form-show");
11552 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11553 Fset (Qinput_method_use_echo_area
, Qnil
);
11555 last_point_position_buffer
= Qnil
;
11556 last_point_position_window
= Qnil
;
11560 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11562 for (i
= 0; i
< len
; i
++)
11564 const struct event_head
*p
= &head_table
[i
];
11565 *p
->var
= intern_c_string (p
->name
);
11566 staticpro (p
->var
);
11567 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11568 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11572 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11573 staticpro (&button_down_location
);
11574 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11575 staticpro (&mouse_syms
);
11576 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11577 / sizeof (lispy_wheel_names
[0])),
11579 staticpro (&wheel_syms
);
11583 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11585 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11586 for (i
= 0; i
< len
; i
++)
11587 if (modifier_names
[i
])
11588 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11589 staticpro (&modifier_symbols
);
11592 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11593 staticpro (&recent_keys
);
11595 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11596 staticpro (&this_command_keys
);
11598 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11599 staticpro (&raw_keybuf
);
11601 DEFSYM (Qextended_command_history
, "extended-command-history");
11602 Fset (Qextended_command_history
, Qnil
);
11604 accent_key_syms
= Qnil
;
11605 staticpro (&accent_key_syms
);
11607 func_key_syms
= Qnil
;
11608 staticpro (&func_key_syms
);
11610 drag_n_drop_syms
= Qnil
;
11611 staticpro (&drag_n_drop_syms
);
11613 unread_switch_frame
= Qnil
;
11614 staticpro (&unread_switch_frame
);
11616 internal_last_event_frame
= Qnil
;
11617 staticpro (&internal_last_event_frame
);
11619 read_key_sequence_cmd
= Qnil
;
11620 staticpro (&read_key_sequence_cmd
);
11621 read_key_sequence_remapped
= Qnil
;
11622 staticpro (&read_key_sequence_remapped
);
11624 menu_bar_one_keymap_changed_items
= Qnil
;
11625 staticpro (&menu_bar_one_keymap_changed_items
);
11627 menu_bar_items_vector
= Qnil
;
11628 staticpro (&menu_bar_items_vector
);
11630 help_form_saved_window_configs
= Qnil
;
11631 staticpro (&help_form_saved_window_configs
);
11633 defsubr (&Scurrent_idle_time
);
11634 defsubr (&Sevent_symbol_parse_modifiers
);
11635 defsubr (&Sevent_convert_list
);
11636 defsubr (&Sread_key_sequence
);
11637 defsubr (&Sread_key_sequence_vector
);
11638 defsubr (&Srecursive_edit
);
11639 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11640 defsubr (&Strack_mouse
);
11642 defsubr (&Sinput_pending_p
);
11643 defsubr (&Scommand_execute
);
11644 defsubr (&Srecent_keys
);
11645 defsubr (&Sthis_command_keys
);
11646 defsubr (&Sthis_command_keys_vector
);
11647 defsubr (&Sthis_single_command_keys
);
11648 defsubr (&Sthis_single_command_raw_keys
);
11649 defsubr (&Sreset_this_command_lengths
);
11650 defsubr (&Sclear_this_command_keys
);
11651 defsubr (&Ssuspend_emacs
);
11652 defsubr (&Sabort_recursive_edit
);
11653 defsubr (&Sexit_recursive_edit
);
11654 defsubr (&Srecursion_depth
);
11655 defsubr (&Stop_level
);
11656 defsubr (&Sdiscard_input
);
11657 defsubr (&Sopen_dribble_file
);
11658 defsubr (&Sset_input_interrupt_mode
);
11659 defsubr (&Sset_output_flow_control
);
11660 defsubr (&Sset_input_meta_mode
);
11661 defsubr (&Sset_quit_char
);
11662 defsubr (&Sset_input_mode
);
11663 defsubr (&Scurrent_input_mode
);
11664 defsubr (&Sposn_at_point
);
11665 defsubr (&Sposn_at_x_y
);
11667 DEFVAR_LISP ("last-command-event", last_command_event
,
11668 doc
: /* Last input event that was part of a command. */);
11670 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11671 doc
: /* Last input event in a command, except for mouse menu events.
11672 Mouse menus give back keys that don't look like mouse events;
11673 this variable holds the actual mouse event that led to the menu,
11674 so that you can determine whether the command was run by mouse or not. */);
11676 DEFVAR_LISP ("last-input-event", last_input_event
,
11677 doc
: /* Last input event. */);
11679 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11680 doc
: /* List of events to be read as the command input.
11681 These events are processed first, before actual keyboard input.
11682 Events read from this list are not normally added to `this-command-keys',
11683 as they will already have been added once as they were read for the first time.
11684 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11685 Vunread_command_events
= Qnil
;
11687 DEFVAR_INT ("unread-command-char", unread_command_char
,
11688 doc
: /* If not -1, an object to be read as next command input event. */);
11690 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11691 doc
: /* List of events to be processed as input by input methods.
11692 These events are processed before `unread-command-events'
11693 and actual keyboard input, but are not given to `input-method-function'. */);
11694 Vunread_post_input_method_events
= Qnil
;
11696 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11697 doc
: /* List of events to be processed as input by input methods.
11698 These events are processed after `unread-command-events', but
11699 before actual keyboard input.
11700 If there's an active input method, the events are given to
11701 `input-method-function'. */);
11702 Vunread_input_method_events
= Qnil
;
11704 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11705 doc
: /* Meta-prefix character code.
11706 Meta-foo as command input turns into this character followed by foo. */);
11707 XSETINT (meta_prefix_char
, 033);
11709 DEFVAR_KBOARD ("last-command", Vlast_command
,
11710 doc
: /* The last command executed.
11711 Normally a symbol with a function definition, but can be whatever was found
11712 in the keymap, or whatever the variable `this-command' was set to by that
11715 The value `mode-exit' is special; it means that the previous command
11716 read an event that told it to exit, and it did so and unread that event.
11717 In other words, the present command is the event that made the previous
11720 The value `kill-region' is special; it means that the previous command
11721 was a kill command.
11723 `last-command' has a separate binding for each terminal device.
11724 See Info node `(elisp)Multiple Terminals'. */);
11726 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11727 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11729 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11730 doc
: /* Last command that may be repeated.
11731 The last command executed that was not bound to an input event.
11732 This is the command `repeat' will try to repeat. */);
11734 DEFVAR_LISP ("this-command", Vthis_command
,
11735 doc
: /* The command now being executed.
11736 The command can set this variable; whatever is put here
11737 will be in `last-command' during the following command. */);
11738 Vthis_command
= Qnil
;
11740 DEFVAR_LISP ("this-command-keys-shift-translated",
11741 Vthis_command_keys_shift_translated
,
11742 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11743 Shift-translation occurs when there is no binding for the key sequence
11744 as entered, but a binding was found by changing an upper-case letter
11745 to lower-case, or a shifted function key to an unshifted one. */);
11746 Vthis_command_keys_shift_translated
= Qnil
;
11748 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11749 doc
: /* The command bound to the current key sequence before remapping.
11750 It equals `this-command' if the original command was not remapped through
11751 any of the active keymaps. Otherwise, the value of `this-command' is the
11752 result of looking up the original command in the active keymaps. */);
11753 Vthis_original_command
= Qnil
;
11755 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11756 doc
: /* Number of input events between auto-saves.
11757 Zero means disable autosaving due to number of characters typed. */);
11758 auto_save_interval
= 300;
11760 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11761 doc
: /* Number of seconds idle time before auto-save.
11762 Zero or nil means disable auto-saving due to idleness.
11763 After auto-saving due to this many seconds of idle time,
11764 Emacs also does a garbage collection if that seems to be warranted. */);
11765 XSETFASTINT (Vauto_save_timeout
, 30);
11767 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11768 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11769 The value may be integer or floating point.
11770 If the value is zero, don't echo at all. */);
11771 Vecho_keystrokes
= make_number (1);
11773 DEFVAR_INT ("polling-period", polling_period
,
11774 doc
: /* Interval between polling for input during Lisp execution.
11775 The reason for polling is to make C-g work to stop a running program.
11776 Polling is needed only when using X windows and SIGIO does not work.
11777 Polling is automatically disabled in all other cases. */);
11778 polling_period
= 2;
11780 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11781 doc
: /* Maximum time between mouse clicks to make a double-click.
11782 Measured in milliseconds. The value nil means disable double-click
11783 recognition; t means double-clicks have no time limit and are detected
11784 by position only. */);
11785 Vdouble_click_time
= make_number (500);
11787 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11788 doc
: /* Maximum mouse movement between clicks to make a double-click.
11789 On window-system frames, value is the number of pixels the mouse may have
11790 moved horizontally or vertically between two clicks to make a double-click.
11791 On non window-system frames, value is interpreted in units of 1/8 characters
11794 This variable is also the threshold for motion of the mouse
11795 to count as a drag. */);
11796 double_click_fuzz
= 3;
11798 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11799 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11800 inhibit_local_menu_bar_menus
= 0;
11802 DEFVAR_INT ("num-input-keys", num_input_keys
,
11803 doc
: /* Number of complete key sequences read as input so far.
11804 This includes key sequences read from keyboard macros.
11805 The number is effectively the number of interactive command invocations. */);
11806 num_input_keys
= 0;
11808 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11809 doc
: /* Number of input events read from the keyboard so far.
11810 This does not include events generated by keyboard macros. */);
11811 num_nonmacro_input_events
= 0;
11813 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11814 doc
: /* The frame in which the most recently read event occurred.
11815 If the last event came from a keyboard macro, this is set to `macro'. */);
11816 Vlast_event_frame
= Qnil
;
11818 /* This variable is set up in sysdep.c. */
11819 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11820 doc
: /* The ERASE character as set by the user with stty. */);
11822 DEFVAR_LISP ("help-char", Vhelp_char
,
11823 doc
: /* Character to recognize as meaning Help.
11824 When it is read, do `(eval help-form)', and display result if it's a string.
11825 If the value of `help-form' is nil, this char can be read normally. */);
11826 XSETINT (Vhelp_char
, Ctl ('H'));
11828 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11829 doc
: /* List of input events to recognize as meaning Help.
11830 These work just like the value of `help-char' (see that). */);
11831 Vhelp_event_list
= Qnil
;
11833 DEFVAR_LISP ("help-form", Vhelp_form
,
11834 doc
: /* Form to execute when character `help-char' is read.
11835 If the form returns a string, that string is displayed.
11836 If `help-form' is nil, the help char is not recognized. */);
11839 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11840 doc
: /* Command to run when `help-char' character follows a prefix key.
11841 This command is used only when there is no actual binding
11842 for that character after that prefix key. */);
11843 Vprefix_help_command
= Qnil
;
11845 DEFVAR_LISP ("top-level", Vtop_level
,
11846 doc
: /* Form to evaluate when Emacs starts up.
11847 Useful to set before you dump a modified Emacs. */);
11850 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11851 doc
: /* Translate table for local keyboard input, or nil.
11852 If non-nil, the value should be a char-table. Each character read
11853 from the keyboard is looked up in this char-table. If the value found
11854 there is non-nil, then it is used instead of the actual input character.
11856 The value can also be a string or vector, but this is considered obsolete.
11857 If it is a string or vector of length N, character codes N and up are left
11858 untranslated. In a vector, an element which is nil means "no translation".
11860 This is applied to the characters supplied to input methods, not their
11861 output. See also `translation-table-for-input'.
11863 This variable has a separate binding for each terminal.
11864 See Info node `(elisp)Multiple Terminals'. */);
11866 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11867 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11868 \(Even if the operating system has support for stopping a process.\) */);
11869 cannot_suspend
= 0;
11871 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11872 doc
: /* Non-nil means prompt with menus when appropriate.
11873 This is done when reading from a keymap that has a prompt string,
11874 for elements that have prompt strings.
11875 The menu is displayed on the screen
11876 if X menus were enabled at configuration
11877 time and the previous event was a mouse click prefix key.
11878 Otherwise, menu prompting uses the echo area. */);
11879 menu_prompting
= 1;
11881 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11882 doc
: /* Character to see next line of menu prompt.
11883 Type this character while in a menu prompt to rotate around the lines of it. */);
11884 XSETINT (menu_prompt_more_char
, ' ');
11886 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11887 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11888 Emacs applies the modifiers of the character stored here to each keyboard
11889 character it reads. For example, after evaluating the expression
11890 (setq extra-keyboard-modifiers ?\\C-x)
11891 all input characters will have the control modifier applied to them.
11893 Note that the character ?\\C-@, equivalent to the integer zero, does
11894 not count as a control character; rather, it counts as a character
11895 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11896 cancels any modification. */);
11897 extra_keyboard_modifiers
= 0;
11899 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11900 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11901 The command loop sets this to nil before each command,
11902 and tests the value when the command returns.
11903 Buffer modification stores t in this variable. */);
11904 Vdeactivate_mark
= Qnil
;
11905 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11907 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11908 doc
: /* Normal hook run before each command is executed.
11909 If an unhandled error happens in running this hook,
11910 the function in which the error occurred is unconditionally removed, since
11911 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11912 Vpre_command_hook
= Qnil
;
11914 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11915 doc
: /* Normal hook run after each command is executed.
11916 If an unhandled error happens in running this hook,
11917 the function in which the error occurred is unconditionally removed, since
11918 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11919 Vpost_command_hook
= Qnil
;
11922 DEFVAR_LISP ("echo-area-clear-hook", ...,
11923 doc
: /* Normal hook run when clearing the echo area. */);
11925 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11926 Fset (Qecho_area_clear_hook
, Qnil
);
11928 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11929 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11930 Vlucid_menu_bar_dirty_flag
= Qnil
;
11932 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11933 doc
: /* List of menu bar items to move to the end of the menu bar.
11934 The elements of the list are event types that may have menu bar bindings. */);
11935 Vmenu_bar_final_items
= Qnil
;
11937 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11938 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11939 This is used internally by graphical displays that do not render
11940 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11941 Vtool_bar_separator_image_expression
= Qnil
;
11943 DEFVAR_KBOARD ("overriding-terminal-local-map",
11944 Voverriding_terminal_local_map
,
11945 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11946 If this variable is non-nil, it is used as a keymap instead of the
11947 buffer's local map, and the minor mode keymaps and text property keymaps.
11948 It also replaces `overriding-local-map'.
11950 This variable is intended to let commands such as `universal-argument'
11951 set up a different keymap for reading the next command.
11953 `overriding-terminal-local-map' has a separate binding for each
11955 See Info node `(elisp)Multiple Terminals'. */);
11957 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11958 doc
: /* Keymap that overrides all other local keymaps.
11959 If this variable is non-nil, it is used as a keymap--replacing the
11960 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11961 Voverriding_local_map
= Qnil
;
11963 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11964 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11965 Otherwise, the menu bar continues to reflect the buffer's local map
11966 and the minor mode maps regardless of `overriding-local-map'. */);
11967 Voverriding_local_map_menu_flag
= Qnil
;
11969 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11970 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11971 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11973 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11974 doc
: /* Non-nil means generate motion events for mouse motion. */);
11976 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11977 doc
: /* Alist of system-specific X windows key symbols.
11978 Each element should have the form (N . SYMBOL) where N is the
11979 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11980 and SYMBOL is its name.
11982 `system-key-alist' has a separate binding for each terminal device.
11983 See Info node `(elisp)Multiple Terminals'. */);
11985 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11986 doc
: /* Keymap that translates key sequences to key sequences during input.
11987 This is used mainly for mapping key sequences into some preferred
11988 key events (symbols).
11990 The `read-key-sequence' function replaces any subsequence bound by
11991 `local-function-key-map' with its binding. More precisely, when the
11992 active keymaps have no binding for the current key sequence but
11993 `local-function-key-map' binds a suffix of the sequence to a vector or
11994 string, `read-key-sequence' replaces the matching suffix with its
11995 binding, and continues with the new sequence.
11997 If the binding is a function, it is called with one argument (the prompt)
11998 and its return value (a key sequence) is used.
12000 The events that come from bindings in `local-function-key-map' are not
12001 themselves looked up in `local-function-key-map'.
12003 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12004 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12005 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12006 typing `ESC O P x' would return [f1 x].
12008 `local-function-key-map' has a separate binding for each terminal
12009 device. See Info node `(elisp)Multiple Terminals'. If you need to
12010 define a binding on all terminals, change `function-key-map'
12011 instead. Initially, `local-function-key-map' is an empty keymap that
12012 has `function-key-map' as its parent on all terminal devices. */);
12014 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12015 doc
: /* Keymap that decodes input escape sequences.
12016 This is used mainly for mapping ASCII function key sequences into
12017 real Emacs function key events (symbols).
12019 The `read-key-sequence' function replaces any subsequence bound by
12020 `input-decode-map' with its binding. Contrary to `function-key-map',
12021 this map applies its rebinding regardless of the presence of an ordinary
12022 binding. So it is more like `key-translation-map' except that it applies
12023 before `function-key-map' rather than after.
12025 If the binding is a function, it is called with one argument (the prompt)
12026 and its return value (a key sequence) is used.
12028 The events that come from bindings in `input-decode-map' are not
12029 themselves looked up in `input-decode-map'.
12031 This variable is keyboard-local. */);
12033 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12034 doc
: /* The parent keymap of all `local-function-key-map' instances.
12035 Function key definitions that apply to all terminal devices should go
12036 here. If a mapping is defined in both the current
12037 `local-function-key-map' binding and this variable, then the local
12038 definition will take precedence. */);
12039 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12041 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12042 doc
: /* Keymap of key translations that can override keymaps.
12043 This keymap works like `function-key-map', but comes after that,
12044 and its non-prefix bindings override ordinary bindings.
12045 Another difference is that it is global rather than keyboard-local. */);
12046 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12048 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12049 doc
: /* List of deferred actions to be performed at a later time.
12050 The precise format isn't relevant here; we just check whether it is nil. */);
12051 Vdeferred_action_list
= Qnil
;
12053 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12054 doc
: /* Function to call to handle deferred actions, after each command.
12055 This function is called with no arguments after each command
12056 whenever `deferred-action-list' is non-nil. */);
12057 Vdeferred_action_function
= Qnil
;
12059 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12060 doc
: /* List of warnings to be displayed after this command.
12061 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12062 as per the args of `display-warning' (which see).
12063 If this variable is non-nil, `delayed-warnings-hook' will be run
12064 immediately after running `post-command-hook'. */);
12065 Vdelayed_warnings_list
= Qnil
;
12067 DEFVAR_LISP ("timer-list", Vtimer_list
,
12068 doc
: /* List of active absolute time timers in order of increasing time. */);
12069 Vtimer_list
= Qnil
;
12071 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12072 doc
: /* List of active idle-time timers in order of increasing time. */);
12073 Vtimer_idle_list
= Qnil
;
12075 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12076 doc
: /* If non-nil, the function that implements the current input method.
12077 It's called with one argument, a printing character that was just read.
12078 \(That means a character with code 040...0176.)
12079 Typically this function uses `read-event' to read additional events.
12080 When it does so, it should first bind `input-method-function' to nil
12081 so it will not be called recursively.
12083 The function should return a list of zero or more events
12084 to be used as input. If it wants to put back some events
12085 to be reconsidered, separately, by the input method,
12086 it can add them to the beginning of `unread-command-events'.
12088 The input method function can find in `input-method-previous-message'
12089 the previous echo area message.
12091 The input method function should refer to the variables
12092 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12093 for guidance on what to do. */);
12094 Vinput_method_function
= Qnil
;
12096 DEFVAR_LISP ("input-method-previous-message",
12097 Vinput_method_previous_message
,
12098 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12099 This variable exists because `read-event' clears the echo area
12100 before running the input method. It is nil if there was no message. */);
12101 Vinput_method_previous_message
= Qnil
;
12103 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12104 doc
: /* If non-nil, the function that implements the display of help.
12105 It's called with one argument, the help string to display. */);
12106 Vshow_help_function
= Qnil
;
12108 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12109 doc
: /* If non-nil, suppress point adjustment after executing a command.
12111 After a command is executed, if point is moved into a region that has
12112 special properties (e.g. composition, display), we adjust point to
12113 the boundary of the region. But, when a command sets this variable to
12114 non-nil, we suppress the point adjustment.
12116 This variable is set to nil before reading a command, and is checked
12117 just after executing the command. */);
12118 Vdisable_point_adjustment
= Qnil
;
12120 DEFVAR_LISP ("global-disable-point-adjustment",
12121 Vglobal_disable_point_adjustment
,
12122 doc
: /* If non-nil, always suppress point adjustment.
12124 The default value is nil, in which case, point adjustment are
12125 suppressed only after special commands that set
12126 `disable-point-adjustment' (which see) to non-nil. */);
12127 Vglobal_disable_point_adjustment
= Qnil
;
12129 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12130 doc
: /* How long to display an echo-area message when the minibuffer is active.
12131 If the value is not a number, such messages don't time out. */);
12132 Vminibuffer_message_timeout
= make_number (2);
12134 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12135 doc
: /* If non-nil, any keyboard input throws to this symbol.
12136 The value of that variable is passed to `quit-flag' and later causes a
12137 peculiar kind of quitting. */);
12138 Vthrow_on_input
= Qnil
;
12140 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12141 doc
: /* If non-nil, function to output error messages.
12142 The arguments are the error data, a list of the form
12143 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12144 such as just as `condition-case' would bind its variable to,
12145 the context (a string which normally goes at the start of the message),
12146 and the Lisp function within which the error was signaled. */);
12147 Vcommand_error_function
= Qnil
;
12149 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12150 Venable_disabled_menus_and_buttons
,
12151 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12153 Help functions bind this to allow help on disabled menu items
12154 and tool-bar buttons. */);
12155 Venable_disabled_menus_and_buttons
= Qnil
;
12157 DEFVAR_LISP ("select-active-regions",
12158 Vselect_active_regions
,
12159 doc
: /* If non-nil, an active region automatically sets the primary selection.
12160 If the value is `only', only temporarily active regions (usually made
12161 by mouse-dragging or shift-selection) set the window selection.
12163 This takes effect only when Transient Mark mode is enabled. */);
12164 Vselect_active_regions
= Qt
;
12166 DEFVAR_LISP ("saved-region-selection",
12167 Vsaved_region_selection
,
12168 doc
: /* Contents of active region prior to buffer modification.
12169 If `select-active-regions' is non-nil, Emacs sets this to the
12170 text in the region before modifying the buffer. The next
12171 `deactivate-mark' call uses this to set the window selection. */);
12172 Vsaved_region_selection
= Qnil
;
12174 DEFVAR_LISP ("selection-inhibit-update-commands",
12175 Vselection_inhibit_update_commands
,
12176 doc
: /* List of commands which should not update the selection.
12177 Normally, if `select-active-regions' is non-nil and the mark remains
12178 active after a command (i.e. the mark was not deactivated), the Emacs
12179 command loop sets the selection to the text in the region. However,
12180 if the command is in this list, the selection is not updated. */);
12181 Vselection_inhibit_update_commands
12182 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12184 DEFVAR_LISP ("debug-on-event",
12186 doc
: /* Enter debugger on this event. When Emacs
12187 receives the special event specified by this variable, it will try to
12188 break into the debugger as soon as possible instead of processing the
12189 event normally through `special-event-map'.
12191 Currently, the only supported values for this
12192 variable are `sigusr1' and `sigusr2'. */);
12193 Vdebug_on_event
= intern_c_string ("sigusr2");
12195 /* Create the initial keyboard. */
12196 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12197 init_kboard (initial_kboard
);
12198 /* Vwindow_system is left at t for now. */
12199 initial_kboard
->next_kboard
= all_kboards
;
12200 all_kboards
= initial_kboard
;
12204 keys_of_keyboard (void)
12206 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12207 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12208 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12209 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12210 initial_define_key (meta_map
, 'x', "execute-extended-command");
12212 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12213 "handle-delete-frame");
12214 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12215 "ns-put-working-text");
12216 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12217 "ns-unput-working-text");
12218 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12219 current-prefix-arg, as is done in `handle-switch-frame'.
12220 But `handle-switch-frame is not run from the special-map.
12221 Commands from that map are run in a special way that automatically
12222 preserves the prefix-arg. Restoring the prefix arg here is not just
12223 redundant but harmful:
12225 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12226 - after the first prompt, the exit-minibuffer-hook is run which may
12227 iconify a frame and thus push a `iconify-frame' event.
12228 - after running exit-minibuffer-hook, current-prefix-arg is
12229 restored to the non-nil value it had before the prompt.
12230 - we enter the second prompt.
12231 current-prefix-arg is non-nil, prefix-arg is nil.
12232 - before running the first real event, we run the special iconify-frame
12233 event, but we pass the `special' arg to execute-command so
12234 current-prefix-arg and prefix-arg are left untouched.
12235 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12236 - the next key event will have a spuriously non-nil current-prefix-arg. */
12237 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12239 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12241 /* Handling it at such a low-level causes read_key_sequence to get
12242 * confused because it doesn't realize that the current_buffer was
12243 * changed by read_char.
12245 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12246 * "handle-select-window"); */
12247 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12248 "handle-save-session");
12251 /* Define a special event which is raised for dbus callback
12253 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12254 "dbus-handle-event");
12257 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12261 /* Mark the pointers in the kboard objects.
12262 Called by Fgarbage_collect. */
12264 mark_kboards (void)
12268 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12270 if (kb
->kbd_macro_buffer
)
12271 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12273 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12274 mark_object (KVAR (kb
, Vlast_command
));
12275 mark_object (KVAR (kb
, Vreal_last_command
));
12276 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12277 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12278 mark_object (KVAR (kb
, Vprefix_arg
));
12279 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12280 mark_object (KVAR (kb
, kbd_queue
));
12281 mark_object (KVAR (kb
, defining_kbd_macro
));
12282 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12283 mark_object (KVAR (kb
, Vsystem_key_alist
));
12284 mark_object (KVAR (kb
, system_key_syms
));
12285 mark_object (KVAR (kb
, Vwindow_system
));
12286 mark_object (KVAR (kb
, Vinput_decode_map
));
12287 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12288 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12289 mark_object (KVAR (kb
, echo_string
));
12292 struct input_event
*event
;
12293 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12295 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12296 event
= kbd_buffer
;
12297 if (event
->kind
!= SELECTION_REQUEST_EVENT
12298 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12300 mark_object (event
->x
);
12301 mark_object (event
->y
);
12303 mark_object (event
->frame_or_window
);
12304 mark_object (event
->arg
);