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"
47 #ifdef HAVE_GTK_AND_PTHREAD
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
100 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
101 static int single_kboard
;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled
;
106 static Lisp_Object Qdisabled_command_function
;
108 #define NUM_RECENT_KEYS (300)
110 /* Index for storing next element into recent_keys. */
111 static int recent_keys_index
;
113 /* Total number of elements stored into recent_keys. */
114 static int total_keys
;
116 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
117 static Lisp_Object recent_keys
;
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 int this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 static int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 static Lisp_Object raw_keybuf
;
134 static int raw_keybuf_count
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
138 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 static int this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static int before_command_key_count
;
147 static int before_command_echo_length
;
149 /* For longjmp to where kbd input is being done. */
151 static jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 int waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
160 /* Non-null means we can start echoing at the next input pause even
161 though there is something in the echo area. */
163 static struct kboard
*ok_to_echo_at_next_pause
;
165 /* The kboard last echoing, or null for none. Reset to 0 in
166 cancel_echoing. If non-null, and a current echo area message
167 exists, and echo_message_buffer is eq to the current message
168 buffer, we know that the message comes from echo_kboard. */
170 struct kboard
*echo_kboard
;
172 /* The buffer used for echoing. Set in echo_now, reset in
175 Lisp_Object echo_message_buffer
;
177 /* Nonzero means C-g should cause immediate error-signal. */
180 /* Character that causes a quit. Normally C-g.
182 If we are running on an ordinary terminal, this must be an ordinary
183 ASCII char, since we want to make it our interrupt character.
185 If we are not running on an ordinary terminal, it still needs to be
186 an ordinary ASCII char. This character needs to be recognized in
187 the input interrupt handler. At this point, the keystroke is
188 represented as a struct input_event, while the desired quit
189 character is specified as a lispy event. The mapping from struct
190 input_events to lispy events cannot run in an interrupt handler,
191 and the reverse mapping is difficult for anything but ASCII
194 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
198 /* Current depth in recursive edits. */
199 int command_loop_level
;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame
;
210 /* Last size recorded for a current buffer which is not a minibuffer. */
211 static EMACS_INT last_non_minibuf_size
;
213 /* Total number of times read_char has returned, modulo SIZE_MAX + 1. */
214 size_t num_input_events
;
216 /* Value of num_nonmacro_input_events as of last auto save. */
218 static int last_auto_save
;
220 /* This is like Vthis_command, except that commands never set it. */
221 Lisp_Object real_this_command
;
223 /* The value of point when the last command was started. */
224 static EMACS_INT last_point_position
;
226 /* The buffer that was current when the last command was started. */
227 static Lisp_Object last_point_position_buffer
;
229 /* The window that was selected when the last command was started. */
230 static Lisp_Object last_point_position_window
;
232 /* The frame in which the last input event occurred, or Qmacro if the
233 last event came from a macro. We use this to determine when to
234 generate switch-frame events. This may be cleared by functions
235 like Fselect_frame, to make sure that a switch-frame event is
236 generated by the next character. */
237 Lisp_Object internal_last_event_frame
;
239 /* The timestamp of the last input event we received from the X server.
240 X Windows wants this for selection ownership. */
241 unsigned long 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 static 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 Qinput_method_exit_on_first_char
;
271 static Lisp_Object Qinput_method_use_echo_area
;
273 static Lisp_Object Qhelp_form_show
;
275 /* File in which we write all commands we read. */
276 static FILE *dribble
;
278 /* Nonzero if input is available. */
281 /* Circular buffer for pre-read keyboard input. */
283 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
285 /* Pointer to next available character in kbd_buffer.
286 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
287 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
288 next available char is in kbd_buffer[0]. */
289 static struct input_event
*kbd_fetch_ptr
;
291 /* Pointer to next place to store character in kbd_buffer. This
292 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
293 character should go in kbd_buffer[0]. */
294 static struct input_event
* volatile kbd_store_ptr
;
296 /* The above pair of variables forms a "queue empty" flag. When we
297 enqueue a non-hook event, we increment kbd_store_ptr. When we
298 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
299 there is input available if the two pointers are not equal.
301 Why not just have a flag set and cleared by the enqueuing and
302 dequeuing functions? Such a flag could be screwed up by interrupts
303 at inopportune times. */
305 /* Symbols to head events. */
306 static Lisp_Object Qmouse_movement
;
307 static Lisp_Object Qscroll_bar_movement
;
308 Lisp_Object Qswitch_frame
;
309 static Lisp_Object Qdelete_frame
;
310 static Lisp_Object Qiconify_frame
;
311 static Lisp_Object Qmake_frame_visible
;
312 static Lisp_Object Qselect_window
;
313 Lisp_Object Qhelp_echo
;
315 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
316 static Lisp_Object Qmouse_fixup_help_message
;
319 /* Symbols to denote kinds of events. */
320 static Lisp_Object Qfunction_key
;
321 Lisp_Object Qmouse_click
;
322 #if defined (WINDOWSNT)
323 Lisp_Object Qlanguage_change
;
325 static Lisp_Object Qdrag_n_drop
;
326 static Lisp_Object Qsave_session
;
328 static Lisp_Object Qdbus_event
;
330 static Lisp_Object Qconfig_changed_event
;
332 /* Lisp_Object Qmouse_movement; - also an event header */
334 /* Properties of event headers. */
335 Lisp_Object Qevent_kind
;
336 static Lisp_Object Qevent_symbol_elements
;
338 /* menu and tool bar item parts */
339 static Lisp_Object Qmenu_enable
;
340 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
341 Lisp_Object QCfilter
;
343 /* Non-nil disable property on a command means
344 do not execute it; call disabled-command-function's value instead. */
345 Lisp_Object QCtoggle
, QCradio
;
346 static Lisp_Object QCbutton
, QClabel
;
348 static Lisp_Object QCvert_only
;
350 /* An event header symbol HEAD may have a property named
351 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
352 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
353 mask of modifiers applied to it. If present, this is used to help
354 speed up parse_modifiers. */
355 Lisp_Object Qevent_symbol_element_mask
;
357 /* An unmodified event header BASE may have a property named
358 Qmodifier_cache, which is an alist mapping modifier masks onto
359 modified versions of BASE. If present, this helps speed up
361 static Lisp_Object Qmodifier_cache
;
363 /* Symbols to use for parts of windows. */
364 Lisp_Object Qmode_line
;
365 Lisp_Object Qvertical_line
;
366 static Lisp_Object Qvertical_scroll_bar
;
367 Lisp_Object Qmenu_bar
;
369 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
370 static Lisp_Object
command_loop (void);
371 static Lisp_Object Qextended_command_history
;
372 EMACS_TIME
timer_check (void);
374 static void record_menu_key (Lisp_Object c
);
375 static void echo_now (void);
376 static int echo_length (void);
378 static Lisp_Object Qpolling_period
;
380 /* Incremented whenever a timer is run. */
383 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
385 EMACS_TIME
*input_available_clear_time
;
387 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
388 Default is 1 if INTERRUPT_INPUT is defined. */
391 /* Nonzero while interrupts are temporarily deferred during redisplay. */
392 int interrupts_deferred
;
394 /* Allow m- file to inhibit use of FIONREAD. */
395 #ifdef BROKEN_FIONREAD
399 /* We are unable to use interrupts if FIONREAD is not available,
400 so flush SIGIO so we won't try. */
401 #if !defined (FIONREAD)
407 /* If we support a window system, turn on the code to poll periodically
408 to detect C-g. It isn't actually used when doing interrupt input. */
409 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
410 #define POLL_FOR_INPUT
413 /* The time when Emacs started being idle. */
415 static EMACS_TIME timer_idleness_start_time
;
417 /* After Emacs stops being idle, this saves the last value
418 of timer_idleness_start_time from when it was idle. */
420 static EMACS_TIME timer_last_idleness_start_time
;
423 /* Global variable declarations. */
425 /* Flags for readable_events. */
426 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
427 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
428 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
430 /* Function for init_keyboard to call with no args (if nonzero). */
431 static void (*keyboard_init_hook
) (void);
433 static int read_avail_input (int);
434 static void get_input_pending (int *, int);
435 static int readable_events (int);
436 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
438 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
440 static Lisp_Object
make_lispy_event (struct input_event
*);
441 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
442 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
443 enum scroll_bar_part
,
444 Lisp_Object
, Lisp_Object
,
447 static Lisp_Object
modify_event_symbol (EMACS_INT
, unsigned, Lisp_Object
,
448 Lisp_Object
, const char *const *,
449 Lisp_Object
*, unsigned);
450 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
451 static int help_char_p (Lisp_Object
);
452 static void save_getcjmp (jmp_buf);
453 static void restore_getcjmp (jmp_buf);
454 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
455 static void clear_event (struct input_event
*);
456 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
457 static void interrupt_signal (int signalnum
);
459 static void input_available_signal (int signo
);
461 static Lisp_Object (Fcommand_execute
) (Lisp_Object
, Lisp_Object
, Lisp_Object
,
463 static void handle_interrupt (void);
464 static void quit_throw_to_read_char (void) NO_RETURN
;
465 static void timer_start_idle (void);
466 static void timer_stop_idle (void);
467 static void timer_resume_idle (void);
468 static void handle_user_signal (int);
469 static char *find_user_signal_name (int);
470 static int store_user_signal_events (void);
473 /* Add C to the echo string, if echoing is going on.
474 C can be a character, which is printed prettily ("M-C-x" and all that
475 jazz), or a symbol, whose name is printed. */
478 echo_char (Lisp_Object c
)
480 if (current_kboard
->immediate_echo
)
482 int size
= KEY_DESCRIPTION_SIZE
+ 100;
483 char *buffer
= (char *) alloca (size
);
485 Lisp_Object echo_string
;
487 echo_string
= KVAR (current_kboard
, echo_string
);
489 /* If someone has passed us a composite event, use its head symbol. */
494 ptr
= push_key_description (XINT (c
), ptr
, 1);
496 else if (SYMBOLP (c
))
498 Lisp_Object name
= SYMBOL_NAME (c
);
499 int nbytes
= SBYTES (name
);
501 if (size
- (ptr
- buffer
) < nbytes
)
503 int offset
= ptr
- buffer
;
504 size
= max (2 * size
, size
+ nbytes
);
505 buffer
= (char *) alloca (size
);
506 ptr
= buffer
+ offset
;
509 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
510 STRING_MULTIBYTE (name
), 1);
513 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
516 const char *text
= " (Type ? for further options)";
517 int len
= strlen (text
);
519 if (size
- (ptr
- buffer
) < len
)
521 int offset
= ptr
- buffer
;
523 buffer
= (char *) alloca (size
);
524 ptr
= buffer
+ offset
;
527 memcpy (ptr
, text
, len
);
531 /* Replace a dash from echo_dash with a space, otherwise
532 add a space at the end as a separator between keys. */
533 if (STRINGP (echo_string
)
534 && SCHARS (echo_string
) > 1)
536 Lisp_Object last_char
, prev_char
, idx
;
538 idx
= make_number (SCHARS (echo_string
) - 2);
539 prev_char
= Faref (echo_string
, idx
);
541 idx
= make_number (SCHARS (echo_string
) - 1);
542 last_char
= Faref (echo_string
, idx
);
544 /* We test PREV_CHAR to make sure this isn't the echoing
546 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
547 Faset (echo_string
, idx
, make_number (' '));
549 echo_string
= concat2 (echo_string
, build_string (" "));
551 else if (STRINGP (echo_string
))
552 echo_string
= concat2 (echo_string
, build_string (" "));
554 KVAR (current_kboard
, echo_string
)
555 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
561 /* Temporarily add a dash to the end of the echo string if it's not
562 empty, so that it serves as a mini-prompt for the very next character. */
567 /* Do nothing if not echoing at all. */
568 if (NILP (KVAR (current_kboard
, echo_string
)))
571 if (this_command_key_count
== 0)
574 if (!current_kboard
->immediate_echo
575 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
578 /* Do nothing if we just printed a prompt. */
579 if (current_kboard
->echo_after_prompt
580 == SCHARS (KVAR (current_kboard
, echo_string
)))
583 /* Do nothing if we have already put a dash at the end. */
584 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
586 Lisp_Object last_char
, prev_char
, idx
;
588 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
589 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
591 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
592 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
594 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
598 /* Put a dash at the end of the buffer temporarily,
599 but make it go away when the next character is added. */
600 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
605 /* Display the current echo string, and begin echoing if not already
611 if (!current_kboard
->immediate_echo
)
614 current_kboard
->immediate_echo
= 1;
616 for (i
= 0; i
< this_command_key_count
; i
++)
620 /* Set before_command_echo_length to the value that would
621 have been saved before the start of this subcommand in
622 command_loop_1, if we had already been echoing then. */
623 if (i
== this_single_command_key_start
)
624 before_command_echo_length
= echo_length ();
626 c
= XVECTOR (this_command_keys
)->contents
[i
];
627 if (! (EVENT_HAS_PARAMETERS (c
)
628 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
632 /* Set before_command_echo_length to the value that would
633 have been saved before the start of this subcommand in
634 command_loop_1, if we had already been echoing then. */
635 if (this_command_key_count
== this_single_command_key_start
)
636 before_command_echo_length
= echo_length ();
638 /* Put a dash at the end to invite the user to type more. */
643 message3_nolog (KVAR (current_kboard
, echo_string
),
644 SBYTES (KVAR (current_kboard
, echo_string
)),
645 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
648 /* Record in what buffer we echoed, and from which kboard. */
649 echo_message_buffer
= echo_area_buffer
[0];
650 echo_kboard
= current_kboard
;
652 if (waiting_for_input
&& !NILP (Vquit_flag
))
653 quit_throw_to_read_char ();
656 /* Turn off echoing, for the start of a new command. */
659 cancel_echoing (void)
661 current_kboard
->immediate_echo
= 0;
662 current_kboard
->echo_after_prompt
= -1;
663 KVAR (current_kboard
, echo_string
) = Qnil
;
664 ok_to_echo_at_next_pause
= NULL
;
666 echo_message_buffer
= Qnil
;
669 /* Return the length of the current echo string. */
674 return (STRINGP (KVAR (current_kboard
, echo_string
))
675 ? SCHARS (KVAR (current_kboard
, echo_string
))
679 /* Truncate the current echo message to its first LEN chars.
680 This and echo_char get used by read_key_sequence when the user
681 switches frames while entering a key sequence. */
684 echo_truncate (EMACS_INT nchars
)
686 if (STRINGP (KVAR (current_kboard
, echo_string
)))
687 KVAR (current_kboard
, echo_string
)
688 = Fsubstring (KVAR (current_kboard
, echo_string
),
689 make_number (0), make_number (nchars
));
690 truncate_echo_area (nchars
);
694 /* Functions for manipulating this_command_keys. */
696 add_command_key (Lisp_Object key
)
698 #if 0 /* Not needed after we made Freset_this_command_lengths
699 do the job immediately. */
700 /* If reset-this-command-length was called recently, obey it now.
701 See the doc string of that function for an explanation of why. */
702 if (before_command_restore_flag
)
704 this_command_key_count
= before_command_key_count_1
;
705 if (this_command_key_count
< this_single_command_key_start
)
706 this_single_command_key_start
= this_command_key_count
;
707 echo_truncate (before_command_echo_length_1
);
708 before_command_restore_flag
= 0;
712 if (this_command_key_count
>= ASIZE (this_command_keys
))
713 this_command_keys
= larger_vector (this_command_keys
,
714 2 * ASIZE (this_command_keys
),
717 ASET (this_command_keys
, this_command_key_count
, key
);
718 ++this_command_key_count
;
723 recursive_edit_1 (void)
725 int 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 int 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
;
1001 #ifdef HAVE_WINDOW_SYSTEM
1002 if (display_hourglass_p
)
1003 cancel_hourglass ();
1006 if (!NILP (executing_kbd_macro
))
1008 if (executing_kbd_macro_iterations
== 1)
1009 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1011 sprintf (macroerror
, "After %d kbd macro iterations: ",
1012 executing_kbd_macro_iterations
);
1017 Vstandard_output
= Qt
;
1018 Vstandard_input
= Qt
;
1019 Vexecuting_kbd_macro
= Qnil
;
1020 executing_kbd_macro
= Qnil
;
1021 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1022 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1025 /* Avoid unquittable loop if data contains a circular list. */
1026 old_level
= Vprint_level
;
1027 old_length
= Vprint_length
;
1028 XSETFASTINT (Vprint_level
, 10);
1029 XSETFASTINT (Vprint_length
, 10);
1030 cmd_error_internal (data
, macroerror
);
1031 Vprint_level
= old_level
;
1032 Vprint_length
= old_length
;
1036 Vinhibit_quit
= Qnil
;
1037 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1038 if (command_loop_level
== 0 && minibuf_level
== 0)
1039 any_kboard_state ();
1042 return make_number (0);
1045 /* Take actions on handling an error. DATA is the data that describes
1048 CONTEXT is a C-string containing ASCII characters only which
1049 describes the context in which the error happened. If we need to
1050 generalize CONTEXT to allow multibyte characters, make it a Lisp
1054 cmd_error_internal (Lisp_Object data
, const char *context
)
1056 struct frame
*sf
= SELECTED_FRAME ();
1058 /* The immediate context is not interesting for Quits,
1059 since they are asyncronous. */
1060 if (EQ (XCAR (data
), Qquit
))
1061 Vsignaling_function
= Qnil
;
1066 /* Use user's specified output function if any. */
1067 if (!NILP (Vcommand_error_function
))
1068 call3 (Vcommand_error_function
, data
,
1069 context
? build_string (context
) : empty_unibyte_string
,
1070 Vsignaling_function
);
1071 /* If the window system or terminal frame hasn't been initialized
1072 yet, or we're not interactive, write the message to stderr and exit. */
1073 else if (!sf
->glyphs_initialized_p
1074 /* The initial frame is a special non-displaying frame. It
1075 will be current in daemon mode when there are no frames
1076 to display, and in non-daemon mode before the real frame
1077 has finished initializing. If an error is thrown in the
1078 latter case while creating the frame, then the frame
1079 will never be displayed, so the safest thing to do is
1080 write to stderr and quit. In daemon mode, there are
1081 many other potential errors that do not prevent frames
1082 from being created, so continuing as normal is better in
1084 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1087 print_error_message (data
, Qexternal_debugging_output
,
1088 context
, Vsignaling_function
);
1089 Fterpri (Qexternal_debugging_output
);
1090 Fkill_emacs (make_number (-1));
1094 clear_message (1, 0);
1096 message_log_maybe_newline ();
1099 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1102 Vsignaling_function
= Qnil
;
1105 Lisp_Object
command_loop_1 (void);
1106 static Lisp_Object
command_loop_2 (Lisp_Object
);
1107 static Lisp_Object
top_level_1 (Lisp_Object
);
1109 /* Entry to editor-command-loop.
1110 This level has the catches for exiting/returning to editor command loop.
1111 It returns nil to exit recursive edit, t to abort it. */
1116 if (command_loop_level
> 0 || minibuf_level
> 0)
1119 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1120 executing_kbd_macro
= Qnil
;
1126 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1127 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1128 /* Reset single_kboard in case top-level set it while
1129 evaluating an -f option, or we are stuck there for some
1131 any_kboard_state ();
1133 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1134 executing_kbd_macro
= Qnil
;
1136 /* End of file in -batch run causes exit here. */
1142 /* Here we catch errors in execution of commands within the
1143 editing loop, and reenter the editing loop.
1144 When there is an error, cmd_error runs and returns a non-nil
1145 value to us. A value of nil means that command_loop_1 itself
1146 returned due to end of file (or end of kbd macro). */
1149 command_loop_2 (Lisp_Object ignore
)
1151 register Lisp_Object val
;
1154 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1155 while (!NILP (val
));
1163 return Feval (Vtop_level
, Qnil
);
1167 top_level_1 (Lisp_Object ignore
)
1169 /* On entry to the outer level, run the startup file */
1170 if (!NILP (Vtop_level
))
1171 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1172 else if (!NILP (Vpurify_flag
))
1173 message ("Bare impure Emacs (standard Lisp code not loaded)");
1175 message ("Bare Emacs (standard Lisp code not loaded)");
1179 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1180 doc
: /* Exit all recursive editing levels.
1181 This also exits all active minibuffers. */)
1184 #ifdef HAVE_WINDOW_SYSTEM
1185 if (display_hourglass_p
)
1186 cancel_hourglass ();
1189 /* Unblock input if we enter with input blocked. This may happen if
1190 redisplay traps e.g. during tool-bar update with input blocked. */
1191 while (INPUT_BLOCKED_P
)
1194 Fthrow (Qtop_level
, Qnil
);
1197 static Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1198 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1199 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1202 if (command_loop_level
> 0 || minibuf_level
> 0)
1203 Fthrow (Qexit
, Qnil
);
1205 error ("No recursive edit is in progress");
1208 static Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1209 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1210 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1213 if (command_loop_level
> 0 || minibuf_level
> 0)
1216 error ("No recursive edit is in progress");
1219 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1221 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1222 of this function. */
1225 tracking_off (Lisp_Object old_value
)
1227 do_mouse_tracking
= old_value
;
1228 if (NILP (old_value
))
1230 /* Redisplay may have been preempted because there was input
1231 available, and it assumes it will be called again after the
1232 input has been processed. If the only input available was
1233 the sort that we have just disabled, then we need to call
1235 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1237 redisplay_preserve_echo_area (6);
1238 get_input_pending (&input_pending
,
1239 READABLE_EVENTS_DO_TIMERS_NOW
);
1245 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1246 doc
: /* Evaluate BODY with mouse movement events enabled.
1247 Within a `track-mouse' form, mouse motion generates input events that
1248 you can read with `read-event'.
1249 Normally, mouse motion is ignored.
1250 usage: (track-mouse BODY...) */)
1253 int count
= SPECPDL_INDEX ();
1256 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1258 do_mouse_tracking
= Qt
;
1260 val
= Fprogn (args
);
1261 return unbind_to (count
, val
);
1264 /* If mouse has moved on some frame, return one of those frames.
1268 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1269 after resizing the tool-bar window. */
1271 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1274 int ignore_mouse_drag_p
;
1277 some_mouse_moved (void)
1279 Lisp_Object tail
, frame
;
1281 if (ignore_mouse_drag_p
)
1283 /* ignore_mouse_drag_p = 0; */
1287 FOR_EACH_FRAME (tail
, frame
)
1289 if (XFRAME (frame
)->mouse_moved
)
1290 return XFRAME (frame
);
1296 #endif /* HAVE_MOUSE || HAVE_GPM */
1298 /* This is the actual command reading loop,
1299 sans error-handling encapsulation. */
1301 static int read_key_sequence (Lisp_Object
*, size_t, Lisp_Object
,
1303 void safe_run_hooks (Lisp_Object
);
1304 static void adjust_point_for_property (EMACS_INT
, int);
1306 /* Cancel hourglass from protect_unwind.
1308 #ifdef HAVE_WINDOW_SYSTEM
1310 cancel_hourglass_unwind (Lisp_Object arg
)
1312 cancel_hourglass ();
1317 /* FIXME: This is wrong rather than test window-system, we should call
1318 a new set-selection, which will then dispatch to x-set-selection, or
1319 tty-set-selection, or w32-set-selection, ... */
1320 EXFUN (Fwindow_system
, 1);
1323 command_loop_1 (void)
1326 Lisp_Object keybuf
[30];
1328 int prev_modiff
= 0;
1329 struct buffer
*prev_buffer
= NULL
;
1330 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1331 int was_locked
= single_kboard
;
1333 int already_adjusted
= 0;
1335 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1336 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1337 Vdeactivate_mark
= Qnil
;
1338 waiting_for_input
= 0;
1341 this_command_key_count
= 0;
1342 this_command_key_count_reset
= 0;
1343 this_single_command_key_start
= 0;
1345 if (NILP (Vmemory_full
))
1347 /* Make sure this hook runs after commands that get errors and
1348 throw to top level. */
1349 /* Note that the value cell will never directly contain nil
1350 if the symbol is a local variable. */
1351 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1352 safe_run_hooks (Qpost_command_hook
);
1354 /* If displaying a message, resize the echo area window to fit
1355 that message's size exactly. */
1356 if (!NILP (echo_area_buffer
[0]))
1357 resize_echo_area_exactly ();
1359 if (!NILP (Vdeferred_action_list
))
1360 safe_run_hooks (Qdeferred_action_function
);
1363 /* Do this after running Vpost_command_hook, for consistency. */
1364 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1365 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1366 if (!CONSP (last_command_event
))
1367 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1371 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1374 /* Make sure the current window's buffer is selected. */
1375 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1376 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1378 /* Display any malloc warning that just came out. Use while because
1379 displaying one warning can cause another. */
1381 while (pending_malloc_warning
)
1382 display_malloc_warning ();
1384 Vdeactivate_mark
= Qnil
;
1386 /* If minibuffer on and echo area in use,
1387 wait a short time and redraw minibuffer. */
1390 && !NILP (echo_area_buffer
[0])
1391 && EQ (minibuf_window
, echo_area_window
)
1392 && NUMBERP (Vminibuffer_message_timeout
))
1394 /* Bind inhibit-quit to t so that C-g gets read in
1395 rather than quitting back to the minibuffer. */
1396 int count
= SPECPDL_INDEX ();
1397 specbind (Qinhibit_quit
, Qt
);
1399 sit_for (Vminibuffer_message_timeout
, 0, 2);
1401 /* Clear the echo area. */
1403 safe_run_hooks (Qecho_area_clear_hook
);
1405 unbind_to (count
, Qnil
);
1407 /* If a C-g came in before, treat it as input now. */
1408 if (!NILP (Vquit_flag
))
1411 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1416 /* Select the frame that the last event came from. Usually,
1417 switch-frame events will take care of this, but if some lisp
1418 code swallows a switch-frame event, we'll fix things up here.
1419 Is this a good idea? */
1420 if (FRAMEP (internal_last_event_frame
)
1421 && !EQ (internal_last_event_frame
, selected_frame
))
1422 Fselect_frame (internal_last_event_frame
, Qnil
);
1424 /* If it has changed current-menubar from previous value,
1425 really recompute the menubar from the value. */
1426 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1427 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1428 call0 (Qrecompute_lucid_menubar
);
1430 before_command_key_count
= this_command_key_count
;
1431 before_command_echo_length
= echo_length ();
1433 Vthis_command
= Qnil
;
1434 real_this_command
= Qnil
;
1435 Vthis_original_command
= Qnil
;
1436 Vthis_command_keys_shift_translated
= Qnil
;
1438 /* Read next key sequence; i gets its length. */
1439 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1442 /* A filter may have run while we were reading the input. */
1443 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1445 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1446 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1450 /* Now we have read a key sequence of length I,
1451 or else I is 0 and we found end of file. */
1453 if (i
== 0) /* End of file -- happens only in */
1454 return Qnil
; /* a kbd macro, at the end. */
1455 /* -1 means read_key_sequence got a menu that was rejected.
1456 Just loop around and read another command. */
1460 this_command_key_count
= 0;
1461 this_command_key_count_reset
= 0;
1462 this_single_command_key_start
= 0;
1466 last_command_event
= keybuf
[i
- 1];
1468 /* If the previous command tried to force a specific window-start,
1469 forget about that, in case this command moves point far away
1470 from that position. But also throw away beg_unchanged and
1471 end_unchanged information in that case, so that redisplay will
1472 update the whole window properly. */
1473 if (!NILP (XWINDOW (selected_window
)->force_start
))
1476 XWINDOW (selected_window
)->force_start
= Qnil
;
1477 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1478 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1481 cmd
= read_key_sequence_cmd
;
1482 if (!NILP (Vexecuting_kbd_macro
))
1484 if (!NILP (Vquit_flag
))
1486 Vexecuting_kbd_macro
= Qt
;
1487 QUIT
; /* Make some noise. */
1488 /* Will return since macro now empty. */
1492 /* Do redisplay processing after this command except in special
1493 cases identified below. */
1494 prev_buffer
= current_buffer
;
1495 prev_modiff
= MODIFF
;
1496 last_point_position
= PT
;
1497 last_point_position_window
= selected_window
;
1498 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1500 /* By default, we adjust point to a boundary of a region that
1501 has such a property that should be treated intangible
1502 (e.g. composition, display). But, some commands will set
1503 this variable differently. */
1504 Vdisable_point_adjustment
= Qnil
;
1506 /* Process filters and timers may have messed with deactivate-mark.
1507 reset it before we execute the command. */
1508 Vdeactivate_mark
= Qnil
;
1510 /* Remap command through active keymaps */
1511 Vthis_original_command
= cmd
;
1515 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1519 /* Execute the command. */
1521 Vthis_command
= cmd
;
1522 real_this_command
= cmd
;
1523 safe_run_hooks (Qpre_command_hook
);
1525 already_adjusted
= 0;
1527 if (NILP (Vthis_command
))
1529 /* nil means key is undefined. */
1530 Lisp_Object keys
= Fvector (i
, keybuf
);
1531 keys
= Fkey_description (keys
, Qnil
);
1533 message_with_string ("%s is undefined", keys
, 0);
1534 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1535 update_mode_lines
= 1;
1536 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1540 /* Here for a command that isn't executed directly */
1542 #ifdef HAVE_WINDOW_SYSTEM
1543 int scount
= SPECPDL_INDEX ();
1545 if (display_hourglass_p
1546 && NILP (Vexecuting_kbd_macro
))
1548 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1553 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1555 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1557 #ifdef HAVE_WINDOW_SYSTEM
1558 /* Do not check display_hourglass_p here, because
1559 Fcommand_execute could change it, but we should cancel
1560 hourglass cursor anyway.
1561 But don't cancel the hourglass within a macro
1562 just because a command in the macro finishes. */
1563 if (NILP (Vexecuting_kbd_macro
))
1564 unbind_to (scount
, Qnil
);
1567 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1569 safe_run_hooks (Qpost_command_hook
);
1571 /* If displaying a message, resize the echo area window to fit
1572 that message's size exactly. */
1573 if (!NILP (echo_area_buffer
[0]))
1574 resize_echo_area_exactly ();
1576 safe_run_hooks (Qdeferred_action_function
);
1578 /* If there is a prefix argument,
1579 1) We don't want Vlast_command to be ``universal-argument''
1580 (that would be dumb), so don't set Vlast_command,
1581 2) we want to leave echoing on so that the prefix will be
1582 echoed as part of this key sequence, so don't call
1584 3) we want to leave this_command_key_count non-zero, so that
1585 read_char will realize that it is re-reading a character, and
1586 not echo it a second time.
1588 If the command didn't actually create a prefix arg,
1589 but is merely a frame event that is transparent to prefix args,
1590 then the above doesn't apply. */
1591 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1593 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1594 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1595 if (!CONSP (last_command_event
))
1596 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1598 this_command_key_count
= 0;
1599 this_command_key_count_reset
= 0;
1600 this_single_command_key_start
= 0;
1603 if (!NILP (BVAR (current_buffer
, mark_active
))
1604 && !NILP (Vrun_hooks
))
1606 /* In Emacs 22, setting transient-mark-mode to `only' was a
1607 way of turning it on for just one command. This usage is
1608 obsolete, but support it anyway. */
1609 if (EQ (Vtransient_mark_mode
, Qidentity
))
1610 Vtransient_mark_mode
= Qnil
;
1611 else if (EQ (Vtransient_mark_mode
, Qonly
))
1612 Vtransient_mark_mode
= Qidentity
;
1614 if (!NILP (Vdeactivate_mark
))
1615 /* If `select-active-regions' is non-nil, this call to
1616 `deactivate-mark' also sets the PRIMARY selection. */
1617 call0 (Qdeactivate_mark
);
1620 /* Even if not deactivating the mark, set PRIMARY if
1621 `select-active-regions' is non-nil. */
1622 if (!NILP (Fwindow_system (Qnil
))
1623 /* Even if mark_active is non-nil, the actual buffer
1624 marker may not have been set yet (Bug#7044). */
1625 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1626 && (EQ (Vselect_active_regions
, Qonly
)
1627 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1628 : (!NILP (Vselect_active_regions
)
1629 && !NILP (Vtransient_mark_mode
)))
1630 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1633 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1636 call2 (Qx_set_selection
, QPRIMARY
,
1637 make_buffer_string (beg
, end
, 0));
1639 call2 (Qx_set_selection
, QPRIMARY
,
1640 make_buffer_string (end
, beg
, 0));
1641 /* Don't set empty selections. */
1644 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1646 Lisp_Object hook
= intern ("activate-mark-hook");
1647 Frun_hooks (1, &hook
);
1651 Vsaved_region_selection
= Qnil
;
1656 if (current_buffer
== prev_buffer
1657 && last_point_position
!= PT
1658 && NILP (Vdisable_point_adjustment
)
1659 && NILP (Vglobal_disable_point_adjustment
))
1661 if (last_point_position
> BEGV
1662 && last_point_position
< ZV
1663 && (composition_adjust_point (last_point_position
,
1664 last_point_position
)
1665 != last_point_position
))
1666 /* The last point was temporarily set within a grapheme
1667 cluster to prevent automatic composition. To recover
1668 the automatic composition, we must update the
1670 windows_or_buffers_changed
++;
1671 if (!already_adjusted
)
1672 adjust_point_for_property (last_point_position
,
1673 MODIFF
!= prev_modiff
);
1676 /* Install chars successfully executed in kbd macro. */
1678 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1679 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1680 finalize_kbd_macro_chars ();
1681 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1683 any_kboard_state ();
1688 /* Adjust point to a boundary of a region that has such a property
1689 that should be treated intangible. For the moment, we check
1690 `composition', `display' and `invisible' properties.
1691 LAST_PT is the last position of point. */
1694 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1697 Lisp_Object val
, overlay
, tmp
;
1698 /* When called after buffer modification, we should temporarily
1699 suppress the point adjustment for automatic composition so that a
1700 user can keep inserting another character at point or keep
1701 deleting characters around point. */
1702 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1703 EMACS_INT orig_pt
= PT
;
1705 /* FIXME: cycling is probably not necessary because these properties
1706 can't be usefully combined anyway. */
1707 while (check_composition
|| check_display
|| check_invisible
)
1709 /* FIXME: check `intangible'. */
1710 if (check_composition
1711 && PT
> BEGV
&& PT
< ZV
1712 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1715 check_display
= check_invisible
= 1;
1717 check_composition
= 0;
1719 && PT
> BEGV
&& PT
< ZV
1720 && !NILP (val
= get_char_property_and_overlay
1721 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1722 && display_prop_intangible_p (val
)
1723 && (!OVERLAYP (overlay
)
1724 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1725 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1726 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1727 && (beg
< PT
/* && end > PT <- It's always the case. */
1728 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1731 SET_PT (PT
< last_pt
1732 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1734 check_composition
= check_invisible
= 1;
1737 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1739 int inv
, ellipsis
= 0;
1742 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1745 /* FIXME: We should stop if we find a spot between
1746 two runs of `invisible' where inserted text would
1747 be visible. This is important when we have two
1748 invisible boundaries that enclose an area: if the
1749 area is empty, we need this test in order to make
1750 it possible to place point in the middle rather
1751 than skip both boundaries. However, this code
1752 also stops anywhere in a non-sticky text-property,
1753 which breaks (e.g.) Org mode. */
1754 && (val
= get_pos_property (make_number (end
),
1756 TEXT_PROP_MEANS_INVISIBLE (val
))
1758 && !NILP (val
= get_char_property_and_overlay
1759 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1760 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1762 ellipsis
= ellipsis
|| inv
> 1
1763 || (OVERLAYP (overlay
)
1764 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1765 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1766 tmp
= Fnext_single_char_property_change
1767 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1768 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1772 && (val
= get_pos_property (make_number (beg
),
1774 TEXT_PROP_MEANS_INVISIBLE (val
))
1776 && !NILP (val
= get_char_property_and_overlay
1777 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1778 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1780 ellipsis
= ellipsis
|| inv
> 1
1781 || (OVERLAYP (overlay
)
1782 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1783 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1784 tmp
= Fprevious_single_char_property_change
1785 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1786 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1789 /* Move away from the inside area. */
1790 if (beg
< PT
&& end
> PT
)
1792 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1793 /* We haven't moved yet (so we don't need to fear
1794 infinite-looping) and we were outside the range
1795 before (so either end of the range still corresponds
1796 to a move in the right direction): pretend we moved
1797 less than we actually did, so that we still have
1798 more freedom below in choosing which end of the range
1800 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1801 /* We either have moved already or the last point
1802 was already in the range: we don't get to choose
1803 which end of the range we have to go to. */
1804 : (PT
< last_pt
? beg
: end
));
1805 check_composition
= check_display
= 1;
1807 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1808 the point to something other than its argument, due to
1809 point-motion hooks, intangibility, etc. */
1810 xassert (PT
== beg
|| PT
== end
);
1813 /* Pretend the area doesn't exist if the buffer is not
1815 if (!modified
&& !ellipsis
&& beg
< end
)
1817 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1818 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1819 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1820 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1821 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1822 /* We've already moved as far as we can. Trying to go
1823 to the other end would mean moving backwards and thus
1824 could lead to an infinite loop. */
1826 else if (val
= get_pos_property (make_number (PT
),
1828 TEXT_PROP_MEANS_INVISIBLE (val
)
1829 && (val
= get_pos_property
1830 (make_number (PT
== beg
? end
: beg
),
1832 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1833 (check_composition
= check_display
= 1,
1834 SET_PT (PT
== beg
? end
: beg
));
1837 check_invisible
= 0;
1841 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1844 safe_run_hooks_1 (void)
1846 eassert (CONSP (Vinhibit_quit
));
1847 return call0 (XCDR (Vinhibit_quit
));
1850 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1854 safe_run_hooks_error (Lisp_Object error_data
)
1857 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1858 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1859 Lisp_Object args
[4];
1860 args
[0] = build_string ("Error in %s (%s): %s");
1863 args
[3] = error_data
;
1869 Lisp_Object newval
= Qnil
;
1870 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1871 if (EQ (fun
, XCAR (val
)))
1874 newval
= Fcons (XCAR (val
), newval
);
1876 return Fset (hook
, Fnreverse (newval
));
1877 /* Not found in the local part of the hook. Let's look at the global
1880 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1881 : Fdefault_value (hook
));
1882 CONSP (val
); val
= XCDR (val
))
1883 if (EQ (fun
, XCAR (val
)))
1886 newval
= Fcons (XCAR (val
), newval
);
1888 return Fset_default (hook
, Fnreverse (newval
));
1894 safe_run_hook_funcall (size_t nargs
, Lisp_Object
*args
)
1896 eassert (nargs
== 1);
1897 if (CONSP (Vinhibit_quit
))
1898 XSETCDR (Vinhibit_quit
, args
[0]);
1900 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1902 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1906 /* If we get an error while running the hook, cause the hook variable
1907 to be nil. Also inhibit quits, so that C-g won't cause the hook
1908 to mysteriously evaporate. */
1911 safe_run_hooks (Lisp_Object hook
)
1913 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1914 to its body or to its handlers other than via globals such as
1915 dynamically-bound variables ;-) */
1916 int count
= SPECPDL_INDEX ();
1917 specbind (Qinhibit_quit
, hook
);
1919 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1921 unbind_to (count
, Qnil
);
1925 /* Nonzero means polling for input is temporarily suppressed. */
1927 int poll_suppress_count
;
1929 /* Asynchronous timer for polling. */
1931 static struct atimer
*poll_timer
;
1934 #ifdef POLL_FOR_INPUT
1936 /* Poll for input, so that we catch a C-g if it comes in. This
1937 function is called from x_make_frame_visible, see comment
1941 poll_for_input_1 (void)
1943 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1944 doing anything dangerous. */
1948 if (interrupt_input_blocked
== 0
1949 && !waiting_for_input
)
1950 read_avail_input (0);
1956 /* Timer callback function for poll_timer. TIMER is equal to
1960 poll_for_input (struct atimer
*timer
)
1962 if (poll_suppress_count
== 0)
1965 interrupt_input_pending
= 1;
1966 pending_signals
= 1;
1968 poll_for_input_1 ();
1973 #endif /* POLL_FOR_INPUT */
1975 /* Begin signals to poll for input, if they are appropriate.
1976 This function is called unconditionally from various places. */
1979 start_polling (void)
1981 #ifdef POLL_FOR_INPUT
1982 /* XXX This condition was (read_socket_hook && !interrupt_input),
1983 but read_socket_hook is not global anymore. Let's pretend that
1985 if (!interrupt_input
)
1987 /* Turn alarm handling on unconditionally. It might have
1988 been turned off in process.c. */
1989 turn_on_atimers (1);
1991 /* If poll timer doesn't exist, are we need one with
1992 a different interval, start a new one. */
1993 if (poll_timer
== NULL
1994 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1996 EMACS_TIME interval
;
1999 cancel_atimer (poll_timer
);
2001 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2002 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2003 poll_for_input
, NULL
);
2006 /* Let the timer's callback function poll for input
2007 if this becomes zero. */
2008 --poll_suppress_count
;
2013 /* Nonzero if we are using polling to handle input asynchronously. */
2016 input_polling_used (void)
2018 #ifdef POLL_FOR_INPUT
2019 /* XXX This condition was (read_socket_hook && !interrupt_input),
2020 but read_socket_hook is not global anymore. Let's pretend that
2022 return !interrupt_input
;
2028 /* Turn off polling. */
2033 #ifdef POLL_FOR_INPUT
2034 /* XXX This condition was (read_socket_hook && !interrupt_input),
2035 but read_socket_hook is not global anymore. Let's pretend that
2037 if (!interrupt_input
)
2038 ++poll_suppress_count
;
2042 /* Set the value of poll_suppress_count to COUNT
2043 and start or stop polling accordingly. */
2046 set_poll_suppress_count (int count
)
2048 #ifdef POLL_FOR_INPUT
2049 if (count
== 0 && poll_suppress_count
!= 0)
2051 poll_suppress_count
= 1;
2054 else if (count
!= 0 && poll_suppress_count
== 0)
2058 poll_suppress_count
= count
;
2062 /* Bind polling_period to a value at least N.
2063 But don't decrease it. */
2066 bind_polling_period (int n
)
2068 #ifdef POLL_FOR_INPUT
2069 int new = polling_period
;
2074 stop_other_atimers (poll_timer
);
2076 specbind (Qpolling_period
, make_number (new));
2077 /* Start a new alarm with the new period. */
2082 /* Apply the control modifier to CHARACTER. */
2085 make_ctrl_char (int c
)
2087 /* Save the upper bits here. */
2088 int upper
= c
& ~0177;
2090 if (! ASCII_BYTE_P (c
))
2091 return c
|= ctrl_modifier
;
2095 /* Everything in the columns containing the upper-case letters
2096 denotes a control character. */
2097 if (c
>= 0100 && c
< 0140)
2101 /* Set the shift modifier for a control char
2102 made from a shifted letter. But only for letters! */
2103 if (oc
>= 'A' && oc
<= 'Z')
2104 c
|= shift_modifier
;
2107 /* The lower-case letters denote control characters too. */
2108 else if (c
>= 'a' && c
<= 'z')
2111 /* Include the bits for control and shift
2112 only if the basic ASCII code can't indicate them. */
2116 /* Replace the high bits. */
2117 c
|= (upper
& ~ctrl_modifier
);
2122 /* Display the help-echo property of the character after the mouse pointer.
2123 Either show it in the echo area, or call show-help-function to display
2124 it by other means (maybe in a tooltip).
2126 If HELP is nil, that means clear the previous help echo.
2128 If HELP is a string, display that string. If HELP is a function,
2129 call it with OBJECT and POS as arguments; the function should
2130 return a help string or nil for none. For all other types of HELP,
2131 evaluate it to obtain a string.
2133 WINDOW is the window in which the help was generated, if any.
2134 It is nil if not in a window.
2136 If OBJECT is a buffer, POS is the position in the buffer where the
2137 `help-echo' text property was found.
2139 If OBJECT is an overlay, that overlay has a `help-echo' property,
2140 and POS is the position in the overlay's buffer under the mouse.
2142 If OBJECT is a string (an overlay string or a string displayed with
2143 the `display' property). POS is the position in that string under
2146 Note: this function may only be called with HELP nil or a string
2147 from X code running asynchronously. */
2150 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2153 if (!NILP (help
) && !STRINGP (help
))
2155 if (FUNCTIONP (help
))
2157 Lisp_Object args
[4];
2162 help
= safe_call (4, args
);
2165 help
= safe_eval (help
);
2167 if (!STRINGP (help
))
2171 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2172 if (!noninteractive
&& STRINGP (help
))
2174 /* The mouse-fixup-help-message Lisp function can call
2175 mouse_position_hook, which resets the mouse_moved flags.
2176 This causes trouble if we are trying to read a mouse motion
2177 event (i.e., if we are inside a `track-mouse' form), so we
2178 restore the mouse_moved flag. */
2179 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2180 help
= call1 (Qmouse_fixup_help_message
, help
);
2186 if (STRINGP (help
) || NILP (help
))
2188 if (!NILP (Vshow_help_function
))
2189 call1 (Vshow_help_function
, help
);
2190 help_echo_showing_p
= STRINGP (help
);
2196 /* Input of single characters from keyboard */
2198 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2199 struct timeval
*end_time
);
2200 static void record_char (Lisp_Object c
);
2202 static Lisp_Object help_form_saved_window_configs
;
2204 read_char_help_form_unwind (Lisp_Object arg
)
2206 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2207 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2208 if (!NILP (window_config
))
2209 Fset_window_configuration (window_config
);
2213 #define STOP_POLLING \
2214 do { if (! polling_stopped_here) stop_polling (); \
2215 polling_stopped_here = 1; } while (0)
2217 #define RESUME_POLLING \
2218 do { if (polling_stopped_here) start_polling (); \
2219 polling_stopped_here = 0; } while (0)
2221 /* read a character from the keyboard; call the redisplay if needed */
2222 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2223 -1 means do not do redisplay, but do do autosaving.
2226 /* The arguments MAPS and NMAPS are for menu prompting.
2227 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2229 PREV_EVENT is the previous input event, or nil if we are reading
2230 the first event of a key sequence (or not reading a key sequence).
2231 If PREV_EVENT is t, that is a "magic" value that says
2232 not to run input methods, but in other respects to act as if
2233 not reading a key sequence.
2235 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2236 if we used a mouse menu to read the input, or zero otherwise. If
2237 USED_MOUSE_MENU is null, we don't dereference it.
2239 Value is -2 when we find input on another keyboard. A second call
2240 to read_char will read it.
2242 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2243 specifying the maximum time to wait until. If no input arrives by
2244 that time, stop waiting and return nil.
2246 Value is t if we showed a menu and the user rejected it. */
2249 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2250 int *used_mouse_menu
, struct timeval
*end_time
)
2252 volatile Lisp_Object c
;
2254 jmp_buf local_getcjmp
;
2256 volatile int key_already_recorded
= 0;
2257 Lisp_Object tem
, save
;
2258 volatile Lisp_Object previous_echo_area_message
;
2259 volatile Lisp_Object also_record
;
2260 volatile int reread
;
2261 struct gcpro gcpro1
, gcpro2
;
2262 int polling_stopped_here
= 0;
2263 struct kboard
*orig_kboard
= current_kboard
;
2267 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2268 before_command_key_count
= this_command_key_count
;
2269 before_command_echo_length
= echo_length ();
2272 previous_echo_area_message
= Qnil
;
2274 GCPRO2 (c
, previous_echo_area_message
);
2279 if (CONSP (Vunread_post_input_method_events
))
2281 c
= XCAR (Vunread_post_input_method_events
);
2282 Vunread_post_input_method_events
2283 = XCDR (Vunread_post_input_method_events
);
2285 /* Undo what read_char_x_menu_prompt did when it unread
2286 additional keys returned by Fx_popup_menu. */
2288 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2296 if (unread_command_char
!= -1)
2298 XSETINT (c
, unread_command_char
);
2299 unread_command_char
= -1;
2305 if (CONSP (Vunread_command_events
))
2307 int was_disabled
= 0;
2309 c
= XCAR (Vunread_command_events
);
2310 Vunread_command_events
= XCDR (Vunread_command_events
);
2314 /* Undo what sit-for did when it unread additional keys
2315 inside universal-argument. */
2318 && EQ (XCAR (c
), Qt
))
2324 /* Undo what read_char_x_menu_prompt did when it unread
2325 additional keys returned by Fx_popup_menu. */
2327 && EQ (XCDR (c
), Qdisabled
)
2328 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2334 /* If the queued event is something that used the mouse,
2335 set used_mouse_menu accordingly. */
2337 /* Also check was_disabled so last-nonmenu-event won't return
2338 a bad value when submenus are involved. (Bug#447) */
2339 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2340 *used_mouse_menu
= 1;
2342 goto reread_for_input_method
;
2345 if (CONSP (Vunread_input_method_events
))
2347 c
= XCAR (Vunread_input_method_events
);
2348 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2350 /* Undo what read_char_x_menu_prompt did when it unread
2351 additional keys returned by Fx_popup_menu. */
2353 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2357 goto reread_for_input_method
;
2360 this_command_key_count_reset
= 0;
2362 if (!NILP (Vexecuting_kbd_macro
))
2364 /* We set this to Qmacro; since that's not a frame, nobody will
2365 try to switch frames on us, and the selected window will
2368 Since this event came from a macro, it would be misleading to
2369 leave internal_last_event_frame set to wherever the last
2370 real event came from. Normally, a switch-frame event selects
2371 internal_last_event_frame after each command is read, but
2372 events read from a macro should never cause a new frame to be
2374 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2376 /* Exit the macro if we are at the end.
2377 Also, some things replace the macro with t
2378 to force an early exit. */
2379 if (EQ (Vexecuting_kbd_macro
, Qt
)
2380 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2386 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2387 if (STRINGP (Vexecuting_kbd_macro
)
2388 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2389 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2391 executing_kbd_macro_index
++;
2396 if (!NILP (unread_switch_frame
))
2398 c
= unread_switch_frame
;
2399 unread_switch_frame
= Qnil
;
2401 /* This event should make it into this_command_keys, and get echoed
2402 again, so we do not set `reread'. */
2406 /* if redisplay was requested */
2407 if (commandflag
>= 0)
2409 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2411 /* If there is pending input, process any events which are not
2412 user-visible, such as X selection_request events. */
2414 || detect_input_pending_run_timers (0))
2415 swallow_events (0); /* may clear input_pending */
2417 /* Redisplay if no pending input. */
2418 while (!input_pending
)
2420 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2421 redisplay_preserve_echo_area (5);
2426 /* Normal case: no input arrived during redisplay. */
2429 /* Input arrived and pre-empted redisplay.
2430 Process any events which are not user-visible. */
2432 /* If that cleared input_pending, try again to redisplay. */
2435 /* Prevent the redisplay we just did
2436 from messing up echoing of the input after the prompt. */
2437 if (commandflag
== 0 && echo_current
)
2438 echo_message_buffer
= echo_area_buffer
[0];
2442 /* Message turns off echoing unless more keystrokes turn it on again.
2444 The code in 20.x for the condition was
2446 1. echo_area_glyphs && *echo_area_glyphs
2447 2. && echo_area_glyphs != current_kboard->echobuf
2448 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2450 (1) means there's a current message displayed
2452 (2) means it's not the message from echoing from the current
2455 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2456 is set to a non-null value. This is done in read_char and it is
2457 set to echo_area_glyphs after a call to echo_char. That means
2458 ok_to_echo_at_next_pause is either null or
2459 current_kboard->echobuf with the appropriate current_kboard at
2462 So, condition (3) means in clear text ok_to_echo_at_next_pause
2463 must be either null, or the current message isn't from echoing at
2464 all, or it's from echoing from a different kboard than the
2467 if (/* There currently is something in the echo area. */
2468 !NILP (echo_area_buffer
[0])
2469 && (/* And it's either not from echoing. */
2470 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2471 /* Or it's an echo from a different kboard. */
2472 || echo_kboard
!= current_kboard
2473 /* Or we explicitly allow overwriting whatever there is. */
2474 || ok_to_echo_at_next_pause
== NULL
))
2479 /* Try reading a character via menu prompting in the minibuf.
2480 Try this before the sit-for, because the sit-for
2481 would do the wrong thing if we are supposed to do
2482 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2483 after a mouse event so don't try a minibuf menu. */
2485 if (nmaps
> 0 && INTERACTIVE
2486 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2487 /* Don't bring up a menu if we already have another event. */
2488 && NILP (Vunread_command_events
)
2489 && unread_command_char
< 0
2490 && !detect_input_pending_run_timers (0))
2492 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2494 if (INTEGERP (c
) && XINT (c
) == -2)
2495 return c
; /* wrong_kboard_jmpbuf */
2499 key_already_recorded
= 1;
2504 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2505 We will do that below, temporarily for short sections of code,
2506 when appropriate. local_getcjmp must be in effect
2507 around any call to sit_for or kbd_buffer_get_event;
2508 it *must not* be in effect when we call redisplay. */
2510 jmpcount
= SPECPDL_INDEX ();
2511 if (_setjmp (local_getcjmp
))
2513 /* Handle quits while reading the keyboard. */
2514 /* We must have saved the outer value of getcjmp here,
2515 so restore it now. */
2516 restore_getcjmp (save_jump
);
2517 unbind_to (jmpcount
, Qnil
);
2518 XSETINT (c
, quit_char
);
2519 internal_last_event_frame
= selected_frame
;
2520 Vlast_event_frame
= internal_last_event_frame
;
2521 /* If we report the quit char as an event,
2522 don't do so more than once. */
2523 if (!NILP (Vinhibit_quit
))
2527 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2528 if (kb
!= current_kboard
)
2530 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2531 /* We shouldn't get here if we were in single-kboard mode! */
2536 while (CONSP (XCDR (last
)))
2538 if (!NILP (XCDR (last
)))
2542 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2544 XSETCDR (last
, Fcons (c
, Qnil
));
2545 kb
->kbd_queue_has_data
= 1;
2546 current_kboard
= kb
;
2547 /* This is going to exit from read_char
2548 so we had better get rid of this frame's stuff. */
2550 return make_number (-2); /* wrong_kboard_jmpbuf */
2556 /* Start idle timers if no time limit is supplied. We don't do it
2557 if a time limit is supplied to avoid an infinite recursion in the
2558 situation where an idle timer calls `sit-for'. */
2561 timer_start_idle ();
2563 /* If in middle of key sequence and minibuffer not active,
2564 start echoing if enough time elapses. */
2566 if (minibuf_level
== 0
2568 && !current_kboard
->immediate_echo
2569 && this_command_key_count
> 0
2571 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2572 && NILP (Fzerop (Vecho_keystrokes
))
2573 && (/* No message. */
2574 NILP (echo_area_buffer
[0])
2575 /* Or empty message. */
2576 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2577 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2578 /* Or already echoing from same kboard. */
2579 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2580 /* Or not echoing before and echoing allowed. */
2581 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2583 /* After a mouse event, start echoing right away.
2584 This is because we are probably about to display a menu,
2585 and we don't want to delay before doing so. */
2586 if (EVENT_HAS_PARAMETERS (prev_event
))
2592 save_getcjmp (save_jump
);
2593 restore_getcjmp (local_getcjmp
);
2594 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2595 restore_getcjmp (save_jump
);
2597 && ! CONSP (Vunread_command_events
))
2602 /* Maybe auto save due to number of keystrokes. */
2604 if (commandflag
!= 0
2605 && auto_save_interval
> 0
2606 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2607 && !detect_input_pending_run_timers (0))
2609 Fdo_auto_save (Qnil
, Qnil
);
2610 /* Hooks can actually change some buffers in auto save. */
2614 /* Try reading using an X menu.
2615 This is never confused with reading using the minibuf
2616 because the recursive call of read_char in read_char_minibuf_menu_prompt
2617 does not pass on any keymaps. */
2619 if (nmaps
> 0 && INTERACTIVE
2620 && !NILP (prev_event
)
2621 && EVENT_HAS_PARAMETERS (prev_event
)
2622 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2623 && !EQ (XCAR (prev_event
), Qtool_bar
)
2624 /* Don't bring up a menu if we already have another event. */
2625 && NILP (Vunread_command_events
)
2626 && unread_command_char
< 0)
2628 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2630 /* Now that we have read an event, Emacs is not idle. */
2637 /* Maybe autosave and/or garbage collect due to idleness. */
2639 if (INTERACTIVE
&& NILP (c
))
2642 EMACS_INT buffer_size
;
2644 /* Slow down auto saves logarithmically in size of current buffer,
2645 and garbage collect while we're at it. */
2646 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2647 last_non_minibuf_size
= Z
- BEG
;
2648 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2650 while (buffer_size
> 64)
2651 delay_level
++, buffer_size
-= buffer_size
>> 2;
2652 if (delay_level
< 4) delay_level
= 4;
2653 /* delay_level is 4 for files under around 50k, 7 at 100k,
2654 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2656 /* Auto save if enough time goes by without input. */
2657 if (commandflag
!= 0
2658 && num_nonmacro_input_events
> last_auto_save
2659 && INTEGERP (Vauto_save_timeout
)
2660 && XINT (Vauto_save_timeout
) > 0)
2663 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2665 save_getcjmp (save_jump
);
2666 restore_getcjmp (local_getcjmp
);
2667 tem0
= sit_for (make_number (timeout
), 1, 1);
2668 restore_getcjmp (save_jump
);
2671 && ! CONSP (Vunread_command_events
))
2673 Fdo_auto_save (Qnil
, Qnil
);
2675 /* If we have auto-saved and there is still no input
2676 available, garbage collect if there has been enough
2677 consing going on to make it worthwhile. */
2678 if (!detect_input_pending_run_timers (0)
2679 && consing_since_gc
> gc_cons_threshold
/ 2)
2680 Fgarbage_collect ();
2687 /* Notify the caller if an autosave hook, or a timer, sentinel or
2688 filter in the sit_for calls above have changed the current
2689 kboard. This could happen if they use the minibuffer or start a
2690 recursive edit, like the fancy splash screen in server.el's
2691 filter. If this longjmp wasn't here, read_key_sequence would
2692 interpret the next key sequence using the wrong translation
2693 tables and function keymaps. */
2694 if (NILP (c
) && current_kboard
!= orig_kboard
)
2697 return make_number (-2); /* wrong_kboard_jmpbuf */
2700 /* If this has become non-nil here, it has been set by a timer
2701 or sentinel or filter. */
2702 if (CONSP (Vunread_command_events
))
2704 c
= XCAR (Vunread_command_events
);
2705 Vunread_command_events
= XCDR (Vunread_command_events
);
2708 /* Read something from current KBOARD's side queue, if possible. */
2712 if (current_kboard
->kbd_queue_has_data
)
2714 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2716 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2717 KVAR (current_kboard
, kbd_queue
)
2718 = XCDR (KVAR (current_kboard
, kbd_queue
));
2719 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2720 current_kboard
->kbd_queue_has_data
= 0;
2721 input_pending
= readable_events (0);
2722 if (EVENT_HAS_PARAMETERS (c
)
2723 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2724 internal_last_event_frame
= XCAR (XCDR (c
));
2725 Vlast_event_frame
= internal_last_event_frame
;
2729 /* If current_kboard's side queue is empty check the other kboards.
2730 If one of them has data that we have not yet seen here,
2731 switch to it and process the data waiting for it.
2733 Note: if the events queued up for another kboard
2734 have already been seen here, and therefore are not a complete command,
2735 the kbd_queue_has_data field is 0, so we skip that kboard here.
2736 That's to avoid an infinite loop switching between kboards here. */
2737 if (NILP (c
) && !single_kboard
)
2740 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2741 if (kb
->kbd_queue_has_data
)
2743 current_kboard
= kb
;
2744 /* This is going to exit from read_char
2745 so we had better get rid of this frame's stuff. */
2747 return make_number (-2); /* wrong_kboard_jmpbuf */
2755 /* Finally, we read from the main queue,
2756 and if that gives us something we can't use yet, we put it on the
2757 appropriate side queue and try again. */
2761 KBOARD
*kb
IF_LINT (= NULL
);
2766 EMACS_GET_TIME (now
);
2767 if (EMACS_TIME_GE (now
, *end_time
))
2771 /* Actually read a character, waiting if necessary. */
2772 save_getcjmp (save_jump
);
2773 restore_getcjmp (local_getcjmp
);
2775 timer_start_idle ();
2776 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2777 restore_getcjmp (save_jump
);
2779 if (! NILP (c
) && (kb
!= current_kboard
))
2781 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2784 while (CONSP (XCDR (last
)))
2786 if (!NILP (XCDR (last
)))
2790 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2792 XSETCDR (last
, Fcons (c
, Qnil
));
2793 kb
->kbd_queue_has_data
= 1;
2797 current_kboard
= kb
;
2798 /* This is going to exit from read_char
2799 so we had better get rid of this frame's stuff. */
2801 return make_number (-2);
2805 /* Terminate Emacs in batch mode if at eof. */
2806 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2807 Fkill_emacs (make_number (1));
2811 /* Add in any extra modifiers, where appropriate. */
2812 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2813 || ((extra_keyboard_modifiers
& 0177) < ' '
2814 && (extra_keyboard_modifiers
& 0177) != 0))
2815 XSETINT (c
, make_ctrl_char (XINT (c
)));
2817 /* Transfer any other modifier bits directly from
2818 extra_keyboard_modifiers to c. Ignore the actual character code
2819 in the low 16 bits of extra_keyboard_modifiers. */
2820 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2831 if (commandflag
>= 0
2832 && !input_pending
&& !detect_input_pending_run_timers (0))
2840 /* Buffer switch events are only for internal wakeups
2841 so don't show them to the user.
2842 Also, don't record a key if we already did. */
2843 if (BUFFERP (c
) || key_already_recorded
)
2846 /* Process special events within read_char
2847 and loop around to read another event. */
2850 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2855 struct buffer
*prev_buffer
= current_buffer
;
2856 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2857 int was_locked
= single_kboard
;
2858 int count
= SPECPDL_INDEX ();
2859 record_single_kboard_state ();
2862 last_input_event
= c
;
2863 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2865 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2866 /* We stopped being idle for this event; undo that. This
2867 prevents automatic window selection (under
2868 mouse_autoselect_window from acting as a real input event, for
2869 example banishing the mouse under mouse-avoidance-mode. */
2870 timer_resume_idle ();
2872 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2873 /* Resume allowing input from any kboard, if that was true before. */
2875 any_kboard_state ();
2876 unbind_to (count
, Qnil
);
2879 if (current_buffer
!= prev_buffer
)
2881 /* The command may have changed the keymaps. Pretend there
2882 is input in another keyboard and return. This will
2883 recalculate keymaps. */
2884 c
= make_number (-2);
2891 /* Handle things that only apply to characters. */
2894 /* If kbd_buffer_get_event gave us an EOF, return that. */
2898 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2899 && SCHARS (KVAR (current_kboard
, Vkeyboard_translate_table
)) > (unsigned) XFASTINT (c
))
2900 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2901 && XVECTOR (KVAR (current_kboard
, Vkeyboard_translate_table
))->size
> (unsigned) XFASTINT (c
))
2902 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2906 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2907 /* nil in keyboard-translate-table means no translation. */
2913 /* If this event is a mouse click in the menu bar,
2914 return just menu-bar for now. Modify the mouse click event
2915 so we won't do this twice, then queue it up. */
2916 if (EVENT_HAS_PARAMETERS (c
)
2918 && CONSP (EVENT_START (c
))
2919 && CONSP (XCDR (EVENT_START (c
))))
2923 posn
= POSN_POSN (EVENT_START (c
));
2924 /* Handle menu-bar events:
2925 insert the dummy prefix event `menu-bar'. */
2926 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2928 /* Change menu-bar to (menu-bar) as the event "position". */
2929 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2932 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2937 /* Store these characters into recent_keys, the dribble file if any,
2938 and the keyboard macro being defined, if any. */
2940 if (! NILP (also_record
))
2941 record_char (also_record
);
2943 /* Wipe the echo area.
2944 But first, if we are about to use an input method,
2945 save the echo area contents for it to refer to. */
2947 && ! NILP (Vinput_method_function
)
2948 && (unsigned) XINT (c
) >= ' '
2949 && (unsigned) XINT (c
) != 127
2950 && (unsigned) XINT (c
) < 256)
2952 previous_echo_area_message
= Fcurrent_message ();
2953 Vinput_method_previous_message
= previous_echo_area_message
;
2956 /* Now wipe the echo area, except for help events which do their
2957 own stuff with the echo area. */
2959 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2960 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2962 if (!NILP (echo_area_buffer
[0]))
2963 safe_run_hooks (Qecho_area_clear_hook
);
2964 clear_message (1, 0);
2967 reread_for_input_method
:
2969 /* Pass this to the input method, if appropriate. */
2971 && ! NILP (Vinput_method_function
)
2972 /* Don't run the input method within a key sequence,
2973 after the first event of the key sequence. */
2974 && NILP (prev_event
)
2975 && (unsigned) XINT (c
) >= ' '
2976 && (unsigned) XINT (c
) != 127
2977 && (unsigned) XINT (c
) < 256)
2980 int key_count
, key_count_reset
;
2981 struct gcpro inner_gcpro1
;
2982 int count
= SPECPDL_INDEX ();
2984 /* Save the echo status. */
2985 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2986 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2987 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2988 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2991 if (before_command_restore_flag
)
2993 this_command_key_count
= before_command_key_count_1
;
2994 if (this_command_key_count
< this_single_command_key_start
)
2995 this_single_command_key_start
= this_command_key_count
;
2996 echo_truncate (before_command_echo_length_1
);
2997 before_command_restore_flag
= 0;
3001 /* Save the this_command_keys status. */
3002 key_count
= this_command_key_count
;
3003 key_count_reset
= this_command_key_count_reset
;
3006 keys
= Fcopy_sequence (this_command_keys
);
3009 GCPRO1_VAR (keys
, inner_gcpro
);
3011 /* Clear out this_command_keys. */
3012 this_command_key_count
= 0;
3013 this_command_key_count_reset
= 0;
3015 /* Now wipe the echo area. */
3016 if (!NILP (echo_area_buffer
[0]))
3017 safe_run_hooks (Qecho_area_clear_hook
);
3018 clear_message (1, 0);
3021 /* If we are not reading a key sequence,
3022 never use the echo area. */
3025 specbind (Qinput_method_use_echo_area
, Qt
);
3028 /* Call the input method. */
3029 tem
= call1 (Vinput_method_function
, c
);
3031 tem
= unbind_to (count
, tem
);
3033 /* Restore the saved echoing state
3034 and this_command_keys state. */
3035 this_command_key_count
= key_count
;
3036 this_command_key_count_reset
= key_count_reset
;
3038 this_command_keys
= keys
;
3041 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3042 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3043 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3044 if (saved_immediate_echo
)
3047 UNGCPRO_VAR (inner_gcpro
);
3049 /* The input method can return no events. */
3052 /* Bring back the previous message, if any. */
3053 if (! NILP (previous_echo_area_message
))
3054 message_with_string ("%s", previous_echo_area_message
, 0);
3057 /* It returned one event or more. */
3059 Vunread_post_input_method_events
3060 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3065 /* Display help if not echoing. */
3066 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3068 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3069 Lisp_Object help
, object
, position
, window
, htem
;
3071 htem
= Fcdr (XCDR (c
));
3074 window
= Fcar (htem
);
3076 object
= Fcar (htem
);
3078 position
= Fcar (htem
);
3080 show_help_echo (help
, window
, object
, position
);
3082 /* We stopped being idle for this event; undo that. */
3084 timer_resume_idle ();
3088 if ((! reread
|| this_command_key_count
== 0
3089 || this_command_key_count_reset
)
3093 /* Don't echo mouse motion events. */
3094 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3095 && NILP (Fzerop (Vecho_keystrokes
))
3096 && ! (EVENT_HAS_PARAMETERS (c
)
3097 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3100 if (! NILP (also_record
))
3101 echo_char (also_record
);
3102 /* Once we reread a character, echoing can happen
3103 the next time we pause to read a new one. */
3104 ok_to_echo_at_next_pause
= current_kboard
;
3107 /* Record this character as part of the current key. */
3108 add_command_key (c
);
3109 if (! NILP (also_record
))
3110 add_command_key (also_record
);
3113 last_input_event
= c
;
3116 /* Process the help character specially if enabled */
3117 if (!NILP (Vhelp_form
) && help_char_p (c
))
3119 int count
= SPECPDL_INDEX ();
3121 help_form_saved_window_configs
3122 = Fcons (Fcurrent_window_configuration (Qnil
),
3123 help_form_saved_window_configs
);
3124 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3125 call0 (Qhelp_form_show
);
3130 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3131 if (EVENT_HAS_PARAMETERS (c
)
3132 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3133 XSETCAR (help_form_saved_window_configs
, Qnil
);
3135 while (BUFFERP (c
));
3136 /* Remove the help from the frame */
3137 unbind_to (count
, Qnil
);
3140 if (EQ (c
, make_number (040)))
3144 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3145 while (BUFFERP (c
));
3154 /* Record a key that came from a mouse menu.
3155 Record it for echoing, for this-command-keys, and so on. */
3158 record_menu_key (Lisp_Object c
)
3160 /* Wipe the echo area. */
3161 clear_message (1, 0);
3166 before_command_key_count
= this_command_key_count
;
3167 before_command_echo_length
= echo_length ();
3170 /* Don't echo mouse motion events. */
3171 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3172 && NILP (Fzerop (Vecho_keystrokes
)))
3176 /* Once we reread a character, echoing can happen
3177 the next time we pause to read a new one. */
3178 ok_to_echo_at_next_pause
= 0;
3181 /* Record this character as part of the current key. */
3182 add_command_key (c
);
3184 /* Re-reading in the middle of a command */
3185 last_input_event
= c
;
3189 /* Return 1 if should recognize C as "the help character". */
3192 help_char_p (Lisp_Object c
)
3196 if (EQ (c
, Vhelp_char
))
3198 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3199 if (EQ (c
, XCAR (tail
)))
3204 /* Record the input event C in various ways. */
3207 record_char (Lisp_Object c
)
3211 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3213 /* To avoid filling recent_keys with help-echo and mouse-movement
3214 events, we filter out repeated help-echo events, only store the
3215 first and last in a series of mouse-movement events, and don't
3216 store repeated help-echo events which are only separated by
3217 mouse-movement events. */
3219 Lisp_Object ev1
, ev2
, ev3
;
3222 if ((ix1
= recent_keys_index
- 1) < 0)
3223 ix1
= NUM_RECENT_KEYS
- 1;
3224 ev1
= AREF (recent_keys
, ix1
);
3226 if ((ix2
= ix1
- 1) < 0)
3227 ix2
= NUM_RECENT_KEYS
- 1;
3228 ev2
= AREF (recent_keys
, ix2
);
3230 if ((ix3
= ix2
- 1) < 0)
3231 ix3
= NUM_RECENT_KEYS
- 1;
3232 ev3
= AREF (recent_keys
, ix3
);
3234 if (EQ (XCAR (c
), Qhelp_echo
))
3236 /* Don't record `help-echo' in recent_keys unless it shows some help
3237 message, and a different help than the previously recorded
3239 Lisp_Object help
, last_help
;
3241 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3242 if (!STRINGP (help
))
3244 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3245 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3247 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3248 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3249 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3251 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3252 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3253 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3254 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3257 else if (EQ (XCAR (c
), Qmouse_movement
))
3259 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3260 So additional mouse movement events replace the last element. */
3261 Lisp_Object last_window
, window
;
3263 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3264 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3265 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3266 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3267 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3269 ASET (recent_keys
, ix1
, c
);
3275 store_kbd_macro_char (c
);
3280 ASET (recent_keys
, recent_keys_index
, c
);
3281 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3282 recent_keys_index
= 0;
3284 else if (recorded
< 0)
3286 /* We need to remove one or two events from recent_keys.
3287 To do this, we simply put nil at those events and move the
3288 recent_keys_index backwards over those events. Usually,
3289 users will never see those nil events, as they will be
3290 overwritten by the command keys entered to see recent_keys
3293 while (recorded
++ < 0 && total_keys
> 0)
3295 if (total_keys
< NUM_RECENT_KEYS
)
3297 if (--recent_keys_index
< 0)
3298 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3299 ASET (recent_keys
, recent_keys_index
, Qnil
);
3303 num_nonmacro_input_events
++;
3305 /* Write c to the dribble file. If c is a lispy event, write
3306 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3307 If you, dear reader, have a better idea, you've got the source. :-) */
3313 if (XUINT (c
) < 0x100)
3314 putc (XINT (c
), dribble
);
3316 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3320 Lisp_Object dribblee
;
3322 /* If it's a structured event, take the event header. */
3323 dribblee
= EVENT_HEAD (c
);
3325 if (SYMBOLP (dribblee
))
3327 putc ('<', dribble
);
3328 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3329 SBYTES (SYMBOL_NAME (dribblee
)),
3331 putc ('>', dribble
);
3340 /* Copy out or in the info on where C-g should throw to.
3341 This is used when running Lisp code from within get_char,
3342 in case get_char is called recursively.
3343 See read_process_output. */
3346 save_getcjmp (jmp_buf temp
)
3348 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3352 restore_getcjmp (jmp_buf temp
)
3354 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3357 /* Low level keyboard/mouse input.
3358 kbd_buffer_store_event places events in kbd_buffer, and
3359 kbd_buffer_get_event retrieves them. */
3361 /* Return true if there are any events in the queue that read-char
3362 would return. If this returns false, a read-char would block. */
3364 readable_events (int flags
)
3366 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3369 /* If the buffer contains only FOCUS_IN_EVENT events, and
3370 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3371 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3373 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3374 #ifdef USE_TOOLKIT_SCROLL_BARS
3375 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3379 struct input_event
*event
;
3381 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3388 #ifdef USE_TOOLKIT_SCROLL_BARS
3389 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3391 event
->kind
== FOCUS_IN_EVENT
)
3392 #ifdef USE_TOOLKIT_SCROLL_BARS
3393 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3394 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3395 && event
->part
== scroll_bar_handle
3396 && event
->modifiers
== 0)
3401 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3404 while (event
!= kbd_store_ptr
);
3410 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3411 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3412 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3417 if (current_kboard
->kbd_queue_has_data
)
3423 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3424 if (kb
->kbd_queue_has_data
)
3430 /* Set this for debugging, to have a way to get out */
3431 int stop_character EXTERNALLY_VISIBLE
;
3434 event_to_kboard (struct input_event
*event
)
3437 frame
= event
->frame_or_window
;
3439 frame
= XCAR (frame
);
3440 else if (WINDOWP (frame
))
3441 frame
= WINDOW_FRAME (XWINDOW (frame
));
3443 /* There are still some events that don't set this field.
3444 For now, just ignore the problem.
3445 Also ignore dead frames here. */
3446 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3449 return FRAME_KBOARD (XFRAME (frame
));
3453 /* Return the number of slots occupied in kbd_buffer. */
3456 kbd_buffer_nr_stored (void)
3458 return kbd_fetch_ptr
== kbd_store_ptr
3460 : (kbd_fetch_ptr
< kbd_store_ptr
3461 ? kbd_store_ptr
- kbd_fetch_ptr
3462 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3463 + (kbd_store_ptr
- kbd_buffer
)));
3465 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3468 kbd_buffer_store_event (register struct input_event
*event
)
3470 kbd_buffer_store_event_hold (event
, 0);
3473 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3475 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3476 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3477 Else, if EVENT is a quit event, store the quit event
3478 in HOLD_QUIT, and return (thus ignoring further events).
3480 This is used in read_avail_input to postpone the processing
3481 of the quit event until all subsequent input events have been
3482 parsed (and discarded).
3486 kbd_buffer_store_event_hold (register struct input_event
*event
,
3487 struct input_event
*hold_quit
)
3489 if (event
->kind
== NO_EVENT
)
3492 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3495 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3497 register int c
= event
->code
& 0377;
3499 if (event
->modifiers
& ctrl_modifier
)
3500 c
= make_ctrl_char (c
);
3502 c
|= (event
->modifiers
3503 & (meta_modifier
| alt_modifier
3504 | hyper_modifier
| super_modifier
));
3508 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3509 struct input_event
*sp
;
3511 if (single_kboard
&& kb
!= current_kboard
)
3513 KVAR (kb
, kbd_queue
)
3514 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3515 Fcons (make_number (c
), Qnil
));
3516 kb
->kbd_queue_has_data
= 1;
3517 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3519 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3522 if (event_to_kboard (sp
) == kb
)
3524 sp
->kind
= NO_EVENT
;
3525 sp
->frame_or_window
= Qnil
;
3534 memcpy (hold_quit
, event
, sizeof (*event
));
3538 /* If this results in a quit_char being returned to Emacs as
3539 input, set Vlast_event_frame properly. If this doesn't
3540 get returned to Emacs as an event, the next event read
3541 will set Vlast_event_frame again, so this is safe to do. */
3545 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3547 focus
= event
->frame_or_window
;
3548 internal_last_event_frame
= focus
;
3549 Vlast_event_frame
= focus
;
3552 last_event_timestamp
= event
->timestamp
;
3553 handle_interrupt ();
3557 if (c
&& c
== stop_character
)
3563 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3564 Just ignore the second one. */
3565 else if (event
->kind
== BUFFER_SWITCH_EVENT
3566 && kbd_fetch_ptr
!= kbd_store_ptr
3567 && ((kbd_store_ptr
== kbd_buffer
3568 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3569 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3572 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3573 kbd_store_ptr
= kbd_buffer
;
3575 /* Don't let the very last slot in the buffer become full,
3576 since that would make the two pointers equal,
3577 and that is indistinguishable from an empty buffer.
3578 Discard the event if it would fill the last slot. */
3579 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3581 *kbd_store_ptr
= *event
;
3584 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3586 /* Don't read keyboard input until we have processed kbd_buffer.
3587 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3588 hold_keyboard_input ();
3590 if (!noninteractive
)
3591 signal (SIGIO
, SIG_IGN
);
3595 #endif /* subprocesses */
3598 /* If we're inside while-no-input, and this event qualifies
3599 as input, set quit-flag to cause an interrupt. */
3600 if (!NILP (Vthrow_on_input
)
3601 && event
->kind
!= FOCUS_IN_EVENT
3602 && event
->kind
!= HELP_EVENT
3603 && event
->kind
!= DEICONIFY_EVENT
)
3605 Vquit_flag
= Vthrow_on_input
;
3606 /* If we're inside a function that wants immediate quits,
3608 if (immediate_quit
&& NILP (Vinhibit_quit
))
3618 /* Put an input event back in the head of the event queue. */
3621 kbd_buffer_unget_event (register struct input_event
*event
)
3623 if (kbd_fetch_ptr
== kbd_buffer
)
3624 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3626 /* Don't let the very last slot in the buffer become full, */
3627 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3630 *kbd_fetch_ptr
= *event
;
3635 /* Generate a HELP_EVENT input_event and store it in the keyboard
3638 HELP is the help form.
3640 FRAME and WINDOW are the frame and window where the help is
3641 generated. OBJECT is the Lisp object where the help was found (a
3642 buffer, a string, an overlay, or nil if neither from a string nor
3643 from a buffer). POS is the position within OBJECT where the help
3647 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3648 Lisp_Object object
, EMACS_INT pos
)
3650 struct input_event event
;
3654 event
.kind
= HELP_EVENT
;
3655 event
.frame_or_window
= frame
;
3657 event
.x
= WINDOWP (window
) ? window
: frame
;
3660 kbd_buffer_store_event (&event
);
3664 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3667 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3669 struct input_event event
;
3671 event
.kind
= HELP_EVENT
;
3672 event
.frame_or_window
= frame
;
3677 kbd_buffer_store_event (&event
);
3681 /* Discard any mouse events in the event buffer by setting them to
3684 discard_mouse_events (void)
3686 struct input_event
*sp
;
3687 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3689 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3692 if (sp
->kind
== MOUSE_CLICK_EVENT
3693 || sp
->kind
== WHEEL_EVENT
3694 || sp
->kind
== HORIZ_WHEEL_EVENT
3696 || sp
->kind
== GPM_CLICK_EVENT
3698 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3700 sp
->kind
= NO_EVENT
;
3706 /* Return non-zero if there are any real events waiting in the event
3707 buffer, not counting `NO_EVENT's.
3709 If DISCARD is non-zero, discard NO_EVENT events at the front of
3710 the input queue, possibly leaving the input queue empty if there
3711 are no real input events. */
3714 kbd_buffer_events_waiting (int discard
)
3716 struct input_event
*sp
;
3718 for (sp
= kbd_fetch_ptr
;
3719 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3722 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3729 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3733 /* Clear input event EVENT. */
3736 clear_event (struct input_event
*event
)
3738 event
->kind
= NO_EVENT
;
3742 /* Read one event from the event buffer, waiting if necessary.
3743 The value is a Lisp object representing the event.
3744 The value is nil for an event that should be ignored,
3745 or that was handled here.
3746 We always read and discard one event. */
3749 kbd_buffer_get_event (KBOARD
**kbp
,
3750 int *used_mouse_menu
,
3751 struct timeval
*end_time
)
3757 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3759 /* Start reading input again, we have processed enough so we can
3760 accept new events again. */
3761 unhold_keyboard_input ();
3763 if (!noninteractive
)
3764 signal (SIGIO
, input_available_signal
);
3768 #endif /* subprocesses */
3771 /* In case we are running as a daemon, only do this before
3772 detaching from the terminal. */
3773 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3777 *kbp
= current_kboard
;
3781 /* Wait until there is input available. */
3784 /* Break loop if there's an unread command event. Needed in
3785 moused window autoselection which uses a timer to insert such
3787 if (CONSP (Vunread_command_events
))
3790 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3792 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3793 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3797 /* If the quit flag is set, then read_char will return
3798 quit_char, so that counts as "available input." */
3799 if (!NILP (Vquit_flag
))
3800 quit_throw_to_read_char ();
3802 /* One way or another, wait until input is available; then, if
3803 interrupt handlers have not read it, read it now. */
3805 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3809 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3811 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3812 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3817 EMACS_TIME duration
;
3818 EMACS_GET_TIME (duration
);
3819 if (EMACS_TIME_GE (duration
, *end_time
))
3820 return Qnil
; /* finished waiting */
3823 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3824 wait_reading_process_output (EMACS_SECS (duration
),
3825 EMACS_USECS (duration
),
3826 -1, 1, Qnil
, NULL
, 0);
3830 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3832 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3833 /* Pass 1 for EXPECT since we just waited to have input. */
3834 read_avail_input (1);
3837 if (CONSP (Vunread_command_events
))
3840 first
= XCAR (Vunread_command_events
);
3841 Vunread_command_events
= XCDR (Vunread_command_events
);
3842 *kbp
= current_kboard
;
3846 /* At this point, we know that there is a readable event available
3847 somewhere. If the event queue is empty, then there must be a
3848 mouse movement enabled and available. */
3849 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3851 struct input_event
*event
;
3853 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3857 last_event_timestamp
= event
->timestamp
;
3859 *kbp
= event_to_kboard (event
);
3861 *kbp
= current_kboard
; /* Better than returning null ptr? */
3865 /* These two kinds of events get special handling
3866 and don't actually appear to the command loop.
3867 We return nil for them. */
3868 if (event
->kind
== SELECTION_REQUEST_EVENT
3869 || event
->kind
== SELECTION_CLEAR_EVENT
)
3872 struct input_event copy
;
3874 /* Remove it from the buffer before processing it,
3875 since otherwise swallow_events will see it
3876 and process it again. */
3878 kbd_fetch_ptr
= event
+ 1;
3879 input_pending
= readable_events (0);
3880 x_handle_selection_event (©
);
3882 /* We're getting selection request events, but we don't have
3888 #if defined (HAVE_NS)
3889 else if (event
->kind
== NS_TEXT_EVENT
)
3891 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3892 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3894 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3895 kbd_fetch_ptr
= event
+ 1;
3896 if (used_mouse_menu
)
3897 *used_mouse_menu
= 1;
3901 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3902 || defined (HAVE_NS)
3903 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3905 /* Make an event (delete-frame (FRAME)). */
3906 obj
= Fcons (event
->frame_or_window
, Qnil
);
3907 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3908 kbd_fetch_ptr
= event
+ 1;
3911 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3912 || defined (HAVE_NS)
3913 else if (event
->kind
== ICONIFY_EVENT
)
3915 /* Make an event (iconify-frame (FRAME)). */
3916 obj
= Fcons (event
->frame_or_window
, Qnil
);
3917 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3918 kbd_fetch_ptr
= event
+ 1;
3920 else if (event
->kind
== DEICONIFY_EVENT
)
3922 /* Make an event (make-frame-visible (FRAME)). */
3923 obj
= Fcons (event
->frame_or_window
, Qnil
);
3924 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3925 kbd_fetch_ptr
= event
+ 1;
3928 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3930 /* The value doesn't matter here; only the type is tested. */
3931 XSETBUFFER (obj
, current_buffer
);
3932 kbd_fetch_ptr
= event
+ 1;
3934 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3935 || defined(HAVE_NS) || defined (USE_GTK)
3936 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3938 kbd_fetch_ptr
= event
+ 1;
3939 input_pending
= readable_events (0);
3940 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3941 x_activate_menubar (XFRAME (event
->frame_or_window
));
3944 #if defined (WINDOWSNT)
3945 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3947 /* Make an event (language-change (FRAME CHARSET LCID)). */
3948 obj
= Fcons (event
->frame_or_window
, Qnil
);
3949 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3950 kbd_fetch_ptr
= event
+ 1;
3953 else if (event
->kind
== SAVE_SESSION_EVENT
)
3955 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3956 kbd_fetch_ptr
= event
+ 1;
3958 /* Just discard these, by returning nil.
3959 With MULTI_KBOARD, these events are used as placeholders
3960 when we need to randomly delete events from the queue.
3961 (They shouldn't otherwise be found in the buffer,
3962 but on some machines it appears they do show up
3963 even without MULTI_KBOARD.) */
3964 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3965 mouse events during a popup-menu call. */
3966 else if (event
->kind
== NO_EVENT
)
3967 kbd_fetch_ptr
= event
+ 1;
3968 else if (event
->kind
== HELP_EVENT
)
3970 Lisp_Object object
, position
, help
, frame
, window
;
3972 frame
= event
->frame_or_window
;
3973 object
= event
->arg
;
3974 position
= make_number (event
->code
);
3977 clear_event (event
);
3979 kbd_fetch_ptr
= event
+ 1;
3980 if (!WINDOWP (window
))
3982 obj
= Fcons (Qhelp_echo
,
3983 list5 (frame
, help
, window
, object
, position
));
3985 else if (event
->kind
== FOCUS_IN_EVENT
)
3987 /* Notification of a FocusIn event. The frame receiving the
3988 focus is in event->frame_or_window. Generate a
3989 switch-frame event if necessary. */
3990 Lisp_Object frame
, focus
;
3992 frame
= event
->frame_or_window
;
3993 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3997 if (!EQ (frame
, internal_last_event_frame
)
3998 && !EQ (frame
, selected_frame
))
3999 obj
= make_lispy_switch_frame (frame
);
4000 internal_last_event_frame
= frame
;
4001 kbd_fetch_ptr
= event
+ 1;
4004 else if (event
->kind
== DBUS_EVENT
)
4006 obj
= make_lispy_event (event
);
4007 kbd_fetch_ptr
= event
+ 1;
4010 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4012 obj
= make_lispy_event (event
);
4013 kbd_fetch_ptr
= event
+ 1;
4017 /* If this event is on a different frame, return a switch-frame this
4018 time, and leave the event in the queue for next time. */
4022 frame
= event
->frame_or_window
;
4024 frame
= XCAR (frame
);
4025 else if (WINDOWP (frame
))
4026 frame
= WINDOW_FRAME (XWINDOW (frame
));
4028 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4032 if (! EQ (frame
, internal_last_event_frame
)
4033 && !EQ (frame
, selected_frame
))
4034 obj
= make_lispy_switch_frame (frame
);
4035 internal_last_event_frame
= frame
;
4037 /* If we didn't decide to make a switch-frame event, go ahead
4038 and build a real event from the queue entry. */
4042 obj
= make_lispy_event (event
);
4044 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4045 || defined(HAVE_NS) || defined (USE_GTK)
4046 /* If this was a menu selection, then set the flag to inhibit
4047 writing to last_nonmenu_event. Don't do this if the event
4048 we're returning is (menu-bar), though; that indicates the
4049 beginning of the menu sequence, and we might as well leave
4050 that as the `event with parameters' for this selection. */
4052 && !EQ (event
->frame_or_window
, event
->arg
)
4053 && (event
->kind
== MENU_BAR_EVENT
4054 || event
->kind
== TOOL_BAR_EVENT
))
4055 *used_mouse_menu
= 1;
4058 /* certain system events are non-key events */
4060 && event
->kind
== NS_NONKEY_EVENT
)
4061 *used_mouse_menu
= 1;
4064 /* Wipe out this event, to catch bugs. */
4065 clear_event (event
);
4066 kbd_fetch_ptr
= event
+ 1;
4070 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4071 /* Try generating a mouse motion event. */
4072 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4074 FRAME_PTR f
= some_mouse_moved ();
4075 Lisp_Object bar_window
;
4076 enum scroll_bar_part part
;
4080 *kbp
= current_kboard
;
4081 /* Note that this uses F to determine which terminal to look at.
4082 If there is no valid info, it does not store anything
4083 so x remains nil. */
4086 /* XXX Can f or mouse_position_hook be NULL here? */
4087 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4088 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4093 /* Decide if we should generate a switch-frame event. Don't
4094 generate switch-frame events for motion outside of all Emacs
4100 frame
= FRAME_FOCUS_FRAME (f
);
4102 XSETFRAME (frame
, f
);
4104 if (! EQ (frame
, internal_last_event_frame
)
4105 && !EQ (frame
, selected_frame
))
4106 obj
= make_lispy_switch_frame (frame
);
4107 internal_last_event_frame
= frame
;
4110 /* If we didn't decide to make a switch-frame event, go ahead and
4111 return a mouse-motion event. */
4112 if (!NILP (x
) && NILP (obj
))
4113 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4115 #endif /* HAVE_MOUSE || HAVE GPM */
4117 /* We were promised by the above while loop that there was
4118 something for us to read! */
4121 input_pending
= readable_events (0);
4123 Vlast_event_frame
= internal_last_event_frame
;
4128 /* Process any events that are not user-visible,
4129 then return, without reading any user-visible events. */
4132 swallow_events (int do_display
)
4136 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4138 struct input_event
*event
;
4140 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4144 last_event_timestamp
= event
->timestamp
;
4146 /* These two kinds of events get special handling
4147 and don't actually appear to the command loop. */
4148 if (event
->kind
== SELECTION_REQUEST_EVENT
4149 || event
->kind
== SELECTION_CLEAR_EVENT
)
4152 struct input_event copy
;
4154 /* Remove it from the buffer before processing it,
4155 since otherwise swallow_events called recursively could see it
4156 and process it again. */
4158 kbd_fetch_ptr
= event
+ 1;
4159 input_pending
= readable_events (0);
4160 x_handle_selection_event (©
);
4162 /* We're getting selection request events, but we don't have
4171 old_timers_run
= timers_run
;
4172 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4174 if (timers_run
!= old_timers_run
&& do_display
)
4175 redisplay_preserve_echo_area (7);
4178 /* Record the start of when Emacs is idle,
4179 for the sake of running idle-time timers. */
4182 timer_start_idle (void)
4186 /* If we are already in the idle state, do nothing. */
4187 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4190 EMACS_GET_TIME (timer_idleness_start_time
);
4192 timer_last_idleness_start_time
= timer_idleness_start_time
;
4194 /* Mark all idle-time timers as once again candidates for running. */
4195 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4199 timer
= XCAR (timers
);
4201 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4203 XVECTOR (timer
)->contents
[0] = Qnil
;
4207 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4210 timer_stop_idle (void)
4212 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4215 /* Resume idle timer from last idle start time. */
4218 timer_resume_idle (void)
4220 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4223 timer_idleness_start_time
= timer_last_idleness_start_time
;
4226 /* This is only for debugging. */
4227 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4229 /* List of elisp functions to call, delayed because they were generated in
4230 a context where Elisp could not be safely run (e.g. redisplay, signal,
4231 ...). Each element has the form (FUN . ARGS). */
4232 Lisp_Object pending_funcalls
;
4234 /* Check whether a timer has fired. To prevent larger problems we simply
4235 disregard elements that are not proper timers. Do not make a circular
4236 timer list for the time being.
4238 Returns the time to wait until the next timer fires. If a
4239 timer is triggering now, return zero.
4240 If no timer is active, return -1.
4242 If a timer is ripe, we run it, with quitting turned off.
4243 In that case we return 0 to indicate that a new timer_check_2 call
4247 timer_check_2 (void)
4249 EMACS_TIME nexttime
;
4251 EMACS_TIME idleness_now
IF_LINT (= {0});
4252 Lisp_Object timers
, idle_timers
, chosen_timer
;
4253 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4255 EMACS_SET_SECS (nexttime
, -1);
4256 EMACS_SET_USECS (nexttime
, -1);
4258 /* Always consider the ordinary timers. */
4259 timers
= Vtimer_list
;
4260 /* Consider the idle timers only if Emacs is idle. */
4261 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4262 idle_timers
= Vtimer_idle_list
;
4265 chosen_timer
= Qnil
;
4266 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4268 /* First run the code that was delayed. */
4269 while (CONSP (pending_funcalls
))
4271 Lisp_Object funcall
= XCAR (pending_funcalls
);
4272 pending_funcalls
= XCDR (pending_funcalls
);
4273 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4276 if (CONSP (timers
) || CONSP (idle_timers
))
4278 EMACS_GET_TIME (now
);
4279 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4280 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4283 while (CONSP (timers
) || CONSP (idle_timers
))
4285 Lisp_Object
*vector
;
4286 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4287 EMACS_TIME timer_time
, idle_timer_time
;
4288 EMACS_TIME difference
;
4289 EMACS_TIME timer_difference
IF_LINT (= {0});
4290 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4292 /* Skip past invalid timers and timers already handled. */
4295 timer
= XCAR (timers
);
4296 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4298 timers
= XCDR (timers
);
4301 vector
= XVECTOR (timer
)->contents
;
4303 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4304 || !INTEGERP (vector
[3])
4305 || ! NILP (vector
[0]))
4307 timers
= XCDR (timers
);
4311 if (CONSP (idle_timers
))
4313 timer
= XCAR (idle_timers
);
4314 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4316 idle_timers
= XCDR (idle_timers
);
4319 vector
= XVECTOR (timer
)->contents
;
4321 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4322 || !INTEGERP (vector
[3])
4323 || ! NILP (vector
[0]))
4325 idle_timers
= XCDR (idle_timers
);
4330 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4331 based on the next ordinary timer.
4332 TIMER_DIFFERENCE is the distance in time from NOW to when
4333 this timer becomes ripe (negative if it's already ripe). */
4336 timer
= XCAR (timers
);
4337 vector
= XVECTOR (timer
)->contents
;
4338 EMACS_SET_SECS (timer_time
,
4339 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4340 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4341 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4344 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4345 based on the next idle timer. */
4346 if (CONSP (idle_timers
))
4348 idle_timer
= XCAR (idle_timers
);
4349 vector
= XVECTOR (idle_timer
)->contents
;
4350 EMACS_SET_SECS (idle_timer_time
,
4351 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4352 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4353 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4356 /* Decide which timer is the next timer,
4357 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4358 Also step down the list where we found that timer. */
4360 if (CONSP (timers
) && CONSP (idle_timers
))
4363 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4364 if (EMACS_TIME_NEG_P (temp
))
4366 chosen_timer
= timer
;
4367 timers
= XCDR (timers
);
4368 difference
= timer_difference
;
4372 chosen_timer
= idle_timer
;
4373 idle_timers
= XCDR (idle_timers
);
4374 difference
= idle_timer_difference
;
4377 else if (CONSP (timers
))
4379 chosen_timer
= timer
;
4380 timers
= XCDR (timers
);
4381 difference
= timer_difference
;
4385 chosen_timer
= idle_timer
;
4386 idle_timers
= XCDR (idle_timers
);
4387 difference
= idle_timer_difference
;
4389 vector
= XVECTOR (chosen_timer
)->contents
;
4391 /* If timer is ripe, run it if it hasn't been run. */
4392 if (EMACS_TIME_NEG_P (difference
)
4393 || (EMACS_SECS (difference
) == 0
4394 && EMACS_USECS (difference
) == 0))
4396 if (NILP (vector
[0]))
4398 int count
= SPECPDL_INDEX ();
4399 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4401 /* Mark the timer as triggered to prevent problems if the lisp
4402 code fails to reschedule it right. */
4405 specbind (Qinhibit_quit
, Qt
);
4407 call1 (Qtimer_event_handler
, chosen_timer
);
4408 Vdeactivate_mark
= old_deactivate_mark
;
4410 unbind_to (count
, Qnil
);
4412 /* Since we have handled the event,
4413 we don't need to tell the caller to wake up and do it. */
4414 /* But the caller must still wait for the next timer, so
4415 return 0 to indicate that. */
4418 EMACS_SET_SECS (nexttime
, 0);
4419 EMACS_SET_USECS (nexttime
, 0);
4422 /* When we encounter a timer that is still waiting,
4423 return the amount of time to wait before it is ripe. */
4430 /* No timers are pending in the future. */
4431 /* Return 0 if we generated an event, and -1 if not. */
4437 /* Check whether a timer has fired. To prevent larger problems we simply
4438 disregard elements that are not proper timers. Do not make a circular
4439 timer list for the time being.
4441 Returns the time to wait until the next timer fires.
4442 If no timer is active, return -1.
4444 As long as any timer is ripe, we run it. */
4449 EMACS_TIME nexttime
;
4453 nexttime
= timer_check_2 ();
4455 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4460 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4461 doc
: /* Return the current length of Emacs idleness, or nil.
4462 The value when Emacs is idle is a list of three integers. The first has
4463 the most significant 16 bits of the seconds, while the second has the least
4464 significant 16 bits. The third integer gives the microsecond count.
4466 The value when Emacs is not idle is nil.
4468 The microsecond count is zero on systems that do not provide
4469 resolution finer than a second. */)
4472 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4474 EMACS_TIME now
, idleness_now
;
4476 EMACS_GET_TIME (now
);
4477 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4479 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4480 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4481 make_number (EMACS_USECS (idleness_now
)));
4487 /* Caches for modify_event_symbol. */
4488 static Lisp_Object accent_key_syms
;
4489 static Lisp_Object func_key_syms
;
4490 static Lisp_Object mouse_syms
;
4491 static Lisp_Object wheel_syms
;
4492 static Lisp_Object drag_n_drop_syms
;
4494 /* This is a list of keysym codes for special "accent" characters.
4495 It parallels lispy_accent_keys. */
4497 static const int lispy_accent_codes
[] =
4499 #ifdef XK_dead_circumflex
4504 #ifdef XK_dead_grave
4509 #ifdef XK_dead_tilde
4514 #ifdef XK_dead_diaeresis
4519 #ifdef XK_dead_macron
4524 #ifdef XK_dead_degree
4529 #ifdef XK_dead_acute
4534 #ifdef XK_dead_cedilla
4539 #ifdef XK_dead_breve
4544 #ifdef XK_dead_ogonek
4549 #ifdef XK_dead_caron
4554 #ifdef XK_dead_doubleacute
4555 XK_dead_doubleacute
,
4559 #ifdef XK_dead_abovedot
4564 #ifdef XK_dead_abovering
4574 #ifdef XK_dead_belowdot
4579 #ifdef XK_dead_voiced_sound
4580 XK_dead_voiced_sound
,
4584 #ifdef XK_dead_semivoiced_sound
4585 XK_dead_semivoiced_sound
,
4601 /* This is a list of Lisp names for special "accent" characters.
4602 It parallels lispy_accent_codes. */
4604 static const char *const lispy_accent_keys
[] =
4622 "dead-voiced-sound",
4623 "dead-semivoiced-sound",
4629 #define FUNCTION_KEY_OFFSET 0x0
4631 const char *const lispy_function_keys
[] =
4635 0, /* VK_LBUTTON 0x01 */
4636 0, /* VK_RBUTTON 0x02 */
4637 "cancel", /* VK_CANCEL 0x03 */
4638 0, /* VK_MBUTTON 0x04 */
4640 0, 0, 0, /* 0x05 .. 0x07 */
4642 "backspace", /* VK_BACK 0x08 */
4643 "tab", /* VK_TAB 0x09 */
4645 0, 0, /* 0x0A .. 0x0B */
4647 "clear", /* VK_CLEAR 0x0C */
4648 "return", /* VK_RETURN 0x0D */
4650 0, 0, /* 0x0E .. 0x0F */
4652 0, /* VK_SHIFT 0x10 */
4653 0, /* VK_CONTROL 0x11 */
4654 0, /* VK_MENU 0x12 */
4655 "pause", /* VK_PAUSE 0x13 */
4656 "capslock", /* VK_CAPITAL 0x14 */
4657 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4659 "junja", /* VK_JUNJA 0x17 */
4660 "final", /* VK_FINAL 0x18 */
4661 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4663 "escape", /* VK_ESCAPE 0x1B */
4664 "convert", /* VK_CONVERT 0x1C */
4665 "non-convert", /* VK_NONCONVERT 0x1D */
4666 "accept", /* VK_ACCEPT 0x1E */
4667 "mode-change", /* VK_MODECHANGE 0x1F */
4668 0, /* VK_SPACE 0x20 */
4669 "prior", /* VK_PRIOR 0x21 */
4670 "next", /* VK_NEXT 0x22 */
4671 "end", /* VK_END 0x23 */
4672 "home", /* VK_HOME 0x24 */
4673 "left", /* VK_LEFT 0x25 */
4674 "up", /* VK_UP 0x26 */
4675 "right", /* VK_RIGHT 0x27 */
4676 "down", /* VK_DOWN 0x28 */
4677 "select", /* VK_SELECT 0x29 */
4678 "print", /* VK_PRINT 0x2A */
4679 "execute", /* VK_EXECUTE 0x2B */
4680 "snapshot", /* VK_SNAPSHOT 0x2C */
4681 "insert", /* VK_INSERT 0x2D */
4682 "delete", /* VK_DELETE 0x2E */
4683 "help", /* VK_HELP 0x2F */
4685 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4687 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4689 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4691 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4693 0, 0, 0, 0, 0, 0, 0, 0, 0,
4694 0, 0, 0, 0, 0, 0, 0, 0, 0,
4695 0, 0, 0, 0, 0, 0, 0, 0,
4697 "lwindow", /* VK_LWIN 0x5B */
4698 "rwindow", /* VK_RWIN 0x5C */
4699 "apps", /* VK_APPS 0x5D */
4702 "kp-0", /* VK_NUMPAD0 0x60 */
4703 "kp-1", /* VK_NUMPAD1 0x61 */
4704 "kp-2", /* VK_NUMPAD2 0x62 */
4705 "kp-3", /* VK_NUMPAD3 0x63 */
4706 "kp-4", /* VK_NUMPAD4 0x64 */
4707 "kp-5", /* VK_NUMPAD5 0x65 */
4708 "kp-6", /* VK_NUMPAD6 0x66 */
4709 "kp-7", /* VK_NUMPAD7 0x67 */
4710 "kp-8", /* VK_NUMPAD8 0x68 */
4711 "kp-9", /* VK_NUMPAD9 0x69 */
4712 "kp-multiply", /* VK_MULTIPLY 0x6A */
4713 "kp-add", /* VK_ADD 0x6B */
4714 "kp-separator", /* VK_SEPARATOR 0x6C */
4715 "kp-subtract", /* VK_SUBTRACT 0x6D */
4716 "kp-decimal", /* VK_DECIMAL 0x6E */
4717 "kp-divide", /* VK_DIVIDE 0x6F */
4718 "f1", /* VK_F1 0x70 */
4719 "f2", /* VK_F2 0x71 */
4720 "f3", /* VK_F3 0x72 */
4721 "f4", /* VK_F4 0x73 */
4722 "f5", /* VK_F5 0x74 */
4723 "f6", /* VK_F6 0x75 */
4724 "f7", /* VK_F7 0x76 */
4725 "f8", /* VK_F8 0x77 */
4726 "f9", /* VK_F9 0x78 */
4727 "f10", /* VK_F10 0x79 */
4728 "f11", /* VK_F11 0x7A */
4729 "f12", /* VK_F12 0x7B */
4730 "f13", /* VK_F13 0x7C */
4731 "f14", /* VK_F14 0x7D */
4732 "f15", /* VK_F15 0x7E */
4733 "f16", /* VK_F16 0x7F */
4734 "f17", /* VK_F17 0x80 */
4735 "f18", /* VK_F18 0x81 */
4736 "f19", /* VK_F19 0x82 */
4737 "f20", /* VK_F20 0x83 */
4738 "f21", /* VK_F21 0x84 */
4739 "f22", /* VK_F22 0x85 */
4740 "f23", /* VK_F23 0x86 */
4741 "f24", /* VK_F24 0x87 */
4743 0, 0, 0, 0, /* 0x88 .. 0x8B */
4744 0, 0, 0, 0, /* 0x8C .. 0x8F */
4746 "kp-numlock", /* VK_NUMLOCK 0x90 */
4747 "scroll", /* VK_SCROLL 0x91 */
4748 /* Not sure where the following block comes from.
4749 Windows headers have NEC and Fujitsu specific keys in
4750 this block, but nothing generic. */
4751 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4752 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4753 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4754 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4755 "kp-end", /* VK_NUMPAD_END 0x96 */
4756 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4757 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4758 "kp-up", /* VK_NUMPAD_UP 0x99 */
4759 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4760 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4761 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4762 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4764 0, 0, /* 0x9E .. 0x9F */
4767 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4768 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4769 * No other API or message will distinguish left and right keys this way.
4774 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4775 to enable them selectively, and gives access to a few more functions.
4776 See lispy_multimedia_keys below. */
4777 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4778 0, 0, 0, /* 0xAD .. 0xAF Volume */
4779 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4780 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4782 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4783 0, 0, 0, 0, 0, 0, 0, 0, 0,
4785 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4786 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4787 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4790 "ax", /* VK_OEM_AX 0xE1 */
4791 0, /* VK_OEM_102 0xE2 */
4792 "ico-help", /* VK_ICO_HELP 0xE3 */
4793 "ico-00", /* VK_ICO_00 0xE4 */
4794 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4795 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4796 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4798 "reset", /* VK_OEM_RESET 0xE9 */
4799 "jump", /* VK_OEM_JUMP 0xEA */
4800 "oem-pa1", /* VK_OEM_PA1 0xEB */
4801 "oem-pa2", /* VK_OEM_PA2 0xEC */
4802 "oem-pa3", /* VK_OEM_PA3 0xED */
4803 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4804 "cusel", /* VK_OEM_CUSEL 0xEF */
4805 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4806 "finish", /* VK_OEM_FINISH 0xF1 */
4807 "copy", /* VK_OEM_COPY 0xF2 */
4808 "auto", /* VK_OEM_AUTO 0xF3 */
4809 "enlw", /* VK_OEM_ENLW 0xF4 */
4810 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4811 "attn", /* VK_ATTN 0xF6 */
4812 "crsel", /* VK_CRSEL 0xF7 */
4813 "exsel", /* VK_EXSEL 0xF8 */
4814 "ereof", /* VK_EREOF 0xF9 */
4815 "play", /* VK_PLAY 0xFA */
4816 "zoom", /* VK_ZOOM 0xFB */
4817 "noname", /* VK_NONAME 0xFC */
4818 "pa1", /* VK_PA1 0xFD */
4819 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4823 /* Some of these duplicate the "Media keys" on newer keyboards,
4824 but they are delivered to the application in a different way. */
4825 static const char *const lispy_multimedia_keys
[] =
4833 "browser-favorites",
4870 "toggle-dictate-command",
4876 "media-fast-forward",
4879 "media-channel-down"
4882 #else /* not HAVE_NTGUI */
4884 /* This should be dealt with in XTread_socket now, and that doesn't
4885 depend on the client system having the Kana syms defined. See also
4886 the XK_kana_A case below. */
4889 static const char *const lispy_kana_keys
[] =
4891 /* X Keysym value */
4892 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4893 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4894 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4895 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4896 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4897 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4898 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4899 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4900 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4901 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4902 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4903 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4904 "kana-i", "kana-u", "kana-e", "kana-o",
4905 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4906 "prolongedsound", "kana-A", "kana-I", "kana-U",
4907 "kana-E", "kana-O", "kana-KA", "kana-KI",
4908 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4909 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4910 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4911 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4912 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4913 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4914 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4915 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4916 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4917 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4918 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4919 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4921 #endif /* XK_kana_A */
4924 #define FUNCTION_KEY_OFFSET 0xff00
4926 /* You'll notice that this table is arranged to be conveniently
4927 indexed by X Windows keysym values. */
4928 static const char *const lispy_function_keys
[] =
4930 /* X Keysym value */
4932 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4933 "backspace", "tab", "linefeed", "clear",
4935 0, 0, 0, "pause", /* 0xff10...1f */
4936 0, 0, 0, 0, 0, 0, 0, "escape",
4938 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4939 "romaji", "hiragana", "katakana", "hiragana-katakana",
4940 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4941 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4942 "eisu-toggle", /* 0xff30...3f */
4943 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4944 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4946 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4947 "down", "prior", "next", "end",
4948 "begin", 0, 0, 0, 0, 0, 0, 0,
4949 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4960 "break", /* 0xff6b */
4963 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4964 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4965 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4966 0, 0, 0, 0, 0, 0, 0, 0,
4967 "kp-tab", /* 0xff89 */
4969 "kp-enter", /* 0xff8d */
4971 "kp-f1", /* 0xff91 */
4975 "kp-home", /* 0xff95 */
4980 "kp-prior", /* kp-page-up */
4981 "kp-next", /* kp-page-down */
4987 0, 0, 0, 0, 0, 0, 0, 0, 0,
4988 "kp-multiply", /* 0xffaa */
4993 "kp-divide", /* 0xffaf */
4994 "kp-0", /* 0xffb0 */
4995 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4998 "kp-equal", /* 0xffbd */
4999 "f1", /* 0xffbe */ /* IsFunctionKey */
5001 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5002 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5003 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5004 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5005 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5006 0, 0, 0, 0, 0, 0, 0, 0,
5007 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5008 0, 0, 0, 0, 0, 0, 0, "delete"
5011 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5012 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5014 static const char *const iso_lispy_function_keys
[] =
5016 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5017 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5018 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5019 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5020 "iso-lefttab", /* 0xfe20 */
5021 "iso-move-line-up", "iso-move-line-down",
5022 "iso-partial-line-up", "iso-partial-line-down",
5023 "iso-partial-space-left", "iso-partial-space-right",
5024 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5025 "iso-release-margin-left", "iso-release-margin-right",
5026 "iso-release-both-margins",
5027 "iso-fast-cursor-left", "iso-fast-cursor-right",
5028 "iso-fast-cursor-up", "iso-fast-cursor-down",
5029 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5030 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5033 #endif /* not HAVE_NTGUI */
5035 static Lisp_Object Vlispy_mouse_stem
;
5037 static const char *const lispy_wheel_names
[] =
5039 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5042 /* drag-n-drop events are generated when a set of selected files are
5043 dragged from another application and dropped onto an Emacs window. */
5044 static const char *const lispy_drag_n_drop_names
[] =
5049 /* Scroll bar parts. */
5050 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5051 Lisp_Object Qup
, Qdown
, Qbottom
;
5052 static Lisp_Object Qend_scroll
;
5054 static Lisp_Object Qratio
;
5056 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5057 static Lisp_Object
*const scroll_bar_parts
[] = {
5058 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5059 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5062 /* A vector, indexed by button number, giving the down-going location
5063 of currently depressed buttons, both scroll bar and non-scroll bar.
5065 The elements have the form
5066 (BUTTON-NUMBER MODIFIER-MASK . REST)
5067 where REST is the cdr of a position as it would be reported in the event.
5069 The make_lispy_event function stores positions here to tell the
5070 difference between click and drag events, and to store the starting
5071 location to be included in drag events. */
5073 static Lisp_Object button_down_location
;
5075 /* Information about the most recent up-going button event: Which
5076 button, what location, and what time. */
5078 static int last_mouse_button
;
5079 static int last_mouse_x
;
5080 static int last_mouse_y
;
5081 static unsigned long button_down_time
;
5083 /* The number of clicks in this multiple-click. */
5085 static int double_click_count
;
5087 /* X and Y are frame-relative coordinates for a click or wheel event.
5088 Return a Lisp-style event list. */
5091 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5094 enum window_part part
;
5095 Lisp_Object posn
= Qnil
;
5096 Lisp_Object extra_info
= Qnil
;
5097 /* Coordinate pixel positions to return. */
5098 int xret
= 0, yret
= 0;
5099 /* The window under frame pixel coordinates (x,y) */
5100 Lisp_Object window
= f
5101 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5104 if (WINDOWP (window
))
5106 /* It's a click in window window at frame coordinates (x,y) */
5107 struct window
*w
= XWINDOW (window
);
5108 Lisp_Object string_info
= Qnil
;
5109 EMACS_INT textpos
= -1;
5110 int col
= -1, row
= -1;
5111 int dx
= -1, dy
= -1;
5112 int width
= -1, height
= -1;
5113 Lisp_Object object
= Qnil
;
5115 /* Pixel coordinates relative to the window corner. */
5116 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5117 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5119 /* For text area clicks, return X, Y relative to the corner of
5120 this text area. Note that dX, dY etc are set below, by
5121 buffer_posn_from_coords. */
5122 if (part
== ON_TEXT
)
5124 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5125 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5127 /* For mode line and header line clicks, return X, Y relative to
5128 the left window edge. Use mode_line_string to look for a
5129 string on the click position. */
5130 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5135 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5136 /* Note that mode_line_string takes COL, ROW as pixels and
5137 converts them to characters. */
5140 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5141 &object
, &dx
, &dy
, &width
, &height
);
5142 if (STRINGP (string
))
5143 string_info
= Fcons (string
, make_number (charpos
));
5144 textpos
= (w
== XWINDOW (selected_window
)
5145 && current_buffer
== XBUFFER (w
->buffer
))
5146 ? PT
: XMARKER (w
->pointm
)->charpos
;
5151 /* For fringes and margins, Y is relative to the area's (and the
5152 window's) top edge, while X is meaningless. */
5153 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5158 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5161 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5162 &object
, &dx
, &dy
, &width
, &height
);
5163 if (STRINGP (string
))
5164 string_info
= Fcons (string
, make_number (charpos
));
5165 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5167 else if (part
== ON_LEFT_FRINGE
)
5169 posn
= Qleft_fringe
;
5172 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5173 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5174 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5176 else if (part
== ON_RIGHT_FRINGE
)
5178 posn
= Qright_fringe
;
5181 - window_box_width (w
, LEFT_MARGIN_AREA
)
5182 - window_box_width (w
, TEXT_AREA
)
5183 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5184 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5186 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5188 else if (part
== ON_VERTICAL_BORDER
)
5190 posn
= Qvertical_line
;
5195 /* Nothing special for part == ON_SCROLL_BAR. */
5197 /* For clicks in the text area, fringes, or margins, call
5198 buffer_posn_from_coords to extract TEXTPOS, the buffer
5199 position nearest to the click. */
5202 Lisp_Object string2
, object2
= Qnil
;
5203 struct display_pos p
;
5205 int width2
, height2
;
5206 /* The pixel X coordinate passed to buffer_posn_from_coords
5207 is the X coordinate relative to the text area for
5208 text-area and right-margin clicks, zero otherwise. */
5210 = (part
== ON_TEXT
) ? xret
5211 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5212 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5216 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5217 &object2
, &dx2
, &dy2
,
5219 textpos
= CHARPOS (p
.pos
);
5220 if (col
< 0) col
= x2
;
5221 if (row
< 0) row
= y2
;
5222 if (dx
< 0) dx
= dx2
;
5223 if (dy
< 0) dy
= dy2
;
5224 if (width
< 0) width
= width2
;
5225 if (height
< 0) height
= height2
;
5229 posn
= make_number (textpos
);
5230 if (STRINGP (string2
))
5231 string_info
= Fcons (string2
,
5232 make_number (CHARPOS (p
.string_pos
)));
5238 #ifdef HAVE_WINDOW_SYSTEM
5239 if (IMAGEP (object
))
5241 Lisp_Object image_map
, hotspot
;
5242 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5244 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5246 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5247 posn
= XCAR (hotspot
);
5254 Fcons (make_number (dx
), make_number (dy
)),
5255 Fcons (make_number (width
), make_number (height
)));
5258 extra_info
= Fcons (string_info
,
5259 Fcons (make_number (textpos
),
5260 Fcons (Fcons (make_number (col
),
5265 XSETFRAME (window
, f
);
5269 return Fcons (window
,
5271 Fcons (Fcons (make_number (xret
),
5272 make_number (yret
)),
5273 Fcons (make_number (t
),
5277 /* Given a struct input_event, build the lisp event which represents
5278 it. If EVENT is 0, build a mouse movement event from the mouse
5279 movement buffer, which should have a movement event in it.
5281 Note that events must be passed to this function in the order they
5282 are received; this function stores the location of button presses
5283 in order to build drag events when the button is released. */
5286 make_lispy_event (struct input_event
*event
)
5290 switch (SWITCH_ENUM_CAST (event
->kind
))
5292 /* A simple keystroke. */
5293 case ASCII_KEYSTROKE_EVENT
:
5294 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5296 Lisp_Object lispy_c
;
5297 EMACS_INT c
= event
->code
;
5298 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5301 eassert (c
== event
->code
);
5302 /* Turn ASCII characters into control characters
5304 if (event
->modifiers
& ctrl_modifier
)
5306 c
= make_ctrl_char (c
);
5307 event
->modifiers
&= ~ctrl_modifier
;
5311 /* Add in the other modifier bits. The shift key was taken care
5312 of by the X code. */
5313 c
|= (event
->modifiers
5314 & (meta_modifier
| alt_modifier
5315 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5316 /* Distinguish Shift-SPC from SPC. */
5317 if ((event
->code
) == 040
5318 && event
->modifiers
& shift_modifier
)
5319 c
|= shift_modifier
;
5320 button_down_time
= 0;
5321 XSETFASTINT (lispy_c
, c
);
5326 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5327 except that they are non-key events (last-nonmenu-event is nil). */
5328 case NS_NONKEY_EVENT
:
5331 /* A function key. The symbol may need to have modifier prefixes
5333 case NON_ASCII_KEYSTROKE_EVENT
:
5334 button_down_time
= 0;
5336 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5337 if (event
->code
== lispy_accent_codes
[i
])
5338 return modify_event_symbol (i
,
5340 Qfunction_key
, Qnil
,
5341 lispy_accent_keys
, &accent_key_syms
,
5342 (sizeof (lispy_accent_keys
)
5343 / sizeof (lispy_accent_keys
[0])));
5347 if (event
->code
>= 0x400 && event
->code
< 0x500)
5348 return modify_event_symbol (event
->code
- 0x400,
5349 event
->modifiers
& ~shift_modifier
,
5350 Qfunction_key
, Qnil
,
5351 lispy_kana_keys
, &func_key_syms
,
5352 (sizeof (lispy_kana_keys
)
5353 / sizeof (lispy_kana_keys
[0])));
5354 #endif /* XK_kana_A */
5357 #ifdef ISO_FUNCTION_KEY_OFFSET
5358 if (event
->code
< FUNCTION_KEY_OFFSET
5359 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5360 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5362 Qfunction_key
, Qnil
,
5363 iso_lispy_function_keys
, &func_key_syms
,
5364 (sizeof (iso_lispy_function_keys
)
5365 / sizeof (iso_lispy_function_keys
[0])));
5368 /* Handle system-specific or unknown keysyms. */
5369 if (event
->code
& (1 << 28)
5370 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5371 || (event
->code
- FUNCTION_KEY_OFFSET
5372 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5373 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5375 /* We need to use an alist rather than a vector as the cache
5376 since we can't make a vector long enuf. */
5377 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5378 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5379 return modify_event_symbol (event
->code
,
5382 KVAR (current_kboard
, Vsystem_key_alist
),
5383 0, &KVAR (current_kboard
, system_key_syms
),
5387 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5389 Qfunction_key
, Qnil
,
5390 lispy_function_keys
, &func_key_syms
,
5391 (sizeof (lispy_function_keys
)
5392 / sizeof (lispy_function_keys
[0])));
5395 case MULTIMEDIA_KEY_EVENT
:
5396 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5397 / sizeof (lispy_multimedia_keys
[0]))
5398 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5400 return modify_event_symbol (event
->code
, event
->modifiers
,
5401 Qfunction_key
, Qnil
,
5402 lispy_multimedia_keys
, &func_key_syms
,
5403 (sizeof (lispy_multimedia_keys
)
5404 / sizeof (lispy_multimedia_keys
[0])));
5410 /* A mouse click. Figure out where it is, decide whether it's
5411 a press, click or drag, and build the appropriate structure. */
5412 case MOUSE_CLICK_EVENT
:
5413 #ifndef USE_TOOLKIT_SCROLL_BARS
5414 case SCROLL_BAR_CLICK_EVENT
:
5417 int button
= event
->code
;
5419 Lisp_Object position
;
5420 Lisp_Object
*start_pos_ptr
;
5421 Lisp_Object start_pos
;
5425 /* Build the position as appropriate for this mouse click. */
5426 if (event
->kind
== MOUSE_CLICK_EVENT
)
5428 struct frame
*f
= XFRAME (event
->frame_or_window
);
5429 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5433 /* Ignore mouse events that were made on frame that
5434 have been deleted. */
5435 if (! FRAME_LIVE_P (f
))
5438 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5439 /* EVENT->x and EVENT->y are frame-relative pixel
5440 coordinates at this place. Under old redisplay, COLUMN
5441 and ROW are set to frame relative glyph coordinates
5442 which are then used to determine whether this click is
5443 in a menu (non-toolkit version). */
5444 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5445 &column
, &row
, NULL
, 1);
5447 /* In the non-toolkit version, clicks on the menu bar
5448 are ordinary button events in the event buffer.
5449 Distinguish them, and invoke the menu.
5451 (In the toolkit version, the toolkit handles the menu bar
5452 and Emacs doesn't know about it until after the user
5453 makes a selection.) */
5454 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5455 && (event
->modifiers
& down_modifier
))
5457 Lisp_Object items
, item
;
5460 /* Find the menu bar item under `column'. */
5462 items
= FRAME_MENU_BAR_ITEMS (f
);
5463 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5465 Lisp_Object pos
, string
;
5466 string
= AREF (items
, i
+ 1);
5467 pos
= AREF (items
, i
+ 3);
5470 if (column
>= XINT (pos
)
5471 && column
< XINT (pos
) + SCHARS (string
))
5473 item
= AREF (items
, i
);
5478 /* ELisp manual 2.4b says (x y) are window relative but
5479 code says they are frame-relative. */
5481 = Fcons (event
->frame_or_window
,
5483 Fcons (Fcons (event
->x
, event
->y
),
5484 Fcons (make_number (event
->timestamp
),
5487 return Fcons (item
, Fcons (position
, Qnil
));
5489 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5491 position
= make_lispy_position (f
, event
->x
, event
->y
,
5494 #ifndef USE_TOOLKIT_SCROLL_BARS
5497 /* It's a scrollbar click. */
5499 Lisp_Object portion_whole
;
5502 window
= event
->frame_or_window
;
5503 portion_whole
= Fcons (event
->x
, event
->y
);
5504 part
= *scroll_bar_parts
[(int) event
->part
];
5508 Fcons (Qvertical_scroll_bar
,
5509 Fcons (portion_whole
,
5510 Fcons (make_number (event
->timestamp
),
5511 Fcons (part
, Qnil
)))));
5513 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5515 if (button
>= ASIZE (button_down_location
))
5517 button_down_location
= larger_vector (button_down_location
,
5519 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5522 start_pos_ptr
= &AREF (button_down_location
, button
);
5523 start_pos
= *start_pos_ptr
;
5524 *start_pos_ptr
= Qnil
;
5527 /* On window-system frames, use the value of
5528 double-click-fuzz as is. On other frames, interpret it
5529 as a multiple of 1/8 characters. */
5533 if (WINDOWP (event
->frame_or_window
))
5534 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5535 else if (FRAMEP (event
->frame_or_window
))
5536 f
= XFRAME (event
->frame_or_window
);
5540 if (FRAME_WINDOW_P (f
))
5541 fuzz
= double_click_fuzz
;
5543 fuzz
= double_click_fuzz
/ 8;
5545 is_double
= (button
== last_mouse_button
5546 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5547 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5548 && button_down_time
!= 0
5549 && (EQ (Vdouble_click_time
, Qt
)
5550 || (INTEGERP (Vdouble_click_time
)
5551 && ((int)(event
->timestamp
- button_down_time
)
5552 < XINT (Vdouble_click_time
)))));
5555 last_mouse_button
= button
;
5556 last_mouse_x
= XINT (event
->x
);
5557 last_mouse_y
= XINT (event
->y
);
5559 /* If this is a button press, squirrel away the location, so
5560 we can decide later whether it was a click or a drag. */
5561 if (event
->modifiers
& down_modifier
)
5565 double_click_count
++;
5566 event
->modifiers
|= ((double_click_count
> 2)
5571 double_click_count
= 1;
5572 button_down_time
= event
->timestamp
;
5573 *start_pos_ptr
= Fcopy_alist (position
);
5574 ignore_mouse_drag_p
= 0;
5577 /* Now we're releasing a button - check the co-ordinates to
5578 see if this was a click or a drag. */
5579 else if (event
->modifiers
& up_modifier
)
5581 /* If we did not see a down before this up, ignore the up.
5582 Probably this happened because the down event chose a
5583 menu item. It would be an annoyance to treat the
5584 release of the button that chose the menu item as a
5587 if (!CONSP (start_pos
))
5590 event
->modifiers
&= ~up_modifier
;
5593 Lisp_Object new_down
, down
;
5594 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5596 /* The third element of every position
5597 should be the (x,y) pair. */
5598 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5599 new_down
= Fcar (Fcdr (Fcdr (position
)));
5602 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5604 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5605 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5608 if (ignore_mouse_drag_p
)
5610 event
->modifiers
|= click_modifier
;
5611 ignore_mouse_drag_p
= 0;
5613 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5614 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5615 /* Maybe the mouse has moved a lot, caused scrolling, and
5616 eventually ended up at the same screen position (but
5617 not buffer position) in which case it is a drag, not
5619 /* FIXME: OTOH if the buffer position has changed
5620 because of a timer or process filter rather than
5621 because of mouse movement, it should be considered as
5622 a click. But mouse-drag-region completely ignores
5623 this case and it hasn't caused any real problem, so
5624 it's probably OK to ignore it as well. */
5625 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5626 /* Mouse hasn't moved (much). */
5627 event
->modifiers
|= click_modifier
;
5630 button_down_time
= 0;
5631 event
->modifiers
|= drag_modifier
;
5634 /* Don't check is_double; treat this as multiple
5635 if the down-event was multiple. */
5636 if (double_click_count
> 1)
5637 event
->modifiers
|= ((double_click_count
> 2)
5643 /* Every mouse event should either have the down_modifier or
5644 the up_modifier set. */
5648 /* Get the symbol we should use for the mouse click. */
5651 head
= modify_event_symbol (button
,
5653 Qmouse_click
, Vlispy_mouse_stem
,
5656 XVECTOR (mouse_syms
)->size
);
5657 if (event
->modifiers
& drag_modifier
)
5662 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5665 Fcons (make_number (double_click_count
),
5675 case HORIZ_WHEEL_EVENT
:
5677 Lisp_Object position
;
5680 /* Build the position as appropriate for this mouse click. */
5681 struct frame
*f
= XFRAME (event
->frame_or_window
);
5683 /* Ignore wheel events that were made on frame that have been
5685 if (! FRAME_LIVE_P (f
))
5688 position
= make_lispy_position (f
, event
->x
, event
->y
,
5691 /* Set double or triple modifiers to indicate the wheel speed. */
5693 /* On window-system frames, use the value of
5694 double-click-fuzz as is. On other frames, interpret it
5695 as a multiple of 1/8 characters. */
5701 if (WINDOWP (event
->frame_or_window
))
5702 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5703 else if (FRAMEP (event
->frame_or_window
))
5704 fr
= XFRAME (event
->frame_or_window
);
5708 fuzz
= FRAME_WINDOW_P (fr
)
5709 ? double_click_fuzz
: double_click_fuzz
/ 8;
5711 if (event
->modifiers
& up_modifier
)
5713 /* Emit a wheel-up event. */
5714 event
->modifiers
&= ~up_modifier
;
5717 else if (event
->modifiers
& down_modifier
)
5719 /* Emit a wheel-down event. */
5720 event
->modifiers
&= ~down_modifier
;
5724 /* Every wheel event should either have the down_modifier or
5725 the up_modifier set. */
5728 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5731 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5732 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5733 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5734 && button_down_time
!= 0
5735 && (EQ (Vdouble_click_time
, Qt
)
5736 || (INTEGERP (Vdouble_click_time
)
5737 && ((int)(event
->timestamp
- button_down_time
)
5738 < XINT (Vdouble_click_time
)))));
5741 double_click_count
++;
5742 event
->modifiers
|= ((double_click_count
> 2)
5748 double_click_count
= 1;
5749 event
->modifiers
|= click_modifier
;
5752 button_down_time
= event
->timestamp
;
5753 /* Use a negative value to distinguish wheel from mouse button. */
5754 last_mouse_button
= - (1 + symbol_num
);
5755 last_mouse_x
= XINT (event
->x
);
5756 last_mouse_y
= XINT (event
->y
);
5758 /* Get the symbol we should use for the wheel event. */
5759 head
= modify_event_symbol (symbol_num
,
5765 ASIZE (wheel_syms
));
5768 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5771 Fcons (make_number (double_click_count
),
5780 #ifdef USE_TOOLKIT_SCROLL_BARS
5782 /* We don't have down and up events if using toolkit scroll bars,
5783 so make this always a click event. Store in the `part' of
5784 the Lisp event a symbol which maps to the following actions:
5786 `above_handle' page up
5787 `below_handle' page down
5791 `bottom' bottom of buffer
5792 `handle' thumb has been dragged.
5793 `end-scroll' end of interaction with scroll bar
5795 The incoming input_event contains in its `part' member an
5796 index of type `enum scroll_bar_part' which we can use as an
5797 index in scroll_bar_parts to get the appropriate symbol. */
5799 case SCROLL_BAR_CLICK_EVENT
:
5801 Lisp_Object position
, head
, window
, portion_whole
, part
;
5803 window
= event
->frame_or_window
;
5804 portion_whole
= Fcons (event
->x
, event
->y
);
5805 part
= *scroll_bar_parts
[(int) event
->part
];
5809 Fcons (Qvertical_scroll_bar
,
5810 Fcons (portion_whole
,
5811 Fcons (make_number (event
->timestamp
),
5812 Fcons (part
, Qnil
)))));
5814 /* Always treat scroll bar events as clicks. */
5815 event
->modifiers
|= click_modifier
;
5816 event
->modifiers
&= ~up_modifier
;
5818 if (event
->code
>= ASIZE (mouse_syms
))
5819 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5821 /* Get the symbol we should use for the mouse click. */
5822 head
= modify_event_symbol (event
->code
,
5827 XVECTOR (mouse_syms
)->size
);
5828 return Fcons (head
, Fcons (position
, Qnil
));
5831 #endif /* USE_TOOLKIT_SCROLL_BARS */
5833 case DRAG_N_DROP_EVENT
:
5836 Lisp_Object head
, position
;
5839 f
= XFRAME (event
->frame_or_window
);
5842 /* Ignore mouse events that were made on frames that
5843 have been deleted. */
5844 if (! FRAME_LIVE_P (f
))
5847 position
= make_lispy_position (f
, event
->x
, event
->y
,
5850 head
= modify_event_symbol (0, event
->modifiers
,
5852 lispy_drag_n_drop_names
,
5853 &drag_n_drop_syms
, 1);
5859 #endif /* HAVE_MOUSE */
5861 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5862 || defined(HAVE_NS) || defined (USE_GTK)
5863 case MENU_BAR_EVENT
:
5864 if (EQ (event
->arg
, event
->frame_or_window
))
5865 /* This is the prefix key. We translate this to
5866 `(menu_bar)' because the code in keyboard.c for menu
5867 events, which we use, relies on this. */
5868 return Fcons (Qmenu_bar
, Qnil
);
5872 case SELECT_WINDOW_EVENT
:
5873 /* Make an event (select-window (WINDOW)). */
5874 return Fcons (Qselect_window
,
5875 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5878 case TOOL_BAR_EVENT
:
5879 if (EQ (event
->arg
, event
->frame_or_window
))
5880 /* This is the prefix key. We translate this to
5881 `(tool_bar)' because the code in keyboard.c for tool bar
5882 events, which we use, relies on this. */
5883 return Fcons (Qtool_bar
, Qnil
);
5884 else if (SYMBOLP (event
->arg
))
5885 return apply_modifiers (event
->modifiers
, event
->arg
);
5888 case USER_SIGNAL_EVENT
:
5889 /* A user signal. */
5891 char *name
= find_user_signal_name (event
->code
);
5894 return intern (name
);
5897 case SAVE_SESSION_EVENT
:
5898 return Qsave_session
;
5903 return Fcons (Qdbus_event
, event
->arg
);
5905 #endif /* HAVE_DBUS */
5907 case CONFIG_CHANGED_EVENT
:
5908 return Fcons (Qconfig_changed_event
,
5910 Fcons (event
->frame_or_window
, Qnil
)));
5912 case GPM_CLICK_EVENT
:
5914 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5915 Lisp_Object head
, position
;
5916 Lisp_Object
*start_pos_ptr
;
5917 Lisp_Object start_pos
;
5918 int button
= event
->code
;
5920 if (button
>= ASIZE (button_down_location
))
5922 button_down_location
= larger_vector (button_down_location
,
5924 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5927 start_pos_ptr
= &AREF (button_down_location
, button
);
5928 start_pos
= *start_pos_ptr
;
5930 position
= make_lispy_position (f
, event
->x
, event
->y
,
5933 if (event
->modifiers
& down_modifier
)
5934 *start_pos_ptr
= Fcopy_alist (position
);
5935 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5937 if (!CONSP (start_pos
))
5939 event
->modifiers
&= ~up_modifier
;
5942 head
= modify_event_symbol (button
,
5944 Qmouse_click
, Vlispy_mouse_stem
,
5947 XVECTOR (mouse_syms
)->size
);
5949 if (event
->modifiers
& drag_modifier
)
5954 else if (event
->modifiers
& double_modifier
)
5957 Fcons (make_number (2),
5959 else if (event
->modifiers
& triple_modifier
)
5962 Fcons (make_number (3),
5969 #endif /* HAVE_GPM */
5971 /* The 'kind' field of the event is something we don't recognize. */
5977 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
5980 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5981 Lisp_Object x
, Lisp_Object y
, unsigned long t
)
5983 /* Is it a scroll bar movement? */
5984 if (frame
&& ! NILP (bar_window
))
5986 Lisp_Object part_sym
;
5988 part_sym
= *scroll_bar_parts
[(int) part
];
5989 return Fcons (Qscroll_bar_movement
,
5990 Fcons (list5 (bar_window
,
5991 Qvertical_scroll_bar
,
5997 /* Or is it an ordinary mouse movement? */
6000 Lisp_Object position
;
6001 position
= make_lispy_position (frame
, x
, y
, t
);
6002 return list2 (Qmouse_movement
, position
);
6006 #endif /* HAVE_MOUSE || HAVE GPM */
6008 /* Construct a switch frame event. */
6010 make_lispy_switch_frame (Lisp_Object frame
)
6012 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6015 /* Manipulating modifiers. */
6017 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6019 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6020 SYMBOL's name of the end of the modifiers; the string from this
6021 position is the unmodified symbol name.
6023 This doesn't use any caches. */
6026 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6032 CHECK_SYMBOL (symbol
);
6035 name
= SYMBOL_NAME (symbol
);
6037 for (i
= 0; i
+2 <= SBYTES (name
); )
6039 EMACS_INT this_mod_end
= 0;
6042 /* See if the name continues with a modifier word.
6043 Check that the word appears, but don't check what follows it.
6044 Set this_mod and this_mod_end to record what we find. */
6046 switch (SREF (name
, i
))
6048 #define SINGLE_LETTER_MOD(BIT) \
6049 (this_mod_end = i + 1, this_mod = BIT)
6052 SINGLE_LETTER_MOD (alt_modifier
);
6056 SINGLE_LETTER_MOD (ctrl_modifier
);
6060 SINGLE_LETTER_MOD (hyper_modifier
);
6064 SINGLE_LETTER_MOD (meta_modifier
);
6068 SINGLE_LETTER_MOD (shift_modifier
);
6072 SINGLE_LETTER_MOD (super_modifier
);
6075 #undef SINGLE_LETTER_MOD
6077 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6078 if (i + LEN + 1 <= SBYTES (name) \
6079 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6081 this_mod_end = i + LEN; \
6086 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6087 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6088 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6092 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6094 #undef MULTI_LETTER_MOD
6098 /* If we found no modifier, stop looking for them. */
6099 if (this_mod_end
== 0)
6102 /* Check there is a dash after the modifier, so that it
6103 really is a modifier. */
6104 if (this_mod_end
>= SBYTES (name
)
6105 || SREF (name
, this_mod_end
) != '-')
6108 /* This modifier is real; look for another. */
6109 modifiers
|= this_mod
;
6110 i
= this_mod_end
+ 1;
6113 /* Should we include the `click' modifier? */
6114 if (! (modifiers
& (down_modifier
| drag_modifier
6115 | double_modifier
| triple_modifier
))
6116 && i
+ 7 == SBYTES (name
)
6117 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6118 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6119 modifiers
|= click_modifier
;
6121 if (! (modifiers
& (double_modifier
| triple_modifier
))
6122 && i
+ 6 < SBYTES (name
)
6123 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6124 modifiers
|= click_modifier
;
6132 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6133 prepended to the string BASE[0..BASE_LEN-1].
6134 This doesn't use any caches. */
6136 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6138 /* Since BASE could contain nulls, we can't use intern here; we have
6139 to use Fintern, which expects a genuine Lisp_String, and keeps a
6142 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6148 /* Only the event queue may use the `up' modifier; it should always
6149 be turned into a click or drag event before presented to lisp code. */
6150 if (modifiers
& up_modifier
)
6153 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6154 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6155 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6156 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6157 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6158 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6159 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6160 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6161 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6162 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6163 /* The click modifier is denoted by the absence of other modifiers. */
6167 mod_len
= p
- new_mods
;
6171 Lisp_Object new_name
;
6173 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6174 mod_len
+ base_len_byte
);
6175 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6176 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6178 return Fintern (new_name
, Qnil
);
6183 static const char *const modifier_names
[] =
6185 "up", "down", "drag", "click", "double", "triple", 0, 0,
6186 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6187 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6189 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6191 static Lisp_Object modifier_symbols
;
6193 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6195 lispy_modifier_list (int modifiers
)
6197 Lisp_Object modifier_list
;
6200 modifier_list
= Qnil
;
6201 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6202 if (modifiers
& (1<<i
))
6203 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6206 return modifier_list
;
6210 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6211 where UNMODIFIED is the unmodified form of SYMBOL,
6212 MASK is the set of modifiers present in SYMBOL's name.
6213 This is similar to parse_modifiers_uncached, but uses the cache in
6214 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6215 Qevent_symbol_elements property. */
6217 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6220 parse_modifiers (Lisp_Object symbol
)
6222 Lisp_Object elements
;
6224 if (INTEGERP (symbol
))
6225 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6226 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6228 else if (!SYMBOLP (symbol
))
6231 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6232 if (CONSP (elements
))
6237 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6238 Lisp_Object unmodified
;
6241 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6242 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6245 if (modifiers
& ~INTMASK
)
6247 XSETFASTINT (mask
, modifiers
);
6248 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6250 /* Cache the parsing results on SYMBOL. */
6251 Fput (symbol
, Qevent_symbol_element_mask
,
6253 Fput (symbol
, Qevent_symbol_elements
,
6254 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6256 /* Since we know that SYMBOL is modifiers applied to unmodified,
6257 it would be nice to put that in unmodified's cache.
6258 But we can't, since we're not sure that parse_modifiers is
6265 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6266 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6267 doc
: /* Parse the event symbol. For internal use. */)
6268 (Lisp_Object symbol
)
6270 /* Fill the cache if needed. */
6271 parse_modifiers (symbol
);
6272 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6273 and use the Lispier representation stored on Qevent_symbol_elements
6275 return Fget (symbol
, Qevent_symbol_elements
);
6278 /* Apply the modifiers MODIFIERS to the symbol BASE.
6279 BASE must be unmodified.
6281 This is like apply_modifiers_uncached, but uses BASE's
6282 Qmodifier_cache property, if present. It also builds
6283 Qevent_symbol_elements properties, since it has that info anyway.
6285 apply_modifiers copies the value of BASE's Qevent_kind property to
6286 the modified symbol. */
6288 apply_modifiers (int modifiers
, Lisp_Object base
)
6290 Lisp_Object cache
, idx
, entry
, new_symbol
;
6292 /* Mask out upper bits. We don't know where this value's been. */
6293 modifiers
&= INTMASK
;
6295 if (INTEGERP (base
))
6296 return make_number (XINT (base
) | modifiers
);
6298 /* The click modifier never figures into cache indices. */
6299 cache
= Fget (base
, Qmodifier_cache
);
6300 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6301 entry
= assq_no_quit (idx
, cache
);
6304 new_symbol
= XCDR (entry
);
6307 /* We have to create the symbol ourselves. */
6308 new_symbol
= apply_modifiers_uncached (modifiers
,
6309 SSDATA (SYMBOL_NAME (base
)),
6310 SCHARS (SYMBOL_NAME (base
)),
6311 SBYTES (SYMBOL_NAME (base
)));
6313 /* Add the new symbol to the base's cache. */
6314 entry
= Fcons (idx
, new_symbol
);
6315 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6317 /* We have the parsing info now for free, so we could add it to
6319 XSETFASTINT (idx, modifiers);
6320 Fput (new_symbol, Qevent_symbol_element_mask,
6321 Fcons (base, Fcons (idx, Qnil)));
6322 Fput (new_symbol, Qevent_symbol_elements,
6323 Fcons (base, lispy_modifier_list (modifiers)));
6324 Sadly, this is only correct if `base' is indeed a base event,
6325 which is not necessarily the case. -stef */
6328 /* Make sure this symbol is of the same kind as BASE.
6330 You'd think we could just set this once and for all when we
6331 intern the symbol above, but reorder_modifiers may call us when
6332 BASE's property isn't set right; we can't assume that just
6333 because it has a Qmodifier_cache property it must have its
6334 Qevent_kind set right as well. */
6335 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6339 kind
= Fget (base
, Qevent_kind
);
6341 Fput (new_symbol
, Qevent_kind
, kind
);
6348 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6349 return a symbol with the modifiers placed in the canonical order.
6350 Canonical order is alphabetical, except for down and drag, which
6351 always come last. The 'click' modifier is never written out.
6353 Fdefine_key calls this to make sure that (for example) C-M-foo
6354 and M-C-foo end up being equivalent in the keymap. */
6357 reorder_modifiers (Lisp_Object symbol
)
6359 /* It's hopefully okay to write the code this way, since everything
6360 will soon be in caches, and no consing will be done at all. */
6363 parsed
= parse_modifiers (symbol
);
6364 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6369 /* For handling events, we often want to produce a symbol whose name
6370 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6371 to some base, like the name of a function key or mouse button.
6372 modify_event_symbol produces symbols of this sort.
6374 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6375 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6378 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6379 into symbol names, or a string specifying a name stem used to
6380 construct a symbol name or the form `STEM-N', where N is the decimal
6381 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6382 non-nil; otherwise NAME_TABLE is used.
6384 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6385 persist between calls to modify_event_symbol that it can use to
6386 store a cache of the symbols it's generated for this NAME_TABLE
6387 before. The object stored there may be a vector or an alist.
6389 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6391 MODIFIERS is a set of modifier bits (as given in struct input_events)
6392 whose prefixes should be applied to the symbol name.
6394 SYMBOL_KIND is the value to be placed in the event_kind property of
6395 the returned symbol.
6397 The symbols we create are supposed to have an
6398 `event-symbol-elements' property, which lists the modifiers present
6399 in the symbol's name. */
6402 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6403 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6404 Lisp_Object
*symbol_table
, unsigned int table_size
)
6407 Lisp_Object symbol_int
;
6409 /* Get rid of the "vendor-specific" bit here. */
6410 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6412 /* Is this a request for a valid symbol? */
6413 if (symbol_num
< 0 || symbol_num
>= table_size
)
6416 if (CONSP (*symbol_table
))
6417 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6419 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6420 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6421 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6422 we've never used that symbol before. */
6425 if (! VECTORP (*symbol_table
)
6426 || XVECTOR (*symbol_table
)->size
!= table_size
)
6430 XSETFASTINT (size
, table_size
);
6431 *symbol_table
= Fmake_vector (size
, Qnil
);
6434 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6437 /* Have we already used this symbol before? */
6440 /* No; let's create it. */
6441 if (CONSP (name_alist_or_stem
))
6442 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6443 else if (STRINGP (name_alist_or_stem
))
6445 int len
= SBYTES (name_alist_or_stem
);
6446 char *buf
= (char *) alloca (len
+ 50);
6447 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6448 (long) XINT (symbol_int
) + 1);
6449 value
= intern (buf
);
6451 else if (name_table
!= 0 && name_table
[symbol_num
])
6452 value
= intern (name_table
[symbol_num
]);
6454 #ifdef HAVE_WINDOW_SYSTEM
6457 char *name
= x_get_keysym_name (symbol_num
);
6459 value
= intern (name
);
6466 sprintf (buf
, "key-%ld", (long)symbol_num
);
6467 value
= intern (buf
);
6470 if (CONSP (*symbol_table
))
6471 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6473 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6475 /* Fill in the cache entries for this symbol; this also
6476 builds the Qevent_symbol_elements property, which the user
6478 apply_modifiers (modifiers
& click_modifier
, value
);
6479 Fput (value
, Qevent_kind
, symbol_kind
);
6482 /* Apply modifiers to that symbol. */
6483 return apply_modifiers (modifiers
, value
);
6486 /* Convert a list that represents an event type,
6487 such as (ctrl meta backspace), into the usual representation of that
6488 event type as a number or a symbol. */
6490 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6491 doc
: /* Convert the event description list EVENT-DESC to an event type.
6492 EVENT-DESC should contain one base event type (a character or symbol)
6493 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6494 drag, down, double or triple). The base must be last.
6495 The return value is an event type (a character or symbol) which
6496 has the same base event type and all the specified modifiers. */)
6497 (Lisp_Object event_desc
)
6505 while (CONSP (rest
))
6513 /* Given a symbol, see if it is a modifier name. */
6514 if (SYMBOLP (elt
) && CONSP (rest
))
6515 this = parse_solitary_modifier (elt
);
6519 else if (!NILP (base
))
6520 error ("Two bases given in one event");
6526 /* Let the symbol A refer to the character A. */
6527 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6528 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6530 if (INTEGERP (base
))
6532 /* Turn (shift a) into A. */
6533 if ((modifiers
& shift_modifier
) != 0
6534 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6536 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6537 modifiers
&= ~shift_modifier
;
6540 /* Turn (control a) into C-a. */
6541 if (modifiers
& ctrl_modifier
)
6542 return make_number ((modifiers
& ~ctrl_modifier
)
6543 | make_ctrl_char (XINT (base
)));
6545 return make_number (modifiers
| XINT (base
));
6547 else if (SYMBOLP (base
))
6548 return apply_modifiers (modifiers
, base
);
6551 error ("Invalid base event");
6556 /* Try to recognize SYMBOL as a modifier name.
6557 Return the modifier flag bit, or 0 if not recognized. */
6560 parse_solitary_modifier (Lisp_Object symbol
)
6562 Lisp_Object name
= SYMBOL_NAME (symbol
);
6564 switch (SREF (name
, 0))
6566 #define SINGLE_LETTER_MOD(BIT) \
6567 if (SBYTES (name) == 1) \
6570 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6571 if (LEN == SBYTES (name) \
6572 && ! strncmp (SSDATA (name), NAME, LEN)) \
6576 SINGLE_LETTER_MOD (alt_modifier
);
6580 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6584 SINGLE_LETTER_MOD (ctrl_modifier
);
6588 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6589 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6593 SINGLE_LETTER_MOD (hyper_modifier
);
6597 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6601 SINGLE_LETTER_MOD (meta_modifier
);
6605 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6609 SINGLE_LETTER_MOD (shift_modifier
);
6613 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6614 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6615 SINGLE_LETTER_MOD (super_modifier
);
6619 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6620 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6621 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6625 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6628 #undef SINGLE_LETTER_MOD
6629 #undef MULTI_LETTER_MOD
6635 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6636 Such a list is not valid as an event,
6637 but it can be a Lucid-style event type list. */
6640 lucid_event_type_list_p (Lisp_Object object
)
6644 if (! CONSP (object
))
6647 if (EQ (XCAR (object
), Qhelp_echo
)
6648 || EQ (XCAR (object
), Qvertical_line
)
6649 || EQ (XCAR (object
), Qmode_line
)
6650 || EQ (XCAR (object
), Qheader_line
))
6653 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6657 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6664 /* Store into *addr a value nonzero if terminal input chars are available.
6665 Serves the purpose of ioctl (0, FIONREAD, addr)
6666 but works even if FIONREAD does not exist.
6667 (In fact, this may actually read some input.)
6669 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6670 timer events that are ripe.
6671 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6672 events (FOCUS_IN_EVENT).
6673 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6674 movements and toolkit scroll bar thumb drags. */
6677 get_input_pending (int *addr
, int flags
)
6679 /* First of all, have we already counted some input? */
6680 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6682 /* If input is being read as it arrives, and we have none, there is none. */
6683 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6686 /* Try to read some input and see how much we get. */
6688 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6691 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6694 gobble_input (int expected
)
6697 if (interrupt_input
)
6700 mask
= sigblock (sigmask (SIGIO
));
6701 read_avail_input (expected
);
6705 #ifdef POLL_FOR_INPUT
6706 /* XXX This condition was (read_socket_hook && !interrupt_input),
6707 but read_socket_hook is not global anymore. Let's pretend that
6709 if (!interrupt_input
&& poll_suppress_count
== 0)
6712 mask
= sigblock (sigmask (SIGALRM
));
6713 read_avail_input (expected
);
6719 read_avail_input (expected
);
6722 /* Put a BUFFER_SWITCH_EVENT in the buffer
6723 so that read_key_sequence will notice the new current buffer. */
6726 record_asynch_buffer_change (void)
6728 struct input_event event
;
6732 event
.kind
= BUFFER_SWITCH_EVENT
;
6733 event
.frame_or_window
= Qnil
;
6736 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6737 The purpose of the event is to make read_key_sequence look up the
6738 keymaps again. If we aren't in read_key_sequence, we don't need one,
6739 and the event could cause trouble by messing up (input-pending-p).
6740 Note: Fwaiting_for_user_input_p always returns nil when async
6741 subprocesses aren't supported. */
6742 tem
= Fwaiting_for_user_input_p ();
6746 /* Make sure no interrupt happens while storing the event. */
6748 if (interrupt_input
)
6751 mask
= sigblock (sigmask (SIGIO
));
6752 kbd_buffer_store_event (&event
);
6759 kbd_buffer_store_event (&event
);
6764 /* Read any terminal input already buffered up by the system
6765 into the kbd_buffer, but do not wait.
6767 EXPECTED should be nonzero if the caller knows there is some input.
6769 Returns the number of keyboard chars read, or -1 meaning
6770 this is a bad time to try to read input. */
6773 read_avail_input (int expected
)
6779 /* Store pending user signal events, if any. */
6780 if (store_user_signal_events ())
6783 /* Loop through the available terminals, and call their input hooks. */
6787 struct terminal
*next
= t
->next_terminal
;
6789 if (t
->read_socket_hook
)
6792 struct input_event hold_quit
;
6794 EVENT_INIT (hold_quit
);
6795 hold_quit
.kind
= NO_EVENT
;
6797 /* No need for FIONREAD or fcntl; just say don't wait. */
6798 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6804 if (nr
== -1) /* Not OK to read input now. */
6808 else if (nr
== -2) /* Non-transient error. */
6810 /* The terminal device terminated; it should be closed. */
6812 /* Kill Emacs if this was our last terminal. */
6813 if (!terminal_list
->next_terminal
)
6814 /* Formerly simply reported no input, but that
6815 sometimes led to a failure of Emacs to terminate.
6816 SIGHUP seems appropriate if we can't reach the
6818 /* ??? Is it really right to send the signal just to
6819 this process rather than to the whole process
6820 group? Perhaps on systems with FIONREAD Emacs is
6821 alone in its group. */
6822 kill (getpid (), SIGHUP
);
6824 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6827 XSETTERMINAL (tmp
, t
);
6828 Fdelete_terminal (tmp
, Qnoelisp
);
6832 if (hold_quit
.kind
!= NO_EVENT
)
6833 kbd_buffer_store_event (&hold_quit
);
6842 frame_make_pointer_visible ();
6848 decode_keyboard_code (struct tty_display_info
*tty
,
6849 struct coding_system
*coding
,
6850 unsigned char *buf
, int nbytes
)
6852 unsigned char *src
= buf
;
6853 const unsigned char *p
;
6858 if (tty
->meta_key
!= 2)
6859 for (i
= 0; i
< nbytes
; i
++)
6861 if (coding
->carryover_bytes
> 0)
6863 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6864 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6865 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6866 nbytes
+= coding
->carryover_bytes
;
6868 coding
->destination
= alloca (nbytes
* 4);
6869 coding
->dst_bytes
= nbytes
* 4;
6870 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6871 if (coding
->produced_char
== 0)
6873 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6875 struct input_event event_buf
;
6877 EVENT_INIT (event_buf
);
6878 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6880 (ASCII_CHAR_P (event_buf
.code
)
6881 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6882 /* See the comment in tty_read_avail_input. */
6883 event_buf
.frame_or_window
= tty
->top_frame
;
6884 event_buf
.arg
= Qnil
;
6885 kbd_buffer_store_event (&event_buf
);
6889 /* This is the tty way of reading available input.
6891 Note that each terminal device has its own `struct terminal' object,
6892 and so this function is called once for each individual termcap
6893 terminal. The first parameter indicates which terminal to read from. */
6896 tty_read_avail_input (struct terminal
*terminal
,
6898 struct input_event
*hold_quit
)
6900 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6901 the kbd_buffer can really hold. That may prevent loss
6902 of characters on some systems when input is stuffed at us. */
6903 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6905 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6908 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6910 if (kbd_on_hold_p () || buffer_free
<= 0)
6912 #endif /* subprocesses */
6914 if (!terminal
->name
) /* Don't read from a dead terminal. */
6917 if (terminal
->type
!= output_termcap
6918 && terminal
->type
!= output_msdos_raw
)
6921 /* XXX I think the following code should be moved to separate hook
6922 functions in system-dependent files. */
6925 #else /* not WINDOWSNT */
6926 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6930 return 0; /* The terminal is suspended. */
6933 n_to_read
= dos_keysns ();
6937 cbuf
[0] = dos_keyread ();
6940 #else /* not MSDOS */
6945 struct input_event gpm_hold_quit
;
6946 int gpm
, fd
= gpm_fd
;
6948 EVENT_INIT (gpm_hold_quit
);
6949 gpm_hold_quit
.kind
= NO_EVENT
;
6951 /* gpm==1 if event received.
6952 gpm==0 if the GPM daemon has closed the connection, in which case
6953 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6954 we save it in `fd' so close_gpm can remove it from the
6956 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6957 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6958 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6961 /* Presumably the GPM daemon has closed the connection. */
6963 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6964 kbd_buffer_store_event (&gpm_hold_quit
);
6968 #endif /* HAVE_GPM */
6970 /* Determine how many characters we should *try* to read. */
6972 /* Find out how much input is available. */
6973 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6975 if (! noninteractive
)
6976 return -2; /* Close this terminal. */
6982 if (n_to_read
> sizeof cbuf
)
6983 n_to_read
= sizeof cbuf
;
6984 #else /* no FIONREAD */
6985 #if defined (USG) || defined(CYGWIN)
6986 /* Read some input if available, but don't wait. */
6987 n_to_read
= sizeof cbuf
;
6988 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6995 /* Don't read more than we can store. */
6996 if (n_to_read
> buffer_free
)
6997 n_to_read
= buffer_free
;
6998 #endif /* subprocesses */
7000 /* Now read; for one reason or another, this will not block.
7001 NREAD is set to the number of chars read. */
7004 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7005 /* POSIX infers that processes which are not in the session leader's
7006 process group won't get SIGHUP's at logout time. BSDI adheres to
7007 this part standard and returns -1 from read (0) with errno==EIO
7008 when the control tty is taken away.
7009 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7010 if (nread
== -1 && errno
== EIO
)
7011 return -2; /* Close this terminal. */
7012 #if defined (AIX) && defined (_BSD)
7013 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7014 This looks incorrect, but it isn't, because _BSD causes
7015 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7016 and that causes a value other than 0 when there is no input. */
7018 return -2; /* Close this terminal. */
7022 /* We used to retry the read if it was interrupted.
7023 But this does the wrong thing when O_NDELAY causes
7024 an EAGAIN error. Does anybody know of a situation
7025 where a retry is actually needed? */
7027 nread
< 0 && (errno
== EAGAIN
7041 #if defined (USG) || defined (CYGWIN)
7042 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7043 #endif /* USG or CYGWIN */
7044 #endif /* no FIONREAD */
7049 #endif /* not MSDOS */
7050 #endif /* not WINDOWSNT */
7052 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7053 & CODING_REQUIRE_DECODING_MASK
)
7055 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7058 /* Decode the key sequence except for those with meta
7060 for (i
= from
= 0; ; i
++)
7061 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7063 struct input_event buf
;
7065 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7070 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7071 buf
.modifiers
= meta_modifier
;
7072 buf
.code
= cbuf
[i
] & ~0x80;
7073 /* See the comment below. */
7074 buf
.frame_or_window
= tty
->top_frame
;
7076 kbd_buffer_store_event (&buf
);
7082 for (i
= 0; i
< nread
; i
++)
7084 struct input_event buf
;
7086 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7088 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7089 buf
.modifiers
= meta_modifier
;
7090 if (tty
->meta_key
!= 2)
7094 /* Set the frame corresponding to the active tty. Note that the
7095 value of selected_frame is not reliable here, redisplay tends
7096 to temporarily change it. */
7097 buf
.frame_or_window
= tty
->top_frame
;
7100 kbd_buffer_store_event (&buf
);
7101 /* Don't look at input that follows a C-g too closely.
7102 This reduces lossage due to autorepeat on C-g. */
7103 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7104 && buf
.code
== quit_char
)
7112 handle_async_input (void)
7114 interrupt_input_pending
= 0;
7116 pending_signals
= pending_atimers
;
7118 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7119 doing anything dangerous. */
7126 nread
= read_avail_input (1);
7127 /* -1 means it's not ok to read the input now.
7128 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7129 0 means there was no keyboard input available. */
7139 process_pending_signals (void)
7141 if (interrupt_input_pending
)
7142 handle_async_input ();
7143 do_pending_atimers ();
7146 #ifdef SIGIO /* for entire page */
7147 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7150 input_available_signal (int signo
)
7152 /* Must preserve main program's value of errno. */
7153 int old_errno
= errno
;
7154 SIGNAL_THREAD_CHECK (signo
);
7157 interrupt_input_pending
= 1;
7158 pending_signals
= 1;
7161 if (input_available_clear_time
)
7162 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7165 handle_async_input ();
7172 /* Send ourselves a SIGIO.
7174 This function exists so that the UNBLOCK_INPUT macro in
7175 blockinput.h can have some way to take care of input we put off
7176 dealing with, without assuming that every file which uses
7177 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7179 reinvoke_input_signal (void)
7182 handle_async_input ();
7188 /* User signal events. */
7190 struct user_signal_info
7192 /* Signal number. */
7195 /* Name of the signal. */
7198 /* Number of pending signals. */
7201 struct user_signal_info
*next
;
7204 /* List of user signals. */
7205 static struct user_signal_info
*user_signals
= NULL
;
7208 add_user_signal (int sig
, const char *name
)
7210 struct user_signal_info
*p
;
7212 for (p
= user_signals
; p
; p
= p
->next
)
7214 /* Already added. */
7217 p
= xmalloc (sizeof (struct user_signal_info
));
7219 p
->name
= xstrdup (name
);
7221 p
->next
= user_signals
;
7224 signal (sig
, handle_user_signal
);
7228 handle_user_signal (int sig
)
7230 int old_errno
= errno
;
7231 struct user_signal_info
*p
;
7233 SIGNAL_THREAD_CHECK (sig
);
7235 for (p
= user_signals
; p
; p
= p
->next
)
7240 if (interrupt_input
)
7241 kill (getpid (), SIGIO
);
7245 /* Tell wait_reading_process_output that it needs to wake
7246 up and look around. */
7247 if (input_available_clear_time
)
7248 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7257 find_user_signal_name (int sig
)
7259 struct user_signal_info
*p
;
7261 for (p
= user_signals
; p
; p
= p
->next
)
7269 store_user_signal_events (void)
7271 struct user_signal_info
*p
;
7272 struct input_event buf
;
7275 for (p
= user_signals
; p
; p
= p
->next
)
7276 if (p
->npending
> 0)
7282 memset (&buf
, 0, sizeof buf
);
7283 buf
.kind
= USER_SIGNAL_EVENT
;
7284 buf
.frame_or_window
= selected_frame
;
7286 nstored
+= p
->npending
;
7288 mask
= sigblock (sigmask (p
->sig
));
7292 kbd_buffer_store_event (&buf
);
7295 while (p
->npending
> 0);
7303 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7304 static Lisp_Object menu_bar_one_keymap_changed_items
;
7306 /* These variables hold the vector under construction within
7307 menu_bar_items and its subroutines, and the current index
7308 for storing into that vector. */
7309 static Lisp_Object menu_bar_items_vector
;
7310 static int menu_bar_items_index
;
7313 static const char* separator_names
[] = {
7318 "single-dashed-line",
7319 "double-dashed-line",
7321 "shadow-etched-out",
7322 "shadow-etched-in-dash",
7323 "shadow-etched-out-dash",
7324 "shadow-double-etched-in",
7325 "shadow-double-etched-out",
7326 "shadow-double-etched-in-dash",
7327 "shadow-double-etched-out-dash",
7331 /* Return non-zero if LABEL specifies a separator. */
7334 menu_separator_name_p (const char *label
)
7338 else if (strlen (label
) > 3
7339 && strncmp (label
, "--", 2) == 0
7344 for (i
= 0; separator_names
[i
]; ++i
)
7345 if (strcmp (label
, separator_names
[i
]) == 0)
7350 /* It's a separator if it contains only dashes. */
7351 while (*label
== '-')
7353 return (*label
== 0);
7360 /* Return a vector of menu items for a menu bar, appropriate
7361 to the current buffer. Each item has three elements in the vector:
7364 OLD is an old vector we can optionally reuse, or nil. */
7367 menu_bar_items (Lisp_Object old
)
7369 /* The number of keymaps we're scanning right now, and the number of
7370 keymaps we have allocated space for. */
7373 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7374 in the current keymaps, or nil where it is not a prefix. */
7377 Lisp_Object def
, tail
;
7382 /* In order to build the menus, we need to call the keymap
7383 accessors. They all call QUIT. But this function is called
7384 during redisplay, during which a quit is fatal. So inhibit
7385 quitting while building the menus.
7386 We do this instead of specbind because (1) errors will clear it anyway
7387 and (2) this avoids risk of specpdl overflow. */
7388 oquit
= Vinhibit_quit
;
7392 menu_bar_items_vector
= old
;
7394 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7395 menu_bar_items_index
= 0;
7397 /* Build our list of keymaps.
7398 If we recognize a function key and replace its escape sequence in
7399 keybuf with its symbol, or if the sequence starts with a mouse
7400 click and we need to switch buffers, we jump back here to rebuild
7401 the initial keymaps from the current buffer. */
7405 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7406 if (!NILP (Voverriding_local_map_menu_flag
))
7408 /* Yes, use them (if non-nil) as well as the global map. */
7409 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7411 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7412 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7413 if (!NILP (Voverriding_local_map
))
7414 maps
[nmaps
++] = Voverriding_local_map
;
7418 /* No, so use major and minor mode keymaps and keymap property.
7419 Note that menu-bar bindings in the local-map and keymap
7420 properties may not work reliable, as they are only
7421 recognized when the menu-bar (or mode-line) is updated,
7422 which does not normally happen after every command. */
7425 nminor
= current_minor_maps (NULL
, &tmaps
);
7426 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7428 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7429 maps
[nmaps
++] = tem
;
7430 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7432 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7434 maps
[nmaps
++] = current_global_map
;
7437 /* Look up in each map the dummy prefix key `menu-bar'. */
7439 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7440 if (!NILP (maps
[mapno
]))
7442 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7446 menu_bar_one_keymap_changed_items
= Qnil
;
7447 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7451 /* Move to the end those items that should be at the end. */
7453 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7456 int end
= menu_bar_items_index
;
7458 for (i
= 0; i
< end
; i
+= 4)
7459 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7461 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7462 /* Move the item at index I to the end,
7463 shifting all the others forward. */
7464 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7465 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7466 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7467 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7469 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7470 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7471 (end
- i
- 4) * sizeof (Lisp_Object
));
7472 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7473 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7474 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7475 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7480 /* Add nil, nil, nil, nil at the end. */
7482 int i
= menu_bar_items_index
;
7483 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7484 menu_bar_items_vector
=
7485 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7486 /* Add this item. */
7487 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7488 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7489 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7490 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7491 menu_bar_items_index
= i
;
7494 Vinhibit_quit
= oquit
;
7495 return menu_bar_items_vector
;
7498 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7499 If there's already an item for KEY, add this DEF to it. */
7501 Lisp_Object item_properties
;
7504 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7506 struct gcpro gcpro1
;
7510 if (EQ (item
, Qundefined
))
7512 /* If a map has an explicit `undefined' as definition,
7513 discard any previously made menu bar item. */
7515 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7516 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7518 if (menu_bar_items_index
> i
+ 4)
7519 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7520 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7521 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7522 menu_bar_items_index
-= 4;
7526 /* If this keymap has already contributed to this KEY,
7527 don't contribute to it a second time. */
7528 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7529 if (!NILP (tem
) || NILP (item
))
7532 menu_bar_one_keymap_changed_items
7533 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7535 /* We add to menu_bar_one_keymap_changed_items before doing the
7536 parse_menu_item, so that if it turns out it wasn't a menu item,
7537 it still correctly hides any further menu item. */
7539 i
= parse_menu_item (item
, 1);
7544 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7546 /* Find any existing item for this KEY. */
7547 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7548 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7551 /* If we did not find this KEY, add it at the end. */
7552 if (i
== menu_bar_items_index
)
7554 /* If vector is too small, get a bigger one. */
7555 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7556 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7557 /* Add this item. */
7558 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7559 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7560 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7561 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7562 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7563 menu_bar_items_index
= i
;
7565 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7569 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7570 /* If the new and the old items are not both keymaps,
7571 the lookup will only find `item'. */
7572 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7573 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7577 /* This is used as the handler when calling menu_item_eval_property. */
7579 menu_item_eval_property_1 (Lisp_Object arg
)
7581 /* If we got a quit from within the menu computation,
7582 quit all the way out of it. This takes care of C-] in the debugger. */
7583 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7584 Fsignal (Qquit
, Qnil
);
7590 eval_dyn (Lisp_Object form
)
7592 return Feval (form
, Qnil
);
7595 /* Evaluate an expression and return the result (or nil if something
7596 went wrong). Used to evaluate dynamic parts of menu items. */
7598 menu_item_eval_property (Lisp_Object sexpr
)
7600 int count
= SPECPDL_INDEX ();
7602 specbind (Qinhibit_redisplay
, Qt
);
7603 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7604 menu_item_eval_property_1
);
7605 return unbind_to (count
, val
);
7608 /* This function parses a menu item and leaves the result in the
7609 vector item_properties.
7610 ITEM is a key binding, a possible menu item.
7611 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7613 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7614 parse_menu_item returns true if the item is a menu item and false
7618 parse_menu_item (Lisp_Object item
, int inmenubar
)
7620 Lisp_Object def
, tem
, item_string
, start
;
7622 Lisp_Object keyhint
;
7631 /* Create item_properties vector if necessary. */
7632 if (NILP (item_properties
))
7634 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7636 /* Initialize optional entries. */
7637 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7638 ASET (item_properties
, i
, Qnil
);
7639 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7641 /* Save the item here to protect it from GC. */
7642 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7644 item_string
= XCAR (item
);
7648 if (STRINGP (item_string
))
7650 /* Old format menu item. */
7651 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7653 /* Maybe help string. */
7654 if (CONSP (item
) && STRINGP (XCAR (item
)))
7656 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7661 /* Maybe an obsolete key binding cache. */
7662 if (CONSP (item
) && CONSP (XCAR (item
))
7663 && (NILP (XCAR (XCAR (item
)))
7664 || VECTORP (XCAR (XCAR (item
)))))
7667 /* This is the real definition--the function to run. */
7668 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7670 /* Get enable property, if any. */
7673 tem
= Fget (item
, Qmenu_enable
);
7674 if (!NILP (Venable_disabled_menus_and_buttons
))
7675 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7676 else if (!NILP (tem
))
7677 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7680 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7682 /* New format menu item. */
7683 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7684 start
= XCDR (item
);
7687 /* We have a real binding. */
7688 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7690 item
= XCDR (start
);
7691 /* Is there an obsolete cache list with key equivalences. */
7692 if (CONSP (item
) && CONSP (XCAR (item
)))
7695 /* Parse properties. */
7696 while (CONSP (item
) && CONSP (XCDR (item
)))
7701 if (EQ (tem
, QCenable
))
7703 if (!NILP (Venable_disabled_menus_and_buttons
))
7704 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7706 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7708 else if (EQ (tem
, QCvisible
))
7710 /* If got a visible property and that evaluates to nil
7711 then ignore this item. */
7712 tem
= menu_item_eval_property (XCAR (item
));
7716 else if (EQ (tem
, QChelp
))
7717 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7718 else if (EQ (tem
, QCfilter
))
7720 else if (EQ (tem
, QCkey_sequence
))
7723 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7724 /* Be GC protected. Set keyhint to item instead of tem. */
7727 else if (EQ (tem
, QCkeys
))
7730 if (CONSP (tem
) || STRINGP (tem
))
7731 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7733 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7738 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7740 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7742 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7748 else if (inmenubar
|| !NILP (start
))
7752 return 0; /* not a menu item */
7754 /* If item string is not a string, evaluate it to get string.
7755 If we don't get a string, skip this item. */
7756 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7757 if (!(STRINGP (item_string
)))
7759 item_string
= menu_item_eval_property (item_string
);
7760 if (!STRINGP (item_string
))
7762 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7765 /* If got a filter apply it on definition. */
7766 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7769 def
= menu_item_eval_property (list2 (XCAR (filter
),
7770 list2 (Qquote
, def
)));
7772 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7775 /* Enable or disable selection of item. */
7776 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7779 tem
= menu_item_eval_property (tem
);
7780 if (inmenubar
&& NILP (tem
))
7781 return 0; /* Ignore disabled items in menu bar. */
7782 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7785 /* If we got no definition, this item is just unselectable text which
7786 is OK in a submenu but not in the menubar. */
7788 return (inmenubar
? 0 : 1);
7790 /* See if this is a separate pane or a submenu. */
7791 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7792 tem
= get_keymap (def
, 0, 1);
7793 /* For a subkeymap, just record its details and exit. */
7796 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7797 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7801 /* At the top level in the menu bar, do likewise for commands also.
7802 The menu bar does not display equivalent key bindings anyway.
7803 ITEM_PROPERTY_DEF is already set up properly. */
7807 { /* This is a command. See if there is an equivalent key binding. */
7808 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7810 /* The previous code preferred :key-sequence to :keys, so we
7811 preserve this behavior. */
7812 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7813 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7816 Lisp_Object prefix
= keyeq
;
7817 Lisp_Object keys
= Qnil
;
7821 def
= XCAR (prefix
);
7822 prefix
= XCDR (prefix
);
7825 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7827 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7829 keys
= XCAR (keyhint
);
7830 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7832 /* We have a suggested key. Is it bound to the command? */
7835 /* If the command is an alias for another
7836 (such as lmenu.el set it up), check if the
7837 original command matches the cached command. */
7838 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7843 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7847 tem
= Fkey_description (keys
, Qnil
);
7850 if (STRINGP (XCAR (prefix
)))
7851 tem
= concat2 (XCAR (prefix
), tem
);
7852 if (STRINGP (XCDR (prefix
)))
7853 tem
= concat2 (tem
, XCDR (prefix
));
7855 keyeq
= concat2 (build_string (" "), tem
);
7856 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7862 /* If we have an equivalent key binding, use that. */
7863 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7866 /* Include this when menu help is implemented.
7867 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7868 if (!(NILP (tem) || STRINGP (tem)))
7870 tem = menu_item_eval_property (tem);
7873 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7877 /* Handle radio buttons or toggle boxes. */
7878 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7880 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7881 menu_item_eval_property (tem
));
7888 /***********************************************************************
7890 ***********************************************************************/
7892 /* A vector holding tool bar items while they are parsed in function
7893 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7896 static Lisp_Object tool_bar_items_vector
;
7898 /* A vector holding the result of parse_tool_bar_item. Layout is like
7899 the one for a single item in tool_bar_items_vector. */
7901 static Lisp_Object tool_bar_item_properties
;
7903 /* Next free index in tool_bar_items_vector. */
7905 static int ntool_bar_items
;
7907 /* The symbols `:image' and `:rtl'. */
7909 static Lisp_Object QCimage
;
7910 static Lisp_Object Qrtl
;
7912 /* Function prototypes. */
7914 static void init_tool_bar_items (Lisp_Object
);
7915 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7916 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7917 static void append_tool_bar_item (void);
7920 /* Return a vector of tool bar items for keymaps currently in effect.
7921 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7922 tool bar items found. */
7925 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7934 /* In order to build the menus, we need to call the keymap
7935 accessors. They all call QUIT. But this function is called
7936 during redisplay, during which a quit is fatal. So inhibit
7937 quitting while building the menus. We do this instead of
7938 specbind because (1) errors will clear it anyway and (2) this
7939 avoids risk of specpdl overflow. */
7940 oquit
= Vinhibit_quit
;
7943 /* Initialize tool_bar_items_vector and protect it from GC. */
7944 init_tool_bar_items (reuse
);
7946 /* Build list of keymaps in maps. Set nmaps to the number of maps
7949 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7950 if (!NILP (Voverriding_local_map_menu_flag
))
7952 /* Yes, use them (if non-nil) as well as the global map. */
7953 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7955 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7956 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7957 if (!NILP (Voverriding_local_map
))
7958 maps
[nmaps
++] = Voverriding_local_map
;
7962 /* No, so use major and minor mode keymaps and keymap property.
7963 Note that tool-bar bindings in the local-map and keymap
7964 properties may not work reliable, as they are only
7965 recognized when the tool-bar (or mode-line) is updated,
7966 which does not normally happen after every command. */
7969 nminor
= current_minor_maps (NULL
, &tmaps
);
7970 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7972 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7973 maps
[nmaps
++] = tem
;
7974 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7976 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7979 /* Add global keymap at the end. */
7980 maps
[nmaps
++] = current_global_map
;
7982 /* Process maps in reverse order and look up in each map the prefix
7984 for (i
= nmaps
- 1; i
>= 0; --i
)
7985 if (!NILP (maps
[i
]))
7989 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7991 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7994 Vinhibit_quit
= oquit
;
7995 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7996 return tool_bar_items_vector
;
8000 /* Process the definition of KEY which is DEF. */
8003 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8006 struct gcpro gcpro1
, gcpro2
;
8008 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8012 if (EQ (def
, Qundefined
))
8014 /* If a map has an explicit `undefined' as definition,
8015 discard any previously made item. */
8016 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8018 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8020 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8022 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8023 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8024 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8025 * sizeof (Lisp_Object
)));
8026 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8031 else if (parse_tool_bar_item (key
, def
))
8032 /* Append a new tool bar item to tool_bar_items_vector. Accept
8033 more than one definition for the same key. */
8034 append_tool_bar_item ();
8040 /* Parse a tool bar item specification ITEM for key KEY and return the
8041 result in tool_bar_item_properties. Value is zero if ITEM is
8044 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8046 CAPTION is the caption of the item, If it's not a string, it is
8047 evaluated to get a string.
8049 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8050 as binding are currently ignored.
8052 The following properties are recognized:
8056 FORM is evaluated and specifies whether the tool bar item is
8057 enabled or disabled.
8061 FORM is evaluated and specifies whether the tool bar item is visible.
8063 - `:filter FUNCTION'
8065 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8066 result is stored as the new binding.
8068 - `:button (TYPE SELECTED)'
8070 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8071 and specifies whether the button is selected (pressed) or not.
8075 IMAGES is either a single image specification or a vector of four
8076 image specifications. See enum tool_bar_item_images.
8078 - `:help HELP-STRING'.
8080 Gives a help string to display for the tool bar item.
8082 - `:label LABEL-STRING'.
8084 A text label to show with the tool bar button if labels are enabled. */
8087 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8089 /* Access slot with index IDX of vector tool_bar_item_properties. */
8090 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8092 Lisp_Object filter
= Qnil
;
8093 Lisp_Object caption
;
8094 int i
, have_label
= 0;
8096 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8097 Rule out items that aren't lists, don't start with
8098 `menu-item' or whose rest following `tool-bar-item' is not a
8103 /* As an exception, allow old-style menu separators. */
8104 if (STRINGP (XCAR (item
)))
8105 item
= Fcons (XCAR (item
), Qnil
);
8106 else if (!EQ (XCAR (item
), Qmenu_item
)
8107 || (item
= XCDR (item
), !CONSP (item
)))
8110 /* Create tool_bar_item_properties vector if necessary. Reset it to
8112 if (VECTORP (tool_bar_item_properties
))
8114 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8118 tool_bar_item_properties
8119 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8122 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8123 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8125 /* Get the caption of the item. If the caption is not a string,
8126 evaluate it to get a string. If we don't get a string, skip this
8128 caption
= XCAR (item
);
8129 if (!STRINGP (caption
))
8131 caption
= menu_item_eval_property (caption
);
8132 if (!STRINGP (caption
))
8135 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8137 /* If the rest following the caption is not a list, the menu item is
8138 either a separator, or invalid. */
8142 if (menu_separator_name_p (SSDATA (caption
)))
8144 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8145 #if !defined (USE_GTK) && !defined (HAVE_NS)
8146 /* If we use build_desired_tool_bar_string to render the
8147 tool bar, the separator is rendered as an image. */
8148 PROP (TOOL_BAR_ITEM_IMAGES
)
8149 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8150 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8151 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8152 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8159 /* Store the binding. */
8160 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8163 /* Ignore cached key binding, if any. */
8164 if (CONSP (item
) && CONSP (XCAR (item
)))
8167 /* Process the rest of the properties. */
8168 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8170 Lisp_Object ikey
, value
;
8173 value
= XCAR (XCDR (item
));
8175 if (EQ (ikey
, QCenable
))
8177 /* `:enable FORM'. */
8178 if (!NILP (Venable_disabled_menus_and_buttons
))
8179 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8181 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8183 else if (EQ (ikey
, QCvisible
))
8185 /* `:visible FORM'. If got a visible property and that
8186 evaluates to nil then ignore this item. */
8187 if (NILP (menu_item_eval_property (value
)))
8190 else if (EQ (ikey
, QChelp
))
8191 /* `:help HELP-STRING'. */
8192 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8193 else if (EQ (ikey
, QCvert_only
))
8194 /* `:vert-only t/nil'. */
8195 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8196 else if (EQ (ikey
, QClabel
))
8198 const char *bad_label
= "!!?GARBLED ITEM?!!";
8199 /* `:label LABEL-STRING'. */
8200 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8202 : make_string (bad_label
, strlen (bad_label
));
8205 else if (EQ (ikey
, QCfilter
))
8206 /* ':filter FORM'. */
8208 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8210 /* `:button (TYPE . SELECTED)'. */
8211 Lisp_Object type
, selected
;
8213 type
= XCAR (value
);
8214 selected
= XCDR (value
);
8215 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8217 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8218 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8221 else if (EQ (ikey
, QCimage
)
8223 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8224 /* Value is either a single image specification or a vector
8225 of 4 such specifications for the different button states. */
8226 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8227 else if (EQ (ikey
, Qrtl
))
8229 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8235 /* Try to make one from caption and key. */
8236 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8237 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8238 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8239 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8240 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8241 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8242 Lisp_Object new_lbl
;
8243 size_t caption_len
= strlen (capt
);
8245 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8248 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8250 buf
[caption_len
] = '\0';
8254 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8258 strcpy (buf
, label
);
8260 for (j
= 0; buf
[j
] != '\0'; ++j
)
8268 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8269 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8270 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8272 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8276 /* If got a filter apply it on binding. */
8278 PROP (TOOL_BAR_ITEM_BINDING
)
8279 = menu_item_eval_property (list2 (filter
,
8281 PROP (TOOL_BAR_ITEM_BINDING
))));
8283 /* See if the binding is a keymap. Give up if it is. */
8284 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8287 /* Enable or disable selection of item. */
8288 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8289 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8290 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8292 /* Handle radio buttons or toggle boxes. */
8293 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8294 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8295 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8303 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8304 that can be reused. */
8307 init_tool_bar_items (Lisp_Object reuse
)
8309 if (VECTORP (reuse
))
8310 tool_bar_items_vector
= reuse
;
8312 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8313 ntool_bar_items
= 0;
8317 /* Append parsed tool bar item properties from
8318 tool_bar_item_properties */
8321 append_tool_bar_item (void)
8323 Lisp_Object
*to
, *from
;
8325 /* Enlarge tool_bar_items_vector if necessary. */
8326 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8327 >= XVECTOR (tool_bar_items_vector
)->size
)
8328 tool_bar_items_vector
8329 = larger_vector (tool_bar_items_vector
,
8330 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8332 /* Append entries from tool_bar_item_properties to the end of
8333 tool_bar_items_vector. */
8334 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8335 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8336 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8337 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8344 /* Read a character using menus based on maps in the array MAPS.
8345 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8346 Return t if we displayed a menu but the user rejected it.
8348 PREV_EVENT is the previous input event, or nil if we are reading
8349 the first event of a key sequence.
8351 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8352 if we used a mouse menu to read the input, or zero otherwise. If
8353 USED_MOUSE_MENU is null, we don't dereference it.
8355 The prompting is done based on the prompt-string of the map
8356 and the strings associated with various map elements.
8358 This can be done with X menus or with menus put in the minibuf.
8359 These are done in different ways, depending on how the input will be read.
8360 Menus using X are done after auto-saving in read-char, getting the input
8361 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8362 and do auto-saving in the inner call of read_char. */
8365 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8366 int *used_mouse_menu
)
8370 if (used_mouse_menu
)
8371 *used_mouse_menu
= 0;
8373 /* Use local over global Menu maps */
8375 if (! menu_prompting
)
8378 /* Optionally disregard all but the global map. */
8379 if (inhibit_local_menu_bar_menus
)
8381 maps
+= (nmaps
- 1);
8386 /* If we got to this point via a mouse click,
8387 use a real menu for mouse selection. */
8388 if (EVENT_HAS_PARAMETERS (prev_event
)
8389 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8390 && !EQ (XCAR (prev_event
), Qtool_bar
))
8392 /* Display the menu and get the selection. */
8393 Lisp_Object
*realmaps
8394 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8398 /* Use the maps that are not nil. */
8399 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8400 if (!NILP (maps
[mapno
]))
8401 realmaps
[nmaps1
++] = maps
[mapno
];
8403 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8408 record_menu_key (XCAR (value
));
8410 /* If we got multiple events, unread all but
8412 There is no way to prevent those unread events
8413 from showing up later in last_nonmenu_event.
8414 So turn symbol and integer events into lists,
8415 to indicate that they came from a mouse menu,
8416 so that when present in last_nonmenu_event
8417 they won't confuse things. */
8418 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8420 record_menu_key (XCAR (tem
));
8421 if (SYMBOLP (XCAR (tem
))
8422 || INTEGERP (XCAR (tem
)))
8423 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8426 /* If we got more than one event, put all but the first
8427 onto this list to be read later.
8428 Return just the first event now. */
8429 Vunread_command_events
8430 = nconc2 (XCDR (value
), Vunread_command_events
);
8431 value
= XCAR (value
);
8433 else if (NILP (value
))
8435 if (used_mouse_menu
)
8436 *used_mouse_menu
= 1;
8439 #endif /* HAVE_MENUS */
8443 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8444 We make this bigger when necessary, and never free it. */
8445 static char *read_char_minibuf_menu_text
;
8446 /* Size of that buffer. */
8447 static int read_char_minibuf_menu_width
;
8450 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8453 register Lisp_Object name
;
8455 /* FIXME: Use the minibuffer's frame width. */
8456 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8459 Lisp_Object rest
, vector
;
8465 if (! menu_prompting
)
8468 /* Get the menu name from the first map that has one (a prompt string). */
8469 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8471 name
= Fkeymap_prompt (maps
[mapno
]);
8476 /* If we don't have any menus, just read a character normally. */
8477 if (!STRINGP (name
))
8480 /* Make sure we have a big enough buffer for the menu text. */
8481 width
= max (width
, SBYTES (name
));
8482 if (read_char_minibuf_menu_text
== 0)
8484 read_char_minibuf_menu_width
= width
+ 4;
8485 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8487 else if (width
+ 4 > read_char_minibuf_menu_width
)
8489 read_char_minibuf_menu_width
= width
+ 4;
8490 read_char_minibuf_menu_text
8491 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8493 menu
= read_char_minibuf_menu_text
;
8495 /* Prompt string always starts with map's prompt, and a space. */
8496 strcpy (menu
, SSDATA (name
));
8497 nlength
= SBYTES (name
);
8498 menu
[nlength
++] = ':';
8499 menu
[nlength
++] = ' ';
8502 /* Start prompting at start of first map. */
8506 /* Present the documented bindings, a line at a time. */
8512 Lisp_Object orig_defn_macro
;
8514 /* Loop over elements of map. */
8519 /* If reached end of map, start at beginning of next map. */
8523 /* At end of last map, wrap around to first map if just starting,
8524 or end this line if already have something on it. */
8528 if (notfirst
|| nobindings
) break;
8533 /* Look at the next element of the map. */
8535 elt
= XVECTOR (vector
)->contents
[idx
];
8537 elt
= Fcar_safe (rest
);
8539 if (idx
< 0 && VECTORP (elt
))
8541 /* If we found a dense table in the keymap,
8542 advanced past it, but start scanning its contents. */
8543 rest
= Fcdr_safe (rest
);
8549 /* An ordinary element. */
8550 Lisp_Object event
, tem
;
8554 event
= Fcar_safe (elt
); /* alist */
8555 elt
= Fcdr_safe (elt
);
8559 XSETINT (event
, idx
); /* vector */
8562 /* Ignore the element if it has no prompt string. */
8563 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8565 /* 1 if the char to type matches the string. */
8567 Lisp_Object upcased_event
, downcased_event
;
8568 Lisp_Object desc
= Qnil
;
8570 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8572 upcased_event
= Fupcase (event
);
8573 downcased_event
= Fdowncase (event
);
8574 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8575 || XINT (downcased_event
) == SREF (s
, 0));
8577 desc
= Fsingle_key_description (event
, Qnil
);
8579 #if 0 /* It is redundant to list the equivalent key bindings because
8580 the prefix is what the user has already typed. */
8582 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8584 /* Insert equivalent keybinding. */
8585 s
= concat2 (s
, tem
);
8588 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8589 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8591 /* Insert button prefix. */
8592 Lisp_Object selected
8593 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8594 if (EQ (tem
, QCradio
))
8595 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8597 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8598 s
= concat2 (tem
, s
);
8602 /* If we have room for the prompt string, add it to this line.
8603 If this is the first on the line, always add it. */
8604 if ((SCHARS (s
) + i
+ 2
8605 + (char_matches
? 0 : SCHARS (desc
) + 3))
8611 /* Punctuate between strings. */
8614 strcpy (menu
+ i
, ", ");
8620 /* If the char to type doesn't match the string's
8621 first char, explicitly show what char to type. */
8624 /* Add as much of string as fits. */
8625 thiswidth
= SCHARS (desc
);
8626 if (thiswidth
+ i
> width
)
8627 thiswidth
= width
- i
;
8628 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8630 strcpy (menu
+ i
, " = ");
8634 /* Add as much of string as fits. */
8635 thiswidth
= SCHARS (s
);
8636 if (thiswidth
+ i
> width
)
8637 thiswidth
= width
- i
;
8638 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8644 /* If this element does not fit, end the line now,
8645 and save the element for the next line. */
8646 strcpy (menu
+ i
, "...");
8651 /* Move past this element. */
8652 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8653 /* Handle reaching end of dense table. */
8658 rest
= Fcdr_safe (rest
);
8662 /* Prompt with that and read response. */
8663 message2_nolog (menu
, strlen (menu
),
8664 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8666 /* Make believe its not a keyboard macro in case the help char
8667 is pressed. Help characters are not recorded because menu prompting
8668 is not used on replay.
8670 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8671 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8673 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8674 while (BUFFERP (obj
));
8675 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8677 if (!INTEGERP (obj
))
8679 else if (XINT (obj
) == -2)
8682 if (! EQ (obj
, menu_prompt_more_char
)
8683 && (!INTEGERP (menu_prompt_more_char
)
8684 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8686 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8687 store_kbd_macro_char (obj
);
8690 /* Help char - go round again */
8694 /* Reading key sequences. */
8696 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8697 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8698 keymap, or nil otherwise. Return the index of the first keymap in
8699 which KEY has any binding, or NMAPS if no map has a binding.
8701 If KEY is a meta ASCII character, treat it like meta-prefix-char
8702 followed by the corresponding non-meta character. Keymaps in
8703 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8706 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8709 NEXT may be the same array as CURRENT. */
8712 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8715 int i
, first_binding
;
8717 first_binding
= nmaps
;
8718 for (i
= nmaps
- 1; i
>= 0; i
--)
8720 if (! NILP (current
[i
]))
8722 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8723 if (! NILP (defs
[i
]))
8730 /* Given the set of bindings we've found, produce the next set of maps. */
8731 if (first_binding
< nmaps
)
8732 for (i
= 0; i
< nmaps
; i
++)
8733 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8735 return first_binding
;
8738 /* Structure used to keep track of partial application of key remapping
8739 such as Vfunction_key_map and Vkey_translation_map. */
8740 typedef struct keyremap
8742 /* This is the map originally specified for this use. */
8744 /* This is a submap reached by looking up, in PARENT,
8745 the events from START to END. */
8747 /* Positions [START, END) in the key sequence buffer
8748 are the key that we have scanned so far.
8749 Those events are the ones that we will replace
8750 if PAREHT maps them into a key sequence. */
8754 /* Lookup KEY in MAP.
8755 MAP is a keymap mapping keys to key vectors or functions.
8756 If the mapping is a function and DO_FUNCTION is non-zero, then
8757 the function is called with PROMPT as parameter and its return
8758 value is used as the return value of this function (after checking
8759 that it is indeed a vector). */
8762 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8767 next
= access_keymap (map
, key
, 1, 0, 1);
8769 /* Handle symbol with autoload definition. */
8770 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8771 && CONSP (XSYMBOL (next
)->function
)
8772 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8773 do_autoload (XSYMBOL (next
)->function
, next
);
8775 /* Handle a symbol whose function definition is a keymap
8777 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8778 && (ARRAYP (XSYMBOL (next
)->function
)
8779 || KEYMAPP (XSYMBOL (next
)->function
)))
8780 next
= XSYMBOL (next
)->function
;
8782 /* If the keymap gives a function, not an
8783 array, then call the function with one arg and use
8784 its value instead. */
8785 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8790 next
= call1 (next
, prompt
);
8791 /* If the function returned something invalid,
8792 barf--don't ignore it.
8793 (To ignore it safely, we would need to gcpro a bunch of
8794 other variables.) */
8795 if (! (VECTORP (next
) || STRINGP (next
)))
8796 error ("Function %s returns invalid key sequence",
8797 SSDATA (SYMBOL_NAME (tem
)));
8802 /* Do one step of the key remapping used for function-key-map and
8803 key-translation-map:
8804 KEYBUF is the buffer holding the input events.
8805 BUFSIZE is its maximum size.
8806 FKEY is a pointer to the keyremap structure to use.
8807 INPUT is the index of the last element in KEYBUF.
8808 DOIT if non-zero says that the remapping can actually take place.
8809 DIFF is used to return the number of keys added/removed by the remapping.
8810 PARENT is the root of the keymap.
8811 PROMPT is the prompt to use if the remapping happens through a function.
8812 The return value is non-zero if the remapping actually took place. */
8815 keyremap_step (Lisp_Object
*keybuf
, size_t bufsize
, volatile keyremap
*fkey
,
8816 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8818 Lisp_Object next
, key
;
8820 key
= keybuf
[fkey
->end
++];
8822 if (KEYMAPP (fkey
->parent
))
8823 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8827 /* If keybuf[fkey->start..fkey->end] is bound in the
8828 map and we're in a position to do the key remapping, replace it with
8829 the binding and restart with fkey->start at the end. */
8830 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8832 int len
= XFASTINT (Flength (next
));
8835 *diff
= len
- (fkey
->end
- fkey
->start
);
8837 if (input
+ *diff
>= bufsize
)
8838 error ("Key sequence too long");
8840 /* Shift the keys that follow fkey->end. */
8842 for (i
= fkey
->end
; i
< input
; i
++)
8843 keybuf
[i
+ *diff
] = keybuf
[i
];
8845 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8846 keybuf
[i
+ *diff
] = keybuf
[i
];
8847 /* Overwrite the old keys with the new ones. */
8848 for (i
= 0; i
< len
; i
++)
8849 keybuf
[fkey
->start
+ i
]
8850 = Faref (next
, make_number (i
));
8852 fkey
->start
= fkey
->end
+= *diff
;
8853 fkey
->map
= fkey
->parent
;
8858 fkey
->map
= get_keymap (next
, 0, 1);
8860 /* If we no longer have a bound suffix, try a new position for
8862 if (!CONSP (fkey
->map
))
8864 fkey
->end
= ++fkey
->start
;
8865 fkey
->map
= fkey
->parent
;
8870 /* Read a sequence of keys that ends with a non prefix character,
8871 storing it in KEYBUF, a buffer of size BUFSIZE.
8873 Return the length of the key sequence stored.
8874 Return -1 if the user rejected a command menu.
8876 Echo starting immediately unless `prompt' is 0.
8878 Where a key sequence ends depends on the currently active keymaps.
8879 These include any minor mode keymaps active in the current buffer,
8880 the current buffer's local map, and the global map.
8882 If a key sequence has no other bindings, we check Vfunction_key_map
8883 to see if some trailing subsequence might be the beginning of a
8884 function key's sequence. If so, we try to read the whole function
8885 key, and substitute its symbolic name into the key sequence.
8887 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8888 `double-' events into similar click events, if that would make them
8889 bound. We try to turn `triple-' events first into `double-' events,
8892 If we get a mouse click in a mode line, vertical divider, or other
8893 non-text area, we treat the click as if it were prefixed by the
8894 symbol denoting that area - `mode-line', `vertical-line', or
8897 If the sequence starts with a mouse click, we read the key sequence
8898 with respect to the buffer clicked on, not the current buffer.
8900 If the user switches frames in the midst of a key sequence, we put
8901 off the switch-frame event until later; the next call to
8902 read_char will return it.
8904 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8905 from the selected window's buffer. */
8908 read_key_sequence (Lisp_Object
*keybuf
, size_t bufsize
, Lisp_Object prompt
,
8909 int dont_downcase_last
, int can_return_switch_frame
,
8910 int fix_current_buffer
)
8912 Lisp_Object from_string
;
8913 int count
= SPECPDL_INDEX ();
8915 /* How many keys there are in the current key sequence. */
8918 /* The length of the echo buffer when we started reading, and
8919 the length of this_command_keys when we started reading. */
8920 int echo_start
IF_LINT (= 0);
8923 /* The number of keymaps we're scanning right now, and the number of
8924 keymaps we have allocated space for. */
8926 int nmaps_allocated
= 0;
8928 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8929 the current keymaps. */
8930 Lisp_Object
*defs
= NULL
;
8932 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8933 in the current keymaps, or nil where it is not a prefix. */
8934 Lisp_Object
*submaps
= NULL
;
8936 /* The local map to start out with at start of key sequence. */
8937 Lisp_Object orig_local_map
;
8939 /* The map from the `keymap' property to start out with at start of
8941 Lisp_Object orig_keymap
;
8943 /* 1 if we have already considered switching to the local-map property
8944 of the place where a mouse click occurred. */
8945 int localized_local_map
= 0;
8947 /* The index in submaps[] of the first keymap that has a binding for
8948 this key sequence. In other words, the lowest i such that
8949 submaps[i] is non-nil. */
8951 /* Index of the first key that has no binding.
8952 It is useless to try fkey.start larger than that. */
8955 /* If t < mock_input, then KEYBUF[t] should be read as the next
8958 We use this to recover after recognizing a function key. Once we
8959 realize that a suffix of the current key sequence is actually a
8960 function key's escape sequence, we replace the suffix with the
8961 function key's binding from Vfunction_key_map. Now keybuf
8962 contains a new and different key sequence, so the echo area,
8963 this_command_keys, and the submaps and defs arrays are wrong. In
8964 this situation, we set mock_input to t, set t to 0, and jump to
8965 restart_sequence; the loop will read keys from keybuf up until
8966 mock_input, thus rebuilding the state; and then it will resume
8967 reading characters from the keyboard. */
8970 /* If the sequence is unbound in submaps[], then
8971 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8972 and fkey.map is its binding.
8974 These might be > t, indicating that all function key scanning
8975 should hold off until t reaches them. We do this when we've just
8976 recognized a function key, to avoid searching for the function
8977 key's again in Vfunction_key_map. */
8980 /* Likewise, for key_translation_map and input-decode-map. */
8981 keyremap keytran
, indec
;
8983 /* Non-zero if we are trying to map a key by changing an upper-case
8984 letter to lower case, or a shifted function key to an unshifted
8986 int shift_translated
= 0;
8988 /* If we receive a `switch-frame' or `select-window' event in the middle of
8989 a key sequence, we put it off for later.
8990 While we're reading, we keep the event here. */
8991 Lisp_Object delayed_switch_frame
;
8993 /* See the comment below... */
8994 #if defined (GOBBLE_FIRST_EVENT)
8995 Lisp_Object first_event
;
8998 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8999 int original_uppercase_position
= -1;
9001 /* Gets around Microsoft compiler limitations. */
9004 struct buffer
*starting_buffer
;
9006 /* List of events for which a fake prefix key has been generated. */
9007 Lisp_Object fake_prefixed_keys
= Qnil
;
9009 #if defined (GOBBLE_FIRST_EVENT)
9013 struct gcpro outer_gcpro1
;
9015 GCPRO1_VAR (fake_prefixed_keys
, outer_gcpro
);
9016 raw_keybuf_count
= 0;
9018 last_nonmenu_event
= Qnil
;
9020 delayed_switch_frame
= Qnil
;
9026 /* Install the string STR as the beginning of the string of
9027 echoing, so that it serves as a prompt for the next
9029 KVAR (current_kboard
, echo_string
) = prompt
;
9030 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9033 else if (cursor_in_echo_area
9034 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9035 && NILP (Fzerop (Vecho_keystrokes
)))
9036 /* This doesn't put in a dash if the echo buffer is empty, so
9037 you don't always see a dash hanging out in the minibuffer. */
9041 /* Record the initial state of the echo area and this_command_keys;
9042 we will need to restore them if we replay a key sequence. */
9044 echo_start
= echo_length ();
9045 keys_start
= this_command_key_count
;
9046 this_single_command_key_start
= keys_start
;
9048 #if defined (GOBBLE_FIRST_EVENT)
9049 /* This doesn't quite work, because some of the things that read_char
9050 does cannot safely be bypassed. It seems too risky to try to make
9053 /* Read the first char of the sequence specially, before setting
9054 up any keymaps, in case a filter runs and switches buffers on us. */
9055 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9057 #endif /* GOBBLE_FIRST_EVENT */
9059 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9060 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9063 /* We jump here when we need to reinitialize fkey and keytran; this
9064 happens if we switch keyboards between rescans. */
9065 replay_entire_sequence
:
9067 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9068 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9069 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9070 indec
.start
= indec
.end
= 0;
9071 fkey
.start
= fkey
.end
= 0;
9072 keytran
.start
= keytran
.end
= 0;
9074 /* We jump here when the key sequence has been thoroughly changed, and
9075 we need to rescan it starting from the beginning. When we jump here,
9076 keybuf[0..mock_input] holds the sequence we should reread. */
9079 starting_buffer
= current_buffer
;
9080 first_unbound
= bufsize
+ 1;
9082 /* Build our list of keymaps.
9083 If we recognize a function key and replace its escape sequence in
9084 keybuf with its symbol, or if the sequence starts with a mouse
9085 click and we need to switch buffers, we jump back here to rebuild
9086 the initial keymaps from the current buffer. */
9089 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9091 if (2 > nmaps_allocated
)
9093 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9094 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9095 nmaps_allocated
= 2;
9097 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9099 else if (!NILP (Voverriding_local_map
))
9101 if (2 > nmaps_allocated
)
9103 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9104 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9105 nmaps_allocated
= 2;
9107 submaps
[nmaps
++] = Voverriding_local_map
;
9115 nminor
= current_minor_maps (0, &maps
);
9116 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9118 if (total
> nmaps_allocated
)
9120 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9121 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9122 nmaps_allocated
= total
;
9125 if (!NILP (orig_keymap
))
9126 submaps
[nmaps
++] = orig_keymap
;
9128 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9132 submaps
[nmaps
++] = orig_local_map
;
9134 submaps
[nmaps
++] = current_global_map
;
9136 /* Find an accurate initial value for first_binding. */
9137 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9138 if (! NILP (submaps
[first_binding
]))
9141 /* Start from the beginning in keybuf. */
9144 /* These are no-ops the first time through, but if we restart, they
9145 revert the echo area and this_command_keys to their original state. */
9146 this_command_key_count
= keys_start
;
9147 if (INTERACTIVE
&& t
< mock_input
)
9148 echo_truncate (echo_start
);
9150 /* If the best binding for the current key sequence is a keymap, or
9151 we may be looking at a function key's escape sequence, keep on
9153 while (first_binding
< nmaps
9154 /* Keep reading as long as there's a prefix binding. */
9155 ? !NILP (submaps
[first_binding
])
9156 /* Don't return in the middle of a possible function key sequence,
9157 if the only bindings we found were via case conversion.
9158 Thus, if ESC O a has a function-key-map translation
9159 and ESC o has a binding, don't return after ESC O,
9160 so that we can translate ESC O plus the next character. */
9161 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9164 int used_mouse_menu
= 0;
9166 /* Where the last real key started. If we need to throw away a
9167 key that has expanded into more than one element of keybuf
9168 (say, a mouse click on the mode line which is being treated
9169 as [mode-line (mouse-...)], then we backtrack to this point
9171 int last_real_key_start
;
9173 /* These variables are analogous to echo_start and keys_start;
9174 while those allow us to restart the entire key sequence,
9175 echo_local_start and keys_local_start allow us to throw away
9177 int echo_local_start
IF_LINT (= 0);
9178 int keys_local_start
, local_first_binding
;
9180 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9181 eassert (indec
.start
<= indec
.end
);
9182 eassert (fkey
.start
<= fkey
.end
);
9183 eassert (keytran
.start
<= keytran
.end
);
9184 /* key-translation-map is applied *after* function-key-map
9185 which is itself applied *after* input-decode-map. */
9186 eassert (fkey
.end
<= indec
.start
);
9187 eassert (keytran
.end
<= fkey
.start
);
9189 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9190 first_unbound
< keytran
.start
)
9191 { /* The prefix upto first_unbound has no binding and has
9192 no translation left to do either, so we know it's unbound.
9193 If we don't stop now, we risk staying here indefinitely
9194 (if the user keeps entering fkey or keytran prefixes
9195 like C-c ESC ESC ESC ESC ...) */
9197 for (i
= first_unbound
+ 1; i
< t
; i
++)
9198 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9199 mock_input
= t
- first_unbound
- 1;
9200 indec
.end
= indec
.start
-= first_unbound
+ 1;
9201 indec
.map
= indec
.parent
;
9202 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9203 fkey
.map
= fkey
.parent
;
9204 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9205 keytran
.map
= keytran
.parent
;
9206 goto replay_sequence
;
9210 error ("Key sequence too long");
9213 echo_local_start
= echo_length ();
9214 keys_local_start
= this_command_key_count
;
9215 local_first_binding
= first_binding
;
9218 /* These are no-ops, unless we throw away a keystroke below and
9219 jumped back up to replay_key; in that case, these restore the
9220 variables to their original state, allowing us to replay the
9222 if (INTERACTIVE
&& t
< mock_input
)
9223 echo_truncate (echo_local_start
);
9224 this_command_key_count
= keys_local_start
;
9225 first_binding
= local_first_binding
;
9227 /* By default, assume each event is "real". */
9228 last_real_key_start
= t
;
9230 /* Does mock_input indicate that we are re-reading a key sequence? */
9234 add_command_key (key
);
9235 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9236 && NILP (Fzerop (Vecho_keystrokes
)))
9240 /* If not, we should actually read a character. */
9244 KBOARD
*interrupted_kboard
= current_kboard
;
9245 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9246 key
= read_char (NILP (prompt
), nmaps
,
9247 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9248 &used_mouse_menu
, NULL
);
9249 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9250 /* When switching to a new tty (with a new keyboard),
9251 read_char returns the new buffer, rather than -2
9252 (Bug#5095). This is because `terminal-init-xterm'
9253 calls read-char, which eats the wrong_kboard_jmpbuf
9254 return. Any better way to fix this? -- cyd */
9255 || (interrupted_kboard
!= current_kboard
))
9260 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9261 if (k
== interrupted_kboard
)
9266 /* Don't touch interrupted_kboard when it's been
9268 delayed_switch_frame
= Qnil
;
9269 goto replay_entire_sequence
;
9272 if (!NILP (delayed_switch_frame
))
9274 KVAR (interrupted_kboard
, kbd_queue
)
9275 = Fcons (delayed_switch_frame
,
9276 KVAR (interrupted_kboard
, kbd_queue
));
9277 delayed_switch_frame
= Qnil
;
9281 KVAR (interrupted_kboard
, kbd_queue
)
9282 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9284 /* If the side queue is non-empty, ensure it begins with a
9285 switch-frame, so we'll replay it in the right context. */
9286 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9287 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9288 !(EVENT_HAS_PARAMETERS (key
)
9289 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9293 XSETFRAME (frame
, interrupted_frame
);
9294 KVAR (interrupted_kboard
, kbd_queue
)
9295 = Fcons (make_lispy_switch_frame (frame
),
9296 KVAR (interrupted_kboard
, kbd_queue
));
9299 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9300 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9301 goto replay_entire_sequence
;
9305 /* read_char returns t when it shows a menu and the user rejects it.
9309 unbind_to (count
, Qnil
);
9310 UNGCPRO_VAR (outer_gcpro
);
9314 /* read_char returns -1 at the end of a macro.
9315 Emacs 18 handles this by returning immediately with a
9316 zero, so that's what we'll do. */
9317 if (INTEGERP (key
) && XINT (key
) == -1)
9320 /* The Microsoft C compiler can't handle the goto that
9326 /* If the current buffer has been changed from under us, the
9327 keymap may have changed, so replay the sequence. */
9330 timer_resume_idle ();
9333 /* Reset the current buffer from the selected window
9334 in case something changed the former and not the latter.
9335 This is to be more consistent with the behavior
9336 of the command_loop_1. */
9337 if (fix_current_buffer
)
9339 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9341 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9342 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9345 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9346 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9347 goto replay_sequence
;
9350 /* If we have a quit that was typed in another frame, and
9351 quit_throw_to_read_char switched buffers,
9352 replay to get the right keymap. */
9354 && XINT (key
) == quit_char
9355 && current_buffer
!= starting_buffer
)
9358 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9362 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9363 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9364 goto replay_sequence
;
9369 if (EVENT_HAS_PARAMETERS (key
)
9370 /* Either a `switch-frame' or a `select-window' event. */
9371 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9373 /* If we're at the beginning of a key sequence, and the caller
9374 says it's okay, go ahead and return this event. If we're
9375 in the midst of a key sequence, delay it until the end. */
9376 if (t
> 0 || !can_return_switch_frame
)
9378 delayed_switch_frame
= key
;
9384 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9388 /* Clicks in non-text areas get prefixed by the symbol
9389 in their CHAR-ADDRESS field. For example, a click on
9390 the mode line is prefixed by the symbol `mode-line'.
9392 Furthermore, key sequences beginning with mouse clicks
9393 are read using the keymaps of the buffer clicked on, not
9394 the current buffer. So we may have to switch the buffer
9397 When we turn one event into two events, we must make sure
9398 that neither of the two looks like the original--so that,
9399 if we replay the events, they won't be expanded again.
9400 If not for this, such reexpansion could happen either here
9401 or when user programs play with this-command-keys. */
9402 if (EVENT_HAS_PARAMETERS (key
))
9407 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9408 if (EQ (kind
, Qmouse_click
))
9410 Lisp_Object window
, posn
;
9412 window
= POSN_WINDOW (EVENT_START (key
));
9413 posn
= POSN_POSN (EVENT_START (key
));
9416 || (!NILP (fake_prefixed_keys
)
9417 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9419 /* We're looking a second time at an event for which
9420 we generated a fake prefix key. Set
9421 last_real_key_start appropriately. */
9423 last_real_key_start
= t
- 1;
9426 if (last_real_key_start
== 0)
9428 /* Key sequences beginning with mouse clicks are
9429 read using the keymaps in the buffer clicked on,
9430 not the current buffer. If we're at the
9431 beginning of a key sequence, switch buffers. */
9432 if (WINDOWP (window
)
9433 && BUFFERP (XWINDOW (window
)->buffer
)
9434 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9436 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9440 /* Arrange to go back to the original buffer once we're
9441 done reading the key sequence. Note that we can't
9442 use save_excursion_{save,restore} here, because they
9443 save point as well as the current buffer; we don't
9444 want to save point, because redisplay may change it,
9445 to accommodate a Fset_window_start or something. We
9446 don't want to do this at the top of the function,
9447 because we may get input from a subprocess which
9448 wants to change the selected window and stuff (say,
9450 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9452 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9454 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9455 orig_local_map
= get_local_map (PT
, current_buffer
,
9457 orig_keymap
= get_local_map (PT
, current_buffer
,
9459 goto replay_sequence
;
9462 /* For a mouse click, get the local text-property keymap
9463 of the place clicked on, rather than point. */
9464 if (CONSP (XCDR (key
))
9465 && ! localized_local_map
)
9467 Lisp_Object map_here
, start
, pos
;
9469 localized_local_map
= 1;
9470 start
= EVENT_START (key
);
9472 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9474 pos
= POSN_BUFFER_POSN (start
);
9476 && XINT (pos
) >= BEGV
9477 && XINT (pos
) <= ZV
)
9479 map_here
= get_local_map (XINT (pos
),
9482 if (!EQ (map_here
, orig_local_map
))
9484 orig_local_map
= map_here
;
9485 ++localized_local_map
;
9488 map_here
= get_local_map (XINT (pos
),
9491 if (!EQ (map_here
, orig_keymap
))
9493 orig_keymap
= map_here
;
9494 ++localized_local_map
;
9497 if (localized_local_map
> 1)
9502 goto replay_sequence
;
9509 /* Expand mode-line and scroll-bar events into two events:
9510 use posn as a fake prefix key. */
9512 && (NILP (fake_prefixed_keys
)
9513 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9515 if (t
+ 1 >= bufsize
)
9516 error ("Key sequence too long");
9519 keybuf
[t
+ 1] = key
;
9522 /* Record that a fake prefix key has been generated
9523 for KEY. Don't modify the event; this would
9524 prevent proper action when the event is pushed
9525 back into unread-command-events. */
9526 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9528 /* If on a mode line string with a local keymap,
9529 reconsider the key sequence with that keymap. */
9530 if (string
= POSN_STRING (EVENT_START (key
)),
9531 (CONSP (string
) && STRINGP (XCAR (string
))))
9533 Lisp_Object pos
, map
, map2
;
9535 pos
= XCDR (string
);
9536 string
= XCAR (string
);
9538 && XINT (pos
) < SCHARS (string
))
9540 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9542 orig_local_map
= map
;
9543 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9546 if (!NILP (map
) || !NILP (map2
))
9547 goto replay_sequence
;
9553 else if (NILP (from_string
)
9554 && (string
= POSN_STRING (EVENT_START (key
)),
9555 (CONSP (string
) && STRINGP (XCAR (string
)))))
9557 /* For a click on a string, i.e. overlay string or a
9558 string displayed via the `display' property,
9559 consider `local-map' and `keymap' properties of
9561 Lisp_Object pos
, map
, map2
;
9563 pos
= XCDR (string
);
9564 string
= XCAR (string
);
9566 && XINT (pos
) < SCHARS (string
))
9568 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9570 orig_local_map
= map
;
9571 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9575 if (!NILP (map
) || !NILP (map2
))
9577 from_string
= string
;
9580 goto replay_sequence
;
9585 else if (CONSP (XCDR (key
))
9586 && CONSP (EVENT_START (key
))
9587 && CONSP (XCDR (EVENT_START (key
))))
9591 posn
= POSN_POSN (EVENT_START (key
));
9592 /* Handle menu-bar events:
9593 insert the dummy prefix event `menu-bar'. */
9594 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9596 if (t
+ 1 >= bufsize
)
9597 error ("Key sequence too long");
9601 /* Zap the position in key, so we know that we've
9602 expanded it, and don't try to do so again. */
9603 POSN_SET_POSN (EVENT_START (key
),
9604 Fcons (posn
, Qnil
));
9607 goto replay_sequence
;
9609 else if (CONSP (posn
))
9611 /* We're looking at the second event of a
9612 sequence which we expanded before. Set
9613 last_real_key_start appropriately. */
9614 if (last_real_key_start
== t
&& t
> 0)
9615 last_real_key_start
= t
- 1;
9620 /* We have finally decided that KEY is something we might want
9622 first_binding
= (follow_key (key
,
9623 nmaps
- first_binding
,
9624 submaps
+ first_binding
,
9625 defs
+ first_binding
,
9626 submaps
+ first_binding
)
9629 /* If KEY wasn't bound, we'll try some fallbacks. */
9630 if (first_binding
< nmaps
)
9631 /* This is needed for the following scenario:
9632 event 0: a down-event that gets dropped by calling replay_key.
9633 event 1: some normal prefix like C-h.
9634 After event 0, first_unbound is 0, after event 1 indec.start,
9635 fkey.start, and keytran.start are all 1, so when we see that
9636 C-h is bound, we need to update first_unbound. */
9637 first_unbound
= max (t
+ 1, first_unbound
);
9642 /* Remember the position to put an upper bound on indec.start. */
9643 first_unbound
= min (t
, first_unbound
);
9645 head
= EVENT_HEAD (key
);
9646 if (help_char_p (head
) && t
> 0)
9648 read_key_sequence_cmd
= Vprefix_help_command
;
9650 last_nonmenu_event
= key
;
9651 /* The Microsoft C compiler can't handle the goto that
9659 Lisp_Object breakdown
;
9662 breakdown
= parse_modifiers (head
);
9663 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9664 /* Attempt to reduce an unbound mouse event to a simpler
9665 event that is bound:
9666 Drags reduce to clicks.
9667 Double-clicks reduce to clicks.
9668 Triple-clicks reduce to double-clicks, then to clicks.
9669 Down-clicks are eliminated.
9670 Double-downs reduce to downs, then are eliminated.
9671 Triple-downs reduce to double-downs, then to downs,
9672 then are eliminated. */
9673 if (modifiers
& (down_modifier
| drag_modifier
9674 | double_modifier
| triple_modifier
))
9676 while (modifiers
& (down_modifier
| drag_modifier
9677 | double_modifier
| triple_modifier
))
9679 Lisp_Object new_head
, new_click
;
9680 if (modifiers
& triple_modifier
)
9681 modifiers
^= (double_modifier
| triple_modifier
);
9682 else if (modifiers
& double_modifier
)
9683 modifiers
&= ~double_modifier
;
9684 else if (modifiers
& drag_modifier
)
9685 modifiers
&= ~drag_modifier
;
9688 /* Dispose of this `down' event by simply jumping
9689 back to replay_key, to get another event.
9691 Note that if this event came from mock input,
9692 then just jumping back to replay_key will just
9693 hand it to us again. So we have to wipe out any
9696 We could delete keybuf[t] and shift everything
9697 after that to the left by one spot, but we'd also
9698 have to fix up any variable that points into
9699 keybuf, and shifting isn't really necessary
9702 Adding prefixes for non-textual mouse clicks
9703 creates two characters of mock input, and both
9704 must be thrown away. If we're only looking at
9705 the prefix now, we can just jump back to
9706 replay_key. On the other hand, if we've already
9707 processed the prefix, and now the actual click
9708 itself is giving us trouble, then we've lost the
9709 state of the keymaps we want to backtrack to, and
9710 we need to replay the whole sequence to rebuild
9713 Beyond that, only function key expansion could
9714 create more than two keys, but that should never
9715 generate mouse events, so it's okay to zero
9716 mock_input in that case too.
9718 FIXME: The above paragraph seems just plain
9719 wrong, if you consider things like
9720 xterm-mouse-mode. -stef
9722 Isn't this just the most wonderful code ever? */
9724 /* If mock_input > t + 1, the above simplification
9725 will actually end up dropping keys on the floor.
9726 This is probably OK for now, but even
9727 if mock_input <= t + 1, we need to adjust indec,
9729 Typical case [header-line down-mouse-N]:
9730 mock_input = 2, t = 1, fkey.end = 1,
9731 last_real_key_start = 0. */
9732 if (indec
.end
> last_real_key_start
)
9734 indec
.end
= indec
.start
9735 = min (last_real_key_start
, indec
.start
);
9736 indec
.map
= indec
.parent
;
9737 if (fkey
.end
> last_real_key_start
)
9739 fkey
.end
= fkey
.start
9740 = min (last_real_key_start
, fkey
.start
);
9741 fkey
.map
= fkey
.parent
;
9742 if (keytran
.end
> last_real_key_start
)
9744 keytran
.end
= keytran
.start
9745 = min (last_real_key_start
, keytran
.start
);
9746 keytran
.map
= keytran
.parent
;
9750 if (t
== last_real_key_start
)
9757 mock_input
= last_real_key_start
;
9758 goto replay_sequence
;
9763 = apply_modifiers (modifiers
, XCAR (breakdown
));
9765 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9767 /* Look for a binding for this new key. follow_key
9768 promises that it didn't munge submaps the
9769 last time we called it, since key was unbound. */
9771 = (follow_key (new_click
,
9772 nmaps
- local_first_binding
,
9773 submaps
+ local_first_binding
,
9774 defs
+ local_first_binding
,
9775 submaps
+ local_first_binding
)
9776 + local_first_binding
);
9778 /* If that click is bound, go for it. */
9779 if (first_binding
< nmaps
)
9784 /* Otherwise, we'll leave key set to the drag event. */
9791 /* Normally, last_nonmenu_event gets the previous key we read.
9792 But when a mouse popup menu is being used,
9793 we don't update last_nonmenu_event; it continues to hold the mouse
9794 event that preceded the first level of menu. */
9795 if (!used_mouse_menu
)
9796 last_nonmenu_event
= key
;
9798 /* Record what part of this_command_keys is the current key sequence. */
9799 this_single_command_key_start
= this_command_key_count
- t
;
9801 /* Look for this sequence in input-decode-map.
9802 Scan from indec.end until we find a bound suffix. */
9803 while (indec
.end
< t
)
9805 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9808 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9809 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9814 mock_input
= diff
+ max (t
, mock_input
);
9815 goto replay_sequence
;
9819 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9820 && indec
.start
>= t
)
9821 /* There is a binding and it's not a prefix.
9822 (and it doesn't have any input-decode-map translation pending).
9823 There is thus no function-key in this sequence.
9824 Moving fkey.start is important in this case to allow keytran.start
9825 to go over the sequence before we return (since we keep the
9826 invariant that keytran.end <= fkey.start). */
9829 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9832 /* If the sequence is unbound, see if we can hang a function key
9833 off the end of it. */
9834 /* Continue scan from fkey.end until we find a bound suffix. */
9835 while (fkey
.end
< indec
.start
)
9837 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9840 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9841 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9842 max (t
, mock_input
),
9843 /* If there's a binding (i.e.
9844 first_binding >= nmaps) we don't want
9845 to apply this function-key-mapping. */
9846 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9851 mock_input
= diff
+ max (t
, mock_input
);
9852 /* Adjust the input-decode-map counters. */
9854 indec
.start
+= diff
;
9856 goto replay_sequence
;
9860 /* Look for this sequence in key-translation-map.
9861 Scan from keytran.end until we find a bound suffix. */
9862 while (keytran
.end
< fkey
.start
)
9864 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9867 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9868 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9873 mock_input
= diff
+ max (t
, mock_input
);
9874 /* Adjust the function-key-map and input-decode-map counters. */
9876 indec
.start
+= diff
;
9880 goto replay_sequence
;
9884 /* If KEY is not defined in any of the keymaps,
9885 and cannot be part of a function key or translation,
9886 and is an upper case letter
9887 use the corresponding lower-case letter instead. */
9888 if (first_binding
>= nmaps
9889 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9891 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9892 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9893 || (XINT (key
) & shift_modifier
)))
9895 Lisp_Object new_key
;
9897 original_uppercase
= key
;
9898 original_uppercase_position
= t
- 1;
9900 if (XINT (key
) & shift_modifier
)
9901 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9903 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9904 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9906 /* We have to do this unconditionally, regardless of whether
9907 the lower-case char is defined in the keymaps, because they
9908 might get translated through function-key-map. */
9909 keybuf
[t
- 1] = new_key
;
9910 mock_input
= max (t
, mock_input
);
9911 shift_translated
= 1;
9913 goto replay_sequence
;
9915 /* If KEY is not defined in any of the keymaps,
9916 and cannot be part of a function key or translation,
9917 and is a shifted function key,
9918 use the corresponding unshifted function key instead. */
9919 if (first_binding
>= nmaps
9920 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9922 Lisp_Object breakdown
= parse_modifiers (key
);
9924 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9926 if (modifiers
& shift_modifier
9927 /* Treat uppercase keys as shifted. */
9929 && (KEY_TO_CHAR (key
)
9930 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->size
)
9931 && uppercasep (KEY_TO_CHAR (key
))))
9934 = (modifiers
& shift_modifier
9935 ? apply_modifiers (modifiers
& ~shift_modifier
,
9937 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9939 original_uppercase
= key
;
9940 original_uppercase_position
= t
- 1;
9942 /* We have to do this unconditionally, regardless of whether
9943 the lower-case char is defined in the keymaps, because they
9944 might get translated through function-key-map. */
9945 keybuf
[t
- 1] = new_key
;
9946 mock_input
= max (t
, mock_input
);
9947 /* Reset fkey (and consequently keytran) to apply
9948 function-key-map on the result, so that S-backspace is
9949 correctly mapped to DEL (via backspace). OTOH,
9950 input-decode-map doesn't need to go through it again. */
9951 fkey
.start
= fkey
.end
= 0;
9952 keytran
.start
= keytran
.end
= 0;
9953 shift_translated
= 1;
9955 goto replay_sequence
;
9960 read_key_sequence_cmd
= (first_binding
< nmaps
9961 ? defs
[first_binding
]
9964 unread_switch_frame
= delayed_switch_frame
;
9965 unbind_to (count
, Qnil
);
9967 /* Don't downcase the last character if the caller says don't.
9968 Don't downcase it if the result is undefined, either. */
9969 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9971 && t
- 1 == original_uppercase_position
)
9973 keybuf
[t
- 1] = original_uppercase
;
9974 shift_translated
= 0;
9977 if (shift_translated
)
9978 Vthis_command_keys_shift_translated
= Qt
;
9980 /* Occasionally we fabricate events, perhaps by expanding something
9981 according to function-key-map, or by adding a prefix symbol to a
9982 mouse click in the scroll bar or modeline. In this cases, return
9983 the entire generated key sequence, even if we hit an unbound
9984 prefix or a definition before the end. This means that you will
9985 be able to push back the event properly, and also means that
9986 read-key-sequence will always return a logical unit.
9989 for (; t
< mock_input
; t
++)
9991 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9992 && NILP (Fzerop (Vecho_keystrokes
)))
9993 echo_char (keybuf
[t
]);
9994 add_command_key (keybuf
[t
]);
9997 UNGCPRO_VAR (outer_gcpro
);
10001 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10002 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10003 The sequence is sufficient to specify a non-prefix command in the
10004 current local and global maps.
10006 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10007 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10008 as a continuation of the previous key.
10010 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10011 convert the last event to lower case. (Normally any upper case event
10012 is converted to lower case if the original event is undefined and the lower
10013 case equivalent is defined.) A non-nil value is appropriate for reading
10014 a key sequence to be defined.
10016 A C-g typed while in this function is treated like any other character,
10017 and `quit-flag' is not set.
10019 If the key sequence starts with a mouse click, then the sequence is read
10020 using the keymaps of the buffer of the window clicked in, not the buffer
10021 of the selected window as normal.
10023 `read-key-sequence' drops unbound button-down events, since you normally
10024 only care about the click or drag events which follow them. If a drag
10025 or multi-click event is unbound, but the corresponding click event would
10026 be bound, `read-key-sequence' turns the event into a click event at the
10027 drag's starting position. This means that you don't have to distinguish
10028 between click and drag, double, or triple events unless you want to.
10030 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10031 lines separating windows, and scroll bars with imaginary keys
10032 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10034 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10035 function will process a switch-frame event if the user switches frames
10036 before typing anything. If the user switches frames in the middle of a
10037 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10038 is nil, then the event will be put off until after the current key sequence.
10040 `read-key-sequence' checks `function-key-map' for function key
10041 sequences, where they wouldn't conflict with ordinary bindings. See
10042 `function-key-map' for more details.
10044 The optional fifth argument CMD-LOOP, if non-nil, means
10045 that this key sequence is being read by something that will
10046 read commands one after another. It should be nil if the caller
10047 will read just one key sequence. */)
10048 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10050 Lisp_Object keybuf
[30];
10052 struct gcpro gcpro1
;
10053 int count
= SPECPDL_INDEX ();
10055 if (!NILP (prompt
))
10056 CHECK_STRING (prompt
);
10059 specbind (Qinput_method_exit_on_first_char
,
10060 (NILP (cmd_loop
) ? Qt
: Qnil
));
10061 specbind (Qinput_method_use_echo_area
,
10062 (NILP (cmd_loop
) ? Qt
: Qnil
));
10064 memset (keybuf
, 0, sizeof keybuf
);
10065 GCPRO1 (keybuf
[0]);
10066 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10068 if (NILP (continue_echo
))
10070 this_command_key_count
= 0;
10071 this_command_key_count_reset
= 0;
10072 this_single_command_key_start
= 0;
10075 #ifdef HAVE_WINDOW_SYSTEM
10076 if (display_hourglass_p
)
10077 cancel_hourglass ();
10080 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10081 prompt
, ! NILP (dont_downcase_last
),
10082 ! NILP (can_return_switch_frame
), 0);
10084 #if 0 /* The following is fine for code reading a key sequence and
10085 then proceeding with a lenghty computation, but it's not good
10086 for code reading keys in a loop, like an input method. */
10087 #ifdef HAVE_WINDOW_SYSTEM
10088 if (display_hourglass_p
)
10089 start_hourglass ();
10099 return unbind_to (count
, make_event_array (i
, keybuf
));
10102 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10103 Sread_key_sequence_vector
, 1, 5, 0,
10104 doc
: /* Like `read-key-sequence' but always return a vector. */)
10105 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10107 Lisp_Object keybuf
[30];
10109 struct gcpro gcpro1
;
10110 int count
= SPECPDL_INDEX ();
10112 if (!NILP (prompt
))
10113 CHECK_STRING (prompt
);
10116 specbind (Qinput_method_exit_on_first_char
,
10117 (NILP (cmd_loop
) ? Qt
: Qnil
));
10118 specbind (Qinput_method_use_echo_area
,
10119 (NILP (cmd_loop
) ? Qt
: Qnil
));
10121 memset (keybuf
, 0, sizeof keybuf
);
10122 GCPRO1 (keybuf
[0]);
10123 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10125 if (NILP (continue_echo
))
10127 this_command_key_count
= 0;
10128 this_command_key_count_reset
= 0;
10129 this_single_command_key_start
= 0;
10132 #ifdef HAVE_WINDOW_SYSTEM
10133 if (display_hourglass_p
)
10134 cancel_hourglass ();
10137 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10138 prompt
, ! NILP (dont_downcase_last
),
10139 ! NILP (can_return_switch_frame
), 0);
10141 #ifdef HAVE_WINDOW_SYSTEM
10142 if (display_hourglass_p
)
10143 start_hourglass ();
10152 return unbind_to (count
, Fvector (i
, keybuf
));
10155 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10156 doc
: /* Execute CMD as an editor command.
10157 CMD must be a symbol that satisfies the `commandp' predicate.
10158 Optional second arg RECORD-FLAG non-nil
10159 means unconditionally put this command in `command-history'.
10160 Otherwise, that is done only if an arg is read using the minibuffer.
10161 The argument KEYS specifies the value to use instead of (this-command-keys)
10162 when reading the arguments; if it is nil, (this-command-keys) is used.
10163 The argument SPECIAL, if non-nil, means that this command is executing
10164 a special event, so ignore the prefix argument and don't clear it. */)
10165 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10167 register Lisp_Object final
;
10168 register Lisp_Object tem
;
10169 Lisp_Object prefixarg
;
10171 debug_on_next_call
= 0;
10173 if (NILP (special
))
10175 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10176 Vcurrent_prefix_arg
= prefixarg
;
10177 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10184 tem
= Fget (cmd
, Qdisabled
);
10187 tem
= Fsymbol_value (Qdisabled_command_function
);
10189 return Frun_hooks (1, &Qdisabled_command_function
);
10195 final
= Findirect_function (cmd
, Qnil
);
10197 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10199 struct gcpro gcpro1
, gcpro2
;
10201 GCPRO2 (cmd
, prefixarg
);
10202 do_autoload (final
, cmd
);
10209 if (STRINGP (final
) || VECTORP (final
))
10211 /* If requested, place the macro in the command history. For
10212 other sorts of commands, call-interactively takes care of
10214 if (!NILP (record_flag
))
10217 = Fcons (Fcons (Qexecute_kbd_macro
,
10218 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10221 /* Don't keep command history around forever. */
10222 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10224 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10226 XSETCDR (tem
, Qnil
);
10230 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10233 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10234 /* Don't call Fcall_interactively directly because we want to make
10235 sure the backtrace has an entry for `call-interactively'.
10236 For the same reason, pass `cmd' rather than `final'. */
10237 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10244 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10246 doc
: /* Read function name, then read its arguments and call it.
10248 To pass a numeric argument to the command you are invoking with, specify
10249 the numeric argument to this command.
10251 Noninteractively, the argument PREFIXARG is the prefix argument to
10252 give to the command you invoke, if it asks for an argument. */)
10253 (Lisp_Object prefixarg
)
10255 Lisp_Object function
;
10256 EMACS_INT saved_last_point_position
;
10257 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10258 Lisp_Object bindings
, value
;
10259 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10260 #ifdef HAVE_WINDOW_SYSTEM
10261 /* The call to Fcompleting_read will start and cancel the hourglass,
10262 but if the hourglass was already scheduled, this means that no
10263 hourglass will be shown for the actual M-x command itself.
10264 So we restart it if it is already scheduled. Note that checking
10265 hourglass_shown_p is not enough, normally the hourglass is not shown,
10266 just scheduled to be shown. */
10267 int hstarted
= hourglass_started ();
10270 saved_keys
= Fvector (this_command_key_count
,
10271 XVECTOR (this_command_keys
)->contents
);
10272 saved_last_point_position_buffer
= last_point_position_buffer
;
10273 saved_last_point_position
= last_point_position
;
10274 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10276 function
= call0 (intern ("read-extended-command"));
10278 #ifdef HAVE_WINDOW_SYSTEM
10279 if (hstarted
) start_hourglass ();
10282 if (STRINGP (function
) && SCHARS (function
) == 0)
10283 error ("No command name given");
10285 /* Set this_command_keys to the concatenation of saved_keys and
10286 function, followed by a RET. */
10291 this_command_key_count
= 0;
10292 this_command_key_count_reset
= 0;
10293 this_single_command_key_start
= 0;
10295 keys
= XVECTOR (saved_keys
)->contents
;
10296 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10297 add_command_key (keys
[i
]);
10299 for (i
= 0; i
< SCHARS (function
); i
++)
10300 add_command_key (Faref (function
, make_number (i
)));
10302 add_command_key (make_number ('\015'));
10305 last_point_position
= saved_last_point_position
;
10306 last_point_position_buffer
= saved_last_point_position_buffer
;
10310 function
= Fintern (function
, Qnil
);
10311 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10312 Vthis_command
= function
;
10313 real_this_command
= function
;
10315 /* If enabled, show which key runs this command. */
10316 if (!NILP (Vsuggest_key_bindings
)
10317 && NILP (Vexecuting_kbd_macro
)
10318 && SYMBOLP (function
))
10319 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10325 GCPRO3 (bindings
, value
, function
);
10326 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10328 /* If the command has a key binding, print it now. */
10329 if (!NILP (bindings
)
10330 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10333 /* But first wait, and skip the message if there is input. */
10334 Lisp_Object waited
;
10336 /* If this command displayed something in the echo area;
10337 wait a few seconds, then display our suggestion message. */
10338 if (NILP (echo_area_buffer
[0]))
10339 waited
= sit_for (make_number (0), 0, 2);
10340 else if (NUMBERP (Vsuggest_key_bindings
))
10341 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10343 waited
= sit_for (make_number (2), 0, 2);
10345 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10347 Lisp_Object binding
;
10349 int message_p
= push_message ();
10350 int count
= SPECPDL_INDEX ();
10352 record_unwind_protect (pop_message_unwind
, Qnil
);
10353 binding
= Fkey_description (bindings
, Qnil
);
10356 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10359 sprintf (newmessage
, "You can run the command `%s' with %s",
10360 SDATA (SYMBOL_NAME (function
)),
10362 message2 (newmessage
,
10363 strlen (newmessage
),
10364 STRING_MULTIBYTE (binding
));
10365 if (NUMBERP (Vsuggest_key_bindings
))
10366 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10368 waited
= sit_for (make_number (2), 0, 2);
10370 if (!NILP (waited
) && message_p
)
10371 restore_message ();
10373 unbind_to (count
, Qnil
);
10377 RETURN_UNGCPRO (value
);
10381 /* Return nonzero if input events are pending. */
10384 detect_input_pending (void)
10386 if (!input_pending
)
10387 get_input_pending (&input_pending
, 0);
10389 return input_pending
;
10392 /* Return nonzero if input events other than mouse movements are
10396 detect_input_pending_ignore_squeezables (void)
10398 if (!input_pending
)
10399 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10401 return input_pending
;
10404 /* Return nonzero if input events are pending, and run any pending timers. */
10407 detect_input_pending_run_timers (int do_display
)
10409 int old_timers_run
= timers_run
;
10411 if (!input_pending
)
10412 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10414 if (old_timers_run
!= timers_run
&& do_display
)
10416 redisplay_preserve_echo_area (8);
10417 /* The following fixes a bug when using lazy-lock with
10418 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10419 from an idle timer function. The symptom of the bug is that
10420 the cursor sometimes doesn't become visible until the next X
10421 event is processed. --gerd. */
10423 Lisp_Object tail
, frame
;
10424 FOR_EACH_FRAME (tail
, frame
)
10425 if (FRAME_RIF (XFRAME (frame
)))
10426 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10430 return input_pending
;
10433 /* This is called in some cases before a possible quit.
10434 It cases the next call to detect_input_pending to recompute input_pending.
10435 So calling this function unnecessarily can't do any harm. */
10438 clear_input_pending (void)
10443 /* Return nonzero if there are pending requeued events.
10444 This isn't used yet. The hope is to make wait_reading_process_output
10445 call it, and return if it runs Lisp code that unreads something.
10446 The problem is, kbd_buffer_get_event needs to be fixed to know what
10447 to do in that case. It isn't trivial. */
10450 requeued_events_pending_p (void)
10452 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10456 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10457 doc
: /* Return t if command input is currently available with no wait.
10458 Actually, the value is nil only if we can be sure that no input is available;
10459 if there is a doubt, the value is t. */)
10462 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10463 || !NILP (Vunread_post_input_method_events
)
10464 || !NILP (Vunread_input_method_events
))
10467 get_input_pending (&input_pending
,
10468 READABLE_EVENTS_DO_TIMERS_NOW
10469 | READABLE_EVENTS_FILTER_EVENTS
);
10470 return input_pending
> 0 ? Qt
: Qnil
;
10473 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10474 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10477 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10480 if (total_keys
< NUM_RECENT_KEYS
)
10481 return Fvector (total_keys
, keys
);
10484 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10485 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10486 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10487 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10488 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10493 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10494 doc
: /* Return the key sequence that invoked this command.
10495 However, if the command has called `read-key-sequence', it returns
10496 the last key sequence that has been read.
10497 The value is a string or a vector.
10499 See also `this-command-keys-vector'. */)
10502 return make_event_array (this_command_key_count
,
10503 XVECTOR (this_command_keys
)->contents
);
10506 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10507 doc
: /* Return the key sequence that invoked this command, as a vector.
10508 However, if the command has called `read-key-sequence', it returns
10509 the last key sequence that has been read.
10511 See also `this-command-keys'. */)
10514 return Fvector (this_command_key_count
,
10515 XVECTOR (this_command_keys
)->contents
);
10518 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10519 Sthis_single_command_keys
, 0, 0, 0,
10520 doc
: /* Return the key sequence that invoked this command.
10521 More generally, it returns the last key sequence read, either by
10522 the command loop or by `read-key-sequence'.
10523 Unlike `this-command-keys', this function's value
10524 does not include prefix arguments.
10525 The value is always a vector. */)
10528 return Fvector (this_command_key_count
10529 - this_single_command_key_start
,
10530 (XVECTOR (this_command_keys
)->contents
10531 + this_single_command_key_start
));
10534 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10535 Sthis_single_command_raw_keys
, 0, 0, 0,
10536 doc
: /* Return the raw events that were read for this command.
10537 More generally, it returns the last key sequence read, either by
10538 the command loop or by `read-key-sequence'.
10539 Unlike `this-single-command-keys', this function's value
10540 shows the events before all translations (except for input methods).
10541 The value is always a vector. */)
10544 return Fvector (raw_keybuf_count
,
10545 (XVECTOR (raw_keybuf
)->contents
));
10548 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10549 Sreset_this_command_lengths
, 0, 0, 0,
10550 doc
: /* Make the unread events replace the last command and echo.
10551 Used in `universal-argument-other-key'.
10553 `universal-argument-other-key' rereads the event just typed.
10554 It then gets translated through `function-key-map'.
10555 The translated event has to replace the real events,
10556 both in the value of (this-command-keys) and in echoing.
10557 To achieve this, `universal-argument-other-key' calls
10558 `reset-this-command-lengths', which discards the record of reading
10559 these events the first time. */)
10562 this_command_key_count
= before_command_key_count
;
10563 if (this_command_key_count
< this_single_command_key_start
)
10564 this_single_command_key_start
= this_command_key_count
;
10566 echo_truncate (before_command_echo_length
);
10568 /* Cause whatever we put into unread-command-events
10569 to echo as if it were being freshly read from the keyboard. */
10570 this_command_key_count_reset
= 1;
10575 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10576 Sclear_this_command_keys
, 0, 1, 0,
10577 doc
: /* Clear out the vector that `this-command-keys' returns.
10578 Also clear the record of the last 100 events, unless optional arg
10579 KEEP-RECORD is non-nil. */)
10580 (Lisp_Object keep_record
)
10584 this_command_key_count
= 0;
10585 this_command_key_count_reset
= 0;
10587 if (NILP (keep_record
))
10589 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10590 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10592 recent_keys_index
= 0;
10597 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10598 doc
: /* Return the current depth in recursive edits. */)
10602 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10606 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10607 "FOpen dribble file: ",
10608 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10609 If FILE is nil, close any open dribble file. */)
10621 file
= Fexpand_file_name (file
, Qnil
);
10622 dribble
= fopen (SSDATA (file
), "w");
10624 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10629 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10630 doc
: /* Discard the contents of the terminal input buffer.
10631 Also end any kbd macro being defined. */)
10634 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10636 /* Discard the last command from the macro. */
10637 Fcancel_kbd_macro_events ();
10641 update_mode_lines
++;
10643 Vunread_command_events
= Qnil
;
10644 unread_command_char
= -1;
10646 discard_tty_input ();
10648 kbd_fetch_ptr
= kbd_store_ptr
;
10654 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10655 doc
: /* Stop Emacs and return to superior process. You can resume later.
10656 If `cannot-suspend' is non-nil, or if the system doesn't support job
10657 control, run a subshell instead.
10659 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10660 to be read as terminal input by Emacs's parent, after suspension.
10662 Before suspending, run the normal hook `suspend-hook'.
10663 After resumption run the normal hook `suspend-resume-hook'.
10665 Some operating systems cannot stop the Emacs process and resume it later.
10666 On such systems, Emacs starts a subshell instead of suspending. */)
10667 (Lisp_Object stuffstring
)
10669 int count
= SPECPDL_INDEX ();
10670 int old_height
, old_width
;
10672 struct gcpro gcpro1
;
10675 if (tty_list
&& tty_list
->next
)
10676 error ("There are other tty frames open; close them before suspending Emacs");
10678 if (!NILP (stuffstring
))
10679 CHECK_STRING (stuffstring
);
10681 /* Run the functions in suspend-hook. */
10682 hook
= intern ("suspend-hook");
10683 Frun_hooks (1, &hook
);
10685 GCPRO1 (stuffstring
);
10686 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10687 reset_all_sys_modes ();
10688 /* sys_suspend can get an error if it tries to fork a subshell
10689 and the system resources aren't available for that. */
10690 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10692 stuff_buffered_input (stuffstring
);
10693 if (cannot_suspend
)
10697 unbind_to (count
, Qnil
);
10699 /* Check if terminal/window size has changed.
10700 Note that this is not useful when we are running directly
10701 with a window system; but suspend should be disabled in that case. */
10702 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10703 if (width
!= old_width
|| height
!= old_height
)
10704 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10706 /* Run suspend-resume-hook. */
10707 hook
= intern ("suspend-resume-hook");
10708 Frun_hooks (1, &hook
);
10714 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10715 Then in any case stuff anything Emacs has read ahead and not used. */
10718 stuff_buffered_input (Lisp_Object stuffstring
)
10720 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10721 register unsigned char *p
;
10723 if (STRINGP (stuffstring
))
10725 register EMACS_INT count
;
10727 p
= SDATA (stuffstring
);
10728 count
= SBYTES (stuffstring
);
10729 while (count
-- > 0)
10734 /* Anything we have read ahead, put back for the shell to read. */
10735 /* ?? What should this do when we have multiple keyboards??
10736 Should we ignore anything that was typed in at the "wrong" kboard?
10738 rms: we should stuff everything back into the kboard
10740 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10743 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10744 kbd_fetch_ptr
= kbd_buffer
;
10745 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10746 stuff_char (kbd_fetch_ptr
->code
);
10748 clear_event (kbd_fetch_ptr
);
10752 #endif /* SIGTSTP */
10756 set_waiting_for_input (struct timeval
*time_to_clear
)
10758 input_available_clear_time
= time_to_clear
;
10760 /* Tell handle_interrupt to throw back to read_char, */
10761 waiting_for_input
= 1;
10763 /* If handle_interrupt was called before and buffered a C-g,
10764 make it run again now, to avoid timing error. */
10765 if (!NILP (Vquit_flag
))
10766 quit_throw_to_read_char ();
10770 clear_waiting_for_input (void)
10772 /* Tell handle_interrupt not to throw back to read_char, */
10773 waiting_for_input
= 0;
10774 input_available_clear_time
= 0;
10777 /* The SIGINT handler.
10779 If we have a frame on the controlling tty, we assume that the
10780 SIGINT was generated by C-g, so we call handle_interrupt.
10781 Otherwise, the handler kills Emacs. */
10784 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10785 /* compilers complain in signal calls. */
10787 /* Must preserve main program's value of errno. */
10788 int old_errno
= errno
;
10789 struct terminal
*terminal
;
10791 SIGNAL_THREAD_CHECK (signalnum
);
10793 /* See if we have an active terminal on our controlling tty. */
10794 terminal
= get_named_tty ("/dev/tty");
10797 /* If there are no frames there, let's pretend that we are a
10798 well-behaving UN*X program and quit. */
10799 Fkill_emacs (Qnil
);
10803 /* Otherwise, the SIGINT was probably generated by C-g. */
10805 /* Set internal_last_event_frame to the top frame of the
10806 controlling tty, if we have a frame there. We disable the
10807 interrupt key on secondary ttys, so the SIGINT must have come
10808 from the controlling tty. */
10809 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10811 handle_interrupt ();
10817 /* This routine is called at interrupt level in response to C-g.
10819 It is called from the SIGINT handler or kbd_buffer_store_event.
10821 If `waiting_for_input' is non zero, then unless `echoing' is
10822 nonzero, immediately throw back to read_char.
10824 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10825 eval to throw, when it gets a chance. If quit-flag is already
10826 non-nil, it stops the job right away. */
10829 handle_interrupt (void)
10835 /* XXX This code needs to be revised for multi-tty support. */
10836 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10838 /* If SIGINT isn't blocked, don't let us be interrupted by
10839 another SIGINT, it might be harmful due to non-reentrancy
10840 in I/O functions. */
10841 sigblock (sigmask (SIGINT
));
10844 reset_all_sys_modes ();
10846 #ifdef SIGTSTP /* Support possible in later USG versions */
10848 * On systems which can suspend the current process and return to the original
10849 * shell, this command causes the user to end up back at the shell.
10850 * The "Auto-save" and "Abort" questions are not asked until
10851 * the user elects to return to emacs, at which point he can save the current
10852 * job and either dump core or continue.
10856 /* Perhaps should really fork an inferior shell?
10857 But that would not provide any way to get back
10858 to the original shell, ever. */
10859 printf ("No support for stopping a process on this operating system;\n");
10860 printf ("you can continue or abort.\n");
10861 #endif /* not SIGTSTP */
10863 /* We must remain inside the screen area when the internal terminal
10864 is used. Note that [Enter] is not echoed by dos. */
10865 cursor_to (SELECTED_FRAME (), 0, 0);
10867 /* It doesn't work to autosave while GC is in progress;
10868 the code used for auto-saving doesn't cope with the mark bit. */
10869 if (!gc_in_progress
)
10871 printf ("Auto-save? (y or n) ");
10873 if (((c
= getchar ()) & ~040) == 'Y')
10875 Fdo_auto_save (Qt
, Qnil
);
10877 printf ("\r\nAuto-save done");
10878 #else /* not MSDOS */
10879 printf ("Auto-save done\n");
10880 #endif /* not MSDOS */
10882 while (c
!= '\n') c
= getchar ();
10886 /* During GC, it must be safe to reenable quitting again. */
10887 Vinhibit_quit
= Qnil
;
10890 #endif /* not MSDOS */
10891 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10892 printf ("but will instead do a real quit after garbage collection ends\r\n");
10897 printf ("\r\nAbort? (y or n) ");
10898 #else /* not MSDOS */
10899 printf ("Abort (and dump core)? (y or n) ");
10900 #endif /* not MSDOS */
10902 if (((c
= getchar ()) & ~040) == 'Y')
10904 while (c
!= '\n') c
= getchar ();
10906 printf ("\r\nContinuing...\r\n");
10907 #else /* not MSDOS */
10908 printf ("Continuing...\n");
10909 #endif /* not MSDOS */
10911 init_all_sys_modes ();
10916 /* If executing a function that wants to be interrupted out of
10917 and the user has not deferred quitting by binding `inhibit-quit'
10918 then quit right away. */
10919 if (immediate_quit
&& NILP (Vinhibit_quit
))
10921 struct gl_state_s saved
;
10922 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10924 immediate_quit
= 0;
10927 GCPRO4 (saved
.object
, saved
.global_code
,
10928 saved
.current_syntax_table
, saved
.old_prop
);
10929 Fsignal (Qquit
, Qnil
);
10930 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10935 /* Else request quit when it's safe */
10939 /* TODO: The longjmp in this call throws the NS event loop integration off,
10940 and it seems to do fine without this. Probably some attention
10941 needs to be paid to the setting of waiting_for_input in
10942 wait_reading_process_output() under HAVE_NS because of the call
10943 to ns_select there (needed because otherwise events aren't picked up
10944 outside of polling since we don't get SIGIO like X and we don't have a
10945 separate event loop thread like W32. */
10947 if (waiting_for_input
&& !echoing
)
10948 quit_throw_to_read_char ();
10952 /* Handle a C-g by making read_char return C-g. */
10955 quit_throw_to_read_char (void)
10958 /* Prevent another signal from doing this before we finish. */
10959 clear_waiting_for_input ();
10962 Vunread_command_events
= Qnil
;
10963 unread_command_char
= -1;
10965 #if 0 /* Currently, sit_for is called from read_char without turning
10966 off polling. And that can call set_waiting_for_input.
10967 It seems to be harmless. */
10968 #ifdef POLL_FOR_INPUT
10969 /* May be > 1 if in recursive minibuffer. */
10970 if (poll_suppress_count
== 0)
10974 if (FRAMEP (internal_last_event_frame
)
10975 && !EQ (internal_last_event_frame
, selected_frame
))
10976 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10979 _longjmp (getcjmp
, 1);
10982 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10983 Sset_input_interrupt_mode
, 1, 1, 0,
10984 doc
: /* Set interrupt mode of reading keyboard input.
10985 If INTERRUPT is non-nil, Emacs will use input interrupts;
10986 otherwise Emacs uses CBREAK mode.
10988 See also `current-input-mode'. */)
10989 (Lisp_Object interrupt
)
10991 int new_interrupt_input
;
10993 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10994 #ifdef HAVE_X_WINDOWS
10995 if (x_display_list
!= NULL
)
10997 /* When using X, don't give the user a real choice,
10998 because we haven't implemented the mechanisms to support it. */
10999 new_interrupt_input
= 1;
11002 #endif /* HAVE_X_WINDOWS */
11003 new_interrupt_input
= !NILP (interrupt
);
11004 #else /* not SIGIO */
11005 new_interrupt_input
= 0;
11006 #endif /* not SIGIO */
11008 if (new_interrupt_input
!= interrupt_input
)
11010 #ifdef POLL_FOR_INPUT
11014 /* this causes startup screen to be restored and messes with the mouse */
11015 reset_all_sys_modes ();
11016 interrupt_input
= new_interrupt_input
;
11017 init_all_sys_modes ();
11019 interrupt_input
= new_interrupt_input
;
11022 #ifdef POLL_FOR_INPUT
11023 poll_suppress_count
= 1;
11030 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11031 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11032 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11033 C-q in key sequences.
11035 This setting only has an effect on tty terminals and only when
11036 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11038 See also `current-input-mode'. */)
11039 (Lisp_Object flow
, Lisp_Object terminal
)
11041 struct terminal
*t
= get_terminal (terminal
, 1);
11042 struct tty_display_info
*tty
;
11043 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11045 tty
= t
->display_info
.tty
;
11047 if (tty
->flow_control
!= !NILP (flow
))
11050 /* this causes startup screen to be restored and messes with the mouse */
11051 reset_sys_modes (tty
);
11054 tty
->flow_control
= !NILP (flow
);
11057 init_sys_modes (tty
);
11063 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11064 doc
: /* Enable or disable 8-bit input on TERMINAL.
11065 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11066 bit as the Meta modifier.
11068 If META is nil, Emacs will ignore the top bit, on the assumption it is
11071 Otherwise, Emacs will accept and pass through 8-bit input without
11072 specially interpreting the top bit.
11074 This setting only has an effect on tty terminal devices.
11076 Optional parameter TERMINAL specifies the tty terminal device to use.
11077 It may be a terminal object, a frame, or nil for the terminal used by
11078 the currently selected frame.
11080 See also `current-input-mode'. */)
11081 (Lisp_Object meta
, Lisp_Object terminal
)
11083 struct terminal
*t
= get_terminal (terminal
, 1);
11084 struct tty_display_info
*tty
;
11087 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11089 tty
= t
->display_info
.tty
;
11093 else if (EQ (meta
, Qt
))
11098 if (tty
->meta_key
!= new_meta
)
11101 /* this causes startup screen to be restored and messes with the mouse */
11102 reset_sys_modes (tty
);
11105 tty
->meta_key
= new_meta
;
11108 init_sys_modes (tty
);
11114 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11115 doc
: /* Specify character used for quitting.
11116 QUIT must be an ASCII character.
11118 This function only has an effect on the controlling tty of the Emacs
11121 See also `current-input-mode'. */)
11124 struct terminal
*t
= get_named_tty ("/dev/tty");
11125 struct tty_display_info
*tty
;
11126 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11128 tty
= t
->display_info
.tty
;
11130 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11131 error ("QUIT must be an ASCII character");
11134 /* this causes startup screen to be restored and messes with the mouse */
11135 reset_sys_modes (tty
);
11138 /* Don't let this value be out of range. */
11139 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11142 init_sys_modes (tty
);
11148 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11149 doc
: /* Set mode of reading keyboard input.
11150 First arg INTERRUPT non-nil means use input interrupts;
11151 nil means use CBREAK mode.
11152 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11153 (no effect except in CBREAK mode).
11154 Third arg META t means accept 8-bit input (for a Meta key).
11155 META nil means ignore the top bit, on the assumption it is parity.
11156 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11157 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11158 See also `current-input-mode'. */)
11159 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11161 Fset_input_interrupt_mode (interrupt
);
11162 Fset_output_flow_control (flow
, Qnil
);
11163 Fset_input_meta_mode (meta
, Qnil
);
11165 Fset_quit_char (quit
);
11169 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11170 doc
: /* Return information about the way Emacs currently reads keyboard input.
11171 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11172 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11173 nil, Emacs is using CBREAK mode.
11174 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11175 terminal; this does not apply if Emacs uses interrupt-driven input.
11176 META is t if accepting 8-bit input with 8th bit as Meta flag.
11177 META nil means ignoring the top bit, on the assumption it is parity.
11178 META is neither t nor nil if accepting 8-bit input and using
11179 all 8 bits as the character code.
11180 QUIT is the character Emacs currently uses to quit.
11181 The elements of this list correspond to the arguments of
11182 `set-input-mode'. */)
11185 Lisp_Object val
[4];
11186 struct frame
*sf
= XFRAME (selected_frame
);
11188 val
[0] = interrupt_input
? Qt
: Qnil
;
11189 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11191 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11192 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11194 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11201 XSETFASTINT (val
[3], quit_char
);
11203 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11206 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11207 doc
: /* Return position information for pixel coordinates X and Y.
11208 By default, X and Y are relative to text area of the selected window.
11209 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11210 If optional fourth arg WHOLE is non-nil, X is relative to the left
11211 edge of the window.
11213 The return value is similar to a mouse click position:
11214 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11215 IMAGE (DX . DY) (WIDTH . HEIGHT))
11216 The `posn-' functions access elements of such lists. */)
11217 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11222 if (NILP (frame_or_window
))
11223 frame_or_window
= selected_window
;
11225 if (WINDOWP (frame_or_window
))
11229 CHECK_LIVE_WINDOW (frame_or_window
);
11231 w
= XWINDOW (frame_or_window
);
11232 XSETINT (x
, (XINT (x
)
11233 + WINDOW_LEFT_EDGE_X (w
)
11235 ? window_box_left_offset (w
, TEXT_AREA
)
11237 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11238 frame_or_window
= w
->frame
;
11241 CHECK_LIVE_FRAME (frame_or_window
);
11243 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11246 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11247 doc
: /* Return position information for buffer POS in WINDOW.
11248 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11250 Return nil if position is not visible in window. Otherwise,
11251 the return value is similar to that returned by `event-start' for
11252 a mouse click at the upper left corner of the glyph corresponding
11253 to the given buffer position:
11254 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11255 IMAGE (DX . DY) (WIDTH . HEIGHT))
11256 The `posn-' functions access elements of such lists. */)
11257 (Lisp_Object pos
, Lisp_Object window
)
11262 window
= selected_window
;
11264 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11267 Lisp_Object x
= XCAR (tem
);
11268 Lisp_Object y
= XCAR (XCDR (tem
));
11270 /* Point invisible due to hscrolling? */
11273 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11281 * Set up a new kboard object with reasonable initial values.
11284 init_kboard (KBOARD
*kb
)
11286 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11287 KVAR (kb
, Vlast_command
) = Qnil
;
11288 KVAR (kb
, Vreal_last_command
) = Qnil
;
11289 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11290 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11291 KVAR (kb
, Vprefix_arg
) = Qnil
;
11292 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11293 KVAR (kb
, kbd_queue
) = Qnil
;
11294 kb
->kbd_queue_has_data
= 0;
11295 kb
->immediate_echo
= 0;
11296 KVAR (kb
, echo_string
) = Qnil
;
11297 kb
->echo_after_prompt
= -1;
11298 kb
->kbd_macro_buffer
= 0;
11299 kb
->kbd_macro_bufsize
= 0;
11300 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11301 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11302 kb
->reference_count
= 0;
11303 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11304 KVAR (kb
, system_key_syms
) = Qnil
;
11305 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11306 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11307 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11308 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11309 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11313 * Destroy the contents of a kboard object, but not the object itself.
11314 * We use this just before deleting it, or if we're going to initialize
11315 * it a second time.
11318 wipe_kboard (KBOARD
*kb
)
11320 xfree (kb
->kbd_macro_buffer
);
11323 /* Free KB and memory referenced from it. */
11326 delete_kboard (KBOARD
*kb
)
11330 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11333 *kbp
= kb
->next_kboard
;
11335 /* Prevent a dangling reference to KB. */
11336 if (kb
== current_kboard
11337 && FRAMEP (selected_frame
)
11338 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11340 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11342 if (current_kboard
== kb
)
11351 init_keyboard (void)
11353 /* This is correct before outermost invocation of the editor loop */
11354 command_loop_level
= -1;
11355 immediate_quit
= 0;
11356 quit_char
= Ctl ('g');
11357 Vunread_command_events
= Qnil
;
11358 unread_command_char
= -1;
11359 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11361 recent_keys_index
= 0;
11362 kbd_fetch_ptr
= kbd_buffer
;
11363 kbd_store_ptr
= kbd_buffer
;
11364 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11365 do_mouse_tracking
= Qnil
;
11368 interrupt_input_blocked
= 0;
11369 interrupt_input_pending
= 0;
11371 pending_signals
= 0;
11374 /* This means that command_loop_1 won't try to select anything the first
11376 internal_last_event_frame
= Qnil
;
11377 Vlast_event_frame
= internal_last_event_frame
;
11379 current_kboard
= initial_kboard
;
11380 /* Re-initialize the keyboard again. */
11381 wipe_kboard (current_kboard
);
11382 init_kboard (current_kboard
);
11383 /* A value of nil for Vwindow_system normally means a tty, but we also use
11384 it for the initial terminal since there is no window system there. */
11385 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11387 if (!noninteractive
)
11389 /* Before multi-tty support, these handlers used to be installed
11390 only if the current session was a tty session. Now an Emacs
11391 session may have multiple display types, so we always handle
11392 SIGINT. There is special code in interrupt_signal to exit
11393 Emacs on SIGINT when there are no termcap frames on the
11394 controlling terminal. */
11395 signal (SIGINT
, interrupt_signal
);
11397 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11398 SIGQUIT and we can't tell which one it will give us. */
11399 signal (SIGQUIT
, interrupt_signal
);
11400 #endif /* not DOS_NT */
11402 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11404 if (!noninteractive
)
11405 signal (SIGIO
, input_available_signal
);
11408 /* Use interrupt input by default, if it works and noninterrupt input
11409 has deficiencies. */
11411 #ifdef INTERRUPT_INPUT
11412 interrupt_input
= 1;
11414 interrupt_input
= 0;
11420 if (keyboard_init_hook
)
11421 (*keyboard_init_hook
) ();
11423 #ifdef POLL_FOR_INPUT
11425 poll_suppress_count
= 1;
11430 /* This type's only use is in syms_of_keyboard, to initialize the
11431 event header symbols and put properties on them. */
11432 struct event_head
{
11438 static const struct event_head head_table
[] = {
11439 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11440 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11441 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11442 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11443 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11444 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11445 /* `select-window' should be handled just like `switch-frame'
11446 in read_key_sequence. */
11447 {&Qselect_window
, "select-window", &Qswitch_frame
}
11451 syms_of_keyboard (void)
11453 pending_funcalls
= Qnil
;
11454 staticpro (&pending_funcalls
);
11456 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11457 staticpro (&Vlispy_mouse_stem
);
11460 DEFSYM (QCimage
, ":image");
11461 DEFSYM (Qhelp_echo
, "help-echo");
11462 DEFSYM (Qrtl
, ":rtl");
11464 staticpro (&item_properties
);
11465 item_properties
= Qnil
;
11467 staticpro (&tool_bar_item_properties
);
11468 tool_bar_item_properties
= Qnil
;
11469 staticpro (&tool_bar_items_vector
);
11470 tool_bar_items_vector
= Qnil
;
11472 staticpro (&real_this_command
);
11473 real_this_command
= Qnil
;
11475 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11476 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11477 DEFSYM (Qself_insert_command
, "self-insert-command");
11478 DEFSYM (Qforward_char
, "forward-char");
11479 DEFSYM (Qbackward_char
, "backward-char");
11480 DEFSYM (Qdisabled
, "disabled");
11481 DEFSYM (Qundefined
, "undefined");
11482 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11483 DEFSYM (Qpost_command_hook
, "post-command-hook");
11484 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11485 DEFSYM (Qfunction_key
, "function-key");
11486 DEFSYM (Qmouse_click
, "mouse-click");
11487 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11488 DEFSYM (Qsave_session
, "save-session");
11489 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11490 DEFSYM (Qmenu_enable
, "menu-enable");
11492 #if defined (WINDOWSNT)
11493 DEFSYM (Qlanguage_change
, "language-change");
11497 DEFSYM (Qdbus_event
, "dbus-event");
11500 DEFSYM (QCenable
, ":enable");
11501 DEFSYM (QCvisible
, ":visible");
11502 DEFSYM (QChelp
, ":help");
11503 DEFSYM (QCfilter
, ":filter");
11504 DEFSYM (QCbutton
, ":button");
11505 DEFSYM (QCkeys
, ":keys");
11506 DEFSYM (QCkey_sequence
, ":key-sequence");
11507 DEFSYM (QCtoggle
, ":toggle");
11508 DEFSYM (QCradio
, ":radio");
11509 DEFSYM (QClabel
, ":label");
11510 DEFSYM (QCvert_only
, ":vert-only");
11512 DEFSYM (Qmode_line
, "mode-line");
11513 DEFSYM (Qvertical_line
, "vertical-line");
11514 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11515 DEFSYM (Qmenu_bar
, "menu-bar");
11517 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11518 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11521 DEFSYM (Qabove_handle
, "above-handle");
11522 DEFSYM (Qhandle
, "handle");
11523 DEFSYM (Qbelow_handle
, "below-handle");
11524 DEFSYM (Qup
, "up");
11525 DEFSYM (Qdown
, "down");
11526 DEFSYM (Qtop
, "top");
11527 DEFSYM (Qbottom
, "bottom");
11528 DEFSYM (Qend_scroll
, "end-scroll");
11529 DEFSYM (Qratio
, "ratio");
11531 DEFSYM (Qevent_kind
, "event-kind");
11532 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11533 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11534 DEFSYM (Qmodifier_cache
, "modifier-cache");
11536 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11537 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11539 DEFSYM (Qpolling_period
, "polling-period");
11541 DEFSYM (Qx_set_selection
, "x-set-selection");
11542 DEFSYM (QPRIMARY
, "PRIMARY");
11543 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11545 DEFSYM (Qinput_method_function
, "input-method-function");
11546 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11547 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11549 DEFSYM (Qhelp_form_show
, "help-form-show");
11551 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11552 Fset (Qinput_method_use_echo_area
, Qnil
);
11554 last_point_position_buffer
= Qnil
;
11555 last_point_position_window
= Qnil
;
11559 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11561 for (i
= 0; i
< len
; i
++)
11563 const struct event_head
*p
= &head_table
[i
];
11564 *p
->var
= intern_c_string (p
->name
);
11565 staticpro (p
->var
);
11566 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11567 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11571 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11572 staticpro (&button_down_location
);
11573 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11574 staticpro (&mouse_syms
);
11575 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11576 / sizeof (lispy_wheel_names
[0])),
11578 staticpro (&wheel_syms
);
11582 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11584 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11585 for (i
= 0; i
< len
; i
++)
11586 if (modifier_names
[i
])
11587 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11588 staticpro (&modifier_symbols
);
11591 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11592 staticpro (&recent_keys
);
11594 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11595 staticpro (&this_command_keys
);
11597 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11598 staticpro (&raw_keybuf
);
11600 DEFSYM (Qextended_command_history
, "extended-command-history");
11601 Fset (Qextended_command_history
, Qnil
);
11603 accent_key_syms
= Qnil
;
11604 staticpro (&accent_key_syms
);
11606 func_key_syms
= Qnil
;
11607 staticpro (&func_key_syms
);
11609 drag_n_drop_syms
= Qnil
;
11610 staticpro (&drag_n_drop_syms
);
11612 unread_switch_frame
= Qnil
;
11613 staticpro (&unread_switch_frame
);
11615 internal_last_event_frame
= Qnil
;
11616 staticpro (&internal_last_event_frame
);
11618 read_key_sequence_cmd
= Qnil
;
11619 staticpro (&read_key_sequence_cmd
);
11621 menu_bar_one_keymap_changed_items
= Qnil
;
11622 staticpro (&menu_bar_one_keymap_changed_items
);
11624 menu_bar_items_vector
= Qnil
;
11625 staticpro (&menu_bar_items_vector
);
11627 help_form_saved_window_configs
= Qnil
;
11628 staticpro (&help_form_saved_window_configs
);
11630 defsubr (&Scurrent_idle_time
);
11631 defsubr (&Sevent_symbol_parse_modifiers
);
11632 defsubr (&Sevent_convert_list
);
11633 defsubr (&Sread_key_sequence
);
11634 defsubr (&Sread_key_sequence_vector
);
11635 defsubr (&Srecursive_edit
);
11636 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11637 defsubr (&Strack_mouse
);
11639 defsubr (&Sinput_pending_p
);
11640 defsubr (&Scommand_execute
);
11641 defsubr (&Srecent_keys
);
11642 defsubr (&Sthis_command_keys
);
11643 defsubr (&Sthis_command_keys_vector
);
11644 defsubr (&Sthis_single_command_keys
);
11645 defsubr (&Sthis_single_command_raw_keys
);
11646 defsubr (&Sreset_this_command_lengths
);
11647 defsubr (&Sclear_this_command_keys
);
11648 defsubr (&Ssuspend_emacs
);
11649 defsubr (&Sabort_recursive_edit
);
11650 defsubr (&Sexit_recursive_edit
);
11651 defsubr (&Srecursion_depth
);
11652 defsubr (&Stop_level
);
11653 defsubr (&Sdiscard_input
);
11654 defsubr (&Sopen_dribble_file
);
11655 defsubr (&Sset_input_interrupt_mode
);
11656 defsubr (&Sset_output_flow_control
);
11657 defsubr (&Sset_input_meta_mode
);
11658 defsubr (&Sset_quit_char
);
11659 defsubr (&Sset_input_mode
);
11660 defsubr (&Scurrent_input_mode
);
11661 defsubr (&Sexecute_extended_command
);
11662 defsubr (&Sposn_at_point
);
11663 defsubr (&Sposn_at_x_y
);
11665 DEFVAR_LISP ("last-command-event", last_command_event
,
11666 doc
: /* Last input event that was part of a command. */);
11668 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11669 doc
: /* Last input event in a command, except for mouse menu events.
11670 Mouse menus give back keys that don't look like mouse events;
11671 this variable holds the actual mouse event that led to the menu,
11672 so that you can determine whether the command was run by mouse or not. */);
11674 DEFVAR_LISP ("last-input-event", last_input_event
,
11675 doc
: /* Last input event. */);
11677 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11678 doc
: /* List of events to be read as the command input.
11679 These events are processed first, before actual keyboard input.
11680 Events read from this list are not normally added to `this-command-keys',
11681 as they will already have been added once as they were read for the first time.
11682 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11683 Vunread_command_events
= Qnil
;
11685 DEFVAR_INT ("unread-command-char", unread_command_char
,
11686 doc
: /* If not -1, an object to be read as next command input event. */);
11688 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11689 doc
: /* List of events to be processed as input by input methods.
11690 These events are processed before `unread-command-events'
11691 and actual keyboard input, but are not given to `input-method-function'. */);
11692 Vunread_post_input_method_events
= Qnil
;
11694 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11695 doc
: /* List of events to be processed as input by input methods.
11696 These events are processed after `unread-command-events', but
11697 before actual keyboard input.
11698 If there's an active input method, the events are given to
11699 `input-method-function'. */);
11700 Vunread_input_method_events
= Qnil
;
11702 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11703 doc
: /* Meta-prefix character code.
11704 Meta-foo as command input turns into this character followed by foo. */);
11705 XSETINT (meta_prefix_char
, 033);
11707 DEFVAR_KBOARD ("last-command", Vlast_command
,
11708 doc
: /* The last command executed.
11709 Normally a symbol with a function definition, but can be whatever was found
11710 in the keymap, or whatever the variable `this-command' was set to by that
11713 The value `mode-exit' is special; it means that the previous command
11714 read an event that told it to exit, and it did so and unread that event.
11715 In other words, the present command is the event that made the previous
11718 The value `kill-region' is special; it means that the previous command
11719 was a kill command.
11721 `last-command' has a separate binding for each terminal device.
11722 See Info node `(elisp)Multiple Terminals'. */);
11724 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11725 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11727 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11728 doc
: /* Last command that may be repeated.
11729 The last command executed that was not bound to an input event.
11730 This is the command `repeat' will try to repeat. */);
11732 DEFVAR_LISP ("this-command", Vthis_command
,
11733 doc
: /* The command now being executed.
11734 The command can set this variable; whatever is put here
11735 will be in `last-command' during the following command. */);
11736 Vthis_command
= Qnil
;
11738 DEFVAR_LISP ("this-command-keys-shift-translated",
11739 Vthis_command_keys_shift_translated
,
11740 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11741 Shift-translation occurs when there is no binding for the key sequence
11742 as entered, but a binding was found by changing an upper-case letter
11743 to lower-case, or a shifted function key to an unshifted one. */);
11744 Vthis_command_keys_shift_translated
= Qnil
;
11746 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11747 doc
: /* The command bound to the current key sequence before remapping.
11748 It equals `this-command' if the original command was not remapped through
11749 any of the active keymaps. Otherwise, the value of `this-command' is the
11750 result of looking up the original command in the active keymaps. */);
11751 Vthis_original_command
= Qnil
;
11753 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11754 doc
: /* *Number of input events between auto-saves.
11755 Zero means disable autosaving due to number of characters typed. */);
11756 auto_save_interval
= 300;
11758 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11759 doc
: /* *Number of seconds idle time before auto-save.
11760 Zero or nil means disable auto-saving due to idleness.
11761 After auto-saving due to this many seconds of idle time,
11762 Emacs also does a garbage collection if that seems to be warranted. */);
11763 XSETFASTINT (Vauto_save_timeout
, 30);
11765 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11766 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11767 The value may be integer or floating point. */);
11768 Vecho_keystrokes
= make_number (1);
11770 DEFVAR_INT ("polling-period", polling_period
,
11771 doc
: /* *Interval between polling for input during Lisp execution.
11772 The reason for polling is to make C-g work to stop a running program.
11773 Polling is needed only when using X windows and SIGIO does not work.
11774 Polling is automatically disabled in all other cases. */);
11775 polling_period
= 2;
11777 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11778 doc
: /* *Maximum time between mouse clicks to make a double-click.
11779 Measured in milliseconds. The value nil means disable double-click
11780 recognition; t means double-clicks have no time limit and are detected
11781 by position only. */);
11782 Vdouble_click_time
= make_number (500);
11784 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11785 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11786 On window-system frames, value is the number of pixels the mouse may have
11787 moved horizontally or vertically between two clicks to make a double-click.
11788 On non window-system frames, value is interpreted in units of 1/8 characters
11791 This variable is also the threshold for motion of the mouse
11792 to count as a drag. */);
11793 double_click_fuzz
= 3;
11795 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11796 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11797 inhibit_local_menu_bar_menus
= 0;
11799 DEFVAR_INT ("num-input-keys", num_input_keys
,
11800 doc
: /* Number of complete key sequences read as input so far.
11801 This includes key sequences read from keyboard macros.
11802 The number is effectively the number of interactive command invocations. */);
11803 num_input_keys
= 0;
11805 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11806 doc
: /* Number of input events read from the keyboard so far.
11807 This does not include events generated by keyboard macros. */);
11808 num_nonmacro_input_events
= 0;
11810 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11811 doc
: /* The frame in which the most recently read event occurred.
11812 If the last event came from a keyboard macro, this is set to `macro'. */);
11813 Vlast_event_frame
= Qnil
;
11815 /* This variable is set up in sysdep.c. */
11816 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11817 doc
: /* The ERASE character as set by the user with stty. */);
11819 DEFVAR_LISP ("help-char", Vhelp_char
,
11820 doc
: /* Character to recognize as meaning Help.
11821 When it is read, do `(eval help-form)', and display result if it's a string.
11822 If the value of `help-form' is nil, this char can be read normally. */);
11823 XSETINT (Vhelp_char
, Ctl ('H'));
11825 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11826 doc
: /* List of input events to recognize as meaning Help.
11827 These work just like the value of `help-char' (see that). */);
11828 Vhelp_event_list
= Qnil
;
11830 DEFVAR_LISP ("help-form", Vhelp_form
,
11831 doc
: /* Form to execute when character `help-char' is read.
11832 If the form returns a string, that string is displayed.
11833 If `help-form' is nil, the help char is not recognized. */);
11836 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11837 doc
: /* Command to run when `help-char' character follows a prefix key.
11838 This command is used only when there is no actual binding
11839 for that character after that prefix key. */);
11840 Vprefix_help_command
= Qnil
;
11842 DEFVAR_LISP ("top-level", Vtop_level
,
11843 doc
: /* Form to evaluate when Emacs starts up.
11844 Useful to set before you dump a modified Emacs. */);
11847 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11848 doc
: /* Translate table for local keyboard input, or nil.
11849 If non-nil, the value should be a char-table. Each character read
11850 from the keyboard is looked up in this char-table. If the value found
11851 there is non-nil, then it is used instead of the actual input character.
11853 The value can also be a string or vector, but this is considered obsolete.
11854 If it is a string or vector of length N, character codes N and up are left
11855 untranslated. In a vector, an element which is nil means "no translation".
11857 This is applied to the characters supplied to input methods, not their
11858 output. See also `translation-table-for-input'.
11860 This variable has a separate binding for each terminal.
11861 See Info node `(elisp)Multiple Terminals'. */);
11863 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11864 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11865 \(Even if the operating system has support for stopping a process.\) */);
11866 cannot_suspend
= 0;
11868 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11869 doc
: /* Non-nil means prompt with menus when appropriate.
11870 This is done when reading from a keymap that has a prompt string,
11871 for elements that have prompt strings.
11872 The menu is displayed on the screen
11873 if X menus were enabled at configuration
11874 time and the previous event was a mouse click prefix key.
11875 Otherwise, menu prompting uses the echo area. */);
11876 menu_prompting
= 1;
11878 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11879 doc
: /* Character to see next line of menu prompt.
11880 Type this character while in a menu prompt to rotate around the lines of it. */);
11881 XSETINT (menu_prompt_more_char
, ' ');
11883 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11884 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11885 Emacs applies the modifiers of the character stored here to each keyboard
11886 character it reads. For example, after evaluating the expression
11887 (setq extra-keyboard-modifiers ?\\C-x)
11888 all input characters will have the control modifier applied to them.
11890 Note that the character ?\\C-@, equivalent to the integer zero, does
11891 not count as a control character; rather, it counts as a character
11892 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11893 cancels any modification. */);
11894 extra_keyboard_modifiers
= 0;
11896 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11897 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11898 The command loop sets this to nil before each command,
11899 and tests the value when the command returns.
11900 Buffer modification stores t in this variable. */);
11901 Vdeactivate_mark
= Qnil
;
11902 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11904 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11905 doc
: /* Normal hook run before each command is executed.
11906 If an unhandled error happens in running this hook,
11907 the function in which the error occurred is unconditionally removed, since
11908 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11909 Vpre_command_hook
= Qnil
;
11911 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11912 doc
: /* Normal hook run after each command is executed.
11913 If an unhandled error happens in running this hook,
11914 the function in which the error occurred is unconditionally removed, since
11915 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11916 Vpost_command_hook
= Qnil
;
11919 DEFVAR_LISP ("echo-area-clear-hook", ...,
11920 doc
: /* Normal hook run when clearing the echo area. */);
11922 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11923 Fset (Qecho_area_clear_hook
, Qnil
);
11925 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11926 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11927 Vlucid_menu_bar_dirty_flag
= Qnil
;
11929 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11930 doc
: /* List of menu bar items to move to the end of the menu bar.
11931 The elements of the list are event types that may have menu bar bindings. */);
11932 Vmenu_bar_final_items
= Qnil
;
11934 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11935 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11936 This is used internally by graphical displays that do not render
11937 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11938 Vtool_bar_separator_image_expression
= Qnil
;
11940 DEFVAR_KBOARD ("overriding-terminal-local-map",
11941 Voverriding_terminal_local_map
,
11942 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11943 If this variable is non-nil, it is used as a keymap instead of the
11944 buffer's local map, and the minor mode keymaps and text property keymaps.
11945 It also replaces `overriding-local-map'.
11947 This variable is intended to let commands such as `universal-argument'
11948 set up a different keymap for reading the next command.
11950 `overriding-terminal-local-map' has a separate binding for each
11952 See Info node `(elisp)Multiple Terminals'. */);
11954 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11955 doc
: /* Keymap that overrides all other local keymaps.
11956 If this variable is non-nil, it is used as a keymap--replacing the
11957 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11958 Voverriding_local_map
= Qnil
;
11960 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11961 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11962 Otherwise, the menu bar continues to reflect the buffer's local map
11963 and the minor mode maps regardless of `overriding-local-map'. */);
11964 Voverriding_local_map_menu_flag
= Qnil
;
11966 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11967 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11968 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11970 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11971 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11973 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11974 doc
: /* Alist of system-specific X windows key symbols.
11975 Each element should have the form (N . SYMBOL) where N is the
11976 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11977 and SYMBOL is its name.
11979 `system-key-alist' has a separate binding for each terminal device.
11980 See Info node `(elisp)Multiple Terminals'. */);
11982 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11983 doc
: /* Keymap that translates key sequences to key sequences during input.
11984 This is used mainly for mapping key sequences into some preferred
11985 key events (symbols).
11987 The `read-key-sequence' function replaces any subsequence bound by
11988 `local-function-key-map' with its binding. More precisely, when the
11989 active keymaps have no binding for the current key sequence but
11990 `local-function-key-map' binds a suffix of the sequence to a vector or
11991 string, `read-key-sequence' replaces the matching suffix with its
11992 binding, and continues with the new sequence.
11994 If the binding is a function, it is called with one argument (the prompt)
11995 and its return value (a key sequence) is used.
11997 The events that come from bindings in `local-function-key-map' are not
11998 themselves looked up in `local-function-key-map'.
12000 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12001 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12002 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12003 typing `ESC O P x' would return [f1 x].
12005 `local-function-key-map' has a separate binding for each terminal
12006 device. See Info node `(elisp)Multiple Terminals'. If you need to
12007 define a binding on all terminals, change `function-key-map'
12008 instead. Initially, `local-function-key-map' is an empty keymap that
12009 has `function-key-map' as its parent on all terminal devices. */);
12011 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12012 doc
: /* Keymap that decodes input escape sequences.
12013 This is used mainly for mapping ASCII function key sequences into
12014 real Emacs function key events (symbols).
12016 The `read-key-sequence' function replaces any subsequence bound by
12017 `input-decode-map' with its binding. Contrary to `function-key-map',
12018 this map applies its rebinding regardless of the presence of an ordinary
12019 binding. So it is more like `key-translation-map' except that it applies
12020 before `function-key-map' rather than after.
12022 If the binding is a function, it is called with one argument (the prompt)
12023 and its return value (a key sequence) is used.
12025 The events that come from bindings in `input-decode-map' are not
12026 themselves looked up in `input-decode-map'.
12028 This variable is keyboard-local. */);
12030 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12031 doc
: /* The parent keymap of all `local-function-key-map' instances.
12032 Function key definitions that apply to all terminal devices should go
12033 here. If a mapping is defined in both the current
12034 `local-function-key-map' binding and this variable, then the local
12035 definition will take precendence. */);
12036 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12038 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12039 doc
: /* Keymap of key translations that can override keymaps.
12040 This keymap works like `function-key-map', but comes after that,
12041 and its non-prefix bindings override ordinary bindings.
12042 Another difference is that it is global rather than keyboard-local. */);
12043 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12045 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12046 doc
: /* List of deferred actions to be performed at a later time.
12047 The precise format isn't relevant here; we just check whether it is nil. */);
12048 Vdeferred_action_list
= Qnil
;
12050 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12051 doc
: /* Function to call to handle deferred actions, after each command.
12052 This function is called with no arguments after each command
12053 whenever `deferred-action-list' is non-nil. */);
12054 Vdeferred_action_function
= Qnil
;
12056 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12057 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12058 The value can be a length of time to show the message for.
12059 If the value is non-nil and not a number, we wait 2 seconds. */);
12060 Vsuggest_key_bindings
= Qt
;
12062 DEFVAR_LISP ("timer-list", Vtimer_list
,
12063 doc
: /* List of active absolute time timers in order of increasing time. */);
12064 Vtimer_list
= Qnil
;
12066 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12067 doc
: /* List of active idle-time timers in order of increasing time. */);
12068 Vtimer_idle_list
= Qnil
;
12070 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12071 doc
: /* If non-nil, the function that implements the current input method.
12072 It's called with one argument, a printing character that was just read.
12073 \(That means a character with code 040...0176.)
12074 Typically this function uses `read-event' to read additional events.
12075 When it does so, it should first bind `input-method-function' to nil
12076 so it will not be called recursively.
12078 The function should return a list of zero or more events
12079 to be used as input. If it wants to put back some events
12080 to be reconsidered, separately, by the input method,
12081 it can add them to the beginning of `unread-command-events'.
12083 The input method function can find in `input-method-previous-message'
12084 the previous echo area message.
12086 The input method function should refer to the variables
12087 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12088 for guidance on what to do. */);
12089 Vinput_method_function
= Qnil
;
12091 DEFVAR_LISP ("input-method-previous-message",
12092 Vinput_method_previous_message
,
12093 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12094 This variable exists because `read-event' clears the echo area
12095 before running the input method. It is nil if there was no message. */);
12096 Vinput_method_previous_message
= Qnil
;
12098 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12099 doc
: /* If non-nil, the function that implements the display of help.
12100 It's called with one argument, the help string to display. */);
12101 Vshow_help_function
= Qnil
;
12103 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12104 doc
: /* If non-nil, suppress point adjustment after executing a command.
12106 After a command is executed, if point is moved into a region that has
12107 special properties (e.g. composition, display), we adjust point to
12108 the boundary of the region. But, when a command sets this variable to
12109 non-nil, we suppress the point adjustment.
12111 This variable is set to nil before reading a command, and is checked
12112 just after executing the command. */);
12113 Vdisable_point_adjustment
= Qnil
;
12115 DEFVAR_LISP ("global-disable-point-adjustment",
12116 Vglobal_disable_point_adjustment
,
12117 doc
: /* *If non-nil, always suppress point adjustment.
12119 The default value is nil, in which case, point adjustment are
12120 suppressed only after special commands that set
12121 `disable-point-adjustment' (which see) to non-nil. */);
12122 Vglobal_disable_point_adjustment
= Qnil
;
12124 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12125 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12126 If the value is not a number, such messages don't time out. */);
12127 Vminibuffer_message_timeout
= make_number (2);
12129 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12130 doc
: /* If non-nil, any keyboard input throws to this symbol.
12131 The value of that variable is passed to `quit-flag' and later causes a
12132 peculiar kind of quitting. */);
12133 Vthrow_on_input
= Qnil
;
12135 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12136 doc
: /* If non-nil, function to output error messages.
12137 The arguments are the error data, a list of the form
12138 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12139 such as just as `condition-case' would bind its variable to,
12140 the context (a string which normally goes at the start of the message),
12141 and the Lisp function within which the error was signaled. */);
12142 Vcommand_error_function
= Qnil
;
12144 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12145 Venable_disabled_menus_and_buttons
,
12146 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12148 Help functions bind this to allow help on disabled menu items
12149 and tool-bar buttons. */);
12150 Venable_disabled_menus_and_buttons
= Qnil
;
12152 DEFVAR_LISP ("select-active-regions",
12153 Vselect_active_regions
,
12154 doc
: /* If non-nil, an active region automatically sets the primary selection.
12155 If the value is `only', only temporarily active regions (usually made
12156 by mouse-dragging or shift-selection) set the window selection.
12158 This takes effect only when Transient Mark mode is enabled. */);
12159 Vselect_active_regions
= Qt
;
12161 DEFVAR_LISP ("saved-region-selection",
12162 Vsaved_region_selection
,
12163 doc
: /* Contents of active region prior to buffer modification.
12164 If `select-active-regions' is non-nil, Emacs sets this to the
12165 text in the region before modifying the buffer. The next
12166 `deactivate-mark' call uses this to set the window selection. */);
12167 Vsaved_region_selection
= Qnil
;
12169 /* Create the initial keyboard. */
12170 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12171 init_kboard (initial_kboard
);
12172 /* Vwindow_system is left at t for now. */
12173 initial_kboard
->next_kboard
= all_kboards
;
12174 all_kboards
= initial_kboard
;
12178 keys_of_keyboard (void)
12180 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12181 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12182 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12183 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12184 initial_define_key (meta_map
, 'x', "execute-extended-command");
12186 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12187 "handle-delete-frame");
12188 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12189 "ns-put-working-text");
12190 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12191 "ns-unput-working-text");
12192 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12193 current-prefix-arg, as is done in `handle-switch-frame'.
12194 But `handle-switch-frame is not run from the special-map.
12195 Commands from that map are run in a special way that automatically
12196 preserves the prefix-arg. Restoring the prefix arg here is not just
12197 redundant but harmful:
12199 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12200 - after the first prompt, the exit-minibuffer-hook is run which may
12201 iconify a frame and thus push a `iconify-frame' event.
12202 - after running exit-minibuffer-hook, current-prefix-arg is
12203 restored to the non-nil value it had before the prompt.
12204 - we enter the second prompt.
12205 current-prefix-arg is non-nil, prefix-arg is nil.
12206 - before running the first real event, we run the special iconify-frame
12207 event, but we pass the `special' arg to execute-command so
12208 current-prefix-arg and prefix-arg are left untouched.
12209 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12210 - the next key event will have a spuriously non-nil current-prefix-arg. */
12211 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12213 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12215 /* Handling it at such a low-level causes read_key_sequence to get
12216 * confused because it doesn't realize that the current_buffer was
12217 * changed by read_char.
12219 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12220 * "handle-select-window"); */
12221 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12222 "handle-save-session");
12225 /* Define a special event which is raised for dbus callback
12227 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12228 "dbus-handle-event");
12231 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12235 /* Mark the pointers in the kboard objects.
12236 Called by the Fgarbage_collector. */
12238 mark_kboards (void)
12242 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12244 if (kb
->kbd_macro_buffer
)
12245 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12247 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12248 mark_object (KVAR (kb
, Vlast_command
));
12249 mark_object (KVAR (kb
, Vreal_last_command
));
12250 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12251 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12252 mark_object (KVAR (kb
, Vprefix_arg
));
12253 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12254 mark_object (KVAR (kb
, kbd_queue
));
12255 mark_object (KVAR (kb
, defining_kbd_macro
));
12256 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12257 mark_object (KVAR (kb
, Vsystem_key_alist
));
12258 mark_object (KVAR (kb
, system_key_syms
));
12259 mark_object (KVAR (kb
, Vwindow_system
));
12260 mark_object (KVAR (kb
, Vinput_decode_map
));
12261 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12262 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12263 mark_object (KVAR (kb
, echo_string
));
12266 struct input_event
*event
;
12267 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12269 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12270 event
= kbd_buffer
;
12271 if (event
->kind
!= SELECTION_REQUEST_EVENT
12272 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12274 mark_object (event
->x
);
12275 mark_object (event
->y
);
12277 mark_object (event
->frame_or_window
);
12278 mark_object (event
->arg
);