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
;
335 Lisp_Object Qxwidget_event
;
337 static Lisp_Object Qconfig_changed_event
;
339 /* Lisp_Object Qmouse_movement; - also an event header */
341 /* Properties of event headers. */
342 Lisp_Object Qevent_kind
;
343 static Lisp_Object Qevent_symbol_elements
;
345 /* Menu and tool bar item parts. */
346 static Lisp_Object Qmenu_enable
;
347 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
348 Lisp_Object QCfilter
;
350 /* Non-nil disable property on a command means
351 do not execute it; call disabled-command-function's value instead. */
352 Lisp_Object QCtoggle
, QCradio
;
353 static Lisp_Object QCbutton
, QClabel
;
355 static Lisp_Object QCvert_only
;
357 /* An event header symbol HEAD may have a property named
358 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
359 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
360 mask of modifiers applied to it. If present, this is used to help
361 speed up parse_modifiers. */
362 Lisp_Object Qevent_symbol_element_mask
;
364 /* An unmodified event header BASE may have a property named
365 Qmodifier_cache, which is an alist mapping modifier masks onto
366 modified versions of BASE. If present, this helps speed up
368 static Lisp_Object Qmodifier_cache
;
370 /* Symbols to use for parts of windows. */
371 Lisp_Object Qmode_line
;
372 Lisp_Object Qvertical_line
;
373 static Lisp_Object Qvertical_scroll_bar
;
374 Lisp_Object Qmenu_bar
;
376 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
377 static Lisp_Object
command_loop (void);
378 static Lisp_Object Qextended_command_history
;
379 EMACS_TIME
timer_check (void);
381 static void record_menu_key (Lisp_Object c
);
382 static void echo_now (void);
383 static int echo_length (void);
385 static Lisp_Object Qpolling_period
;
387 /* Incremented whenever a timer is run. */
390 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
392 EMACS_TIME
*input_available_clear_time
;
394 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
395 Default is 1 if INTERRUPT_INPUT is defined. */
398 /* Nonzero while interrupts are temporarily deferred during redisplay. */
399 int interrupts_deferred
;
401 /* Allow m- file to inhibit use of FIONREAD. */
402 #ifdef BROKEN_FIONREAD
406 /* We are unable to use interrupts if FIONREAD is not available,
407 so flush SIGIO so we won't try. */
408 #if !defined (FIONREAD)
414 /* If we support a window system, turn on the code to poll periodically
415 to detect C-g. It isn't actually used when doing interrupt input. */
416 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
417 #define POLL_FOR_INPUT
420 /* The time when Emacs started being idle. */
422 static EMACS_TIME timer_idleness_start_time
;
424 /* After Emacs stops being idle, this saves the last value
425 of timer_idleness_start_time from when it was idle. */
427 static EMACS_TIME timer_last_idleness_start_time
;
430 /* Global variable declarations. */
432 /* Flags for readable_events. */
433 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
434 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
435 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
437 /* Function for init_keyboard to call with no args (if nonzero). */
438 static void (*keyboard_init_hook
) (void);
440 static int read_avail_input (int);
441 static void get_input_pending (int *, int);
442 static int readable_events (int);
443 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
445 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
447 static Lisp_Object
make_lispy_event (struct input_event
*);
448 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
449 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
450 enum scroll_bar_part
,
451 Lisp_Object
, Lisp_Object
,
454 static Lisp_Object
modify_event_symbol (EMACS_INT
, unsigned, Lisp_Object
,
455 Lisp_Object
, const char *const *,
456 Lisp_Object
*, EMACS_INT
);
457 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
458 static int help_char_p (Lisp_Object
);
459 static void save_getcjmp (jmp_buf);
460 static void restore_getcjmp (jmp_buf);
461 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
462 static void clear_event (struct input_event
*);
463 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
464 static void interrupt_signal (int signalnum
);
466 static void input_available_signal (int signo
);
468 static Lisp_Object (Fcommand_execute
) (Lisp_Object
, Lisp_Object
, Lisp_Object
,
470 static void handle_interrupt (void);
471 static void quit_throw_to_read_char (int) NO_RETURN
;
472 static void process_special_events (void);
473 static void timer_start_idle (void);
474 static void timer_stop_idle (void);
475 static void timer_resume_idle (void);
476 static void handle_user_signal (int);
477 static char *find_user_signal_name (int);
478 static int store_user_signal_events (void);
481 /* Add C to the echo string, if echoing is going on.
482 C can be a character, which is printed prettily ("M-C-x" and all that
483 jazz), or a symbol, whose name is printed. */
486 echo_char (Lisp_Object c
)
488 if (current_kboard
->immediate_echo
)
490 int size
= KEY_DESCRIPTION_SIZE
+ 100;
491 char *buffer
= (char *) alloca (size
);
493 Lisp_Object echo_string
;
495 echo_string
= KVAR (current_kboard
, echo_string
);
497 /* If someone has passed us a composite event, use its head symbol. */
502 ptr
= push_key_description (XINT (c
), ptr
, 1);
504 else if (SYMBOLP (c
))
506 Lisp_Object name
= SYMBOL_NAME (c
);
507 int nbytes
= SBYTES (name
);
509 if (size
- (ptr
- buffer
) < nbytes
)
511 int offset
= ptr
- buffer
;
512 size
= max (2 * size
, size
+ nbytes
);
513 buffer
= (char *) alloca (size
);
514 ptr
= buffer
+ offset
;
517 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
518 STRING_MULTIBYTE (name
), 1);
521 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
524 const char *text
= " (Type ? for further options)";
525 int len
= strlen (text
);
527 if (size
- (ptr
- buffer
) < len
)
529 int offset
= ptr
- buffer
;
531 buffer
= (char *) alloca (size
);
532 ptr
= buffer
+ offset
;
535 memcpy (ptr
, text
, len
);
539 /* Replace a dash from echo_dash with a space, otherwise
540 add a space at the end as a separator between keys. */
541 if (STRINGP (echo_string
)
542 && SCHARS (echo_string
) > 1)
544 Lisp_Object last_char
, prev_char
, idx
;
546 idx
= make_number (SCHARS (echo_string
) - 2);
547 prev_char
= Faref (echo_string
, idx
);
549 idx
= make_number (SCHARS (echo_string
) - 1);
550 last_char
= Faref (echo_string
, idx
);
552 /* We test PREV_CHAR to make sure this isn't the echoing
554 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
555 Faset (echo_string
, idx
, make_number (' '));
557 echo_string
= concat2 (echo_string
, build_string (" "));
559 else if (STRINGP (echo_string
))
560 echo_string
= concat2 (echo_string
, build_string (" "));
562 KVAR (current_kboard
, echo_string
)
563 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
569 /* Temporarily add a dash to the end of the echo string if it's not
570 empty, so that it serves as a mini-prompt for the very next character. */
575 /* Do nothing if not echoing at all. */
576 if (NILP (KVAR (current_kboard
, echo_string
)))
579 if (this_command_key_count
== 0)
582 if (!current_kboard
->immediate_echo
583 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
586 /* Do nothing if we just printed a prompt. */
587 if (current_kboard
->echo_after_prompt
588 == SCHARS (KVAR (current_kboard
, echo_string
)))
591 /* Do nothing if we have already put a dash at the end. */
592 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
594 Lisp_Object last_char
, prev_char
, idx
;
596 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
597 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
599 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
600 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
602 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
606 /* Put a dash at the end of the buffer temporarily,
607 but make it go away when the next character is added. */
608 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
613 /* Display the current echo string, and begin echoing if not already
619 if (!current_kboard
->immediate_echo
)
622 current_kboard
->immediate_echo
= 1;
624 for (i
= 0; i
< this_command_key_count
; i
++)
628 /* Set before_command_echo_length to the value that would
629 have been saved before the start of this subcommand in
630 command_loop_1, if we had already been echoing then. */
631 if (i
== this_single_command_key_start
)
632 before_command_echo_length
= echo_length ();
634 c
= XVECTOR (this_command_keys
)->contents
[i
];
635 if (! (EVENT_HAS_PARAMETERS (c
)
636 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
640 /* Set before_command_echo_length to the value that would
641 have been saved before the start of this subcommand in
642 command_loop_1, if we had already been echoing then. */
643 if (this_command_key_count
== this_single_command_key_start
)
644 before_command_echo_length
= echo_length ();
646 /* Put a dash at the end to invite the user to type more. */
651 message3_nolog (KVAR (current_kboard
, echo_string
),
652 SBYTES (KVAR (current_kboard
, echo_string
)),
653 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
656 /* Record in what buffer we echoed, and from which kboard. */
657 echo_message_buffer
= echo_area_buffer
[0];
658 echo_kboard
= current_kboard
;
660 if (waiting_for_input
&& !NILP (Vquit_flag
))
661 quit_throw_to_read_char (0);
664 /* Turn off echoing, for the start of a new command. */
667 cancel_echoing (void)
669 current_kboard
->immediate_echo
= 0;
670 current_kboard
->echo_after_prompt
= -1;
671 KVAR (current_kboard
, echo_string
) = Qnil
;
672 ok_to_echo_at_next_pause
= NULL
;
674 echo_message_buffer
= Qnil
;
677 /* Return the length of the current echo string. */
682 return (STRINGP (KVAR (current_kboard
, echo_string
))
683 ? SCHARS (KVAR (current_kboard
, echo_string
))
687 /* Truncate the current echo message to its first LEN chars.
688 This and echo_char get used by read_key_sequence when the user
689 switches frames while entering a key sequence. */
692 echo_truncate (EMACS_INT nchars
)
694 if (STRINGP (KVAR (current_kboard
, echo_string
)))
695 KVAR (current_kboard
, echo_string
)
696 = Fsubstring (KVAR (current_kboard
, echo_string
),
697 make_number (0), make_number (nchars
));
698 truncate_echo_area (nchars
);
702 /* Functions for manipulating this_command_keys. */
704 add_command_key (Lisp_Object key
)
706 #if 0 /* Not needed after we made Freset_this_command_lengths
707 do the job immediately. */
708 /* If reset-this-command-length was called recently, obey it now.
709 See the doc string of that function for an explanation of why. */
710 if (before_command_restore_flag
)
712 this_command_key_count
= before_command_key_count_1
;
713 if (this_command_key_count
< this_single_command_key_start
)
714 this_single_command_key_start
= this_command_key_count
;
715 echo_truncate (before_command_echo_length_1
);
716 before_command_restore_flag
= 0;
720 if (this_command_key_count
>= ASIZE (this_command_keys
))
721 this_command_keys
= larger_vector (this_command_keys
,
722 2 * ASIZE (this_command_keys
),
725 ASET (this_command_keys
, this_command_key_count
, key
);
726 ++this_command_key_count
;
731 recursive_edit_1 (void)
733 int count
= SPECPDL_INDEX ();
736 if (command_loop_level
> 0)
738 specbind (Qstandard_output
, Qt
);
739 specbind (Qstandard_input
, Qt
);
742 #ifdef HAVE_WINDOW_SYSTEM
743 /* The command loop has started an hourglass timer, so we have to
744 cancel it here, otherwise it will fire because the recursive edit
745 can take some time. Do not check for display_hourglass_p here,
746 because it could already be nil. */
750 /* This function may have been called from a debugger called from
751 within redisplay, for instance by Edebugging a function called
752 from fontification-functions. We want to allow redisplay in
753 the debugging session.
755 The recursive edit is left with a `(throw exit ...)'. The `exit'
756 tag is not caught anywhere in redisplay, i.e. when we leave the
757 recursive edit, the original redisplay leading to the recursive
758 edit will be unwound. The outcome should therefore be safe. */
759 specbind (Qinhibit_redisplay
, Qnil
);
762 val
= command_loop ();
764 Fsignal (Qquit
, Qnil
);
765 /* Handle throw from read_minibuf when using minibuffer
766 while it's active but we're in another window. */
768 xsignal1 (Qerror
, val
);
770 return unbind_to (count
, Qnil
);
773 /* When an auto-save happens, record the "time", and don't do again soon. */
776 record_auto_save (void)
778 last_auto_save
= num_nonmacro_input_events
;
781 /* Make an auto save happen as soon as possible at command level. */
785 force_auto_save_soon (void)
787 last_auto_save
= - auto_save_interval
- 1;
789 record_asynch_buffer_change ();
793 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
794 doc
: /* Invoke the editor command loop recursively.
795 To get out of the recursive edit, a command can do `(throw 'exit nil)';
796 that tells this function to return.
797 Alternatively, `(throw 'exit t)' makes this function signal an error.
798 This function is called by the editor initialization to begin editing. */)
801 int count
= SPECPDL_INDEX ();
804 /* If we enter while input is blocked, don't lock up here.
805 This may happen through the debugger during redisplay. */
809 command_loop_level
++;
810 update_mode_lines
= 1;
812 if (command_loop_level
813 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
814 buffer
= Fcurrent_buffer ();
818 /* If we leave recursive_edit_1 below with a `throw' for instance,
819 like it is done in the splash screen display, we have to
820 make sure that we restore single_kboard as command_loop_1
821 would have done if it were left normally. */
822 if (command_loop_level
> 0)
823 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
824 record_unwind_protect (recursive_edit_unwind
, buffer
);
827 return unbind_to (count
, Qnil
);
831 recursive_edit_unwind (Lisp_Object buffer
)
833 if (BUFFERP (buffer
))
834 Fset_buffer (buffer
);
836 command_loop_level
--;
837 update_mode_lines
= 1;
842 #if 0 /* These two functions are now replaced with
843 temporarily_switch_to_single_kboard. */
847 #if 0 /* Theory: if there's anything in Vunread_command_events,
848 it will right away be read by read_key_sequence,
849 and then if we do switch KBOARDS, it will go into the side
850 queue then. So we don't need to do anything special here -- rms. */
851 if (CONSP (Vunread_command_events
))
853 current_kboard
->kbd_queue
854 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
855 current_kboard
->kbd_queue_has_data
= 1;
857 Vunread_command_events
= Qnil
;
862 /* Switch to the single-kboard state, making current_kboard
863 the only KBOARD from which further input is accepted. */
866 single_kboard_state ()
872 /* If we're in single_kboard state for kboard KBOARD,
876 not_single_kboard_state (KBOARD
*kboard
)
878 if (kboard
== current_kboard
)
882 /* Maintain a stack of kboards, so other parts of Emacs
883 can switch temporarily to the kboard of a given frame
884 and then revert to the previous status. */
889 struct kboard_stack
*next
;
892 static struct kboard_stack
*kboard_stack
;
895 push_kboard (struct kboard
*k
)
897 struct kboard_stack
*p
898 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
900 p
->next
= kboard_stack
;
901 p
->kboard
= current_kboard
;
911 struct kboard_stack
*p
= kboard_stack
;
913 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
915 if (t
->kboard
== p
->kboard
)
917 current_kboard
= p
->kboard
;
924 /* The terminal we remembered has been deleted. */
925 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
928 kboard_stack
= p
->next
;
932 /* Switch to single_kboard mode, making current_kboard the only KBOARD
933 from which further input is accepted. If F is non-nil, set its
934 KBOARD as the current keyboard.
936 This function uses record_unwind_protect to return to the previous
939 If Emacs is already in single_kboard mode, and F's keyboard is
940 locked, then this function will throw an error. */
943 temporarily_switch_to_single_kboard (struct frame
*f
)
945 int was_locked
= single_kboard
;
948 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
949 /* We can not switch keyboards while in single_kboard mode.
950 In rare cases, Lisp code may call `recursive-edit' (or
951 `read-minibuffer' or `y-or-n-p') after it switched to a
952 locked frame. For example, this is likely to happen
953 when server.el connects to a new terminal while Emacs is in
954 single_kboard mode. It is best to throw an error instead
955 of presenting the user with a frozen screen. */
956 error ("Terminal %d is locked, cannot read from it",
957 FRAME_TERMINAL (f
)->id
);
959 /* This call is unnecessary, but helps
960 `restore_kboard_configuration' discover if somebody changed
961 `current_kboard' behind our back. */
962 push_kboard (current_kboard
);
965 current_kboard
= FRAME_KBOARD (f
);
967 record_unwind_protect (restore_kboard_configuration
,
968 (was_locked
? Qt
: Qnil
));
971 #if 0 /* This function is not needed anymore. */
973 record_single_kboard_state ()
976 push_kboard (current_kboard
);
977 record_unwind_protect (restore_kboard_configuration
,
978 (single_kboard
? Qt
: Qnil
));
983 restore_kboard_configuration (Lisp_Object was_locked
)
985 if (NILP (was_locked
))
989 struct kboard
*prev
= current_kboard
;
992 /* The pop should not change the kboard. */
993 if (single_kboard
&& current_kboard
!= prev
)
1000 /* Handle errors that are not handled at inner levels
1001 by printing an error message and returning to the editor command loop. */
1004 cmd_error (Lisp_Object data
)
1006 Lisp_Object old_level
, old_length
;
1007 char macroerror
[sizeof "After..kbd macro iterations: "
1008 + INT_STRLEN_BOUND (EMACS_INT
)];
1010 #ifdef HAVE_WINDOW_SYSTEM
1011 if (display_hourglass_p
)
1012 cancel_hourglass ();
1015 if (!NILP (executing_kbd_macro
))
1017 if (executing_kbd_macro_iterations
== 1)
1018 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1020 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1021 executing_kbd_macro_iterations
);
1026 Vstandard_output
= Qt
;
1027 Vstandard_input
= Qt
;
1028 Vexecuting_kbd_macro
= Qnil
;
1029 executing_kbd_macro
= Qnil
;
1030 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1031 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1034 /* Avoid unquittable loop if data contains a circular list. */
1035 old_level
= Vprint_level
;
1036 old_length
= Vprint_length
;
1037 XSETFASTINT (Vprint_level
, 10);
1038 XSETFASTINT (Vprint_length
, 10);
1039 cmd_error_internal (data
, macroerror
);
1040 Vprint_level
= old_level
;
1041 Vprint_length
= old_length
;
1045 Vinhibit_quit
= Qnil
;
1046 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1047 if (command_loop_level
== 0 && minibuf_level
== 0)
1048 any_kboard_state ();
1051 return make_number (0);
1054 /* Take actions on handling an error. DATA is the data that describes
1057 CONTEXT is a C-string containing ASCII characters only which
1058 describes the context in which the error happened. If we need to
1059 generalize CONTEXT to allow multibyte characters, make it a Lisp
1063 cmd_error_internal (Lisp_Object data
, const char *context
)
1065 struct frame
*sf
= SELECTED_FRAME ();
1067 /* The immediate context is not interesting for Quits,
1068 since they are asynchronous. */
1069 if (EQ (XCAR (data
), Qquit
))
1070 Vsignaling_function
= Qnil
;
1075 /* Use user's specified output function if any. */
1076 if (!NILP (Vcommand_error_function
))
1077 call3 (Vcommand_error_function
, data
,
1078 context
? build_string (context
) : empty_unibyte_string
,
1079 Vsignaling_function
);
1080 /* If the window system or terminal frame hasn't been initialized
1081 yet, or we're not interactive, write the message to stderr and exit. */
1082 else if (!sf
->glyphs_initialized_p
1083 /* The initial frame is a special non-displaying frame. It
1084 will be current in daemon mode when there are no frames
1085 to display, and in non-daemon mode before the real frame
1086 has finished initializing. If an error is thrown in the
1087 latter case while creating the frame, then the frame
1088 will never be displayed, so the safest thing to do is
1089 write to stderr and quit. In daemon mode, there are
1090 many other potential errors that do not prevent frames
1091 from being created, so continuing as normal is better in
1093 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1096 print_error_message (data
, Qexternal_debugging_output
,
1097 context
, Vsignaling_function
);
1098 Fterpri (Qexternal_debugging_output
);
1099 Fkill_emacs (make_number (-1));
1103 clear_message (1, 0);
1105 message_log_maybe_newline ();
1108 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1111 Vsignaling_function
= Qnil
;
1114 Lisp_Object
command_loop_1 (void);
1115 static Lisp_Object
command_loop_2 (Lisp_Object
);
1116 static Lisp_Object
top_level_1 (Lisp_Object
);
1118 /* Entry to editor-command-loop.
1119 This level has the catches for exiting/returning to editor command loop.
1120 It returns nil to exit recursive edit, t to abort it. */
1125 if (command_loop_level
> 0 || minibuf_level
> 0)
1128 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1129 executing_kbd_macro
= Qnil
;
1135 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1136 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1137 /* Reset single_kboard in case top-level set it while
1138 evaluating an -f option, or we are stuck there for some
1140 any_kboard_state ();
1142 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1143 executing_kbd_macro
= Qnil
;
1145 /* End of file in -batch run causes exit here. */
1151 /* Here we catch errors in execution of commands within the
1152 editing loop, and reenter the editing loop.
1153 When there is an error, cmd_error runs and returns a non-nil
1154 value to us. A value of nil means that command_loop_1 itself
1155 returned due to end of file (or end of kbd macro). */
1158 command_loop_2 (Lisp_Object ignore
)
1160 register Lisp_Object val
;
1163 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1164 while (!NILP (val
));
1172 return Feval (Vtop_level
, Qnil
);
1176 top_level_1 (Lisp_Object ignore
)
1178 /* On entry to the outer level, run the startup file */
1179 if (!NILP (Vtop_level
))
1180 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1181 else if (!NILP (Vpurify_flag
))
1182 message ("Bare impure Emacs (standard Lisp code not loaded)");
1184 message ("Bare Emacs (standard Lisp code not loaded)");
1188 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1189 doc
: /* Exit all recursive editing levels.
1190 This also exits all active minibuffers. */)
1193 #ifdef HAVE_WINDOW_SYSTEM
1194 if (display_hourglass_p
)
1195 cancel_hourglass ();
1198 /* Unblock input if we enter with input blocked. This may happen if
1199 redisplay traps e.g. during tool-bar update with input blocked. */
1200 while (INPUT_BLOCKED_P
)
1203 Fthrow (Qtop_level
, Qnil
);
1206 static Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1207 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1208 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1211 if (command_loop_level
> 0 || minibuf_level
> 0)
1212 Fthrow (Qexit
, Qnil
);
1214 error ("No recursive edit is in progress");
1217 static Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1218 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1219 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1222 if (command_loop_level
> 0 || minibuf_level
> 0)
1225 error ("No recursive edit is in progress");
1228 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1230 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1231 of this function. */
1234 tracking_off (Lisp_Object old_value
)
1236 do_mouse_tracking
= old_value
;
1237 if (NILP (old_value
))
1239 /* Redisplay may have been preempted because there was input
1240 available, and it assumes it will be called again after the
1241 input has been processed. If the only input available was
1242 the sort that we have just disabled, then we need to call
1244 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1246 redisplay_preserve_echo_area (6);
1247 get_input_pending (&input_pending
,
1248 READABLE_EVENTS_DO_TIMERS_NOW
);
1254 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1255 doc
: /* Evaluate BODY with mouse movement events enabled.
1256 Within a `track-mouse' form, mouse motion generates input events that
1257 you can read with `read-event'.
1258 Normally, mouse motion is ignored.
1259 usage: (track-mouse BODY...) */)
1262 int count
= SPECPDL_INDEX ();
1265 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1267 do_mouse_tracking
= Qt
;
1269 val
= Fprogn (args
);
1270 return unbind_to (count
, val
);
1273 /* If mouse has moved on some frame, return one of those frames.
1277 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1278 after resizing the tool-bar window. */
1280 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1283 int ignore_mouse_drag_p
;
1286 some_mouse_moved (void)
1288 Lisp_Object tail
, frame
;
1290 if (ignore_mouse_drag_p
)
1292 /* ignore_mouse_drag_p = 0; */
1296 FOR_EACH_FRAME (tail
, frame
)
1298 if (XFRAME (frame
)->mouse_moved
)
1299 return XFRAME (frame
);
1305 #endif /* HAVE_MOUSE || HAVE_GPM */
1307 /* This is the actual command reading loop,
1308 sans error-handling encapsulation. */
1310 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1312 void safe_run_hooks (Lisp_Object
);
1313 static void adjust_point_for_property (EMACS_INT
, int);
1315 /* Cancel hourglass from protect_unwind.
1317 #ifdef HAVE_WINDOW_SYSTEM
1319 cancel_hourglass_unwind (Lisp_Object arg
)
1321 cancel_hourglass ();
1326 /* FIXME: This is wrong rather than test window-system, we should call
1327 a new set-selection, which will then dispatch to x-set-selection, or
1328 tty-set-selection, or w32-set-selection, ... */
1329 EXFUN (Fwindow_system
, 1);
1332 command_loop_1 (void)
1335 Lisp_Object keybuf
[30];
1337 int prev_modiff
= 0;
1338 struct buffer
*prev_buffer
= NULL
;
1339 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1340 int was_locked
= single_kboard
;
1342 int already_adjusted
= 0;
1344 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1345 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1346 Vdeactivate_mark
= Qnil
;
1347 waiting_for_input
= 0;
1350 this_command_key_count
= 0;
1351 this_command_key_count_reset
= 0;
1352 this_single_command_key_start
= 0;
1354 if (NILP (Vmemory_full
))
1356 /* Make sure this hook runs after commands that get errors and
1357 throw to top level. */
1358 /* Note that the value cell will never directly contain nil
1359 if the symbol is a local variable. */
1360 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1361 safe_run_hooks (Qpost_command_hook
);
1363 /* If displaying a message, resize the echo area window to fit
1364 that message's size exactly. */
1365 if (!NILP (echo_area_buffer
[0]))
1366 resize_echo_area_exactly ();
1368 /* If there are warnings waiting, process them. */
1369 if (!NILP (Vdelayed_warnings_list
))
1370 safe_run_hooks (Qdelayed_warnings_hook
);
1372 if (!NILP (Vdeferred_action_list
))
1373 safe_run_hooks (Qdeferred_action_function
);
1376 /* Do this after running Vpost_command_hook, for consistency. */
1377 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1378 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1379 if (!CONSP (last_command_event
))
1380 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1384 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1387 /* Make sure the current window's buffer is selected. */
1388 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1389 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1391 /* Display any malloc warning that just came out. Use while because
1392 displaying one warning can cause another. */
1394 while (pending_malloc_warning
)
1395 display_malloc_warning ();
1397 Vdeactivate_mark
= Qnil
;
1399 /* If minibuffer on and echo area in use,
1400 wait a short time and redraw minibuffer. */
1403 && !NILP (echo_area_buffer
[0])
1404 && EQ (minibuf_window
, echo_area_window
)
1405 && NUMBERP (Vminibuffer_message_timeout
))
1407 /* Bind inhibit-quit to t so that C-g gets read in
1408 rather than quitting back to the minibuffer. */
1409 int count
= SPECPDL_INDEX ();
1410 specbind (Qinhibit_quit
, Qt
);
1412 sit_for (Vminibuffer_message_timeout
, 0, 2);
1414 /* Clear the echo area. */
1416 safe_run_hooks (Qecho_area_clear_hook
);
1418 unbind_to (count
, Qnil
);
1420 /* If a C-g came in before, treat it as input now. */
1421 if (!NILP (Vquit_flag
))
1424 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1429 /* Select the frame that the last event came from. Usually,
1430 switch-frame events will take care of this, but if some lisp
1431 code swallows a switch-frame event, we'll fix things up here.
1432 Is this a good idea? */
1433 if (FRAMEP (internal_last_event_frame
)
1434 && !EQ (internal_last_event_frame
, selected_frame
))
1435 Fselect_frame (internal_last_event_frame
, Qnil
);
1437 /* If it has changed current-menubar from previous value,
1438 really recompute the menubar from the value. */
1439 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1440 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1441 call0 (Qrecompute_lucid_menubar
);
1443 before_command_key_count
= this_command_key_count
;
1444 before_command_echo_length
= echo_length ();
1446 Vthis_command
= Qnil
;
1447 real_this_command
= Qnil
;
1448 Vthis_original_command
= Qnil
;
1449 Vthis_command_keys_shift_translated
= Qnil
;
1451 /* Read next key sequence; i gets its length. */
1452 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1455 /* A filter may have run while we were reading the input. */
1456 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1458 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1459 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1463 /* Now we have read a key sequence of length I,
1464 or else I is 0 and we found end of file. */
1466 if (i
== 0) /* End of file -- happens only in */
1467 return Qnil
; /* a kbd macro, at the end. */
1468 /* -1 means read_key_sequence got a menu that was rejected.
1469 Just loop around and read another command. */
1473 this_command_key_count
= 0;
1474 this_command_key_count_reset
= 0;
1475 this_single_command_key_start
= 0;
1479 last_command_event
= keybuf
[i
- 1];
1481 /* If the previous command tried to force a specific window-start,
1482 forget about that, in case this command moves point far away
1483 from that position. But also throw away beg_unchanged and
1484 end_unchanged information in that case, so that redisplay will
1485 update the whole window properly. */
1486 if (!NILP (XWINDOW (selected_window
)->force_start
))
1489 XWINDOW (selected_window
)->force_start
= Qnil
;
1490 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1491 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1494 cmd
= read_key_sequence_cmd
;
1495 if (!NILP (Vexecuting_kbd_macro
))
1497 if (!NILP (Vquit_flag
))
1499 Vexecuting_kbd_macro
= Qt
;
1500 QUIT
; /* Make some noise. */
1501 /* Will return since macro now empty. */
1505 /* Do redisplay processing after this command except in special
1506 cases identified below. */
1507 prev_buffer
= current_buffer
;
1508 prev_modiff
= MODIFF
;
1509 last_point_position
= PT
;
1510 last_point_position_window
= selected_window
;
1511 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1513 /* By default, we adjust point to a boundary of a region that
1514 has such a property that should be treated intangible
1515 (e.g. composition, display). But, some commands will set
1516 this variable differently. */
1517 Vdisable_point_adjustment
= Qnil
;
1519 /* Process filters and timers may have messed with deactivate-mark.
1520 reset it before we execute the command. */
1521 Vdeactivate_mark
= Qnil
;
1523 /* Remap command through active keymaps. */
1524 Vthis_original_command
= cmd
;
1525 if (!NILP (read_key_sequence_remapped
))
1526 cmd
= read_key_sequence_remapped
;
1528 /* Execute the command. */
1530 Vthis_command
= cmd
;
1531 real_this_command
= cmd
;
1532 safe_run_hooks (Qpre_command_hook
);
1534 already_adjusted
= 0;
1536 if (NILP (Vthis_command
))
1538 /* nil means key is undefined. */
1539 Lisp_Object keys
= Fvector (i
, keybuf
);
1540 keys
= Fkey_description (keys
, Qnil
);
1542 message_with_string ("%s is undefined", keys
, 0);
1543 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1544 update_mode_lines
= 1;
1545 /* If this is a down-mouse event, don't reset prefix-arg;
1546 pass it to the command run by the up event. */
1547 if (EVENT_HAS_PARAMETERS (last_command_event
))
1549 Lisp_Object breakdown
1550 = parse_modifiers (EVENT_HEAD (last_command_event
));
1551 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1552 if (!(modifiers
& down_modifier
))
1553 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1556 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1560 /* Here for a command that isn't executed directly. */
1562 #ifdef HAVE_WINDOW_SYSTEM
1563 int scount
= SPECPDL_INDEX ();
1565 if (display_hourglass_p
1566 && NILP (Vexecuting_kbd_macro
))
1568 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1573 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1575 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1577 #ifdef HAVE_WINDOW_SYSTEM
1578 /* Do not check display_hourglass_p here, because
1579 Fcommand_execute could change it, but we should cancel
1580 hourglass cursor anyway.
1581 But don't cancel the hourglass within a macro
1582 just because a command in the macro finishes. */
1583 if (NILP (Vexecuting_kbd_macro
))
1584 unbind_to (scount
, Qnil
);
1587 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1589 safe_run_hooks (Qpost_command_hook
);
1591 /* If displaying a message, resize the echo area window to fit
1592 that message's size exactly. */
1593 if (!NILP (echo_area_buffer
[0]))
1594 resize_echo_area_exactly ();
1596 /* If there are warnings waiting, process them. */
1597 if (!NILP (Vdelayed_warnings_list
))
1598 safe_run_hooks (Qdelayed_warnings_hook
);
1600 safe_run_hooks (Qdeferred_action_function
);
1602 /* If there is a prefix argument,
1603 1) We don't want Vlast_command to be ``universal-argument''
1604 (that would be dumb), so don't set Vlast_command,
1605 2) we want to leave echoing on so that the prefix will be
1606 echoed as part of this key sequence, so don't call
1608 3) we want to leave this_command_key_count non-zero, so that
1609 read_char will realize that it is re-reading a character, and
1610 not echo it a second time.
1612 If the command didn't actually create a prefix arg,
1613 but is merely a frame event that is transparent to prefix args,
1614 then the above doesn't apply. */
1615 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1617 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1618 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1619 if (!CONSP (last_command_event
))
1620 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1622 this_command_key_count
= 0;
1623 this_command_key_count_reset
= 0;
1624 this_single_command_key_start
= 0;
1627 if (!NILP (BVAR (current_buffer
, mark_active
))
1628 && !NILP (Vrun_hooks
))
1630 /* In Emacs 22, setting transient-mark-mode to `only' was a
1631 way of turning it on for just one command. This usage is
1632 obsolete, but support it anyway. */
1633 if (EQ (Vtransient_mark_mode
, Qidentity
))
1634 Vtransient_mark_mode
= Qnil
;
1635 else if (EQ (Vtransient_mark_mode
, Qonly
))
1636 Vtransient_mark_mode
= Qidentity
;
1638 if (!NILP (Vdeactivate_mark
))
1639 /* If `select-active-regions' is non-nil, this call to
1640 `deactivate-mark' also sets the PRIMARY selection. */
1641 call0 (Qdeactivate_mark
);
1644 /* Even if not deactivating the mark, set PRIMARY if
1645 `select-active-regions' is non-nil. */
1646 if (!NILP (Fwindow_system (Qnil
))
1647 /* Even if mark_active is non-nil, the actual buffer
1648 marker may not have been set yet (Bug#7044). */
1649 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1650 && (EQ (Vselect_active_regions
, Qonly
)
1651 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1652 : (!NILP (Vselect_active_regions
)
1653 && !NILP (Vtransient_mark_mode
)))
1654 && NILP (Fmemq (Vthis_command
,
1655 Vselection_inhibit_update_commands
)))
1658 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1661 call2 (Qx_set_selection
, QPRIMARY
,
1662 make_buffer_string (beg
, end
, 0));
1664 call2 (Qx_set_selection
, QPRIMARY
,
1665 make_buffer_string (end
, beg
, 0));
1666 /* Don't set empty selections. */
1669 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1671 Lisp_Object hook
= intern ("activate-mark-hook");
1672 Frun_hooks (1, &hook
);
1676 Vsaved_region_selection
= Qnil
;
1681 if (current_buffer
== prev_buffer
1682 && last_point_position
!= PT
1683 && NILP (Vdisable_point_adjustment
)
1684 && NILP (Vglobal_disable_point_adjustment
))
1686 if (last_point_position
> BEGV
1687 && last_point_position
< ZV
1688 && (composition_adjust_point (last_point_position
,
1689 last_point_position
)
1690 != last_point_position
))
1691 /* The last point was temporarily set within a grapheme
1692 cluster to prevent automatic composition. To recover
1693 the automatic composition, we must update the
1695 windows_or_buffers_changed
++;
1696 if (!already_adjusted
)
1697 adjust_point_for_property (last_point_position
,
1698 MODIFF
!= prev_modiff
);
1701 /* Install chars successfully executed in kbd macro. */
1703 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1704 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1705 finalize_kbd_macro_chars ();
1706 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1708 any_kboard_state ();
1713 /* Adjust point to a boundary of a region that has such a property
1714 that should be treated intangible. For the moment, we check
1715 `composition', `display' and `invisible' properties.
1716 LAST_PT is the last position of point. */
1719 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1722 Lisp_Object val
, overlay
, tmp
;
1723 /* When called after buffer modification, we should temporarily
1724 suppress the point adjustment for automatic composition so that a
1725 user can keep inserting another character at point or keep
1726 deleting characters around point. */
1727 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1728 EMACS_INT orig_pt
= PT
;
1730 /* FIXME: cycling is probably not necessary because these properties
1731 can't be usefully combined anyway. */
1732 while (check_composition
|| check_display
|| check_invisible
)
1734 /* FIXME: check `intangible'. */
1735 if (check_composition
1736 && PT
> BEGV
&& PT
< ZV
1737 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1740 check_display
= check_invisible
= 1;
1742 check_composition
= 0;
1744 && PT
> BEGV
&& PT
< ZV
1745 && !NILP (val
= get_char_property_and_overlay
1746 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1747 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1748 && (!OVERLAYP (overlay
)
1749 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1750 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1751 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1752 && (beg
< PT
/* && end > PT <- It's always the case. */
1753 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1756 SET_PT (PT
< last_pt
1757 ? (STRINGP (val
) && SCHARS (val
) == 0
1758 ? max (beg
- 1, BEGV
)
1761 check_composition
= check_invisible
= 1;
1764 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1766 int inv
, ellipsis
= 0;
1769 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1772 /* FIXME: We should stop if we find a spot between
1773 two runs of `invisible' where inserted text would
1774 be visible. This is important when we have two
1775 invisible boundaries that enclose an area: if the
1776 area is empty, we need this test in order to make
1777 it possible to place point in the middle rather
1778 than skip both boundaries. However, this code
1779 also stops anywhere in a non-sticky text-property,
1780 which breaks (e.g.) Org mode. */
1781 && (val
= get_pos_property (make_number (end
),
1783 TEXT_PROP_MEANS_INVISIBLE (val
))
1785 && !NILP (val
= get_char_property_and_overlay
1786 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1787 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1789 ellipsis
= ellipsis
|| inv
> 1
1790 || (OVERLAYP (overlay
)
1791 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1792 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1793 tmp
= Fnext_single_char_property_change
1794 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1795 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1799 && (val
= get_pos_property (make_number (beg
),
1801 TEXT_PROP_MEANS_INVISIBLE (val
))
1803 && !NILP (val
= get_char_property_and_overlay
1804 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1805 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1807 ellipsis
= ellipsis
|| inv
> 1
1808 || (OVERLAYP (overlay
)
1809 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1810 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1811 tmp
= Fprevious_single_char_property_change
1812 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1813 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1816 /* Move away from the inside area. */
1817 if (beg
< PT
&& end
> PT
)
1819 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1820 /* We haven't moved yet (so we don't need to fear
1821 infinite-looping) and we were outside the range
1822 before (so either end of the range still corresponds
1823 to a move in the right direction): pretend we moved
1824 less than we actually did, so that we still have
1825 more freedom below in choosing which end of the range
1827 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1828 /* We either have moved already or the last point
1829 was already in the range: we don't get to choose
1830 which end of the range we have to go to. */
1831 : (PT
< last_pt
? beg
: end
));
1832 check_composition
= check_display
= 1;
1834 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1835 the point to something other than its argument, due to
1836 point-motion hooks, intangibility, etc. */
1837 xassert (PT
== beg
|| PT
== end
);
1840 /* Pretend the area doesn't exist if the buffer is not
1842 if (!modified
&& !ellipsis
&& beg
< end
)
1844 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1845 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1846 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1847 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1848 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1849 /* We've already moved as far as we can. Trying to go
1850 to the other end would mean moving backwards and thus
1851 could lead to an infinite loop. */
1853 else if (val
= get_pos_property (make_number (PT
),
1855 TEXT_PROP_MEANS_INVISIBLE (val
)
1856 && (val
= get_pos_property
1857 (make_number (PT
== beg
? end
: beg
),
1859 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1860 (check_composition
= check_display
= 1,
1861 SET_PT (PT
== beg
? end
: beg
));
1864 check_invisible
= 0;
1868 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1871 safe_run_hooks_1 (void)
1873 eassert (CONSP (Vinhibit_quit
));
1874 return call0 (XCDR (Vinhibit_quit
));
1877 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1881 safe_run_hooks_error (Lisp_Object error_data
)
1884 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1885 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1886 Lisp_Object args
[4];
1887 args
[0] = build_string ("Error in %s (%s): %S");
1890 args
[3] = error_data
;
1896 Lisp_Object newval
= Qnil
;
1897 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1898 if (EQ (fun
, XCAR (val
)))
1901 newval
= Fcons (XCAR (val
), newval
);
1903 return Fset (hook
, Fnreverse (newval
));
1904 /* Not found in the local part of the hook. Let's look at the global
1907 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1908 : Fdefault_value (hook
));
1909 CONSP (val
); val
= XCDR (val
))
1910 if (EQ (fun
, XCAR (val
)))
1913 newval
= Fcons (XCAR (val
), newval
);
1915 return Fset_default (hook
, Fnreverse (newval
));
1921 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1923 eassert (nargs
== 1);
1924 if (CONSP (Vinhibit_quit
))
1925 XSETCDR (Vinhibit_quit
, args
[0]);
1927 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1929 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1933 /* If we get an error while running the hook, cause the hook variable
1934 to be nil. Also inhibit quits, so that C-g won't cause the hook
1935 to mysteriously evaporate. */
1938 safe_run_hooks (Lisp_Object hook
)
1940 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1941 to its body or to its handlers other than via globals such as
1942 dynamically-bound variables ;-) */
1943 int count
= SPECPDL_INDEX ();
1944 specbind (Qinhibit_quit
, hook
);
1946 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1948 unbind_to (count
, Qnil
);
1952 /* Nonzero means polling for input is temporarily suppressed. */
1954 int poll_suppress_count
;
1956 /* Asynchronous timer for polling. */
1958 static struct atimer
*poll_timer
;
1961 #ifdef POLL_FOR_INPUT
1963 /* Poll for input, so that we catch a C-g if it comes in. This
1964 function is called from x_make_frame_visible, see comment
1968 poll_for_input_1 (void)
1970 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1971 doing anything dangerous. */
1975 if (interrupt_input_blocked
== 0
1976 && !waiting_for_input
)
1977 read_avail_input (0);
1983 /* Timer callback function for poll_timer. TIMER is equal to
1987 poll_for_input (struct atimer
*timer
)
1989 if (poll_suppress_count
== 0)
1992 interrupt_input_pending
= 1;
1993 pending_signals
= 1;
1995 poll_for_input_1 ();
2000 #endif /* POLL_FOR_INPUT */
2002 /* Begin signals to poll for input, if they are appropriate.
2003 This function is called unconditionally from various places. */
2006 start_polling (void)
2008 #ifdef POLL_FOR_INPUT
2009 /* XXX This condition was (read_socket_hook && !interrupt_input),
2010 but read_socket_hook is not global anymore. Let's pretend that
2012 if (!interrupt_input
)
2014 /* Turn alarm handling on unconditionally. It might have
2015 been turned off in process.c. */
2016 turn_on_atimers (1);
2018 /* If poll timer doesn't exist, are we need one with
2019 a different interval, start a new one. */
2020 if (poll_timer
== NULL
2021 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2023 EMACS_TIME interval
;
2026 cancel_atimer (poll_timer
);
2028 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2029 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2030 poll_for_input
, NULL
);
2033 /* Let the timer's callback function poll for input
2034 if this becomes zero. */
2035 --poll_suppress_count
;
2040 /* Nonzero if we are using polling to handle input asynchronously. */
2043 input_polling_used (void)
2045 #ifdef POLL_FOR_INPUT
2046 /* XXX This condition was (read_socket_hook && !interrupt_input),
2047 but read_socket_hook is not global anymore. Let's pretend that
2049 return !interrupt_input
;
2055 /* Turn off polling. */
2060 #ifdef POLL_FOR_INPUT
2061 /* XXX This condition was (read_socket_hook && !interrupt_input),
2062 but read_socket_hook is not global anymore. Let's pretend that
2064 if (!interrupt_input
)
2065 ++poll_suppress_count
;
2069 /* Set the value of poll_suppress_count to COUNT
2070 and start or stop polling accordingly. */
2073 set_poll_suppress_count (int count
)
2075 #ifdef POLL_FOR_INPUT
2076 if (count
== 0 && poll_suppress_count
!= 0)
2078 poll_suppress_count
= 1;
2081 else if (count
!= 0 && poll_suppress_count
== 0)
2085 poll_suppress_count
= count
;
2089 /* Bind polling_period to a value at least N.
2090 But don't decrease it. */
2093 bind_polling_period (int n
)
2095 #ifdef POLL_FOR_INPUT
2096 int new = polling_period
;
2101 stop_other_atimers (poll_timer
);
2103 specbind (Qpolling_period
, make_number (new));
2104 /* Start a new alarm with the new period. */
2109 /* Apply the control modifier to CHARACTER. */
2112 make_ctrl_char (int c
)
2114 /* Save the upper bits here. */
2115 int upper
= c
& ~0177;
2117 if (! ASCII_BYTE_P (c
))
2118 return c
|= ctrl_modifier
;
2122 /* Everything in the columns containing the upper-case letters
2123 denotes a control character. */
2124 if (c
>= 0100 && c
< 0140)
2128 /* Set the shift modifier for a control char
2129 made from a shifted letter. But only for letters! */
2130 if (oc
>= 'A' && oc
<= 'Z')
2131 c
|= shift_modifier
;
2134 /* The lower-case letters denote control characters too. */
2135 else if (c
>= 'a' && c
<= 'z')
2138 /* Include the bits for control and shift
2139 only if the basic ASCII code can't indicate them. */
2143 /* Replace the high bits. */
2144 c
|= (upper
& ~ctrl_modifier
);
2149 /* Display the help-echo property of the character after the mouse pointer.
2150 Either show it in the echo area, or call show-help-function to display
2151 it by other means (maybe in a tooltip).
2153 If HELP is nil, that means clear the previous help echo.
2155 If HELP is a string, display that string. If HELP is a function,
2156 call it with OBJECT and POS as arguments; the function should
2157 return a help string or nil for none. For all other types of HELP,
2158 evaluate it to obtain a string.
2160 WINDOW is the window in which the help was generated, if any.
2161 It is nil if not in a window.
2163 If OBJECT is a buffer, POS is the position in the buffer where the
2164 `help-echo' text property was found.
2166 If OBJECT is an overlay, that overlay has a `help-echo' property,
2167 and POS is the position in the overlay's buffer under the mouse.
2169 If OBJECT is a string (an overlay string or a string displayed with
2170 the `display' property). POS is the position in that string under
2173 Note: this function may only be called with HELP nil or a string
2174 from X code running asynchronously. */
2177 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2180 if (!NILP (help
) && !STRINGP (help
))
2182 if (FUNCTIONP (help
))
2184 Lisp_Object args
[4];
2189 help
= safe_call (4, args
);
2192 help
= safe_eval (help
);
2194 if (!STRINGP (help
))
2198 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2199 if (!noninteractive
&& STRINGP (help
))
2201 /* The mouse-fixup-help-message Lisp function can call
2202 mouse_position_hook, which resets the mouse_moved flags.
2203 This causes trouble if we are trying to read a mouse motion
2204 event (i.e., if we are inside a `track-mouse' form), so we
2205 restore the mouse_moved flag. */
2206 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2207 help
= call1 (Qmouse_fixup_help_message
, help
);
2213 if (STRINGP (help
) || NILP (help
))
2215 if (!NILP (Vshow_help_function
))
2216 call1 (Vshow_help_function
, help
);
2217 help_echo_showing_p
= STRINGP (help
);
2223 /* Input of single characters from keyboard */
2225 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2226 struct timeval
*end_time
);
2227 static void record_char (Lisp_Object c
);
2229 static Lisp_Object help_form_saved_window_configs
;
2231 read_char_help_form_unwind (Lisp_Object arg
)
2233 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2234 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2235 if (!NILP (window_config
))
2236 Fset_window_configuration (window_config
);
2240 #define STOP_POLLING \
2241 do { if (! polling_stopped_here) stop_polling (); \
2242 polling_stopped_here = 1; } while (0)
2244 #define RESUME_POLLING \
2245 do { if (polling_stopped_here) start_polling (); \
2246 polling_stopped_here = 0; } while (0)
2248 /* read a character from the keyboard; call the redisplay if needed */
2249 /* commandflag 0 means do not autosave, but do redisplay.
2250 -1 means do not redisplay, but do autosave.
2253 /* The arguments MAPS and NMAPS are for menu prompting.
2254 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2256 PREV_EVENT is the previous input event, or nil if we are reading
2257 the first event of a key sequence (or not reading a key sequence).
2258 If PREV_EVENT is t, that is a "magic" value that says
2259 not to run input methods, but in other respects to act as if
2260 not reading a key sequence.
2262 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2263 if we used a mouse menu to read the input, or zero otherwise. If
2264 USED_MOUSE_MENU is null, we don't dereference it.
2266 Value is -2 when we find input on another keyboard. A second call
2267 to read_char will read it.
2269 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2270 specifying the maximum time to wait until. If no input arrives by
2271 that time, stop waiting and return nil.
2273 Value is t if we showed a menu and the user rejected it. */
2276 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2277 Lisp_Object prev_event
,
2278 int *used_mouse_menu
, struct timeval
*end_time
)
2280 volatile Lisp_Object c
;
2282 jmp_buf local_getcjmp
;
2284 volatile int key_already_recorded
= 0;
2285 Lisp_Object tem
, save
;
2286 volatile Lisp_Object previous_echo_area_message
;
2287 volatile Lisp_Object also_record
;
2288 volatile int reread
;
2289 struct gcpro gcpro1
, gcpro2
;
2290 int volatile polling_stopped_here
= 0;
2291 struct kboard
*orig_kboard
= current_kboard
;
2295 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2296 before_command_key_count
= this_command_key_count
;
2297 before_command_echo_length
= echo_length ();
2300 previous_echo_area_message
= Qnil
;
2302 GCPRO2 (c
, previous_echo_area_message
);
2307 if (CONSP (Vunread_post_input_method_events
))
2309 c
= XCAR (Vunread_post_input_method_events
);
2310 Vunread_post_input_method_events
2311 = XCDR (Vunread_post_input_method_events
);
2313 /* Undo what read_char_x_menu_prompt did when it unread
2314 additional keys returned by Fx_popup_menu. */
2316 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2324 if (unread_command_char
!= -1)
2326 XSETINT (c
, unread_command_char
);
2327 unread_command_char
= -1;
2333 if (CONSP (Vunread_command_events
))
2335 int was_disabled
= 0;
2337 c
= XCAR (Vunread_command_events
);
2338 Vunread_command_events
= XCDR (Vunread_command_events
);
2342 /* Undo what sit-for did when it unread additional keys
2343 inside universal-argument. */
2346 && EQ (XCAR (c
), Qt
))
2352 /* Undo what read_char_x_menu_prompt did when it unread
2353 additional keys returned by Fx_popup_menu. */
2355 && EQ (XCDR (c
), Qdisabled
)
2356 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2362 /* If the queued event is something that used the mouse,
2363 set used_mouse_menu accordingly. */
2365 /* Also check was_disabled so last-nonmenu-event won't return
2366 a bad value when submenus are involved. (Bug#447) */
2367 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2368 *used_mouse_menu
= 1;
2370 goto reread_for_input_method
;
2373 if (CONSP (Vunread_input_method_events
))
2375 c
= XCAR (Vunread_input_method_events
);
2376 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2378 /* Undo what read_char_x_menu_prompt did when it unread
2379 additional keys returned by Fx_popup_menu. */
2381 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2385 goto reread_for_input_method
;
2388 this_command_key_count_reset
= 0;
2390 if (!NILP (Vexecuting_kbd_macro
))
2392 /* We set this to Qmacro; since that's not a frame, nobody will
2393 try to switch frames on us, and the selected window will
2396 Since this event came from a macro, it would be misleading to
2397 leave internal_last_event_frame set to wherever the last
2398 real event came from. Normally, a switch-frame event selects
2399 internal_last_event_frame after each command is read, but
2400 events read from a macro should never cause a new frame to be
2402 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2404 /* Exit the macro if we are at the end.
2405 Also, some things replace the macro with t
2406 to force an early exit. */
2407 if (EQ (Vexecuting_kbd_macro
, Qt
)
2408 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2414 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2415 if (STRINGP (Vexecuting_kbd_macro
)
2416 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2417 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2419 executing_kbd_macro_index
++;
2424 if (!NILP (unread_switch_frame
))
2426 c
= unread_switch_frame
;
2427 unread_switch_frame
= Qnil
;
2429 /* This event should make it into this_command_keys, and get echoed
2430 again, so we do not set `reread'. */
2434 /* if redisplay was requested */
2435 if (commandflag
>= 0)
2437 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2439 /* If there is pending input, process any events which are not
2440 user-visible, such as X selection_request events. */
2442 || detect_input_pending_run_timers (0))
2443 swallow_events (0); /* may clear input_pending */
2445 /* Redisplay if no pending input. */
2446 while (!input_pending
)
2448 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2449 redisplay_preserve_echo_area (5);
2454 /* Normal case: no input arrived during redisplay. */
2457 /* Input arrived and pre-empted redisplay.
2458 Process any events which are not user-visible. */
2460 /* If that cleared input_pending, try again to redisplay. */
2463 /* Prevent the redisplay we just did
2464 from messing up echoing of the input after the prompt. */
2465 if (commandflag
== 0 && echo_current
)
2466 echo_message_buffer
= echo_area_buffer
[0];
2470 /* Message turns off echoing unless more keystrokes turn it on again.
2472 The code in 20.x for the condition was
2474 1. echo_area_glyphs && *echo_area_glyphs
2475 2. && echo_area_glyphs != current_kboard->echobuf
2476 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2478 (1) means there's a current message displayed
2480 (2) means it's not the message from echoing from the current
2483 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2484 is set to a non-null value. This is done in read_char and it is
2485 set to echo_area_glyphs after a call to echo_char. That means
2486 ok_to_echo_at_next_pause is either null or
2487 current_kboard->echobuf with the appropriate current_kboard at
2490 So, condition (3) means in clear text ok_to_echo_at_next_pause
2491 must be either null, or the current message isn't from echoing at
2492 all, or it's from echoing from a different kboard than the
2495 if (/* There currently is something in the echo area. */
2496 !NILP (echo_area_buffer
[0])
2497 && (/* And it's either not from echoing. */
2498 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2499 /* Or it's an echo from a different kboard. */
2500 || echo_kboard
!= current_kboard
2501 /* Or we explicitly allow overwriting whatever there is. */
2502 || ok_to_echo_at_next_pause
== NULL
))
2507 /* Try reading a character via menu prompting in the minibuf.
2508 Try this before the sit-for, because the sit-for
2509 would do the wrong thing if we are supposed to do
2510 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2511 after a mouse event so don't try a minibuf menu. */
2513 if (nmaps
> 0 && INTERACTIVE
2514 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2515 /* Don't bring up a menu if we already have another event. */
2516 && NILP (Vunread_command_events
)
2517 && unread_command_char
< 0
2518 && !detect_input_pending_run_timers (0))
2520 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2522 if (INTEGERP (c
) && XINT (c
) == -2)
2523 return c
; /* wrong_kboard_jmpbuf */
2527 key_already_recorded
= 1;
2532 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2533 We will do that below, temporarily for short sections of code,
2534 when appropriate. local_getcjmp must be in effect
2535 around any call to sit_for or kbd_buffer_get_event;
2536 it *must not* be in effect when we call redisplay. */
2538 jmpcount
= SPECPDL_INDEX ();
2539 if (_setjmp (local_getcjmp
))
2541 /* Handle quits while reading the keyboard. */
2542 /* We must have saved the outer value of getcjmp here,
2543 so restore it now. */
2544 restore_getcjmp (save_jump
);
2545 unbind_to (jmpcount
, Qnil
);
2546 XSETINT (c
, quit_char
);
2547 internal_last_event_frame
= selected_frame
;
2548 Vlast_event_frame
= internal_last_event_frame
;
2549 /* If we report the quit char as an event,
2550 don't do so more than once. */
2551 if (!NILP (Vinhibit_quit
))
2555 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2556 if (kb
!= current_kboard
)
2558 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2559 /* We shouldn't get here if we were in single-kboard mode! */
2564 while (CONSP (XCDR (last
)))
2566 if (!NILP (XCDR (last
)))
2570 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2572 XSETCDR (last
, Fcons (c
, Qnil
));
2573 kb
->kbd_queue_has_data
= 1;
2574 current_kboard
= kb
;
2575 /* This is going to exit from read_char
2576 so we had better get rid of this frame's stuff. */
2578 return make_number (-2); /* wrong_kboard_jmpbuf */
2584 /* Start idle timers if no time limit is supplied. We don't do it
2585 if a time limit is supplied to avoid an infinite recursion in the
2586 situation where an idle timer calls `sit-for'. */
2589 timer_start_idle ();
2591 /* If in middle of key sequence and minibuffer not active,
2592 start echoing if enough time elapses. */
2594 if (minibuf_level
== 0
2596 && !current_kboard
->immediate_echo
2597 && this_command_key_count
> 0
2599 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2600 && NILP (Fzerop (Vecho_keystrokes
))
2601 && (/* No message. */
2602 NILP (echo_area_buffer
[0])
2603 /* Or empty message. */
2604 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2605 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2606 /* Or already echoing from same kboard. */
2607 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2608 /* Or not echoing before and echoing allowed. */
2609 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2611 /* After a mouse event, start echoing right away.
2612 This is because we are probably about to display a menu,
2613 and we don't want to delay before doing so. */
2614 if (EVENT_HAS_PARAMETERS (prev_event
))
2620 save_getcjmp (save_jump
);
2621 restore_getcjmp (local_getcjmp
);
2622 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2623 restore_getcjmp (save_jump
);
2625 && ! CONSP (Vunread_command_events
))
2630 /* Maybe auto save due to number of keystrokes. */
2632 if (commandflag
!= 0
2633 && auto_save_interval
> 0
2634 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2635 && !detect_input_pending_run_timers (0))
2637 Fdo_auto_save (Qnil
, Qnil
);
2638 /* Hooks can actually change some buffers in auto save. */
2642 /* Try reading using an X menu.
2643 This is never confused with reading using the minibuf
2644 because the recursive call of read_char in read_char_minibuf_menu_prompt
2645 does not pass on any keymaps. */
2647 if (nmaps
> 0 && INTERACTIVE
2648 && !NILP (prev_event
)
2649 && EVENT_HAS_PARAMETERS (prev_event
)
2650 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2651 && !EQ (XCAR (prev_event
), Qtool_bar
)
2652 /* Don't bring up a menu if we already have another event. */
2653 && NILP (Vunread_command_events
)
2654 && unread_command_char
< 0)
2656 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2658 /* Now that we have read an event, Emacs is not idle. */
2665 /* Maybe autosave and/or garbage collect due to idleness. */
2667 if (INTERACTIVE
&& NILP (c
))
2670 EMACS_INT buffer_size
;
2672 /* Slow down auto saves logarithmically in size of current buffer,
2673 and garbage collect while we're at it. */
2674 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2675 last_non_minibuf_size
= Z
- BEG
;
2676 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2678 while (buffer_size
> 64)
2679 delay_level
++, buffer_size
-= buffer_size
>> 2;
2680 if (delay_level
< 4) delay_level
= 4;
2681 /* delay_level is 4 for files under around 50k, 7 at 100k,
2682 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2684 /* Auto save if enough time goes by without input. */
2685 if (commandflag
!= 0
2686 && num_nonmacro_input_events
> last_auto_save
2687 && INTEGERP (Vauto_save_timeout
)
2688 && XINT (Vauto_save_timeout
) > 0)
2691 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2693 save_getcjmp (save_jump
);
2694 restore_getcjmp (local_getcjmp
);
2695 tem0
= sit_for (make_number (timeout
), 1, 1);
2696 restore_getcjmp (save_jump
);
2699 && ! CONSP (Vunread_command_events
))
2701 Fdo_auto_save (Qnil
, Qnil
);
2703 /* If we have auto-saved and there is still no input
2704 available, garbage collect if there has been enough
2705 consing going on to make it worthwhile. */
2706 if (!detect_input_pending_run_timers (0)
2707 && consing_since_gc
> gc_cons_threshold
/ 2)
2708 Fgarbage_collect ();
2715 /* Notify the caller if an autosave hook, or a timer, sentinel or
2716 filter in the sit_for calls above have changed the current
2717 kboard. This could happen if they use the minibuffer or start a
2718 recursive edit, like the fancy splash screen in server.el's
2719 filter. If this longjmp wasn't here, read_key_sequence would
2720 interpret the next key sequence using the wrong translation
2721 tables and function keymaps. */
2722 if (NILP (c
) && current_kboard
!= orig_kboard
)
2725 return make_number (-2); /* wrong_kboard_jmpbuf */
2728 /* If this has become non-nil here, it has been set by a timer
2729 or sentinel or filter. */
2730 if (CONSP (Vunread_command_events
))
2732 c
= XCAR (Vunread_command_events
);
2733 Vunread_command_events
= XCDR (Vunread_command_events
);
2736 /* Read something from current KBOARD's side queue, if possible. */
2740 if (current_kboard
->kbd_queue_has_data
)
2742 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2744 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2745 KVAR (current_kboard
, kbd_queue
)
2746 = XCDR (KVAR (current_kboard
, kbd_queue
));
2747 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2748 current_kboard
->kbd_queue_has_data
= 0;
2749 input_pending
= readable_events (0);
2750 if (EVENT_HAS_PARAMETERS (c
)
2751 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2752 internal_last_event_frame
= XCAR (XCDR (c
));
2753 Vlast_event_frame
= internal_last_event_frame
;
2757 /* If current_kboard's side queue is empty check the other kboards.
2758 If one of them has data that we have not yet seen here,
2759 switch to it and process the data waiting for it.
2761 Note: if the events queued up for another kboard
2762 have already been seen here, and therefore are not a complete command,
2763 the kbd_queue_has_data field is 0, so we skip that kboard here.
2764 That's to avoid an infinite loop switching between kboards here. */
2765 if (NILP (c
) && !single_kboard
)
2768 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2769 if (kb
->kbd_queue_has_data
)
2771 current_kboard
= kb
;
2772 /* This is going to exit from read_char
2773 so we had better get rid of this frame's stuff. */
2775 return make_number (-2); /* wrong_kboard_jmpbuf */
2783 /* Finally, we read from the main queue,
2784 and if that gives us something we can't use yet, we put it on the
2785 appropriate side queue and try again. */
2789 KBOARD
*kb
IF_LINT (= NULL
);
2794 EMACS_GET_TIME (now
);
2795 if (EMACS_TIME_GE (now
, *end_time
))
2799 /* Actually read a character, waiting if necessary. */
2800 save_getcjmp (save_jump
);
2801 restore_getcjmp (local_getcjmp
);
2803 timer_start_idle ();
2804 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2805 restore_getcjmp (save_jump
);
2807 if (! NILP (c
) && (kb
!= current_kboard
))
2809 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2812 while (CONSP (XCDR (last
)))
2814 if (!NILP (XCDR (last
)))
2818 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2820 XSETCDR (last
, Fcons (c
, Qnil
));
2821 kb
->kbd_queue_has_data
= 1;
2825 current_kboard
= kb
;
2826 /* This is going to exit from read_char
2827 so we had better get rid of this frame's stuff. */
2829 return make_number (-2);
2833 /* Terminate Emacs in batch mode if at eof. */
2834 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2835 Fkill_emacs (make_number (1));
2839 /* Add in any extra modifiers, where appropriate. */
2840 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2841 || ((extra_keyboard_modifiers
& 0177) < ' '
2842 && (extra_keyboard_modifiers
& 0177) != 0))
2843 XSETINT (c
, make_ctrl_char (XINT (c
)));
2845 /* Transfer any other modifier bits directly from
2846 extra_keyboard_modifiers to c. Ignore the actual character code
2847 in the low 16 bits of extra_keyboard_modifiers. */
2848 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2859 if (commandflag
>= 0
2860 && !input_pending
&& !detect_input_pending_run_timers (0))
2868 /* Buffer switch events are only for internal wakeups
2869 so don't show them to the user.
2870 Also, don't record a key if we already did. */
2871 if (BUFFERP (c
) || key_already_recorded
)
2874 /* Process special events within read_char
2875 and loop around to read another event. */
2878 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2883 struct buffer
*prev_buffer
= current_buffer
;
2884 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2885 int was_locked
= single_kboard
;
2886 int count
= SPECPDL_INDEX ();
2887 record_single_kboard_state ();
2890 last_input_event
= c
;
2891 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2893 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2894 /* We stopped being idle for this event; undo that. This
2895 prevents automatic window selection (under
2896 mouse_autoselect_window from acting as a real input event, for
2897 example banishing the mouse under mouse-avoidance-mode. */
2898 timer_resume_idle ();
2900 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2901 /* Resume allowing input from any kboard, if that was true before. */
2903 any_kboard_state ();
2904 unbind_to (count
, Qnil
);
2907 if (current_buffer
!= prev_buffer
)
2909 /* The command may have changed the keymaps. Pretend there
2910 is input in another keyboard and return. This will
2911 recalculate keymaps. */
2912 c
= make_number (-2);
2919 /* Handle things that only apply to characters. */
2922 /* If kbd_buffer_get_event gave us an EOF, return that. */
2926 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2927 && UNSIGNED_CMP (XFASTINT (c
), <,
2928 SCHARS (KVAR (current_kboard
,
2929 Vkeyboard_translate_table
))))
2930 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2931 && UNSIGNED_CMP (XFASTINT (c
), <,
2932 ASIZE (KVAR (current_kboard
,
2933 Vkeyboard_translate_table
))))
2934 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2938 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2939 /* nil in keyboard-translate-table means no translation. */
2945 /* If this event is a mouse click in the menu bar,
2946 return just menu-bar for now. Modify the mouse click event
2947 so we won't do this twice, then queue it up. */
2948 if (EVENT_HAS_PARAMETERS (c
)
2950 && CONSP (EVENT_START (c
))
2951 && CONSP (XCDR (EVENT_START (c
))))
2955 posn
= POSN_POSN (EVENT_START (c
));
2956 /* Handle menu-bar events:
2957 insert the dummy prefix event `menu-bar'. */
2958 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2960 /* Change menu-bar to (menu-bar) as the event "position". */
2961 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2964 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2969 /* Store these characters into recent_keys, the dribble file if any,
2970 and the keyboard macro being defined, if any. */
2972 if (! NILP (also_record
))
2973 record_char (also_record
);
2975 /* Wipe the echo area.
2976 But first, if we are about to use an input method,
2977 save the echo area contents for it to refer to. */
2979 && ! NILP (Vinput_method_function
)
2980 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2982 previous_echo_area_message
= Fcurrent_message ();
2983 Vinput_method_previous_message
= previous_echo_area_message
;
2986 /* Now wipe the echo area, except for help events which do their
2987 own stuff with the echo area. */
2989 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2990 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2992 if (!NILP (echo_area_buffer
[0]))
2993 safe_run_hooks (Qecho_area_clear_hook
);
2994 clear_message (1, 0);
2997 reread_for_input_method
:
2999 /* Pass this to the input method, if appropriate. */
3001 && ! NILP (Vinput_method_function
)
3002 /* Don't run the input method within a key sequence,
3003 after the first event of the key sequence. */
3004 && NILP (prev_event
)
3005 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3008 int key_count
, key_count_reset
;
3009 struct gcpro gcpro1
;
3010 int count
= SPECPDL_INDEX ();
3012 /* Save the echo status. */
3013 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3014 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3015 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3016 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3019 if (before_command_restore_flag
)
3021 this_command_key_count
= before_command_key_count_1
;
3022 if (this_command_key_count
< this_single_command_key_start
)
3023 this_single_command_key_start
= this_command_key_count
;
3024 echo_truncate (before_command_echo_length_1
);
3025 before_command_restore_flag
= 0;
3029 /* Save the this_command_keys status. */
3030 key_count
= this_command_key_count
;
3031 key_count_reset
= this_command_key_count_reset
;
3034 keys
= Fcopy_sequence (this_command_keys
);
3039 /* Clear out this_command_keys. */
3040 this_command_key_count
= 0;
3041 this_command_key_count_reset
= 0;
3043 /* Now wipe the echo area. */
3044 if (!NILP (echo_area_buffer
[0]))
3045 safe_run_hooks (Qecho_area_clear_hook
);
3046 clear_message (1, 0);
3049 /* If we are not reading a key sequence,
3050 never use the echo area. */
3053 specbind (Qinput_method_use_echo_area
, Qt
);
3056 /* Call the input method. */
3057 tem
= call1 (Vinput_method_function
, c
);
3059 tem
= unbind_to (count
, tem
);
3061 /* Restore the saved echoing state
3062 and this_command_keys state. */
3063 this_command_key_count
= key_count
;
3064 this_command_key_count_reset
= key_count_reset
;
3066 this_command_keys
= keys
;
3069 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3070 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3071 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3072 if (saved_immediate_echo
)
3077 /* The input method can return no events. */
3080 /* Bring back the previous message, if any. */
3081 if (! NILP (previous_echo_area_message
))
3082 message_with_string ("%s", previous_echo_area_message
, 0);
3085 /* It returned one event or more. */
3087 Vunread_post_input_method_events
3088 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3093 /* Display help if not echoing. */
3094 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3096 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3097 Lisp_Object help
, object
, position
, window
, htem
;
3099 htem
= Fcdr (XCDR (c
));
3102 window
= Fcar (htem
);
3104 object
= Fcar (htem
);
3106 position
= Fcar (htem
);
3108 show_help_echo (help
, window
, object
, position
);
3110 /* We stopped being idle for this event; undo that. */
3112 timer_resume_idle ();
3116 if ((! reread
|| this_command_key_count
== 0
3117 || this_command_key_count_reset
)
3121 /* Don't echo mouse motion events. */
3122 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3123 && NILP (Fzerop (Vecho_keystrokes
))
3124 && ! (EVENT_HAS_PARAMETERS (c
)
3125 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3128 if (! NILP (also_record
))
3129 echo_char (also_record
);
3130 /* Once we reread a character, echoing can happen
3131 the next time we pause to read a new one. */
3132 ok_to_echo_at_next_pause
= current_kboard
;
3135 /* Record this character as part of the current key. */
3136 add_command_key (c
);
3137 if (! NILP (also_record
))
3138 add_command_key (also_record
);
3141 last_input_event
= c
;
3144 /* Process the help character specially if enabled */
3145 if (!NILP (Vhelp_form
) && help_char_p (c
))
3147 int count
= SPECPDL_INDEX ();
3149 help_form_saved_window_configs
3150 = Fcons (Fcurrent_window_configuration (Qnil
),
3151 help_form_saved_window_configs
);
3152 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3153 call0 (Qhelp_form_show
);
3158 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3159 if (EVENT_HAS_PARAMETERS (c
)
3160 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3161 XSETCAR (help_form_saved_window_configs
, Qnil
);
3163 while (BUFFERP (c
));
3164 /* Remove the help from the frame */
3165 unbind_to (count
, Qnil
);
3168 if (EQ (c
, make_number (040)))
3172 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3173 while (BUFFERP (c
));
3182 /* Record a key that came from a mouse menu.
3183 Record it for echoing, for this-command-keys, and so on. */
3186 record_menu_key (Lisp_Object c
)
3188 /* Wipe the echo area. */
3189 clear_message (1, 0);
3194 before_command_key_count
= this_command_key_count
;
3195 before_command_echo_length
= echo_length ();
3198 /* Don't echo mouse motion events. */
3199 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3200 && NILP (Fzerop (Vecho_keystrokes
)))
3204 /* Once we reread a character, echoing can happen
3205 the next time we pause to read a new one. */
3206 ok_to_echo_at_next_pause
= 0;
3209 /* Record this character as part of the current key. */
3210 add_command_key (c
);
3212 /* Re-reading in the middle of a command */
3213 last_input_event
= c
;
3217 /* Return 1 if should recognize C as "the help character". */
3220 help_char_p (Lisp_Object c
)
3224 if (EQ (c
, Vhelp_char
))
3226 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3227 if (EQ (c
, XCAR (tail
)))
3232 /* Record the input event C in various ways. */
3235 record_char (Lisp_Object c
)
3239 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3241 /* To avoid filling recent_keys with help-echo and mouse-movement
3242 events, we filter out repeated help-echo events, only store the
3243 first and last in a series of mouse-movement events, and don't
3244 store repeated help-echo events which are only separated by
3245 mouse-movement events. */
3247 Lisp_Object ev1
, ev2
, ev3
;
3250 if ((ix1
= recent_keys_index
- 1) < 0)
3251 ix1
= NUM_RECENT_KEYS
- 1;
3252 ev1
= AREF (recent_keys
, ix1
);
3254 if ((ix2
= ix1
- 1) < 0)
3255 ix2
= NUM_RECENT_KEYS
- 1;
3256 ev2
= AREF (recent_keys
, ix2
);
3258 if ((ix3
= ix2
- 1) < 0)
3259 ix3
= NUM_RECENT_KEYS
- 1;
3260 ev3
= AREF (recent_keys
, ix3
);
3262 if (EQ (XCAR (c
), Qhelp_echo
))
3264 /* Don't record `help-echo' in recent_keys unless it shows some help
3265 message, and a different help than the previously recorded
3267 Lisp_Object help
, last_help
;
3269 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3270 if (!STRINGP (help
))
3272 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3273 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3275 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3276 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3277 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3279 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3280 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3281 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3282 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3285 else if (EQ (XCAR (c
), Qmouse_movement
))
3287 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3288 So additional mouse movement events replace the last element. */
3289 Lisp_Object last_window
, window
;
3291 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3292 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3293 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3294 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3295 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3297 ASET (recent_keys
, ix1
, c
);
3303 store_kbd_macro_char (c
);
3308 ASET (recent_keys
, recent_keys_index
, c
);
3309 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3310 recent_keys_index
= 0;
3312 else if (recorded
< 0)
3314 /* We need to remove one or two events from recent_keys.
3315 To do this, we simply put nil at those events and move the
3316 recent_keys_index backwards over those events. Usually,
3317 users will never see those nil events, as they will be
3318 overwritten by the command keys entered to see recent_keys
3321 while (recorded
++ < 0 && total_keys
> 0)
3323 if (total_keys
< NUM_RECENT_KEYS
)
3325 if (--recent_keys_index
< 0)
3326 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3327 ASET (recent_keys
, recent_keys_index
, Qnil
);
3331 num_nonmacro_input_events
++;
3333 /* Write c to the dribble file. If c is a lispy event, write
3334 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3335 If you, dear reader, have a better idea, you've got the source. :-) */
3341 if (XUINT (c
) < 0x100)
3342 putc (XUINT (c
), dribble
);
3344 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3348 Lisp_Object dribblee
;
3350 /* If it's a structured event, take the event header. */
3351 dribblee
= EVENT_HEAD (c
);
3353 if (SYMBOLP (dribblee
))
3355 putc ('<', dribble
);
3356 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3357 SBYTES (SYMBOL_NAME (dribblee
)),
3359 putc ('>', dribble
);
3368 /* Copy out or in the info on where C-g should throw to.
3369 This is used when running Lisp code from within get_char,
3370 in case get_char is called recursively.
3371 See read_process_output. */
3374 save_getcjmp (jmp_buf temp
)
3376 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3380 restore_getcjmp (jmp_buf temp
)
3382 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3385 /* Low level keyboard/mouse input.
3386 kbd_buffer_store_event places events in kbd_buffer, and
3387 kbd_buffer_get_event retrieves them. */
3389 /* Return true if there are any events in the queue that read-char
3390 would return. If this returns false, a read-char would block. */
3392 readable_events (int flags
)
3394 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3397 /* If the buffer contains only FOCUS_IN_EVENT events, and
3398 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3399 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3401 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3402 #ifdef USE_TOOLKIT_SCROLL_BARS
3403 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3407 struct input_event
*event
;
3409 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3416 #ifdef USE_TOOLKIT_SCROLL_BARS
3417 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3419 event
->kind
== FOCUS_IN_EVENT
)
3420 #ifdef USE_TOOLKIT_SCROLL_BARS
3421 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3422 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3423 && event
->part
== scroll_bar_handle
3424 && event
->modifiers
== 0)
3429 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3432 while (event
!= kbd_store_ptr
);
3438 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3439 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3440 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3445 if (current_kboard
->kbd_queue_has_data
)
3451 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3452 if (kb
->kbd_queue_has_data
)
3458 /* Set this for debugging, to have a way to get out */
3459 int stop_character EXTERNALLY_VISIBLE
;
3462 event_to_kboard (struct input_event
*event
)
3465 frame
= event
->frame_or_window
;
3467 frame
= XCAR (frame
);
3468 else if (WINDOWP (frame
))
3469 frame
= WINDOW_FRAME (XWINDOW (frame
));
3471 /* There are still some events that don't set this field.
3472 For now, just ignore the problem.
3473 Also ignore dead frames here. */
3474 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3477 return FRAME_KBOARD (XFRAME (frame
));
3481 /* Return the number of slots occupied in kbd_buffer. */
3484 kbd_buffer_nr_stored (void)
3486 return kbd_fetch_ptr
== kbd_store_ptr
3488 : (kbd_fetch_ptr
< kbd_store_ptr
3489 ? kbd_store_ptr
- kbd_fetch_ptr
3490 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3491 + (kbd_store_ptr
- kbd_buffer
)));
3493 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3496 kbd_buffer_store_event (register struct input_event
*event
)
3498 kbd_buffer_store_event_hold (event
, 0);
3501 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3503 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3504 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3505 Else, if EVENT is a quit event, store the quit event
3506 in HOLD_QUIT, and return (thus ignoring further events).
3508 This is used in read_avail_input to postpone the processing
3509 of the quit event until all subsequent input events have been
3510 parsed (and discarded).
3514 kbd_buffer_store_event_hold (register struct input_event
*event
,
3515 struct input_event
*hold_quit
)
3517 if (event
->kind
== NO_EVENT
)
3520 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3523 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3525 register int c
= event
->code
& 0377;
3527 if (event
->modifiers
& ctrl_modifier
)
3528 c
= make_ctrl_char (c
);
3530 c
|= (event
->modifiers
3531 & (meta_modifier
| alt_modifier
3532 | hyper_modifier
| super_modifier
));
3536 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3537 struct input_event
*sp
;
3539 if (single_kboard
&& kb
!= current_kboard
)
3541 KVAR (kb
, kbd_queue
)
3542 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3543 Fcons (make_number (c
), Qnil
));
3544 kb
->kbd_queue_has_data
= 1;
3545 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3547 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3550 if (event_to_kboard (sp
) == kb
)
3552 sp
->kind
= NO_EVENT
;
3553 sp
->frame_or_window
= Qnil
;
3562 memcpy (hold_quit
, event
, sizeof (*event
));
3566 /* If this results in a quit_char being returned to Emacs as
3567 input, set Vlast_event_frame properly. If this doesn't
3568 get returned to Emacs as an event, the next event read
3569 will set Vlast_event_frame again, so this is safe to do. */
3573 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3575 focus
= event
->frame_or_window
;
3576 internal_last_event_frame
= focus
;
3577 Vlast_event_frame
= focus
;
3580 last_event_timestamp
= event
->timestamp
;
3581 handle_interrupt ();
3585 if (c
&& c
== stop_character
)
3591 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3592 Just ignore the second one. */
3593 else if (event
->kind
== BUFFER_SWITCH_EVENT
3594 && kbd_fetch_ptr
!= kbd_store_ptr
3595 && ((kbd_store_ptr
== kbd_buffer
3596 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3597 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3600 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3601 kbd_store_ptr
= kbd_buffer
;
3603 /* Don't let the very last slot in the buffer become full,
3604 since that would make the two pointers equal,
3605 and that is indistinguishable from an empty buffer.
3606 Discard the event if it would fill the last slot. */
3607 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3609 *kbd_store_ptr
= *event
;
3612 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3614 /* Don't read keyboard input until we have processed kbd_buffer.
3615 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3616 hold_keyboard_input ();
3618 if (!noninteractive
)
3619 signal (SIGIO
, SIG_IGN
);
3623 #endif /* subprocesses */
3626 /* If we're inside while-no-input, and this event qualifies
3627 as input, set quit-flag to cause an interrupt. */
3628 if (!NILP (Vthrow_on_input
)
3629 && event
->kind
!= FOCUS_IN_EVENT
3630 && event
->kind
!= HELP_EVENT
3631 && event
->kind
!= DEICONIFY_EVENT
)
3633 Vquit_flag
= Vthrow_on_input
;
3634 /* If we're inside a function that wants immediate quits,
3636 if (immediate_quit
&& NILP (Vinhibit_quit
))
3646 /* Put an input event back in the head of the event queue. */
3649 kbd_buffer_unget_event (register struct input_event
*event
)
3651 if (kbd_fetch_ptr
== kbd_buffer
)
3652 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3654 /* Don't let the very last slot in the buffer become full, */
3655 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3658 *kbd_fetch_ptr
= *event
;
3663 /* Generate a HELP_EVENT input_event and store it in the keyboard
3666 HELP is the help form.
3668 FRAME and WINDOW are the frame and window where the help is
3669 generated. OBJECT is the Lisp object where the help was found (a
3670 buffer, a string, an overlay, or nil if neither from a string nor
3671 from a buffer). POS is the position within OBJECT where the help
3675 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3676 Lisp_Object object
, EMACS_INT pos
)
3678 struct input_event event
;
3682 event
.kind
= HELP_EVENT
;
3683 event
.frame_or_window
= frame
;
3685 event
.x
= WINDOWP (window
) ? window
: frame
;
3688 kbd_buffer_store_event (&event
);
3692 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3695 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3697 struct input_event event
;
3699 event
.kind
= HELP_EVENT
;
3700 event
.frame_or_window
= frame
;
3705 kbd_buffer_store_event (&event
);
3709 /* Discard any mouse events in the event buffer by setting them to
3712 discard_mouse_events (void)
3714 struct input_event
*sp
;
3715 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3717 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3720 if (sp
->kind
== MOUSE_CLICK_EVENT
3721 || sp
->kind
== WHEEL_EVENT
3722 || sp
->kind
== HORIZ_WHEEL_EVENT
3724 || sp
->kind
== GPM_CLICK_EVENT
3726 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3728 sp
->kind
= NO_EVENT
;
3734 /* Return non-zero if there are any real events waiting in the event
3735 buffer, not counting `NO_EVENT's.
3737 If DISCARD is non-zero, discard NO_EVENT events at the front of
3738 the input queue, possibly leaving the input queue empty if there
3739 are no real input events. */
3742 kbd_buffer_events_waiting (int discard
)
3744 struct input_event
*sp
;
3746 for (sp
= kbd_fetch_ptr
;
3747 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3750 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3757 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3761 /* Clear input event EVENT. */
3764 clear_event (struct input_event
*event
)
3766 event
->kind
= NO_EVENT
;
3770 /* Read one event from the event buffer, waiting if necessary.
3771 The value is a Lisp object representing the event.
3772 The value is nil for an event that should be ignored,
3773 or that was handled here.
3774 We always read and discard one event. */
3777 kbd_buffer_get_event (KBOARD
**kbp
,
3778 int *used_mouse_menu
,
3779 struct timeval
*end_time
)
3785 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3787 /* Start reading input again, we have processed enough so we can
3788 accept new events again. */
3789 unhold_keyboard_input ();
3791 if (!noninteractive
)
3792 signal (SIGIO
, input_available_signal
);
3796 #endif /* subprocesses */
3799 /* In case we are running as a daemon, only do this before
3800 detaching from the terminal. */
3801 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3805 *kbp
= current_kboard
;
3809 /* Wait until there is input available. */
3812 /* Break loop if there's an unread command event. Needed in
3813 moused window autoselection which uses a timer to insert such
3815 if (CONSP (Vunread_command_events
))
3818 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3820 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3821 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3825 /* If the quit flag is set, then read_char will return
3826 quit_char, so that counts as "available input." */
3827 if (!NILP (Vquit_flag
))
3828 quit_throw_to_read_char (0);
3830 /* One way or another, wait until input is available; then, if
3831 interrupt handlers have not read it, read it now. */
3833 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3837 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3839 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3840 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3845 EMACS_TIME duration
;
3846 EMACS_GET_TIME (duration
);
3847 if (EMACS_TIME_GE (duration
, *end_time
))
3848 return Qnil
; /* finished waiting */
3851 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3852 wait_reading_process_output (EMACS_SECS (duration
),
3853 EMACS_USECS (duration
),
3854 -1, 1, Qnil
, NULL
, 0);
3858 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3860 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3861 /* Pass 1 for EXPECT since we just waited to have input. */
3862 read_avail_input (1);
3865 if (CONSP (Vunread_command_events
))
3868 first
= XCAR (Vunread_command_events
);
3869 Vunread_command_events
= XCDR (Vunread_command_events
);
3870 *kbp
= current_kboard
;
3874 /* At this point, we know that there is a readable event available
3875 somewhere. If the event queue is empty, then there must be a
3876 mouse movement enabled and available. */
3877 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3879 struct input_event
*event
;
3881 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3885 last_event_timestamp
= event
->timestamp
;
3887 *kbp
= event_to_kboard (event
);
3889 *kbp
= current_kboard
; /* Better than returning null ptr? */
3893 /* These two kinds of events get special handling
3894 and don't actually appear to the command loop.
3895 We return nil for them. */
3896 if (event
->kind
== SELECTION_REQUEST_EVENT
3897 || event
->kind
== SELECTION_CLEAR_EVENT
)
3900 struct input_event copy
;
3902 /* Remove it from the buffer before processing it,
3903 since otherwise swallow_events will see it
3904 and process it again. */
3906 kbd_fetch_ptr
= event
+ 1;
3907 input_pending
= readable_events (0);
3908 x_handle_selection_event (©
);
3910 /* We're getting selection request events, but we don't have
3916 #if defined (HAVE_NS)
3917 else if (event
->kind
== NS_TEXT_EVENT
)
3919 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3920 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3922 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3923 kbd_fetch_ptr
= event
+ 1;
3924 if (used_mouse_menu
)
3925 *used_mouse_menu
= 1;
3929 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3930 || defined (HAVE_NS)
3931 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3933 /* Make an event (delete-frame (FRAME)). */
3934 obj
= Fcons (event
->frame_or_window
, Qnil
);
3935 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3936 kbd_fetch_ptr
= event
+ 1;
3939 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3940 || defined (HAVE_NS)
3941 else if (event
->kind
== ICONIFY_EVENT
)
3943 /* Make an event (iconify-frame (FRAME)). */
3944 obj
= Fcons (event
->frame_or_window
, Qnil
);
3945 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3946 kbd_fetch_ptr
= event
+ 1;
3948 else if (event
->kind
== DEICONIFY_EVENT
)
3950 /* Make an event (make-frame-visible (FRAME)). */
3951 obj
= Fcons (event
->frame_or_window
, Qnil
);
3952 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3953 kbd_fetch_ptr
= event
+ 1;
3956 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3958 /* The value doesn't matter here; only the type is tested. */
3959 XSETBUFFER (obj
, current_buffer
);
3960 kbd_fetch_ptr
= event
+ 1;
3962 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3963 || defined (HAVE_NS) || defined (USE_GTK)
3964 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3966 kbd_fetch_ptr
= event
+ 1;
3967 input_pending
= readable_events (0);
3968 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3969 x_activate_menubar (XFRAME (event
->frame_or_window
));
3972 #if defined (WINDOWSNT)
3973 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3975 /* Make an event (language-change (FRAME CHARSET LCID)). */
3976 obj
= Fcons (event
->frame_or_window
, Qnil
);
3977 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3978 kbd_fetch_ptr
= event
+ 1;
3981 else if (event
->kind
== SAVE_SESSION_EVENT
)
3983 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3984 kbd_fetch_ptr
= event
+ 1;
3986 /* Just discard these, by returning nil.
3987 With MULTI_KBOARD, these events are used as placeholders
3988 when we need to randomly delete events from the queue.
3989 (They shouldn't otherwise be found in the buffer,
3990 but on some machines it appears they do show up
3991 even without MULTI_KBOARD.) */
3992 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3993 mouse events during a popup-menu call. */
3994 else if (event
->kind
== NO_EVENT
)
3995 kbd_fetch_ptr
= event
+ 1;
3996 else if (event
->kind
== HELP_EVENT
)
3998 Lisp_Object object
, position
, help
, frame
, window
;
4000 frame
= event
->frame_or_window
;
4001 object
= event
->arg
;
4002 position
= make_number (event
->code
);
4005 clear_event (event
);
4007 kbd_fetch_ptr
= event
+ 1;
4008 if (!WINDOWP (window
))
4010 obj
= Fcons (Qhelp_echo
,
4011 list5 (frame
, help
, window
, object
, position
));
4013 else if (event
->kind
== FOCUS_IN_EVENT
)
4015 /* Notification of a FocusIn event. The frame receiving the
4016 focus is in event->frame_or_window. Generate a
4017 switch-frame event if necessary. */
4018 Lisp_Object frame
, focus
;
4020 frame
= event
->frame_or_window
;
4021 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4025 if (!EQ (frame
, internal_last_event_frame
)
4026 && !EQ (frame
, selected_frame
))
4027 obj
= make_lispy_switch_frame (frame
);
4028 internal_last_event_frame
= frame
;
4029 kbd_fetch_ptr
= event
+ 1;
4032 else if (event
->kind
== DBUS_EVENT
)
4034 obj
= make_lispy_event (event
);
4035 kbd_fetch_ptr
= event
+ 1;
4038 #ifdef HAVE_XWIDGETS
4039 else if (event
->kind
== XWIDGET_EVENT
)
4041 obj
= make_lispy_event (event
);
4042 kbd_fetch_ptr
= event
+ 1;
4045 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4047 obj
= make_lispy_event (event
);
4048 kbd_fetch_ptr
= event
+ 1;
4052 /* If this event is on a different frame, return a switch-frame this
4053 time, and leave the event in the queue for next time. */
4057 frame
= event
->frame_or_window
;
4059 frame
= XCAR (frame
);
4060 else if (WINDOWP (frame
))
4061 frame
= WINDOW_FRAME (XWINDOW (frame
));
4063 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4067 if (! EQ (frame
, internal_last_event_frame
)
4068 && !EQ (frame
, selected_frame
))
4069 obj
= make_lispy_switch_frame (frame
);
4070 internal_last_event_frame
= frame
;
4072 /* If we didn't decide to make a switch-frame event, go ahead
4073 and build a real event from the queue entry. */
4077 obj
= make_lispy_event (event
);
4079 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4080 || defined (HAVE_NS) || defined (USE_GTK)
4081 /* If this was a menu selection, then set the flag to inhibit
4082 writing to last_nonmenu_event. Don't do this if the event
4083 we're returning is (menu-bar), though; that indicates the
4084 beginning of the menu sequence, and we might as well leave
4085 that as the `event with parameters' for this selection. */
4087 && !EQ (event
->frame_or_window
, event
->arg
)
4088 && (event
->kind
== MENU_BAR_EVENT
4089 || event
->kind
== TOOL_BAR_EVENT
))
4090 *used_mouse_menu
= 1;
4093 /* certain system events are non-key events */
4095 && event
->kind
== NS_NONKEY_EVENT
)
4096 *used_mouse_menu
= 1;
4099 /* Wipe out this event, to catch bugs. */
4100 clear_event (event
);
4101 kbd_fetch_ptr
= event
+ 1;
4105 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4106 /* Try generating a mouse motion event. */
4107 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4109 FRAME_PTR f
= some_mouse_moved ();
4110 Lisp_Object bar_window
;
4111 enum scroll_bar_part part
;
4115 *kbp
= current_kboard
;
4116 /* Note that this uses F to determine which terminal to look at.
4117 If there is no valid info, it does not store anything
4118 so x remains nil. */
4121 /* XXX Can f or mouse_position_hook be NULL here? */
4122 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4123 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4128 /* Decide if we should generate a switch-frame event. Don't
4129 generate switch-frame events for motion outside of all Emacs
4135 frame
= FRAME_FOCUS_FRAME (f
);
4137 XSETFRAME (frame
, f
);
4139 if (! EQ (frame
, internal_last_event_frame
)
4140 && !EQ (frame
, selected_frame
))
4141 obj
= make_lispy_switch_frame (frame
);
4142 internal_last_event_frame
= frame
;
4145 /* If we didn't decide to make a switch-frame event, go ahead and
4146 return a mouse-motion event. */
4147 if (!NILP (x
) && NILP (obj
))
4148 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4150 #endif /* HAVE_MOUSE || HAVE GPM */
4152 /* We were promised by the above while loop that there was
4153 something for us to read! */
4156 input_pending
= readable_events (0);
4158 Vlast_event_frame
= internal_last_event_frame
;
4163 /* Process any non-user-visible events (currently X selection events),
4164 without reading any user-visible events. */
4167 process_special_events (void)
4169 struct input_event
*event
;
4171 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4173 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4176 if (event
== kbd_store_ptr
)
4180 /* If we find a stored X selection request, handle it now. */
4181 if (event
->kind
== SELECTION_REQUEST_EVENT
4182 || event
->kind
== SELECTION_CLEAR_EVENT
)
4186 /* Remove the event from the fifo buffer before processing;
4187 otherwise swallow_events called recursively could see it
4188 and process it again. To do this, we move the events
4189 between kbd_fetch_ptr and EVENT one slot to the right,
4192 struct input_event copy
= *event
;
4193 struct input_event
*beg
4194 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4195 ? kbd_buffer
: kbd_fetch_ptr
;
4198 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4199 else if (event
< beg
)
4201 if (event
> kbd_buffer
)
4202 memmove (kbd_buffer
+ 1, kbd_buffer
,
4203 (event
- kbd_buffer
) * sizeof (struct input_event
));
4204 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4205 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4206 memmove (beg
+ 1, beg
,
4207 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4208 * sizeof (struct input_event
));
4211 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4212 kbd_fetch_ptr
= kbd_buffer
+ 1;
4216 /* X wants last_event_timestamp for selection ownership. */
4217 last_event_timestamp
= copy
.timestamp
;
4218 input_pending
= readable_events (0);
4219 x_handle_selection_event (©
);
4221 /* We're getting selection request events, but we don't have
4229 /* Process any events that are not user-visible, run timer events that
4230 are ripe, and return, without reading any user-visible events. */
4233 swallow_events (int do_display
)
4237 process_special_events ();
4239 old_timers_run
= timers_run
;
4240 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4242 if (timers_run
!= old_timers_run
&& do_display
)
4243 redisplay_preserve_echo_area (7);
4246 /* Record the start of when Emacs is idle,
4247 for the sake of running idle-time timers. */
4250 timer_start_idle (void)
4254 /* If we are already in the idle state, do nothing. */
4255 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4258 EMACS_GET_TIME (timer_idleness_start_time
);
4260 timer_last_idleness_start_time
= timer_idleness_start_time
;
4262 /* Mark all idle-time timers as once again candidates for running. */
4263 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4267 timer
= XCAR (timers
);
4269 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4271 XVECTOR (timer
)->contents
[0] = Qnil
;
4275 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4278 timer_stop_idle (void)
4280 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4283 /* Resume idle timer from last idle start time. */
4286 timer_resume_idle (void)
4288 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4291 timer_idleness_start_time
= timer_last_idleness_start_time
;
4294 /* This is only for debugging. */
4295 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4297 /* List of elisp functions to call, delayed because they were generated in
4298 a context where Elisp could not be safely run (e.g. redisplay, signal,
4299 ...). Each element has the form (FUN . ARGS). */
4300 Lisp_Object pending_funcalls
;
4302 /* Check whether a timer has fired. To prevent larger problems we simply
4303 disregard elements that are not proper timers. Do not make a circular
4304 timer list for the time being.
4306 Returns the time to wait until the next timer fires. If a
4307 timer is triggering now, return zero.
4308 If no timer is active, return -1.
4310 If a timer is ripe, we run it, with quitting turned off.
4311 In that case we return 0 to indicate that a new timer_check_2 call
4315 timer_check_2 (void)
4317 EMACS_TIME nexttime
;
4319 EMACS_TIME idleness_now
IF_LINT (= {0});
4320 Lisp_Object timers
, idle_timers
, chosen_timer
;
4321 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4323 EMACS_SET_SECS (nexttime
, -1);
4324 EMACS_SET_USECS (nexttime
, -1);
4326 /* Always consider the ordinary timers. */
4327 timers
= Vtimer_list
;
4328 /* Consider the idle timers only if Emacs is idle. */
4329 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4330 idle_timers
= Vtimer_idle_list
;
4333 chosen_timer
= Qnil
;
4334 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4336 /* First run the code that was delayed. */
4337 while (CONSP (pending_funcalls
))
4339 Lisp_Object funcall
= XCAR (pending_funcalls
);
4340 pending_funcalls
= XCDR (pending_funcalls
);
4341 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4344 if (CONSP (timers
) || CONSP (idle_timers
))
4346 EMACS_GET_TIME (now
);
4347 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4348 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4351 while (CONSP (timers
) || CONSP (idle_timers
))
4353 Lisp_Object
*vector
;
4354 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4355 EMACS_TIME timer_time
, idle_timer_time
;
4356 EMACS_TIME difference
;
4357 EMACS_TIME timer_difference
IF_LINT (= {0});
4358 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4360 /* Skip past invalid timers and timers already handled. */
4363 timer
= XCAR (timers
);
4364 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4366 timers
= XCDR (timers
);
4369 vector
= XVECTOR (timer
)->contents
;
4371 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4372 || !INTEGERP (vector
[3])
4373 || ! NILP (vector
[0]))
4375 timers
= XCDR (timers
);
4379 if (CONSP (idle_timers
))
4381 timer
= XCAR (idle_timers
);
4382 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4384 idle_timers
= XCDR (idle_timers
);
4387 vector
= XVECTOR (timer
)->contents
;
4389 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4390 || !INTEGERP (vector
[3])
4391 || ! NILP (vector
[0]))
4393 idle_timers
= XCDR (idle_timers
);
4398 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4399 based on the next ordinary timer.
4400 TIMER_DIFFERENCE is the distance in time from NOW to when
4401 this timer becomes ripe (negative if it's already ripe). */
4404 timer
= XCAR (timers
);
4405 vector
= XVECTOR (timer
)->contents
;
4406 EMACS_SET_SECS (timer_time
,
4407 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4408 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4409 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4412 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4413 based on the next idle timer. */
4414 if (CONSP (idle_timers
))
4416 idle_timer
= XCAR (idle_timers
);
4417 vector
= XVECTOR (idle_timer
)->contents
;
4418 EMACS_SET_SECS (idle_timer_time
,
4419 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4420 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4421 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4424 /* Decide which timer is the next timer,
4425 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4426 Also step down the list where we found that timer. */
4428 if (CONSP (timers
) && CONSP (idle_timers
))
4431 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4432 if (EMACS_TIME_NEG_P (temp
))
4434 chosen_timer
= timer
;
4435 timers
= XCDR (timers
);
4436 difference
= timer_difference
;
4440 chosen_timer
= idle_timer
;
4441 idle_timers
= XCDR (idle_timers
);
4442 difference
= idle_timer_difference
;
4445 else if (CONSP (timers
))
4447 chosen_timer
= timer
;
4448 timers
= XCDR (timers
);
4449 difference
= timer_difference
;
4453 chosen_timer
= idle_timer
;
4454 idle_timers
= XCDR (idle_timers
);
4455 difference
= idle_timer_difference
;
4457 vector
= XVECTOR (chosen_timer
)->contents
;
4459 /* If timer is ripe, run it if it hasn't been run. */
4460 if (EMACS_TIME_NEG_P (difference
)
4461 || (EMACS_SECS (difference
) == 0
4462 && EMACS_USECS (difference
) == 0))
4464 if (NILP (vector
[0]))
4466 int count
= SPECPDL_INDEX ();
4467 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4469 /* Mark the timer as triggered to prevent problems if the lisp
4470 code fails to reschedule it right. */
4473 specbind (Qinhibit_quit
, Qt
);
4475 call1 (Qtimer_event_handler
, chosen_timer
);
4476 Vdeactivate_mark
= old_deactivate_mark
;
4478 unbind_to (count
, Qnil
);
4480 /* Since we have handled the event,
4481 we don't need to tell the caller to wake up and do it. */
4482 /* But the caller must still wait for the next timer, so
4483 return 0 to indicate that. */
4486 EMACS_SET_SECS (nexttime
, 0);
4487 EMACS_SET_USECS (nexttime
, 0);
4490 /* When we encounter a timer that is still waiting,
4491 return the amount of time to wait before it is ripe. */
4498 /* No timers are pending in the future. */
4499 /* Return 0 if we generated an event, and -1 if not. */
4505 /* Check whether a timer has fired. To prevent larger problems we simply
4506 disregard elements that are not proper timers. Do not make a circular
4507 timer list for the time being.
4509 Returns the time to wait until the next timer fires.
4510 If no timer is active, return -1.
4512 As long as any timer is ripe, we run it. */
4517 EMACS_TIME nexttime
;
4521 nexttime
= timer_check_2 ();
4523 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4528 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4529 doc
: /* Return the current length of Emacs idleness, or nil.
4530 The value when Emacs is idle is a list of three integers. The first has
4531 the most significant 16 bits of the seconds, while the second has the least
4532 significant 16 bits. The third integer gives the microsecond count.
4534 The value when Emacs is not idle is nil.
4536 The microsecond count is zero on systems that do not provide
4537 resolution finer than a second. */)
4540 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4542 EMACS_TIME now
, idleness_now
;
4544 EMACS_GET_TIME (now
);
4545 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4547 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4548 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4549 make_number (EMACS_USECS (idleness_now
)));
4555 /* Caches for modify_event_symbol. */
4556 static Lisp_Object accent_key_syms
;
4557 static Lisp_Object func_key_syms
;
4558 static Lisp_Object mouse_syms
;
4559 static Lisp_Object wheel_syms
;
4560 static Lisp_Object drag_n_drop_syms
;
4562 /* This is a list of keysym codes for special "accent" characters.
4563 It parallels lispy_accent_keys. */
4565 static const int lispy_accent_codes
[] =
4567 #ifdef XK_dead_circumflex
4572 #ifdef XK_dead_grave
4577 #ifdef XK_dead_tilde
4582 #ifdef XK_dead_diaeresis
4587 #ifdef XK_dead_macron
4592 #ifdef XK_dead_degree
4597 #ifdef XK_dead_acute
4602 #ifdef XK_dead_cedilla
4607 #ifdef XK_dead_breve
4612 #ifdef XK_dead_ogonek
4617 #ifdef XK_dead_caron
4622 #ifdef XK_dead_doubleacute
4623 XK_dead_doubleacute
,
4627 #ifdef XK_dead_abovedot
4632 #ifdef XK_dead_abovering
4642 #ifdef XK_dead_belowdot
4647 #ifdef XK_dead_voiced_sound
4648 XK_dead_voiced_sound
,
4652 #ifdef XK_dead_semivoiced_sound
4653 XK_dead_semivoiced_sound
,
4669 /* This is a list of Lisp names for special "accent" characters.
4670 It parallels lispy_accent_codes. */
4672 static const char *const lispy_accent_keys
[] =
4690 "dead-voiced-sound",
4691 "dead-semivoiced-sound",
4697 #define FUNCTION_KEY_OFFSET 0x0
4699 const char *const lispy_function_keys
[] =
4703 0, /* VK_LBUTTON 0x01 */
4704 0, /* VK_RBUTTON 0x02 */
4705 "cancel", /* VK_CANCEL 0x03 */
4706 0, /* VK_MBUTTON 0x04 */
4708 0, 0, 0, /* 0x05 .. 0x07 */
4710 "backspace", /* VK_BACK 0x08 */
4711 "tab", /* VK_TAB 0x09 */
4713 0, 0, /* 0x0A .. 0x0B */
4715 "clear", /* VK_CLEAR 0x0C */
4716 "return", /* VK_RETURN 0x0D */
4718 0, 0, /* 0x0E .. 0x0F */
4720 0, /* VK_SHIFT 0x10 */
4721 0, /* VK_CONTROL 0x11 */
4722 0, /* VK_MENU 0x12 */
4723 "pause", /* VK_PAUSE 0x13 */
4724 "capslock", /* VK_CAPITAL 0x14 */
4725 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4727 "junja", /* VK_JUNJA 0x17 */
4728 "final", /* VK_FINAL 0x18 */
4729 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4731 "escape", /* VK_ESCAPE 0x1B */
4732 "convert", /* VK_CONVERT 0x1C */
4733 "non-convert", /* VK_NONCONVERT 0x1D */
4734 "accept", /* VK_ACCEPT 0x1E */
4735 "mode-change", /* VK_MODECHANGE 0x1F */
4736 0, /* VK_SPACE 0x20 */
4737 "prior", /* VK_PRIOR 0x21 */
4738 "next", /* VK_NEXT 0x22 */
4739 "end", /* VK_END 0x23 */
4740 "home", /* VK_HOME 0x24 */
4741 "left", /* VK_LEFT 0x25 */
4742 "up", /* VK_UP 0x26 */
4743 "right", /* VK_RIGHT 0x27 */
4744 "down", /* VK_DOWN 0x28 */
4745 "select", /* VK_SELECT 0x29 */
4746 "print", /* VK_PRINT 0x2A */
4747 "execute", /* VK_EXECUTE 0x2B */
4748 "snapshot", /* VK_SNAPSHOT 0x2C */
4749 "insert", /* VK_INSERT 0x2D */
4750 "delete", /* VK_DELETE 0x2E */
4751 "help", /* VK_HELP 0x2F */
4753 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4755 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4757 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4759 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4761 0, 0, 0, 0, 0, 0, 0, 0, 0,
4762 0, 0, 0, 0, 0, 0, 0, 0, 0,
4763 0, 0, 0, 0, 0, 0, 0, 0,
4765 "lwindow", /* VK_LWIN 0x5B */
4766 "rwindow", /* VK_RWIN 0x5C */
4767 "apps", /* VK_APPS 0x5D */
4770 "kp-0", /* VK_NUMPAD0 0x60 */
4771 "kp-1", /* VK_NUMPAD1 0x61 */
4772 "kp-2", /* VK_NUMPAD2 0x62 */
4773 "kp-3", /* VK_NUMPAD3 0x63 */
4774 "kp-4", /* VK_NUMPAD4 0x64 */
4775 "kp-5", /* VK_NUMPAD5 0x65 */
4776 "kp-6", /* VK_NUMPAD6 0x66 */
4777 "kp-7", /* VK_NUMPAD7 0x67 */
4778 "kp-8", /* VK_NUMPAD8 0x68 */
4779 "kp-9", /* VK_NUMPAD9 0x69 */
4780 "kp-multiply", /* VK_MULTIPLY 0x6A */
4781 "kp-add", /* VK_ADD 0x6B */
4782 "kp-separator", /* VK_SEPARATOR 0x6C */
4783 "kp-subtract", /* VK_SUBTRACT 0x6D */
4784 "kp-decimal", /* VK_DECIMAL 0x6E */
4785 "kp-divide", /* VK_DIVIDE 0x6F */
4786 "f1", /* VK_F1 0x70 */
4787 "f2", /* VK_F2 0x71 */
4788 "f3", /* VK_F3 0x72 */
4789 "f4", /* VK_F4 0x73 */
4790 "f5", /* VK_F5 0x74 */
4791 "f6", /* VK_F6 0x75 */
4792 "f7", /* VK_F7 0x76 */
4793 "f8", /* VK_F8 0x77 */
4794 "f9", /* VK_F9 0x78 */
4795 "f10", /* VK_F10 0x79 */
4796 "f11", /* VK_F11 0x7A */
4797 "f12", /* VK_F12 0x7B */
4798 "f13", /* VK_F13 0x7C */
4799 "f14", /* VK_F14 0x7D */
4800 "f15", /* VK_F15 0x7E */
4801 "f16", /* VK_F16 0x7F */
4802 "f17", /* VK_F17 0x80 */
4803 "f18", /* VK_F18 0x81 */
4804 "f19", /* VK_F19 0x82 */
4805 "f20", /* VK_F20 0x83 */
4806 "f21", /* VK_F21 0x84 */
4807 "f22", /* VK_F22 0x85 */
4808 "f23", /* VK_F23 0x86 */
4809 "f24", /* VK_F24 0x87 */
4811 0, 0, 0, 0, /* 0x88 .. 0x8B */
4812 0, 0, 0, 0, /* 0x8C .. 0x8F */
4814 "kp-numlock", /* VK_NUMLOCK 0x90 */
4815 "scroll", /* VK_SCROLL 0x91 */
4816 /* Not sure where the following block comes from.
4817 Windows headers have NEC and Fujitsu specific keys in
4818 this block, but nothing generic. */
4819 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4820 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4821 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4822 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4823 "kp-end", /* VK_NUMPAD_END 0x96 */
4824 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4825 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4826 "kp-up", /* VK_NUMPAD_UP 0x99 */
4827 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4828 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4829 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4830 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4832 0, 0, /* 0x9E .. 0x9F */
4835 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4836 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4837 * No other API or message will distinguish left and right keys this way.
4842 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4843 to enable them selectively, and gives access to a few more functions.
4844 See lispy_multimedia_keys below. */
4845 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4846 0, 0, 0, /* 0xAD .. 0xAF Volume */
4847 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4848 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4850 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4851 0, 0, 0, 0, 0, 0, 0, 0, 0,
4853 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4854 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4855 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4858 "ax", /* VK_OEM_AX 0xE1 */
4859 0, /* VK_OEM_102 0xE2 */
4860 "ico-help", /* VK_ICO_HELP 0xE3 */
4861 "ico-00", /* VK_ICO_00 0xE4 */
4862 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4863 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4864 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4866 "reset", /* VK_OEM_RESET 0xE9 */
4867 "jump", /* VK_OEM_JUMP 0xEA */
4868 "oem-pa1", /* VK_OEM_PA1 0xEB */
4869 "oem-pa2", /* VK_OEM_PA2 0xEC */
4870 "oem-pa3", /* VK_OEM_PA3 0xED */
4871 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4872 "cusel", /* VK_OEM_CUSEL 0xEF */
4873 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4874 "finish", /* VK_OEM_FINISH 0xF1 */
4875 "copy", /* VK_OEM_COPY 0xF2 */
4876 "auto", /* VK_OEM_AUTO 0xF3 */
4877 "enlw", /* VK_OEM_ENLW 0xF4 */
4878 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4879 "attn", /* VK_ATTN 0xF6 */
4880 "crsel", /* VK_CRSEL 0xF7 */
4881 "exsel", /* VK_EXSEL 0xF8 */
4882 "ereof", /* VK_EREOF 0xF9 */
4883 "play", /* VK_PLAY 0xFA */
4884 "zoom", /* VK_ZOOM 0xFB */
4885 "noname", /* VK_NONAME 0xFC */
4886 "pa1", /* VK_PA1 0xFD */
4887 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4891 /* Some of these duplicate the "Media keys" on newer keyboards,
4892 but they are delivered to the application in a different way. */
4893 static const char *const lispy_multimedia_keys
[] =
4901 "browser-favorites",
4938 "toggle-dictate-command",
4944 "media-fast-forward",
4947 "media-channel-down"
4950 #else /* not HAVE_NTGUI */
4952 /* This should be dealt with in XTread_socket now, and that doesn't
4953 depend on the client system having the Kana syms defined. See also
4954 the XK_kana_A case below. */
4957 static const char *const lispy_kana_keys
[] =
4959 /* X Keysym value */
4960 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4961 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4962 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4963 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4964 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4965 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4966 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4967 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4968 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4969 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4970 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4971 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4972 "kana-i", "kana-u", "kana-e", "kana-o",
4973 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4974 "prolongedsound", "kana-A", "kana-I", "kana-U",
4975 "kana-E", "kana-O", "kana-KA", "kana-KI",
4976 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4977 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4978 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4979 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4980 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4981 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4982 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4983 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4984 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4985 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4986 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4987 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4989 #endif /* XK_kana_A */
4992 #define FUNCTION_KEY_OFFSET 0xff00
4994 /* You'll notice that this table is arranged to be conveniently
4995 indexed by X Windows keysym values. */
4996 static const char *const lispy_function_keys
[] =
4998 /* X Keysym value */
5000 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5001 "backspace", "tab", "linefeed", "clear",
5003 0, 0, 0, "pause", /* 0xff10...1f */
5004 0, 0, 0, 0, 0, 0, 0, "escape",
5006 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5007 "romaji", "hiragana", "katakana", "hiragana-katakana",
5008 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5009 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5010 "eisu-toggle", /* 0xff30...3f */
5011 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5012 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5014 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5015 "down", "prior", "next", "end",
5016 "begin", 0, 0, 0, 0, 0, 0, 0,
5017 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5028 "break", /* 0xff6b */
5031 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5032 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5033 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5034 0, 0, 0, 0, 0, 0, 0, 0,
5035 "kp-tab", /* 0xff89 */
5037 "kp-enter", /* 0xff8d */
5039 "kp-f1", /* 0xff91 */
5043 "kp-home", /* 0xff95 */
5048 "kp-prior", /* kp-page-up */
5049 "kp-next", /* kp-page-down */
5055 0, 0, 0, 0, 0, 0, 0, 0, 0,
5056 "kp-multiply", /* 0xffaa */
5061 "kp-divide", /* 0xffaf */
5062 "kp-0", /* 0xffb0 */
5063 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5066 "kp-equal", /* 0xffbd */
5067 "f1", /* 0xffbe */ /* IsFunctionKey */
5069 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5070 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5071 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5072 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5073 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5074 0, 0, 0, 0, 0, 0, 0, 0,
5075 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5076 0, 0, 0, 0, 0, 0, 0, "delete"
5079 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5080 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5082 static const char *const iso_lispy_function_keys
[] =
5084 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5085 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5086 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5087 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5088 "iso-lefttab", /* 0xfe20 */
5089 "iso-move-line-up", "iso-move-line-down",
5090 "iso-partial-line-up", "iso-partial-line-down",
5091 "iso-partial-space-left", "iso-partial-space-right",
5092 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5093 "iso-release-margin-left", "iso-release-margin-right",
5094 "iso-release-both-margins",
5095 "iso-fast-cursor-left", "iso-fast-cursor-right",
5096 "iso-fast-cursor-up", "iso-fast-cursor-down",
5097 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5098 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5101 #endif /* not HAVE_NTGUI */
5103 static Lisp_Object Vlispy_mouse_stem
;
5105 static const char *const lispy_wheel_names
[] =
5107 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5110 /* drag-n-drop events are generated when a set of selected files are
5111 dragged from another application and dropped onto an Emacs window. */
5112 static const char *const lispy_drag_n_drop_names
[] =
5117 /* Scroll bar parts. */
5118 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5119 Lisp_Object Qup
, Qdown
, Qbottom
;
5120 static Lisp_Object Qend_scroll
;
5122 static Lisp_Object Qratio
;
5124 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5125 static Lisp_Object
*const scroll_bar_parts
[] = {
5126 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5127 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5130 /* A vector, indexed by button number, giving the down-going location
5131 of currently depressed buttons, both scroll bar and non-scroll bar.
5133 The elements have the form
5134 (BUTTON-NUMBER MODIFIER-MASK . REST)
5135 where REST is the cdr of a position as it would be reported in the event.
5137 The make_lispy_event function stores positions here to tell the
5138 difference between click and drag events, and to store the starting
5139 location to be included in drag events. */
5141 static Lisp_Object button_down_location
;
5143 /* Information about the most recent up-going button event: Which
5144 button, what location, and what time. */
5146 static int last_mouse_button
;
5147 static int last_mouse_x
;
5148 static int last_mouse_y
;
5149 static Time button_down_time
;
5151 /* The number of clicks in this multiple-click. */
5153 static int double_click_count
;
5155 /* X and Y are frame-relative coordinates for a click or wheel event.
5156 Return a Lisp-style event list. */
5159 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5162 enum window_part part
;
5163 Lisp_Object posn
= Qnil
;
5164 Lisp_Object extra_info
= Qnil
;
5165 /* Coordinate pixel positions to return. */
5166 int xret
= 0, yret
= 0;
5167 /* The window under frame pixel coordinates (x,y) */
5168 Lisp_Object window
= f
5169 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5172 if (WINDOWP (window
))
5174 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5175 struct window
*w
= XWINDOW (window
);
5176 Lisp_Object string_info
= Qnil
;
5177 EMACS_INT textpos
= -1;
5178 int col
= -1, row
= -1;
5179 int dx
= -1, dy
= -1;
5180 int width
= -1, height
= -1;
5181 Lisp_Object object
= Qnil
;
5183 /* Pixel coordinates relative to the window corner. */
5184 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5185 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5187 /* For text area clicks, return X, Y relative to the corner of
5188 this text area. Note that dX, dY etc are set below, by
5189 buffer_posn_from_coords. */
5190 if (part
== ON_TEXT
)
5192 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5193 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5195 /* For mode line and header line clicks, return X, Y relative to
5196 the left window edge. Use mode_line_string to look for a
5197 string on the click position. */
5198 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5203 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5204 /* Note that mode_line_string takes COL, ROW as pixels and
5205 converts them to characters. */
5208 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5209 &object
, &dx
, &dy
, &width
, &height
);
5210 if (STRINGP (string
))
5211 string_info
= Fcons (string
, make_number (charpos
));
5212 textpos
= (w
== XWINDOW (selected_window
)
5213 && current_buffer
== XBUFFER (w
->buffer
))
5214 ? PT
: XMARKER (w
->pointm
)->charpos
;
5219 /* For fringes and margins, Y is relative to the area's (and the
5220 window's) top edge, while X is meaningless. */
5221 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5226 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5229 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5230 &object
, &dx
, &dy
, &width
, &height
);
5231 if (STRINGP (string
))
5232 string_info
= Fcons (string
, make_number (charpos
));
5233 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5235 else if (part
== ON_LEFT_FRINGE
)
5237 posn
= Qleft_fringe
;
5240 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5241 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5242 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5244 else if (part
== ON_RIGHT_FRINGE
)
5246 posn
= Qright_fringe
;
5249 - window_box_width (w
, LEFT_MARGIN_AREA
)
5250 - window_box_width (w
, TEXT_AREA
)
5251 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5252 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5254 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5256 else if (part
== ON_VERTICAL_BORDER
)
5258 posn
= Qvertical_line
;
5263 /* Nothing special for part == ON_SCROLL_BAR. */
5265 /* For clicks in the text area, fringes, or margins, call
5266 buffer_posn_from_coords to extract TEXTPOS, the buffer
5267 position nearest to the click. */
5270 Lisp_Object string2
, object2
= Qnil
;
5271 struct display_pos p
;
5273 int width2
, height2
;
5274 /* The pixel X coordinate passed to buffer_posn_from_coords
5275 is the X coordinate relative to the text area for
5276 text-area and right-margin clicks, zero otherwise. */
5278 = (part
== ON_TEXT
) ? xret
5279 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5280 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5284 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5285 &object2
, &dx2
, &dy2
,
5287 textpos
= CHARPOS (p
.pos
);
5288 if (col
< 0) col
= x2
;
5289 if (row
< 0) row
= y2
;
5290 if (dx
< 0) dx
= dx2
;
5291 if (dy
< 0) dy
= dy2
;
5292 if (width
< 0) width
= width2
;
5293 if (height
< 0) height
= height2
;
5297 posn
= make_number (textpos
);
5298 if (STRINGP (string2
))
5299 string_info
= Fcons (string2
,
5300 make_number (CHARPOS (p
.string_pos
)));
5306 #ifdef HAVE_WINDOW_SYSTEM
5307 if (IMAGEP (object
))
5309 Lisp_Object image_map
, hotspot
;
5310 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5312 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5314 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5315 posn
= XCAR (hotspot
);
5322 Fcons (make_number (dx
), make_number (dy
)),
5323 Fcons (make_number (width
), make_number (height
)));
5326 extra_info
= Fcons (string_info
,
5327 Fcons (make_number (textpos
),
5328 Fcons (Fcons (make_number (col
),
5333 XSETFRAME (window
, f
);
5337 return Fcons (window
,
5339 Fcons (Fcons (make_number (xret
),
5340 make_number (yret
)),
5341 Fcons (make_number (t
),
5345 /* Given a struct input_event, build the lisp event which represents
5346 it. If EVENT is 0, build a mouse movement event from the mouse
5347 movement buffer, which should have a movement event in it.
5349 Note that events must be passed to this function in the order they
5350 are received; this function stores the location of button presses
5351 in order to build drag events when the button is released. */
5354 make_lispy_event (struct input_event
*event
)
5358 switch (SWITCH_ENUM_CAST (event
->kind
))
5360 /* A simple keystroke. */
5361 case ASCII_KEYSTROKE_EVENT
:
5362 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5364 Lisp_Object lispy_c
;
5365 EMACS_INT c
= event
->code
;
5366 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5369 eassert (c
== event
->code
);
5370 /* Turn ASCII characters into control characters
5372 if (event
->modifiers
& ctrl_modifier
)
5374 c
= make_ctrl_char (c
);
5375 event
->modifiers
&= ~ctrl_modifier
;
5379 /* Add in the other modifier bits. The shift key was taken care
5380 of by the X code. */
5381 c
|= (event
->modifiers
5382 & (meta_modifier
| alt_modifier
5383 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5384 /* Distinguish Shift-SPC from SPC. */
5385 if ((event
->code
) == 040
5386 && event
->modifiers
& shift_modifier
)
5387 c
|= shift_modifier
;
5388 button_down_time
= 0;
5389 XSETFASTINT (lispy_c
, c
);
5394 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5395 except that they are non-key events (last-nonmenu-event is nil). */
5396 case NS_NONKEY_EVENT
:
5399 /* A function key. The symbol may need to have modifier prefixes
5401 case NON_ASCII_KEYSTROKE_EVENT
:
5402 button_down_time
= 0;
5404 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5405 if (event
->code
== lispy_accent_codes
[i
])
5406 return modify_event_symbol (i
,
5408 Qfunction_key
, Qnil
,
5409 lispy_accent_keys
, &accent_key_syms
,
5410 (sizeof (lispy_accent_keys
)
5411 / sizeof (lispy_accent_keys
[0])));
5415 if (event
->code
>= 0x400 && event
->code
< 0x500)
5416 return modify_event_symbol (event
->code
- 0x400,
5417 event
->modifiers
& ~shift_modifier
,
5418 Qfunction_key
, Qnil
,
5419 lispy_kana_keys
, &func_key_syms
,
5420 (sizeof (lispy_kana_keys
)
5421 / sizeof (lispy_kana_keys
[0])));
5422 #endif /* XK_kana_A */
5425 #ifdef ISO_FUNCTION_KEY_OFFSET
5426 if (event
->code
< FUNCTION_KEY_OFFSET
5427 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5428 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5430 Qfunction_key
, Qnil
,
5431 iso_lispy_function_keys
, &func_key_syms
,
5432 (sizeof (iso_lispy_function_keys
)
5433 / sizeof (iso_lispy_function_keys
[0])));
5436 /* Handle system-specific or unknown keysyms. */
5437 if (event
->code
& (1 << 28)
5438 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5439 || (event
->code
- FUNCTION_KEY_OFFSET
5440 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5441 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5443 /* We need to use an alist rather than a vector as the cache
5444 since we can't make a vector long enough. */
5445 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5446 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5447 return modify_event_symbol (event
->code
,
5450 KVAR (current_kboard
, Vsystem_key_alist
),
5451 0, &KVAR (current_kboard
, system_key_syms
),
5452 TYPE_MAXIMUM (EMACS_INT
));
5455 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5457 Qfunction_key
, Qnil
,
5458 lispy_function_keys
, &func_key_syms
,
5459 (sizeof (lispy_function_keys
)
5460 / sizeof (lispy_function_keys
[0])));
5463 case MULTIMEDIA_KEY_EVENT
:
5464 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5465 / sizeof (lispy_multimedia_keys
[0]))
5466 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5468 return modify_event_symbol (event
->code
, event
->modifiers
,
5469 Qfunction_key
, Qnil
,
5470 lispy_multimedia_keys
, &func_key_syms
,
5471 (sizeof (lispy_multimedia_keys
)
5472 / sizeof (lispy_multimedia_keys
[0])));
5478 /* A mouse click. Figure out where it is, decide whether it's
5479 a press, click or drag, and build the appropriate structure. */
5480 case MOUSE_CLICK_EVENT
:
5481 #ifndef USE_TOOLKIT_SCROLL_BARS
5482 case SCROLL_BAR_CLICK_EVENT
:
5485 int button
= event
->code
;
5487 Lisp_Object position
;
5488 Lisp_Object
*start_pos_ptr
;
5489 Lisp_Object start_pos
;
5493 /* Build the position as appropriate for this mouse click. */
5494 if (event
->kind
== MOUSE_CLICK_EVENT
)
5496 struct frame
*f
= XFRAME (event
->frame_or_window
);
5497 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5501 /* Ignore mouse events that were made on frame that
5502 have been deleted. */
5503 if (! FRAME_LIVE_P (f
))
5506 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5507 /* EVENT->x and EVENT->y are frame-relative pixel
5508 coordinates at this place. Under old redisplay, COLUMN
5509 and ROW are set to frame relative glyph coordinates
5510 which are then used to determine whether this click is
5511 in a menu (non-toolkit version). */
5512 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5513 &column
, &row
, NULL
, 1);
5515 /* In the non-toolkit version, clicks on the menu bar
5516 are ordinary button events in the event buffer.
5517 Distinguish them, and invoke the menu.
5519 (In the toolkit version, the toolkit handles the menu bar
5520 and Emacs doesn't know about it until after the user
5521 makes a selection.) */
5522 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5523 && (event
->modifiers
& down_modifier
))
5525 Lisp_Object items
, item
;
5527 /* Find the menu bar item under `column'. */
5529 items
= FRAME_MENU_BAR_ITEMS (f
);
5530 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5532 Lisp_Object pos
, string
;
5533 string
= AREF (items
, i
+ 1);
5534 pos
= AREF (items
, i
+ 3);
5537 if (column
>= XINT (pos
)
5538 && column
< XINT (pos
) + SCHARS (string
))
5540 item
= AREF (items
, i
);
5545 /* ELisp manual 2.4b says (x y) are window relative but
5546 code says they are frame-relative. */
5548 = Fcons (event
->frame_or_window
,
5550 Fcons (Fcons (event
->x
, event
->y
),
5551 Fcons (make_number (event
->timestamp
),
5554 return Fcons (item
, Fcons (position
, Qnil
));
5556 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5558 position
= make_lispy_position (f
, event
->x
, event
->y
,
5561 #ifndef USE_TOOLKIT_SCROLL_BARS
5564 /* It's a scrollbar click. */
5566 Lisp_Object portion_whole
;
5569 window
= event
->frame_or_window
;
5570 portion_whole
= Fcons (event
->x
, event
->y
);
5571 part
= *scroll_bar_parts
[(int) event
->part
];
5575 Fcons (Qvertical_scroll_bar
,
5576 Fcons (portion_whole
,
5577 Fcons (make_number (event
->timestamp
),
5578 Fcons (part
, Qnil
)))));
5580 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5582 if (button
>= ASIZE (button_down_location
))
5584 button_down_location
= larger_vector (button_down_location
,
5586 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5589 start_pos_ptr
= &AREF (button_down_location
, button
);
5590 start_pos
= *start_pos_ptr
;
5591 *start_pos_ptr
= Qnil
;
5594 /* On window-system frames, use the value of
5595 double-click-fuzz as is. On other frames, interpret it
5596 as a multiple of 1/8 characters. */
5600 if (WINDOWP (event
->frame_or_window
))
5601 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5602 else if (FRAMEP (event
->frame_or_window
))
5603 f
= XFRAME (event
->frame_or_window
);
5607 if (FRAME_WINDOW_P (f
))
5608 fuzz
= double_click_fuzz
;
5610 fuzz
= double_click_fuzz
/ 8;
5612 is_double
= (button
== last_mouse_button
5613 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5614 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5615 && button_down_time
!= 0
5616 && (EQ (Vdouble_click_time
, Qt
)
5617 || (NATNUMP (Vdouble_click_time
)
5618 && (event
->timestamp
- button_down_time
5619 < XFASTINT (Vdouble_click_time
)))));
5622 last_mouse_button
= button
;
5623 last_mouse_x
= XINT (event
->x
);
5624 last_mouse_y
= XINT (event
->y
);
5626 /* If this is a button press, squirrel away the location, so
5627 we can decide later whether it was a click or a drag. */
5628 if (event
->modifiers
& down_modifier
)
5632 double_click_count
++;
5633 event
->modifiers
|= ((double_click_count
> 2)
5638 double_click_count
= 1;
5639 button_down_time
= event
->timestamp
;
5640 *start_pos_ptr
= Fcopy_alist (position
);
5641 ignore_mouse_drag_p
= 0;
5644 /* Now we're releasing a button - check the co-ordinates to
5645 see if this was a click or a drag. */
5646 else if (event
->modifiers
& up_modifier
)
5648 /* If we did not see a down before this up, ignore the up.
5649 Probably this happened because the down event chose a
5650 menu item. It would be an annoyance to treat the
5651 release of the button that chose the menu item as a
5654 if (!CONSP (start_pos
))
5657 event
->modifiers
&= ~up_modifier
;
5660 Lisp_Object new_down
, down
;
5661 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5663 /* The third element of every position
5664 should be the (x,y) pair. */
5665 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5666 new_down
= Fcar (Fcdr (Fcdr (position
)));
5669 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5671 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5672 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5675 if (ignore_mouse_drag_p
)
5677 event
->modifiers
|= click_modifier
;
5678 ignore_mouse_drag_p
= 0;
5680 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5681 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5682 /* Maybe the mouse has moved a lot, caused scrolling, and
5683 eventually ended up at the same screen position (but
5684 not buffer position) in which case it is a drag, not
5686 /* FIXME: OTOH if the buffer position has changed
5687 because of a timer or process filter rather than
5688 because of mouse movement, it should be considered as
5689 a click. But mouse-drag-region completely ignores
5690 this case and it hasn't caused any real problem, so
5691 it's probably OK to ignore it as well. */
5692 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5693 /* Mouse hasn't moved (much). */
5694 event
->modifiers
|= click_modifier
;
5697 button_down_time
= 0;
5698 event
->modifiers
|= drag_modifier
;
5701 /* Don't check is_double; treat this as multiple
5702 if the down-event was multiple. */
5703 if (double_click_count
> 1)
5704 event
->modifiers
|= ((double_click_count
> 2)
5710 /* Every mouse event should either have the down_modifier or
5711 the up_modifier set. */
5715 /* Get the symbol we should use for the mouse click. */
5718 head
= modify_event_symbol (button
,
5720 Qmouse_click
, Vlispy_mouse_stem
,
5723 ASIZE (mouse_syms
));
5724 if (event
->modifiers
& drag_modifier
)
5729 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5732 Fcons (make_number (double_click_count
),
5742 case HORIZ_WHEEL_EVENT
:
5744 Lisp_Object position
;
5747 /* Build the position as appropriate for this mouse click. */
5748 struct frame
*f
= XFRAME (event
->frame_or_window
);
5750 /* Ignore wheel events that were made on frame that have been
5752 if (! FRAME_LIVE_P (f
))
5755 position
= make_lispy_position (f
, event
->x
, event
->y
,
5758 /* Set double or triple modifiers to indicate the wheel speed. */
5760 /* On window-system frames, use the value of
5761 double-click-fuzz as is. On other frames, interpret it
5762 as a multiple of 1/8 characters. */
5768 if (WINDOWP (event
->frame_or_window
))
5769 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5770 else if (FRAMEP (event
->frame_or_window
))
5771 fr
= XFRAME (event
->frame_or_window
);
5775 fuzz
= FRAME_WINDOW_P (fr
)
5776 ? double_click_fuzz
: double_click_fuzz
/ 8;
5778 if (event
->modifiers
& up_modifier
)
5780 /* Emit a wheel-up event. */
5781 event
->modifiers
&= ~up_modifier
;
5784 else if (event
->modifiers
& down_modifier
)
5786 /* Emit a wheel-down event. */
5787 event
->modifiers
&= ~down_modifier
;
5791 /* Every wheel event should either have the down_modifier or
5792 the up_modifier set. */
5795 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5798 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5799 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5800 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5801 && button_down_time
!= 0
5802 && (EQ (Vdouble_click_time
, Qt
)
5803 || (NATNUMP (Vdouble_click_time
)
5804 && (event
->timestamp
- button_down_time
5805 < XFASTINT (Vdouble_click_time
)))));
5808 double_click_count
++;
5809 event
->modifiers
|= ((double_click_count
> 2)
5815 double_click_count
= 1;
5816 event
->modifiers
|= click_modifier
;
5819 button_down_time
= event
->timestamp
;
5820 /* Use a negative value to distinguish wheel from mouse button. */
5821 last_mouse_button
= - (1 + symbol_num
);
5822 last_mouse_x
= XINT (event
->x
);
5823 last_mouse_y
= XINT (event
->y
);
5825 /* Get the symbol we should use for the wheel event. */
5826 head
= modify_event_symbol (symbol_num
,
5832 ASIZE (wheel_syms
));
5835 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5838 Fcons (make_number (double_click_count
),
5847 #ifdef USE_TOOLKIT_SCROLL_BARS
5849 /* We don't have down and up events if using toolkit scroll bars,
5850 so make this always a click event. Store in the `part' of
5851 the Lisp event a symbol which maps to the following actions:
5853 `above_handle' page up
5854 `below_handle' page down
5858 `bottom' bottom of buffer
5859 `handle' thumb has been dragged.
5860 `end-scroll' end of interaction with scroll bar
5862 The incoming input_event contains in its `part' member an
5863 index of type `enum scroll_bar_part' which we can use as an
5864 index in scroll_bar_parts to get the appropriate symbol. */
5866 case SCROLL_BAR_CLICK_EVENT
:
5868 Lisp_Object position
, head
, window
, portion_whole
, part
;
5870 window
= event
->frame_or_window
;
5871 portion_whole
= Fcons (event
->x
, event
->y
);
5872 part
= *scroll_bar_parts
[(int) event
->part
];
5876 Fcons (Qvertical_scroll_bar
,
5877 Fcons (portion_whole
,
5878 Fcons (make_number (event
->timestamp
),
5879 Fcons (part
, Qnil
)))));
5881 /* Always treat scroll bar events as clicks. */
5882 event
->modifiers
|= click_modifier
;
5883 event
->modifiers
&= ~up_modifier
;
5885 if (event
->code
>= ASIZE (mouse_syms
))
5886 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5888 /* Get the symbol we should use for the mouse click. */
5889 head
= modify_event_symbol (event
->code
,
5894 ASIZE (mouse_syms
));
5895 return Fcons (head
, Fcons (position
, Qnil
));
5898 #endif /* USE_TOOLKIT_SCROLL_BARS */
5900 case DRAG_N_DROP_EVENT
:
5903 Lisp_Object head
, position
;
5906 f
= XFRAME (event
->frame_or_window
);
5909 /* Ignore mouse events that were made on frames that
5910 have been deleted. */
5911 if (! FRAME_LIVE_P (f
))
5914 position
= make_lispy_position (f
, event
->x
, event
->y
,
5917 head
= modify_event_symbol (0, event
->modifiers
,
5919 lispy_drag_n_drop_names
,
5920 &drag_n_drop_syms
, 1);
5926 #endif /* HAVE_MOUSE */
5928 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5929 || defined (HAVE_NS) || defined (USE_GTK)
5930 case MENU_BAR_EVENT
:
5931 if (EQ (event
->arg
, event
->frame_or_window
))
5932 /* This is the prefix key. We translate this to
5933 `(menu_bar)' because the code in keyboard.c for menu
5934 events, which we use, relies on this. */
5935 return Fcons (Qmenu_bar
, Qnil
);
5939 case SELECT_WINDOW_EVENT
:
5940 /* Make an event (select-window (WINDOW)). */
5941 return Fcons (Qselect_window
,
5942 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5945 case TOOL_BAR_EVENT
:
5946 if (EQ (event
->arg
, event
->frame_or_window
))
5947 /* This is the prefix key. We translate this to
5948 `(tool_bar)' because the code in keyboard.c for tool bar
5949 events, which we use, relies on this. */
5950 return Fcons (Qtool_bar
, Qnil
);
5951 else if (SYMBOLP (event
->arg
))
5952 return apply_modifiers (event
->modifiers
, event
->arg
);
5955 case USER_SIGNAL_EVENT
:
5956 /* A user signal. */
5958 char *name
= find_user_signal_name (event
->code
);
5961 return intern (name
);
5964 case SAVE_SESSION_EVENT
:
5965 return Qsave_session
;
5970 return Fcons (Qdbus_event
, event
->arg
);
5972 #endif /* HAVE_DBUS */
5973 #ifdef HAVE_XWIDGETS
5976 printf("cool, an xwidget event arrived in make_lispy_event!\n");
5977 return Fcons (Qxwidget_event
,event
->arg
);
5980 case CONFIG_CHANGED_EVENT
:
5981 return Fcons (Qconfig_changed_event
,
5983 Fcons (event
->frame_or_window
, Qnil
)));
5985 case GPM_CLICK_EVENT
:
5987 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5988 Lisp_Object head
, position
;
5989 Lisp_Object
*start_pos_ptr
;
5990 Lisp_Object start_pos
;
5991 int button
= event
->code
;
5993 if (button
>= ASIZE (button_down_location
))
5995 button_down_location
= larger_vector (button_down_location
,
5997 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6000 start_pos_ptr
= &AREF (button_down_location
, button
);
6001 start_pos
= *start_pos_ptr
;
6003 position
= make_lispy_position (f
, event
->x
, event
->y
,
6006 if (event
->modifiers
& down_modifier
)
6007 *start_pos_ptr
= Fcopy_alist (position
);
6008 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6010 if (!CONSP (start_pos
))
6012 event
->modifiers
&= ~up_modifier
;
6015 head
= modify_event_symbol (button
,
6017 Qmouse_click
, Vlispy_mouse_stem
,
6020 ASIZE (mouse_syms
));
6022 if (event
->modifiers
& drag_modifier
)
6027 else if (event
->modifiers
& double_modifier
)
6030 Fcons (make_number (2),
6032 else if (event
->modifiers
& triple_modifier
)
6035 Fcons (make_number (3),
6042 #endif /* HAVE_GPM */
6044 /* The 'kind' field of the event is something we don't recognize. */
6050 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6053 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6054 Lisp_Object x
, Lisp_Object y
, Time t
)
6056 /* Is it a scroll bar movement? */
6057 if (frame
&& ! NILP (bar_window
))
6059 Lisp_Object part_sym
;
6061 part_sym
= *scroll_bar_parts
[(int) part
];
6062 return Fcons (Qscroll_bar_movement
,
6063 Fcons (list5 (bar_window
,
6064 Qvertical_scroll_bar
,
6070 /* Or is it an ordinary mouse movement? */
6073 Lisp_Object position
;
6074 position
= make_lispy_position (frame
, x
, y
, t
);
6075 return list2 (Qmouse_movement
, position
);
6079 #endif /* HAVE_MOUSE || HAVE GPM */
6081 /* Construct a switch frame event. */
6083 make_lispy_switch_frame (Lisp_Object frame
)
6085 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6088 /* Manipulating modifiers. */
6090 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6092 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6093 SYMBOL's name of the end of the modifiers; the string from this
6094 position is the unmodified symbol name.
6096 This doesn't use any caches. */
6099 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6105 CHECK_SYMBOL (symbol
);
6108 name
= SYMBOL_NAME (symbol
);
6110 for (i
= 0; i
+2 <= SBYTES (name
); )
6112 EMACS_INT this_mod_end
= 0;
6115 /* See if the name continues with a modifier word.
6116 Check that the word appears, but don't check what follows it.
6117 Set this_mod and this_mod_end to record what we find. */
6119 switch (SREF (name
, i
))
6121 #define SINGLE_LETTER_MOD(BIT) \
6122 (this_mod_end = i + 1, this_mod = BIT)
6125 SINGLE_LETTER_MOD (alt_modifier
);
6129 SINGLE_LETTER_MOD (ctrl_modifier
);
6133 SINGLE_LETTER_MOD (hyper_modifier
);
6137 SINGLE_LETTER_MOD (meta_modifier
);
6141 SINGLE_LETTER_MOD (shift_modifier
);
6145 SINGLE_LETTER_MOD (super_modifier
);
6148 #undef SINGLE_LETTER_MOD
6150 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6151 if (i + LEN + 1 <= SBYTES (name) \
6152 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6154 this_mod_end = i + LEN; \
6159 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6160 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6161 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6165 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6167 #undef MULTI_LETTER_MOD
6171 /* If we found no modifier, stop looking for them. */
6172 if (this_mod_end
== 0)
6175 /* Check there is a dash after the modifier, so that it
6176 really is a modifier. */
6177 if (this_mod_end
>= SBYTES (name
)
6178 || SREF (name
, this_mod_end
) != '-')
6181 /* This modifier is real; look for another. */
6182 modifiers
|= this_mod
;
6183 i
= this_mod_end
+ 1;
6186 /* Should we include the `click' modifier? */
6187 if (! (modifiers
& (down_modifier
| drag_modifier
6188 | double_modifier
| triple_modifier
))
6189 && i
+ 7 == SBYTES (name
)
6190 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6191 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6192 modifiers
|= click_modifier
;
6194 if (! (modifiers
& (double_modifier
| triple_modifier
))
6195 && i
+ 6 < SBYTES (name
)
6196 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6197 modifiers
|= click_modifier
;
6205 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6206 prepended to the string BASE[0..BASE_LEN-1].
6207 This doesn't use any caches. */
6209 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6211 /* Since BASE could contain nulls, we can't use intern here; we have
6212 to use Fintern, which expects a genuine Lisp_String, and keeps a
6215 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6221 /* Only the event queue may use the `up' modifier; it should always
6222 be turned into a click or drag event before presented to lisp code. */
6223 if (modifiers
& up_modifier
)
6226 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6227 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6228 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6229 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6230 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6231 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6232 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6233 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6234 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6235 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6236 /* The click modifier is denoted by the absence of other modifiers. */
6240 mod_len
= p
- new_mods
;
6244 Lisp_Object new_name
;
6246 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6247 mod_len
+ base_len_byte
);
6248 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6249 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6251 return Fintern (new_name
, Qnil
);
6256 static const char *const modifier_names
[] =
6258 "up", "down", "drag", "click", "double", "triple", 0, 0,
6259 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6260 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6262 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6264 static Lisp_Object modifier_symbols
;
6266 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6268 lispy_modifier_list (int modifiers
)
6270 Lisp_Object modifier_list
;
6273 modifier_list
= Qnil
;
6274 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6275 if (modifiers
& (1<<i
))
6276 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6279 return modifier_list
;
6283 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6284 where UNMODIFIED is the unmodified form of SYMBOL,
6285 MASK is the set of modifiers present in SYMBOL's name.
6286 This is similar to parse_modifiers_uncached, but uses the cache in
6287 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6288 Qevent_symbol_elements property. */
6290 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6293 parse_modifiers (Lisp_Object symbol
)
6295 Lisp_Object elements
;
6297 if (INTEGERP (symbol
))
6298 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6299 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6301 else if (!SYMBOLP (symbol
))
6304 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6305 if (CONSP (elements
))
6310 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6311 Lisp_Object unmodified
;
6314 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6315 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6318 if (modifiers
& ~INTMASK
)
6320 XSETFASTINT (mask
, modifiers
);
6321 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6323 /* Cache the parsing results on SYMBOL. */
6324 Fput (symbol
, Qevent_symbol_element_mask
,
6326 Fput (symbol
, Qevent_symbol_elements
,
6327 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6329 /* Since we know that SYMBOL is modifiers applied to unmodified,
6330 it would be nice to put that in unmodified's cache.
6331 But we can't, since we're not sure that parse_modifiers is
6338 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6339 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6340 doc
: /* Parse the event symbol. For internal use. */)
6341 (Lisp_Object symbol
)
6343 /* Fill the cache if needed. */
6344 parse_modifiers (symbol
);
6345 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6346 and use the Lispier representation stored on Qevent_symbol_elements
6348 return Fget (symbol
, Qevent_symbol_elements
);
6351 /* Apply the modifiers MODIFIERS to the symbol BASE.
6352 BASE must be unmodified.
6354 This is like apply_modifiers_uncached, but uses BASE's
6355 Qmodifier_cache property, if present. It also builds
6356 Qevent_symbol_elements properties, since it has that info anyway.
6358 apply_modifiers copies the value of BASE's Qevent_kind property to
6359 the modified symbol. */
6361 apply_modifiers (int modifiers
, Lisp_Object base
)
6363 Lisp_Object cache
, idx
, entry
, new_symbol
;
6365 /* Mask out upper bits. We don't know where this value's been. */
6366 modifiers
&= INTMASK
;
6368 if (INTEGERP (base
))
6369 return make_number (XINT (base
) | modifiers
);
6371 /* The click modifier never figures into cache indices. */
6372 cache
= Fget (base
, Qmodifier_cache
);
6373 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6374 entry
= assq_no_quit (idx
, cache
);
6377 new_symbol
= XCDR (entry
);
6380 /* We have to create the symbol ourselves. */
6381 new_symbol
= apply_modifiers_uncached (modifiers
,
6382 SSDATA (SYMBOL_NAME (base
)),
6383 SCHARS (SYMBOL_NAME (base
)),
6384 SBYTES (SYMBOL_NAME (base
)));
6386 /* Add the new symbol to the base's cache. */
6387 entry
= Fcons (idx
, new_symbol
);
6388 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6390 /* We have the parsing info now for free, so we could add it to
6392 XSETFASTINT (idx, modifiers);
6393 Fput (new_symbol, Qevent_symbol_element_mask,
6394 Fcons (base, Fcons (idx, Qnil)));
6395 Fput (new_symbol, Qevent_symbol_elements,
6396 Fcons (base, lispy_modifier_list (modifiers)));
6397 Sadly, this is only correct if `base' is indeed a base event,
6398 which is not necessarily the case. -stef */
6401 /* Make sure this symbol is of the same kind as BASE.
6403 You'd think we could just set this once and for all when we
6404 intern the symbol above, but reorder_modifiers may call us when
6405 BASE's property isn't set right; we can't assume that just
6406 because it has a Qmodifier_cache property it must have its
6407 Qevent_kind set right as well. */
6408 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6412 kind
= Fget (base
, Qevent_kind
);
6414 Fput (new_symbol
, Qevent_kind
, kind
);
6421 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6422 return a symbol with the modifiers placed in the canonical order.
6423 Canonical order is alphabetical, except for down and drag, which
6424 always come last. The 'click' modifier is never written out.
6426 Fdefine_key calls this to make sure that (for example) C-M-foo
6427 and M-C-foo end up being equivalent in the keymap. */
6430 reorder_modifiers (Lisp_Object symbol
)
6432 /* It's hopefully okay to write the code this way, since everything
6433 will soon be in caches, and no consing will be done at all. */
6436 parsed
= parse_modifiers (symbol
);
6437 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6442 /* For handling events, we often want to produce a symbol whose name
6443 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6444 to some base, like the name of a function key or mouse button.
6445 modify_event_symbol produces symbols of this sort.
6447 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6448 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6451 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6452 into symbol names, or a string specifying a name stem used to
6453 construct a symbol name or the form `STEM-N', where N is the decimal
6454 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6455 non-nil; otherwise NAME_TABLE is used.
6457 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6458 persist between calls to modify_event_symbol that it can use to
6459 store a cache of the symbols it's generated for this NAME_TABLE
6460 before. The object stored there may be a vector or an alist.
6462 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6464 MODIFIERS is a set of modifier bits (as given in struct input_events)
6465 whose prefixes should be applied to the symbol name.
6467 SYMBOL_KIND is the value to be placed in the event_kind property of
6468 the returned symbol.
6470 The symbols we create are supposed to have an
6471 `event-symbol-elements' property, which lists the modifiers present
6472 in the symbol's name. */
6475 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6476 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6477 Lisp_Object
*symbol_table
, EMACS_INT table_size
)
6480 Lisp_Object symbol_int
;
6482 /* Get rid of the "vendor-specific" bit here. */
6483 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6485 /* Is this a request for a valid symbol? */
6486 if (symbol_num
< 0 || symbol_num
>= table_size
)
6489 if (CONSP (*symbol_table
))
6490 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6492 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6493 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6494 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6495 we've never used that symbol before. */
6498 if (! VECTORP (*symbol_table
)
6499 || ASIZE (*symbol_table
) != table_size
)
6503 XSETFASTINT (size
, table_size
);
6504 *symbol_table
= Fmake_vector (size
, Qnil
);
6507 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6510 /* Have we already used this symbol before? */
6513 /* No; let's create it. */
6514 if (CONSP (name_alist_or_stem
))
6515 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6516 else if (STRINGP (name_alist_or_stem
))
6519 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6520 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6522 SAFE_ALLOCA (buf
, char *, len
);
6523 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6524 XINT (symbol_int
) + 1);
6525 value
= intern (buf
);
6528 else if (name_table
!= 0 && name_table
[symbol_num
])
6529 value
= intern (name_table
[symbol_num
]);
6531 #ifdef HAVE_WINDOW_SYSTEM
6534 char *name
= x_get_keysym_name (symbol_num
);
6536 value
= intern (name
);
6542 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6543 sprintf (buf
, "key-%"pI
"d", symbol_num
);
6544 value
= intern (buf
);
6547 if (CONSP (*symbol_table
))
6548 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6550 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6552 /* Fill in the cache entries for this symbol; this also
6553 builds the Qevent_symbol_elements property, which the user
6555 apply_modifiers (modifiers
& click_modifier
, value
);
6556 Fput (value
, Qevent_kind
, symbol_kind
);
6559 /* Apply modifiers to that symbol. */
6560 return apply_modifiers (modifiers
, value
);
6563 /* Convert a list that represents an event type,
6564 such as (ctrl meta backspace), into the usual representation of that
6565 event type as a number or a symbol. */
6567 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6568 doc
: /* Convert the event description list EVENT-DESC to an event type.
6569 EVENT-DESC should contain one base event type (a character or symbol)
6570 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6571 drag, down, double or triple). The base must be last.
6572 The return value is an event type (a character or symbol) which
6573 has the same base event type and all the specified modifiers. */)
6574 (Lisp_Object event_desc
)
6582 while (CONSP (rest
))
6590 /* Given a symbol, see if it is a modifier name. */
6591 if (SYMBOLP (elt
) && CONSP (rest
))
6592 this = parse_solitary_modifier (elt
);
6596 else if (!NILP (base
))
6597 error ("Two bases given in one event");
6603 /* Let the symbol A refer to the character A. */
6604 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6605 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6607 if (INTEGERP (base
))
6609 /* Turn (shift a) into A. */
6610 if ((modifiers
& shift_modifier
) != 0
6611 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6613 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6614 modifiers
&= ~shift_modifier
;
6617 /* Turn (control a) into C-a. */
6618 if (modifiers
& ctrl_modifier
)
6619 return make_number ((modifiers
& ~ctrl_modifier
)
6620 | make_ctrl_char (XINT (base
)));
6622 return make_number (modifiers
| XINT (base
));
6624 else if (SYMBOLP (base
))
6625 return apply_modifiers (modifiers
, base
);
6628 error ("Invalid base event");
6633 /* Try to recognize SYMBOL as a modifier name.
6634 Return the modifier flag bit, or 0 if not recognized. */
6637 parse_solitary_modifier (Lisp_Object symbol
)
6639 Lisp_Object name
= SYMBOL_NAME (symbol
);
6641 switch (SREF (name
, 0))
6643 #define SINGLE_LETTER_MOD(BIT) \
6644 if (SBYTES (name) == 1) \
6647 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6648 if (LEN == SBYTES (name) \
6649 && ! strncmp (SSDATA (name), NAME, LEN)) \
6653 SINGLE_LETTER_MOD (alt_modifier
);
6657 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6661 SINGLE_LETTER_MOD (ctrl_modifier
);
6665 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6666 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6670 SINGLE_LETTER_MOD (hyper_modifier
);
6674 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6678 SINGLE_LETTER_MOD (meta_modifier
);
6682 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6686 SINGLE_LETTER_MOD (shift_modifier
);
6690 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6691 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6692 SINGLE_LETTER_MOD (super_modifier
);
6696 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6697 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6698 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6702 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6705 #undef SINGLE_LETTER_MOD
6706 #undef MULTI_LETTER_MOD
6712 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6713 Such a list is not valid as an event,
6714 but it can be a Lucid-style event type list. */
6717 lucid_event_type_list_p (Lisp_Object object
)
6721 if (! CONSP (object
))
6724 if (EQ (XCAR (object
), Qhelp_echo
)
6725 || EQ (XCAR (object
), Qvertical_line
)
6726 || EQ (XCAR (object
), Qmode_line
)
6727 || EQ (XCAR (object
), Qheader_line
))
6730 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6734 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6741 /* Store into *addr a value nonzero if terminal input chars are available.
6742 Serves the purpose of ioctl (0, FIONREAD, addr)
6743 but works even if FIONREAD does not exist.
6744 (In fact, this may actually read some input.)
6746 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6747 timer events that are ripe.
6748 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6749 events (FOCUS_IN_EVENT).
6750 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6751 movements and toolkit scroll bar thumb drags. */
6754 get_input_pending (int *addr
, int flags
)
6756 /* First of all, have we already counted some input? */
6757 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6759 /* If input is being read as it arrives, and we have none, there is none. */
6760 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6763 /* Try to read some input and see how much we get. */
6765 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6768 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6771 gobble_input (int expected
)
6774 if (interrupt_input
)
6777 mask
= sigblock (sigmask (SIGIO
));
6778 read_avail_input (expected
);
6782 #ifdef POLL_FOR_INPUT
6783 /* XXX This condition was (read_socket_hook && !interrupt_input),
6784 but read_socket_hook is not global anymore. Let's pretend that
6786 if (!interrupt_input
&& poll_suppress_count
== 0)
6789 mask
= sigblock (sigmask (SIGALRM
));
6790 read_avail_input (expected
);
6796 read_avail_input (expected
);
6799 /* Put a BUFFER_SWITCH_EVENT in the buffer
6800 so that read_key_sequence will notice the new current buffer. */
6803 record_asynch_buffer_change (void)
6805 struct input_event event
;
6809 event
.kind
= BUFFER_SWITCH_EVENT
;
6810 event
.frame_or_window
= Qnil
;
6813 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6814 The purpose of the event is to make read_key_sequence look up the
6815 keymaps again. If we aren't in read_key_sequence, we don't need one,
6816 and the event could cause trouble by messing up (input-pending-p).
6817 Note: Fwaiting_for_user_input_p always returns nil when async
6818 subprocesses aren't supported. */
6819 tem
= Fwaiting_for_user_input_p ();
6823 /* Make sure no interrupt happens while storing the event. */
6825 if (interrupt_input
)
6828 mask
= sigblock (sigmask (SIGIO
));
6829 kbd_buffer_store_event (&event
);
6836 kbd_buffer_store_event (&event
);
6841 /* Read any terminal input already buffered up by the system
6842 into the kbd_buffer, but do not wait.
6844 EXPECTED should be nonzero if the caller knows there is some input.
6846 Returns the number of keyboard chars read, or -1 meaning
6847 this is a bad time to try to read input. */
6850 read_avail_input (int expected
)
6856 /* Store pending user signal events, if any. */
6857 if (store_user_signal_events ())
6860 /* Loop through the available terminals, and call their input hooks. */
6864 struct terminal
*next
= t
->next_terminal
;
6866 if (t
->read_socket_hook
)
6869 struct input_event hold_quit
;
6871 EVENT_INIT (hold_quit
);
6872 hold_quit
.kind
= NO_EVENT
;
6874 /* No need for FIONREAD or fcntl; just say don't wait. */
6875 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6881 if (nr
== -1) /* Not OK to read input now. */
6885 else if (nr
== -2) /* Non-transient error. */
6887 /* The terminal device terminated; it should be closed. */
6889 /* Kill Emacs if this was our last terminal. */
6890 if (!terminal_list
->next_terminal
)
6891 /* Formerly simply reported no input, but that
6892 sometimes led to a failure of Emacs to terminate.
6893 SIGHUP seems appropriate if we can't reach the
6895 /* ??? Is it really right to send the signal just to
6896 this process rather than to the whole process
6897 group? Perhaps on systems with FIONREAD Emacs is
6898 alone in its group. */
6899 kill (getpid (), SIGHUP
);
6901 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6904 XSETTERMINAL (tmp
, t
);
6905 Fdelete_terminal (tmp
, Qnoelisp
);
6909 if (hold_quit
.kind
!= NO_EVENT
)
6910 kbd_buffer_store_event (&hold_quit
);
6919 frame_make_pointer_visible ();
6925 decode_keyboard_code (struct tty_display_info
*tty
,
6926 struct coding_system
*coding
,
6927 unsigned char *buf
, int nbytes
)
6929 unsigned char *src
= buf
;
6930 const unsigned char *p
;
6935 if (tty
->meta_key
!= 2)
6936 for (i
= 0; i
< nbytes
; i
++)
6938 if (coding
->carryover_bytes
> 0)
6940 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6941 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6942 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6943 nbytes
+= coding
->carryover_bytes
;
6945 coding
->destination
= alloca (nbytes
* 4);
6946 coding
->dst_bytes
= nbytes
* 4;
6947 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6948 if (coding
->produced_char
== 0)
6950 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6952 struct input_event event_buf
;
6954 EVENT_INIT (event_buf
);
6955 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6957 (ASCII_CHAR_P (event_buf
.code
)
6958 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6959 /* See the comment in tty_read_avail_input. */
6960 event_buf
.frame_or_window
= tty
->top_frame
;
6961 event_buf
.arg
= Qnil
;
6962 kbd_buffer_store_event (&event_buf
);
6966 /* This is the tty way of reading available input.
6968 Note that each terminal device has its own `struct terminal' object,
6969 and so this function is called once for each individual termcap
6970 terminal. The first parameter indicates which terminal to read from. */
6973 tty_read_avail_input (struct terminal
*terminal
,
6975 struct input_event
*hold_quit
)
6977 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6978 the kbd_buffer can really hold. That may prevent loss
6979 of characters on some systems when input is stuffed at us. */
6980 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6982 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6985 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6987 if (kbd_on_hold_p () || buffer_free
<= 0)
6989 #endif /* subprocesses */
6991 if (!terminal
->name
) /* Don't read from a dead terminal. */
6994 if (terminal
->type
!= output_termcap
6995 && terminal
->type
!= output_msdos_raw
)
6998 /* XXX I think the following code should be moved to separate hook
6999 functions in system-dependent files. */
7002 #else /* not WINDOWSNT */
7003 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7007 return 0; /* The terminal is suspended. */
7010 n_to_read
= dos_keysns ();
7014 cbuf
[0] = dos_keyread ();
7017 #else /* not MSDOS */
7022 struct input_event gpm_hold_quit
;
7023 int gpm
, fd
= gpm_fd
;
7025 EVENT_INIT (gpm_hold_quit
);
7026 gpm_hold_quit
.kind
= NO_EVENT
;
7028 /* gpm==1 if event received.
7029 gpm==0 if the GPM daemon has closed the connection, in which case
7030 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7031 we save it in `fd' so close_gpm can remove it from the
7033 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7034 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7035 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7038 /* Presumably the GPM daemon has closed the connection. */
7040 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7041 kbd_buffer_store_event (&gpm_hold_quit
);
7045 #endif /* HAVE_GPM */
7047 /* Determine how many characters we should *try* to read. */
7049 /* Find out how much input is available. */
7050 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7052 if (! noninteractive
)
7053 return -2; /* Close this terminal. */
7059 if (n_to_read
> sizeof cbuf
)
7060 n_to_read
= sizeof cbuf
;
7061 #else /* no FIONREAD */
7062 #if defined (USG) || defined (CYGWIN)
7063 /* Read some input if available, but don't wait. */
7064 n_to_read
= sizeof cbuf
;
7065 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7072 /* Don't read more than we can store. */
7073 if (n_to_read
> buffer_free
)
7074 n_to_read
= buffer_free
;
7075 #endif /* subprocesses */
7077 /* Now read; for one reason or another, this will not block.
7078 NREAD is set to the number of chars read. */
7081 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7082 /* POSIX infers that processes which are not in the session leader's
7083 process group won't get SIGHUP's at logout time. BSDI adheres to
7084 this part standard and returns -1 from read (0) with errno==EIO
7085 when the control tty is taken away.
7086 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7087 if (nread
== -1 && errno
== EIO
)
7088 return -2; /* Close this terminal. */
7089 #if defined (AIX) && defined (_BSD)
7090 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7091 This looks incorrect, but it isn't, because _BSD causes
7092 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7093 and that causes a value other than 0 when there is no input. */
7095 return -2; /* Close this terminal. */
7099 /* We used to retry the read if it was interrupted.
7100 But this does the wrong thing when O_NDELAY causes
7101 an EAGAIN error. Does anybody know of a situation
7102 where a retry is actually needed? */
7104 nread
< 0 && (errno
== EAGAIN
7118 #if defined (USG) || defined (CYGWIN)
7119 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7120 #endif /* USG or CYGWIN */
7121 #endif /* no FIONREAD */
7126 #endif /* not MSDOS */
7127 #endif /* not WINDOWSNT */
7129 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7130 & CODING_REQUIRE_DECODING_MASK
)
7132 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7135 /* Decode the key sequence except for those with meta
7137 for (i
= from
= 0; ; i
++)
7138 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7140 struct input_event buf
;
7142 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7147 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7148 buf
.modifiers
= meta_modifier
;
7149 buf
.code
= cbuf
[i
] & ~0x80;
7150 /* See the comment below. */
7151 buf
.frame_or_window
= tty
->top_frame
;
7153 kbd_buffer_store_event (&buf
);
7159 for (i
= 0; i
< nread
; i
++)
7161 struct input_event buf
;
7163 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7165 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7166 buf
.modifiers
= meta_modifier
;
7167 if (tty
->meta_key
!= 2)
7171 /* Set the frame corresponding to the active tty. Note that the
7172 value of selected_frame is not reliable here, redisplay tends
7173 to temporarily change it. */
7174 buf
.frame_or_window
= tty
->top_frame
;
7177 kbd_buffer_store_event (&buf
);
7178 /* Don't look at input that follows a C-g too closely.
7179 This reduces lossage due to autorepeat on C-g. */
7180 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7181 && buf
.code
== quit_char
)
7189 handle_async_input (void)
7191 interrupt_input_pending
= 0;
7193 pending_signals
= pending_atimers
;
7195 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7196 doing anything dangerous. */
7203 nread
= read_avail_input (1);
7204 /* -1 means it's not ok to read the input now.
7205 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7206 0 means there was no keyboard input available. */
7216 process_pending_signals (void)
7218 if (interrupt_input_pending
)
7219 handle_async_input ();
7220 do_pending_atimers ();
7223 #ifdef SIGIO /* for entire page */
7224 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7227 input_available_signal (int signo
)
7229 /* Must preserve main program's value of errno. */
7230 int old_errno
= errno
;
7231 SIGNAL_THREAD_CHECK (signo
);
7234 interrupt_input_pending
= 1;
7235 pending_signals
= 1;
7238 if (input_available_clear_time
)
7239 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7242 handle_async_input ();
7249 /* Send ourselves a SIGIO.
7251 This function exists so that the UNBLOCK_INPUT macro in
7252 blockinput.h can have some way to take care of input we put off
7253 dealing with, without assuming that every file which uses
7254 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7256 reinvoke_input_signal (void)
7259 handle_async_input ();
7265 /* User signal events. */
7267 struct user_signal_info
7269 /* Signal number. */
7272 /* Name of the signal. */
7275 /* Number of pending signals. */
7278 struct user_signal_info
*next
;
7281 /* List of user signals. */
7282 static struct user_signal_info
*user_signals
= NULL
;
7285 add_user_signal (int sig
, const char *name
)
7287 struct user_signal_info
*p
;
7289 for (p
= user_signals
; p
; p
= p
->next
)
7291 /* Already added. */
7294 p
= xmalloc (sizeof (struct user_signal_info
));
7296 p
->name
= xstrdup (name
);
7298 p
->next
= user_signals
;
7301 signal (sig
, handle_user_signal
);
7305 handle_user_signal (int sig
)
7307 int old_errno
= errno
;
7308 struct user_signal_info
*p
;
7309 const char *special_event_name
= NULL
;
7311 SIGNAL_THREAD_CHECK (sig
);
7313 if (SYMBOLP (Vdebug_on_event
))
7314 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7316 for (p
= user_signals
; p
; p
= p
->next
)
7319 if (special_event_name
&&
7320 strcmp (special_event_name
, p
->name
) == 0)
7322 /* Enter the debugger in many ways. */
7323 debug_on_next_call
= 1;
7326 Vinhibit_quit
= Qnil
;
7328 /* Eat the event. */
7334 if (interrupt_input
)
7335 kill (getpid (), SIGIO
);
7339 /* Tell wait_reading_process_output that it needs to wake
7340 up and look around. */
7341 if (input_available_clear_time
)
7342 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7351 find_user_signal_name (int sig
)
7353 struct user_signal_info
*p
;
7355 for (p
= user_signals
; p
; p
= p
->next
)
7363 store_user_signal_events (void)
7365 struct user_signal_info
*p
;
7366 struct input_event buf
;
7369 for (p
= user_signals
; p
; p
= p
->next
)
7370 if (p
->npending
> 0)
7376 memset (&buf
, 0, sizeof buf
);
7377 buf
.kind
= USER_SIGNAL_EVENT
;
7378 buf
.frame_or_window
= selected_frame
;
7380 nstored
+= p
->npending
;
7382 mask
= sigblock (sigmask (p
->sig
));
7386 kbd_buffer_store_event (&buf
);
7389 while (p
->npending
> 0);
7397 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7398 static Lisp_Object menu_bar_one_keymap_changed_items
;
7400 /* These variables hold the vector under construction within
7401 menu_bar_items and its subroutines, and the current index
7402 for storing into that vector. */
7403 static Lisp_Object menu_bar_items_vector
;
7404 static int menu_bar_items_index
;
7407 static const char* separator_names
[] = {
7412 "single-dashed-line",
7413 "double-dashed-line",
7415 "shadow-etched-out",
7416 "shadow-etched-in-dash",
7417 "shadow-etched-out-dash",
7418 "shadow-double-etched-in",
7419 "shadow-double-etched-out",
7420 "shadow-double-etched-in-dash",
7421 "shadow-double-etched-out-dash",
7425 /* Return non-zero if LABEL specifies a separator. */
7428 menu_separator_name_p (const char *label
)
7432 else if (strlen (label
) > 3
7433 && strncmp (label
, "--", 2) == 0
7438 for (i
= 0; separator_names
[i
]; ++i
)
7439 if (strcmp (label
, separator_names
[i
]) == 0)
7444 /* It's a separator if it contains only dashes. */
7445 while (*label
== '-')
7447 return (*label
== 0);
7454 /* Return a vector of menu items for a menu bar, appropriate
7455 to the current buffer. Each item has three elements in the vector:
7458 OLD is an old vector we can optionally reuse, or nil. */
7461 menu_bar_items (Lisp_Object old
)
7463 /* The number of keymaps we're scanning right now, and the number of
7464 keymaps we have allocated space for. */
7467 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7468 in the current keymaps, or nil where it is not a prefix. */
7471 Lisp_Object def
, tail
;
7476 /* In order to build the menus, we need to call the keymap
7477 accessors. They all call QUIT. But this function is called
7478 during redisplay, during which a quit is fatal. So inhibit
7479 quitting while building the menus.
7480 We do this instead of specbind because (1) errors will clear it anyway
7481 and (2) this avoids risk of specpdl overflow. */
7482 oquit
= Vinhibit_quit
;
7486 menu_bar_items_vector
= old
;
7488 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7489 menu_bar_items_index
= 0;
7491 /* Build our list of keymaps.
7492 If we recognize a function key and replace its escape sequence in
7493 keybuf with its symbol, or if the sequence starts with a mouse
7494 click and we need to switch buffers, we jump back here to rebuild
7495 the initial keymaps from the current buffer. */
7499 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7500 if (!NILP (Voverriding_local_map_menu_flag
))
7502 /* Yes, use them (if non-nil) as well as the global map. */
7503 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7505 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7506 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7507 if (!NILP (Voverriding_local_map
))
7508 maps
[nmaps
++] = Voverriding_local_map
;
7512 /* No, so use major and minor mode keymaps and keymap property.
7513 Note that menu-bar bindings in the local-map and keymap
7514 properties may not work reliable, as they are only
7515 recognized when the menu-bar (or mode-line) is updated,
7516 which does not normally happen after every command. */
7519 nminor
= current_minor_maps (NULL
, &tmaps
);
7520 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7522 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7523 maps
[nmaps
++] = tem
;
7524 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7526 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7528 maps
[nmaps
++] = current_global_map
;
7531 /* Look up in each map the dummy prefix key `menu-bar'. */
7533 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7534 if (!NILP (maps
[mapno
]))
7536 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7540 menu_bar_one_keymap_changed_items
= Qnil
;
7541 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7545 /* Move to the end those items that should be at the end. */
7547 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7550 int end
= menu_bar_items_index
;
7552 for (i
= 0; i
< end
; i
+= 4)
7553 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7555 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7556 /* Move the item at index I to the end,
7557 shifting all the others forward. */
7558 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7559 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7560 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7561 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7563 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7564 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7565 (end
- i
- 4) * sizeof (Lisp_Object
));
7566 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7567 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7568 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7569 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7574 /* Add nil, nil, nil, nil at the end. */
7576 int i
= menu_bar_items_index
;
7577 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7578 menu_bar_items_vector
=
7579 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7580 /* Add this item. */
7581 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
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 menu_bar_items_index
= i
;
7588 Vinhibit_quit
= oquit
;
7589 return menu_bar_items_vector
;
7592 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7593 If there's already an item for KEY, add this DEF to it. */
7595 Lisp_Object item_properties
;
7598 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7600 struct gcpro gcpro1
;
7604 if (EQ (item
, Qundefined
))
7606 /* If a map has an explicit `undefined' as definition,
7607 discard any previously made menu bar item. */
7609 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7610 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7612 if (menu_bar_items_index
> i
+ 4)
7613 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7614 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7615 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7616 menu_bar_items_index
-= 4;
7620 /* If this keymap has already contributed to this KEY,
7621 don't contribute to it a second time. */
7622 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7623 if (!NILP (tem
) || NILP (item
))
7626 menu_bar_one_keymap_changed_items
7627 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7629 /* We add to menu_bar_one_keymap_changed_items before doing the
7630 parse_menu_item, so that if it turns out it wasn't a menu item,
7631 it still correctly hides any further menu item. */
7633 i
= parse_menu_item (item
, 1);
7638 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7640 /* Find any existing item for this KEY. */
7641 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7642 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7645 /* If we did not find this KEY, add it at the end. */
7646 if (i
== menu_bar_items_index
)
7648 /* If vector is too small, get a bigger one. */
7649 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7650 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7651 /* Add this item. */
7652 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7653 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7654 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7655 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7656 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7657 menu_bar_items_index
= i
;
7659 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7663 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7664 /* If the new and the old items are not both keymaps,
7665 the lookup will only find `item'. */
7666 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7667 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7671 /* This is used as the handler when calling menu_item_eval_property. */
7673 menu_item_eval_property_1 (Lisp_Object arg
)
7675 /* If we got a quit from within the menu computation,
7676 quit all the way out of it. This takes care of C-] in the debugger. */
7677 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7678 Fsignal (Qquit
, Qnil
);
7684 eval_dyn (Lisp_Object form
)
7686 return Feval (form
, Qnil
);
7689 /* Evaluate an expression and return the result (or nil if something
7690 went wrong). Used to evaluate dynamic parts of menu items. */
7692 menu_item_eval_property (Lisp_Object sexpr
)
7694 int count
= SPECPDL_INDEX ();
7696 specbind (Qinhibit_redisplay
, Qt
);
7697 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7698 menu_item_eval_property_1
);
7699 return unbind_to (count
, val
);
7702 /* This function parses a menu item and leaves the result in the
7703 vector item_properties.
7704 ITEM is a key binding, a possible menu item.
7705 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7707 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7708 parse_menu_item returns true if the item is a menu item and false
7712 parse_menu_item (Lisp_Object item
, int inmenubar
)
7714 Lisp_Object def
, tem
, item_string
, start
;
7716 Lisp_Object keyhint
;
7725 /* Create item_properties vector if necessary. */
7726 if (NILP (item_properties
))
7728 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7730 /* Initialize optional entries. */
7731 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7732 ASET (item_properties
, i
, Qnil
);
7733 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7735 /* Save the item here to protect it from GC. */
7736 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7738 item_string
= XCAR (item
);
7742 if (STRINGP (item_string
))
7744 /* Old format menu item. */
7745 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7747 /* Maybe help string. */
7748 if (CONSP (item
) && STRINGP (XCAR (item
)))
7750 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7755 /* Maybe an obsolete key binding cache. */
7756 if (CONSP (item
) && CONSP (XCAR (item
))
7757 && (NILP (XCAR (XCAR (item
)))
7758 || VECTORP (XCAR (XCAR (item
)))))
7761 /* This is the real definition--the function to run. */
7762 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7764 /* Get enable property, if any. */
7767 tem
= Fget (item
, Qmenu_enable
);
7768 if (!NILP (Venable_disabled_menus_and_buttons
))
7769 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7770 else if (!NILP (tem
))
7771 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7774 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7776 /* New format menu item. */
7777 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7778 start
= XCDR (item
);
7781 /* We have a real binding. */
7782 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7784 item
= XCDR (start
);
7785 /* Is there an obsolete cache list with key equivalences. */
7786 if (CONSP (item
) && CONSP (XCAR (item
)))
7789 /* Parse properties. */
7790 while (CONSP (item
) && CONSP (XCDR (item
)))
7795 if (EQ (tem
, QCenable
))
7797 if (!NILP (Venable_disabled_menus_and_buttons
))
7798 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7800 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7802 else if (EQ (tem
, QCvisible
))
7804 /* If got a visible property and that evaluates to nil
7805 then ignore this item. */
7806 tem
= menu_item_eval_property (XCAR (item
));
7810 else if (EQ (tem
, QChelp
))
7811 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7812 else if (EQ (tem
, QCfilter
))
7814 else if (EQ (tem
, QCkey_sequence
))
7817 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7818 /* Be GC protected. Set keyhint to item instead of tem. */
7821 else if (EQ (tem
, QCkeys
))
7824 if (CONSP (tem
) || STRINGP (tem
))
7825 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7827 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7832 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7834 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7836 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7842 else if (inmenubar
|| !NILP (start
))
7846 return 0; /* not a menu item */
7848 /* If item string is not a string, evaluate it to get string.
7849 If we don't get a string, skip this item. */
7850 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7851 if (!(STRINGP (item_string
)))
7853 item_string
= menu_item_eval_property (item_string
);
7854 if (!STRINGP (item_string
))
7856 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7859 /* If got a filter apply it on definition. */
7860 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7863 def
= menu_item_eval_property (list2 (XCAR (filter
),
7864 list2 (Qquote
, def
)));
7866 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7869 /* Enable or disable selection of item. */
7870 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7873 tem
= menu_item_eval_property (tem
);
7874 if (inmenubar
&& NILP (tem
))
7875 return 0; /* Ignore disabled items in menu bar. */
7876 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7879 /* If we got no definition, this item is just unselectable text which
7880 is OK in a submenu but not in the menubar. */
7882 return (!inmenubar
);
7884 /* See if this is a separate pane or a submenu. */
7885 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7886 tem
= get_keymap (def
, 0, 1);
7887 /* For a subkeymap, just record its details and exit. */
7890 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7891 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7895 /* At the top level in the menu bar, do likewise for commands also.
7896 The menu bar does not display equivalent key bindings anyway.
7897 ITEM_PROPERTY_DEF is already set up properly. */
7901 { /* This is a command. See if there is an equivalent key binding. */
7902 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7904 /* The previous code preferred :key-sequence to :keys, so we
7905 preserve this behavior. */
7906 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7907 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7910 Lisp_Object prefix
= keyeq
;
7911 Lisp_Object keys
= Qnil
;
7915 def
= XCAR (prefix
);
7916 prefix
= XCDR (prefix
);
7919 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7921 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7923 keys
= XCAR (keyhint
);
7924 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7926 /* We have a suggested key. Is it bound to the command? */
7929 /* If the command is an alias for another
7930 (such as lmenu.el set it up), check if the
7931 original command matches the cached command. */
7932 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7937 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7941 tem
= Fkey_description (keys
, Qnil
);
7944 if (STRINGP (XCAR (prefix
)))
7945 tem
= concat2 (XCAR (prefix
), tem
);
7946 if (STRINGP (XCDR (prefix
)))
7947 tem
= concat2 (tem
, XCDR (prefix
));
7949 keyeq
= concat2 (build_string (" "), tem
);
7950 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7956 /* If we have an equivalent key binding, use that. */
7957 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7960 /* Include this when menu help is implemented.
7961 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7962 if (!(NILP (tem) || STRINGP (tem)))
7964 tem = menu_item_eval_property (tem);
7967 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7971 /* Handle radio buttons or toggle boxes. */
7972 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7974 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7975 menu_item_eval_property (tem
));
7982 /***********************************************************************
7984 ***********************************************************************/
7986 /* A vector holding tool bar items while they are parsed in function
7987 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7990 static Lisp_Object tool_bar_items_vector
;
7992 /* A vector holding the result of parse_tool_bar_item. Layout is like
7993 the one for a single item in tool_bar_items_vector. */
7995 static Lisp_Object tool_bar_item_properties
;
7997 /* Next free index in tool_bar_items_vector. */
7999 static int ntool_bar_items
;
8001 /* The symbols `:image' and `:rtl'. */
8003 static Lisp_Object QCimage
;
8004 static Lisp_Object QCrtl
;
8006 /* Function prototypes. */
8008 static void init_tool_bar_items (Lisp_Object
);
8009 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8010 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8011 static void append_tool_bar_item (void);
8014 /* Return a vector of tool bar items for keymaps currently in effect.
8015 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8016 tool bar items found. */
8019 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8028 /* In order to build the menus, we need to call the keymap
8029 accessors. They all call QUIT. But this function is called
8030 during redisplay, during which a quit is fatal. So inhibit
8031 quitting while building the menus. We do this instead of
8032 specbind because (1) errors will clear it anyway and (2) this
8033 avoids risk of specpdl overflow. */
8034 oquit
= Vinhibit_quit
;
8037 /* Initialize tool_bar_items_vector and protect it from GC. */
8038 init_tool_bar_items (reuse
);
8040 /* Build list of keymaps in maps. Set nmaps to the number of maps
8043 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8044 if (!NILP (Voverriding_local_map_menu_flag
))
8046 /* Yes, use them (if non-nil) as well as the global map. */
8047 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8049 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8050 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8051 if (!NILP (Voverriding_local_map
))
8052 maps
[nmaps
++] = Voverriding_local_map
;
8056 /* No, so use major and minor mode keymaps and keymap property.
8057 Note that tool-bar bindings in the local-map and keymap
8058 properties may not work reliable, as they are only
8059 recognized when the tool-bar (or mode-line) is updated,
8060 which does not normally happen after every command. */
8063 nminor
= current_minor_maps (NULL
, &tmaps
);
8064 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8066 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8067 maps
[nmaps
++] = tem
;
8068 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8070 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8073 /* Add global keymap at the end. */
8074 maps
[nmaps
++] = current_global_map
;
8076 /* Process maps in reverse order and look up in each map the prefix
8078 for (i
= nmaps
- 1; i
>= 0; --i
)
8079 if (!NILP (maps
[i
]))
8083 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8085 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8088 Vinhibit_quit
= oquit
;
8089 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8090 return tool_bar_items_vector
;
8094 /* Process the definition of KEY which is DEF. */
8097 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8100 struct gcpro gcpro1
, gcpro2
;
8102 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8106 if (EQ (def
, Qundefined
))
8108 /* If a map has an explicit `undefined' as definition,
8109 discard any previously made item. */
8110 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8112 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8114 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8116 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8117 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8118 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8119 * sizeof (Lisp_Object
)));
8120 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8125 else if (parse_tool_bar_item (key
, def
))
8126 /* Append a new tool bar item to tool_bar_items_vector. Accept
8127 more than one definition for the same key. */
8128 append_tool_bar_item ();
8134 /* Parse a tool bar item specification ITEM for key KEY and return the
8135 result in tool_bar_item_properties. Value is zero if ITEM is
8138 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8140 CAPTION is the caption of the item, If it's not a string, it is
8141 evaluated to get a string.
8143 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8144 as binding are currently ignored.
8146 The following properties are recognized:
8150 FORM is evaluated and specifies whether the tool bar item is
8151 enabled or disabled.
8155 FORM is evaluated and specifies whether the tool bar item is visible.
8157 - `:filter FUNCTION'
8159 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8160 result is stored as the new binding.
8162 - `:button (TYPE SELECTED)'
8164 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8165 and specifies whether the button is selected (pressed) or not.
8169 IMAGES is either a single image specification or a vector of four
8170 image specifications. See enum tool_bar_item_images.
8172 - `:help HELP-STRING'.
8174 Gives a help string to display for the tool bar item.
8176 - `:label LABEL-STRING'.
8178 A text label to show with the tool bar button if labels are enabled. */
8181 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8183 /* Access slot with index IDX of vector tool_bar_item_properties. */
8184 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8186 Lisp_Object filter
= Qnil
;
8187 Lisp_Object caption
;
8188 int i
, have_label
= 0;
8190 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8191 Rule out items that aren't lists, don't start with
8192 `menu-item' or whose rest following `tool-bar-item' is not a
8197 /* As an exception, allow old-style menu separators. */
8198 if (STRINGP (XCAR (item
)))
8199 item
= Fcons (XCAR (item
), Qnil
);
8200 else if (!EQ (XCAR (item
), Qmenu_item
)
8201 || (item
= XCDR (item
), !CONSP (item
)))
8204 /* Create tool_bar_item_properties vector if necessary. Reset it to
8206 if (VECTORP (tool_bar_item_properties
))
8208 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8212 tool_bar_item_properties
8213 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8216 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8217 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8219 /* Get the caption of the item. If the caption is not a string,
8220 evaluate it to get a string. If we don't get a string, skip this
8222 caption
= XCAR (item
);
8223 if (!STRINGP (caption
))
8225 caption
= menu_item_eval_property (caption
);
8226 if (!STRINGP (caption
))
8229 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8231 /* If the rest following the caption is not a list, the menu item is
8232 either a separator, or invalid. */
8236 if (menu_separator_name_p (SSDATA (caption
)))
8238 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8239 #if !defined (USE_GTK) && !defined (HAVE_NS)
8240 /* If we use build_desired_tool_bar_string to render the
8241 tool bar, the separator is rendered as an image. */
8242 PROP (TOOL_BAR_ITEM_IMAGES
)
8243 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8244 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8245 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8246 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8253 /* Store the binding. */
8254 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8257 /* Ignore cached key binding, if any. */
8258 if (CONSP (item
) && CONSP (XCAR (item
)))
8261 /* Process the rest of the properties. */
8262 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8264 Lisp_Object ikey
, value
;
8267 value
= XCAR (XCDR (item
));
8269 if (EQ (ikey
, QCenable
))
8271 /* `:enable FORM'. */
8272 if (!NILP (Venable_disabled_menus_and_buttons
))
8273 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8275 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8277 else if (EQ (ikey
, QCvisible
))
8279 /* `:visible FORM'. If got a visible property and that
8280 evaluates to nil then ignore this item. */
8281 if (NILP (menu_item_eval_property (value
)))
8284 else if (EQ (ikey
, QChelp
))
8285 /* `:help HELP-STRING'. */
8286 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8287 else if (EQ (ikey
, QCvert_only
))
8288 /* `:vert-only t/nil'. */
8289 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8290 else if (EQ (ikey
, QClabel
))
8292 const char *bad_label
= "!!?GARBLED ITEM?!!";
8293 /* `:label LABEL-STRING'. */
8294 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8296 : build_string (bad_label
);
8299 else if (EQ (ikey
, QCfilter
))
8300 /* ':filter FORM'. */
8302 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8304 /* `:button (TYPE . SELECTED)'. */
8305 Lisp_Object type
, selected
;
8307 type
= XCAR (value
);
8308 selected
= XCDR (value
);
8309 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8311 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8312 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8315 else if (EQ (ikey
, QCimage
)
8317 || (VECTORP (value
) && ASIZE (value
) == 4)))
8318 /* Value is either a single image specification or a vector
8319 of 4 such specifications for the different button states. */
8320 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8321 else if (EQ (ikey
, QCrtl
))
8323 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8329 /* Try to make one from caption and key. */
8330 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8331 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8332 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8333 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8335 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8336 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8337 Lisp_Object new_lbl
;
8338 ptrdiff_t caption_len
= strlen (capt
);
8340 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8343 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8345 buf
[caption_len
] = '\0';
8349 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8353 strcpy (buf
, label
);
8355 for (j
= 0; buf
[j
] != '\0'; ++j
)
8363 new_lbl
= Fupcase_initials (build_string (label
));
8364 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8365 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8367 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8371 /* If got a filter apply it on binding. */
8373 PROP (TOOL_BAR_ITEM_BINDING
)
8374 = menu_item_eval_property (list2 (filter
,
8376 PROP (TOOL_BAR_ITEM_BINDING
))));
8378 /* See if the binding is a keymap. Give up if it is. */
8379 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8382 /* Enable or disable selection of item. */
8383 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8384 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8385 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8387 /* Handle radio buttons or toggle boxes. */
8388 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8389 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8390 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8398 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8399 that can be reused. */
8402 init_tool_bar_items (Lisp_Object reuse
)
8404 if (VECTORP (reuse
))
8405 tool_bar_items_vector
= reuse
;
8407 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8408 ntool_bar_items
= 0;
8412 /* Append parsed tool bar item properties from
8413 tool_bar_item_properties */
8416 append_tool_bar_item (void)
8418 Lisp_Object
*to
, *from
;
8420 /* Enlarge tool_bar_items_vector if necessary. */
8421 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8422 >= ASIZE (tool_bar_items_vector
))
8423 tool_bar_items_vector
8424 = larger_vector (tool_bar_items_vector
,
8425 2 * ASIZE (tool_bar_items_vector
), Qnil
);
8427 /* Append entries from tool_bar_item_properties to the end of
8428 tool_bar_items_vector. */
8429 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8430 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8431 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8432 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8439 /* Read a character using menus based on maps in the array MAPS.
8440 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8441 Return t if we displayed a menu but the user rejected it.
8443 PREV_EVENT is the previous input event, or nil if we are reading
8444 the first event of a key sequence.
8446 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8447 if we used a mouse menu to read the input, or zero otherwise. If
8448 USED_MOUSE_MENU is null, we don't dereference it.
8450 The prompting is done based on the prompt-string of the map
8451 and the strings associated with various map elements.
8453 This can be done with X menus or with menus put in the minibuf.
8454 These are done in different ways, depending on how the input will be read.
8455 Menus using X are done after auto-saving in read-char, getting the input
8456 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8457 and do auto-saving in the inner call of read_char. */
8460 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8461 Lisp_Object prev_event
, int *used_mouse_menu
)
8465 if (used_mouse_menu
)
8466 *used_mouse_menu
= 0;
8468 /* Use local over global Menu maps */
8470 if (! menu_prompting
)
8473 /* Optionally disregard all but the global map. */
8474 if (inhibit_local_menu_bar_menus
)
8476 maps
+= (nmaps
- 1);
8481 /* If we got to this point via a mouse click,
8482 use a real menu for mouse selection. */
8483 if (EVENT_HAS_PARAMETERS (prev_event
)
8484 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8485 && !EQ (XCAR (prev_event
), Qtool_bar
))
8487 /* Display the menu and get the selection. */
8488 Lisp_Object
*realmaps
8489 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8491 ptrdiff_t nmaps1
= 0;
8493 /* Use the maps that are not nil. */
8494 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8495 if (!NILP (maps
[mapno
]))
8496 realmaps
[nmaps1
++] = maps
[mapno
];
8498 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8503 record_menu_key (XCAR (value
));
8505 /* If we got multiple events, unread all but
8507 There is no way to prevent those unread events
8508 from showing up later in last_nonmenu_event.
8509 So turn symbol and integer events into lists,
8510 to indicate that they came from a mouse menu,
8511 so that when present in last_nonmenu_event
8512 they won't confuse things. */
8513 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8515 record_menu_key (XCAR (tem
));
8516 if (SYMBOLP (XCAR (tem
))
8517 || INTEGERP (XCAR (tem
)))
8518 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8521 /* If we got more than one event, put all but the first
8522 onto this list to be read later.
8523 Return just the first event now. */
8524 Vunread_command_events
8525 = nconc2 (XCDR (value
), Vunread_command_events
);
8526 value
= XCAR (value
);
8528 else if (NILP (value
))
8530 if (used_mouse_menu
)
8531 *used_mouse_menu
= 1;
8534 #endif /* HAVE_MENUS */
8538 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8539 We make this bigger when necessary, and never free it. */
8540 static char *read_char_minibuf_menu_text
;
8541 /* Size of that buffer. */
8542 static ptrdiff_t read_char_minibuf_menu_width
;
8545 read_char_minibuf_menu_prompt (int commandflag
,
8546 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8549 register Lisp_Object name
;
8551 /* FIXME: Use the minibuffer's frame width. */
8552 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8555 Lisp_Object rest
, vector
;
8561 if (! menu_prompting
)
8564 /* Get the menu name from the first map that has one (a prompt string). */
8565 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8567 name
= Fkeymap_prompt (maps
[mapno
]);
8572 /* If we don't have any menus, just read a character normally. */
8573 if (!STRINGP (name
))
8576 /* Make sure we have a big enough buffer for the menu text. */
8577 width
= max (width
, SBYTES (name
));
8578 if (STRING_BYTES_BOUND
- 4 < width
)
8579 memory_full (SIZE_MAX
);
8580 if (width
+ 4 > read_char_minibuf_menu_width
)
8582 read_char_minibuf_menu_text
8583 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8584 read_char_minibuf_menu_width
= width
+ 4;
8586 menu
= read_char_minibuf_menu_text
;
8588 /* Prompt string always starts with map's prompt, and a space. */
8589 strcpy (menu
, SSDATA (name
));
8590 nlength
= SBYTES (name
);
8591 menu
[nlength
++] = ':';
8592 menu
[nlength
++] = ' ';
8595 /* Start prompting at start of first map. */
8599 /* Present the documented bindings, a line at a time. */
8603 ptrdiff_t i
= nlength
;
8605 Lisp_Object orig_defn_macro
;
8607 /* Loop over elements of map. */
8612 /* If reached end of map, start at beginning of next map. */
8616 /* At end of last map, wrap around to first map if just starting,
8617 or end this line if already have something on it. */
8621 if (notfirst
|| nobindings
) break;
8626 /* Look at the next element of the map. */
8628 elt
= XVECTOR (vector
)->contents
[idx
];
8630 elt
= Fcar_safe (rest
);
8632 if (idx
< 0 && VECTORP (elt
))
8634 /* If we found a dense table in the keymap,
8635 advanced past it, but start scanning its contents. */
8636 rest
= Fcdr_safe (rest
);
8642 /* An ordinary element. */
8643 Lisp_Object event
, tem
;
8647 event
= Fcar_safe (elt
); /* alist */
8648 elt
= Fcdr_safe (elt
);
8652 XSETINT (event
, idx
); /* vector */
8655 /* Ignore the element if it has no prompt string. */
8656 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8658 /* 1 if the char to type matches the string. */
8660 Lisp_Object upcased_event
, downcased_event
;
8661 Lisp_Object desc
= Qnil
;
8663 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8665 upcased_event
= Fupcase (event
);
8666 downcased_event
= Fdowncase (event
);
8667 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8668 || XINT (downcased_event
) == SREF (s
, 0));
8670 desc
= Fsingle_key_description (event
, Qnil
);
8672 #if 0 /* It is redundant to list the equivalent key bindings because
8673 the prefix is what the user has already typed. */
8675 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8677 /* Insert equivalent keybinding. */
8678 s
= concat2 (s
, tem
);
8681 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8682 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8684 /* Insert button prefix. */
8685 Lisp_Object selected
8686 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8687 if (EQ (tem
, QCradio
))
8688 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8690 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8691 s
= concat2 (tem
, s
);
8695 /* If we have room for the prompt string, add it to this line.
8696 If this is the first on the line, always add it. */
8697 if ((SCHARS (s
) + i
+ 2
8698 + (char_matches
? 0 : SCHARS (desc
) + 3))
8702 ptrdiff_t thiswidth
;
8704 /* Punctuate between strings. */
8707 strcpy (menu
+ i
, ", ");
8713 /* If the char to type doesn't match the string's
8714 first char, explicitly show what char to type. */
8717 /* Add as much of string as fits. */
8718 thiswidth
= min (SCHARS (desc
), width
- i
);
8719 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8721 strcpy (menu
+ i
, " = ");
8725 /* Add as much of string as fits. */
8726 thiswidth
= min (SCHARS (s
), width
- i
);
8727 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8733 /* If this element does not fit, end the line now,
8734 and save the element for the next line. */
8735 strcpy (menu
+ i
, "...");
8740 /* Move past this element. */
8741 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8742 /* Handle reaching end of dense table. */
8747 rest
= Fcdr_safe (rest
);
8751 /* Prompt with that and read response. */
8752 message2_nolog (menu
, strlen (menu
),
8753 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8755 /* Make believe its not a keyboard macro in case the help char
8756 is pressed. Help characters are not recorded because menu prompting
8757 is not used on replay.
8759 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8760 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8762 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8763 while (BUFFERP (obj
));
8764 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8766 if (!INTEGERP (obj
))
8768 else if (XINT (obj
) == -2)
8771 if (! EQ (obj
, menu_prompt_more_char
)
8772 && (!INTEGERP (menu_prompt_more_char
)
8773 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8775 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8776 store_kbd_macro_char (obj
);
8779 /* Help char - go round again */
8783 /* Reading key sequences. */
8785 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8786 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8787 keymap, or nil otherwise. Return the index of the first keymap in
8788 which KEY has any binding, or NMAPS if no map has a binding.
8790 If KEY is a meta ASCII character, treat it like meta-prefix-char
8791 followed by the corresponding non-meta character. Keymaps in
8792 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8795 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8798 NEXT may be the same array as CURRENT. */
8801 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8802 Lisp_Object
*defs
, Lisp_Object
*next
)
8804 ptrdiff_t i
, first_binding
;
8806 first_binding
= nmaps
;
8807 for (i
= nmaps
- 1; i
>= 0; i
--)
8809 if (! NILP (current
[i
]))
8811 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8812 if (! NILP (defs
[i
]))
8819 /* Given the set of bindings we've found, produce the next set of maps. */
8820 if (first_binding
< nmaps
)
8821 for (i
= 0; i
< nmaps
; i
++)
8822 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8824 return first_binding
;
8827 /* Structure used to keep track of partial application of key remapping
8828 such as Vfunction_key_map and Vkey_translation_map. */
8829 typedef struct keyremap
8831 /* This is the map originally specified for this use. */
8833 /* This is a submap reached by looking up, in PARENT,
8834 the events from START to END. */
8836 /* Positions [START, END) in the key sequence buffer
8837 are the key that we have scanned so far.
8838 Those events are the ones that we will replace
8839 if PARENT maps them into a key sequence. */
8843 /* Lookup KEY in MAP.
8844 MAP is a keymap mapping keys to key vectors or functions.
8845 If the mapping is a function and DO_FUNCTION is non-zero, then
8846 the function is called with PROMPT as parameter and its return
8847 value is used as the return value of this function (after checking
8848 that it is indeed a vector). */
8851 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8856 next
= access_keymap (map
, key
, 1, 0, 1);
8858 /* Handle symbol with autoload definition. */
8859 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8860 && CONSP (XSYMBOL (next
)->function
)
8861 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8862 do_autoload (XSYMBOL (next
)->function
, next
);
8864 /* Handle a symbol whose function definition is a keymap
8866 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8867 && (ARRAYP (XSYMBOL (next
)->function
)
8868 || KEYMAPP (XSYMBOL (next
)->function
)))
8869 next
= XSYMBOL (next
)->function
;
8871 /* If the keymap gives a function, not an
8872 array, then call the function with one arg and use
8873 its value instead. */
8874 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8879 next
= call1 (next
, prompt
);
8880 /* If the function returned something invalid,
8881 barf--don't ignore it.
8882 (To ignore it safely, we would need to gcpro a bunch of
8883 other variables.) */
8884 if (! (VECTORP (next
) || STRINGP (next
)))
8885 error ("Function %s returns invalid key sequence",
8886 SSDATA (SYMBOL_NAME (tem
)));
8891 /* Do one step of the key remapping used for function-key-map and
8892 key-translation-map:
8893 KEYBUF is the buffer holding the input events.
8894 BUFSIZE is its maximum size.
8895 FKEY is a pointer to the keyremap structure to use.
8896 INPUT is the index of the last element in KEYBUF.
8897 DOIT if non-zero says that the remapping can actually take place.
8898 DIFF is used to return the number of keys added/removed by the remapping.
8899 PARENT is the root of the keymap.
8900 PROMPT is the prompt to use if the remapping happens through a function.
8901 The return value is non-zero if the remapping actually took place. */
8904 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8905 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8907 Lisp_Object next
, key
;
8909 key
= keybuf
[fkey
->end
++];
8911 if (KEYMAPP (fkey
->parent
))
8912 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8916 /* If keybuf[fkey->start..fkey->end] is bound in the
8917 map and we're in a position to do the key remapping, replace it with
8918 the binding and restart with fkey->start at the end. */
8919 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8921 int len
= XFASTINT (Flength (next
));
8924 *diff
= len
- (fkey
->end
- fkey
->start
);
8926 if (bufsize
- input
<= *diff
)
8927 error ("Key sequence too long");
8929 /* Shift the keys that follow fkey->end. */
8931 for (i
= fkey
->end
; i
< input
; i
++)
8932 keybuf
[i
+ *diff
] = keybuf
[i
];
8934 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8935 keybuf
[i
+ *diff
] = keybuf
[i
];
8936 /* Overwrite the old keys with the new ones. */
8937 for (i
= 0; i
< len
; i
++)
8938 keybuf
[fkey
->start
+ i
]
8939 = Faref (next
, make_number (i
));
8941 fkey
->start
= fkey
->end
+= *diff
;
8942 fkey
->map
= fkey
->parent
;
8947 fkey
->map
= get_keymap (next
, 0, 1);
8949 /* If we no longer have a bound suffix, try a new position for
8951 if (!CONSP (fkey
->map
))
8953 fkey
->end
= ++fkey
->start
;
8954 fkey
->map
= fkey
->parent
;
8960 test_undefined (Lisp_Object binding
)
8962 return (EQ (binding
, Qundefined
)
8963 || (!NILP (binding
) && SYMBOLP (binding
)
8964 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8967 /* Read a sequence of keys that ends with a non prefix character,
8968 storing it in KEYBUF, a buffer of size BUFSIZE.
8970 Return the length of the key sequence stored.
8971 Return -1 if the user rejected a command menu.
8973 Echo starting immediately unless `prompt' is 0.
8975 Where a key sequence ends depends on the currently active keymaps.
8976 These include any minor mode keymaps active in the current buffer,
8977 the current buffer's local map, and the global map.
8979 If a key sequence has no other bindings, we check Vfunction_key_map
8980 to see if some trailing subsequence might be the beginning of a
8981 function key's sequence. If so, we try to read the whole function
8982 key, and substitute its symbolic name into the key sequence.
8984 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8985 `double-' events into similar click events, if that would make them
8986 bound. We try to turn `triple-' events first into `double-' events,
8989 If we get a mouse click in a mode line, vertical divider, or other
8990 non-text area, we treat the click as if it were prefixed by the
8991 symbol denoting that area - `mode-line', `vertical-line', or
8994 If the sequence starts with a mouse click, we read the key sequence
8995 with respect to the buffer clicked on, not the current buffer.
8997 If the user switches frames in the midst of a key sequence, we put
8998 off the switch-frame event until later; the next call to
8999 read_char will return it.
9001 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9002 from the selected window's buffer. */
9005 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9006 int dont_downcase_last
, int can_return_switch_frame
,
9007 int fix_current_buffer
)
9009 Lisp_Object from_string
;
9010 int count
= SPECPDL_INDEX ();
9012 /* How many keys there are in the current key sequence. */
9015 /* The length of the echo buffer when we started reading, and
9016 the length of this_command_keys when we started reading. */
9017 int echo_start
IF_LINT (= 0);
9020 /* The number of keymaps we're scanning right now, and the number of
9021 keymaps we have allocated space for. */
9023 ptrdiff_t nmaps_allocated
= 0;
9025 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9026 the current keymaps. */
9027 Lisp_Object
*defs
= NULL
;
9029 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9030 in the current keymaps, or nil where it is not a prefix. */
9031 Lisp_Object
*submaps
= NULL
;
9033 /* The local map to start out with at start of key sequence. */
9034 Lisp_Object orig_local_map
;
9036 /* The map from the `keymap' property to start out with at start of
9038 Lisp_Object orig_keymap
;
9040 /* 1 if we have already considered switching to the local-map property
9041 of the place where a mouse click occurred. */
9042 int localized_local_map
= 0;
9044 /* The index in submaps[] of the first keymap that has a binding for
9045 this key sequence. In other words, the lowest i such that
9046 submaps[i] is non-nil. */
9047 ptrdiff_t first_binding
;
9048 /* Index of the first key that has no binding.
9049 It is useless to try fkey.start larger than that. */
9052 /* If t < mock_input, then KEYBUF[t] should be read as the next
9055 We use this to recover after recognizing a function key. Once we
9056 realize that a suffix of the current key sequence is actually a
9057 function key's escape sequence, we replace the suffix with the
9058 function key's binding from Vfunction_key_map. Now keybuf
9059 contains a new and different key sequence, so the echo area,
9060 this_command_keys, and the submaps and defs arrays are wrong. In
9061 this situation, we set mock_input to t, set t to 0, and jump to
9062 restart_sequence; the loop will read keys from keybuf up until
9063 mock_input, thus rebuilding the state; and then it will resume
9064 reading characters from the keyboard. */
9067 /* If the sequence is unbound in submaps[], then
9068 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9069 and fkey.map is its binding.
9071 These might be > t, indicating that all function key scanning
9072 should hold off until t reaches them. We do this when we've just
9073 recognized a function key, to avoid searching for the function
9074 key's again in Vfunction_key_map. */
9077 /* Likewise, for key_translation_map and input-decode-map. */
9078 keyremap keytran
, indec
;
9080 /* Non-zero if we are trying to map a key by changing an upper-case
9081 letter to lower case, or a shifted function key to an unshifted
9083 int shift_translated
= 0;
9085 /* If we receive a `switch-frame' or `select-window' event in the middle of
9086 a key sequence, we put it off for later.
9087 While we're reading, we keep the event here. */
9088 Lisp_Object delayed_switch_frame
;
9090 /* See the comment below... */
9091 #if defined (GOBBLE_FIRST_EVENT)
9092 Lisp_Object first_event
;
9095 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9096 int original_uppercase_position
= -1;
9098 /* Gets around Microsoft compiler limitations. */
9101 struct buffer
*starting_buffer
;
9103 /* List of events for which a fake prefix key has been generated. */
9104 Lisp_Object fake_prefixed_keys
= Qnil
;
9106 #if defined (GOBBLE_FIRST_EVENT)
9110 struct gcpro gcpro1
;
9112 GCPRO1 (fake_prefixed_keys
);
9113 raw_keybuf_count
= 0;
9115 last_nonmenu_event
= Qnil
;
9117 delayed_switch_frame
= Qnil
;
9123 /* Install the string STR as the beginning of the string of
9124 echoing, so that it serves as a prompt for the next
9126 KVAR (current_kboard
, echo_string
) = prompt
;
9127 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9130 else if (cursor_in_echo_area
9131 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9132 && NILP (Fzerop (Vecho_keystrokes
)))
9133 /* This doesn't put in a dash if the echo buffer is empty, so
9134 you don't always see a dash hanging out in the minibuffer. */
9138 /* Record the initial state of the echo area and this_command_keys;
9139 we will need to restore them if we replay a key sequence. */
9141 echo_start
= echo_length ();
9142 keys_start
= this_command_key_count
;
9143 this_single_command_key_start
= keys_start
;
9145 #if defined (GOBBLE_FIRST_EVENT)
9146 /* This doesn't quite work, because some of the things that read_char
9147 does cannot safely be bypassed. It seems too risky to try to make
9150 /* Read the first char of the sequence specially, before setting
9151 up any keymaps, in case a filter runs and switches buffers on us. */
9152 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9154 #endif /* GOBBLE_FIRST_EVENT */
9156 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9157 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9160 /* We jump here when we need to reinitialize fkey and keytran; this
9161 happens if we switch keyboards between rescans. */
9162 replay_entire_sequence
:
9164 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9165 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9166 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9167 indec
.start
= indec
.end
= 0;
9168 fkey
.start
= fkey
.end
= 0;
9169 keytran
.start
= keytran
.end
= 0;
9171 /* We jump here when the key sequence has been thoroughly changed, and
9172 we need to rescan it starting from the beginning. When we jump here,
9173 keybuf[0..mock_input] holds the sequence we should reread. */
9176 starting_buffer
= current_buffer
;
9177 first_unbound
= bufsize
+ 1;
9179 /* Build our list of keymaps.
9180 If we recognize a function key and replace its escape sequence in
9181 keybuf with its symbol, or if the sequence starts with a mouse
9182 click and we need to switch buffers, we jump back here to rebuild
9183 the initial keymaps from the current buffer. */
9186 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9188 if (2 > nmaps_allocated
)
9190 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9191 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9192 nmaps_allocated
= 2;
9194 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9196 else if (!NILP (Voverriding_local_map
))
9198 if (2 > nmaps_allocated
)
9200 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9201 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9202 nmaps_allocated
= 2;
9204 submaps
[nmaps
++] = Voverriding_local_map
;
9212 nminor
= current_minor_maps (0, &maps
);
9213 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9215 if (total
> nmaps_allocated
)
9217 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9218 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9219 nmaps_allocated
= total
;
9222 if (!NILP (orig_keymap
))
9223 submaps
[nmaps
++] = orig_keymap
;
9225 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9229 submaps
[nmaps
++] = orig_local_map
;
9231 submaps
[nmaps
++] = current_global_map
;
9233 /* Find an accurate initial value for first_binding. */
9234 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9235 if (! NILP (submaps
[first_binding
]))
9238 /* Start from the beginning in keybuf. */
9241 /* These are no-ops the first time through, but if we restart, they
9242 revert the echo area and this_command_keys to their original state. */
9243 this_command_key_count
= keys_start
;
9244 if (INTERACTIVE
&& t
< mock_input
)
9245 echo_truncate (echo_start
);
9247 /* If the best binding for the current key sequence is a keymap, or
9248 we may be looking at a function key's escape sequence, keep on
9250 while (first_binding
< nmaps
9251 /* Keep reading as long as there's a prefix binding. */
9252 ? !NILP (submaps
[first_binding
])
9253 /* Don't return in the middle of a possible function key sequence,
9254 if the only bindings we found were via case conversion.
9255 Thus, if ESC O a has a function-key-map translation
9256 and ESC o has a binding, don't return after ESC O,
9257 so that we can translate ESC O plus the next character. */
9258 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9261 int used_mouse_menu
= 0;
9263 /* Where the last real key started. If we need to throw away a
9264 key that has expanded into more than one element of keybuf
9265 (say, a mouse click on the mode line which is being treated
9266 as [mode-line (mouse-...)], then we backtrack to this point
9268 int last_real_key_start
;
9270 /* These variables are analogous to echo_start and keys_start;
9271 while those allow us to restart the entire key sequence,
9272 echo_local_start and keys_local_start allow us to throw away
9274 int echo_local_start
IF_LINT (= 0);
9275 int keys_local_start
;
9276 ptrdiff_t local_first_binding
;
9278 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9279 eassert (indec
.start
<= indec
.end
);
9280 eassert (fkey
.start
<= fkey
.end
);
9281 eassert (keytran
.start
<= keytran
.end
);
9282 /* key-translation-map is applied *after* function-key-map
9283 which is itself applied *after* input-decode-map. */
9284 eassert (fkey
.end
<= indec
.start
);
9285 eassert (keytran
.end
<= fkey
.start
);
9287 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9288 first_unbound
< keytran
.start
)
9289 { /* The prefix upto first_unbound has no binding and has
9290 no translation left to do either, so we know it's unbound.
9291 If we don't stop now, we risk staying here indefinitely
9292 (if the user keeps entering fkey or keytran prefixes
9293 like C-c ESC ESC ESC ESC ...) */
9295 for (i
= first_unbound
+ 1; i
< t
; i
++)
9296 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9297 mock_input
= t
- first_unbound
- 1;
9298 indec
.end
= indec
.start
-= first_unbound
+ 1;
9299 indec
.map
= indec
.parent
;
9300 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9301 fkey
.map
= fkey
.parent
;
9302 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9303 keytran
.map
= keytran
.parent
;
9304 goto replay_sequence
;
9308 error ("Key sequence too long");
9311 echo_local_start
= echo_length ();
9312 keys_local_start
= this_command_key_count
;
9313 local_first_binding
= first_binding
;
9316 /* These are no-ops, unless we throw away a keystroke below and
9317 jumped back up to replay_key; in that case, these restore the
9318 variables to their original state, allowing us to replay the
9320 if (INTERACTIVE
&& t
< mock_input
)
9321 echo_truncate (echo_local_start
);
9322 this_command_key_count
= keys_local_start
;
9323 first_binding
= local_first_binding
;
9325 /* By default, assume each event is "real". */
9326 last_real_key_start
= t
;
9328 /* Does mock_input indicate that we are re-reading a key sequence? */
9332 add_command_key (key
);
9333 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9334 && NILP (Fzerop (Vecho_keystrokes
)))
9338 /* If not, we should actually read a character. */
9342 KBOARD
*interrupted_kboard
= current_kboard
;
9343 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9344 key
= read_char (NILP (prompt
), nmaps
,
9345 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9346 &used_mouse_menu
, NULL
);
9347 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9348 /* When switching to a new tty (with a new keyboard),
9349 read_char returns the new buffer, rather than -2
9350 (Bug#5095). This is because `terminal-init-xterm'
9351 calls read-char, which eats the wrong_kboard_jmpbuf
9352 return. Any better way to fix this? -- cyd */
9353 || (interrupted_kboard
!= current_kboard
))
9358 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9359 if (k
== interrupted_kboard
)
9364 /* Don't touch interrupted_kboard when it's been
9366 delayed_switch_frame
= Qnil
;
9367 goto replay_entire_sequence
;
9370 if (!NILP (delayed_switch_frame
))
9372 KVAR (interrupted_kboard
, kbd_queue
)
9373 = Fcons (delayed_switch_frame
,
9374 KVAR (interrupted_kboard
, kbd_queue
));
9375 delayed_switch_frame
= Qnil
;
9379 KVAR (interrupted_kboard
, kbd_queue
)
9380 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9382 /* If the side queue is non-empty, ensure it begins with a
9383 switch-frame, so we'll replay it in the right context. */
9384 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9385 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9386 !(EVENT_HAS_PARAMETERS (key
)
9387 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9391 XSETFRAME (frame
, interrupted_frame
);
9392 KVAR (interrupted_kboard
, kbd_queue
)
9393 = Fcons (make_lispy_switch_frame (frame
),
9394 KVAR (interrupted_kboard
, kbd_queue
));
9397 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9398 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9399 goto replay_entire_sequence
;
9403 /* read_char returns t when it shows a menu and the user rejects it.
9407 unbind_to (count
, Qnil
);
9412 /* read_char returns -1 at the end of a macro.
9413 Emacs 18 handles this by returning immediately with a
9414 zero, so that's what we'll do. */
9415 if (INTEGERP (key
) && XINT (key
) == -1)
9418 /* The Microsoft C compiler can't handle the goto that
9424 /* If the current buffer has been changed from under us, the
9425 keymap may have changed, so replay the sequence. */
9428 timer_resume_idle ();
9431 /* Reset the current buffer from the selected window
9432 in case something changed the former and not the latter.
9433 This is to be more consistent with the behavior
9434 of the command_loop_1. */
9435 if (fix_current_buffer
)
9437 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9439 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9440 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9443 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9444 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9445 goto replay_sequence
;
9448 /* If we have a quit that was typed in another frame, and
9449 quit_throw_to_read_char switched buffers,
9450 replay to get the right keymap. */
9452 && XINT (key
) == quit_char
9453 && current_buffer
!= starting_buffer
)
9456 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9460 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9461 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9462 goto replay_sequence
;
9467 if (EVENT_HAS_PARAMETERS (key
)
9468 /* Either a `switch-frame' or a `select-window' event. */
9469 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9471 /* If we're at the beginning of a key sequence, and the caller
9472 says it's okay, go ahead and return this event. If we're
9473 in the midst of a key sequence, delay it until the end. */
9474 if (t
> 0 || !can_return_switch_frame
)
9476 delayed_switch_frame
= key
;
9482 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9486 /* Clicks in non-text areas get prefixed by the symbol
9487 in their CHAR-ADDRESS field. For example, a click on
9488 the mode line is prefixed by the symbol `mode-line'.
9490 Furthermore, key sequences beginning with mouse clicks
9491 are read using the keymaps of the buffer clicked on, not
9492 the current buffer. So we may have to switch the buffer
9495 When we turn one event into two events, we must make sure
9496 that neither of the two looks like the original--so that,
9497 if we replay the events, they won't be expanded again.
9498 If not for this, such reexpansion could happen either here
9499 or when user programs play with this-command-keys. */
9500 if (EVENT_HAS_PARAMETERS (key
))
9505 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9506 if (EQ (kind
, Qmouse_click
))
9508 Lisp_Object window
, posn
;
9510 window
= POSN_WINDOW (EVENT_START (key
));
9511 posn
= POSN_POSN (EVENT_START (key
));
9514 || (!NILP (fake_prefixed_keys
)
9515 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9517 /* We're looking a second time at an event for which
9518 we generated a fake prefix key. Set
9519 last_real_key_start appropriately. */
9521 last_real_key_start
= t
- 1;
9524 if (last_real_key_start
== 0)
9526 /* Key sequences beginning with mouse clicks are
9527 read using the keymaps in the buffer clicked on,
9528 not the current buffer. If we're at the
9529 beginning of a key sequence, switch buffers. */
9530 if (WINDOWP (window
)
9531 && BUFFERP (XWINDOW (window
)->buffer
)
9532 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9534 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9538 /* Arrange to go back to the original buffer once we're
9539 done reading the key sequence. Note that we can't
9540 use save_excursion_{save,restore} here, because they
9541 save point as well as the current buffer; we don't
9542 want to save point, because redisplay may change it,
9543 to accommodate a Fset_window_start or something. We
9544 don't want to do this at the top of the function,
9545 because we may get input from a subprocess which
9546 wants to change the selected window and stuff (say,
9548 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9550 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9552 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9553 orig_local_map
= get_local_map (PT
, current_buffer
,
9555 orig_keymap
= get_local_map (PT
, current_buffer
,
9557 goto replay_sequence
;
9560 /* For a mouse click, get the local text-property keymap
9561 of the place clicked on, rather than point. */
9562 if (CONSP (XCDR (key
))
9563 && ! localized_local_map
)
9565 Lisp_Object map_here
, start
, pos
;
9567 localized_local_map
= 1;
9568 start
= EVENT_START (key
);
9570 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9572 pos
= POSN_BUFFER_POSN (start
);
9574 && XINT (pos
) >= BEGV
9575 && XINT (pos
) <= ZV
)
9577 map_here
= get_local_map (XINT (pos
),
9580 if (!EQ (map_here
, orig_local_map
))
9582 orig_local_map
= map_here
;
9583 ++localized_local_map
;
9586 map_here
= get_local_map (XINT (pos
),
9589 if (!EQ (map_here
, orig_keymap
))
9591 orig_keymap
= map_here
;
9592 ++localized_local_map
;
9595 if (localized_local_map
> 1)
9600 goto replay_sequence
;
9607 /* Expand mode-line and scroll-bar events into two events:
9608 use posn as a fake prefix key. */
9610 && (NILP (fake_prefixed_keys
)
9611 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9613 if (bufsize
- t
<= 1)
9614 error ("Key sequence too long");
9617 keybuf
[t
+ 1] = key
;
9620 /* Record that a fake prefix key has been generated
9621 for KEY. Don't modify the event; this would
9622 prevent proper action when the event is pushed
9623 back into unread-command-events. */
9624 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9626 /* If on a mode line string with a local keymap,
9627 reconsider the key sequence with that keymap. */
9628 if (string
= POSN_STRING (EVENT_START (key
)),
9629 (CONSP (string
) && STRINGP (XCAR (string
))))
9631 Lisp_Object pos
, map
, map2
;
9633 pos
= XCDR (string
);
9634 string
= XCAR (string
);
9636 && XINT (pos
) < SCHARS (string
))
9638 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9640 orig_local_map
= map
;
9641 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9644 if (!NILP (map
) || !NILP (map2
))
9645 goto replay_sequence
;
9651 else if (NILP (from_string
)
9652 && (string
= POSN_STRING (EVENT_START (key
)),
9653 (CONSP (string
) && STRINGP (XCAR (string
)))))
9655 /* For a click on a string, i.e. overlay string or a
9656 string displayed via the `display' property,
9657 consider `local-map' and `keymap' properties of
9659 Lisp_Object pos
, map
, map2
;
9661 pos
= XCDR (string
);
9662 string
= XCAR (string
);
9664 && XINT (pos
) < SCHARS (string
))
9666 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9668 orig_local_map
= map
;
9669 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9673 if (!NILP (map
) || !NILP (map2
))
9675 from_string
= string
;
9678 goto replay_sequence
;
9683 else if (CONSP (XCDR (key
))
9684 && CONSP (EVENT_START (key
))
9685 && CONSP (XCDR (EVENT_START (key
))))
9689 posn
= POSN_POSN (EVENT_START (key
));
9690 /* Handle menu-bar events:
9691 insert the dummy prefix event `menu-bar'. */
9692 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9694 if (bufsize
- t
<= 1)
9695 error ("Key sequence too long");
9699 /* Zap the position in key, so we know that we've
9700 expanded it, and don't try to do so again. */
9701 POSN_SET_POSN (EVENT_START (key
),
9702 Fcons (posn
, Qnil
));
9705 goto replay_sequence
;
9707 else if (CONSP (posn
))
9709 /* We're looking at the second event of a
9710 sequence which we expanded before. Set
9711 last_real_key_start appropriately. */
9712 if (last_real_key_start
== t
&& t
> 0)
9713 last_real_key_start
= t
- 1;
9718 /* We have finally decided that KEY is something we might want
9720 first_binding
= (follow_key (key
,
9721 nmaps
- first_binding
,
9722 submaps
+ first_binding
,
9723 defs
+ first_binding
,
9724 submaps
+ first_binding
)
9727 /* If KEY wasn't bound, we'll try some fallbacks. */
9728 if (first_binding
< nmaps
)
9729 /* This is needed for the following scenario:
9730 event 0: a down-event that gets dropped by calling replay_key.
9731 event 1: some normal prefix like C-h.
9732 After event 0, first_unbound is 0, after event 1 indec.start,
9733 fkey.start, and keytran.start are all 1, so when we see that
9734 C-h is bound, we need to update first_unbound. */
9735 first_unbound
= max (t
+ 1, first_unbound
);
9740 /* Remember the position to put an upper bound on indec.start. */
9741 first_unbound
= min (t
, first_unbound
);
9743 head
= EVENT_HEAD (key
);
9744 if (help_char_p (head
) && t
> 0)
9746 read_key_sequence_cmd
= Vprefix_help_command
;
9748 last_nonmenu_event
= key
;
9749 /* The Microsoft C compiler can't handle the goto that
9757 Lisp_Object breakdown
;
9760 breakdown
= parse_modifiers (head
);
9761 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9762 /* Attempt to reduce an unbound mouse event to a simpler
9763 event that is bound:
9764 Drags reduce to clicks.
9765 Double-clicks reduce to clicks.
9766 Triple-clicks reduce to double-clicks, then to clicks.
9767 Down-clicks are eliminated.
9768 Double-downs reduce to downs, then are eliminated.
9769 Triple-downs reduce to double-downs, then to downs,
9770 then are eliminated. */
9771 if (modifiers
& (down_modifier
| drag_modifier
9772 | double_modifier
| triple_modifier
))
9774 while (modifiers
& (down_modifier
| drag_modifier
9775 | double_modifier
| triple_modifier
))
9777 Lisp_Object new_head
, new_click
;
9778 if (modifiers
& triple_modifier
)
9779 modifiers
^= (double_modifier
| triple_modifier
);
9780 else if (modifiers
& double_modifier
)
9781 modifiers
&= ~double_modifier
;
9782 else if (modifiers
& drag_modifier
)
9783 modifiers
&= ~drag_modifier
;
9786 /* Dispose of this `down' event by simply jumping
9787 back to replay_key, to get another event.
9789 Note that if this event came from mock input,
9790 then just jumping back to replay_key will just
9791 hand it to us again. So we have to wipe out any
9794 We could delete keybuf[t] and shift everything
9795 after that to the left by one spot, but we'd also
9796 have to fix up any variable that points into
9797 keybuf, and shifting isn't really necessary
9800 Adding prefixes for non-textual mouse clicks
9801 creates two characters of mock input, and both
9802 must be thrown away. If we're only looking at
9803 the prefix now, we can just jump back to
9804 replay_key. On the other hand, if we've already
9805 processed the prefix, and now the actual click
9806 itself is giving us trouble, then we've lost the
9807 state of the keymaps we want to backtrack to, and
9808 we need to replay the whole sequence to rebuild
9811 Beyond that, only function key expansion could
9812 create more than two keys, but that should never
9813 generate mouse events, so it's okay to zero
9814 mock_input in that case too.
9816 FIXME: The above paragraph seems just plain
9817 wrong, if you consider things like
9818 xterm-mouse-mode. -stef
9820 Isn't this just the most wonderful code ever? */
9822 /* If mock_input > t + 1, the above simplification
9823 will actually end up dropping keys on the floor.
9824 This is probably OK for now, but even
9825 if mock_input <= t + 1, we need to adjust indec,
9827 Typical case [header-line down-mouse-N]:
9828 mock_input = 2, t = 1, fkey.end = 1,
9829 last_real_key_start = 0. */
9830 if (indec
.end
> last_real_key_start
)
9832 indec
.end
= indec
.start
9833 = min (last_real_key_start
, indec
.start
);
9834 indec
.map
= indec
.parent
;
9835 if (fkey
.end
> last_real_key_start
)
9837 fkey
.end
= fkey
.start
9838 = min (last_real_key_start
, fkey
.start
);
9839 fkey
.map
= fkey
.parent
;
9840 if (keytran
.end
> last_real_key_start
)
9842 keytran
.end
= keytran
.start
9843 = min (last_real_key_start
, keytran
.start
);
9844 keytran
.map
= keytran
.parent
;
9848 if (t
== last_real_key_start
)
9855 mock_input
= last_real_key_start
;
9856 goto replay_sequence
;
9861 = apply_modifiers (modifiers
, XCAR (breakdown
));
9863 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9865 /* Look for a binding for this new key. follow_key
9866 promises that it didn't munge submaps the
9867 last time we called it, since key was unbound. */
9869 = (follow_key (new_click
,
9870 nmaps
- local_first_binding
,
9871 submaps
+ local_first_binding
,
9872 defs
+ local_first_binding
,
9873 submaps
+ local_first_binding
)
9874 + local_first_binding
);
9876 /* If that click is bound, go for it. */
9877 if (first_binding
< nmaps
)
9882 /* Otherwise, we'll leave key set to the drag event. */
9889 /* Normally, last_nonmenu_event gets the previous key we read.
9890 But when a mouse popup menu is being used,
9891 we don't update last_nonmenu_event; it continues to hold the mouse
9892 event that preceded the first level of menu. */
9893 if (!used_mouse_menu
)
9894 last_nonmenu_event
= key
;
9896 /* Record what part of this_command_keys is the current key sequence. */
9897 this_single_command_key_start
= this_command_key_count
- t
;
9899 /* Look for this sequence in input-decode-map.
9900 Scan from indec.end until we find a bound suffix. */
9901 while (indec
.end
< t
)
9903 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9906 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9907 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9912 mock_input
= diff
+ max (t
, mock_input
);
9913 goto replay_sequence
;
9917 if (first_binding
< nmaps
9918 && NILP (submaps
[first_binding
])
9919 && !test_undefined (defs
[first_binding
])
9920 && indec
.start
>= t
)
9921 /* There is a binding and it's not a prefix.
9922 (and it doesn't have any input-decode-map translation pending).
9923 There is thus no function-key in this sequence.
9924 Moving fkey.start is important in this case to allow keytran.start
9925 to go over the sequence before we return (since we keep the
9926 invariant that keytran.end <= fkey.start). */
9929 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9932 /* If the sequence is unbound, see if we can hang a function key
9933 off the end of it. */
9934 /* Continue scan from fkey.end until we find a bound suffix. */
9935 while (fkey
.end
< indec
.start
)
9937 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9940 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9941 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9942 max (t
, mock_input
),
9943 /* If there's a binding (i.e.
9944 first_binding >= nmaps) we don't want
9945 to apply this function-key-mapping. */
9947 && (first_binding
>= nmaps
9948 || test_undefined (defs
[first_binding
])),
9953 mock_input
= diff
+ max (t
, mock_input
);
9954 /* Adjust the input-decode-map counters. */
9956 indec
.start
+= diff
;
9958 goto replay_sequence
;
9962 /* Look for this sequence in key-translation-map.
9963 Scan from keytran.end until we find a bound suffix. */
9964 while (keytran
.end
< fkey
.start
)
9966 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9969 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9970 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9975 mock_input
= diff
+ max (t
, mock_input
);
9976 /* Adjust the function-key-map and input-decode-map counters. */
9978 indec
.start
+= diff
;
9982 goto replay_sequence
;
9986 /* If KEY is not defined in any of the keymaps,
9987 and cannot be part of a function key or translation,
9988 and is an upper case letter
9989 use the corresponding lower-case letter instead. */
9990 if (first_binding
>= nmaps
9991 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9993 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9994 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9995 || (XINT (key
) & shift_modifier
)))
9997 Lisp_Object new_key
;
9999 original_uppercase
= key
;
10000 original_uppercase_position
= t
- 1;
10002 if (XINT (key
) & shift_modifier
)
10003 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10005 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10006 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10008 /* We have to do this unconditionally, regardless of whether
10009 the lower-case char is defined in the keymaps, because they
10010 might get translated through function-key-map. */
10011 keybuf
[t
- 1] = new_key
;
10012 mock_input
= max (t
, mock_input
);
10013 shift_translated
= 1;
10015 goto replay_sequence
;
10017 /* If KEY is not defined in any of the keymaps,
10018 and cannot be part of a function key or translation,
10019 and is a shifted function key,
10020 use the corresponding unshifted function key instead. */
10021 if (first_binding
>= nmaps
10022 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10024 Lisp_Object breakdown
= parse_modifiers (key
);
10026 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10028 if (modifiers
& shift_modifier
10029 /* Treat uppercase keys as shifted. */
10031 && (KEY_TO_CHAR (key
)
10032 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10033 && uppercasep (KEY_TO_CHAR (key
))))
10035 Lisp_Object new_key
10036 = (modifiers
& shift_modifier
10037 ? apply_modifiers (modifiers
& ~shift_modifier
,
10039 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10041 original_uppercase
= key
;
10042 original_uppercase_position
= t
- 1;
10044 /* We have to do this unconditionally, regardless of whether
10045 the lower-case char is defined in the keymaps, because they
10046 might get translated through function-key-map. */
10047 keybuf
[t
- 1] = new_key
;
10048 mock_input
= max (t
, mock_input
);
10049 /* Reset fkey (and consequently keytran) to apply
10050 function-key-map on the result, so that S-backspace is
10051 correctly mapped to DEL (via backspace). OTOH,
10052 input-decode-map doesn't need to go through it again. */
10053 fkey
.start
= fkey
.end
= 0;
10054 keytran
.start
= keytran
.end
= 0;
10055 shift_translated
= 1;
10057 goto replay_sequence
;
10062 read_key_sequence_cmd
= (first_binding
< nmaps
10063 ? defs
[first_binding
]
10065 read_key_sequence_remapped
10066 /* Remap command through active keymaps.
10067 Do the remapping here, before the unbind_to so it uses the keymaps
10068 of the appropriate buffer. */
10069 = SYMBOLP (read_key_sequence_cmd
)
10070 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10073 unread_switch_frame
= delayed_switch_frame
;
10074 unbind_to (count
, Qnil
);
10076 /* Don't downcase the last character if the caller says don't.
10077 Don't downcase it if the result is undefined, either. */
10078 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10080 && t
- 1 == original_uppercase_position
)
10082 keybuf
[t
- 1] = original_uppercase
;
10083 shift_translated
= 0;
10086 if (shift_translated
)
10087 Vthis_command_keys_shift_translated
= Qt
;
10089 /* Occasionally we fabricate events, perhaps by expanding something
10090 according to function-key-map, or by adding a prefix symbol to a
10091 mouse click in the scroll bar or modeline. In this cases, return
10092 the entire generated key sequence, even if we hit an unbound
10093 prefix or a definition before the end. This means that you will
10094 be able to push back the event properly, and also means that
10095 read-key-sequence will always return a logical unit.
10098 for (; t
< mock_input
; t
++)
10100 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10101 && NILP (Fzerop (Vecho_keystrokes
)))
10102 echo_char (keybuf
[t
]);
10103 add_command_key (keybuf
[t
]);
10110 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10111 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10112 The sequence is sufficient to specify a non-prefix command in the
10113 current local and global maps.
10115 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10116 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10117 as a continuation of the previous key.
10119 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10120 convert the last event to lower case. (Normally any upper case event
10121 is converted to lower case if the original event is undefined and the lower
10122 case equivalent is defined.) A non-nil value is appropriate for reading
10123 a key sequence to be defined.
10125 A C-g typed while in this function is treated like any other character,
10126 and `quit-flag' is not set.
10128 If the key sequence starts with a mouse click, then the sequence is read
10129 using the keymaps of the buffer of the window clicked in, not the buffer
10130 of the selected window as normal.
10132 `read-key-sequence' drops unbound button-down events, since you normally
10133 only care about the click or drag events which follow them. If a drag
10134 or multi-click event is unbound, but the corresponding click event would
10135 be bound, `read-key-sequence' turns the event into a click event at the
10136 drag's starting position. This means that you don't have to distinguish
10137 between click and drag, double, or triple events unless you want to.
10139 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10140 lines separating windows, and scroll bars with imaginary keys
10141 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10143 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10144 function will process a switch-frame event if the user switches frames
10145 before typing anything. If the user switches frames in the middle of a
10146 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10147 is nil, then the event will be put off until after the current key sequence.
10149 `read-key-sequence' checks `function-key-map' for function key
10150 sequences, where they wouldn't conflict with ordinary bindings. See
10151 `function-key-map' for more details.
10153 The optional fifth argument CMD-LOOP, if non-nil, means
10154 that this key sequence is being read by something that will
10155 read commands one after another. It should be nil if the caller
10156 will read just one key sequence. */)
10157 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10159 Lisp_Object keybuf
[30];
10161 struct gcpro gcpro1
;
10162 int count
= SPECPDL_INDEX ();
10164 if (!NILP (prompt
))
10165 CHECK_STRING (prompt
);
10168 specbind (Qinput_method_exit_on_first_char
,
10169 (NILP (cmd_loop
) ? Qt
: Qnil
));
10170 specbind (Qinput_method_use_echo_area
,
10171 (NILP (cmd_loop
) ? Qt
: Qnil
));
10173 memset (keybuf
, 0, sizeof keybuf
);
10174 GCPRO1 (keybuf
[0]);
10175 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10177 if (NILP (continue_echo
))
10179 this_command_key_count
= 0;
10180 this_command_key_count_reset
= 0;
10181 this_single_command_key_start
= 0;
10184 #ifdef HAVE_WINDOW_SYSTEM
10185 if (display_hourglass_p
)
10186 cancel_hourglass ();
10189 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10190 prompt
, ! NILP (dont_downcase_last
),
10191 ! NILP (can_return_switch_frame
), 0);
10193 #if 0 /* The following is fine for code reading a key sequence and
10194 then proceeding with a lengthy computation, but it's not good
10195 for code reading keys in a loop, like an input method. */
10196 #ifdef HAVE_WINDOW_SYSTEM
10197 if (display_hourglass_p
)
10198 start_hourglass ();
10208 return unbind_to (count
, make_event_array (i
, keybuf
));
10211 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10212 Sread_key_sequence_vector
, 1, 5, 0,
10213 doc
: /* Like `read-key-sequence' but always return a vector. */)
10214 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10216 Lisp_Object keybuf
[30];
10218 struct gcpro gcpro1
;
10219 int count
= SPECPDL_INDEX ();
10221 if (!NILP (prompt
))
10222 CHECK_STRING (prompt
);
10225 specbind (Qinput_method_exit_on_first_char
,
10226 (NILP (cmd_loop
) ? Qt
: Qnil
));
10227 specbind (Qinput_method_use_echo_area
,
10228 (NILP (cmd_loop
) ? Qt
: Qnil
));
10230 memset (keybuf
, 0, sizeof keybuf
);
10231 GCPRO1 (keybuf
[0]);
10232 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10234 if (NILP (continue_echo
))
10236 this_command_key_count
= 0;
10237 this_command_key_count_reset
= 0;
10238 this_single_command_key_start
= 0;
10241 #ifdef HAVE_WINDOW_SYSTEM
10242 if (display_hourglass_p
)
10243 cancel_hourglass ();
10246 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10247 prompt
, ! NILP (dont_downcase_last
),
10248 ! NILP (can_return_switch_frame
), 0);
10250 #ifdef HAVE_WINDOW_SYSTEM
10251 if (display_hourglass_p
)
10252 start_hourglass ();
10261 return unbind_to (count
, Fvector (i
, keybuf
));
10264 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10265 doc
: /* Execute CMD as an editor command.
10266 CMD must be a symbol that satisfies the `commandp' predicate.
10267 Optional second arg RECORD-FLAG non-nil
10268 means unconditionally put this command in `command-history'.
10269 Otherwise, that is done only if an arg is read using the minibuffer.
10270 The argument KEYS specifies the value to use instead of (this-command-keys)
10271 when reading the arguments; if it is nil, (this-command-keys) is used.
10272 The argument SPECIAL, if non-nil, means that this command is executing
10273 a special event, so ignore the prefix argument and don't clear it. */)
10274 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10276 register Lisp_Object final
;
10277 register Lisp_Object tem
;
10278 Lisp_Object prefixarg
;
10280 debug_on_next_call
= 0;
10282 if (NILP (special
))
10284 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10285 Vcurrent_prefix_arg
= prefixarg
;
10286 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10293 tem
= Fget (cmd
, Qdisabled
);
10296 tem
= Fsymbol_value (Qdisabled_command_function
);
10298 return Frun_hooks (1, &Qdisabled_command_function
);
10304 final
= Findirect_function (cmd
, Qnil
);
10306 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10308 struct gcpro gcpro1
, gcpro2
;
10310 GCPRO2 (cmd
, prefixarg
);
10311 do_autoload (final
, cmd
);
10318 if (STRINGP (final
) || VECTORP (final
))
10320 /* If requested, place the macro in the command history. For
10321 other sorts of commands, call-interactively takes care of
10323 if (!NILP (record_flag
))
10326 = Fcons (Fcons (Qexecute_kbd_macro
,
10327 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10330 /* Don't keep command history around forever. */
10331 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10333 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10335 XSETCDR (tem
, Qnil
);
10339 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10342 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10343 /* Don't call Fcall_interactively directly because we want to make
10344 sure the backtrace has an entry for `call-interactively'.
10345 For the same reason, pass `cmd' rather than `final'. */
10346 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10353 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10355 doc
: /* Read function name, then read its arguments and call it.
10357 To pass a numeric argument to the command you are invoking with, specify
10358 the numeric argument to this command.
10360 Noninteractively, the argument PREFIXARG is the prefix argument to
10361 give to the command you invoke, if it asks for an argument. */)
10362 (Lisp_Object prefixarg
)
10364 Lisp_Object function
;
10365 EMACS_INT saved_last_point_position
;
10366 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10367 Lisp_Object bindings
, value
;
10368 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10369 #ifdef HAVE_WINDOW_SYSTEM
10370 /* The call to Fcompleting_read will start and cancel the hourglass,
10371 but if the hourglass was already scheduled, this means that no
10372 hourglass will be shown for the actual M-x command itself.
10373 So we restart it if it is already scheduled. Note that checking
10374 hourglass_shown_p is not enough, normally the hourglass is not shown,
10375 just scheduled to be shown. */
10376 int hstarted
= hourglass_started ();
10379 saved_keys
= Fvector (this_command_key_count
,
10380 XVECTOR (this_command_keys
)->contents
);
10381 saved_last_point_position_buffer
= last_point_position_buffer
;
10382 saved_last_point_position
= last_point_position
;
10383 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10385 function
= call0 (intern ("read-extended-command"));
10387 #ifdef HAVE_WINDOW_SYSTEM
10388 if (hstarted
) start_hourglass ();
10391 if (STRINGP (function
) && SCHARS (function
) == 0)
10392 error ("No command name given");
10394 /* Set this_command_keys to the concatenation of saved_keys and
10395 function, followed by a RET. */
10400 this_command_key_count
= 0;
10401 this_command_key_count_reset
= 0;
10402 this_single_command_key_start
= 0;
10404 keys
= XVECTOR (saved_keys
)->contents
;
10405 for (i
= 0; i
< ASIZE (saved_keys
); i
++)
10406 add_command_key (keys
[i
]);
10408 for (i
= 0; i
< SCHARS (function
); i
++)
10409 add_command_key (Faref (function
, make_number (i
)));
10411 add_command_key (make_number ('\015'));
10414 last_point_position
= saved_last_point_position
;
10415 last_point_position_buffer
= saved_last_point_position_buffer
;
10419 function
= Fintern (function
, Qnil
);
10420 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10421 Vthis_command
= function
;
10422 real_this_command
= function
;
10424 /* If enabled, show which key runs this command. */
10425 if (!NILP (Vsuggest_key_bindings
)
10426 && NILP (Vexecuting_kbd_macro
)
10427 && SYMBOLP (function
))
10428 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10434 GCPRO3 (bindings
, value
, function
);
10435 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10437 /* If the command has a key binding, print it now. */
10438 if (!NILP (bindings
)
10439 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10442 /* But first wait, and skip the message if there is input. */
10443 Lisp_Object waited
;
10445 /* If this command displayed something in the echo area;
10446 wait a few seconds, then display our suggestion message. */
10447 if (NILP (echo_area_buffer
[0]))
10448 waited
= sit_for (make_number (0), 0, 2);
10449 else if (NUMBERP (Vsuggest_key_bindings
))
10450 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10452 waited
= sit_for (make_number (2), 0, 2);
10454 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10456 Lisp_Object binding
;
10458 int message_p
= push_message ();
10459 int count
= SPECPDL_INDEX ();
10460 ptrdiff_t newmessage_len
, newmessage_alloc
;
10463 record_unwind_protect (pop_message_unwind
, Qnil
);
10464 binding
= Fkey_description (bindings
, Qnil
);
10466 (sizeof "You can run the command `' with "
10467 + SBYTES (SYMBOL_NAME (function
)) + SBYTES (binding
));
10468 SAFE_ALLOCA (newmessage
, char *, newmessage_alloc
);
10470 esprintf (newmessage
, "You can run the command `%s' with %s",
10471 SDATA (SYMBOL_NAME (function
)),
10473 message2 (newmessage
,
10475 STRING_MULTIBYTE (binding
));
10476 if (NUMBERP (Vsuggest_key_bindings
))
10477 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10479 waited
= sit_for (make_number (2), 0, 2);
10481 if (!NILP (waited
) && message_p
)
10482 restore_message ();
10485 unbind_to (count
, Qnil
);
10489 RETURN_UNGCPRO (value
);
10493 /* Return nonzero if input events are pending. */
10496 detect_input_pending (void)
10498 if (!input_pending
)
10499 get_input_pending (&input_pending
, 0);
10501 return input_pending
;
10504 /* Return nonzero if input events other than mouse movements are
10508 detect_input_pending_ignore_squeezables (void)
10510 if (!input_pending
)
10511 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10513 return input_pending
;
10516 /* Return nonzero if input events are pending, and run any pending timers. */
10519 detect_input_pending_run_timers (int do_display
)
10521 int old_timers_run
= timers_run
;
10523 if (!input_pending
)
10524 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10526 if (old_timers_run
!= timers_run
&& do_display
)
10528 redisplay_preserve_echo_area (8);
10529 /* The following fixes a bug when using lazy-lock with
10530 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10531 from an idle timer function. The symptom of the bug is that
10532 the cursor sometimes doesn't become visible until the next X
10533 event is processed. --gerd. */
10535 Lisp_Object tail
, frame
;
10536 FOR_EACH_FRAME (tail
, frame
)
10537 if (FRAME_RIF (XFRAME (frame
)))
10538 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10542 return input_pending
;
10545 /* This is called in some cases before a possible quit.
10546 It cases the next call to detect_input_pending to recompute input_pending.
10547 So calling this function unnecessarily can't do any harm. */
10550 clear_input_pending (void)
10555 /* Return nonzero if there are pending requeued events.
10556 This isn't used yet. The hope is to make wait_reading_process_output
10557 call it, and return if it runs Lisp code that unreads something.
10558 The problem is, kbd_buffer_get_event needs to be fixed to know what
10559 to do in that case. It isn't trivial. */
10562 requeued_events_pending_p (void)
10564 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10568 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10569 doc
: /* Return t if command input is currently available with no wait.
10570 Actually, the value is nil only if we can be sure that no input is available;
10571 if there is a doubt, the value is t. */)
10574 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10575 || !NILP (Vunread_post_input_method_events
)
10576 || !NILP (Vunread_input_method_events
))
10579 /* Process non-user-visible events (Bug#10195). */
10580 process_special_events ();
10582 get_input_pending (&input_pending
,
10583 READABLE_EVENTS_DO_TIMERS_NOW
10584 | READABLE_EVENTS_FILTER_EVENTS
);
10585 return input_pending
> 0 ? Qt
: Qnil
;
10588 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10589 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10592 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10595 if (total_keys
< NUM_RECENT_KEYS
)
10596 return Fvector (total_keys
, keys
);
10599 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10600 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10601 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10602 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10603 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10608 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10609 doc
: /* Return the key sequence that invoked this command.
10610 However, if the command has called `read-key-sequence', it returns
10611 the last key sequence that has been read.
10612 The value is a string or a vector.
10614 See also `this-command-keys-vector'. */)
10617 return make_event_array (this_command_key_count
,
10618 XVECTOR (this_command_keys
)->contents
);
10621 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10622 doc
: /* Return the key sequence that invoked this command, as a vector.
10623 However, if the command has called `read-key-sequence', it returns
10624 the last key sequence that has been read.
10626 See also `this-command-keys'. */)
10629 return Fvector (this_command_key_count
,
10630 XVECTOR (this_command_keys
)->contents
);
10633 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10634 Sthis_single_command_keys
, 0, 0, 0,
10635 doc
: /* Return the key sequence that invoked this command.
10636 More generally, it returns the last key sequence read, either by
10637 the command loop or by `read-key-sequence'.
10638 Unlike `this-command-keys', this function's value
10639 does not include prefix arguments.
10640 The value is always a vector. */)
10643 return Fvector (this_command_key_count
10644 - this_single_command_key_start
,
10645 (XVECTOR (this_command_keys
)->contents
10646 + this_single_command_key_start
));
10649 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10650 Sthis_single_command_raw_keys
, 0, 0, 0,
10651 doc
: /* Return the raw events that were read for this command.
10652 More generally, it returns the last key sequence read, either by
10653 the command loop or by `read-key-sequence'.
10654 Unlike `this-single-command-keys', this function's value
10655 shows the events before all translations (except for input methods).
10656 The value is always a vector. */)
10659 return Fvector (raw_keybuf_count
,
10660 (XVECTOR (raw_keybuf
)->contents
));
10663 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10664 Sreset_this_command_lengths
, 0, 0, 0,
10665 doc
: /* Make the unread events replace the last command and echo.
10666 Used in `universal-argument-other-key'.
10668 `universal-argument-other-key' rereads the event just typed.
10669 It then gets translated through `function-key-map'.
10670 The translated event has to replace the real events,
10671 both in the value of (this-command-keys) and in echoing.
10672 To achieve this, `universal-argument-other-key' calls
10673 `reset-this-command-lengths', which discards the record of reading
10674 these events the first time. */)
10677 this_command_key_count
= before_command_key_count
;
10678 if (this_command_key_count
< this_single_command_key_start
)
10679 this_single_command_key_start
= this_command_key_count
;
10681 echo_truncate (before_command_echo_length
);
10683 /* Cause whatever we put into unread-command-events
10684 to echo as if it were being freshly read from the keyboard. */
10685 this_command_key_count_reset
= 1;
10690 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10691 Sclear_this_command_keys
, 0, 1, 0,
10692 doc
: /* Clear out the vector that `this-command-keys' returns.
10693 Also clear the record of the last 100 events, unless optional arg
10694 KEEP-RECORD is non-nil. */)
10695 (Lisp_Object keep_record
)
10699 this_command_key_count
= 0;
10700 this_command_key_count_reset
= 0;
10702 if (NILP (keep_record
))
10704 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10705 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10707 recent_keys_index
= 0;
10712 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10713 doc
: /* Return the current depth in recursive edits. */)
10717 /* Wrap around reliably on integer overflow. */
10718 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10719 XSETINT (temp
, sum
);
10723 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10724 "FOpen dribble file: ",
10725 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10726 If FILE is nil, close any open dribble file.
10727 The file will be closed when Emacs exits. */)
10739 file
= Fexpand_file_name (file
, Qnil
);
10740 dribble
= fopen (SSDATA (file
), "w");
10742 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10747 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10748 doc
: /* Discard the contents of the terminal input buffer.
10749 Also end any kbd macro being defined. */)
10752 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10754 /* Discard the last command from the macro. */
10755 Fcancel_kbd_macro_events ();
10759 update_mode_lines
++;
10761 Vunread_command_events
= Qnil
;
10762 unread_command_char
= -1;
10764 discard_tty_input ();
10766 kbd_fetch_ptr
= kbd_store_ptr
;
10772 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10773 doc
: /* Stop Emacs and return to superior process. You can resume later.
10774 If `cannot-suspend' is non-nil, or if the system doesn't support job
10775 control, run a subshell instead.
10777 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10778 to be read as terminal input by Emacs's parent, after suspension.
10780 Before suspending, run the normal hook `suspend-hook'.
10781 After resumption run the normal hook `suspend-resume-hook'.
10783 Some operating systems cannot stop the Emacs process and resume it later.
10784 On such systems, Emacs starts a subshell instead of suspending. */)
10785 (Lisp_Object stuffstring
)
10787 int count
= SPECPDL_INDEX ();
10788 int old_height
, old_width
;
10790 struct gcpro gcpro1
;
10793 if (tty_list
&& tty_list
->next
)
10794 error ("There are other tty frames open; close them before suspending Emacs");
10796 if (!NILP (stuffstring
))
10797 CHECK_STRING (stuffstring
);
10799 /* Run the functions in suspend-hook. */
10800 hook
= intern ("suspend-hook");
10801 Frun_hooks (1, &hook
);
10803 GCPRO1 (stuffstring
);
10804 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10805 reset_all_sys_modes ();
10806 /* sys_suspend can get an error if it tries to fork a subshell
10807 and the system resources aren't available for that. */
10808 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10810 stuff_buffered_input (stuffstring
);
10811 if (cannot_suspend
)
10815 unbind_to (count
, Qnil
);
10817 /* Check if terminal/window size has changed.
10818 Note that this is not useful when we are running directly
10819 with a window system; but suspend should be disabled in that case. */
10820 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10821 if (width
!= old_width
|| height
!= old_height
)
10822 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10824 /* Run suspend-resume-hook. */
10825 hook
= intern ("suspend-resume-hook");
10826 Frun_hooks (1, &hook
);
10832 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10833 Then in any case stuff anything Emacs has read ahead and not used. */
10836 stuff_buffered_input (Lisp_Object stuffstring
)
10838 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10839 register unsigned char *p
;
10841 if (STRINGP (stuffstring
))
10843 register EMACS_INT count
;
10845 p
= SDATA (stuffstring
);
10846 count
= SBYTES (stuffstring
);
10847 while (count
-- > 0)
10852 /* Anything we have read ahead, put back for the shell to read. */
10853 /* ?? What should this do when we have multiple keyboards??
10854 Should we ignore anything that was typed in at the "wrong" kboard?
10856 rms: we should stuff everything back into the kboard
10858 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10861 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10862 kbd_fetch_ptr
= kbd_buffer
;
10863 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10864 stuff_char (kbd_fetch_ptr
->code
);
10866 clear_event (kbd_fetch_ptr
);
10870 #endif /* SIGTSTP */
10874 set_waiting_for_input (struct timeval
*time_to_clear
)
10876 input_available_clear_time
= time_to_clear
;
10878 /* Tell handle_interrupt to throw back to read_char, */
10879 waiting_for_input
= 1;
10881 /* If handle_interrupt was called before and buffered a C-g,
10882 make it run again now, to avoid timing error. */
10883 if (!NILP (Vquit_flag
))
10884 quit_throw_to_read_char (0);
10888 clear_waiting_for_input (void)
10890 /* Tell handle_interrupt not to throw back to read_char, */
10891 waiting_for_input
= 0;
10892 input_available_clear_time
= 0;
10895 /* The SIGINT handler.
10897 If we have a frame on the controlling tty, we assume that the
10898 SIGINT was generated by C-g, so we call handle_interrupt.
10899 Otherwise, tell QUIT to kill Emacs. */
10902 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10903 /* compilers complain in signal calls. */
10905 /* Must preserve main program's value of errno. */
10906 int old_errno
= errno
;
10907 struct terminal
*terminal
;
10909 SIGNAL_THREAD_CHECK (signalnum
);
10911 /* See if we have an active terminal on our controlling tty. */
10912 terminal
= get_named_tty ("/dev/tty");
10915 /* If there are no frames there, let's pretend that we are a
10916 well-behaving UN*X program and quit. We must not call Lisp
10917 in a signal handler, so tell QUIT to exit when it is
10919 Vquit_flag
= Qkill_emacs
;
10923 /* Otherwise, the SIGINT was probably generated by C-g. */
10925 /* Set internal_last_event_frame to the top frame of the
10926 controlling tty, if we have a frame there. We disable the
10927 interrupt key on secondary ttys, so the SIGINT must have come
10928 from the controlling tty. */
10929 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10931 handle_interrupt ();
10937 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10938 of the number of times C-g has been requested. If C-g is pressed
10939 enough times, then quit anyway. See bug#6585. */
10940 static int force_quit_count
;
10942 /* This routine is called at interrupt level in response to C-g.
10944 It is called from the SIGINT handler or kbd_buffer_store_event.
10946 If `waiting_for_input' is non zero, then unless `echoing' is
10947 nonzero, immediately throw back to read_char.
10949 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10950 eval to throw, when it gets a chance. If quit-flag is already
10951 non-nil, it stops the job right away. */
10954 handle_interrupt (void)
10960 /* XXX This code needs to be revised for multi-tty support. */
10961 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10963 /* If SIGINT isn't blocked, don't let us be interrupted by
10964 another SIGINT, it might be harmful due to non-reentrancy
10965 in I/O functions. */
10966 sigblock (sigmask (SIGINT
));
10969 reset_all_sys_modes ();
10971 #ifdef SIGTSTP /* Support possible in later USG versions */
10973 * On systems which can suspend the current process and return to the original
10974 * shell, this command causes the user to end up back at the shell.
10975 * The "Auto-save" and "Abort" questions are not asked until
10976 * the user elects to return to emacs, at which point he can save the current
10977 * job and either dump core or continue.
10981 /* Perhaps should really fork an inferior shell?
10982 But that would not provide any way to get back
10983 to the original shell, ever. */
10984 printf ("No support for stopping a process on this operating system;\n");
10985 printf ("you can continue or abort.\n");
10986 #endif /* not SIGTSTP */
10988 /* We must remain inside the screen area when the internal terminal
10989 is used. Note that [Enter] is not echoed by dos. */
10990 cursor_to (SELECTED_FRAME (), 0, 0);
10992 /* It doesn't work to autosave while GC is in progress;
10993 the code used for auto-saving doesn't cope with the mark bit. */
10994 if (!gc_in_progress
)
10996 printf ("Auto-save? (y or n) ");
10998 if (((c
= getchar ()) & ~040) == 'Y')
11000 Fdo_auto_save (Qt
, Qnil
);
11002 printf ("\r\nAuto-save done");
11003 #else /* not MSDOS */
11004 printf ("Auto-save done\n");
11005 #endif /* not MSDOS */
11007 while (c
!= '\n') c
= getchar ();
11011 /* During GC, it must be safe to reenable quitting again. */
11012 Vinhibit_quit
= Qnil
;
11015 #endif /* not MSDOS */
11016 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11017 printf ("but will instead do a real quit after garbage collection ends\r\n");
11022 printf ("\r\nAbort? (y or n) ");
11023 #else /* not MSDOS */
11024 printf ("Abort (and dump core)? (y or n) ");
11025 #endif /* not MSDOS */
11027 if (((c
= getchar ()) & ~040) == 'Y')
11029 while (c
!= '\n') c
= getchar ();
11031 printf ("\r\nContinuing...\r\n");
11032 #else /* not MSDOS */
11033 printf ("Continuing...\n");
11034 #endif /* not MSDOS */
11036 init_all_sys_modes ();
11041 /* If executing a function that wants to be interrupted out of
11042 and the user has not deferred quitting by binding `inhibit-quit'
11043 then quit right away. */
11044 if (immediate_quit
&& NILP (Vinhibit_quit
))
11046 struct gl_state_s saved
;
11047 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11049 immediate_quit
= 0;
11052 GCPRO4 (saved
.object
, saved
.global_code
,
11053 saved
.current_syntax_table
, saved
.old_prop
);
11054 Fsignal (Qquit
, Qnil
);
11055 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11060 { /* Else request quit when it's safe. */
11061 if (NILP (Vquit_flag
))
11062 force_quit_count
= 0;
11063 if (++force_quit_count
== 3)
11065 immediate_quit
= 1;
11066 Vinhibit_quit
= Qnil
;
11072 /* TODO: The longjmp in this call throws the NS event loop integration off,
11073 and it seems to do fine without this. Probably some attention
11074 needs to be paid to the setting of waiting_for_input in
11075 wait_reading_process_output() under HAVE_NS because of the call
11076 to ns_select there (needed because otherwise events aren't picked up
11077 outside of polling since we don't get SIGIO like X and we don't have a
11078 separate event loop thread like W32. */
11080 if (waiting_for_input
&& !echoing
)
11081 quit_throw_to_read_char (1);
11085 /* Handle a C-g by making read_char return C-g. */
11088 quit_throw_to_read_char (int from_signal
)
11090 /* When not called from a signal handler it is safe to call
11092 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
11093 Fkill_emacs (Qnil
);
11096 /* Prevent another signal from doing this before we finish. */
11097 clear_waiting_for_input ();
11100 Vunread_command_events
= Qnil
;
11101 unread_command_char
= -1;
11103 #if 0 /* Currently, sit_for is called from read_char without turning
11104 off polling. And that can call set_waiting_for_input.
11105 It seems to be harmless. */
11106 #ifdef POLL_FOR_INPUT
11107 /* May be > 1 if in recursive minibuffer. */
11108 if (poll_suppress_count
== 0)
11112 if (FRAMEP (internal_last_event_frame
)
11113 && !EQ (internal_last_event_frame
, selected_frame
))
11114 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11117 _longjmp (getcjmp
, 1);
11120 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
11121 Sset_input_interrupt_mode
, 1, 1, 0,
11122 doc
: /* Set interrupt mode of reading keyboard input.
11123 If INTERRUPT is non-nil, Emacs will use input interrupts;
11124 otherwise Emacs uses CBREAK mode.
11126 See also `current-input-mode'. */)
11127 (Lisp_Object interrupt
)
11129 int new_interrupt_input
;
11131 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11132 #ifdef HAVE_X_WINDOWS
11133 if (x_display_list
!= NULL
)
11135 /* When using X, don't give the user a real choice,
11136 because we haven't implemented the mechanisms to support it. */
11137 new_interrupt_input
= 1;
11140 #endif /* HAVE_X_WINDOWS */
11141 new_interrupt_input
= !NILP (interrupt
);
11142 #else /* not SIGIO */
11143 new_interrupt_input
= 0;
11144 #endif /* not SIGIO */
11146 if (new_interrupt_input
!= interrupt_input
)
11148 #ifdef POLL_FOR_INPUT
11152 /* this causes startup screen to be restored and messes with the mouse */
11153 reset_all_sys_modes ();
11154 interrupt_input
= new_interrupt_input
;
11155 init_all_sys_modes ();
11157 interrupt_input
= new_interrupt_input
;
11160 #ifdef POLL_FOR_INPUT
11161 poll_suppress_count
= 1;
11168 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11169 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11170 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11171 C-q in key sequences.
11173 This setting only has an effect on tty terminals and only when
11174 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11176 See also `current-input-mode'. */)
11177 (Lisp_Object flow
, Lisp_Object terminal
)
11179 struct terminal
*t
= get_terminal (terminal
, 1);
11180 struct tty_display_info
*tty
;
11181 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11183 tty
= t
->display_info
.tty
;
11185 if (tty
->flow_control
!= !NILP (flow
))
11188 /* this causes startup screen to be restored and messes with the mouse */
11189 reset_sys_modes (tty
);
11192 tty
->flow_control
= !NILP (flow
);
11195 init_sys_modes (tty
);
11201 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11202 doc
: /* Enable or disable 8-bit input on TERMINAL.
11203 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11204 bit as the Meta modifier.
11206 If META is nil, Emacs will ignore the top bit, on the assumption it is
11209 Otherwise, Emacs will accept and pass through 8-bit input without
11210 specially interpreting the top bit.
11212 This setting only has an effect on tty terminal devices.
11214 Optional parameter TERMINAL specifies the tty terminal device to use.
11215 It may be a terminal object, a frame, or nil for the terminal used by
11216 the currently selected frame.
11218 See also `current-input-mode'. */)
11219 (Lisp_Object meta
, Lisp_Object terminal
)
11221 struct terminal
*t
= get_terminal (terminal
, 1);
11222 struct tty_display_info
*tty
;
11225 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11227 tty
= t
->display_info
.tty
;
11231 else if (EQ (meta
, Qt
))
11236 if (tty
->meta_key
!= new_meta
)
11239 /* this causes startup screen to be restored and messes with the mouse */
11240 reset_sys_modes (tty
);
11243 tty
->meta_key
= new_meta
;
11246 init_sys_modes (tty
);
11252 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11253 doc
: /* Specify character used for quitting.
11254 QUIT must be an ASCII character.
11256 This function only has an effect on the controlling tty of the Emacs
11259 See also `current-input-mode'. */)
11262 struct terminal
*t
= get_named_tty ("/dev/tty");
11263 struct tty_display_info
*tty
;
11264 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11266 tty
= t
->display_info
.tty
;
11268 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11269 error ("QUIT must be an ASCII character");
11272 /* this causes startup screen to be restored and messes with the mouse */
11273 reset_sys_modes (tty
);
11276 /* Don't let this value be out of range. */
11277 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11280 init_sys_modes (tty
);
11286 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11287 doc
: /* Set mode of reading keyboard input.
11288 First arg INTERRUPT non-nil means use input interrupts;
11289 nil means use CBREAK mode.
11290 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11291 (no effect except in CBREAK mode).
11292 Third arg META t means accept 8-bit input (for a Meta key).
11293 META nil means ignore the top bit, on the assumption it is parity.
11294 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11295 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11296 See also `current-input-mode'. */)
11297 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11299 Fset_input_interrupt_mode (interrupt
);
11300 Fset_output_flow_control (flow
, Qnil
);
11301 Fset_input_meta_mode (meta
, Qnil
);
11303 Fset_quit_char (quit
);
11307 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11308 doc
: /* Return information about the way Emacs currently reads keyboard input.
11309 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11310 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11311 nil, Emacs is using CBREAK mode.
11312 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11313 terminal; this does not apply if Emacs uses interrupt-driven input.
11314 META is t if accepting 8-bit input with 8th bit as Meta flag.
11315 META nil means ignoring the top bit, on the assumption it is parity.
11316 META is neither t nor nil if accepting 8-bit input and using
11317 all 8 bits as the character code.
11318 QUIT is the character Emacs currently uses to quit.
11319 The elements of this list correspond to the arguments of
11320 `set-input-mode'. */)
11323 Lisp_Object val
[4];
11324 struct frame
*sf
= XFRAME (selected_frame
);
11326 val
[0] = interrupt_input
? Qt
: Qnil
;
11327 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11329 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11330 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11332 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11339 XSETFASTINT (val
[3], quit_char
);
11341 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11344 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11345 doc
: /* Return position information for pixel coordinates X and Y.
11346 By default, X and Y are relative to text area of the selected window.
11347 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11348 If optional fourth arg WHOLE is non-nil, X is relative to the left
11349 edge of the window.
11351 The return value is similar to a mouse click position:
11352 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11353 IMAGE (DX . DY) (WIDTH . HEIGHT))
11354 The `posn-' functions access elements of such lists. */)
11355 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11360 if (NILP (frame_or_window
))
11361 frame_or_window
= selected_window
;
11363 if (WINDOWP (frame_or_window
))
11367 CHECK_LIVE_WINDOW (frame_or_window
);
11369 w
= XWINDOW (frame_or_window
);
11370 XSETINT (x
, (XINT (x
)
11371 + WINDOW_LEFT_EDGE_X (w
)
11373 ? window_box_left_offset (w
, TEXT_AREA
)
11375 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11376 frame_or_window
= w
->frame
;
11379 CHECK_LIVE_FRAME (frame_or_window
);
11381 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11384 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11385 doc
: /* Return position information for buffer POS in WINDOW.
11386 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11388 Return nil if position is not visible in window. Otherwise,
11389 the return value is similar to that returned by `event-start' for
11390 a mouse click at the upper left corner of the glyph corresponding
11391 to the given buffer position:
11392 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11393 IMAGE (DX . DY) (WIDTH . HEIGHT))
11394 The `posn-' functions access elements of such lists. */)
11395 (Lisp_Object pos
, Lisp_Object window
)
11400 window
= selected_window
;
11402 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11405 Lisp_Object x
= XCAR (tem
);
11406 Lisp_Object y
= XCAR (XCDR (tem
));
11408 /* Point invisible due to hscrolling? */
11411 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11419 * Set up a new kboard object with reasonable initial values.
11422 init_kboard (KBOARD
*kb
)
11424 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11425 KVAR (kb
, Vlast_command
) = Qnil
;
11426 KVAR (kb
, Vreal_last_command
) = Qnil
;
11427 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11428 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11429 KVAR (kb
, Vprefix_arg
) = Qnil
;
11430 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11431 KVAR (kb
, kbd_queue
) = Qnil
;
11432 kb
->kbd_queue_has_data
= 0;
11433 kb
->immediate_echo
= 0;
11434 KVAR (kb
, echo_string
) = Qnil
;
11435 kb
->echo_after_prompt
= -1;
11436 kb
->kbd_macro_buffer
= 0;
11437 kb
->kbd_macro_bufsize
= 0;
11438 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11439 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11440 kb
->reference_count
= 0;
11441 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11442 KVAR (kb
, system_key_syms
) = Qnil
;
11443 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11444 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11445 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11446 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11447 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11451 * Destroy the contents of a kboard object, but not the object itself.
11452 * We use this just before deleting it, or if we're going to initialize
11453 * it a second time.
11456 wipe_kboard (KBOARD
*kb
)
11458 xfree (kb
->kbd_macro_buffer
);
11461 /* Free KB and memory referenced from it. */
11464 delete_kboard (KBOARD
*kb
)
11468 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11471 *kbp
= kb
->next_kboard
;
11473 /* Prevent a dangling reference to KB. */
11474 if (kb
== current_kboard
11475 && FRAMEP (selected_frame
)
11476 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11478 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11480 if (current_kboard
== kb
)
11489 init_keyboard (void)
11491 /* This is correct before outermost invocation of the editor loop */
11492 command_loop_level
= -1;
11493 immediate_quit
= 0;
11494 quit_char
= Ctl ('g');
11495 Vunread_command_events
= Qnil
;
11496 unread_command_char
= -1;
11497 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11499 recent_keys_index
= 0;
11500 kbd_fetch_ptr
= kbd_buffer
;
11501 kbd_store_ptr
= kbd_buffer
;
11502 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11503 do_mouse_tracking
= Qnil
;
11506 interrupt_input_blocked
= 0;
11507 interrupt_input_pending
= 0;
11509 pending_signals
= 0;
11512 /* This means that command_loop_1 won't try to select anything the first
11514 internal_last_event_frame
= Qnil
;
11515 Vlast_event_frame
= internal_last_event_frame
;
11517 current_kboard
= initial_kboard
;
11518 /* Re-initialize the keyboard again. */
11519 wipe_kboard (current_kboard
);
11520 init_kboard (current_kboard
);
11521 /* A value of nil for Vwindow_system normally means a tty, but we also use
11522 it for the initial terminal since there is no window system there. */
11523 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11525 if (!noninteractive
)
11527 /* Before multi-tty support, these handlers used to be installed
11528 only if the current session was a tty session. Now an Emacs
11529 session may have multiple display types, so we always handle
11530 SIGINT. There is special code in interrupt_signal to exit
11531 Emacs on SIGINT when there are no termcap frames on the
11532 controlling terminal. */
11533 signal (SIGINT
, interrupt_signal
);
11535 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11536 SIGQUIT and we can't tell which one it will give us. */
11537 signal (SIGQUIT
, interrupt_signal
);
11538 #endif /* not DOS_NT */
11540 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11542 if (!noninteractive
)
11543 signal (SIGIO
, input_available_signal
);
11546 /* Use interrupt input by default, if it works and noninterrupt input
11547 has deficiencies. */
11549 #ifdef INTERRUPT_INPUT
11550 interrupt_input
= 1;
11552 interrupt_input
= 0;
11558 if (keyboard_init_hook
)
11559 (*keyboard_init_hook
) ();
11561 #ifdef POLL_FOR_INPUT
11563 poll_suppress_count
= 1;
11568 /* This type's only use is in syms_of_keyboard, to initialize the
11569 event header symbols and put properties on them. */
11570 struct event_head
{
11576 static const struct event_head head_table
[] = {
11577 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11578 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11579 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11580 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11581 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11582 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11583 /* `select-window' should be handled just like `switch-frame'
11584 in read_key_sequence. */
11585 {&Qselect_window
, "select-window", &Qswitch_frame
}
11589 syms_of_keyboard (void)
11591 pending_funcalls
= Qnil
;
11592 staticpro (&pending_funcalls
);
11594 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11595 staticpro (&Vlispy_mouse_stem
);
11598 DEFSYM (QCimage
, ":image");
11599 DEFSYM (Qhelp_echo
, "help-echo");
11600 DEFSYM (QCrtl
, ":rtl");
11602 staticpro (&item_properties
);
11603 item_properties
= Qnil
;
11605 staticpro (&tool_bar_item_properties
);
11606 tool_bar_item_properties
= Qnil
;
11607 staticpro (&tool_bar_items_vector
);
11608 tool_bar_items_vector
= Qnil
;
11610 staticpro (&real_this_command
);
11611 real_this_command
= Qnil
;
11613 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11614 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11615 DEFSYM (Qself_insert_command
, "self-insert-command");
11616 DEFSYM (Qforward_char
, "forward-char");
11617 DEFSYM (Qbackward_char
, "backward-char");
11618 DEFSYM (Qdisabled
, "disabled");
11619 DEFSYM (Qundefined
, "undefined");
11620 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11621 DEFSYM (Qpost_command_hook
, "post-command-hook");
11622 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11623 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11624 DEFSYM (Qfunction_key
, "function-key");
11625 DEFSYM (Qmouse_click
, "mouse-click");
11626 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11627 DEFSYM (Qsave_session
, "save-session");
11628 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11629 DEFSYM (Qmenu_enable
, "menu-enable");
11631 #if defined (WINDOWSNT)
11632 DEFSYM (Qlanguage_change
, "language-change");
11636 DEFSYM (Qdbus_event
, "dbus-event");
11639 #ifdef HAVE_XWIDGETS
11640 Qxwidget_event
= intern ("xwidget-event");
11641 staticpro (&Qxwidget_event
);
11643 DEFSYM (QCenable
, ":enable");
11644 DEFSYM (QCvisible
, ":visible");
11645 DEFSYM (QChelp
, ":help");
11646 DEFSYM (QCfilter
, ":filter");
11647 DEFSYM (QCbutton
, ":button");
11648 DEFSYM (QCkeys
, ":keys");
11649 DEFSYM (QCkey_sequence
, ":key-sequence");
11650 DEFSYM (QCtoggle
, ":toggle");
11651 DEFSYM (QCradio
, ":radio");
11652 DEFSYM (QClabel
, ":label");
11653 DEFSYM (QCvert_only
, ":vert-only");
11655 DEFSYM (Qmode_line
, "mode-line");
11656 DEFSYM (Qvertical_line
, "vertical-line");
11657 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11658 DEFSYM (Qmenu_bar
, "menu-bar");
11660 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11661 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11664 DEFSYM (Qabove_handle
, "above-handle");
11665 DEFSYM (Qhandle
, "handle");
11666 DEFSYM (Qbelow_handle
, "below-handle");
11667 DEFSYM (Qup
, "up");
11668 DEFSYM (Qdown
, "down");
11669 DEFSYM (Qtop
, "top");
11670 DEFSYM (Qbottom
, "bottom");
11671 DEFSYM (Qend_scroll
, "end-scroll");
11672 DEFSYM (Qratio
, "ratio");
11674 DEFSYM (Qevent_kind
, "event-kind");
11675 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11676 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11677 DEFSYM (Qmodifier_cache
, "modifier-cache");
11679 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11680 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11682 DEFSYM (Qpolling_period
, "polling-period");
11684 DEFSYM (Qx_set_selection
, "x-set-selection");
11685 DEFSYM (QPRIMARY
, "PRIMARY");
11686 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11687 DEFSYM (Qhandle_select_window
, "handle-select-window");
11689 DEFSYM (Qinput_method_function
, "input-method-function");
11690 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11691 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11693 DEFSYM (Qhelp_form_show
, "help-form-show");
11695 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11696 Fset (Qinput_method_use_echo_area
, Qnil
);
11698 last_point_position_buffer
= Qnil
;
11699 last_point_position_window
= Qnil
;
11703 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11705 for (i
= 0; i
< len
; i
++)
11707 const struct event_head
*p
= &head_table
[i
];
11708 *p
->var
= intern_c_string (p
->name
);
11709 staticpro (p
->var
);
11710 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11711 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11715 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11716 staticpro (&button_down_location
);
11717 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11718 staticpro (&mouse_syms
);
11719 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11720 / sizeof (lispy_wheel_names
[0])),
11722 staticpro (&wheel_syms
);
11726 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11728 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11729 for (i
= 0; i
< len
; i
++)
11730 if (modifier_names
[i
])
11731 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11732 staticpro (&modifier_symbols
);
11735 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11736 staticpro (&recent_keys
);
11738 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11739 staticpro (&this_command_keys
);
11741 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11742 staticpro (&raw_keybuf
);
11744 DEFSYM (Qextended_command_history
, "extended-command-history");
11745 Fset (Qextended_command_history
, Qnil
);
11747 accent_key_syms
= Qnil
;
11748 staticpro (&accent_key_syms
);
11750 func_key_syms
= Qnil
;
11751 staticpro (&func_key_syms
);
11753 drag_n_drop_syms
= Qnil
;
11754 staticpro (&drag_n_drop_syms
);
11756 unread_switch_frame
= Qnil
;
11757 staticpro (&unread_switch_frame
);
11759 internal_last_event_frame
= Qnil
;
11760 staticpro (&internal_last_event_frame
);
11762 read_key_sequence_cmd
= Qnil
;
11763 staticpro (&read_key_sequence_cmd
);
11764 read_key_sequence_remapped
= Qnil
;
11765 staticpro (&read_key_sequence_remapped
);
11767 menu_bar_one_keymap_changed_items
= Qnil
;
11768 staticpro (&menu_bar_one_keymap_changed_items
);
11770 menu_bar_items_vector
= Qnil
;
11771 staticpro (&menu_bar_items_vector
);
11773 help_form_saved_window_configs
= Qnil
;
11774 staticpro (&help_form_saved_window_configs
);
11776 defsubr (&Scurrent_idle_time
);
11777 defsubr (&Sevent_symbol_parse_modifiers
);
11778 defsubr (&Sevent_convert_list
);
11779 defsubr (&Sread_key_sequence
);
11780 defsubr (&Sread_key_sequence_vector
);
11781 defsubr (&Srecursive_edit
);
11782 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11783 defsubr (&Strack_mouse
);
11785 defsubr (&Sinput_pending_p
);
11786 defsubr (&Scommand_execute
);
11787 defsubr (&Srecent_keys
);
11788 defsubr (&Sthis_command_keys
);
11789 defsubr (&Sthis_command_keys_vector
);
11790 defsubr (&Sthis_single_command_keys
);
11791 defsubr (&Sthis_single_command_raw_keys
);
11792 defsubr (&Sreset_this_command_lengths
);
11793 defsubr (&Sclear_this_command_keys
);
11794 defsubr (&Ssuspend_emacs
);
11795 defsubr (&Sabort_recursive_edit
);
11796 defsubr (&Sexit_recursive_edit
);
11797 defsubr (&Srecursion_depth
);
11798 defsubr (&Stop_level
);
11799 defsubr (&Sdiscard_input
);
11800 defsubr (&Sopen_dribble_file
);
11801 defsubr (&Sset_input_interrupt_mode
);
11802 defsubr (&Sset_output_flow_control
);
11803 defsubr (&Sset_input_meta_mode
);
11804 defsubr (&Sset_quit_char
);
11805 defsubr (&Sset_input_mode
);
11806 defsubr (&Scurrent_input_mode
);
11807 defsubr (&Sexecute_extended_command
);
11808 defsubr (&Sposn_at_point
);
11809 defsubr (&Sposn_at_x_y
);
11811 DEFVAR_LISP ("last-command-event", last_command_event
,
11812 doc
: /* Last input event that was part of a command. */);
11814 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11815 doc
: /* Last input event in a command, except for mouse menu events.
11816 Mouse menus give back keys that don't look like mouse events;
11817 this variable holds the actual mouse event that led to the menu,
11818 so that you can determine whether the command was run by mouse or not. */);
11820 DEFVAR_LISP ("last-input-event", last_input_event
,
11821 doc
: /* Last input event. */);
11823 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11824 doc
: /* List of events to be read as the command input.
11825 These events are processed first, before actual keyboard input.
11826 Events read from this list are not normally added to `this-command-keys',
11827 as they will already have been added once as they were read for the first time.
11828 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11829 Vunread_command_events
= Qnil
;
11831 DEFVAR_INT ("unread-command-char", unread_command_char
,
11832 doc
: /* If not -1, an object to be read as next command input event. */);
11834 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11835 doc
: /* List of events to be processed as input by input methods.
11836 These events are processed before `unread-command-events'
11837 and actual keyboard input, but are not given to `input-method-function'. */);
11838 Vunread_post_input_method_events
= Qnil
;
11840 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11841 doc
: /* List of events to be processed as input by input methods.
11842 These events are processed after `unread-command-events', but
11843 before actual keyboard input.
11844 If there's an active input method, the events are given to
11845 `input-method-function'. */);
11846 Vunread_input_method_events
= Qnil
;
11848 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11849 doc
: /* Meta-prefix character code.
11850 Meta-foo as command input turns into this character followed by foo. */);
11851 XSETINT (meta_prefix_char
, 033);
11853 DEFVAR_KBOARD ("last-command", Vlast_command
,
11854 doc
: /* The last command executed.
11855 Normally a symbol with a function definition, but can be whatever was found
11856 in the keymap, or whatever the variable `this-command' was set to by that
11859 The value `mode-exit' is special; it means that the previous command
11860 read an event that told it to exit, and it did so and unread that event.
11861 In other words, the present command is the event that made the previous
11864 The value `kill-region' is special; it means that the previous command
11865 was a kill command.
11867 `last-command' has a separate binding for each terminal device.
11868 See Info node `(elisp)Multiple Terminals'. */);
11870 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11871 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11873 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11874 doc
: /* Last command that may be repeated.
11875 The last command executed that was not bound to an input event.
11876 This is the command `repeat' will try to repeat. */);
11878 DEFVAR_LISP ("this-command", Vthis_command
,
11879 doc
: /* The command now being executed.
11880 The command can set this variable; whatever is put here
11881 will be in `last-command' during the following command. */);
11882 Vthis_command
= Qnil
;
11884 DEFVAR_LISP ("this-command-keys-shift-translated",
11885 Vthis_command_keys_shift_translated
,
11886 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11887 Shift-translation occurs when there is no binding for the key sequence
11888 as entered, but a binding was found by changing an upper-case letter
11889 to lower-case, or a shifted function key to an unshifted one. */);
11890 Vthis_command_keys_shift_translated
= Qnil
;
11892 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11893 doc
: /* The command bound to the current key sequence before remapping.
11894 It equals `this-command' if the original command was not remapped through
11895 any of the active keymaps. Otherwise, the value of `this-command' is the
11896 result of looking up the original command in the active keymaps. */);
11897 Vthis_original_command
= Qnil
;
11899 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11900 doc
: /* Number of input events between auto-saves.
11901 Zero means disable autosaving due to number of characters typed. */);
11902 auto_save_interval
= 300;
11904 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11905 doc
: /* Number of seconds idle time before auto-save.
11906 Zero or nil means disable auto-saving due to idleness.
11907 After auto-saving due to this many seconds of idle time,
11908 Emacs also does a garbage collection if that seems to be warranted. */);
11909 XSETFASTINT (Vauto_save_timeout
, 30);
11911 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11912 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11913 The value may be integer or floating point.
11914 If the value is zero, don't echo at all. */);
11915 Vecho_keystrokes
= make_number (1);
11917 DEFVAR_INT ("polling-period", polling_period
,
11918 doc
: /* Interval between polling for input during Lisp execution.
11919 The reason for polling is to make C-g work to stop a running program.
11920 Polling is needed only when using X windows and SIGIO does not work.
11921 Polling is automatically disabled in all other cases. */);
11922 polling_period
= 2;
11924 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11925 doc
: /* Maximum time between mouse clicks to make a double-click.
11926 Measured in milliseconds. The value nil means disable double-click
11927 recognition; t means double-clicks have no time limit and are detected
11928 by position only. */);
11929 Vdouble_click_time
= make_number (500);
11931 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11932 doc
: /* Maximum mouse movement between clicks to make a double-click.
11933 On window-system frames, value is the number of pixels the mouse may have
11934 moved horizontally or vertically between two clicks to make a double-click.
11935 On non window-system frames, value is interpreted in units of 1/8 characters
11938 This variable is also the threshold for motion of the mouse
11939 to count as a drag. */);
11940 double_click_fuzz
= 3;
11942 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11943 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11944 inhibit_local_menu_bar_menus
= 0;
11946 DEFVAR_INT ("num-input-keys", num_input_keys
,
11947 doc
: /* Number of complete key sequences read as input so far.
11948 This includes key sequences read from keyboard macros.
11949 The number is effectively the number of interactive command invocations. */);
11950 num_input_keys
= 0;
11952 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11953 doc
: /* Number of input events read from the keyboard so far.
11954 This does not include events generated by keyboard macros. */);
11955 num_nonmacro_input_events
= 0;
11957 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11958 doc
: /* The frame in which the most recently read event occurred.
11959 If the last event came from a keyboard macro, this is set to `macro'. */);
11960 Vlast_event_frame
= Qnil
;
11962 /* This variable is set up in sysdep.c. */
11963 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11964 doc
: /* The ERASE character as set by the user with stty. */);
11966 DEFVAR_LISP ("help-char", Vhelp_char
,
11967 doc
: /* Character to recognize as meaning Help.
11968 When it is read, do `(eval help-form)', and display result if it's a string.
11969 If the value of `help-form' is nil, this char can be read normally. */);
11970 XSETINT (Vhelp_char
, Ctl ('H'));
11972 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11973 doc
: /* List of input events to recognize as meaning Help.
11974 These work just like the value of `help-char' (see that). */);
11975 Vhelp_event_list
= Qnil
;
11977 DEFVAR_LISP ("help-form", Vhelp_form
,
11978 doc
: /* Form to execute when character `help-char' is read.
11979 If the form returns a string, that string is displayed.
11980 If `help-form' is nil, the help char is not recognized. */);
11983 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11984 doc
: /* Command to run when `help-char' character follows a prefix key.
11985 This command is used only when there is no actual binding
11986 for that character after that prefix key. */);
11987 Vprefix_help_command
= Qnil
;
11989 DEFVAR_LISP ("top-level", Vtop_level
,
11990 doc
: /* Form to evaluate when Emacs starts up.
11991 Useful to set before you dump a modified Emacs. */);
11994 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11995 doc
: /* Translate table for local keyboard input, or nil.
11996 If non-nil, the value should be a char-table. Each character read
11997 from the keyboard is looked up in this char-table. If the value found
11998 there is non-nil, then it is used instead of the actual input character.
12000 The value can also be a string or vector, but this is considered obsolete.
12001 If it is a string or vector of length N, character codes N and up are left
12002 untranslated. In a vector, an element which is nil means "no translation".
12004 This is applied to the characters supplied to input methods, not their
12005 output. See also `translation-table-for-input'.
12007 This variable has a separate binding for each terminal.
12008 See Info node `(elisp)Multiple Terminals'. */);
12010 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
12011 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12012 \(Even if the operating system has support for stopping a process.\) */);
12013 cannot_suspend
= 0;
12015 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
12016 doc
: /* Non-nil means prompt with menus when appropriate.
12017 This is done when reading from a keymap that has a prompt string,
12018 for elements that have prompt strings.
12019 The menu is displayed on the screen
12020 if X menus were enabled at configuration
12021 time and the previous event was a mouse click prefix key.
12022 Otherwise, menu prompting uses the echo area. */);
12023 menu_prompting
= 1;
12025 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
12026 doc
: /* Character to see next line of menu prompt.
12027 Type this character while in a menu prompt to rotate around the lines of it. */);
12028 XSETINT (menu_prompt_more_char
, ' ');
12030 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
12031 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12032 Emacs applies the modifiers of the character stored here to each keyboard
12033 character it reads. For example, after evaluating the expression
12034 (setq extra-keyboard-modifiers ?\\C-x)
12035 all input characters will have the control modifier applied to them.
12037 Note that the character ?\\C-@, equivalent to the integer zero, does
12038 not count as a control character; rather, it counts as a character
12039 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12040 cancels any modification. */);
12041 extra_keyboard_modifiers
= 0;
12043 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
12044 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12045 The command loop sets this to nil before each command,
12046 and tests the value when the command returns.
12047 Buffer modification stores t in this variable. */);
12048 Vdeactivate_mark
= Qnil
;
12049 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
12051 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
12052 doc
: /* Normal hook run before each command is executed.
12053 If an unhandled error happens in running this hook,
12054 the function in which the error occurred is unconditionally removed, since
12055 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
12056 Vpre_command_hook
= Qnil
;
12058 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
12059 doc
: /* Normal hook run after each command is executed.
12060 If an unhandled error happens in running this hook,
12061 the function in which the error occurred is unconditionally removed, since
12062 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
12063 Vpost_command_hook
= Qnil
;
12066 DEFVAR_LISP ("echo-area-clear-hook", ...,
12067 doc
: /* Normal hook run when clearing the echo area. */);
12069 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
12070 Fset (Qecho_area_clear_hook
, Qnil
);
12072 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
12073 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12074 Vlucid_menu_bar_dirty_flag
= Qnil
;
12076 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
12077 doc
: /* List of menu bar items to move to the end of the menu bar.
12078 The elements of the list are event types that may have menu bar bindings. */);
12079 Vmenu_bar_final_items
= Qnil
;
12081 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
12082 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
12083 This is used internally by graphical displays that do not render
12084 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
12085 Vtool_bar_separator_image_expression
= Qnil
;
12087 DEFVAR_KBOARD ("overriding-terminal-local-map",
12088 Voverriding_terminal_local_map
,
12089 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12090 If this variable is non-nil, it is used as a keymap instead of the
12091 buffer's local map, and the minor mode keymaps and text property keymaps.
12092 It also replaces `overriding-local-map'.
12094 This variable is intended to let commands such as `universal-argument'
12095 set up a different keymap for reading the next command.
12097 `overriding-terminal-local-map' has a separate binding for each
12099 See Info node `(elisp)Multiple Terminals'. */);
12101 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
12102 doc
: /* Keymap that overrides all other local keymaps.
12103 If this variable is non-nil, it is used as a keymap--replacing the
12104 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12105 Voverriding_local_map
= Qnil
;
12107 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
12108 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12109 Otherwise, the menu bar continues to reflect the buffer's local map
12110 and the minor mode maps regardless of `overriding-local-map'. */);
12111 Voverriding_local_map_menu_flag
= Qnil
;
12113 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12114 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12115 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12117 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12118 doc
: /* Non-nil means generate motion events for mouse motion. */);
12120 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12121 doc
: /* Alist of system-specific X windows key symbols.
12122 Each element should have the form (N . SYMBOL) where N is the
12123 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12124 and SYMBOL is its name.
12126 `system-key-alist' has a separate binding for each terminal device.
12127 See Info node `(elisp)Multiple Terminals'. */);
12129 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12130 doc
: /* Keymap that translates key sequences to key sequences during input.
12131 This is used mainly for mapping key sequences into some preferred
12132 key events (symbols).
12134 The `read-key-sequence' function replaces any subsequence bound by
12135 `local-function-key-map' with its binding. More precisely, when the
12136 active keymaps have no binding for the current key sequence but
12137 `local-function-key-map' binds a suffix of the sequence to a vector or
12138 string, `read-key-sequence' replaces the matching suffix with its
12139 binding, and continues with the new sequence.
12141 If the binding is a function, it is called with one argument (the prompt)
12142 and its return value (a key sequence) is used.
12144 The events that come from bindings in `local-function-key-map' are not
12145 themselves looked up in `local-function-key-map'.
12147 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12148 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12149 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12150 typing `ESC O P x' would return [f1 x].
12152 `local-function-key-map' has a separate binding for each terminal
12153 device. See Info node `(elisp)Multiple Terminals'. If you need to
12154 define a binding on all terminals, change `function-key-map'
12155 instead. Initially, `local-function-key-map' is an empty keymap that
12156 has `function-key-map' as its parent on all terminal devices. */);
12158 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12159 doc
: /* Keymap that decodes input escape sequences.
12160 This is used mainly for mapping ASCII function key sequences into
12161 real Emacs function key events (symbols).
12163 The `read-key-sequence' function replaces any subsequence bound by
12164 `input-decode-map' with its binding. Contrary to `function-key-map',
12165 this map applies its rebinding regardless of the presence of an ordinary
12166 binding. So it is more like `key-translation-map' except that it applies
12167 before `function-key-map' rather than after.
12169 If the binding is a function, it is called with one argument (the prompt)
12170 and its return value (a key sequence) is used.
12172 The events that come from bindings in `input-decode-map' are not
12173 themselves looked up in `input-decode-map'.
12175 This variable is keyboard-local. */);
12177 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12178 doc
: /* The parent keymap of all `local-function-key-map' instances.
12179 Function key definitions that apply to all terminal devices should go
12180 here. If a mapping is defined in both the current
12181 `local-function-key-map' binding and this variable, then the local
12182 definition will take precedence. */);
12183 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12185 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12186 doc
: /* Keymap of key translations that can override keymaps.
12187 This keymap works like `function-key-map', but comes after that,
12188 and its non-prefix bindings override ordinary bindings.
12189 Another difference is that it is global rather than keyboard-local. */);
12190 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12192 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12193 doc
: /* List of deferred actions to be performed at a later time.
12194 The precise format isn't relevant here; we just check whether it is nil. */);
12195 Vdeferred_action_list
= Qnil
;
12197 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12198 doc
: /* Function to call to handle deferred actions, after each command.
12199 This function is called with no arguments after each command
12200 whenever `deferred-action-list' is non-nil. */);
12201 Vdeferred_action_function
= Qnil
;
12203 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12204 doc
: /* List of warnings to be displayed after this command.
12205 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12206 as per the args of `display-warning' (which see).
12207 If this variable is non-nil, `delayed-warnings-hook' will be run
12208 immediately after running `post-command-hook'. */);
12209 Vdelayed_warnings_list
= Qnil
;
12211 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12212 doc
: /* Non-nil means show the equivalent key-binding when M-x command has one.
12213 The value can be a length of time to show the message for.
12214 If the value is non-nil and not a number, we wait 2 seconds. */);
12215 Vsuggest_key_bindings
= Qt
;
12217 DEFVAR_LISP ("timer-list", Vtimer_list
,
12218 doc
: /* List of active absolute time timers in order of increasing time. */);
12219 Vtimer_list
= Qnil
;
12221 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12222 doc
: /* List of active idle-time timers in order of increasing time. */);
12223 Vtimer_idle_list
= Qnil
;
12225 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12226 doc
: /* If non-nil, the function that implements the current input method.
12227 It's called with one argument, a printing character that was just read.
12228 \(That means a character with code 040...0176.)
12229 Typically this function uses `read-event' to read additional events.
12230 When it does so, it should first bind `input-method-function' to nil
12231 so it will not be called recursively.
12233 The function should return a list of zero or more events
12234 to be used as input. If it wants to put back some events
12235 to be reconsidered, separately, by the input method,
12236 it can add them to the beginning of `unread-command-events'.
12238 The input method function can find in `input-method-previous-message'
12239 the previous echo area message.
12241 The input method function should refer to the variables
12242 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12243 for guidance on what to do. */);
12244 Vinput_method_function
= Qnil
;
12246 DEFVAR_LISP ("input-method-previous-message",
12247 Vinput_method_previous_message
,
12248 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12249 This variable exists because `read-event' clears the echo area
12250 before running the input method. It is nil if there was no message. */);
12251 Vinput_method_previous_message
= Qnil
;
12253 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12254 doc
: /* If non-nil, the function that implements the display of help.
12255 It's called with one argument, the help string to display. */);
12256 Vshow_help_function
= Qnil
;
12258 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12259 doc
: /* If non-nil, suppress point adjustment after executing a command.
12261 After a command is executed, if point is moved into a region that has
12262 special properties (e.g. composition, display), we adjust point to
12263 the boundary of the region. But, when a command sets this variable to
12264 non-nil, we suppress the point adjustment.
12266 This variable is set to nil before reading a command, and is checked
12267 just after executing the command. */);
12268 Vdisable_point_adjustment
= Qnil
;
12270 DEFVAR_LISP ("global-disable-point-adjustment",
12271 Vglobal_disable_point_adjustment
,
12272 doc
: /* If non-nil, always suppress point adjustment.
12274 The default value is nil, in which case, point adjustment are
12275 suppressed only after special commands that set
12276 `disable-point-adjustment' (which see) to non-nil. */);
12277 Vglobal_disable_point_adjustment
= Qnil
;
12279 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12280 doc
: /* How long to display an echo-area message when the minibuffer is active.
12281 If the value is not a number, such messages don't time out. */);
12282 Vminibuffer_message_timeout
= make_number (2);
12284 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12285 doc
: /* If non-nil, any keyboard input throws to this symbol.
12286 The value of that variable is passed to `quit-flag' and later causes a
12287 peculiar kind of quitting. */);
12288 Vthrow_on_input
= Qnil
;
12290 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12291 doc
: /* If non-nil, function to output error messages.
12292 The arguments are the error data, a list of the form
12293 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12294 such as just as `condition-case' would bind its variable to,
12295 the context (a string which normally goes at the start of the message),
12296 and the Lisp function within which the error was signaled. */);
12297 Vcommand_error_function
= Qnil
;
12299 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12300 Venable_disabled_menus_and_buttons
,
12301 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12303 Help functions bind this to allow help on disabled menu items
12304 and tool-bar buttons. */);
12305 Venable_disabled_menus_and_buttons
= Qnil
;
12307 DEFVAR_LISP ("select-active-regions",
12308 Vselect_active_regions
,
12309 doc
: /* If non-nil, an active region automatically sets the primary selection.
12310 If the value is `only', only temporarily active regions (usually made
12311 by mouse-dragging or shift-selection) set the window selection.
12313 This takes effect only when Transient Mark mode is enabled. */);
12314 Vselect_active_regions
= Qt
;
12316 DEFVAR_LISP ("saved-region-selection",
12317 Vsaved_region_selection
,
12318 doc
: /* Contents of active region prior to buffer modification.
12319 If `select-active-regions' is non-nil, Emacs sets this to the
12320 text in the region before modifying the buffer. The next
12321 `deactivate-mark' call uses this to set the window selection. */);
12322 Vsaved_region_selection
= Qnil
;
12324 DEFVAR_LISP ("selection-inhibit-update-commands",
12325 Vselection_inhibit_update_commands
,
12326 doc
: /* List of commands which should not update the selection.
12327 Normally, if `select-active-regions' is non-nil and the mark remains
12328 active after a command (i.e. the mark was not deactivated), the Emacs
12329 command loop sets the selection to the text in the region. However,
12330 if the command is in this list, the selection is not updated. */);
12331 Vselection_inhibit_update_commands
12332 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12334 DEFVAR_LISP ("debug-on-event",
12336 doc
: /* Enter debugger on this event. When Emacs
12337 receives the special event specified by this variable, it will try to
12338 break into the debugger as soon as possible instead of processing the
12339 event normally through `special-event-map'.
12341 Currently, the only supported values for this
12342 variable are `sigusr1' and `sigusr2'. */);
12343 Vdebug_on_event
= intern_c_string ("sigusr2");
12345 /* Create the initial keyboard. */
12346 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12347 init_kboard (initial_kboard
);
12348 /* Vwindow_system is left at t for now. */
12349 initial_kboard
->next_kboard
= all_kboards
;
12350 all_kboards
= initial_kboard
;
12354 keys_of_keyboard (void)
12356 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12357 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12358 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12359 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12360 initial_define_key (meta_map
, 'x', "execute-extended-command");
12362 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12363 "handle-delete-frame");
12364 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12365 "ns-put-working-text");
12366 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12367 "ns-unput-working-text");
12368 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12369 current-prefix-arg, as is done in `handle-switch-frame'.
12370 But `handle-switch-frame is not run from the special-map.
12371 Commands from that map are run in a special way that automatically
12372 preserves the prefix-arg. Restoring the prefix arg here is not just
12373 redundant but harmful:
12375 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12376 - after the first prompt, the exit-minibuffer-hook is run which may
12377 iconify a frame and thus push a `iconify-frame' event.
12378 - after running exit-minibuffer-hook, current-prefix-arg is
12379 restored to the non-nil value it had before the prompt.
12380 - we enter the second prompt.
12381 current-prefix-arg is non-nil, prefix-arg is nil.
12382 - before running the first real event, we run the special iconify-frame
12383 event, but we pass the `special' arg to execute-command so
12384 current-prefix-arg and prefix-arg are left untouched.
12385 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12386 - the next key event will have a spuriously non-nil current-prefix-arg. */
12387 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12389 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12391 /* Handling it at such a low-level causes read_key_sequence to get
12392 * confused because it doesn't realize that the current_buffer was
12393 * changed by read_char.
12395 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12396 * "handle-select-window"); */
12397 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12398 "handle-save-session");
12401 /* Define a special event which is raised for dbus callback
12403 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12404 "dbus-handle-event");
12407 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12411 /* Mark the pointers in the kboard objects.
12412 Called by the Fgarbage_collector. */
12414 mark_kboards (void)
12418 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12420 if (kb
->kbd_macro_buffer
)
12421 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12423 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12424 mark_object (KVAR (kb
, Vlast_command
));
12425 mark_object (KVAR (kb
, Vreal_last_command
));
12426 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12427 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12428 mark_object (KVAR (kb
, Vprefix_arg
));
12429 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12430 mark_object (KVAR (kb
, kbd_queue
));
12431 mark_object (KVAR (kb
, defining_kbd_macro
));
12432 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12433 mark_object (KVAR (kb
, Vsystem_key_alist
));
12434 mark_object (KVAR (kb
, system_key_syms
));
12435 mark_object (KVAR (kb
, Vwindow_system
));
12436 mark_object (KVAR (kb
, Vinput_decode_map
));
12437 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12438 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12439 mark_object (KVAR (kb
, echo_string
));
12442 struct input_event
*event
;
12443 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12445 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12446 event
= kbd_buffer
;
12447 if (event
->kind
!= SELECTION_REQUEST_EVENT
12448 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12450 mark_object (event
->x
);
12451 mark_object (event
->y
);
12453 mark_object (event
->frame_or_window
);
12454 mark_object (event
->arg
);