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
;
256 static Lisp_Object Qinput_method_function
;
258 static Lisp_Object Qdeactivate_mark
;
260 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
262 static Lisp_Object Qecho_area_clear_hook
;
264 /* Hooks to run before and after each command. */
265 static Lisp_Object Qpre_command_hook
;
266 static Lisp_Object Qpost_command_hook
;
268 static Lisp_Object Qdeferred_action_function
;
270 static Lisp_Object Qdelayed_warnings_hook
;
272 static Lisp_Object Qinput_method_exit_on_first_char
;
273 static Lisp_Object Qinput_method_use_echo_area
;
275 static Lisp_Object Qhelp_form_show
;
277 /* File in which we write all commands we read. */
278 static FILE *dribble
;
280 /* Nonzero if input is available. */
283 /* Circular buffer for pre-read keyboard input. */
285 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
287 /* Pointer to next available character in kbd_buffer.
288 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
289 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
290 next available char is in kbd_buffer[0]. */
291 static struct input_event
*kbd_fetch_ptr
;
293 /* Pointer to next place to store character in kbd_buffer. This
294 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
295 character should go in kbd_buffer[0]. */
296 static struct input_event
* volatile kbd_store_ptr
;
298 /* The above pair of variables forms a "queue empty" flag. When we
299 enqueue a non-hook event, we increment kbd_store_ptr. When we
300 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
301 there is input available if the two pointers are not equal.
303 Why not just have a flag set and cleared by the enqueuing and
304 dequeuing functions? Such a flag could be screwed up by interrupts
305 at inopportune times. */
307 /* Symbols to head events. */
308 static Lisp_Object Qmouse_movement
;
309 static Lisp_Object Qscroll_bar_movement
;
310 Lisp_Object Qswitch_frame
;
311 static Lisp_Object Qdelete_frame
;
312 static Lisp_Object Qiconify_frame
;
313 static Lisp_Object Qmake_frame_visible
;
314 static Lisp_Object Qselect_window
;
315 Lisp_Object Qhelp_echo
;
317 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
318 static Lisp_Object Qmouse_fixup_help_message
;
321 /* Symbols to denote kinds of events. */
322 static Lisp_Object Qfunction_key
;
323 Lisp_Object Qmouse_click
;
324 #if defined (WINDOWSNT)
325 Lisp_Object Qlanguage_change
;
327 static Lisp_Object Qdrag_n_drop
;
328 static Lisp_Object Qsave_session
;
330 static Lisp_Object Qdbus_event
;
332 static Lisp_Object Qconfig_changed_event
;
334 /* Lisp_Object Qmouse_movement; - also an event header */
336 /* Properties of event headers. */
337 Lisp_Object Qevent_kind
;
338 static Lisp_Object Qevent_symbol_elements
;
340 /* menu and tool bar item parts */
341 static Lisp_Object Qmenu_enable
;
342 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
343 Lisp_Object QCfilter
;
345 /* Non-nil disable property on a command means
346 do not execute it; call disabled-command-function's value instead. */
347 Lisp_Object QCtoggle
, QCradio
;
348 static Lisp_Object QCbutton
, QClabel
;
350 static Lisp_Object QCvert_only
;
352 /* An event header symbol HEAD may have a property named
353 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
354 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
355 mask of modifiers applied to it. If present, this is used to help
356 speed up parse_modifiers. */
357 Lisp_Object Qevent_symbol_element_mask
;
359 /* An unmodified event header BASE may have a property named
360 Qmodifier_cache, which is an alist mapping modifier masks onto
361 modified versions of BASE. If present, this helps speed up
363 static Lisp_Object Qmodifier_cache
;
365 /* Symbols to use for parts of windows. */
366 Lisp_Object Qmode_line
;
367 Lisp_Object Qvertical_line
;
368 static Lisp_Object Qvertical_scroll_bar
;
369 Lisp_Object Qmenu_bar
;
371 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
372 static Lisp_Object
command_loop (void);
373 static Lisp_Object Qextended_command_history
;
374 EMACS_TIME
timer_check (void);
376 static void record_menu_key (Lisp_Object c
);
377 static void echo_now (void);
378 static ptrdiff_t echo_length (void);
380 static Lisp_Object Qpolling_period
;
382 /* Incremented whenever a timer is run. */
385 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
387 EMACS_TIME
*input_available_clear_time
;
389 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
390 Default is 1 if INTERRUPT_INPUT is defined. */
393 /* Nonzero while interrupts are temporarily deferred during redisplay. */
394 int interrupts_deferred
;
396 /* Allow m- file to inhibit use of FIONREAD. */
397 #ifdef BROKEN_FIONREAD
401 /* We are unable to use interrupts if FIONREAD is not available,
402 so flush SIGIO so we won't try. */
403 #if !defined (FIONREAD)
409 /* If we support a window system, turn on the code to poll periodically
410 to detect C-g. It isn't actually used when doing interrupt input. */
411 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
412 #define POLL_FOR_INPUT
415 /* The time when Emacs started being idle. */
417 static EMACS_TIME timer_idleness_start_time
;
419 /* After Emacs stops being idle, this saves the last value
420 of timer_idleness_start_time from when it was idle. */
422 static EMACS_TIME timer_last_idleness_start_time
;
425 /* Global variable declarations. */
427 /* Flags for readable_events. */
428 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
429 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
430 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
432 /* Function for init_keyboard to call with no args (if nonzero). */
433 static void (*keyboard_init_hook
) (void);
435 static int read_avail_input (int);
436 static void get_input_pending (int *, int);
437 static int readable_events (int);
438 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
440 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
442 static Lisp_Object
make_lispy_event (struct input_event
*);
443 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
444 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
445 enum scroll_bar_part
,
446 Lisp_Object
, Lisp_Object
,
449 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
450 Lisp_Object
, const char *const *,
451 Lisp_Object
*, ptrdiff_t);
452 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
453 static int help_char_p (Lisp_Object
);
454 static void save_getcjmp (jmp_buf);
455 static void restore_getcjmp (jmp_buf);
456 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
457 static void clear_event (struct input_event
*);
458 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
459 static void interrupt_signal (int signalnum
);
461 static void input_available_signal (int signo
);
463 static Lisp_Object (Fcommand_execute
) (Lisp_Object
, Lisp_Object
, Lisp_Object
,
465 static void handle_interrupt (void);
466 static void quit_throw_to_read_char (void) NO_RETURN
;
467 static void timer_start_idle (void);
468 static void timer_stop_idle (void);
469 static void timer_resume_idle (void);
470 static void handle_user_signal (int);
471 static char *find_user_signal_name (int);
472 static int store_user_signal_events (void);
475 /* Add C to the echo string, if echoing is going on.
476 C can be a character, which is printed prettily ("M-C-x" and all that
477 jazz), or a symbol, whose name is printed. */
480 echo_char (Lisp_Object c
)
482 if (current_kboard
->immediate_echo
)
484 int size
= KEY_DESCRIPTION_SIZE
+ 100;
485 char *buffer
= (char *) alloca (size
);
487 Lisp_Object echo_string
;
489 echo_string
= KVAR (current_kboard
, echo_string
);
491 /* If someone has passed us a composite event, use its head symbol. */
496 ptr
= push_key_description (XINT (c
), ptr
, 1);
498 else if (SYMBOLP (c
))
500 Lisp_Object name
= SYMBOL_NAME (c
);
501 int nbytes
= SBYTES (name
);
503 if (size
- (ptr
- buffer
) < nbytes
)
505 int offset
= ptr
- buffer
;
506 size
= max (2 * size
, size
+ nbytes
);
507 buffer
= (char *) alloca (size
);
508 ptr
= buffer
+ offset
;
511 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
512 STRING_MULTIBYTE (name
), 1);
515 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
518 const char *text
= " (Type ? for further options)";
519 int len
= strlen (text
);
521 if (size
- (ptr
- buffer
) < len
)
523 int offset
= ptr
- buffer
;
525 buffer
= (char *) alloca (size
);
526 ptr
= buffer
+ offset
;
529 memcpy (ptr
, text
, len
);
533 /* Replace a dash from echo_dash with a space, otherwise
534 add a space at the end as a separator between keys. */
535 if (STRINGP (echo_string
)
536 && SCHARS (echo_string
) > 1)
538 Lisp_Object last_char
, prev_char
, idx
;
540 idx
= make_number (SCHARS (echo_string
) - 2);
541 prev_char
= Faref (echo_string
, idx
);
543 idx
= make_number (SCHARS (echo_string
) - 1);
544 last_char
= Faref (echo_string
, idx
);
546 /* We test PREV_CHAR to make sure this isn't the echoing
548 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
549 Faset (echo_string
, idx
, make_number (' '));
551 echo_string
= concat2 (echo_string
, build_string (" "));
553 else if (STRINGP (echo_string
))
554 echo_string
= concat2 (echo_string
, build_string (" "));
556 KVAR (current_kboard
, echo_string
)
557 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
563 /* Temporarily add a dash to the end of the echo string if it's not
564 empty, so that it serves as a mini-prompt for the very next character. */
569 /* Do nothing if not echoing at all. */
570 if (NILP (KVAR (current_kboard
, echo_string
)))
573 if (this_command_key_count
== 0)
576 if (!current_kboard
->immediate_echo
577 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
580 /* Do nothing if we just printed a prompt. */
581 if (current_kboard
->echo_after_prompt
582 == SCHARS (KVAR (current_kboard
, echo_string
)))
585 /* Do nothing if we have already put a dash at the end. */
586 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
588 Lisp_Object last_char
, prev_char
, idx
;
590 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
591 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
593 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
594 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
596 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
600 /* Put a dash at the end of the buffer temporarily,
601 but make it go away when the next character is added. */
602 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
607 /* Display the current echo string, and begin echoing if not already
613 if (!current_kboard
->immediate_echo
)
616 current_kboard
->immediate_echo
= 1;
618 for (i
= 0; i
< this_command_key_count
; i
++)
622 /* Set before_command_echo_length to the value that would
623 have been saved before the start of this subcommand in
624 command_loop_1, if we had already been echoing then. */
625 if (i
== this_single_command_key_start
)
626 before_command_echo_length
= echo_length ();
628 c
= XVECTOR (this_command_keys
)->contents
[i
];
629 if (! (EVENT_HAS_PARAMETERS (c
)
630 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
634 /* Set before_command_echo_length to the value that would
635 have been saved before the start of this subcommand in
636 command_loop_1, if we had already been echoing then. */
637 if (this_command_key_count
== this_single_command_key_start
)
638 before_command_echo_length
= echo_length ();
640 /* Put a dash at the end to invite the user to type more. */
645 message3_nolog (KVAR (current_kboard
, echo_string
),
646 SBYTES (KVAR (current_kboard
, echo_string
)),
647 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
650 /* Record in what buffer we echoed, and from which kboard. */
651 echo_message_buffer
= echo_area_buffer
[0];
652 echo_kboard
= current_kboard
;
654 if (waiting_for_input
&& !NILP (Vquit_flag
))
655 quit_throw_to_read_char ();
658 /* Turn off echoing, for the start of a new command. */
661 cancel_echoing (void)
663 current_kboard
->immediate_echo
= 0;
664 current_kboard
->echo_after_prompt
= -1;
665 KVAR (current_kboard
, echo_string
) = Qnil
;
666 ok_to_echo_at_next_pause
= NULL
;
668 echo_message_buffer
= Qnil
;
671 /* Return the length of the current echo string. */
676 return (STRINGP (KVAR (current_kboard
, echo_string
))
677 ? SCHARS (KVAR (current_kboard
, echo_string
))
681 /* Truncate the current echo message to its first LEN chars.
682 This and echo_char get used by read_key_sequence when the user
683 switches frames while entering a key sequence. */
686 echo_truncate (ptrdiff_t nchars
)
688 if (STRINGP (KVAR (current_kboard
, echo_string
)))
689 KVAR (current_kboard
, echo_string
)
690 = Fsubstring (KVAR (current_kboard
, echo_string
),
691 make_number (0), make_number (nchars
));
692 truncate_echo_area (nchars
);
696 /* Functions for manipulating this_command_keys. */
698 add_command_key (Lisp_Object key
)
700 #if 0 /* Not needed after we made Freset_this_command_lengths
701 do the job immediately. */
702 /* If reset-this-command-length was called recently, obey it now.
703 See the doc string of that function for an explanation of why. */
704 if (before_command_restore_flag
)
706 this_command_key_count
= before_command_key_count_1
;
707 if (this_command_key_count
< this_single_command_key_start
)
708 this_single_command_key_start
= this_command_key_count
;
709 echo_truncate (before_command_echo_length_1
);
710 before_command_restore_flag
= 0;
714 if (this_command_key_count
>= ASIZE (this_command_keys
))
715 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
717 ASET (this_command_keys
, this_command_key_count
, key
);
718 ++this_command_key_count
;
723 recursive_edit_1 (void)
725 ptrdiff_t count
= SPECPDL_INDEX ();
728 if (command_loop_level
> 0)
730 specbind (Qstandard_output
, Qt
);
731 specbind (Qstandard_input
, Qt
);
734 #ifdef HAVE_WINDOW_SYSTEM
735 /* The command loop has started an hourglass timer, so we have to
736 cancel it here, otherwise it will fire because the recursive edit
737 can take some time. Do not check for display_hourglass_p here,
738 because it could already be nil. */
742 /* This function may have been called from a debugger called from
743 within redisplay, for instance by Edebugging a function called
744 from fontification-functions. We want to allow redisplay in
745 the debugging session.
747 The recursive edit is left with a `(throw exit ...)'. The `exit'
748 tag is not caught anywhere in redisplay, i.e. when we leave the
749 recursive edit, the original redisplay leading to the recursive
750 edit will be unwound. The outcome should therefore be safe. */
751 specbind (Qinhibit_redisplay
, Qnil
);
754 val
= command_loop ();
756 Fsignal (Qquit
, Qnil
);
757 /* Handle throw from read_minibuf when using minibuffer
758 while it's active but we're in another window. */
760 xsignal1 (Qerror
, val
);
762 return unbind_to (count
, Qnil
);
765 /* When an auto-save happens, record the "time", and don't do again soon. */
768 record_auto_save (void)
770 last_auto_save
= num_nonmacro_input_events
;
773 /* Make an auto save happen as soon as possible at command level. */
777 force_auto_save_soon (void)
779 last_auto_save
= - auto_save_interval
- 1;
781 record_asynch_buffer_change ();
785 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
786 doc
: /* Invoke the editor command loop recursively.
787 To get out of the recursive edit, a command can do `(throw 'exit nil)';
788 that tells this function to return.
789 Alternatively, `(throw 'exit t)' makes this function signal an error.
790 This function is called by the editor initialization to begin editing. */)
793 ptrdiff_t count
= SPECPDL_INDEX ();
796 /* If we enter while input is blocked, don't lock up here.
797 This may happen through the debugger during redisplay. */
801 command_loop_level
++;
802 update_mode_lines
= 1;
804 if (command_loop_level
805 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
806 buffer
= Fcurrent_buffer ();
810 /* If we leave recursive_edit_1 below with a `throw' for instance,
811 like it is done in the splash screen display, we have to
812 make sure that we restore single_kboard as command_loop_1
813 would have done if it were left normally. */
814 if (command_loop_level
> 0)
815 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
816 record_unwind_protect (recursive_edit_unwind
, buffer
);
819 return unbind_to (count
, Qnil
);
823 recursive_edit_unwind (Lisp_Object buffer
)
825 if (BUFFERP (buffer
))
826 Fset_buffer (buffer
);
828 command_loop_level
--;
829 update_mode_lines
= 1;
834 #if 0 /* These two functions are now replaced with
835 temporarily_switch_to_single_kboard. */
839 #if 0 /* Theory: if there's anything in Vunread_command_events,
840 it will right away be read by read_key_sequence,
841 and then if we do switch KBOARDS, it will go into the side
842 queue then. So we don't need to do anything special here -- rms. */
843 if (CONSP (Vunread_command_events
))
845 current_kboard
->kbd_queue
846 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
847 current_kboard
->kbd_queue_has_data
= 1;
849 Vunread_command_events
= Qnil
;
854 /* Switch to the single-kboard state, making current_kboard
855 the only KBOARD from which further input is accepted. */
858 single_kboard_state ()
864 /* If we're in single_kboard state for kboard KBOARD,
868 not_single_kboard_state (KBOARD
*kboard
)
870 if (kboard
== current_kboard
)
874 /* Maintain a stack of kboards, so other parts of Emacs
875 can switch temporarily to the kboard of a given frame
876 and then revert to the previous status. */
881 struct kboard_stack
*next
;
884 static struct kboard_stack
*kboard_stack
;
887 push_kboard (struct kboard
*k
)
889 struct kboard_stack
*p
890 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
892 p
->next
= kboard_stack
;
893 p
->kboard
= current_kboard
;
903 struct kboard_stack
*p
= kboard_stack
;
905 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
907 if (t
->kboard
== p
->kboard
)
909 current_kboard
= p
->kboard
;
916 /* The terminal we remembered has been deleted. */
917 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
920 kboard_stack
= p
->next
;
924 /* Switch to single_kboard mode, making current_kboard the only KBOARD
925 from which further input is accepted. If F is non-nil, set its
926 KBOARD as the current keyboard.
928 This function uses record_unwind_protect to return to the previous
931 If Emacs is already in single_kboard mode, and F's keyboard is
932 locked, then this function will throw an errow. */
935 temporarily_switch_to_single_kboard (struct frame
*f
)
937 int was_locked
= single_kboard
;
940 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
941 /* We can not switch keyboards while in single_kboard mode.
942 In rare cases, Lisp code may call `recursive-edit' (or
943 `read-minibuffer' or `y-or-n-p') after it switched to a
944 locked frame. For example, this is likely to happen
945 when server.el connects to a new terminal while Emacs is in
946 single_kboard mode. It is best to throw an error instead
947 of presenting the user with a frozen screen. */
948 error ("Terminal %d is locked, cannot read from it",
949 FRAME_TERMINAL (f
)->id
);
951 /* This call is unnecessary, but helps
952 `restore_kboard_configuration' discover if somebody changed
953 `current_kboard' behind our back. */
954 push_kboard (current_kboard
);
957 current_kboard
= FRAME_KBOARD (f
);
959 record_unwind_protect (restore_kboard_configuration
,
960 (was_locked
? Qt
: Qnil
));
963 #if 0 /* This function is not needed anymore. */
965 record_single_kboard_state ()
968 push_kboard (current_kboard
);
969 record_unwind_protect (restore_kboard_configuration
,
970 (single_kboard
? Qt
: Qnil
));
975 restore_kboard_configuration (Lisp_Object was_locked
)
977 if (NILP (was_locked
))
981 struct kboard
*prev
= current_kboard
;
984 /* The pop should not change the kboard. */
985 if (single_kboard
&& current_kboard
!= prev
)
992 /* Handle errors that are not handled at inner levels
993 by printing an error message and returning to the editor command loop. */
996 cmd_error (Lisp_Object data
)
998 Lisp_Object old_level
, old_length
;
999 char macroerror
[sizeof "After..kbd macro iterations: "
1000 + INT_STRLEN_BOUND (EMACS_INT
)];
1002 #ifdef HAVE_WINDOW_SYSTEM
1003 if (display_hourglass_p
)
1004 cancel_hourglass ();
1007 if (!NILP (executing_kbd_macro
))
1009 if (executing_kbd_macro_iterations
== 1)
1010 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1012 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1013 executing_kbd_macro_iterations
);
1018 Vstandard_output
= Qt
;
1019 Vstandard_input
= Qt
;
1020 Vexecuting_kbd_macro
= Qnil
;
1021 executing_kbd_macro
= Qnil
;
1022 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1023 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1026 /* Avoid unquittable loop if data contains a circular list. */
1027 old_level
= Vprint_level
;
1028 old_length
= Vprint_length
;
1029 XSETFASTINT (Vprint_level
, 10);
1030 XSETFASTINT (Vprint_length
, 10);
1031 cmd_error_internal (data
, macroerror
);
1032 Vprint_level
= old_level
;
1033 Vprint_length
= old_length
;
1037 Vinhibit_quit
= Qnil
;
1038 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1039 if (command_loop_level
== 0 && minibuf_level
== 0)
1040 any_kboard_state ();
1043 return make_number (0);
1046 /* Take actions on handling an error. DATA is the data that describes
1049 CONTEXT is a C-string containing ASCII characters only which
1050 describes the context in which the error happened. If we need to
1051 generalize CONTEXT to allow multibyte characters, make it a Lisp
1055 cmd_error_internal (Lisp_Object data
, const char *context
)
1057 struct frame
*sf
= SELECTED_FRAME ();
1059 /* The immediate context is not interesting for Quits,
1060 since they are asyncronous. */
1061 if (EQ (XCAR (data
), Qquit
))
1062 Vsignaling_function
= Qnil
;
1067 /* Use user's specified output function if any. */
1068 if (!NILP (Vcommand_error_function
))
1069 call3 (Vcommand_error_function
, data
,
1070 context
? build_string (context
) : empty_unibyte_string
,
1071 Vsignaling_function
);
1072 /* If the window system or terminal frame hasn't been initialized
1073 yet, or we're not interactive, write the message to stderr and exit. */
1074 else if (!sf
->glyphs_initialized_p
1075 /* The initial frame is a special non-displaying frame. It
1076 will be current in daemon mode when there are no frames
1077 to display, and in non-daemon mode before the real frame
1078 has finished initializing. If an error is thrown in the
1079 latter case while creating the frame, then the frame
1080 will never be displayed, so the safest thing to do is
1081 write to stderr and quit. In daemon mode, there are
1082 many other potential errors that do not prevent frames
1083 from being created, so continuing as normal is better in
1085 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1088 print_error_message (data
, Qexternal_debugging_output
,
1089 context
, Vsignaling_function
);
1090 Fterpri (Qexternal_debugging_output
);
1091 Fkill_emacs (make_number (-1));
1095 clear_message (1, 0);
1097 message_log_maybe_newline ();
1100 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1103 Vsignaling_function
= Qnil
;
1106 Lisp_Object
command_loop_1 (void);
1107 static Lisp_Object
command_loop_2 (Lisp_Object
);
1108 static Lisp_Object
top_level_1 (Lisp_Object
);
1110 /* Entry to editor-command-loop.
1111 This level has the catches for exiting/returning to editor command loop.
1112 It returns nil to exit recursive edit, t to abort it. */
1117 if (command_loop_level
> 0 || minibuf_level
> 0)
1120 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1121 executing_kbd_macro
= Qnil
;
1127 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1128 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1129 /* Reset single_kboard in case top-level set it while
1130 evaluating an -f option, or we are stuck there for some
1132 any_kboard_state ();
1134 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1135 executing_kbd_macro
= Qnil
;
1137 /* End of file in -batch run causes exit here. */
1143 /* Here we catch errors in execution of commands within the
1144 editing loop, and reenter the editing loop.
1145 When there is an error, cmd_error runs and returns a non-nil
1146 value to us. A value of nil means that command_loop_1 itself
1147 returned due to end of file (or end of kbd macro). */
1150 command_loop_2 (Lisp_Object ignore
)
1152 register Lisp_Object val
;
1155 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1156 while (!NILP (val
));
1164 return Feval (Vtop_level
, Qnil
);
1168 top_level_1 (Lisp_Object ignore
)
1170 /* On entry to the outer level, run the startup file */
1171 if (!NILP (Vtop_level
))
1172 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1173 else if (!NILP (Vpurify_flag
))
1174 message ("Bare impure Emacs (standard Lisp code not loaded)");
1176 message ("Bare Emacs (standard Lisp code not loaded)");
1180 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1181 doc
: /* Exit all recursive editing levels.
1182 This also exits all active minibuffers. */)
1185 #ifdef HAVE_WINDOW_SYSTEM
1186 if (display_hourglass_p
)
1187 cancel_hourglass ();
1190 /* Unblock input if we enter with input blocked. This may happen if
1191 redisplay traps e.g. during tool-bar update with input blocked. */
1192 while (INPUT_BLOCKED_P
)
1195 Fthrow (Qtop_level
, Qnil
);
1198 static Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1199 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1200 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1203 if (command_loop_level
> 0 || minibuf_level
> 0)
1204 Fthrow (Qexit
, Qnil
);
1206 error ("No recursive edit is in progress");
1209 static Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1210 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1211 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1214 if (command_loop_level
> 0 || minibuf_level
> 0)
1217 error ("No recursive edit is in progress");
1220 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1222 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1223 of this function. */
1226 tracking_off (Lisp_Object old_value
)
1228 do_mouse_tracking
= old_value
;
1229 if (NILP (old_value
))
1231 /* Redisplay may have been preempted because there was input
1232 available, and it assumes it will be called again after the
1233 input has been processed. If the only input available was
1234 the sort that we have just disabled, then we need to call
1236 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1238 redisplay_preserve_echo_area (6);
1239 get_input_pending (&input_pending
,
1240 READABLE_EVENTS_DO_TIMERS_NOW
);
1246 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1247 doc
: /* Evaluate BODY with mouse movement events enabled.
1248 Within a `track-mouse' form, mouse motion generates input events that
1249 you can read with `read-event'.
1250 Normally, mouse motion is ignored.
1251 usage: (track-mouse BODY...) */)
1254 ptrdiff_t count
= SPECPDL_INDEX ();
1257 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1259 do_mouse_tracking
= Qt
;
1261 val
= Fprogn (args
);
1262 return unbind_to (count
, val
);
1265 /* If mouse has moved on some frame, return one of those frames.
1269 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1270 after resizing the tool-bar window. */
1272 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1275 int ignore_mouse_drag_p
;
1278 some_mouse_moved (void)
1280 Lisp_Object tail
, frame
;
1282 if (ignore_mouse_drag_p
)
1284 /* ignore_mouse_drag_p = 0; */
1288 FOR_EACH_FRAME (tail
, frame
)
1290 if (XFRAME (frame
)->mouse_moved
)
1291 return XFRAME (frame
);
1297 #endif /* HAVE_MOUSE || HAVE_GPM */
1299 /* This is the actual command reading loop,
1300 sans error-handling encapsulation. */
1302 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1304 void safe_run_hooks (Lisp_Object
);
1305 static void adjust_point_for_property (ptrdiff_t, int);
1307 /* Cancel hourglass from protect_unwind.
1309 #ifdef HAVE_WINDOW_SYSTEM
1311 cancel_hourglass_unwind (Lisp_Object arg
)
1313 cancel_hourglass ();
1318 /* FIXME: This is wrong rather than test window-system, we should call
1319 a new set-selection, which will then dispatch to x-set-selection, or
1320 tty-set-selection, or w32-set-selection, ... */
1321 EXFUN (Fwindow_system
, 1);
1324 command_loop_1 (void)
1327 Lisp_Object keybuf
[30];
1329 EMACS_INT prev_modiff
= 0;
1330 struct buffer
*prev_buffer
= NULL
;
1331 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1332 int was_locked
= single_kboard
;
1334 int already_adjusted
= 0;
1336 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1337 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1338 Vdeactivate_mark
= Qnil
;
1339 waiting_for_input
= 0;
1342 this_command_key_count
= 0;
1343 this_command_key_count_reset
= 0;
1344 this_single_command_key_start
= 0;
1346 if (NILP (Vmemory_full
))
1348 /* Make sure this hook runs after commands that get errors and
1349 throw to top level. */
1350 /* Note that the value cell will never directly contain nil
1351 if the symbol is a local variable. */
1352 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1353 safe_run_hooks (Qpost_command_hook
);
1355 /* If displaying a message, resize the echo area window to fit
1356 that message's size exactly. */
1357 if (!NILP (echo_area_buffer
[0]))
1358 resize_echo_area_exactly ();
1360 /* If there are warnings waiting, process them. */
1361 if (!NILP (Vdelayed_warnings_list
))
1362 safe_run_hooks (Qdelayed_warnings_hook
);
1364 if (!NILP (Vdeferred_action_list
))
1365 safe_run_hooks (Qdeferred_action_function
);
1368 /* Do this after running Vpost_command_hook, for consistency. */
1369 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1370 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1371 if (!CONSP (last_command_event
))
1372 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1376 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1379 /* Make sure the current window's buffer is selected. */
1380 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1381 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1383 /* Display any malloc warning that just came out. Use while because
1384 displaying one warning can cause another. */
1386 while (pending_malloc_warning
)
1387 display_malloc_warning ();
1389 Vdeactivate_mark
= Qnil
;
1391 /* If minibuffer on and echo area in use,
1392 wait a short time and redraw minibuffer. */
1395 && !NILP (echo_area_buffer
[0])
1396 && EQ (minibuf_window
, echo_area_window
)
1397 && NUMBERP (Vminibuffer_message_timeout
))
1399 /* Bind inhibit-quit to t so that C-g gets read in
1400 rather than quitting back to the minibuffer. */
1401 ptrdiff_t count
= SPECPDL_INDEX ();
1402 specbind (Qinhibit_quit
, Qt
);
1404 sit_for (Vminibuffer_message_timeout
, 0, 2);
1406 /* Clear the echo area. */
1408 safe_run_hooks (Qecho_area_clear_hook
);
1410 unbind_to (count
, Qnil
);
1412 /* If a C-g came in before, treat it as input now. */
1413 if (!NILP (Vquit_flag
))
1416 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1421 /* Select the frame that the last event came from. Usually,
1422 switch-frame events will take care of this, but if some lisp
1423 code swallows a switch-frame event, we'll fix things up here.
1424 Is this a good idea? */
1425 if (FRAMEP (internal_last_event_frame
)
1426 && !EQ (internal_last_event_frame
, selected_frame
))
1427 Fselect_frame (internal_last_event_frame
, Qnil
);
1429 /* If it has changed current-menubar from previous value,
1430 really recompute the menubar from the value. */
1431 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1432 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1433 call0 (Qrecompute_lucid_menubar
);
1435 before_command_key_count
= this_command_key_count
;
1436 before_command_echo_length
= echo_length ();
1438 Vthis_command
= Qnil
;
1439 real_this_command
= Qnil
;
1440 Vthis_original_command
= Qnil
;
1441 Vthis_command_keys_shift_translated
= Qnil
;
1443 /* Read next key sequence; i gets its length. */
1444 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1447 /* A filter may have run while we were reading the input. */
1448 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1450 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1451 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1455 /* Now we have read a key sequence of length I,
1456 or else I is 0 and we found end of file. */
1458 if (i
== 0) /* End of file -- happens only in */
1459 return Qnil
; /* a kbd macro, at the end. */
1460 /* -1 means read_key_sequence got a menu that was rejected.
1461 Just loop around and read another command. */
1465 this_command_key_count
= 0;
1466 this_command_key_count_reset
= 0;
1467 this_single_command_key_start
= 0;
1471 last_command_event
= keybuf
[i
- 1];
1473 /* If the previous command tried to force a specific window-start,
1474 forget about that, in case this command moves point far away
1475 from that position. But also throw away beg_unchanged and
1476 end_unchanged information in that case, so that redisplay will
1477 update the whole window properly. */
1478 if (!NILP (XWINDOW (selected_window
)->force_start
))
1481 XWINDOW (selected_window
)->force_start
= Qnil
;
1482 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1483 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1486 cmd
= read_key_sequence_cmd
;
1487 if (!NILP (Vexecuting_kbd_macro
))
1489 if (!NILP (Vquit_flag
))
1491 Vexecuting_kbd_macro
= Qt
;
1492 QUIT
; /* Make some noise. */
1493 /* Will return since macro now empty. */
1497 /* Do redisplay processing after this command except in special
1498 cases identified below. */
1499 prev_buffer
= current_buffer
;
1500 prev_modiff
= MODIFF
;
1501 last_point_position
= PT
;
1502 last_point_position_window
= selected_window
;
1503 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1505 /* By default, we adjust point to a boundary of a region that
1506 has such a property that should be treated intangible
1507 (e.g. composition, display). But, some commands will set
1508 this variable differently. */
1509 Vdisable_point_adjustment
= Qnil
;
1511 /* Process filters and timers may have messed with deactivate-mark.
1512 reset it before we execute the command. */
1513 Vdeactivate_mark
= Qnil
;
1515 /* Remap command through active keymaps */
1516 Vthis_original_command
= cmd
;
1520 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1524 /* Execute the command. */
1526 Vthis_command
= cmd
;
1527 real_this_command
= cmd
;
1528 safe_run_hooks (Qpre_command_hook
);
1530 already_adjusted
= 0;
1532 if (NILP (Vthis_command
))
1534 /* nil means key is undefined. */
1535 Lisp_Object keys
= Fvector (i
, keybuf
);
1536 keys
= Fkey_description (keys
, Qnil
);
1538 message_with_string ("%s is undefined", keys
, 0);
1539 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1540 update_mode_lines
= 1;
1541 /* If this is a down-mouse event, don't reset prefix-arg;
1542 pass it to the command run by the up event. */
1543 if (EVENT_HAS_PARAMETERS (last_command_event
))
1545 Lisp_Object breakdown
1546 = parse_modifiers (EVENT_HEAD (last_command_event
));
1547 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1548 if (!(modifiers
& down_modifier
))
1549 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1552 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1556 /* Here for a command that isn't executed directly */
1558 #ifdef HAVE_WINDOW_SYSTEM
1559 ptrdiff_t scount
= SPECPDL_INDEX ();
1561 if (display_hourglass_p
1562 && NILP (Vexecuting_kbd_macro
))
1564 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1569 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1571 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1573 #ifdef HAVE_WINDOW_SYSTEM
1574 /* Do not check display_hourglass_p here, because
1575 Fcommand_execute could change it, but we should cancel
1576 hourglass cursor anyway.
1577 But don't cancel the hourglass within a macro
1578 just because a command in the macro finishes. */
1579 if (NILP (Vexecuting_kbd_macro
))
1580 unbind_to (scount
, Qnil
);
1583 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1585 safe_run_hooks (Qpost_command_hook
);
1587 /* If displaying a message, resize the echo area window to fit
1588 that message's size exactly. */
1589 if (!NILP (echo_area_buffer
[0]))
1590 resize_echo_area_exactly ();
1592 /* If there are warnings waiting, process them. */
1593 if (!NILP (Vdelayed_warnings_list
))
1594 safe_run_hooks (Qdelayed_warnings_hook
);
1596 safe_run_hooks (Qdeferred_action_function
);
1598 /* If there is a prefix argument,
1599 1) We don't want Vlast_command to be ``universal-argument''
1600 (that would be dumb), so don't set Vlast_command,
1601 2) we want to leave echoing on so that the prefix will be
1602 echoed as part of this key sequence, so don't call
1604 3) we want to leave this_command_key_count non-zero, so that
1605 read_char will realize that it is re-reading a character, and
1606 not echo it a second time.
1608 If the command didn't actually create a prefix arg,
1609 but is merely a frame event that is transparent to prefix args,
1610 then the above doesn't apply. */
1611 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1613 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1614 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1615 if (!CONSP (last_command_event
))
1616 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1618 this_command_key_count
= 0;
1619 this_command_key_count_reset
= 0;
1620 this_single_command_key_start
= 0;
1623 if (!NILP (BVAR (current_buffer
, mark_active
))
1624 && !NILP (Vrun_hooks
))
1626 /* In Emacs 22, setting transient-mark-mode to `only' was a
1627 way of turning it on for just one command. This usage is
1628 obsolete, but support it anyway. */
1629 if (EQ (Vtransient_mark_mode
, Qidentity
))
1630 Vtransient_mark_mode
= Qnil
;
1631 else if (EQ (Vtransient_mark_mode
, Qonly
))
1632 Vtransient_mark_mode
= Qidentity
;
1634 if (!NILP (Vdeactivate_mark
))
1635 /* If `select-active-regions' is non-nil, this call to
1636 `deactivate-mark' also sets the PRIMARY selection. */
1637 call0 (Qdeactivate_mark
);
1640 /* Even if not deactivating the mark, set PRIMARY if
1641 `select-active-regions' is non-nil. */
1642 if (!NILP (Fwindow_system (Qnil
))
1643 /* Even if mark_active is non-nil, the actual buffer
1644 marker may not have been set yet (Bug#7044). */
1645 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1646 && (EQ (Vselect_active_regions
, Qonly
)
1647 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1648 : (!NILP (Vselect_active_regions
)
1649 && !NILP (Vtransient_mark_mode
)))
1650 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1653 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1656 call2 (Qx_set_selection
, QPRIMARY
,
1657 make_buffer_string (beg
, end
, 0));
1659 call2 (Qx_set_selection
, QPRIMARY
,
1660 make_buffer_string (end
, beg
, 0));
1661 /* Don't set empty selections. */
1664 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1666 Lisp_Object hook
= intern ("activate-mark-hook");
1667 Frun_hooks (1, &hook
);
1671 Vsaved_region_selection
= Qnil
;
1676 if (current_buffer
== prev_buffer
1677 && last_point_position
!= PT
1678 && NILP (Vdisable_point_adjustment
)
1679 && NILP (Vglobal_disable_point_adjustment
))
1681 if (last_point_position
> BEGV
1682 && last_point_position
< ZV
1683 && (composition_adjust_point (last_point_position
,
1684 last_point_position
)
1685 != last_point_position
))
1686 /* The last point was temporarily set within a grapheme
1687 cluster to prevent automatic composition. To recover
1688 the automatic composition, we must update the
1690 windows_or_buffers_changed
++;
1691 if (!already_adjusted
)
1692 adjust_point_for_property (last_point_position
,
1693 MODIFF
!= prev_modiff
);
1696 /* Install chars successfully executed in kbd macro. */
1698 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1699 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1700 finalize_kbd_macro_chars ();
1701 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1703 any_kboard_state ();
1708 /* Adjust point to a boundary of a region that has such a property
1709 that should be treated intangible. For the moment, we check
1710 `composition', `display' and `invisible' properties.
1711 LAST_PT is the last position of point. */
1714 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1717 Lisp_Object val
, overlay
, tmp
;
1718 /* When called after buffer modification, we should temporarily
1719 suppress the point adjustment for automatic composition so that a
1720 user can keep inserting another character at point or keep
1721 deleting characters around point. */
1722 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1723 ptrdiff_t orig_pt
= PT
;
1725 /* FIXME: cycling is probably not necessary because these properties
1726 can't be usefully combined anyway. */
1727 while (check_composition
|| check_display
|| check_invisible
)
1729 /* FIXME: check `intangible'. */
1730 if (check_composition
1731 && PT
> BEGV
&& PT
< ZV
1732 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1735 check_display
= check_invisible
= 1;
1737 check_composition
= 0;
1739 && PT
> BEGV
&& PT
< ZV
1740 && !NILP (val
= get_char_property_and_overlay
1741 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1742 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1743 && (!OVERLAYP (overlay
)
1744 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1745 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1746 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1747 && (beg
< PT
/* && end > PT <- It's always the case. */
1748 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1751 SET_PT (PT
< last_pt
1752 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1754 check_composition
= check_invisible
= 1;
1757 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1759 int inv
, ellipsis
= 0;
1762 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1765 /* FIXME: We should stop if we find a spot between
1766 two runs of `invisible' where inserted text would
1767 be visible. This is important when we have two
1768 invisible boundaries that enclose an area: if the
1769 area is empty, we need this test in order to make
1770 it possible to place point in the middle rather
1771 than skip both boundaries. However, this code
1772 also stops anywhere in a non-sticky text-property,
1773 which breaks (e.g.) Org mode. */
1774 && (val
= get_pos_property (make_number (end
),
1776 TEXT_PROP_MEANS_INVISIBLE (val
))
1778 && !NILP (val
= get_char_property_and_overlay
1779 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1780 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1782 ellipsis
= ellipsis
|| inv
> 1
1783 || (OVERLAYP (overlay
)
1784 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1785 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1786 tmp
= Fnext_single_char_property_change
1787 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1788 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1792 && (val
= get_pos_property (make_number (beg
),
1794 TEXT_PROP_MEANS_INVISIBLE (val
))
1796 && !NILP (val
= get_char_property_and_overlay
1797 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1798 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1800 ellipsis
= ellipsis
|| inv
> 1
1801 || (OVERLAYP (overlay
)
1802 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1803 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1804 tmp
= Fprevious_single_char_property_change
1805 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1806 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1809 /* Move away from the inside area. */
1810 if (beg
< PT
&& end
> PT
)
1812 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1813 /* We haven't moved yet (so we don't need to fear
1814 infinite-looping) and we were outside the range
1815 before (so either end of the range still corresponds
1816 to a move in the right direction): pretend we moved
1817 less than we actually did, so that we still have
1818 more freedom below in choosing which end of the range
1820 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1821 /* We either have moved already or the last point
1822 was already in the range: we don't get to choose
1823 which end of the range we have to go to. */
1824 : (PT
< last_pt
? beg
: end
));
1825 check_composition
= check_display
= 1;
1827 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1828 the point to something other than its argument, due to
1829 point-motion hooks, intangibility, etc. */
1830 xassert (PT
== beg
|| PT
== end
);
1833 /* Pretend the area doesn't exist if the buffer is not
1835 if (!modified
&& !ellipsis
&& beg
< end
)
1837 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1838 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1839 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1840 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1841 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1842 /* We've already moved as far as we can. Trying to go
1843 to the other end would mean moving backwards and thus
1844 could lead to an infinite loop. */
1846 else if (val
= get_pos_property (make_number (PT
),
1848 TEXT_PROP_MEANS_INVISIBLE (val
)
1849 && (val
= get_pos_property
1850 (make_number (PT
== beg
? end
: beg
),
1852 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1853 (check_composition
= check_display
= 1,
1854 SET_PT (PT
== beg
? end
: beg
));
1857 check_invisible
= 0;
1861 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1864 safe_run_hooks_1 (void)
1866 eassert (CONSP (Vinhibit_quit
));
1867 return call0 (XCDR (Vinhibit_quit
));
1870 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1874 safe_run_hooks_error (Lisp_Object error_data
)
1877 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1878 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1879 Lisp_Object args
[4];
1880 args
[0] = build_string ("Error in %s (%s): %s");
1883 args
[3] = error_data
;
1889 Lisp_Object newval
= Qnil
;
1890 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1891 if (EQ (fun
, XCAR (val
)))
1894 newval
= Fcons (XCAR (val
), newval
);
1896 return Fset (hook
, Fnreverse (newval
));
1897 /* Not found in the local part of the hook. Let's look at the global
1900 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1901 : Fdefault_value (hook
));
1902 CONSP (val
); val
= XCDR (val
))
1903 if (EQ (fun
, XCAR (val
)))
1906 newval
= Fcons (XCAR (val
), newval
);
1908 return Fset_default (hook
, Fnreverse (newval
));
1914 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1916 eassert (nargs
== 1);
1917 if (CONSP (Vinhibit_quit
))
1918 XSETCDR (Vinhibit_quit
, args
[0]);
1920 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1922 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1926 /* If we get an error while running the hook, cause the hook variable
1927 to be nil. Also inhibit quits, so that C-g won't cause the hook
1928 to mysteriously evaporate. */
1931 safe_run_hooks (Lisp_Object hook
)
1933 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1934 to its body or to its handlers other than via globals such as
1935 dynamically-bound variables ;-) */
1936 ptrdiff_t count
= SPECPDL_INDEX ();
1937 specbind (Qinhibit_quit
, hook
);
1939 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1941 unbind_to (count
, Qnil
);
1945 /* Nonzero means polling for input is temporarily suppressed. */
1947 int poll_suppress_count
;
1949 /* Asynchronous timer for polling. */
1951 static struct atimer
*poll_timer
;
1954 #ifdef POLL_FOR_INPUT
1956 /* Poll for input, so that we catch a C-g if it comes in. This
1957 function is called from x_make_frame_visible, see comment
1961 poll_for_input_1 (void)
1963 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1964 doing anything dangerous. */
1968 if (interrupt_input_blocked
== 0
1969 && !waiting_for_input
)
1970 read_avail_input (0);
1976 /* Timer callback function for poll_timer. TIMER is equal to
1980 poll_for_input (struct atimer
*timer
)
1982 if (poll_suppress_count
== 0)
1985 interrupt_input_pending
= 1;
1986 pending_signals
= 1;
1988 poll_for_input_1 ();
1993 #endif /* POLL_FOR_INPUT */
1995 /* Begin signals to poll for input, if they are appropriate.
1996 This function is called unconditionally from various places. */
1999 start_polling (void)
2001 #ifdef POLL_FOR_INPUT
2002 /* XXX This condition was (read_socket_hook && !interrupt_input),
2003 but read_socket_hook is not global anymore. Let's pretend that
2005 if (!interrupt_input
)
2007 /* Turn alarm handling on unconditionally. It might have
2008 been turned off in process.c. */
2009 turn_on_atimers (1);
2011 /* If poll timer doesn't exist, are we need one with
2012 a different interval, start a new one. */
2013 if (poll_timer
== NULL
2014 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2016 EMACS_TIME interval
;
2019 cancel_atimer (poll_timer
);
2021 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2022 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2023 poll_for_input
, NULL
);
2026 /* Let the timer's callback function poll for input
2027 if this becomes zero. */
2028 --poll_suppress_count
;
2033 /* Nonzero if we are using polling to handle input asynchronously. */
2036 input_polling_used (void)
2038 #ifdef POLL_FOR_INPUT
2039 /* XXX This condition was (read_socket_hook && !interrupt_input),
2040 but read_socket_hook is not global anymore. Let's pretend that
2042 return !interrupt_input
;
2048 /* Turn off polling. */
2053 #ifdef POLL_FOR_INPUT
2054 /* XXX This condition was (read_socket_hook && !interrupt_input),
2055 but read_socket_hook is not global anymore. Let's pretend that
2057 if (!interrupt_input
)
2058 ++poll_suppress_count
;
2062 /* Set the value of poll_suppress_count to COUNT
2063 and start or stop polling accordingly. */
2066 set_poll_suppress_count (int count
)
2068 #ifdef POLL_FOR_INPUT
2069 if (count
== 0 && poll_suppress_count
!= 0)
2071 poll_suppress_count
= 1;
2074 else if (count
!= 0 && poll_suppress_count
== 0)
2078 poll_suppress_count
= count
;
2082 /* Bind polling_period to a value at least N.
2083 But don't decrease it. */
2086 bind_polling_period (int n
)
2088 #ifdef POLL_FOR_INPUT
2089 int new = polling_period
;
2094 stop_other_atimers (poll_timer
);
2096 specbind (Qpolling_period
, make_number (new));
2097 /* Start a new alarm with the new period. */
2102 /* Apply the control modifier to CHARACTER. */
2105 make_ctrl_char (int c
)
2107 /* Save the upper bits here. */
2108 int upper
= c
& ~0177;
2110 if (! ASCII_BYTE_P (c
))
2111 return c
|= ctrl_modifier
;
2115 /* Everything in the columns containing the upper-case letters
2116 denotes a control character. */
2117 if (c
>= 0100 && c
< 0140)
2121 /* Set the shift modifier for a control char
2122 made from a shifted letter. But only for letters! */
2123 if (oc
>= 'A' && oc
<= 'Z')
2124 c
|= shift_modifier
;
2127 /* The lower-case letters denote control characters too. */
2128 else if (c
>= 'a' && c
<= 'z')
2131 /* Include the bits for control and shift
2132 only if the basic ASCII code can't indicate them. */
2136 /* Replace the high bits. */
2137 c
|= (upper
& ~ctrl_modifier
);
2142 /* Display the help-echo property of the character after the mouse pointer.
2143 Either show it in the echo area, or call show-help-function to display
2144 it by other means (maybe in a tooltip).
2146 If HELP is nil, that means clear the previous help echo.
2148 If HELP is a string, display that string. If HELP is a function,
2149 call it with OBJECT and POS as arguments; the function should
2150 return a help string or nil for none. For all other types of HELP,
2151 evaluate it to obtain a string.
2153 WINDOW is the window in which the help was generated, if any.
2154 It is nil if not in a window.
2156 If OBJECT is a buffer, POS is the position in the buffer where the
2157 `help-echo' text property was found.
2159 If OBJECT is an overlay, that overlay has a `help-echo' property,
2160 and POS is the position in the overlay's buffer under the mouse.
2162 If OBJECT is a string (an overlay string or a string displayed with
2163 the `display' property). POS is the position in that string under
2166 Note: this function may only be called with HELP nil or a string
2167 from X code running asynchronously. */
2170 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2173 if (!NILP (help
) && !STRINGP (help
))
2175 if (FUNCTIONP (help
))
2177 Lisp_Object args
[4];
2182 help
= safe_call (4, args
);
2185 help
= safe_eval (help
);
2187 if (!STRINGP (help
))
2191 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2192 if (!noninteractive
&& STRINGP (help
))
2194 /* The mouse-fixup-help-message Lisp function can call
2195 mouse_position_hook, which resets the mouse_moved flags.
2196 This causes trouble if we are trying to read a mouse motion
2197 event (i.e., if we are inside a `track-mouse' form), so we
2198 restore the mouse_moved flag. */
2199 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2200 help
= call1 (Qmouse_fixup_help_message
, help
);
2206 if (STRINGP (help
) || NILP (help
))
2208 if (!NILP (Vshow_help_function
))
2209 call1 (Vshow_help_function
, help
);
2210 help_echo_showing_p
= STRINGP (help
);
2216 /* Input of single characters from keyboard */
2218 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2219 struct timeval
*end_time
);
2220 static void record_char (Lisp_Object c
);
2222 static Lisp_Object help_form_saved_window_configs
;
2224 read_char_help_form_unwind (Lisp_Object arg
)
2226 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2227 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2228 if (!NILP (window_config
))
2229 Fset_window_configuration (window_config
);
2233 #define STOP_POLLING \
2234 do { if (! polling_stopped_here) stop_polling (); \
2235 polling_stopped_here = 1; } while (0)
2237 #define RESUME_POLLING \
2238 do { if (polling_stopped_here) start_polling (); \
2239 polling_stopped_here = 0; } while (0)
2241 /* read a character from the keyboard; call the redisplay if needed */
2242 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2243 -1 means do not do redisplay, but do do autosaving.
2246 /* The arguments MAPS and NMAPS are for menu prompting.
2247 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2249 PREV_EVENT is the previous input event, or nil if we are reading
2250 the first event of a key sequence (or not reading a key sequence).
2251 If PREV_EVENT is t, that is a "magic" value that says
2252 not to run input methods, but in other respects to act as if
2253 not reading a key sequence.
2255 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2256 if we used a mouse menu to read the input, or zero otherwise. If
2257 USED_MOUSE_MENU is null, we don't dereference it.
2259 Value is -2 when we find input on another keyboard. A second call
2260 to read_char will read it.
2262 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2263 specifying the maximum time to wait until. If no input arrives by
2264 that time, stop waiting and return nil.
2266 Value is t if we showed a menu and the user rejected it. */
2269 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2270 Lisp_Object prev_event
,
2271 int *used_mouse_menu
, struct timeval
*end_time
)
2273 volatile Lisp_Object c
;
2275 jmp_buf local_getcjmp
;
2277 volatile int key_already_recorded
= 0;
2278 Lisp_Object tem
, save
;
2279 volatile Lisp_Object previous_echo_area_message
;
2280 volatile Lisp_Object also_record
;
2281 volatile int reread
;
2282 struct gcpro gcpro1
, gcpro2
;
2283 int volatile polling_stopped_here
= 0;
2284 struct kboard
*orig_kboard
= current_kboard
;
2288 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2289 before_command_key_count
= this_command_key_count
;
2290 before_command_echo_length
= echo_length ();
2293 previous_echo_area_message
= Qnil
;
2295 GCPRO2 (c
, previous_echo_area_message
);
2300 if (CONSP (Vunread_post_input_method_events
))
2302 c
= XCAR (Vunread_post_input_method_events
);
2303 Vunread_post_input_method_events
2304 = XCDR (Vunread_post_input_method_events
);
2306 /* Undo what read_char_x_menu_prompt did when it unread
2307 additional keys returned by Fx_popup_menu. */
2309 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2317 if (unread_command_char
!= -1)
2319 XSETINT (c
, unread_command_char
);
2320 unread_command_char
= -1;
2326 if (CONSP (Vunread_command_events
))
2328 int was_disabled
= 0;
2330 c
= XCAR (Vunread_command_events
);
2331 Vunread_command_events
= XCDR (Vunread_command_events
);
2335 /* Undo what sit-for did when it unread additional keys
2336 inside universal-argument. */
2339 && EQ (XCAR (c
), Qt
))
2345 /* Undo what read_char_x_menu_prompt did when it unread
2346 additional keys returned by Fx_popup_menu. */
2348 && EQ (XCDR (c
), Qdisabled
)
2349 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2355 /* If the queued event is something that used the mouse,
2356 set used_mouse_menu accordingly. */
2358 /* Also check was_disabled so last-nonmenu-event won't return
2359 a bad value when submenus are involved. (Bug#447) */
2360 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2361 *used_mouse_menu
= 1;
2363 goto reread_for_input_method
;
2366 if (CONSP (Vunread_input_method_events
))
2368 c
= XCAR (Vunread_input_method_events
);
2369 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2371 /* Undo what read_char_x_menu_prompt did when it unread
2372 additional keys returned by Fx_popup_menu. */
2374 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2378 goto reread_for_input_method
;
2381 this_command_key_count_reset
= 0;
2383 if (!NILP (Vexecuting_kbd_macro
))
2385 /* We set this to Qmacro; since that's not a frame, nobody will
2386 try to switch frames on us, and the selected window will
2389 Since this event came from a macro, it would be misleading to
2390 leave internal_last_event_frame set to wherever the last
2391 real event came from. Normally, a switch-frame event selects
2392 internal_last_event_frame after each command is read, but
2393 events read from a macro should never cause a new frame to be
2395 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2397 /* Exit the macro if we are at the end.
2398 Also, some things replace the macro with t
2399 to force an early exit. */
2400 if (EQ (Vexecuting_kbd_macro
, Qt
)
2401 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2407 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2408 if (STRINGP (Vexecuting_kbd_macro
)
2409 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2410 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2412 executing_kbd_macro_index
++;
2417 if (!NILP (unread_switch_frame
))
2419 c
= unread_switch_frame
;
2420 unread_switch_frame
= Qnil
;
2422 /* This event should make it into this_command_keys, and get echoed
2423 again, so we do not set `reread'. */
2427 /* if redisplay was requested */
2428 if (commandflag
>= 0)
2430 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2432 /* If there is pending input, process any events which are not
2433 user-visible, such as X selection_request events. */
2435 || detect_input_pending_run_timers (0))
2436 swallow_events (0); /* may clear input_pending */
2438 /* Redisplay if no pending input. */
2439 while (!input_pending
)
2441 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2442 redisplay_preserve_echo_area (5);
2447 /* Normal case: no input arrived during redisplay. */
2450 /* Input arrived and pre-empted redisplay.
2451 Process any events which are not user-visible. */
2453 /* If that cleared input_pending, try again to redisplay. */
2456 /* Prevent the redisplay we just did
2457 from messing up echoing of the input after the prompt. */
2458 if (commandflag
== 0 && echo_current
)
2459 echo_message_buffer
= echo_area_buffer
[0];
2463 /* Message turns off echoing unless more keystrokes turn it on again.
2465 The code in 20.x for the condition was
2467 1. echo_area_glyphs && *echo_area_glyphs
2468 2. && echo_area_glyphs != current_kboard->echobuf
2469 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2471 (1) means there's a current message displayed
2473 (2) means it's not the message from echoing from the current
2476 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2477 is set to a non-null value. This is done in read_char and it is
2478 set to echo_area_glyphs after a call to echo_char. That means
2479 ok_to_echo_at_next_pause is either null or
2480 current_kboard->echobuf with the appropriate current_kboard at
2483 So, condition (3) means in clear text ok_to_echo_at_next_pause
2484 must be either null, or the current message isn't from echoing at
2485 all, or it's from echoing from a different kboard than the
2488 if (/* There currently is something in the echo area. */
2489 !NILP (echo_area_buffer
[0])
2490 && (/* And it's either not from echoing. */
2491 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2492 /* Or it's an echo from a different kboard. */
2493 || echo_kboard
!= current_kboard
2494 /* Or we explicitly allow overwriting whatever there is. */
2495 || ok_to_echo_at_next_pause
== NULL
))
2500 /* Try reading a character via menu prompting in the minibuf.
2501 Try this before the sit-for, because the sit-for
2502 would do the wrong thing if we are supposed to do
2503 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2504 after a mouse event so don't try a minibuf menu. */
2506 if (nmaps
> 0 && INTERACTIVE
2507 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2508 /* Don't bring up a menu if we already have another event. */
2509 && NILP (Vunread_command_events
)
2510 && unread_command_char
< 0
2511 && !detect_input_pending_run_timers (0))
2513 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2515 if (INTEGERP (c
) && XINT (c
) == -2)
2516 return c
; /* wrong_kboard_jmpbuf */
2520 key_already_recorded
= 1;
2525 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2526 We will do that below, temporarily for short sections of code,
2527 when appropriate. local_getcjmp must be in effect
2528 around any call to sit_for or kbd_buffer_get_event;
2529 it *must not* be in effect when we call redisplay. */
2531 jmpcount
= SPECPDL_INDEX ();
2532 if (_setjmp (local_getcjmp
))
2534 /* Handle quits while reading the keyboard. */
2535 /* We must have saved the outer value of getcjmp here,
2536 so restore it now. */
2537 restore_getcjmp (save_jump
);
2538 unbind_to (jmpcount
, Qnil
);
2539 XSETINT (c
, quit_char
);
2540 internal_last_event_frame
= selected_frame
;
2541 Vlast_event_frame
= internal_last_event_frame
;
2542 /* If we report the quit char as an event,
2543 don't do so more than once. */
2544 if (!NILP (Vinhibit_quit
))
2548 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2549 if (kb
!= current_kboard
)
2551 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2552 /* We shouldn't get here if we were in single-kboard mode! */
2557 while (CONSP (XCDR (last
)))
2559 if (!NILP (XCDR (last
)))
2563 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2565 XSETCDR (last
, Fcons (c
, Qnil
));
2566 kb
->kbd_queue_has_data
= 1;
2567 current_kboard
= kb
;
2568 /* This is going to exit from read_char
2569 so we had better get rid of this frame's stuff. */
2571 return make_number (-2); /* wrong_kboard_jmpbuf */
2577 /* Start idle timers if no time limit is supplied. We don't do it
2578 if a time limit is supplied to avoid an infinite recursion in the
2579 situation where an idle timer calls `sit-for'. */
2582 timer_start_idle ();
2584 /* If in middle of key sequence and minibuffer not active,
2585 start echoing if enough time elapses. */
2587 if (minibuf_level
== 0
2589 && !current_kboard
->immediate_echo
2590 && this_command_key_count
> 0
2592 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2593 && NILP (Fzerop (Vecho_keystrokes
))
2594 && (/* No message. */
2595 NILP (echo_area_buffer
[0])
2596 /* Or empty message. */
2597 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2598 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2599 /* Or already echoing from same kboard. */
2600 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2601 /* Or not echoing before and echoing allowed. */
2602 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2604 /* After a mouse event, start echoing right away.
2605 This is because we are probably about to display a menu,
2606 and we don't want to delay before doing so. */
2607 if (EVENT_HAS_PARAMETERS (prev_event
))
2613 save_getcjmp (save_jump
);
2614 restore_getcjmp (local_getcjmp
);
2615 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2616 restore_getcjmp (save_jump
);
2618 && ! CONSP (Vunread_command_events
))
2623 /* Maybe auto save due to number of keystrokes. */
2625 if (commandflag
!= 0
2626 && auto_save_interval
> 0
2627 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2628 && !detect_input_pending_run_timers (0))
2630 Fdo_auto_save (Qnil
, Qnil
);
2631 /* Hooks can actually change some buffers in auto save. */
2635 /* Try reading using an X menu.
2636 This is never confused with reading using the minibuf
2637 because the recursive call of read_char in read_char_minibuf_menu_prompt
2638 does not pass on any keymaps. */
2640 if (nmaps
> 0 && INTERACTIVE
2641 && !NILP (prev_event
)
2642 && EVENT_HAS_PARAMETERS (prev_event
)
2643 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2644 && !EQ (XCAR (prev_event
), Qtool_bar
)
2645 /* Don't bring up a menu if we already have another event. */
2646 && NILP (Vunread_command_events
)
2647 && unread_command_char
< 0)
2649 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2651 /* Now that we have read an event, Emacs is not idle. */
2658 /* Maybe autosave and/or garbage collect due to idleness. */
2660 if (INTERACTIVE
&& NILP (c
))
2663 ptrdiff_t buffer_size
;
2665 /* Slow down auto saves logarithmically in size of current buffer,
2666 and garbage collect while we're at it. */
2667 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2668 last_non_minibuf_size
= Z
- BEG
;
2669 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2671 while (buffer_size
> 64)
2672 delay_level
++, buffer_size
-= buffer_size
>> 2;
2673 if (delay_level
< 4) delay_level
= 4;
2674 /* delay_level is 4 for files under around 50k, 7 at 100k,
2675 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2677 /* Auto save if enough time goes by without input. */
2678 if (commandflag
!= 0
2679 && num_nonmacro_input_events
> last_auto_save
2680 && INTEGERP (Vauto_save_timeout
)
2681 && XINT (Vauto_save_timeout
) > 0)
2684 EMACS_INT timeout
= (delay_level
2685 * min (XFASTINT (Vauto_save_timeout
) / 4,
2686 MOST_POSITIVE_FIXNUM
/ delay_level
));
2687 save_getcjmp (save_jump
);
2688 restore_getcjmp (local_getcjmp
);
2689 tem0
= sit_for (make_number (timeout
), 1, 1);
2690 restore_getcjmp (save_jump
);
2693 && ! CONSP (Vunread_command_events
))
2695 Fdo_auto_save (Qnil
, Qnil
);
2697 /* If we have auto-saved and there is still no input
2698 available, garbage collect if there has been enough
2699 consing going on to make it worthwhile. */
2700 if (!detect_input_pending_run_timers (0)
2701 && consing_since_gc
> gc_cons_threshold
/ 2)
2702 Fgarbage_collect ();
2709 /* Notify the caller if an autosave hook, or a timer, sentinel or
2710 filter in the sit_for calls above have changed the current
2711 kboard. This could happen if they use the minibuffer or start a
2712 recursive edit, like the fancy splash screen in server.el's
2713 filter. If this longjmp wasn't here, read_key_sequence would
2714 interpret the next key sequence using the wrong translation
2715 tables and function keymaps. */
2716 if (NILP (c
) && current_kboard
!= orig_kboard
)
2719 return make_number (-2); /* wrong_kboard_jmpbuf */
2722 /* If this has become non-nil here, it has been set by a timer
2723 or sentinel or filter. */
2724 if (CONSP (Vunread_command_events
))
2726 c
= XCAR (Vunread_command_events
);
2727 Vunread_command_events
= XCDR (Vunread_command_events
);
2730 /* Read something from current KBOARD's side queue, if possible. */
2734 if (current_kboard
->kbd_queue_has_data
)
2736 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2738 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2739 KVAR (current_kboard
, kbd_queue
)
2740 = XCDR (KVAR (current_kboard
, kbd_queue
));
2741 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2742 current_kboard
->kbd_queue_has_data
= 0;
2743 input_pending
= readable_events (0);
2744 if (EVENT_HAS_PARAMETERS (c
)
2745 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2746 internal_last_event_frame
= XCAR (XCDR (c
));
2747 Vlast_event_frame
= internal_last_event_frame
;
2751 /* If current_kboard's side queue is empty check the other kboards.
2752 If one of them has data that we have not yet seen here,
2753 switch to it and process the data waiting for it.
2755 Note: if the events queued up for another kboard
2756 have already been seen here, and therefore are not a complete command,
2757 the kbd_queue_has_data field is 0, so we skip that kboard here.
2758 That's to avoid an infinite loop switching between kboards here. */
2759 if (NILP (c
) && !single_kboard
)
2762 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2763 if (kb
->kbd_queue_has_data
)
2765 current_kboard
= kb
;
2766 /* This is going to exit from read_char
2767 so we had better get rid of this frame's stuff. */
2769 return make_number (-2); /* wrong_kboard_jmpbuf */
2777 /* Finally, we read from the main queue,
2778 and if that gives us something we can't use yet, we put it on the
2779 appropriate side queue and try again. */
2783 KBOARD
*kb
IF_LINT (= NULL
);
2788 EMACS_GET_TIME (now
);
2789 if (EMACS_TIME_GE (now
, *end_time
))
2793 /* Actually read a character, waiting if necessary. */
2794 save_getcjmp (save_jump
);
2795 restore_getcjmp (local_getcjmp
);
2797 timer_start_idle ();
2798 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2799 restore_getcjmp (save_jump
);
2801 if (! NILP (c
) && (kb
!= current_kboard
))
2803 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2806 while (CONSP (XCDR (last
)))
2808 if (!NILP (XCDR (last
)))
2812 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2814 XSETCDR (last
, Fcons (c
, Qnil
));
2815 kb
->kbd_queue_has_data
= 1;
2819 current_kboard
= kb
;
2820 /* This is going to exit from read_char
2821 so we had better get rid of this frame's stuff. */
2823 return make_number (-2);
2827 /* Terminate Emacs in batch mode if at eof. */
2828 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2829 Fkill_emacs (make_number (1));
2833 /* Add in any extra modifiers, where appropriate. */
2834 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2835 || ((extra_keyboard_modifiers
& 0177) < ' '
2836 && (extra_keyboard_modifiers
& 0177) != 0))
2837 XSETINT (c
, make_ctrl_char (XINT (c
)));
2839 /* Transfer any other modifier bits directly from
2840 extra_keyboard_modifiers to c. Ignore the actual character code
2841 in the low 16 bits of extra_keyboard_modifiers. */
2842 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2853 if (commandflag
>= 0
2854 && !input_pending
&& !detect_input_pending_run_timers (0))
2862 /* Buffer switch events are only for internal wakeups
2863 so don't show them to the user.
2864 Also, don't record a key if we already did. */
2865 if (BUFFERP (c
) || key_already_recorded
)
2868 /* Process special events within read_char
2869 and loop around to read another event. */
2872 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2877 struct buffer
*prev_buffer
= current_buffer
;
2878 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2879 int was_locked
= single_kboard
;
2880 ptrdiff_t count
= SPECPDL_INDEX ();
2881 record_single_kboard_state ();
2884 last_input_event
= c
;
2885 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2887 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2888 /* We stopped being idle for this event; undo that. This
2889 prevents automatic window selection (under
2890 mouse_autoselect_window from acting as a real input event, for
2891 example banishing the mouse under mouse-avoidance-mode. */
2892 timer_resume_idle ();
2894 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2895 /* Resume allowing input from any kboard, if that was true before. */
2897 any_kboard_state ();
2898 unbind_to (count
, Qnil
);
2901 if (current_buffer
!= prev_buffer
)
2903 /* The command may have changed the keymaps. Pretend there
2904 is input in another keyboard and return. This will
2905 recalculate keymaps. */
2906 c
= make_number (-2);
2913 /* Handle things that only apply to characters. */
2916 /* If kbd_buffer_get_event gave us an EOF, return that. */
2920 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2921 && UNSIGNED_CMP (XFASTINT (c
), <,
2922 SCHARS (KVAR (current_kboard
,
2923 Vkeyboard_translate_table
))))
2924 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2925 && UNSIGNED_CMP (XFASTINT (c
), <,
2926 ASIZE (KVAR (current_kboard
,
2927 Vkeyboard_translate_table
))))
2928 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2932 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2933 /* nil in keyboard-translate-table means no translation. */
2939 /* If this event is a mouse click in the menu bar,
2940 return just menu-bar for now. Modify the mouse click event
2941 so we won't do this twice, then queue it up. */
2942 if (EVENT_HAS_PARAMETERS (c
)
2944 && CONSP (EVENT_START (c
))
2945 && CONSP (XCDR (EVENT_START (c
))))
2949 posn
= POSN_POSN (EVENT_START (c
));
2950 /* Handle menu-bar events:
2951 insert the dummy prefix event `menu-bar'. */
2952 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2954 /* Change menu-bar to (menu-bar) as the event "position". */
2955 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2958 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2963 /* Store these characters into recent_keys, the dribble file if any,
2964 and the keyboard macro being defined, if any. */
2966 if (! NILP (also_record
))
2967 record_char (also_record
);
2969 /* Wipe the echo area.
2970 But first, if we are about to use an input method,
2971 save the echo area contents for it to refer to. */
2973 && ! NILP (Vinput_method_function
)
2974 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2976 previous_echo_area_message
= Fcurrent_message ();
2977 Vinput_method_previous_message
= previous_echo_area_message
;
2980 /* Now wipe the echo area, except for help events which do their
2981 own stuff with the echo area. */
2983 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2984 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2986 if (!NILP (echo_area_buffer
[0]))
2987 safe_run_hooks (Qecho_area_clear_hook
);
2988 clear_message (1, 0);
2991 reread_for_input_method
:
2993 /* Pass this to the input method, if appropriate. */
2995 && ! NILP (Vinput_method_function
)
2996 /* Don't run the input method within a key sequence,
2997 after the first event of the key sequence. */
2998 && NILP (prev_event
)
2999 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3002 ptrdiff_t key_count
;
3003 int key_count_reset
;
3004 struct gcpro inner_gcpro1
;
3005 ptrdiff_t count
= SPECPDL_INDEX ();
3007 /* Save the echo status. */
3008 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3009 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3010 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3011 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3014 if (before_command_restore_flag
)
3016 this_command_key_count
= before_command_key_count_1
;
3017 if (this_command_key_count
< this_single_command_key_start
)
3018 this_single_command_key_start
= this_command_key_count
;
3019 echo_truncate (before_command_echo_length_1
);
3020 before_command_restore_flag
= 0;
3024 /* Save the this_command_keys status. */
3025 key_count
= this_command_key_count
;
3026 key_count_reset
= this_command_key_count_reset
;
3029 keys
= Fcopy_sequence (this_command_keys
);
3032 GCPRO1_VAR (keys
, inner_gcpro
);
3034 /* Clear out this_command_keys. */
3035 this_command_key_count
= 0;
3036 this_command_key_count_reset
= 0;
3038 /* Now wipe the echo area. */
3039 if (!NILP (echo_area_buffer
[0]))
3040 safe_run_hooks (Qecho_area_clear_hook
);
3041 clear_message (1, 0);
3044 /* If we are not reading a key sequence,
3045 never use the echo area. */
3048 specbind (Qinput_method_use_echo_area
, Qt
);
3051 /* Call the input method. */
3052 tem
= call1 (Vinput_method_function
, c
);
3054 tem
= unbind_to (count
, tem
);
3056 /* Restore the saved echoing state
3057 and this_command_keys state. */
3058 this_command_key_count
= key_count
;
3059 this_command_key_count_reset
= key_count_reset
;
3061 this_command_keys
= keys
;
3064 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3065 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3066 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3067 if (saved_immediate_echo
)
3070 UNGCPRO_VAR (inner_gcpro
);
3072 /* The input method can return no events. */
3075 /* Bring back the previous message, if any. */
3076 if (! NILP (previous_echo_area_message
))
3077 message_with_string ("%s", previous_echo_area_message
, 0);
3080 /* It returned one event or more. */
3082 Vunread_post_input_method_events
3083 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3088 /* Display help if not echoing. */
3089 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3091 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3092 Lisp_Object help
, object
, position
, window
, htem
;
3094 htem
= Fcdr (XCDR (c
));
3097 window
= Fcar (htem
);
3099 object
= Fcar (htem
);
3101 position
= Fcar (htem
);
3103 show_help_echo (help
, window
, object
, position
);
3105 /* We stopped being idle for this event; undo that. */
3107 timer_resume_idle ();
3111 if ((! reread
|| this_command_key_count
== 0
3112 || this_command_key_count_reset
)
3116 /* Don't echo mouse motion events. */
3117 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3118 && NILP (Fzerop (Vecho_keystrokes
))
3119 && ! (EVENT_HAS_PARAMETERS (c
)
3120 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3123 if (! NILP (also_record
))
3124 echo_char (also_record
);
3125 /* Once we reread a character, echoing can happen
3126 the next time we pause to read a new one. */
3127 ok_to_echo_at_next_pause
= current_kboard
;
3130 /* Record this character as part of the current key. */
3131 add_command_key (c
);
3132 if (! NILP (also_record
))
3133 add_command_key (also_record
);
3136 last_input_event
= c
;
3139 /* Process the help character specially if enabled */
3140 if (!NILP (Vhelp_form
) && help_char_p (c
))
3142 ptrdiff_t count
= SPECPDL_INDEX ();
3144 help_form_saved_window_configs
3145 = Fcons (Fcurrent_window_configuration (Qnil
),
3146 help_form_saved_window_configs
);
3147 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3148 call0 (Qhelp_form_show
);
3153 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3154 if (EVENT_HAS_PARAMETERS (c
)
3155 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3156 XSETCAR (help_form_saved_window_configs
, Qnil
);
3158 while (BUFFERP (c
));
3159 /* Remove the help from the frame */
3160 unbind_to (count
, Qnil
);
3163 if (EQ (c
, make_number (040)))
3167 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3168 while (BUFFERP (c
));
3177 /* Record a key that came from a mouse menu.
3178 Record it for echoing, for this-command-keys, and so on. */
3181 record_menu_key (Lisp_Object c
)
3183 /* Wipe the echo area. */
3184 clear_message (1, 0);
3189 before_command_key_count
= this_command_key_count
;
3190 before_command_echo_length
= echo_length ();
3193 /* Don't echo mouse motion events. */
3194 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3195 && NILP (Fzerop (Vecho_keystrokes
)))
3199 /* Once we reread a character, echoing can happen
3200 the next time we pause to read a new one. */
3201 ok_to_echo_at_next_pause
= 0;
3204 /* Record this character as part of the current key. */
3205 add_command_key (c
);
3207 /* Re-reading in the middle of a command */
3208 last_input_event
= c
;
3212 /* Return 1 if should recognize C as "the help character". */
3215 help_char_p (Lisp_Object c
)
3219 if (EQ (c
, Vhelp_char
))
3221 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3222 if (EQ (c
, XCAR (tail
)))
3227 /* Record the input event C in various ways. */
3230 record_char (Lisp_Object c
)
3234 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3236 /* To avoid filling recent_keys with help-echo and mouse-movement
3237 events, we filter out repeated help-echo events, only store the
3238 first and last in a series of mouse-movement events, and don't
3239 store repeated help-echo events which are only separated by
3240 mouse-movement events. */
3242 Lisp_Object ev1
, ev2
, ev3
;
3245 if ((ix1
= recent_keys_index
- 1) < 0)
3246 ix1
= NUM_RECENT_KEYS
- 1;
3247 ev1
= AREF (recent_keys
, ix1
);
3249 if ((ix2
= ix1
- 1) < 0)
3250 ix2
= NUM_RECENT_KEYS
- 1;
3251 ev2
= AREF (recent_keys
, ix2
);
3253 if ((ix3
= ix2
- 1) < 0)
3254 ix3
= NUM_RECENT_KEYS
- 1;
3255 ev3
= AREF (recent_keys
, ix3
);
3257 if (EQ (XCAR (c
), Qhelp_echo
))
3259 /* Don't record `help-echo' in recent_keys unless it shows some help
3260 message, and a different help than the previously recorded
3262 Lisp_Object help
, last_help
;
3264 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3265 if (!STRINGP (help
))
3267 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3268 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3270 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3271 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3272 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3274 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3275 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3276 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3277 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3280 else if (EQ (XCAR (c
), Qmouse_movement
))
3282 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3283 So additional mouse movement events replace the last element. */
3284 Lisp_Object last_window
, window
;
3286 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3287 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3288 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3289 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3290 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3292 ASET (recent_keys
, ix1
, c
);
3298 store_kbd_macro_char (c
);
3302 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3303 ASET (recent_keys
, recent_keys_index
, c
);
3304 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3305 recent_keys_index
= 0;
3307 else if (recorded
< 0)
3309 /* We need to remove one or two events from recent_keys.
3310 To do this, we simply put nil at those events and move the
3311 recent_keys_index backwards over those events. Usually,
3312 users will never see those nil events, as they will be
3313 overwritten by the command keys entered to see recent_keys
3316 while (recorded
++ < 0 && total_keys
> 0)
3318 if (total_keys
< NUM_RECENT_KEYS
)
3320 if (--recent_keys_index
< 0)
3321 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3322 ASET (recent_keys
, recent_keys_index
, Qnil
);
3326 num_nonmacro_input_events
++;
3328 /* Write c to the dribble file. If c is a lispy event, write
3329 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3330 If you, dear reader, have a better idea, you've got the source. :-) */
3336 if (XUINT (c
) < 0x100)
3337 putc (XUINT (c
), dribble
);
3339 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3343 Lisp_Object dribblee
;
3345 /* If it's a structured event, take the event header. */
3346 dribblee
= EVENT_HEAD (c
);
3348 if (SYMBOLP (dribblee
))
3350 putc ('<', dribble
);
3351 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3352 SBYTES (SYMBOL_NAME (dribblee
)),
3354 putc ('>', dribble
);
3363 /* Copy out or in the info on where C-g should throw to.
3364 This is used when running Lisp code from within get_char,
3365 in case get_char is called recursively.
3366 See read_process_output. */
3369 save_getcjmp (jmp_buf temp
)
3371 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3375 restore_getcjmp (jmp_buf temp
)
3377 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3380 /* Low level keyboard/mouse input.
3381 kbd_buffer_store_event places events in kbd_buffer, and
3382 kbd_buffer_get_event retrieves them. */
3384 /* Return true if there are any events in the queue that read-char
3385 would return. If this returns false, a read-char would block. */
3387 readable_events (int flags
)
3389 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3392 /* If the buffer contains only FOCUS_IN_EVENT events, and
3393 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3394 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3396 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3397 #ifdef USE_TOOLKIT_SCROLL_BARS
3398 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3402 struct input_event
*event
;
3404 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3411 #ifdef USE_TOOLKIT_SCROLL_BARS
3412 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3414 event
->kind
== FOCUS_IN_EVENT
)
3415 #ifdef USE_TOOLKIT_SCROLL_BARS
3416 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3417 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3418 && event
->part
== scroll_bar_handle
3419 && event
->modifiers
== 0)
3424 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3427 while (event
!= kbd_store_ptr
);
3433 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3434 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3435 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3440 if (current_kboard
->kbd_queue_has_data
)
3446 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3447 if (kb
->kbd_queue_has_data
)
3453 /* Set this for debugging, to have a way to get out */
3454 int stop_character EXTERNALLY_VISIBLE
;
3457 event_to_kboard (struct input_event
*event
)
3460 frame
= event
->frame_or_window
;
3462 frame
= XCAR (frame
);
3463 else if (WINDOWP (frame
))
3464 frame
= WINDOW_FRAME (XWINDOW (frame
));
3466 /* There are still some events that don't set this field.
3467 For now, just ignore the problem.
3468 Also ignore dead frames here. */
3469 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3472 return FRAME_KBOARD (XFRAME (frame
));
3476 /* Return the number of slots occupied in kbd_buffer. */
3479 kbd_buffer_nr_stored (void)
3481 return kbd_fetch_ptr
== kbd_store_ptr
3483 : (kbd_fetch_ptr
< kbd_store_ptr
3484 ? kbd_store_ptr
- kbd_fetch_ptr
3485 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3486 + (kbd_store_ptr
- kbd_buffer
)));
3488 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3491 kbd_buffer_store_event (register struct input_event
*event
)
3493 kbd_buffer_store_event_hold (event
, 0);
3496 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3498 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3499 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3500 Else, if EVENT is a quit event, store the quit event
3501 in HOLD_QUIT, and return (thus ignoring further events).
3503 This is used in read_avail_input to postpone the processing
3504 of the quit event until all subsequent input events have been
3505 parsed (and discarded).
3509 kbd_buffer_store_event_hold (register struct input_event
*event
,
3510 struct input_event
*hold_quit
)
3512 if (event
->kind
== NO_EVENT
)
3515 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3518 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3520 register int c
= event
->code
& 0377;
3522 if (event
->modifiers
& ctrl_modifier
)
3523 c
= make_ctrl_char (c
);
3525 c
|= (event
->modifiers
3526 & (meta_modifier
| alt_modifier
3527 | hyper_modifier
| super_modifier
));
3531 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3532 struct input_event
*sp
;
3534 if (single_kboard
&& kb
!= current_kboard
)
3536 KVAR (kb
, kbd_queue
)
3537 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3538 Fcons (make_number (c
), Qnil
));
3539 kb
->kbd_queue_has_data
= 1;
3540 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3542 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3545 if (event_to_kboard (sp
) == kb
)
3547 sp
->kind
= NO_EVENT
;
3548 sp
->frame_or_window
= Qnil
;
3557 memcpy (hold_quit
, event
, sizeof (*event
));
3561 /* If this results in a quit_char being returned to Emacs as
3562 input, set Vlast_event_frame properly. If this doesn't
3563 get returned to Emacs as an event, the next event read
3564 will set Vlast_event_frame again, so this is safe to do. */
3568 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3570 focus
= event
->frame_or_window
;
3571 internal_last_event_frame
= focus
;
3572 Vlast_event_frame
= focus
;
3575 last_event_timestamp
= event
->timestamp
;
3576 handle_interrupt ();
3580 if (c
&& c
== stop_character
)
3586 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3587 Just ignore the second one. */
3588 else if (event
->kind
== BUFFER_SWITCH_EVENT
3589 && kbd_fetch_ptr
!= kbd_store_ptr
3590 && ((kbd_store_ptr
== kbd_buffer
3591 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3592 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3595 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3596 kbd_store_ptr
= kbd_buffer
;
3598 /* Don't let the very last slot in the buffer become full,
3599 since that would make the two pointers equal,
3600 and that is indistinguishable from an empty buffer.
3601 Discard the event if it would fill the last slot. */
3602 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3604 *kbd_store_ptr
= *event
;
3607 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3609 /* Don't read keyboard input until we have processed kbd_buffer.
3610 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3611 hold_keyboard_input ();
3613 if (!noninteractive
)
3614 signal (SIGIO
, SIG_IGN
);
3618 #endif /* subprocesses */
3621 /* If we're inside while-no-input, and this event qualifies
3622 as input, set quit-flag to cause an interrupt. */
3623 if (!NILP (Vthrow_on_input
)
3624 && event
->kind
!= FOCUS_IN_EVENT
3625 && event
->kind
!= HELP_EVENT
3626 && event
->kind
!= DEICONIFY_EVENT
)
3628 Vquit_flag
= Vthrow_on_input
;
3629 /* If we're inside a function that wants immediate quits,
3631 if (immediate_quit
&& NILP (Vinhibit_quit
))
3641 /* Put an input event back in the head of the event queue. */
3644 kbd_buffer_unget_event (register struct input_event
*event
)
3646 if (kbd_fetch_ptr
== kbd_buffer
)
3647 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3649 /* Don't let the very last slot in the buffer become full, */
3650 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3653 *kbd_fetch_ptr
= *event
;
3658 /* Generate a HELP_EVENT input_event and store it in the keyboard
3661 HELP is the help form.
3663 FRAME and WINDOW are the frame and window where the help is
3664 generated. OBJECT is the Lisp object where the help was found (a
3665 buffer, a string, an overlay, or nil if neither from a string nor
3666 from a buffer). POS is the position within OBJECT where the help
3670 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3671 Lisp_Object object
, ptrdiff_t pos
)
3673 struct input_event event
;
3677 event
.kind
= HELP_EVENT
;
3678 event
.frame_or_window
= frame
;
3680 event
.x
= WINDOWP (window
) ? window
: frame
;
3683 kbd_buffer_store_event (&event
);
3687 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3690 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3692 struct input_event event
;
3694 event
.kind
= HELP_EVENT
;
3695 event
.frame_or_window
= frame
;
3700 kbd_buffer_store_event (&event
);
3704 /* Discard any mouse events in the event buffer by setting them to
3707 discard_mouse_events (void)
3709 struct input_event
*sp
;
3710 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3712 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3715 if (sp
->kind
== MOUSE_CLICK_EVENT
3716 || sp
->kind
== WHEEL_EVENT
3717 || sp
->kind
== HORIZ_WHEEL_EVENT
3719 || sp
->kind
== GPM_CLICK_EVENT
3721 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3723 sp
->kind
= NO_EVENT
;
3729 /* Return non-zero if there are any real events waiting in the event
3730 buffer, not counting `NO_EVENT's.
3732 If DISCARD is non-zero, discard NO_EVENT events at the front of
3733 the input queue, possibly leaving the input queue empty if there
3734 are no real input events. */
3737 kbd_buffer_events_waiting (int discard
)
3739 struct input_event
*sp
;
3741 for (sp
= kbd_fetch_ptr
;
3742 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3745 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3752 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3756 /* Clear input event EVENT. */
3759 clear_event (struct input_event
*event
)
3761 event
->kind
= NO_EVENT
;
3765 /* Read one event from the event buffer, waiting if necessary.
3766 The value is a Lisp object representing the event.
3767 The value is nil for an event that should be ignored,
3768 or that was handled here.
3769 We always read and discard one event. */
3772 kbd_buffer_get_event (KBOARD
**kbp
,
3773 int *used_mouse_menu
,
3774 struct timeval
*end_time
)
3780 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3782 /* Start reading input again, we have processed enough so we can
3783 accept new events again. */
3784 unhold_keyboard_input ();
3786 if (!noninteractive
)
3787 signal (SIGIO
, input_available_signal
);
3791 #endif /* subprocesses */
3794 /* In case we are running as a daemon, only do this before
3795 detaching from the terminal. */
3796 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3800 *kbp
= current_kboard
;
3804 /* Wait until there is input available. */
3807 /* Break loop if there's an unread command event. Needed in
3808 moused window autoselection which uses a timer to insert such
3810 if (CONSP (Vunread_command_events
))
3813 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3815 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3816 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3820 /* If the quit flag is set, then read_char will return
3821 quit_char, so that counts as "available input." */
3822 if (!NILP (Vquit_flag
))
3823 quit_throw_to_read_char ();
3825 /* One way or another, wait until input is available; then, if
3826 interrupt handlers have not read it, read it now. */
3828 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3832 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3834 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3835 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3840 EMACS_TIME duration
;
3841 EMACS_GET_TIME (duration
);
3842 if (EMACS_TIME_GE (duration
, *end_time
))
3843 return Qnil
; /* finished waiting */
3846 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3847 wait_reading_process_output (EMACS_SECS (duration
),
3848 EMACS_USECS (duration
),
3849 -1, 1, Qnil
, NULL
, 0);
3853 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3855 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3856 /* Pass 1 for EXPECT since we just waited to have input. */
3857 read_avail_input (1);
3860 if (CONSP (Vunread_command_events
))
3863 first
= XCAR (Vunread_command_events
);
3864 Vunread_command_events
= XCDR (Vunread_command_events
);
3865 *kbp
= current_kboard
;
3869 /* At this point, we know that there is a readable event available
3870 somewhere. If the event queue is empty, then there must be a
3871 mouse movement enabled and available. */
3872 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3874 struct input_event
*event
;
3876 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3880 last_event_timestamp
= event
->timestamp
;
3882 *kbp
= event_to_kboard (event
);
3884 *kbp
= current_kboard
; /* Better than returning null ptr? */
3888 /* These two kinds of events get special handling
3889 and don't actually appear to the command loop.
3890 We return nil for them. */
3891 if (event
->kind
== SELECTION_REQUEST_EVENT
3892 || event
->kind
== SELECTION_CLEAR_EVENT
)
3895 struct input_event copy
;
3897 /* Remove it from the buffer before processing it,
3898 since otherwise swallow_events will see it
3899 and process it again. */
3901 kbd_fetch_ptr
= event
+ 1;
3902 input_pending
= readable_events (0);
3903 x_handle_selection_event (©
);
3905 /* We're getting selection request events, but we don't have
3911 #if defined (HAVE_NS)
3912 else if (event
->kind
== NS_TEXT_EVENT
)
3914 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3915 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3917 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3918 kbd_fetch_ptr
= event
+ 1;
3919 if (used_mouse_menu
)
3920 *used_mouse_menu
= 1;
3924 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3925 || defined (HAVE_NS)
3926 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3928 /* Make an event (delete-frame (FRAME)). */
3929 obj
= Fcons (event
->frame_or_window
, Qnil
);
3930 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3931 kbd_fetch_ptr
= event
+ 1;
3934 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3935 || defined (HAVE_NS)
3936 else if (event
->kind
== ICONIFY_EVENT
)
3938 /* Make an event (iconify-frame (FRAME)). */
3939 obj
= Fcons (event
->frame_or_window
, Qnil
);
3940 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3941 kbd_fetch_ptr
= event
+ 1;
3943 else if (event
->kind
== DEICONIFY_EVENT
)
3945 /* Make an event (make-frame-visible (FRAME)). */
3946 obj
= Fcons (event
->frame_or_window
, Qnil
);
3947 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3948 kbd_fetch_ptr
= event
+ 1;
3951 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3953 /* The value doesn't matter here; only the type is tested. */
3954 XSETBUFFER (obj
, current_buffer
);
3955 kbd_fetch_ptr
= event
+ 1;
3957 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3958 || defined (HAVE_NS) || defined (USE_GTK)
3959 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3961 kbd_fetch_ptr
= event
+ 1;
3962 input_pending
= readable_events (0);
3963 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3964 x_activate_menubar (XFRAME (event
->frame_or_window
));
3967 #if defined (WINDOWSNT)
3968 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3970 /* Make an event (language-change (FRAME CHARSET LCID)). */
3971 obj
= Fcons (event
->frame_or_window
, Qnil
);
3972 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3973 kbd_fetch_ptr
= event
+ 1;
3976 else if (event
->kind
== SAVE_SESSION_EVENT
)
3978 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3979 kbd_fetch_ptr
= event
+ 1;
3981 /* Just discard these, by returning nil.
3982 With MULTI_KBOARD, these events are used as placeholders
3983 when we need to randomly delete events from the queue.
3984 (They shouldn't otherwise be found in the buffer,
3985 but on some machines it appears they do show up
3986 even without MULTI_KBOARD.) */
3987 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3988 mouse events during a popup-menu call. */
3989 else if (event
->kind
== NO_EVENT
)
3990 kbd_fetch_ptr
= event
+ 1;
3991 else if (event
->kind
== HELP_EVENT
)
3993 Lisp_Object object
, position
, help
, frame
, window
;
3995 frame
= event
->frame_or_window
;
3996 object
= event
->arg
;
3997 position
= make_number (event
->code
);
4000 clear_event (event
);
4002 kbd_fetch_ptr
= event
+ 1;
4003 if (!WINDOWP (window
))
4005 obj
= Fcons (Qhelp_echo
,
4006 list5 (frame
, help
, window
, object
, position
));
4008 else if (event
->kind
== FOCUS_IN_EVENT
)
4010 /* Notification of a FocusIn event. The frame receiving the
4011 focus is in event->frame_or_window. Generate a
4012 switch-frame event if necessary. */
4013 Lisp_Object frame
, focus
;
4015 frame
= event
->frame_or_window
;
4016 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4020 if (!EQ (frame
, internal_last_event_frame
)
4021 && !EQ (frame
, selected_frame
))
4022 obj
= make_lispy_switch_frame (frame
);
4023 internal_last_event_frame
= frame
;
4024 kbd_fetch_ptr
= event
+ 1;
4027 else if (event
->kind
== DBUS_EVENT
)
4029 obj
= make_lispy_event (event
);
4030 kbd_fetch_ptr
= event
+ 1;
4033 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4035 obj
= make_lispy_event (event
);
4036 kbd_fetch_ptr
= event
+ 1;
4040 /* If this event is on a different frame, return a switch-frame this
4041 time, and leave the event in the queue for next time. */
4045 frame
= event
->frame_or_window
;
4047 frame
= XCAR (frame
);
4048 else if (WINDOWP (frame
))
4049 frame
= WINDOW_FRAME (XWINDOW (frame
));
4051 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4055 if (! EQ (frame
, internal_last_event_frame
)
4056 && !EQ (frame
, selected_frame
))
4057 obj
= make_lispy_switch_frame (frame
);
4058 internal_last_event_frame
= frame
;
4060 /* If we didn't decide to make a switch-frame event, go ahead
4061 and build a real event from the queue entry. */
4065 obj
= make_lispy_event (event
);
4067 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4068 || defined (HAVE_NS) || defined (USE_GTK)
4069 /* If this was a menu selection, then set the flag to inhibit
4070 writing to last_nonmenu_event. Don't do this if the event
4071 we're returning is (menu-bar), though; that indicates the
4072 beginning of the menu sequence, and we might as well leave
4073 that as the `event with parameters' for this selection. */
4075 && !EQ (event
->frame_or_window
, event
->arg
)
4076 && (event
->kind
== MENU_BAR_EVENT
4077 || event
->kind
== TOOL_BAR_EVENT
))
4078 *used_mouse_menu
= 1;
4081 /* certain system events are non-key events */
4083 && event
->kind
== NS_NONKEY_EVENT
)
4084 *used_mouse_menu
= 1;
4087 /* Wipe out this event, to catch bugs. */
4088 clear_event (event
);
4089 kbd_fetch_ptr
= event
+ 1;
4093 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4094 /* Try generating a mouse motion event. */
4095 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4097 FRAME_PTR f
= some_mouse_moved ();
4098 Lisp_Object bar_window
;
4099 enum scroll_bar_part part
;
4103 *kbp
= current_kboard
;
4104 /* Note that this uses F to determine which terminal to look at.
4105 If there is no valid info, it does not store anything
4106 so x remains nil. */
4109 /* XXX Can f or mouse_position_hook be NULL here? */
4110 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4111 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4116 /* Decide if we should generate a switch-frame event. Don't
4117 generate switch-frame events for motion outside of all Emacs
4123 frame
= FRAME_FOCUS_FRAME (f
);
4125 XSETFRAME (frame
, f
);
4127 if (! EQ (frame
, internal_last_event_frame
)
4128 && !EQ (frame
, selected_frame
))
4129 obj
= make_lispy_switch_frame (frame
);
4130 internal_last_event_frame
= frame
;
4133 /* If we didn't decide to make a switch-frame event, go ahead and
4134 return a mouse-motion event. */
4135 if (!NILP (x
) && NILP (obj
))
4136 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4138 #endif /* HAVE_MOUSE || HAVE GPM */
4140 /* We were promised by the above while loop that there was
4141 something for us to read! */
4144 input_pending
= readable_events (0);
4146 Vlast_event_frame
= internal_last_event_frame
;
4151 /* Process any events that are not user-visible,
4152 then return, without reading any user-visible events. */
4155 swallow_events (int do_display
)
4159 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4161 struct input_event
*event
;
4163 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4167 last_event_timestamp
= event
->timestamp
;
4169 /* These two kinds of events get special handling
4170 and don't actually appear to the command loop. */
4171 if (event
->kind
== SELECTION_REQUEST_EVENT
4172 || event
->kind
== SELECTION_CLEAR_EVENT
)
4175 struct input_event copy
;
4177 /* Remove it from the buffer before processing it,
4178 since otherwise swallow_events called recursively could see it
4179 and process it again. */
4181 kbd_fetch_ptr
= event
+ 1;
4182 input_pending
= readable_events (0);
4183 x_handle_selection_event (©
);
4185 /* We're getting selection request events, but we don't have
4194 old_timers_run
= timers_run
;
4195 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4197 if (timers_run
!= old_timers_run
&& do_display
)
4198 redisplay_preserve_echo_area (7);
4201 /* Record the start of when Emacs is idle,
4202 for the sake of running idle-time timers. */
4205 timer_start_idle (void)
4209 /* If we are already in the idle state, do nothing. */
4210 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4213 EMACS_GET_TIME (timer_idleness_start_time
);
4215 timer_last_idleness_start_time
= timer_idleness_start_time
;
4217 /* Mark all idle-time timers as once again candidates for running. */
4218 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4222 timer
= XCAR (timers
);
4224 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4226 XVECTOR (timer
)->contents
[0] = Qnil
;
4230 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4233 timer_stop_idle (void)
4235 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4238 /* Resume idle timer from last idle start time. */
4241 timer_resume_idle (void)
4243 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4246 timer_idleness_start_time
= timer_last_idleness_start_time
;
4249 /* This is only for debugging. */
4250 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4252 /* List of elisp functions to call, delayed because they were generated in
4253 a context where Elisp could not be safely run (e.g. redisplay, signal,
4254 ...). Each element has the form (FUN . ARGS). */
4255 Lisp_Object pending_funcalls
;
4257 /* Check whether a timer has fired. To prevent larger problems we simply
4258 disregard elements that are not proper timers. Do not make a circular
4259 timer list for the time being.
4261 Returns the time to wait until the next timer fires. If a
4262 timer is triggering now, return zero.
4263 If no timer is active, return -1.
4265 If a timer is ripe, we run it, with quitting turned off.
4266 In that case we return 0 to indicate that a new timer_check_2 call
4270 timer_check_2 (void)
4272 EMACS_TIME nexttime
;
4274 EMACS_TIME idleness_now
IF_LINT (= {0});
4275 Lisp_Object timers
, idle_timers
, chosen_timer
;
4276 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4278 EMACS_SET_SECS (nexttime
, -1);
4279 EMACS_SET_USECS (nexttime
, -1);
4281 /* Always consider the ordinary timers. */
4282 timers
= Vtimer_list
;
4283 /* Consider the idle timers only if Emacs is idle. */
4284 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4285 idle_timers
= Vtimer_idle_list
;
4288 chosen_timer
= Qnil
;
4289 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4291 /* First run the code that was delayed. */
4292 while (CONSP (pending_funcalls
))
4294 Lisp_Object funcall
= XCAR (pending_funcalls
);
4295 pending_funcalls
= XCDR (pending_funcalls
);
4296 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4299 if (CONSP (timers
) || CONSP (idle_timers
))
4301 EMACS_GET_TIME (now
);
4302 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4303 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4306 while (CONSP (timers
) || CONSP (idle_timers
))
4308 Lisp_Object
*vector
;
4309 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4310 EMACS_TIME timer_time
, idle_timer_time
;
4311 EMACS_TIME difference
;
4312 EMACS_TIME timer_difference
IF_LINT (= {0});
4313 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4315 /* Skip past invalid timers and timers already handled. */
4318 timer
= XCAR (timers
);
4319 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4321 timers
= XCDR (timers
);
4324 vector
= XVECTOR (timer
)->contents
;
4326 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4327 || !INTEGERP (vector
[3])
4328 || ! NILP (vector
[0]))
4330 timers
= XCDR (timers
);
4334 if (CONSP (idle_timers
))
4336 timer
= XCAR (idle_timers
);
4337 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4339 idle_timers
= XCDR (idle_timers
);
4342 vector
= XVECTOR (timer
)->contents
;
4344 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4345 || !INTEGERP (vector
[3])
4346 || ! NILP (vector
[0]))
4348 idle_timers
= XCDR (idle_timers
);
4353 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4354 based on the next ordinary timer.
4355 TIMER_DIFFERENCE is the distance in time from NOW to when
4356 this timer becomes ripe (negative if it's already ripe). */
4359 timer
= XCAR (timers
);
4360 vector
= XVECTOR (timer
)->contents
;
4361 EMACS_SET_SECS (timer_time
,
4362 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4363 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4364 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4367 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4368 based on the next idle timer. */
4369 if (CONSP (idle_timers
))
4371 idle_timer
= XCAR (idle_timers
);
4372 vector
= XVECTOR (idle_timer
)->contents
;
4373 EMACS_SET_SECS (idle_timer_time
,
4374 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4375 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4376 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4379 /* Decide which timer is the next timer,
4380 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4381 Also step down the list where we found that timer. */
4383 if (CONSP (timers
) && CONSP (idle_timers
))
4386 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4387 if (EMACS_TIME_NEG_P (temp
))
4389 chosen_timer
= timer
;
4390 timers
= XCDR (timers
);
4391 difference
= timer_difference
;
4395 chosen_timer
= idle_timer
;
4396 idle_timers
= XCDR (idle_timers
);
4397 difference
= idle_timer_difference
;
4400 else if (CONSP (timers
))
4402 chosen_timer
= timer
;
4403 timers
= XCDR (timers
);
4404 difference
= timer_difference
;
4408 chosen_timer
= idle_timer
;
4409 idle_timers
= XCDR (idle_timers
);
4410 difference
= idle_timer_difference
;
4412 vector
= XVECTOR (chosen_timer
)->contents
;
4414 /* If timer is ripe, run it if it hasn't been run. */
4415 if (EMACS_TIME_NEG_P (difference
)
4416 || (EMACS_SECS (difference
) == 0
4417 && EMACS_USECS (difference
) == 0))
4419 if (NILP (vector
[0]))
4421 ptrdiff_t count
= SPECPDL_INDEX ();
4422 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4424 /* Mark the timer as triggered to prevent problems if the lisp
4425 code fails to reschedule it right. */
4428 specbind (Qinhibit_quit
, Qt
);
4430 call1 (Qtimer_event_handler
, chosen_timer
);
4431 Vdeactivate_mark
= old_deactivate_mark
;
4433 unbind_to (count
, Qnil
);
4435 /* Since we have handled the event,
4436 we don't need to tell the caller to wake up and do it. */
4437 /* But the caller must still wait for the next timer, so
4438 return 0 to indicate that. */
4441 EMACS_SET_SECS (nexttime
, 0);
4442 EMACS_SET_USECS (nexttime
, 0);
4445 /* When we encounter a timer that is still waiting,
4446 return the amount of time to wait before it is ripe. */
4453 /* No timers are pending in the future. */
4454 /* Return 0 if we generated an event, and -1 if not. */
4460 /* Check whether a timer has fired. To prevent larger problems we simply
4461 disregard elements that are not proper timers. Do not make a circular
4462 timer list for the time being.
4464 Returns the time to wait until the next timer fires.
4465 If no timer is active, return -1.
4467 As long as any timer is ripe, we run it. */
4472 EMACS_TIME nexttime
;
4476 nexttime
= timer_check_2 ();
4478 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4483 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4484 doc
: /* Return the current length of Emacs idleness, or nil.
4485 The value when Emacs is idle is a list of three integers. The first has
4486 the most significant 16 bits of the seconds, while the second has the least
4487 significant 16 bits. The third integer gives the microsecond count.
4489 The value when Emacs is not idle is nil.
4491 The microsecond count is zero on systems that do not provide
4492 resolution finer than a second. */)
4495 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4497 EMACS_TIME now
, idleness_now
;
4499 EMACS_GET_TIME (now
);
4500 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4502 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4503 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4504 make_number (EMACS_USECS (idleness_now
)));
4510 /* Caches for modify_event_symbol. */
4511 static Lisp_Object accent_key_syms
;
4512 static Lisp_Object func_key_syms
;
4513 static Lisp_Object mouse_syms
;
4514 static Lisp_Object wheel_syms
;
4515 static Lisp_Object drag_n_drop_syms
;
4517 /* This is a list of keysym codes for special "accent" characters.
4518 It parallels lispy_accent_keys. */
4520 static const int lispy_accent_codes
[] =
4522 #ifdef XK_dead_circumflex
4527 #ifdef XK_dead_grave
4532 #ifdef XK_dead_tilde
4537 #ifdef XK_dead_diaeresis
4542 #ifdef XK_dead_macron
4547 #ifdef XK_dead_degree
4552 #ifdef XK_dead_acute
4557 #ifdef XK_dead_cedilla
4562 #ifdef XK_dead_breve
4567 #ifdef XK_dead_ogonek
4572 #ifdef XK_dead_caron
4577 #ifdef XK_dead_doubleacute
4578 XK_dead_doubleacute
,
4582 #ifdef XK_dead_abovedot
4587 #ifdef XK_dead_abovering
4597 #ifdef XK_dead_belowdot
4602 #ifdef XK_dead_voiced_sound
4603 XK_dead_voiced_sound
,
4607 #ifdef XK_dead_semivoiced_sound
4608 XK_dead_semivoiced_sound
,
4624 /* This is a list of Lisp names for special "accent" characters.
4625 It parallels lispy_accent_codes. */
4627 static const char *const lispy_accent_keys
[] =
4645 "dead-voiced-sound",
4646 "dead-semivoiced-sound",
4652 #define FUNCTION_KEY_OFFSET 0x0
4654 const char *const lispy_function_keys
[] =
4658 0, /* VK_LBUTTON 0x01 */
4659 0, /* VK_RBUTTON 0x02 */
4660 "cancel", /* VK_CANCEL 0x03 */
4661 0, /* VK_MBUTTON 0x04 */
4663 0, 0, 0, /* 0x05 .. 0x07 */
4665 "backspace", /* VK_BACK 0x08 */
4666 "tab", /* VK_TAB 0x09 */
4668 0, 0, /* 0x0A .. 0x0B */
4670 "clear", /* VK_CLEAR 0x0C */
4671 "return", /* VK_RETURN 0x0D */
4673 0, 0, /* 0x0E .. 0x0F */
4675 0, /* VK_SHIFT 0x10 */
4676 0, /* VK_CONTROL 0x11 */
4677 0, /* VK_MENU 0x12 */
4678 "pause", /* VK_PAUSE 0x13 */
4679 "capslock", /* VK_CAPITAL 0x14 */
4680 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4682 "junja", /* VK_JUNJA 0x17 */
4683 "final", /* VK_FINAL 0x18 */
4684 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4686 "escape", /* VK_ESCAPE 0x1B */
4687 "convert", /* VK_CONVERT 0x1C */
4688 "non-convert", /* VK_NONCONVERT 0x1D */
4689 "accept", /* VK_ACCEPT 0x1E */
4690 "mode-change", /* VK_MODECHANGE 0x1F */
4691 0, /* VK_SPACE 0x20 */
4692 "prior", /* VK_PRIOR 0x21 */
4693 "next", /* VK_NEXT 0x22 */
4694 "end", /* VK_END 0x23 */
4695 "home", /* VK_HOME 0x24 */
4696 "left", /* VK_LEFT 0x25 */
4697 "up", /* VK_UP 0x26 */
4698 "right", /* VK_RIGHT 0x27 */
4699 "down", /* VK_DOWN 0x28 */
4700 "select", /* VK_SELECT 0x29 */
4701 "print", /* VK_PRINT 0x2A */
4702 "execute", /* VK_EXECUTE 0x2B */
4703 "snapshot", /* VK_SNAPSHOT 0x2C */
4704 "insert", /* VK_INSERT 0x2D */
4705 "delete", /* VK_DELETE 0x2E */
4706 "help", /* VK_HELP 0x2F */
4708 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4710 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4712 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4714 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4716 0, 0, 0, 0, 0, 0, 0, 0, 0,
4717 0, 0, 0, 0, 0, 0, 0, 0, 0,
4718 0, 0, 0, 0, 0, 0, 0, 0,
4720 "lwindow", /* VK_LWIN 0x5B */
4721 "rwindow", /* VK_RWIN 0x5C */
4722 "apps", /* VK_APPS 0x5D */
4725 "kp-0", /* VK_NUMPAD0 0x60 */
4726 "kp-1", /* VK_NUMPAD1 0x61 */
4727 "kp-2", /* VK_NUMPAD2 0x62 */
4728 "kp-3", /* VK_NUMPAD3 0x63 */
4729 "kp-4", /* VK_NUMPAD4 0x64 */
4730 "kp-5", /* VK_NUMPAD5 0x65 */
4731 "kp-6", /* VK_NUMPAD6 0x66 */
4732 "kp-7", /* VK_NUMPAD7 0x67 */
4733 "kp-8", /* VK_NUMPAD8 0x68 */
4734 "kp-9", /* VK_NUMPAD9 0x69 */
4735 "kp-multiply", /* VK_MULTIPLY 0x6A */
4736 "kp-add", /* VK_ADD 0x6B */
4737 "kp-separator", /* VK_SEPARATOR 0x6C */
4738 "kp-subtract", /* VK_SUBTRACT 0x6D */
4739 "kp-decimal", /* VK_DECIMAL 0x6E */
4740 "kp-divide", /* VK_DIVIDE 0x6F */
4741 "f1", /* VK_F1 0x70 */
4742 "f2", /* VK_F2 0x71 */
4743 "f3", /* VK_F3 0x72 */
4744 "f4", /* VK_F4 0x73 */
4745 "f5", /* VK_F5 0x74 */
4746 "f6", /* VK_F6 0x75 */
4747 "f7", /* VK_F7 0x76 */
4748 "f8", /* VK_F8 0x77 */
4749 "f9", /* VK_F9 0x78 */
4750 "f10", /* VK_F10 0x79 */
4751 "f11", /* VK_F11 0x7A */
4752 "f12", /* VK_F12 0x7B */
4753 "f13", /* VK_F13 0x7C */
4754 "f14", /* VK_F14 0x7D */
4755 "f15", /* VK_F15 0x7E */
4756 "f16", /* VK_F16 0x7F */
4757 "f17", /* VK_F17 0x80 */
4758 "f18", /* VK_F18 0x81 */
4759 "f19", /* VK_F19 0x82 */
4760 "f20", /* VK_F20 0x83 */
4761 "f21", /* VK_F21 0x84 */
4762 "f22", /* VK_F22 0x85 */
4763 "f23", /* VK_F23 0x86 */
4764 "f24", /* VK_F24 0x87 */
4766 0, 0, 0, 0, /* 0x88 .. 0x8B */
4767 0, 0, 0, 0, /* 0x8C .. 0x8F */
4769 "kp-numlock", /* VK_NUMLOCK 0x90 */
4770 "scroll", /* VK_SCROLL 0x91 */
4771 /* Not sure where the following block comes from.
4772 Windows headers have NEC and Fujitsu specific keys in
4773 this block, but nothing generic. */
4774 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4775 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4776 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4777 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4778 "kp-end", /* VK_NUMPAD_END 0x96 */
4779 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4780 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4781 "kp-up", /* VK_NUMPAD_UP 0x99 */
4782 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4783 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4784 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4785 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4787 0, 0, /* 0x9E .. 0x9F */
4790 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4791 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4792 * No other API or message will distinguish left and right keys this way.
4797 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4798 to enable them selectively, and gives access to a few more functions.
4799 See lispy_multimedia_keys below. */
4800 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4801 0, 0, 0, /* 0xAD .. 0xAF Volume */
4802 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4803 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4805 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4806 0, 0, 0, 0, 0, 0, 0, 0, 0,
4808 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4809 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4810 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4813 "ax", /* VK_OEM_AX 0xE1 */
4814 0, /* VK_OEM_102 0xE2 */
4815 "ico-help", /* VK_ICO_HELP 0xE3 */
4816 "ico-00", /* VK_ICO_00 0xE4 */
4817 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4818 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4819 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4821 "reset", /* VK_OEM_RESET 0xE9 */
4822 "jump", /* VK_OEM_JUMP 0xEA */
4823 "oem-pa1", /* VK_OEM_PA1 0xEB */
4824 "oem-pa2", /* VK_OEM_PA2 0xEC */
4825 "oem-pa3", /* VK_OEM_PA3 0xED */
4826 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4827 "cusel", /* VK_OEM_CUSEL 0xEF */
4828 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4829 "finish", /* VK_OEM_FINISH 0xF1 */
4830 "copy", /* VK_OEM_COPY 0xF2 */
4831 "auto", /* VK_OEM_AUTO 0xF3 */
4832 "enlw", /* VK_OEM_ENLW 0xF4 */
4833 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4834 "attn", /* VK_ATTN 0xF6 */
4835 "crsel", /* VK_CRSEL 0xF7 */
4836 "exsel", /* VK_EXSEL 0xF8 */
4837 "ereof", /* VK_EREOF 0xF9 */
4838 "play", /* VK_PLAY 0xFA */
4839 "zoom", /* VK_ZOOM 0xFB */
4840 "noname", /* VK_NONAME 0xFC */
4841 "pa1", /* VK_PA1 0xFD */
4842 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4846 /* Some of these duplicate the "Media keys" on newer keyboards,
4847 but they are delivered to the application in a different way. */
4848 static const char *const lispy_multimedia_keys
[] =
4856 "browser-favorites",
4893 "toggle-dictate-command",
4899 "media-fast-forward",
4902 "media-channel-down"
4905 #else /* not HAVE_NTGUI */
4907 /* This should be dealt with in XTread_socket now, and that doesn't
4908 depend on the client system having the Kana syms defined. See also
4909 the XK_kana_A case below. */
4912 static const char *const lispy_kana_keys
[] =
4914 /* X Keysym value */
4915 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4916 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4917 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4918 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4919 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4920 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4921 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4922 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4923 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4924 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4925 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4926 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4927 "kana-i", "kana-u", "kana-e", "kana-o",
4928 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4929 "prolongedsound", "kana-A", "kana-I", "kana-U",
4930 "kana-E", "kana-O", "kana-KA", "kana-KI",
4931 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4932 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4933 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4934 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4935 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4936 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4937 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4938 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4939 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4940 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4941 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4942 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4944 #endif /* XK_kana_A */
4947 #define FUNCTION_KEY_OFFSET 0xff00
4949 /* You'll notice that this table is arranged to be conveniently
4950 indexed by X Windows keysym values. */
4951 static const char *const lispy_function_keys
[] =
4953 /* X Keysym value */
4955 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4956 "backspace", "tab", "linefeed", "clear",
4958 0, 0, 0, "pause", /* 0xff10...1f */
4959 0, 0, 0, 0, 0, 0, 0, "escape",
4961 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4962 "romaji", "hiragana", "katakana", "hiragana-katakana",
4963 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4964 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4965 "eisu-toggle", /* 0xff30...3f */
4966 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4967 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4969 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4970 "down", "prior", "next", "end",
4971 "begin", 0, 0, 0, 0, 0, 0, 0,
4972 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4983 "break", /* 0xff6b */
4986 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4987 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4988 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4989 0, 0, 0, 0, 0, 0, 0, 0,
4990 "kp-tab", /* 0xff89 */
4992 "kp-enter", /* 0xff8d */
4994 "kp-f1", /* 0xff91 */
4998 "kp-home", /* 0xff95 */
5003 "kp-prior", /* kp-page-up */
5004 "kp-next", /* kp-page-down */
5010 0, 0, 0, 0, 0, 0, 0, 0, 0,
5011 "kp-multiply", /* 0xffaa */
5016 "kp-divide", /* 0xffaf */
5017 "kp-0", /* 0xffb0 */
5018 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5021 "kp-equal", /* 0xffbd */
5022 "f1", /* 0xffbe */ /* IsFunctionKey */
5024 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5025 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5026 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5027 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5028 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5029 0, 0, 0, 0, 0, 0, 0, 0,
5030 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5031 0, 0, 0, 0, 0, 0, 0, "delete"
5034 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5035 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5037 static const char *const iso_lispy_function_keys
[] =
5039 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5040 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5041 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5042 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5043 "iso-lefttab", /* 0xfe20 */
5044 "iso-move-line-up", "iso-move-line-down",
5045 "iso-partial-line-up", "iso-partial-line-down",
5046 "iso-partial-space-left", "iso-partial-space-right",
5047 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5048 "iso-release-margin-left", "iso-release-margin-right",
5049 "iso-release-both-margins",
5050 "iso-fast-cursor-left", "iso-fast-cursor-right",
5051 "iso-fast-cursor-up", "iso-fast-cursor-down",
5052 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5053 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5056 #endif /* not HAVE_NTGUI */
5058 static Lisp_Object Vlispy_mouse_stem
;
5060 static const char *const lispy_wheel_names
[] =
5062 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5065 /* drag-n-drop events are generated when a set of selected files are
5066 dragged from another application and dropped onto an Emacs window. */
5067 static const char *const lispy_drag_n_drop_names
[] =
5072 /* Scroll bar parts. */
5073 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5074 Lisp_Object Qup
, Qdown
, Qbottom
;
5075 static Lisp_Object Qend_scroll
;
5077 static Lisp_Object Qratio
;
5079 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5080 static Lisp_Object
*const scroll_bar_parts
[] = {
5081 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5082 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5085 /* A vector, indexed by button number, giving the down-going location
5086 of currently depressed buttons, both scroll bar and non-scroll bar.
5088 The elements have the form
5089 (BUTTON-NUMBER MODIFIER-MASK . REST)
5090 where REST is the cdr of a position as it would be reported in the event.
5092 The make_lispy_event function stores positions here to tell the
5093 difference between click and drag events, and to store the starting
5094 location to be included in drag events. */
5096 static Lisp_Object button_down_location
;
5098 /* Information about the most recent up-going button event: Which
5099 button, what location, and what time. */
5101 static int last_mouse_button
;
5102 static int last_mouse_x
;
5103 static int last_mouse_y
;
5104 static Time button_down_time
;
5106 /* The number of clicks in this multiple-click. */
5108 static int double_click_count
;
5110 /* X and Y are frame-relative coordinates for a click or wheel event.
5111 Return a Lisp-style event list. */
5114 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5117 enum window_part part
;
5118 Lisp_Object posn
= Qnil
;
5119 Lisp_Object extra_info
= Qnil
;
5120 /* Coordinate pixel positions to return. */
5121 int xret
= 0, yret
= 0;
5122 /* The window under frame pixel coordinates (x,y) */
5123 Lisp_Object window
= f
5124 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5127 if (WINDOWP (window
))
5129 /* It's a click in window window at frame coordinates (x,y) */
5130 struct window
*w
= XWINDOW (window
);
5131 Lisp_Object string_info
= Qnil
;
5132 ptrdiff_t textpos
= -1;
5133 int col
= -1, row
= -1;
5134 int dx
= -1, dy
= -1;
5135 int width
= -1, height
= -1;
5136 Lisp_Object object
= Qnil
;
5138 /* Pixel coordinates relative to the window corner. */
5139 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5140 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5142 /* For text area clicks, return X, Y relative to the corner of
5143 this text area. Note that dX, dY etc are set below, by
5144 buffer_posn_from_coords. */
5145 if (part
== ON_TEXT
)
5147 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5148 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5150 /* For mode line and header line clicks, return X, Y relative to
5151 the left window edge. Use mode_line_string to look for a
5152 string on the click position. */
5153 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5158 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5159 /* Note that mode_line_string takes COL, ROW as pixels and
5160 converts them to characters. */
5163 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5164 &object
, &dx
, &dy
, &width
, &height
);
5165 if (STRINGP (string
))
5166 string_info
= Fcons (string
, make_number (charpos
));
5167 textpos
= (w
== XWINDOW (selected_window
)
5168 && current_buffer
== XBUFFER (w
->buffer
))
5169 ? PT
: XMARKER (w
->pointm
)->charpos
;
5174 /* For fringes and margins, Y is relative to the area's (and the
5175 window's) top edge, while X is meaningless. */
5176 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5181 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5184 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5185 &object
, &dx
, &dy
, &width
, &height
);
5186 if (STRINGP (string
))
5187 string_info
= Fcons (string
, make_number (charpos
));
5188 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5190 else if (part
== ON_LEFT_FRINGE
)
5192 posn
= Qleft_fringe
;
5195 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5196 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5197 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5199 else if (part
== ON_RIGHT_FRINGE
)
5201 posn
= Qright_fringe
;
5204 - window_box_width (w
, LEFT_MARGIN_AREA
)
5205 - window_box_width (w
, TEXT_AREA
)
5206 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5207 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5209 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5211 else if (part
== ON_VERTICAL_BORDER
)
5213 posn
= Qvertical_line
;
5218 /* Nothing special for part == ON_SCROLL_BAR. */
5220 /* For clicks in the text area, fringes, or margins, call
5221 buffer_posn_from_coords to extract TEXTPOS, the buffer
5222 position nearest to the click. */
5225 Lisp_Object string2
, object2
= Qnil
;
5226 struct display_pos p
;
5228 int width2
, height2
;
5229 /* The pixel X coordinate passed to buffer_posn_from_coords
5230 is the X coordinate relative to the text area for
5231 text-area and right-margin clicks, zero otherwise. */
5233 = (part
== ON_TEXT
) ? xret
5234 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5235 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5239 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5240 &object2
, &dx2
, &dy2
,
5242 textpos
= CHARPOS (p
.pos
);
5243 if (col
< 0) col
= x2
;
5244 if (row
< 0) row
= y2
;
5245 if (dx
< 0) dx
= dx2
;
5246 if (dy
< 0) dy
= dy2
;
5247 if (width
< 0) width
= width2
;
5248 if (height
< 0) height
= height2
;
5252 posn
= make_number (textpos
);
5253 if (STRINGP (string2
))
5254 string_info
= Fcons (string2
,
5255 make_number (CHARPOS (p
.string_pos
)));
5261 #ifdef HAVE_WINDOW_SYSTEM
5262 if (IMAGEP (object
))
5264 Lisp_Object image_map
, hotspot
;
5265 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5267 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5269 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5270 posn
= XCAR (hotspot
);
5277 Fcons (make_number (dx
), make_number (dy
)),
5278 Fcons (make_number (width
), make_number (height
)));
5281 extra_info
= Fcons (string_info
,
5282 Fcons (make_number (textpos
),
5283 Fcons (Fcons (make_number (col
),
5288 XSETFRAME (window
, f
);
5292 return Fcons (window
,
5294 Fcons (Fcons (make_number (xret
),
5295 make_number (yret
)),
5296 Fcons (make_number (t
),
5300 /* Given a struct input_event, build the lisp event which represents
5301 it. If EVENT is 0, build a mouse movement event from the mouse
5302 movement buffer, which should have a movement event in it.
5304 Note that events must be passed to this function in the order they
5305 are received; this function stores the location of button presses
5306 in order to build drag events when the button is released. */
5309 make_lispy_event (struct input_event
*event
)
5313 switch (SWITCH_ENUM_CAST (event
->kind
))
5315 /* A simple keystroke. */
5316 case ASCII_KEYSTROKE_EVENT
:
5317 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5319 Lisp_Object lispy_c
;
5320 EMACS_INT c
= event
->code
;
5321 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5324 eassert (c
== event
->code
);
5325 /* Turn ASCII characters into control characters
5327 if (event
->modifiers
& ctrl_modifier
)
5329 c
= make_ctrl_char (c
);
5330 event
->modifiers
&= ~ctrl_modifier
;
5334 /* Add in the other modifier bits. The shift key was taken care
5335 of by the X code. */
5336 c
|= (event
->modifiers
5337 & (meta_modifier
| alt_modifier
5338 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5339 /* Distinguish Shift-SPC from SPC. */
5340 if ((event
->code
) == 040
5341 && event
->modifiers
& shift_modifier
)
5342 c
|= shift_modifier
;
5343 button_down_time
= 0;
5344 XSETFASTINT (lispy_c
, c
);
5349 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5350 except that they are non-key events (last-nonmenu-event is nil). */
5351 case NS_NONKEY_EVENT
:
5354 /* A function key. The symbol may need to have modifier prefixes
5356 case NON_ASCII_KEYSTROKE_EVENT
:
5357 button_down_time
= 0;
5359 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5360 if (event
->code
== lispy_accent_codes
[i
])
5361 return modify_event_symbol (i
,
5363 Qfunction_key
, Qnil
,
5364 lispy_accent_keys
, &accent_key_syms
,
5365 (sizeof (lispy_accent_keys
)
5366 / sizeof (lispy_accent_keys
[0])));
5370 if (event
->code
>= 0x400 && event
->code
< 0x500)
5371 return modify_event_symbol (event
->code
- 0x400,
5372 event
->modifiers
& ~shift_modifier
,
5373 Qfunction_key
, Qnil
,
5374 lispy_kana_keys
, &func_key_syms
,
5375 (sizeof (lispy_kana_keys
)
5376 / sizeof (lispy_kana_keys
[0])));
5377 #endif /* XK_kana_A */
5380 #ifdef ISO_FUNCTION_KEY_OFFSET
5381 if (event
->code
< FUNCTION_KEY_OFFSET
5382 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5383 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5385 Qfunction_key
, Qnil
,
5386 iso_lispy_function_keys
, &func_key_syms
,
5387 (sizeof (iso_lispy_function_keys
)
5388 / sizeof (iso_lispy_function_keys
[0])));
5391 /* Handle system-specific or unknown keysyms. */
5392 if (event
->code
& (1 << 28)
5393 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5394 || (event
->code
- FUNCTION_KEY_OFFSET
5395 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5396 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5398 /* We need to use an alist rather than a vector as the cache
5399 since we can't make a vector long enuf. */
5400 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5401 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5402 return modify_event_symbol (event
->code
,
5405 KVAR (current_kboard
, Vsystem_key_alist
),
5406 0, &KVAR (current_kboard
, system_key_syms
),
5410 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5412 Qfunction_key
, Qnil
,
5413 lispy_function_keys
, &func_key_syms
,
5414 (sizeof (lispy_function_keys
)
5415 / sizeof (lispy_function_keys
[0])));
5418 case MULTIMEDIA_KEY_EVENT
:
5419 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5420 / sizeof (lispy_multimedia_keys
[0]))
5421 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5423 return modify_event_symbol (event
->code
, event
->modifiers
,
5424 Qfunction_key
, Qnil
,
5425 lispy_multimedia_keys
, &func_key_syms
,
5426 (sizeof (lispy_multimedia_keys
)
5427 / sizeof (lispy_multimedia_keys
[0])));
5433 /* A mouse click. Figure out where it is, decide whether it's
5434 a press, click or drag, and build the appropriate structure. */
5435 case MOUSE_CLICK_EVENT
:
5436 #ifndef USE_TOOLKIT_SCROLL_BARS
5437 case SCROLL_BAR_CLICK_EVENT
:
5440 int button
= event
->code
;
5442 Lisp_Object position
;
5443 Lisp_Object
*start_pos_ptr
;
5444 Lisp_Object start_pos
;
5448 /* Build the position as appropriate for this mouse click. */
5449 if (event
->kind
== MOUSE_CLICK_EVENT
)
5451 struct frame
*f
= XFRAME (event
->frame_or_window
);
5452 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5456 /* Ignore mouse events that were made on frame that
5457 have been deleted. */
5458 if (! FRAME_LIVE_P (f
))
5461 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5462 /* EVENT->x and EVENT->y are frame-relative pixel
5463 coordinates at this place. Under old redisplay, COLUMN
5464 and ROW are set to frame relative glyph coordinates
5465 which are then used to determine whether this click is
5466 in a menu (non-toolkit version). */
5467 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5468 &column
, &row
, NULL
, 1);
5470 /* In the non-toolkit version, clicks on the menu bar
5471 are ordinary button events in the event buffer.
5472 Distinguish them, and invoke the menu.
5474 (In the toolkit version, the toolkit handles the menu bar
5475 and Emacs doesn't know about it until after the user
5476 makes a selection.) */
5477 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5478 && (event
->modifiers
& down_modifier
))
5480 Lisp_Object items
, item
;
5482 /* Find the menu bar item under `column'. */
5484 items
= FRAME_MENU_BAR_ITEMS (f
);
5485 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5487 Lisp_Object pos
, string
;
5488 string
= AREF (items
, i
+ 1);
5489 pos
= AREF (items
, i
+ 3);
5492 if (column
>= XINT (pos
)
5493 && column
< XINT (pos
) + SCHARS (string
))
5495 item
= AREF (items
, i
);
5500 /* ELisp manual 2.4b says (x y) are window relative but
5501 code says they are frame-relative. */
5503 = Fcons (event
->frame_or_window
,
5505 Fcons (Fcons (event
->x
, event
->y
),
5506 Fcons (make_number (event
->timestamp
),
5509 return Fcons (item
, Fcons (position
, Qnil
));
5511 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5513 position
= make_lispy_position (f
, event
->x
, event
->y
,
5516 #ifndef USE_TOOLKIT_SCROLL_BARS
5519 /* It's a scrollbar click. */
5521 Lisp_Object portion_whole
;
5524 window
= event
->frame_or_window
;
5525 portion_whole
= Fcons (event
->x
, event
->y
);
5526 part
= *scroll_bar_parts
[(int) event
->part
];
5530 Fcons (Qvertical_scroll_bar
,
5531 Fcons (portion_whole
,
5532 Fcons (make_number (event
->timestamp
),
5533 Fcons (part
, Qnil
)))));
5535 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5537 if (button
>= ASIZE (button_down_location
))
5539 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5540 button_down_location
= larger_vector (button_down_location
,
5542 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5545 start_pos_ptr
= &AREF (button_down_location
, button
);
5546 start_pos
= *start_pos_ptr
;
5547 *start_pos_ptr
= Qnil
;
5550 /* On window-system frames, use the value of
5551 double-click-fuzz as is. On other frames, interpret it
5552 as a multiple of 1/8 characters. */
5556 if (WINDOWP (event
->frame_or_window
))
5557 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5558 else if (FRAMEP (event
->frame_or_window
))
5559 f
= XFRAME (event
->frame_or_window
);
5563 if (FRAME_WINDOW_P (f
))
5564 fuzz
= double_click_fuzz
;
5566 fuzz
= double_click_fuzz
/ 8;
5568 is_double
= (button
== last_mouse_button
5569 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5570 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5571 && button_down_time
!= 0
5572 && (EQ (Vdouble_click_time
, Qt
)
5573 || (NATNUMP (Vdouble_click_time
)
5574 && (event
->timestamp
- button_down_time
5575 < XFASTINT (Vdouble_click_time
)))));
5578 last_mouse_button
= button
;
5579 last_mouse_x
= XINT (event
->x
);
5580 last_mouse_y
= XINT (event
->y
);
5582 /* If this is a button press, squirrel away the location, so
5583 we can decide later whether it was a click or a drag. */
5584 if (event
->modifiers
& down_modifier
)
5588 double_click_count
++;
5589 event
->modifiers
|= ((double_click_count
> 2)
5594 double_click_count
= 1;
5595 button_down_time
= event
->timestamp
;
5596 *start_pos_ptr
= Fcopy_alist (position
);
5597 ignore_mouse_drag_p
= 0;
5600 /* Now we're releasing a button - check the co-ordinates to
5601 see if this was a click or a drag. */
5602 else if (event
->modifiers
& up_modifier
)
5604 /* If we did not see a down before this up, ignore the up.
5605 Probably this happened because the down event chose a
5606 menu item. It would be an annoyance to treat the
5607 release of the button that chose the menu item as a
5610 if (!CONSP (start_pos
))
5613 event
->modifiers
&= ~up_modifier
;
5616 Lisp_Object new_down
, down
;
5617 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5619 /* The third element of every position
5620 should be the (x,y) pair. */
5621 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5622 new_down
= Fcar (Fcdr (Fcdr (position
)));
5625 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5627 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5628 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5631 if (ignore_mouse_drag_p
)
5633 event
->modifiers
|= click_modifier
;
5634 ignore_mouse_drag_p
= 0;
5636 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5637 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5638 /* Maybe the mouse has moved a lot, caused scrolling, and
5639 eventually ended up at the same screen position (but
5640 not buffer position) in which case it is a drag, not
5642 /* FIXME: OTOH if the buffer position has changed
5643 because of a timer or process filter rather than
5644 because of mouse movement, it should be considered as
5645 a click. But mouse-drag-region completely ignores
5646 this case and it hasn't caused any real problem, so
5647 it's probably OK to ignore it as well. */
5648 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5649 /* Mouse hasn't moved (much). */
5650 event
->modifiers
|= click_modifier
;
5653 button_down_time
= 0;
5654 event
->modifiers
|= drag_modifier
;
5657 /* Don't check is_double; treat this as multiple
5658 if the down-event was multiple. */
5659 if (double_click_count
> 1)
5660 event
->modifiers
|= ((double_click_count
> 2)
5666 /* Every mouse event should either have the down_modifier or
5667 the up_modifier set. */
5671 /* Get the symbol we should use for the mouse click. */
5674 head
= modify_event_symbol (button
,
5676 Qmouse_click
, Vlispy_mouse_stem
,
5679 ASIZE (mouse_syms
));
5680 if (event
->modifiers
& drag_modifier
)
5685 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5688 Fcons (make_number (double_click_count
),
5698 case HORIZ_WHEEL_EVENT
:
5700 Lisp_Object position
;
5703 /* Build the position as appropriate for this mouse click. */
5704 struct frame
*f
= XFRAME (event
->frame_or_window
);
5706 /* Ignore wheel events that were made on frame that have been
5708 if (! FRAME_LIVE_P (f
))
5711 position
= make_lispy_position (f
, event
->x
, event
->y
,
5714 /* Set double or triple modifiers to indicate the wheel speed. */
5716 /* On window-system frames, use the value of
5717 double-click-fuzz as is. On other frames, interpret it
5718 as a multiple of 1/8 characters. */
5724 if (WINDOWP (event
->frame_or_window
))
5725 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5726 else if (FRAMEP (event
->frame_or_window
))
5727 fr
= XFRAME (event
->frame_or_window
);
5731 fuzz
= FRAME_WINDOW_P (fr
)
5732 ? double_click_fuzz
: double_click_fuzz
/ 8;
5734 if (event
->modifiers
& up_modifier
)
5736 /* Emit a wheel-up event. */
5737 event
->modifiers
&= ~up_modifier
;
5740 else if (event
->modifiers
& down_modifier
)
5742 /* Emit a wheel-down event. */
5743 event
->modifiers
&= ~down_modifier
;
5747 /* Every wheel event should either have the down_modifier or
5748 the up_modifier set. */
5751 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5754 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5755 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5756 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5757 && button_down_time
!= 0
5758 && (EQ (Vdouble_click_time
, Qt
)
5759 || (NATNUMP (Vdouble_click_time
)
5760 && (event
->timestamp
- button_down_time
5761 < XFASTINT (Vdouble_click_time
)))));
5764 double_click_count
++;
5765 event
->modifiers
|= ((double_click_count
> 2)
5771 double_click_count
= 1;
5772 event
->modifiers
|= click_modifier
;
5775 button_down_time
= event
->timestamp
;
5776 /* Use a negative value to distinguish wheel from mouse button. */
5777 last_mouse_button
= - (1 + symbol_num
);
5778 last_mouse_x
= XINT (event
->x
);
5779 last_mouse_y
= XINT (event
->y
);
5781 /* Get the symbol we should use for the wheel event. */
5782 head
= modify_event_symbol (symbol_num
,
5788 ASIZE (wheel_syms
));
5791 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5794 Fcons (make_number (double_click_count
),
5803 #ifdef USE_TOOLKIT_SCROLL_BARS
5805 /* We don't have down and up events if using toolkit scroll bars,
5806 so make this always a click event. Store in the `part' of
5807 the Lisp event a symbol which maps to the following actions:
5809 `above_handle' page up
5810 `below_handle' page down
5814 `bottom' bottom of buffer
5815 `handle' thumb has been dragged.
5816 `end-scroll' end of interaction with scroll bar
5818 The incoming input_event contains in its `part' member an
5819 index of type `enum scroll_bar_part' which we can use as an
5820 index in scroll_bar_parts to get the appropriate symbol. */
5822 case SCROLL_BAR_CLICK_EVENT
:
5824 Lisp_Object position
, head
, window
, portion_whole
, part
;
5826 window
= event
->frame_or_window
;
5827 portion_whole
= Fcons (event
->x
, event
->y
);
5828 part
= *scroll_bar_parts
[(int) event
->part
];
5832 Fcons (Qvertical_scroll_bar
,
5833 Fcons (portion_whole
,
5834 Fcons (make_number (event
->timestamp
),
5835 Fcons (part
, Qnil
)))));
5837 /* Always treat scroll bar events as clicks. */
5838 event
->modifiers
|= click_modifier
;
5839 event
->modifiers
&= ~up_modifier
;
5841 if (event
->code
>= ASIZE (mouse_syms
))
5842 mouse_syms
= larger_vector (mouse_syms
,
5843 event
->code
- ASIZE (mouse_syms
) + 1,
5846 /* Get the symbol we should use for the mouse click. */
5847 head
= modify_event_symbol (event
->code
,
5852 ASIZE (mouse_syms
));
5853 return Fcons (head
, Fcons (position
, Qnil
));
5856 #endif /* USE_TOOLKIT_SCROLL_BARS */
5858 case DRAG_N_DROP_EVENT
:
5861 Lisp_Object head
, position
;
5864 f
= XFRAME (event
->frame_or_window
);
5867 /* Ignore mouse events that were made on frames that
5868 have been deleted. */
5869 if (! FRAME_LIVE_P (f
))
5872 position
= make_lispy_position (f
, event
->x
, event
->y
,
5875 head
= modify_event_symbol (0, event
->modifiers
,
5877 lispy_drag_n_drop_names
,
5878 &drag_n_drop_syms
, 1);
5884 #endif /* HAVE_MOUSE */
5886 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5887 || defined (HAVE_NS) || defined (USE_GTK)
5888 case MENU_BAR_EVENT
:
5889 if (EQ (event
->arg
, event
->frame_or_window
))
5890 /* This is the prefix key. We translate this to
5891 `(menu_bar)' because the code in keyboard.c for menu
5892 events, which we use, relies on this. */
5893 return Fcons (Qmenu_bar
, Qnil
);
5897 case SELECT_WINDOW_EVENT
:
5898 /* Make an event (select-window (WINDOW)). */
5899 return Fcons (Qselect_window
,
5900 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5903 case TOOL_BAR_EVENT
:
5904 if (EQ (event
->arg
, event
->frame_or_window
))
5905 /* This is the prefix key. We translate this to
5906 `(tool_bar)' because the code in keyboard.c for tool bar
5907 events, which we use, relies on this. */
5908 return Fcons (Qtool_bar
, Qnil
);
5909 else if (SYMBOLP (event
->arg
))
5910 return apply_modifiers (event
->modifiers
, event
->arg
);
5913 case USER_SIGNAL_EVENT
:
5914 /* A user signal. */
5916 char *name
= find_user_signal_name (event
->code
);
5919 return intern (name
);
5922 case SAVE_SESSION_EVENT
:
5923 return Qsave_session
;
5928 return Fcons (Qdbus_event
, event
->arg
);
5930 #endif /* HAVE_DBUS */
5932 case CONFIG_CHANGED_EVENT
:
5933 return Fcons (Qconfig_changed_event
,
5935 Fcons (event
->frame_or_window
, Qnil
)));
5937 case GPM_CLICK_EVENT
:
5939 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5940 Lisp_Object head
, position
;
5941 Lisp_Object
*start_pos_ptr
;
5942 Lisp_Object start_pos
;
5943 int button
= event
->code
;
5945 if (button
>= ASIZE (button_down_location
))
5947 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5948 button_down_location
= larger_vector (button_down_location
,
5950 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5953 start_pos_ptr
= &AREF (button_down_location
, button
);
5954 start_pos
= *start_pos_ptr
;
5956 position
= make_lispy_position (f
, event
->x
, event
->y
,
5959 if (event
->modifiers
& down_modifier
)
5960 *start_pos_ptr
= Fcopy_alist (position
);
5961 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5963 if (!CONSP (start_pos
))
5965 event
->modifiers
&= ~up_modifier
;
5968 head
= modify_event_symbol (button
,
5970 Qmouse_click
, Vlispy_mouse_stem
,
5973 ASIZE (mouse_syms
));
5975 if (event
->modifiers
& drag_modifier
)
5980 else if (event
->modifiers
& double_modifier
)
5983 Fcons (make_number (2),
5985 else if (event
->modifiers
& triple_modifier
)
5988 Fcons (make_number (3),
5995 #endif /* HAVE_GPM */
5997 /* The 'kind' field of the event is something we don't recognize. */
6003 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6006 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6007 Lisp_Object x
, Lisp_Object y
, Time t
)
6009 /* Is it a scroll bar movement? */
6010 if (frame
&& ! NILP (bar_window
))
6012 Lisp_Object part_sym
;
6014 part_sym
= *scroll_bar_parts
[(int) part
];
6015 return Fcons (Qscroll_bar_movement
,
6016 Fcons (list5 (bar_window
,
6017 Qvertical_scroll_bar
,
6023 /* Or is it an ordinary mouse movement? */
6026 Lisp_Object position
;
6027 position
= make_lispy_position (frame
, x
, y
, t
);
6028 return list2 (Qmouse_movement
, position
);
6032 #endif /* HAVE_MOUSE || HAVE GPM */
6034 /* Construct a switch frame event. */
6036 make_lispy_switch_frame (Lisp_Object frame
)
6038 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6041 /* Manipulating modifiers. */
6043 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6045 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6046 SYMBOL's name of the end of the modifiers; the string from this
6047 position is the unmodified symbol name.
6049 This doesn't use any caches. */
6052 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6058 CHECK_SYMBOL (symbol
);
6061 name
= SYMBOL_NAME (symbol
);
6063 for (i
= 0; 2 <= SBYTES (name
) - i
; )
6065 ptrdiff_t this_mod_end
= 0;
6068 /* See if the name continues with a modifier word.
6069 Check that the word appears, but don't check what follows it.
6070 Set this_mod and this_mod_end to record what we find. */
6072 switch (SREF (name
, i
))
6074 #define SINGLE_LETTER_MOD(BIT) \
6075 (this_mod_end = i + 1, this_mod = BIT)
6078 SINGLE_LETTER_MOD (alt_modifier
);
6082 SINGLE_LETTER_MOD (ctrl_modifier
);
6086 SINGLE_LETTER_MOD (hyper_modifier
);
6090 SINGLE_LETTER_MOD (meta_modifier
);
6094 SINGLE_LETTER_MOD (shift_modifier
);
6098 SINGLE_LETTER_MOD (super_modifier
);
6101 #undef SINGLE_LETTER_MOD
6103 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6104 if (i + LEN + 1 <= SBYTES (name) \
6105 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6107 this_mod_end = i + LEN; \
6112 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6113 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6114 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6118 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6120 #undef MULTI_LETTER_MOD
6124 /* If we found no modifier, stop looking for them. */
6125 if (this_mod_end
== 0)
6128 /* Check there is a dash after the modifier, so that it
6129 really is a modifier. */
6130 if (this_mod_end
>= SBYTES (name
)
6131 || SREF (name
, this_mod_end
) != '-')
6134 /* This modifier is real; look for another. */
6135 modifiers
|= this_mod
;
6136 i
= this_mod_end
+ 1;
6139 /* Should we include the `click' modifier? */
6140 if (! (modifiers
& (down_modifier
| drag_modifier
6141 | double_modifier
| triple_modifier
))
6142 && i
+ 7 == SBYTES (name
)
6143 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6144 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6145 modifiers
|= click_modifier
;
6147 if (! (modifiers
& (double_modifier
| triple_modifier
))
6148 && i
+ 6 < SBYTES (name
)
6149 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6150 modifiers
|= click_modifier
;
6158 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6159 prepended to the string BASE[0..BASE_LEN-1].
6160 This doesn't use any caches. */
6162 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6164 /* Since BASE could contain nulls, we can't use intern here; we have
6165 to use Fintern, which expects a genuine Lisp_String, and keeps a
6168 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6174 /* Only the event queue may use the `up' modifier; it should always
6175 be turned into a click or drag event before presented to lisp code. */
6176 if (modifiers
& up_modifier
)
6179 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6180 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6181 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6182 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6183 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6184 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6185 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6186 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6187 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6188 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6189 /* The click modifier is denoted by the absence of other modifiers. */
6193 mod_len
= p
- new_mods
;
6197 Lisp_Object new_name
;
6199 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6200 mod_len
+ base_len_byte
);
6201 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6202 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6204 return Fintern (new_name
, Qnil
);
6209 static const char *const modifier_names
[] =
6211 "up", "down", "drag", "click", "double", "triple", 0, 0,
6212 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6213 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6215 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6217 static Lisp_Object modifier_symbols
;
6219 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6221 lispy_modifier_list (int modifiers
)
6223 Lisp_Object modifier_list
;
6226 modifier_list
= Qnil
;
6227 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6228 if (modifiers
& (1<<i
))
6229 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6232 return modifier_list
;
6236 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6237 where UNMODIFIED is the unmodified form of SYMBOL,
6238 MASK is the set of modifiers present in SYMBOL's name.
6239 This is similar to parse_modifiers_uncached, but uses the cache in
6240 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6241 Qevent_symbol_elements property. */
6243 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6246 parse_modifiers (Lisp_Object symbol
)
6248 Lisp_Object elements
;
6250 if (INTEGERP (symbol
))
6251 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6252 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6254 else if (!SYMBOLP (symbol
))
6257 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6258 if (CONSP (elements
))
6263 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6264 Lisp_Object unmodified
;
6267 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6268 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6271 if (modifiers
& ~INTMASK
)
6273 XSETFASTINT (mask
, modifiers
);
6274 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6276 /* Cache the parsing results on SYMBOL. */
6277 Fput (symbol
, Qevent_symbol_element_mask
,
6279 Fput (symbol
, Qevent_symbol_elements
,
6280 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6282 /* Since we know that SYMBOL is modifiers applied to unmodified,
6283 it would be nice to put that in unmodified's cache.
6284 But we can't, since we're not sure that parse_modifiers is
6291 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6292 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6293 doc
: /* Parse the event symbol. For internal use. */)
6294 (Lisp_Object symbol
)
6296 /* Fill the cache if needed. */
6297 parse_modifiers (symbol
);
6298 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6299 and use the Lispier representation stored on Qevent_symbol_elements
6301 return Fget (symbol
, Qevent_symbol_elements
);
6304 /* Apply the modifiers MODIFIERS to the symbol BASE.
6305 BASE must be unmodified.
6307 This is like apply_modifiers_uncached, but uses BASE's
6308 Qmodifier_cache property, if present. It also builds
6309 Qevent_symbol_elements properties, since it has that info anyway.
6311 apply_modifiers copies the value of BASE's Qevent_kind property to
6312 the modified symbol. */
6314 apply_modifiers (int modifiers
, Lisp_Object base
)
6316 Lisp_Object cache
, idx
, entry
, new_symbol
;
6318 /* Mask out upper bits. We don't know where this value's been. */
6319 modifiers
&= INTMASK
;
6321 if (INTEGERP (base
))
6322 return make_number (XINT (base
) | modifiers
);
6324 /* The click modifier never figures into cache indices. */
6325 cache
= Fget (base
, Qmodifier_cache
);
6326 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6327 entry
= assq_no_quit (idx
, cache
);
6330 new_symbol
= XCDR (entry
);
6333 /* We have to create the symbol ourselves. */
6334 new_symbol
= apply_modifiers_uncached (modifiers
,
6335 SSDATA (SYMBOL_NAME (base
)),
6336 SCHARS (SYMBOL_NAME (base
)),
6337 SBYTES (SYMBOL_NAME (base
)));
6339 /* Add the new symbol to the base's cache. */
6340 entry
= Fcons (idx
, new_symbol
);
6341 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6343 /* We have the parsing info now for free, so we could add it to
6345 XSETFASTINT (idx, modifiers);
6346 Fput (new_symbol, Qevent_symbol_element_mask,
6347 Fcons (base, Fcons (idx, Qnil)));
6348 Fput (new_symbol, Qevent_symbol_elements,
6349 Fcons (base, lispy_modifier_list (modifiers)));
6350 Sadly, this is only correct if `base' is indeed a base event,
6351 which is not necessarily the case. -stef */
6354 /* Make sure this symbol is of the same kind as BASE.
6356 You'd think we could just set this once and for all when we
6357 intern the symbol above, but reorder_modifiers may call us when
6358 BASE's property isn't set right; we can't assume that just
6359 because it has a Qmodifier_cache property it must have its
6360 Qevent_kind set right as well. */
6361 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6365 kind
= Fget (base
, Qevent_kind
);
6367 Fput (new_symbol
, Qevent_kind
, kind
);
6374 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6375 return a symbol with the modifiers placed in the canonical order.
6376 Canonical order is alphabetical, except for down and drag, which
6377 always come last. The 'click' modifier is never written out.
6379 Fdefine_key calls this to make sure that (for example) C-M-foo
6380 and M-C-foo end up being equivalent in the keymap. */
6383 reorder_modifiers (Lisp_Object symbol
)
6385 /* It's hopefully okay to write the code this way, since everything
6386 will soon be in caches, and no consing will be done at all. */
6389 parsed
= parse_modifiers (symbol
);
6390 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6395 /* For handling events, we often want to produce a symbol whose name
6396 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6397 to some base, like the name of a function key or mouse button.
6398 modify_event_symbol produces symbols of this sort.
6400 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6401 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6404 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6405 into symbol names, or a string specifying a name stem used to
6406 construct a symbol name or the form `STEM-N', where N is the decimal
6407 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6408 non-nil; otherwise NAME_TABLE is used.
6410 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6411 persist between calls to modify_event_symbol that it can use to
6412 store a cache of the symbols it's generated for this NAME_TABLE
6413 before. The object stored there may be a vector or an alist.
6415 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6417 MODIFIERS is a set of modifier bits (as given in struct input_events)
6418 whose prefixes should be applied to the symbol name.
6420 SYMBOL_KIND is the value to be placed in the event_kind property of
6421 the returned symbol.
6423 The symbols we create are supposed to have an
6424 `event-symbol-elements' property, which lists the modifiers present
6425 in the symbol's name. */
6428 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6429 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6430 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6433 Lisp_Object symbol_int
;
6435 /* Get rid of the "vendor-specific" bit here. */
6436 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6438 /* Is this a request for a valid symbol? */
6439 if (symbol_num
< 0 || symbol_num
>= table_size
)
6442 if (CONSP (*symbol_table
))
6443 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6445 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6446 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6447 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6448 we've never used that symbol before. */
6451 if (! VECTORP (*symbol_table
)
6452 || ASIZE (*symbol_table
) != table_size
)
6456 XSETFASTINT (size
, table_size
);
6457 *symbol_table
= Fmake_vector (size
, Qnil
);
6460 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6463 /* Have we already used this symbol before? */
6466 /* No; let's create it. */
6467 if (CONSP (name_alist_or_stem
))
6468 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6469 else if (STRINGP (name_alist_or_stem
))
6472 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6473 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6475 SAFE_ALLOCA (buf
, char *, len
);
6476 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6477 XINT (symbol_int
) + 1);
6478 value
= intern (buf
);
6481 else if (name_table
!= 0 && name_table
[symbol_num
])
6482 value
= intern (name_table
[symbol_num
]);
6484 #ifdef HAVE_WINDOW_SYSTEM
6487 char *name
= x_get_keysym_name (symbol_num
);
6489 value
= intern (name
);
6495 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6496 sprintf (buf
, "key-%"pI
"d", symbol_num
);
6497 value
= intern (buf
);
6500 if (CONSP (*symbol_table
))
6501 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6503 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6505 /* Fill in the cache entries for this symbol; this also
6506 builds the Qevent_symbol_elements property, which the user
6508 apply_modifiers (modifiers
& click_modifier
, value
);
6509 Fput (value
, Qevent_kind
, symbol_kind
);
6512 /* Apply modifiers to that symbol. */
6513 return apply_modifiers (modifiers
, value
);
6516 /* Convert a list that represents an event type,
6517 such as (ctrl meta backspace), into the usual representation of that
6518 event type as a number or a symbol. */
6520 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6521 doc
: /* Convert the event description list EVENT-DESC to an event type.
6522 EVENT-DESC should contain one base event type (a character or symbol)
6523 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6524 drag, down, double or triple). The base must be last.
6525 The return value is an event type (a character or symbol) which
6526 has the same base event type and all the specified modifiers. */)
6527 (Lisp_Object event_desc
)
6535 while (CONSP (rest
))
6543 /* Given a symbol, see if it is a modifier name. */
6544 if (SYMBOLP (elt
) && CONSP (rest
))
6545 this = parse_solitary_modifier (elt
);
6549 else if (!NILP (base
))
6550 error ("Two bases given in one event");
6556 /* Let the symbol A refer to the character A. */
6557 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6558 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6560 if (INTEGERP (base
))
6562 /* Turn (shift a) into A. */
6563 if ((modifiers
& shift_modifier
) != 0
6564 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6566 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6567 modifiers
&= ~shift_modifier
;
6570 /* Turn (control a) into C-a. */
6571 if (modifiers
& ctrl_modifier
)
6572 return make_number ((modifiers
& ~ctrl_modifier
)
6573 | make_ctrl_char (XINT (base
)));
6575 return make_number (modifiers
| XINT (base
));
6577 else if (SYMBOLP (base
))
6578 return apply_modifiers (modifiers
, base
);
6581 error ("Invalid base event");
6586 /* Try to recognize SYMBOL as a modifier name.
6587 Return the modifier flag bit, or 0 if not recognized. */
6590 parse_solitary_modifier (Lisp_Object symbol
)
6592 Lisp_Object name
= SYMBOL_NAME (symbol
);
6594 switch (SREF (name
, 0))
6596 #define SINGLE_LETTER_MOD(BIT) \
6597 if (SBYTES (name) == 1) \
6600 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6601 if (LEN == SBYTES (name) \
6602 && ! strncmp (SSDATA (name), NAME, LEN)) \
6606 SINGLE_LETTER_MOD (alt_modifier
);
6610 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6614 SINGLE_LETTER_MOD (ctrl_modifier
);
6618 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6619 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6623 SINGLE_LETTER_MOD (hyper_modifier
);
6627 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6631 SINGLE_LETTER_MOD (meta_modifier
);
6635 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6639 SINGLE_LETTER_MOD (shift_modifier
);
6643 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6644 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6645 SINGLE_LETTER_MOD (super_modifier
);
6649 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6650 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6651 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6655 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6658 #undef SINGLE_LETTER_MOD
6659 #undef MULTI_LETTER_MOD
6665 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6666 Such a list is not valid as an event,
6667 but it can be a Lucid-style event type list. */
6670 lucid_event_type_list_p (Lisp_Object object
)
6674 if (! CONSP (object
))
6677 if (EQ (XCAR (object
), Qhelp_echo
)
6678 || EQ (XCAR (object
), Qvertical_line
)
6679 || EQ (XCAR (object
), Qmode_line
)
6680 || EQ (XCAR (object
), Qheader_line
))
6683 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6687 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6694 /* Store into *addr a value nonzero if terminal input chars are available.
6695 Serves the purpose of ioctl (0, FIONREAD, addr)
6696 but works even if FIONREAD does not exist.
6697 (In fact, this may actually read some input.)
6699 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6700 timer events that are ripe.
6701 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6702 events (FOCUS_IN_EVENT).
6703 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6704 movements and toolkit scroll bar thumb drags. */
6707 get_input_pending (int *addr
, int flags
)
6709 /* First of all, have we already counted some input? */
6710 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6712 /* If input is being read as it arrives, and we have none, there is none. */
6713 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6716 /* Try to read some input and see how much we get. */
6718 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6721 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6724 gobble_input (int expected
)
6727 if (interrupt_input
)
6730 mask
= sigblock (sigmask (SIGIO
));
6731 read_avail_input (expected
);
6735 #ifdef POLL_FOR_INPUT
6736 /* XXX This condition was (read_socket_hook && !interrupt_input),
6737 but read_socket_hook is not global anymore. Let's pretend that
6739 if (!interrupt_input
&& poll_suppress_count
== 0)
6742 mask
= sigblock (sigmask (SIGALRM
));
6743 read_avail_input (expected
);
6749 read_avail_input (expected
);
6752 /* Put a BUFFER_SWITCH_EVENT in the buffer
6753 so that read_key_sequence will notice the new current buffer. */
6756 record_asynch_buffer_change (void)
6758 struct input_event event
;
6762 event
.kind
= BUFFER_SWITCH_EVENT
;
6763 event
.frame_or_window
= Qnil
;
6766 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6767 The purpose of the event is to make read_key_sequence look up the
6768 keymaps again. If we aren't in read_key_sequence, we don't need one,
6769 and the event could cause trouble by messing up (input-pending-p).
6770 Note: Fwaiting_for_user_input_p always returns nil when async
6771 subprocesses aren't supported. */
6772 tem
= Fwaiting_for_user_input_p ();
6776 /* Make sure no interrupt happens while storing the event. */
6778 if (interrupt_input
)
6781 mask
= sigblock (sigmask (SIGIO
));
6782 kbd_buffer_store_event (&event
);
6789 kbd_buffer_store_event (&event
);
6794 /* Read any terminal input already buffered up by the system
6795 into the kbd_buffer, but do not wait.
6797 EXPECTED should be nonzero if the caller knows there is some input.
6799 Returns the number of keyboard chars read, or -1 meaning
6800 this is a bad time to try to read input. */
6803 read_avail_input (int expected
)
6809 /* Store pending user signal events, if any. */
6810 if (store_user_signal_events ())
6813 /* Loop through the available terminals, and call their input hooks. */
6817 struct terminal
*next
= t
->next_terminal
;
6819 if (t
->read_socket_hook
)
6822 struct input_event hold_quit
;
6824 EVENT_INIT (hold_quit
);
6825 hold_quit
.kind
= NO_EVENT
;
6827 /* No need for FIONREAD or fcntl; just say don't wait. */
6828 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6834 if (nr
== -1) /* Not OK to read input now. */
6838 else if (nr
== -2) /* Non-transient error. */
6840 /* The terminal device terminated; it should be closed. */
6842 /* Kill Emacs if this was our last terminal. */
6843 if (!terminal_list
->next_terminal
)
6844 /* Formerly simply reported no input, but that
6845 sometimes led to a failure of Emacs to terminate.
6846 SIGHUP seems appropriate if we can't reach the
6848 /* ??? Is it really right to send the signal just to
6849 this process rather than to the whole process
6850 group? Perhaps on systems with FIONREAD Emacs is
6851 alone in its group. */
6852 kill (getpid (), SIGHUP
);
6854 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6857 XSETTERMINAL (tmp
, t
);
6858 Fdelete_terminal (tmp
, Qnoelisp
);
6862 if (hold_quit
.kind
!= NO_EVENT
)
6863 kbd_buffer_store_event (&hold_quit
);
6872 frame_make_pointer_visible ();
6878 decode_keyboard_code (struct tty_display_info
*tty
,
6879 struct coding_system
*coding
,
6880 unsigned char *buf
, int nbytes
)
6882 unsigned char *src
= buf
;
6883 const unsigned char *p
;
6888 if (tty
->meta_key
!= 2)
6889 for (i
= 0; i
< nbytes
; i
++)
6891 if (coding
->carryover_bytes
> 0)
6893 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6894 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6895 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6896 nbytes
+= coding
->carryover_bytes
;
6898 coding
->destination
= alloca (nbytes
* 4);
6899 coding
->dst_bytes
= nbytes
* 4;
6900 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6901 if (coding
->produced_char
== 0)
6903 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6905 struct input_event event_buf
;
6907 EVENT_INIT (event_buf
);
6908 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6910 (ASCII_CHAR_P (event_buf
.code
)
6911 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6912 /* See the comment in tty_read_avail_input. */
6913 event_buf
.frame_or_window
= tty
->top_frame
;
6914 event_buf
.arg
= Qnil
;
6915 kbd_buffer_store_event (&event_buf
);
6919 /* This is the tty way of reading available input.
6921 Note that each terminal device has its own `struct terminal' object,
6922 and so this function is called once for each individual termcap
6923 terminal. The first parameter indicates which terminal to read from. */
6926 tty_read_avail_input (struct terminal
*terminal
,
6928 struct input_event
*hold_quit
)
6930 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6931 the kbd_buffer can really hold. That may prevent loss
6932 of characters on some systems when input is stuffed at us. */
6933 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6935 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6938 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6940 if (kbd_on_hold_p () || buffer_free
<= 0)
6942 #endif /* subprocesses */
6944 if (!terminal
->name
) /* Don't read from a dead terminal. */
6947 if (terminal
->type
!= output_termcap
6948 && terminal
->type
!= output_msdos_raw
)
6951 /* XXX I think the following code should be moved to separate hook
6952 functions in system-dependent files. */
6955 #else /* not WINDOWSNT */
6956 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6960 return 0; /* The terminal is suspended. */
6963 n_to_read
= dos_keysns ();
6967 cbuf
[0] = dos_keyread ();
6970 #else /* not MSDOS */
6975 struct input_event gpm_hold_quit
;
6976 int gpm
, fd
= gpm_fd
;
6978 EVENT_INIT (gpm_hold_quit
);
6979 gpm_hold_quit
.kind
= NO_EVENT
;
6981 /* gpm==1 if event received.
6982 gpm==0 if the GPM daemon has closed the connection, in which case
6983 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6984 we save it in `fd' so close_gpm can remove it from the
6986 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6987 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6988 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6991 /* Presumably the GPM daemon has closed the connection. */
6993 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6994 kbd_buffer_store_event (&gpm_hold_quit
);
6998 #endif /* HAVE_GPM */
7000 /* Determine how many characters we should *try* to read. */
7002 /* Find out how much input is available. */
7003 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7005 if (! noninteractive
)
7006 return -2; /* Close this terminal. */
7012 if (n_to_read
> sizeof cbuf
)
7013 n_to_read
= sizeof cbuf
;
7014 #else /* no FIONREAD */
7015 #if defined (USG) || defined (CYGWIN)
7016 /* Read some input if available, but don't wait. */
7017 n_to_read
= sizeof cbuf
;
7018 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7025 /* Don't read more than we can store. */
7026 if (n_to_read
> buffer_free
)
7027 n_to_read
= buffer_free
;
7028 #endif /* subprocesses */
7030 /* Now read; for one reason or another, this will not block.
7031 NREAD is set to the number of chars read. */
7034 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7035 /* POSIX infers that processes which are not in the session leader's
7036 process group won't get SIGHUP's at logout time. BSDI adheres to
7037 this part standard and returns -1 from read (0) with errno==EIO
7038 when the control tty is taken away.
7039 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7040 if (nread
== -1 && errno
== EIO
)
7041 return -2; /* Close this terminal. */
7042 #if defined (AIX) && defined (_BSD)
7043 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7044 This looks incorrect, but it isn't, because _BSD causes
7045 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7046 and that causes a value other than 0 when there is no input. */
7048 return -2; /* Close this terminal. */
7052 /* We used to retry the read if it was interrupted.
7053 But this does the wrong thing when O_NDELAY causes
7054 an EAGAIN error. Does anybody know of a situation
7055 where a retry is actually needed? */
7057 nread
< 0 && (errno
== EAGAIN
7071 #if defined (USG) || defined (CYGWIN)
7072 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7073 #endif /* USG or CYGWIN */
7074 #endif /* no FIONREAD */
7079 #endif /* not MSDOS */
7080 #endif /* not WINDOWSNT */
7082 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7083 & CODING_REQUIRE_DECODING_MASK
)
7085 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7088 /* Decode the key sequence except for those with meta
7090 for (i
= from
= 0; ; i
++)
7091 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7093 struct input_event buf
;
7095 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7100 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7101 buf
.modifiers
= meta_modifier
;
7102 buf
.code
= cbuf
[i
] & ~0x80;
7103 /* See the comment below. */
7104 buf
.frame_or_window
= tty
->top_frame
;
7106 kbd_buffer_store_event (&buf
);
7112 for (i
= 0; i
< nread
; i
++)
7114 struct input_event buf
;
7116 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7118 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7119 buf
.modifiers
= meta_modifier
;
7120 if (tty
->meta_key
!= 2)
7124 /* Set the frame corresponding to the active tty. Note that the
7125 value of selected_frame is not reliable here, redisplay tends
7126 to temporarily change it. */
7127 buf
.frame_or_window
= tty
->top_frame
;
7130 kbd_buffer_store_event (&buf
);
7131 /* Don't look at input that follows a C-g too closely.
7132 This reduces lossage due to autorepeat on C-g. */
7133 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7134 && buf
.code
== quit_char
)
7142 handle_async_input (void)
7144 interrupt_input_pending
= 0;
7146 pending_signals
= pending_atimers
;
7148 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7149 doing anything dangerous. */
7156 nread
= read_avail_input (1);
7157 /* -1 means it's not ok to read the input now.
7158 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7159 0 means there was no keyboard input available. */
7169 process_pending_signals (void)
7171 if (interrupt_input_pending
)
7172 handle_async_input ();
7173 do_pending_atimers ();
7176 #ifdef SIGIO /* for entire page */
7177 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7180 input_available_signal (int signo
)
7182 /* Must preserve main program's value of errno. */
7183 int old_errno
= errno
;
7184 SIGNAL_THREAD_CHECK (signo
);
7187 interrupt_input_pending
= 1;
7188 pending_signals
= 1;
7191 if (input_available_clear_time
)
7192 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7195 handle_async_input ();
7202 /* Send ourselves a SIGIO.
7204 This function exists so that the UNBLOCK_INPUT macro in
7205 blockinput.h can have some way to take care of input we put off
7206 dealing with, without assuming that every file which uses
7207 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7209 reinvoke_input_signal (void)
7212 handle_async_input ();
7218 /* User signal events. */
7220 struct user_signal_info
7222 /* Signal number. */
7225 /* Name of the signal. */
7228 /* Number of pending signals. */
7231 struct user_signal_info
*next
;
7234 /* List of user signals. */
7235 static struct user_signal_info
*user_signals
= NULL
;
7238 add_user_signal (int sig
, const char *name
)
7240 struct user_signal_info
*p
;
7242 for (p
= user_signals
; p
; p
= p
->next
)
7244 /* Already added. */
7247 p
= xmalloc (sizeof (struct user_signal_info
));
7249 p
->name
= xstrdup (name
);
7251 p
->next
= user_signals
;
7254 signal (sig
, handle_user_signal
);
7258 handle_user_signal (int sig
)
7260 int old_errno
= errno
;
7261 struct user_signal_info
*p
;
7262 const char *special_event_name
= NULL
;
7264 SIGNAL_THREAD_CHECK (sig
);
7266 if (SYMBOLP (Vdebug_on_event
))
7267 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7269 for (p
= user_signals
; p
; p
= p
->next
)
7272 if (special_event_name
&&
7273 strcmp (special_event_name
, p
->name
) == 0)
7275 /* Enter the debugger in many ways. */
7276 debug_on_next_call
= 1;
7279 Vinhibit_quit
= Qnil
;
7281 /* Eat the event. */
7287 if (interrupt_input
)
7288 kill (getpid (), SIGIO
);
7292 /* Tell wait_reading_process_output that it needs to wake
7293 up and look around. */
7294 if (input_available_clear_time
)
7295 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7304 find_user_signal_name (int sig
)
7306 struct user_signal_info
*p
;
7308 for (p
= user_signals
; p
; p
= p
->next
)
7316 store_user_signal_events (void)
7318 struct user_signal_info
*p
;
7319 struct input_event buf
;
7322 for (p
= user_signals
; p
; p
= p
->next
)
7323 if (p
->npending
> 0)
7329 memset (&buf
, 0, sizeof buf
);
7330 buf
.kind
= USER_SIGNAL_EVENT
;
7331 buf
.frame_or_window
= selected_frame
;
7333 nstored
+= p
->npending
;
7335 mask
= sigblock (sigmask (p
->sig
));
7339 kbd_buffer_store_event (&buf
);
7342 while (p
->npending
> 0);
7350 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7351 static Lisp_Object menu_bar_one_keymap_changed_items
;
7353 /* These variables hold the vector under construction within
7354 menu_bar_items and its subroutines, and the current index
7355 for storing into that vector. */
7356 static Lisp_Object menu_bar_items_vector
;
7357 static int menu_bar_items_index
;
7360 static const char* separator_names
[] = {
7365 "single-dashed-line",
7366 "double-dashed-line",
7368 "shadow-etched-out",
7369 "shadow-etched-in-dash",
7370 "shadow-etched-out-dash",
7371 "shadow-double-etched-in",
7372 "shadow-double-etched-out",
7373 "shadow-double-etched-in-dash",
7374 "shadow-double-etched-out-dash",
7378 /* Return non-zero if LABEL specifies a separator. */
7381 menu_separator_name_p (const char *label
)
7385 else if (strlen (label
) > 3
7386 && strncmp (label
, "--", 2) == 0
7391 for (i
= 0; separator_names
[i
]; ++i
)
7392 if (strcmp (label
, separator_names
[i
]) == 0)
7397 /* It's a separator if it contains only dashes. */
7398 while (*label
== '-')
7400 return (*label
== 0);
7407 /* Return a vector of menu items for a menu bar, appropriate
7408 to the current buffer. Each item has three elements in the vector:
7411 OLD is an old vector we can optionally reuse, or nil. */
7414 menu_bar_items (Lisp_Object old
)
7416 /* The number of keymaps we're scanning right now, and the number of
7417 keymaps we have allocated space for. */
7420 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7421 in the current keymaps, or nil where it is not a prefix. */
7424 Lisp_Object def
, tail
;
7429 /* In order to build the menus, we need to call the keymap
7430 accessors. They all call QUIT. But this function is called
7431 during redisplay, during which a quit is fatal. So inhibit
7432 quitting while building the menus.
7433 We do this instead of specbind because (1) errors will clear it anyway
7434 and (2) this avoids risk of specpdl overflow. */
7435 oquit
= Vinhibit_quit
;
7439 menu_bar_items_vector
= old
;
7441 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7442 menu_bar_items_index
= 0;
7444 /* Build our list of keymaps.
7445 If we recognize a function key and replace its escape sequence in
7446 keybuf with its symbol, or if the sequence starts with a mouse
7447 click and we need to switch buffers, we jump back here to rebuild
7448 the initial keymaps from the current buffer. */
7452 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7453 if (!NILP (Voverriding_local_map_menu_flag
))
7455 /* Yes, use them (if non-nil) as well as the global map. */
7456 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7458 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7459 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7460 if (!NILP (Voverriding_local_map
))
7461 maps
[nmaps
++] = Voverriding_local_map
;
7465 /* No, so use major and minor mode keymaps and keymap property.
7466 Note that menu-bar bindings in the local-map and keymap
7467 properties may not work reliable, as they are only
7468 recognized when the menu-bar (or mode-line) is updated,
7469 which does not normally happen after every command. */
7472 nminor
= current_minor_maps (NULL
, &tmaps
);
7473 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7475 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7476 maps
[nmaps
++] = tem
;
7477 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7479 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7481 maps
[nmaps
++] = current_global_map
;
7484 /* Look up in each map the dummy prefix key `menu-bar'. */
7486 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7487 if (!NILP (maps
[mapno
]))
7489 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7493 menu_bar_one_keymap_changed_items
= Qnil
;
7494 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7498 /* Move to the end those items that should be at the end. */
7500 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7503 int end
= menu_bar_items_index
;
7505 for (i
= 0; i
< end
; i
+= 4)
7506 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7508 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7509 /* Move the item at index I to the end,
7510 shifting all the others forward. */
7511 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7512 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7513 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7514 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7516 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7517 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7518 (end
- i
- 4) * sizeof (Lisp_Object
));
7519 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7520 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7521 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7522 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7527 /* Add nil, nil, nil, nil at the end. */
7529 int i
= menu_bar_items_index
;
7530 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7531 menu_bar_items_vector
=
7532 larger_vector (menu_bar_items_vector
, 4, -1);
7533 /* Add this item. */
7534 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7535 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7536 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7537 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7538 menu_bar_items_index
= i
;
7541 Vinhibit_quit
= oquit
;
7542 return menu_bar_items_vector
;
7545 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7546 If there's already an item for KEY, add this DEF to it. */
7548 Lisp_Object item_properties
;
7551 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7553 struct gcpro gcpro1
;
7557 if (EQ (item
, Qundefined
))
7559 /* If a map has an explicit `undefined' as definition,
7560 discard any previously made menu bar item. */
7562 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7563 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7565 if (menu_bar_items_index
> i
+ 4)
7566 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7567 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7568 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7569 menu_bar_items_index
-= 4;
7573 /* If this keymap has already contributed to this KEY,
7574 don't contribute to it a second time. */
7575 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7576 if (!NILP (tem
) || NILP (item
))
7579 menu_bar_one_keymap_changed_items
7580 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7582 /* We add to menu_bar_one_keymap_changed_items before doing the
7583 parse_menu_item, so that if it turns out it wasn't a menu item,
7584 it still correctly hides any further menu item. */
7586 i
= parse_menu_item (item
, 1);
7591 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7593 /* Find any existing item for this KEY. */
7594 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7595 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7598 /* If we did not find this KEY, add it at the end. */
7599 if (i
== menu_bar_items_index
)
7601 /* If vector is too small, get a bigger one. */
7602 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7603 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7604 /* Add this item. */
7605 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7606 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7607 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7608 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7609 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7610 menu_bar_items_index
= i
;
7612 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7616 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7617 /* If the new and the old items are not both keymaps,
7618 the lookup will only find `item'. */
7619 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7620 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7624 /* This is used as the handler when calling menu_item_eval_property. */
7626 menu_item_eval_property_1 (Lisp_Object arg
)
7628 /* If we got a quit from within the menu computation,
7629 quit all the way out of it. This takes care of C-] in the debugger. */
7630 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7631 Fsignal (Qquit
, Qnil
);
7637 eval_dyn (Lisp_Object form
)
7639 return Feval (form
, Qnil
);
7642 /* Evaluate an expression and return the result (or nil if something
7643 went wrong). Used to evaluate dynamic parts of menu items. */
7645 menu_item_eval_property (Lisp_Object sexpr
)
7647 ptrdiff_t count
= SPECPDL_INDEX ();
7649 specbind (Qinhibit_redisplay
, Qt
);
7650 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7651 menu_item_eval_property_1
);
7652 return unbind_to (count
, val
);
7655 /* This function parses a menu item and leaves the result in the
7656 vector item_properties.
7657 ITEM is a key binding, a possible menu item.
7658 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7660 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7661 parse_menu_item returns true if the item is a menu item and false
7665 parse_menu_item (Lisp_Object item
, int inmenubar
)
7667 Lisp_Object def
, tem
, item_string
, start
;
7669 Lisp_Object keyhint
;
7678 /* Create item_properties vector if necessary. */
7679 if (NILP (item_properties
))
7681 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7683 /* Initialize optional entries. */
7684 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7685 ASET (item_properties
, i
, Qnil
);
7686 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7688 /* Save the item here to protect it from GC. */
7689 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7691 item_string
= XCAR (item
);
7695 if (STRINGP (item_string
))
7697 /* Old format menu item. */
7698 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7700 /* Maybe help string. */
7701 if (CONSP (item
) && STRINGP (XCAR (item
)))
7703 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7708 /* Maybe an obsolete key binding cache. */
7709 if (CONSP (item
) && CONSP (XCAR (item
))
7710 && (NILP (XCAR (XCAR (item
)))
7711 || VECTORP (XCAR (XCAR (item
)))))
7714 /* This is the real definition--the function to run. */
7715 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7717 /* Get enable property, if any. */
7720 tem
= Fget (item
, Qmenu_enable
);
7721 if (!NILP (Venable_disabled_menus_and_buttons
))
7722 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7723 else if (!NILP (tem
))
7724 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7727 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7729 /* New format menu item. */
7730 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7731 start
= XCDR (item
);
7734 /* We have a real binding. */
7735 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7737 item
= XCDR (start
);
7738 /* Is there an obsolete cache list with key equivalences. */
7739 if (CONSP (item
) && CONSP (XCAR (item
)))
7742 /* Parse properties. */
7743 while (CONSP (item
) && CONSP (XCDR (item
)))
7748 if (EQ (tem
, QCenable
))
7750 if (!NILP (Venable_disabled_menus_and_buttons
))
7751 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7753 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7755 else if (EQ (tem
, QCvisible
))
7757 /* If got a visible property and that evaluates to nil
7758 then ignore this item. */
7759 tem
= menu_item_eval_property (XCAR (item
));
7763 else if (EQ (tem
, QChelp
))
7764 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7765 else if (EQ (tem
, QCfilter
))
7767 else if (EQ (tem
, QCkey_sequence
))
7770 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7771 /* Be GC protected. Set keyhint to item instead of tem. */
7774 else if (EQ (tem
, QCkeys
))
7777 if (CONSP (tem
) || STRINGP (tem
))
7778 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7780 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7785 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7787 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7789 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7795 else if (inmenubar
|| !NILP (start
))
7799 return 0; /* not a menu item */
7801 /* If item string is not a string, evaluate it to get string.
7802 If we don't get a string, skip this item. */
7803 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7804 if (!(STRINGP (item_string
)))
7806 item_string
= menu_item_eval_property (item_string
);
7807 if (!STRINGP (item_string
))
7809 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7812 /* If got a filter apply it on definition. */
7813 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7816 def
= menu_item_eval_property (list2 (XCAR (filter
),
7817 list2 (Qquote
, def
)));
7819 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7822 /* Enable or disable selection of item. */
7823 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7826 tem
= menu_item_eval_property (tem
);
7827 if (inmenubar
&& NILP (tem
))
7828 return 0; /* Ignore disabled items in menu bar. */
7829 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7832 /* If we got no definition, this item is just unselectable text which
7833 is OK in a submenu but not in the menubar. */
7835 return (!inmenubar
);
7837 /* See if this is a separate pane or a submenu. */
7838 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7839 tem
= get_keymap (def
, 0, 1);
7840 /* For a subkeymap, just record its details and exit. */
7843 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7844 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7848 /* At the top level in the menu bar, do likewise for commands also.
7849 The menu bar does not display equivalent key bindings anyway.
7850 ITEM_PROPERTY_DEF is already set up properly. */
7854 { /* This is a command. See if there is an equivalent key binding. */
7855 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7857 /* The previous code preferred :key-sequence to :keys, so we
7858 preserve this behavior. */
7859 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7860 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7863 Lisp_Object prefix
= keyeq
;
7864 Lisp_Object keys
= Qnil
;
7868 def
= XCAR (prefix
);
7869 prefix
= XCDR (prefix
);
7872 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7874 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7876 keys
= XCAR (keyhint
);
7877 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7879 /* We have a suggested key. Is it bound to the command? */
7882 /* If the command is an alias for another
7883 (such as lmenu.el set it up), check if the
7884 original command matches the cached command. */
7885 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7890 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7894 tem
= Fkey_description (keys
, Qnil
);
7897 if (STRINGP (XCAR (prefix
)))
7898 tem
= concat2 (XCAR (prefix
), tem
);
7899 if (STRINGP (XCDR (prefix
)))
7900 tem
= concat2 (tem
, XCDR (prefix
));
7902 keyeq
= concat2 (build_string (" "), tem
);
7903 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7909 /* If we have an equivalent key binding, use that. */
7910 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7913 /* Include this when menu help is implemented.
7914 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7915 if (!(NILP (tem) || STRINGP (tem)))
7917 tem = menu_item_eval_property (tem);
7920 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7924 /* Handle radio buttons or toggle boxes. */
7925 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7927 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7928 menu_item_eval_property (tem
));
7935 /***********************************************************************
7937 ***********************************************************************/
7939 /* A vector holding tool bar items while they are parsed in function
7940 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7943 static Lisp_Object tool_bar_items_vector
;
7945 /* A vector holding the result of parse_tool_bar_item. Layout is like
7946 the one for a single item in tool_bar_items_vector. */
7948 static Lisp_Object tool_bar_item_properties
;
7950 /* Next free index in tool_bar_items_vector. */
7952 static int ntool_bar_items
;
7954 /* The symbols `:image' and `:rtl'. */
7956 static Lisp_Object QCimage
;
7957 static Lisp_Object QCrtl
;
7959 /* Function prototypes. */
7961 static void init_tool_bar_items (Lisp_Object
);
7962 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7963 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7964 static void append_tool_bar_item (void);
7967 /* Return a vector of tool bar items for keymaps currently in effect.
7968 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7969 tool bar items found. */
7972 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7981 /* In order to build the menus, we need to call the keymap
7982 accessors. They all call QUIT. But this function is called
7983 during redisplay, during which a quit is fatal. So inhibit
7984 quitting while building the menus. We do this instead of
7985 specbind because (1) errors will clear it anyway and (2) this
7986 avoids risk of specpdl overflow. */
7987 oquit
= Vinhibit_quit
;
7990 /* Initialize tool_bar_items_vector and protect it from GC. */
7991 init_tool_bar_items (reuse
);
7993 /* Build list of keymaps in maps. Set nmaps to the number of maps
7996 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7997 if (!NILP (Voverriding_local_map_menu_flag
))
7999 /* Yes, use them (if non-nil) as well as the global map. */
8000 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8002 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8003 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8004 if (!NILP (Voverriding_local_map
))
8005 maps
[nmaps
++] = Voverriding_local_map
;
8009 /* No, so use major and minor mode keymaps and keymap property.
8010 Note that tool-bar bindings in the local-map and keymap
8011 properties may not work reliable, as they are only
8012 recognized when the tool-bar (or mode-line) is updated,
8013 which does not normally happen after every command. */
8016 nminor
= current_minor_maps (NULL
, &tmaps
);
8017 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8019 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8020 maps
[nmaps
++] = tem
;
8021 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8023 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8026 /* Add global keymap at the end. */
8027 maps
[nmaps
++] = current_global_map
;
8029 /* Process maps in reverse order and look up in each map the prefix
8031 for (i
= nmaps
- 1; i
>= 0; --i
)
8032 if (!NILP (maps
[i
]))
8036 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8038 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8041 Vinhibit_quit
= oquit
;
8042 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8043 return tool_bar_items_vector
;
8047 /* Process the definition of KEY which is DEF. */
8050 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8053 struct gcpro gcpro1
, gcpro2
;
8055 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8059 if (EQ (def
, Qundefined
))
8061 /* If a map has an explicit `undefined' as definition,
8062 discard any previously made item. */
8063 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8065 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8067 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8069 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8070 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8071 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8072 * sizeof (Lisp_Object
)));
8073 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8078 else if (parse_tool_bar_item (key
, def
))
8079 /* Append a new tool bar item to tool_bar_items_vector. Accept
8080 more than one definition for the same key. */
8081 append_tool_bar_item ();
8087 /* Parse a tool bar item specification ITEM for key KEY and return the
8088 result in tool_bar_item_properties. Value is zero if ITEM is
8091 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8093 CAPTION is the caption of the item, If it's not a string, it is
8094 evaluated to get a string.
8096 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8097 as binding are currently ignored.
8099 The following properties are recognized:
8103 FORM is evaluated and specifies whether the tool bar item is
8104 enabled or disabled.
8108 FORM is evaluated and specifies whether the tool bar item is visible.
8110 - `:filter FUNCTION'
8112 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8113 result is stored as the new binding.
8115 - `:button (TYPE SELECTED)'
8117 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8118 and specifies whether the button is selected (pressed) or not.
8122 IMAGES is either a single image specification or a vector of four
8123 image specifications. See enum tool_bar_item_images.
8125 - `:help HELP-STRING'.
8127 Gives a help string to display for the tool bar item.
8129 - `:label LABEL-STRING'.
8131 A text label to show with the tool bar button if labels are enabled. */
8134 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8136 /* Access slot with index IDX of vector tool_bar_item_properties. */
8137 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8139 Lisp_Object filter
= Qnil
;
8140 Lisp_Object caption
;
8141 int i
, have_label
= 0;
8143 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8144 Rule out items that aren't lists, don't start with
8145 `menu-item' or whose rest following `tool-bar-item' is not a
8150 /* As an exception, allow old-style menu separators. */
8151 if (STRINGP (XCAR (item
)))
8152 item
= Fcons (XCAR (item
), Qnil
);
8153 else if (!EQ (XCAR (item
), Qmenu_item
)
8154 || (item
= XCDR (item
), !CONSP (item
)))
8157 /* Create tool_bar_item_properties vector if necessary. Reset it to
8159 if (VECTORP (tool_bar_item_properties
))
8161 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8165 tool_bar_item_properties
8166 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8169 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8170 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8172 /* Get the caption of the item. If the caption is not a string,
8173 evaluate it to get a string. If we don't get a string, skip this
8175 caption
= XCAR (item
);
8176 if (!STRINGP (caption
))
8178 caption
= menu_item_eval_property (caption
);
8179 if (!STRINGP (caption
))
8182 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8184 /* If the rest following the caption is not a list, the menu item is
8185 either a separator, or invalid. */
8189 if (menu_separator_name_p (SSDATA (caption
)))
8191 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8192 #if !defined (USE_GTK) && !defined (HAVE_NS)
8193 /* If we use build_desired_tool_bar_string to render the
8194 tool bar, the separator is rendered as an image. */
8195 PROP (TOOL_BAR_ITEM_IMAGES
)
8196 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8197 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8198 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8199 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8206 /* Store the binding. */
8207 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8210 /* Ignore cached key binding, if any. */
8211 if (CONSP (item
) && CONSP (XCAR (item
)))
8214 /* Process the rest of the properties. */
8215 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8217 Lisp_Object ikey
, value
;
8220 value
= XCAR (XCDR (item
));
8222 if (EQ (ikey
, QCenable
))
8224 /* `:enable FORM'. */
8225 if (!NILP (Venable_disabled_menus_and_buttons
))
8226 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8228 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8230 else if (EQ (ikey
, QCvisible
))
8232 /* `:visible FORM'. If got a visible property and that
8233 evaluates to nil then ignore this item. */
8234 if (NILP (menu_item_eval_property (value
)))
8237 else if (EQ (ikey
, QChelp
))
8238 /* `:help HELP-STRING'. */
8239 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8240 else if (EQ (ikey
, QCvert_only
))
8241 /* `:vert-only t/nil'. */
8242 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8243 else if (EQ (ikey
, QClabel
))
8245 const char *bad_label
= "!!?GARBLED ITEM?!!";
8246 /* `:label LABEL-STRING'. */
8247 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8249 : build_string (bad_label
);
8252 else if (EQ (ikey
, QCfilter
))
8253 /* ':filter FORM'. */
8255 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8257 /* `:button (TYPE . SELECTED)'. */
8258 Lisp_Object type
, selected
;
8260 type
= XCAR (value
);
8261 selected
= XCDR (value
);
8262 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8264 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8265 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8268 else if (EQ (ikey
, QCimage
)
8270 || (VECTORP (value
) && ASIZE (value
) == 4)))
8271 /* Value is either a single image specification or a vector
8272 of 4 such specifications for the different button states. */
8273 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8274 else if (EQ (ikey
, QCrtl
))
8276 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8282 /* Try to make one from caption and key. */
8283 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8284 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8285 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8286 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8288 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8289 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8290 Lisp_Object new_lbl
;
8291 ptrdiff_t caption_len
= strlen (capt
);
8293 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8296 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8298 buf
[caption_len
] = '\0';
8302 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8306 strcpy (buf
, label
);
8308 for (j
= 0; buf
[j
] != '\0'; ++j
)
8316 new_lbl
= Fupcase_initials (build_string (label
));
8317 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8318 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8320 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8324 /* If got a filter apply it on binding. */
8326 PROP (TOOL_BAR_ITEM_BINDING
)
8327 = menu_item_eval_property (list2 (filter
,
8329 PROP (TOOL_BAR_ITEM_BINDING
))));
8331 /* See if the binding is a keymap. Give up if it is. */
8332 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8335 /* Enable or disable selection of item. */
8336 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8337 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8338 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8340 /* Handle radio buttons or toggle boxes. */
8341 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8342 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8343 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8351 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8352 that can be reused. */
8355 init_tool_bar_items (Lisp_Object reuse
)
8357 if (VECTORP (reuse
))
8358 tool_bar_items_vector
= reuse
;
8360 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8361 ntool_bar_items
= 0;
8365 /* Append parsed tool bar item properties from
8366 tool_bar_item_properties */
8369 append_tool_bar_item (void)
8371 Lisp_Object
*to
, *from
;
8374 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8376 /* Enlarge tool_bar_items_vector if necessary. */
8378 tool_bar_items_vector
8379 = larger_vector (tool_bar_items_vector
, incr
, -1);
8381 /* Append entries from tool_bar_item_properties to the end of
8382 tool_bar_items_vector. */
8383 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8384 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8385 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8386 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8393 /* Read a character using menus based on maps in the array MAPS.
8394 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8395 Return t if we displayed a menu but the user rejected it.
8397 PREV_EVENT is the previous input event, or nil if we are reading
8398 the first event of a key sequence.
8400 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8401 if we used a mouse menu to read the input, or zero otherwise. If
8402 USED_MOUSE_MENU is null, we don't dereference it.
8404 The prompting is done based on the prompt-string of the map
8405 and the strings associated with various map elements.
8407 This can be done with X menus or with menus put in the minibuf.
8408 These are done in different ways, depending on how the input will be read.
8409 Menus using X are done after auto-saving in read-char, getting the input
8410 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8411 and do auto-saving in the inner call of read_char. */
8414 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8415 Lisp_Object prev_event
, int *used_mouse_menu
)
8419 if (used_mouse_menu
)
8420 *used_mouse_menu
= 0;
8422 /* Use local over global Menu maps */
8424 if (! menu_prompting
)
8427 /* Optionally disregard all but the global map. */
8428 if (inhibit_local_menu_bar_menus
)
8430 maps
+= (nmaps
- 1);
8435 /* If we got to this point via a mouse click,
8436 use a real menu for mouse selection. */
8437 if (EVENT_HAS_PARAMETERS (prev_event
)
8438 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8439 && !EQ (XCAR (prev_event
), Qtool_bar
))
8441 /* Display the menu and get the selection. */
8442 Lisp_Object
*realmaps
8443 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8445 ptrdiff_t nmaps1
= 0;
8447 /* Use the maps that are not nil. */
8448 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8449 if (!NILP (maps
[mapno
]))
8450 realmaps
[nmaps1
++] = maps
[mapno
];
8452 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8457 record_menu_key (XCAR (value
));
8459 /* If we got multiple events, unread all but
8461 There is no way to prevent those unread events
8462 from showing up later in last_nonmenu_event.
8463 So turn symbol and integer events into lists,
8464 to indicate that they came from a mouse menu,
8465 so that when present in last_nonmenu_event
8466 they won't confuse things. */
8467 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8469 record_menu_key (XCAR (tem
));
8470 if (SYMBOLP (XCAR (tem
))
8471 || INTEGERP (XCAR (tem
)))
8472 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8475 /* If we got more than one event, put all but the first
8476 onto this list to be read later.
8477 Return just the first event now. */
8478 Vunread_command_events
8479 = nconc2 (XCDR (value
), Vunread_command_events
);
8480 value
= XCAR (value
);
8482 else if (NILP (value
))
8484 if (used_mouse_menu
)
8485 *used_mouse_menu
= 1;
8488 #endif /* HAVE_MENUS */
8492 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8493 We make this bigger when necessary, and never free it. */
8494 static char *read_char_minibuf_menu_text
;
8495 /* Size of that buffer. */
8496 static ptrdiff_t read_char_minibuf_menu_width
;
8499 read_char_minibuf_menu_prompt (int commandflag
,
8500 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8503 register Lisp_Object name
;
8505 /* FIXME: Use the minibuffer's frame width. */
8506 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8509 Lisp_Object rest
, vector
;
8515 if (! menu_prompting
)
8518 /* Get the menu name from the first map that has one (a prompt string). */
8519 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8521 name
= Fkeymap_prompt (maps
[mapno
]);
8526 /* If we don't have any menus, just read a character normally. */
8527 if (!STRINGP (name
))
8530 /* Make sure we have a big enough buffer for the menu text. */
8531 width
= max (width
, SBYTES (name
));
8532 if (STRING_BYTES_BOUND
- 4 < width
)
8533 memory_full (SIZE_MAX
);
8534 if (width
+ 4 > read_char_minibuf_menu_width
)
8536 read_char_minibuf_menu_text
8537 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8538 read_char_minibuf_menu_width
= width
+ 4;
8540 menu
= read_char_minibuf_menu_text
;
8542 /* Prompt string always starts with map's prompt, and a space. */
8543 strcpy (menu
, SSDATA (name
));
8544 nlength
= SBYTES (name
);
8545 menu
[nlength
++] = ':';
8546 menu
[nlength
++] = ' ';
8549 /* Start prompting at start of first map. */
8553 /* Present the documented bindings, a line at a time. */
8557 ptrdiff_t i
= nlength
;
8559 Lisp_Object orig_defn_macro
;
8561 /* Loop over elements of map. */
8566 /* If reached end of map, start at beginning of next map. */
8570 /* At end of last map, wrap around to first map if just starting,
8571 or end this line if already have something on it. */
8575 if (notfirst
|| nobindings
) break;
8580 /* Look at the next element of the map. */
8582 elt
= XVECTOR (vector
)->contents
[idx
];
8584 elt
= Fcar_safe (rest
);
8586 if (idx
< 0 && VECTORP (elt
))
8588 /* If we found a dense table in the keymap,
8589 advanced past it, but start scanning its contents. */
8590 rest
= Fcdr_safe (rest
);
8596 /* An ordinary element. */
8597 Lisp_Object event
, tem
;
8601 event
= Fcar_safe (elt
); /* alist */
8602 elt
= Fcdr_safe (elt
);
8606 XSETINT (event
, idx
); /* vector */
8609 /* Ignore the element if it has no prompt string. */
8610 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8612 /* 1 if the char to type matches the string. */
8614 Lisp_Object upcased_event
, downcased_event
;
8615 Lisp_Object desc
= Qnil
;
8617 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8619 upcased_event
= Fupcase (event
);
8620 downcased_event
= Fdowncase (event
);
8621 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8622 || XINT (downcased_event
) == SREF (s
, 0));
8624 desc
= Fsingle_key_description (event
, Qnil
);
8626 #if 0 /* It is redundant to list the equivalent key bindings because
8627 the prefix is what the user has already typed. */
8629 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8631 /* Insert equivalent keybinding. */
8632 s
= concat2 (s
, tem
);
8635 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8636 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8638 /* Insert button prefix. */
8639 Lisp_Object selected
8640 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8641 if (EQ (tem
, QCradio
))
8642 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8644 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8645 s
= concat2 (tem
, s
);
8649 /* If we have room for the prompt string, add it to this line.
8650 If this is the first on the line, always add it. */
8651 if ((SCHARS (s
) + i
+ 2
8652 + (char_matches
? 0 : SCHARS (desc
) + 3))
8656 ptrdiff_t thiswidth
;
8658 /* Punctuate between strings. */
8661 strcpy (menu
+ i
, ", ");
8667 /* If the char to type doesn't match the string's
8668 first char, explicitly show what char to type. */
8671 /* Add as much of string as fits. */
8672 thiswidth
= min (SCHARS (desc
), width
- i
);
8673 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8675 strcpy (menu
+ i
, " = ");
8679 /* Add as much of string as fits. */
8680 thiswidth
= min (SCHARS (s
), width
- i
);
8681 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8687 /* If this element does not fit, end the line now,
8688 and save the element for the next line. */
8689 strcpy (menu
+ i
, "...");
8694 /* Move past this element. */
8695 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8696 /* Handle reaching end of dense table. */
8701 rest
= Fcdr_safe (rest
);
8705 /* Prompt with that and read response. */
8706 message2_nolog (menu
, strlen (menu
),
8707 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8709 /* Make believe its not a keyboard macro in case the help char
8710 is pressed. Help characters are not recorded because menu prompting
8711 is not used on replay.
8713 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8714 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8716 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8717 while (BUFFERP (obj
));
8718 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8720 if (!INTEGERP (obj
))
8722 else if (XINT (obj
) == -2)
8725 if (! EQ (obj
, menu_prompt_more_char
)
8726 && (!INTEGERP (menu_prompt_more_char
)
8727 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8729 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8730 store_kbd_macro_char (obj
);
8733 /* Help char - go round again */
8737 /* Reading key sequences. */
8739 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8740 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8741 keymap, or nil otherwise. Return the index of the first keymap in
8742 which KEY has any binding, or NMAPS if no map has a binding.
8744 If KEY is a meta ASCII character, treat it like meta-prefix-char
8745 followed by the corresponding non-meta character. Keymaps in
8746 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8749 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8752 NEXT may be the same array as CURRENT. */
8755 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8756 Lisp_Object
*defs
, Lisp_Object
*next
)
8758 ptrdiff_t i
, first_binding
;
8760 first_binding
= nmaps
;
8761 for (i
= nmaps
- 1; i
>= 0; i
--)
8763 if (! NILP (current
[i
]))
8765 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8766 if (! NILP (defs
[i
]))
8773 /* Given the set of bindings we've found, produce the next set of maps. */
8774 if (first_binding
< nmaps
)
8775 for (i
= 0; i
< nmaps
; i
++)
8776 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8778 return first_binding
;
8781 /* Structure used to keep track of partial application of key remapping
8782 such as Vfunction_key_map and Vkey_translation_map. */
8783 typedef struct keyremap
8785 /* This is the map originally specified for this use. */
8787 /* This is a submap reached by looking up, in PARENT,
8788 the events from START to END. */
8790 /* Positions [START, END) in the key sequence buffer
8791 are the key that we have scanned so far.
8792 Those events are the ones that we will replace
8793 if PAREHT maps them into a key sequence. */
8797 /* Lookup KEY in MAP.
8798 MAP is a keymap mapping keys to key vectors or functions.
8799 If the mapping is a function and DO_FUNCTION is non-zero, then
8800 the function is called with PROMPT as parameter and its return
8801 value is used as the return value of this function (after checking
8802 that it is indeed a vector). */
8805 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8810 next
= access_keymap (map
, key
, 1, 0, 1);
8812 /* Handle symbol with autoload definition. */
8813 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8814 && CONSP (XSYMBOL (next
)->function
)
8815 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8816 do_autoload (XSYMBOL (next
)->function
, next
);
8818 /* Handle a symbol whose function definition is a keymap
8820 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8821 && (ARRAYP (XSYMBOL (next
)->function
)
8822 || KEYMAPP (XSYMBOL (next
)->function
)))
8823 next
= XSYMBOL (next
)->function
;
8825 /* If the keymap gives a function, not an
8826 array, then call the function with one arg and use
8827 its value instead. */
8828 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8833 next
= call1 (next
, prompt
);
8834 /* If the function returned something invalid,
8835 barf--don't ignore it.
8836 (To ignore it safely, we would need to gcpro a bunch of
8837 other variables.) */
8838 if (! (VECTORP (next
) || STRINGP (next
)))
8839 error ("Function %s returns invalid key sequence",
8840 SSDATA (SYMBOL_NAME (tem
)));
8845 /* Do one step of the key remapping used for function-key-map and
8846 key-translation-map:
8847 KEYBUF is the buffer holding the input events.
8848 BUFSIZE is its maximum size.
8849 FKEY is a pointer to the keyremap structure to use.
8850 INPUT is the index of the last element in KEYBUF.
8851 DOIT if non-zero says that the remapping can actually take place.
8852 DIFF is used to return the number of keys added/removed by the remapping.
8853 PARENT is the root of the keymap.
8854 PROMPT is the prompt to use if the remapping happens through a function.
8855 The return value is non-zero if the remapping actually took place. */
8858 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8859 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8861 Lisp_Object next
, key
;
8863 key
= keybuf
[fkey
->end
++];
8865 if (KEYMAPP (fkey
->parent
))
8866 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8870 /* If keybuf[fkey->start..fkey->end] is bound in the
8871 map and we're in a position to do the key remapping, replace it with
8872 the binding and restart with fkey->start at the end. */
8873 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8875 int len
= XFASTINT (Flength (next
));
8878 *diff
= len
- (fkey
->end
- fkey
->start
);
8880 if (bufsize
- input
<= *diff
)
8881 error ("Key sequence too long");
8883 /* Shift the keys that follow fkey->end. */
8885 for (i
= fkey
->end
; i
< input
; i
++)
8886 keybuf
[i
+ *diff
] = keybuf
[i
];
8888 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8889 keybuf
[i
+ *diff
] = keybuf
[i
];
8890 /* Overwrite the old keys with the new ones. */
8891 for (i
= 0; i
< len
; i
++)
8892 keybuf
[fkey
->start
+ i
]
8893 = Faref (next
, make_number (i
));
8895 fkey
->start
= fkey
->end
+= *diff
;
8896 fkey
->map
= fkey
->parent
;
8901 fkey
->map
= get_keymap (next
, 0, 1);
8903 /* If we no longer have a bound suffix, try a new position for
8905 if (!CONSP (fkey
->map
))
8907 fkey
->end
= ++fkey
->start
;
8908 fkey
->map
= fkey
->parent
;
8913 /* Read a sequence of keys that ends with a non prefix character,
8914 storing it in KEYBUF, a buffer of size BUFSIZE.
8916 Return the length of the key sequence stored.
8917 Return -1 if the user rejected a command menu.
8919 Echo starting immediately unless `prompt' is 0.
8921 Where a key sequence ends depends on the currently active keymaps.
8922 These include any minor mode keymaps active in the current buffer,
8923 the current buffer's local map, and the global map.
8925 If a key sequence has no other bindings, we check Vfunction_key_map
8926 to see if some trailing subsequence might be the beginning of a
8927 function key's sequence. If so, we try to read the whole function
8928 key, and substitute its symbolic name into the key sequence.
8930 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8931 `double-' events into similar click events, if that would make them
8932 bound. We try to turn `triple-' events first into `double-' events,
8935 If we get a mouse click in a mode line, vertical divider, or other
8936 non-text area, we treat the click as if it were prefixed by the
8937 symbol denoting that area - `mode-line', `vertical-line', or
8940 If the sequence starts with a mouse click, we read the key sequence
8941 with respect to the buffer clicked on, not the current buffer.
8943 If the user switches frames in the midst of a key sequence, we put
8944 off the switch-frame event until later; the next call to
8945 read_char will return it.
8947 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8948 from the selected window's buffer. */
8951 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8952 int dont_downcase_last
, int can_return_switch_frame
,
8953 int fix_current_buffer
)
8955 Lisp_Object from_string
;
8956 ptrdiff_t count
= SPECPDL_INDEX ();
8958 /* How many keys there are in the current key sequence. */
8961 /* The length of the echo buffer when we started reading, and
8962 the length of this_command_keys when we started reading. */
8963 ptrdiff_t echo_start
IF_LINT (= 0);
8964 ptrdiff_t keys_start
;
8966 /* The number of keymaps we're scanning right now, and the number of
8967 keymaps we have allocated space for. */
8969 ptrdiff_t nmaps_allocated
= 0;
8971 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8972 the current keymaps. */
8973 Lisp_Object
*defs
= NULL
;
8975 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8976 in the current keymaps, or nil where it is not a prefix. */
8977 Lisp_Object
*submaps
= NULL
;
8979 /* The local map to start out with at start of key sequence. */
8980 Lisp_Object orig_local_map
;
8982 /* The map from the `keymap' property to start out with at start of
8984 Lisp_Object orig_keymap
;
8986 /* 1 if we have already considered switching to the local-map property
8987 of the place where a mouse click occurred. */
8988 int localized_local_map
= 0;
8990 /* The index in submaps[] of the first keymap that has a binding for
8991 this key sequence. In other words, the lowest i such that
8992 submaps[i] is non-nil. */
8993 ptrdiff_t first_binding
;
8994 /* Index of the first key that has no binding.
8995 It is useless to try fkey.start larger than that. */
8998 /* If t < mock_input, then KEYBUF[t] should be read as the next
9001 We use this to recover after recognizing a function key. Once we
9002 realize that a suffix of the current key sequence is actually a
9003 function key's escape sequence, we replace the suffix with the
9004 function key's binding from Vfunction_key_map. Now keybuf
9005 contains a new and different key sequence, so the echo area,
9006 this_command_keys, and the submaps and defs arrays are wrong. In
9007 this situation, we set mock_input to t, set t to 0, and jump to
9008 restart_sequence; the loop will read keys from keybuf up until
9009 mock_input, thus rebuilding the state; and then it will resume
9010 reading characters from the keyboard. */
9013 /* If the sequence is unbound in submaps[], then
9014 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9015 and fkey.map is its binding.
9017 These might be > t, indicating that all function key scanning
9018 should hold off until t reaches them. We do this when we've just
9019 recognized a function key, to avoid searching for the function
9020 key's again in Vfunction_key_map. */
9023 /* Likewise, for key_translation_map and input-decode-map. */
9024 keyremap keytran
, indec
;
9026 /* Non-zero if we are trying to map a key by changing an upper-case
9027 letter to lower case, or a shifted function key to an unshifted
9029 int shift_translated
= 0;
9031 /* If we receive a `switch-frame' or `select-window' event in the middle of
9032 a key sequence, we put it off for later.
9033 While we're reading, we keep the event here. */
9034 Lisp_Object delayed_switch_frame
;
9036 /* See the comment below... */
9037 #if defined (GOBBLE_FIRST_EVENT)
9038 Lisp_Object first_event
;
9041 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9042 int original_uppercase_position
= -1;
9044 /* Gets around Microsoft compiler limitations. */
9047 struct buffer
*starting_buffer
;
9049 /* List of events for which a fake prefix key has been generated. */
9050 Lisp_Object fake_prefixed_keys
= Qnil
;
9052 #if defined (GOBBLE_FIRST_EVENT)
9056 struct gcpro outer_gcpro1
;
9058 GCPRO1_VAR (fake_prefixed_keys
, outer_gcpro
);
9059 raw_keybuf_count
= 0;
9061 last_nonmenu_event
= Qnil
;
9063 delayed_switch_frame
= Qnil
;
9069 /* Install the string STR as the beginning of the string of
9070 echoing, so that it serves as a prompt for the next
9072 KVAR (current_kboard
, echo_string
) = prompt
;
9073 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9076 else if (cursor_in_echo_area
9077 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9078 && NILP (Fzerop (Vecho_keystrokes
)))
9079 /* This doesn't put in a dash if the echo buffer is empty, so
9080 you don't always see a dash hanging out in the minibuffer. */
9084 /* Record the initial state of the echo area and this_command_keys;
9085 we will need to restore them if we replay a key sequence. */
9087 echo_start
= echo_length ();
9088 keys_start
= this_command_key_count
;
9089 this_single_command_key_start
= keys_start
;
9091 #if defined (GOBBLE_FIRST_EVENT)
9092 /* This doesn't quite work, because some of the things that read_char
9093 does cannot safely be bypassed. It seems too risky to try to make
9096 /* Read the first char of the sequence specially, before setting
9097 up any keymaps, in case a filter runs and switches buffers on us. */
9098 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9100 #endif /* GOBBLE_FIRST_EVENT */
9102 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9103 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9106 /* We jump here when we need to reinitialize fkey and keytran; this
9107 happens if we switch keyboards between rescans. */
9108 replay_entire_sequence
:
9110 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9111 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9112 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9113 indec
.start
= indec
.end
= 0;
9114 fkey
.start
= fkey
.end
= 0;
9115 keytran
.start
= keytran
.end
= 0;
9117 /* We jump here when the key sequence has been thoroughly changed, and
9118 we need to rescan it starting from the beginning. When we jump here,
9119 keybuf[0..mock_input] holds the sequence we should reread. */
9122 starting_buffer
= current_buffer
;
9123 first_unbound
= bufsize
+ 1;
9125 /* Build our list of keymaps.
9126 If we recognize a function key and replace its escape sequence in
9127 keybuf with its symbol, or if the sequence starts with a mouse
9128 click and we need to switch buffers, we jump back here to rebuild
9129 the initial keymaps from the current buffer. */
9132 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9134 if (2 > nmaps_allocated
)
9136 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9137 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9138 nmaps_allocated
= 2;
9140 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9142 else if (!NILP (Voverriding_local_map
))
9144 if (2 > nmaps_allocated
)
9146 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9147 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9148 nmaps_allocated
= 2;
9150 submaps
[nmaps
++] = Voverriding_local_map
;
9158 nminor
= current_minor_maps (0, &maps
);
9159 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9161 if (total
> nmaps_allocated
)
9163 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9164 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9165 nmaps_allocated
= total
;
9168 if (!NILP (orig_keymap
))
9169 submaps
[nmaps
++] = orig_keymap
;
9171 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9175 submaps
[nmaps
++] = orig_local_map
;
9177 submaps
[nmaps
++] = current_global_map
;
9179 /* Find an accurate initial value for first_binding. */
9180 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9181 if (! NILP (submaps
[first_binding
]))
9184 /* Start from the beginning in keybuf. */
9187 /* These are no-ops the first time through, but if we restart, they
9188 revert the echo area and this_command_keys to their original state. */
9189 this_command_key_count
= keys_start
;
9190 if (INTERACTIVE
&& t
< mock_input
)
9191 echo_truncate (echo_start
);
9193 /* If the best binding for the current key sequence is a keymap, or
9194 we may be looking at a function key's escape sequence, keep on
9196 while (first_binding
< nmaps
9197 /* Keep reading as long as there's a prefix binding. */
9198 ? !NILP (submaps
[first_binding
])
9199 /* Don't return in the middle of a possible function key sequence,
9200 if the only bindings we found were via case conversion.
9201 Thus, if ESC O a has a function-key-map translation
9202 and ESC o has a binding, don't return after ESC O,
9203 so that we can translate ESC O plus the next character. */
9204 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9207 int used_mouse_menu
= 0;
9209 /* Where the last real key started. If we need to throw away a
9210 key that has expanded into more than one element of keybuf
9211 (say, a mouse click on the mode line which is being treated
9212 as [mode-line (mouse-...)], then we backtrack to this point
9214 int last_real_key_start
;
9216 /* These variables are analogous to echo_start and keys_start;
9217 while those allow us to restart the entire key sequence,
9218 echo_local_start and keys_local_start allow us to throw away
9220 ptrdiff_t echo_local_start
IF_LINT (= 0);
9221 int keys_local_start
;
9222 ptrdiff_t local_first_binding
;
9224 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9225 eassert (indec
.start
<= indec
.end
);
9226 eassert (fkey
.start
<= fkey
.end
);
9227 eassert (keytran
.start
<= keytran
.end
);
9228 /* key-translation-map is applied *after* function-key-map
9229 which is itself applied *after* input-decode-map. */
9230 eassert (fkey
.end
<= indec
.start
);
9231 eassert (keytran
.end
<= fkey
.start
);
9233 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9234 first_unbound
< keytran
.start
)
9235 { /* The prefix upto first_unbound has no binding and has
9236 no translation left to do either, so we know it's unbound.
9237 If we don't stop now, we risk staying here indefinitely
9238 (if the user keeps entering fkey or keytran prefixes
9239 like C-c ESC ESC ESC ESC ...) */
9241 for (i
= first_unbound
+ 1; i
< t
; i
++)
9242 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9243 mock_input
= t
- first_unbound
- 1;
9244 indec
.end
= indec
.start
-= first_unbound
+ 1;
9245 indec
.map
= indec
.parent
;
9246 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9247 fkey
.map
= fkey
.parent
;
9248 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9249 keytran
.map
= keytran
.parent
;
9250 goto replay_sequence
;
9254 error ("Key sequence too long");
9257 echo_local_start
= echo_length ();
9258 keys_local_start
= this_command_key_count
;
9259 local_first_binding
= first_binding
;
9262 /* These are no-ops, unless we throw away a keystroke below and
9263 jumped back up to replay_key; in that case, these restore the
9264 variables to their original state, allowing us to replay the
9266 if (INTERACTIVE
&& t
< mock_input
)
9267 echo_truncate (echo_local_start
);
9268 this_command_key_count
= keys_local_start
;
9269 first_binding
= local_first_binding
;
9271 /* By default, assume each event is "real". */
9272 last_real_key_start
= t
;
9274 /* Does mock_input indicate that we are re-reading a key sequence? */
9278 add_command_key (key
);
9279 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9280 && NILP (Fzerop (Vecho_keystrokes
)))
9284 /* If not, we should actually read a character. */
9288 KBOARD
*interrupted_kboard
= current_kboard
;
9289 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9290 key
= read_char (NILP (prompt
), nmaps
,
9291 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9292 &used_mouse_menu
, NULL
);
9293 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9294 /* When switching to a new tty (with a new keyboard),
9295 read_char returns the new buffer, rather than -2
9296 (Bug#5095). This is because `terminal-init-xterm'
9297 calls read-char, which eats the wrong_kboard_jmpbuf
9298 return. Any better way to fix this? -- cyd */
9299 || (interrupted_kboard
!= current_kboard
))
9304 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9305 if (k
== interrupted_kboard
)
9310 /* Don't touch interrupted_kboard when it's been
9312 delayed_switch_frame
= Qnil
;
9313 goto replay_entire_sequence
;
9316 if (!NILP (delayed_switch_frame
))
9318 KVAR (interrupted_kboard
, kbd_queue
)
9319 = Fcons (delayed_switch_frame
,
9320 KVAR (interrupted_kboard
, kbd_queue
));
9321 delayed_switch_frame
= Qnil
;
9325 KVAR (interrupted_kboard
, kbd_queue
)
9326 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9328 /* If the side queue is non-empty, ensure it begins with a
9329 switch-frame, so we'll replay it in the right context. */
9330 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9331 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9332 !(EVENT_HAS_PARAMETERS (key
)
9333 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9337 XSETFRAME (frame
, interrupted_frame
);
9338 KVAR (interrupted_kboard
, kbd_queue
)
9339 = Fcons (make_lispy_switch_frame (frame
),
9340 KVAR (interrupted_kboard
, kbd_queue
));
9343 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9344 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9345 goto replay_entire_sequence
;
9349 /* read_char returns t when it shows a menu and the user rejects it.
9353 unbind_to (count
, Qnil
);
9354 UNGCPRO_VAR (outer_gcpro
);
9358 /* read_char returns -1 at the end of a macro.
9359 Emacs 18 handles this by returning immediately with a
9360 zero, so that's what we'll do. */
9361 if (INTEGERP (key
) && XINT (key
) == -1)
9364 /* The Microsoft C compiler can't handle the goto that
9370 /* If the current buffer has been changed from under us, the
9371 keymap may have changed, so replay the sequence. */
9374 timer_resume_idle ();
9377 /* Reset the current buffer from the selected window
9378 in case something changed the former and not the latter.
9379 This is to be more consistent with the behavior
9380 of the command_loop_1. */
9381 if (fix_current_buffer
)
9383 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9385 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9386 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9389 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9390 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9391 goto replay_sequence
;
9394 /* If we have a quit that was typed in another frame, and
9395 quit_throw_to_read_char switched buffers,
9396 replay to get the right keymap. */
9398 && XINT (key
) == quit_char
9399 && current_buffer
!= starting_buffer
)
9402 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9406 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9407 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9408 goto replay_sequence
;
9413 if (EVENT_HAS_PARAMETERS (key
)
9414 /* Either a `switch-frame' or a `select-window' event. */
9415 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9417 /* If we're at the beginning of a key sequence, and the caller
9418 says it's okay, go ahead and return this event. If we're
9419 in the midst of a key sequence, delay it until the end. */
9420 if (t
> 0 || !can_return_switch_frame
)
9422 delayed_switch_frame
= key
;
9428 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9432 /* Clicks in non-text areas get prefixed by the symbol
9433 in their CHAR-ADDRESS field. For example, a click on
9434 the mode line is prefixed by the symbol `mode-line'.
9436 Furthermore, key sequences beginning with mouse clicks
9437 are read using the keymaps of the buffer clicked on, not
9438 the current buffer. So we may have to switch the buffer
9441 When we turn one event into two events, we must make sure
9442 that neither of the two looks like the original--so that,
9443 if we replay the events, they won't be expanded again.
9444 If not for this, such reexpansion could happen either here
9445 or when user programs play with this-command-keys. */
9446 if (EVENT_HAS_PARAMETERS (key
))
9451 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9452 if (EQ (kind
, Qmouse_click
))
9454 Lisp_Object window
, posn
;
9456 window
= POSN_WINDOW (EVENT_START (key
));
9457 posn
= POSN_POSN (EVENT_START (key
));
9460 || (!NILP (fake_prefixed_keys
)
9461 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9463 /* We're looking a second time at an event for which
9464 we generated a fake prefix key. Set
9465 last_real_key_start appropriately. */
9467 last_real_key_start
= t
- 1;
9470 if (last_real_key_start
== 0)
9472 /* Key sequences beginning with mouse clicks are
9473 read using the keymaps in the buffer clicked on,
9474 not the current buffer. If we're at the
9475 beginning of a key sequence, switch buffers. */
9476 if (WINDOWP (window
)
9477 && BUFFERP (XWINDOW (window
)->buffer
)
9478 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9480 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9484 /* Arrange to go back to the original buffer once we're
9485 done reading the key sequence. Note that we can't
9486 use save_excursion_{save,restore} here, because they
9487 save point as well as the current buffer; we don't
9488 want to save point, because redisplay may change it,
9489 to accommodate a Fset_window_start or something. We
9490 don't want to do this at the top of the function,
9491 because we may get input from a subprocess which
9492 wants to change the selected window and stuff (say,
9494 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9496 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9498 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9499 orig_local_map
= get_local_map (PT
, current_buffer
,
9501 orig_keymap
= get_local_map (PT
, current_buffer
,
9503 goto replay_sequence
;
9506 /* For a mouse click, get the local text-property keymap
9507 of the place clicked on, rather than point. */
9508 if (CONSP (XCDR (key
))
9509 && ! localized_local_map
)
9511 Lisp_Object map_here
, start
, pos
;
9513 localized_local_map
= 1;
9514 start
= EVENT_START (key
);
9516 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9518 pos
= POSN_BUFFER_POSN (start
);
9520 && XINT (pos
) >= BEGV
9521 && XINT (pos
) <= ZV
)
9523 map_here
= get_local_map (XINT (pos
),
9526 if (!EQ (map_here
, orig_local_map
))
9528 orig_local_map
= map_here
;
9529 ++localized_local_map
;
9532 map_here
= get_local_map (XINT (pos
),
9535 if (!EQ (map_here
, orig_keymap
))
9537 orig_keymap
= map_here
;
9538 ++localized_local_map
;
9541 if (localized_local_map
> 1)
9546 goto replay_sequence
;
9553 /* Expand mode-line and scroll-bar events into two events:
9554 use posn as a fake prefix key. */
9556 && (NILP (fake_prefixed_keys
)
9557 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9559 if (bufsize
- t
<= 1)
9560 error ("Key sequence too long");
9563 keybuf
[t
+ 1] = key
;
9566 /* Record that a fake prefix key has been generated
9567 for KEY. Don't modify the event; this would
9568 prevent proper action when the event is pushed
9569 back into unread-command-events. */
9570 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9572 /* If on a mode line string with a local keymap,
9573 reconsider the key sequence with that keymap. */
9574 if (string
= POSN_STRING (EVENT_START (key
)),
9575 (CONSP (string
) && STRINGP (XCAR (string
))))
9577 Lisp_Object pos
, map
, map2
;
9579 pos
= XCDR (string
);
9580 string
= XCAR (string
);
9582 && XINT (pos
) < SCHARS (string
))
9584 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9586 orig_local_map
= map
;
9587 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9590 if (!NILP (map
) || !NILP (map2
))
9591 goto replay_sequence
;
9597 else if (NILP (from_string
)
9598 && (string
= POSN_STRING (EVENT_START (key
)),
9599 (CONSP (string
) && STRINGP (XCAR (string
)))))
9601 /* For a click on a string, i.e. overlay string or a
9602 string displayed via the `display' property,
9603 consider `local-map' and `keymap' properties of
9605 Lisp_Object pos
, map
, map2
;
9607 pos
= XCDR (string
);
9608 string
= XCAR (string
);
9610 && XINT (pos
) < SCHARS (string
))
9612 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9614 orig_local_map
= map
;
9615 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9619 if (!NILP (map
) || !NILP (map2
))
9621 from_string
= string
;
9624 goto replay_sequence
;
9629 else if (CONSP (XCDR (key
))
9630 && CONSP (EVENT_START (key
))
9631 && CONSP (XCDR (EVENT_START (key
))))
9635 posn
= POSN_POSN (EVENT_START (key
));
9636 /* Handle menu-bar events:
9637 insert the dummy prefix event `menu-bar'. */
9638 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9640 if (bufsize
- t
<= 1)
9641 error ("Key sequence too long");
9645 /* Zap the position in key, so we know that we've
9646 expanded it, and don't try to do so again. */
9647 POSN_SET_POSN (EVENT_START (key
),
9648 Fcons (posn
, Qnil
));
9651 goto replay_sequence
;
9653 else if (CONSP (posn
))
9655 /* We're looking at the second event of a
9656 sequence which we expanded before. Set
9657 last_real_key_start appropriately. */
9658 if (last_real_key_start
== t
&& t
> 0)
9659 last_real_key_start
= t
- 1;
9664 /* We have finally decided that KEY is something we might want
9666 first_binding
= (follow_key (key
,
9667 nmaps
- first_binding
,
9668 submaps
+ first_binding
,
9669 defs
+ first_binding
,
9670 submaps
+ first_binding
)
9673 /* If KEY wasn't bound, we'll try some fallbacks. */
9674 if (first_binding
< nmaps
)
9675 /* This is needed for the following scenario:
9676 event 0: a down-event that gets dropped by calling replay_key.
9677 event 1: some normal prefix like C-h.
9678 After event 0, first_unbound is 0, after event 1 indec.start,
9679 fkey.start, and keytran.start are all 1, so when we see that
9680 C-h is bound, we need to update first_unbound. */
9681 first_unbound
= max (t
+ 1, first_unbound
);
9686 /* Remember the position to put an upper bound on indec.start. */
9687 first_unbound
= min (t
, first_unbound
);
9689 head
= EVENT_HEAD (key
);
9690 if (help_char_p (head
) && t
> 0)
9692 read_key_sequence_cmd
= Vprefix_help_command
;
9694 last_nonmenu_event
= key
;
9695 /* The Microsoft C compiler can't handle the goto that
9703 Lisp_Object breakdown
;
9706 breakdown
= parse_modifiers (head
);
9707 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9708 /* Attempt to reduce an unbound mouse event to a simpler
9709 event that is bound:
9710 Drags reduce to clicks.
9711 Double-clicks reduce to clicks.
9712 Triple-clicks reduce to double-clicks, then to clicks.
9713 Down-clicks are eliminated.
9714 Double-downs reduce to downs, then are eliminated.
9715 Triple-downs reduce to double-downs, then to downs,
9716 then are eliminated. */
9717 if (modifiers
& (down_modifier
| drag_modifier
9718 | double_modifier
| triple_modifier
))
9720 while (modifiers
& (down_modifier
| drag_modifier
9721 | double_modifier
| triple_modifier
))
9723 Lisp_Object new_head
, new_click
;
9724 if (modifiers
& triple_modifier
)
9725 modifiers
^= (double_modifier
| triple_modifier
);
9726 else if (modifiers
& double_modifier
)
9727 modifiers
&= ~double_modifier
;
9728 else if (modifiers
& drag_modifier
)
9729 modifiers
&= ~drag_modifier
;
9732 /* Dispose of this `down' event by simply jumping
9733 back to replay_key, to get another event.
9735 Note that if this event came from mock input,
9736 then just jumping back to replay_key will just
9737 hand it to us again. So we have to wipe out any
9740 We could delete keybuf[t] and shift everything
9741 after that to the left by one spot, but we'd also
9742 have to fix up any variable that points into
9743 keybuf, and shifting isn't really necessary
9746 Adding prefixes for non-textual mouse clicks
9747 creates two characters of mock input, and both
9748 must be thrown away. If we're only looking at
9749 the prefix now, we can just jump back to
9750 replay_key. On the other hand, if we've already
9751 processed the prefix, and now the actual click
9752 itself is giving us trouble, then we've lost the
9753 state of the keymaps we want to backtrack to, and
9754 we need to replay the whole sequence to rebuild
9757 Beyond that, only function key expansion could
9758 create more than two keys, but that should never
9759 generate mouse events, so it's okay to zero
9760 mock_input in that case too.
9762 FIXME: The above paragraph seems just plain
9763 wrong, if you consider things like
9764 xterm-mouse-mode. -stef
9766 Isn't this just the most wonderful code ever? */
9768 /* If mock_input > t + 1, the above simplification
9769 will actually end up dropping keys on the floor.
9770 This is probably OK for now, but even
9771 if mock_input <= t + 1, we need to adjust indec,
9773 Typical case [header-line down-mouse-N]:
9774 mock_input = 2, t = 1, fkey.end = 1,
9775 last_real_key_start = 0. */
9776 if (indec
.end
> last_real_key_start
)
9778 indec
.end
= indec
.start
9779 = min (last_real_key_start
, indec
.start
);
9780 indec
.map
= indec
.parent
;
9781 if (fkey
.end
> last_real_key_start
)
9783 fkey
.end
= fkey
.start
9784 = min (last_real_key_start
, fkey
.start
);
9785 fkey
.map
= fkey
.parent
;
9786 if (keytran
.end
> last_real_key_start
)
9788 keytran
.end
= keytran
.start
9789 = min (last_real_key_start
, keytran
.start
);
9790 keytran
.map
= keytran
.parent
;
9794 if (t
== last_real_key_start
)
9801 mock_input
= last_real_key_start
;
9802 goto replay_sequence
;
9807 = apply_modifiers (modifiers
, XCAR (breakdown
));
9809 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9811 /* Look for a binding for this new key. follow_key
9812 promises that it didn't munge submaps the
9813 last time we called it, since key was unbound. */
9815 = (follow_key (new_click
,
9816 nmaps
- local_first_binding
,
9817 submaps
+ local_first_binding
,
9818 defs
+ local_first_binding
,
9819 submaps
+ local_first_binding
)
9820 + local_first_binding
);
9822 /* If that click is bound, go for it. */
9823 if (first_binding
< nmaps
)
9828 /* Otherwise, we'll leave key set to the drag event. */
9835 /* Normally, last_nonmenu_event gets the previous key we read.
9836 But when a mouse popup menu is being used,
9837 we don't update last_nonmenu_event; it continues to hold the mouse
9838 event that preceded the first level of menu. */
9839 if (!used_mouse_menu
)
9840 last_nonmenu_event
= key
;
9842 /* Record what part of this_command_keys is the current key sequence. */
9843 this_single_command_key_start
= this_command_key_count
- t
;
9845 /* Look for this sequence in input-decode-map.
9846 Scan from indec.end until we find a bound suffix. */
9847 while (indec
.end
< t
)
9849 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9852 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9853 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9858 mock_input
= diff
+ max (t
, mock_input
);
9859 goto replay_sequence
;
9863 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9864 && indec
.start
>= t
)
9865 /* There is a binding and it's not a prefix.
9866 (and it doesn't have any input-decode-map translation pending).
9867 There is thus no function-key in this sequence.
9868 Moving fkey.start is important in this case to allow keytran.start
9869 to go over the sequence before we return (since we keep the
9870 invariant that keytran.end <= fkey.start). */
9873 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9876 /* If the sequence is unbound, see if we can hang a function key
9877 off the end of it. */
9878 /* Continue scan from fkey.end until we find a bound suffix. */
9879 while (fkey
.end
< indec
.start
)
9881 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9884 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9885 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9886 max (t
, mock_input
),
9887 /* If there's a binding (i.e.
9888 first_binding >= nmaps) we don't want
9889 to apply this function-key-mapping. */
9890 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9895 mock_input
= diff
+ max (t
, mock_input
);
9896 /* Adjust the input-decode-map counters. */
9898 indec
.start
+= diff
;
9900 goto replay_sequence
;
9904 /* Look for this sequence in key-translation-map.
9905 Scan from keytran.end until we find a bound suffix. */
9906 while (keytran
.end
< fkey
.start
)
9908 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9911 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9912 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9917 mock_input
= diff
+ max (t
, mock_input
);
9918 /* Adjust the function-key-map and input-decode-map counters. */
9920 indec
.start
+= diff
;
9924 goto replay_sequence
;
9928 /* If KEY is not defined in any of the keymaps,
9929 and cannot be part of a function key or translation,
9930 and is an upper case letter
9931 use the corresponding lower-case letter instead. */
9932 if (first_binding
>= nmaps
9933 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9935 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9936 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9937 || (XINT (key
) & shift_modifier
)))
9939 Lisp_Object new_key
;
9941 original_uppercase
= key
;
9942 original_uppercase_position
= t
- 1;
9944 if (XINT (key
) & shift_modifier
)
9945 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9947 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9948 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9950 /* We have to do this unconditionally, regardless of whether
9951 the lower-case char is defined in the keymaps, because they
9952 might get translated through function-key-map. */
9953 keybuf
[t
- 1] = new_key
;
9954 mock_input
= max (t
, mock_input
);
9955 shift_translated
= 1;
9957 goto replay_sequence
;
9959 /* If KEY is not defined in any of the keymaps,
9960 and cannot be part of a function key or translation,
9961 and is a shifted function key,
9962 use the corresponding unshifted function key instead. */
9963 if (first_binding
>= nmaps
9964 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9966 Lisp_Object breakdown
= parse_modifiers (key
);
9968 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9970 if (modifiers
& shift_modifier
9971 /* Treat uppercase keys as shifted. */
9973 && (KEY_TO_CHAR (key
)
9974 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9975 && uppercasep (KEY_TO_CHAR (key
))))
9978 = (modifiers
& shift_modifier
9979 ? apply_modifiers (modifiers
& ~shift_modifier
,
9981 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9983 original_uppercase
= key
;
9984 original_uppercase_position
= t
- 1;
9986 /* We have to do this unconditionally, regardless of whether
9987 the lower-case char is defined in the keymaps, because they
9988 might get translated through function-key-map. */
9989 keybuf
[t
- 1] = new_key
;
9990 mock_input
= max (t
, mock_input
);
9991 /* Reset fkey (and consequently keytran) to apply
9992 function-key-map on the result, so that S-backspace is
9993 correctly mapped to DEL (via backspace). OTOH,
9994 input-decode-map doesn't need to go through it again. */
9995 fkey
.start
= fkey
.end
= 0;
9996 keytran
.start
= keytran
.end
= 0;
9997 shift_translated
= 1;
9999 goto replay_sequence
;
10004 read_key_sequence_cmd
= (first_binding
< nmaps
10005 ? defs
[first_binding
]
10008 unread_switch_frame
= delayed_switch_frame
;
10009 unbind_to (count
, Qnil
);
10011 /* Don't downcase the last character if the caller says don't.
10012 Don't downcase it if the result is undefined, either. */
10013 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10015 && t
- 1 == original_uppercase_position
)
10017 keybuf
[t
- 1] = original_uppercase
;
10018 shift_translated
= 0;
10021 if (shift_translated
)
10022 Vthis_command_keys_shift_translated
= Qt
;
10024 /* Occasionally we fabricate events, perhaps by expanding something
10025 according to function-key-map, or by adding a prefix symbol to a
10026 mouse click in the scroll bar or modeline. In this cases, return
10027 the entire generated key sequence, even if we hit an unbound
10028 prefix or a definition before the end. This means that you will
10029 be able to push back the event properly, and also means that
10030 read-key-sequence will always return a logical unit.
10033 for (; t
< mock_input
; t
++)
10035 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10036 && NILP (Fzerop (Vecho_keystrokes
)))
10037 echo_char (keybuf
[t
]);
10038 add_command_key (keybuf
[t
]);
10041 UNGCPRO_VAR (outer_gcpro
);
10045 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10046 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10047 The sequence is sufficient to specify a non-prefix command in the
10048 current local and global maps.
10050 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10051 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10052 as a continuation of the previous key.
10054 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10055 convert the last event to lower case. (Normally any upper case event
10056 is converted to lower case if the original event is undefined and the lower
10057 case equivalent is defined.) A non-nil value is appropriate for reading
10058 a key sequence to be defined.
10060 A C-g typed while in this function is treated like any other character,
10061 and `quit-flag' is not set.
10063 If the key sequence starts with a mouse click, then the sequence is read
10064 using the keymaps of the buffer of the window clicked in, not the buffer
10065 of the selected window as normal.
10067 `read-key-sequence' drops unbound button-down events, since you normally
10068 only care about the click or drag events which follow them. If a drag
10069 or multi-click event is unbound, but the corresponding click event would
10070 be bound, `read-key-sequence' turns the event into a click event at the
10071 drag's starting position. This means that you don't have to distinguish
10072 between click and drag, double, or triple events unless you want to.
10074 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10075 lines separating windows, and scroll bars with imaginary keys
10076 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10078 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10079 function will process a switch-frame event if the user switches frames
10080 before typing anything. If the user switches frames in the middle of a
10081 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10082 is nil, then the event will be put off until after the current key sequence.
10084 `read-key-sequence' checks `function-key-map' for function key
10085 sequences, where they wouldn't conflict with ordinary bindings. See
10086 `function-key-map' for more details.
10088 The optional fifth argument CMD-LOOP, if non-nil, means
10089 that this key sequence is being read by something that will
10090 read commands one after another. It should be nil if the caller
10091 will read just one key sequence. */)
10092 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10094 Lisp_Object keybuf
[30];
10096 struct gcpro gcpro1
;
10097 ptrdiff_t count
= SPECPDL_INDEX ();
10099 if (!NILP (prompt
))
10100 CHECK_STRING (prompt
);
10103 specbind (Qinput_method_exit_on_first_char
,
10104 (NILP (cmd_loop
) ? Qt
: Qnil
));
10105 specbind (Qinput_method_use_echo_area
,
10106 (NILP (cmd_loop
) ? Qt
: Qnil
));
10108 memset (keybuf
, 0, sizeof keybuf
);
10109 GCPRO1 (keybuf
[0]);
10110 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10112 if (NILP (continue_echo
))
10114 this_command_key_count
= 0;
10115 this_command_key_count_reset
= 0;
10116 this_single_command_key_start
= 0;
10119 #ifdef HAVE_WINDOW_SYSTEM
10120 if (display_hourglass_p
)
10121 cancel_hourglass ();
10124 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10125 prompt
, ! NILP (dont_downcase_last
),
10126 ! NILP (can_return_switch_frame
), 0);
10128 #if 0 /* The following is fine for code reading a key sequence and
10129 then proceeding with a lenghty computation, but it's not good
10130 for code reading keys in a loop, like an input method. */
10131 #ifdef HAVE_WINDOW_SYSTEM
10132 if (display_hourglass_p
)
10133 start_hourglass ();
10143 return unbind_to (count
, make_event_array (i
, keybuf
));
10146 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10147 Sread_key_sequence_vector
, 1, 5, 0,
10148 doc
: /* Like `read-key-sequence' but always return a vector. */)
10149 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10151 Lisp_Object keybuf
[30];
10153 struct gcpro gcpro1
;
10154 ptrdiff_t count
= SPECPDL_INDEX ();
10156 if (!NILP (prompt
))
10157 CHECK_STRING (prompt
);
10160 specbind (Qinput_method_exit_on_first_char
,
10161 (NILP (cmd_loop
) ? Qt
: Qnil
));
10162 specbind (Qinput_method_use_echo_area
,
10163 (NILP (cmd_loop
) ? Qt
: Qnil
));
10165 memset (keybuf
, 0, sizeof keybuf
);
10166 GCPRO1 (keybuf
[0]);
10167 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10169 if (NILP (continue_echo
))
10171 this_command_key_count
= 0;
10172 this_command_key_count_reset
= 0;
10173 this_single_command_key_start
= 0;
10176 #ifdef HAVE_WINDOW_SYSTEM
10177 if (display_hourglass_p
)
10178 cancel_hourglass ();
10181 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10182 prompt
, ! NILP (dont_downcase_last
),
10183 ! NILP (can_return_switch_frame
), 0);
10185 #ifdef HAVE_WINDOW_SYSTEM
10186 if (display_hourglass_p
)
10187 start_hourglass ();
10196 return unbind_to (count
, Fvector (i
, keybuf
));
10199 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10200 doc
: /* Execute CMD as an editor command.
10201 CMD must be a symbol that satisfies the `commandp' predicate.
10202 Optional second arg RECORD-FLAG non-nil
10203 means unconditionally put this command in `command-history'.
10204 Otherwise, that is done only if an arg is read using the minibuffer.
10205 The argument KEYS specifies the value to use instead of (this-command-keys)
10206 when reading the arguments; if it is nil, (this-command-keys) is used.
10207 The argument SPECIAL, if non-nil, means that this command is executing
10208 a special event, so ignore the prefix argument and don't clear it. */)
10209 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10211 register Lisp_Object final
;
10212 register Lisp_Object tem
;
10213 Lisp_Object prefixarg
;
10215 debug_on_next_call
= 0;
10217 if (NILP (special
))
10219 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10220 Vcurrent_prefix_arg
= prefixarg
;
10221 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10228 tem
= Fget (cmd
, Qdisabled
);
10231 tem
= Fsymbol_value (Qdisabled_command_function
);
10233 return Frun_hooks (1, &Qdisabled_command_function
);
10239 final
= Findirect_function (cmd
, Qnil
);
10241 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10243 struct gcpro gcpro1
, gcpro2
;
10245 GCPRO2 (cmd
, prefixarg
);
10246 do_autoload (final
, cmd
);
10253 if (STRINGP (final
) || VECTORP (final
))
10255 /* If requested, place the macro in the command history. For
10256 other sorts of commands, call-interactively takes care of
10258 if (!NILP (record_flag
))
10261 = Fcons (Fcons (Qexecute_kbd_macro
,
10262 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10265 /* Don't keep command history around forever. */
10266 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10268 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10270 XSETCDR (tem
, Qnil
);
10274 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10277 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10278 /* Don't call Fcall_interactively directly because we want to make
10279 sure the backtrace has an entry for `call-interactively'.
10280 For the same reason, pass `cmd' rather than `final'. */
10281 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10288 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10290 doc
: /* Read function name, then read its arguments and call it.
10292 To pass a numeric argument to the command you are invoking with, specify
10293 the numeric argument to this command.
10295 Noninteractively, the argument PREFIXARG is the prefix argument to
10296 give to the command you invoke, if it asks for an argument. */)
10297 (Lisp_Object prefixarg
)
10299 Lisp_Object function
;
10300 ptrdiff_t saved_last_point_position
;
10301 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10302 Lisp_Object bindings
, value
;
10303 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10304 #ifdef HAVE_WINDOW_SYSTEM
10305 /* The call to Fcompleting_read will start and cancel the hourglass,
10306 but if the hourglass was already scheduled, this means that no
10307 hourglass will be shown for the actual M-x command itself.
10308 So we restart it if it is already scheduled. Note that checking
10309 hourglass_shown_p is not enough, normally the hourglass is not shown,
10310 just scheduled to be shown. */
10311 int hstarted
= hourglass_started ();
10314 saved_keys
= Fvector (this_command_key_count
,
10315 XVECTOR (this_command_keys
)->contents
);
10316 saved_last_point_position_buffer
= last_point_position_buffer
;
10317 saved_last_point_position
= last_point_position
;
10318 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10320 function
= call0 (intern ("read-extended-command"));
10322 #ifdef HAVE_WINDOW_SYSTEM
10323 if (hstarted
) start_hourglass ();
10326 if (STRINGP (function
) && SCHARS (function
) == 0)
10327 error ("No command name given");
10329 /* Set this_command_keys to the concatenation of saved_keys and
10330 function, followed by a RET. */
10335 this_command_key_count
= 0;
10336 this_command_key_count_reset
= 0;
10337 this_single_command_key_start
= 0;
10339 keys
= XVECTOR (saved_keys
)->contents
;
10340 for (i
= 0; i
< ASIZE (saved_keys
); i
++)
10341 add_command_key (keys
[i
]);
10343 for (i
= 0; i
< SCHARS (function
); i
++)
10344 add_command_key (Faref (function
, make_number (i
)));
10346 add_command_key (make_number ('\015'));
10349 last_point_position
= saved_last_point_position
;
10350 last_point_position_buffer
= saved_last_point_position_buffer
;
10354 function
= Fintern (function
, Qnil
);
10355 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10356 Vthis_command
= function
;
10357 real_this_command
= function
;
10359 /* If enabled, show which key runs this command. */
10360 if (!NILP (Vsuggest_key_bindings
)
10361 && NILP (Vexecuting_kbd_macro
)
10362 && SYMBOLP (function
))
10363 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10369 GCPRO3 (bindings
, value
, function
);
10370 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10372 /* If the command has a key binding, print it now. */
10373 if (!NILP (bindings
)
10374 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10377 /* But first wait, and skip the message if there is input. */
10378 Lisp_Object waited
;
10380 /* If this command displayed something in the echo area;
10381 wait a few seconds, then display our suggestion message. */
10382 if (NILP (echo_area_buffer
[0]))
10383 waited
= sit_for (make_number (0), 0, 2);
10384 else if (NUMBERP (Vsuggest_key_bindings
))
10385 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10387 waited
= sit_for (make_number (2), 0, 2);
10389 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10391 Lisp_Object binding
;
10393 int message_p
= push_message ();
10394 ptrdiff_t count
= SPECPDL_INDEX ();
10395 ptrdiff_t newmessage_len
, newmessage_alloc
;
10398 record_unwind_protect (pop_message_unwind
, Qnil
);
10399 binding
= Fkey_description (bindings
, Qnil
);
10401 (sizeof "You can run the command `' with "
10402 + SBYTES (SYMBOL_NAME (function
)) + SBYTES (binding
));
10403 SAFE_ALLOCA (newmessage
, char *, newmessage_alloc
);
10405 esprintf (newmessage
, "You can run the command `%s' with %s",
10406 SDATA (SYMBOL_NAME (function
)),
10408 message2 (newmessage
,
10410 STRING_MULTIBYTE (binding
));
10411 if (NUMBERP (Vsuggest_key_bindings
))
10412 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10414 waited
= sit_for (make_number (2), 0, 2);
10416 if (!NILP (waited
) && message_p
)
10417 restore_message ();
10420 unbind_to (count
, Qnil
);
10424 RETURN_UNGCPRO (value
);
10428 /* Return nonzero if input events are pending. */
10431 detect_input_pending (void)
10433 if (!input_pending
)
10434 get_input_pending (&input_pending
, 0);
10436 return input_pending
;
10439 /* Return nonzero if input events other than mouse movements are
10443 detect_input_pending_ignore_squeezables (void)
10445 if (!input_pending
)
10446 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10448 return input_pending
;
10451 /* Return nonzero if input events are pending, and run any pending timers. */
10454 detect_input_pending_run_timers (int do_display
)
10456 int old_timers_run
= timers_run
;
10458 if (!input_pending
)
10459 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10461 if (old_timers_run
!= timers_run
&& do_display
)
10463 redisplay_preserve_echo_area (8);
10464 /* The following fixes a bug when using lazy-lock with
10465 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10466 from an idle timer function. The symptom of the bug is that
10467 the cursor sometimes doesn't become visible until the next X
10468 event is processed. --gerd. */
10470 Lisp_Object tail
, frame
;
10471 FOR_EACH_FRAME (tail
, frame
)
10472 if (FRAME_RIF (XFRAME (frame
)))
10473 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10477 return input_pending
;
10480 /* This is called in some cases before a possible quit.
10481 It cases the next call to detect_input_pending to recompute input_pending.
10482 So calling this function unnecessarily can't do any harm. */
10485 clear_input_pending (void)
10490 /* Return nonzero if there are pending requeued events.
10491 This isn't used yet. The hope is to make wait_reading_process_output
10492 call it, and return if it runs Lisp code that unreads something.
10493 The problem is, kbd_buffer_get_event needs to be fixed to know what
10494 to do in that case. It isn't trivial. */
10497 requeued_events_pending_p (void)
10499 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10503 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10504 doc
: /* Return t if command input is currently available with no wait.
10505 Actually, the value is nil only if we can be sure that no input is available;
10506 if there is a doubt, the value is t. */)
10509 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10510 || !NILP (Vunread_post_input_method_events
)
10511 || !NILP (Vunread_input_method_events
))
10514 get_input_pending (&input_pending
,
10515 READABLE_EVENTS_DO_TIMERS_NOW
10516 | READABLE_EVENTS_FILTER_EVENTS
);
10517 return input_pending
> 0 ? Qt
: Qnil
;
10520 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10521 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10524 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10527 if (total_keys
< NUM_RECENT_KEYS
)
10528 return Fvector (total_keys
, keys
);
10531 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10532 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10533 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10534 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10535 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10540 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10541 doc
: /* Return the key sequence that invoked this command.
10542 However, if the command has called `read-key-sequence', it returns
10543 the last key sequence that has been read.
10544 The value is a string or a vector.
10546 See also `this-command-keys-vector'. */)
10549 return make_event_array (this_command_key_count
,
10550 XVECTOR (this_command_keys
)->contents
);
10553 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10554 doc
: /* Return the key sequence that invoked this command, as a vector.
10555 However, if the command has called `read-key-sequence', it returns
10556 the last key sequence that has been read.
10558 See also `this-command-keys'. */)
10561 return Fvector (this_command_key_count
,
10562 XVECTOR (this_command_keys
)->contents
);
10565 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10566 Sthis_single_command_keys
, 0, 0, 0,
10567 doc
: /* Return the key sequence that invoked this command.
10568 More generally, it returns the last key sequence read, either by
10569 the command loop or by `read-key-sequence'.
10570 Unlike `this-command-keys', this function's value
10571 does not include prefix arguments.
10572 The value is always a vector. */)
10575 return Fvector (this_command_key_count
10576 - this_single_command_key_start
,
10577 (XVECTOR (this_command_keys
)->contents
10578 + this_single_command_key_start
));
10581 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10582 Sthis_single_command_raw_keys
, 0, 0, 0,
10583 doc
: /* Return the raw events that were read for 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-single-command-keys', this function's value
10587 shows the events before all translations (except for input methods).
10588 The value is always a vector. */)
10591 return Fvector (raw_keybuf_count
,
10592 (XVECTOR (raw_keybuf
)->contents
));
10595 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10596 Sreset_this_command_lengths
, 0, 0, 0,
10597 doc
: /* Make the unread events replace the last command and echo.
10598 Used in `universal-argument-other-key'.
10600 `universal-argument-other-key' rereads the event just typed.
10601 It then gets translated through `function-key-map'.
10602 The translated event has to replace the real events,
10603 both in the value of (this-command-keys) and in echoing.
10604 To achieve this, `universal-argument-other-key' calls
10605 `reset-this-command-lengths', which discards the record of reading
10606 these events the first time. */)
10609 this_command_key_count
= before_command_key_count
;
10610 if (this_command_key_count
< this_single_command_key_start
)
10611 this_single_command_key_start
= this_command_key_count
;
10613 echo_truncate (before_command_echo_length
);
10615 /* Cause whatever we put into unread-command-events
10616 to echo as if it were being freshly read from the keyboard. */
10617 this_command_key_count_reset
= 1;
10622 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10623 Sclear_this_command_keys
, 0, 1, 0,
10624 doc
: /* Clear out the vector that `this-command-keys' returns.
10625 Also clear the record of the last 100 events, unless optional arg
10626 KEEP-RECORD is non-nil. */)
10627 (Lisp_Object keep_record
)
10631 this_command_key_count
= 0;
10632 this_command_key_count_reset
= 0;
10634 if (NILP (keep_record
))
10636 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10637 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10639 recent_keys_index
= 0;
10644 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10645 doc
: /* Return the current depth in recursive edits. */)
10649 /* Wrap around reliably on integer overflow. */
10650 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10651 XSETINT (temp
, sum
);
10655 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10656 "FOpen dribble file: ",
10657 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10658 If FILE is nil, close any open dribble file.
10659 The file will be closed when Emacs exits. */)
10671 file
= Fexpand_file_name (file
, Qnil
);
10672 dribble
= fopen (SSDATA (file
), "w");
10674 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10679 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10680 doc
: /* Discard the contents of the terminal input buffer.
10681 Also end any kbd macro being defined. */)
10684 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10686 /* Discard the last command from the macro. */
10687 Fcancel_kbd_macro_events ();
10691 update_mode_lines
++;
10693 Vunread_command_events
= Qnil
;
10694 unread_command_char
= -1;
10696 discard_tty_input ();
10698 kbd_fetch_ptr
= kbd_store_ptr
;
10704 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10705 doc
: /* Stop Emacs and return to superior process. You can resume later.
10706 If `cannot-suspend' is non-nil, or if the system doesn't support job
10707 control, run a subshell instead.
10709 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10710 to be read as terminal input by Emacs's parent, after suspension.
10712 Before suspending, run the normal hook `suspend-hook'.
10713 After resumption run the normal hook `suspend-resume-hook'.
10715 Some operating systems cannot stop the Emacs process and resume it later.
10716 On such systems, Emacs starts a subshell instead of suspending. */)
10717 (Lisp_Object stuffstring
)
10719 ptrdiff_t count
= SPECPDL_INDEX ();
10720 int old_height
, old_width
;
10722 struct gcpro gcpro1
;
10725 if (tty_list
&& tty_list
->next
)
10726 error ("There are other tty frames open; close them before suspending Emacs");
10728 if (!NILP (stuffstring
))
10729 CHECK_STRING (stuffstring
);
10731 /* Run the functions in suspend-hook. */
10732 hook
= intern ("suspend-hook");
10733 Frun_hooks (1, &hook
);
10735 GCPRO1 (stuffstring
);
10736 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10737 reset_all_sys_modes ();
10738 /* sys_suspend can get an error if it tries to fork a subshell
10739 and the system resources aren't available for that. */
10740 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10742 stuff_buffered_input (stuffstring
);
10743 if (cannot_suspend
)
10747 unbind_to (count
, Qnil
);
10749 /* Check if terminal/window size has changed.
10750 Note that this is not useful when we are running directly
10751 with a window system; but suspend should be disabled in that case. */
10752 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10753 if (width
!= old_width
|| height
!= old_height
)
10754 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10756 /* Run suspend-resume-hook. */
10757 hook
= intern ("suspend-resume-hook");
10758 Frun_hooks (1, &hook
);
10764 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10765 Then in any case stuff anything Emacs has read ahead and not used. */
10768 stuff_buffered_input (Lisp_Object stuffstring
)
10770 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10771 register unsigned char *p
;
10773 if (STRINGP (stuffstring
))
10775 register ptrdiff_t count
;
10777 p
= SDATA (stuffstring
);
10778 count
= SBYTES (stuffstring
);
10779 while (count
-- > 0)
10784 /* Anything we have read ahead, put back for the shell to read. */
10785 /* ?? What should this do when we have multiple keyboards??
10786 Should we ignore anything that was typed in at the "wrong" kboard?
10788 rms: we should stuff everything back into the kboard
10790 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10793 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10794 kbd_fetch_ptr
= kbd_buffer
;
10795 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10796 stuff_char (kbd_fetch_ptr
->code
);
10798 clear_event (kbd_fetch_ptr
);
10802 #endif /* SIGTSTP */
10806 set_waiting_for_input (struct timeval
*time_to_clear
)
10808 input_available_clear_time
= time_to_clear
;
10810 /* Tell handle_interrupt to throw back to read_char, */
10811 waiting_for_input
= 1;
10813 /* If handle_interrupt was called before and buffered a C-g,
10814 make it run again now, to avoid timing error. */
10815 if (!NILP (Vquit_flag
))
10816 quit_throw_to_read_char ();
10820 clear_waiting_for_input (void)
10822 /* Tell handle_interrupt not to throw back to read_char, */
10823 waiting_for_input
= 0;
10824 input_available_clear_time
= 0;
10827 /* The SIGINT handler.
10829 If we have a frame on the controlling tty, we assume that the
10830 SIGINT was generated by C-g, so we call handle_interrupt.
10831 Otherwise, the handler kills Emacs. */
10834 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10835 /* compilers complain in signal calls. */
10837 /* Must preserve main program's value of errno. */
10838 int old_errno
= errno
;
10839 struct terminal
*terminal
;
10841 SIGNAL_THREAD_CHECK (signalnum
);
10843 /* See if we have an active terminal on our controlling tty. */
10844 terminal
= get_named_tty ("/dev/tty");
10847 /* If there are no frames there, let's pretend that we are a
10848 well-behaving UN*X program and quit. */
10849 Fkill_emacs (Qnil
);
10853 /* Otherwise, the SIGINT was probably generated by C-g. */
10855 /* Set internal_last_event_frame to the top frame of the
10856 controlling tty, if we have a frame there. We disable the
10857 interrupt key on secondary ttys, so the SIGINT must have come
10858 from the controlling tty. */
10859 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10861 handle_interrupt ();
10867 /* This routine is called at interrupt level in response to C-g.
10869 It is called from the SIGINT handler or kbd_buffer_store_event.
10871 If `waiting_for_input' is non zero, then unless `echoing' is
10872 nonzero, immediately throw back to read_char.
10874 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10875 eval to throw, when it gets a chance. If quit-flag is already
10876 non-nil, it stops the job right away. */
10879 handle_interrupt (void)
10885 /* XXX This code needs to be revised for multi-tty support. */
10886 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10888 /* If SIGINT isn't blocked, don't let us be interrupted by
10889 another SIGINT, it might be harmful due to non-reentrancy
10890 in I/O functions. */
10891 sigblock (sigmask (SIGINT
));
10894 reset_all_sys_modes ();
10896 #ifdef SIGTSTP /* Support possible in later USG versions */
10898 * On systems which can suspend the current process and return to the original
10899 * shell, this command causes the user to end up back at the shell.
10900 * The "Auto-save" and "Abort" questions are not asked until
10901 * the user elects to return to emacs, at which point he can save the current
10902 * job and either dump core or continue.
10906 /* Perhaps should really fork an inferior shell?
10907 But that would not provide any way to get back
10908 to the original shell, ever. */
10909 printf ("No support for stopping a process on this operating system;\n");
10910 printf ("you can continue or abort.\n");
10911 #endif /* not SIGTSTP */
10913 /* We must remain inside the screen area when the internal terminal
10914 is used. Note that [Enter] is not echoed by dos. */
10915 cursor_to (SELECTED_FRAME (), 0, 0);
10917 /* It doesn't work to autosave while GC is in progress;
10918 the code used for auto-saving doesn't cope with the mark bit. */
10919 if (!gc_in_progress
)
10921 printf ("Auto-save? (y or n) ");
10923 if (((c
= getchar ()) & ~040) == 'Y')
10925 Fdo_auto_save (Qt
, Qnil
);
10927 printf ("\r\nAuto-save done");
10928 #else /* not MSDOS */
10929 printf ("Auto-save done\n");
10930 #endif /* not MSDOS */
10932 while (c
!= '\n') c
= getchar ();
10936 /* During GC, it must be safe to reenable quitting again. */
10937 Vinhibit_quit
= Qnil
;
10940 #endif /* not MSDOS */
10941 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10942 printf ("but will instead do a real quit after garbage collection ends\r\n");
10947 printf ("\r\nAbort? (y or n) ");
10948 #else /* not MSDOS */
10949 printf ("Abort (and dump core)? (y or n) ");
10950 #endif /* not MSDOS */
10952 if (((c
= getchar ()) & ~040) == 'Y')
10954 while (c
!= '\n') c
= getchar ();
10956 printf ("\r\nContinuing...\r\n");
10957 #else /* not MSDOS */
10958 printf ("Continuing...\n");
10959 #endif /* not MSDOS */
10961 init_all_sys_modes ();
10966 /* If executing a function that wants to be interrupted out of
10967 and the user has not deferred quitting by binding `inhibit-quit'
10968 then quit right away. */
10969 if (immediate_quit
&& NILP (Vinhibit_quit
))
10971 struct gl_state_s saved
;
10972 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10974 immediate_quit
= 0;
10977 GCPRO4 (saved
.object
, saved
.global_code
,
10978 saved
.current_syntax_table
, saved
.old_prop
);
10979 Fsignal (Qquit
, Qnil
);
10980 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10985 /* Else request quit when it's safe */
10989 /* TODO: The longjmp in this call throws the NS event loop integration off,
10990 and it seems to do fine without this. Probably some attention
10991 needs to be paid to the setting of waiting_for_input in
10992 wait_reading_process_output() under HAVE_NS because of the call
10993 to ns_select there (needed because otherwise events aren't picked up
10994 outside of polling since we don't get SIGIO like X and we don't have a
10995 separate event loop thread like W32. */
10997 if (waiting_for_input
&& !echoing
)
10998 quit_throw_to_read_char ();
11002 /* Handle a C-g by making read_char return C-g. */
11005 quit_throw_to_read_char (void)
11008 /* Prevent another signal from doing this before we finish. */
11009 clear_waiting_for_input ();
11012 Vunread_command_events
= Qnil
;
11013 unread_command_char
= -1;
11015 #if 0 /* Currently, sit_for is called from read_char without turning
11016 off polling. And that can call set_waiting_for_input.
11017 It seems to be harmless. */
11018 #ifdef POLL_FOR_INPUT
11019 /* May be > 1 if in recursive minibuffer. */
11020 if (poll_suppress_count
== 0)
11024 if (FRAMEP (internal_last_event_frame
)
11025 && !EQ (internal_last_event_frame
, selected_frame
))
11026 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11029 _longjmp (getcjmp
, 1);
11032 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
11033 Sset_input_interrupt_mode
, 1, 1, 0,
11034 doc
: /* Set interrupt mode of reading keyboard input.
11035 If INTERRUPT is non-nil, Emacs will use input interrupts;
11036 otherwise Emacs uses CBREAK mode.
11038 See also `current-input-mode'. */)
11039 (Lisp_Object interrupt
)
11041 int new_interrupt_input
;
11043 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11044 #ifdef HAVE_X_WINDOWS
11045 if (x_display_list
!= NULL
)
11047 /* When using X, don't give the user a real choice,
11048 because we haven't implemented the mechanisms to support it. */
11049 new_interrupt_input
= 1;
11052 #endif /* HAVE_X_WINDOWS */
11053 new_interrupt_input
= !NILP (interrupt
);
11054 #else /* not SIGIO */
11055 new_interrupt_input
= 0;
11056 #endif /* not SIGIO */
11058 if (new_interrupt_input
!= interrupt_input
)
11060 #ifdef POLL_FOR_INPUT
11064 /* this causes startup screen to be restored and messes with the mouse */
11065 reset_all_sys_modes ();
11066 interrupt_input
= new_interrupt_input
;
11067 init_all_sys_modes ();
11069 interrupt_input
= new_interrupt_input
;
11072 #ifdef POLL_FOR_INPUT
11073 poll_suppress_count
= 1;
11080 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11081 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11082 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11083 C-q in key sequences.
11085 This setting only has an effect on tty terminals and only when
11086 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11088 See also `current-input-mode'. */)
11089 (Lisp_Object flow
, Lisp_Object terminal
)
11091 struct terminal
*t
= get_terminal (terminal
, 1);
11092 struct tty_display_info
*tty
;
11093 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11095 tty
= t
->display_info
.tty
;
11097 if (tty
->flow_control
!= !NILP (flow
))
11100 /* this causes startup screen to be restored and messes with the mouse */
11101 reset_sys_modes (tty
);
11104 tty
->flow_control
= !NILP (flow
);
11107 init_sys_modes (tty
);
11113 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11114 doc
: /* Enable or disable 8-bit input on TERMINAL.
11115 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11116 bit as the Meta modifier.
11118 If META is nil, Emacs will ignore the top bit, on the assumption it is
11121 Otherwise, Emacs will accept and pass through 8-bit input without
11122 specially interpreting the top bit.
11124 This setting only has an effect on tty terminal devices.
11126 Optional parameter TERMINAL specifies the tty terminal device to use.
11127 It may be a terminal object, a frame, or nil for the terminal used by
11128 the currently selected frame.
11130 See also `current-input-mode'. */)
11131 (Lisp_Object meta
, Lisp_Object terminal
)
11133 struct terminal
*t
= get_terminal (terminal
, 1);
11134 struct tty_display_info
*tty
;
11137 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11139 tty
= t
->display_info
.tty
;
11143 else if (EQ (meta
, Qt
))
11148 if (tty
->meta_key
!= new_meta
)
11151 /* this causes startup screen to be restored and messes with the mouse */
11152 reset_sys_modes (tty
);
11155 tty
->meta_key
= new_meta
;
11158 init_sys_modes (tty
);
11164 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11165 doc
: /* Specify character used for quitting.
11166 QUIT must be an ASCII character.
11168 This function only has an effect on the controlling tty of the Emacs
11171 See also `current-input-mode'. */)
11174 struct terminal
*t
= get_named_tty ("/dev/tty");
11175 struct tty_display_info
*tty
;
11176 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11178 tty
= t
->display_info
.tty
;
11180 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11181 error ("QUIT must be an ASCII character");
11184 /* this causes startup screen to be restored and messes with the mouse */
11185 reset_sys_modes (tty
);
11188 /* Don't let this value be out of range. */
11189 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11192 init_sys_modes (tty
);
11198 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11199 doc
: /* Set mode of reading keyboard input.
11200 First arg INTERRUPT non-nil means use input interrupts;
11201 nil means use CBREAK mode.
11202 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11203 (no effect except in CBREAK mode).
11204 Third arg META t means accept 8-bit input (for a Meta key).
11205 META nil means ignore the top bit, on the assumption it is parity.
11206 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11207 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11208 See also `current-input-mode'. */)
11209 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11211 Fset_input_interrupt_mode (interrupt
);
11212 Fset_output_flow_control (flow
, Qnil
);
11213 Fset_input_meta_mode (meta
, Qnil
);
11215 Fset_quit_char (quit
);
11219 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11220 doc
: /* Return information about the way Emacs currently reads keyboard input.
11221 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11222 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11223 nil, Emacs is using CBREAK mode.
11224 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11225 terminal; this does not apply if Emacs uses interrupt-driven input.
11226 META is t if accepting 8-bit input with 8th bit as Meta flag.
11227 META nil means ignoring the top bit, on the assumption it is parity.
11228 META is neither t nor nil if accepting 8-bit input and using
11229 all 8 bits as the character code.
11230 QUIT is the character Emacs currently uses to quit.
11231 The elements of this list correspond to the arguments of
11232 `set-input-mode'. */)
11235 Lisp_Object val
[4];
11236 struct frame
*sf
= XFRAME (selected_frame
);
11238 val
[0] = interrupt_input
? Qt
: Qnil
;
11239 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11241 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11242 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11244 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11251 XSETFASTINT (val
[3], quit_char
);
11253 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11256 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11257 doc
: /* Return position information for pixel coordinates X and Y.
11258 By default, X and Y are relative to text area of the selected window.
11259 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11260 If optional fourth arg WHOLE is non-nil, X is relative to the left
11261 edge of the window.
11263 The return value is similar to a mouse click position:
11264 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11265 IMAGE (DX . DY) (WIDTH . HEIGHT))
11266 The `posn-' functions access elements of such lists. */)
11267 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11272 if (NILP (frame_or_window
))
11273 frame_or_window
= selected_window
;
11275 if (WINDOWP (frame_or_window
))
11279 CHECK_LIVE_WINDOW (frame_or_window
);
11281 w
= XWINDOW (frame_or_window
);
11282 XSETINT (x
, (XINT (x
)
11283 + WINDOW_LEFT_EDGE_X (w
)
11285 ? window_box_left_offset (w
, TEXT_AREA
)
11287 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11288 frame_or_window
= w
->frame
;
11291 CHECK_LIVE_FRAME (frame_or_window
);
11293 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11296 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11297 doc
: /* Return position information for buffer POS in WINDOW.
11298 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11300 Return nil if position is not visible in window. Otherwise,
11301 the return value is similar to that returned by `event-start' for
11302 a mouse click at the upper left corner of the glyph corresponding
11303 to the given buffer position:
11304 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11305 IMAGE (DX . DY) (WIDTH . HEIGHT))
11306 The `posn-' functions access elements of such lists. */)
11307 (Lisp_Object pos
, Lisp_Object window
)
11312 window
= selected_window
;
11314 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11317 Lisp_Object x
= XCAR (tem
);
11318 Lisp_Object y
= XCAR (XCDR (tem
));
11320 /* Point invisible due to hscrolling? */
11323 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11331 * Set up a new kboard object with reasonable initial values.
11334 init_kboard (KBOARD
*kb
)
11336 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11337 KVAR (kb
, Vlast_command
) = Qnil
;
11338 KVAR (kb
, Vreal_last_command
) = Qnil
;
11339 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11340 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11341 KVAR (kb
, Vprefix_arg
) = Qnil
;
11342 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11343 KVAR (kb
, kbd_queue
) = Qnil
;
11344 kb
->kbd_queue_has_data
= 0;
11345 kb
->immediate_echo
= 0;
11346 KVAR (kb
, echo_string
) = Qnil
;
11347 kb
->echo_after_prompt
= -1;
11348 kb
->kbd_macro_buffer
= 0;
11349 kb
->kbd_macro_bufsize
= 0;
11350 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11351 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11352 kb
->reference_count
= 0;
11353 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11354 KVAR (kb
, system_key_syms
) = Qnil
;
11355 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11356 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11357 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11358 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11359 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11363 * Destroy the contents of a kboard object, but not the object itself.
11364 * We use this just before deleting it, or if we're going to initialize
11365 * it a second time.
11368 wipe_kboard (KBOARD
*kb
)
11370 xfree (kb
->kbd_macro_buffer
);
11373 /* Free KB and memory referenced from it. */
11376 delete_kboard (KBOARD
*kb
)
11380 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11383 *kbp
= kb
->next_kboard
;
11385 /* Prevent a dangling reference to KB. */
11386 if (kb
== current_kboard
11387 && FRAMEP (selected_frame
)
11388 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11390 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11392 if (current_kboard
== kb
)
11401 init_keyboard (void)
11403 /* This is correct before outermost invocation of the editor loop */
11404 command_loop_level
= -1;
11405 immediate_quit
= 0;
11406 quit_char
= Ctl ('g');
11407 Vunread_command_events
= Qnil
;
11408 unread_command_char
= -1;
11409 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11411 recent_keys_index
= 0;
11412 kbd_fetch_ptr
= kbd_buffer
;
11413 kbd_store_ptr
= kbd_buffer
;
11414 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11415 do_mouse_tracking
= Qnil
;
11418 interrupt_input_blocked
= 0;
11419 interrupt_input_pending
= 0;
11421 pending_signals
= 0;
11424 /* This means that command_loop_1 won't try to select anything the first
11426 internal_last_event_frame
= Qnil
;
11427 Vlast_event_frame
= internal_last_event_frame
;
11429 current_kboard
= initial_kboard
;
11430 /* Re-initialize the keyboard again. */
11431 wipe_kboard (current_kboard
);
11432 init_kboard (current_kboard
);
11433 /* A value of nil for Vwindow_system normally means a tty, but we also use
11434 it for the initial terminal since there is no window system there. */
11435 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11437 if (!noninteractive
)
11439 /* Before multi-tty support, these handlers used to be installed
11440 only if the current session was a tty session. Now an Emacs
11441 session may have multiple display types, so we always handle
11442 SIGINT. There is special code in interrupt_signal to exit
11443 Emacs on SIGINT when there are no termcap frames on the
11444 controlling terminal. */
11445 signal (SIGINT
, interrupt_signal
);
11447 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11448 SIGQUIT and we can't tell which one it will give us. */
11449 signal (SIGQUIT
, interrupt_signal
);
11450 #endif /* not DOS_NT */
11452 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11454 if (!noninteractive
)
11455 signal (SIGIO
, input_available_signal
);
11458 /* Use interrupt input by default, if it works and noninterrupt input
11459 has deficiencies. */
11461 #ifdef INTERRUPT_INPUT
11462 interrupt_input
= 1;
11464 interrupt_input
= 0;
11470 if (keyboard_init_hook
)
11471 (*keyboard_init_hook
) ();
11473 #ifdef POLL_FOR_INPUT
11475 poll_suppress_count
= 1;
11480 /* This type's only use is in syms_of_keyboard, to initialize the
11481 event header symbols and put properties on them. */
11482 struct event_head
{
11488 static const struct event_head head_table
[] = {
11489 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11490 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11491 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11492 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11493 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11494 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11495 /* `select-window' should be handled just like `switch-frame'
11496 in read_key_sequence. */
11497 {&Qselect_window
, "select-window", &Qswitch_frame
}
11501 syms_of_keyboard (void)
11503 pending_funcalls
= Qnil
;
11504 staticpro (&pending_funcalls
);
11506 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11507 staticpro (&Vlispy_mouse_stem
);
11510 DEFSYM (QCimage
, ":image");
11511 DEFSYM (Qhelp_echo
, "help-echo");
11512 DEFSYM (QCrtl
, ":rtl");
11514 staticpro (&item_properties
);
11515 item_properties
= Qnil
;
11517 staticpro (&tool_bar_item_properties
);
11518 tool_bar_item_properties
= Qnil
;
11519 staticpro (&tool_bar_items_vector
);
11520 tool_bar_items_vector
= Qnil
;
11522 staticpro (&real_this_command
);
11523 real_this_command
= Qnil
;
11525 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11526 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11527 DEFSYM (Qself_insert_command
, "self-insert-command");
11528 DEFSYM (Qforward_char
, "forward-char");
11529 DEFSYM (Qbackward_char
, "backward-char");
11530 DEFSYM (Qdisabled
, "disabled");
11531 DEFSYM (Qundefined
, "undefined");
11532 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11533 DEFSYM (Qpost_command_hook
, "post-command-hook");
11534 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11535 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11536 DEFSYM (Qfunction_key
, "function-key");
11537 DEFSYM (Qmouse_click
, "mouse-click");
11538 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11539 DEFSYM (Qsave_session
, "save-session");
11540 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11541 DEFSYM (Qmenu_enable
, "menu-enable");
11543 #if defined (WINDOWSNT)
11544 DEFSYM (Qlanguage_change
, "language-change");
11548 DEFSYM (Qdbus_event
, "dbus-event");
11551 DEFSYM (QCenable
, ":enable");
11552 DEFSYM (QCvisible
, ":visible");
11553 DEFSYM (QChelp
, ":help");
11554 DEFSYM (QCfilter
, ":filter");
11555 DEFSYM (QCbutton
, ":button");
11556 DEFSYM (QCkeys
, ":keys");
11557 DEFSYM (QCkey_sequence
, ":key-sequence");
11558 DEFSYM (QCtoggle
, ":toggle");
11559 DEFSYM (QCradio
, ":radio");
11560 DEFSYM (QClabel
, ":label");
11561 DEFSYM (QCvert_only
, ":vert-only");
11563 DEFSYM (Qmode_line
, "mode-line");
11564 DEFSYM (Qvertical_line
, "vertical-line");
11565 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11566 DEFSYM (Qmenu_bar
, "menu-bar");
11568 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11569 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11572 DEFSYM (Qabove_handle
, "above-handle");
11573 DEFSYM (Qhandle
, "handle");
11574 DEFSYM (Qbelow_handle
, "below-handle");
11575 DEFSYM (Qup
, "up");
11576 DEFSYM (Qdown
, "down");
11577 DEFSYM (Qtop
, "top");
11578 DEFSYM (Qbottom
, "bottom");
11579 DEFSYM (Qend_scroll
, "end-scroll");
11580 DEFSYM (Qratio
, "ratio");
11582 DEFSYM (Qevent_kind
, "event-kind");
11583 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11584 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11585 DEFSYM (Qmodifier_cache
, "modifier-cache");
11587 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11588 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11590 DEFSYM (Qpolling_period
, "polling-period");
11592 DEFSYM (Qx_set_selection
, "x-set-selection");
11593 DEFSYM (QPRIMARY
, "PRIMARY");
11594 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11596 DEFSYM (Qinput_method_function
, "input-method-function");
11597 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11598 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11600 DEFSYM (Qhelp_form_show
, "help-form-show");
11602 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11603 Fset (Qinput_method_use_echo_area
, Qnil
);
11605 last_point_position_buffer
= Qnil
;
11606 last_point_position_window
= Qnil
;
11610 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11612 for (i
= 0; i
< len
; i
++)
11614 const struct event_head
*p
= &head_table
[i
];
11615 *p
->var
= intern_c_string (p
->name
);
11616 staticpro (p
->var
);
11617 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11618 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11622 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11623 staticpro (&button_down_location
);
11624 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11625 staticpro (&mouse_syms
);
11626 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11627 / sizeof (lispy_wheel_names
[0])),
11629 staticpro (&wheel_syms
);
11633 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11635 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11636 for (i
= 0; i
< len
; i
++)
11637 if (modifier_names
[i
])
11638 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11639 staticpro (&modifier_symbols
);
11642 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11643 staticpro (&recent_keys
);
11645 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11646 staticpro (&this_command_keys
);
11648 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11649 staticpro (&raw_keybuf
);
11651 DEFSYM (Qextended_command_history
, "extended-command-history");
11652 Fset (Qextended_command_history
, Qnil
);
11654 accent_key_syms
= Qnil
;
11655 staticpro (&accent_key_syms
);
11657 func_key_syms
= Qnil
;
11658 staticpro (&func_key_syms
);
11660 drag_n_drop_syms
= Qnil
;
11661 staticpro (&drag_n_drop_syms
);
11663 unread_switch_frame
= Qnil
;
11664 staticpro (&unread_switch_frame
);
11666 internal_last_event_frame
= Qnil
;
11667 staticpro (&internal_last_event_frame
);
11669 read_key_sequence_cmd
= Qnil
;
11670 staticpro (&read_key_sequence_cmd
);
11672 menu_bar_one_keymap_changed_items
= Qnil
;
11673 staticpro (&menu_bar_one_keymap_changed_items
);
11675 menu_bar_items_vector
= Qnil
;
11676 staticpro (&menu_bar_items_vector
);
11678 help_form_saved_window_configs
= Qnil
;
11679 staticpro (&help_form_saved_window_configs
);
11681 defsubr (&Scurrent_idle_time
);
11682 defsubr (&Sevent_symbol_parse_modifiers
);
11683 defsubr (&Sevent_convert_list
);
11684 defsubr (&Sread_key_sequence
);
11685 defsubr (&Sread_key_sequence_vector
);
11686 defsubr (&Srecursive_edit
);
11687 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11688 defsubr (&Strack_mouse
);
11690 defsubr (&Sinput_pending_p
);
11691 defsubr (&Scommand_execute
);
11692 defsubr (&Srecent_keys
);
11693 defsubr (&Sthis_command_keys
);
11694 defsubr (&Sthis_command_keys_vector
);
11695 defsubr (&Sthis_single_command_keys
);
11696 defsubr (&Sthis_single_command_raw_keys
);
11697 defsubr (&Sreset_this_command_lengths
);
11698 defsubr (&Sclear_this_command_keys
);
11699 defsubr (&Ssuspend_emacs
);
11700 defsubr (&Sabort_recursive_edit
);
11701 defsubr (&Sexit_recursive_edit
);
11702 defsubr (&Srecursion_depth
);
11703 defsubr (&Stop_level
);
11704 defsubr (&Sdiscard_input
);
11705 defsubr (&Sopen_dribble_file
);
11706 defsubr (&Sset_input_interrupt_mode
);
11707 defsubr (&Sset_output_flow_control
);
11708 defsubr (&Sset_input_meta_mode
);
11709 defsubr (&Sset_quit_char
);
11710 defsubr (&Sset_input_mode
);
11711 defsubr (&Scurrent_input_mode
);
11712 defsubr (&Sexecute_extended_command
);
11713 defsubr (&Sposn_at_point
);
11714 defsubr (&Sposn_at_x_y
);
11716 DEFVAR_LISP ("last-command-event", last_command_event
,
11717 doc
: /* Last input event that was part of a command. */);
11719 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11720 doc
: /* Last input event in a command, except for mouse menu events.
11721 Mouse menus give back keys that don't look like mouse events;
11722 this variable holds the actual mouse event that led to the menu,
11723 so that you can determine whether the command was run by mouse or not. */);
11725 DEFVAR_LISP ("last-input-event", last_input_event
,
11726 doc
: /* Last input event. */);
11728 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11729 doc
: /* List of events to be read as the command input.
11730 These events are processed first, before actual keyboard input.
11731 Events read from this list are not normally added to `this-command-keys',
11732 as they will already have been added once as they were read for the first time.
11733 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11734 Vunread_command_events
= Qnil
;
11736 DEFVAR_INT ("unread-command-char", unread_command_char
,
11737 doc
: /* If not -1, an object to be read as next command input event. */);
11739 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11740 doc
: /* List of events to be processed as input by input methods.
11741 These events are processed before `unread-command-events'
11742 and actual keyboard input, but are not given to `input-method-function'. */);
11743 Vunread_post_input_method_events
= Qnil
;
11745 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11746 doc
: /* List of events to be processed as input by input methods.
11747 These events are processed after `unread-command-events', but
11748 before actual keyboard input.
11749 If there's an active input method, the events are given to
11750 `input-method-function'. */);
11751 Vunread_input_method_events
= Qnil
;
11753 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11754 doc
: /* Meta-prefix character code.
11755 Meta-foo as command input turns into this character followed by foo. */);
11756 XSETINT (meta_prefix_char
, 033);
11758 DEFVAR_KBOARD ("last-command", Vlast_command
,
11759 doc
: /* The last command executed.
11760 Normally a symbol with a function definition, but can be whatever was found
11761 in the keymap, or whatever the variable `this-command' was set to by that
11764 The value `mode-exit' is special; it means that the previous command
11765 read an event that told it to exit, and it did so and unread that event.
11766 In other words, the present command is the event that made the previous
11769 The value `kill-region' is special; it means that the previous command
11770 was a kill command.
11772 `last-command' has a separate binding for each terminal device.
11773 See Info node `(elisp)Multiple Terminals'. */);
11775 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11776 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11778 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11779 doc
: /* Last command that may be repeated.
11780 The last command executed that was not bound to an input event.
11781 This is the command `repeat' will try to repeat. */);
11783 DEFVAR_LISP ("this-command", Vthis_command
,
11784 doc
: /* The command now being executed.
11785 The command can set this variable; whatever is put here
11786 will be in `last-command' during the following command. */);
11787 Vthis_command
= Qnil
;
11789 DEFVAR_LISP ("this-command-keys-shift-translated",
11790 Vthis_command_keys_shift_translated
,
11791 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11792 Shift-translation occurs when there is no binding for the key sequence
11793 as entered, but a binding was found by changing an upper-case letter
11794 to lower-case, or a shifted function key to an unshifted one. */);
11795 Vthis_command_keys_shift_translated
= Qnil
;
11797 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11798 doc
: /* The command bound to the current key sequence before remapping.
11799 It equals `this-command' if the original command was not remapped through
11800 any of the active keymaps. Otherwise, the value of `this-command' is the
11801 result of looking up the original command in the active keymaps. */);
11802 Vthis_original_command
= Qnil
;
11804 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11805 doc
: /* *Number of input events between auto-saves.
11806 Zero means disable autosaving due to number of characters typed. */);
11807 auto_save_interval
= 300;
11809 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11810 doc
: /* *Number of seconds idle time before auto-save.
11811 Zero or nil means disable auto-saving due to idleness.
11812 After auto-saving due to this many seconds of idle time,
11813 Emacs also does a garbage collection if that seems to be warranted. */);
11814 XSETFASTINT (Vauto_save_timeout
, 30);
11816 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11817 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11818 The value may be integer or floating point. */);
11819 Vecho_keystrokes
= make_number (1);
11821 DEFVAR_INT ("polling-period", polling_period
,
11822 doc
: /* *Interval between polling for input during Lisp execution.
11823 The reason for polling is to make C-g work to stop a running program.
11824 Polling is needed only when using X windows and SIGIO does not work.
11825 Polling is automatically disabled in all other cases. */);
11826 polling_period
= 2;
11828 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11829 doc
: /* *Maximum time between mouse clicks to make a double-click.
11830 Measured in milliseconds. The value nil means disable double-click
11831 recognition; t means double-clicks have no time limit and are detected
11832 by position only. */);
11833 Vdouble_click_time
= make_number (500);
11835 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11836 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11837 On window-system frames, value is the number of pixels the mouse may have
11838 moved horizontally or vertically between two clicks to make a double-click.
11839 On non window-system frames, value is interpreted in units of 1/8 characters
11842 This variable is also the threshold for motion of the mouse
11843 to count as a drag. */);
11844 double_click_fuzz
= 3;
11846 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11847 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11848 inhibit_local_menu_bar_menus
= 0;
11850 DEFVAR_INT ("num-input-keys", num_input_keys
,
11851 doc
: /* Number of complete key sequences read as input so far.
11852 This includes key sequences read from keyboard macros.
11853 The number is effectively the number of interactive command invocations. */);
11854 num_input_keys
= 0;
11856 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11857 doc
: /* Number of input events read from the keyboard so far.
11858 This does not include events generated by keyboard macros. */);
11859 num_nonmacro_input_events
= 0;
11861 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11862 doc
: /* The frame in which the most recently read event occurred.
11863 If the last event came from a keyboard macro, this is set to `macro'. */);
11864 Vlast_event_frame
= Qnil
;
11866 /* This variable is set up in sysdep.c. */
11867 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11868 doc
: /* The ERASE character as set by the user with stty. */);
11870 DEFVAR_LISP ("help-char", Vhelp_char
,
11871 doc
: /* Character to recognize as meaning Help.
11872 When it is read, do `(eval help-form)', and display result if it's a string.
11873 If the value of `help-form' is nil, this char can be read normally. */);
11874 XSETINT (Vhelp_char
, Ctl ('H'));
11876 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11877 doc
: /* List of input events to recognize as meaning Help.
11878 These work just like the value of `help-char' (see that). */);
11879 Vhelp_event_list
= Qnil
;
11881 DEFVAR_LISP ("help-form", Vhelp_form
,
11882 doc
: /* Form to execute when character `help-char' is read.
11883 If the form returns a string, that string is displayed.
11884 If `help-form' is nil, the help char is not recognized. */);
11887 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11888 doc
: /* Command to run when `help-char' character follows a prefix key.
11889 This command is used only when there is no actual binding
11890 for that character after that prefix key. */);
11891 Vprefix_help_command
= Qnil
;
11893 DEFVAR_LISP ("top-level", Vtop_level
,
11894 doc
: /* Form to evaluate when Emacs starts up.
11895 Useful to set before you dump a modified Emacs. */);
11898 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11899 doc
: /* Translate table for local keyboard input, or nil.
11900 If non-nil, the value should be a char-table. Each character read
11901 from the keyboard is looked up in this char-table. If the value found
11902 there is non-nil, then it is used instead of the actual input character.
11904 The value can also be a string or vector, but this is considered obsolete.
11905 If it is a string or vector of length N, character codes N and up are left
11906 untranslated. In a vector, an element which is nil means "no translation".
11908 This is applied to the characters supplied to input methods, not their
11909 output. See also `translation-table-for-input'.
11911 This variable has a separate binding for each terminal.
11912 See Info node `(elisp)Multiple Terminals'. */);
11914 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11915 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11916 \(Even if the operating system has support for stopping a process.\) */);
11917 cannot_suspend
= 0;
11919 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11920 doc
: /* Non-nil means prompt with menus when appropriate.
11921 This is done when reading from a keymap that has a prompt string,
11922 for elements that have prompt strings.
11923 The menu is displayed on the screen
11924 if X menus were enabled at configuration
11925 time and the previous event was a mouse click prefix key.
11926 Otherwise, menu prompting uses the echo area. */);
11927 menu_prompting
= 1;
11929 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11930 doc
: /* Character to see next line of menu prompt.
11931 Type this character while in a menu prompt to rotate around the lines of it. */);
11932 XSETINT (menu_prompt_more_char
, ' ');
11934 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11935 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11936 Emacs applies the modifiers of the character stored here to each keyboard
11937 character it reads. For example, after evaluating the expression
11938 (setq extra-keyboard-modifiers ?\\C-x)
11939 all input characters will have the control modifier applied to them.
11941 Note that the character ?\\C-@, equivalent to the integer zero, does
11942 not count as a control character; rather, it counts as a character
11943 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11944 cancels any modification. */);
11945 extra_keyboard_modifiers
= 0;
11947 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11948 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11949 The command loop sets this to nil before each command,
11950 and tests the value when the command returns.
11951 Buffer modification stores t in this variable. */);
11952 Vdeactivate_mark
= Qnil
;
11953 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11955 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11956 doc
: /* Normal hook run before each command is executed.
11957 If an unhandled error happens in running this hook,
11958 the function in which the error occurred is unconditionally removed, since
11959 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11960 Vpre_command_hook
= Qnil
;
11962 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11963 doc
: /* Normal hook run after each command is executed.
11964 If an unhandled error happens in running this hook,
11965 the function in which the error occurred is unconditionally removed, since
11966 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11967 Vpost_command_hook
= Qnil
;
11970 DEFVAR_LISP ("echo-area-clear-hook", ...,
11971 doc
: /* Normal hook run when clearing the echo area. */);
11973 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11974 Fset (Qecho_area_clear_hook
, Qnil
);
11976 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11977 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11978 Vlucid_menu_bar_dirty_flag
= Qnil
;
11980 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11981 doc
: /* List of menu bar items to move to the end of the menu bar.
11982 The elements of the list are event types that may have menu bar bindings. */);
11983 Vmenu_bar_final_items
= Qnil
;
11985 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11986 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11987 This is used internally by graphical displays that do not render
11988 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11989 Vtool_bar_separator_image_expression
= Qnil
;
11991 DEFVAR_KBOARD ("overriding-terminal-local-map",
11992 Voverriding_terminal_local_map
,
11993 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11994 If this variable is non-nil, it is used as a keymap instead of the
11995 buffer's local map, and the minor mode keymaps and text property keymaps.
11996 It also replaces `overriding-local-map'.
11998 This variable is intended to let commands such as `universal-argument'
11999 set up a different keymap for reading the next command.
12001 `overriding-terminal-local-map' has a separate binding for each
12003 See Info node `(elisp)Multiple Terminals'. */);
12005 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
12006 doc
: /* Keymap that overrides all other local keymaps.
12007 If this variable is non-nil, it is used as a keymap--replacing the
12008 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12009 Voverriding_local_map
= Qnil
;
12011 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
12012 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12013 Otherwise, the menu bar continues to reflect the buffer's local map
12014 and the minor mode maps regardless of `overriding-local-map'. */);
12015 Voverriding_local_map_menu_flag
= Qnil
;
12017 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12018 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12019 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12021 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12022 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12024 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12025 doc
: /* Alist of system-specific X windows key symbols.
12026 Each element should have the form (N . SYMBOL) where N is the
12027 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12028 and SYMBOL is its name.
12030 `system-key-alist' has a separate binding for each terminal device.
12031 See Info node `(elisp)Multiple Terminals'. */);
12033 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12034 doc
: /* Keymap that translates key sequences to key sequences during input.
12035 This is used mainly for mapping key sequences into some preferred
12036 key events (symbols).
12038 The `read-key-sequence' function replaces any subsequence bound by
12039 `local-function-key-map' with its binding. More precisely, when the
12040 active keymaps have no binding for the current key sequence but
12041 `local-function-key-map' binds a suffix of the sequence to a vector or
12042 string, `read-key-sequence' replaces the matching suffix with its
12043 binding, and continues with the new sequence.
12045 If the binding is a function, it is called with one argument (the prompt)
12046 and its return value (a key sequence) is used.
12048 The events that come from bindings in `local-function-key-map' are not
12049 themselves looked up in `local-function-key-map'.
12051 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12052 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12053 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12054 typing `ESC O P x' would return [f1 x].
12056 `local-function-key-map' has a separate binding for each terminal
12057 device. See Info node `(elisp)Multiple Terminals'. If you need to
12058 define a binding on all terminals, change `function-key-map'
12059 instead. Initially, `local-function-key-map' is an empty keymap that
12060 has `function-key-map' as its parent on all terminal devices. */);
12062 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12063 doc
: /* Keymap that decodes input escape sequences.
12064 This is used mainly for mapping ASCII function key sequences into
12065 real Emacs function key events (symbols).
12067 The `read-key-sequence' function replaces any subsequence bound by
12068 `input-decode-map' with its binding. Contrary to `function-key-map',
12069 this map applies its rebinding regardless of the presence of an ordinary
12070 binding. So it is more like `key-translation-map' except that it applies
12071 before `function-key-map' rather than after.
12073 If the binding is a function, it is called with one argument (the prompt)
12074 and its return value (a key sequence) is used.
12076 The events that come from bindings in `input-decode-map' are not
12077 themselves looked up in `input-decode-map'.
12079 This variable is keyboard-local. */);
12081 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12082 doc
: /* The parent keymap of all `local-function-key-map' instances.
12083 Function key definitions that apply to all terminal devices should go
12084 here. If a mapping is defined in both the current
12085 `local-function-key-map' binding and this variable, then the local
12086 definition will take precendence. */);
12087 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12089 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12090 doc
: /* Keymap of key translations that can override keymaps.
12091 This keymap works like `function-key-map', but comes after that,
12092 and its non-prefix bindings override ordinary bindings.
12093 Another difference is that it is global rather than keyboard-local. */);
12094 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12096 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12097 doc
: /* List of deferred actions to be performed at a later time.
12098 The precise format isn't relevant here; we just check whether it is nil. */);
12099 Vdeferred_action_list
= Qnil
;
12101 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12102 doc
: /* Function to call to handle deferred actions, after each command.
12103 This function is called with no arguments after each command
12104 whenever `deferred-action-list' is non-nil. */);
12105 Vdeferred_action_function
= Qnil
;
12107 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12108 doc
: /* List of warnings to be displayed as soon as possible.
12109 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12110 as per the args of `display-warning' (which see).
12111 If this variable is non-nil, `delayed-warnings-hook' will be run
12112 immediately after running `post-command-hook'. */);
12113 Vdelayed_warnings_list
= Qnil
;
12115 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12116 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12117 The value can be a length of time to show the message for.
12118 If the value is non-nil and not a number, we wait 2 seconds. */);
12119 Vsuggest_key_bindings
= Qt
;
12121 DEFVAR_LISP ("timer-list", Vtimer_list
,
12122 doc
: /* List of active absolute time timers in order of increasing time. */);
12123 Vtimer_list
= Qnil
;
12125 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12126 doc
: /* List of active idle-time timers in order of increasing time. */);
12127 Vtimer_idle_list
= Qnil
;
12129 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12130 doc
: /* If non-nil, the function that implements the current input method.
12131 It's called with one argument, a printing character that was just read.
12132 \(That means a character with code 040...0176.)
12133 Typically this function uses `read-event' to read additional events.
12134 When it does so, it should first bind `input-method-function' to nil
12135 so it will not be called recursively.
12137 The function should return a list of zero or more events
12138 to be used as input. If it wants to put back some events
12139 to be reconsidered, separately, by the input method,
12140 it can add them to the beginning of `unread-command-events'.
12142 The input method function can find in `input-method-previous-message'
12143 the previous echo area message.
12145 The input method function should refer to the variables
12146 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12147 for guidance on what to do. */);
12148 Vinput_method_function
= Qnil
;
12150 DEFVAR_LISP ("input-method-previous-message",
12151 Vinput_method_previous_message
,
12152 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12153 This variable exists because `read-event' clears the echo area
12154 before running the input method. It is nil if there was no message. */);
12155 Vinput_method_previous_message
= Qnil
;
12157 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12158 doc
: /* If non-nil, the function that implements the display of help.
12159 It's called with one argument, the help string to display. */);
12160 Vshow_help_function
= Qnil
;
12162 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12163 doc
: /* If non-nil, suppress point adjustment after executing a command.
12165 After a command is executed, if point is moved into a region that has
12166 special properties (e.g. composition, display), we adjust point to
12167 the boundary of the region. But, when a command sets this variable to
12168 non-nil, we suppress the point adjustment.
12170 This variable is set to nil before reading a command, and is checked
12171 just after executing the command. */);
12172 Vdisable_point_adjustment
= Qnil
;
12174 DEFVAR_LISP ("global-disable-point-adjustment",
12175 Vglobal_disable_point_adjustment
,
12176 doc
: /* *If non-nil, always suppress point adjustment.
12178 The default value is nil, in which case, point adjustment are
12179 suppressed only after special commands that set
12180 `disable-point-adjustment' (which see) to non-nil. */);
12181 Vglobal_disable_point_adjustment
= Qnil
;
12183 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12184 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12185 If the value is not a number, such messages don't time out. */);
12186 Vminibuffer_message_timeout
= make_number (2);
12188 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12189 doc
: /* If non-nil, any keyboard input throws to this symbol.
12190 The value of that variable is passed to `quit-flag' and later causes a
12191 peculiar kind of quitting. */);
12192 Vthrow_on_input
= Qnil
;
12194 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12195 doc
: /* If non-nil, function to output error messages.
12196 The arguments are the error data, a list of the form
12197 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12198 such as just as `condition-case' would bind its variable to,
12199 the context (a string which normally goes at the start of the message),
12200 and the Lisp function within which the error was signaled. */);
12201 Vcommand_error_function
= Qnil
;
12203 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12204 Venable_disabled_menus_and_buttons
,
12205 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12207 Help functions bind this to allow help on disabled menu items
12208 and tool-bar buttons. */);
12209 Venable_disabled_menus_and_buttons
= Qnil
;
12211 DEFVAR_LISP ("select-active-regions",
12212 Vselect_active_regions
,
12213 doc
: /* If non-nil, an active region automatically sets the primary selection.
12214 If the value is `only', only temporarily active regions (usually made
12215 by mouse-dragging or shift-selection) set the window selection.
12217 This takes effect only when Transient Mark mode is enabled. */);
12218 Vselect_active_regions
= Qt
;
12220 DEFVAR_LISP ("saved-region-selection",
12221 Vsaved_region_selection
,
12222 doc
: /* Contents of active region prior to buffer modification.
12223 If `select-active-regions' is non-nil, Emacs sets this to the
12224 text in the region before modifying the buffer. The next
12225 `deactivate-mark' call uses this to set the window selection. */);
12226 Vsaved_region_selection
= Qnil
;
12228 DEFVAR_LISP ("debug-on-event",
12230 doc
: /* Enter debugger on this event. When Emacs
12231 receives the special event specifed by this variable, it will try to
12232 break into the debugger as soon as possible instead of processing the
12233 event normally through `special-event-map'.
12235 Currently, the only supported values for this
12236 variable are `sigusr1' and `sigusr2'. */);
12237 Vdebug_on_event
= intern_c_string ("sigusr2");
12239 /* Create the initial keyboard. */
12240 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12241 init_kboard (initial_kboard
);
12242 /* Vwindow_system is left at t for now. */
12243 initial_kboard
->next_kboard
= all_kboards
;
12244 all_kboards
= initial_kboard
;
12248 keys_of_keyboard (void)
12250 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12251 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12252 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12253 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12254 initial_define_key (meta_map
, 'x', "execute-extended-command");
12256 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12257 "handle-delete-frame");
12258 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12259 "ns-put-working-text");
12260 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12261 "ns-unput-working-text");
12262 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12263 current-prefix-arg, as is done in `handle-switch-frame'.
12264 But `handle-switch-frame is not run from the special-map.
12265 Commands from that map are run in a special way that automatically
12266 preserves the prefix-arg. Restoring the prefix arg here is not just
12267 redundant but harmful:
12269 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12270 - after the first prompt, the exit-minibuffer-hook is run which may
12271 iconify a frame and thus push a `iconify-frame' event.
12272 - after running exit-minibuffer-hook, current-prefix-arg is
12273 restored to the non-nil value it had before the prompt.
12274 - we enter the second prompt.
12275 current-prefix-arg is non-nil, prefix-arg is nil.
12276 - before running the first real event, we run the special iconify-frame
12277 event, but we pass the `special' arg to execute-command so
12278 current-prefix-arg and prefix-arg are left untouched.
12279 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12280 - the next key event will have a spuriously non-nil current-prefix-arg. */
12281 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12283 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12285 /* Handling it at such a low-level causes read_key_sequence to get
12286 * confused because it doesn't realize that the current_buffer was
12287 * changed by read_char.
12289 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12290 * "handle-select-window"); */
12291 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12292 "handle-save-session");
12295 /* Define a special event which is raised for dbus callback
12297 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12298 "dbus-handle-event");
12301 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12305 /* Mark the pointers in the kboard objects.
12306 Called by the Fgarbage_collector. */
12308 mark_kboards (void)
12312 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12314 if (kb
->kbd_macro_buffer
)
12315 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12317 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12318 mark_object (KVAR (kb
, Vlast_command
));
12319 mark_object (KVAR (kb
, Vreal_last_command
));
12320 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12321 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12322 mark_object (KVAR (kb
, Vprefix_arg
));
12323 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12324 mark_object (KVAR (kb
, kbd_queue
));
12325 mark_object (KVAR (kb
, defining_kbd_macro
));
12326 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12327 mark_object (KVAR (kb
, Vsystem_key_alist
));
12328 mark_object (KVAR (kb
, system_key_syms
));
12329 mark_object (KVAR (kb
, Vwindow_system
));
12330 mark_object (KVAR (kb
, Vinput_decode_map
));
12331 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12332 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12333 mark_object (KVAR (kb
, echo_string
));
12336 struct input_event
*event
;
12337 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12339 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12340 event
= kbd_buffer
;
12341 if (event
->kind
!= SELECTION_REQUEST_EVENT
12342 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12344 mark_object (event
->x
);
12345 mark_object (event
->y
);
12347 mark_object (event
->frame_or_window
);
12348 mark_object (event
->arg
);