1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
100 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
101 static int single_kboard
;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled
;
106 static Lisp_Object Qdisabled_command_function
;
108 #define NUM_RECENT_KEYS (300)
110 /* Index for storing next element into recent_keys. */
111 static int recent_keys_index
;
113 /* Total number of elements stored into recent_keys. */
114 static int total_keys
;
116 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
117 static Lisp_Object recent_keys
;
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 ptrdiff_t this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 static int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 static Lisp_Object raw_keybuf
;
134 static int raw_keybuf_count
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
138 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 static ptrdiff_t this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static ptrdiff_t before_command_key_count
;
147 static ptrdiff_t before_command_echo_length
;
149 /* For longjmp to where kbd input is being done. */
151 static jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 int waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
160 /* Non-null means we can start echoing at the next input pause even
161 though there is something in the echo area. */
163 static struct kboard
*ok_to_echo_at_next_pause
;
165 /* The kboard last echoing, or null for none. Reset to 0 in
166 cancel_echoing. If non-null, and a current echo area message
167 exists, and echo_message_buffer is eq to the current message
168 buffer, we know that the message comes from echo_kboard. */
170 struct kboard
*echo_kboard
;
172 /* The buffer used for echoing. Set in echo_now, reset in
175 Lisp_Object echo_message_buffer
;
177 /* Nonzero means C-g should cause immediate error-signal. */
180 /* Character that causes a quit. Normally C-g.
182 If we are running on an ordinary terminal, this must be an ordinary
183 ASCII char, since we want to make it our interrupt character.
185 If we are not running on an ordinary terminal, it still needs to be
186 an ordinary ASCII char. This character needs to be recognized in
187 the input interrupt handler. At this point, the keystroke is
188 represented as a struct input_event, while the desired quit
189 character is specified as a lispy event. The mapping from struct
190 input_events to lispy events cannot run in an interrupt handler,
191 and the reverse mapping is difficult for anything but ASCII
194 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
198 /* Current depth in recursive edits. */
199 EMACS_INT command_loop_level
;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame
;
210 /* Last size recorded for a current buffer which is not a minibuffer. */
211 static ptrdiff_t last_non_minibuf_size
;
213 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
214 uintmax_t num_input_events
;
216 /* Value of num_nonmacro_input_events as of last auto save. */
218 static EMACS_INT last_auto_save
;
220 /* This is like Vthis_command, except that commands never set it. */
221 Lisp_Object real_this_command
;
223 /* The value of point when the last command was started. */
224 static ptrdiff_t last_point_position
;
226 /* The buffer that was current when the last command was started. */
227 static Lisp_Object last_point_position_buffer
;
229 /* The window that was selected when the last command was started. */
230 static Lisp_Object last_point_position_window
;
232 /* The frame in which the last input event occurred, or Qmacro if the
233 last event came from a macro. We use this to determine when to
234 generate switch-frame events. This may be cleared by functions
235 like Fselect_frame, to make sure that a switch-frame event is
236 generated by the next character. */
237 Lisp_Object internal_last_event_frame
;
239 /* The timestamp of the last input event we received from the X server.
240 X Windows wants this for selection ownership. */
241 Time last_event_timestamp
;
243 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
244 Lisp_Object QPRIMARY
;
246 static Lisp_Object Qself_insert_command
;
247 static Lisp_Object Qforward_char
;
248 static Lisp_Object Qbackward_char
;
249 Lisp_Object Qundefined
;
250 static Lisp_Object Qtimer_event_handler
;
252 /* read_key_sequence stores here the command definition of the
253 key sequence that it reads. */
254 static Lisp_Object read_key_sequence_cmd
;
255 static Lisp_Object read_key_sequence_remapped
;
257 static Lisp_Object Qinput_method_function
;
259 static Lisp_Object Qdeactivate_mark
;
261 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
263 static Lisp_Object Qecho_area_clear_hook
;
265 /* Hooks to run before and after each command. */
266 static Lisp_Object Qpre_command_hook
;
267 static Lisp_Object Qpost_command_hook
;
269 static Lisp_Object Qdeferred_action_function
;
271 static Lisp_Object Qdelayed_warnings_hook
;
273 static Lisp_Object Qinput_method_exit_on_first_char
;
274 static Lisp_Object Qinput_method_use_echo_area
;
276 static Lisp_Object Qhelp_form_show
;
278 /* File in which we write all commands we read. */
279 static FILE *dribble
;
281 /* Nonzero if input is available. */
284 /* Circular buffer for pre-read keyboard input. */
286 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
288 /* Pointer to next available character in kbd_buffer.
289 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
290 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
291 next available char is in kbd_buffer[0]. */
292 static struct input_event
*kbd_fetch_ptr
;
294 /* Pointer to next place to store character in kbd_buffer. This
295 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
296 character should go in kbd_buffer[0]. */
297 static struct input_event
* volatile kbd_store_ptr
;
299 /* The above pair of variables forms a "queue empty" flag. When we
300 enqueue a non-hook event, we increment kbd_store_ptr. When we
301 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
302 there is input available if the two pointers are not equal.
304 Why not just have a flag set and cleared by the enqueuing and
305 dequeuing functions? Such a flag could be screwed up by interrupts
306 at inopportune times. */
308 /* Symbols to head events. */
309 static Lisp_Object Qmouse_movement
;
310 static Lisp_Object Qscroll_bar_movement
;
311 Lisp_Object Qswitch_frame
;
312 static Lisp_Object Qdelete_frame
;
313 static Lisp_Object Qiconify_frame
;
314 static Lisp_Object Qmake_frame_visible
;
315 static Lisp_Object Qselect_window
;
316 Lisp_Object Qhelp_echo
;
318 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
319 static Lisp_Object Qmouse_fixup_help_message
;
322 /* Symbols to denote kinds of events. */
323 static Lisp_Object Qfunction_key
;
324 Lisp_Object Qmouse_click
;
325 #if defined (WINDOWSNT)
326 Lisp_Object Qlanguage_change
;
328 static Lisp_Object Qdrag_n_drop
;
329 static Lisp_Object Qsave_session
;
331 static Lisp_Object Qdbus_event
;
333 static Lisp_Object Qconfig_changed_event
;
335 /* Lisp_Object Qmouse_movement; - also an event header */
337 /* Properties of event headers. */
338 Lisp_Object Qevent_kind
;
339 static Lisp_Object Qevent_symbol_elements
;
341 /* menu and tool bar item parts */
342 static Lisp_Object Qmenu_enable
;
343 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
344 Lisp_Object QCfilter
;
346 /* Non-nil disable property on a command means
347 do not execute it; call disabled-command-function's value instead. */
348 Lisp_Object QCtoggle
, QCradio
;
349 static Lisp_Object QCbutton
, QClabel
;
351 static Lisp_Object QCvert_only
;
353 /* An event header symbol HEAD may have a property named
354 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
355 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
356 mask of modifiers applied to it. If present, this is used to help
357 speed up parse_modifiers. */
358 Lisp_Object Qevent_symbol_element_mask
;
360 /* An unmodified event header BASE may have a property named
361 Qmodifier_cache, which is an alist mapping modifier masks onto
362 modified versions of BASE. If present, this helps speed up
364 static Lisp_Object Qmodifier_cache
;
366 /* Symbols to use for parts of windows. */
367 Lisp_Object Qmode_line
;
368 Lisp_Object Qvertical_line
;
369 static Lisp_Object Qvertical_scroll_bar
;
370 Lisp_Object Qmenu_bar
;
372 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
373 static Lisp_Object
command_loop (void);
374 static Lisp_Object Qextended_command_history
;
375 EMACS_TIME
timer_check (void);
377 static void record_menu_key (Lisp_Object c
);
378 static void echo_now (void);
379 static ptrdiff_t echo_length (void);
381 static Lisp_Object Qpolling_period
;
383 /* Incremented whenever a timer is run. */
386 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
388 EMACS_TIME
*input_available_clear_time
;
390 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
391 Default is 1 if INTERRUPT_INPUT is defined. */
394 /* Nonzero while interrupts are temporarily deferred during redisplay. */
395 int interrupts_deferred
;
397 /* Allow m- file to inhibit use of FIONREAD. */
398 #ifdef BROKEN_FIONREAD
402 /* We are unable to use interrupts if FIONREAD is not available,
403 so flush SIGIO so we won't try. */
404 #if !defined (FIONREAD)
410 /* If we support a window system, turn on the code to poll periodically
411 to detect C-g. It isn't actually used when doing interrupt input. */
412 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
413 #define POLL_FOR_INPUT
416 /* The time when Emacs started being idle. */
418 static EMACS_TIME timer_idleness_start_time
;
420 /* After Emacs stops being idle, this saves the last value
421 of timer_idleness_start_time from when it was idle. */
423 static EMACS_TIME timer_last_idleness_start_time
;
426 /* Global variable declarations. */
428 /* Flags for readable_events. */
429 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
430 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
431 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
433 /* Function for init_keyboard to call with no args (if nonzero). */
434 static void (*keyboard_init_hook
) (void);
436 static int read_avail_input (int);
437 static void get_input_pending (int *, int);
438 static int readable_events (int);
439 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
441 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
443 static Lisp_Object
make_lispy_event (struct input_event
*);
444 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
445 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
446 enum scroll_bar_part
,
447 Lisp_Object
, Lisp_Object
,
450 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
451 Lisp_Object
, const char *const *,
452 Lisp_Object
*, ptrdiff_t);
453 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
454 static int help_char_p (Lisp_Object
);
455 static void save_getcjmp (jmp_buf);
456 static void restore_getcjmp (jmp_buf);
457 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
458 static void clear_event (struct input_event
*);
459 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
460 static void interrupt_signal (int signalnum
);
462 static void input_available_signal (int signo
);
464 static Lisp_Object (Fcommand_execute
) (Lisp_Object
, Lisp_Object
, Lisp_Object
,
466 static void handle_interrupt (void);
467 static void quit_throw_to_read_char (void) NO_RETURN
;
468 static void timer_start_idle (void);
469 static void timer_stop_idle (void);
470 static void timer_resume_idle (void);
471 static void handle_user_signal (int);
472 static char *find_user_signal_name (int);
473 static int store_user_signal_events (void);
476 /* Add C to the echo string, if echoing is going on.
477 C can be a character, which is printed prettily ("M-C-x" and all that
478 jazz), or a symbol, whose name is printed. */
481 echo_char (Lisp_Object c
)
483 if (current_kboard
->immediate_echo
)
485 int size
= KEY_DESCRIPTION_SIZE
+ 100;
486 char *buffer
= (char *) alloca (size
);
488 Lisp_Object echo_string
;
490 echo_string
= KVAR (current_kboard
, echo_string
);
492 /* If someone has passed us a composite event, use its head symbol. */
497 ptr
= push_key_description (XINT (c
), ptr
, 1);
499 else if (SYMBOLP (c
))
501 Lisp_Object name
= SYMBOL_NAME (c
);
502 int nbytes
= SBYTES (name
);
504 if (size
- (ptr
- buffer
) < nbytes
)
506 int offset
= ptr
- buffer
;
507 size
= max (2 * size
, size
+ nbytes
);
508 buffer
= (char *) alloca (size
);
509 ptr
= buffer
+ offset
;
512 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
513 STRING_MULTIBYTE (name
), 1);
516 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
519 const char *text
= " (Type ? for further options)";
520 int len
= strlen (text
);
522 if (size
- (ptr
- buffer
) < len
)
524 int offset
= ptr
- buffer
;
526 buffer
= (char *) alloca (size
);
527 ptr
= buffer
+ offset
;
530 memcpy (ptr
, text
, len
);
534 /* Replace a dash from echo_dash with a space, otherwise
535 add a space at the end as a separator between keys. */
536 if (STRINGP (echo_string
)
537 && SCHARS (echo_string
) > 1)
539 Lisp_Object last_char
, prev_char
, idx
;
541 idx
= make_number (SCHARS (echo_string
) - 2);
542 prev_char
= Faref (echo_string
, idx
);
544 idx
= make_number (SCHARS (echo_string
) - 1);
545 last_char
= Faref (echo_string
, idx
);
547 /* We test PREV_CHAR to make sure this isn't the echoing
549 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
550 Faset (echo_string
, idx
, make_number (' '));
552 echo_string
= concat2 (echo_string
, build_string (" "));
554 else if (STRINGP (echo_string
))
555 echo_string
= concat2 (echo_string
, build_string (" "));
557 KVAR (current_kboard
, echo_string
)
558 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
564 /* Temporarily add a dash to the end of the echo string if it's not
565 empty, so that it serves as a mini-prompt for the very next character. */
570 /* Do nothing if not echoing at all. */
571 if (NILP (KVAR (current_kboard
, echo_string
)))
574 if (this_command_key_count
== 0)
577 if (!current_kboard
->immediate_echo
578 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
581 /* Do nothing if we just printed a prompt. */
582 if (current_kboard
->echo_after_prompt
583 == SCHARS (KVAR (current_kboard
, echo_string
)))
586 /* Do nothing if we have already put a dash at the end. */
587 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
589 Lisp_Object last_char
, prev_char
, idx
;
591 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
592 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
594 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
595 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
597 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
601 /* Put a dash at the end of the buffer temporarily,
602 but make it go away when the next character is added. */
603 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
608 /* Display the current echo string, and begin echoing if not already
614 if (!current_kboard
->immediate_echo
)
617 current_kboard
->immediate_echo
= 1;
619 for (i
= 0; i
< this_command_key_count
; i
++)
623 /* Set before_command_echo_length to the value that would
624 have been saved before the start of this subcommand in
625 command_loop_1, if we had already been echoing then. */
626 if (i
== this_single_command_key_start
)
627 before_command_echo_length
= echo_length ();
629 c
= XVECTOR (this_command_keys
)->contents
[i
];
630 if (! (EVENT_HAS_PARAMETERS (c
)
631 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
635 /* Set before_command_echo_length to the value that would
636 have been saved before the start of this subcommand in
637 command_loop_1, if we had already been echoing then. */
638 if (this_command_key_count
== this_single_command_key_start
)
639 before_command_echo_length
= echo_length ();
641 /* Put a dash at the end to invite the user to type more. */
646 message3_nolog (KVAR (current_kboard
, echo_string
),
647 SBYTES (KVAR (current_kboard
, echo_string
)),
648 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
651 /* Record in what buffer we echoed, and from which kboard. */
652 echo_message_buffer
= echo_area_buffer
[0];
653 echo_kboard
= current_kboard
;
655 if (waiting_for_input
&& !NILP (Vquit_flag
))
656 quit_throw_to_read_char ();
659 /* Turn off echoing, for the start of a new command. */
662 cancel_echoing (void)
664 current_kboard
->immediate_echo
= 0;
665 current_kboard
->echo_after_prompt
= -1;
666 KVAR (current_kboard
, echo_string
) = Qnil
;
667 ok_to_echo_at_next_pause
= NULL
;
669 echo_message_buffer
= Qnil
;
672 /* Return the length of the current echo string. */
677 return (STRINGP (KVAR (current_kboard
, echo_string
))
678 ? SCHARS (KVAR (current_kboard
, echo_string
))
682 /* Truncate the current echo message to its first LEN chars.
683 This and echo_char get used by read_key_sequence when the user
684 switches frames while entering a key sequence. */
687 echo_truncate (ptrdiff_t nchars
)
689 if (STRINGP (KVAR (current_kboard
, echo_string
)))
690 KVAR (current_kboard
, echo_string
)
691 = Fsubstring (KVAR (current_kboard
, echo_string
),
692 make_number (0), make_number (nchars
));
693 truncate_echo_area (nchars
);
697 /* Functions for manipulating this_command_keys. */
699 add_command_key (Lisp_Object key
)
701 #if 0 /* Not needed after we made Freset_this_command_lengths
702 do the job immediately. */
703 /* If reset-this-command-length was called recently, obey it now.
704 See the doc string of that function for an explanation of why. */
705 if (before_command_restore_flag
)
707 this_command_key_count
= before_command_key_count_1
;
708 if (this_command_key_count
< this_single_command_key_start
)
709 this_single_command_key_start
= this_command_key_count
;
710 echo_truncate (before_command_echo_length_1
);
711 before_command_restore_flag
= 0;
715 if (this_command_key_count
>= ASIZE (this_command_keys
))
716 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
718 ASET (this_command_keys
, this_command_key_count
, key
);
719 ++this_command_key_count
;
724 recursive_edit_1 (void)
726 ptrdiff_t count
= SPECPDL_INDEX ();
729 if (command_loop_level
> 0)
731 specbind (Qstandard_output
, Qt
);
732 specbind (Qstandard_input
, Qt
);
735 #ifdef HAVE_WINDOW_SYSTEM
736 /* The command loop has started an hourglass timer, so we have to
737 cancel it here, otherwise it will fire because the recursive edit
738 can take some time. Do not check for display_hourglass_p here,
739 because it could already be nil. */
743 /* This function may have been called from a debugger called from
744 within redisplay, for instance by Edebugging a function called
745 from fontification-functions. We want to allow redisplay in
746 the debugging session.
748 The recursive edit is left with a `(throw exit ...)'. The `exit'
749 tag is not caught anywhere in redisplay, i.e. when we leave the
750 recursive edit, the original redisplay leading to the recursive
751 edit will be unwound. The outcome should therefore be safe. */
752 specbind (Qinhibit_redisplay
, Qnil
);
755 val
= command_loop ();
757 Fsignal (Qquit
, Qnil
);
758 /* Handle throw from read_minibuf when using minibuffer
759 while it's active but we're in another window. */
761 xsignal1 (Qerror
, val
);
763 return unbind_to (count
, Qnil
);
766 /* When an auto-save happens, record the "time", and don't do again soon. */
769 record_auto_save (void)
771 last_auto_save
= num_nonmacro_input_events
;
774 /* Make an auto save happen as soon as possible at command level. */
778 force_auto_save_soon (void)
780 last_auto_save
= - auto_save_interval
- 1;
782 record_asynch_buffer_change ();
786 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
787 doc
: /* Invoke the editor command loop recursively.
788 To get out of the recursive edit, a command can do `(throw 'exit nil)';
789 that tells this function to return.
790 Alternatively, `(throw 'exit t)' makes this function signal an error.
791 This function is called by the editor initialization to begin editing. */)
794 ptrdiff_t count
= SPECPDL_INDEX ();
797 /* If we enter while input is blocked, don't lock up here.
798 This may happen through the debugger during redisplay. */
802 command_loop_level
++;
803 update_mode_lines
= 1;
805 if (command_loop_level
806 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
807 buffer
= Fcurrent_buffer ();
811 /* If we leave recursive_edit_1 below with a `throw' for instance,
812 like it is done in the splash screen display, we have to
813 make sure that we restore single_kboard as command_loop_1
814 would have done if it were left normally. */
815 if (command_loop_level
> 0)
816 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
817 record_unwind_protect (recursive_edit_unwind
, buffer
);
820 return unbind_to (count
, Qnil
);
824 recursive_edit_unwind (Lisp_Object buffer
)
826 if (BUFFERP (buffer
))
827 Fset_buffer (buffer
);
829 command_loop_level
--;
830 update_mode_lines
= 1;
835 #if 0 /* These two functions are now replaced with
836 temporarily_switch_to_single_kboard. */
840 #if 0 /* Theory: if there's anything in Vunread_command_events,
841 it will right away be read by read_key_sequence,
842 and then if we do switch KBOARDS, it will go into the side
843 queue then. So we don't need to do anything special here -- rms. */
844 if (CONSP (Vunread_command_events
))
846 current_kboard
->kbd_queue
847 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
848 current_kboard
->kbd_queue_has_data
= 1;
850 Vunread_command_events
= Qnil
;
855 /* Switch to the single-kboard state, making current_kboard
856 the only KBOARD from which further input is accepted. */
859 single_kboard_state ()
865 /* If we're in single_kboard state for kboard KBOARD,
869 not_single_kboard_state (KBOARD
*kboard
)
871 if (kboard
== current_kboard
)
875 /* Maintain a stack of kboards, so other parts of Emacs
876 can switch temporarily to the kboard of a given frame
877 and then revert to the previous status. */
882 struct kboard_stack
*next
;
885 static struct kboard_stack
*kboard_stack
;
888 push_kboard (struct kboard
*k
)
890 struct kboard_stack
*p
891 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
893 p
->next
= kboard_stack
;
894 p
->kboard
= current_kboard
;
904 struct kboard_stack
*p
= kboard_stack
;
906 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
908 if (t
->kboard
== p
->kboard
)
910 current_kboard
= p
->kboard
;
917 /* The terminal we remembered has been deleted. */
918 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
921 kboard_stack
= p
->next
;
925 /* Switch to single_kboard mode, making current_kboard the only KBOARD
926 from which further input is accepted. If F is non-nil, set its
927 KBOARD as the current keyboard.
929 This function uses record_unwind_protect to return to the previous
932 If Emacs is already in single_kboard mode, and F's keyboard is
933 locked, then this function will throw an errow. */
936 temporarily_switch_to_single_kboard (struct frame
*f
)
938 int was_locked
= single_kboard
;
941 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
942 /* We can not switch keyboards while in single_kboard mode.
943 In rare cases, Lisp code may call `recursive-edit' (or
944 `read-minibuffer' or `y-or-n-p') after it switched to a
945 locked frame. For example, this is likely to happen
946 when server.el connects to a new terminal while Emacs is in
947 single_kboard mode. It is best to throw an error instead
948 of presenting the user with a frozen screen. */
949 error ("Terminal %d is locked, cannot read from it",
950 FRAME_TERMINAL (f
)->id
);
952 /* This call is unnecessary, but helps
953 `restore_kboard_configuration' discover if somebody changed
954 `current_kboard' behind our back. */
955 push_kboard (current_kboard
);
958 current_kboard
= FRAME_KBOARD (f
);
960 record_unwind_protect (restore_kboard_configuration
,
961 (was_locked
? Qt
: Qnil
));
964 #if 0 /* This function is not needed anymore. */
966 record_single_kboard_state ()
969 push_kboard (current_kboard
);
970 record_unwind_protect (restore_kboard_configuration
,
971 (single_kboard
? Qt
: Qnil
));
976 restore_kboard_configuration (Lisp_Object was_locked
)
978 if (NILP (was_locked
))
982 struct kboard
*prev
= current_kboard
;
985 /* The pop should not change the kboard. */
986 if (single_kboard
&& current_kboard
!= prev
)
993 /* Handle errors that are not handled at inner levels
994 by printing an error message and returning to the editor command loop. */
997 cmd_error (Lisp_Object data
)
999 Lisp_Object old_level
, old_length
;
1000 char macroerror
[sizeof "After..kbd macro iterations: "
1001 + INT_STRLEN_BOUND (EMACS_INT
)];
1003 #ifdef HAVE_WINDOW_SYSTEM
1004 if (display_hourglass_p
)
1005 cancel_hourglass ();
1008 if (!NILP (executing_kbd_macro
))
1010 if (executing_kbd_macro_iterations
== 1)
1011 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1013 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1014 executing_kbd_macro_iterations
);
1019 Vstandard_output
= Qt
;
1020 Vstandard_input
= Qt
;
1021 Vexecuting_kbd_macro
= Qnil
;
1022 executing_kbd_macro
= Qnil
;
1023 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1024 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1027 /* Avoid unquittable loop if data contains a circular list. */
1028 old_level
= Vprint_level
;
1029 old_length
= Vprint_length
;
1030 XSETFASTINT (Vprint_level
, 10);
1031 XSETFASTINT (Vprint_length
, 10);
1032 cmd_error_internal (data
, macroerror
);
1033 Vprint_level
= old_level
;
1034 Vprint_length
= old_length
;
1038 Vinhibit_quit
= Qnil
;
1039 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1040 if (command_loop_level
== 0 && minibuf_level
== 0)
1041 any_kboard_state ();
1044 return make_number (0);
1047 /* Take actions on handling an error. DATA is the data that describes
1050 CONTEXT is a C-string containing ASCII characters only which
1051 describes the context in which the error happened. If we need to
1052 generalize CONTEXT to allow multibyte characters, make it a Lisp
1056 cmd_error_internal (Lisp_Object data
, const char *context
)
1058 struct frame
*sf
= SELECTED_FRAME ();
1060 /* The immediate context is not interesting for Quits,
1061 since they are asyncronous. */
1062 if (EQ (XCAR (data
), Qquit
))
1063 Vsignaling_function
= Qnil
;
1068 /* Use user's specified output function if any. */
1069 if (!NILP (Vcommand_error_function
))
1070 call3 (Vcommand_error_function
, data
,
1071 context
? build_string (context
) : empty_unibyte_string
,
1072 Vsignaling_function
);
1073 /* If the window system or terminal frame hasn't been initialized
1074 yet, or we're not interactive, write the message to stderr and exit. */
1075 else if (!sf
->glyphs_initialized_p
1076 /* The initial frame is a special non-displaying frame. It
1077 will be current in daemon mode when there are no frames
1078 to display, and in non-daemon mode before the real frame
1079 has finished initializing. If an error is thrown in the
1080 latter case while creating the frame, then the frame
1081 will never be displayed, so the safest thing to do is
1082 write to stderr and quit. In daemon mode, there are
1083 many other potential errors that do not prevent frames
1084 from being created, so continuing as normal is better in
1086 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1089 print_error_message (data
, Qexternal_debugging_output
,
1090 context
, Vsignaling_function
);
1091 Fterpri (Qexternal_debugging_output
);
1092 Fkill_emacs (make_number (-1));
1096 clear_message (1, 0);
1098 message_log_maybe_newline ();
1101 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1104 Vsignaling_function
= Qnil
;
1107 Lisp_Object
command_loop_1 (void);
1108 static Lisp_Object
command_loop_2 (Lisp_Object
);
1109 static Lisp_Object
top_level_1 (Lisp_Object
);
1111 /* Entry to editor-command-loop.
1112 This level has the catches for exiting/returning to editor command loop.
1113 It returns nil to exit recursive edit, t to abort it. */
1118 if (command_loop_level
> 0 || minibuf_level
> 0)
1121 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1122 executing_kbd_macro
= Qnil
;
1128 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1129 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1130 /* Reset single_kboard in case top-level set it while
1131 evaluating an -f option, or we are stuck there for some
1133 any_kboard_state ();
1135 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1136 executing_kbd_macro
= Qnil
;
1138 /* End of file in -batch run causes exit here. */
1144 /* Here we catch errors in execution of commands within the
1145 editing loop, and reenter the editing loop.
1146 When there is an error, cmd_error runs and returns a non-nil
1147 value to us. A value of nil means that command_loop_1 itself
1148 returned due to end of file (or end of kbd macro). */
1151 command_loop_2 (Lisp_Object ignore
)
1153 register Lisp_Object val
;
1156 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1157 while (!NILP (val
));
1165 return Feval (Vtop_level
, Qnil
);
1169 top_level_1 (Lisp_Object ignore
)
1171 /* On entry to the outer level, run the startup file */
1172 if (!NILP (Vtop_level
))
1173 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1174 else if (!NILP (Vpurify_flag
))
1175 message ("Bare impure Emacs (standard Lisp code not loaded)");
1177 message ("Bare Emacs (standard Lisp code not loaded)");
1181 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1182 doc
: /* Exit all recursive editing levels.
1183 This also exits all active minibuffers. */)
1186 #ifdef HAVE_WINDOW_SYSTEM
1187 if (display_hourglass_p
)
1188 cancel_hourglass ();
1191 /* Unblock input if we enter with input blocked. This may happen if
1192 redisplay traps e.g. during tool-bar update with input blocked. */
1193 while (INPUT_BLOCKED_P
)
1196 Fthrow (Qtop_level
, Qnil
);
1199 static Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1200 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1201 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1204 if (command_loop_level
> 0 || minibuf_level
> 0)
1205 Fthrow (Qexit
, Qnil
);
1207 error ("No recursive edit is in progress");
1210 static Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1211 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1212 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1215 if (command_loop_level
> 0 || minibuf_level
> 0)
1218 error ("No recursive edit is in progress");
1221 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1223 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1224 of this function. */
1227 tracking_off (Lisp_Object old_value
)
1229 do_mouse_tracking
= old_value
;
1230 if (NILP (old_value
))
1232 /* Redisplay may have been preempted because there was input
1233 available, and it assumes it will be called again after the
1234 input has been processed. If the only input available was
1235 the sort that we have just disabled, then we need to call
1237 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1239 redisplay_preserve_echo_area (6);
1240 get_input_pending (&input_pending
,
1241 READABLE_EVENTS_DO_TIMERS_NOW
);
1247 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1248 doc
: /* Evaluate BODY with mouse movement events enabled.
1249 Within a `track-mouse' form, mouse motion generates input events that
1250 you can read with `read-event'.
1251 Normally, mouse motion is ignored.
1252 usage: (track-mouse BODY...) */)
1255 ptrdiff_t count
= SPECPDL_INDEX ();
1258 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1260 do_mouse_tracking
= Qt
;
1262 val
= Fprogn (args
);
1263 return unbind_to (count
, val
);
1266 /* If mouse has moved on some frame, return one of those frames.
1270 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1271 after resizing the tool-bar window. */
1273 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1276 int ignore_mouse_drag_p
;
1279 some_mouse_moved (void)
1281 Lisp_Object tail
, frame
;
1283 if (ignore_mouse_drag_p
)
1285 /* ignore_mouse_drag_p = 0; */
1289 FOR_EACH_FRAME (tail
, frame
)
1291 if (XFRAME (frame
)->mouse_moved
)
1292 return XFRAME (frame
);
1298 #endif /* HAVE_MOUSE || HAVE_GPM */
1300 /* This is the actual command reading loop,
1301 sans error-handling encapsulation. */
1303 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1305 void safe_run_hooks (Lisp_Object
);
1306 static void adjust_point_for_property (ptrdiff_t, int);
1308 /* Cancel hourglass from protect_unwind.
1310 #ifdef HAVE_WINDOW_SYSTEM
1312 cancel_hourglass_unwind (Lisp_Object arg
)
1314 cancel_hourglass ();
1319 /* FIXME: This is wrong rather than test window-system, we should call
1320 a new set-selection, which will then dispatch to x-set-selection, or
1321 tty-set-selection, or w32-set-selection, ... */
1322 EXFUN (Fwindow_system
, 1);
1325 command_loop_1 (void)
1328 Lisp_Object keybuf
[30];
1330 EMACS_INT prev_modiff
= 0;
1331 struct buffer
*prev_buffer
= NULL
;
1332 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1333 int was_locked
= single_kboard
;
1335 int already_adjusted
= 0;
1337 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1338 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1339 Vdeactivate_mark
= Qnil
;
1340 waiting_for_input
= 0;
1343 this_command_key_count
= 0;
1344 this_command_key_count_reset
= 0;
1345 this_single_command_key_start
= 0;
1347 if (NILP (Vmemory_full
))
1349 /* Make sure this hook runs after commands that get errors and
1350 throw to top level. */
1351 /* Note that the value cell will never directly contain nil
1352 if the symbol is a local variable. */
1353 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1354 safe_run_hooks (Qpost_command_hook
);
1356 /* If displaying a message, resize the echo area window to fit
1357 that message's size exactly. */
1358 if (!NILP (echo_area_buffer
[0]))
1359 resize_echo_area_exactly ();
1361 /* If there are warnings waiting, process them. */
1362 if (!NILP (Vdelayed_warnings_list
))
1363 safe_run_hooks (Qdelayed_warnings_hook
);
1365 if (!NILP (Vdeferred_action_list
))
1366 safe_run_hooks (Qdeferred_action_function
);
1369 /* Do this after running Vpost_command_hook, for consistency. */
1370 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1371 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1372 if (!CONSP (last_command_event
))
1373 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1377 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1380 /* Make sure the current window's buffer is selected. */
1381 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1382 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1384 /* Display any malloc warning that just came out. Use while because
1385 displaying one warning can cause another. */
1387 while (pending_malloc_warning
)
1388 display_malloc_warning ();
1390 Vdeactivate_mark
= Qnil
;
1392 /* If minibuffer on and echo area in use,
1393 wait a short time and redraw minibuffer. */
1396 && !NILP (echo_area_buffer
[0])
1397 && EQ (minibuf_window
, echo_area_window
)
1398 && NUMBERP (Vminibuffer_message_timeout
))
1400 /* Bind inhibit-quit to t so that C-g gets read in
1401 rather than quitting back to the minibuffer. */
1402 ptrdiff_t count
= SPECPDL_INDEX ();
1403 specbind (Qinhibit_quit
, Qt
);
1405 sit_for (Vminibuffer_message_timeout
, 0, 2);
1407 /* Clear the echo area. */
1409 safe_run_hooks (Qecho_area_clear_hook
);
1411 unbind_to (count
, Qnil
);
1413 /* If a C-g came in before, treat it as input now. */
1414 if (!NILP (Vquit_flag
))
1417 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1422 /* Select the frame that the last event came from. Usually,
1423 switch-frame events will take care of this, but if some lisp
1424 code swallows a switch-frame event, we'll fix things up here.
1425 Is this a good idea? */
1426 if (FRAMEP (internal_last_event_frame
)
1427 && !EQ (internal_last_event_frame
, selected_frame
))
1428 Fselect_frame (internal_last_event_frame
, Qnil
);
1430 /* If it has changed current-menubar from previous value,
1431 really recompute the menubar from the value. */
1432 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1433 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1434 call0 (Qrecompute_lucid_menubar
);
1436 before_command_key_count
= this_command_key_count
;
1437 before_command_echo_length
= echo_length ();
1439 Vthis_command
= Qnil
;
1440 real_this_command
= Qnil
;
1441 Vthis_original_command
= Qnil
;
1442 Vthis_command_keys_shift_translated
= Qnil
;
1444 /* Read next key sequence; i gets its length. */
1445 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1448 /* A filter may have run while we were reading the input. */
1449 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1451 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1452 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1456 /* Now we have read a key sequence of length I,
1457 or else I is 0 and we found end of file. */
1459 if (i
== 0) /* End of file -- happens only in */
1460 return Qnil
; /* a kbd macro, at the end. */
1461 /* -1 means read_key_sequence got a menu that was rejected.
1462 Just loop around and read another command. */
1466 this_command_key_count
= 0;
1467 this_command_key_count_reset
= 0;
1468 this_single_command_key_start
= 0;
1472 last_command_event
= keybuf
[i
- 1];
1474 /* If the previous command tried to force a specific window-start,
1475 forget about that, in case this command moves point far away
1476 from that position. But also throw away beg_unchanged and
1477 end_unchanged information in that case, so that redisplay will
1478 update the whole window properly. */
1479 if (!NILP (XWINDOW (selected_window
)->force_start
))
1482 XWINDOW (selected_window
)->force_start
= Qnil
;
1483 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1484 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1487 cmd
= read_key_sequence_cmd
;
1488 if (!NILP (Vexecuting_kbd_macro
))
1490 if (!NILP (Vquit_flag
))
1492 Vexecuting_kbd_macro
= Qt
;
1493 QUIT
; /* Make some noise. */
1494 /* Will return since macro now empty. */
1498 /* Do redisplay processing after this command except in special
1499 cases identified below. */
1500 prev_buffer
= current_buffer
;
1501 prev_modiff
= MODIFF
;
1502 last_point_position
= PT
;
1503 last_point_position_window
= selected_window
;
1504 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1506 /* By default, we adjust point to a boundary of a region that
1507 has such a property that should be treated intangible
1508 (e.g. composition, display). But, some commands will set
1509 this variable differently. */
1510 Vdisable_point_adjustment
= Qnil
;
1512 /* Process filters and timers may have messed with deactivate-mark.
1513 reset it before we execute the command. */
1514 Vdeactivate_mark
= Qnil
;
1516 /* Remap command through active keymaps. */
1517 Vthis_original_command
= cmd
;
1518 if (!NILP (read_key_sequence_remapped
))
1519 cmd
= read_key_sequence_remapped
;
1521 /* Execute the command. */
1523 Vthis_command
= cmd
;
1524 real_this_command
= cmd
;
1525 safe_run_hooks (Qpre_command_hook
);
1527 already_adjusted
= 0;
1529 if (NILP (Vthis_command
))
1531 /* nil means key is undefined. */
1532 Lisp_Object keys
= Fvector (i
, keybuf
);
1533 keys
= Fkey_description (keys
, Qnil
);
1535 message_with_string ("%s is undefined", keys
, 0);
1536 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1537 update_mode_lines
= 1;
1538 /* If this is a down-mouse event, don't reset prefix-arg;
1539 pass it to the command run by the up event. */
1540 if (EVENT_HAS_PARAMETERS (last_command_event
))
1542 Lisp_Object breakdown
1543 = parse_modifiers (EVENT_HEAD (last_command_event
));
1544 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1545 if (!(modifiers
& down_modifier
))
1546 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1549 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1553 /* Here for a command that isn't executed directly */
1555 #ifdef HAVE_WINDOW_SYSTEM
1556 ptrdiff_t scount
= SPECPDL_INDEX ();
1558 if (display_hourglass_p
1559 && NILP (Vexecuting_kbd_macro
))
1561 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1566 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1568 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1570 #ifdef HAVE_WINDOW_SYSTEM
1571 /* Do not check display_hourglass_p here, because
1572 Fcommand_execute could change it, but we should cancel
1573 hourglass cursor anyway.
1574 But don't cancel the hourglass within a macro
1575 just because a command in the macro finishes. */
1576 if (NILP (Vexecuting_kbd_macro
))
1577 unbind_to (scount
, Qnil
);
1580 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1582 safe_run_hooks (Qpost_command_hook
);
1584 /* If displaying a message, resize the echo area window to fit
1585 that message's size exactly. */
1586 if (!NILP (echo_area_buffer
[0]))
1587 resize_echo_area_exactly ();
1589 /* If there are warnings waiting, process them. */
1590 if (!NILP (Vdelayed_warnings_list
))
1591 safe_run_hooks (Qdelayed_warnings_hook
);
1593 safe_run_hooks (Qdeferred_action_function
);
1595 /* If there is a prefix argument,
1596 1) We don't want Vlast_command to be ``universal-argument''
1597 (that would be dumb), so don't set Vlast_command,
1598 2) we want to leave echoing on so that the prefix will be
1599 echoed as part of this key sequence, so don't call
1601 3) we want to leave this_command_key_count non-zero, so that
1602 read_char will realize that it is re-reading a character, and
1603 not echo it a second time.
1605 If the command didn't actually create a prefix arg,
1606 but is merely a frame event that is transparent to prefix args,
1607 then the above doesn't apply. */
1608 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1610 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1611 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1612 if (!CONSP (last_command_event
))
1613 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1615 this_command_key_count
= 0;
1616 this_command_key_count_reset
= 0;
1617 this_single_command_key_start
= 0;
1620 if (!NILP (BVAR (current_buffer
, mark_active
))
1621 && !NILP (Vrun_hooks
))
1623 /* In Emacs 22, setting transient-mark-mode to `only' was a
1624 way of turning it on for just one command. This usage is
1625 obsolete, but support it anyway. */
1626 if (EQ (Vtransient_mark_mode
, Qidentity
))
1627 Vtransient_mark_mode
= Qnil
;
1628 else if (EQ (Vtransient_mark_mode
, Qonly
))
1629 Vtransient_mark_mode
= Qidentity
;
1631 if (!NILP (Vdeactivate_mark
))
1632 /* If `select-active-regions' is non-nil, this call to
1633 `deactivate-mark' also sets the PRIMARY selection. */
1634 call0 (Qdeactivate_mark
);
1637 /* Even if not deactivating the mark, set PRIMARY if
1638 `select-active-regions' is non-nil. */
1639 if (!NILP (Fwindow_system (Qnil
))
1640 /* Even if mark_active is non-nil, the actual buffer
1641 marker may not have been set yet (Bug#7044). */
1642 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1643 && (EQ (Vselect_active_regions
, Qonly
)
1644 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1645 : (!NILP (Vselect_active_regions
)
1646 && !NILP (Vtransient_mark_mode
)))
1647 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1650 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1653 call2 (Qx_set_selection
, QPRIMARY
,
1654 make_buffer_string (beg
, end
, 0));
1656 call2 (Qx_set_selection
, QPRIMARY
,
1657 make_buffer_string (end
, beg
, 0));
1658 /* Don't set empty selections. */
1661 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1663 Lisp_Object hook
= intern ("activate-mark-hook");
1664 Frun_hooks (1, &hook
);
1668 Vsaved_region_selection
= Qnil
;
1673 if (current_buffer
== prev_buffer
1674 && last_point_position
!= PT
1675 && NILP (Vdisable_point_adjustment
)
1676 && NILP (Vglobal_disable_point_adjustment
))
1678 if (last_point_position
> BEGV
1679 && last_point_position
< ZV
1680 && (composition_adjust_point (last_point_position
,
1681 last_point_position
)
1682 != last_point_position
))
1683 /* The last point was temporarily set within a grapheme
1684 cluster to prevent automatic composition. To recover
1685 the automatic composition, we must update the
1687 windows_or_buffers_changed
++;
1688 if (!already_adjusted
)
1689 adjust_point_for_property (last_point_position
,
1690 MODIFF
!= prev_modiff
);
1693 /* Install chars successfully executed in kbd macro. */
1695 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1696 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1697 finalize_kbd_macro_chars ();
1698 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1700 any_kboard_state ();
1705 /* Adjust point to a boundary of a region that has such a property
1706 that should be treated intangible. For the moment, we check
1707 `composition', `display' and `invisible' properties.
1708 LAST_PT is the last position of point. */
1711 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1714 Lisp_Object val
, overlay
, tmp
;
1715 /* When called after buffer modification, we should temporarily
1716 suppress the point adjustment for automatic composition so that a
1717 user can keep inserting another character at point or keep
1718 deleting characters around point. */
1719 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1720 ptrdiff_t orig_pt
= PT
;
1722 /* FIXME: cycling is probably not necessary because these properties
1723 can't be usefully combined anyway. */
1724 while (check_composition
|| check_display
|| check_invisible
)
1726 /* FIXME: check `intangible'. */
1727 if (check_composition
1728 && PT
> BEGV
&& PT
< ZV
1729 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1732 check_display
= check_invisible
= 1;
1734 check_composition
= 0;
1736 && PT
> BEGV
&& PT
< ZV
1737 && !NILP (val
= get_char_property_and_overlay
1738 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1739 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1740 && (!OVERLAYP (overlay
)
1741 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1742 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1743 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1744 && (beg
< PT
/* && end > PT <- It's always the case. */
1745 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1748 SET_PT (PT
< last_pt
1749 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1751 check_composition
= check_invisible
= 1;
1754 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1756 int inv
, ellipsis
= 0;
1759 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1762 /* FIXME: We should stop if we find a spot between
1763 two runs of `invisible' where inserted text would
1764 be visible. This is important when we have two
1765 invisible boundaries that enclose an area: if the
1766 area is empty, we need this test in order to make
1767 it possible to place point in the middle rather
1768 than skip both boundaries. However, this code
1769 also stops anywhere in a non-sticky text-property,
1770 which breaks (e.g.) Org mode. */
1771 && (val
= get_pos_property (make_number (end
),
1773 TEXT_PROP_MEANS_INVISIBLE (val
))
1775 && !NILP (val
= get_char_property_and_overlay
1776 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1777 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1779 ellipsis
= ellipsis
|| inv
> 1
1780 || (OVERLAYP (overlay
)
1781 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1782 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1783 tmp
= Fnext_single_char_property_change
1784 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1785 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1789 && (val
= get_pos_property (make_number (beg
),
1791 TEXT_PROP_MEANS_INVISIBLE (val
))
1793 && !NILP (val
= get_char_property_and_overlay
1794 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1795 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1797 ellipsis
= ellipsis
|| inv
> 1
1798 || (OVERLAYP (overlay
)
1799 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1800 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1801 tmp
= Fprevious_single_char_property_change
1802 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1803 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1806 /* Move away from the inside area. */
1807 if (beg
< PT
&& end
> PT
)
1809 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1810 /* We haven't moved yet (so we don't need to fear
1811 infinite-looping) and we were outside the range
1812 before (so either end of the range still corresponds
1813 to a move in the right direction): pretend we moved
1814 less than we actually did, so that we still have
1815 more freedom below in choosing which end of the range
1817 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1818 /* We either have moved already or the last point
1819 was already in the range: we don't get to choose
1820 which end of the range we have to go to. */
1821 : (PT
< last_pt
? beg
: end
));
1822 check_composition
= check_display
= 1;
1824 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1825 the point to something other than its argument, due to
1826 point-motion hooks, intangibility, etc. */
1827 xassert (PT
== beg
|| PT
== end
);
1830 /* Pretend the area doesn't exist if the buffer is not
1832 if (!modified
&& !ellipsis
&& beg
< end
)
1834 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1835 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1836 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1837 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1838 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1839 /* We've already moved as far as we can. Trying to go
1840 to the other end would mean moving backwards and thus
1841 could lead to an infinite loop. */
1843 else if (val
= get_pos_property (make_number (PT
),
1845 TEXT_PROP_MEANS_INVISIBLE (val
)
1846 && (val
= get_pos_property
1847 (make_number (PT
== beg
? end
: beg
),
1849 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1850 (check_composition
= check_display
= 1,
1851 SET_PT (PT
== beg
? end
: beg
));
1854 check_invisible
= 0;
1858 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1861 safe_run_hooks_1 (void)
1863 eassert (CONSP (Vinhibit_quit
));
1864 return call0 (XCDR (Vinhibit_quit
));
1867 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1871 safe_run_hooks_error (Lisp_Object error_data
)
1874 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1875 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1876 Lisp_Object args
[4];
1877 args
[0] = build_string ("Error in %s (%s): %s");
1880 args
[3] = error_data
;
1886 Lisp_Object newval
= Qnil
;
1887 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1888 if (EQ (fun
, XCAR (val
)))
1891 newval
= Fcons (XCAR (val
), newval
);
1893 return Fset (hook
, Fnreverse (newval
));
1894 /* Not found in the local part of the hook. Let's look at the global
1897 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1898 : Fdefault_value (hook
));
1899 CONSP (val
); val
= XCDR (val
))
1900 if (EQ (fun
, XCAR (val
)))
1903 newval
= Fcons (XCAR (val
), newval
);
1905 return Fset_default (hook
, Fnreverse (newval
));
1911 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1913 eassert (nargs
== 1);
1914 if (CONSP (Vinhibit_quit
))
1915 XSETCDR (Vinhibit_quit
, args
[0]);
1917 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1919 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1923 /* If we get an error while running the hook, cause the hook variable
1924 to be nil. Also inhibit quits, so that C-g won't cause the hook
1925 to mysteriously evaporate. */
1928 safe_run_hooks (Lisp_Object hook
)
1930 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1931 to its body or to its handlers other than via globals such as
1932 dynamically-bound variables ;-) */
1933 ptrdiff_t count
= SPECPDL_INDEX ();
1934 specbind (Qinhibit_quit
, hook
);
1936 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1938 unbind_to (count
, Qnil
);
1942 /* Nonzero means polling for input is temporarily suppressed. */
1944 int poll_suppress_count
;
1946 /* Asynchronous timer for polling. */
1948 static struct atimer
*poll_timer
;
1951 #ifdef POLL_FOR_INPUT
1953 /* Poll for input, so that we catch a C-g if it comes in. This
1954 function is called from x_make_frame_visible, see comment
1958 poll_for_input_1 (void)
1960 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1961 doing anything dangerous. */
1965 if (interrupt_input_blocked
== 0
1966 && !waiting_for_input
)
1967 read_avail_input (0);
1973 /* Timer callback function for poll_timer. TIMER is equal to
1977 poll_for_input (struct atimer
*timer
)
1979 if (poll_suppress_count
== 0)
1982 interrupt_input_pending
= 1;
1983 pending_signals
= 1;
1985 poll_for_input_1 ();
1990 #endif /* POLL_FOR_INPUT */
1992 /* Begin signals to poll for input, if they are appropriate.
1993 This function is called unconditionally from various places. */
1996 start_polling (void)
1998 #ifdef POLL_FOR_INPUT
1999 /* XXX This condition was (read_socket_hook && !interrupt_input),
2000 but read_socket_hook is not global anymore. Let's pretend that
2002 if (!interrupt_input
)
2004 /* Turn alarm handling on unconditionally. It might have
2005 been turned off in process.c. */
2006 turn_on_atimers (1);
2008 /* If poll timer doesn't exist, are we need one with
2009 a different interval, start a new one. */
2010 if (poll_timer
== NULL
2011 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2013 EMACS_TIME interval
;
2016 cancel_atimer (poll_timer
);
2018 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2019 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2020 poll_for_input
, NULL
);
2023 /* Let the timer's callback function poll for input
2024 if this becomes zero. */
2025 --poll_suppress_count
;
2030 /* Nonzero if we are using polling to handle input asynchronously. */
2033 input_polling_used (void)
2035 #ifdef POLL_FOR_INPUT
2036 /* XXX This condition was (read_socket_hook && !interrupt_input),
2037 but read_socket_hook is not global anymore. Let's pretend that
2039 return !interrupt_input
;
2045 /* Turn off polling. */
2050 #ifdef POLL_FOR_INPUT
2051 /* XXX This condition was (read_socket_hook && !interrupt_input),
2052 but read_socket_hook is not global anymore. Let's pretend that
2054 if (!interrupt_input
)
2055 ++poll_suppress_count
;
2059 /* Set the value of poll_suppress_count to COUNT
2060 and start or stop polling accordingly. */
2063 set_poll_suppress_count (int count
)
2065 #ifdef POLL_FOR_INPUT
2066 if (count
== 0 && poll_suppress_count
!= 0)
2068 poll_suppress_count
= 1;
2071 else if (count
!= 0 && poll_suppress_count
== 0)
2075 poll_suppress_count
= count
;
2079 /* Bind polling_period to a value at least N.
2080 But don't decrease it. */
2083 bind_polling_period (int n
)
2085 #ifdef POLL_FOR_INPUT
2086 int new = polling_period
;
2091 stop_other_atimers (poll_timer
);
2093 specbind (Qpolling_period
, make_number (new));
2094 /* Start a new alarm with the new period. */
2099 /* Apply the control modifier to CHARACTER. */
2102 make_ctrl_char (int c
)
2104 /* Save the upper bits here. */
2105 int upper
= c
& ~0177;
2107 if (! ASCII_BYTE_P (c
))
2108 return c
|= ctrl_modifier
;
2112 /* Everything in the columns containing the upper-case letters
2113 denotes a control character. */
2114 if (c
>= 0100 && c
< 0140)
2118 /* Set the shift modifier for a control char
2119 made from a shifted letter. But only for letters! */
2120 if (oc
>= 'A' && oc
<= 'Z')
2121 c
|= shift_modifier
;
2124 /* The lower-case letters denote control characters too. */
2125 else if (c
>= 'a' && c
<= 'z')
2128 /* Include the bits for control and shift
2129 only if the basic ASCII code can't indicate them. */
2133 /* Replace the high bits. */
2134 c
|= (upper
& ~ctrl_modifier
);
2139 /* Display the help-echo property of the character after the mouse pointer.
2140 Either show it in the echo area, or call show-help-function to display
2141 it by other means (maybe in a tooltip).
2143 If HELP is nil, that means clear the previous help echo.
2145 If HELP is a string, display that string. If HELP is a function,
2146 call it with OBJECT and POS as arguments; the function should
2147 return a help string or nil for none. For all other types of HELP,
2148 evaluate it to obtain a string.
2150 WINDOW is the window in which the help was generated, if any.
2151 It is nil if not in a window.
2153 If OBJECT is a buffer, POS is the position in the buffer where the
2154 `help-echo' text property was found.
2156 If OBJECT is an overlay, that overlay has a `help-echo' property,
2157 and POS is the position in the overlay's buffer under the mouse.
2159 If OBJECT is a string (an overlay string or a string displayed with
2160 the `display' property). POS is the position in that string under
2163 Note: this function may only be called with HELP nil or a string
2164 from X code running asynchronously. */
2167 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2170 if (!NILP (help
) && !STRINGP (help
))
2172 if (FUNCTIONP (help
))
2174 Lisp_Object args
[4];
2179 help
= safe_call (4, args
);
2182 help
= safe_eval (help
);
2184 if (!STRINGP (help
))
2188 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2189 if (!noninteractive
&& STRINGP (help
))
2191 /* The mouse-fixup-help-message Lisp function can call
2192 mouse_position_hook, which resets the mouse_moved flags.
2193 This causes trouble if we are trying to read a mouse motion
2194 event (i.e., if we are inside a `track-mouse' form), so we
2195 restore the mouse_moved flag. */
2196 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2197 help
= call1 (Qmouse_fixup_help_message
, help
);
2203 if (STRINGP (help
) || NILP (help
))
2205 if (!NILP (Vshow_help_function
))
2206 call1 (Vshow_help_function
, help
);
2207 help_echo_showing_p
= STRINGP (help
);
2213 /* Input of single characters from keyboard */
2215 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2216 struct timeval
*end_time
);
2217 static void record_char (Lisp_Object c
);
2219 static Lisp_Object help_form_saved_window_configs
;
2221 read_char_help_form_unwind (Lisp_Object arg
)
2223 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2224 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2225 if (!NILP (window_config
))
2226 Fset_window_configuration (window_config
);
2230 #define STOP_POLLING \
2231 do { if (! polling_stopped_here) stop_polling (); \
2232 polling_stopped_here = 1; } while (0)
2234 #define RESUME_POLLING \
2235 do { if (polling_stopped_here) start_polling (); \
2236 polling_stopped_here = 0; } while (0)
2238 /* read a character from the keyboard; call the redisplay if needed */
2239 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2240 -1 means do not do redisplay, but do do autosaving.
2243 /* The arguments MAPS and NMAPS are for menu prompting.
2244 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2246 PREV_EVENT is the previous input event, or nil if we are reading
2247 the first event of a key sequence (or not reading a key sequence).
2248 If PREV_EVENT is t, that is a "magic" value that says
2249 not to run input methods, but in other respects to act as if
2250 not reading a key sequence.
2252 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2253 if we used a mouse menu to read the input, or zero otherwise. If
2254 USED_MOUSE_MENU is null, we don't dereference it.
2256 Value is -2 when we find input on another keyboard. A second call
2257 to read_char will read it.
2259 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2260 specifying the maximum time to wait until. If no input arrives by
2261 that time, stop waiting and return nil.
2263 Value is t if we showed a menu and the user rejected it. */
2266 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2267 Lisp_Object prev_event
,
2268 int *used_mouse_menu
, struct timeval
*end_time
)
2270 volatile Lisp_Object c
;
2272 jmp_buf local_getcjmp
;
2274 volatile int key_already_recorded
= 0;
2275 Lisp_Object tem
, save
;
2276 volatile Lisp_Object previous_echo_area_message
;
2277 volatile Lisp_Object also_record
;
2278 volatile int reread
;
2279 struct gcpro gcpro1
, gcpro2
;
2280 int volatile polling_stopped_here
= 0;
2281 struct kboard
*orig_kboard
= current_kboard
;
2285 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2286 before_command_key_count
= this_command_key_count
;
2287 before_command_echo_length
= echo_length ();
2290 previous_echo_area_message
= Qnil
;
2292 GCPRO2 (c
, previous_echo_area_message
);
2297 if (CONSP (Vunread_post_input_method_events
))
2299 c
= XCAR (Vunread_post_input_method_events
);
2300 Vunread_post_input_method_events
2301 = XCDR (Vunread_post_input_method_events
);
2303 /* Undo what read_char_x_menu_prompt did when it unread
2304 additional keys returned by Fx_popup_menu. */
2306 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2314 if (unread_command_char
!= -1)
2316 XSETINT (c
, unread_command_char
);
2317 unread_command_char
= -1;
2323 if (CONSP (Vunread_command_events
))
2325 int was_disabled
= 0;
2327 c
= XCAR (Vunread_command_events
);
2328 Vunread_command_events
= XCDR (Vunread_command_events
);
2332 /* Undo what sit-for did when it unread additional keys
2333 inside universal-argument. */
2336 && EQ (XCAR (c
), Qt
))
2342 /* Undo what read_char_x_menu_prompt did when it unread
2343 additional keys returned by Fx_popup_menu. */
2345 && EQ (XCDR (c
), Qdisabled
)
2346 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2352 /* If the queued event is something that used the mouse,
2353 set used_mouse_menu accordingly. */
2355 /* Also check was_disabled so last-nonmenu-event won't return
2356 a bad value when submenus are involved. (Bug#447) */
2357 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2358 *used_mouse_menu
= 1;
2360 goto reread_for_input_method
;
2363 if (CONSP (Vunread_input_method_events
))
2365 c
= XCAR (Vunread_input_method_events
);
2366 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2368 /* Undo what read_char_x_menu_prompt did when it unread
2369 additional keys returned by Fx_popup_menu. */
2371 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2375 goto reread_for_input_method
;
2378 this_command_key_count_reset
= 0;
2380 if (!NILP (Vexecuting_kbd_macro
))
2382 /* We set this to Qmacro; since that's not a frame, nobody will
2383 try to switch frames on us, and the selected window will
2386 Since this event came from a macro, it would be misleading to
2387 leave internal_last_event_frame set to wherever the last
2388 real event came from. Normally, a switch-frame event selects
2389 internal_last_event_frame after each command is read, but
2390 events read from a macro should never cause a new frame to be
2392 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2394 /* Exit the macro if we are at the end.
2395 Also, some things replace the macro with t
2396 to force an early exit. */
2397 if (EQ (Vexecuting_kbd_macro
, Qt
)
2398 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2404 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2405 if (STRINGP (Vexecuting_kbd_macro
)
2406 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2407 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2409 executing_kbd_macro_index
++;
2414 if (!NILP (unread_switch_frame
))
2416 c
= unread_switch_frame
;
2417 unread_switch_frame
= Qnil
;
2419 /* This event should make it into this_command_keys, and get echoed
2420 again, so we do not set `reread'. */
2424 /* if redisplay was requested */
2425 if (commandflag
>= 0)
2427 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2429 /* If there is pending input, process any events which are not
2430 user-visible, such as X selection_request events. */
2432 || detect_input_pending_run_timers (0))
2433 swallow_events (0); /* may clear input_pending */
2435 /* Redisplay if no pending input. */
2436 while (!input_pending
)
2438 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2439 redisplay_preserve_echo_area (5);
2444 /* Normal case: no input arrived during redisplay. */
2447 /* Input arrived and pre-empted redisplay.
2448 Process any events which are not user-visible. */
2450 /* If that cleared input_pending, try again to redisplay. */
2453 /* Prevent the redisplay we just did
2454 from messing up echoing of the input after the prompt. */
2455 if (commandflag
== 0 && echo_current
)
2456 echo_message_buffer
= echo_area_buffer
[0];
2460 /* Message turns off echoing unless more keystrokes turn it on again.
2462 The code in 20.x for the condition was
2464 1. echo_area_glyphs && *echo_area_glyphs
2465 2. && echo_area_glyphs != current_kboard->echobuf
2466 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2468 (1) means there's a current message displayed
2470 (2) means it's not the message from echoing from the current
2473 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2474 is set to a non-null value. This is done in read_char and it is
2475 set to echo_area_glyphs after a call to echo_char. That means
2476 ok_to_echo_at_next_pause is either null or
2477 current_kboard->echobuf with the appropriate current_kboard at
2480 So, condition (3) means in clear text ok_to_echo_at_next_pause
2481 must be either null, or the current message isn't from echoing at
2482 all, or it's from echoing from a different kboard than the
2485 if (/* There currently is something in the echo area. */
2486 !NILP (echo_area_buffer
[0])
2487 && (/* And it's either not from echoing. */
2488 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2489 /* Or it's an echo from a different kboard. */
2490 || echo_kboard
!= current_kboard
2491 /* Or we explicitly allow overwriting whatever there is. */
2492 || ok_to_echo_at_next_pause
== NULL
))
2497 /* Try reading a character via menu prompting in the minibuf.
2498 Try this before the sit-for, because the sit-for
2499 would do the wrong thing if we are supposed to do
2500 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2501 after a mouse event so don't try a minibuf menu. */
2503 if (nmaps
> 0 && INTERACTIVE
2504 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2505 /* Don't bring up a menu if we already have another event. */
2506 && NILP (Vunread_command_events
)
2507 && unread_command_char
< 0
2508 && !detect_input_pending_run_timers (0))
2510 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2512 if (INTEGERP (c
) && XINT (c
) == -2)
2513 return c
; /* wrong_kboard_jmpbuf */
2517 key_already_recorded
= 1;
2522 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2523 We will do that below, temporarily for short sections of code,
2524 when appropriate. local_getcjmp must be in effect
2525 around any call to sit_for or kbd_buffer_get_event;
2526 it *must not* be in effect when we call redisplay. */
2528 jmpcount
= SPECPDL_INDEX ();
2529 if (_setjmp (local_getcjmp
))
2531 /* Handle quits while reading the keyboard. */
2532 /* We must have saved the outer value of getcjmp here,
2533 so restore it now. */
2534 restore_getcjmp (save_jump
);
2535 unbind_to (jmpcount
, Qnil
);
2536 XSETINT (c
, quit_char
);
2537 internal_last_event_frame
= selected_frame
;
2538 Vlast_event_frame
= internal_last_event_frame
;
2539 /* If we report the quit char as an event,
2540 don't do so more than once. */
2541 if (!NILP (Vinhibit_quit
))
2545 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2546 if (kb
!= current_kboard
)
2548 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2549 /* We shouldn't get here if we were in single-kboard mode! */
2554 while (CONSP (XCDR (last
)))
2556 if (!NILP (XCDR (last
)))
2560 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2562 XSETCDR (last
, Fcons (c
, Qnil
));
2563 kb
->kbd_queue_has_data
= 1;
2564 current_kboard
= kb
;
2565 /* This is going to exit from read_char
2566 so we had better get rid of this frame's stuff. */
2568 return make_number (-2); /* wrong_kboard_jmpbuf */
2574 /* Start idle timers if no time limit is supplied. We don't do it
2575 if a time limit is supplied to avoid an infinite recursion in the
2576 situation where an idle timer calls `sit-for'. */
2579 timer_start_idle ();
2581 /* If in middle of key sequence and minibuffer not active,
2582 start echoing if enough time elapses. */
2584 if (minibuf_level
== 0
2586 && !current_kboard
->immediate_echo
2587 && this_command_key_count
> 0
2589 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2590 && NILP (Fzerop (Vecho_keystrokes
))
2591 && (/* No message. */
2592 NILP (echo_area_buffer
[0])
2593 /* Or empty message. */
2594 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2595 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2596 /* Or already echoing from same kboard. */
2597 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2598 /* Or not echoing before and echoing allowed. */
2599 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2601 /* After a mouse event, start echoing right away.
2602 This is because we are probably about to display a menu,
2603 and we don't want to delay before doing so. */
2604 if (EVENT_HAS_PARAMETERS (prev_event
))
2610 save_getcjmp (save_jump
);
2611 restore_getcjmp (local_getcjmp
);
2612 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2613 restore_getcjmp (save_jump
);
2615 && ! CONSP (Vunread_command_events
))
2620 /* Maybe auto save due to number of keystrokes. */
2622 if (commandflag
!= 0
2623 && auto_save_interval
> 0
2624 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2625 && !detect_input_pending_run_timers (0))
2627 Fdo_auto_save (Qnil
, Qnil
);
2628 /* Hooks can actually change some buffers in auto save. */
2632 /* Try reading using an X menu.
2633 This is never confused with reading using the minibuf
2634 because the recursive call of read_char in read_char_minibuf_menu_prompt
2635 does not pass on any keymaps. */
2637 if (nmaps
> 0 && INTERACTIVE
2638 && !NILP (prev_event
)
2639 && EVENT_HAS_PARAMETERS (prev_event
)
2640 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2641 && !EQ (XCAR (prev_event
), Qtool_bar
)
2642 /* Don't bring up a menu if we already have another event. */
2643 && NILP (Vunread_command_events
)
2644 && unread_command_char
< 0)
2646 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2648 /* Now that we have read an event, Emacs is not idle. */
2655 /* Maybe autosave and/or garbage collect due to idleness. */
2657 if (INTERACTIVE
&& NILP (c
))
2660 ptrdiff_t buffer_size
;
2662 /* Slow down auto saves logarithmically in size of current buffer,
2663 and garbage collect while we're at it. */
2664 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2665 last_non_minibuf_size
= Z
- BEG
;
2666 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2668 while (buffer_size
> 64)
2669 delay_level
++, buffer_size
-= buffer_size
>> 2;
2670 if (delay_level
< 4) delay_level
= 4;
2671 /* delay_level is 4 for files under around 50k, 7 at 100k,
2672 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2674 /* Auto save if enough time goes by without input. */
2675 if (commandflag
!= 0
2676 && num_nonmacro_input_events
> last_auto_save
2677 && INTEGERP (Vauto_save_timeout
)
2678 && XINT (Vauto_save_timeout
) > 0)
2681 EMACS_INT timeout
= (delay_level
2682 * min (XFASTINT (Vauto_save_timeout
) / 4,
2683 MOST_POSITIVE_FIXNUM
/ delay_level
));
2684 save_getcjmp (save_jump
);
2685 restore_getcjmp (local_getcjmp
);
2686 tem0
= sit_for (make_number (timeout
), 1, 1);
2687 restore_getcjmp (save_jump
);
2690 && ! CONSP (Vunread_command_events
))
2692 Fdo_auto_save (Qnil
, Qnil
);
2694 /* If we have auto-saved and there is still no input
2695 available, garbage collect if there has been enough
2696 consing going on to make it worthwhile. */
2697 if (!detect_input_pending_run_timers (0)
2698 && consing_since_gc
> gc_cons_threshold
/ 2)
2699 Fgarbage_collect ();
2706 /* Notify the caller if an autosave hook, or a timer, sentinel or
2707 filter in the sit_for calls above have changed the current
2708 kboard. This could happen if they use the minibuffer or start a
2709 recursive edit, like the fancy splash screen in server.el's
2710 filter. If this longjmp wasn't here, read_key_sequence would
2711 interpret the next key sequence using the wrong translation
2712 tables and function keymaps. */
2713 if (NILP (c
) && current_kboard
!= orig_kboard
)
2716 return make_number (-2); /* wrong_kboard_jmpbuf */
2719 /* If this has become non-nil here, it has been set by a timer
2720 or sentinel or filter. */
2721 if (CONSP (Vunread_command_events
))
2723 c
= XCAR (Vunread_command_events
);
2724 Vunread_command_events
= XCDR (Vunread_command_events
);
2727 /* Read something from current KBOARD's side queue, if possible. */
2731 if (current_kboard
->kbd_queue_has_data
)
2733 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2735 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2736 KVAR (current_kboard
, kbd_queue
)
2737 = XCDR (KVAR (current_kboard
, kbd_queue
));
2738 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2739 current_kboard
->kbd_queue_has_data
= 0;
2740 input_pending
= readable_events (0);
2741 if (EVENT_HAS_PARAMETERS (c
)
2742 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2743 internal_last_event_frame
= XCAR (XCDR (c
));
2744 Vlast_event_frame
= internal_last_event_frame
;
2748 /* If current_kboard's side queue is empty check the other kboards.
2749 If one of them has data that we have not yet seen here,
2750 switch to it and process the data waiting for it.
2752 Note: if the events queued up for another kboard
2753 have already been seen here, and therefore are not a complete command,
2754 the kbd_queue_has_data field is 0, so we skip that kboard here.
2755 That's to avoid an infinite loop switching between kboards here. */
2756 if (NILP (c
) && !single_kboard
)
2759 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2760 if (kb
->kbd_queue_has_data
)
2762 current_kboard
= kb
;
2763 /* This is going to exit from read_char
2764 so we had better get rid of this frame's stuff. */
2766 return make_number (-2); /* wrong_kboard_jmpbuf */
2774 /* Finally, we read from the main queue,
2775 and if that gives us something we can't use yet, we put it on the
2776 appropriate side queue and try again. */
2780 KBOARD
*kb
IF_LINT (= NULL
);
2785 EMACS_GET_TIME (now
);
2786 if (EMACS_TIME_GE (now
, *end_time
))
2790 /* Actually read a character, waiting if necessary. */
2791 save_getcjmp (save_jump
);
2792 restore_getcjmp (local_getcjmp
);
2794 timer_start_idle ();
2795 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2796 restore_getcjmp (save_jump
);
2798 if (! NILP (c
) && (kb
!= current_kboard
))
2800 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2803 while (CONSP (XCDR (last
)))
2805 if (!NILP (XCDR (last
)))
2809 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2811 XSETCDR (last
, Fcons (c
, Qnil
));
2812 kb
->kbd_queue_has_data
= 1;
2816 current_kboard
= kb
;
2817 /* This is going to exit from read_char
2818 so we had better get rid of this frame's stuff. */
2820 return make_number (-2);
2824 /* Terminate Emacs in batch mode if at eof. */
2825 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2826 Fkill_emacs (make_number (1));
2830 /* Add in any extra modifiers, where appropriate. */
2831 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2832 || ((extra_keyboard_modifiers
& 0177) < ' '
2833 && (extra_keyboard_modifiers
& 0177) != 0))
2834 XSETINT (c
, make_ctrl_char (XINT (c
)));
2836 /* Transfer any other modifier bits directly from
2837 extra_keyboard_modifiers to c. Ignore the actual character code
2838 in the low 16 bits of extra_keyboard_modifiers. */
2839 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2850 if (commandflag
>= 0
2851 && !input_pending
&& !detect_input_pending_run_timers (0))
2859 /* Buffer switch events are only for internal wakeups
2860 so don't show them to the user.
2861 Also, don't record a key if we already did. */
2862 if (BUFFERP (c
) || key_already_recorded
)
2865 /* Process special events within read_char
2866 and loop around to read another event. */
2869 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2874 struct buffer
*prev_buffer
= current_buffer
;
2875 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2876 int was_locked
= single_kboard
;
2877 ptrdiff_t count
= SPECPDL_INDEX ();
2878 record_single_kboard_state ();
2881 last_input_event
= c
;
2882 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2884 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2885 /* We stopped being idle for this event; undo that. This
2886 prevents automatic window selection (under
2887 mouse_autoselect_window from acting as a real input event, for
2888 example banishing the mouse under mouse-avoidance-mode. */
2889 timer_resume_idle ();
2891 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2892 /* Resume allowing input from any kboard, if that was true before. */
2894 any_kboard_state ();
2895 unbind_to (count
, Qnil
);
2898 if (current_buffer
!= prev_buffer
)
2900 /* The command may have changed the keymaps. Pretend there
2901 is input in another keyboard and return. This will
2902 recalculate keymaps. */
2903 c
= make_number (-2);
2910 /* Handle things that only apply to characters. */
2913 /* If kbd_buffer_get_event gave us an EOF, return that. */
2917 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2918 && UNSIGNED_CMP (XFASTINT (c
), <,
2919 SCHARS (KVAR (current_kboard
,
2920 Vkeyboard_translate_table
))))
2921 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2922 && UNSIGNED_CMP (XFASTINT (c
), <,
2923 ASIZE (KVAR (current_kboard
,
2924 Vkeyboard_translate_table
))))
2925 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2929 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2930 /* nil in keyboard-translate-table means no translation. */
2936 /* If this event is a mouse click in the menu bar,
2937 return just menu-bar for now. Modify the mouse click event
2938 so we won't do this twice, then queue it up. */
2939 if (EVENT_HAS_PARAMETERS (c
)
2941 && CONSP (EVENT_START (c
))
2942 && CONSP (XCDR (EVENT_START (c
))))
2946 posn
= POSN_POSN (EVENT_START (c
));
2947 /* Handle menu-bar events:
2948 insert the dummy prefix event `menu-bar'. */
2949 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2951 /* Change menu-bar to (menu-bar) as the event "position". */
2952 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2955 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2960 /* Store these characters into recent_keys, the dribble file if any,
2961 and the keyboard macro being defined, if any. */
2963 if (! NILP (also_record
))
2964 record_char (also_record
);
2966 /* Wipe the echo area.
2967 But first, if we are about to use an input method,
2968 save the echo area contents for it to refer to. */
2970 && ! NILP (Vinput_method_function
)
2971 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2973 previous_echo_area_message
= Fcurrent_message ();
2974 Vinput_method_previous_message
= previous_echo_area_message
;
2977 /* Now wipe the echo area, except for help events which do their
2978 own stuff with the echo area. */
2980 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2981 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2983 if (!NILP (echo_area_buffer
[0]))
2984 safe_run_hooks (Qecho_area_clear_hook
);
2985 clear_message (1, 0);
2988 reread_for_input_method
:
2990 /* Pass this to the input method, if appropriate. */
2992 && ! NILP (Vinput_method_function
)
2993 /* Don't run the input method within a key sequence,
2994 after the first event of the key sequence. */
2995 && NILP (prev_event
)
2996 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2999 ptrdiff_t key_count
;
3000 int key_count_reset
;
3001 struct gcpro inner_gcpro1
;
3002 ptrdiff_t count
= SPECPDL_INDEX ();
3004 /* Save the echo status. */
3005 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3006 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3007 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3008 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3011 if (before_command_restore_flag
)
3013 this_command_key_count
= before_command_key_count_1
;
3014 if (this_command_key_count
< this_single_command_key_start
)
3015 this_single_command_key_start
= this_command_key_count
;
3016 echo_truncate (before_command_echo_length_1
);
3017 before_command_restore_flag
= 0;
3021 /* Save the this_command_keys status. */
3022 key_count
= this_command_key_count
;
3023 key_count_reset
= this_command_key_count_reset
;
3026 keys
= Fcopy_sequence (this_command_keys
);
3029 GCPRO1_VAR (keys
, inner_gcpro
);
3031 /* Clear out this_command_keys. */
3032 this_command_key_count
= 0;
3033 this_command_key_count_reset
= 0;
3035 /* Now wipe the echo area. */
3036 if (!NILP (echo_area_buffer
[0]))
3037 safe_run_hooks (Qecho_area_clear_hook
);
3038 clear_message (1, 0);
3041 /* If we are not reading a key sequence,
3042 never use the echo area. */
3045 specbind (Qinput_method_use_echo_area
, Qt
);
3048 /* Call the input method. */
3049 tem
= call1 (Vinput_method_function
, c
);
3051 tem
= unbind_to (count
, tem
);
3053 /* Restore the saved echoing state
3054 and this_command_keys state. */
3055 this_command_key_count
= key_count
;
3056 this_command_key_count_reset
= key_count_reset
;
3058 this_command_keys
= keys
;
3061 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3062 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3063 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3064 if (saved_immediate_echo
)
3067 UNGCPRO_VAR (inner_gcpro
);
3069 /* The input method can return no events. */
3072 /* Bring back the previous message, if any. */
3073 if (! NILP (previous_echo_area_message
))
3074 message_with_string ("%s", previous_echo_area_message
, 0);
3077 /* It returned one event or more. */
3079 Vunread_post_input_method_events
3080 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3085 /* Display help if not echoing. */
3086 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3088 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3089 Lisp_Object help
, object
, position
, window
, htem
;
3091 htem
= Fcdr (XCDR (c
));
3094 window
= Fcar (htem
);
3096 object
= Fcar (htem
);
3098 position
= Fcar (htem
);
3100 show_help_echo (help
, window
, object
, position
);
3102 /* We stopped being idle for this event; undo that. */
3104 timer_resume_idle ();
3108 if ((! reread
|| this_command_key_count
== 0
3109 || this_command_key_count_reset
)
3113 /* Don't echo mouse motion events. */
3114 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3115 && NILP (Fzerop (Vecho_keystrokes
))
3116 && ! (EVENT_HAS_PARAMETERS (c
)
3117 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3120 if (! NILP (also_record
))
3121 echo_char (also_record
);
3122 /* Once we reread a character, echoing can happen
3123 the next time we pause to read a new one. */
3124 ok_to_echo_at_next_pause
= current_kboard
;
3127 /* Record this character as part of the current key. */
3128 add_command_key (c
);
3129 if (! NILP (also_record
))
3130 add_command_key (also_record
);
3133 last_input_event
= c
;
3136 /* Process the help character specially if enabled */
3137 if (!NILP (Vhelp_form
) && help_char_p (c
))
3139 ptrdiff_t count
= SPECPDL_INDEX ();
3141 help_form_saved_window_configs
3142 = Fcons (Fcurrent_window_configuration (Qnil
),
3143 help_form_saved_window_configs
);
3144 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3145 call0 (Qhelp_form_show
);
3150 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3151 if (EVENT_HAS_PARAMETERS (c
)
3152 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3153 XSETCAR (help_form_saved_window_configs
, Qnil
);
3155 while (BUFFERP (c
));
3156 /* Remove the help from the frame */
3157 unbind_to (count
, Qnil
);
3160 if (EQ (c
, make_number (040)))
3164 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3165 while (BUFFERP (c
));
3174 /* Record a key that came from a mouse menu.
3175 Record it for echoing, for this-command-keys, and so on. */
3178 record_menu_key (Lisp_Object c
)
3180 /* Wipe the echo area. */
3181 clear_message (1, 0);
3186 before_command_key_count
= this_command_key_count
;
3187 before_command_echo_length
= echo_length ();
3190 /* Don't echo mouse motion events. */
3191 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3192 && NILP (Fzerop (Vecho_keystrokes
)))
3196 /* Once we reread a character, echoing can happen
3197 the next time we pause to read a new one. */
3198 ok_to_echo_at_next_pause
= 0;
3201 /* Record this character as part of the current key. */
3202 add_command_key (c
);
3204 /* Re-reading in the middle of a command */
3205 last_input_event
= c
;
3209 /* Return 1 if should recognize C as "the help character". */
3212 help_char_p (Lisp_Object c
)
3216 if (EQ (c
, Vhelp_char
))
3218 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3219 if (EQ (c
, XCAR (tail
)))
3224 /* Record the input event C in various ways. */
3227 record_char (Lisp_Object c
)
3231 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3233 /* To avoid filling recent_keys with help-echo and mouse-movement
3234 events, we filter out repeated help-echo events, only store the
3235 first and last in a series of mouse-movement events, and don't
3236 store repeated help-echo events which are only separated by
3237 mouse-movement events. */
3239 Lisp_Object ev1
, ev2
, ev3
;
3242 if ((ix1
= recent_keys_index
- 1) < 0)
3243 ix1
= NUM_RECENT_KEYS
- 1;
3244 ev1
= AREF (recent_keys
, ix1
);
3246 if ((ix2
= ix1
- 1) < 0)
3247 ix2
= NUM_RECENT_KEYS
- 1;
3248 ev2
= AREF (recent_keys
, ix2
);
3250 if ((ix3
= ix2
- 1) < 0)
3251 ix3
= NUM_RECENT_KEYS
- 1;
3252 ev3
= AREF (recent_keys
, ix3
);
3254 if (EQ (XCAR (c
), Qhelp_echo
))
3256 /* Don't record `help-echo' in recent_keys unless it shows some help
3257 message, and a different help than the previously recorded
3259 Lisp_Object help
, last_help
;
3261 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3262 if (!STRINGP (help
))
3264 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3265 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3267 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3268 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3269 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3271 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3272 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3273 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3274 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3277 else if (EQ (XCAR (c
), Qmouse_movement
))
3279 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3280 So additional mouse movement events replace the last element. */
3281 Lisp_Object last_window
, window
;
3283 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3284 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3285 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3286 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3287 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3289 ASET (recent_keys
, ix1
, c
);
3295 store_kbd_macro_char (c
);
3299 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3300 ASET (recent_keys
, recent_keys_index
, c
);
3301 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3302 recent_keys_index
= 0;
3304 else if (recorded
< 0)
3306 /* We need to remove one or two events from recent_keys.
3307 To do this, we simply put nil at those events and move the
3308 recent_keys_index backwards over those events. Usually,
3309 users will never see those nil events, as they will be
3310 overwritten by the command keys entered to see recent_keys
3313 while (recorded
++ < 0 && total_keys
> 0)
3315 if (total_keys
< NUM_RECENT_KEYS
)
3317 if (--recent_keys_index
< 0)
3318 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3319 ASET (recent_keys
, recent_keys_index
, Qnil
);
3323 num_nonmacro_input_events
++;
3325 /* Write c to the dribble file. If c is a lispy event, write
3326 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3327 If you, dear reader, have a better idea, you've got the source. :-) */
3333 if (XUINT (c
) < 0x100)
3334 putc (XUINT (c
), dribble
);
3336 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3340 Lisp_Object dribblee
;
3342 /* If it's a structured event, take the event header. */
3343 dribblee
= EVENT_HEAD (c
);
3345 if (SYMBOLP (dribblee
))
3347 putc ('<', dribble
);
3348 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3349 SBYTES (SYMBOL_NAME (dribblee
)),
3351 putc ('>', dribble
);
3360 /* Copy out or in the info on where C-g should throw to.
3361 This is used when running Lisp code from within get_char,
3362 in case get_char is called recursively.
3363 See read_process_output. */
3366 save_getcjmp (jmp_buf temp
)
3368 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3372 restore_getcjmp (jmp_buf temp
)
3374 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3377 /* Low level keyboard/mouse input.
3378 kbd_buffer_store_event places events in kbd_buffer, and
3379 kbd_buffer_get_event retrieves them. */
3381 /* Return true if there are any events in the queue that read-char
3382 would return. If this returns false, a read-char would block. */
3384 readable_events (int flags
)
3386 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3389 /* If the buffer contains only FOCUS_IN_EVENT events, and
3390 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3391 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3393 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3394 #ifdef USE_TOOLKIT_SCROLL_BARS
3395 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3399 struct input_event
*event
;
3401 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3408 #ifdef USE_TOOLKIT_SCROLL_BARS
3409 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3411 event
->kind
== FOCUS_IN_EVENT
)
3412 #ifdef USE_TOOLKIT_SCROLL_BARS
3413 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3414 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3415 && event
->part
== scroll_bar_handle
3416 && event
->modifiers
== 0)
3421 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3424 while (event
!= kbd_store_ptr
);
3430 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3431 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3432 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3437 if (current_kboard
->kbd_queue_has_data
)
3443 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3444 if (kb
->kbd_queue_has_data
)
3450 /* Set this for debugging, to have a way to get out */
3451 int stop_character EXTERNALLY_VISIBLE
;
3454 event_to_kboard (struct input_event
*event
)
3457 frame
= event
->frame_or_window
;
3459 frame
= XCAR (frame
);
3460 else if (WINDOWP (frame
))
3461 frame
= WINDOW_FRAME (XWINDOW (frame
));
3463 /* There are still some events that don't set this field.
3464 For now, just ignore the problem.
3465 Also ignore dead frames here. */
3466 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3469 return FRAME_KBOARD (XFRAME (frame
));
3473 /* Return the number of slots occupied in kbd_buffer. */
3476 kbd_buffer_nr_stored (void)
3478 return kbd_fetch_ptr
== kbd_store_ptr
3480 : (kbd_fetch_ptr
< kbd_store_ptr
3481 ? kbd_store_ptr
- kbd_fetch_ptr
3482 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3483 + (kbd_store_ptr
- kbd_buffer
)));
3485 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3488 kbd_buffer_store_event (register struct input_event
*event
)
3490 kbd_buffer_store_event_hold (event
, 0);
3493 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3495 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3496 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3497 Else, if EVENT is a quit event, store the quit event
3498 in HOLD_QUIT, and return (thus ignoring further events).
3500 This is used in read_avail_input to postpone the processing
3501 of the quit event until all subsequent input events have been
3502 parsed (and discarded).
3506 kbd_buffer_store_event_hold (register struct input_event
*event
,
3507 struct input_event
*hold_quit
)
3509 if (event
->kind
== NO_EVENT
)
3512 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3515 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3517 register int c
= event
->code
& 0377;
3519 if (event
->modifiers
& ctrl_modifier
)
3520 c
= make_ctrl_char (c
);
3522 c
|= (event
->modifiers
3523 & (meta_modifier
| alt_modifier
3524 | hyper_modifier
| super_modifier
));
3528 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3529 struct input_event
*sp
;
3531 if (single_kboard
&& kb
!= current_kboard
)
3533 KVAR (kb
, kbd_queue
)
3534 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3535 Fcons (make_number (c
), Qnil
));
3536 kb
->kbd_queue_has_data
= 1;
3537 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3539 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3542 if (event_to_kboard (sp
) == kb
)
3544 sp
->kind
= NO_EVENT
;
3545 sp
->frame_or_window
= Qnil
;
3554 memcpy (hold_quit
, event
, sizeof (*event
));
3558 /* If this results in a quit_char being returned to Emacs as
3559 input, set Vlast_event_frame properly. If this doesn't
3560 get returned to Emacs as an event, the next event read
3561 will set Vlast_event_frame again, so this is safe to do. */
3565 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3567 focus
= event
->frame_or_window
;
3568 internal_last_event_frame
= focus
;
3569 Vlast_event_frame
= focus
;
3572 last_event_timestamp
= event
->timestamp
;
3573 handle_interrupt ();
3577 if (c
&& c
== stop_character
)
3583 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3584 Just ignore the second one. */
3585 else if (event
->kind
== BUFFER_SWITCH_EVENT
3586 && kbd_fetch_ptr
!= kbd_store_ptr
3587 && ((kbd_store_ptr
== kbd_buffer
3588 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3589 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3592 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3593 kbd_store_ptr
= kbd_buffer
;
3595 /* Don't let the very last slot in the buffer become full,
3596 since that would make the two pointers equal,
3597 and that is indistinguishable from an empty buffer.
3598 Discard the event if it would fill the last slot. */
3599 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3601 *kbd_store_ptr
= *event
;
3604 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3606 /* Don't read keyboard input until we have processed kbd_buffer.
3607 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3608 hold_keyboard_input ();
3610 if (!noninteractive
)
3611 signal (SIGIO
, SIG_IGN
);
3615 #endif /* subprocesses */
3618 /* If we're inside while-no-input, and this event qualifies
3619 as input, set quit-flag to cause an interrupt. */
3620 if (!NILP (Vthrow_on_input
)
3621 && event
->kind
!= FOCUS_IN_EVENT
3622 && event
->kind
!= HELP_EVENT
3623 && event
->kind
!= DEICONIFY_EVENT
)
3625 Vquit_flag
= Vthrow_on_input
;
3626 /* If we're inside a function that wants immediate quits,
3628 if (immediate_quit
&& NILP (Vinhibit_quit
))
3638 /* Put an input event back in the head of the event queue. */
3641 kbd_buffer_unget_event (register struct input_event
*event
)
3643 if (kbd_fetch_ptr
== kbd_buffer
)
3644 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3646 /* Don't let the very last slot in the buffer become full, */
3647 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3650 *kbd_fetch_ptr
= *event
;
3655 /* Generate a HELP_EVENT input_event and store it in the keyboard
3658 HELP is the help form.
3660 FRAME and WINDOW are the frame and window where the help is
3661 generated. OBJECT is the Lisp object where the help was found (a
3662 buffer, a string, an overlay, or nil if neither from a string nor
3663 from a buffer). POS is the position within OBJECT where the help
3667 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3668 Lisp_Object object
, ptrdiff_t pos
)
3670 struct input_event event
;
3674 event
.kind
= HELP_EVENT
;
3675 event
.frame_or_window
= frame
;
3677 event
.x
= WINDOWP (window
) ? window
: frame
;
3680 kbd_buffer_store_event (&event
);
3684 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3687 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3689 struct input_event event
;
3691 event
.kind
= HELP_EVENT
;
3692 event
.frame_or_window
= frame
;
3697 kbd_buffer_store_event (&event
);
3701 /* Discard any mouse events in the event buffer by setting them to
3704 discard_mouse_events (void)
3706 struct input_event
*sp
;
3707 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3709 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3712 if (sp
->kind
== MOUSE_CLICK_EVENT
3713 || sp
->kind
== WHEEL_EVENT
3714 || sp
->kind
== HORIZ_WHEEL_EVENT
3716 || sp
->kind
== GPM_CLICK_EVENT
3718 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3720 sp
->kind
= NO_EVENT
;
3726 /* Return non-zero if there are any real events waiting in the event
3727 buffer, not counting `NO_EVENT's.
3729 If DISCARD is non-zero, discard NO_EVENT events at the front of
3730 the input queue, possibly leaving the input queue empty if there
3731 are no real input events. */
3734 kbd_buffer_events_waiting (int discard
)
3736 struct input_event
*sp
;
3738 for (sp
= kbd_fetch_ptr
;
3739 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3742 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3749 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3753 /* Clear input event EVENT. */
3756 clear_event (struct input_event
*event
)
3758 event
->kind
= NO_EVENT
;
3762 /* Read one event from the event buffer, waiting if necessary.
3763 The value is a Lisp object representing the event.
3764 The value is nil for an event that should be ignored,
3765 or that was handled here.
3766 We always read and discard one event. */
3769 kbd_buffer_get_event (KBOARD
**kbp
,
3770 int *used_mouse_menu
,
3771 struct timeval
*end_time
)
3777 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3779 /* Start reading input again, we have processed enough so we can
3780 accept new events again. */
3781 unhold_keyboard_input ();
3783 if (!noninteractive
)
3784 signal (SIGIO
, input_available_signal
);
3788 #endif /* subprocesses */
3791 /* In case we are running as a daemon, only do this before
3792 detaching from the terminal. */
3793 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3797 *kbp
= current_kboard
;
3801 /* Wait until there is input available. */
3804 /* Break loop if there's an unread command event. Needed in
3805 moused window autoselection which uses a timer to insert such
3807 if (CONSP (Vunread_command_events
))
3810 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3812 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3813 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3817 /* If the quit flag is set, then read_char will return
3818 quit_char, so that counts as "available input." */
3819 if (!NILP (Vquit_flag
))
3820 quit_throw_to_read_char ();
3822 /* One way or another, wait until input is available; then, if
3823 interrupt handlers have not read it, read it now. */
3825 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3829 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3831 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3832 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3837 EMACS_TIME duration
;
3838 EMACS_GET_TIME (duration
);
3839 if (EMACS_TIME_GE (duration
, *end_time
))
3840 return Qnil
; /* finished waiting */
3843 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3844 wait_reading_process_output (EMACS_SECS (duration
),
3845 EMACS_USECS (duration
),
3846 -1, 1, Qnil
, NULL
, 0);
3850 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3852 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3853 /* Pass 1 for EXPECT since we just waited to have input. */
3854 read_avail_input (1);
3857 if (CONSP (Vunread_command_events
))
3860 first
= XCAR (Vunread_command_events
);
3861 Vunread_command_events
= XCDR (Vunread_command_events
);
3862 *kbp
= current_kboard
;
3866 /* At this point, we know that there is a readable event available
3867 somewhere. If the event queue is empty, then there must be a
3868 mouse movement enabled and available. */
3869 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3871 struct input_event
*event
;
3873 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3877 last_event_timestamp
= event
->timestamp
;
3879 *kbp
= event_to_kboard (event
);
3881 *kbp
= current_kboard
; /* Better than returning null ptr? */
3885 /* These two kinds of events get special handling
3886 and don't actually appear to the command loop.
3887 We return nil for them. */
3888 if (event
->kind
== SELECTION_REQUEST_EVENT
3889 || event
->kind
== SELECTION_CLEAR_EVENT
)
3892 struct input_event copy
;
3894 /* Remove it from the buffer before processing it,
3895 since otherwise swallow_events will see it
3896 and process it again. */
3898 kbd_fetch_ptr
= event
+ 1;
3899 input_pending
= readable_events (0);
3900 x_handle_selection_event (©
);
3902 /* We're getting selection request events, but we don't have
3908 #if defined (HAVE_NS)
3909 else if (event
->kind
== NS_TEXT_EVENT
)
3911 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3912 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3914 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3915 kbd_fetch_ptr
= event
+ 1;
3916 if (used_mouse_menu
)
3917 *used_mouse_menu
= 1;
3921 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3922 || defined (HAVE_NS)
3923 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3925 /* Make an event (delete-frame (FRAME)). */
3926 obj
= Fcons (event
->frame_or_window
, Qnil
);
3927 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3928 kbd_fetch_ptr
= event
+ 1;
3931 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3932 || defined (HAVE_NS)
3933 else if (event
->kind
== ICONIFY_EVENT
)
3935 /* Make an event (iconify-frame (FRAME)). */
3936 obj
= Fcons (event
->frame_or_window
, Qnil
);
3937 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3938 kbd_fetch_ptr
= event
+ 1;
3940 else if (event
->kind
== DEICONIFY_EVENT
)
3942 /* Make an event (make-frame-visible (FRAME)). */
3943 obj
= Fcons (event
->frame_or_window
, Qnil
);
3944 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3945 kbd_fetch_ptr
= event
+ 1;
3948 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3950 /* The value doesn't matter here; only the type is tested. */
3951 XSETBUFFER (obj
, current_buffer
);
3952 kbd_fetch_ptr
= event
+ 1;
3954 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3955 || defined (HAVE_NS) || defined (USE_GTK)
3956 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3958 kbd_fetch_ptr
= event
+ 1;
3959 input_pending
= readable_events (0);
3960 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3961 x_activate_menubar (XFRAME (event
->frame_or_window
));
3964 #if defined (WINDOWSNT)
3965 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3967 /* Make an event (language-change (FRAME CHARSET LCID)). */
3968 obj
= Fcons (event
->frame_or_window
, Qnil
);
3969 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3970 kbd_fetch_ptr
= event
+ 1;
3973 else if (event
->kind
== SAVE_SESSION_EVENT
)
3975 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3976 kbd_fetch_ptr
= event
+ 1;
3978 /* Just discard these, by returning nil.
3979 With MULTI_KBOARD, these events are used as placeholders
3980 when we need to randomly delete events from the queue.
3981 (They shouldn't otherwise be found in the buffer,
3982 but on some machines it appears they do show up
3983 even without MULTI_KBOARD.) */
3984 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3985 mouse events during a popup-menu call. */
3986 else if (event
->kind
== NO_EVENT
)
3987 kbd_fetch_ptr
= event
+ 1;
3988 else if (event
->kind
== HELP_EVENT
)
3990 Lisp_Object object
, position
, help
, frame
, window
;
3992 frame
= event
->frame_or_window
;
3993 object
= event
->arg
;
3994 position
= make_number (event
->code
);
3997 clear_event (event
);
3999 kbd_fetch_ptr
= event
+ 1;
4000 if (!WINDOWP (window
))
4002 obj
= Fcons (Qhelp_echo
,
4003 list5 (frame
, help
, window
, object
, position
));
4005 else if (event
->kind
== FOCUS_IN_EVENT
)
4007 /* Notification of a FocusIn event. The frame receiving the
4008 focus is in event->frame_or_window. Generate a
4009 switch-frame event if necessary. */
4010 Lisp_Object frame
, focus
;
4012 frame
= event
->frame_or_window
;
4013 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4017 if (!EQ (frame
, internal_last_event_frame
)
4018 && !EQ (frame
, selected_frame
))
4019 obj
= make_lispy_switch_frame (frame
);
4020 internal_last_event_frame
= frame
;
4021 kbd_fetch_ptr
= event
+ 1;
4024 else if (event
->kind
== DBUS_EVENT
)
4026 obj
= make_lispy_event (event
);
4027 kbd_fetch_ptr
= event
+ 1;
4030 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4032 obj
= make_lispy_event (event
);
4033 kbd_fetch_ptr
= event
+ 1;
4037 /* If this event is on a different frame, return a switch-frame this
4038 time, and leave the event in the queue for next time. */
4042 frame
= event
->frame_or_window
;
4044 frame
= XCAR (frame
);
4045 else if (WINDOWP (frame
))
4046 frame
= WINDOW_FRAME (XWINDOW (frame
));
4048 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4052 if (! EQ (frame
, internal_last_event_frame
)
4053 && !EQ (frame
, selected_frame
))
4054 obj
= make_lispy_switch_frame (frame
);
4055 internal_last_event_frame
= frame
;
4057 /* If we didn't decide to make a switch-frame event, go ahead
4058 and build a real event from the queue entry. */
4062 obj
= make_lispy_event (event
);
4064 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4065 || defined (HAVE_NS) || defined (USE_GTK)
4066 /* If this was a menu selection, then set the flag to inhibit
4067 writing to last_nonmenu_event. Don't do this if the event
4068 we're returning is (menu-bar), though; that indicates the
4069 beginning of the menu sequence, and we might as well leave
4070 that as the `event with parameters' for this selection. */
4072 && !EQ (event
->frame_or_window
, event
->arg
)
4073 && (event
->kind
== MENU_BAR_EVENT
4074 || event
->kind
== TOOL_BAR_EVENT
))
4075 *used_mouse_menu
= 1;
4078 /* certain system events are non-key events */
4080 && event
->kind
== NS_NONKEY_EVENT
)
4081 *used_mouse_menu
= 1;
4084 /* Wipe out this event, to catch bugs. */
4085 clear_event (event
);
4086 kbd_fetch_ptr
= event
+ 1;
4090 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4091 /* Try generating a mouse motion event. */
4092 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4094 FRAME_PTR f
= some_mouse_moved ();
4095 Lisp_Object bar_window
;
4096 enum scroll_bar_part part
;
4100 *kbp
= current_kboard
;
4101 /* Note that this uses F to determine which terminal to look at.
4102 If there is no valid info, it does not store anything
4103 so x remains nil. */
4106 /* XXX Can f or mouse_position_hook be NULL here? */
4107 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4108 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4113 /* Decide if we should generate a switch-frame event. Don't
4114 generate switch-frame events for motion outside of all Emacs
4120 frame
= FRAME_FOCUS_FRAME (f
);
4122 XSETFRAME (frame
, f
);
4124 if (! EQ (frame
, internal_last_event_frame
)
4125 && !EQ (frame
, selected_frame
))
4126 obj
= make_lispy_switch_frame (frame
);
4127 internal_last_event_frame
= frame
;
4130 /* If we didn't decide to make a switch-frame event, go ahead and
4131 return a mouse-motion event. */
4132 if (!NILP (x
) && NILP (obj
))
4133 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4135 #endif /* HAVE_MOUSE || HAVE GPM */
4137 /* We were promised by the above while loop that there was
4138 something for us to read! */
4141 input_pending
= readable_events (0);
4143 Vlast_event_frame
= internal_last_event_frame
;
4148 /* Process any events that are not user-visible,
4149 then return, without reading any user-visible events. */
4152 swallow_events (int do_display
)
4156 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4158 struct input_event
*event
;
4160 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4164 last_event_timestamp
= event
->timestamp
;
4166 /* These two kinds of events get special handling
4167 and don't actually appear to the command loop. */
4168 if (event
->kind
== SELECTION_REQUEST_EVENT
4169 || event
->kind
== SELECTION_CLEAR_EVENT
)
4172 struct input_event copy
;
4174 /* Remove it from the buffer before processing it,
4175 since otherwise swallow_events called recursively could see it
4176 and process it again. */
4178 kbd_fetch_ptr
= event
+ 1;
4179 input_pending
= readable_events (0);
4180 x_handle_selection_event (©
);
4182 /* We're getting selection request events, but we don't have
4191 old_timers_run
= timers_run
;
4192 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4194 if (timers_run
!= old_timers_run
&& do_display
)
4195 redisplay_preserve_echo_area (7);
4198 /* Record the start of when Emacs is idle,
4199 for the sake of running idle-time timers. */
4202 timer_start_idle (void)
4206 /* If we are already in the idle state, do nothing. */
4207 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4210 EMACS_GET_TIME (timer_idleness_start_time
);
4212 timer_last_idleness_start_time
= timer_idleness_start_time
;
4214 /* Mark all idle-time timers as once again candidates for running. */
4215 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4219 timer
= XCAR (timers
);
4221 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4223 XVECTOR (timer
)->contents
[0] = Qnil
;
4227 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4230 timer_stop_idle (void)
4232 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4235 /* Resume idle timer from last idle start time. */
4238 timer_resume_idle (void)
4240 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4243 timer_idleness_start_time
= timer_last_idleness_start_time
;
4246 /* This is only for debugging. */
4247 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4249 /* List of elisp functions to call, delayed because they were generated in
4250 a context where Elisp could not be safely run (e.g. redisplay, signal,
4251 ...). Each element has the form (FUN . ARGS). */
4252 Lisp_Object pending_funcalls
;
4254 /* Check whether a timer has fired. To prevent larger problems we simply
4255 disregard elements that are not proper timers. Do not make a circular
4256 timer list for the time being.
4258 Returns the time to wait until the next timer fires. If a
4259 timer is triggering now, return zero.
4260 If no timer is active, return -1.
4262 If a timer is ripe, we run it, with quitting turned off.
4263 In that case we return 0 to indicate that a new timer_check_2 call
4267 timer_check_2 (void)
4269 EMACS_TIME nexttime
;
4271 EMACS_TIME idleness_now
IF_LINT (= {0});
4272 Lisp_Object timers
, idle_timers
, chosen_timer
;
4273 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4275 EMACS_SET_SECS (nexttime
, -1);
4276 EMACS_SET_USECS (nexttime
, -1);
4278 /* Always consider the ordinary timers. */
4279 timers
= Vtimer_list
;
4280 /* Consider the idle timers only if Emacs is idle. */
4281 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4282 idle_timers
= Vtimer_idle_list
;
4285 chosen_timer
= Qnil
;
4286 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4288 /* First run the code that was delayed. */
4289 while (CONSP (pending_funcalls
))
4291 Lisp_Object funcall
= XCAR (pending_funcalls
);
4292 pending_funcalls
= XCDR (pending_funcalls
);
4293 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4296 if (CONSP (timers
) || CONSP (idle_timers
))
4298 EMACS_GET_TIME (now
);
4299 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4300 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4303 while (CONSP (timers
) || CONSP (idle_timers
))
4305 Lisp_Object
*vector
;
4306 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4307 EMACS_TIME timer_time
, idle_timer_time
;
4308 EMACS_TIME difference
;
4309 EMACS_TIME timer_difference
IF_LINT (= {0});
4310 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4312 /* Skip past invalid timers and timers already handled. */
4315 timer
= XCAR (timers
);
4316 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4318 timers
= XCDR (timers
);
4321 vector
= XVECTOR (timer
)->contents
;
4323 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4324 || !INTEGERP (vector
[3])
4325 || ! NILP (vector
[0]))
4327 timers
= XCDR (timers
);
4331 if (CONSP (idle_timers
))
4333 timer
= XCAR (idle_timers
);
4334 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4336 idle_timers
= XCDR (idle_timers
);
4339 vector
= XVECTOR (timer
)->contents
;
4341 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4342 || !INTEGERP (vector
[3])
4343 || ! NILP (vector
[0]))
4345 idle_timers
= XCDR (idle_timers
);
4350 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4351 based on the next ordinary timer.
4352 TIMER_DIFFERENCE is the distance in time from NOW to when
4353 this timer becomes ripe (negative if it's already ripe). */
4356 timer
= XCAR (timers
);
4357 vector
= XVECTOR (timer
)->contents
;
4358 EMACS_SET_SECS (timer_time
,
4359 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4360 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4361 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4364 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4365 based on the next idle timer. */
4366 if (CONSP (idle_timers
))
4368 idle_timer
= XCAR (idle_timers
);
4369 vector
= XVECTOR (idle_timer
)->contents
;
4370 EMACS_SET_SECS (idle_timer_time
,
4371 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4372 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4373 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4376 /* Decide which timer is the next timer,
4377 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4378 Also step down the list where we found that timer. */
4380 if (CONSP (timers
) && CONSP (idle_timers
))
4383 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4384 if (EMACS_TIME_NEG_P (temp
))
4386 chosen_timer
= timer
;
4387 timers
= XCDR (timers
);
4388 difference
= timer_difference
;
4392 chosen_timer
= idle_timer
;
4393 idle_timers
= XCDR (idle_timers
);
4394 difference
= idle_timer_difference
;
4397 else if (CONSP (timers
))
4399 chosen_timer
= timer
;
4400 timers
= XCDR (timers
);
4401 difference
= timer_difference
;
4405 chosen_timer
= idle_timer
;
4406 idle_timers
= XCDR (idle_timers
);
4407 difference
= idle_timer_difference
;
4409 vector
= XVECTOR (chosen_timer
)->contents
;
4411 /* If timer is ripe, run it if it hasn't been run. */
4412 if (EMACS_TIME_NEG_P (difference
)
4413 || (EMACS_SECS (difference
) == 0
4414 && EMACS_USECS (difference
) == 0))
4416 if (NILP (vector
[0]))
4418 ptrdiff_t count
= SPECPDL_INDEX ();
4419 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4421 /* Mark the timer as triggered to prevent problems if the lisp
4422 code fails to reschedule it right. */
4425 specbind (Qinhibit_quit
, Qt
);
4427 call1 (Qtimer_event_handler
, chosen_timer
);
4428 Vdeactivate_mark
= old_deactivate_mark
;
4430 unbind_to (count
, Qnil
);
4432 /* Since we have handled the event,
4433 we don't need to tell the caller to wake up and do it. */
4434 /* But the caller must still wait for the next timer, so
4435 return 0 to indicate that. */
4438 EMACS_SET_SECS (nexttime
, 0);
4439 EMACS_SET_USECS (nexttime
, 0);
4442 /* When we encounter a timer that is still waiting,
4443 return the amount of time to wait before it is ripe. */
4450 /* No timers are pending in the future. */
4451 /* Return 0 if we generated an event, and -1 if not. */
4457 /* Check whether a timer has fired. To prevent larger problems we simply
4458 disregard elements that are not proper timers. Do not make a circular
4459 timer list for the time being.
4461 Returns the time to wait until the next timer fires.
4462 If no timer is active, return -1.
4464 As long as any timer is ripe, we run it. */
4469 EMACS_TIME nexttime
;
4473 nexttime
= timer_check_2 ();
4475 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4480 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4481 doc
: /* Return the current length of Emacs idleness, or nil.
4482 The value when Emacs is idle is a list of three integers. The first has
4483 the most significant 16 bits of the seconds, while the second has the least
4484 significant 16 bits. The third integer gives the microsecond count.
4486 The value when Emacs is not idle is nil.
4488 The microsecond count is zero on systems that do not provide
4489 resolution finer than a second. */)
4492 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4494 EMACS_TIME now
, idleness_now
;
4496 EMACS_GET_TIME (now
);
4497 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4499 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4500 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4501 make_number (EMACS_USECS (idleness_now
)));
4507 /* Caches for modify_event_symbol. */
4508 static Lisp_Object accent_key_syms
;
4509 static Lisp_Object func_key_syms
;
4510 static Lisp_Object mouse_syms
;
4511 static Lisp_Object wheel_syms
;
4512 static Lisp_Object drag_n_drop_syms
;
4514 /* This is a list of keysym codes for special "accent" characters.
4515 It parallels lispy_accent_keys. */
4517 static const int lispy_accent_codes
[] =
4519 #ifdef XK_dead_circumflex
4524 #ifdef XK_dead_grave
4529 #ifdef XK_dead_tilde
4534 #ifdef XK_dead_diaeresis
4539 #ifdef XK_dead_macron
4544 #ifdef XK_dead_degree
4549 #ifdef XK_dead_acute
4554 #ifdef XK_dead_cedilla
4559 #ifdef XK_dead_breve
4564 #ifdef XK_dead_ogonek
4569 #ifdef XK_dead_caron
4574 #ifdef XK_dead_doubleacute
4575 XK_dead_doubleacute
,
4579 #ifdef XK_dead_abovedot
4584 #ifdef XK_dead_abovering
4594 #ifdef XK_dead_belowdot
4599 #ifdef XK_dead_voiced_sound
4600 XK_dead_voiced_sound
,
4604 #ifdef XK_dead_semivoiced_sound
4605 XK_dead_semivoiced_sound
,
4621 /* This is a list of Lisp names for special "accent" characters.
4622 It parallels lispy_accent_codes. */
4624 static const char *const lispy_accent_keys
[] =
4642 "dead-voiced-sound",
4643 "dead-semivoiced-sound",
4649 #define FUNCTION_KEY_OFFSET 0x0
4651 const char *const lispy_function_keys
[] =
4655 0, /* VK_LBUTTON 0x01 */
4656 0, /* VK_RBUTTON 0x02 */
4657 "cancel", /* VK_CANCEL 0x03 */
4658 0, /* VK_MBUTTON 0x04 */
4660 0, 0, 0, /* 0x05 .. 0x07 */
4662 "backspace", /* VK_BACK 0x08 */
4663 "tab", /* VK_TAB 0x09 */
4665 0, 0, /* 0x0A .. 0x0B */
4667 "clear", /* VK_CLEAR 0x0C */
4668 "return", /* VK_RETURN 0x0D */
4670 0, 0, /* 0x0E .. 0x0F */
4672 0, /* VK_SHIFT 0x10 */
4673 0, /* VK_CONTROL 0x11 */
4674 0, /* VK_MENU 0x12 */
4675 "pause", /* VK_PAUSE 0x13 */
4676 "capslock", /* VK_CAPITAL 0x14 */
4677 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4679 "junja", /* VK_JUNJA 0x17 */
4680 "final", /* VK_FINAL 0x18 */
4681 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4683 "escape", /* VK_ESCAPE 0x1B */
4684 "convert", /* VK_CONVERT 0x1C */
4685 "non-convert", /* VK_NONCONVERT 0x1D */
4686 "accept", /* VK_ACCEPT 0x1E */
4687 "mode-change", /* VK_MODECHANGE 0x1F */
4688 0, /* VK_SPACE 0x20 */
4689 "prior", /* VK_PRIOR 0x21 */
4690 "next", /* VK_NEXT 0x22 */
4691 "end", /* VK_END 0x23 */
4692 "home", /* VK_HOME 0x24 */
4693 "left", /* VK_LEFT 0x25 */
4694 "up", /* VK_UP 0x26 */
4695 "right", /* VK_RIGHT 0x27 */
4696 "down", /* VK_DOWN 0x28 */
4697 "select", /* VK_SELECT 0x29 */
4698 "print", /* VK_PRINT 0x2A */
4699 "execute", /* VK_EXECUTE 0x2B */
4700 "snapshot", /* VK_SNAPSHOT 0x2C */
4701 "insert", /* VK_INSERT 0x2D */
4702 "delete", /* VK_DELETE 0x2E */
4703 "help", /* VK_HELP 0x2F */
4705 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4707 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4709 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4711 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4713 0, 0, 0, 0, 0, 0, 0, 0, 0,
4714 0, 0, 0, 0, 0, 0, 0, 0, 0,
4715 0, 0, 0, 0, 0, 0, 0, 0,
4717 "lwindow", /* VK_LWIN 0x5B */
4718 "rwindow", /* VK_RWIN 0x5C */
4719 "apps", /* VK_APPS 0x5D */
4722 "kp-0", /* VK_NUMPAD0 0x60 */
4723 "kp-1", /* VK_NUMPAD1 0x61 */
4724 "kp-2", /* VK_NUMPAD2 0x62 */
4725 "kp-3", /* VK_NUMPAD3 0x63 */
4726 "kp-4", /* VK_NUMPAD4 0x64 */
4727 "kp-5", /* VK_NUMPAD5 0x65 */
4728 "kp-6", /* VK_NUMPAD6 0x66 */
4729 "kp-7", /* VK_NUMPAD7 0x67 */
4730 "kp-8", /* VK_NUMPAD8 0x68 */
4731 "kp-9", /* VK_NUMPAD9 0x69 */
4732 "kp-multiply", /* VK_MULTIPLY 0x6A */
4733 "kp-add", /* VK_ADD 0x6B */
4734 "kp-separator", /* VK_SEPARATOR 0x6C */
4735 "kp-subtract", /* VK_SUBTRACT 0x6D */
4736 "kp-decimal", /* VK_DECIMAL 0x6E */
4737 "kp-divide", /* VK_DIVIDE 0x6F */
4738 "f1", /* VK_F1 0x70 */
4739 "f2", /* VK_F2 0x71 */
4740 "f3", /* VK_F3 0x72 */
4741 "f4", /* VK_F4 0x73 */
4742 "f5", /* VK_F5 0x74 */
4743 "f6", /* VK_F6 0x75 */
4744 "f7", /* VK_F7 0x76 */
4745 "f8", /* VK_F8 0x77 */
4746 "f9", /* VK_F9 0x78 */
4747 "f10", /* VK_F10 0x79 */
4748 "f11", /* VK_F11 0x7A */
4749 "f12", /* VK_F12 0x7B */
4750 "f13", /* VK_F13 0x7C */
4751 "f14", /* VK_F14 0x7D */
4752 "f15", /* VK_F15 0x7E */
4753 "f16", /* VK_F16 0x7F */
4754 "f17", /* VK_F17 0x80 */
4755 "f18", /* VK_F18 0x81 */
4756 "f19", /* VK_F19 0x82 */
4757 "f20", /* VK_F20 0x83 */
4758 "f21", /* VK_F21 0x84 */
4759 "f22", /* VK_F22 0x85 */
4760 "f23", /* VK_F23 0x86 */
4761 "f24", /* VK_F24 0x87 */
4763 0, 0, 0, 0, /* 0x88 .. 0x8B */
4764 0, 0, 0, 0, /* 0x8C .. 0x8F */
4766 "kp-numlock", /* VK_NUMLOCK 0x90 */
4767 "scroll", /* VK_SCROLL 0x91 */
4768 /* Not sure where the following block comes from.
4769 Windows headers have NEC and Fujitsu specific keys in
4770 this block, but nothing generic. */
4771 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4772 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4773 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4774 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4775 "kp-end", /* VK_NUMPAD_END 0x96 */
4776 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4777 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4778 "kp-up", /* VK_NUMPAD_UP 0x99 */
4779 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4780 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4781 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4782 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4784 0, 0, /* 0x9E .. 0x9F */
4787 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4788 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4789 * No other API or message will distinguish left and right keys this way.
4794 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4795 to enable them selectively, and gives access to a few more functions.
4796 See lispy_multimedia_keys below. */
4797 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4798 0, 0, 0, /* 0xAD .. 0xAF Volume */
4799 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4800 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4802 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4803 0, 0, 0, 0, 0, 0, 0, 0, 0,
4805 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4806 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4807 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4810 "ax", /* VK_OEM_AX 0xE1 */
4811 0, /* VK_OEM_102 0xE2 */
4812 "ico-help", /* VK_ICO_HELP 0xE3 */
4813 "ico-00", /* VK_ICO_00 0xE4 */
4814 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4815 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4816 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4818 "reset", /* VK_OEM_RESET 0xE9 */
4819 "jump", /* VK_OEM_JUMP 0xEA */
4820 "oem-pa1", /* VK_OEM_PA1 0xEB */
4821 "oem-pa2", /* VK_OEM_PA2 0xEC */
4822 "oem-pa3", /* VK_OEM_PA3 0xED */
4823 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4824 "cusel", /* VK_OEM_CUSEL 0xEF */
4825 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4826 "finish", /* VK_OEM_FINISH 0xF1 */
4827 "copy", /* VK_OEM_COPY 0xF2 */
4828 "auto", /* VK_OEM_AUTO 0xF3 */
4829 "enlw", /* VK_OEM_ENLW 0xF4 */
4830 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4831 "attn", /* VK_ATTN 0xF6 */
4832 "crsel", /* VK_CRSEL 0xF7 */
4833 "exsel", /* VK_EXSEL 0xF8 */
4834 "ereof", /* VK_EREOF 0xF9 */
4835 "play", /* VK_PLAY 0xFA */
4836 "zoom", /* VK_ZOOM 0xFB */
4837 "noname", /* VK_NONAME 0xFC */
4838 "pa1", /* VK_PA1 0xFD */
4839 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4843 /* Some of these duplicate the "Media keys" on newer keyboards,
4844 but they are delivered to the application in a different way. */
4845 static const char *const lispy_multimedia_keys
[] =
4853 "browser-favorites",
4890 "toggle-dictate-command",
4896 "media-fast-forward",
4899 "media-channel-down"
4902 #else /* not HAVE_NTGUI */
4904 /* This should be dealt with in XTread_socket now, and that doesn't
4905 depend on the client system having the Kana syms defined. See also
4906 the XK_kana_A case below. */
4909 static const char *const lispy_kana_keys
[] =
4911 /* X Keysym value */
4912 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4913 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4914 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4915 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4916 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4917 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4918 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4919 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4920 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4921 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4922 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4923 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4924 "kana-i", "kana-u", "kana-e", "kana-o",
4925 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4926 "prolongedsound", "kana-A", "kana-I", "kana-U",
4927 "kana-E", "kana-O", "kana-KA", "kana-KI",
4928 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4929 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4930 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4931 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4932 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4933 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4934 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4935 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4936 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4937 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4938 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4939 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4941 #endif /* XK_kana_A */
4944 #define FUNCTION_KEY_OFFSET 0xff00
4946 /* You'll notice that this table is arranged to be conveniently
4947 indexed by X Windows keysym values. */
4948 static const char *const lispy_function_keys
[] =
4950 /* X Keysym value */
4952 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4953 "backspace", "tab", "linefeed", "clear",
4955 0, 0, 0, "pause", /* 0xff10...1f */
4956 0, 0, 0, 0, 0, 0, 0, "escape",
4958 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4959 "romaji", "hiragana", "katakana", "hiragana-katakana",
4960 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4961 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4962 "eisu-toggle", /* 0xff30...3f */
4963 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4964 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4966 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4967 "down", "prior", "next", "end",
4968 "begin", 0, 0, 0, 0, 0, 0, 0,
4969 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4980 "break", /* 0xff6b */
4983 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4984 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4985 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4986 0, 0, 0, 0, 0, 0, 0, 0,
4987 "kp-tab", /* 0xff89 */
4989 "kp-enter", /* 0xff8d */
4991 "kp-f1", /* 0xff91 */
4995 "kp-home", /* 0xff95 */
5000 "kp-prior", /* kp-page-up */
5001 "kp-next", /* kp-page-down */
5007 0, 0, 0, 0, 0, 0, 0, 0, 0,
5008 "kp-multiply", /* 0xffaa */
5013 "kp-divide", /* 0xffaf */
5014 "kp-0", /* 0xffb0 */
5015 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5018 "kp-equal", /* 0xffbd */
5019 "f1", /* 0xffbe */ /* IsFunctionKey */
5021 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5022 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5023 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5024 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5025 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5026 0, 0, 0, 0, 0, 0, 0, 0,
5027 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5028 0, 0, 0, 0, 0, 0, 0, "delete"
5031 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5032 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5034 static const char *const iso_lispy_function_keys
[] =
5036 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5037 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5038 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5039 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5040 "iso-lefttab", /* 0xfe20 */
5041 "iso-move-line-up", "iso-move-line-down",
5042 "iso-partial-line-up", "iso-partial-line-down",
5043 "iso-partial-space-left", "iso-partial-space-right",
5044 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5045 "iso-release-margin-left", "iso-release-margin-right",
5046 "iso-release-both-margins",
5047 "iso-fast-cursor-left", "iso-fast-cursor-right",
5048 "iso-fast-cursor-up", "iso-fast-cursor-down",
5049 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5050 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5053 #endif /* not HAVE_NTGUI */
5055 static Lisp_Object Vlispy_mouse_stem
;
5057 static const char *const lispy_wheel_names
[] =
5059 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5062 /* drag-n-drop events are generated when a set of selected files are
5063 dragged from another application and dropped onto an Emacs window. */
5064 static const char *const lispy_drag_n_drop_names
[] =
5069 /* Scroll bar parts. */
5070 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5071 Lisp_Object Qup
, Qdown
, Qbottom
;
5072 static Lisp_Object Qend_scroll
;
5074 static Lisp_Object Qratio
;
5076 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5077 static Lisp_Object
*const scroll_bar_parts
[] = {
5078 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5079 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5082 /* A vector, indexed by button number, giving the down-going location
5083 of currently depressed buttons, both scroll bar and non-scroll bar.
5085 The elements have the form
5086 (BUTTON-NUMBER MODIFIER-MASK . REST)
5087 where REST is the cdr of a position as it would be reported in the event.
5089 The make_lispy_event function stores positions here to tell the
5090 difference between click and drag events, and to store the starting
5091 location to be included in drag events. */
5093 static Lisp_Object button_down_location
;
5095 /* Information about the most recent up-going button event: Which
5096 button, what location, and what time. */
5098 static int last_mouse_button
;
5099 static int last_mouse_x
;
5100 static int last_mouse_y
;
5101 static Time button_down_time
;
5103 /* The number of clicks in this multiple-click. */
5105 static int double_click_count
;
5107 /* X and Y are frame-relative coordinates for a click or wheel event.
5108 Return a Lisp-style event list. */
5111 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5114 enum window_part part
;
5115 Lisp_Object posn
= Qnil
;
5116 Lisp_Object extra_info
= Qnil
;
5117 /* Coordinate pixel positions to return. */
5118 int xret
= 0, yret
= 0;
5119 /* The window under frame pixel coordinates (x,y) */
5120 Lisp_Object window
= f
5121 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5124 if (WINDOWP (window
))
5126 /* It's a click in window window at frame coordinates (x,y) */
5127 struct window
*w
= XWINDOW (window
);
5128 Lisp_Object string_info
= Qnil
;
5129 ptrdiff_t textpos
= -1;
5130 int col
= -1, row
= -1;
5131 int dx
= -1, dy
= -1;
5132 int width
= -1, height
= -1;
5133 Lisp_Object object
= Qnil
;
5135 /* Pixel coordinates relative to the window corner. */
5136 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5137 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5139 /* For text area clicks, return X, Y relative to the corner of
5140 this text area. Note that dX, dY etc are set below, by
5141 buffer_posn_from_coords. */
5142 if (part
== ON_TEXT
)
5144 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5145 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5147 /* For mode line and header line clicks, return X, Y relative to
5148 the left window edge. Use mode_line_string to look for a
5149 string on the click position. */
5150 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5155 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5156 /* Note that mode_line_string takes COL, ROW as pixels and
5157 converts them to characters. */
5160 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5161 &object
, &dx
, &dy
, &width
, &height
);
5162 if (STRINGP (string
))
5163 string_info
= Fcons (string
, make_number (charpos
));
5164 textpos
= (w
== XWINDOW (selected_window
)
5165 && current_buffer
== XBUFFER (w
->buffer
))
5166 ? PT
: XMARKER (w
->pointm
)->charpos
;
5171 /* For fringes and margins, Y is relative to the area's (and the
5172 window's) top edge, while X is meaningless. */
5173 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5178 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5181 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5182 &object
, &dx
, &dy
, &width
, &height
);
5183 if (STRINGP (string
))
5184 string_info
= Fcons (string
, make_number (charpos
));
5185 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5187 else if (part
== ON_LEFT_FRINGE
)
5189 posn
= Qleft_fringe
;
5192 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5193 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5194 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5196 else if (part
== ON_RIGHT_FRINGE
)
5198 posn
= Qright_fringe
;
5201 - window_box_width (w
, LEFT_MARGIN_AREA
)
5202 - window_box_width (w
, TEXT_AREA
)
5203 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5204 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5206 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5208 else if (part
== ON_VERTICAL_BORDER
)
5210 posn
= Qvertical_line
;
5215 /* Nothing special for part == ON_SCROLL_BAR. */
5217 /* For clicks in the text area, fringes, or margins, call
5218 buffer_posn_from_coords to extract TEXTPOS, the buffer
5219 position nearest to the click. */
5222 Lisp_Object string2
, object2
= Qnil
;
5223 struct display_pos p
;
5225 int width2
, height2
;
5226 /* The pixel X coordinate passed to buffer_posn_from_coords
5227 is the X coordinate relative to the text area for
5228 text-area and right-margin clicks, zero otherwise. */
5230 = (part
== ON_TEXT
) ? xret
5231 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5232 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5236 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5237 &object2
, &dx2
, &dy2
,
5239 textpos
= CHARPOS (p
.pos
);
5240 if (col
< 0) col
= x2
;
5241 if (row
< 0) row
= y2
;
5242 if (dx
< 0) dx
= dx2
;
5243 if (dy
< 0) dy
= dy2
;
5244 if (width
< 0) width
= width2
;
5245 if (height
< 0) height
= height2
;
5249 posn
= make_number (textpos
);
5250 if (STRINGP (string2
))
5251 string_info
= Fcons (string2
,
5252 make_number (CHARPOS (p
.string_pos
)));
5258 #ifdef HAVE_WINDOW_SYSTEM
5259 if (IMAGEP (object
))
5261 Lisp_Object image_map
, hotspot
;
5262 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5264 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5266 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5267 posn
= XCAR (hotspot
);
5274 Fcons (make_number (dx
), make_number (dy
)),
5275 Fcons (make_number (width
), make_number (height
)));
5278 extra_info
= Fcons (string_info
,
5279 Fcons (make_number (textpos
),
5280 Fcons (Fcons (make_number (col
),
5285 XSETFRAME (window
, f
);
5289 return Fcons (window
,
5291 Fcons (Fcons (make_number (xret
),
5292 make_number (yret
)),
5293 Fcons (make_number (t
),
5297 /* Given a struct input_event, build the lisp event which represents
5298 it. If EVENT is 0, build a mouse movement event from the mouse
5299 movement buffer, which should have a movement event in it.
5301 Note that events must be passed to this function in the order they
5302 are received; this function stores the location of button presses
5303 in order to build drag events when the button is released. */
5306 make_lispy_event (struct input_event
*event
)
5310 switch (SWITCH_ENUM_CAST (event
->kind
))
5312 /* A simple keystroke. */
5313 case ASCII_KEYSTROKE_EVENT
:
5314 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5316 Lisp_Object lispy_c
;
5317 EMACS_INT c
= event
->code
;
5318 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5321 eassert (c
== event
->code
);
5322 /* Turn ASCII characters into control characters
5324 if (event
->modifiers
& ctrl_modifier
)
5326 c
= make_ctrl_char (c
);
5327 event
->modifiers
&= ~ctrl_modifier
;
5331 /* Add in the other modifier bits. The shift key was taken care
5332 of by the X code. */
5333 c
|= (event
->modifiers
5334 & (meta_modifier
| alt_modifier
5335 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5336 /* Distinguish Shift-SPC from SPC. */
5337 if ((event
->code
) == 040
5338 && event
->modifiers
& shift_modifier
)
5339 c
|= shift_modifier
;
5340 button_down_time
= 0;
5341 XSETFASTINT (lispy_c
, c
);
5346 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5347 except that they are non-key events (last-nonmenu-event is nil). */
5348 case NS_NONKEY_EVENT
:
5351 /* A function key. The symbol may need to have modifier prefixes
5353 case NON_ASCII_KEYSTROKE_EVENT
:
5354 button_down_time
= 0;
5356 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5357 if (event
->code
== lispy_accent_codes
[i
])
5358 return modify_event_symbol (i
,
5360 Qfunction_key
, Qnil
,
5361 lispy_accent_keys
, &accent_key_syms
,
5362 (sizeof (lispy_accent_keys
)
5363 / sizeof (lispy_accent_keys
[0])));
5367 if (event
->code
>= 0x400 && event
->code
< 0x500)
5368 return modify_event_symbol (event
->code
- 0x400,
5369 event
->modifiers
& ~shift_modifier
,
5370 Qfunction_key
, Qnil
,
5371 lispy_kana_keys
, &func_key_syms
,
5372 (sizeof (lispy_kana_keys
)
5373 / sizeof (lispy_kana_keys
[0])));
5374 #endif /* XK_kana_A */
5377 #ifdef ISO_FUNCTION_KEY_OFFSET
5378 if (event
->code
< FUNCTION_KEY_OFFSET
5379 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5380 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5382 Qfunction_key
, Qnil
,
5383 iso_lispy_function_keys
, &func_key_syms
,
5384 (sizeof (iso_lispy_function_keys
)
5385 / sizeof (iso_lispy_function_keys
[0])));
5388 /* Handle system-specific or unknown keysyms. */
5389 if (event
->code
& (1 << 28)
5390 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5391 || (event
->code
- FUNCTION_KEY_OFFSET
5392 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5393 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5395 /* We need to use an alist rather than a vector as the cache
5396 since we can't make a vector long enuf. */
5397 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5398 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5399 return modify_event_symbol (event
->code
,
5402 KVAR (current_kboard
, Vsystem_key_alist
),
5403 0, &KVAR (current_kboard
, system_key_syms
),
5407 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5409 Qfunction_key
, Qnil
,
5410 lispy_function_keys
, &func_key_syms
,
5411 (sizeof (lispy_function_keys
)
5412 / sizeof (lispy_function_keys
[0])));
5415 case MULTIMEDIA_KEY_EVENT
:
5416 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5417 / sizeof (lispy_multimedia_keys
[0]))
5418 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5420 return modify_event_symbol (event
->code
, event
->modifiers
,
5421 Qfunction_key
, Qnil
,
5422 lispy_multimedia_keys
, &func_key_syms
,
5423 (sizeof (lispy_multimedia_keys
)
5424 / sizeof (lispy_multimedia_keys
[0])));
5430 /* A mouse click. Figure out where it is, decide whether it's
5431 a press, click or drag, and build the appropriate structure. */
5432 case MOUSE_CLICK_EVENT
:
5433 #ifndef USE_TOOLKIT_SCROLL_BARS
5434 case SCROLL_BAR_CLICK_EVENT
:
5437 int button
= event
->code
;
5439 Lisp_Object position
;
5440 Lisp_Object
*start_pos_ptr
;
5441 Lisp_Object start_pos
;
5445 /* Build the position as appropriate for this mouse click. */
5446 if (event
->kind
== MOUSE_CLICK_EVENT
)
5448 struct frame
*f
= XFRAME (event
->frame_or_window
);
5449 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5453 /* Ignore mouse events that were made on frame that
5454 have been deleted. */
5455 if (! FRAME_LIVE_P (f
))
5458 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5459 /* EVENT->x and EVENT->y are frame-relative pixel
5460 coordinates at this place. Under old redisplay, COLUMN
5461 and ROW are set to frame relative glyph coordinates
5462 which are then used to determine whether this click is
5463 in a menu (non-toolkit version). */
5464 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5465 &column
, &row
, NULL
, 1);
5467 /* In the non-toolkit version, clicks on the menu bar
5468 are ordinary button events in the event buffer.
5469 Distinguish them, and invoke the menu.
5471 (In the toolkit version, the toolkit handles the menu bar
5472 and Emacs doesn't know about it until after the user
5473 makes a selection.) */
5474 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5475 && (event
->modifiers
& down_modifier
))
5477 Lisp_Object items
, item
;
5479 /* Find the menu bar item under `column'. */
5481 items
= FRAME_MENU_BAR_ITEMS (f
);
5482 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5484 Lisp_Object pos
, string
;
5485 string
= AREF (items
, i
+ 1);
5486 pos
= AREF (items
, i
+ 3);
5489 if (column
>= XINT (pos
)
5490 && column
< XINT (pos
) + SCHARS (string
))
5492 item
= AREF (items
, i
);
5497 /* ELisp manual 2.4b says (x y) are window relative but
5498 code says they are frame-relative. */
5500 = Fcons (event
->frame_or_window
,
5502 Fcons (Fcons (event
->x
, event
->y
),
5503 Fcons (make_number (event
->timestamp
),
5506 return Fcons (item
, Fcons (position
, Qnil
));
5508 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5510 position
= make_lispy_position (f
, event
->x
, event
->y
,
5513 #ifndef USE_TOOLKIT_SCROLL_BARS
5516 /* It's a scrollbar click. */
5518 Lisp_Object portion_whole
;
5521 window
= event
->frame_or_window
;
5522 portion_whole
= Fcons (event
->x
, event
->y
);
5523 part
= *scroll_bar_parts
[(int) event
->part
];
5527 Fcons (Qvertical_scroll_bar
,
5528 Fcons (portion_whole
,
5529 Fcons (make_number (event
->timestamp
),
5530 Fcons (part
, Qnil
)))));
5532 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5534 if (button
>= ASIZE (button_down_location
))
5536 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5537 button_down_location
= larger_vector (button_down_location
,
5539 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5542 start_pos_ptr
= &AREF (button_down_location
, button
);
5543 start_pos
= *start_pos_ptr
;
5544 *start_pos_ptr
= Qnil
;
5547 /* On window-system frames, use the value of
5548 double-click-fuzz as is. On other frames, interpret it
5549 as a multiple of 1/8 characters. */
5553 if (WINDOWP (event
->frame_or_window
))
5554 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5555 else if (FRAMEP (event
->frame_or_window
))
5556 f
= XFRAME (event
->frame_or_window
);
5560 if (FRAME_WINDOW_P (f
))
5561 fuzz
= double_click_fuzz
;
5563 fuzz
= double_click_fuzz
/ 8;
5565 is_double
= (button
== last_mouse_button
5566 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5567 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5568 && button_down_time
!= 0
5569 && (EQ (Vdouble_click_time
, Qt
)
5570 || (NATNUMP (Vdouble_click_time
)
5571 && (event
->timestamp
- button_down_time
5572 < XFASTINT (Vdouble_click_time
)))));
5575 last_mouse_button
= button
;
5576 last_mouse_x
= XINT (event
->x
);
5577 last_mouse_y
= XINT (event
->y
);
5579 /* If this is a button press, squirrel away the location, so
5580 we can decide later whether it was a click or a drag. */
5581 if (event
->modifiers
& down_modifier
)
5585 double_click_count
++;
5586 event
->modifiers
|= ((double_click_count
> 2)
5591 double_click_count
= 1;
5592 button_down_time
= event
->timestamp
;
5593 *start_pos_ptr
= Fcopy_alist (position
);
5594 ignore_mouse_drag_p
= 0;
5597 /* Now we're releasing a button - check the co-ordinates to
5598 see if this was a click or a drag. */
5599 else if (event
->modifiers
& up_modifier
)
5601 /* If we did not see a down before this up, ignore the up.
5602 Probably this happened because the down event chose a
5603 menu item. It would be an annoyance to treat the
5604 release of the button that chose the menu item as a
5607 if (!CONSP (start_pos
))
5610 event
->modifiers
&= ~up_modifier
;
5613 Lisp_Object new_down
, down
;
5614 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5616 /* The third element of every position
5617 should be the (x,y) pair. */
5618 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5619 new_down
= Fcar (Fcdr (Fcdr (position
)));
5622 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5624 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5625 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5628 if (ignore_mouse_drag_p
)
5630 event
->modifiers
|= click_modifier
;
5631 ignore_mouse_drag_p
= 0;
5633 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5634 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5635 /* Maybe the mouse has moved a lot, caused scrolling, and
5636 eventually ended up at the same screen position (but
5637 not buffer position) in which case it is a drag, not
5639 /* FIXME: OTOH if the buffer position has changed
5640 because of a timer or process filter rather than
5641 because of mouse movement, it should be considered as
5642 a click. But mouse-drag-region completely ignores
5643 this case and it hasn't caused any real problem, so
5644 it's probably OK to ignore it as well. */
5645 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5646 /* Mouse hasn't moved (much). */
5647 event
->modifiers
|= click_modifier
;
5650 button_down_time
= 0;
5651 event
->modifiers
|= drag_modifier
;
5654 /* Don't check is_double; treat this as multiple
5655 if the down-event was multiple. */
5656 if (double_click_count
> 1)
5657 event
->modifiers
|= ((double_click_count
> 2)
5663 /* Every mouse event should either have the down_modifier or
5664 the up_modifier set. */
5668 /* Get the symbol we should use for the mouse click. */
5671 head
= modify_event_symbol (button
,
5673 Qmouse_click
, Vlispy_mouse_stem
,
5676 ASIZE (mouse_syms
));
5677 if (event
->modifiers
& drag_modifier
)
5682 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5685 Fcons (make_number (double_click_count
),
5695 case HORIZ_WHEEL_EVENT
:
5697 Lisp_Object position
;
5700 /* Build the position as appropriate for this mouse click. */
5701 struct frame
*f
= XFRAME (event
->frame_or_window
);
5703 /* Ignore wheel events that were made on frame that have been
5705 if (! FRAME_LIVE_P (f
))
5708 position
= make_lispy_position (f
, event
->x
, event
->y
,
5711 /* Set double or triple modifiers to indicate the wheel speed. */
5713 /* On window-system frames, use the value of
5714 double-click-fuzz as is. On other frames, interpret it
5715 as a multiple of 1/8 characters. */
5721 if (WINDOWP (event
->frame_or_window
))
5722 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5723 else if (FRAMEP (event
->frame_or_window
))
5724 fr
= XFRAME (event
->frame_or_window
);
5728 fuzz
= FRAME_WINDOW_P (fr
)
5729 ? double_click_fuzz
: double_click_fuzz
/ 8;
5731 if (event
->modifiers
& up_modifier
)
5733 /* Emit a wheel-up event. */
5734 event
->modifiers
&= ~up_modifier
;
5737 else if (event
->modifiers
& down_modifier
)
5739 /* Emit a wheel-down event. */
5740 event
->modifiers
&= ~down_modifier
;
5744 /* Every wheel event should either have the down_modifier or
5745 the up_modifier set. */
5748 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5751 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5752 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5753 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5754 && button_down_time
!= 0
5755 && (EQ (Vdouble_click_time
, Qt
)
5756 || (NATNUMP (Vdouble_click_time
)
5757 && (event
->timestamp
- button_down_time
5758 < XFASTINT (Vdouble_click_time
)))));
5761 double_click_count
++;
5762 event
->modifiers
|= ((double_click_count
> 2)
5768 double_click_count
= 1;
5769 event
->modifiers
|= click_modifier
;
5772 button_down_time
= event
->timestamp
;
5773 /* Use a negative value to distinguish wheel from mouse button. */
5774 last_mouse_button
= - (1 + symbol_num
);
5775 last_mouse_x
= XINT (event
->x
);
5776 last_mouse_y
= XINT (event
->y
);
5778 /* Get the symbol we should use for the wheel event. */
5779 head
= modify_event_symbol (symbol_num
,
5785 ASIZE (wheel_syms
));
5788 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5791 Fcons (make_number (double_click_count
),
5800 #ifdef USE_TOOLKIT_SCROLL_BARS
5802 /* We don't have down and up events if using toolkit scroll bars,
5803 so make this always a click event. Store in the `part' of
5804 the Lisp event a symbol which maps to the following actions:
5806 `above_handle' page up
5807 `below_handle' page down
5811 `bottom' bottom of buffer
5812 `handle' thumb has been dragged.
5813 `end-scroll' end of interaction with scroll bar
5815 The incoming input_event contains in its `part' member an
5816 index of type `enum scroll_bar_part' which we can use as an
5817 index in scroll_bar_parts to get the appropriate symbol. */
5819 case SCROLL_BAR_CLICK_EVENT
:
5821 Lisp_Object position
, head
, window
, portion_whole
, part
;
5823 window
= event
->frame_or_window
;
5824 portion_whole
= Fcons (event
->x
, event
->y
);
5825 part
= *scroll_bar_parts
[(int) event
->part
];
5829 Fcons (Qvertical_scroll_bar
,
5830 Fcons (portion_whole
,
5831 Fcons (make_number (event
->timestamp
),
5832 Fcons (part
, Qnil
)))));
5834 /* Always treat scroll bar events as clicks. */
5835 event
->modifiers
|= click_modifier
;
5836 event
->modifiers
&= ~up_modifier
;
5838 if (event
->code
>= ASIZE (mouse_syms
))
5839 mouse_syms
= larger_vector (mouse_syms
,
5840 event
->code
- ASIZE (mouse_syms
) + 1,
5843 /* Get the symbol we should use for the mouse click. */
5844 head
= modify_event_symbol (event
->code
,
5849 ASIZE (mouse_syms
));
5850 return Fcons (head
, Fcons (position
, Qnil
));
5853 #endif /* USE_TOOLKIT_SCROLL_BARS */
5855 case DRAG_N_DROP_EVENT
:
5858 Lisp_Object head
, position
;
5861 f
= XFRAME (event
->frame_or_window
);
5864 /* Ignore mouse events that were made on frames that
5865 have been deleted. */
5866 if (! FRAME_LIVE_P (f
))
5869 position
= make_lispy_position (f
, event
->x
, event
->y
,
5872 head
= modify_event_symbol (0, event
->modifiers
,
5874 lispy_drag_n_drop_names
,
5875 &drag_n_drop_syms
, 1);
5881 #endif /* HAVE_MOUSE */
5883 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5884 || defined (HAVE_NS) || defined (USE_GTK)
5885 case MENU_BAR_EVENT
:
5886 if (EQ (event
->arg
, event
->frame_or_window
))
5887 /* This is the prefix key. We translate this to
5888 `(menu_bar)' because the code in keyboard.c for menu
5889 events, which we use, relies on this. */
5890 return Fcons (Qmenu_bar
, Qnil
);
5894 case SELECT_WINDOW_EVENT
:
5895 /* Make an event (select-window (WINDOW)). */
5896 return Fcons (Qselect_window
,
5897 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5900 case TOOL_BAR_EVENT
:
5901 if (EQ (event
->arg
, event
->frame_or_window
))
5902 /* This is the prefix key. We translate this to
5903 `(tool_bar)' because the code in keyboard.c for tool bar
5904 events, which we use, relies on this. */
5905 return Fcons (Qtool_bar
, Qnil
);
5906 else if (SYMBOLP (event
->arg
))
5907 return apply_modifiers (event
->modifiers
, event
->arg
);
5910 case USER_SIGNAL_EVENT
:
5911 /* A user signal. */
5913 char *name
= find_user_signal_name (event
->code
);
5916 return intern (name
);
5919 case SAVE_SESSION_EVENT
:
5920 return Qsave_session
;
5925 return Fcons (Qdbus_event
, event
->arg
);
5927 #endif /* HAVE_DBUS */
5929 case CONFIG_CHANGED_EVENT
:
5930 return Fcons (Qconfig_changed_event
,
5932 Fcons (event
->frame_or_window
, Qnil
)));
5934 case GPM_CLICK_EVENT
:
5936 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5937 Lisp_Object head
, position
;
5938 Lisp_Object
*start_pos_ptr
;
5939 Lisp_Object start_pos
;
5940 int button
= event
->code
;
5942 if (button
>= ASIZE (button_down_location
))
5944 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5945 button_down_location
= larger_vector (button_down_location
,
5947 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5950 start_pos_ptr
= &AREF (button_down_location
, button
);
5951 start_pos
= *start_pos_ptr
;
5953 position
= make_lispy_position (f
, event
->x
, event
->y
,
5956 if (event
->modifiers
& down_modifier
)
5957 *start_pos_ptr
= Fcopy_alist (position
);
5958 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5960 if (!CONSP (start_pos
))
5962 event
->modifiers
&= ~up_modifier
;
5965 head
= modify_event_symbol (button
,
5967 Qmouse_click
, Vlispy_mouse_stem
,
5970 ASIZE (mouse_syms
));
5972 if (event
->modifiers
& drag_modifier
)
5977 else if (event
->modifiers
& double_modifier
)
5980 Fcons (make_number (2),
5982 else if (event
->modifiers
& triple_modifier
)
5985 Fcons (make_number (3),
5992 #endif /* HAVE_GPM */
5994 /* The 'kind' field of the event is something we don't recognize. */
6000 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6003 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6004 Lisp_Object x
, Lisp_Object y
, Time t
)
6006 /* Is it a scroll bar movement? */
6007 if (frame
&& ! NILP (bar_window
))
6009 Lisp_Object part_sym
;
6011 part_sym
= *scroll_bar_parts
[(int) part
];
6012 return Fcons (Qscroll_bar_movement
,
6013 Fcons (list5 (bar_window
,
6014 Qvertical_scroll_bar
,
6020 /* Or is it an ordinary mouse movement? */
6023 Lisp_Object position
;
6024 position
= make_lispy_position (frame
, x
, y
, t
);
6025 return list2 (Qmouse_movement
, position
);
6029 #endif /* HAVE_MOUSE || HAVE GPM */
6031 /* Construct a switch frame event. */
6033 make_lispy_switch_frame (Lisp_Object frame
)
6035 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6038 /* Manipulating modifiers. */
6040 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6042 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6043 SYMBOL's name of the end of the modifiers; the string from this
6044 position is the unmodified symbol name.
6046 This doesn't use any caches. */
6049 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6055 CHECK_SYMBOL (symbol
);
6058 name
= SYMBOL_NAME (symbol
);
6060 for (i
= 0; i
< SBYTES (name
) - 1; )
6062 ptrdiff_t this_mod_end
= 0;
6065 /* See if the name continues with a modifier word.
6066 Check that the word appears, but don't check what follows it.
6067 Set this_mod and this_mod_end to record what we find. */
6069 switch (SREF (name
, i
))
6071 #define SINGLE_LETTER_MOD(BIT) \
6072 (this_mod_end = i + 1, this_mod = BIT)
6075 SINGLE_LETTER_MOD (alt_modifier
);
6079 SINGLE_LETTER_MOD (ctrl_modifier
);
6083 SINGLE_LETTER_MOD (hyper_modifier
);
6087 SINGLE_LETTER_MOD (meta_modifier
);
6091 SINGLE_LETTER_MOD (shift_modifier
);
6095 SINGLE_LETTER_MOD (super_modifier
);
6098 #undef SINGLE_LETTER_MOD
6100 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6101 if (i + LEN + 1 <= SBYTES (name) \
6102 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6104 this_mod_end = i + LEN; \
6109 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6110 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6111 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6115 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6117 #undef MULTI_LETTER_MOD
6121 /* If we found no modifier, stop looking for them. */
6122 if (this_mod_end
== 0)
6125 /* Check there is a dash after the modifier, so that it
6126 really is a modifier. */
6127 if (this_mod_end
>= SBYTES (name
)
6128 || SREF (name
, this_mod_end
) != '-')
6131 /* This modifier is real; look for another. */
6132 modifiers
|= this_mod
;
6133 i
= this_mod_end
+ 1;
6136 /* Should we include the `click' modifier? */
6137 if (! (modifiers
& (down_modifier
| drag_modifier
6138 | double_modifier
| triple_modifier
))
6139 && i
+ 7 == SBYTES (name
)
6140 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6141 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6142 modifiers
|= click_modifier
;
6144 if (! (modifiers
& (double_modifier
| triple_modifier
))
6145 && i
+ 6 < SBYTES (name
)
6146 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6147 modifiers
|= click_modifier
;
6155 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6156 prepended to the string BASE[0..BASE_LEN-1].
6157 This doesn't use any caches. */
6159 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6161 /* Since BASE could contain nulls, we can't use intern here; we have
6162 to use Fintern, which expects a genuine Lisp_String, and keeps a
6165 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6171 /* Only the event queue may use the `up' modifier; it should always
6172 be turned into a click or drag event before presented to lisp code. */
6173 if (modifiers
& up_modifier
)
6176 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6177 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6178 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6179 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6180 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6181 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6182 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6183 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6184 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6185 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6186 /* The click modifier is denoted by the absence of other modifiers. */
6190 mod_len
= p
- new_mods
;
6194 Lisp_Object new_name
;
6196 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6197 mod_len
+ base_len_byte
);
6198 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6199 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6201 return Fintern (new_name
, Qnil
);
6206 static const char *const modifier_names
[] =
6208 "up", "down", "drag", "click", "double", "triple", 0, 0,
6209 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6210 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6212 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6214 static Lisp_Object modifier_symbols
;
6216 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6218 lispy_modifier_list (int modifiers
)
6220 Lisp_Object modifier_list
;
6223 modifier_list
= Qnil
;
6224 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6225 if (modifiers
& (1<<i
))
6226 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6229 return modifier_list
;
6233 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6234 where UNMODIFIED is the unmodified form of SYMBOL,
6235 MASK is the set of modifiers present in SYMBOL's name.
6236 This is similar to parse_modifiers_uncached, but uses the cache in
6237 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6238 Qevent_symbol_elements property. */
6240 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6243 parse_modifiers (Lisp_Object symbol
)
6245 Lisp_Object elements
;
6247 if (INTEGERP (symbol
))
6248 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6249 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6251 else if (!SYMBOLP (symbol
))
6254 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6255 if (CONSP (elements
))
6260 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6261 Lisp_Object unmodified
;
6264 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6265 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6268 if (modifiers
& ~INTMASK
)
6270 XSETFASTINT (mask
, modifiers
);
6271 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6273 /* Cache the parsing results on SYMBOL. */
6274 Fput (symbol
, Qevent_symbol_element_mask
,
6276 Fput (symbol
, Qevent_symbol_elements
,
6277 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6279 /* Since we know that SYMBOL is modifiers applied to unmodified,
6280 it would be nice to put that in unmodified's cache.
6281 But we can't, since we're not sure that parse_modifiers is
6288 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6289 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6290 doc
: /* Parse the event symbol. For internal use. */)
6291 (Lisp_Object symbol
)
6293 /* Fill the cache if needed. */
6294 parse_modifiers (symbol
);
6295 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6296 and use the Lispier representation stored on Qevent_symbol_elements
6298 return Fget (symbol
, Qevent_symbol_elements
);
6301 /* Apply the modifiers MODIFIERS to the symbol BASE.
6302 BASE must be unmodified.
6304 This is like apply_modifiers_uncached, but uses BASE's
6305 Qmodifier_cache property, if present. It also builds
6306 Qevent_symbol_elements properties, since it has that info anyway.
6308 apply_modifiers copies the value of BASE's Qevent_kind property to
6309 the modified symbol. */
6311 apply_modifiers (int modifiers
, Lisp_Object base
)
6313 Lisp_Object cache
, idx
, entry
, new_symbol
;
6315 /* Mask out upper bits. We don't know where this value's been. */
6316 modifiers
&= INTMASK
;
6318 if (INTEGERP (base
))
6319 return make_number (XINT (base
) | modifiers
);
6321 /* The click modifier never figures into cache indices. */
6322 cache
= Fget (base
, Qmodifier_cache
);
6323 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6324 entry
= assq_no_quit (idx
, cache
);
6327 new_symbol
= XCDR (entry
);
6330 /* We have to create the symbol ourselves. */
6331 new_symbol
= apply_modifiers_uncached (modifiers
,
6332 SSDATA (SYMBOL_NAME (base
)),
6333 SCHARS (SYMBOL_NAME (base
)),
6334 SBYTES (SYMBOL_NAME (base
)));
6336 /* Add the new symbol to the base's cache. */
6337 entry
= Fcons (idx
, new_symbol
);
6338 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6340 /* We have the parsing info now for free, so we could add it to
6342 XSETFASTINT (idx, modifiers);
6343 Fput (new_symbol, Qevent_symbol_element_mask,
6344 Fcons (base, Fcons (idx, Qnil)));
6345 Fput (new_symbol, Qevent_symbol_elements,
6346 Fcons (base, lispy_modifier_list (modifiers)));
6347 Sadly, this is only correct if `base' is indeed a base event,
6348 which is not necessarily the case. -stef */
6351 /* Make sure this symbol is of the same kind as BASE.
6353 You'd think we could just set this once and for all when we
6354 intern the symbol above, but reorder_modifiers may call us when
6355 BASE's property isn't set right; we can't assume that just
6356 because it has a Qmodifier_cache property it must have its
6357 Qevent_kind set right as well. */
6358 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6362 kind
= Fget (base
, Qevent_kind
);
6364 Fput (new_symbol
, Qevent_kind
, kind
);
6371 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6372 return a symbol with the modifiers placed in the canonical order.
6373 Canonical order is alphabetical, except for down and drag, which
6374 always come last. The 'click' modifier is never written out.
6376 Fdefine_key calls this to make sure that (for example) C-M-foo
6377 and M-C-foo end up being equivalent in the keymap. */
6380 reorder_modifiers (Lisp_Object symbol
)
6382 /* It's hopefully okay to write the code this way, since everything
6383 will soon be in caches, and no consing will be done at all. */
6386 parsed
= parse_modifiers (symbol
);
6387 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6392 /* For handling events, we often want to produce a symbol whose name
6393 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6394 to some base, like the name of a function key or mouse button.
6395 modify_event_symbol produces symbols of this sort.
6397 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6398 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6401 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6402 into symbol names, or a string specifying a name stem used to
6403 construct a symbol name or the form `STEM-N', where N is the decimal
6404 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6405 non-nil; otherwise NAME_TABLE is used.
6407 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6408 persist between calls to modify_event_symbol that it can use to
6409 store a cache of the symbols it's generated for this NAME_TABLE
6410 before. The object stored there may be a vector or an alist.
6412 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6414 MODIFIERS is a set of modifier bits (as given in struct input_events)
6415 whose prefixes should be applied to the symbol name.
6417 SYMBOL_KIND is the value to be placed in the event_kind property of
6418 the returned symbol.
6420 The symbols we create are supposed to have an
6421 `event-symbol-elements' property, which lists the modifiers present
6422 in the symbol's name. */
6425 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6426 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6427 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6430 Lisp_Object symbol_int
;
6432 /* Get rid of the "vendor-specific" bit here. */
6433 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6435 /* Is this a request for a valid symbol? */
6436 if (symbol_num
< 0 || symbol_num
>= table_size
)
6439 if (CONSP (*symbol_table
))
6440 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6442 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6443 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6444 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6445 we've never used that symbol before. */
6448 if (! VECTORP (*symbol_table
)
6449 || ASIZE (*symbol_table
) != table_size
)
6453 XSETFASTINT (size
, table_size
);
6454 *symbol_table
= Fmake_vector (size
, Qnil
);
6457 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6460 /* Have we already used this symbol before? */
6463 /* No; let's create it. */
6464 if (CONSP (name_alist_or_stem
))
6465 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6466 else if (STRINGP (name_alist_or_stem
))
6469 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6470 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6472 SAFE_ALLOCA (buf
, char *, len
);
6473 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6474 XINT (symbol_int
) + 1);
6475 value
= intern (buf
);
6478 else if (name_table
!= 0 && name_table
[symbol_num
])
6479 value
= intern (name_table
[symbol_num
]);
6481 #ifdef HAVE_WINDOW_SYSTEM
6484 char *name
= x_get_keysym_name (symbol_num
);
6486 value
= intern (name
);
6492 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6493 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6494 value
= intern (buf
);
6497 if (CONSP (*symbol_table
))
6498 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6500 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6502 /* Fill in the cache entries for this symbol; this also
6503 builds the Qevent_symbol_elements property, which the user
6505 apply_modifiers (modifiers
& click_modifier
, value
);
6506 Fput (value
, Qevent_kind
, symbol_kind
);
6509 /* Apply modifiers to that symbol. */
6510 return apply_modifiers (modifiers
, value
);
6513 /* Convert a list that represents an event type,
6514 such as (ctrl meta backspace), into the usual representation of that
6515 event type as a number or a symbol. */
6517 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6518 doc
: /* Convert the event description list EVENT-DESC to an event type.
6519 EVENT-DESC should contain one base event type (a character or symbol)
6520 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6521 drag, down, double or triple). The base must be last.
6522 The return value is an event type (a character or symbol) which
6523 has the same base event type and all the specified modifiers. */)
6524 (Lisp_Object event_desc
)
6532 while (CONSP (rest
))
6540 /* Given a symbol, see if it is a modifier name. */
6541 if (SYMBOLP (elt
) && CONSP (rest
))
6542 this = parse_solitary_modifier (elt
);
6546 else if (!NILP (base
))
6547 error ("Two bases given in one event");
6553 /* Let the symbol A refer to the character A. */
6554 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6555 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6557 if (INTEGERP (base
))
6559 /* Turn (shift a) into A. */
6560 if ((modifiers
& shift_modifier
) != 0
6561 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6563 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6564 modifiers
&= ~shift_modifier
;
6567 /* Turn (control a) into C-a. */
6568 if (modifiers
& ctrl_modifier
)
6569 return make_number ((modifiers
& ~ctrl_modifier
)
6570 | make_ctrl_char (XINT (base
)));
6572 return make_number (modifiers
| XINT (base
));
6574 else if (SYMBOLP (base
))
6575 return apply_modifiers (modifiers
, base
);
6578 error ("Invalid base event");
6583 /* Try to recognize SYMBOL as a modifier name.
6584 Return the modifier flag bit, or 0 if not recognized. */
6587 parse_solitary_modifier (Lisp_Object symbol
)
6589 Lisp_Object name
= SYMBOL_NAME (symbol
);
6591 switch (SREF (name
, 0))
6593 #define SINGLE_LETTER_MOD(BIT) \
6594 if (SBYTES (name) == 1) \
6597 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6598 if (LEN == SBYTES (name) \
6599 && ! strncmp (SSDATA (name), NAME, LEN)) \
6603 SINGLE_LETTER_MOD (alt_modifier
);
6607 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6611 SINGLE_LETTER_MOD (ctrl_modifier
);
6615 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6616 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6620 SINGLE_LETTER_MOD (hyper_modifier
);
6624 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6628 SINGLE_LETTER_MOD (meta_modifier
);
6632 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6636 SINGLE_LETTER_MOD (shift_modifier
);
6640 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6641 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6642 SINGLE_LETTER_MOD (super_modifier
);
6646 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6647 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6648 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6652 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6655 #undef SINGLE_LETTER_MOD
6656 #undef MULTI_LETTER_MOD
6662 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6663 Such a list is not valid as an event,
6664 but it can be a Lucid-style event type list. */
6667 lucid_event_type_list_p (Lisp_Object object
)
6671 if (! CONSP (object
))
6674 if (EQ (XCAR (object
), Qhelp_echo
)
6675 || EQ (XCAR (object
), Qvertical_line
)
6676 || EQ (XCAR (object
), Qmode_line
)
6677 || EQ (XCAR (object
), Qheader_line
))
6680 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6684 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6691 /* Store into *addr a value nonzero if terminal input chars are available.
6692 Serves the purpose of ioctl (0, FIONREAD, addr)
6693 but works even if FIONREAD does not exist.
6694 (In fact, this may actually read some input.)
6696 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6697 timer events that are ripe.
6698 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6699 events (FOCUS_IN_EVENT).
6700 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6701 movements and toolkit scroll bar thumb drags. */
6704 get_input_pending (int *addr
, int flags
)
6706 /* First of all, have we already counted some input? */
6707 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6709 /* If input is being read as it arrives, and we have none, there is none. */
6710 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6713 /* Try to read some input and see how much we get. */
6715 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6718 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6721 gobble_input (int expected
)
6724 if (interrupt_input
)
6727 mask
= sigblock (sigmask (SIGIO
));
6728 read_avail_input (expected
);
6732 #ifdef POLL_FOR_INPUT
6733 /* XXX This condition was (read_socket_hook && !interrupt_input),
6734 but read_socket_hook is not global anymore. Let's pretend that
6736 if (!interrupt_input
&& poll_suppress_count
== 0)
6739 mask
= sigblock (sigmask (SIGALRM
));
6740 read_avail_input (expected
);
6746 read_avail_input (expected
);
6749 /* Put a BUFFER_SWITCH_EVENT in the buffer
6750 so that read_key_sequence will notice the new current buffer. */
6753 record_asynch_buffer_change (void)
6755 struct input_event event
;
6759 event
.kind
= BUFFER_SWITCH_EVENT
;
6760 event
.frame_or_window
= Qnil
;
6763 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6764 The purpose of the event is to make read_key_sequence look up the
6765 keymaps again. If we aren't in read_key_sequence, we don't need one,
6766 and the event could cause trouble by messing up (input-pending-p).
6767 Note: Fwaiting_for_user_input_p always returns nil when async
6768 subprocesses aren't supported. */
6769 tem
= Fwaiting_for_user_input_p ();
6773 /* Make sure no interrupt happens while storing the event. */
6775 if (interrupt_input
)
6778 mask
= sigblock (sigmask (SIGIO
));
6779 kbd_buffer_store_event (&event
);
6786 kbd_buffer_store_event (&event
);
6791 /* Read any terminal input already buffered up by the system
6792 into the kbd_buffer, but do not wait.
6794 EXPECTED should be nonzero if the caller knows there is some input.
6796 Returns the number of keyboard chars read, or -1 meaning
6797 this is a bad time to try to read input. */
6800 read_avail_input (int expected
)
6806 /* Store pending user signal events, if any. */
6807 if (store_user_signal_events ())
6810 /* Loop through the available terminals, and call their input hooks. */
6814 struct terminal
*next
= t
->next_terminal
;
6816 if (t
->read_socket_hook
)
6819 struct input_event hold_quit
;
6821 EVENT_INIT (hold_quit
);
6822 hold_quit
.kind
= NO_EVENT
;
6824 /* No need for FIONREAD or fcntl; just say don't wait. */
6825 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6831 if (nr
== -1) /* Not OK to read input now. */
6835 else if (nr
== -2) /* Non-transient error. */
6837 /* The terminal device terminated; it should be closed. */
6839 /* Kill Emacs if this was our last terminal. */
6840 if (!terminal_list
->next_terminal
)
6841 /* Formerly simply reported no input, but that
6842 sometimes led to a failure of Emacs to terminate.
6843 SIGHUP seems appropriate if we can't reach the
6845 /* ??? Is it really right to send the signal just to
6846 this process rather than to the whole process
6847 group? Perhaps on systems with FIONREAD Emacs is
6848 alone in its group. */
6849 kill (getpid (), SIGHUP
);
6851 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6854 XSETTERMINAL (tmp
, t
);
6855 Fdelete_terminal (tmp
, Qnoelisp
);
6859 if (hold_quit
.kind
!= NO_EVENT
)
6860 kbd_buffer_store_event (&hold_quit
);
6869 frame_make_pointer_visible ();
6875 decode_keyboard_code (struct tty_display_info
*tty
,
6876 struct coding_system
*coding
,
6877 unsigned char *buf
, int nbytes
)
6879 unsigned char *src
= buf
;
6880 const unsigned char *p
;
6885 if (tty
->meta_key
!= 2)
6886 for (i
= 0; i
< nbytes
; i
++)
6888 if (coding
->carryover_bytes
> 0)
6890 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6891 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6892 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6893 nbytes
+= coding
->carryover_bytes
;
6895 coding
->destination
= alloca (nbytes
* 4);
6896 coding
->dst_bytes
= nbytes
* 4;
6897 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6898 if (coding
->produced_char
== 0)
6900 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6902 struct input_event event_buf
;
6904 EVENT_INIT (event_buf
);
6905 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6907 (ASCII_CHAR_P (event_buf
.code
)
6908 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6909 /* See the comment in tty_read_avail_input. */
6910 event_buf
.frame_or_window
= tty
->top_frame
;
6911 event_buf
.arg
= Qnil
;
6912 kbd_buffer_store_event (&event_buf
);
6916 /* This is the tty way of reading available input.
6918 Note that each terminal device has its own `struct terminal' object,
6919 and so this function is called once for each individual termcap
6920 terminal. The first parameter indicates which terminal to read from. */
6923 tty_read_avail_input (struct terminal
*terminal
,
6925 struct input_event
*hold_quit
)
6927 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6928 the kbd_buffer can really hold. That may prevent loss
6929 of characters on some systems when input is stuffed at us. */
6930 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6932 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6935 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6937 if (kbd_on_hold_p () || buffer_free
<= 0)
6939 #endif /* subprocesses */
6941 if (!terminal
->name
) /* Don't read from a dead terminal. */
6944 if (terminal
->type
!= output_termcap
6945 && terminal
->type
!= output_msdos_raw
)
6948 /* XXX I think the following code should be moved to separate hook
6949 functions in system-dependent files. */
6952 #else /* not WINDOWSNT */
6953 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6957 return 0; /* The terminal is suspended. */
6960 n_to_read
= dos_keysns ();
6964 cbuf
[0] = dos_keyread ();
6967 #else /* not MSDOS */
6972 struct input_event gpm_hold_quit
;
6973 int gpm
, fd
= gpm_fd
;
6975 EVENT_INIT (gpm_hold_quit
);
6976 gpm_hold_quit
.kind
= NO_EVENT
;
6978 /* gpm==1 if event received.
6979 gpm==0 if the GPM daemon has closed the connection, in which case
6980 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6981 we save it in `fd' so close_gpm can remove it from the
6983 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6984 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6985 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6988 /* Presumably the GPM daemon has closed the connection. */
6990 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6991 kbd_buffer_store_event (&gpm_hold_quit
);
6995 #endif /* HAVE_GPM */
6997 /* Determine how many characters we should *try* to read. */
6999 /* Find out how much input is available. */
7000 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7002 if (! noninteractive
)
7003 return -2; /* Close this terminal. */
7009 if (n_to_read
> sizeof cbuf
)
7010 n_to_read
= sizeof cbuf
;
7011 #else /* no FIONREAD */
7012 #if defined (USG) || defined (CYGWIN)
7013 /* Read some input if available, but don't wait. */
7014 n_to_read
= sizeof cbuf
;
7015 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7022 /* Don't read more than we can store. */
7023 if (n_to_read
> buffer_free
)
7024 n_to_read
= buffer_free
;
7025 #endif /* subprocesses */
7027 /* Now read; for one reason or another, this will not block.
7028 NREAD is set to the number of chars read. */
7031 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7032 /* POSIX infers that processes which are not in the session leader's
7033 process group won't get SIGHUP's at logout time. BSDI adheres to
7034 this part standard and returns -1 from read (0) with errno==EIO
7035 when the control tty is taken away.
7036 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7037 if (nread
== -1 && errno
== EIO
)
7038 return -2; /* Close this terminal. */
7039 #if defined (AIX) && defined (_BSD)
7040 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7041 This looks incorrect, but it isn't, because _BSD causes
7042 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7043 and that causes a value other than 0 when there is no input. */
7045 return -2; /* Close this terminal. */
7049 /* We used to retry the read if it was interrupted.
7050 But this does the wrong thing when O_NDELAY causes
7051 an EAGAIN error. Does anybody know of a situation
7052 where a retry is actually needed? */
7054 nread
< 0 && (errno
== EAGAIN
7068 #if defined (USG) || defined (CYGWIN)
7069 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7070 #endif /* USG or CYGWIN */
7071 #endif /* no FIONREAD */
7076 #endif /* not MSDOS */
7077 #endif /* not WINDOWSNT */
7079 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7080 & CODING_REQUIRE_DECODING_MASK
)
7082 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7085 /* Decode the key sequence except for those with meta
7087 for (i
= from
= 0; ; i
++)
7088 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7090 struct input_event buf
;
7092 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7097 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7098 buf
.modifiers
= meta_modifier
;
7099 buf
.code
= cbuf
[i
] & ~0x80;
7100 /* See the comment below. */
7101 buf
.frame_or_window
= tty
->top_frame
;
7103 kbd_buffer_store_event (&buf
);
7109 for (i
= 0; i
< nread
; i
++)
7111 struct input_event buf
;
7113 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7115 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7116 buf
.modifiers
= meta_modifier
;
7117 if (tty
->meta_key
!= 2)
7121 /* Set the frame corresponding to the active tty. Note that the
7122 value of selected_frame is not reliable here, redisplay tends
7123 to temporarily change it. */
7124 buf
.frame_or_window
= tty
->top_frame
;
7127 kbd_buffer_store_event (&buf
);
7128 /* Don't look at input that follows a C-g too closely.
7129 This reduces lossage due to autorepeat on C-g. */
7130 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7131 && buf
.code
== quit_char
)
7139 handle_async_input (void)
7141 interrupt_input_pending
= 0;
7143 pending_signals
= pending_atimers
;
7145 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7146 doing anything dangerous. */
7153 nread
= read_avail_input (1);
7154 /* -1 means it's not ok to read the input now.
7155 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7156 0 means there was no keyboard input available. */
7166 process_pending_signals (void)
7168 if (interrupt_input_pending
)
7169 handle_async_input ();
7170 do_pending_atimers ();
7173 #ifdef SIGIO /* for entire page */
7174 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7177 input_available_signal (int signo
)
7179 /* Must preserve main program's value of errno. */
7180 int old_errno
= errno
;
7181 SIGNAL_THREAD_CHECK (signo
);
7184 interrupt_input_pending
= 1;
7185 pending_signals
= 1;
7188 if (input_available_clear_time
)
7189 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7192 handle_async_input ();
7199 /* Send ourselves a SIGIO.
7201 This function exists so that the UNBLOCK_INPUT macro in
7202 blockinput.h can have some way to take care of input we put off
7203 dealing with, without assuming that every file which uses
7204 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7206 reinvoke_input_signal (void)
7209 handle_async_input ();
7215 /* User signal events. */
7217 struct user_signal_info
7219 /* Signal number. */
7222 /* Name of the signal. */
7225 /* Number of pending signals. */
7228 struct user_signal_info
*next
;
7231 /* List of user signals. */
7232 static struct user_signal_info
*user_signals
= NULL
;
7235 add_user_signal (int sig
, const char *name
)
7237 struct user_signal_info
*p
;
7239 for (p
= user_signals
; p
; p
= p
->next
)
7241 /* Already added. */
7244 p
= xmalloc (sizeof (struct user_signal_info
));
7246 p
->name
= xstrdup (name
);
7248 p
->next
= user_signals
;
7251 signal (sig
, handle_user_signal
);
7255 handle_user_signal (int sig
)
7257 int old_errno
= errno
;
7258 struct user_signal_info
*p
;
7259 const char *special_event_name
= NULL
;
7261 SIGNAL_THREAD_CHECK (sig
);
7263 if (SYMBOLP (Vdebug_on_event
))
7264 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7266 for (p
= user_signals
; p
; p
= p
->next
)
7269 if (special_event_name
&&
7270 strcmp (special_event_name
, p
->name
) == 0)
7272 /* Enter the debugger in many ways. */
7273 debug_on_next_call
= 1;
7276 Vinhibit_quit
= Qnil
;
7278 /* Eat the event. */
7284 if (interrupt_input
)
7285 kill (getpid (), SIGIO
);
7289 /* Tell wait_reading_process_output that it needs to wake
7290 up and look around. */
7291 if (input_available_clear_time
)
7292 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7301 find_user_signal_name (int sig
)
7303 struct user_signal_info
*p
;
7305 for (p
= user_signals
; p
; p
= p
->next
)
7313 store_user_signal_events (void)
7315 struct user_signal_info
*p
;
7316 struct input_event buf
;
7319 for (p
= user_signals
; p
; p
= p
->next
)
7320 if (p
->npending
> 0)
7326 memset (&buf
, 0, sizeof buf
);
7327 buf
.kind
= USER_SIGNAL_EVENT
;
7328 buf
.frame_or_window
= selected_frame
;
7330 nstored
+= p
->npending
;
7332 mask
= sigblock (sigmask (p
->sig
));
7336 kbd_buffer_store_event (&buf
);
7339 while (p
->npending
> 0);
7347 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7348 static Lisp_Object menu_bar_one_keymap_changed_items
;
7350 /* These variables hold the vector under construction within
7351 menu_bar_items and its subroutines, and the current index
7352 for storing into that vector. */
7353 static Lisp_Object menu_bar_items_vector
;
7354 static int menu_bar_items_index
;
7357 static const char* separator_names
[] = {
7362 "single-dashed-line",
7363 "double-dashed-line",
7365 "shadow-etched-out",
7366 "shadow-etched-in-dash",
7367 "shadow-etched-out-dash",
7368 "shadow-double-etched-in",
7369 "shadow-double-etched-out",
7370 "shadow-double-etched-in-dash",
7371 "shadow-double-etched-out-dash",
7375 /* Return non-zero if LABEL specifies a separator. */
7378 menu_separator_name_p (const char *label
)
7382 else if (strlen (label
) > 3
7383 && strncmp (label
, "--", 2) == 0
7388 for (i
= 0; separator_names
[i
]; ++i
)
7389 if (strcmp (label
, separator_names
[i
]) == 0)
7394 /* It's a separator if it contains only dashes. */
7395 while (*label
== '-')
7397 return (*label
== 0);
7404 /* Return a vector of menu items for a menu bar, appropriate
7405 to the current buffer. Each item has three elements in the vector:
7408 OLD is an old vector we can optionally reuse, or nil. */
7411 menu_bar_items (Lisp_Object old
)
7413 /* The number of keymaps we're scanning right now, and the number of
7414 keymaps we have allocated space for. */
7417 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7418 in the current keymaps, or nil where it is not a prefix. */
7421 Lisp_Object def
, tail
;
7426 /* In order to build the menus, we need to call the keymap
7427 accessors. They all call QUIT. But this function is called
7428 during redisplay, during which a quit is fatal. So inhibit
7429 quitting while building the menus.
7430 We do this instead of specbind because (1) errors will clear it anyway
7431 and (2) this avoids risk of specpdl overflow. */
7432 oquit
= Vinhibit_quit
;
7436 menu_bar_items_vector
= old
;
7438 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7439 menu_bar_items_index
= 0;
7441 /* Build our list of keymaps.
7442 If we recognize a function key and replace its escape sequence in
7443 keybuf with its symbol, or if the sequence starts with a mouse
7444 click and we need to switch buffers, we jump back here to rebuild
7445 the initial keymaps from the current buffer. */
7449 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7450 if (!NILP (Voverriding_local_map_menu_flag
))
7452 /* Yes, use them (if non-nil) as well as the global map. */
7453 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7455 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7456 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7457 if (!NILP (Voverriding_local_map
))
7458 maps
[nmaps
++] = Voverriding_local_map
;
7462 /* No, so use major and minor mode keymaps and keymap property.
7463 Note that menu-bar bindings in the local-map and keymap
7464 properties may not work reliable, as they are only
7465 recognized when the menu-bar (or mode-line) is updated,
7466 which does not normally happen after every command. */
7469 nminor
= current_minor_maps (NULL
, &tmaps
);
7470 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7472 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7473 maps
[nmaps
++] = tem
;
7474 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7476 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7478 maps
[nmaps
++] = current_global_map
;
7481 /* Look up in each map the dummy prefix key `menu-bar'. */
7483 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7484 if (!NILP (maps
[mapno
]))
7486 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7490 menu_bar_one_keymap_changed_items
= Qnil
;
7491 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7495 /* Move to the end those items that should be at the end. */
7497 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7500 int end
= menu_bar_items_index
;
7502 for (i
= 0; i
< end
; i
+= 4)
7503 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7505 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7506 /* Move the item at index I to the end,
7507 shifting all the others forward. */
7508 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7509 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7510 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7511 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7513 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7514 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7515 (end
- i
- 4) * sizeof (Lisp_Object
));
7516 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7517 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7518 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7519 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7524 /* Add nil, nil, nil, nil at the end. */
7526 int i
= menu_bar_items_index
;
7527 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7528 menu_bar_items_vector
=
7529 larger_vector (menu_bar_items_vector
, 4, -1);
7530 /* Add this item. */
7531 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7532 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7533 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7534 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7535 menu_bar_items_index
= i
;
7538 Vinhibit_quit
= oquit
;
7539 return menu_bar_items_vector
;
7542 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7543 If there's already an item for KEY, add this DEF to it. */
7545 Lisp_Object item_properties
;
7548 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7550 struct gcpro gcpro1
;
7554 if (EQ (item
, Qundefined
))
7556 /* If a map has an explicit `undefined' as definition,
7557 discard any previously made menu bar item. */
7559 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7560 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7562 if (menu_bar_items_index
> i
+ 4)
7563 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7564 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7565 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7566 menu_bar_items_index
-= 4;
7570 /* If this keymap has already contributed to this KEY,
7571 don't contribute to it a second time. */
7572 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7573 if (!NILP (tem
) || NILP (item
))
7576 menu_bar_one_keymap_changed_items
7577 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7579 /* We add to menu_bar_one_keymap_changed_items before doing the
7580 parse_menu_item, so that if it turns out it wasn't a menu item,
7581 it still correctly hides any further menu item. */
7583 i
= parse_menu_item (item
, 1);
7588 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7590 /* Find any existing item for this KEY. */
7591 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7592 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7595 /* If we did not find this KEY, add it at the end. */
7596 if (i
== menu_bar_items_index
)
7598 /* If vector is too small, get a bigger one. */
7599 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7600 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7601 /* Add this item. */
7602 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7603 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7604 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7605 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7606 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7607 menu_bar_items_index
= i
;
7609 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7613 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7614 /* If the new and the old items are not both keymaps,
7615 the lookup will only find `item'. */
7616 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7617 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7621 /* This is used as the handler when calling menu_item_eval_property. */
7623 menu_item_eval_property_1 (Lisp_Object arg
)
7625 /* If we got a quit from within the menu computation,
7626 quit all the way out of it. This takes care of C-] in the debugger. */
7627 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7628 Fsignal (Qquit
, Qnil
);
7634 eval_dyn (Lisp_Object form
)
7636 return Feval (form
, Qnil
);
7639 /* Evaluate an expression and return the result (or nil if something
7640 went wrong). Used to evaluate dynamic parts of menu items. */
7642 menu_item_eval_property (Lisp_Object sexpr
)
7644 ptrdiff_t count
= SPECPDL_INDEX ();
7646 specbind (Qinhibit_redisplay
, Qt
);
7647 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7648 menu_item_eval_property_1
);
7649 return unbind_to (count
, val
);
7652 /* This function parses a menu item and leaves the result in the
7653 vector item_properties.
7654 ITEM is a key binding, a possible menu item.
7655 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7657 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7658 parse_menu_item returns true if the item is a menu item and false
7662 parse_menu_item (Lisp_Object item
, int inmenubar
)
7664 Lisp_Object def
, tem
, item_string
, start
;
7666 Lisp_Object keyhint
;
7675 /* Create item_properties vector if necessary. */
7676 if (NILP (item_properties
))
7678 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7680 /* Initialize optional entries. */
7681 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7682 ASET (item_properties
, i
, Qnil
);
7683 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7685 /* Save the item here to protect it from GC. */
7686 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7688 item_string
= XCAR (item
);
7692 if (STRINGP (item_string
))
7694 /* Old format menu item. */
7695 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7697 /* Maybe help string. */
7698 if (CONSP (item
) && STRINGP (XCAR (item
)))
7700 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7705 /* Maybe an obsolete key binding cache. */
7706 if (CONSP (item
) && CONSP (XCAR (item
))
7707 && (NILP (XCAR (XCAR (item
)))
7708 || VECTORP (XCAR (XCAR (item
)))))
7711 /* This is the real definition--the function to run. */
7712 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7714 /* Get enable property, if any. */
7717 tem
= Fget (item
, Qmenu_enable
);
7718 if (!NILP (Venable_disabled_menus_and_buttons
))
7719 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7720 else if (!NILP (tem
))
7721 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7724 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7726 /* New format menu item. */
7727 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7728 start
= XCDR (item
);
7731 /* We have a real binding. */
7732 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7734 item
= XCDR (start
);
7735 /* Is there an obsolete cache list with key equivalences. */
7736 if (CONSP (item
) && CONSP (XCAR (item
)))
7739 /* Parse properties. */
7740 while (CONSP (item
) && CONSP (XCDR (item
)))
7745 if (EQ (tem
, QCenable
))
7747 if (!NILP (Venable_disabled_menus_and_buttons
))
7748 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7750 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7752 else if (EQ (tem
, QCvisible
))
7754 /* If got a visible property and that evaluates to nil
7755 then ignore this item. */
7756 tem
= menu_item_eval_property (XCAR (item
));
7760 else if (EQ (tem
, QChelp
))
7761 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7762 else if (EQ (tem
, QCfilter
))
7764 else if (EQ (tem
, QCkey_sequence
))
7767 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7768 /* Be GC protected. Set keyhint to item instead of tem. */
7771 else if (EQ (tem
, QCkeys
))
7774 if (CONSP (tem
) || STRINGP (tem
))
7775 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7777 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7782 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7784 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7786 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7792 else if (inmenubar
|| !NILP (start
))
7796 return 0; /* not a menu item */
7798 /* If item string is not a string, evaluate it to get string.
7799 If we don't get a string, skip this item. */
7800 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7801 if (!(STRINGP (item_string
)))
7803 item_string
= menu_item_eval_property (item_string
);
7804 if (!STRINGP (item_string
))
7806 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7809 /* If got a filter apply it on definition. */
7810 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7813 def
= menu_item_eval_property (list2 (XCAR (filter
),
7814 list2 (Qquote
, def
)));
7816 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7819 /* Enable or disable selection of item. */
7820 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7823 tem
= menu_item_eval_property (tem
);
7824 if (inmenubar
&& NILP (tem
))
7825 return 0; /* Ignore disabled items in menu bar. */
7826 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7829 /* If we got no definition, this item is just unselectable text which
7830 is OK in a submenu but not in the menubar. */
7832 return (!inmenubar
);
7834 /* See if this is a separate pane or a submenu. */
7835 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7836 tem
= get_keymap (def
, 0, 1);
7837 /* For a subkeymap, just record its details and exit. */
7840 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7841 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7845 /* At the top level in the menu bar, do likewise for commands also.
7846 The menu bar does not display equivalent key bindings anyway.
7847 ITEM_PROPERTY_DEF is already set up properly. */
7851 { /* This is a command. See if there is an equivalent key binding. */
7852 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7854 /* The previous code preferred :key-sequence to :keys, so we
7855 preserve this behavior. */
7856 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7857 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7860 Lisp_Object prefix
= keyeq
;
7861 Lisp_Object keys
= Qnil
;
7865 def
= XCAR (prefix
);
7866 prefix
= XCDR (prefix
);
7869 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7871 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7873 keys
= XCAR (keyhint
);
7874 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7876 /* We have a suggested key. Is it bound to the command? */
7879 /* If the command is an alias for another
7880 (such as lmenu.el set it up), check if the
7881 original command matches the cached command. */
7882 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7887 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7891 tem
= Fkey_description (keys
, Qnil
);
7894 if (STRINGP (XCAR (prefix
)))
7895 tem
= concat2 (XCAR (prefix
), tem
);
7896 if (STRINGP (XCDR (prefix
)))
7897 tem
= concat2 (tem
, XCDR (prefix
));
7899 keyeq
= concat2 (build_string (" "), tem
);
7900 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7906 /* If we have an equivalent key binding, use that. */
7907 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7910 /* Include this when menu help is implemented.
7911 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7912 if (!(NILP (tem) || STRINGP (tem)))
7914 tem = menu_item_eval_property (tem);
7917 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7921 /* Handle radio buttons or toggle boxes. */
7922 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7924 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7925 menu_item_eval_property (tem
));
7932 /***********************************************************************
7934 ***********************************************************************/
7936 /* A vector holding tool bar items while they are parsed in function
7937 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7940 static Lisp_Object tool_bar_items_vector
;
7942 /* A vector holding the result of parse_tool_bar_item. Layout is like
7943 the one for a single item in tool_bar_items_vector. */
7945 static Lisp_Object tool_bar_item_properties
;
7947 /* Next free index in tool_bar_items_vector. */
7949 static int ntool_bar_items
;
7951 /* The symbols `:image' and `:rtl'. */
7953 static Lisp_Object QCimage
;
7954 static Lisp_Object QCrtl
;
7956 /* Function prototypes. */
7958 static void init_tool_bar_items (Lisp_Object
);
7959 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7960 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7961 static void append_tool_bar_item (void);
7964 /* Return a vector of tool bar items for keymaps currently in effect.
7965 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7966 tool bar items found. */
7969 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7978 /* In order to build the menus, we need to call the keymap
7979 accessors. They all call QUIT. But this function is called
7980 during redisplay, during which a quit is fatal. So inhibit
7981 quitting while building the menus. We do this instead of
7982 specbind because (1) errors will clear it anyway and (2) this
7983 avoids risk of specpdl overflow. */
7984 oquit
= Vinhibit_quit
;
7987 /* Initialize tool_bar_items_vector and protect it from GC. */
7988 init_tool_bar_items (reuse
);
7990 /* Build list of keymaps in maps. Set nmaps to the number of maps
7993 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7994 if (!NILP (Voverriding_local_map_menu_flag
))
7996 /* Yes, use them (if non-nil) as well as the global map. */
7997 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7999 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8000 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8001 if (!NILP (Voverriding_local_map
))
8002 maps
[nmaps
++] = Voverriding_local_map
;
8006 /* No, so use major and minor mode keymaps and keymap property.
8007 Note that tool-bar bindings in the local-map and keymap
8008 properties may not work reliable, as they are only
8009 recognized when the tool-bar (or mode-line) is updated,
8010 which does not normally happen after every command. */
8013 nminor
= current_minor_maps (NULL
, &tmaps
);
8014 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8016 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8017 maps
[nmaps
++] = tem
;
8018 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8020 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8023 /* Add global keymap at the end. */
8024 maps
[nmaps
++] = current_global_map
;
8026 /* Process maps in reverse order and look up in each map the prefix
8028 for (i
= nmaps
- 1; i
>= 0; --i
)
8029 if (!NILP (maps
[i
]))
8033 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8035 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8038 Vinhibit_quit
= oquit
;
8039 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8040 return tool_bar_items_vector
;
8044 /* Process the definition of KEY which is DEF. */
8047 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8050 struct gcpro gcpro1
, gcpro2
;
8052 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8056 if (EQ (def
, Qundefined
))
8058 /* If a map has an explicit `undefined' as definition,
8059 discard any previously made item. */
8060 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8062 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8064 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8066 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8067 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8068 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8069 * sizeof (Lisp_Object
)));
8070 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8075 else if (parse_tool_bar_item (key
, def
))
8076 /* Append a new tool bar item to tool_bar_items_vector. Accept
8077 more than one definition for the same key. */
8078 append_tool_bar_item ();
8084 /* Parse a tool bar item specification ITEM for key KEY and return the
8085 result in tool_bar_item_properties. Value is zero if ITEM is
8088 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8090 CAPTION is the caption of the item, If it's not a string, it is
8091 evaluated to get a string.
8093 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8094 as binding are currently ignored.
8096 The following properties are recognized:
8100 FORM is evaluated and specifies whether the tool bar item is
8101 enabled or disabled.
8105 FORM is evaluated and specifies whether the tool bar item is visible.
8107 - `:filter FUNCTION'
8109 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8110 result is stored as the new binding.
8112 - `:button (TYPE SELECTED)'
8114 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8115 and specifies whether the button is selected (pressed) or not.
8119 IMAGES is either a single image specification or a vector of four
8120 image specifications. See enum tool_bar_item_images.
8122 - `:help HELP-STRING'.
8124 Gives a help string to display for the tool bar item.
8126 - `:label LABEL-STRING'.
8128 A text label to show with the tool bar button if labels are enabled. */
8131 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8133 /* Access slot with index IDX of vector tool_bar_item_properties. */
8134 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8136 Lisp_Object filter
= Qnil
;
8137 Lisp_Object caption
;
8138 int i
, have_label
= 0;
8140 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8141 Rule out items that aren't lists, don't start with
8142 `menu-item' or whose rest following `tool-bar-item' is not a
8147 /* As an exception, allow old-style menu separators. */
8148 if (STRINGP (XCAR (item
)))
8149 item
= Fcons (XCAR (item
), Qnil
);
8150 else if (!EQ (XCAR (item
), Qmenu_item
)
8151 || (item
= XCDR (item
), !CONSP (item
)))
8154 /* Create tool_bar_item_properties vector if necessary. Reset it to
8156 if (VECTORP (tool_bar_item_properties
))
8158 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8162 tool_bar_item_properties
8163 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8166 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8167 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8169 /* Get the caption of the item. If the caption is not a string,
8170 evaluate it to get a string. If we don't get a string, skip this
8172 caption
= XCAR (item
);
8173 if (!STRINGP (caption
))
8175 caption
= menu_item_eval_property (caption
);
8176 if (!STRINGP (caption
))
8179 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8181 /* If the rest following the caption is not a list, the menu item is
8182 either a separator, or invalid. */
8186 if (menu_separator_name_p (SSDATA (caption
)))
8188 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8189 #if !defined (USE_GTK) && !defined (HAVE_NS)
8190 /* If we use build_desired_tool_bar_string to render the
8191 tool bar, the separator is rendered as an image. */
8192 PROP (TOOL_BAR_ITEM_IMAGES
)
8193 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8194 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8195 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8196 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8203 /* Store the binding. */
8204 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8207 /* Ignore cached key binding, if any. */
8208 if (CONSP (item
) && CONSP (XCAR (item
)))
8211 /* Process the rest of the properties. */
8212 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8214 Lisp_Object ikey
, value
;
8217 value
= XCAR (XCDR (item
));
8219 if (EQ (ikey
, QCenable
))
8221 /* `:enable FORM'. */
8222 if (!NILP (Venable_disabled_menus_and_buttons
))
8223 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8225 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8227 else if (EQ (ikey
, QCvisible
))
8229 /* `:visible FORM'. If got a visible property and that
8230 evaluates to nil then ignore this item. */
8231 if (NILP (menu_item_eval_property (value
)))
8234 else if (EQ (ikey
, QChelp
))
8235 /* `:help HELP-STRING'. */
8236 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8237 else if (EQ (ikey
, QCvert_only
))
8238 /* `:vert-only t/nil'. */
8239 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8240 else if (EQ (ikey
, QClabel
))
8242 const char *bad_label
= "!!?GARBLED ITEM?!!";
8243 /* `:label LABEL-STRING'. */
8244 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8246 : build_string (bad_label
);
8249 else if (EQ (ikey
, QCfilter
))
8250 /* ':filter FORM'. */
8252 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8254 /* `:button (TYPE . SELECTED)'. */
8255 Lisp_Object type
, selected
;
8257 type
= XCAR (value
);
8258 selected
= XCDR (value
);
8259 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8261 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8262 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8265 else if (EQ (ikey
, QCimage
)
8267 || (VECTORP (value
) && ASIZE (value
) == 4)))
8268 /* Value is either a single image specification or a vector
8269 of 4 such specifications for the different button states. */
8270 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8271 else if (EQ (ikey
, QCrtl
))
8273 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8279 /* Try to make one from caption and key. */
8280 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8281 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8282 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8283 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8285 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8286 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8287 Lisp_Object new_lbl
;
8288 ptrdiff_t caption_len
= strlen (capt
);
8290 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8293 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8295 buf
[caption_len
] = '\0';
8299 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8303 strcpy (buf
, label
);
8305 for (j
= 0; buf
[j
] != '\0'; ++j
)
8313 new_lbl
= Fupcase_initials (build_string (label
));
8314 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8315 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8317 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8321 /* If got a filter apply it on binding. */
8323 PROP (TOOL_BAR_ITEM_BINDING
)
8324 = menu_item_eval_property (list2 (filter
,
8326 PROP (TOOL_BAR_ITEM_BINDING
))));
8328 /* See if the binding is a keymap. Give up if it is. */
8329 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8332 /* Enable or disable selection of item. */
8333 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8334 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8335 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8337 /* Handle radio buttons or toggle boxes. */
8338 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8339 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8340 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8348 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8349 that can be reused. */
8352 init_tool_bar_items (Lisp_Object reuse
)
8354 if (VECTORP (reuse
))
8355 tool_bar_items_vector
= reuse
;
8357 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8358 ntool_bar_items
= 0;
8362 /* Append parsed tool bar item properties from
8363 tool_bar_item_properties */
8366 append_tool_bar_item (void)
8368 Lisp_Object
*to
, *from
;
8371 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8373 /* Enlarge tool_bar_items_vector if necessary. */
8375 tool_bar_items_vector
8376 = larger_vector (tool_bar_items_vector
, incr
, -1);
8378 /* Append entries from tool_bar_item_properties to the end of
8379 tool_bar_items_vector. */
8380 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8381 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8382 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8383 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8390 /* Read a character using menus based on maps in the array MAPS.
8391 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8392 Return t if we displayed a menu but the user rejected it.
8394 PREV_EVENT is the previous input event, or nil if we are reading
8395 the first event of a key sequence.
8397 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8398 if we used a mouse menu to read the input, or zero otherwise. If
8399 USED_MOUSE_MENU is null, we don't dereference it.
8401 The prompting is done based on the prompt-string of the map
8402 and the strings associated with various map elements.
8404 This can be done with X menus or with menus put in the minibuf.
8405 These are done in different ways, depending on how the input will be read.
8406 Menus using X are done after auto-saving in read-char, getting the input
8407 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8408 and do auto-saving in the inner call of read_char. */
8411 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8412 Lisp_Object prev_event
, int *used_mouse_menu
)
8416 if (used_mouse_menu
)
8417 *used_mouse_menu
= 0;
8419 /* Use local over global Menu maps */
8421 if (! menu_prompting
)
8424 /* Optionally disregard all but the global map. */
8425 if (inhibit_local_menu_bar_menus
)
8427 maps
+= (nmaps
- 1);
8432 /* If we got to this point via a mouse click,
8433 use a real menu for mouse selection. */
8434 if (EVENT_HAS_PARAMETERS (prev_event
)
8435 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8436 && !EQ (XCAR (prev_event
), Qtool_bar
))
8438 /* Display the menu and get the selection. */
8439 Lisp_Object
*realmaps
8440 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8442 ptrdiff_t nmaps1
= 0;
8444 /* Use the maps that are not nil. */
8445 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8446 if (!NILP (maps
[mapno
]))
8447 realmaps
[nmaps1
++] = maps
[mapno
];
8449 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8454 record_menu_key (XCAR (value
));
8456 /* If we got multiple events, unread all but
8458 There is no way to prevent those unread events
8459 from showing up later in last_nonmenu_event.
8460 So turn symbol and integer events into lists,
8461 to indicate that they came from a mouse menu,
8462 so that when present in last_nonmenu_event
8463 they won't confuse things. */
8464 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8466 record_menu_key (XCAR (tem
));
8467 if (SYMBOLP (XCAR (tem
))
8468 || INTEGERP (XCAR (tem
)))
8469 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8472 /* If we got more than one event, put all but the first
8473 onto this list to be read later.
8474 Return just the first event now. */
8475 Vunread_command_events
8476 = nconc2 (XCDR (value
), Vunread_command_events
);
8477 value
= XCAR (value
);
8479 else if (NILP (value
))
8481 if (used_mouse_menu
)
8482 *used_mouse_menu
= 1;
8485 #endif /* HAVE_MENUS */
8489 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8490 We make this bigger when necessary, and never free it. */
8491 static char *read_char_minibuf_menu_text
;
8492 /* Size of that buffer. */
8493 static ptrdiff_t read_char_minibuf_menu_width
;
8496 read_char_minibuf_menu_prompt (int commandflag
,
8497 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8500 register Lisp_Object name
;
8502 /* FIXME: Use the minibuffer's frame width. */
8503 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8506 Lisp_Object rest
, vector
;
8512 if (! menu_prompting
)
8515 /* Get the menu name from the first map that has one (a prompt string). */
8516 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8518 name
= Fkeymap_prompt (maps
[mapno
]);
8523 /* If we don't have any menus, just read a character normally. */
8524 if (!STRINGP (name
))
8527 /* Make sure we have a big enough buffer for the menu text. */
8528 width
= max (width
, SBYTES (name
));
8529 if (STRING_BYTES_BOUND
- 4 < width
)
8530 memory_full (SIZE_MAX
);
8531 if (width
+ 4 > read_char_minibuf_menu_width
)
8533 read_char_minibuf_menu_text
8534 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8535 read_char_minibuf_menu_width
= width
+ 4;
8537 menu
= read_char_minibuf_menu_text
;
8539 /* Prompt string always starts with map's prompt, and a space. */
8540 strcpy (menu
, SSDATA (name
));
8541 nlength
= SBYTES (name
);
8542 menu
[nlength
++] = ':';
8543 menu
[nlength
++] = ' ';
8546 /* Start prompting at start of first map. */
8550 /* Present the documented bindings, a line at a time. */
8554 ptrdiff_t i
= nlength
;
8556 Lisp_Object orig_defn_macro
;
8558 /* Loop over elements of map. */
8563 /* If reached end of map, start at beginning of next map. */
8567 /* At end of last map, wrap around to first map if just starting,
8568 or end this line if already have something on it. */
8572 if (notfirst
|| nobindings
) break;
8577 /* Look at the next element of the map. */
8579 elt
= XVECTOR (vector
)->contents
[idx
];
8581 elt
= Fcar_safe (rest
);
8583 if (idx
< 0 && VECTORP (elt
))
8585 /* If we found a dense table in the keymap,
8586 advanced past it, but start scanning its contents. */
8587 rest
= Fcdr_safe (rest
);
8593 /* An ordinary element. */
8594 Lisp_Object event
, tem
;
8598 event
= Fcar_safe (elt
); /* alist */
8599 elt
= Fcdr_safe (elt
);
8603 XSETINT (event
, idx
); /* vector */
8606 /* Ignore the element if it has no prompt string. */
8607 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8609 /* 1 if the char to type matches the string. */
8611 Lisp_Object upcased_event
, downcased_event
;
8612 Lisp_Object desc
= Qnil
;
8614 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8616 upcased_event
= Fupcase (event
);
8617 downcased_event
= Fdowncase (event
);
8618 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8619 || XINT (downcased_event
) == SREF (s
, 0));
8621 desc
= Fsingle_key_description (event
, Qnil
);
8623 #if 0 /* It is redundant to list the equivalent key bindings because
8624 the prefix is what the user has already typed. */
8626 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8628 /* Insert equivalent keybinding. */
8629 s
= concat2 (s
, tem
);
8632 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8633 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8635 /* Insert button prefix. */
8636 Lisp_Object selected
8637 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8638 if (EQ (tem
, QCradio
))
8639 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8641 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8642 s
= concat2 (tem
, s
);
8646 /* If we have room for the prompt string, add it to this line.
8647 If this is the first on the line, always add it. */
8648 if ((SCHARS (s
) + i
+ 2
8649 + (char_matches
? 0 : SCHARS (desc
) + 3))
8653 ptrdiff_t thiswidth
;
8655 /* Punctuate between strings. */
8658 strcpy (menu
+ i
, ", ");
8664 /* If the char to type doesn't match the string's
8665 first char, explicitly show what char to type. */
8668 /* Add as much of string as fits. */
8669 thiswidth
= min (SCHARS (desc
), width
- i
);
8670 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8672 strcpy (menu
+ i
, " = ");
8676 /* Add as much of string as fits. */
8677 thiswidth
= min (SCHARS (s
), width
- i
);
8678 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8684 /* If this element does not fit, end the line now,
8685 and save the element for the next line. */
8686 strcpy (menu
+ i
, "...");
8691 /* Move past this element. */
8692 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8693 /* Handle reaching end of dense table. */
8698 rest
= Fcdr_safe (rest
);
8702 /* Prompt with that and read response. */
8703 message2_nolog (menu
, strlen (menu
),
8704 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8706 /* Make believe its not a keyboard macro in case the help char
8707 is pressed. Help characters are not recorded because menu prompting
8708 is not used on replay.
8710 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8711 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8713 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8714 while (BUFFERP (obj
));
8715 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8717 if (!INTEGERP (obj
))
8719 else if (XINT (obj
) == -2)
8722 if (! EQ (obj
, menu_prompt_more_char
)
8723 && (!INTEGERP (menu_prompt_more_char
)
8724 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8726 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8727 store_kbd_macro_char (obj
);
8730 /* Help char - go round again */
8734 /* Reading key sequences. */
8736 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8737 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8738 keymap, or nil otherwise. Return the index of the first keymap in
8739 which KEY has any binding, or NMAPS if no map has a binding.
8741 If KEY is a meta ASCII character, treat it like meta-prefix-char
8742 followed by the corresponding non-meta character. Keymaps in
8743 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8746 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8749 NEXT may be the same array as CURRENT. */
8752 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8753 Lisp_Object
*defs
, Lisp_Object
*next
)
8755 ptrdiff_t i
, first_binding
;
8757 first_binding
= nmaps
;
8758 for (i
= nmaps
- 1; i
>= 0; i
--)
8760 if (! NILP (current
[i
]))
8762 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8763 if (! NILP (defs
[i
]))
8770 /* Given the set of bindings we've found, produce the next set of maps. */
8771 if (first_binding
< nmaps
)
8772 for (i
= 0; i
< nmaps
; i
++)
8773 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8775 return first_binding
;
8778 /* Structure used to keep track of partial application of key remapping
8779 such as Vfunction_key_map and Vkey_translation_map. */
8780 typedef struct keyremap
8782 /* This is the map originally specified for this use. */
8784 /* This is a submap reached by looking up, in PARENT,
8785 the events from START to END. */
8787 /* Positions [START, END) in the key sequence buffer
8788 are the key that we have scanned so far.
8789 Those events are the ones that we will replace
8790 if PAREHT maps them into a key sequence. */
8794 /* Lookup KEY in MAP.
8795 MAP is a keymap mapping keys to key vectors or functions.
8796 If the mapping is a function and DO_FUNCTION is non-zero, then
8797 the function is called with PROMPT as parameter and its return
8798 value is used as the return value of this function (after checking
8799 that it is indeed a vector). */
8802 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8807 next
= access_keymap (map
, key
, 1, 0, 1);
8809 /* Handle symbol with autoload definition. */
8810 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8811 && CONSP (XSYMBOL (next
)->function
)
8812 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8813 do_autoload (XSYMBOL (next
)->function
, next
);
8815 /* Handle a symbol whose function definition is a keymap
8817 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8818 && (ARRAYP (XSYMBOL (next
)->function
)
8819 || KEYMAPP (XSYMBOL (next
)->function
)))
8820 next
= XSYMBOL (next
)->function
;
8822 /* If the keymap gives a function, not an
8823 array, then call the function with one arg and use
8824 its value instead. */
8825 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8830 next
= call1 (next
, prompt
);
8831 /* If the function returned something invalid,
8832 barf--don't ignore it.
8833 (To ignore it safely, we would need to gcpro a bunch of
8834 other variables.) */
8835 if (! (VECTORP (next
) || STRINGP (next
)))
8836 error ("Function %s returns invalid key sequence",
8837 SSDATA (SYMBOL_NAME (tem
)));
8842 /* Do one step of the key remapping used for function-key-map and
8843 key-translation-map:
8844 KEYBUF is the buffer holding the input events.
8845 BUFSIZE is its maximum size.
8846 FKEY is a pointer to the keyremap structure to use.
8847 INPUT is the index of the last element in KEYBUF.
8848 DOIT if non-zero says that the remapping can actually take place.
8849 DIFF is used to return the number of keys added/removed by the remapping.
8850 PARENT is the root of the keymap.
8851 PROMPT is the prompt to use if the remapping happens through a function.
8852 The return value is non-zero if the remapping actually took place. */
8855 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8856 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8858 Lisp_Object next
, key
;
8860 key
= keybuf
[fkey
->end
++];
8862 if (KEYMAPP (fkey
->parent
))
8863 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8867 /* If keybuf[fkey->start..fkey->end] is bound in the
8868 map and we're in a position to do the key remapping, replace it with
8869 the binding and restart with fkey->start at the end. */
8870 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8872 int len
= XFASTINT (Flength (next
));
8875 *diff
= len
- (fkey
->end
- fkey
->start
);
8877 if (bufsize
- input
<= *diff
)
8878 error ("Key sequence too long");
8880 /* Shift the keys that follow fkey->end. */
8882 for (i
= fkey
->end
; i
< input
; i
++)
8883 keybuf
[i
+ *diff
] = keybuf
[i
];
8885 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8886 keybuf
[i
+ *diff
] = keybuf
[i
];
8887 /* Overwrite the old keys with the new ones. */
8888 for (i
= 0; i
< len
; i
++)
8889 keybuf
[fkey
->start
+ i
]
8890 = Faref (next
, make_number (i
));
8892 fkey
->start
= fkey
->end
+= *diff
;
8893 fkey
->map
= fkey
->parent
;
8898 fkey
->map
= get_keymap (next
, 0, 1);
8900 /* If we no longer have a bound suffix, try a new position for
8902 if (!CONSP (fkey
->map
))
8904 fkey
->end
= ++fkey
->start
;
8905 fkey
->map
= fkey
->parent
;
8911 test_undefined (Lisp_Object binding
)
8913 return (EQ (binding
, Qundefined
)
8914 || (!NILP (binding
) && SYMBOLP (binding
)
8915 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8918 /* Read a sequence of keys that ends with a non prefix character,
8919 storing it in KEYBUF, a buffer of size BUFSIZE.
8921 Return the length of the key sequence stored.
8922 Return -1 if the user rejected a command menu.
8924 Echo starting immediately unless `prompt' is 0.
8926 Where a key sequence ends depends on the currently active keymaps.
8927 These include any minor mode keymaps active in the current buffer,
8928 the current buffer's local map, and the global map.
8930 If a key sequence has no other bindings, we check Vfunction_key_map
8931 to see if some trailing subsequence might be the beginning of a
8932 function key's sequence. If so, we try to read the whole function
8933 key, and substitute its symbolic name into the key sequence.
8935 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8936 `double-' events into similar click events, if that would make them
8937 bound. We try to turn `triple-' events first into `double-' events,
8940 If we get a mouse click in a mode line, vertical divider, or other
8941 non-text area, we treat the click as if it were prefixed by the
8942 symbol denoting that area - `mode-line', `vertical-line', or
8945 If the sequence starts with a mouse click, we read the key sequence
8946 with respect to the buffer clicked on, not the current buffer.
8948 If the user switches frames in the midst of a key sequence, we put
8949 off the switch-frame event until later; the next call to
8950 read_char will return it.
8952 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8953 from the selected window's buffer. */
8956 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8957 int dont_downcase_last
, int can_return_switch_frame
,
8958 int fix_current_buffer
)
8960 Lisp_Object from_string
;
8961 ptrdiff_t count
= SPECPDL_INDEX ();
8963 /* How many keys there are in the current key sequence. */
8966 /* The length of the echo buffer when we started reading, and
8967 the length of this_command_keys when we started reading. */
8968 ptrdiff_t echo_start
IF_LINT (= 0);
8969 ptrdiff_t keys_start
;
8971 /* The number of keymaps we're scanning right now, and the number of
8972 keymaps we have allocated space for. */
8974 ptrdiff_t nmaps_allocated
= 0;
8976 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8977 the current keymaps. */
8978 Lisp_Object
*defs
= NULL
;
8980 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8981 in the current keymaps, or nil where it is not a prefix. */
8982 Lisp_Object
*submaps
= NULL
;
8984 /* The local map to start out with at start of key sequence. */
8985 Lisp_Object orig_local_map
;
8987 /* The map from the `keymap' property to start out with at start of
8989 Lisp_Object orig_keymap
;
8991 /* 1 if we have already considered switching to the local-map property
8992 of the place where a mouse click occurred. */
8993 int localized_local_map
= 0;
8995 /* The index in submaps[] of the first keymap that has a binding for
8996 this key sequence. In other words, the lowest i such that
8997 submaps[i] is non-nil. */
8998 ptrdiff_t first_binding
;
8999 /* Index of the first key that has no binding.
9000 It is useless to try fkey.start larger than that. */
9003 /* If t < mock_input, then KEYBUF[t] should be read as the next
9006 We use this to recover after recognizing a function key. Once we
9007 realize that a suffix of the current key sequence is actually a
9008 function key's escape sequence, we replace the suffix with the
9009 function key's binding from Vfunction_key_map. Now keybuf
9010 contains a new and different key sequence, so the echo area,
9011 this_command_keys, and the submaps and defs arrays are wrong. In
9012 this situation, we set mock_input to t, set t to 0, and jump to
9013 restart_sequence; the loop will read keys from keybuf up until
9014 mock_input, thus rebuilding the state; and then it will resume
9015 reading characters from the keyboard. */
9018 /* If the sequence is unbound in submaps[], then
9019 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9020 and fkey.map is its binding.
9022 These might be > t, indicating that all function key scanning
9023 should hold off until t reaches them. We do this when we've just
9024 recognized a function key, to avoid searching for the function
9025 key's again in Vfunction_key_map. */
9028 /* Likewise, for key_translation_map and input-decode-map. */
9029 keyremap keytran
, indec
;
9031 /* Non-zero if we are trying to map a key by changing an upper-case
9032 letter to lower case, or a shifted function key to an unshifted
9034 int shift_translated
= 0;
9036 /* If we receive a `switch-frame' or `select-window' event in the middle of
9037 a key sequence, we put it off for later.
9038 While we're reading, we keep the event here. */
9039 Lisp_Object delayed_switch_frame
;
9041 /* See the comment below... */
9042 #if defined (GOBBLE_FIRST_EVENT)
9043 Lisp_Object first_event
;
9046 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9047 int original_uppercase_position
= -1;
9049 /* Gets around Microsoft compiler limitations. */
9052 struct buffer
*starting_buffer
;
9054 /* List of events for which a fake prefix key has been generated. */
9055 Lisp_Object fake_prefixed_keys
= Qnil
;
9057 #if defined (GOBBLE_FIRST_EVENT)
9061 struct gcpro outer_gcpro1
;
9063 GCPRO1_VAR (fake_prefixed_keys
, outer_gcpro
);
9064 raw_keybuf_count
= 0;
9066 last_nonmenu_event
= Qnil
;
9068 delayed_switch_frame
= Qnil
;
9074 /* Install the string STR as the beginning of the string of
9075 echoing, so that it serves as a prompt for the next
9077 KVAR (current_kboard
, echo_string
) = prompt
;
9078 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9081 else if (cursor_in_echo_area
9082 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9083 && NILP (Fzerop (Vecho_keystrokes
)))
9084 /* This doesn't put in a dash if the echo buffer is empty, so
9085 you don't always see a dash hanging out in the minibuffer. */
9089 /* Record the initial state of the echo area and this_command_keys;
9090 we will need to restore them if we replay a key sequence. */
9092 echo_start
= echo_length ();
9093 keys_start
= this_command_key_count
;
9094 this_single_command_key_start
= keys_start
;
9096 #if defined (GOBBLE_FIRST_EVENT)
9097 /* This doesn't quite work, because some of the things that read_char
9098 does cannot safely be bypassed. It seems too risky to try to make
9101 /* Read the first char of the sequence specially, before setting
9102 up any keymaps, in case a filter runs and switches buffers on us. */
9103 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9105 #endif /* GOBBLE_FIRST_EVENT */
9107 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9108 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9111 /* We jump here when we need to reinitialize fkey and keytran; this
9112 happens if we switch keyboards between rescans. */
9113 replay_entire_sequence
:
9115 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9116 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9117 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9118 indec
.start
= indec
.end
= 0;
9119 fkey
.start
= fkey
.end
= 0;
9120 keytran
.start
= keytran
.end
= 0;
9122 /* We jump here when the key sequence has been thoroughly changed, and
9123 we need to rescan it starting from the beginning. When we jump here,
9124 keybuf[0..mock_input] holds the sequence we should reread. */
9127 starting_buffer
= current_buffer
;
9128 first_unbound
= bufsize
+ 1;
9130 /* Build our list of keymaps.
9131 If we recognize a function key and replace its escape sequence in
9132 keybuf with its symbol, or if the sequence starts with a mouse
9133 click and we need to switch buffers, we jump back here to rebuild
9134 the initial keymaps from the current buffer. */
9137 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9139 if (2 > nmaps_allocated
)
9141 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9142 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9143 nmaps_allocated
= 2;
9145 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9147 else if (!NILP (Voverriding_local_map
))
9149 if (2 > nmaps_allocated
)
9151 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9152 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9153 nmaps_allocated
= 2;
9155 submaps
[nmaps
++] = Voverriding_local_map
;
9163 nminor
= current_minor_maps (0, &maps
);
9164 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9166 if (total
> nmaps_allocated
)
9168 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9169 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9170 nmaps_allocated
= total
;
9173 if (!NILP (orig_keymap
))
9174 submaps
[nmaps
++] = orig_keymap
;
9176 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9180 submaps
[nmaps
++] = orig_local_map
;
9182 submaps
[nmaps
++] = current_global_map
;
9184 /* Find an accurate initial value for first_binding. */
9185 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9186 if (! NILP (submaps
[first_binding
]))
9189 /* Start from the beginning in keybuf. */
9192 /* These are no-ops the first time through, but if we restart, they
9193 revert the echo area and this_command_keys to their original state. */
9194 this_command_key_count
= keys_start
;
9195 if (INTERACTIVE
&& t
< mock_input
)
9196 echo_truncate (echo_start
);
9198 /* If the best binding for the current key sequence is a keymap, or
9199 we may be looking at a function key's escape sequence, keep on
9201 while (first_binding
< nmaps
9202 /* Keep reading as long as there's a prefix binding. */
9203 ? !NILP (submaps
[first_binding
])
9204 /* Don't return in the middle of a possible function key sequence,
9205 if the only bindings we found were via case conversion.
9206 Thus, if ESC O a has a function-key-map translation
9207 and ESC o has a binding, don't return after ESC O,
9208 so that we can translate ESC O plus the next character. */
9209 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9212 int used_mouse_menu
= 0;
9214 /* Where the last real key started. If we need to throw away a
9215 key that has expanded into more than one element of keybuf
9216 (say, a mouse click on the mode line which is being treated
9217 as [mode-line (mouse-...)], then we backtrack to this point
9219 int last_real_key_start
;
9221 /* These variables are analogous to echo_start and keys_start;
9222 while those allow us to restart the entire key sequence,
9223 echo_local_start and keys_local_start allow us to throw away
9225 ptrdiff_t echo_local_start
IF_LINT (= 0);
9226 int keys_local_start
;
9227 ptrdiff_t local_first_binding
;
9229 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9230 eassert (indec
.start
<= indec
.end
);
9231 eassert (fkey
.start
<= fkey
.end
);
9232 eassert (keytran
.start
<= keytran
.end
);
9233 /* key-translation-map is applied *after* function-key-map
9234 which is itself applied *after* input-decode-map. */
9235 eassert (fkey
.end
<= indec
.start
);
9236 eassert (keytran
.end
<= fkey
.start
);
9238 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9239 first_unbound
< keytran
.start
)
9240 { /* The prefix upto first_unbound has no binding and has
9241 no translation left to do either, so we know it's unbound.
9242 If we don't stop now, we risk staying here indefinitely
9243 (if the user keeps entering fkey or keytran prefixes
9244 like C-c ESC ESC ESC ESC ...) */
9246 for (i
= first_unbound
+ 1; i
< t
; i
++)
9247 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9248 mock_input
= t
- first_unbound
- 1;
9249 indec
.end
= indec
.start
-= first_unbound
+ 1;
9250 indec
.map
= indec
.parent
;
9251 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9252 fkey
.map
= fkey
.parent
;
9253 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9254 keytran
.map
= keytran
.parent
;
9255 goto replay_sequence
;
9259 error ("Key sequence too long");
9262 echo_local_start
= echo_length ();
9263 keys_local_start
= this_command_key_count
;
9264 local_first_binding
= first_binding
;
9267 /* These are no-ops, unless we throw away a keystroke below and
9268 jumped back up to replay_key; in that case, these restore the
9269 variables to their original state, allowing us to replay the
9271 if (INTERACTIVE
&& t
< mock_input
)
9272 echo_truncate (echo_local_start
);
9273 this_command_key_count
= keys_local_start
;
9274 first_binding
= local_first_binding
;
9276 /* By default, assume each event is "real". */
9277 last_real_key_start
= t
;
9279 /* Does mock_input indicate that we are re-reading a key sequence? */
9283 add_command_key (key
);
9284 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9285 && NILP (Fzerop (Vecho_keystrokes
)))
9289 /* If not, we should actually read a character. */
9293 KBOARD
*interrupted_kboard
= current_kboard
;
9294 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9295 key
= read_char (NILP (prompt
), nmaps
,
9296 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9297 &used_mouse_menu
, NULL
);
9298 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9299 /* When switching to a new tty (with a new keyboard),
9300 read_char returns the new buffer, rather than -2
9301 (Bug#5095). This is because `terminal-init-xterm'
9302 calls read-char, which eats the wrong_kboard_jmpbuf
9303 return. Any better way to fix this? -- cyd */
9304 || (interrupted_kboard
!= current_kboard
))
9309 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9310 if (k
== interrupted_kboard
)
9315 /* Don't touch interrupted_kboard when it's been
9317 delayed_switch_frame
= Qnil
;
9318 goto replay_entire_sequence
;
9321 if (!NILP (delayed_switch_frame
))
9323 KVAR (interrupted_kboard
, kbd_queue
)
9324 = Fcons (delayed_switch_frame
,
9325 KVAR (interrupted_kboard
, kbd_queue
));
9326 delayed_switch_frame
= Qnil
;
9330 KVAR (interrupted_kboard
, kbd_queue
)
9331 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9333 /* If the side queue is non-empty, ensure it begins with a
9334 switch-frame, so we'll replay it in the right context. */
9335 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9336 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9337 !(EVENT_HAS_PARAMETERS (key
)
9338 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9342 XSETFRAME (frame
, interrupted_frame
);
9343 KVAR (interrupted_kboard
, kbd_queue
)
9344 = Fcons (make_lispy_switch_frame (frame
),
9345 KVAR (interrupted_kboard
, kbd_queue
));
9348 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9349 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9350 goto replay_entire_sequence
;
9354 /* read_char returns t when it shows a menu and the user rejects it.
9358 unbind_to (count
, Qnil
);
9359 UNGCPRO_VAR (outer_gcpro
);
9363 /* read_char returns -1 at the end of a macro.
9364 Emacs 18 handles this by returning immediately with a
9365 zero, so that's what we'll do. */
9366 if (INTEGERP (key
) && XINT (key
) == -1)
9369 /* The Microsoft C compiler can't handle the goto that
9375 /* If the current buffer has been changed from under us, the
9376 keymap may have changed, so replay the sequence. */
9379 timer_resume_idle ();
9382 /* Reset the current buffer from the selected window
9383 in case something changed the former and not the latter.
9384 This is to be more consistent with the behavior
9385 of the command_loop_1. */
9386 if (fix_current_buffer
)
9388 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9390 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9391 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9394 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9395 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9396 goto replay_sequence
;
9399 /* If we have a quit that was typed in another frame, and
9400 quit_throw_to_read_char switched buffers,
9401 replay to get the right keymap. */
9403 && XINT (key
) == quit_char
9404 && current_buffer
!= starting_buffer
)
9407 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9411 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9412 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9413 goto replay_sequence
;
9418 if (EVENT_HAS_PARAMETERS (key
)
9419 /* Either a `switch-frame' or a `select-window' event. */
9420 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9422 /* If we're at the beginning of a key sequence, and the caller
9423 says it's okay, go ahead and return this event. If we're
9424 in the midst of a key sequence, delay it until the end. */
9425 if (t
> 0 || !can_return_switch_frame
)
9427 delayed_switch_frame
= key
;
9433 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9437 /* Clicks in non-text areas get prefixed by the symbol
9438 in their CHAR-ADDRESS field. For example, a click on
9439 the mode line is prefixed by the symbol `mode-line'.
9441 Furthermore, key sequences beginning with mouse clicks
9442 are read using the keymaps of the buffer clicked on, not
9443 the current buffer. So we may have to switch the buffer
9446 When we turn one event into two events, we must make sure
9447 that neither of the two looks like the original--so that,
9448 if we replay the events, they won't be expanded again.
9449 If not for this, such reexpansion could happen either here
9450 or when user programs play with this-command-keys. */
9451 if (EVENT_HAS_PARAMETERS (key
))
9456 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9457 if (EQ (kind
, Qmouse_click
))
9459 Lisp_Object window
, posn
;
9461 window
= POSN_WINDOW (EVENT_START (key
));
9462 posn
= POSN_POSN (EVENT_START (key
));
9465 || (!NILP (fake_prefixed_keys
)
9466 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9468 /* We're looking a second time at an event for which
9469 we generated a fake prefix key. Set
9470 last_real_key_start appropriately. */
9472 last_real_key_start
= t
- 1;
9475 if (last_real_key_start
== 0)
9477 /* Key sequences beginning with mouse clicks are
9478 read using the keymaps in the buffer clicked on,
9479 not the current buffer. If we're at the
9480 beginning of a key sequence, switch buffers. */
9481 if (WINDOWP (window
)
9482 && BUFFERP (XWINDOW (window
)->buffer
)
9483 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9485 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9489 /* Arrange to go back to the original buffer once we're
9490 done reading the key sequence. Note that we can't
9491 use save_excursion_{save,restore} here, because they
9492 save point as well as the current buffer; we don't
9493 want to save point, because redisplay may change it,
9494 to accommodate a Fset_window_start or something. We
9495 don't want to do this at the top of the function,
9496 because we may get input from a subprocess which
9497 wants to change the selected window and stuff (say,
9499 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9501 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9503 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9504 orig_local_map
= get_local_map (PT
, current_buffer
,
9506 orig_keymap
= get_local_map (PT
, current_buffer
,
9508 goto replay_sequence
;
9511 /* For a mouse click, get the local text-property keymap
9512 of the place clicked on, rather than point. */
9513 if (CONSP (XCDR (key
))
9514 && ! localized_local_map
)
9516 Lisp_Object map_here
, start
, pos
;
9518 localized_local_map
= 1;
9519 start
= EVENT_START (key
);
9521 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9523 pos
= POSN_BUFFER_POSN (start
);
9525 && XINT (pos
) >= BEGV
9526 && XINT (pos
) <= ZV
)
9528 map_here
= get_local_map (XINT (pos
),
9531 if (!EQ (map_here
, orig_local_map
))
9533 orig_local_map
= map_here
;
9534 ++localized_local_map
;
9537 map_here
= get_local_map (XINT (pos
),
9540 if (!EQ (map_here
, orig_keymap
))
9542 orig_keymap
= map_here
;
9543 ++localized_local_map
;
9546 if (localized_local_map
> 1)
9551 goto replay_sequence
;
9558 /* Expand mode-line and scroll-bar events into two events:
9559 use posn as a fake prefix key. */
9561 && (NILP (fake_prefixed_keys
)
9562 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9564 if (bufsize
- t
<= 1)
9565 error ("Key sequence too long");
9568 keybuf
[t
+ 1] = key
;
9571 /* Record that a fake prefix key has been generated
9572 for KEY. Don't modify the event; this would
9573 prevent proper action when the event is pushed
9574 back into unread-command-events. */
9575 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9577 /* If on a mode line string with a local keymap,
9578 reconsider the key sequence with that keymap. */
9579 if (string
= POSN_STRING (EVENT_START (key
)),
9580 (CONSP (string
) && STRINGP (XCAR (string
))))
9582 Lisp_Object pos
, map
, map2
;
9584 pos
= XCDR (string
);
9585 string
= XCAR (string
);
9587 && XINT (pos
) < SCHARS (string
))
9589 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9591 orig_local_map
= map
;
9592 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9595 if (!NILP (map
) || !NILP (map2
))
9596 goto replay_sequence
;
9602 else if (NILP (from_string
)
9603 && (string
= POSN_STRING (EVENT_START (key
)),
9604 (CONSP (string
) && STRINGP (XCAR (string
)))))
9606 /* For a click on a string, i.e. overlay string or a
9607 string displayed via the `display' property,
9608 consider `local-map' and `keymap' properties of
9610 Lisp_Object pos
, map
, map2
;
9612 pos
= XCDR (string
);
9613 string
= XCAR (string
);
9615 && XINT (pos
) < SCHARS (string
))
9617 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9619 orig_local_map
= map
;
9620 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9624 if (!NILP (map
) || !NILP (map2
))
9626 from_string
= string
;
9629 goto replay_sequence
;
9634 else if (CONSP (XCDR (key
))
9635 && CONSP (EVENT_START (key
))
9636 && CONSP (XCDR (EVENT_START (key
))))
9640 posn
= POSN_POSN (EVENT_START (key
));
9641 /* Handle menu-bar events:
9642 insert the dummy prefix event `menu-bar'. */
9643 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9645 if (bufsize
- t
<= 1)
9646 error ("Key sequence too long");
9650 /* Zap the position in key, so we know that we've
9651 expanded it, and don't try to do so again. */
9652 POSN_SET_POSN (EVENT_START (key
),
9653 Fcons (posn
, Qnil
));
9656 goto replay_sequence
;
9658 else if (CONSP (posn
))
9660 /* We're looking at the second event of a
9661 sequence which we expanded before. Set
9662 last_real_key_start appropriately. */
9663 if (last_real_key_start
== t
&& t
> 0)
9664 last_real_key_start
= t
- 1;
9669 /* We have finally decided that KEY is something we might want
9671 first_binding
= (follow_key (key
,
9672 nmaps
- first_binding
,
9673 submaps
+ first_binding
,
9674 defs
+ first_binding
,
9675 submaps
+ first_binding
)
9678 /* If KEY wasn't bound, we'll try some fallbacks. */
9679 if (first_binding
< nmaps
)
9680 /* This is needed for the following scenario:
9681 event 0: a down-event that gets dropped by calling replay_key.
9682 event 1: some normal prefix like C-h.
9683 After event 0, first_unbound is 0, after event 1 indec.start,
9684 fkey.start, and keytran.start are all 1, so when we see that
9685 C-h is bound, we need to update first_unbound. */
9686 first_unbound
= max (t
+ 1, first_unbound
);
9691 /* Remember the position to put an upper bound on indec.start. */
9692 first_unbound
= min (t
, first_unbound
);
9694 head
= EVENT_HEAD (key
);
9695 if (help_char_p (head
) && t
> 0)
9697 read_key_sequence_cmd
= Vprefix_help_command
;
9699 last_nonmenu_event
= key
;
9700 /* The Microsoft C compiler can't handle the goto that
9708 Lisp_Object breakdown
;
9711 breakdown
= parse_modifiers (head
);
9712 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9713 /* Attempt to reduce an unbound mouse event to a simpler
9714 event that is bound:
9715 Drags reduce to clicks.
9716 Double-clicks reduce to clicks.
9717 Triple-clicks reduce to double-clicks, then to clicks.
9718 Down-clicks are eliminated.
9719 Double-downs reduce to downs, then are eliminated.
9720 Triple-downs reduce to double-downs, then to downs,
9721 then are eliminated. */
9722 if (modifiers
& (down_modifier
| drag_modifier
9723 | double_modifier
| triple_modifier
))
9725 while (modifiers
& (down_modifier
| drag_modifier
9726 | double_modifier
| triple_modifier
))
9728 Lisp_Object new_head
, new_click
;
9729 if (modifiers
& triple_modifier
)
9730 modifiers
^= (double_modifier
| triple_modifier
);
9731 else if (modifiers
& double_modifier
)
9732 modifiers
&= ~double_modifier
;
9733 else if (modifiers
& drag_modifier
)
9734 modifiers
&= ~drag_modifier
;
9737 /* Dispose of this `down' event by simply jumping
9738 back to replay_key, to get another event.
9740 Note that if this event came from mock input,
9741 then just jumping back to replay_key will just
9742 hand it to us again. So we have to wipe out any
9745 We could delete keybuf[t] and shift everything
9746 after that to the left by one spot, but we'd also
9747 have to fix up any variable that points into
9748 keybuf, and shifting isn't really necessary
9751 Adding prefixes for non-textual mouse clicks
9752 creates two characters of mock input, and both
9753 must be thrown away. If we're only looking at
9754 the prefix now, we can just jump back to
9755 replay_key. On the other hand, if we've already
9756 processed the prefix, and now the actual click
9757 itself is giving us trouble, then we've lost the
9758 state of the keymaps we want to backtrack to, and
9759 we need to replay the whole sequence to rebuild
9762 Beyond that, only function key expansion could
9763 create more than two keys, but that should never
9764 generate mouse events, so it's okay to zero
9765 mock_input in that case too.
9767 FIXME: The above paragraph seems just plain
9768 wrong, if you consider things like
9769 xterm-mouse-mode. -stef
9771 Isn't this just the most wonderful code ever? */
9773 /* If mock_input > t + 1, the above simplification
9774 will actually end up dropping keys on the floor.
9775 This is probably OK for now, but even
9776 if mock_input <= t + 1, we need to adjust indec,
9778 Typical case [header-line down-mouse-N]:
9779 mock_input = 2, t = 1, fkey.end = 1,
9780 last_real_key_start = 0. */
9781 if (indec
.end
> last_real_key_start
)
9783 indec
.end
= indec
.start
9784 = min (last_real_key_start
, indec
.start
);
9785 indec
.map
= indec
.parent
;
9786 if (fkey
.end
> last_real_key_start
)
9788 fkey
.end
= fkey
.start
9789 = min (last_real_key_start
, fkey
.start
);
9790 fkey
.map
= fkey
.parent
;
9791 if (keytran
.end
> last_real_key_start
)
9793 keytran
.end
= keytran
.start
9794 = min (last_real_key_start
, keytran
.start
);
9795 keytran
.map
= keytran
.parent
;
9799 if (t
== last_real_key_start
)
9806 mock_input
= last_real_key_start
;
9807 goto replay_sequence
;
9812 = apply_modifiers (modifiers
, XCAR (breakdown
));
9814 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9816 /* Look for a binding for this new key. follow_key
9817 promises that it didn't munge submaps the
9818 last time we called it, since key was unbound. */
9820 = (follow_key (new_click
,
9821 nmaps
- local_first_binding
,
9822 submaps
+ local_first_binding
,
9823 defs
+ local_first_binding
,
9824 submaps
+ local_first_binding
)
9825 + local_first_binding
);
9827 /* If that click is bound, go for it. */
9828 if (first_binding
< nmaps
)
9833 /* Otherwise, we'll leave key set to the drag event. */
9840 /* Normally, last_nonmenu_event gets the previous key we read.
9841 But when a mouse popup menu is being used,
9842 we don't update last_nonmenu_event; it continues to hold the mouse
9843 event that preceded the first level of menu. */
9844 if (!used_mouse_menu
)
9845 last_nonmenu_event
= key
;
9847 /* Record what part of this_command_keys is the current key sequence. */
9848 this_single_command_key_start
= this_command_key_count
- t
;
9850 /* Look for this sequence in input-decode-map.
9851 Scan from indec.end until we find a bound suffix. */
9852 while (indec
.end
< t
)
9854 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9857 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9858 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9863 mock_input
= diff
+ max (t
, mock_input
);
9864 goto replay_sequence
;
9868 if (first_binding
< nmaps
9869 && NILP (submaps
[first_binding
])
9870 && !test_undefined (defs
[first_binding
])
9871 && indec
.start
>= t
)
9872 /* There is a binding and it's not a prefix.
9873 (and it doesn't have any input-decode-map translation pending).
9874 There is thus no function-key in this sequence.
9875 Moving fkey.start is important in this case to allow keytran.start
9876 to go over the sequence before we return (since we keep the
9877 invariant that keytran.end <= fkey.start). */
9880 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9883 /* If the sequence is unbound, see if we can hang a function key
9884 off the end of it. */
9885 /* Continue scan from fkey.end until we find a bound suffix. */
9886 while (fkey
.end
< indec
.start
)
9888 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9891 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9892 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9893 max (t
, mock_input
),
9894 /* If there's a binding (i.e.
9895 first_binding >= nmaps) we don't want
9896 to apply this function-key-mapping. */
9898 && (first_binding
>= nmaps
9899 || test_undefined (defs
[first_binding
])),
9904 mock_input
= diff
+ max (t
, mock_input
);
9905 /* Adjust the input-decode-map counters. */
9907 indec
.start
+= diff
;
9909 goto replay_sequence
;
9913 /* Look for this sequence in key-translation-map.
9914 Scan from keytran.end until we find a bound suffix. */
9915 while (keytran
.end
< fkey
.start
)
9917 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9920 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9921 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9926 mock_input
= diff
+ max (t
, mock_input
);
9927 /* Adjust the function-key-map and input-decode-map counters. */
9929 indec
.start
+= diff
;
9933 goto replay_sequence
;
9937 /* If KEY is not defined in any of the keymaps,
9938 and cannot be part of a function key or translation,
9939 and is an upper case letter
9940 use the corresponding lower-case letter instead. */
9941 if (first_binding
>= nmaps
9942 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9944 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9945 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9946 || (XINT (key
) & shift_modifier
)))
9948 Lisp_Object new_key
;
9950 original_uppercase
= key
;
9951 original_uppercase_position
= t
- 1;
9953 if (XINT (key
) & shift_modifier
)
9954 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9956 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9957 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9959 /* We have to do this unconditionally, regardless of whether
9960 the lower-case char is defined in the keymaps, because they
9961 might get translated through function-key-map. */
9962 keybuf
[t
- 1] = new_key
;
9963 mock_input
= max (t
, mock_input
);
9964 shift_translated
= 1;
9966 goto replay_sequence
;
9968 /* If KEY is not defined in any of the keymaps,
9969 and cannot be part of a function key or translation,
9970 and is a shifted function key,
9971 use the corresponding unshifted function key instead. */
9972 if (first_binding
>= nmaps
9973 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9975 Lisp_Object breakdown
= parse_modifiers (key
);
9977 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9979 if (modifiers
& shift_modifier
9980 /* Treat uppercase keys as shifted. */
9982 && (KEY_TO_CHAR (key
)
9983 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9984 && uppercasep (KEY_TO_CHAR (key
))))
9987 = (modifiers
& shift_modifier
9988 ? apply_modifiers (modifiers
& ~shift_modifier
,
9990 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9992 original_uppercase
= key
;
9993 original_uppercase_position
= t
- 1;
9995 /* We have to do this unconditionally, regardless of whether
9996 the lower-case char is defined in the keymaps, because they
9997 might get translated through function-key-map. */
9998 keybuf
[t
- 1] = new_key
;
9999 mock_input
= max (t
, mock_input
);
10000 /* Reset fkey (and consequently keytran) to apply
10001 function-key-map on the result, so that S-backspace is
10002 correctly mapped to DEL (via backspace). OTOH,
10003 input-decode-map doesn't need to go through it again. */
10004 fkey
.start
= fkey
.end
= 0;
10005 keytran
.start
= keytran
.end
= 0;
10006 shift_translated
= 1;
10008 goto replay_sequence
;
10013 read_key_sequence_cmd
= (first_binding
< nmaps
10014 ? defs
[first_binding
]
10016 read_key_sequence_remapped
10017 /* Remap command through active keymaps.
10018 Do the remapping here, before the unbind_to so it uses the keymaps
10019 of the appropriate buffer. */
10020 = SYMBOLP (read_key_sequence_cmd
)
10021 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10024 unread_switch_frame
= delayed_switch_frame
;
10025 unbind_to (count
, Qnil
);
10027 /* Don't downcase the last character if the caller says don't.
10028 Don't downcase it if the result is undefined, either. */
10029 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10031 && t
- 1 == original_uppercase_position
)
10033 keybuf
[t
- 1] = original_uppercase
;
10034 shift_translated
= 0;
10037 if (shift_translated
)
10038 Vthis_command_keys_shift_translated
= Qt
;
10040 /* Occasionally we fabricate events, perhaps by expanding something
10041 according to function-key-map, or by adding a prefix symbol to a
10042 mouse click in the scroll bar or modeline. In this cases, return
10043 the entire generated key sequence, even if we hit an unbound
10044 prefix or a definition before the end. This means that you will
10045 be able to push back the event properly, and also means that
10046 read-key-sequence will always return a logical unit.
10049 for (; t
< mock_input
; t
++)
10051 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10052 && NILP (Fzerop (Vecho_keystrokes
)))
10053 echo_char (keybuf
[t
]);
10054 add_command_key (keybuf
[t
]);
10057 UNGCPRO_VAR (outer_gcpro
);
10061 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10062 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10063 The sequence is sufficient to specify a non-prefix command in the
10064 current local and global maps.
10066 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10067 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10068 as a continuation of the previous key.
10070 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10071 convert the last event to lower case. (Normally any upper case event
10072 is converted to lower case if the original event is undefined and the lower
10073 case equivalent is defined.) A non-nil value is appropriate for reading
10074 a key sequence to be defined.
10076 A C-g typed while in this function is treated like any other character,
10077 and `quit-flag' is not set.
10079 If the key sequence starts with a mouse click, then the sequence is read
10080 using the keymaps of the buffer of the window clicked in, not the buffer
10081 of the selected window as normal.
10083 `read-key-sequence' drops unbound button-down events, since you normally
10084 only care about the click or drag events which follow them. If a drag
10085 or multi-click event is unbound, but the corresponding click event would
10086 be bound, `read-key-sequence' turns the event into a click event at the
10087 drag's starting position. This means that you don't have to distinguish
10088 between click and drag, double, or triple events unless you want to.
10090 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10091 lines separating windows, and scroll bars with imaginary keys
10092 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10094 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10095 function will process a switch-frame event if the user switches frames
10096 before typing anything. If the user switches frames in the middle of a
10097 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10098 is nil, then the event will be put off until after the current key sequence.
10100 `read-key-sequence' checks `function-key-map' for function key
10101 sequences, where they wouldn't conflict with ordinary bindings. See
10102 `function-key-map' for more details.
10104 The optional fifth argument CMD-LOOP, if non-nil, means
10105 that this key sequence is being read by something that will
10106 read commands one after another. It should be nil if the caller
10107 will read just one key sequence. */)
10108 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10110 Lisp_Object keybuf
[30];
10112 struct gcpro gcpro1
;
10113 ptrdiff_t count
= SPECPDL_INDEX ();
10115 if (!NILP (prompt
))
10116 CHECK_STRING (prompt
);
10119 specbind (Qinput_method_exit_on_first_char
,
10120 (NILP (cmd_loop
) ? Qt
: Qnil
));
10121 specbind (Qinput_method_use_echo_area
,
10122 (NILP (cmd_loop
) ? Qt
: Qnil
));
10124 memset (keybuf
, 0, sizeof keybuf
);
10125 GCPRO1 (keybuf
[0]);
10126 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10128 if (NILP (continue_echo
))
10130 this_command_key_count
= 0;
10131 this_command_key_count_reset
= 0;
10132 this_single_command_key_start
= 0;
10135 #ifdef HAVE_WINDOW_SYSTEM
10136 if (display_hourglass_p
)
10137 cancel_hourglass ();
10140 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10141 prompt
, ! NILP (dont_downcase_last
),
10142 ! NILP (can_return_switch_frame
), 0);
10144 #if 0 /* The following is fine for code reading a key sequence and
10145 then proceeding with a lenghty computation, but it's not good
10146 for code reading keys in a loop, like an input method. */
10147 #ifdef HAVE_WINDOW_SYSTEM
10148 if (display_hourglass_p
)
10149 start_hourglass ();
10159 return unbind_to (count
, make_event_array (i
, keybuf
));
10162 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10163 Sread_key_sequence_vector
, 1, 5, 0,
10164 doc
: /* Like `read-key-sequence' but always return a vector. */)
10165 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10167 Lisp_Object keybuf
[30];
10169 struct gcpro gcpro1
;
10170 ptrdiff_t count
= SPECPDL_INDEX ();
10172 if (!NILP (prompt
))
10173 CHECK_STRING (prompt
);
10176 specbind (Qinput_method_exit_on_first_char
,
10177 (NILP (cmd_loop
) ? Qt
: Qnil
));
10178 specbind (Qinput_method_use_echo_area
,
10179 (NILP (cmd_loop
) ? Qt
: Qnil
));
10181 memset (keybuf
, 0, sizeof keybuf
);
10182 GCPRO1 (keybuf
[0]);
10183 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10185 if (NILP (continue_echo
))
10187 this_command_key_count
= 0;
10188 this_command_key_count_reset
= 0;
10189 this_single_command_key_start
= 0;
10192 #ifdef HAVE_WINDOW_SYSTEM
10193 if (display_hourglass_p
)
10194 cancel_hourglass ();
10197 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10198 prompt
, ! NILP (dont_downcase_last
),
10199 ! NILP (can_return_switch_frame
), 0);
10201 #ifdef HAVE_WINDOW_SYSTEM
10202 if (display_hourglass_p
)
10203 start_hourglass ();
10212 return unbind_to (count
, Fvector (i
, keybuf
));
10215 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10216 doc
: /* Execute CMD as an editor command.
10217 CMD must be a symbol that satisfies the `commandp' predicate.
10218 Optional second arg RECORD-FLAG non-nil
10219 means unconditionally put this command in `command-history'.
10220 Otherwise, that is done only if an arg is read using the minibuffer.
10221 The argument KEYS specifies the value to use instead of (this-command-keys)
10222 when reading the arguments; if it is nil, (this-command-keys) is used.
10223 The argument SPECIAL, if non-nil, means that this command is executing
10224 a special event, so ignore the prefix argument and don't clear it. */)
10225 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10227 register Lisp_Object final
;
10228 register Lisp_Object tem
;
10229 Lisp_Object prefixarg
;
10231 debug_on_next_call
= 0;
10233 if (NILP (special
))
10235 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10236 Vcurrent_prefix_arg
= prefixarg
;
10237 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10244 tem
= Fget (cmd
, Qdisabled
);
10247 tem
= Fsymbol_value (Qdisabled_command_function
);
10249 return Frun_hooks (1, &Qdisabled_command_function
);
10255 final
= Findirect_function (cmd
, Qnil
);
10257 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10259 struct gcpro gcpro1
, gcpro2
;
10261 GCPRO2 (cmd
, prefixarg
);
10262 do_autoload (final
, cmd
);
10269 if (STRINGP (final
) || VECTORP (final
))
10271 /* If requested, place the macro in the command history. For
10272 other sorts of commands, call-interactively takes care of
10274 if (!NILP (record_flag
))
10277 = Fcons (Fcons (Qexecute_kbd_macro
,
10278 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10281 /* Don't keep command history around forever. */
10282 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10284 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10286 XSETCDR (tem
, Qnil
);
10290 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10293 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10294 /* Don't call Fcall_interactively directly because we want to make
10295 sure the backtrace has an entry for `call-interactively'.
10296 For the same reason, pass `cmd' rather than `final'. */
10297 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10304 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10306 doc
: /* Read function name, then read its arguments and call it.
10308 To pass a numeric argument to the command you are invoking with, specify
10309 the numeric argument to this command.
10311 Noninteractively, the argument PREFIXARG is the prefix argument to
10312 give to the command you invoke, if it asks for an argument. */)
10313 (Lisp_Object prefixarg
)
10315 Lisp_Object function
;
10316 ptrdiff_t saved_last_point_position
;
10317 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10318 Lisp_Object bindings
, value
;
10319 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10320 #ifdef HAVE_WINDOW_SYSTEM
10321 /* The call to Fcompleting_read will start and cancel the hourglass,
10322 but if the hourglass was already scheduled, this means that no
10323 hourglass will be shown for the actual M-x command itself.
10324 So we restart it if it is already scheduled. Note that checking
10325 hourglass_shown_p is not enough, normally the hourglass is not shown,
10326 just scheduled to be shown. */
10327 int hstarted
= hourglass_started ();
10330 saved_keys
= Fvector (this_command_key_count
,
10331 XVECTOR (this_command_keys
)->contents
);
10332 saved_last_point_position_buffer
= last_point_position_buffer
;
10333 saved_last_point_position
= last_point_position
;
10334 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10336 function
= call0 (intern ("read-extended-command"));
10338 #ifdef HAVE_WINDOW_SYSTEM
10339 if (hstarted
) start_hourglass ();
10342 if (STRINGP (function
) && SCHARS (function
) == 0)
10343 error ("No command name given");
10345 /* Set this_command_keys to the concatenation of saved_keys and
10346 function, followed by a RET. */
10351 this_command_key_count
= 0;
10352 this_command_key_count_reset
= 0;
10353 this_single_command_key_start
= 0;
10355 keys
= XVECTOR (saved_keys
)->contents
;
10356 for (i
= 0; i
< ASIZE (saved_keys
); i
++)
10357 add_command_key (keys
[i
]);
10359 for (i
= 0; i
< SCHARS (function
); i
++)
10360 add_command_key (Faref (function
, make_number (i
)));
10362 add_command_key (make_number ('\015'));
10365 last_point_position
= saved_last_point_position
;
10366 last_point_position_buffer
= saved_last_point_position_buffer
;
10370 function
= Fintern (function
, Qnil
);
10371 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10372 Vthis_command
= function
;
10373 real_this_command
= function
;
10375 /* If enabled, show which key runs this command. */
10376 if (!NILP (Vsuggest_key_bindings
)
10377 && NILP (Vexecuting_kbd_macro
)
10378 && SYMBOLP (function
))
10379 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10385 GCPRO3 (bindings
, value
, function
);
10386 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10388 /* If the command has a key binding, print it now. */
10389 if (!NILP (bindings
)
10390 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10393 /* But first wait, and skip the message if there is input. */
10394 Lisp_Object waited
;
10396 /* If this command displayed something in the echo area;
10397 wait a few seconds, then display our suggestion message. */
10398 if (NILP (echo_area_buffer
[0]))
10399 waited
= sit_for (make_number (0), 0, 2);
10400 else if (NUMBERP (Vsuggest_key_bindings
))
10401 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10403 waited
= sit_for (make_number (2), 0, 2);
10405 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10407 Lisp_Object binding
;
10409 int message_p
= push_message ();
10410 ptrdiff_t count
= SPECPDL_INDEX ();
10411 ptrdiff_t newmessage_len
, newmessage_alloc
;
10414 record_unwind_protect (pop_message_unwind
, Qnil
);
10415 binding
= Fkey_description (bindings
, Qnil
);
10417 (sizeof "You can run the command `' with "
10418 + SBYTES (SYMBOL_NAME (function
)) + SBYTES (binding
));
10419 SAFE_ALLOCA (newmessage
, char *, newmessage_alloc
);
10421 esprintf (newmessage
, "You can run the command `%s' with %s",
10422 SDATA (SYMBOL_NAME (function
)),
10424 message2 (newmessage
,
10426 STRING_MULTIBYTE (binding
));
10427 if (NUMBERP (Vsuggest_key_bindings
))
10428 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10430 waited
= sit_for (make_number (2), 0, 2);
10432 if (!NILP (waited
) && message_p
)
10433 restore_message ();
10436 unbind_to (count
, Qnil
);
10440 RETURN_UNGCPRO (value
);
10444 /* Return nonzero if input events are pending. */
10447 detect_input_pending (void)
10449 if (!input_pending
)
10450 get_input_pending (&input_pending
, 0);
10452 return input_pending
;
10455 /* Return nonzero if input events other than mouse movements are
10459 detect_input_pending_ignore_squeezables (void)
10461 if (!input_pending
)
10462 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10464 return input_pending
;
10467 /* Return nonzero if input events are pending, and run any pending timers. */
10470 detect_input_pending_run_timers (int do_display
)
10472 int old_timers_run
= timers_run
;
10474 if (!input_pending
)
10475 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10477 if (old_timers_run
!= timers_run
&& do_display
)
10479 redisplay_preserve_echo_area (8);
10480 /* The following fixes a bug when using lazy-lock with
10481 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10482 from an idle timer function. The symptom of the bug is that
10483 the cursor sometimes doesn't become visible until the next X
10484 event is processed. --gerd. */
10486 Lisp_Object tail
, frame
;
10487 FOR_EACH_FRAME (tail
, frame
)
10488 if (FRAME_RIF (XFRAME (frame
)))
10489 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10493 return input_pending
;
10496 /* This is called in some cases before a possible quit.
10497 It cases the next call to detect_input_pending to recompute input_pending.
10498 So calling this function unnecessarily can't do any harm. */
10501 clear_input_pending (void)
10506 /* Return nonzero if there are pending requeued events.
10507 This isn't used yet. The hope is to make wait_reading_process_output
10508 call it, and return if it runs Lisp code that unreads something.
10509 The problem is, kbd_buffer_get_event needs to be fixed to know what
10510 to do in that case. It isn't trivial. */
10513 requeued_events_pending_p (void)
10515 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10519 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10520 doc
: /* Return t if command input is currently available with no wait.
10521 Actually, the value is nil only if we can be sure that no input is available;
10522 if there is a doubt, the value is t. */)
10525 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10526 || !NILP (Vunread_post_input_method_events
)
10527 || !NILP (Vunread_input_method_events
))
10530 get_input_pending (&input_pending
,
10531 READABLE_EVENTS_DO_TIMERS_NOW
10532 | READABLE_EVENTS_FILTER_EVENTS
);
10533 return input_pending
> 0 ? Qt
: Qnil
;
10536 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10537 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10540 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10543 if (total_keys
< NUM_RECENT_KEYS
)
10544 return Fvector (total_keys
, keys
);
10547 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10548 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10549 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10550 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10551 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10556 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10557 doc
: /* Return the key sequence that invoked this command.
10558 However, if the command has called `read-key-sequence', it returns
10559 the last key sequence that has been read.
10560 The value is a string or a vector.
10562 See also `this-command-keys-vector'. */)
10565 return make_event_array (this_command_key_count
,
10566 XVECTOR (this_command_keys
)->contents
);
10569 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10570 doc
: /* Return the key sequence that invoked this command, as a vector.
10571 However, if the command has called `read-key-sequence', it returns
10572 the last key sequence that has been read.
10574 See also `this-command-keys'. */)
10577 return Fvector (this_command_key_count
,
10578 XVECTOR (this_command_keys
)->contents
);
10581 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10582 Sthis_single_command_keys
, 0, 0, 0,
10583 doc
: /* Return the key sequence that invoked this command.
10584 More generally, it returns the last key sequence read, either by
10585 the command loop or by `read-key-sequence'.
10586 Unlike `this-command-keys', this function's value
10587 does not include prefix arguments.
10588 The value is always a vector. */)
10591 return Fvector (this_command_key_count
10592 - this_single_command_key_start
,
10593 (XVECTOR (this_command_keys
)->contents
10594 + this_single_command_key_start
));
10597 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10598 Sthis_single_command_raw_keys
, 0, 0, 0,
10599 doc
: /* Return the raw events that were read for this command.
10600 More generally, it returns the last key sequence read, either by
10601 the command loop or by `read-key-sequence'.
10602 Unlike `this-single-command-keys', this function's value
10603 shows the events before all translations (except for input methods).
10604 The value is always a vector. */)
10607 return Fvector (raw_keybuf_count
,
10608 (XVECTOR (raw_keybuf
)->contents
));
10611 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10612 Sreset_this_command_lengths
, 0, 0, 0,
10613 doc
: /* Make the unread events replace the last command and echo.
10614 Used in `universal-argument-other-key'.
10616 `universal-argument-other-key' rereads the event just typed.
10617 It then gets translated through `function-key-map'.
10618 The translated event has to replace the real events,
10619 both in the value of (this-command-keys) and in echoing.
10620 To achieve this, `universal-argument-other-key' calls
10621 `reset-this-command-lengths', which discards the record of reading
10622 these events the first time. */)
10625 this_command_key_count
= before_command_key_count
;
10626 if (this_command_key_count
< this_single_command_key_start
)
10627 this_single_command_key_start
= this_command_key_count
;
10629 echo_truncate (before_command_echo_length
);
10631 /* Cause whatever we put into unread-command-events
10632 to echo as if it were being freshly read from the keyboard. */
10633 this_command_key_count_reset
= 1;
10638 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10639 Sclear_this_command_keys
, 0, 1, 0,
10640 doc
: /* Clear out the vector that `this-command-keys' returns.
10641 Also clear the record of the last 100 events, unless optional arg
10642 KEEP-RECORD is non-nil. */)
10643 (Lisp_Object keep_record
)
10647 this_command_key_count
= 0;
10648 this_command_key_count_reset
= 0;
10650 if (NILP (keep_record
))
10652 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10653 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10655 recent_keys_index
= 0;
10660 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10661 doc
: /* Return the current depth in recursive edits. */)
10665 /* Wrap around reliably on integer overflow. */
10666 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10667 XSETINT (temp
, sum
);
10671 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10672 "FOpen dribble file: ",
10673 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10674 If FILE is nil, close any open dribble file.
10675 The file will be closed when Emacs exits. */)
10687 file
= Fexpand_file_name (file
, Qnil
);
10688 dribble
= fopen (SSDATA (file
), "w");
10690 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10695 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10696 doc
: /* Discard the contents of the terminal input buffer.
10697 Also end any kbd macro being defined. */)
10700 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10702 /* Discard the last command from the macro. */
10703 Fcancel_kbd_macro_events ();
10707 update_mode_lines
++;
10709 Vunread_command_events
= Qnil
;
10710 unread_command_char
= -1;
10712 discard_tty_input ();
10714 kbd_fetch_ptr
= kbd_store_ptr
;
10720 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10721 doc
: /* Stop Emacs and return to superior process. You can resume later.
10722 If `cannot-suspend' is non-nil, or if the system doesn't support job
10723 control, run a subshell instead.
10725 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10726 to be read as terminal input by Emacs's parent, after suspension.
10728 Before suspending, run the normal hook `suspend-hook'.
10729 After resumption run the normal hook `suspend-resume-hook'.
10731 Some operating systems cannot stop the Emacs process and resume it later.
10732 On such systems, Emacs starts a subshell instead of suspending. */)
10733 (Lisp_Object stuffstring
)
10735 ptrdiff_t count
= SPECPDL_INDEX ();
10736 int old_height
, old_width
;
10738 struct gcpro gcpro1
;
10741 if (tty_list
&& tty_list
->next
)
10742 error ("There are other tty frames open; close them before suspending Emacs");
10744 if (!NILP (stuffstring
))
10745 CHECK_STRING (stuffstring
);
10747 /* Run the functions in suspend-hook. */
10748 hook
= intern ("suspend-hook");
10749 Frun_hooks (1, &hook
);
10751 GCPRO1 (stuffstring
);
10752 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10753 reset_all_sys_modes ();
10754 /* sys_suspend can get an error if it tries to fork a subshell
10755 and the system resources aren't available for that. */
10756 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10758 stuff_buffered_input (stuffstring
);
10759 if (cannot_suspend
)
10763 unbind_to (count
, Qnil
);
10765 /* Check if terminal/window size has changed.
10766 Note that this is not useful when we are running directly
10767 with a window system; but suspend should be disabled in that case. */
10768 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10769 if (width
!= old_width
|| height
!= old_height
)
10770 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10772 /* Run suspend-resume-hook. */
10773 hook
= intern ("suspend-resume-hook");
10774 Frun_hooks (1, &hook
);
10780 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10781 Then in any case stuff anything Emacs has read ahead and not used. */
10784 stuff_buffered_input (Lisp_Object stuffstring
)
10786 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10787 register unsigned char *p
;
10789 if (STRINGP (stuffstring
))
10791 register ptrdiff_t count
;
10793 p
= SDATA (stuffstring
);
10794 count
= SBYTES (stuffstring
);
10795 while (count
-- > 0)
10800 /* Anything we have read ahead, put back for the shell to read. */
10801 /* ?? What should this do when we have multiple keyboards??
10802 Should we ignore anything that was typed in at the "wrong" kboard?
10804 rms: we should stuff everything back into the kboard
10806 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10809 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10810 kbd_fetch_ptr
= kbd_buffer
;
10811 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10812 stuff_char (kbd_fetch_ptr
->code
);
10814 clear_event (kbd_fetch_ptr
);
10818 #endif /* SIGTSTP */
10822 set_waiting_for_input (struct timeval
*time_to_clear
)
10824 input_available_clear_time
= time_to_clear
;
10826 /* Tell handle_interrupt to throw back to read_char, */
10827 waiting_for_input
= 1;
10829 /* If handle_interrupt was called before and buffered a C-g,
10830 make it run again now, to avoid timing error. */
10831 if (!NILP (Vquit_flag
))
10832 quit_throw_to_read_char ();
10836 clear_waiting_for_input (void)
10838 /* Tell handle_interrupt not to throw back to read_char, */
10839 waiting_for_input
= 0;
10840 input_available_clear_time
= 0;
10843 /* The SIGINT handler.
10845 If we have a frame on the controlling tty, we assume that the
10846 SIGINT was generated by C-g, so we call handle_interrupt.
10847 Otherwise, the handler kills Emacs. */
10850 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10851 /* compilers complain in signal calls. */
10853 /* Must preserve main program's value of errno. */
10854 int old_errno
= errno
;
10855 struct terminal
*terminal
;
10857 SIGNAL_THREAD_CHECK (signalnum
);
10859 /* See if we have an active terminal on our controlling tty. */
10860 terminal
= get_named_tty ("/dev/tty");
10863 /* If there are no frames there, let's pretend that we are a
10864 well-behaving UN*X program and quit. */
10865 Fkill_emacs (Qnil
);
10869 /* Otherwise, the SIGINT was probably generated by C-g. */
10871 /* Set internal_last_event_frame to the top frame of the
10872 controlling tty, if we have a frame there. We disable the
10873 interrupt key on secondary ttys, so the SIGINT must have come
10874 from the controlling tty. */
10875 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10877 handle_interrupt ();
10883 /* This routine is called at interrupt level in response to C-g.
10885 It is called from the SIGINT handler or kbd_buffer_store_event.
10887 If `waiting_for_input' is non zero, then unless `echoing' is
10888 nonzero, immediately throw back to read_char.
10890 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10891 eval to throw, when it gets a chance. If quit-flag is already
10892 non-nil, it stops the job right away. */
10895 handle_interrupt (void)
10901 /* XXX This code needs to be revised for multi-tty support. */
10902 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10904 /* If SIGINT isn't blocked, don't let us be interrupted by
10905 another SIGINT, it might be harmful due to non-reentrancy
10906 in I/O functions. */
10907 sigblock (sigmask (SIGINT
));
10910 reset_all_sys_modes ();
10912 #ifdef SIGTSTP /* Support possible in later USG versions */
10914 * On systems which can suspend the current process and return to the original
10915 * shell, this command causes the user to end up back at the shell.
10916 * The "Auto-save" and "Abort" questions are not asked until
10917 * the user elects to return to emacs, at which point he can save the current
10918 * job and either dump core or continue.
10922 /* Perhaps should really fork an inferior shell?
10923 But that would not provide any way to get back
10924 to the original shell, ever. */
10925 printf ("No support for stopping a process on this operating system;\n");
10926 printf ("you can continue or abort.\n");
10927 #endif /* not SIGTSTP */
10929 /* We must remain inside the screen area when the internal terminal
10930 is used. Note that [Enter] is not echoed by dos. */
10931 cursor_to (SELECTED_FRAME (), 0, 0);
10933 /* It doesn't work to autosave while GC is in progress;
10934 the code used for auto-saving doesn't cope with the mark bit. */
10935 if (!gc_in_progress
)
10937 printf ("Auto-save? (y or n) ");
10939 if (((c
= getchar ()) & ~040) == 'Y')
10941 Fdo_auto_save (Qt
, Qnil
);
10943 printf ("\r\nAuto-save done");
10944 #else /* not MSDOS */
10945 printf ("Auto-save done\n");
10946 #endif /* not MSDOS */
10948 while (c
!= '\n') c
= getchar ();
10952 /* During GC, it must be safe to reenable quitting again. */
10953 Vinhibit_quit
= Qnil
;
10956 #endif /* not MSDOS */
10957 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10958 printf ("but will instead do a real quit after garbage collection ends\r\n");
10963 printf ("\r\nAbort? (y or n) ");
10964 #else /* not MSDOS */
10965 printf ("Abort (and dump core)? (y or n) ");
10966 #endif /* not MSDOS */
10968 if (((c
= getchar ()) & ~040) == 'Y')
10970 while (c
!= '\n') c
= getchar ();
10972 printf ("\r\nContinuing...\r\n");
10973 #else /* not MSDOS */
10974 printf ("Continuing...\n");
10975 #endif /* not MSDOS */
10977 init_all_sys_modes ();
10982 /* If executing a function that wants to be interrupted out of
10983 and the user has not deferred quitting by binding `inhibit-quit'
10984 then quit right away. */
10985 if (immediate_quit
&& NILP (Vinhibit_quit
))
10987 struct gl_state_s saved
;
10988 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10990 immediate_quit
= 0;
10993 GCPRO4 (saved
.object
, saved
.global_code
,
10994 saved
.current_syntax_table
, saved
.old_prop
);
10995 Fsignal (Qquit
, Qnil
);
10996 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11001 /* Else request quit when it's safe */
11005 /* TODO: The longjmp in this call throws the NS event loop integration off,
11006 and it seems to do fine without this. Probably some attention
11007 needs to be paid to the setting of waiting_for_input in
11008 wait_reading_process_output() under HAVE_NS because of the call
11009 to ns_select there (needed because otherwise events aren't picked up
11010 outside of polling since we don't get SIGIO like X and we don't have a
11011 separate event loop thread like W32. */
11013 if (waiting_for_input
&& !echoing
)
11014 quit_throw_to_read_char ();
11018 /* Handle a C-g by making read_char return C-g. */
11021 quit_throw_to_read_char (void)
11024 /* Prevent another signal from doing this before we finish. */
11025 clear_waiting_for_input ();
11028 Vunread_command_events
= Qnil
;
11029 unread_command_char
= -1;
11031 #if 0 /* Currently, sit_for is called from read_char without turning
11032 off polling. And that can call set_waiting_for_input.
11033 It seems to be harmless. */
11034 #ifdef POLL_FOR_INPUT
11035 /* May be > 1 if in recursive minibuffer. */
11036 if (poll_suppress_count
== 0)
11040 if (FRAMEP (internal_last_event_frame
)
11041 && !EQ (internal_last_event_frame
, selected_frame
))
11042 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11045 _longjmp (getcjmp
, 1);
11048 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
11049 Sset_input_interrupt_mode
, 1, 1, 0,
11050 doc
: /* Set interrupt mode of reading keyboard input.
11051 If INTERRUPT is non-nil, Emacs will use input interrupts;
11052 otherwise Emacs uses CBREAK mode.
11054 See also `current-input-mode'. */)
11055 (Lisp_Object interrupt
)
11057 int new_interrupt_input
;
11059 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11060 #ifdef HAVE_X_WINDOWS
11061 if (x_display_list
!= NULL
)
11063 /* When using X, don't give the user a real choice,
11064 because we haven't implemented the mechanisms to support it. */
11065 new_interrupt_input
= 1;
11068 #endif /* HAVE_X_WINDOWS */
11069 new_interrupt_input
= !NILP (interrupt
);
11070 #else /* not SIGIO */
11071 new_interrupt_input
= 0;
11072 #endif /* not SIGIO */
11074 if (new_interrupt_input
!= interrupt_input
)
11076 #ifdef POLL_FOR_INPUT
11080 /* this causes startup screen to be restored and messes with the mouse */
11081 reset_all_sys_modes ();
11082 interrupt_input
= new_interrupt_input
;
11083 init_all_sys_modes ();
11085 interrupt_input
= new_interrupt_input
;
11088 #ifdef POLL_FOR_INPUT
11089 poll_suppress_count
= 1;
11096 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11097 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11098 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11099 C-q in key sequences.
11101 This setting only has an effect on tty terminals and only when
11102 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11104 See also `current-input-mode'. */)
11105 (Lisp_Object flow
, Lisp_Object terminal
)
11107 struct terminal
*t
= get_terminal (terminal
, 1);
11108 struct tty_display_info
*tty
;
11109 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11111 tty
= t
->display_info
.tty
;
11113 if (tty
->flow_control
!= !NILP (flow
))
11116 /* this causes startup screen to be restored and messes with the mouse */
11117 reset_sys_modes (tty
);
11120 tty
->flow_control
= !NILP (flow
);
11123 init_sys_modes (tty
);
11129 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11130 doc
: /* Enable or disable 8-bit input on TERMINAL.
11131 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11132 bit as the Meta modifier.
11134 If META is nil, Emacs will ignore the top bit, on the assumption it is
11137 Otherwise, Emacs will accept and pass through 8-bit input without
11138 specially interpreting the top bit.
11140 This setting only has an effect on tty terminal devices.
11142 Optional parameter TERMINAL specifies the tty terminal device to use.
11143 It may be a terminal object, a frame, or nil for the terminal used by
11144 the currently selected frame.
11146 See also `current-input-mode'. */)
11147 (Lisp_Object meta
, Lisp_Object terminal
)
11149 struct terminal
*t
= get_terminal (terminal
, 1);
11150 struct tty_display_info
*tty
;
11153 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11155 tty
= t
->display_info
.tty
;
11159 else if (EQ (meta
, Qt
))
11164 if (tty
->meta_key
!= new_meta
)
11167 /* this causes startup screen to be restored and messes with the mouse */
11168 reset_sys_modes (tty
);
11171 tty
->meta_key
= new_meta
;
11174 init_sys_modes (tty
);
11180 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11181 doc
: /* Specify character used for quitting.
11182 QUIT must be an ASCII character.
11184 This function only has an effect on the controlling tty of the Emacs
11187 See also `current-input-mode'. */)
11190 struct terminal
*t
= get_named_tty ("/dev/tty");
11191 struct tty_display_info
*tty
;
11192 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11194 tty
= t
->display_info
.tty
;
11196 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11197 error ("QUIT must be an ASCII character");
11200 /* this causes startup screen to be restored and messes with the mouse */
11201 reset_sys_modes (tty
);
11204 /* Don't let this value be out of range. */
11205 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11208 init_sys_modes (tty
);
11214 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11215 doc
: /* Set mode of reading keyboard input.
11216 First arg INTERRUPT non-nil means use input interrupts;
11217 nil means use CBREAK mode.
11218 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11219 (no effect except in CBREAK mode).
11220 Third arg META t means accept 8-bit input (for a Meta key).
11221 META nil means ignore the top bit, on the assumption it is parity.
11222 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11223 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11224 See also `current-input-mode'. */)
11225 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11227 Fset_input_interrupt_mode (interrupt
);
11228 Fset_output_flow_control (flow
, Qnil
);
11229 Fset_input_meta_mode (meta
, Qnil
);
11231 Fset_quit_char (quit
);
11235 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11236 doc
: /* Return information about the way Emacs currently reads keyboard input.
11237 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11238 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11239 nil, Emacs is using CBREAK mode.
11240 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11241 terminal; this does not apply if Emacs uses interrupt-driven input.
11242 META is t if accepting 8-bit input with 8th bit as Meta flag.
11243 META nil means ignoring the top bit, on the assumption it is parity.
11244 META is neither t nor nil if accepting 8-bit input and using
11245 all 8 bits as the character code.
11246 QUIT is the character Emacs currently uses to quit.
11247 The elements of this list correspond to the arguments of
11248 `set-input-mode'. */)
11251 Lisp_Object val
[4];
11252 struct frame
*sf
= XFRAME (selected_frame
);
11254 val
[0] = interrupt_input
? Qt
: Qnil
;
11255 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11257 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11258 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11260 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11267 XSETFASTINT (val
[3], quit_char
);
11269 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11272 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11273 doc
: /* Return position information for pixel coordinates X and Y.
11274 By default, X and Y are relative to text area of the selected window.
11275 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11276 If optional fourth arg WHOLE is non-nil, X is relative to the left
11277 edge of the window.
11279 The return value is similar to a mouse click position:
11280 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11281 IMAGE (DX . DY) (WIDTH . HEIGHT))
11282 The `posn-' functions access elements of such lists. */)
11283 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11288 if (NILP (frame_or_window
))
11289 frame_or_window
= selected_window
;
11291 if (WINDOWP (frame_or_window
))
11295 CHECK_LIVE_WINDOW (frame_or_window
);
11297 w
= XWINDOW (frame_or_window
);
11298 XSETINT (x
, (XINT (x
)
11299 + WINDOW_LEFT_EDGE_X (w
)
11301 ? window_box_left_offset (w
, TEXT_AREA
)
11303 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11304 frame_or_window
= w
->frame
;
11307 CHECK_LIVE_FRAME (frame_or_window
);
11309 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11312 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11313 doc
: /* Return position information for buffer POS in WINDOW.
11314 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11316 Return nil if position is not visible in window. Otherwise,
11317 the return value is similar to that returned by `event-start' for
11318 a mouse click at the upper left corner of the glyph corresponding
11319 to the given buffer position:
11320 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11321 IMAGE (DX . DY) (WIDTH . HEIGHT))
11322 The `posn-' functions access elements of such lists. */)
11323 (Lisp_Object pos
, Lisp_Object window
)
11328 window
= selected_window
;
11330 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11333 Lisp_Object x
= XCAR (tem
);
11334 Lisp_Object y
= XCAR (XCDR (tem
));
11336 /* Point invisible due to hscrolling? */
11339 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11347 * Set up a new kboard object with reasonable initial values.
11350 init_kboard (KBOARD
*kb
)
11352 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11353 KVAR (kb
, Vlast_command
) = Qnil
;
11354 KVAR (kb
, Vreal_last_command
) = Qnil
;
11355 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11356 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11357 KVAR (kb
, Vprefix_arg
) = Qnil
;
11358 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11359 KVAR (kb
, kbd_queue
) = Qnil
;
11360 kb
->kbd_queue_has_data
= 0;
11361 kb
->immediate_echo
= 0;
11362 KVAR (kb
, echo_string
) = Qnil
;
11363 kb
->echo_after_prompt
= -1;
11364 kb
->kbd_macro_buffer
= 0;
11365 kb
->kbd_macro_bufsize
= 0;
11366 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11367 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11368 kb
->reference_count
= 0;
11369 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11370 KVAR (kb
, system_key_syms
) = Qnil
;
11371 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11372 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11373 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11374 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11375 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11379 * Destroy the contents of a kboard object, but not the object itself.
11380 * We use this just before deleting it, or if we're going to initialize
11381 * it a second time.
11384 wipe_kboard (KBOARD
*kb
)
11386 xfree (kb
->kbd_macro_buffer
);
11389 /* Free KB and memory referenced from it. */
11392 delete_kboard (KBOARD
*kb
)
11396 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11399 *kbp
= kb
->next_kboard
;
11401 /* Prevent a dangling reference to KB. */
11402 if (kb
== current_kboard
11403 && FRAMEP (selected_frame
)
11404 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11406 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11408 if (current_kboard
== kb
)
11417 init_keyboard (void)
11419 /* This is correct before outermost invocation of the editor loop */
11420 command_loop_level
= -1;
11421 immediate_quit
= 0;
11422 quit_char
= Ctl ('g');
11423 Vunread_command_events
= Qnil
;
11424 unread_command_char
= -1;
11425 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11427 recent_keys_index
= 0;
11428 kbd_fetch_ptr
= kbd_buffer
;
11429 kbd_store_ptr
= kbd_buffer
;
11430 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11431 do_mouse_tracking
= Qnil
;
11434 interrupt_input_blocked
= 0;
11435 interrupt_input_pending
= 0;
11437 pending_signals
= 0;
11440 /* This means that command_loop_1 won't try to select anything the first
11442 internal_last_event_frame
= Qnil
;
11443 Vlast_event_frame
= internal_last_event_frame
;
11445 current_kboard
= initial_kboard
;
11446 /* Re-initialize the keyboard again. */
11447 wipe_kboard (current_kboard
);
11448 init_kboard (current_kboard
);
11449 /* A value of nil for Vwindow_system normally means a tty, but we also use
11450 it for the initial terminal since there is no window system there. */
11451 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11453 if (!noninteractive
)
11455 /* Before multi-tty support, these handlers used to be installed
11456 only if the current session was a tty session. Now an Emacs
11457 session may have multiple display types, so we always handle
11458 SIGINT. There is special code in interrupt_signal to exit
11459 Emacs on SIGINT when there are no termcap frames on the
11460 controlling terminal. */
11461 signal (SIGINT
, interrupt_signal
);
11463 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11464 SIGQUIT and we can't tell which one it will give us. */
11465 signal (SIGQUIT
, interrupt_signal
);
11466 #endif /* not DOS_NT */
11468 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11470 if (!noninteractive
)
11471 signal (SIGIO
, input_available_signal
);
11474 /* Use interrupt input by default, if it works and noninterrupt input
11475 has deficiencies. */
11477 #ifdef INTERRUPT_INPUT
11478 interrupt_input
= 1;
11480 interrupt_input
= 0;
11486 if (keyboard_init_hook
)
11487 (*keyboard_init_hook
) ();
11489 #ifdef POLL_FOR_INPUT
11491 poll_suppress_count
= 1;
11496 /* This type's only use is in syms_of_keyboard, to initialize the
11497 event header symbols and put properties on them. */
11498 struct event_head
{
11504 static const struct event_head head_table
[] = {
11505 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11506 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11507 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11508 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11509 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11510 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11511 /* `select-window' should be handled just like `switch-frame'
11512 in read_key_sequence. */
11513 {&Qselect_window
, "select-window", &Qswitch_frame
}
11517 syms_of_keyboard (void)
11519 pending_funcalls
= Qnil
;
11520 staticpro (&pending_funcalls
);
11522 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11523 staticpro (&Vlispy_mouse_stem
);
11526 DEFSYM (QCimage
, ":image");
11527 DEFSYM (Qhelp_echo
, "help-echo");
11528 DEFSYM (QCrtl
, ":rtl");
11530 staticpro (&item_properties
);
11531 item_properties
= Qnil
;
11533 staticpro (&tool_bar_item_properties
);
11534 tool_bar_item_properties
= Qnil
;
11535 staticpro (&tool_bar_items_vector
);
11536 tool_bar_items_vector
= Qnil
;
11538 staticpro (&real_this_command
);
11539 real_this_command
= Qnil
;
11541 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11542 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11543 DEFSYM (Qself_insert_command
, "self-insert-command");
11544 DEFSYM (Qforward_char
, "forward-char");
11545 DEFSYM (Qbackward_char
, "backward-char");
11546 DEFSYM (Qdisabled
, "disabled");
11547 DEFSYM (Qundefined
, "undefined");
11548 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11549 DEFSYM (Qpost_command_hook
, "post-command-hook");
11550 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11551 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11552 DEFSYM (Qfunction_key
, "function-key");
11553 DEFSYM (Qmouse_click
, "mouse-click");
11554 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11555 DEFSYM (Qsave_session
, "save-session");
11556 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11557 DEFSYM (Qmenu_enable
, "menu-enable");
11559 #if defined (WINDOWSNT)
11560 DEFSYM (Qlanguage_change
, "language-change");
11564 DEFSYM (Qdbus_event
, "dbus-event");
11567 DEFSYM (QCenable
, ":enable");
11568 DEFSYM (QCvisible
, ":visible");
11569 DEFSYM (QChelp
, ":help");
11570 DEFSYM (QCfilter
, ":filter");
11571 DEFSYM (QCbutton
, ":button");
11572 DEFSYM (QCkeys
, ":keys");
11573 DEFSYM (QCkey_sequence
, ":key-sequence");
11574 DEFSYM (QCtoggle
, ":toggle");
11575 DEFSYM (QCradio
, ":radio");
11576 DEFSYM (QClabel
, ":label");
11577 DEFSYM (QCvert_only
, ":vert-only");
11579 DEFSYM (Qmode_line
, "mode-line");
11580 DEFSYM (Qvertical_line
, "vertical-line");
11581 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11582 DEFSYM (Qmenu_bar
, "menu-bar");
11584 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11585 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11588 DEFSYM (Qabove_handle
, "above-handle");
11589 DEFSYM (Qhandle
, "handle");
11590 DEFSYM (Qbelow_handle
, "below-handle");
11591 DEFSYM (Qup
, "up");
11592 DEFSYM (Qdown
, "down");
11593 DEFSYM (Qtop
, "top");
11594 DEFSYM (Qbottom
, "bottom");
11595 DEFSYM (Qend_scroll
, "end-scroll");
11596 DEFSYM (Qratio
, "ratio");
11598 DEFSYM (Qevent_kind
, "event-kind");
11599 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11600 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11601 DEFSYM (Qmodifier_cache
, "modifier-cache");
11603 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11604 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11606 DEFSYM (Qpolling_period
, "polling-period");
11608 DEFSYM (Qx_set_selection
, "x-set-selection");
11609 DEFSYM (QPRIMARY
, "PRIMARY");
11610 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11612 DEFSYM (Qinput_method_function
, "input-method-function");
11613 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11614 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11616 DEFSYM (Qhelp_form_show
, "help-form-show");
11618 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11619 Fset (Qinput_method_use_echo_area
, Qnil
);
11621 last_point_position_buffer
= Qnil
;
11622 last_point_position_window
= Qnil
;
11626 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11628 for (i
= 0; i
< len
; i
++)
11630 const struct event_head
*p
= &head_table
[i
];
11631 *p
->var
= intern_c_string (p
->name
);
11632 staticpro (p
->var
);
11633 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11634 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11638 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11639 staticpro (&button_down_location
);
11640 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11641 staticpro (&mouse_syms
);
11642 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11643 / sizeof (lispy_wheel_names
[0])),
11645 staticpro (&wheel_syms
);
11649 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11651 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11652 for (i
= 0; i
< len
; i
++)
11653 if (modifier_names
[i
])
11654 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11655 staticpro (&modifier_symbols
);
11658 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11659 staticpro (&recent_keys
);
11661 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11662 staticpro (&this_command_keys
);
11664 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11665 staticpro (&raw_keybuf
);
11667 DEFSYM (Qextended_command_history
, "extended-command-history");
11668 Fset (Qextended_command_history
, Qnil
);
11670 accent_key_syms
= Qnil
;
11671 staticpro (&accent_key_syms
);
11673 func_key_syms
= Qnil
;
11674 staticpro (&func_key_syms
);
11676 drag_n_drop_syms
= Qnil
;
11677 staticpro (&drag_n_drop_syms
);
11679 unread_switch_frame
= Qnil
;
11680 staticpro (&unread_switch_frame
);
11682 internal_last_event_frame
= Qnil
;
11683 staticpro (&internal_last_event_frame
);
11685 read_key_sequence_cmd
= Qnil
;
11686 staticpro (&read_key_sequence_cmd
);
11687 read_key_sequence_remapped
= Qnil
;
11688 staticpro (&read_key_sequence_remapped
);
11690 menu_bar_one_keymap_changed_items
= Qnil
;
11691 staticpro (&menu_bar_one_keymap_changed_items
);
11693 menu_bar_items_vector
= Qnil
;
11694 staticpro (&menu_bar_items_vector
);
11696 help_form_saved_window_configs
= Qnil
;
11697 staticpro (&help_form_saved_window_configs
);
11699 defsubr (&Scurrent_idle_time
);
11700 defsubr (&Sevent_symbol_parse_modifiers
);
11701 defsubr (&Sevent_convert_list
);
11702 defsubr (&Sread_key_sequence
);
11703 defsubr (&Sread_key_sequence_vector
);
11704 defsubr (&Srecursive_edit
);
11705 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11706 defsubr (&Strack_mouse
);
11708 defsubr (&Sinput_pending_p
);
11709 defsubr (&Scommand_execute
);
11710 defsubr (&Srecent_keys
);
11711 defsubr (&Sthis_command_keys
);
11712 defsubr (&Sthis_command_keys_vector
);
11713 defsubr (&Sthis_single_command_keys
);
11714 defsubr (&Sthis_single_command_raw_keys
);
11715 defsubr (&Sreset_this_command_lengths
);
11716 defsubr (&Sclear_this_command_keys
);
11717 defsubr (&Ssuspend_emacs
);
11718 defsubr (&Sabort_recursive_edit
);
11719 defsubr (&Sexit_recursive_edit
);
11720 defsubr (&Srecursion_depth
);
11721 defsubr (&Stop_level
);
11722 defsubr (&Sdiscard_input
);
11723 defsubr (&Sopen_dribble_file
);
11724 defsubr (&Sset_input_interrupt_mode
);
11725 defsubr (&Sset_output_flow_control
);
11726 defsubr (&Sset_input_meta_mode
);
11727 defsubr (&Sset_quit_char
);
11728 defsubr (&Sset_input_mode
);
11729 defsubr (&Scurrent_input_mode
);
11730 defsubr (&Sexecute_extended_command
);
11731 defsubr (&Sposn_at_point
);
11732 defsubr (&Sposn_at_x_y
);
11734 DEFVAR_LISP ("last-command-event", last_command_event
,
11735 doc
: /* Last input event that was part of a command. */);
11737 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11738 doc
: /* Last input event in a command, except for mouse menu events.
11739 Mouse menus give back keys that don't look like mouse events;
11740 this variable holds the actual mouse event that led to the menu,
11741 so that you can determine whether the command was run by mouse or not. */);
11743 DEFVAR_LISP ("last-input-event", last_input_event
,
11744 doc
: /* Last input event. */);
11746 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11747 doc
: /* List of events to be read as the command input.
11748 These events are processed first, before actual keyboard input.
11749 Events read from this list are not normally added to `this-command-keys',
11750 as they will already have been added once as they were read for the first time.
11751 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11752 Vunread_command_events
= Qnil
;
11754 DEFVAR_INT ("unread-command-char", unread_command_char
,
11755 doc
: /* If not -1, an object to be read as next command input event. */);
11757 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11758 doc
: /* List of events to be processed as input by input methods.
11759 These events are processed before `unread-command-events'
11760 and actual keyboard input, but are not given to `input-method-function'. */);
11761 Vunread_post_input_method_events
= Qnil
;
11763 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11764 doc
: /* List of events to be processed as input by input methods.
11765 These events are processed after `unread-command-events', but
11766 before actual keyboard input.
11767 If there's an active input method, the events are given to
11768 `input-method-function'. */);
11769 Vunread_input_method_events
= Qnil
;
11771 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11772 doc
: /* Meta-prefix character code.
11773 Meta-foo as command input turns into this character followed by foo. */);
11774 XSETINT (meta_prefix_char
, 033);
11776 DEFVAR_KBOARD ("last-command", Vlast_command
,
11777 doc
: /* The last command executed.
11778 Normally a symbol with a function definition, but can be whatever was found
11779 in the keymap, or whatever the variable `this-command' was set to by that
11782 The value `mode-exit' is special; it means that the previous command
11783 read an event that told it to exit, and it did so and unread that event.
11784 In other words, the present command is the event that made the previous
11787 The value `kill-region' is special; it means that the previous command
11788 was a kill command.
11790 `last-command' has a separate binding for each terminal device.
11791 See Info node `(elisp)Multiple Terminals'. */);
11793 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11794 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11796 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11797 doc
: /* Last command that may be repeated.
11798 The last command executed that was not bound to an input event.
11799 This is the command `repeat' will try to repeat. */);
11801 DEFVAR_LISP ("this-command", Vthis_command
,
11802 doc
: /* The command now being executed.
11803 The command can set this variable; whatever is put here
11804 will be in `last-command' during the following command. */);
11805 Vthis_command
= Qnil
;
11807 DEFVAR_LISP ("this-command-keys-shift-translated",
11808 Vthis_command_keys_shift_translated
,
11809 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11810 Shift-translation occurs when there is no binding for the key sequence
11811 as entered, but a binding was found by changing an upper-case letter
11812 to lower-case, or a shifted function key to an unshifted one. */);
11813 Vthis_command_keys_shift_translated
= Qnil
;
11815 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11816 doc
: /* The command bound to the current key sequence before remapping.
11817 It equals `this-command' if the original command was not remapped through
11818 any of the active keymaps. Otherwise, the value of `this-command' is the
11819 result of looking up the original command in the active keymaps. */);
11820 Vthis_original_command
= Qnil
;
11822 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11823 doc
: /* *Number of input events between auto-saves.
11824 Zero means disable autosaving due to number of characters typed. */);
11825 auto_save_interval
= 300;
11827 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11828 doc
: /* *Number of seconds idle time before auto-save.
11829 Zero or nil means disable auto-saving due to idleness.
11830 After auto-saving due to this many seconds of idle time,
11831 Emacs also does a garbage collection if that seems to be warranted. */);
11832 XSETFASTINT (Vauto_save_timeout
, 30);
11834 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11835 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11836 The value may be integer or floating point. */);
11837 Vecho_keystrokes
= make_number (1);
11839 DEFVAR_INT ("polling-period", polling_period
,
11840 doc
: /* *Interval between polling for input during Lisp execution.
11841 The reason for polling is to make C-g work to stop a running program.
11842 Polling is needed only when using X windows and SIGIO does not work.
11843 Polling is automatically disabled in all other cases. */);
11844 polling_period
= 2;
11846 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11847 doc
: /* *Maximum time between mouse clicks to make a double-click.
11848 Measured in milliseconds. The value nil means disable double-click
11849 recognition; t means double-clicks have no time limit and are detected
11850 by position only. */);
11851 Vdouble_click_time
= make_number (500);
11853 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11854 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11855 On window-system frames, value is the number of pixels the mouse may have
11856 moved horizontally or vertically between two clicks to make a double-click.
11857 On non window-system frames, value is interpreted in units of 1/8 characters
11860 This variable is also the threshold for motion of the mouse
11861 to count as a drag. */);
11862 double_click_fuzz
= 3;
11864 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11865 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11866 inhibit_local_menu_bar_menus
= 0;
11868 DEFVAR_INT ("num-input-keys", num_input_keys
,
11869 doc
: /* Number of complete key sequences read as input so far.
11870 This includes key sequences read from keyboard macros.
11871 The number is effectively the number of interactive command invocations. */);
11872 num_input_keys
= 0;
11874 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11875 doc
: /* Number of input events read from the keyboard so far.
11876 This does not include events generated by keyboard macros. */);
11877 num_nonmacro_input_events
= 0;
11879 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11880 doc
: /* The frame in which the most recently read event occurred.
11881 If the last event came from a keyboard macro, this is set to `macro'. */);
11882 Vlast_event_frame
= Qnil
;
11884 /* This variable is set up in sysdep.c. */
11885 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11886 doc
: /* The ERASE character as set by the user with stty. */);
11888 DEFVAR_LISP ("help-char", Vhelp_char
,
11889 doc
: /* Character to recognize as meaning Help.
11890 When it is read, do `(eval help-form)', and display result if it's a string.
11891 If the value of `help-form' is nil, this char can be read normally. */);
11892 XSETINT (Vhelp_char
, Ctl ('H'));
11894 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11895 doc
: /* List of input events to recognize as meaning Help.
11896 These work just like the value of `help-char' (see that). */);
11897 Vhelp_event_list
= Qnil
;
11899 DEFVAR_LISP ("help-form", Vhelp_form
,
11900 doc
: /* Form to execute when character `help-char' is read.
11901 If the form returns a string, that string is displayed.
11902 If `help-form' is nil, the help char is not recognized. */);
11905 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11906 doc
: /* Command to run when `help-char' character follows a prefix key.
11907 This command is used only when there is no actual binding
11908 for that character after that prefix key. */);
11909 Vprefix_help_command
= Qnil
;
11911 DEFVAR_LISP ("top-level", Vtop_level
,
11912 doc
: /* Form to evaluate when Emacs starts up.
11913 Useful to set before you dump a modified Emacs. */);
11916 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11917 doc
: /* Translate table for local keyboard input, or nil.
11918 If non-nil, the value should be a char-table. Each character read
11919 from the keyboard is looked up in this char-table. If the value found
11920 there is non-nil, then it is used instead of the actual input character.
11922 The value can also be a string or vector, but this is considered obsolete.
11923 If it is a string or vector of length N, character codes N and up are left
11924 untranslated. In a vector, an element which is nil means "no translation".
11926 This is applied to the characters supplied to input methods, not their
11927 output. See also `translation-table-for-input'.
11929 This variable has a separate binding for each terminal.
11930 See Info node `(elisp)Multiple Terminals'. */);
11932 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11933 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11934 \(Even if the operating system has support for stopping a process.\) */);
11935 cannot_suspend
= 0;
11937 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11938 doc
: /* Non-nil means prompt with menus when appropriate.
11939 This is done when reading from a keymap that has a prompt string,
11940 for elements that have prompt strings.
11941 The menu is displayed on the screen
11942 if X menus were enabled at configuration
11943 time and the previous event was a mouse click prefix key.
11944 Otherwise, menu prompting uses the echo area. */);
11945 menu_prompting
= 1;
11947 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11948 doc
: /* Character to see next line of menu prompt.
11949 Type this character while in a menu prompt to rotate around the lines of it. */);
11950 XSETINT (menu_prompt_more_char
, ' ');
11952 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11953 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11954 Emacs applies the modifiers of the character stored here to each keyboard
11955 character it reads. For example, after evaluating the expression
11956 (setq extra-keyboard-modifiers ?\\C-x)
11957 all input characters will have the control modifier applied to them.
11959 Note that the character ?\\C-@, equivalent to the integer zero, does
11960 not count as a control character; rather, it counts as a character
11961 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11962 cancels any modification. */);
11963 extra_keyboard_modifiers
= 0;
11965 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11966 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11967 The command loop sets this to nil before each command,
11968 and tests the value when the command returns.
11969 Buffer modification stores t in this variable. */);
11970 Vdeactivate_mark
= Qnil
;
11971 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11973 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11974 doc
: /* Normal hook run before each command is executed.
11975 If an unhandled error happens in running this hook,
11976 the function in which the error occurred is unconditionally removed, since
11977 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11978 Vpre_command_hook
= Qnil
;
11980 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11981 doc
: /* Normal hook run after each command is executed.
11982 If an unhandled error happens in running this hook,
11983 the function in which the error occurred is unconditionally removed, since
11984 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11985 Vpost_command_hook
= Qnil
;
11988 DEFVAR_LISP ("echo-area-clear-hook", ...,
11989 doc
: /* Normal hook run when clearing the echo area. */);
11991 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11992 Fset (Qecho_area_clear_hook
, Qnil
);
11994 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11995 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11996 Vlucid_menu_bar_dirty_flag
= Qnil
;
11998 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11999 doc
: /* List of menu bar items to move to the end of the menu bar.
12000 The elements of the list are event types that may have menu bar bindings. */);
12001 Vmenu_bar_final_items
= Qnil
;
12003 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
12004 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
12005 This is used internally by graphical displays that do not render
12006 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
12007 Vtool_bar_separator_image_expression
= Qnil
;
12009 DEFVAR_KBOARD ("overriding-terminal-local-map",
12010 Voverriding_terminal_local_map
,
12011 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12012 If this variable is non-nil, it is used as a keymap instead of the
12013 buffer's local map, and the minor mode keymaps and text property keymaps.
12014 It also replaces `overriding-local-map'.
12016 This variable is intended to let commands such as `universal-argument'
12017 set up a different keymap for reading the next command.
12019 `overriding-terminal-local-map' has a separate binding for each
12021 See Info node `(elisp)Multiple Terminals'. */);
12023 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
12024 doc
: /* Keymap that overrides all other local keymaps.
12025 If this variable is non-nil, it is used as a keymap--replacing the
12026 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12027 Voverriding_local_map
= Qnil
;
12029 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
12030 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12031 Otherwise, the menu bar continues to reflect the buffer's local map
12032 and the minor mode maps regardless of `overriding-local-map'. */);
12033 Voverriding_local_map_menu_flag
= Qnil
;
12035 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12036 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12037 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12039 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12040 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12042 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12043 doc
: /* Alist of system-specific X windows key symbols.
12044 Each element should have the form (N . SYMBOL) where N is the
12045 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12046 and SYMBOL is its name.
12048 `system-key-alist' has a separate binding for each terminal device.
12049 See Info node `(elisp)Multiple Terminals'. */);
12051 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12052 doc
: /* Keymap that translates key sequences to key sequences during input.
12053 This is used mainly for mapping key sequences into some preferred
12054 key events (symbols).
12056 The `read-key-sequence' function replaces any subsequence bound by
12057 `local-function-key-map' with its binding. More precisely, when the
12058 active keymaps have no binding for the current key sequence but
12059 `local-function-key-map' binds a suffix of the sequence to a vector or
12060 string, `read-key-sequence' replaces the matching suffix with its
12061 binding, and continues with the new sequence.
12063 If the binding is a function, it is called with one argument (the prompt)
12064 and its return value (a key sequence) is used.
12066 The events that come from bindings in `local-function-key-map' are not
12067 themselves looked up in `local-function-key-map'.
12069 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12070 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12071 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12072 typing `ESC O P x' would return [f1 x].
12074 `local-function-key-map' has a separate binding for each terminal
12075 device. See Info node `(elisp)Multiple Terminals'. If you need to
12076 define a binding on all terminals, change `function-key-map'
12077 instead. Initially, `local-function-key-map' is an empty keymap that
12078 has `function-key-map' as its parent on all terminal devices. */);
12080 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12081 doc
: /* Keymap that decodes input escape sequences.
12082 This is used mainly for mapping ASCII function key sequences into
12083 real Emacs function key events (symbols).
12085 The `read-key-sequence' function replaces any subsequence bound by
12086 `input-decode-map' with its binding. Contrary to `function-key-map',
12087 this map applies its rebinding regardless of the presence of an ordinary
12088 binding. So it is more like `key-translation-map' except that it applies
12089 before `function-key-map' rather than after.
12091 If the binding is a function, it is called with one argument (the prompt)
12092 and its return value (a key sequence) is used.
12094 The events that come from bindings in `input-decode-map' are not
12095 themselves looked up in `input-decode-map'.
12097 This variable is keyboard-local. */);
12099 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12100 doc
: /* The parent keymap of all `local-function-key-map' instances.
12101 Function key definitions that apply to all terminal devices should go
12102 here. If a mapping is defined in both the current
12103 `local-function-key-map' binding and this variable, then the local
12104 definition will take precendence. */);
12105 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12107 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12108 doc
: /* Keymap of key translations that can override keymaps.
12109 This keymap works like `function-key-map', but comes after that,
12110 and its non-prefix bindings override ordinary bindings.
12111 Another difference is that it is global rather than keyboard-local. */);
12112 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12114 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12115 doc
: /* List of deferred actions to be performed at a later time.
12116 The precise format isn't relevant here; we just check whether it is nil. */);
12117 Vdeferred_action_list
= Qnil
;
12119 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12120 doc
: /* Function to call to handle deferred actions, after each command.
12121 This function is called with no arguments after each command
12122 whenever `deferred-action-list' is non-nil. */);
12123 Vdeferred_action_function
= Qnil
;
12125 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12126 doc
: /* List of warnings to be displayed as soon as possible.
12127 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12128 as per the args of `display-warning' (which see).
12129 If this variable is non-nil, `delayed-warnings-hook' will be run
12130 immediately after running `post-command-hook'. */);
12131 Vdelayed_warnings_list
= Qnil
;
12133 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12134 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12135 The value can be a length of time to show the message for.
12136 If the value is non-nil and not a number, we wait 2 seconds. */);
12137 Vsuggest_key_bindings
= Qt
;
12139 DEFVAR_LISP ("timer-list", Vtimer_list
,
12140 doc
: /* List of active absolute time timers in order of increasing time. */);
12141 Vtimer_list
= Qnil
;
12143 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12144 doc
: /* List of active idle-time timers in order of increasing time. */);
12145 Vtimer_idle_list
= Qnil
;
12147 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12148 doc
: /* If non-nil, the function that implements the current input method.
12149 It's called with one argument, a printing character that was just read.
12150 \(That means a character with code 040...0176.)
12151 Typically this function uses `read-event' to read additional events.
12152 When it does so, it should first bind `input-method-function' to nil
12153 so it will not be called recursively.
12155 The function should return a list of zero or more events
12156 to be used as input. If it wants to put back some events
12157 to be reconsidered, separately, by the input method,
12158 it can add them to the beginning of `unread-command-events'.
12160 The input method function can find in `input-method-previous-message'
12161 the previous echo area message.
12163 The input method function should refer to the variables
12164 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12165 for guidance on what to do. */);
12166 Vinput_method_function
= Qnil
;
12168 DEFVAR_LISP ("input-method-previous-message",
12169 Vinput_method_previous_message
,
12170 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12171 This variable exists because `read-event' clears the echo area
12172 before running the input method. It is nil if there was no message. */);
12173 Vinput_method_previous_message
= Qnil
;
12175 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12176 doc
: /* If non-nil, the function that implements the display of help.
12177 It's called with one argument, the help string to display. */);
12178 Vshow_help_function
= Qnil
;
12180 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12181 doc
: /* If non-nil, suppress point adjustment after executing a command.
12183 After a command is executed, if point is moved into a region that has
12184 special properties (e.g. composition, display), we adjust point to
12185 the boundary of the region. But, when a command sets this variable to
12186 non-nil, we suppress the point adjustment.
12188 This variable is set to nil before reading a command, and is checked
12189 just after executing the command. */);
12190 Vdisable_point_adjustment
= Qnil
;
12192 DEFVAR_LISP ("global-disable-point-adjustment",
12193 Vglobal_disable_point_adjustment
,
12194 doc
: /* *If non-nil, always suppress point adjustment.
12196 The default value is nil, in which case, point adjustment are
12197 suppressed only after special commands that set
12198 `disable-point-adjustment' (which see) to non-nil. */);
12199 Vglobal_disable_point_adjustment
= Qnil
;
12201 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12202 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12203 If the value is not a number, such messages don't time out. */);
12204 Vminibuffer_message_timeout
= make_number (2);
12206 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12207 doc
: /* If non-nil, any keyboard input throws to this symbol.
12208 The value of that variable is passed to `quit-flag' and later causes a
12209 peculiar kind of quitting. */);
12210 Vthrow_on_input
= Qnil
;
12212 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12213 doc
: /* If non-nil, function to output error messages.
12214 The arguments are the error data, a list of the form
12215 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12216 such as just as `condition-case' would bind its variable to,
12217 the context (a string which normally goes at the start of the message),
12218 and the Lisp function within which the error was signaled. */);
12219 Vcommand_error_function
= Qnil
;
12221 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12222 Venable_disabled_menus_and_buttons
,
12223 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12225 Help functions bind this to allow help on disabled menu items
12226 and tool-bar buttons. */);
12227 Venable_disabled_menus_and_buttons
= Qnil
;
12229 DEFVAR_LISP ("select-active-regions",
12230 Vselect_active_regions
,
12231 doc
: /* If non-nil, an active region automatically sets the primary selection.
12232 If the value is `only', only temporarily active regions (usually made
12233 by mouse-dragging or shift-selection) set the window selection.
12235 This takes effect only when Transient Mark mode is enabled. */);
12236 Vselect_active_regions
= Qt
;
12238 DEFVAR_LISP ("saved-region-selection",
12239 Vsaved_region_selection
,
12240 doc
: /* Contents of active region prior to buffer modification.
12241 If `select-active-regions' is non-nil, Emacs sets this to the
12242 text in the region before modifying the buffer. The next
12243 `deactivate-mark' call uses this to set the window selection. */);
12244 Vsaved_region_selection
= Qnil
;
12246 DEFVAR_LISP ("debug-on-event",
12248 doc
: /* Enter debugger on this event. When Emacs
12249 receives the special event specifed by this variable, it will try to
12250 break into the debugger as soon as possible instead of processing the
12251 event normally through `special-event-map'.
12253 Currently, the only supported values for this
12254 variable are `sigusr1' and `sigusr2'. */);
12255 Vdebug_on_event
= intern_c_string ("sigusr2");
12257 /* Create the initial keyboard. */
12258 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12259 init_kboard (initial_kboard
);
12260 /* Vwindow_system is left at t for now. */
12261 initial_kboard
->next_kboard
= all_kboards
;
12262 all_kboards
= initial_kboard
;
12266 keys_of_keyboard (void)
12268 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12269 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12270 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12271 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12272 initial_define_key (meta_map
, 'x', "execute-extended-command");
12274 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12275 "handle-delete-frame");
12276 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12277 "ns-put-working-text");
12278 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12279 "ns-unput-working-text");
12280 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12281 current-prefix-arg, as is done in `handle-switch-frame'.
12282 But `handle-switch-frame is not run from the special-map.
12283 Commands from that map are run in a special way that automatically
12284 preserves the prefix-arg. Restoring the prefix arg here is not just
12285 redundant but harmful:
12287 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12288 - after the first prompt, the exit-minibuffer-hook is run which may
12289 iconify a frame and thus push a `iconify-frame' event.
12290 - after running exit-minibuffer-hook, current-prefix-arg is
12291 restored to the non-nil value it had before the prompt.
12292 - we enter the second prompt.
12293 current-prefix-arg is non-nil, prefix-arg is nil.
12294 - before running the first real event, we run the special iconify-frame
12295 event, but we pass the `special' arg to execute-command so
12296 current-prefix-arg and prefix-arg are left untouched.
12297 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12298 - the next key event will have a spuriously non-nil current-prefix-arg. */
12299 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12301 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12303 /* Handling it at such a low-level causes read_key_sequence to get
12304 * confused because it doesn't realize that the current_buffer was
12305 * changed by read_char.
12307 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12308 * "handle-select-window"); */
12309 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12310 "handle-save-session");
12313 /* Define a special event which is raised for dbus callback
12315 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12316 "dbus-handle-event");
12319 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12323 /* Mark the pointers in the kboard objects.
12324 Called by the Fgarbage_collector. */
12326 mark_kboards (void)
12330 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12332 if (kb
->kbd_macro_buffer
)
12333 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12335 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12336 mark_object (KVAR (kb
, Vlast_command
));
12337 mark_object (KVAR (kb
, Vreal_last_command
));
12338 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12339 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12340 mark_object (KVAR (kb
, Vprefix_arg
));
12341 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12342 mark_object (KVAR (kb
, kbd_queue
));
12343 mark_object (KVAR (kb
, defining_kbd_macro
));
12344 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12345 mark_object (KVAR (kb
, Vsystem_key_alist
));
12346 mark_object (KVAR (kb
, system_key_syms
));
12347 mark_object (KVAR (kb
, Vwindow_system
));
12348 mark_object (KVAR (kb
, Vinput_decode_map
));
12349 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12350 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12351 mark_object (KVAR (kb
, echo_string
));
12354 struct input_event
*event
;
12355 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12357 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12358 event
= kbd_buffer
;
12359 if (event
->kind
!= SELECTION_REQUEST_EVENT
12360 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12362 mark_object (event
->x
);
12363 mark_object (event
->y
);
12365 mark_object (event
->frame_or_window
);
12366 mark_object (event
->arg
);