1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
100 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
101 static int single_kboard
;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled
;
106 static Lisp_Object Qdisabled_command_function
;
108 #define NUM_RECENT_KEYS (300)
110 /* Index for storing next element into recent_keys. */
111 static int recent_keys_index
;
113 /* Total number of elements stored into recent_keys. */
114 static int total_keys
;
116 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
117 static Lisp_Object recent_keys
;
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 int this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 static int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 static Lisp_Object raw_keybuf
;
134 static int raw_keybuf_count
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
138 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 static int this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static int before_command_key_count
;
147 static int before_command_echo_length
;
149 /* For longjmp to where kbd input is being done. */
151 static jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 int waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
160 /* Non-null means we can start echoing at the next input pause even
161 though there is something in the echo area. */
163 static struct kboard
*ok_to_echo_at_next_pause
;
165 /* The kboard last echoing, or null for none. Reset to 0 in
166 cancel_echoing. If non-null, and a current echo area message
167 exists, and echo_message_buffer is eq to the current message
168 buffer, we know that the message comes from echo_kboard. */
170 struct kboard
*echo_kboard
;
172 /* The buffer used for echoing. Set in echo_now, reset in
175 Lisp_Object echo_message_buffer
;
177 /* Nonzero means C-g should cause immediate error-signal. */
180 /* Character that causes a quit. Normally C-g.
182 If we are running on an ordinary terminal, this must be an ordinary
183 ASCII char, since we want to make it our interrupt character.
185 If we are not running on an ordinary terminal, it still needs to be
186 an ordinary ASCII char. This character needs to be recognized in
187 the input interrupt handler. At this point, the keystroke is
188 represented as a struct input_event, while the desired quit
189 character is specified as a lispy event. The mapping from struct
190 input_events to lispy events cannot run in an interrupt handler,
191 and the reverse mapping is difficult for anything but ASCII
194 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
198 /* Current depth in recursive edits. */
199 EMACS_INT command_loop_level
;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame
;
210 /* Last size recorded for a current buffer which is not a minibuffer. */
211 static EMACS_INT last_non_minibuf_size
;
213 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
214 uintmax_t num_input_events
;
216 /* Value of num_nonmacro_input_events as of last auto save. */
218 static int last_auto_save
;
220 /* This is like Vthis_command, except that commands never set it. */
221 Lisp_Object real_this_command
;
223 /* The value of point when the last command was started. */
224 static EMACS_INT last_point_position
;
226 /* The buffer that was current when the last command was started. */
227 static Lisp_Object last_point_position_buffer
;
229 /* The window that was selected when the last command was started. */
230 static Lisp_Object last_point_position_window
;
232 /* The frame in which the last input event occurred, or Qmacro if the
233 last event came from a macro. We use this to determine when to
234 generate switch-frame events. This may be cleared by functions
235 like Fselect_frame, to make sure that a switch-frame event is
236 generated by the next character. */
237 Lisp_Object internal_last_event_frame
;
239 /* The timestamp of the last input event we received from the X server.
240 X Windows wants this for selection ownership. */
241 Time last_event_timestamp
;
243 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
244 Lisp_Object QPRIMARY
;
246 static Lisp_Object Qself_insert_command
;
247 static Lisp_Object Qforward_char
;
248 static Lisp_Object Qbackward_char
;
249 Lisp_Object Qundefined
;
250 static Lisp_Object Qtimer_event_handler
;
252 /* read_key_sequence stores here the command definition of the
253 key sequence that it reads. */
254 static Lisp_Object read_key_sequence_cmd
;
255 static Lisp_Object read_key_sequence_remapped
;
257 static Lisp_Object Qinput_method_function
;
259 static Lisp_Object Qdeactivate_mark
;
261 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
263 static Lisp_Object Qecho_area_clear_hook
;
265 /* Hooks to run before and after each command. */
266 static Lisp_Object Qpre_command_hook
;
267 static Lisp_Object Qpost_command_hook
;
269 static Lisp_Object Qdeferred_action_function
;
271 static Lisp_Object Qdelayed_warnings_hook
;
273 static Lisp_Object Qinput_method_exit_on_first_char
;
274 static Lisp_Object Qinput_method_use_echo_area
;
276 static Lisp_Object Qhelp_form_show
;
278 /* File in which we write all commands we read. */
279 static FILE *dribble
;
281 /* Nonzero if input is available. */
284 /* Circular buffer for pre-read keyboard input. */
286 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
288 /* Pointer to next available character in kbd_buffer.
289 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
290 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
291 next available char is in kbd_buffer[0]. */
292 static struct input_event
*kbd_fetch_ptr
;
294 /* Pointer to next place to store character in kbd_buffer. This
295 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
296 character should go in kbd_buffer[0]. */
297 static struct input_event
* volatile kbd_store_ptr
;
299 /* The above pair of variables forms a "queue empty" flag. When we
300 enqueue a non-hook event, we increment kbd_store_ptr. When we
301 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
302 there is input available if the two pointers are not equal.
304 Why not just have a flag set and cleared by the enqueuing and
305 dequeuing functions? Such a flag could be screwed up by interrupts
306 at inopportune times. */
308 /* Symbols to head events. */
309 static Lisp_Object Qmouse_movement
;
310 static Lisp_Object Qscroll_bar_movement
;
311 Lisp_Object Qswitch_frame
;
312 static Lisp_Object Qdelete_frame
;
313 static Lisp_Object Qiconify_frame
;
314 static Lisp_Object Qmake_frame_visible
;
315 static Lisp_Object Qselect_window
;
316 Lisp_Object Qhelp_echo
;
318 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
319 static Lisp_Object Qmouse_fixup_help_message
;
322 /* Symbols to denote kinds of events. */
323 static Lisp_Object Qfunction_key
;
324 Lisp_Object Qmouse_click
;
325 #if defined (WINDOWSNT)
326 Lisp_Object Qlanguage_change
;
328 static Lisp_Object Qdrag_n_drop
;
329 static Lisp_Object Qsave_session
;
331 static Lisp_Object Qdbus_event
;
334 Lisp_Object Qxwidget_event
;
336 static Lisp_Object Qconfig_changed_event
;
338 /* Lisp_Object Qmouse_movement; - also an event header */
340 /* Properties of event headers. */
341 Lisp_Object Qevent_kind
;
342 static Lisp_Object Qevent_symbol_elements
;
344 /* Menu and tool bar item parts. */
345 static Lisp_Object Qmenu_enable
;
346 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
347 Lisp_Object QCfilter
;
349 /* Non-nil disable property on a command means
350 do not execute it; call disabled-command-function's value instead. */
351 Lisp_Object QCtoggle
, QCradio
;
352 static Lisp_Object QCbutton
, QClabel
;
354 static Lisp_Object QCvert_only
;
356 /* An event header symbol HEAD may have a property named
357 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
358 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
359 mask of modifiers applied to it. If present, this is used to help
360 speed up parse_modifiers. */
361 Lisp_Object Qevent_symbol_element_mask
;
363 /* An unmodified event header BASE may have a property named
364 Qmodifier_cache, which is an alist mapping modifier masks onto
365 modified versions of BASE. If present, this helps speed up
367 static Lisp_Object Qmodifier_cache
;
369 /* Symbols to use for parts of windows. */
370 Lisp_Object Qmode_line
;
371 Lisp_Object Qvertical_line
;
372 static Lisp_Object Qvertical_scroll_bar
;
373 Lisp_Object Qmenu_bar
;
375 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
376 static Lisp_Object
command_loop (void);
377 static Lisp_Object Qextended_command_history
;
378 EMACS_TIME
timer_check (void);
380 static void record_menu_key (Lisp_Object c
);
381 static void echo_now (void);
382 static int echo_length (void);
384 static Lisp_Object Qpolling_period
;
386 /* Incremented whenever a timer is run. */
389 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
391 EMACS_TIME
*input_available_clear_time
;
393 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
394 Default is 1 if INTERRUPT_INPUT is defined. */
397 /* Nonzero while interrupts are temporarily deferred during redisplay. */
398 int interrupts_deferred
;
400 /* Allow m- file to inhibit use of FIONREAD. */
401 #ifdef BROKEN_FIONREAD
405 /* We are unable to use interrupts if FIONREAD is not available,
406 so flush SIGIO so we won't try. */
407 #if !defined (FIONREAD)
413 /* If we support a window system, turn on the code to poll periodically
414 to detect C-g. It isn't actually used when doing interrupt input. */
415 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
416 #define POLL_FOR_INPUT
419 /* The time when Emacs started being idle. */
421 static EMACS_TIME timer_idleness_start_time
;
423 /* After Emacs stops being idle, this saves the last value
424 of timer_idleness_start_time from when it was idle. */
426 static EMACS_TIME timer_last_idleness_start_time
;
429 /* Global variable declarations. */
431 /* Flags for readable_events. */
432 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
433 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
434 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
436 /* Function for init_keyboard to call with no args (if nonzero). */
437 static void (*keyboard_init_hook
) (void);
439 static int read_avail_input (int);
440 static void get_input_pending (int *, int);
441 static int readable_events (int);
442 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
444 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
446 static Lisp_Object
make_lispy_event (struct input_event
*);
447 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
448 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
449 enum scroll_bar_part
,
450 Lisp_Object
, Lisp_Object
,
453 static Lisp_Object
modify_event_symbol (EMACS_INT
, unsigned, Lisp_Object
,
454 Lisp_Object
, const char *const *,
455 Lisp_Object
*, EMACS_INT
);
456 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
457 static int help_char_p (Lisp_Object
);
458 static void save_getcjmp (jmp_buf);
459 static void restore_getcjmp (jmp_buf);
460 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
461 static void clear_event (struct input_event
*);
462 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
463 static void interrupt_signal (int signalnum
);
465 static void input_available_signal (int signo
);
467 static Lisp_Object (Fcommand_execute
) (Lisp_Object
, Lisp_Object
, Lisp_Object
,
469 static void handle_interrupt (void);
470 static void quit_throw_to_read_char (int) NO_RETURN
;
471 static void process_special_events (void);
472 static void timer_start_idle (void);
473 static void timer_stop_idle (void);
474 static void timer_resume_idle (void);
475 static void handle_user_signal (int);
476 static char *find_user_signal_name (int);
477 static int store_user_signal_events (void);
480 /* Add C to the echo string, if echoing is going on.
481 C can be a character, which is printed prettily ("M-C-x" and all that
482 jazz), or a symbol, whose name is printed. */
485 echo_char (Lisp_Object c
)
487 if (current_kboard
->immediate_echo
)
489 int size
= KEY_DESCRIPTION_SIZE
+ 100;
490 char *buffer
= (char *) alloca (size
);
492 Lisp_Object echo_string
;
494 echo_string
= KVAR (current_kboard
, echo_string
);
496 /* If someone has passed us a composite event, use its head symbol. */
501 ptr
= push_key_description (XINT (c
), ptr
, 1);
503 else if (SYMBOLP (c
))
505 Lisp_Object name
= SYMBOL_NAME (c
);
506 int nbytes
= SBYTES (name
);
508 if (size
- (ptr
- buffer
) < nbytes
)
510 int offset
= ptr
- buffer
;
511 size
= max (2 * size
, size
+ nbytes
);
512 buffer
= (char *) alloca (size
);
513 ptr
= buffer
+ offset
;
516 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
517 STRING_MULTIBYTE (name
), 1);
520 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
523 const char *text
= " (Type ? for further options)";
524 int len
= strlen (text
);
526 if (size
- (ptr
- buffer
) < len
)
528 int offset
= ptr
- buffer
;
530 buffer
= (char *) alloca (size
);
531 ptr
= buffer
+ offset
;
534 memcpy (ptr
, text
, len
);
538 /* Replace a dash from echo_dash with a space, otherwise
539 add a space at the end as a separator between keys. */
540 if (STRINGP (echo_string
)
541 && SCHARS (echo_string
) > 1)
543 Lisp_Object last_char
, prev_char
, idx
;
545 idx
= make_number (SCHARS (echo_string
) - 2);
546 prev_char
= Faref (echo_string
, idx
);
548 idx
= make_number (SCHARS (echo_string
) - 1);
549 last_char
= Faref (echo_string
, idx
);
551 /* We test PREV_CHAR to make sure this isn't the echoing
553 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
554 Faset (echo_string
, idx
, make_number (' '));
556 echo_string
= concat2 (echo_string
, build_string (" "));
558 else if (STRINGP (echo_string
))
559 echo_string
= concat2 (echo_string
, build_string (" "));
561 KVAR (current_kboard
, echo_string
)
562 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
568 /* Temporarily add a dash to the end of the echo string if it's not
569 empty, so that it serves as a mini-prompt for the very next character. */
574 /* Do nothing if not echoing at all. */
575 if (NILP (KVAR (current_kboard
, echo_string
)))
578 if (this_command_key_count
== 0)
581 if (!current_kboard
->immediate_echo
582 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
585 /* Do nothing if we just printed a prompt. */
586 if (current_kboard
->echo_after_prompt
587 == SCHARS (KVAR (current_kboard
, echo_string
)))
590 /* Do nothing if we have already put a dash at the end. */
591 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
593 Lisp_Object last_char
, prev_char
, idx
;
595 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
596 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
598 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
599 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
601 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
605 /* Put a dash at the end of the buffer temporarily,
606 but make it go away when the next character is added. */
607 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
612 /* Display the current echo string, and begin echoing if not already
618 if (!current_kboard
->immediate_echo
)
621 current_kboard
->immediate_echo
= 1;
623 for (i
= 0; i
< this_command_key_count
; i
++)
627 /* Set before_command_echo_length to the value that would
628 have been saved before the start of this subcommand in
629 command_loop_1, if we had already been echoing then. */
630 if (i
== this_single_command_key_start
)
631 before_command_echo_length
= echo_length ();
633 c
= XVECTOR (this_command_keys
)->contents
[i
];
634 if (! (EVENT_HAS_PARAMETERS (c
)
635 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
639 /* Set before_command_echo_length to the value that would
640 have been saved before the start of this subcommand in
641 command_loop_1, if we had already been echoing then. */
642 if (this_command_key_count
== this_single_command_key_start
)
643 before_command_echo_length
= echo_length ();
645 /* Put a dash at the end to invite the user to type more. */
650 message3_nolog (KVAR (current_kboard
, echo_string
),
651 SBYTES (KVAR (current_kboard
, echo_string
)),
652 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
655 /* Record in what buffer we echoed, and from which kboard. */
656 echo_message_buffer
= echo_area_buffer
[0];
657 echo_kboard
= current_kboard
;
659 if (waiting_for_input
&& !NILP (Vquit_flag
))
660 quit_throw_to_read_char (0);
663 /* Turn off echoing, for the start of a new command. */
666 cancel_echoing (void)
668 current_kboard
->immediate_echo
= 0;
669 current_kboard
->echo_after_prompt
= -1;
670 KVAR (current_kboard
, echo_string
) = Qnil
;
671 ok_to_echo_at_next_pause
= NULL
;
673 echo_message_buffer
= Qnil
;
676 /* Return the length of the current echo string. */
681 return (STRINGP (KVAR (current_kboard
, echo_string
))
682 ? SCHARS (KVAR (current_kboard
, echo_string
))
686 /* Truncate the current echo message to its first LEN chars.
687 This and echo_char get used by read_key_sequence when the user
688 switches frames while entering a key sequence. */
691 echo_truncate (EMACS_INT nchars
)
693 if (STRINGP (KVAR (current_kboard
, echo_string
)))
694 KVAR (current_kboard
, echo_string
)
695 = Fsubstring (KVAR (current_kboard
, echo_string
),
696 make_number (0), make_number (nchars
));
697 truncate_echo_area (nchars
);
701 /* Functions for manipulating this_command_keys. */
703 add_command_key (Lisp_Object key
)
705 #if 0 /* Not needed after we made Freset_this_command_lengths
706 do the job immediately. */
707 /* If reset-this-command-length was called recently, obey it now.
708 See the doc string of that function for an explanation of why. */
709 if (before_command_restore_flag
)
711 this_command_key_count
= before_command_key_count_1
;
712 if (this_command_key_count
< this_single_command_key_start
)
713 this_single_command_key_start
= this_command_key_count
;
714 echo_truncate (before_command_echo_length_1
);
715 before_command_restore_flag
= 0;
719 if (this_command_key_count
>= ASIZE (this_command_keys
))
720 this_command_keys
= larger_vector (this_command_keys
,
721 2 * ASIZE (this_command_keys
),
724 ASET (this_command_keys
, this_command_key_count
, key
);
725 ++this_command_key_count
;
730 recursive_edit_1 (void)
732 int count
= SPECPDL_INDEX ();
735 if (command_loop_level
> 0)
737 specbind (Qstandard_output
, Qt
);
738 specbind (Qstandard_input
, Qt
);
741 #ifdef HAVE_WINDOW_SYSTEM
742 /* The command loop has started an hourglass timer, so we have to
743 cancel it here, otherwise it will fire because the recursive edit
744 can take some time. Do not check for display_hourglass_p here,
745 because it could already be nil. */
749 /* This function may have been called from a debugger called from
750 within redisplay, for instance by Edebugging a function called
751 from fontification-functions. We want to allow redisplay in
752 the debugging session.
754 The recursive edit is left with a `(throw exit ...)'. The `exit'
755 tag is not caught anywhere in redisplay, i.e. when we leave the
756 recursive edit, the original redisplay leading to the recursive
757 edit will be unwound. The outcome should therefore be safe. */
758 specbind (Qinhibit_redisplay
, Qnil
);
761 val
= command_loop ();
763 Fsignal (Qquit
, Qnil
);
764 /* Handle throw from read_minibuf when using minibuffer
765 while it's active but we're in another window. */
767 xsignal1 (Qerror
, val
);
769 return unbind_to (count
, Qnil
);
772 /* When an auto-save happens, record the "time", and don't do again soon. */
775 record_auto_save (void)
777 last_auto_save
= num_nonmacro_input_events
;
780 /* Make an auto save happen as soon as possible at command level. */
784 force_auto_save_soon (void)
786 last_auto_save
= - auto_save_interval
- 1;
788 record_asynch_buffer_change ();
792 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
793 doc
: /* Invoke the editor command loop recursively.
794 To get out of the recursive edit, a command can do `(throw 'exit nil)';
795 that tells this function to return.
796 Alternatively, `(throw 'exit t)' makes this function signal an error.
797 This function is called by the editor initialization to begin editing. */)
800 int count
= SPECPDL_INDEX ();
803 /* If we enter while input is blocked, don't lock up here.
804 This may happen through the debugger during redisplay. */
808 command_loop_level
++;
809 update_mode_lines
= 1;
811 if (command_loop_level
812 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
813 buffer
= Fcurrent_buffer ();
817 /* If we leave recursive_edit_1 below with a `throw' for instance,
818 like it is done in the splash screen display, we have to
819 make sure that we restore single_kboard as command_loop_1
820 would have done if it were left normally. */
821 if (command_loop_level
> 0)
822 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
823 record_unwind_protect (recursive_edit_unwind
, buffer
);
826 return unbind_to (count
, Qnil
);
830 recursive_edit_unwind (Lisp_Object buffer
)
832 if (BUFFERP (buffer
))
833 Fset_buffer (buffer
);
835 command_loop_level
--;
836 update_mode_lines
= 1;
841 #if 0 /* These two functions are now replaced with
842 temporarily_switch_to_single_kboard. */
846 #if 0 /* Theory: if there's anything in Vunread_command_events,
847 it will right away be read by read_key_sequence,
848 and then if we do switch KBOARDS, it will go into the side
849 queue then. So we don't need to do anything special here -- rms. */
850 if (CONSP (Vunread_command_events
))
852 current_kboard
->kbd_queue
853 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
854 current_kboard
->kbd_queue_has_data
= 1;
856 Vunread_command_events
= Qnil
;
861 /* Switch to the single-kboard state, making current_kboard
862 the only KBOARD from which further input is accepted. */
865 single_kboard_state ()
871 /* If we're in single_kboard state for kboard KBOARD,
875 not_single_kboard_state (KBOARD
*kboard
)
877 if (kboard
== current_kboard
)
881 /* Maintain a stack of kboards, so other parts of Emacs
882 can switch temporarily to the kboard of a given frame
883 and then revert to the previous status. */
888 struct kboard_stack
*next
;
891 static struct kboard_stack
*kboard_stack
;
894 push_kboard (struct kboard
*k
)
896 struct kboard_stack
*p
897 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
899 p
->next
= kboard_stack
;
900 p
->kboard
= current_kboard
;
910 struct kboard_stack
*p
= kboard_stack
;
912 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
914 if (t
->kboard
== p
->kboard
)
916 current_kboard
= p
->kboard
;
923 /* The terminal we remembered has been deleted. */
924 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
927 kboard_stack
= p
->next
;
931 /* Switch to single_kboard mode, making current_kboard the only KBOARD
932 from which further input is accepted. If F is non-nil, set its
933 KBOARD as the current keyboard.
935 This function uses record_unwind_protect to return to the previous
938 If Emacs is already in single_kboard mode, and F's keyboard is
939 locked, then this function will throw an error. */
942 temporarily_switch_to_single_kboard (struct frame
*f
)
944 int was_locked
= single_kboard
;
947 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
948 /* We can not switch keyboards while in single_kboard mode.
949 In rare cases, Lisp code may call `recursive-edit' (or
950 `read-minibuffer' or `y-or-n-p') after it switched to a
951 locked frame. For example, this is likely to happen
952 when server.el connects to a new terminal while Emacs is in
953 single_kboard mode. It is best to throw an error instead
954 of presenting the user with a frozen screen. */
955 error ("Terminal %d is locked, cannot read from it",
956 FRAME_TERMINAL (f
)->id
);
958 /* This call is unnecessary, but helps
959 `restore_kboard_configuration' discover if somebody changed
960 `current_kboard' behind our back. */
961 push_kboard (current_kboard
);
964 current_kboard
= FRAME_KBOARD (f
);
966 record_unwind_protect (restore_kboard_configuration
,
967 (was_locked
? Qt
: Qnil
));
970 #if 0 /* This function is not needed anymore. */
972 record_single_kboard_state ()
975 push_kboard (current_kboard
);
976 record_unwind_protect (restore_kboard_configuration
,
977 (single_kboard
? Qt
: Qnil
));
982 restore_kboard_configuration (Lisp_Object was_locked
)
984 if (NILP (was_locked
))
988 struct kboard
*prev
= current_kboard
;
991 /* The pop should not change the kboard. */
992 if (single_kboard
&& current_kboard
!= prev
)
999 /* Handle errors that are not handled at inner levels
1000 by printing an error message and returning to the editor command loop. */
1003 cmd_error (Lisp_Object data
)
1005 Lisp_Object old_level
, old_length
;
1006 char macroerror
[sizeof "After..kbd macro iterations: "
1007 + INT_STRLEN_BOUND (EMACS_INT
)];
1009 #ifdef HAVE_WINDOW_SYSTEM
1010 if (display_hourglass_p
)
1011 cancel_hourglass ();
1014 if (!NILP (executing_kbd_macro
))
1016 if (executing_kbd_macro_iterations
== 1)
1017 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1019 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1020 executing_kbd_macro_iterations
);
1025 Vstandard_output
= Qt
;
1026 Vstandard_input
= Qt
;
1027 Vexecuting_kbd_macro
= Qnil
;
1028 executing_kbd_macro
= Qnil
;
1029 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1030 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1033 /* Avoid unquittable loop if data contains a circular list. */
1034 old_level
= Vprint_level
;
1035 old_length
= Vprint_length
;
1036 XSETFASTINT (Vprint_level
, 10);
1037 XSETFASTINT (Vprint_length
, 10);
1038 cmd_error_internal (data
, macroerror
);
1039 Vprint_level
= old_level
;
1040 Vprint_length
= old_length
;
1044 Vinhibit_quit
= Qnil
;
1045 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1046 if (command_loop_level
== 0 && minibuf_level
== 0)
1047 any_kboard_state ();
1050 return make_number (0);
1053 /* Take actions on handling an error. DATA is the data that describes
1056 CONTEXT is a C-string containing ASCII characters only which
1057 describes the context in which the error happened. If we need to
1058 generalize CONTEXT to allow multibyte characters, make it a Lisp
1062 cmd_error_internal (Lisp_Object data
, const char *context
)
1064 struct frame
*sf
= SELECTED_FRAME ();
1066 /* The immediate context is not interesting for Quits,
1067 since they are asynchronous. */
1068 if (EQ (XCAR (data
), Qquit
))
1069 Vsignaling_function
= Qnil
;
1074 /* Use user's specified output function if any. */
1075 if (!NILP (Vcommand_error_function
))
1076 call3 (Vcommand_error_function
, data
,
1077 context
? build_string (context
) : empty_unibyte_string
,
1078 Vsignaling_function
);
1079 /* If the window system or terminal frame hasn't been initialized
1080 yet, or we're not interactive, write the message to stderr and exit. */
1081 else if (!sf
->glyphs_initialized_p
1082 /* The initial frame is a special non-displaying frame. It
1083 will be current in daemon mode when there are no frames
1084 to display, and in non-daemon mode before the real frame
1085 has finished initializing. If an error is thrown in the
1086 latter case while creating the frame, then the frame
1087 will never be displayed, so the safest thing to do is
1088 write to stderr and quit. In daemon mode, there are
1089 many other potential errors that do not prevent frames
1090 from being created, so continuing as normal is better in
1092 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1095 print_error_message (data
, Qexternal_debugging_output
,
1096 context
, Vsignaling_function
);
1097 Fterpri (Qexternal_debugging_output
);
1098 Fkill_emacs (make_number (-1));
1102 clear_message (1, 0);
1104 message_log_maybe_newline ();
1107 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1110 Vsignaling_function
= Qnil
;
1113 Lisp_Object
command_loop_1 (void);
1114 static Lisp_Object
command_loop_2 (Lisp_Object
);
1115 static Lisp_Object
top_level_1 (Lisp_Object
);
1117 /* Entry to editor-command-loop.
1118 This level has the catches for exiting/returning to editor command loop.
1119 It returns nil to exit recursive edit, t to abort it. */
1124 if (command_loop_level
> 0 || minibuf_level
> 0)
1127 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1128 executing_kbd_macro
= Qnil
;
1134 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1135 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1136 /* Reset single_kboard in case top-level set it while
1137 evaluating an -f option, or we are stuck there for some
1139 any_kboard_state ();
1141 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1142 executing_kbd_macro
= Qnil
;
1144 /* End of file in -batch run causes exit here. */
1150 /* Here we catch errors in execution of commands within the
1151 editing loop, and reenter the editing loop.
1152 When there is an error, cmd_error runs and returns a non-nil
1153 value to us. A value of nil means that command_loop_1 itself
1154 returned due to end of file (or end of kbd macro). */
1157 command_loop_2 (Lisp_Object ignore
)
1159 register Lisp_Object val
;
1162 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1163 while (!NILP (val
));
1171 return Feval (Vtop_level
, Qnil
);
1175 top_level_1 (Lisp_Object ignore
)
1177 /* On entry to the outer level, run the startup file */
1178 if (!NILP (Vtop_level
))
1179 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1180 else if (!NILP (Vpurify_flag
))
1181 message ("Bare impure Emacs (standard Lisp code not loaded)");
1183 message ("Bare Emacs (standard Lisp code not loaded)");
1187 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1188 doc
: /* Exit all recursive editing levels.
1189 This also exits all active minibuffers. */)
1192 #ifdef HAVE_WINDOW_SYSTEM
1193 if (display_hourglass_p
)
1194 cancel_hourglass ();
1197 /* Unblock input if we enter with input blocked. This may happen if
1198 redisplay traps e.g. during tool-bar update with input blocked. */
1199 while (INPUT_BLOCKED_P
)
1202 Fthrow (Qtop_level
, Qnil
);
1205 static Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1206 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1207 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1210 if (command_loop_level
> 0 || minibuf_level
> 0)
1211 Fthrow (Qexit
, Qnil
);
1213 error ("No recursive edit is in progress");
1216 static Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1217 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1218 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1221 if (command_loop_level
> 0 || minibuf_level
> 0)
1224 error ("No recursive edit is in progress");
1227 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1229 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1230 of this function. */
1233 tracking_off (Lisp_Object old_value
)
1235 do_mouse_tracking
= old_value
;
1236 if (NILP (old_value
))
1238 /* Redisplay may have been preempted because there was input
1239 available, and it assumes it will be called again after the
1240 input has been processed. If the only input available was
1241 the sort that we have just disabled, then we need to call
1243 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1245 redisplay_preserve_echo_area (6);
1246 get_input_pending (&input_pending
,
1247 READABLE_EVENTS_DO_TIMERS_NOW
);
1253 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1254 doc
: /* Evaluate BODY with mouse movement events enabled.
1255 Within a `track-mouse' form, mouse motion generates input events that
1256 you can read with `read-event'.
1257 Normally, mouse motion is ignored.
1258 usage: (track-mouse BODY...) */)
1261 int count
= SPECPDL_INDEX ();
1264 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1266 do_mouse_tracking
= Qt
;
1268 val
= Fprogn (args
);
1269 return unbind_to (count
, val
);
1272 /* If mouse has moved on some frame, return one of those frames.
1276 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1277 after resizing the tool-bar window. */
1279 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1282 int ignore_mouse_drag_p
;
1285 some_mouse_moved (void)
1287 Lisp_Object tail
, frame
;
1289 if (ignore_mouse_drag_p
)
1291 /* ignore_mouse_drag_p = 0; */
1295 FOR_EACH_FRAME (tail
, frame
)
1297 if (XFRAME (frame
)->mouse_moved
)
1298 return XFRAME (frame
);
1304 #endif /* HAVE_MOUSE || HAVE_GPM */
1306 /* This is the actual command reading loop,
1307 sans error-handling encapsulation. */
1309 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1311 void safe_run_hooks (Lisp_Object
);
1312 static void adjust_point_for_property (EMACS_INT
, int);
1314 /* Cancel hourglass from protect_unwind.
1316 #ifdef HAVE_WINDOW_SYSTEM
1318 cancel_hourglass_unwind (Lisp_Object arg
)
1320 cancel_hourglass ();
1325 /* FIXME: This is wrong rather than test window-system, we should call
1326 a new set-selection, which will then dispatch to x-set-selection, or
1327 tty-set-selection, or w32-set-selection, ... */
1328 EXFUN (Fwindow_system
, 1);
1331 command_loop_1 (void)
1334 Lisp_Object keybuf
[30];
1336 int prev_modiff
= 0;
1337 struct buffer
*prev_buffer
= NULL
;
1338 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1339 int was_locked
= single_kboard
;
1341 int already_adjusted
= 0;
1343 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1344 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1345 Vdeactivate_mark
= Qnil
;
1346 waiting_for_input
= 0;
1349 this_command_key_count
= 0;
1350 this_command_key_count_reset
= 0;
1351 this_single_command_key_start
= 0;
1353 if (NILP (Vmemory_full
))
1355 /* Make sure this hook runs after commands that get errors and
1356 throw to top level. */
1357 /* Note that the value cell will never directly contain nil
1358 if the symbol is a local variable. */
1359 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1360 safe_run_hooks (Qpost_command_hook
);
1362 /* If displaying a message, resize the echo area window to fit
1363 that message's size exactly. */
1364 if (!NILP (echo_area_buffer
[0]))
1365 resize_echo_area_exactly ();
1367 /* If there are warnings waiting, process them. */
1368 if (!NILP (Vdelayed_warnings_list
))
1369 safe_run_hooks (Qdelayed_warnings_hook
);
1371 if (!NILP (Vdeferred_action_list
))
1372 safe_run_hooks (Qdeferred_action_function
);
1375 /* Do this after running Vpost_command_hook, for consistency. */
1376 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1377 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1378 if (!CONSP (last_command_event
))
1379 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1383 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1386 /* Make sure the current window's buffer is selected. */
1387 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1388 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1390 /* Display any malloc warning that just came out. Use while because
1391 displaying one warning can cause another. */
1393 while (pending_malloc_warning
)
1394 display_malloc_warning ();
1396 Vdeactivate_mark
= Qnil
;
1398 /* If minibuffer on and echo area in use,
1399 wait a short time and redraw minibuffer. */
1402 && !NILP (echo_area_buffer
[0])
1403 && EQ (minibuf_window
, echo_area_window
)
1404 && NUMBERP (Vminibuffer_message_timeout
))
1406 /* Bind inhibit-quit to t so that C-g gets read in
1407 rather than quitting back to the minibuffer. */
1408 int count
= SPECPDL_INDEX ();
1409 specbind (Qinhibit_quit
, Qt
);
1411 sit_for (Vminibuffer_message_timeout
, 0, 2);
1413 /* Clear the echo area. */
1415 safe_run_hooks (Qecho_area_clear_hook
);
1417 unbind_to (count
, Qnil
);
1419 /* If a C-g came in before, treat it as input now. */
1420 if (!NILP (Vquit_flag
))
1423 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1428 /* Select the frame that the last event came from. Usually,
1429 switch-frame events will take care of this, but if some lisp
1430 code swallows a switch-frame event, we'll fix things up here.
1431 Is this a good idea? */
1432 if (FRAMEP (internal_last_event_frame
)
1433 && !EQ (internal_last_event_frame
, selected_frame
))
1434 Fselect_frame (internal_last_event_frame
, Qnil
);
1436 /* If it has changed current-menubar from previous value,
1437 really recompute the menubar from the value. */
1438 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1439 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1440 call0 (Qrecompute_lucid_menubar
);
1442 before_command_key_count
= this_command_key_count
;
1443 before_command_echo_length
= echo_length ();
1445 Vthis_command
= Qnil
;
1446 real_this_command
= Qnil
;
1447 Vthis_original_command
= Qnil
;
1448 Vthis_command_keys_shift_translated
= Qnil
;
1450 /* Read next key sequence; i gets its length. */
1451 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1454 /* A filter may have run while we were reading the input. */
1455 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1457 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1458 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1462 /* Now we have read a key sequence of length I,
1463 or else I is 0 and we found end of file. */
1465 if (i
== 0) /* End of file -- happens only in */
1466 return Qnil
; /* a kbd macro, at the end. */
1467 /* -1 means read_key_sequence got a menu that was rejected.
1468 Just loop around and read another command. */
1472 this_command_key_count
= 0;
1473 this_command_key_count_reset
= 0;
1474 this_single_command_key_start
= 0;
1478 last_command_event
= keybuf
[i
- 1];
1480 /* If the previous command tried to force a specific window-start,
1481 forget about that, in case this command moves point far away
1482 from that position. But also throw away beg_unchanged and
1483 end_unchanged information in that case, so that redisplay will
1484 update the whole window properly. */
1485 if (!NILP (XWINDOW (selected_window
)->force_start
))
1488 XWINDOW (selected_window
)->force_start
= Qnil
;
1489 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1490 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1493 cmd
= read_key_sequence_cmd
;
1494 if (!NILP (Vexecuting_kbd_macro
))
1496 if (!NILP (Vquit_flag
))
1498 Vexecuting_kbd_macro
= Qt
;
1499 QUIT
; /* Make some noise. */
1500 /* Will return since macro now empty. */
1504 /* Do redisplay processing after this command except in special
1505 cases identified below. */
1506 prev_buffer
= current_buffer
;
1507 prev_modiff
= MODIFF
;
1508 last_point_position
= PT
;
1509 last_point_position_window
= selected_window
;
1510 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1512 /* By default, we adjust point to a boundary of a region that
1513 has such a property that should be treated intangible
1514 (e.g. composition, display). But, some commands will set
1515 this variable differently. */
1516 Vdisable_point_adjustment
= Qnil
;
1518 /* Process filters and timers may have messed with deactivate-mark.
1519 reset it before we execute the command. */
1520 Vdeactivate_mark
= Qnil
;
1522 /* Remap command through active keymaps. */
1523 Vthis_original_command
= cmd
;
1524 if (!NILP (read_key_sequence_remapped
))
1525 cmd
= read_key_sequence_remapped
;
1527 /* Execute the command. */
1529 Vthis_command
= cmd
;
1530 real_this_command
= cmd
;
1531 safe_run_hooks (Qpre_command_hook
);
1533 already_adjusted
= 0;
1535 if (NILP (Vthis_command
))
1537 /* nil means key is undefined. */
1538 Lisp_Object keys
= Fvector (i
, keybuf
);
1539 keys
= Fkey_description (keys
, Qnil
);
1541 message_with_string ("%s is undefined", keys
, 0);
1542 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1543 update_mode_lines
= 1;
1544 /* If this is a down-mouse event, don't reset prefix-arg;
1545 pass it to the command run by the up event. */
1546 if (EVENT_HAS_PARAMETERS (last_command_event
))
1548 Lisp_Object breakdown
1549 = parse_modifiers (EVENT_HEAD (last_command_event
));
1550 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1551 if (!(modifiers
& down_modifier
))
1552 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1555 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1559 /* Here for a command that isn't executed directly. */
1561 #ifdef HAVE_WINDOW_SYSTEM
1562 int scount
= SPECPDL_INDEX ();
1564 if (display_hourglass_p
1565 && NILP (Vexecuting_kbd_macro
))
1567 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1572 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1574 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1576 #ifdef HAVE_WINDOW_SYSTEM
1577 /* Do not check display_hourglass_p here, because
1578 Fcommand_execute could change it, but we should cancel
1579 hourglass cursor anyway.
1580 But don't cancel the hourglass within a macro
1581 just because a command in the macro finishes. */
1582 if (NILP (Vexecuting_kbd_macro
))
1583 unbind_to (scount
, Qnil
);
1586 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1588 safe_run_hooks (Qpost_command_hook
);
1590 /* If displaying a message, resize the echo area window to fit
1591 that message's size exactly. */
1592 if (!NILP (echo_area_buffer
[0]))
1593 resize_echo_area_exactly ();
1595 /* If there are warnings waiting, process them. */
1596 if (!NILP (Vdelayed_warnings_list
))
1597 safe_run_hooks (Qdelayed_warnings_hook
);
1599 safe_run_hooks (Qdeferred_action_function
);
1601 /* If there is a prefix argument,
1602 1) We don't want Vlast_command to be ``universal-argument''
1603 (that would be dumb), so don't set Vlast_command,
1604 2) we want to leave echoing on so that the prefix will be
1605 echoed as part of this key sequence, so don't call
1607 3) we want to leave this_command_key_count non-zero, so that
1608 read_char will realize that it is re-reading a character, and
1609 not echo it a second time.
1611 If the command didn't actually create a prefix arg,
1612 but is merely a frame event that is transparent to prefix args,
1613 then the above doesn't apply. */
1614 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1616 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1617 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1618 if (!CONSP (last_command_event
))
1619 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1621 this_command_key_count
= 0;
1622 this_command_key_count_reset
= 0;
1623 this_single_command_key_start
= 0;
1626 if (!NILP (BVAR (current_buffer
, mark_active
))
1627 && !NILP (Vrun_hooks
))
1629 /* In Emacs 22, setting transient-mark-mode to `only' was a
1630 way of turning it on for just one command. This usage is
1631 obsolete, but support it anyway. */
1632 if (EQ (Vtransient_mark_mode
, Qidentity
))
1633 Vtransient_mark_mode
= Qnil
;
1634 else if (EQ (Vtransient_mark_mode
, Qonly
))
1635 Vtransient_mark_mode
= Qidentity
;
1637 if (!NILP (Vdeactivate_mark
))
1638 /* If `select-active-regions' is non-nil, this call to
1639 `deactivate-mark' also sets the PRIMARY selection. */
1640 call0 (Qdeactivate_mark
);
1643 /* Even if not deactivating the mark, set PRIMARY if
1644 `select-active-regions' is non-nil. */
1645 if (!NILP (Fwindow_system (Qnil
))
1646 /* Even if mark_active is non-nil, the actual buffer
1647 marker may not have been set yet (Bug#7044). */
1648 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1649 && (EQ (Vselect_active_regions
, Qonly
)
1650 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1651 : (!NILP (Vselect_active_regions
)
1652 && !NILP (Vtransient_mark_mode
)))
1653 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1656 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1659 call2 (Qx_set_selection
, QPRIMARY
,
1660 make_buffer_string (beg
, end
, 0));
1662 call2 (Qx_set_selection
, QPRIMARY
,
1663 make_buffer_string (end
, beg
, 0));
1664 /* Don't set empty selections. */
1667 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1669 Lisp_Object hook
= intern ("activate-mark-hook");
1670 Frun_hooks (1, &hook
);
1674 Vsaved_region_selection
= Qnil
;
1679 if (current_buffer
== prev_buffer
1680 && last_point_position
!= PT
1681 && NILP (Vdisable_point_adjustment
)
1682 && NILP (Vglobal_disable_point_adjustment
))
1684 if (last_point_position
> BEGV
1685 && last_point_position
< ZV
1686 && (composition_adjust_point (last_point_position
,
1687 last_point_position
)
1688 != last_point_position
))
1689 /* The last point was temporarily set within a grapheme
1690 cluster to prevent automatic composition. To recover
1691 the automatic composition, we must update the
1693 windows_or_buffers_changed
++;
1694 if (!already_adjusted
)
1695 adjust_point_for_property (last_point_position
,
1696 MODIFF
!= prev_modiff
);
1699 /* Install chars successfully executed in kbd macro. */
1701 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1702 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1703 finalize_kbd_macro_chars ();
1704 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1706 any_kboard_state ();
1711 /* Adjust point to a boundary of a region that has such a property
1712 that should be treated intangible. For the moment, we check
1713 `composition', `display' and `invisible' properties.
1714 LAST_PT is the last position of point. */
1717 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1720 Lisp_Object val
, overlay
, tmp
;
1721 /* When called after buffer modification, we should temporarily
1722 suppress the point adjustment for automatic composition so that a
1723 user can keep inserting another character at point or keep
1724 deleting characters around point. */
1725 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1726 EMACS_INT orig_pt
= PT
;
1728 /* FIXME: cycling is probably not necessary because these properties
1729 can't be usefully combined anyway. */
1730 while (check_composition
|| check_display
|| check_invisible
)
1732 /* FIXME: check `intangible'. */
1733 if (check_composition
1734 && PT
> BEGV
&& PT
< ZV
1735 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1738 check_display
= check_invisible
= 1;
1740 check_composition
= 0;
1742 && PT
> BEGV
&& PT
< ZV
1743 && !NILP (val
= get_char_property_and_overlay
1744 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1745 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1746 && (!OVERLAYP (overlay
)
1747 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1748 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1749 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1750 && (beg
< PT
/* && end > PT <- It's always the case. */
1751 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1754 SET_PT (PT
< last_pt
1755 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1757 check_composition
= check_invisible
= 1;
1760 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1762 int inv
, ellipsis
= 0;
1765 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1768 /* FIXME: We should stop if we find a spot between
1769 two runs of `invisible' where inserted text would
1770 be visible. This is important when we have two
1771 invisible boundaries that enclose an area: if the
1772 area is empty, we need this test in order to make
1773 it possible to place point in the middle rather
1774 than skip both boundaries. However, this code
1775 also stops anywhere in a non-sticky text-property,
1776 which breaks (e.g.) Org mode. */
1777 && (val
= get_pos_property (make_number (end
),
1779 TEXT_PROP_MEANS_INVISIBLE (val
))
1781 && !NILP (val
= get_char_property_and_overlay
1782 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1783 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1785 ellipsis
= ellipsis
|| inv
> 1
1786 || (OVERLAYP (overlay
)
1787 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1788 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1789 tmp
= Fnext_single_char_property_change
1790 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1791 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1795 && (val
= get_pos_property (make_number (beg
),
1797 TEXT_PROP_MEANS_INVISIBLE (val
))
1799 && !NILP (val
= get_char_property_and_overlay
1800 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1801 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1803 ellipsis
= ellipsis
|| inv
> 1
1804 || (OVERLAYP (overlay
)
1805 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1806 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1807 tmp
= Fprevious_single_char_property_change
1808 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1809 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1812 /* Move away from the inside area. */
1813 if (beg
< PT
&& end
> PT
)
1815 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1816 /* We haven't moved yet (so we don't need to fear
1817 infinite-looping) and we were outside the range
1818 before (so either end of the range still corresponds
1819 to a move in the right direction): pretend we moved
1820 less than we actually did, so that we still have
1821 more freedom below in choosing which end of the range
1823 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1824 /* We either have moved already or the last point
1825 was already in the range: we don't get to choose
1826 which end of the range we have to go to. */
1827 : (PT
< last_pt
? beg
: end
));
1828 check_composition
= check_display
= 1;
1830 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1831 the point to something other than its argument, due to
1832 point-motion hooks, intangibility, etc. */
1833 xassert (PT
== beg
|| PT
== end
);
1836 /* Pretend the area doesn't exist if the buffer is not
1838 if (!modified
&& !ellipsis
&& beg
< end
)
1840 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1841 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1842 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1843 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1844 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1845 /* We've already moved as far as we can. Trying to go
1846 to the other end would mean moving backwards and thus
1847 could lead to an infinite loop. */
1849 else if (val
= get_pos_property (make_number (PT
),
1851 TEXT_PROP_MEANS_INVISIBLE (val
)
1852 && (val
= get_pos_property
1853 (make_number (PT
== beg
? end
: beg
),
1855 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1856 (check_composition
= check_display
= 1,
1857 SET_PT (PT
== beg
? end
: beg
));
1860 check_invisible
= 0;
1864 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1867 safe_run_hooks_1 (void)
1869 eassert (CONSP (Vinhibit_quit
));
1870 return call0 (XCDR (Vinhibit_quit
));
1873 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1877 safe_run_hooks_error (Lisp_Object error_data
)
1880 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1881 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1882 Lisp_Object args
[4];
1883 args
[0] = build_string ("Error in %s (%s): %s");
1886 args
[3] = error_data
;
1892 Lisp_Object newval
= Qnil
;
1893 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1894 if (EQ (fun
, XCAR (val
)))
1897 newval
= Fcons (XCAR (val
), newval
);
1899 return Fset (hook
, Fnreverse (newval
));
1900 /* Not found in the local part of the hook. Let's look at the global
1903 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1904 : Fdefault_value (hook
));
1905 CONSP (val
); val
= XCDR (val
))
1906 if (EQ (fun
, XCAR (val
)))
1909 newval
= Fcons (XCAR (val
), newval
);
1911 return Fset_default (hook
, Fnreverse (newval
));
1917 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1919 eassert (nargs
== 1);
1920 if (CONSP (Vinhibit_quit
))
1921 XSETCDR (Vinhibit_quit
, args
[0]);
1923 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1925 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1929 /* If we get an error while running the hook, cause the hook variable
1930 to be nil. Also inhibit quits, so that C-g won't cause the hook
1931 to mysteriously evaporate. */
1934 safe_run_hooks (Lisp_Object hook
)
1936 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1937 to its body or to its handlers other than via globals such as
1938 dynamically-bound variables ;-) */
1939 int count
= SPECPDL_INDEX ();
1940 specbind (Qinhibit_quit
, hook
);
1942 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1944 unbind_to (count
, Qnil
);
1948 /* Nonzero means polling for input is temporarily suppressed. */
1950 int poll_suppress_count
;
1952 /* Asynchronous timer for polling. */
1954 static struct atimer
*poll_timer
;
1957 #ifdef POLL_FOR_INPUT
1959 /* Poll for input, so that we catch a C-g if it comes in. This
1960 function is called from x_make_frame_visible, see comment
1964 poll_for_input_1 (void)
1966 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1967 doing anything dangerous. */
1971 if (interrupt_input_blocked
== 0
1972 && !waiting_for_input
)
1973 read_avail_input (0);
1979 /* Timer callback function for poll_timer. TIMER is equal to
1983 poll_for_input (struct atimer
*timer
)
1985 if (poll_suppress_count
== 0)
1988 interrupt_input_pending
= 1;
1989 pending_signals
= 1;
1991 poll_for_input_1 ();
1996 #endif /* POLL_FOR_INPUT */
1998 /* Begin signals to poll for input, if they are appropriate.
1999 This function is called unconditionally from various places. */
2002 start_polling (void)
2004 #ifdef POLL_FOR_INPUT
2005 /* XXX This condition was (read_socket_hook && !interrupt_input),
2006 but read_socket_hook is not global anymore. Let's pretend that
2008 if (!interrupt_input
)
2010 /* Turn alarm handling on unconditionally. It might have
2011 been turned off in process.c. */
2012 turn_on_atimers (1);
2014 /* If poll timer doesn't exist, are we need one with
2015 a different interval, start a new one. */
2016 if (poll_timer
== NULL
2017 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2019 EMACS_TIME interval
;
2022 cancel_atimer (poll_timer
);
2024 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2025 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2026 poll_for_input
, NULL
);
2029 /* Let the timer's callback function poll for input
2030 if this becomes zero. */
2031 --poll_suppress_count
;
2036 /* Nonzero if we are using polling to handle input asynchronously. */
2039 input_polling_used (void)
2041 #ifdef POLL_FOR_INPUT
2042 /* XXX This condition was (read_socket_hook && !interrupt_input),
2043 but read_socket_hook is not global anymore. Let's pretend that
2045 return !interrupt_input
;
2051 /* Turn off polling. */
2056 #ifdef POLL_FOR_INPUT
2057 /* XXX This condition was (read_socket_hook && !interrupt_input),
2058 but read_socket_hook is not global anymore. Let's pretend that
2060 if (!interrupt_input
)
2061 ++poll_suppress_count
;
2065 /* Set the value of poll_suppress_count to COUNT
2066 and start or stop polling accordingly. */
2069 set_poll_suppress_count (int count
)
2071 #ifdef POLL_FOR_INPUT
2072 if (count
== 0 && poll_suppress_count
!= 0)
2074 poll_suppress_count
= 1;
2077 else if (count
!= 0 && poll_suppress_count
== 0)
2081 poll_suppress_count
= count
;
2085 /* Bind polling_period to a value at least N.
2086 But don't decrease it. */
2089 bind_polling_period (int n
)
2091 #ifdef POLL_FOR_INPUT
2092 int new = polling_period
;
2097 stop_other_atimers (poll_timer
);
2099 specbind (Qpolling_period
, make_number (new));
2100 /* Start a new alarm with the new period. */
2105 /* Apply the control modifier to CHARACTER. */
2108 make_ctrl_char (int c
)
2110 /* Save the upper bits here. */
2111 int upper
= c
& ~0177;
2113 if (! ASCII_BYTE_P (c
))
2114 return c
|= ctrl_modifier
;
2118 /* Everything in the columns containing the upper-case letters
2119 denotes a control character. */
2120 if (c
>= 0100 && c
< 0140)
2124 /* Set the shift modifier for a control char
2125 made from a shifted letter. But only for letters! */
2126 if (oc
>= 'A' && oc
<= 'Z')
2127 c
|= shift_modifier
;
2130 /* The lower-case letters denote control characters too. */
2131 else if (c
>= 'a' && c
<= 'z')
2134 /* Include the bits for control and shift
2135 only if the basic ASCII code can't indicate them. */
2139 /* Replace the high bits. */
2140 c
|= (upper
& ~ctrl_modifier
);
2145 /* Display the help-echo property of the character after the mouse pointer.
2146 Either show it in the echo area, or call show-help-function to display
2147 it by other means (maybe in a tooltip).
2149 If HELP is nil, that means clear the previous help echo.
2151 If HELP is a string, display that string. If HELP is a function,
2152 call it with OBJECT and POS as arguments; the function should
2153 return a help string or nil for none. For all other types of HELP,
2154 evaluate it to obtain a string.
2156 WINDOW is the window in which the help was generated, if any.
2157 It is nil if not in a window.
2159 If OBJECT is a buffer, POS is the position in the buffer where the
2160 `help-echo' text property was found.
2162 If OBJECT is an overlay, that overlay has a `help-echo' property,
2163 and POS is the position in the overlay's buffer under the mouse.
2165 If OBJECT is a string (an overlay string or a string displayed with
2166 the `display' property). POS is the position in that string under
2169 Note: this function may only be called with HELP nil or a string
2170 from X code running asynchronously. */
2173 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2176 if (!NILP (help
) && !STRINGP (help
))
2178 if (FUNCTIONP (help
))
2180 Lisp_Object args
[4];
2185 help
= safe_call (4, args
);
2188 help
= safe_eval (help
);
2190 if (!STRINGP (help
))
2194 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2195 if (!noninteractive
&& STRINGP (help
))
2197 /* The mouse-fixup-help-message Lisp function can call
2198 mouse_position_hook, which resets the mouse_moved flags.
2199 This causes trouble if we are trying to read a mouse motion
2200 event (i.e., if we are inside a `track-mouse' form), so we
2201 restore the mouse_moved flag. */
2202 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2203 help
= call1 (Qmouse_fixup_help_message
, help
);
2209 if (STRINGP (help
) || NILP (help
))
2211 if (!NILP (Vshow_help_function
))
2212 call1 (Vshow_help_function
, help
);
2213 help_echo_showing_p
= STRINGP (help
);
2219 /* Input of single characters from keyboard */
2221 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2222 struct timeval
*end_time
);
2223 static void record_char (Lisp_Object c
);
2225 static Lisp_Object help_form_saved_window_configs
;
2227 read_char_help_form_unwind (Lisp_Object arg
)
2229 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2230 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2231 if (!NILP (window_config
))
2232 Fset_window_configuration (window_config
);
2236 #define STOP_POLLING \
2237 do { if (! polling_stopped_here) stop_polling (); \
2238 polling_stopped_here = 1; } while (0)
2240 #define RESUME_POLLING \
2241 do { if (polling_stopped_here) start_polling (); \
2242 polling_stopped_here = 0; } while (0)
2244 /* read a character from the keyboard; call the redisplay if needed */
2245 /* commandflag 0 means do not autosave, but do redisplay.
2246 -1 means do not redisplay, but do autosave.
2249 /* The arguments MAPS and NMAPS are for menu prompting.
2250 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2252 PREV_EVENT is the previous input event, or nil if we are reading
2253 the first event of a key sequence (or not reading a key sequence).
2254 If PREV_EVENT is t, that is a "magic" value that says
2255 not to run input methods, but in other respects to act as if
2256 not reading a key sequence.
2258 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2259 if we used a mouse menu to read the input, or zero otherwise. If
2260 USED_MOUSE_MENU is null, we don't dereference it.
2262 Value is -2 when we find input on another keyboard. A second call
2263 to read_char will read it.
2265 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2266 specifying the maximum time to wait until. If no input arrives by
2267 that time, stop waiting and return nil.
2269 Value is t if we showed a menu and the user rejected it. */
2272 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2273 Lisp_Object prev_event
,
2274 int *used_mouse_menu
, struct timeval
*end_time
)
2276 volatile Lisp_Object c
;
2278 jmp_buf local_getcjmp
;
2280 volatile int key_already_recorded
= 0;
2281 Lisp_Object tem
, save
;
2282 volatile Lisp_Object previous_echo_area_message
;
2283 volatile Lisp_Object also_record
;
2284 volatile int reread
;
2285 struct gcpro gcpro1
, gcpro2
;
2286 int volatile polling_stopped_here
= 0;
2287 struct kboard
*orig_kboard
= current_kboard
;
2291 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2292 before_command_key_count
= this_command_key_count
;
2293 before_command_echo_length
= echo_length ();
2296 previous_echo_area_message
= Qnil
;
2298 GCPRO2 (c
, previous_echo_area_message
);
2303 if (CONSP (Vunread_post_input_method_events
))
2305 c
= XCAR (Vunread_post_input_method_events
);
2306 Vunread_post_input_method_events
2307 = XCDR (Vunread_post_input_method_events
);
2309 /* Undo what read_char_x_menu_prompt did when it unread
2310 additional keys returned by Fx_popup_menu. */
2312 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2320 if (unread_command_char
!= -1)
2322 XSETINT (c
, unread_command_char
);
2323 unread_command_char
= -1;
2329 if (CONSP (Vunread_command_events
))
2331 int was_disabled
= 0;
2333 c
= XCAR (Vunread_command_events
);
2334 Vunread_command_events
= XCDR (Vunread_command_events
);
2338 /* Undo what sit-for did when it unread additional keys
2339 inside universal-argument. */
2342 && EQ (XCAR (c
), Qt
))
2348 /* Undo what read_char_x_menu_prompt did when it unread
2349 additional keys returned by Fx_popup_menu. */
2351 && EQ (XCDR (c
), Qdisabled
)
2352 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2358 /* If the queued event is something that used the mouse,
2359 set used_mouse_menu accordingly. */
2361 /* Also check was_disabled so last-nonmenu-event won't return
2362 a bad value when submenus are involved. (Bug#447) */
2363 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2364 *used_mouse_menu
= 1;
2366 goto reread_for_input_method
;
2369 if (CONSP (Vunread_input_method_events
))
2371 c
= XCAR (Vunread_input_method_events
);
2372 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2374 /* Undo what read_char_x_menu_prompt did when it unread
2375 additional keys returned by Fx_popup_menu. */
2377 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2381 goto reread_for_input_method
;
2384 this_command_key_count_reset
= 0;
2386 if (!NILP (Vexecuting_kbd_macro
))
2388 /* We set this to Qmacro; since that's not a frame, nobody will
2389 try to switch frames on us, and the selected window will
2392 Since this event came from a macro, it would be misleading to
2393 leave internal_last_event_frame set to wherever the last
2394 real event came from. Normally, a switch-frame event selects
2395 internal_last_event_frame after each command is read, but
2396 events read from a macro should never cause a new frame to be
2398 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2400 /* Exit the macro if we are at the end.
2401 Also, some things replace the macro with t
2402 to force an early exit. */
2403 if (EQ (Vexecuting_kbd_macro
, Qt
)
2404 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2410 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2411 if (STRINGP (Vexecuting_kbd_macro
)
2412 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2413 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2415 executing_kbd_macro_index
++;
2420 if (!NILP (unread_switch_frame
))
2422 c
= unread_switch_frame
;
2423 unread_switch_frame
= Qnil
;
2425 /* This event should make it into this_command_keys, and get echoed
2426 again, so we do not set `reread'. */
2430 /* if redisplay was requested */
2431 if (commandflag
>= 0)
2433 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2435 /* If there is pending input, process any events which are not
2436 user-visible, such as X selection_request events. */
2438 || detect_input_pending_run_timers (0))
2439 swallow_events (0); /* may clear input_pending */
2441 /* Redisplay if no pending input. */
2442 while (!input_pending
)
2444 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2445 redisplay_preserve_echo_area (5);
2450 /* Normal case: no input arrived during redisplay. */
2453 /* Input arrived and pre-empted redisplay.
2454 Process any events which are not user-visible. */
2456 /* If that cleared input_pending, try again to redisplay. */
2459 /* Prevent the redisplay we just did
2460 from messing up echoing of the input after the prompt. */
2461 if (commandflag
== 0 && echo_current
)
2462 echo_message_buffer
= echo_area_buffer
[0];
2466 /* Message turns off echoing unless more keystrokes turn it on again.
2468 The code in 20.x for the condition was
2470 1. echo_area_glyphs && *echo_area_glyphs
2471 2. && echo_area_glyphs != current_kboard->echobuf
2472 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2474 (1) means there's a current message displayed
2476 (2) means it's not the message from echoing from the current
2479 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2480 is set to a non-null value. This is done in read_char and it is
2481 set to echo_area_glyphs after a call to echo_char. That means
2482 ok_to_echo_at_next_pause is either null or
2483 current_kboard->echobuf with the appropriate current_kboard at
2486 So, condition (3) means in clear text ok_to_echo_at_next_pause
2487 must be either null, or the current message isn't from echoing at
2488 all, or it's from echoing from a different kboard than the
2491 if (/* There currently is something in the echo area. */
2492 !NILP (echo_area_buffer
[0])
2493 && (/* And it's either not from echoing. */
2494 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2495 /* Or it's an echo from a different kboard. */
2496 || echo_kboard
!= current_kboard
2497 /* Or we explicitly allow overwriting whatever there is. */
2498 || ok_to_echo_at_next_pause
== NULL
))
2503 /* Try reading a character via menu prompting in the minibuf.
2504 Try this before the sit-for, because the sit-for
2505 would do the wrong thing if we are supposed to do
2506 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2507 after a mouse event so don't try a minibuf menu. */
2509 if (nmaps
> 0 && INTERACTIVE
2510 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2511 /* Don't bring up a menu if we already have another event. */
2512 && NILP (Vunread_command_events
)
2513 && unread_command_char
< 0
2514 && !detect_input_pending_run_timers (0))
2516 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2518 if (INTEGERP (c
) && XINT (c
) == -2)
2519 return c
; /* wrong_kboard_jmpbuf */
2523 key_already_recorded
= 1;
2528 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2529 We will do that below, temporarily for short sections of code,
2530 when appropriate. local_getcjmp must be in effect
2531 around any call to sit_for or kbd_buffer_get_event;
2532 it *must not* be in effect when we call redisplay. */
2534 jmpcount
= SPECPDL_INDEX ();
2535 if (_setjmp (local_getcjmp
))
2537 /* Handle quits while reading the keyboard. */
2538 /* We must have saved the outer value of getcjmp here,
2539 so restore it now. */
2540 restore_getcjmp (save_jump
);
2541 unbind_to (jmpcount
, Qnil
);
2542 XSETINT (c
, quit_char
);
2543 internal_last_event_frame
= selected_frame
;
2544 Vlast_event_frame
= internal_last_event_frame
;
2545 /* If we report the quit char as an event,
2546 don't do so more than once. */
2547 if (!NILP (Vinhibit_quit
))
2551 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2552 if (kb
!= current_kboard
)
2554 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2555 /* We shouldn't get here if we were in single-kboard mode! */
2560 while (CONSP (XCDR (last
)))
2562 if (!NILP (XCDR (last
)))
2566 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2568 XSETCDR (last
, Fcons (c
, Qnil
));
2569 kb
->kbd_queue_has_data
= 1;
2570 current_kboard
= kb
;
2571 /* This is going to exit from read_char
2572 so we had better get rid of this frame's stuff. */
2574 return make_number (-2); /* wrong_kboard_jmpbuf */
2580 /* Start idle timers if no time limit is supplied. We don't do it
2581 if a time limit is supplied to avoid an infinite recursion in the
2582 situation where an idle timer calls `sit-for'. */
2585 timer_start_idle ();
2587 /* If in middle of key sequence and minibuffer not active,
2588 start echoing if enough time elapses. */
2590 if (minibuf_level
== 0
2592 && !current_kboard
->immediate_echo
2593 && this_command_key_count
> 0
2595 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2596 && NILP (Fzerop (Vecho_keystrokes
))
2597 && (/* No message. */
2598 NILP (echo_area_buffer
[0])
2599 /* Or empty message. */
2600 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2601 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2602 /* Or already echoing from same kboard. */
2603 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2604 /* Or not echoing before and echoing allowed. */
2605 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2607 /* After a mouse event, start echoing right away.
2608 This is because we are probably about to display a menu,
2609 and we don't want to delay before doing so. */
2610 if (EVENT_HAS_PARAMETERS (prev_event
))
2616 save_getcjmp (save_jump
);
2617 restore_getcjmp (local_getcjmp
);
2618 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2619 restore_getcjmp (save_jump
);
2621 && ! CONSP (Vunread_command_events
))
2626 /* Maybe auto save due to number of keystrokes. */
2628 if (commandflag
!= 0
2629 && auto_save_interval
> 0
2630 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2631 && !detect_input_pending_run_timers (0))
2633 Fdo_auto_save (Qnil
, Qnil
);
2634 /* Hooks can actually change some buffers in auto save. */
2638 /* Try reading using an X menu.
2639 This is never confused with reading using the minibuf
2640 because the recursive call of read_char in read_char_minibuf_menu_prompt
2641 does not pass on any keymaps. */
2643 if (nmaps
> 0 && INTERACTIVE
2644 && !NILP (prev_event
)
2645 && EVENT_HAS_PARAMETERS (prev_event
)
2646 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2647 && !EQ (XCAR (prev_event
), Qtool_bar
)
2648 /* Don't bring up a menu if we already have another event. */
2649 && NILP (Vunread_command_events
)
2650 && unread_command_char
< 0)
2652 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2654 /* Now that we have read an event, Emacs is not idle. */
2661 /* Maybe autosave and/or garbage collect due to idleness. */
2663 if (INTERACTIVE
&& NILP (c
))
2666 EMACS_INT buffer_size
;
2668 /* Slow down auto saves logarithmically in size of current buffer,
2669 and garbage collect while we're at it. */
2670 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2671 last_non_minibuf_size
= Z
- BEG
;
2672 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2674 while (buffer_size
> 64)
2675 delay_level
++, buffer_size
-= buffer_size
>> 2;
2676 if (delay_level
< 4) delay_level
= 4;
2677 /* delay_level is 4 for files under around 50k, 7 at 100k,
2678 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2680 /* Auto save if enough time goes by without input. */
2681 if (commandflag
!= 0
2682 && num_nonmacro_input_events
> last_auto_save
2683 && INTEGERP (Vauto_save_timeout
)
2684 && XINT (Vauto_save_timeout
) > 0)
2687 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2689 save_getcjmp (save_jump
);
2690 restore_getcjmp (local_getcjmp
);
2691 tem0
= sit_for (make_number (timeout
), 1, 1);
2692 restore_getcjmp (save_jump
);
2695 && ! CONSP (Vunread_command_events
))
2697 Fdo_auto_save (Qnil
, Qnil
);
2699 /* If we have auto-saved and there is still no input
2700 available, garbage collect if there has been enough
2701 consing going on to make it worthwhile. */
2702 if (!detect_input_pending_run_timers (0)
2703 && consing_since_gc
> gc_cons_threshold
/ 2)
2704 Fgarbage_collect ();
2711 /* Notify the caller if an autosave hook, or a timer, sentinel or
2712 filter in the sit_for calls above have changed the current
2713 kboard. This could happen if they use the minibuffer or start a
2714 recursive edit, like the fancy splash screen in server.el's
2715 filter. If this longjmp wasn't here, read_key_sequence would
2716 interpret the next key sequence using the wrong translation
2717 tables and function keymaps. */
2718 if (NILP (c
) && current_kboard
!= orig_kboard
)
2721 return make_number (-2); /* wrong_kboard_jmpbuf */
2724 /* If this has become non-nil here, it has been set by a timer
2725 or sentinel or filter. */
2726 if (CONSP (Vunread_command_events
))
2728 c
= XCAR (Vunread_command_events
);
2729 Vunread_command_events
= XCDR (Vunread_command_events
);
2732 /* Read something from current KBOARD's side queue, if possible. */
2736 if (current_kboard
->kbd_queue_has_data
)
2738 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2740 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2741 KVAR (current_kboard
, kbd_queue
)
2742 = XCDR (KVAR (current_kboard
, kbd_queue
));
2743 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2744 current_kboard
->kbd_queue_has_data
= 0;
2745 input_pending
= readable_events (0);
2746 if (EVENT_HAS_PARAMETERS (c
)
2747 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2748 internal_last_event_frame
= XCAR (XCDR (c
));
2749 Vlast_event_frame
= internal_last_event_frame
;
2753 /* If current_kboard's side queue is empty check the other kboards.
2754 If one of them has data that we have not yet seen here,
2755 switch to it and process the data waiting for it.
2757 Note: if the events queued up for another kboard
2758 have already been seen here, and therefore are not a complete command,
2759 the kbd_queue_has_data field is 0, so we skip that kboard here.
2760 That's to avoid an infinite loop switching between kboards here. */
2761 if (NILP (c
) && !single_kboard
)
2764 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2765 if (kb
->kbd_queue_has_data
)
2767 current_kboard
= kb
;
2768 /* This is going to exit from read_char
2769 so we had better get rid of this frame's stuff. */
2771 return make_number (-2); /* wrong_kboard_jmpbuf */
2779 /* Finally, we read from the main queue,
2780 and if that gives us something we can't use yet, we put it on the
2781 appropriate side queue and try again. */
2785 KBOARD
*kb
IF_LINT (= NULL
);
2790 EMACS_GET_TIME (now
);
2791 if (EMACS_TIME_GE (now
, *end_time
))
2795 /* Actually read a character, waiting if necessary. */
2796 save_getcjmp (save_jump
);
2797 restore_getcjmp (local_getcjmp
);
2799 timer_start_idle ();
2800 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2801 restore_getcjmp (save_jump
);
2803 if (! NILP (c
) && (kb
!= current_kboard
))
2805 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2808 while (CONSP (XCDR (last
)))
2810 if (!NILP (XCDR (last
)))
2814 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2816 XSETCDR (last
, Fcons (c
, Qnil
));
2817 kb
->kbd_queue_has_data
= 1;
2821 current_kboard
= kb
;
2822 /* This is going to exit from read_char
2823 so we had better get rid of this frame's stuff. */
2825 return make_number (-2);
2829 /* Terminate Emacs in batch mode if at eof. */
2830 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2831 Fkill_emacs (make_number (1));
2835 /* Add in any extra modifiers, where appropriate. */
2836 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2837 || ((extra_keyboard_modifiers
& 0177) < ' '
2838 && (extra_keyboard_modifiers
& 0177) != 0))
2839 XSETINT (c
, make_ctrl_char (XINT (c
)));
2841 /* Transfer any other modifier bits directly from
2842 extra_keyboard_modifiers to c. Ignore the actual character code
2843 in the low 16 bits of extra_keyboard_modifiers. */
2844 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2855 if (commandflag
>= 0
2856 && !input_pending
&& !detect_input_pending_run_timers (0))
2864 /* Buffer switch events are only for internal wakeups
2865 so don't show them to the user.
2866 Also, don't record a key if we already did. */
2867 if (BUFFERP (c
) || key_already_recorded
)
2870 /* Process special events within read_char
2871 and loop around to read another event. */
2874 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2879 struct buffer
*prev_buffer
= current_buffer
;
2880 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2881 int was_locked
= single_kboard
;
2882 int count
= SPECPDL_INDEX ();
2883 record_single_kboard_state ();
2886 last_input_event
= c
;
2887 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2889 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2890 /* We stopped being idle for this event; undo that. This
2891 prevents automatic window selection (under
2892 mouse_autoselect_window from acting as a real input event, for
2893 example banishing the mouse under mouse-avoidance-mode. */
2894 timer_resume_idle ();
2896 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2897 /* Resume allowing input from any kboard, if that was true before. */
2899 any_kboard_state ();
2900 unbind_to (count
, Qnil
);
2903 if (current_buffer
!= prev_buffer
)
2905 /* The command may have changed the keymaps. Pretend there
2906 is input in another keyboard and return. This will
2907 recalculate keymaps. */
2908 c
= make_number (-2);
2915 /* Handle things that only apply to characters. */
2918 /* If kbd_buffer_get_event gave us an EOF, return that. */
2922 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2923 && UNSIGNED_CMP (XFASTINT (c
), <,
2924 SCHARS (KVAR (current_kboard
,
2925 Vkeyboard_translate_table
))))
2926 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2927 && UNSIGNED_CMP (XFASTINT (c
), <,
2928 ASIZE (KVAR (current_kboard
,
2929 Vkeyboard_translate_table
))))
2930 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2934 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2935 /* nil in keyboard-translate-table means no translation. */
2941 /* If this event is a mouse click in the menu bar,
2942 return just menu-bar for now. Modify the mouse click event
2943 so we won't do this twice, then queue it up. */
2944 if (EVENT_HAS_PARAMETERS (c
)
2946 && CONSP (EVENT_START (c
))
2947 && CONSP (XCDR (EVENT_START (c
))))
2951 posn
= POSN_POSN (EVENT_START (c
));
2952 /* Handle menu-bar events:
2953 insert the dummy prefix event `menu-bar'. */
2954 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2956 /* Change menu-bar to (menu-bar) as the event "position". */
2957 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2960 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2965 /* Store these characters into recent_keys, the dribble file if any,
2966 and the keyboard macro being defined, if any. */
2968 if (! NILP (also_record
))
2969 record_char (also_record
);
2971 /* Wipe the echo area.
2972 But first, if we are about to use an input method,
2973 save the echo area contents for it to refer to. */
2975 && ! NILP (Vinput_method_function
)
2976 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2978 previous_echo_area_message
= Fcurrent_message ();
2979 Vinput_method_previous_message
= previous_echo_area_message
;
2982 /* Now wipe the echo area, except for help events which do their
2983 own stuff with the echo area. */
2985 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2986 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2988 if (!NILP (echo_area_buffer
[0]))
2989 safe_run_hooks (Qecho_area_clear_hook
);
2990 clear_message (1, 0);
2993 reread_for_input_method
:
2995 /* Pass this to the input method, if appropriate. */
2997 && ! NILP (Vinput_method_function
)
2998 /* Don't run the input method within a key sequence,
2999 after the first event of the key sequence. */
3000 && NILP (prev_event
)
3001 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3004 int key_count
, key_count_reset
;
3005 struct gcpro gcpro1
;
3006 int count
= SPECPDL_INDEX ();
3008 /* Save the echo status. */
3009 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3010 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3011 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3012 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3015 if (before_command_restore_flag
)
3017 this_command_key_count
= before_command_key_count_1
;
3018 if (this_command_key_count
< this_single_command_key_start
)
3019 this_single_command_key_start
= this_command_key_count
;
3020 echo_truncate (before_command_echo_length_1
);
3021 before_command_restore_flag
= 0;
3025 /* Save the this_command_keys status. */
3026 key_count
= this_command_key_count
;
3027 key_count_reset
= this_command_key_count_reset
;
3030 keys
= Fcopy_sequence (this_command_keys
);
3035 /* Clear out this_command_keys. */
3036 this_command_key_count
= 0;
3037 this_command_key_count_reset
= 0;
3039 /* Now wipe the echo area. */
3040 if (!NILP (echo_area_buffer
[0]))
3041 safe_run_hooks (Qecho_area_clear_hook
);
3042 clear_message (1, 0);
3045 /* If we are not reading a key sequence,
3046 never use the echo area. */
3049 specbind (Qinput_method_use_echo_area
, Qt
);
3052 /* Call the input method. */
3053 tem
= call1 (Vinput_method_function
, c
);
3055 tem
= unbind_to (count
, tem
);
3057 /* Restore the saved echoing state
3058 and this_command_keys state. */
3059 this_command_key_count
= key_count
;
3060 this_command_key_count_reset
= key_count_reset
;
3062 this_command_keys
= keys
;
3065 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3066 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3067 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3068 if (saved_immediate_echo
)
3073 /* The input method can return no events. */
3076 /* Bring back the previous message, if any. */
3077 if (! NILP (previous_echo_area_message
))
3078 message_with_string ("%s", previous_echo_area_message
, 0);
3081 /* It returned one event or more. */
3083 Vunread_post_input_method_events
3084 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3089 /* Display help if not echoing. */
3090 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3092 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3093 Lisp_Object help
, object
, position
, window
, htem
;
3095 htem
= Fcdr (XCDR (c
));
3098 window
= Fcar (htem
);
3100 object
= Fcar (htem
);
3102 position
= Fcar (htem
);
3104 show_help_echo (help
, window
, object
, position
);
3106 /* We stopped being idle for this event; undo that. */
3108 timer_resume_idle ();
3112 if ((! reread
|| this_command_key_count
== 0
3113 || this_command_key_count_reset
)
3117 /* Don't echo mouse motion events. */
3118 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3119 && NILP (Fzerop (Vecho_keystrokes
))
3120 && ! (EVENT_HAS_PARAMETERS (c
)
3121 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3124 if (! NILP (also_record
))
3125 echo_char (also_record
);
3126 /* Once we reread a character, echoing can happen
3127 the next time we pause to read a new one. */
3128 ok_to_echo_at_next_pause
= current_kboard
;
3131 /* Record this character as part of the current key. */
3132 add_command_key (c
);
3133 if (! NILP (also_record
))
3134 add_command_key (also_record
);
3137 last_input_event
= c
;
3140 /* Process the help character specially if enabled */
3141 if (!NILP (Vhelp_form
) && help_char_p (c
))
3143 int count
= SPECPDL_INDEX ();
3145 help_form_saved_window_configs
3146 = Fcons (Fcurrent_window_configuration (Qnil
),
3147 help_form_saved_window_configs
);
3148 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3149 call0 (Qhelp_form_show
);
3154 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3155 if (EVENT_HAS_PARAMETERS (c
)
3156 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3157 XSETCAR (help_form_saved_window_configs
, Qnil
);
3159 while (BUFFERP (c
));
3160 /* Remove the help from the frame */
3161 unbind_to (count
, Qnil
);
3164 if (EQ (c
, make_number (040)))
3168 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3169 while (BUFFERP (c
));
3178 /* Record a key that came from a mouse menu.
3179 Record it for echoing, for this-command-keys, and so on. */
3182 record_menu_key (Lisp_Object c
)
3184 /* Wipe the echo area. */
3185 clear_message (1, 0);
3190 before_command_key_count
= this_command_key_count
;
3191 before_command_echo_length
= echo_length ();
3194 /* Don't echo mouse motion events. */
3195 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3196 && NILP (Fzerop (Vecho_keystrokes
)))
3200 /* Once we reread a character, echoing can happen
3201 the next time we pause to read a new one. */
3202 ok_to_echo_at_next_pause
= 0;
3205 /* Record this character as part of the current key. */
3206 add_command_key (c
);
3208 /* Re-reading in the middle of a command */
3209 last_input_event
= c
;
3213 /* Return 1 if should recognize C as "the help character". */
3216 help_char_p (Lisp_Object c
)
3220 if (EQ (c
, Vhelp_char
))
3222 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3223 if (EQ (c
, XCAR (tail
)))
3228 /* Record the input event C in various ways. */
3231 record_char (Lisp_Object c
)
3235 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3237 /* To avoid filling recent_keys with help-echo and mouse-movement
3238 events, we filter out repeated help-echo events, only store the
3239 first and last in a series of mouse-movement events, and don't
3240 store repeated help-echo events which are only separated by
3241 mouse-movement events. */
3243 Lisp_Object ev1
, ev2
, ev3
;
3246 if ((ix1
= recent_keys_index
- 1) < 0)
3247 ix1
= NUM_RECENT_KEYS
- 1;
3248 ev1
= AREF (recent_keys
, ix1
);
3250 if ((ix2
= ix1
- 1) < 0)
3251 ix2
= NUM_RECENT_KEYS
- 1;
3252 ev2
= AREF (recent_keys
, ix2
);
3254 if ((ix3
= ix2
- 1) < 0)
3255 ix3
= NUM_RECENT_KEYS
- 1;
3256 ev3
= AREF (recent_keys
, ix3
);
3258 if (EQ (XCAR (c
), Qhelp_echo
))
3260 /* Don't record `help-echo' in recent_keys unless it shows some help
3261 message, and a different help than the previously recorded
3263 Lisp_Object help
, last_help
;
3265 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3266 if (!STRINGP (help
))
3268 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3269 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3271 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3272 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3273 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3275 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3276 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3277 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3278 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3281 else if (EQ (XCAR (c
), Qmouse_movement
))
3283 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3284 So additional mouse movement events replace the last element. */
3285 Lisp_Object last_window
, window
;
3287 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3288 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3289 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3290 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3291 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3293 ASET (recent_keys
, ix1
, c
);
3299 store_kbd_macro_char (c
);
3304 ASET (recent_keys
, recent_keys_index
, c
);
3305 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3306 recent_keys_index
= 0;
3308 else if (recorded
< 0)
3310 /* We need to remove one or two events from recent_keys.
3311 To do this, we simply put nil at those events and move the
3312 recent_keys_index backwards over those events. Usually,
3313 users will never see those nil events, as they will be
3314 overwritten by the command keys entered to see recent_keys
3317 while (recorded
++ < 0 && total_keys
> 0)
3319 if (total_keys
< NUM_RECENT_KEYS
)
3321 if (--recent_keys_index
< 0)
3322 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3323 ASET (recent_keys
, recent_keys_index
, Qnil
);
3327 num_nonmacro_input_events
++;
3329 /* Write c to the dribble file. If c is a lispy event, write
3330 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3331 If you, dear reader, have a better idea, you've got the source. :-) */
3337 if (XUINT (c
) < 0x100)
3338 putc (XUINT (c
), dribble
);
3340 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3344 Lisp_Object dribblee
;
3346 /* If it's a structured event, take the event header. */
3347 dribblee
= EVENT_HEAD (c
);
3349 if (SYMBOLP (dribblee
))
3351 putc ('<', dribble
);
3352 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3353 SBYTES (SYMBOL_NAME (dribblee
)),
3355 putc ('>', dribble
);
3364 /* Copy out or in the info on where C-g should throw to.
3365 This is used when running Lisp code from within get_char,
3366 in case get_char is called recursively.
3367 See read_process_output. */
3370 save_getcjmp (jmp_buf temp
)
3372 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3376 restore_getcjmp (jmp_buf temp
)
3378 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3381 /* Low level keyboard/mouse input.
3382 kbd_buffer_store_event places events in kbd_buffer, and
3383 kbd_buffer_get_event retrieves them. */
3385 /* Return true if there are any events in the queue that read-char
3386 would return. If this returns false, a read-char would block. */
3388 readable_events (int flags
)
3390 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3393 /* If the buffer contains only FOCUS_IN_EVENT events, and
3394 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3395 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3397 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3398 #ifdef USE_TOOLKIT_SCROLL_BARS
3399 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3403 struct input_event
*event
;
3405 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3412 #ifdef USE_TOOLKIT_SCROLL_BARS
3413 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3415 event
->kind
== FOCUS_IN_EVENT
)
3416 #ifdef USE_TOOLKIT_SCROLL_BARS
3417 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3418 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3419 && event
->part
== scroll_bar_handle
3420 && event
->modifiers
== 0)
3425 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3428 while (event
!= kbd_store_ptr
);
3434 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3435 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3436 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3441 if (current_kboard
->kbd_queue_has_data
)
3447 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3448 if (kb
->kbd_queue_has_data
)
3454 /* Set this for debugging, to have a way to get out */
3455 int stop_character EXTERNALLY_VISIBLE
;
3458 event_to_kboard (struct input_event
*event
)
3461 frame
= event
->frame_or_window
;
3463 frame
= XCAR (frame
);
3464 else if (WINDOWP (frame
))
3465 frame
= WINDOW_FRAME (XWINDOW (frame
));
3467 /* There are still some events that don't set this field.
3468 For now, just ignore the problem.
3469 Also ignore dead frames here. */
3470 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3473 return FRAME_KBOARD (XFRAME (frame
));
3477 /* Return the number of slots occupied in kbd_buffer. */
3480 kbd_buffer_nr_stored (void)
3482 return kbd_fetch_ptr
== kbd_store_ptr
3484 : (kbd_fetch_ptr
< kbd_store_ptr
3485 ? kbd_store_ptr
- kbd_fetch_ptr
3486 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3487 + (kbd_store_ptr
- kbd_buffer
)));
3489 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3492 kbd_buffer_store_event (register struct input_event
*event
)
3494 kbd_buffer_store_event_hold (event
, 0);
3497 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3499 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3500 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3501 Else, if EVENT is a quit event, store the quit event
3502 in HOLD_QUIT, and return (thus ignoring further events).
3504 This is used in read_avail_input to postpone the processing
3505 of the quit event until all subsequent input events have been
3506 parsed (and discarded).
3510 kbd_buffer_store_event_hold (register struct input_event
*event
,
3511 struct input_event
*hold_quit
)
3513 if (event
->kind
== NO_EVENT
)
3516 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3519 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3521 register int c
= event
->code
& 0377;
3523 if (event
->modifiers
& ctrl_modifier
)
3524 c
= make_ctrl_char (c
);
3526 c
|= (event
->modifiers
3527 & (meta_modifier
| alt_modifier
3528 | hyper_modifier
| super_modifier
));
3532 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3533 struct input_event
*sp
;
3535 if (single_kboard
&& kb
!= current_kboard
)
3537 KVAR (kb
, kbd_queue
)
3538 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3539 Fcons (make_number (c
), Qnil
));
3540 kb
->kbd_queue_has_data
= 1;
3541 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3543 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3546 if (event_to_kboard (sp
) == kb
)
3548 sp
->kind
= NO_EVENT
;
3549 sp
->frame_or_window
= Qnil
;
3558 memcpy (hold_quit
, event
, sizeof (*event
));
3562 /* If this results in a quit_char being returned to Emacs as
3563 input, set Vlast_event_frame properly. If this doesn't
3564 get returned to Emacs as an event, the next event read
3565 will set Vlast_event_frame again, so this is safe to do. */
3569 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3571 focus
= event
->frame_or_window
;
3572 internal_last_event_frame
= focus
;
3573 Vlast_event_frame
= focus
;
3576 last_event_timestamp
= event
->timestamp
;
3577 handle_interrupt ();
3581 if (c
&& c
== stop_character
)
3587 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3588 Just ignore the second one. */
3589 else if (event
->kind
== BUFFER_SWITCH_EVENT
3590 && kbd_fetch_ptr
!= kbd_store_ptr
3591 && ((kbd_store_ptr
== kbd_buffer
3592 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3593 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3596 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3597 kbd_store_ptr
= kbd_buffer
;
3599 /* Don't let the very last slot in the buffer become full,
3600 since that would make the two pointers equal,
3601 and that is indistinguishable from an empty buffer.
3602 Discard the event if it would fill the last slot. */
3603 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3605 *kbd_store_ptr
= *event
;
3608 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3610 /* Don't read keyboard input until we have processed kbd_buffer.
3611 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3612 hold_keyboard_input ();
3614 if (!noninteractive
)
3615 signal (SIGIO
, SIG_IGN
);
3619 #endif /* subprocesses */
3622 /* If we're inside while-no-input, and this event qualifies
3623 as input, set quit-flag to cause an interrupt. */
3624 if (!NILP (Vthrow_on_input
)
3625 && event
->kind
!= FOCUS_IN_EVENT
3626 && event
->kind
!= HELP_EVENT
3627 && event
->kind
!= DEICONIFY_EVENT
)
3629 Vquit_flag
= Vthrow_on_input
;
3630 /* If we're inside a function that wants immediate quits,
3632 if (immediate_quit
&& NILP (Vinhibit_quit
))
3642 /* Put an input event back in the head of the event queue. */
3645 kbd_buffer_unget_event (register struct input_event
*event
)
3647 if (kbd_fetch_ptr
== kbd_buffer
)
3648 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3650 /* Don't let the very last slot in the buffer become full, */
3651 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3654 *kbd_fetch_ptr
= *event
;
3659 /* Generate a HELP_EVENT input_event and store it in the keyboard
3662 HELP is the help form.
3664 FRAME and WINDOW are the frame and window where the help is
3665 generated. OBJECT is the Lisp object where the help was found (a
3666 buffer, a string, an overlay, or nil if neither from a string nor
3667 from a buffer). POS is the position within OBJECT where the help
3671 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3672 Lisp_Object object
, EMACS_INT pos
)
3674 struct input_event event
;
3678 event
.kind
= HELP_EVENT
;
3679 event
.frame_or_window
= frame
;
3681 event
.x
= WINDOWP (window
) ? window
: frame
;
3684 kbd_buffer_store_event (&event
);
3688 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3691 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3693 struct input_event event
;
3695 event
.kind
= HELP_EVENT
;
3696 event
.frame_or_window
= frame
;
3701 kbd_buffer_store_event (&event
);
3705 /* Discard any mouse events in the event buffer by setting them to
3708 discard_mouse_events (void)
3710 struct input_event
*sp
;
3711 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3713 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3716 if (sp
->kind
== MOUSE_CLICK_EVENT
3717 || sp
->kind
== WHEEL_EVENT
3718 || sp
->kind
== HORIZ_WHEEL_EVENT
3720 || sp
->kind
== GPM_CLICK_EVENT
3722 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3724 sp
->kind
= NO_EVENT
;
3730 /* Return non-zero if there are any real events waiting in the event
3731 buffer, not counting `NO_EVENT's.
3733 If DISCARD is non-zero, discard NO_EVENT events at the front of
3734 the input queue, possibly leaving the input queue empty if there
3735 are no real input events. */
3738 kbd_buffer_events_waiting (int discard
)
3740 struct input_event
*sp
;
3742 for (sp
= kbd_fetch_ptr
;
3743 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3746 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3753 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3757 /* Clear input event EVENT. */
3760 clear_event (struct input_event
*event
)
3762 event
->kind
= NO_EVENT
;
3766 /* Read one event from the event buffer, waiting if necessary.
3767 The value is a Lisp object representing the event.
3768 The value is nil for an event that should be ignored,
3769 or that was handled here.
3770 We always read and discard one event. */
3773 kbd_buffer_get_event (KBOARD
**kbp
,
3774 int *used_mouse_menu
,
3775 struct timeval
*end_time
)
3781 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3783 /* Start reading input again, we have processed enough so we can
3784 accept new events again. */
3785 unhold_keyboard_input ();
3787 if (!noninteractive
)
3788 signal (SIGIO
, input_available_signal
);
3792 #endif /* subprocesses */
3795 /* In case we are running as a daemon, only do this before
3796 detaching from the terminal. */
3797 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3801 *kbp
= current_kboard
;
3805 /* Wait until there is input available. */
3808 /* Break loop if there's an unread command event. Needed in
3809 moused window autoselection which uses a timer to insert such
3811 if (CONSP (Vunread_command_events
))
3814 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3816 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3817 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3821 /* If the quit flag is set, then read_char will return
3822 quit_char, so that counts as "available input." */
3823 if (!NILP (Vquit_flag
))
3824 quit_throw_to_read_char (0);
3826 /* One way or another, wait until input is available; then, if
3827 interrupt handlers have not read it, read it now. */
3829 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3833 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3835 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3836 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3841 EMACS_TIME duration
;
3842 EMACS_GET_TIME (duration
);
3843 if (EMACS_TIME_GE (duration
, *end_time
))
3844 return Qnil
; /* finished waiting */
3847 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3848 wait_reading_process_output (EMACS_SECS (duration
),
3849 EMACS_USECS (duration
),
3850 -1, 1, Qnil
, NULL
, 0);
3854 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3856 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3857 /* Pass 1 for EXPECT since we just waited to have input. */
3858 read_avail_input (1);
3861 if (CONSP (Vunread_command_events
))
3864 first
= XCAR (Vunread_command_events
);
3865 Vunread_command_events
= XCDR (Vunread_command_events
);
3866 *kbp
= current_kboard
;
3870 /* At this point, we know that there is a readable event available
3871 somewhere. If the event queue is empty, then there must be a
3872 mouse movement enabled and available. */
3873 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3875 struct input_event
*event
;
3877 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3881 last_event_timestamp
= event
->timestamp
;
3883 *kbp
= event_to_kboard (event
);
3885 *kbp
= current_kboard
; /* Better than returning null ptr? */
3889 /* These two kinds of events get special handling
3890 and don't actually appear to the command loop.
3891 We return nil for them. */
3892 if (event
->kind
== SELECTION_REQUEST_EVENT
3893 || event
->kind
== SELECTION_CLEAR_EVENT
)
3896 struct input_event copy
;
3898 /* Remove it from the buffer before processing it,
3899 since otherwise swallow_events will see it
3900 and process it again. */
3902 kbd_fetch_ptr
= event
+ 1;
3903 input_pending
= readable_events (0);
3904 x_handle_selection_event (©
);
3906 /* We're getting selection request events, but we don't have
3912 #if defined (HAVE_NS)
3913 else if (event
->kind
== NS_TEXT_EVENT
)
3915 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3916 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3918 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3919 kbd_fetch_ptr
= event
+ 1;
3920 if (used_mouse_menu
)
3921 *used_mouse_menu
= 1;
3925 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3926 || defined (HAVE_NS)
3927 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3929 /* Make an event (delete-frame (FRAME)). */
3930 obj
= Fcons (event
->frame_or_window
, Qnil
);
3931 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3932 kbd_fetch_ptr
= event
+ 1;
3935 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3936 || defined (HAVE_NS)
3937 else if (event
->kind
== ICONIFY_EVENT
)
3939 /* Make an event (iconify-frame (FRAME)). */
3940 obj
= Fcons (event
->frame_or_window
, Qnil
);
3941 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3942 kbd_fetch_ptr
= event
+ 1;
3944 else if (event
->kind
== DEICONIFY_EVENT
)
3946 /* Make an event (make-frame-visible (FRAME)). */
3947 obj
= Fcons (event
->frame_or_window
, Qnil
);
3948 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3949 kbd_fetch_ptr
= event
+ 1;
3952 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3954 /* The value doesn't matter here; only the type is tested. */
3955 XSETBUFFER (obj
, current_buffer
);
3956 kbd_fetch_ptr
= event
+ 1;
3958 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3959 || defined (HAVE_NS) || defined (USE_GTK)
3960 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3962 kbd_fetch_ptr
= event
+ 1;
3963 input_pending
= readable_events (0);
3964 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3965 x_activate_menubar (XFRAME (event
->frame_or_window
));
3968 #if defined (WINDOWSNT)
3969 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3971 /* Make an event (language-change (FRAME CHARSET LCID)). */
3972 obj
= Fcons (event
->frame_or_window
, Qnil
);
3973 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3974 kbd_fetch_ptr
= event
+ 1;
3977 else if (event
->kind
== SAVE_SESSION_EVENT
)
3979 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3980 kbd_fetch_ptr
= event
+ 1;
3982 /* Just discard these, by returning nil.
3983 With MULTI_KBOARD, these events are used as placeholders
3984 when we need to randomly delete events from the queue.
3985 (They shouldn't otherwise be found in the buffer,
3986 but on some machines it appears they do show up
3987 even without MULTI_KBOARD.) */
3988 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3989 mouse events during a popup-menu call. */
3990 else if (event
->kind
== NO_EVENT
)
3991 kbd_fetch_ptr
= event
+ 1;
3992 else if (event
->kind
== HELP_EVENT
)
3994 Lisp_Object object
, position
, help
, frame
, window
;
3996 frame
= event
->frame_or_window
;
3997 object
= event
->arg
;
3998 position
= make_number (event
->code
);
4001 clear_event (event
);
4003 kbd_fetch_ptr
= event
+ 1;
4004 if (!WINDOWP (window
))
4006 obj
= Fcons (Qhelp_echo
,
4007 list5 (frame
, help
, window
, object
, position
));
4009 else if (event
->kind
== FOCUS_IN_EVENT
)
4011 /* Notification of a FocusIn event. The frame receiving the
4012 focus is in event->frame_or_window. Generate a
4013 switch-frame event if necessary. */
4014 Lisp_Object frame
, focus
;
4016 frame
= event
->frame_or_window
;
4017 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4021 if (!EQ (frame
, internal_last_event_frame
)
4022 && !EQ (frame
, selected_frame
))
4023 obj
= make_lispy_switch_frame (frame
);
4024 internal_last_event_frame
= frame
;
4025 kbd_fetch_ptr
= event
+ 1;
4028 else if (event
->kind
== DBUS_EVENT
)
4030 obj
= make_lispy_event (event
);
4031 kbd_fetch_ptr
= event
+ 1;
4034 #ifdef HAVE_XWIDGETS
4035 else if (event
->kind
== XWIDGET_EVENT
)
4037 obj
= make_lispy_event (event
);
4038 kbd_fetch_ptr
= event
+ 1;
4041 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4043 obj
= make_lispy_event (event
);
4044 kbd_fetch_ptr
= event
+ 1;
4048 /* If this event is on a different frame, return a switch-frame this
4049 time, and leave the event in the queue for next time. */
4053 frame
= event
->frame_or_window
;
4055 frame
= XCAR (frame
);
4056 else if (WINDOWP (frame
))
4057 frame
= WINDOW_FRAME (XWINDOW (frame
));
4059 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4063 if (! EQ (frame
, internal_last_event_frame
)
4064 && !EQ (frame
, selected_frame
))
4065 obj
= make_lispy_switch_frame (frame
);
4066 internal_last_event_frame
= frame
;
4068 /* If we didn't decide to make a switch-frame event, go ahead
4069 and build a real event from the queue entry. */
4073 obj
= make_lispy_event (event
);
4075 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4076 || defined (HAVE_NS) || defined (USE_GTK)
4077 /* If this was a menu selection, then set the flag to inhibit
4078 writing to last_nonmenu_event. Don't do this if the event
4079 we're returning is (menu-bar), though; that indicates the
4080 beginning of the menu sequence, and we might as well leave
4081 that as the `event with parameters' for this selection. */
4083 && !EQ (event
->frame_or_window
, event
->arg
)
4084 && (event
->kind
== MENU_BAR_EVENT
4085 || event
->kind
== TOOL_BAR_EVENT
))
4086 *used_mouse_menu
= 1;
4089 /* certain system events are non-key events */
4091 && event
->kind
== NS_NONKEY_EVENT
)
4092 *used_mouse_menu
= 1;
4095 /* Wipe out this event, to catch bugs. */
4096 clear_event (event
);
4097 kbd_fetch_ptr
= event
+ 1;
4101 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4102 /* Try generating a mouse motion event. */
4103 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4105 FRAME_PTR f
= some_mouse_moved ();
4106 Lisp_Object bar_window
;
4107 enum scroll_bar_part part
;
4111 *kbp
= current_kboard
;
4112 /* Note that this uses F to determine which terminal to look at.
4113 If there is no valid info, it does not store anything
4114 so x remains nil. */
4117 /* XXX Can f or mouse_position_hook be NULL here? */
4118 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4119 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4124 /* Decide if we should generate a switch-frame event. Don't
4125 generate switch-frame events for motion outside of all Emacs
4131 frame
= FRAME_FOCUS_FRAME (f
);
4133 XSETFRAME (frame
, f
);
4135 if (! EQ (frame
, internal_last_event_frame
)
4136 && !EQ (frame
, selected_frame
))
4137 obj
= make_lispy_switch_frame (frame
);
4138 internal_last_event_frame
= frame
;
4141 /* If we didn't decide to make a switch-frame event, go ahead and
4142 return a mouse-motion event. */
4143 if (!NILP (x
) && NILP (obj
))
4144 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4146 #endif /* HAVE_MOUSE || HAVE GPM */
4148 /* We were promised by the above while loop that there was
4149 something for us to read! */
4152 input_pending
= readable_events (0);
4154 Vlast_event_frame
= internal_last_event_frame
;
4159 /* Process any non-user-visible events (currently X selection events),
4160 without reading any user-visible events. */
4163 process_special_events (void)
4165 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4167 struct input_event
*event
;
4169 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4173 last_event_timestamp
= event
->timestamp
;
4175 /* These two kinds of events get special handling
4176 and don't actually appear to the command loop. */
4177 if (event
->kind
== SELECTION_REQUEST_EVENT
4178 || event
->kind
== SELECTION_CLEAR_EVENT
)
4181 struct input_event copy
;
4183 /* Remove it from the buffer before processing it,
4184 since otherwise swallow_events called recursively could see it
4185 and process it again. */
4187 kbd_fetch_ptr
= event
+ 1;
4188 input_pending
= readable_events (0);
4189 x_handle_selection_event (©
);
4191 /* We're getting selection request events, but we don't have
4201 /* Process any events that are not user-visible, run timer events that
4202 are ripe, and return, without reading any user-visible events. */
4205 swallow_events (int do_display
)
4209 process_special_events ();
4211 old_timers_run
= timers_run
;
4212 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4214 if (timers_run
!= old_timers_run
&& do_display
)
4215 redisplay_preserve_echo_area (7);
4218 /* Record the start of when Emacs is idle,
4219 for the sake of running idle-time timers. */
4222 timer_start_idle (void)
4226 /* If we are already in the idle state, do nothing. */
4227 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4230 EMACS_GET_TIME (timer_idleness_start_time
);
4232 timer_last_idleness_start_time
= timer_idleness_start_time
;
4234 /* Mark all idle-time timers as once again candidates for running. */
4235 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4239 timer
= XCAR (timers
);
4241 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4243 XVECTOR (timer
)->contents
[0] = Qnil
;
4247 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4250 timer_stop_idle (void)
4252 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4255 /* Resume idle timer from last idle start time. */
4258 timer_resume_idle (void)
4260 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4263 timer_idleness_start_time
= timer_last_idleness_start_time
;
4266 /* This is only for debugging. */
4267 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4269 /* List of elisp functions to call, delayed because they were generated in
4270 a context where Elisp could not be safely run (e.g. redisplay, signal,
4271 ...). Each element has the form (FUN . ARGS). */
4272 Lisp_Object pending_funcalls
;
4274 /* Check whether a timer has fired. To prevent larger problems we simply
4275 disregard elements that are not proper timers. Do not make a circular
4276 timer list for the time being.
4278 Returns the time to wait until the next timer fires. If a
4279 timer is triggering now, return zero.
4280 If no timer is active, return -1.
4282 If a timer is ripe, we run it, with quitting turned off.
4283 In that case we return 0 to indicate that a new timer_check_2 call
4287 timer_check_2 (void)
4289 EMACS_TIME nexttime
;
4291 EMACS_TIME idleness_now
IF_LINT (= {0});
4292 Lisp_Object timers
, idle_timers
, chosen_timer
;
4293 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4295 EMACS_SET_SECS (nexttime
, -1);
4296 EMACS_SET_USECS (nexttime
, -1);
4298 /* Always consider the ordinary timers. */
4299 timers
= Vtimer_list
;
4300 /* Consider the idle timers only if Emacs is idle. */
4301 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4302 idle_timers
= Vtimer_idle_list
;
4305 chosen_timer
= Qnil
;
4306 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4308 /* First run the code that was delayed. */
4309 while (CONSP (pending_funcalls
))
4311 Lisp_Object funcall
= XCAR (pending_funcalls
);
4312 pending_funcalls
= XCDR (pending_funcalls
);
4313 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4316 if (CONSP (timers
) || CONSP (idle_timers
))
4318 EMACS_GET_TIME (now
);
4319 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4320 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4323 while (CONSP (timers
) || CONSP (idle_timers
))
4325 Lisp_Object
*vector
;
4326 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4327 EMACS_TIME timer_time
, idle_timer_time
;
4328 EMACS_TIME difference
;
4329 EMACS_TIME timer_difference
IF_LINT (= {0});
4330 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4332 /* Skip past invalid timers and timers already handled. */
4335 timer
= XCAR (timers
);
4336 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4338 timers
= XCDR (timers
);
4341 vector
= XVECTOR (timer
)->contents
;
4343 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4344 || !INTEGERP (vector
[3])
4345 || ! NILP (vector
[0]))
4347 timers
= XCDR (timers
);
4351 if (CONSP (idle_timers
))
4353 timer
= XCAR (idle_timers
);
4354 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4356 idle_timers
= XCDR (idle_timers
);
4359 vector
= XVECTOR (timer
)->contents
;
4361 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4362 || !INTEGERP (vector
[3])
4363 || ! NILP (vector
[0]))
4365 idle_timers
= XCDR (idle_timers
);
4370 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4371 based on the next ordinary timer.
4372 TIMER_DIFFERENCE is the distance in time from NOW to when
4373 this timer becomes ripe (negative if it's already ripe). */
4376 timer
= XCAR (timers
);
4377 vector
= XVECTOR (timer
)->contents
;
4378 EMACS_SET_SECS (timer_time
,
4379 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4380 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4381 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4384 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4385 based on the next idle timer. */
4386 if (CONSP (idle_timers
))
4388 idle_timer
= XCAR (idle_timers
);
4389 vector
= XVECTOR (idle_timer
)->contents
;
4390 EMACS_SET_SECS (idle_timer_time
,
4391 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4392 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4393 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4396 /* Decide which timer is the next timer,
4397 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4398 Also step down the list where we found that timer. */
4400 if (CONSP (timers
) && CONSP (idle_timers
))
4403 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4404 if (EMACS_TIME_NEG_P (temp
))
4406 chosen_timer
= timer
;
4407 timers
= XCDR (timers
);
4408 difference
= timer_difference
;
4412 chosen_timer
= idle_timer
;
4413 idle_timers
= XCDR (idle_timers
);
4414 difference
= idle_timer_difference
;
4417 else if (CONSP (timers
))
4419 chosen_timer
= timer
;
4420 timers
= XCDR (timers
);
4421 difference
= timer_difference
;
4425 chosen_timer
= idle_timer
;
4426 idle_timers
= XCDR (idle_timers
);
4427 difference
= idle_timer_difference
;
4429 vector
= XVECTOR (chosen_timer
)->contents
;
4431 /* If timer is ripe, run it if it hasn't been run. */
4432 if (EMACS_TIME_NEG_P (difference
)
4433 || (EMACS_SECS (difference
) == 0
4434 && EMACS_USECS (difference
) == 0))
4436 if (NILP (vector
[0]))
4438 int count
= SPECPDL_INDEX ();
4439 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4441 /* Mark the timer as triggered to prevent problems if the lisp
4442 code fails to reschedule it right. */
4445 specbind (Qinhibit_quit
, Qt
);
4447 call1 (Qtimer_event_handler
, chosen_timer
);
4448 Vdeactivate_mark
= old_deactivate_mark
;
4450 unbind_to (count
, Qnil
);
4452 /* Since we have handled the event,
4453 we don't need to tell the caller to wake up and do it. */
4454 /* But the caller must still wait for the next timer, so
4455 return 0 to indicate that. */
4458 EMACS_SET_SECS (nexttime
, 0);
4459 EMACS_SET_USECS (nexttime
, 0);
4462 /* When we encounter a timer that is still waiting,
4463 return the amount of time to wait before it is ripe. */
4470 /* No timers are pending in the future. */
4471 /* Return 0 if we generated an event, and -1 if not. */
4477 /* Check whether a timer has fired. To prevent larger problems we simply
4478 disregard elements that are not proper timers. Do not make a circular
4479 timer list for the time being.
4481 Returns the time to wait until the next timer fires.
4482 If no timer is active, return -1.
4484 As long as any timer is ripe, we run it. */
4489 EMACS_TIME nexttime
;
4493 nexttime
= timer_check_2 ();
4495 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4500 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4501 doc
: /* Return the current length of Emacs idleness, or nil.
4502 The value when Emacs is idle is a list of three integers. The first has
4503 the most significant 16 bits of the seconds, while the second has the least
4504 significant 16 bits. The third integer gives the microsecond count.
4506 The value when Emacs is not idle is nil.
4508 The microsecond count is zero on systems that do not provide
4509 resolution finer than a second. */)
4512 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4514 EMACS_TIME now
, idleness_now
;
4516 EMACS_GET_TIME (now
);
4517 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4519 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4520 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4521 make_number (EMACS_USECS (idleness_now
)));
4527 /* Caches for modify_event_symbol. */
4528 static Lisp_Object accent_key_syms
;
4529 static Lisp_Object func_key_syms
;
4530 static Lisp_Object mouse_syms
;
4531 static Lisp_Object wheel_syms
;
4532 static Lisp_Object drag_n_drop_syms
;
4534 /* This is a list of keysym codes for special "accent" characters.
4535 It parallels lispy_accent_keys. */
4537 static const int lispy_accent_codes
[] =
4539 #ifdef XK_dead_circumflex
4544 #ifdef XK_dead_grave
4549 #ifdef XK_dead_tilde
4554 #ifdef XK_dead_diaeresis
4559 #ifdef XK_dead_macron
4564 #ifdef XK_dead_degree
4569 #ifdef XK_dead_acute
4574 #ifdef XK_dead_cedilla
4579 #ifdef XK_dead_breve
4584 #ifdef XK_dead_ogonek
4589 #ifdef XK_dead_caron
4594 #ifdef XK_dead_doubleacute
4595 XK_dead_doubleacute
,
4599 #ifdef XK_dead_abovedot
4604 #ifdef XK_dead_abovering
4614 #ifdef XK_dead_belowdot
4619 #ifdef XK_dead_voiced_sound
4620 XK_dead_voiced_sound
,
4624 #ifdef XK_dead_semivoiced_sound
4625 XK_dead_semivoiced_sound
,
4641 /* This is a list of Lisp names for special "accent" characters.
4642 It parallels lispy_accent_codes. */
4644 static const char *const lispy_accent_keys
[] =
4662 "dead-voiced-sound",
4663 "dead-semivoiced-sound",
4669 #define FUNCTION_KEY_OFFSET 0x0
4671 const char *const lispy_function_keys
[] =
4675 0, /* VK_LBUTTON 0x01 */
4676 0, /* VK_RBUTTON 0x02 */
4677 "cancel", /* VK_CANCEL 0x03 */
4678 0, /* VK_MBUTTON 0x04 */
4680 0, 0, 0, /* 0x05 .. 0x07 */
4682 "backspace", /* VK_BACK 0x08 */
4683 "tab", /* VK_TAB 0x09 */
4685 0, 0, /* 0x0A .. 0x0B */
4687 "clear", /* VK_CLEAR 0x0C */
4688 "return", /* VK_RETURN 0x0D */
4690 0, 0, /* 0x0E .. 0x0F */
4692 0, /* VK_SHIFT 0x10 */
4693 0, /* VK_CONTROL 0x11 */
4694 0, /* VK_MENU 0x12 */
4695 "pause", /* VK_PAUSE 0x13 */
4696 "capslock", /* VK_CAPITAL 0x14 */
4697 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4699 "junja", /* VK_JUNJA 0x17 */
4700 "final", /* VK_FINAL 0x18 */
4701 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4703 "escape", /* VK_ESCAPE 0x1B */
4704 "convert", /* VK_CONVERT 0x1C */
4705 "non-convert", /* VK_NONCONVERT 0x1D */
4706 "accept", /* VK_ACCEPT 0x1E */
4707 "mode-change", /* VK_MODECHANGE 0x1F */
4708 0, /* VK_SPACE 0x20 */
4709 "prior", /* VK_PRIOR 0x21 */
4710 "next", /* VK_NEXT 0x22 */
4711 "end", /* VK_END 0x23 */
4712 "home", /* VK_HOME 0x24 */
4713 "left", /* VK_LEFT 0x25 */
4714 "up", /* VK_UP 0x26 */
4715 "right", /* VK_RIGHT 0x27 */
4716 "down", /* VK_DOWN 0x28 */
4717 "select", /* VK_SELECT 0x29 */
4718 "print", /* VK_PRINT 0x2A */
4719 "execute", /* VK_EXECUTE 0x2B */
4720 "snapshot", /* VK_SNAPSHOT 0x2C */
4721 "insert", /* VK_INSERT 0x2D */
4722 "delete", /* VK_DELETE 0x2E */
4723 "help", /* VK_HELP 0x2F */
4725 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4727 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4729 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4731 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4733 0, 0, 0, 0, 0, 0, 0, 0, 0,
4734 0, 0, 0, 0, 0, 0, 0, 0, 0,
4735 0, 0, 0, 0, 0, 0, 0, 0,
4737 "lwindow", /* VK_LWIN 0x5B */
4738 "rwindow", /* VK_RWIN 0x5C */
4739 "apps", /* VK_APPS 0x5D */
4742 "kp-0", /* VK_NUMPAD0 0x60 */
4743 "kp-1", /* VK_NUMPAD1 0x61 */
4744 "kp-2", /* VK_NUMPAD2 0x62 */
4745 "kp-3", /* VK_NUMPAD3 0x63 */
4746 "kp-4", /* VK_NUMPAD4 0x64 */
4747 "kp-5", /* VK_NUMPAD5 0x65 */
4748 "kp-6", /* VK_NUMPAD6 0x66 */
4749 "kp-7", /* VK_NUMPAD7 0x67 */
4750 "kp-8", /* VK_NUMPAD8 0x68 */
4751 "kp-9", /* VK_NUMPAD9 0x69 */
4752 "kp-multiply", /* VK_MULTIPLY 0x6A */
4753 "kp-add", /* VK_ADD 0x6B */
4754 "kp-separator", /* VK_SEPARATOR 0x6C */
4755 "kp-subtract", /* VK_SUBTRACT 0x6D */
4756 "kp-decimal", /* VK_DECIMAL 0x6E */
4757 "kp-divide", /* VK_DIVIDE 0x6F */
4758 "f1", /* VK_F1 0x70 */
4759 "f2", /* VK_F2 0x71 */
4760 "f3", /* VK_F3 0x72 */
4761 "f4", /* VK_F4 0x73 */
4762 "f5", /* VK_F5 0x74 */
4763 "f6", /* VK_F6 0x75 */
4764 "f7", /* VK_F7 0x76 */
4765 "f8", /* VK_F8 0x77 */
4766 "f9", /* VK_F9 0x78 */
4767 "f10", /* VK_F10 0x79 */
4768 "f11", /* VK_F11 0x7A */
4769 "f12", /* VK_F12 0x7B */
4770 "f13", /* VK_F13 0x7C */
4771 "f14", /* VK_F14 0x7D */
4772 "f15", /* VK_F15 0x7E */
4773 "f16", /* VK_F16 0x7F */
4774 "f17", /* VK_F17 0x80 */
4775 "f18", /* VK_F18 0x81 */
4776 "f19", /* VK_F19 0x82 */
4777 "f20", /* VK_F20 0x83 */
4778 "f21", /* VK_F21 0x84 */
4779 "f22", /* VK_F22 0x85 */
4780 "f23", /* VK_F23 0x86 */
4781 "f24", /* VK_F24 0x87 */
4783 0, 0, 0, 0, /* 0x88 .. 0x8B */
4784 0, 0, 0, 0, /* 0x8C .. 0x8F */
4786 "kp-numlock", /* VK_NUMLOCK 0x90 */
4787 "scroll", /* VK_SCROLL 0x91 */
4788 /* Not sure where the following block comes from.
4789 Windows headers have NEC and Fujitsu specific keys in
4790 this block, but nothing generic. */
4791 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4792 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4793 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4794 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4795 "kp-end", /* VK_NUMPAD_END 0x96 */
4796 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4797 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4798 "kp-up", /* VK_NUMPAD_UP 0x99 */
4799 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4800 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4801 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4802 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4804 0, 0, /* 0x9E .. 0x9F */
4807 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4808 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4809 * No other API or message will distinguish left and right keys this way.
4814 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4815 to enable them selectively, and gives access to a few more functions.
4816 See lispy_multimedia_keys below. */
4817 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4818 0, 0, 0, /* 0xAD .. 0xAF Volume */
4819 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4820 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4822 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4823 0, 0, 0, 0, 0, 0, 0, 0, 0,
4825 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4826 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4827 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4830 "ax", /* VK_OEM_AX 0xE1 */
4831 0, /* VK_OEM_102 0xE2 */
4832 "ico-help", /* VK_ICO_HELP 0xE3 */
4833 "ico-00", /* VK_ICO_00 0xE4 */
4834 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4835 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4836 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4838 "reset", /* VK_OEM_RESET 0xE9 */
4839 "jump", /* VK_OEM_JUMP 0xEA */
4840 "oem-pa1", /* VK_OEM_PA1 0xEB */
4841 "oem-pa2", /* VK_OEM_PA2 0xEC */
4842 "oem-pa3", /* VK_OEM_PA3 0xED */
4843 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4844 "cusel", /* VK_OEM_CUSEL 0xEF */
4845 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4846 "finish", /* VK_OEM_FINISH 0xF1 */
4847 "copy", /* VK_OEM_COPY 0xF2 */
4848 "auto", /* VK_OEM_AUTO 0xF3 */
4849 "enlw", /* VK_OEM_ENLW 0xF4 */
4850 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4851 "attn", /* VK_ATTN 0xF6 */
4852 "crsel", /* VK_CRSEL 0xF7 */
4853 "exsel", /* VK_EXSEL 0xF8 */
4854 "ereof", /* VK_EREOF 0xF9 */
4855 "play", /* VK_PLAY 0xFA */
4856 "zoom", /* VK_ZOOM 0xFB */
4857 "noname", /* VK_NONAME 0xFC */
4858 "pa1", /* VK_PA1 0xFD */
4859 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4863 /* Some of these duplicate the "Media keys" on newer keyboards,
4864 but they are delivered to the application in a different way. */
4865 static const char *const lispy_multimedia_keys
[] =
4873 "browser-favorites",
4910 "toggle-dictate-command",
4916 "media-fast-forward",
4919 "media-channel-down"
4922 #else /* not HAVE_NTGUI */
4924 /* This should be dealt with in XTread_socket now, and that doesn't
4925 depend on the client system having the Kana syms defined. See also
4926 the XK_kana_A case below. */
4929 static const char *const lispy_kana_keys
[] =
4931 /* X Keysym value */
4932 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4933 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4934 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4935 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4936 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4937 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4938 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4939 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4940 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4941 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4942 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4943 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4944 "kana-i", "kana-u", "kana-e", "kana-o",
4945 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4946 "prolongedsound", "kana-A", "kana-I", "kana-U",
4947 "kana-E", "kana-O", "kana-KA", "kana-KI",
4948 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4949 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4950 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4951 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4952 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4953 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4954 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4955 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4956 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4957 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4958 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4959 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4961 #endif /* XK_kana_A */
4964 #define FUNCTION_KEY_OFFSET 0xff00
4966 /* You'll notice that this table is arranged to be conveniently
4967 indexed by X Windows keysym values. */
4968 static const char *const lispy_function_keys
[] =
4970 /* X Keysym value */
4972 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4973 "backspace", "tab", "linefeed", "clear",
4975 0, 0, 0, "pause", /* 0xff10...1f */
4976 0, 0, 0, 0, 0, 0, 0, "escape",
4978 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4979 "romaji", "hiragana", "katakana", "hiragana-katakana",
4980 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4981 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4982 "eisu-toggle", /* 0xff30...3f */
4983 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4984 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4986 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4987 "down", "prior", "next", "end",
4988 "begin", 0, 0, 0, 0, 0, 0, 0,
4989 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5000 "break", /* 0xff6b */
5003 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5004 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5005 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5006 0, 0, 0, 0, 0, 0, 0, 0,
5007 "kp-tab", /* 0xff89 */
5009 "kp-enter", /* 0xff8d */
5011 "kp-f1", /* 0xff91 */
5015 "kp-home", /* 0xff95 */
5020 "kp-prior", /* kp-page-up */
5021 "kp-next", /* kp-page-down */
5027 0, 0, 0, 0, 0, 0, 0, 0, 0,
5028 "kp-multiply", /* 0xffaa */
5033 "kp-divide", /* 0xffaf */
5034 "kp-0", /* 0xffb0 */
5035 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5038 "kp-equal", /* 0xffbd */
5039 "f1", /* 0xffbe */ /* IsFunctionKey */
5041 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5042 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5043 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5044 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5045 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5046 0, 0, 0, 0, 0, 0, 0, 0,
5047 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5048 0, 0, 0, 0, 0, 0, 0, "delete"
5051 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5052 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5054 static const char *const iso_lispy_function_keys
[] =
5056 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5057 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5058 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5059 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5060 "iso-lefttab", /* 0xfe20 */
5061 "iso-move-line-up", "iso-move-line-down",
5062 "iso-partial-line-up", "iso-partial-line-down",
5063 "iso-partial-space-left", "iso-partial-space-right",
5064 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5065 "iso-release-margin-left", "iso-release-margin-right",
5066 "iso-release-both-margins",
5067 "iso-fast-cursor-left", "iso-fast-cursor-right",
5068 "iso-fast-cursor-up", "iso-fast-cursor-down",
5069 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5070 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5073 #endif /* not HAVE_NTGUI */
5075 static Lisp_Object Vlispy_mouse_stem
;
5077 static const char *const lispy_wheel_names
[] =
5079 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5082 /* drag-n-drop events are generated when a set of selected files are
5083 dragged from another application and dropped onto an Emacs window. */
5084 static const char *const lispy_drag_n_drop_names
[] =
5089 /* Scroll bar parts. */
5090 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5091 Lisp_Object Qup
, Qdown
, Qbottom
;
5092 static Lisp_Object Qend_scroll
;
5094 static Lisp_Object Qratio
;
5096 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5097 static Lisp_Object
*const scroll_bar_parts
[] = {
5098 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5099 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5102 /* A vector, indexed by button number, giving the down-going location
5103 of currently depressed buttons, both scroll bar and non-scroll bar.
5105 The elements have the form
5106 (BUTTON-NUMBER MODIFIER-MASK . REST)
5107 where REST is the cdr of a position as it would be reported in the event.
5109 The make_lispy_event function stores positions here to tell the
5110 difference between click and drag events, and to store the starting
5111 location to be included in drag events. */
5113 static Lisp_Object button_down_location
;
5115 /* Information about the most recent up-going button event: Which
5116 button, what location, and what time. */
5118 static int last_mouse_button
;
5119 static int last_mouse_x
;
5120 static int last_mouse_y
;
5121 static Time button_down_time
;
5123 /* The number of clicks in this multiple-click. */
5125 static int double_click_count
;
5127 /* X and Y are frame-relative coordinates for a click or wheel event.
5128 Return a Lisp-style event list. */
5131 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5134 enum window_part part
;
5135 Lisp_Object posn
= Qnil
;
5136 Lisp_Object extra_info
= Qnil
;
5137 /* Coordinate pixel positions to return. */
5138 int xret
= 0, yret
= 0;
5139 /* The window under frame pixel coordinates (x,y) */
5140 Lisp_Object window
= f
5141 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5144 if (WINDOWP (window
))
5146 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5147 struct window
*w
= XWINDOW (window
);
5148 Lisp_Object string_info
= Qnil
;
5149 EMACS_INT textpos
= -1;
5150 int col
= -1, row
= -1;
5151 int dx
= -1, dy
= -1;
5152 int width
= -1, height
= -1;
5153 Lisp_Object object
= Qnil
;
5155 /* Pixel coordinates relative to the window corner. */
5156 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5157 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5159 /* For text area clicks, return X, Y relative to the corner of
5160 this text area. Note that dX, dY etc are set below, by
5161 buffer_posn_from_coords. */
5162 if (part
== ON_TEXT
)
5164 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5165 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5167 /* For mode line and header line clicks, return X, Y relative to
5168 the left window edge. Use mode_line_string to look for a
5169 string on the click position. */
5170 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5175 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5176 /* Note that mode_line_string takes COL, ROW as pixels and
5177 converts them to characters. */
5180 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5181 &object
, &dx
, &dy
, &width
, &height
);
5182 if (STRINGP (string
))
5183 string_info
= Fcons (string
, make_number (charpos
));
5184 textpos
= (w
== XWINDOW (selected_window
)
5185 && current_buffer
== XBUFFER (w
->buffer
))
5186 ? PT
: XMARKER (w
->pointm
)->charpos
;
5191 /* For fringes and margins, Y is relative to the area's (and the
5192 window's) top edge, while X is meaningless. */
5193 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5198 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5201 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5202 &object
, &dx
, &dy
, &width
, &height
);
5203 if (STRINGP (string
))
5204 string_info
= Fcons (string
, make_number (charpos
));
5205 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5207 else if (part
== ON_LEFT_FRINGE
)
5209 posn
= Qleft_fringe
;
5212 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5213 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5214 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5216 else if (part
== ON_RIGHT_FRINGE
)
5218 posn
= Qright_fringe
;
5221 - window_box_width (w
, LEFT_MARGIN_AREA
)
5222 - window_box_width (w
, TEXT_AREA
)
5223 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5224 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5226 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5228 else if (part
== ON_VERTICAL_BORDER
)
5230 posn
= Qvertical_line
;
5235 /* Nothing special for part == ON_SCROLL_BAR. */
5237 /* For clicks in the text area, fringes, or margins, call
5238 buffer_posn_from_coords to extract TEXTPOS, the buffer
5239 position nearest to the click. */
5242 Lisp_Object string2
, object2
= Qnil
;
5243 struct display_pos p
;
5245 int width2
, height2
;
5246 /* The pixel X coordinate passed to buffer_posn_from_coords
5247 is the X coordinate relative to the text area for
5248 text-area and right-margin clicks, zero otherwise. */
5250 = (part
== ON_TEXT
) ? xret
5251 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5252 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5256 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5257 &object2
, &dx2
, &dy2
,
5259 textpos
= CHARPOS (p
.pos
);
5260 if (col
< 0) col
= x2
;
5261 if (row
< 0) row
= y2
;
5262 if (dx
< 0) dx
= dx2
;
5263 if (dy
< 0) dy
= dy2
;
5264 if (width
< 0) width
= width2
;
5265 if (height
< 0) height
= height2
;
5269 posn
= make_number (textpos
);
5270 if (STRINGP (string2
))
5271 string_info
= Fcons (string2
,
5272 make_number (CHARPOS (p
.string_pos
)));
5278 #ifdef HAVE_WINDOW_SYSTEM
5279 if (IMAGEP (object
))
5281 Lisp_Object image_map
, hotspot
;
5282 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5284 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5286 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5287 posn
= XCAR (hotspot
);
5294 Fcons (make_number (dx
), make_number (dy
)),
5295 Fcons (make_number (width
), make_number (height
)));
5298 extra_info
= Fcons (string_info
,
5299 Fcons (make_number (textpos
),
5300 Fcons (Fcons (make_number (col
),
5305 XSETFRAME (window
, f
);
5309 return Fcons (window
,
5311 Fcons (Fcons (make_number (xret
),
5312 make_number (yret
)),
5313 Fcons (make_number (t
),
5317 /* Given a struct input_event, build the lisp event which represents
5318 it. If EVENT is 0, build a mouse movement event from the mouse
5319 movement buffer, which should have a movement event in it.
5321 Note that events must be passed to this function in the order they
5322 are received; this function stores the location of button presses
5323 in order to build drag events when the button is released. */
5326 make_lispy_event (struct input_event
*event
)
5330 switch (SWITCH_ENUM_CAST (event
->kind
))
5332 /* A simple keystroke. */
5333 case ASCII_KEYSTROKE_EVENT
:
5334 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5336 Lisp_Object lispy_c
;
5337 EMACS_INT c
= event
->code
;
5338 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5341 eassert (c
== event
->code
);
5342 /* Turn ASCII characters into control characters
5344 if (event
->modifiers
& ctrl_modifier
)
5346 c
= make_ctrl_char (c
);
5347 event
->modifiers
&= ~ctrl_modifier
;
5351 /* Add in the other modifier bits. The shift key was taken care
5352 of by the X code. */
5353 c
|= (event
->modifiers
5354 & (meta_modifier
| alt_modifier
5355 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5356 /* Distinguish Shift-SPC from SPC. */
5357 if ((event
->code
) == 040
5358 && event
->modifiers
& shift_modifier
)
5359 c
|= shift_modifier
;
5360 button_down_time
= 0;
5361 XSETFASTINT (lispy_c
, c
);
5366 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5367 except that they are non-key events (last-nonmenu-event is nil). */
5368 case NS_NONKEY_EVENT
:
5371 /* A function key. The symbol may need to have modifier prefixes
5373 case NON_ASCII_KEYSTROKE_EVENT
:
5374 button_down_time
= 0;
5376 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5377 if (event
->code
== lispy_accent_codes
[i
])
5378 return modify_event_symbol (i
,
5380 Qfunction_key
, Qnil
,
5381 lispy_accent_keys
, &accent_key_syms
,
5382 (sizeof (lispy_accent_keys
)
5383 / sizeof (lispy_accent_keys
[0])));
5387 if (event
->code
>= 0x400 && event
->code
< 0x500)
5388 return modify_event_symbol (event
->code
- 0x400,
5389 event
->modifiers
& ~shift_modifier
,
5390 Qfunction_key
, Qnil
,
5391 lispy_kana_keys
, &func_key_syms
,
5392 (sizeof (lispy_kana_keys
)
5393 / sizeof (lispy_kana_keys
[0])));
5394 #endif /* XK_kana_A */
5397 #ifdef ISO_FUNCTION_KEY_OFFSET
5398 if (event
->code
< FUNCTION_KEY_OFFSET
5399 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5400 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5402 Qfunction_key
, Qnil
,
5403 iso_lispy_function_keys
, &func_key_syms
,
5404 (sizeof (iso_lispy_function_keys
)
5405 / sizeof (iso_lispy_function_keys
[0])));
5408 /* Handle system-specific or unknown keysyms. */
5409 if (event
->code
& (1 << 28)
5410 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5411 || (event
->code
- FUNCTION_KEY_OFFSET
5412 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5413 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5415 /* We need to use an alist rather than a vector as the cache
5416 since we can't make a vector long enough. */
5417 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5418 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5419 return modify_event_symbol (event
->code
,
5422 KVAR (current_kboard
, Vsystem_key_alist
),
5423 0, &KVAR (current_kboard
, system_key_syms
),
5424 TYPE_MAXIMUM (EMACS_INT
));
5427 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5429 Qfunction_key
, Qnil
,
5430 lispy_function_keys
, &func_key_syms
,
5431 (sizeof (lispy_function_keys
)
5432 / sizeof (lispy_function_keys
[0])));
5435 case MULTIMEDIA_KEY_EVENT
:
5436 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5437 / sizeof (lispy_multimedia_keys
[0]))
5438 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5440 return modify_event_symbol (event
->code
, event
->modifiers
,
5441 Qfunction_key
, Qnil
,
5442 lispy_multimedia_keys
, &func_key_syms
,
5443 (sizeof (lispy_multimedia_keys
)
5444 / sizeof (lispy_multimedia_keys
[0])));
5450 /* A mouse click. Figure out where it is, decide whether it's
5451 a press, click or drag, and build the appropriate structure. */
5452 case MOUSE_CLICK_EVENT
:
5453 #ifndef USE_TOOLKIT_SCROLL_BARS
5454 case SCROLL_BAR_CLICK_EVENT
:
5457 int button
= event
->code
;
5459 Lisp_Object position
;
5460 Lisp_Object
*start_pos_ptr
;
5461 Lisp_Object start_pos
;
5465 /* Build the position as appropriate for this mouse click. */
5466 if (event
->kind
== MOUSE_CLICK_EVENT
)
5468 struct frame
*f
= XFRAME (event
->frame_or_window
);
5469 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5473 /* Ignore mouse events that were made on frame that
5474 have been deleted. */
5475 if (! FRAME_LIVE_P (f
))
5478 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5479 /* EVENT->x and EVENT->y are frame-relative pixel
5480 coordinates at this place. Under old redisplay, COLUMN
5481 and ROW are set to frame relative glyph coordinates
5482 which are then used to determine whether this click is
5483 in a menu (non-toolkit version). */
5484 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5485 &column
, &row
, NULL
, 1);
5487 /* In the non-toolkit version, clicks on the menu bar
5488 are ordinary button events in the event buffer.
5489 Distinguish them, and invoke the menu.
5491 (In the toolkit version, the toolkit handles the menu bar
5492 and Emacs doesn't know about it until after the user
5493 makes a selection.) */
5494 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5495 && (event
->modifiers
& down_modifier
))
5497 Lisp_Object items
, item
;
5499 /* Find the menu bar item under `column'. */
5501 items
= FRAME_MENU_BAR_ITEMS (f
);
5502 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5504 Lisp_Object pos
, string
;
5505 string
= AREF (items
, i
+ 1);
5506 pos
= AREF (items
, i
+ 3);
5509 if (column
>= XINT (pos
)
5510 && column
< XINT (pos
) + SCHARS (string
))
5512 item
= AREF (items
, i
);
5517 /* ELisp manual 2.4b says (x y) are window relative but
5518 code says they are frame-relative. */
5520 = Fcons (event
->frame_or_window
,
5522 Fcons (Fcons (event
->x
, event
->y
),
5523 Fcons (make_number (event
->timestamp
),
5526 return Fcons (item
, Fcons (position
, Qnil
));
5528 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5530 position
= make_lispy_position (f
, event
->x
, event
->y
,
5533 #ifndef USE_TOOLKIT_SCROLL_BARS
5536 /* It's a scrollbar click. */
5538 Lisp_Object portion_whole
;
5541 window
= event
->frame_or_window
;
5542 portion_whole
= Fcons (event
->x
, event
->y
);
5543 part
= *scroll_bar_parts
[(int) event
->part
];
5547 Fcons (Qvertical_scroll_bar
,
5548 Fcons (portion_whole
,
5549 Fcons (make_number (event
->timestamp
),
5550 Fcons (part
, Qnil
)))));
5552 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5554 if (button
>= ASIZE (button_down_location
))
5556 button_down_location
= larger_vector (button_down_location
,
5558 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5561 start_pos_ptr
= &AREF (button_down_location
, button
);
5562 start_pos
= *start_pos_ptr
;
5563 *start_pos_ptr
= Qnil
;
5566 /* On window-system frames, use the value of
5567 double-click-fuzz as is. On other frames, interpret it
5568 as a multiple of 1/8 characters. */
5572 if (WINDOWP (event
->frame_or_window
))
5573 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5574 else if (FRAMEP (event
->frame_or_window
))
5575 f
= XFRAME (event
->frame_or_window
);
5579 if (FRAME_WINDOW_P (f
))
5580 fuzz
= double_click_fuzz
;
5582 fuzz
= double_click_fuzz
/ 8;
5584 is_double
= (button
== last_mouse_button
5585 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5586 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5587 && button_down_time
!= 0
5588 && (EQ (Vdouble_click_time
, Qt
)
5589 || (NATNUMP (Vdouble_click_time
)
5590 && (event
->timestamp
- button_down_time
5591 < XFASTINT (Vdouble_click_time
)))));
5594 last_mouse_button
= button
;
5595 last_mouse_x
= XINT (event
->x
);
5596 last_mouse_y
= XINT (event
->y
);
5598 /* If this is a button press, squirrel away the location, so
5599 we can decide later whether it was a click or a drag. */
5600 if (event
->modifiers
& down_modifier
)
5604 double_click_count
++;
5605 event
->modifiers
|= ((double_click_count
> 2)
5610 double_click_count
= 1;
5611 button_down_time
= event
->timestamp
;
5612 *start_pos_ptr
= Fcopy_alist (position
);
5613 ignore_mouse_drag_p
= 0;
5616 /* Now we're releasing a button - check the co-ordinates to
5617 see if this was a click or a drag. */
5618 else if (event
->modifiers
& up_modifier
)
5620 /* If we did not see a down before this up, ignore the up.
5621 Probably this happened because the down event chose a
5622 menu item. It would be an annoyance to treat the
5623 release of the button that chose the menu item as a
5626 if (!CONSP (start_pos
))
5629 event
->modifiers
&= ~up_modifier
;
5632 Lisp_Object new_down
, down
;
5633 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5635 /* The third element of every position
5636 should be the (x,y) pair. */
5637 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5638 new_down
= Fcar (Fcdr (Fcdr (position
)));
5641 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5643 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5644 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5647 if (ignore_mouse_drag_p
)
5649 event
->modifiers
|= click_modifier
;
5650 ignore_mouse_drag_p
= 0;
5652 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5653 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5654 /* Maybe the mouse has moved a lot, caused scrolling, and
5655 eventually ended up at the same screen position (but
5656 not buffer position) in which case it is a drag, not
5658 /* FIXME: OTOH if the buffer position has changed
5659 because of a timer or process filter rather than
5660 because of mouse movement, it should be considered as
5661 a click. But mouse-drag-region completely ignores
5662 this case and it hasn't caused any real problem, so
5663 it's probably OK to ignore it as well. */
5664 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5665 /* Mouse hasn't moved (much). */
5666 event
->modifiers
|= click_modifier
;
5669 button_down_time
= 0;
5670 event
->modifiers
|= drag_modifier
;
5673 /* Don't check is_double; treat this as multiple
5674 if the down-event was multiple. */
5675 if (double_click_count
> 1)
5676 event
->modifiers
|= ((double_click_count
> 2)
5682 /* Every mouse event should either have the down_modifier or
5683 the up_modifier set. */
5687 /* Get the symbol we should use for the mouse click. */
5690 head
= modify_event_symbol (button
,
5692 Qmouse_click
, Vlispy_mouse_stem
,
5695 ASIZE (mouse_syms
));
5696 if (event
->modifiers
& drag_modifier
)
5701 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5704 Fcons (make_number (double_click_count
),
5714 case HORIZ_WHEEL_EVENT
:
5716 Lisp_Object position
;
5719 /* Build the position as appropriate for this mouse click. */
5720 struct frame
*f
= XFRAME (event
->frame_or_window
);
5722 /* Ignore wheel events that were made on frame that have been
5724 if (! FRAME_LIVE_P (f
))
5727 position
= make_lispy_position (f
, event
->x
, event
->y
,
5730 /* Set double or triple modifiers to indicate the wheel speed. */
5732 /* On window-system frames, use the value of
5733 double-click-fuzz as is. On other frames, interpret it
5734 as a multiple of 1/8 characters. */
5740 if (WINDOWP (event
->frame_or_window
))
5741 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5742 else if (FRAMEP (event
->frame_or_window
))
5743 fr
= XFRAME (event
->frame_or_window
);
5747 fuzz
= FRAME_WINDOW_P (fr
)
5748 ? double_click_fuzz
: double_click_fuzz
/ 8;
5750 if (event
->modifiers
& up_modifier
)
5752 /* Emit a wheel-up event. */
5753 event
->modifiers
&= ~up_modifier
;
5756 else if (event
->modifiers
& down_modifier
)
5758 /* Emit a wheel-down event. */
5759 event
->modifiers
&= ~down_modifier
;
5763 /* Every wheel event should either have the down_modifier or
5764 the up_modifier set. */
5767 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5770 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5771 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5772 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5773 && button_down_time
!= 0
5774 && (EQ (Vdouble_click_time
, Qt
)
5775 || (NATNUMP (Vdouble_click_time
)
5776 && (event
->timestamp
- button_down_time
5777 < XFASTINT (Vdouble_click_time
)))));
5780 double_click_count
++;
5781 event
->modifiers
|= ((double_click_count
> 2)
5787 double_click_count
= 1;
5788 event
->modifiers
|= click_modifier
;
5791 button_down_time
= event
->timestamp
;
5792 /* Use a negative value to distinguish wheel from mouse button. */
5793 last_mouse_button
= - (1 + symbol_num
);
5794 last_mouse_x
= XINT (event
->x
);
5795 last_mouse_y
= XINT (event
->y
);
5797 /* Get the symbol we should use for the wheel event. */
5798 head
= modify_event_symbol (symbol_num
,
5804 ASIZE (wheel_syms
));
5807 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5810 Fcons (make_number (double_click_count
),
5819 #ifdef USE_TOOLKIT_SCROLL_BARS
5821 /* We don't have down and up events if using toolkit scroll bars,
5822 so make this always a click event. Store in the `part' of
5823 the Lisp event a symbol which maps to the following actions:
5825 `above_handle' page up
5826 `below_handle' page down
5830 `bottom' bottom of buffer
5831 `handle' thumb has been dragged.
5832 `end-scroll' end of interaction with scroll bar
5834 The incoming input_event contains in its `part' member an
5835 index of type `enum scroll_bar_part' which we can use as an
5836 index in scroll_bar_parts to get the appropriate symbol. */
5838 case SCROLL_BAR_CLICK_EVENT
:
5840 Lisp_Object position
, head
, window
, portion_whole
, part
;
5842 window
= event
->frame_or_window
;
5843 portion_whole
= Fcons (event
->x
, event
->y
);
5844 part
= *scroll_bar_parts
[(int) event
->part
];
5848 Fcons (Qvertical_scroll_bar
,
5849 Fcons (portion_whole
,
5850 Fcons (make_number (event
->timestamp
),
5851 Fcons (part
, Qnil
)))));
5853 /* Always treat scroll bar events as clicks. */
5854 event
->modifiers
|= click_modifier
;
5855 event
->modifiers
&= ~up_modifier
;
5857 if (event
->code
>= ASIZE (mouse_syms
))
5858 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5860 /* Get the symbol we should use for the mouse click. */
5861 head
= modify_event_symbol (event
->code
,
5866 ASIZE (mouse_syms
));
5867 return Fcons (head
, Fcons (position
, Qnil
));
5870 #endif /* USE_TOOLKIT_SCROLL_BARS */
5872 case DRAG_N_DROP_EVENT
:
5875 Lisp_Object head
, position
;
5878 f
= XFRAME (event
->frame_or_window
);
5881 /* Ignore mouse events that were made on frames that
5882 have been deleted. */
5883 if (! FRAME_LIVE_P (f
))
5886 position
= make_lispy_position (f
, event
->x
, event
->y
,
5889 head
= modify_event_symbol (0, event
->modifiers
,
5891 lispy_drag_n_drop_names
,
5892 &drag_n_drop_syms
, 1);
5898 #endif /* HAVE_MOUSE */
5900 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5901 || defined (HAVE_NS) || defined (USE_GTK)
5902 case MENU_BAR_EVENT
:
5903 if (EQ (event
->arg
, event
->frame_or_window
))
5904 /* This is the prefix key. We translate this to
5905 `(menu_bar)' because the code in keyboard.c for menu
5906 events, which we use, relies on this. */
5907 return Fcons (Qmenu_bar
, Qnil
);
5911 case SELECT_WINDOW_EVENT
:
5912 /* Make an event (select-window (WINDOW)). */
5913 return Fcons (Qselect_window
,
5914 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5917 case TOOL_BAR_EVENT
:
5918 if (EQ (event
->arg
, event
->frame_or_window
))
5919 /* This is the prefix key. We translate this to
5920 `(tool_bar)' because the code in keyboard.c for tool bar
5921 events, which we use, relies on this. */
5922 return Fcons (Qtool_bar
, Qnil
);
5923 else if (SYMBOLP (event
->arg
))
5924 return apply_modifiers (event
->modifiers
, event
->arg
);
5927 case USER_SIGNAL_EVENT
:
5928 /* A user signal. */
5930 char *name
= find_user_signal_name (event
->code
);
5933 return intern (name
);
5936 case SAVE_SESSION_EVENT
:
5937 return Qsave_session
;
5942 return Fcons (Qdbus_event
, event
->arg
);
5944 #endif /* HAVE_DBUS */
5945 #ifdef HAVE_XWIDGETS
5948 printf("cool, an xwidget event arrived in make_lispy_event!\n");
5949 return Fcons (Qxwidget_event
,event
->arg
);
5952 case CONFIG_CHANGED_EVENT
:
5953 return Fcons (Qconfig_changed_event
,
5955 Fcons (event
->frame_or_window
, Qnil
)));
5957 case GPM_CLICK_EVENT
:
5959 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5960 Lisp_Object head
, position
;
5961 Lisp_Object
*start_pos_ptr
;
5962 Lisp_Object start_pos
;
5963 int button
= event
->code
;
5965 if (button
>= ASIZE (button_down_location
))
5967 button_down_location
= larger_vector (button_down_location
,
5969 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5972 start_pos_ptr
= &AREF (button_down_location
, button
);
5973 start_pos
= *start_pos_ptr
;
5975 position
= make_lispy_position (f
, event
->x
, event
->y
,
5978 if (event
->modifiers
& down_modifier
)
5979 *start_pos_ptr
= Fcopy_alist (position
);
5980 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5982 if (!CONSP (start_pos
))
5984 event
->modifiers
&= ~up_modifier
;
5987 head
= modify_event_symbol (button
,
5989 Qmouse_click
, Vlispy_mouse_stem
,
5992 ASIZE (mouse_syms
));
5994 if (event
->modifiers
& drag_modifier
)
5999 else if (event
->modifiers
& double_modifier
)
6002 Fcons (make_number (2),
6004 else if (event
->modifiers
& triple_modifier
)
6007 Fcons (make_number (3),
6014 #endif /* HAVE_GPM */
6016 /* The 'kind' field of the event is something we don't recognize. */
6022 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6025 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6026 Lisp_Object x
, Lisp_Object y
, Time t
)
6028 /* Is it a scroll bar movement? */
6029 if (frame
&& ! NILP (bar_window
))
6031 Lisp_Object part_sym
;
6033 part_sym
= *scroll_bar_parts
[(int) part
];
6034 return Fcons (Qscroll_bar_movement
,
6035 Fcons (list5 (bar_window
,
6036 Qvertical_scroll_bar
,
6042 /* Or is it an ordinary mouse movement? */
6045 Lisp_Object position
;
6046 position
= make_lispy_position (frame
, x
, y
, t
);
6047 return list2 (Qmouse_movement
, position
);
6051 #endif /* HAVE_MOUSE || HAVE GPM */
6053 /* Construct a switch frame event. */
6055 make_lispy_switch_frame (Lisp_Object frame
)
6057 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6060 /* Manipulating modifiers. */
6062 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6064 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6065 SYMBOL's name of the end of the modifiers; the string from this
6066 position is the unmodified symbol name.
6068 This doesn't use any caches. */
6071 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6077 CHECK_SYMBOL (symbol
);
6080 name
= SYMBOL_NAME (symbol
);
6082 for (i
= 0; i
+2 <= SBYTES (name
); )
6084 EMACS_INT this_mod_end
= 0;
6087 /* See if the name continues with a modifier word.
6088 Check that the word appears, but don't check what follows it.
6089 Set this_mod and this_mod_end to record what we find. */
6091 switch (SREF (name
, i
))
6093 #define SINGLE_LETTER_MOD(BIT) \
6094 (this_mod_end = i + 1, this_mod = BIT)
6097 SINGLE_LETTER_MOD (alt_modifier
);
6101 SINGLE_LETTER_MOD (ctrl_modifier
);
6105 SINGLE_LETTER_MOD (hyper_modifier
);
6109 SINGLE_LETTER_MOD (meta_modifier
);
6113 SINGLE_LETTER_MOD (shift_modifier
);
6117 SINGLE_LETTER_MOD (super_modifier
);
6120 #undef SINGLE_LETTER_MOD
6122 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6123 if (i + LEN + 1 <= SBYTES (name) \
6124 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6126 this_mod_end = i + LEN; \
6131 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6132 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6133 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6137 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6139 #undef MULTI_LETTER_MOD
6143 /* If we found no modifier, stop looking for them. */
6144 if (this_mod_end
== 0)
6147 /* Check there is a dash after the modifier, so that it
6148 really is a modifier. */
6149 if (this_mod_end
>= SBYTES (name
)
6150 || SREF (name
, this_mod_end
) != '-')
6153 /* This modifier is real; look for another. */
6154 modifiers
|= this_mod
;
6155 i
= this_mod_end
+ 1;
6158 /* Should we include the `click' modifier? */
6159 if (! (modifiers
& (down_modifier
| drag_modifier
6160 | double_modifier
| triple_modifier
))
6161 && i
+ 7 == SBYTES (name
)
6162 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6163 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6164 modifiers
|= click_modifier
;
6166 if (! (modifiers
& (double_modifier
| triple_modifier
))
6167 && i
+ 6 < SBYTES (name
)
6168 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6169 modifiers
|= click_modifier
;
6177 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6178 prepended to the string BASE[0..BASE_LEN-1].
6179 This doesn't use any caches. */
6181 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6183 /* Since BASE could contain nulls, we can't use intern here; we have
6184 to use Fintern, which expects a genuine Lisp_String, and keeps a
6187 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6193 /* Only the event queue may use the `up' modifier; it should always
6194 be turned into a click or drag event before presented to lisp code. */
6195 if (modifiers
& up_modifier
)
6198 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6199 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6200 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6201 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6202 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6203 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6204 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6205 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6206 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6207 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6208 /* The click modifier is denoted by the absence of other modifiers. */
6212 mod_len
= p
- new_mods
;
6216 Lisp_Object new_name
;
6218 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6219 mod_len
+ base_len_byte
);
6220 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6221 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6223 return Fintern (new_name
, Qnil
);
6228 static const char *const modifier_names
[] =
6230 "up", "down", "drag", "click", "double", "triple", 0, 0,
6231 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6232 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6234 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6236 static Lisp_Object modifier_symbols
;
6238 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6240 lispy_modifier_list (int modifiers
)
6242 Lisp_Object modifier_list
;
6245 modifier_list
= Qnil
;
6246 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6247 if (modifiers
& (1<<i
))
6248 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6251 return modifier_list
;
6255 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6256 where UNMODIFIED is the unmodified form of SYMBOL,
6257 MASK is the set of modifiers present in SYMBOL's name.
6258 This is similar to parse_modifiers_uncached, but uses the cache in
6259 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6260 Qevent_symbol_elements property. */
6262 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6265 parse_modifiers (Lisp_Object symbol
)
6267 Lisp_Object elements
;
6269 if (INTEGERP (symbol
))
6270 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6271 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6273 else if (!SYMBOLP (symbol
))
6276 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6277 if (CONSP (elements
))
6282 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6283 Lisp_Object unmodified
;
6286 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6287 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6290 if (modifiers
& ~INTMASK
)
6292 XSETFASTINT (mask
, modifiers
);
6293 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6295 /* Cache the parsing results on SYMBOL. */
6296 Fput (symbol
, Qevent_symbol_element_mask
,
6298 Fput (symbol
, Qevent_symbol_elements
,
6299 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6301 /* Since we know that SYMBOL is modifiers applied to unmodified,
6302 it would be nice to put that in unmodified's cache.
6303 But we can't, since we're not sure that parse_modifiers is
6310 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6311 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6312 doc
: /* Parse the event symbol. For internal use. */)
6313 (Lisp_Object symbol
)
6315 /* Fill the cache if needed. */
6316 parse_modifiers (symbol
);
6317 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6318 and use the Lispier representation stored on Qevent_symbol_elements
6320 return Fget (symbol
, Qevent_symbol_elements
);
6323 /* Apply the modifiers MODIFIERS to the symbol BASE.
6324 BASE must be unmodified.
6326 This is like apply_modifiers_uncached, but uses BASE's
6327 Qmodifier_cache property, if present. It also builds
6328 Qevent_symbol_elements properties, since it has that info anyway.
6330 apply_modifiers copies the value of BASE's Qevent_kind property to
6331 the modified symbol. */
6333 apply_modifiers (int modifiers
, Lisp_Object base
)
6335 Lisp_Object cache
, idx
, entry
, new_symbol
;
6337 /* Mask out upper bits. We don't know where this value's been. */
6338 modifiers
&= INTMASK
;
6340 if (INTEGERP (base
))
6341 return make_number (XINT (base
) | modifiers
);
6343 /* The click modifier never figures into cache indices. */
6344 cache
= Fget (base
, Qmodifier_cache
);
6345 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6346 entry
= assq_no_quit (idx
, cache
);
6349 new_symbol
= XCDR (entry
);
6352 /* We have to create the symbol ourselves. */
6353 new_symbol
= apply_modifiers_uncached (modifiers
,
6354 SSDATA (SYMBOL_NAME (base
)),
6355 SCHARS (SYMBOL_NAME (base
)),
6356 SBYTES (SYMBOL_NAME (base
)));
6358 /* Add the new symbol to the base's cache. */
6359 entry
= Fcons (idx
, new_symbol
);
6360 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6362 /* We have the parsing info now for free, so we could add it to
6364 XSETFASTINT (idx, modifiers);
6365 Fput (new_symbol, Qevent_symbol_element_mask,
6366 Fcons (base, Fcons (idx, Qnil)));
6367 Fput (new_symbol, Qevent_symbol_elements,
6368 Fcons (base, lispy_modifier_list (modifiers)));
6369 Sadly, this is only correct if `base' is indeed a base event,
6370 which is not necessarily the case. -stef */
6373 /* Make sure this symbol is of the same kind as BASE.
6375 You'd think we could just set this once and for all when we
6376 intern the symbol above, but reorder_modifiers may call us when
6377 BASE's property isn't set right; we can't assume that just
6378 because it has a Qmodifier_cache property it must have its
6379 Qevent_kind set right as well. */
6380 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6384 kind
= Fget (base
, Qevent_kind
);
6386 Fput (new_symbol
, Qevent_kind
, kind
);
6393 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6394 return a symbol with the modifiers placed in the canonical order.
6395 Canonical order is alphabetical, except for down and drag, which
6396 always come last. The 'click' modifier is never written out.
6398 Fdefine_key calls this to make sure that (for example) C-M-foo
6399 and M-C-foo end up being equivalent in the keymap. */
6402 reorder_modifiers (Lisp_Object symbol
)
6404 /* It's hopefully okay to write the code this way, since everything
6405 will soon be in caches, and no consing will be done at all. */
6408 parsed
= parse_modifiers (symbol
);
6409 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6414 /* For handling events, we often want to produce a symbol whose name
6415 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6416 to some base, like the name of a function key or mouse button.
6417 modify_event_symbol produces symbols of this sort.
6419 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6420 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6423 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6424 into symbol names, or a string specifying a name stem used to
6425 construct a symbol name or the form `STEM-N', where N is the decimal
6426 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6427 non-nil; otherwise NAME_TABLE is used.
6429 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6430 persist between calls to modify_event_symbol that it can use to
6431 store a cache of the symbols it's generated for this NAME_TABLE
6432 before. The object stored there may be a vector or an alist.
6434 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6436 MODIFIERS is a set of modifier bits (as given in struct input_events)
6437 whose prefixes should be applied to the symbol name.
6439 SYMBOL_KIND is the value to be placed in the event_kind property of
6440 the returned symbol.
6442 The symbols we create are supposed to have an
6443 `event-symbol-elements' property, which lists the modifiers present
6444 in the symbol's name. */
6447 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6448 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6449 Lisp_Object
*symbol_table
, EMACS_INT table_size
)
6452 Lisp_Object symbol_int
;
6454 /* Get rid of the "vendor-specific" bit here. */
6455 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6457 /* Is this a request for a valid symbol? */
6458 if (symbol_num
< 0 || symbol_num
>= table_size
)
6461 if (CONSP (*symbol_table
))
6462 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6464 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6465 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6466 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6467 we've never used that symbol before. */
6470 if (! VECTORP (*symbol_table
)
6471 || ASIZE (*symbol_table
) != table_size
)
6475 XSETFASTINT (size
, table_size
);
6476 *symbol_table
= Fmake_vector (size
, Qnil
);
6479 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6482 /* Have we already used this symbol before? */
6485 /* No; let's create it. */
6486 if (CONSP (name_alist_or_stem
))
6487 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6488 else if (STRINGP (name_alist_or_stem
))
6491 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6492 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6494 SAFE_ALLOCA (buf
, char *, len
);
6495 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6496 XINT (symbol_int
) + 1);
6497 value
= intern (buf
);
6500 else if (name_table
!= 0 && name_table
[symbol_num
])
6501 value
= intern (name_table
[symbol_num
]);
6503 #ifdef HAVE_WINDOW_SYSTEM
6506 char *name
= x_get_keysym_name (symbol_num
);
6508 value
= intern (name
);
6514 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6515 sprintf (buf
, "key-%"pI
"d", symbol_num
);
6516 value
= intern (buf
);
6519 if (CONSP (*symbol_table
))
6520 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6522 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6524 /* Fill in the cache entries for this symbol; this also
6525 builds the Qevent_symbol_elements property, which the user
6527 apply_modifiers (modifiers
& click_modifier
, value
);
6528 Fput (value
, Qevent_kind
, symbol_kind
);
6531 /* Apply modifiers to that symbol. */
6532 return apply_modifiers (modifiers
, value
);
6535 /* Convert a list that represents an event type,
6536 such as (ctrl meta backspace), into the usual representation of that
6537 event type as a number or a symbol. */
6539 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6540 doc
: /* Convert the event description list EVENT-DESC to an event type.
6541 EVENT-DESC should contain one base event type (a character or symbol)
6542 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6543 drag, down, double or triple). The base must be last.
6544 The return value is an event type (a character or symbol) which
6545 has the same base event type and all the specified modifiers. */)
6546 (Lisp_Object event_desc
)
6554 while (CONSP (rest
))
6562 /* Given a symbol, see if it is a modifier name. */
6563 if (SYMBOLP (elt
) && CONSP (rest
))
6564 this = parse_solitary_modifier (elt
);
6568 else if (!NILP (base
))
6569 error ("Two bases given in one event");
6575 /* Let the symbol A refer to the character A. */
6576 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6577 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6579 if (INTEGERP (base
))
6581 /* Turn (shift a) into A. */
6582 if ((modifiers
& shift_modifier
) != 0
6583 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6585 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6586 modifiers
&= ~shift_modifier
;
6589 /* Turn (control a) into C-a. */
6590 if (modifiers
& ctrl_modifier
)
6591 return make_number ((modifiers
& ~ctrl_modifier
)
6592 | make_ctrl_char (XINT (base
)));
6594 return make_number (modifiers
| XINT (base
));
6596 else if (SYMBOLP (base
))
6597 return apply_modifiers (modifiers
, base
);
6600 error ("Invalid base event");
6605 /* Try to recognize SYMBOL as a modifier name.
6606 Return the modifier flag bit, or 0 if not recognized. */
6609 parse_solitary_modifier (Lisp_Object symbol
)
6611 Lisp_Object name
= SYMBOL_NAME (symbol
);
6613 switch (SREF (name
, 0))
6615 #define SINGLE_LETTER_MOD(BIT) \
6616 if (SBYTES (name) == 1) \
6619 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6620 if (LEN == SBYTES (name) \
6621 && ! strncmp (SSDATA (name), NAME, LEN)) \
6625 SINGLE_LETTER_MOD (alt_modifier
);
6629 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6633 SINGLE_LETTER_MOD (ctrl_modifier
);
6637 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6638 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6642 SINGLE_LETTER_MOD (hyper_modifier
);
6646 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6650 SINGLE_LETTER_MOD (meta_modifier
);
6654 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6658 SINGLE_LETTER_MOD (shift_modifier
);
6662 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6663 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6664 SINGLE_LETTER_MOD (super_modifier
);
6668 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6669 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6670 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6674 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6677 #undef SINGLE_LETTER_MOD
6678 #undef MULTI_LETTER_MOD
6684 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6685 Such a list is not valid as an event,
6686 but it can be a Lucid-style event type list. */
6689 lucid_event_type_list_p (Lisp_Object object
)
6693 if (! CONSP (object
))
6696 if (EQ (XCAR (object
), Qhelp_echo
)
6697 || EQ (XCAR (object
), Qvertical_line
)
6698 || EQ (XCAR (object
), Qmode_line
)
6699 || EQ (XCAR (object
), Qheader_line
))
6702 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6706 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6713 /* Store into *addr a value nonzero if terminal input chars are available.
6714 Serves the purpose of ioctl (0, FIONREAD, addr)
6715 but works even if FIONREAD does not exist.
6716 (In fact, this may actually read some input.)
6718 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6719 timer events that are ripe.
6720 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6721 events (FOCUS_IN_EVENT).
6722 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6723 movements and toolkit scroll bar thumb drags. */
6726 get_input_pending (int *addr
, int flags
)
6728 /* First of all, have we already counted some input? */
6729 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6731 /* If input is being read as it arrives, and we have none, there is none. */
6732 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6735 /* Try to read some input and see how much we get. */
6737 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6740 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6743 gobble_input (int expected
)
6746 if (interrupt_input
)
6749 mask
= sigblock (sigmask (SIGIO
));
6750 read_avail_input (expected
);
6754 #ifdef POLL_FOR_INPUT
6755 /* XXX This condition was (read_socket_hook && !interrupt_input),
6756 but read_socket_hook is not global anymore. Let's pretend that
6758 if (!interrupt_input
&& poll_suppress_count
== 0)
6761 mask
= sigblock (sigmask (SIGALRM
));
6762 read_avail_input (expected
);
6768 read_avail_input (expected
);
6771 /* Put a BUFFER_SWITCH_EVENT in the buffer
6772 so that read_key_sequence will notice the new current buffer. */
6775 record_asynch_buffer_change (void)
6777 struct input_event event
;
6781 event
.kind
= BUFFER_SWITCH_EVENT
;
6782 event
.frame_or_window
= Qnil
;
6785 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6786 The purpose of the event is to make read_key_sequence look up the
6787 keymaps again. If we aren't in read_key_sequence, we don't need one,
6788 and the event could cause trouble by messing up (input-pending-p).
6789 Note: Fwaiting_for_user_input_p always returns nil when async
6790 subprocesses aren't supported. */
6791 tem
= Fwaiting_for_user_input_p ();
6795 /* Make sure no interrupt happens while storing the event. */
6797 if (interrupt_input
)
6800 mask
= sigblock (sigmask (SIGIO
));
6801 kbd_buffer_store_event (&event
);
6808 kbd_buffer_store_event (&event
);
6813 /* Read any terminal input already buffered up by the system
6814 into the kbd_buffer, but do not wait.
6816 EXPECTED should be nonzero if the caller knows there is some input.
6818 Returns the number of keyboard chars read, or -1 meaning
6819 this is a bad time to try to read input. */
6822 read_avail_input (int expected
)
6828 /* Store pending user signal events, if any. */
6829 if (store_user_signal_events ())
6832 /* Loop through the available terminals, and call their input hooks. */
6836 struct terminal
*next
= t
->next_terminal
;
6838 if (t
->read_socket_hook
)
6841 struct input_event hold_quit
;
6843 EVENT_INIT (hold_quit
);
6844 hold_quit
.kind
= NO_EVENT
;
6846 /* No need for FIONREAD or fcntl; just say don't wait. */
6847 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6853 if (nr
== -1) /* Not OK to read input now. */
6857 else if (nr
== -2) /* Non-transient error. */
6859 /* The terminal device terminated; it should be closed. */
6861 /* Kill Emacs if this was our last terminal. */
6862 if (!terminal_list
->next_terminal
)
6863 /* Formerly simply reported no input, but that
6864 sometimes led to a failure of Emacs to terminate.
6865 SIGHUP seems appropriate if we can't reach the
6867 /* ??? Is it really right to send the signal just to
6868 this process rather than to the whole process
6869 group? Perhaps on systems with FIONREAD Emacs is
6870 alone in its group. */
6871 kill (getpid (), SIGHUP
);
6873 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6876 XSETTERMINAL (tmp
, t
);
6877 Fdelete_terminal (tmp
, Qnoelisp
);
6881 if (hold_quit
.kind
!= NO_EVENT
)
6882 kbd_buffer_store_event (&hold_quit
);
6891 frame_make_pointer_visible ();
6897 decode_keyboard_code (struct tty_display_info
*tty
,
6898 struct coding_system
*coding
,
6899 unsigned char *buf
, int nbytes
)
6901 unsigned char *src
= buf
;
6902 const unsigned char *p
;
6907 if (tty
->meta_key
!= 2)
6908 for (i
= 0; i
< nbytes
; i
++)
6910 if (coding
->carryover_bytes
> 0)
6912 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6913 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6914 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6915 nbytes
+= coding
->carryover_bytes
;
6917 coding
->destination
= alloca (nbytes
* 4);
6918 coding
->dst_bytes
= nbytes
* 4;
6919 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6920 if (coding
->produced_char
== 0)
6922 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6924 struct input_event event_buf
;
6926 EVENT_INIT (event_buf
);
6927 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6929 (ASCII_CHAR_P (event_buf
.code
)
6930 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6931 /* See the comment in tty_read_avail_input. */
6932 event_buf
.frame_or_window
= tty
->top_frame
;
6933 event_buf
.arg
= Qnil
;
6934 kbd_buffer_store_event (&event_buf
);
6938 /* This is the tty way of reading available input.
6940 Note that each terminal device has its own `struct terminal' object,
6941 and so this function is called once for each individual termcap
6942 terminal. The first parameter indicates which terminal to read from. */
6945 tty_read_avail_input (struct terminal
*terminal
,
6947 struct input_event
*hold_quit
)
6949 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6950 the kbd_buffer can really hold. That may prevent loss
6951 of characters on some systems when input is stuffed at us. */
6952 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6954 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6957 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6959 if (kbd_on_hold_p () || buffer_free
<= 0)
6961 #endif /* subprocesses */
6963 if (!terminal
->name
) /* Don't read from a dead terminal. */
6966 if (terminal
->type
!= output_termcap
6967 && terminal
->type
!= output_msdos_raw
)
6970 /* XXX I think the following code should be moved to separate hook
6971 functions in system-dependent files. */
6974 #else /* not WINDOWSNT */
6975 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6979 return 0; /* The terminal is suspended. */
6982 n_to_read
= dos_keysns ();
6986 cbuf
[0] = dos_keyread ();
6989 #else /* not MSDOS */
6994 struct input_event gpm_hold_quit
;
6995 int gpm
, fd
= gpm_fd
;
6997 EVENT_INIT (gpm_hold_quit
);
6998 gpm_hold_quit
.kind
= NO_EVENT
;
7000 /* gpm==1 if event received.
7001 gpm==0 if the GPM daemon has closed the connection, in which case
7002 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7003 we save it in `fd' so close_gpm can remove it from the
7005 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7006 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7007 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7010 /* Presumably the GPM daemon has closed the connection. */
7012 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7013 kbd_buffer_store_event (&gpm_hold_quit
);
7017 #endif /* HAVE_GPM */
7019 /* Determine how many characters we should *try* to read. */
7021 /* Find out how much input is available. */
7022 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7024 if (! noninteractive
)
7025 return -2; /* Close this terminal. */
7031 if (n_to_read
> sizeof cbuf
)
7032 n_to_read
= sizeof cbuf
;
7033 #else /* no FIONREAD */
7034 #if defined (USG) || defined (CYGWIN)
7035 /* Read some input if available, but don't wait. */
7036 n_to_read
= sizeof cbuf
;
7037 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7044 /* Don't read more than we can store. */
7045 if (n_to_read
> buffer_free
)
7046 n_to_read
= buffer_free
;
7047 #endif /* subprocesses */
7049 /* Now read; for one reason or another, this will not block.
7050 NREAD is set to the number of chars read. */
7053 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7054 /* POSIX infers that processes which are not in the session leader's
7055 process group won't get SIGHUP's at logout time. BSDI adheres to
7056 this part standard and returns -1 from read (0) with errno==EIO
7057 when the control tty is taken away.
7058 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7059 if (nread
== -1 && errno
== EIO
)
7060 return -2; /* Close this terminal. */
7061 #if defined (AIX) && defined (_BSD)
7062 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7063 This looks incorrect, but it isn't, because _BSD causes
7064 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7065 and that causes a value other than 0 when there is no input. */
7067 return -2; /* Close this terminal. */
7071 /* We used to retry the read if it was interrupted.
7072 But this does the wrong thing when O_NDELAY causes
7073 an EAGAIN error. Does anybody know of a situation
7074 where a retry is actually needed? */
7076 nread
< 0 && (errno
== EAGAIN
7090 #if defined (USG) || defined (CYGWIN)
7091 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7092 #endif /* USG or CYGWIN */
7093 #endif /* no FIONREAD */
7098 #endif /* not MSDOS */
7099 #endif /* not WINDOWSNT */
7101 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7102 & CODING_REQUIRE_DECODING_MASK
)
7104 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7107 /* Decode the key sequence except for those with meta
7109 for (i
= from
= 0; ; i
++)
7110 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7112 struct input_event buf
;
7114 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7119 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7120 buf
.modifiers
= meta_modifier
;
7121 buf
.code
= cbuf
[i
] & ~0x80;
7122 /* See the comment below. */
7123 buf
.frame_or_window
= tty
->top_frame
;
7125 kbd_buffer_store_event (&buf
);
7131 for (i
= 0; i
< nread
; i
++)
7133 struct input_event buf
;
7135 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7137 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7138 buf
.modifiers
= meta_modifier
;
7139 if (tty
->meta_key
!= 2)
7143 /* Set the frame corresponding to the active tty. Note that the
7144 value of selected_frame is not reliable here, redisplay tends
7145 to temporarily change it. */
7146 buf
.frame_or_window
= tty
->top_frame
;
7149 kbd_buffer_store_event (&buf
);
7150 /* Don't look at input that follows a C-g too closely.
7151 This reduces lossage due to autorepeat on C-g. */
7152 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7153 && buf
.code
== quit_char
)
7161 handle_async_input (void)
7163 interrupt_input_pending
= 0;
7165 pending_signals
= pending_atimers
;
7167 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7168 doing anything dangerous. */
7175 nread
= read_avail_input (1);
7176 /* -1 means it's not ok to read the input now.
7177 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7178 0 means there was no keyboard input available. */
7188 process_pending_signals (void)
7190 if (interrupt_input_pending
)
7191 handle_async_input ();
7192 do_pending_atimers ();
7195 #ifdef SIGIO /* for entire page */
7196 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7199 input_available_signal (int signo
)
7201 /* Must preserve main program's value of errno. */
7202 int old_errno
= errno
;
7203 SIGNAL_THREAD_CHECK (signo
);
7206 interrupt_input_pending
= 1;
7207 pending_signals
= 1;
7210 if (input_available_clear_time
)
7211 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7214 handle_async_input ();
7221 /* Send ourselves a SIGIO.
7223 This function exists so that the UNBLOCK_INPUT macro in
7224 blockinput.h can have some way to take care of input we put off
7225 dealing with, without assuming that every file which uses
7226 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7228 reinvoke_input_signal (void)
7231 handle_async_input ();
7237 /* User signal events. */
7239 struct user_signal_info
7241 /* Signal number. */
7244 /* Name of the signal. */
7247 /* Number of pending signals. */
7250 struct user_signal_info
*next
;
7253 /* List of user signals. */
7254 static struct user_signal_info
*user_signals
= NULL
;
7257 add_user_signal (int sig
, const char *name
)
7259 struct user_signal_info
*p
;
7261 for (p
= user_signals
; p
; p
= p
->next
)
7263 /* Already added. */
7266 p
= xmalloc (sizeof (struct user_signal_info
));
7268 p
->name
= xstrdup (name
);
7270 p
->next
= user_signals
;
7273 signal (sig
, handle_user_signal
);
7277 handle_user_signal (int sig
)
7279 int old_errno
= errno
;
7280 struct user_signal_info
*p
;
7281 const char *special_event_name
= NULL
;
7283 SIGNAL_THREAD_CHECK (sig
);
7285 if (SYMBOLP (Vdebug_on_event
))
7286 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7288 for (p
= user_signals
; p
; p
= p
->next
)
7291 if (special_event_name
&&
7292 strcmp (special_event_name
, p
->name
) == 0)
7294 /* Enter the debugger in many ways. */
7295 debug_on_next_call
= 1;
7298 Vinhibit_quit
= Qnil
;
7300 /* Eat the event. */
7306 if (interrupt_input
)
7307 kill (getpid (), SIGIO
);
7311 /* Tell wait_reading_process_output that it needs to wake
7312 up and look around. */
7313 if (input_available_clear_time
)
7314 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7323 find_user_signal_name (int sig
)
7325 struct user_signal_info
*p
;
7327 for (p
= user_signals
; p
; p
= p
->next
)
7335 store_user_signal_events (void)
7337 struct user_signal_info
*p
;
7338 struct input_event buf
;
7341 for (p
= user_signals
; p
; p
= p
->next
)
7342 if (p
->npending
> 0)
7348 memset (&buf
, 0, sizeof buf
);
7349 buf
.kind
= USER_SIGNAL_EVENT
;
7350 buf
.frame_or_window
= selected_frame
;
7352 nstored
+= p
->npending
;
7354 mask
= sigblock (sigmask (p
->sig
));
7358 kbd_buffer_store_event (&buf
);
7361 while (p
->npending
> 0);
7369 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7370 static Lisp_Object menu_bar_one_keymap_changed_items
;
7372 /* These variables hold the vector under construction within
7373 menu_bar_items and its subroutines, and the current index
7374 for storing into that vector. */
7375 static Lisp_Object menu_bar_items_vector
;
7376 static int menu_bar_items_index
;
7379 static const char* separator_names
[] = {
7384 "single-dashed-line",
7385 "double-dashed-line",
7387 "shadow-etched-out",
7388 "shadow-etched-in-dash",
7389 "shadow-etched-out-dash",
7390 "shadow-double-etched-in",
7391 "shadow-double-etched-out",
7392 "shadow-double-etched-in-dash",
7393 "shadow-double-etched-out-dash",
7397 /* Return non-zero if LABEL specifies a separator. */
7400 menu_separator_name_p (const char *label
)
7404 else if (strlen (label
) > 3
7405 && strncmp (label
, "--", 2) == 0
7410 for (i
= 0; separator_names
[i
]; ++i
)
7411 if (strcmp (label
, separator_names
[i
]) == 0)
7416 /* It's a separator if it contains only dashes. */
7417 while (*label
== '-')
7419 return (*label
== 0);
7426 /* Return a vector of menu items for a menu bar, appropriate
7427 to the current buffer. Each item has three elements in the vector:
7430 OLD is an old vector we can optionally reuse, or nil. */
7433 menu_bar_items (Lisp_Object old
)
7435 /* The number of keymaps we're scanning right now, and the number of
7436 keymaps we have allocated space for. */
7439 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7440 in the current keymaps, or nil where it is not a prefix. */
7443 Lisp_Object def
, tail
;
7448 /* In order to build the menus, we need to call the keymap
7449 accessors. They all call QUIT. But this function is called
7450 during redisplay, during which a quit is fatal. So inhibit
7451 quitting while building the menus.
7452 We do this instead of specbind because (1) errors will clear it anyway
7453 and (2) this avoids risk of specpdl overflow. */
7454 oquit
= Vinhibit_quit
;
7458 menu_bar_items_vector
= old
;
7460 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7461 menu_bar_items_index
= 0;
7463 /* Build our list of keymaps.
7464 If we recognize a function key and replace its escape sequence in
7465 keybuf with its symbol, or if the sequence starts with a mouse
7466 click and we need to switch buffers, we jump back here to rebuild
7467 the initial keymaps from the current buffer. */
7471 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7472 if (!NILP (Voverriding_local_map_menu_flag
))
7474 /* Yes, use them (if non-nil) as well as the global map. */
7475 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7477 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7478 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7479 if (!NILP (Voverriding_local_map
))
7480 maps
[nmaps
++] = Voverriding_local_map
;
7484 /* No, so use major and minor mode keymaps and keymap property.
7485 Note that menu-bar bindings in the local-map and keymap
7486 properties may not work reliable, as they are only
7487 recognized when the menu-bar (or mode-line) is updated,
7488 which does not normally happen after every command. */
7491 nminor
= current_minor_maps (NULL
, &tmaps
);
7492 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7494 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7495 maps
[nmaps
++] = tem
;
7496 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7498 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7500 maps
[nmaps
++] = current_global_map
;
7503 /* Look up in each map the dummy prefix key `menu-bar'. */
7505 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7506 if (!NILP (maps
[mapno
]))
7508 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7512 menu_bar_one_keymap_changed_items
= Qnil
;
7513 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7517 /* Move to the end those items that should be at the end. */
7519 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7522 int end
= menu_bar_items_index
;
7524 for (i
= 0; i
< end
; i
+= 4)
7525 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7527 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7528 /* Move the item at index I to the end,
7529 shifting all the others forward. */
7530 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7531 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7532 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7533 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7535 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7536 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7537 (end
- i
- 4) * sizeof (Lisp_Object
));
7538 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7539 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7540 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7541 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7546 /* Add nil, nil, nil, nil at the end. */
7548 int i
= menu_bar_items_index
;
7549 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7550 menu_bar_items_vector
=
7551 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7552 /* Add this item. */
7553 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7554 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7555 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7556 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7557 menu_bar_items_index
= i
;
7560 Vinhibit_quit
= oquit
;
7561 return menu_bar_items_vector
;
7564 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7565 If there's already an item for KEY, add this DEF to it. */
7567 Lisp_Object item_properties
;
7570 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7572 struct gcpro gcpro1
;
7576 if (EQ (item
, Qundefined
))
7578 /* If a map has an explicit `undefined' as definition,
7579 discard any previously made menu bar item. */
7581 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7582 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7584 if (menu_bar_items_index
> i
+ 4)
7585 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7586 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7587 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7588 menu_bar_items_index
-= 4;
7592 /* If this keymap has already contributed to this KEY,
7593 don't contribute to it a second time. */
7594 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7595 if (!NILP (tem
) || NILP (item
))
7598 menu_bar_one_keymap_changed_items
7599 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7601 /* We add to menu_bar_one_keymap_changed_items before doing the
7602 parse_menu_item, so that if it turns out it wasn't a menu item,
7603 it still correctly hides any further menu item. */
7605 i
= parse_menu_item (item
, 1);
7610 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7612 /* Find any existing item for this KEY. */
7613 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7614 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7617 /* If we did not find this KEY, add it at the end. */
7618 if (i
== menu_bar_items_index
)
7620 /* If vector is too small, get a bigger one. */
7621 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7622 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7623 /* Add this item. */
7624 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7625 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7626 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7627 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7628 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7629 menu_bar_items_index
= i
;
7631 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7635 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7636 /* If the new and the old items are not both keymaps,
7637 the lookup will only find `item'. */
7638 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7639 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7643 /* This is used as the handler when calling menu_item_eval_property. */
7645 menu_item_eval_property_1 (Lisp_Object arg
)
7647 /* If we got a quit from within the menu computation,
7648 quit all the way out of it. This takes care of C-] in the debugger. */
7649 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7650 Fsignal (Qquit
, Qnil
);
7656 eval_dyn (Lisp_Object form
)
7658 return Feval (form
, Qnil
);
7661 /* Evaluate an expression and return the result (or nil if something
7662 went wrong). Used to evaluate dynamic parts of menu items. */
7664 menu_item_eval_property (Lisp_Object sexpr
)
7666 int count
= SPECPDL_INDEX ();
7668 specbind (Qinhibit_redisplay
, Qt
);
7669 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7670 menu_item_eval_property_1
);
7671 return unbind_to (count
, val
);
7674 /* This function parses a menu item and leaves the result in the
7675 vector item_properties.
7676 ITEM is a key binding, a possible menu item.
7677 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7679 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7680 parse_menu_item returns true if the item is a menu item and false
7684 parse_menu_item (Lisp_Object item
, int inmenubar
)
7686 Lisp_Object def
, tem
, item_string
, start
;
7688 Lisp_Object keyhint
;
7697 /* Create item_properties vector if necessary. */
7698 if (NILP (item_properties
))
7700 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7702 /* Initialize optional entries. */
7703 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7704 ASET (item_properties
, i
, Qnil
);
7705 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7707 /* Save the item here to protect it from GC. */
7708 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7710 item_string
= XCAR (item
);
7714 if (STRINGP (item_string
))
7716 /* Old format menu item. */
7717 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7719 /* Maybe help string. */
7720 if (CONSP (item
) && STRINGP (XCAR (item
)))
7722 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7727 /* Maybe an obsolete key binding cache. */
7728 if (CONSP (item
) && CONSP (XCAR (item
))
7729 && (NILP (XCAR (XCAR (item
)))
7730 || VECTORP (XCAR (XCAR (item
)))))
7733 /* This is the real definition--the function to run. */
7734 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7736 /* Get enable property, if any. */
7739 tem
= Fget (item
, Qmenu_enable
);
7740 if (!NILP (Venable_disabled_menus_and_buttons
))
7741 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7742 else if (!NILP (tem
))
7743 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7746 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7748 /* New format menu item. */
7749 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7750 start
= XCDR (item
);
7753 /* We have a real binding. */
7754 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7756 item
= XCDR (start
);
7757 /* Is there an obsolete cache list with key equivalences. */
7758 if (CONSP (item
) && CONSP (XCAR (item
)))
7761 /* Parse properties. */
7762 while (CONSP (item
) && CONSP (XCDR (item
)))
7767 if (EQ (tem
, QCenable
))
7769 if (!NILP (Venable_disabled_menus_and_buttons
))
7770 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7772 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7774 else if (EQ (tem
, QCvisible
))
7776 /* If got a visible property and that evaluates to nil
7777 then ignore this item. */
7778 tem
= menu_item_eval_property (XCAR (item
));
7782 else if (EQ (tem
, QChelp
))
7783 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7784 else if (EQ (tem
, QCfilter
))
7786 else if (EQ (tem
, QCkey_sequence
))
7789 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7790 /* Be GC protected. Set keyhint to item instead of tem. */
7793 else if (EQ (tem
, QCkeys
))
7796 if (CONSP (tem
) || STRINGP (tem
))
7797 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7799 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7804 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7806 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7808 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7814 else if (inmenubar
|| !NILP (start
))
7818 return 0; /* not a menu item */
7820 /* If item string is not a string, evaluate it to get string.
7821 If we don't get a string, skip this item. */
7822 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7823 if (!(STRINGP (item_string
)))
7825 item_string
= menu_item_eval_property (item_string
);
7826 if (!STRINGP (item_string
))
7828 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7831 /* If got a filter apply it on definition. */
7832 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7835 def
= menu_item_eval_property (list2 (XCAR (filter
),
7836 list2 (Qquote
, def
)));
7838 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7841 /* Enable or disable selection of item. */
7842 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7845 tem
= menu_item_eval_property (tem
);
7846 if (inmenubar
&& NILP (tem
))
7847 return 0; /* Ignore disabled items in menu bar. */
7848 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7851 /* If we got no definition, this item is just unselectable text which
7852 is OK in a submenu but not in the menubar. */
7854 return (!inmenubar
);
7856 /* See if this is a separate pane or a submenu. */
7857 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7858 tem
= get_keymap (def
, 0, 1);
7859 /* For a subkeymap, just record its details and exit. */
7862 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7863 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7867 /* At the top level in the menu bar, do likewise for commands also.
7868 The menu bar does not display equivalent key bindings anyway.
7869 ITEM_PROPERTY_DEF is already set up properly. */
7873 { /* This is a command. See if there is an equivalent key binding. */
7874 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7876 /* The previous code preferred :key-sequence to :keys, so we
7877 preserve this behavior. */
7878 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7879 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7882 Lisp_Object prefix
= keyeq
;
7883 Lisp_Object keys
= Qnil
;
7887 def
= XCAR (prefix
);
7888 prefix
= XCDR (prefix
);
7891 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7893 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7895 keys
= XCAR (keyhint
);
7896 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7898 /* We have a suggested key. Is it bound to the command? */
7901 /* If the command is an alias for another
7902 (such as lmenu.el set it up), check if the
7903 original command matches the cached command. */
7904 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7909 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7913 tem
= Fkey_description (keys
, Qnil
);
7916 if (STRINGP (XCAR (prefix
)))
7917 tem
= concat2 (XCAR (prefix
), tem
);
7918 if (STRINGP (XCDR (prefix
)))
7919 tem
= concat2 (tem
, XCDR (prefix
));
7921 keyeq
= concat2 (build_string (" "), tem
);
7922 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7928 /* If we have an equivalent key binding, use that. */
7929 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7932 /* Include this when menu help is implemented.
7933 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7934 if (!(NILP (tem) || STRINGP (tem)))
7936 tem = menu_item_eval_property (tem);
7939 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7943 /* Handle radio buttons or toggle boxes. */
7944 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7946 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7947 menu_item_eval_property (tem
));
7954 /***********************************************************************
7956 ***********************************************************************/
7958 /* A vector holding tool bar items while they are parsed in function
7959 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7962 static Lisp_Object tool_bar_items_vector
;
7964 /* A vector holding the result of parse_tool_bar_item. Layout is like
7965 the one for a single item in tool_bar_items_vector. */
7967 static Lisp_Object tool_bar_item_properties
;
7969 /* Next free index in tool_bar_items_vector. */
7971 static int ntool_bar_items
;
7973 /* The symbols `:image' and `:rtl'. */
7975 static Lisp_Object QCimage
;
7976 static Lisp_Object QCrtl
;
7978 /* Function prototypes. */
7980 static void init_tool_bar_items (Lisp_Object
);
7981 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7982 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7983 static void append_tool_bar_item (void);
7986 /* Return a vector of tool bar items for keymaps currently in effect.
7987 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7988 tool bar items found. */
7991 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8000 /* In order to build the menus, we need to call the keymap
8001 accessors. They all call QUIT. But this function is called
8002 during redisplay, during which a quit is fatal. So inhibit
8003 quitting while building the menus. We do this instead of
8004 specbind because (1) errors will clear it anyway and (2) this
8005 avoids risk of specpdl overflow. */
8006 oquit
= Vinhibit_quit
;
8009 /* Initialize tool_bar_items_vector and protect it from GC. */
8010 init_tool_bar_items (reuse
);
8012 /* Build list of keymaps in maps. Set nmaps to the number of maps
8015 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8016 if (!NILP (Voverriding_local_map_menu_flag
))
8018 /* Yes, use them (if non-nil) as well as the global map. */
8019 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8021 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8022 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8023 if (!NILP (Voverriding_local_map
))
8024 maps
[nmaps
++] = Voverriding_local_map
;
8028 /* No, so use major and minor mode keymaps and keymap property.
8029 Note that tool-bar bindings in the local-map and keymap
8030 properties may not work reliable, as they are only
8031 recognized when the tool-bar (or mode-line) is updated,
8032 which does not normally happen after every command. */
8035 nminor
= current_minor_maps (NULL
, &tmaps
);
8036 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8038 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8039 maps
[nmaps
++] = tem
;
8040 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8042 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8045 /* Add global keymap at the end. */
8046 maps
[nmaps
++] = current_global_map
;
8048 /* Process maps in reverse order and look up in each map the prefix
8050 for (i
= nmaps
- 1; i
>= 0; --i
)
8051 if (!NILP (maps
[i
]))
8055 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8057 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8060 Vinhibit_quit
= oquit
;
8061 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8062 return tool_bar_items_vector
;
8066 /* Process the definition of KEY which is DEF. */
8069 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8072 struct gcpro gcpro1
, gcpro2
;
8074 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8078 if (EQ (def
, Qundefined
))
8080 /* If a map has an explicit `undefined' as definition,
8081 discard any previously made item. */
8082 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8084 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8086 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8088 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8089 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8090 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8091 * sizeof (Lisp_Object
)));
8092 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8097 else if (parse_tool_bar_item (key
, def
))
8098 /* Append a new tool bar item to tool_bar_items_vector. Accept
8099 more than one definition for the same key. */
8100 append_tool_bar_item ();
8106 /* Parse a tool bar item specification ITEM for key KEY and return the
8107 result in tool_bar_item_properties. Value is zero if ITEM is
8110 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8112 CAPTION is the caption of the item, If it's not a string, it is
8113 evaluated to get a string.
8115 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8116 as binding are currently ignored.
8118 The following properties are recognized:
8122 FORM is evaluated and specifies whether the tool bar item is
8123 enabled or disabled.
8127 FORM is evaluated and specifies whether the tool bar item is visible.
8129 - `:filter FUNCTION'
8131 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8132 result is stored as the new binding.
8134 - `:button (TYPE SELECTED)'
8136 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8137 and specifies whether the button is selected (pressed) or not.
8141 IMAGES is either a single image specification or a vector of four
8142 image specifications. See enum tool_bar_item_images.
8144 - `:help HELP-STRING'.
8146 Gives a help string to display for the tool bar item.
8148 - `:label LABEL-STRING'.
8150 A text label to show with the tool bar button if labels are enabled. */
8153 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8155 /* Access slot with index IDX of vector tool_bar_item_properties. */
8156 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8158 Lisp_Object filter
= Qnil
;
8159 Lisp_Object caption
;
8160 int i
, have_label
= 0;
8162 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8163 Rule out items that aren't lists, don't start with
8164 `menu-item' or whose rest following `tool-bar-item' is not a
8169 /* As an exception, allow old-style menu separators. */
8170 if (STRINGP (XCAR (item
)))
8171 item
= Fcons (XCAR (item
), Qnil
);
8172 else if (!EQ (XCAR (item
), Qmenu_item
)
8173 || (item
= XCDR (item
), !CONSP (item
)))
8176 /* Create tool_bar_item_properties vector if necessary. Reset it to
8178 if (VECTORP (tool_bar_item_properties
))
8180 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8184 tool_bar_item_properties
8185 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8188 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8189 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8191 /* Get the caption of the item. If the caption is not a string,
8192 evaluate it to get a string. If we don't get a string, skip this
8194 caption
= XCAR (item
);
8195 if (!STRINGP (caption
))
8197 caption
= menu_item_eval_property (caption
);
8198 if (!STRINGP (caption
))
8201 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8203 /* If the rest following the caption is not a list, the menu item is
8204 either a separator, or invalid. */
8208 if (menu_separator_name_p (SSDATA (caption
)))
8210 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8211 #if !defined (USE_GTK) && !defined (HAVE_NS)
8212 /* If we use build_desired_tool_bar_string to render the
8213 tool bar, the separator is rendered as an image. */
8214 PROP (TOOL_BAR_ITEM_IMAGES
)
8215 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8216 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8217 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8218 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8225 /* Store the binding. */
8226 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8229 /* Ignore cached key binding, if any. */
8230 if (CONSP (item
) && CONSP (XCAR (item
)))
8233 /* Process the rest of the properties. */
8234 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8236 Lisp_Object ikey
, value
;
8239 value
= XCAR (XCDR (item
));
8241 if (EQ (ikey
, QCenable
))
8243 /* `:enable FORM'. */
8244 if (!NILP (Venable_disabled_menus_and_buttons
))
8245 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8247 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8249 else if (EQ (ikey
, QCvisible
))
8251 /* `:visible FORM'. If got a visible property and that
8252 evaluates to nil then ignore this item. */
8253 if (NILP (menu_item_eval_property (value
)))
8256 else if (EQ (ikey
, QChelp
))
8257 /* `:help HELP-STRING'. */
8258 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8259 else if (EQ (ikey
, QCvert_only
))
8260 /* `:vert-only t/nil'. */
8261 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8262 else if (EQ (ikey
, QClabel
))
8264 const char *bad_label
= "!!?GARBLED ITEM?!!";
8265 /* `:label LABEL-STRING'. */
8266 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8268 : build_string (bad_label
);
8271 else if (EQ (ikey
, QCfilter
))
8272 /* ':filter FORM'. */
8274 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8276 /* `:button (TYPE . SELECTED)'. */
8277 Lisp_Object type
, selected
;
8279 type
= XCAR (value
);
8280 selected
= XCDR (value
);
8281 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8283 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8284 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8287 else if (EQ (ikey
, QCimage
)
8289 || (VECTORP (value
) && ASIZE (value
) == 4)))
8290 /* Value is either a single image specification or a vector
8291 of 4 such specifications for the different button states. */
8292 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8293 else if (EQ (ikey
, QCrtl
))
8295 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8301 /* Try to make one from caption and key. */
8302 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8303 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8304 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8305 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8307 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8308 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8309 Lisp_Object new_lbl
;
8310 ptrdiff_t caption_len
= strlen (capt
);
8312 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8315 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8317 buf
[caption_len
] = '\0';
8321 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8325 strcpy (buf
, label
);
8327 for (j
= 0; buf
[j
] != '\0'; ++j
)
8335 new_lbl
= Fupcase_initials (build_string (label
));
8336 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8337 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8339 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8343 /* If got a filter apply it on binding. */
8345 PROP (TOOL_BAR_ITEM_BINDING
)
8346 = menu_item_eval_property (list2 (filter
,
8348 PROP (TOOL_BAR_ITEM_BINDING
))));
8350 /* See if the binding is a keymap. Give up if it is. */
8351 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8354 /* Enable or disable selection of item. */
8355 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8356 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8357 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8359 /* Handle radio buttons or toggle boxes. */
8360 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8361 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8362 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8370 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8371 that can be reused. */
8374 init_tool_bar_items (Lisp_Object reuse
)
8376 if (VECTORP (reuse
))
8377 tool_bar_items_vector
= reuse
;
8379 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8380 ntool_bar_items
= 0;
8384 /* Append parsed tool bar item properties from
8385 tool_bar_item_properties */
8388 append_tool_bar_item (void)
8390 Lisp_Object
*to
, *from
;
8392 /* Enlarge tool_bar_items_vector if necessary. */
8393 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8394 >= ASIZE (tool_bar_items_vector
))
8395 tool_bar_items_vector
8396 = larger_vector (tool_bar_items_vector
,
8397 2 * ASIZE (tool_bar_items_vector
), Qnil
);
8399 /* Append entries from tool_bar_item_properties to the end of
8400 tool_bar_items_vector. */
8401 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8402 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8403 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8404 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8411 /* Read a character using menus based on maps in the array MAPS.
8412 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8413 Return t if we displayed a menu but the user rejected it.
8415 PREV_EVENT is the previous input event, or nil if we are reading
8416 the first event of a key sequence.
8418 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8419 if we used a mouse menu to read the input, or zero otherwise. If
8420 USED_MOUSE_MENU is null, we don't dereference it.
8422 The prompting is done based on the prompt-string of the map
8423 and the strings associated with various map elements.
8425 This can be done with X menus or with menus put in the minibuf.
8426 These are done in different ways, depending on how the input will be read.
8427 Menus using X are done after auto-saving in read-char, getting the input
8428 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8429 and do auto-saving in the inner call of read_char. */
8432 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8433 Lisp_Object prev_event
, int *used_mouse_menu
)
8437 if (used_mouse_menu
)
8438 *used_mouse_menu
= 0;
8440 /* Use local over global Menu maps */
8442 if (! menu_prompting
)
8445 /* Optionally disregard all but the global map. */
8446 if (inhibit_local_menu_bar_menus
)
8448 maps
+= (nmaps
- 1);
8453 /* If we got to this point via a mouse click,
8454 use a real menu for mouse selection. */
8455 if (EVENT_HAS_PARAMETERS (prev_event
)
8456 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8457 && !EQ (XCAR (prev_event
), Qtool_bar
))
8459 /* Display the menu and get the selection. */
8460 Lisp_Object
*realmaps
8461 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8463 ptrdiff_t nmaps1
= 0;
8465 /* Use the maps that are not nil. */
8466 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8467 if (!NILP (maps
[mapno
]))
8468 realmaps
[nmaps1
++] = maps
[mapno
];
8470 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8475 record_menu_key (XCAR (value
));
8477 /* If we got multiple events, unread all but
8479 There is no way to prevent those unread events
8480 from showing up later in last_nonmenu_event.
8481 So turn symbol and integer events into lists,
8482 to indicate that they came from a mouse menu,
8483 so that when present in last_nonmenu_event
8484 they won't confuse things. */
8485 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8487 record_menu_key (XCAR (tem
));
8488 if (SYMBOLP (XCAR (tem
))
8489 || INTEGERP (XCAR (tem
)))
8490 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8493 /* If we got more than one event, put all but the first
8494 onto this list to be read later.
8495 Return just the first event now. */
8496 Vunread_command_events
8497 = nconc2 (XCDR (value
), Vunread_command_events
);
8498 value
= XCAR (value
);
8500 else if (NILP (value
))
8502 if (used_mouse_menu
)
8503 *used_mouse_menu
= 1;
8506 #endif /* HAVE_MENUS */
8510 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8511 We make this bigger when necessary, and never free it. */
8512 static char *read_char_minibuf_menu_text
;
8513 /* Size of that buffer. */
8514 static ptrdiff_t read_char_minibuf_menu_width
;
8517 read_char_minibuf_menu_prompt (int commandflag
,
8518 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8521 register Lisp_Object name
;
8523 /* FIXME: Use the minibuffer's frame width. */
8524 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8527 Lisp_Object rest
, vector
;
8533 if (! menu_prompting
)
8536 /* Get the menu name from the first map that has one (a prompt string). */
8537 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8539 name
= Fkeymap_prompt (maps
[mapno
]);
8544 /* If we don't have any menus, just read a character normally. */
8545 if (!STRINGP (name
))
8548 /* Make sure we have a big enough buffer for the menu text. */
8549 width
= max (width
, SBYTES (name
));
8550 if (STRING_BYTES_BOUND
- 4 < width
)
8551 memory_full (SIZE_MAX
);
8552 if (width
+ 4 > read_char_minibuf_menu_width
)
8554 read_char_minibuf_menu_text
8555 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8556 read_char_minibuf_menu_width
= width
+ 4;
8558 menu
= read_char_minibuf_menu_text
;
8560 /* Prompt string always starts with map's prompt, and a space. */
8561 strcpy (menu
, SSDATA (name
));
8562 nlength
= SBYTES (name
);
8563 menu
[nlength
++] = ':';
8564 menu
[nlength
++] = ' ';
8567 /* Start prompting at start of first map. */
8571 /* Present the documented bindings, a line at a time. */
8575 ptrdiff_t i
= nlength
;
8577 Lisp_Object orig_defn_macro
;
8579 /* Loop over elements of map. */
8584 /* If reached end of map, start at beginning of next map. */
8588 /* At end of last map, wrap around to first map if just starting,
8589 or end this line if already have something on it. */
8593 if (notfirst
|| nobindings
) break;
8598 /* Look at the next element of the map. */
8600 elt
= XVECTOR (vector
)->contents
[idx
];
8602 elt
= Fcar_safe (rest
);
8604 if (idx
< 0 && VECTORP (elt
))
8606 /* If we found a dense table in the keymap,
8607 advanced past it, but start scanning its contents. */
8608 rest
= Fcdr_safe (rest
);
8614 /* An ordinary element. */
8615 Lisp_Object event
, tem
;
8619 event
= Fcar_safe (elt
); /* alist */
8620 elt
= Fcdr_safe (elt
);
8624 XSETINT (event
, idx
); /* vector */
8627 /* Ignore the element if it has no prompt string. */
8628 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8630 /* 1 if the char to type matches the string. */
8632 Lisp_Object upcased_event
, downcased_event
;
8633 Lisp_Object desc
= Qnil
;
8635 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8637 upcased_event
= Fupcase (event
);
8638 downcased_event
= Fdowncase (event
);
8639 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8640 || XINT (downcased_event
) == SREF (s
, 0));
8642 desc
= Fsingle_key_description (event
, Qnil
);
8644 #if 0 /* It is redundant to list the equivalent key bindings because
8645 the prefix is what the user has already typed. */
8647 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8649 /* Insert equivalent keybinding. */
8650 s
= concat2 (s
, tem
);
8653 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8654 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8656 /* Insert button prefix. */
8657 Lisp_Object selected
8658 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8659 if (EQ (tem
, QCradio
))
8660 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8662 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8663 s
= concat2 (tem
, s
);
8667 /* If we have room for the prompt string, add it to this line.
8668 If this is the first on the line, always add it. */
8669 if ((SCHARS (s
) + i
+ 2
8670 + (char_matches
? 0 : SCHARS (desc
) + 3))
8674 ptrdiff_t thiswidth
;
8676 /* Punctuate between strings. */
8679 strcpy (menu
+ i
, ", ");
8685 /* If the char to type doesn't match the string's
8686 first char, explicitly show what char to type. */
8689 /* Add as much of string as fits. */
8690 thiswidth
= min (SCHARS (desc
), width
- i
);
8691 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8693 strcpy (menu
+ i
, " = ");
8697 /* Add as much of string as fits. */
8698 thiswidth
= min (SCHARS (s
), width
- i
);
8699 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8705 /* If this element does not fit, end the line now,
8706 and save the element for the next line. */
8707 strcpy (menu
+ i
, "...");
8712 /* Move past this element. */
8713 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8714 /* Handle reaching end of dense table. */
8719 rest
= Fcdr_safe (rest
);
8723 /* Prompt with that and read response. */
8724 message2_nolog (menu
, strlen (menu
),
8725 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8727 /* Make believe its not a keyboard macro in case the help char
8728 is pressed. Help characters are not recorded because menu prompting
8729 is not used on replay.
8731 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8732 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8734 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8735 while (BUFFERP (obj
));
8736 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8738 if (!INTEGERP (obj
))
8740 else if (XINT (obj
) == -2)
8743 if (! EQ (obj
, menu_prompt_more_char
)
8744 && (!INTEGERP (menu_prompt_more_char
)
8745 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8747 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8748 store_kbd_macro_char (obj
);
8751 /* Help char - go round again */
8755 /* Reading key sequences. */
8757 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8758 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8759 keymap, or nil otherwise. Return the index of the first keymap in
8760 which KEY has any binding, or NMAPS if no map has a binding.
8762 If KEY is a meta ASCII character, treat it like meta-prefix-char
8763 followed by the corresponding non-meta character. Keymaps in
8764 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8767 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8770 NEXT may be the same array as CURRENT. */
8773 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8774 Lisp_Object
*defs
, Lisp_Object
*next
)
8776 ptrdiff_t i
, first_binding
;
8778 first_binding
= nmaps
;
8779 for (i
= nmaps
- 1; i
>= 0; i
--)
8781 if (! NILP (current
[i
]))
8783 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8784 if (! NILP (defs
[i
]))
8791 /* Given the set of bindings we've found, produce the next set of maps. */
8792 if (first_binding
< nmaps
)
8793 for (i
= 0; i
< nmaps
; i
++)
8794 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8796 return first_binding
;
8799 /* Structure used to keep track of partial application of key remapping
8800 such as Vfunction_key_map and Vkey_translation_map. */
8801 typedef struct keyremap
8803 /* This is the map originally specified for this use. */
8805 /* This is a submap reached by looking up, in PARENT,
8806 the events from START to END. */
8808 /* Positions [START, END) in the key sequence buffer
8809 are the key that we have scanned so far.
8810 Those events are the ones that we will replace
8811 if PARENT maps them into a key sequence. */
8815 /* Lookup KEY in MAP.
8816 MAP is a keymap mapping keys to key vectors or functions.
8817 If the mapping is a function and DO_FUNCTION is non-zero, then
8818 the function is called with PROMPT as parameter and its return
8819 value is used as the return value of this function (after checking
8820 that it is indeed a vector). */
8823 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8828 next
= access_keymap (map
, key
, 1, 0, 1);
8830 /* Handle symbol with autoload definition. */
8831 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8832 && CONSP (XSYMBOL (next
)->function
)
8833 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8834 do_autoload (XSYMBOL (next
)->function
, next
);
8836 /* Handle a symbol whose function definition is a keymap
8838 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8839 && (ARRAYP (XSYMBOL (next
)->function
)
8840 || KEYMAPP (XSYMBOL (next
)->function
)))
8841 next
= XSYMBOL (next
)->function
;
8843 /* If the keymap gives a function, not an
8844 array, then call the function with one arg and use
8845 its value instead. */
8846 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8851 next
= call1 (next
, prompt
);
8852 /* If the function returned something invalid,
8853 barf--don't ignore it.
8854 (To ignore it safely, we would need to gcpro a bunch of
8855 other variables.) */
8856 if (! (VECTORP (next
) || STRINGP (next
)))
8857 error ("Function %s returns invalid key sequence",
8858 SSDATA (SYMBOL_NAME (tem
)));
8863 /* Do one step of the key remapping used for function-key-map and
8864 key-translation-map:
8865 KEYBUF is the buffer holding the input events.
8866 BUFSIZE is its maximum size.
8867 FKEY is a pointer to the keyremap structure to use.
8868 INPUT is the index of the last element in KEYBUF.
8869 DOIT if non-zero says that the remapping can actually take place.
8870 DIFF is used to return the number of keys added/removed by the remapping.
8871 PARENT is the root of the keymap.
8872 PROMPT is the prompt to use if the remapping happens through a function.
8873 The return value is non-zero if the remapping actually took place. */
8876 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8877 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8879 Lisp_Object next
, key
;
8881 key
= keybuf
[fkey
->end
++];
8883 if (KEYMAPP (fkey
->parent
))
8884 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8888 /* If keybuf[fkey->start..fkey->end] is bound in the
8889 map and we're in a position to do the key remapping, replace it with
8890 the binding and restart with fkey->start at the end. */
8891 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8893 int len
= XFASTINT (Flength (next
));
8896 *diff
= len
- (fkey
->end
- fkey
->start
);
8898 if (bufsize
- input
<= *diff
)
8899 error ("Key sequence too long");
8901 /* Shift the keys that follow fkey->end. */
8903 for (i
= fkey
->end
; i
< input
; i
++)
8904 keybuf
[i
+ *diff
] = keybuf
[i
];
8906 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8907 keybuf
[i
+ *diff
] = keybuf
[i
];
8908 /* Overwrite the old keys with the new ones. */
8909 for (i
= 0; i
< len
; i
++)
8910 keybuf
[fkey
->start
+ i
]
8911 = Faref (next
, make_number (i
));
8913 fkey
->start
= fkey
->end
+= *diff
;
8914 fkey
->map
= fkey
->parent
;
8919 fkey
->map
= get_keymap (next
, 0, 1);
8921 /* If we no longer have a bound suffix, try a new position for
8923 if (!CONSP (fkey
->map
))
8925 fkey
->end
= ++fkey
->start
;
8926 fkey
->map
= fkey
->parent
;
8932 test_undefined (Lisp_Object binding
)
8934 return (EQ (binding
, Qundefined
)
8935 || (!NILP (binding
) && SYMBOLP (binding
)
8936 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8939 /* Read a sequence of keys that ends with a non prefix character,
8940 storing it in KEYBUF, a buffer of size BUFSIZE.
8942 Return the length of the key sequence stored.
8943 Return -1 if the user rejected a command menu.
8945 Echo starting immediately unless `prompt' is 0.
8947 Where a key sequence ends depends on the currently active keymaps.
8948 These include any minor mode keymaps active in the current buffer,
8949 the current buffer's local map, and the global map.
8951 If a key sequence has no other bindings, we check Vfunction_key_map
8952 to see if some trailing subsequence might be the beginning of a
8953 function key's sequence. If so, we try to read the whole function
8954 key, and substitute its symbolic name into the key sequence.
8956 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8957 `double-' events into similar click events, if that would make them
8958 bound. We try to turn `triple-' events first into `double-' events,
8961 If we get a mouse click in a mode line, vertical divider, or other
8962 non-text area, we treat the click as if it were prefixed by the
8963 symbol denoting that area - `mode-line', `vertical-line', or
8966 If the sequence starts with a mouse click, we read the key sequence
8967 with respect to the buffer clicked on, not the current buffer.
8969 If the user switches frames in the midst of a key sequence, we put
8970 off the switch-frame event until later; the next call to
8971 read_char will return it.
8973 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8974 from the selected window's buffer. */
8977 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8978 int dont_downcase_last
, int can_return_switch_frame
,
8979 int fix_current_buffer
)
8981 Lisp_Object from_string
;
8982 int count
= SPECPDL_INDEX ();
8984 /* How many keys there are in the current key sequence. */
8987 /* The length of the echo buffer when we started reading, and
8988 the length of this_command_keys when we started reading. */
8989 int echo_start
IF_LINT (= 0);
8992 /* The number of keymaps we're scanning right now, and the number of
8993 keymaps we have allocated space for. */
8995 ptrdiff_t nmaps_allocated
= 0;
8997 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8998 the current keymaps. */
8999 Lisp_Object
*defs
= NULL
;
9001 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9002 in the current keymaps, or nil where it is not a prefix. */
9003 Lisp_Object
*submaps
= NULL
;
9005 /* The local map to start out with at start of key sequence. */
9006 Lisp_Object orig_local_map
;
9008 /* The map from the `keymap' property to start out with at start of
9010 Lisp_Object orig_keymap
;
9012 /* 1 if we have already considered switching to the local-map property
9013 of the place where a mouse click occurred. */
9014 int localized_local_map
= 0;
9016 /* The index in submaps[] of the first keymap that has a binding for
9017 this key sequence. In other words, the lowest i such that
9018 submaps[i] is non-nil. */
9019 ptrdiff_t first_binding
;
9020 /* Index of the first key that has no binding.
9021 It is useless to try fkey.start larger than that. */
9024 /* If t < mock_input, then KEYBUF[t] should be read as the next
9027 We use this to recover after recognizing a function key. Once we
9028 realize that a suffix of the current key sequence is actually a
9029 function key's escape sequence, we replace the suffix with the
9030 function key's binding from Vfunction_key_map. Now keybuf
9031 contains a new and different key sequence, so the echo area,
9032 this_command_keys, and the submaps and defs arrays are wrong. In
9033 this situation, we set mock_input to t, set t to 0, and jump to
9034 restart_sequence; the loop will read keys from keybuf up until
9035 mock_input, thus rebuilding the state; and then it will resume
9036 reading characters from the keyboard. */
9039 /* If the sequence is unbound in submaps[], then
9040 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9041 and fkey.map is its binding.
9043 These might be > t, indicating that all function key scanning
9044 should hold off until t reaches them. We do this when we've just
9045 recognized a function key, to avoid searching for the function
9046 key's again in Vfunction_key_map. */
9049 /* Likewise, for key_translation_map and input-decode-map. */
9050 keyremap keytran
, indec
;
9052 /* Non-zero if we are trying to map a key by changing an upper-case
9053 letter to lower case, or a shifted function key to an unshifted
9055 int shift_translated
= 0;
9057 /* If we receive a `switch-frame' or `select-window' event in the middle of
9058 a key sequence, we put it off for later.
9059 While we're reading, we keep the event here. */
9060 Lisp_Object delayed_switch_frame
;
9062 /* See the comment below... */
9063 #if defined (GOBBLE_FIRST_EVENT)
9064 Lisp_Object first_event
;
9067 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9068 int original_uppercase_position
= -1;
9070 /* Gets around Microsoft compiler limitations. */
9073 struct buffer
*starting_buffer
;
9075 /* List of events for which a fake prefix key has been generated. */
9076 Lisp_Object fake_prefixed_keys
= Qnil
;
9078 #if defined (GOBBLE_FIRST_EVENT)
9082 struct gcpro gcpro1
;
9084 GCPRO1 (fake_prefixed_keys
);
9085 raw_keybuf_count
= 0;
9087 last_nonmenu_event
= Qnil
;
9089 delayed_switch_frame
= Qnil
;
9095 /* Install the string STR as the beginning of the string of
9096 echoing, so that it serves as a prompt for the next
9098 KVAR (current_kboard
, echo_string
) = prompt
;
9099 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9102 else if (cursor_in_echo_area
9103 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9104 && NILP (Fzerop (Vecho_keystrokes
)))
9105 /* This doesn't put in a dash if the echo buffer is empty, so
9106 you don't always see a dash hanging out in the minibuffer. */
9110 /* Record the initial state of the echo area and this_command_keys;
9111 we will need to restore them if we replay a key sequence. */
9113 echo_start
= echo_length ();
9114 keys_start
= this_command_key_count
;
9115 this_single_command_key_start
= keys_start
;
9117 #if defined (GOBBLE_FIRST_EVENT)
9118 /* This doesn't quite work, because some of the things that read_char
9119 does cannot safely be bypassed. It seems too risky to try to make
9122 /* Read the first char of the sequence specially, before setting
9123 up any keymaps, in case a filter runs and switches buffers on us. */
9124 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9126 #endif /* GOBBLE_FIRST_EVENT */
9128 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9129 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9132 /* We jump here when we need to reinitialize fkey and keytran; this
9133 happens if we switch keyboards between rescans. */
9134 replay_entire_sequence
:
9136 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9137 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9138 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9139 indec
.start
= indec
.end
= 0;
9140 fkey
.start
= fkey
.end
= 0;
9141 keytran
.start
= keytran
.end
= 0;
9143 /* We jump here when the key sequence has been thoroughly changed, and
9144 we need to rescan it starting from the beginning. When we jump here,
9145 keybuf[0..mock_input] holds the sequence we should reread. */
9148 starting_buffer
= current_buffer
;
9149 first_unbound
= bufsize
+ 1;
9151 /* Build our list of keymaps.
9152 If we recognize a function key and replace its escape sequence in
9153 keybuf with its symbol, or if the sequence starts with a mouse
9154 click and we need to switch buffers, we jump back here to rebuild
9155 the initial keymaps from the current buffer. */
9158 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9160 if (2 > nmaps_allocated
)
9162 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9163 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9164 nmaps_allocated
= 2;
9166 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9168 else if (!NILP (Voverriding_local_map
))
9170 if (2 > nmaps_allocated
)
9172 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9173 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9174 nmaps_allocated
= 2;
9176 submaps
[nmaps
++] = Voverriding_local_map
;
9184 nminor
= current_minor_maps (0, &maps
);
9185 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9187 if (total
> nmaps_allocated
)
9189 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9190 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9191 nmaps_allocated
= total
;
9194 if (!NILP (orig_keymap
))
9195 submaps
[nmaps
++] = orig_keymap
;
9197 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9201 submaps
[nmaps
++] = orig_local_map
;
9203 submaps
[nmaps
++] = current_global_map
;
9205 /* Find an accurate initial value for first_binding. */
9206 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9207 if (! NILP (submaps
[first_binding
]))
9210 /* Start from the beginning in keybuf. */
9213 /* These are no-ops the first time through, but if we restart, they
9214 revert the echo area and this_command_keys to their original state. */
9215 this_command_key_count
= keys_start
;
9216 if (INTERACTIVE
&& t
< mock_input
)
9217 echo_truncate (echo_start
);
9219 /* If the best binding for the current key sequence is a keymap, or
9220 we may be looking at a function key's escape sequence, keep on
9222 while (first_binding
< nmaps
9223 /* Keep reading as long as there's a prefix binding. */
9224 ? !NILP (submaps
[first_binding
])
9225 /* Don't return in the middle of a possible function key sequence,
9226 if the only bindings we found were via case conversion.
9227 Thus, if ESC O a has a function-key-map translation
9228 and ESC o has a binding, don't return after ESC O,
9229 so that we can translate ESC O plus the next character. */
9230 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9233 int used_mouse_menu
= 0;
9235 /* Where the last real key started. If we need to throw away a
9236 key that has expanded into more than one element of keybuf
9237 (say, a mouse click on the mode line which is being treated
9238 as [mode-line (mouse-...)], then we backtrack to this point
9240 int last_real_key_start
;
9242 /* These variables are analogous to echo_start and keys_start;
9243 while those allow us to restart the entire key sequence,
9244 echo_local_start and keys_local_start allow us to throw away
9246 int echo_local_start
IF_LINT (= 0);
9247 int keys_local_start
;
9248 ptrdiff_t local_first_binding
;
9250 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9251 eassert (indec
.start
<= indec
.end
);
9252 eassert (fkey
.start
<= fkey
.end
);
9253 eassert (keytran
.start
<= keytran
.end
);
9254 /* key-translation-map is applied *after* function-key-map
9255 which is itself applied *after* input-decode-map. */
9256 eassert (fkey
.end
<= indec
.start
);
9257 eassert (keytran
.end
<= fkey
.start
);
9259 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9260 first_unbound
< keytran
.start
)
9261 { /* The prefix upto first_unbound has no binding and has
9262 no translation left to do either, so we know it's unbound.
9263 If we don't stop now, we risk staying here indefinitely
9264 (if the user keeps entering fkey or keytran prefixes
9265 like C-c ESC ESC ESC ESC ...) */
9267 for (i
= first_unbound
+ 1; i
< t
; i
++)
9268 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9269 mock_input
= t
- first_unbound
- 1;
9270 indec
.end
= indec
.start
-= first_unbound
+ 1;
9271 indec
.map
= indec
.parent
;
9272 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9273 fkey
.map
= fkey
.parent
;
9274 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9275 keytran
.map
= keytran
.parent
;
9276 goto replay_sequence
;
9280 error ("Key sequence too long");
9283 echo_local_start
= echo_length ();
9284 keys_local_start
= this_command_key_count
;
9285 local_first_binding
= first_binding
;
9288 /* These are no-ops, unless we throw away a keystroke below and
9289 jumped back up to replay_key; in that case, these restore the
9290 variables to their original state, allowing us to replay the
9292 if (INTERACTIVE
&& t
< mock_input
)
9293 echo_truncate (echo_local_start
);
9294 this_command_key_count
= keys_local_start
;
9295 first_binding
= local_first_binding
;
9297 /* By default, assume each event is "real". */
9298 last_real_key_start
= t
;
9300 /* Does mock_input indicate that we are re-reading a key sequence? */
9304 add_command_key (key
);
9305 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9306 && NILP (Fzerop (Vecho_keystrokes
)))
9310 /* If not, we should actually read a character. */
9314 KBOARD
*interrupted_kboard
= current_kboard
;
9315 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9316 key
= read_char (NILP (prompt
), nmaps
,
9317 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9318 &used_mouse_menu
, NULL
);
9319 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9320 /* When switching to a new tty (with a new keyboard),
9321 read_char returns the new buffer, rather than -2
9322 (Bug#5095). This is because `terminal-init-xterm'
9323 calls read-char, which eats the wrong_kboard_jmpbuf
9324 return. Any better way to fix this? -- cyd */
9325 || (interrupted_kboard
!= current_kboard
))
9330 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9331 if (k
== interrupted_kboard
)
9336 /* Don't touch interrupted_kboard when it's been
9338 delayed_switch_frame
= Qnil
;
9339 goto replay_entire_sequence
;
9342 if (!NILP (delayed_switch_frame
))
9344 KVAR (interrupted_kboard
, kbd_queue
)
9345 = Fcons (delayed_switch_frame
,
9346 KVAR (interrupted_kboard
, kbd_queue
));
9347 delayed_switch_frame
= Qnil
;
9351 KVAR (interrupted_kboard
, kbd_queue
)
9352 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9354 /* If the side queue is non-empty, ensure it begins with a
9355 switch-frame, so we'll replay it in the right context. */
9356 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9357 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9358 !(EVENT_HAS_PARAMETERS (key
)
9359 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9363 XSETFRAME (frame
, interrupted_frame
);
9364 KVAR (interrupted_kboard
, kbd_queue
)
9365 = Fcons (make_lispy_switch_frame (frame
),
9366 KVAR (interrupted_kboard
, kbd_queue
));
9369 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9370 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9371 goto replay_entire_sequence
;
9375 /* read_char returns t when it shows a menu and the user rejects it.
9379 unbind_to (count
, Qnil
);
9384 /* read_char returns -1 at the end of a macro.
9385 Emacs 18 handles this by returning immediately with a
9386 zero, so that's what we'll do. */
9387 if (INTEGERP (key
) && XINT (key
) == -1)
9390 /* The Microsoft C compiler can't handle the goto that
9396 /* If the current buffer has been changed from under us, the
9397 keymap may have changed, so replay the sequence. */
9400 timer_resume_idle ();
9403 /* Reset the current buffer from the selected window
9404 in case something changed the former and not the latter.
9405 This is to be more consistent with the behavior
9406 of the command_loop_1. */
9407 if (fix_current_buffer
)
9409 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9411 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9412 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9415 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9416 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9417 goto replay_sequence
;
9420 /* If we have a quit that was typed in another frame, and
9421 quit_throw_to_read_char switched buffers,
9422 replay to get the right keymap. */
9424 && XINT (key
) == quit_char
9425 && current_buffer
!= starting_buffer
)
9428 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9432 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9433 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9434 goto replay_sequence
;
9439 if (EVENT_HAS_PARAMETERS (key
)
9440 /* Either a `switch-frame' or a `select-window' event. */
9441 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9443 /* If we're at the beginning of a key sequence, and the caller
9444 says it's okay, go ahead and return this event. If we're
9445 in the midst of a key sequence, delay it until the end. */
9446 if (t
> 0 || !can_return_switch_frame
)
9448 delayed_switch_frame
= key
;
9454 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9458 /* Clicks in non-text areas get prefixed by the symbol
9459 in their CHAR-ADDRESS field. For example, a click on
9460 the mode line is prefixed by the symbol `mode-line'.
9462 Furthermore, key sequences beginning with mouse clicks
9463 are read using the keymaps of the buffer clicked on, not
9464 the current buffer. So we may have to switch the buffer
9467 When we turn one event into two events, we must make sure
9468 that neither of the two looks like the original--so that,
9469 if we replay the events, they won't be expanded again.
9470 If not for this, such reexpansion could happen either here
9471 or when user programs play with this-command-keys. */
9472 if (EVENT_HAS_PARAMETERS (key
))
9477 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9478 if (EQ (kind
, Qmouse_click
))
9480 Lisp_Object window
, posn
;
9482 window
= POSN_WINDOW (EVENT_START (key
));
9483 posn
= POSN_POSN (EVENT_START (key
));
9486 || (!NILP (fake_prefixed_keys
)
9487 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9489 /* We're looking a second time at an event for which
9490 we generated a fake prefix key. Set
9491 last_real_key_start appropriately. */
9493 last_real_key_start
= t
- 1;
9496 if (last_real_key_start
== 0)
9498 /* Key sequences beginning with mouse clicks are
9499 read using the keymaps in the buffer clicked on,
9500 not the current buffer. If we're at the
9501 beginning of a key sequence, switch buffers. */
9502 if (WINDOWP (window
)
9503 && BUFFERP (XWINDOW (window
)->buffer
)
9504 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9506 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9510 /* Arrange to go back to the original buffer once we're
9511 done reading the key sequence. Note that we can't
9512 use save_excursion_{save,restore} here, because they
9513 save point as well as the current buffer; we don't
9514 want to save point, because redisplay may change it,
9515 to accommodate a Fset_window_start or something. We
9516 don't want to do this at the top of the function,
9517 because we may get input from a subprocess which
9518 wants to change the selected window and stuff (say,
9520 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9522 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9524 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9525 orig_local_map
= get_local_map (PT
, current_buffer
,
9527 orig_keymap
= get_local_map (PT
, current_buffer
,
9529 goto replay_sequence
;
9532 /* For a mouse click, get the local text-property keymap
9533 of the place clicked on, rather than point. */
9534 if (CONSP (XCDR (key
))
9535 && ! localized_local_map
)
9537 Lisp_Object map_here
, start
, pos
;
9539 localized_local_map
= 1;
9540 start
= EVENT_START (key
);
9542 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9544 pos
= POSN_BUFFER_POSN (start
);
9546 && XINT (pos
) >= BEGV
9547 && XINT (pos
) <= ZV
)
9549 map_here
= get_local_map (XINT (pos
),
9552 if (!EQ (map_here
, orig_local_map
))
9554 orig_local_map
= map_here
;
9555 ++localized_local_map
;
9558 map_here
= get_local_map (XINT (pos
),
9561 if (!EQ (map_here
, orig_keymap
))
9563 orig_keymap
= map_here
;
9564 ++localized_local_map
;
9567 if (localized_local_map
> 1)
9572 goto replay_sequence
;
9579 /* Expand mode-line and scroll-bar events into two events:
9580 use posn as a fake prefix key. */
9582 && (NILP (fake_prefixed_keys
)
9583 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9585 if (bufsize
- t
<= 1)
9586 error ("Key sequence too long");
9589 keybuf
[t
+ 1] = key
;
9592 /* Record that a fake prefix key has been generated
9593 for KEY. Don't modify the event; this would
9594 prevent proper action when the event is pushed
9595 back into unread-command-events. */
9596 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9598 /* If on a mode line string with a local keymap,
9599 reconsider the key sequence with that keymap. */
9600 if (string
= POSN_STRING (EVENT_START (key
)),
9601 (CONSP (string
) && STRINGP (XCAR (string
))))
9603 Lisp_Object pos
, map
, map2
;
9605 pos
= XCDR (string
);
9606 string
= XCAR (string
);
9608 && XINT (pos
) < SCHARS (string
))
9610 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9612 orig_local_map
= map
;
9613 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9616 if (!NILP (map
) || !NILP (map2
))
9617 goto replay_sequence
;
9623 else if (NILP (from_string
)
9624 && (string
= POSN_STRING (EVENT_START (key
)),
9625 (CONSP (string
) && STRINGP (XCAR (string
)))))
9627 /* For a click on a string, i.e. overlay string or a
9628 string displayed via the `display' property,
9629 consider `local-map' and `keymap' properties of
9631 Lisp_Object pos
, map
, map2
;
9633 pos
= XCDR (string
);
9634 string
= XCAR (string
);
9636 && XINT (pos
) < SCHARS (string
))
9638 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9640 orig_local_map
= map
;
9641 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9645 if (!NILP (map
) || !NILP (map2
))
9647 from_string
= string
;
9650 goto replay_sequence
;
9655 else if (CONSP (XCDR (key
))
9656 && CONSP (EVENT_START (key
))
9657 && CONSP (XCDR (EVENT_START (key
))))
9661 posn
= POSN_POSN (EVENT_START (key
));
9662 /* Handle menu-bar events:
9663 insert the dummy prefix event `menu-bar'. */
9664 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9666 if (bufsize
- t
<= 1)
9667 error ("Key sequence too long");
9671 /* Zap the position in key, so we know that we've
9672 expanded it, and don't try to do so again. */
9673 POSN_SET_POSN (EVENT_START (key
),
9674 Fcons (posn
, Qnil
));
9677 goto replay_sequence
;
9679 else if (CONSP (posn
))
9681 /* We're looking at the second event of a
9682 sequence which we expanded before. Set
9683 last_real_key_start appropriately. */
9684 if (last_real_key_start
== t
&& t
> 0)
9685 last_real_key_start
= t
- 1;
9690 /* We have finally decided that KEY is something we might want
9692 first_binding
= (follow_key (key
,
9693 nmaps
- first_binding
,
9694 submaps
+ first_binding
,
9695 defs
+ first_binding
,
9696 submaps
+ first_binding
)
9699 /* If KEY wasn't bound, we'll try some fallbacks. */
9700 if (first_binding
< nmaps
)
9701 /* This is needed for the following scenario:
9702 event 0: a down-event that gets dropped by calling replay_key.
9703 event 1: some normal prefix like C-h.
9704 After event 0, first_unbound is 0, after event 1 indec.start,
9705 fkey.start, and keytran.start are all 1, so when we see that
9706 C-h is bound, we need to update first_unbound. */
9707 first_unbound
= max (t
+ 1, first_unbound
);
9712 /* Remember the position to put an upper bound on indec.start. */
9713 first_unbound
= min (t
, first_unbound
);
9715 head
= EVENT_HEAD (key
);
9716 if (help_char_p (head
) && t
> 0)
9718 read_key_sequence_cmd
= Vprefix_help_command
;
9720 last_nonmenu_event
= key
;
9721 /* The Microsoft C compiler can't handle the goto that
9729 Lisp_Object breakdown
;
9732 breakdown
= parse_modifiers (head
);
9733 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9734 /* Attempt to reduce an unbound mouse event to a simpler
9735 event that is bound:
9736 Drags reduce to clicks.
9737 Double-clicks reduce to clicks.
9738 Triple-clicks reduce to double-clicks, then to clicks.
9739 Down-clicks are eliminated.
9740 Double-downs reduce to downs, then are eliminated.
9741 Triple-downs reduce to double-downs, then to downs,
9742 then are eliminated. */
9743 if (modifiers
& (down_modifier
| drag_modifier
9744 | double_modifier
| triple_modifier
))
9746 while (modifiers
& (down_modifier
| drag_modifier
9747 | double_modifier
| triple_modifier
))
9749 Lisp_Object new_head
, new_click
;
9750 if (modifiers
& triple_modifier
)
9751 modifiers
^= (double_modifier
| triple_modifier
);
9752 else if (modifiers
& double_modifier
)
9753 modifiers
&= ~double_modifier
;
9754 else if (modifiers
& drag_modifier
)
9755 modifiers
&= ~drag_modifier
;
9758 /* Dispose of this `down' event by simply jumping
9759 back to replay_key, to get another event.
9761 Note that if this event came from mock input,
9762 then just jumping back to replay_key will just
9763 hand it to us again. So we have to wipe out any
9766 We could delete keybuf[t] and shift everything
9767 after that to the left by one spot, but we'd also
9768 have to fix up any variable that points into
9769 keybuf, and shifting isn't really necessary
9772 Adding prefixes for non-textual mouse clicks
9773 creates two characters of mock input, and both
9774 must be thrown away. If we're only looking at
9775 the prefix now, we can just jump back to
9776 replay_key. On the other hand, if we've already
9777 processed the prefix, and now the actual click
9778 itself is giving us trouble, then we've lost the
9779 state of the keymaps we want to backtrack to, and
9780 we need to replay the whole sequence to rebuild
9783 Beyond that, only function key expansion could
9784 create more than two keys, but that should never
9785 generate mouse events, so it's okay to zero
9786 mock_input in that case too.
9788 FIXME: The above paragraph seems just plain
9789 wrong, if you consider things like
9790 xterm-mouse-mode. -stef
9792 Isn't this just the most wonderful code ever? */
9794 /* If mock_input > t + 1, the above simplification
9795 will actually end up dropping keys on the floor.
9796 This is probably OK for now, but even
9797 if mock_input <= t + 1, we need to adjust indec,
9799 Typical case [header-line down-mouse-N]:
9800 mock_input = 2, t = 1, fkey.end = 1,
9801 last_real_key_start = 0. */
9802 if (indec
.end
> last_real_key_start
)
9804 indec
.end
= indec
.start
9805 = min (last_real_key_start
, indec
.start
);
9806 indec
.map
= indec
.parent
;
9807 if (fkey
.end
> last_real_key_start
)
9809 fkey
.end
= fkey
.start
9810 = min (last_real_key_start
, fkey
.start
);
9811 fkey
.map
= fkey
.parent
;
9812 if (keytran
.end
> last_real_key_start
)
9814 keytran
.end
= keytran
.start
9815 = min (last_real_key_start
, keytran
.start
);
9816 keytran
.map
= keytran
.parent
;
9820 if (t
== last_real_key_start
)
9827 mock_input
= last_real_key_start
;
9828 goto replay_sequence
;
9833 = apply_modifiers (modifiers
, XCAR (breakdown
));
9835 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9837 /* Look for a binding for this new key. follow_key
9838 promises that it didn't munge submaps the
9839 last time we called it, since key was unbound. */
9841 = (follow_key (new_click
,
9842 nmaps
- local_first_binding
,
9843 submaps
+ local_first_binding
,
9844 defs
+ local_first_binding
,
9845 submaps
+ local_first_binding
)
9846 + local_first_binding
);
9848 /* If that click is bound, go for it. */
9849 if (first_binding
< nmaps
)
9854 /* Otherwise, we'll leave key set to the drag event. */
9861 /* Normally, last_nonmenu_event gets the previous key we read.
9862 But when a mouse popup menu is being used,
9863 we don't update last_nonmenu_event; it continues to hold the mouse
9864 event that preceded the first level of menu. */
9865 if (!used_mouse_menu
)
9866 last_nonmenu_event
= key
;
9868 /* Record what part of this_command_keys is the current key sequence. */
9869 this_single_command_key_start
= this_command_key_count
- t
;
9871 /* Look for this sequence in input-decode-map.
9872 Scan from indec.end until we find a bound suffix. */
9873 while (indec
.end
< t
)
9875 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9878 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9879 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9884 mock_input
= diff
+ max (t
, mock_input
);
9885 goto replay_sequence
;
9889 if (first_binding
< nmaps
9890 && NILP (submaps
[first_binding
])
9891 && !test_undefined (defs
[first_binding
])
9892 && indec
.start
>= t
)
9893 /* There is a binding and it's not a prefix.
9894 (and it doesn't have any input-decode-map translation pending).
9895 There is thus no function-key in this sequence.
9896 Moving fkey.start is important in this case to allow keytran.start
9897 to go over the sequence before we return (since we keep the
9898 invariant that keytran.end <= fkey.start). */
9901 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9904 /* If the sequence is unbound, see if we can hang a function key
9905 off the end of it. */
9906 /* Continue scan from fkey.end until we find a bound suffix. */
9907 while (fkey
.end
< indec
.start
)
9909 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9912 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9913 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9914 max (t
, mock_input
),
9915 /* If there's a binding (i.e.
9916 first_binding >= nmaps) we don't want
9917 to apply this function-key-mapping. */
9919 && (first_binding
>= nmaps
9920 || test_undefined (defs
[first_binding
])),
9925 mock_input
= diff
+ max (t
, mock_input
);
9926 /* Adjust the input-decode-map counters. */
9928 indec
.start
+= diff
;
9930 goto replay_sequence
;
9934 /* Look for this sequence in key-translation-map.
9935 Scan from keytran.end until we find a bound suffix. */
9936 while (keytran
.end
< fkey
.start
)
9938 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9941 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9942 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9947 mock_input
= diff
+ max (t
, mock_input
);
9948 /* Adjust the function-key-map and input-decode-map counters. */
9950 indec
.start
+= diff
;
9954 goto replay_sequence
;
9958 /* If KEY is not defined in any of the keymaps,
9959 and cannot be part of a function key or translation,
9960 and is an upper case letter
9961 use the corresponding lower-case letter instead. */
9962 if (first_binding
>= nmaps
9963 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9965 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9966 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9967 || (XINT (key
) & shift_modifier
)))
9969 Lisp_Object new_key
;
9971 original_uppercase
= key
;
9972 original_uppercase_position
= t
- 1;
9974 if (XINT (key
) & shift_modifier
)
9975 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9977 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9978 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9980 /* We have to do this unconditionally, regardless of whether
9981 the lower-case char is defined in the keymaps, because they
9982 might get translated through function-key-map. */
9983 keybuf
[t
- 1] = new_key
;
9984 mock_input
= max (t
, mock_input
);
9985 shift_translated
= 1;
9987 goto replay_sequence
;
9989 /* If KEY is not defined in any of the keymaps,
9990 and cannot be part of a function key or translation,
9991 and is a shifted function key,
9992 use the corresponding unshifted function key instead. */
9993 if (first_binding
>= nmaps
9994 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9996 Lisp_Object breakdown
= parse_modifiers (key
);
9998 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10000 if (modifiers
& shift_modifier
10001 /* Treat uppercase keys as shifted. */
10003 && (KEY_TO_CHAR (key
)
10004 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10005 && uppercasep (KEY_TO_CHAR (key
))))
10007 Lisp_Object new_key
10008 = (modifiers
& shift_modifier
10009 ? apply_modifiers (modifiers
& ~shift_modifier
,
10011 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10013 original_uppercase
= key
;
10014 original_uppercase_position
= t
- 1;
10016 /* We have to do this unconditionally, regardless of whether
10017 the lower-case char is defined in the keymaps, because they
10018 might get translated through function-key-map. */
10019 keybuf
[t
- 1] = new_key
;
10020 mock_input
= max (t
, mock_input
);
10021 /* Reset fkey (and consequently keytran) to apply
10022 function-key-map on the result, so that S-backspace is
10023 correctly mapped to DEL (via backspace). OTOH,
10024 input-decode-map doesn't need to go through it again. */
10025 fkey
.start
= fkey
.end
= 0;
10026 keytran
.start
= keytran
.end
= 0;
10027 shift_translated
= 1;
10029 goto replay_sequence
;
10034 read_key_sequence_cmd
= (first_binding
< nmaps
10035 ? defs
[first_binding
]
10037 read_key_sequence_remapped
10038 /* Remap command through active keymaps.
10039 Do the remapping here, before the unbind_to so it uses the keymaps
10040 of the appropriate buffer. */
10041 = SYMBOLP (read_key_sequence_cmd
)
10042 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10045 unread_switch_frame
= delayed_switch_frame
;
10046 unbind_to (count
, Qnil
);
10048 /* Don't downcase the last character if the caller says don't.
10049 Don't downcase it if the result is undefined, either. */
10050 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10052 && t
- 1 == original_uppercase_position
)
10054 keybuf
[t
- 1] = original_uppercase
;
10055 shift_translated
= 0;
10058 if (shift_translated
)
10059 Vthis_command_keys_shift_translated
= Qt
;
10061 /* Occasionally we fabricate events, perhaps by expanding something
10062 according to function-key-map, or by adding a prefix symbol to a
10063 mouse click in the scroll bar or modeline. In this cases, return
10064 the entire generated key sequence, even if we hit an unbound
10065 prefix or a definition before the end. This means that you will
10066 be able to push back the event properly, and also means that
10067 read-key-sequence will always return a logical unit.
10070 for (; t
< mock_input
; t
++)
10072 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10073 && NILP (Fzerop (Vecho_keystrokes
)))
10074 echo_char (keybuf
[t
]);
10075 add_command_key (keybuf
[t
]);
10082 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10083 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10084 The sequence is sufficient to specify a non-prefix command in the
10085 current local and global maps.
10087 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10088 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10089 as a continuation of the previous key.
10091 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10092 convert the last event to lower case. (Normally any upper case event
10093 is converted to lower case if the original event is undefined and the lower
10094 case equivalent is defined.) A non-nil value is appropriate for reading
10095 a key sequence to be defined.
10097 A C-g typed while in this function is treated like any other character,
10098 and `quit-flag' is not set.
10100 If the key sequence starts with a mouse click, then the sequence is read
10101 using the keymaps of the buffer of the window clicked in, not the buffer
10102 of the selected window as normal.
10104 `read-key-sequence' drops unbound button-down events, since you normally
10105 only care about the click or drag events which follow them. If a drag
10106 or multi-click event is unbound, but the corresponding click event would
10107 be bound, `read-key-sequence' turns the event into a click event at the
10108 drag's starting position. This means that you don't have to distinguish
10109 between click and drag, double, or triple events unless you want to.
10111 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10112 lines separating windows, and scroll bars with imaginary keys
10113 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10115 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10116 function will process a switch-frame event if the user switches frames
10117 before typing anything. If the user switches frames in the middle of a
10118 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10119 is nil, then the event will be put off until after the current key sequence.
10121 `read-key-sequence' checks `function-key-map' for function key
10122 sequences, where they wouldn't conflict with ordinary bindings. See
10123 `function-key-map' for more details.
10125 The optional fifth argument CMD-LOOP, if non-nil, means
10126 that this key sequence is being read by something that will
10127 read commands one after another. It should be nil if the caller
10128 will read just one key sequence. */)
10129 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10131 Lisp_Object keybuf
[30];
10133 struct gcpro gcpro1
;
10134 int count
= SPECPDL_INDEX ();
10136 if (!NILP (prompt
))
10137 CHECK_STRING (prompt
);
10140 specbind (Qinput_method_exit_on_first_char
,
10141 (NILP (cmd_loop
) ? Qt
: Qnil
));
10142 specbind (Qinput_method_use_echo_area
,
10143 (NILP (cmd_loop
) ? Qt
: Qnil
));
10145 memset (keybuf
, 0, sizeof keybuf
);
10146 GCPRO1 (keybuf
[0]);
10147 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10149 if (NILP (continue_echo
))
10151 this_command_key_count
= 0;
10152 this_command_key_count_reset
= 0;
10153 this_single_command_key_start
= 0;
10156 #ifdef HAVE_WINDOW_SYSTEM
10157 if (display_hourglass_p
)
10158 cancel_hourglass ();
10161 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10162 prompt
, ! NILP (dont_downcase_last
),
10163 ! NILP (can_return_switch_frame
), 0);
10165 #if 0 /* The following is fine for code reading a key sequence and
10166 then proceeding with a lengthy computation, but it's not good
10167 for code reading keys in a loop, like an input method. */
10168 #ifdef HAVE_WINDOW_SYSTEM
10169 if (display_hourglass_p
)
10170 start_hourglass ();
10180 return unbind_to (count
, make_event_array (i
, keybuf
));
10183 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10184 Sread_key_sequence_vector
, 1, 5, 0,
10185 doc
: /* Like `read-key-sequence' but always return a vector. */)
10186 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10188 Lisp_Object keybuf
[30];
10190 struct gcpro gcpro1
;
10191 int count
= SPECPDL_INDEX ();
10193 if (!NILP (prompt
))
10194 CHECK_STRING (prompt
);
10197 specbind (Qinput_method_exit_on_first_char
,
10198 (NILP (cmd_loop
) ? Qt
: Qnil
));
10199 specbind (Qinput_method_use_echo_area
,
10200 (NILP (cmd_loop
) ? Qt
: Qnil
));
10202 memset (keybuf
, 0, sizeof keybuf
);
10203 GCPRO1 (keybuf
[0]);
10204 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10206 if (NILP (continue_echo
))
10208 this_command_key_count
= 0;
10209 this_command_key_count_reset
= 0;
10210 this_single_command_key_start
= 0;
10213 #ifdef HAVE_WINDOW_SYSTEM
10214 if (display_hourglass_p
)
10215 cancel_hourglass ();
10218 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10219 prompt
, ! NILP (dont_downcase_last
),
10220 ! NILP (can_return_switch_frame
), 0);
10222 #ifdef HAVE_WINDOW_SYSTEM
10223 if (display_hourglass_p
)
10224 start_hourglass ();
10233 return unbind_to (count
, Fvector (i
, keybuf
));
10236 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10237 doc
: /* Execute CMD as an editor command.
10238 CMD must be a symbol that satisfies the `commandp' predicate.
10239 Optional second arg RECORD-FLAG non-nil
10240 means unconditionally put this command in `command-history'.
10241 Otherwise, that is done only if an arg is read using the minibuffer.
10242 The argument KEYS specifies the value to use instead of (this-command-keys)
10243 when reading the arguments; if it is nil, (this-command-keys) is used.
10244 The argument SPECIAL, if non-nil, means that this command is executing
10245 a special event, so ignore the prefix argument and don't clear it. */)
10246 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10248 register Lisp_Object final
;
10249 register Lisp_Object tem
;
10250 Lisp_Object prefixarg
;
10252 debug_on_next_call
= 0;
10254 if (NILP (special
))
10256 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10257 Vcurrent_prefix_arg
= prefixarg
;
10258 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10265 tem
= Fget (cmd
, Qdisabled
);
10268 tem
= Fsymbol_value (Qdisabled_command_function
);
10270 return Frun_hooks (1, &Qdisabled_command_function
);
10276 final
= Findirect_function (cmd
, Qnil
);
10278 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10280 struct gcpro gcpro1
, gcpro2
;
10282 GCPRO2 (cmd
, prefixarg
);
10283 do_autoload (final
, cmd
);
10290 if (STRINGP (final
) || VECTORP (final
))
10292 /* If requested, place the macro in the command history. For
10293 other sorts of commands, call-interactively takes care of
10295 if (!NILP (record_flag
))
10298 = Fcons (Fcons (Qexecute_kbd_macro
,
10299 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10302 /* Don't keep command history around forever. */
10303 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10305 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10307 XSETCDR (tem
, Qnil
);
10311 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10314 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10315 /* Don't call Fcall_interactively directly because we want to make
10316 sure the backtrace has an entry for `call-interactively'.
10317 For the same reason, pass `cmd' rather than `final'. */
10318 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10325 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10327 doc
: /* Read function name, then read its arguments and call it.
10329 To pass a numeric argument to the command you are invoking with, specify
10330 the numeric argument to this command.
10332 Noninteractively, the argument PREFIXARG is the prefix argument to
10333 give to the command you invoke, if it asks for an argument. */)
10334 (Lisp_Object prefixarg
)
10336 Lisp_Object function
;
10337 EMACS_INT saved_last_point_position
;
10338 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10339 Lisp_Object bindings
, value
;
10340 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10341 #ifdef HAVE_WINDOW_SYSTEM
10342 /* The call to Fcompleting_read will start and cancel the hourglass,
10343 but if the hourglass was already scheduled, this means that no
10344 hourglass will be shown for the actual M-x command itself.
10345 So we restart it if it is already scheduled. Note that checking
10346 hourglass_shown_p is not enough, normally the hourglass is not shown,
10347 just scheduled to be shown. */
10348 int hstarted
= hourglass_started ();
10351 saved_keys
= Fvector (this_command_key_count
,
10352 XVECTOR (this_command_keys
)->contents
);
10353 saved_last_point_position_buffer
= last_point_position_buffer
;
10354 saved_last_point_position
= last_point_position
;
10355 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10357 function
= call0 (intern ("read-extended-command"));
10359 #ifdef HAVE_WINDOW_SYSTEM
10360 if (hstarted
) start_hourglass ();
10363 if (STRINGP (function
) && SCHARS (function
) == 0)
10364 error ("No command name given");
10366 /* Set this_command_keys to the concatenation of saved_keys and
10367 function, followed by a RET. */
10372 this_command_key_count
= 0;
10373 this_command_key_count_reset
= 0;
10374 this_single_command_key_start
= 0;
10376 keys
= XVECTOR (saved_keys
)->contents
;
10377 for (i
= 0; i
< ASIZE (saved_keys
); i
++)
10378 add_command_key (keys
[i
]);
10380 for (i
= 0; i
< SCHARS (function
); i
++)
10381 add_command_key (Faref (function
, make_number (i
)));
10383 add_command_key (make_number ('\015'));
10386 last_point_position
= saved_last_point_position
;
10387 last_point_position_buffer
= saved_last_point_position_buffer
;
10391 function
= Fintern (function
, Qnil
);
10392 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10393 Vthis_command
= function
;
10394 real_this_command
= function
;
10396 /* If enabled, show which key runs this command. */
10397 if (!NILP (Vsuggest_key_bindings
)
10398 && NILP (Vexecuting_kbd_macro
)
10399 && SYMBOLP (function
))
10400 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10406 GCPRO3 (bindings
, value
, function
);
10407 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10409 /* If the command has a key binding, print it now. */
10410 if (!NILP (bindings
)
10411 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10414 /* But first wait, and skip the message if there is input. */
10415 Lisp_Object waited
;
10417 /* If this command displayed something in the echo area;
10418 wait a few seconds, then display our suggestion message. */
10419 if (NILP (echo_area_buffer
[0]))
10420 waited
= sit_for (make_number (0), 0, 2);
10421 else if (NUMBERP (Vsuggest_key_bindings
))
10422 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10424 waited
= sit_for (make_number (2), 0, 2);
10426 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10428 Lisp_Object binding
;
10430 int message_p
= push_message ();
10431 int count
= SPECPDL_INDEX ();
10432 ptrdiff_t newmessage_len
, newmessage_alloc
;
10435 record_unwind_protect (pop_message_unwind
, Qnil
);
10436 binding
= Fkey_description (bindings
, Qnil
);
10438 (sizeof "You can run the command `' with "
10439 + SBYTES (SYMBOL_NAME (function
)) + SBYTES (binding
));
10440 SAFE_ALLOCA (newmessage
, char *, newmessage_alloc
);
10442 esprintf (newmessage
, "You can run the command `%s' with %s",
10443 SDATA (SYMBOL_NAME (function
)),
10445 message2 (newmessage
,
10447 STRING_MULTIBYTE (binding
));
10448 if (NUMBERP (Vsuggest_key_bindings
))
10449 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10451 waited
= sit_for (make_number (2), 0, 2);
10453 if (!NILP (waited
) && message_p
)
10454 restore_message ();
10457 unbind_to (count
, Qnil
);
10461 RETURN_UNGCPRO (value
);
10465 /* Return nonzero if input events are pending. */
10468 detect_input_pending (void)
10470 if (!input_pending
)
10471 get_input_pending (&input_pending
, 0);
10473 return input_pending
;
10476 /* Return nonzero if input events other than mouse movements are
10480 detect_input_pending_ignore_squeezables (void)
10482 if (!input_pending
)
10483 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10485 return input_pending
;
10488 /* Return nonzero if input events are pending, and run any pending timers. */
10491 detect_input_pending_run_timers (int do_display
)
10493 int old_timers_run
= timers_run
;
10495 if (!input_pending
)
10496 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10498 if (old_timers_run
!= timers_run
&& do_display
)
10500 redisplay_preserve_echo_area (8);
10501 /* The following fixes a bug when using lazy-lock with
10502 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10503 from an idle timer function. The symptom of the bug is that
10504 the cursor sometimes doesn't become visible until the next X
10505 event is processed. --gerd. */
10507 Lisp_Object tail
, frame
;
10508 FOR_EACH_FRAME (tail
, frame
)
10509 if (FRAME_RIF (XFRAME (frame
)))
10510 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10514 return input_pending
;
10517 /* This is called in some cases before a possible quit.
10518 It cases the next call to detect_input_pending to recompute input_pending.
10519 So calling this function unnecessarily can't do any harm. */
10522 clear_input_pending (void)
10527 /* Return nonzero if there are pending requeued events.
10528 This isn't used yet. The hope is to make wait_reading_process_output
10529 call it, and return if it runs Lisp code that unreads something.
10530 The problem is, kbd_buffer_get_event needs to be fixed to know what
10531 to do in that case. It isn't trivial. */
10534 requeued_events_pending_p (void)
10536 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10540 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10541 doc
: /* Return t if command input is currently available with no wait.
10542 Actually, the value is nil only if we can be sure that no input is available;
10543 if there is a doubt, the value is t. */)
10546 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10547 || !NILP (Vunread_post_input_method_events
)
10548 || !NILP (Vunread_input_method_events
))
10551 /* Process non-user-visible events (Bug#10195). */
10552 process_special_events ();
10554 get_input_pending (&input_pending
,
10555 READABLE_EVENTS_DO_TIMERS_NOW
10556 | READABLE_EVENTS_FILTER_EVENTS
);
10557 return input_pending
> 0 ? Qt
: Qnil
;
10560 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10561 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10564 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10567 if (total_keys
< NUM_RECENT_KEYS
)
10568 return Fvector (total_keys
, keys
);
10571 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10572 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10573 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10574 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10575 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10580 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10581 doc
: /* Return the key sequence that invoked this command.
10582 However, if the command has called `read-key-sequence', it returns
10583 the last key sequence that has been read.
10584 The value is a string or a vector.
10586 See also `this-command-keys-vector'. */)
10589 return make_event_array (this_command_key_count
,
10590 XVECTOR (this_command_keys
)->contents
);
10593 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10594 doc
: /* Return the key sequence that invoked this command, as a vector.
10595 However, if the command has called `read-key-sequence', it returns
10596 the last key sequence that has been read.
10598 See also `this-command-keys'. */)
10601 return Fvector (this_command_key_count
,
10602 XVECTOR (this_command_keys
)->contents
);
10605 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10606 Sthis_single_command_keys
, 0, 0, 0,
10607 doc
: /* Return the key sequence that invoked this command.
10608 More generally, it returns the last key sequence read, either by
10609 the command loop or by `read-key-sequence'.
10610 Unlike `this-command-keys', this function's value
10611 does not include prefix arguments.
10612 The value is always a vector. */)
10615 return Fvector (this_command_key_count
10616 - this_single_command_key_start
,
10617 (XVECTOR (this_command_keys
)->contents
10618 + this_single_command_key_start
));
10621 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10622 Sthis_single_command_raw_keys
, 0, 0, 0,
10623 doc
: /* Return the raw events that were read for this command.
10624 More generally, it returns the last key sequence read, either by
10625 the command loop or by `read-key-sequence'.
10626 Unlike `this-single-command-keys', this function's value
10627 shows the events before all translations (except for input methods).
10628 The value is always a vector. */)
10631 return Fvector (raw_keybuf_count
,
10632 (XVECTOR (raw_keybuf
)->contents
));
10635 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10636 Sreset_this_command_lengths
, 0, 0, 0,
10637 doc
: /* Make the unread events replace the last command and echo.
10638 Used in `universal-argument-other-key'.
10640 `universal-argument-other-key' rereads the event just typed.
10641 It then gets translated through `function-key-map'.
10642 The translated event has to replace the real events,
10643 both in the value of (this-command-keys) and in echoing.
10644 To achieve this, `universal-argument-other-key' calls
10645 `reset-this-command-lengths', which discards the record of reading
10646 these events the first time. */)
10649 this_command_key_count
= before_command_key_count
;
10650 if (this_command_key_count
< this_single_command_key_start
)
10651 this_single_command_key_start
= this_command_key_count
;
10653 echo_truncate (before_command_echo_length
);
10655 /* Cause whatever we put into unread-command-events
10656 to echo as if it were being freshly read from the keyboard. */
10657 this_command_key_count_reset
= 1;
10662 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10663 Sclear_this_command_keys
, 0, 1, 0,
10664 doc
: /* Clear out the vector that `this-command-keys' returns.
10665 Also clear the record of the last 100 events, unless optional arg
10666 KEEP-RECORD is non-nil. */)
10667 (Lisp_Object keep_record
)
10671 this_command_key_count
= 0;
10672 this_command_key_count_reset
= 0;
10674 if (NILP (keep_record
))
10676 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10677 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10679 recent_keys_index
= 0;
10684 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10685 doc
: /* Return the current depth in recursive edits. */)
10689 /* Wrap around reliably on integer overflow. */
10690 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10691 XSETINT (temp
, sum
);
10695 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10696 "FOpen dribble file: ",
10697 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10698 If FILE is nil, close any open dribble file.
10699 The file will be closed when Emacs exits. */)
10711 file
= Fexpand_file_name (file
, Qnil
);
10712 dribble
= fopen (SSDATA (file
), "w");
10714 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10719 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10720 doc
: /* Discard the contents of the terminal input buffer.
10721 Also end any kbd macro being defined. */)
10724 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10726 /* Discard the last command from the macro. */
10727 Fcancel_kbd_macro_events ();
10731 update_mode_lines
++;
10733 Vunread_command_events
= Qnil
;
10734 unread_command_char
= -1;
10736 discard_tty_input ();
10738 kbd_fetch_ptr
= kbd_store_ptr
;
10744 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10745 doc
: /* Stop Emacs and return to superior process. You can resume later.
10746 If `cannot-suspend' is non-nil, or if the system doesn't support job
10747 control, run a subshell instead.
10749 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10750 to be read as terminal input by Emacs's parent, after suspension.
10752 Before suspending, run the normal hook `suspend-hook'.
10753 After resumption run the normal hook `suspend-resume-hook'.
10755 Some operating systems cannot stop the Emacs process and resume it later.
10756 On such systems, Emacs starts a subshell instead of suspending. */)
10757 (Lisp_Object stuffstring
)
10759 int count
= SPECPDL_INDEX ();
10760 int old_height
, old_width
;
10762 struct gcpro gcpro1
;
10765 if (tty_list
&& tty_list
->next
)
10766 error ("There are other tty frames open; close them before suspending Emacs");
10768 if (!NILP (stuffstring
))
10769 CHECK_STRING (stuffstring
);
10771 /* Run the functions in suspend-hook. */
10772 hook
= intern ("suspend-hook");
10773 Frun_hooks (1, &hook
);
10775 GCPRO1 (stuffstring
);
10776 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10777 reset_all_sys_modes ();
10778 /* sys_suspend can get an error if it tries to fork a subshell
10779 and the system resources aren't available for that. */
10780 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10782 stuff_buffered_input (stuffstring
);
10783 if (cannot_suspend
)
10787 unbind_to (count
, Qnil
);
10789 /* Check if terminal/window size has changed.
10790 Note that this is not useful when we are running directly
10791 with a window system; but suspend should be disabled in that case. */
10792 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10793 if (width
!= old_width
|| height
!= old_height
)
10794 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10796 /* Run suspend-resume-hook. */
10797 hook
= intern ("suspend-resume-hook");
10798 Frun_hooks (1, &hook
);
10804 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10805 Then in any case stuff anything Emacs has read ahead and not used. */
10808 stuff_buffered_input (Lisp_Object stuffstring
)
10810 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10811 register unsigned char *p
;
10813 if (STRINGP (stuffstring
))
10815 register EMACS_INT count
;
10817 p
= SDATA (stuffstring
);
10818 count
= SBYTES (stuffstring
);
10819 while (count
-- > 0)
10824 /* Anything we have read ahead, put back for the shell to read. */
10825 /* ?? What should this do when we have multiple keyboards??
10826 Should we ignore anything that was typed in at the "wrong" kboard?
10828 rms: we should stuff everything back into the kboard
10830 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10833 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10834 kbd_fetch_ptr
= kbd_buffer
;
10835 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10836 stuff_char (kbd_fetch_ptr
->code
);
10838 clear_event (kbd_fetch_ptr
);
10842 #endif /* SIGTSTP */
10846 set_waiting_for_input (struct timeval
*time_to_clear
)
10848 input_available_clear_time
= time_to_clear
;
10850 /* Tell handle_interrupt to throw back to read_char, */
10851 waiting_for_input
= 1;
10853 /* If handle_interrupt was called before and buffered a C-g,
10854 make it run again now, to avoid timing error. */
10855 if (!NILP (Vquit_flag
))
10856 quit_throw_to_read_char (0);
10860 clear_waiting_for_input (void)
10862 /* Tell handle_interrupt not to throw back to read_char, */
10863 waiting_for_input
= 0;
10864 input_available_clear_time
= 0;
10867 /* The SIGINT handler.
10869 If we have a frame on the controlling tty, we assume that the
10870 SIGINT was generated by C-g, so we call handle_interrupt.
10871 Otherwise, tell QUIT to kill Emacs. */
10874 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10875 /* compilers complain in signal calls. */
10877 /* Must preserve main program's value of errno. */
10878 int old_errno
= errno
;
10879 struct terminal
*terminal
;
10881 SIGNAL_THREAD_CHECK (signalnum
);
10883 /* See if we have an active terminal on our controlling tty. */
10884 terminal
= get_named_tty ("/dev/tty");
10887 /* If there are no frames there, let's pretend that we are a
10888 well-behaving UN*X program and quit. We must not call Lisp
10889 in a signal handler, so tell QUIT to exit when it is
10891 Vquit_flag
= Qkill_emacs
;
10895 /* Otherwise, the SIGINT was probably generated by C-g. */
10897 /* Set internal_last_event_frame to the top frame of the
10898 controlling tty, if we have a frame there. We disable the
10899 interrupt key on secondary ttys, so the SIGINT must have come
10900 from the controlling tty. */
10901 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10903 handle_interrupt ();
10909 /* This routine is called at interrupt level in response to C-g.
10911 It is called from the SIGINT handler or kbd_buffer_store_event.
10913 If `waiting_for_input' is non zero, then unless `echoing' is
10914 nonzero, immediately throw back to read_char.
10916 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10917 eval to throw, when it gets a chance. If quit-flag is already
10918 non-nil, it stops the job right away. */
10921 handle_interrupt (void)
10927 /* XXX This code needs to be revised for multi-tty support. */
10928 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10930 /* If SIGINT isn't blocked, don't let us be interrupted by
10931 another SIGINT, it might be harmful due to non-reentrancy
10932 in I/O functions. */
10933 sigblock (sigmask (SIGINT
));
10936 reset_all_sys_modes ();
10938 #ifdef SIGTSTP /* Support possible in later USG versions */
10940 * On systems which can suspend the current process and return to the original
10941 * shell, this command causes the user to end up back at the shell.
10942 * The "Auto-save" and "Abort" questions are not asked until
10943 * the user elects to return to emacs, at which point he can save the current
10944 * job and either dump core or continue.
10948 /* Perhaps should really fork an inferior shell?
10949 But that would not provide any way to get back
10950 to the original shell, ever. */
10951 printf ("No support for stopping a process on this operating system;\n");
10952 printf ("you can continue or abort.\n");
10953 #endif /* not SIGTSTP */
10955 /* We must remain inside the screen area when the internal terminal
10956 is used. Note that [Enter] is not echoed by dos. */
10957 cursor_to (SELECTED_FRAME (), 0, 0);
10959 /* It doesn't work to autosave while GC is in progress;
10960 the code used for auto-saving doesn't cope with the mark bit. */
10961 if (!gc_in_progress
)
10963 printf ("Auto-save? (y or n) ");
10965 if (((c
= getchar ()) & ~040) == 'Y')
10967 Fdo_auto_save (Qt
, Qnil
);
10969 printf ("\r\nAuto-save done");
10970 #else /* not MSDOS */
10971 printf ("Auto-save done\n");
10972 #endif /* not MSDOS */
10974 while (c
!= '\n') c
= getchar ();
10978 /* During GC, it must be safe to reenable quitting again. */
10979 Vinhibit_quit
= Qnil
;
10982 #endif /* not MSDOS */
10983 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10984 printf ("but will instead do a real quit after garbage collection ends\r\n");
10989 printf ("\r\nAbort? (y or n) ");
10990 #else /* not MSDOS */
10991 printf ("Abort (and dump core)? (y or n) ");
10992 #endif /* not MSDOS */
10994 if (((c
= getchar ()) & ~040) == 'Y')
10996 while (c
!= '\n') c
= getchar ();
10998 printf ("\r\nContinuing...\r\n");
10999 #else /* not MSDOS */
11000 printf ("Continuing...\n");
11001 #endif /* not MSDOS */
11003 init_all_sys_modes ();
11008 /* If executing a function that wants to be interrupted out of
11009 and the user has not deferred quitting by binding `inhibit-quit'
11010 then quit right away. */
11011 if (immediate_quit
&& NILP (Vinhibit_quit
))
11013 struct gl_state_s saved
;
11014 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11016 immediate_quit
= 0;
11019 GCPRO4 (saved
.object
, saved
.global_code
,
11020 saved
.current_syntax_table
, saved
.old_prop
);
11021 Fsignal (Qquit
, Qnil
);
11022 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11027 /* Else request quit when it's safe */
11031 /* TODO: The longjmp in this call throws the NS event loop integration off,
11032 and it seems to do fine without this. Probably some attention
11033 needs to be paid to the setting of waiting_for_input in
11034 wait_reading_process_output() under HAVE_NS because of the call
11035 to ns_select there (needed because otherwise events aren't picked up
11036 outside of polling since we don't get SIGIO like X and we don't have a
11037 separate event loop thread like W32. */
11039 if (waiting_for_input
&& !echoing
)
11040 quit_throw_to_read_char (1);
11044 /* Handle a C-g by making read_char return C-g. */
11047 quit_throw_to_read_char (int from_signal
)
11049 /* When not called from a signal handler it is safe to call
11051 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
11052 Fkill_emacs (Qnil
);
11055 /* Prevent another signal from doing this before we finish. */
11056 clear_waiting_for_input ();
11059 Vunread_command_events
= Qnil
;
11060 unread_command_char
= -1;
11062 #if 0 /* Currently, sit_for is called from read_char without turning
11063 off polling. And that can call set_waiting_for_input.
11064 It seems to be harmless. */
11065 #ifdef POLL_FOR_INPUT
11066 /* May be > 1 if in recursive minibuffer. */
11067 if (poll_suppress_count
== 0)
11071 if (FRAMEP (internal_last_event_frame
)
11072 && !EQ (internal_last_event_frame
, selected_frame
))
11073 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11076 _longjmp (getcjmp
, 1);
11079 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
11080 Sset_input_interrupt_mode
, 1, 1, 0,
11081 doc
: /* Set interrupt mode of reading keyboard input.
11082 If INTERRUPT is non-nil, Emacs will use input interrupts;
11083 otherwise Emacs uses CBREAK mode.
11085 See also `current-input-mode'. */)
11086 (Lisp_Object interrupt
)
11088 int new_interrupt_input
;
11090 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11091 #ifdef HAVE_X_WINDOWS
11092 if (x_display_list
!= NULL
)
11094 /* When using X, don't give the user a real choice,
11095 because we haven't implemented the mechanisms to support it. */
11096 new_interrupt_input
= 1;
11099 #endif /* HAVE_X_WINDOWS */
11100 new_interrupt_input
= !NILP (interrupt
);
11101 #else /* not SIGIO */
11102 new_interrupt_input
= 0;
11103 #endif /* not SIGIO */
11105 if (new_interrupt_input
!= interrupt_input
)
11107 #ifdef POLL_FOR_INPUT
11111 /* this causes startup screen to be restored and messes with the mouse */
11112 reset_all_sys_modes ();
11113 interrupt_input
= new_interrupt_input
;
11114 init_all_sys_modes ();
11116 interrupt_input
= new_interrupt_input
;
11119 #ifdef POLL_FOR_INPUT
11120 poll_suppress_count
= 1;
11127 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11128 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11129 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11130 C-q in key sequences.
11132 This setting only has an effect on tty terminals and only when
11133 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11135 See also `current-input-mode'. */)
11136 (Lisp_Object flow
, Lisp_Object terminal
)
11138 struct terminal
*t
= get_terminal (terminal
, 1);
11139 struct tty_display_info
*tty
;
11140 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11142 tty
= t
->display_info
.tty
;
11144 if (tty
->flow_control
!= !NILP (flow
))
11147 /* this causes startup screen to be restored and messes with the mouse */
11148 reset_sys_modes (tty
);
11151 tty
->flow_control
= !NILP (flow
);
11154 init_sys_modes (tty
);
11160 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11161 doc
: /* Enable or disable 8-bit input on TERMINAL.
11162 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11163 bit as the Meta modifier.
11165 If META is nil, Emacs will ignore the top bit, on the assumption it is
11168 Otherwise, Emacs will accept and pass through 8-bit input without
11169 specially interpreting the top bit.
11171 This setting only has an effect on tty terminal devices.
11173 Optional parameter TERMINAL specifies the tty terminal device to use.
11174 It may be a terminal object, a frame, or nil for the terminal used by
11175 the currently selected frame.
11177 See also `current-input-mode'. */)
11178 (Lisp_Object meta
, Lisp_Object terminal
)
11180 struct terminal
*t
= get_terminal (terminal
, 1);
11181 struct tty_display_info
*tty
;
11184 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11186 tty
= t
->display_info
.tty
;
11190 else if (EQ (meta
, Qt
))
11195 if (tty
->meta_key
!= new_meta
)
11198 /* this causes startup screen to be restored and messes with the mouse */
11199 reset_sys_modes (tty
);
11202 tty
->meta_key
= new_meta
;
11205 init_sys_modes (tty
);
11211 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11212 doc
: /* Specify character used for quitting.
11213 QUIT must be an ASCII character.
11215 This function only has an effect on the controlling tty of the Emacs
11218 See also `current-input-mode'. */)
11221 struct terminal
*t
= get_named_tty ("/dev/tty");
11222 struct tty_display_info
*tty
;
11223 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11225 tty
= t
->display_info
.tty
;
11227 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11228 error ("QUIT must be an ASCII character");
11231 /* this causes startup screen to be restored and messes with the mouse */
11232 reset_sys_modes (tty
);
11235 /* Don't let this value be out of range. */
11236 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11239 init_sys_modes (tty
);
11245 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11246 doc
: /* Set mode of reading keyboard input.
11247 First arg INTERRUPT non-nil means use input interrupts;
11248 nil means use CBREAK mode.
11249 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11250 (no effect except in CBREAK mode).
11251 Third arg META t means accept 8-bit input (for a Meta key).
11252 META nil means ignore the top bit, on the assumption it is parity.
11253 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11254 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11255 See also `current-input-mode'. */)
11256 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11258 Fset_input_interrupt_mode (interrupt
);
11259 Fset_output_flow_control (flow
, Qnil
);
11260 Fset_input_meta_mode (meta
, Qnil
);
11262 Fset_quit_char (quit
);
11266 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11267 doc
: /* Return information about the way Emacs currently reads keyboard input.
11268 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11269 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11270 nil, Emacs is using CBREAK mode.
11271 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11272 terminal; this does not apply if Emacs uses interrupt-driven input.
11273 META is t if accepting 8-bit input with 8th bit as Meta flag.
11274 META nil means ignoring the top bit, on the assumption it is parity.
11275 META is neither t nor nil if accepting 8-bit input and using
11276 all 8 bits as the character code.
11277 QUIT is the character Emacs currently uses to quit.
11278 The elements of this list correspond to the arguments of
11279 `set-input-mode'. */)
11282 Lisp_Object val
[4];
11283 struct frame
*sf
= XFRAME (selected_frame
);
11285 val
[0] = interrupt_input
? Qt
: Qnil
;
11286 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11288 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11289 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11291 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11298 XSETFASTINT (val
[3], quit_char
);
11300 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11303 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11304 doc
: /* Return position information for pixel coordinates X and Y.
11305 By default, X and Y are relative to text area of the selected window.
11306 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11307 If optional fourth arg WHOLE is non-nil, X is relative to the left
11308 edge of the window.
11310 The return value is similar to a mouse click position:
11311 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11312 IMAGE (DX . DY) (WIDTH . HEIGHT))
11313 The `posn-' functions access elements of such lists. */)
11314 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11319 if (NILP (frame_or_window
))
11320 frame_or_window
= selected_window
;
11322 if (WINDOWP (frame_or_window
))
11326 CHECK_LIVE_WINDOW (frame_or_window
);
11328 w
= XWINDOW (frame_or_window
);
11329 XSETINT (x
, (XINT (x
)
11330 + WINDOW_LEFT_EDGE_X (w
)
11332 ? window_box_left_offset (w
, TEXT_AREA
)
11334 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11335 frame_or_window
= w
->frame
;
11338 CHECK_LIVE_FRAME (frame_or_window
);
11340 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11343 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11344 doc
: /* Return position information for buffer POS in WINDOW.
11345 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11347 Return nil if position is not visible in window. Otherwise,
11348 the return value is similar to that returned by `event-start' for
11349 a mouse click at the upper left corner of the glyph corresponding
11350 to the given buffer position:
11351 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11352 IMAGE (DX . DY) (WIDTH . HEIGHT))
11353 The `posn-' functions access elements of such lists. */)
11354 (Lisp_Object pos
, Lisp_Object window
)
11359 window
= selected_window
;
11361 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11364 Lisp_Object x
= XCAR (tem
);
11365 Lisp_Object y
= XCAR (XCDR (tem
));
11367 /* Point invisible due to hscrolling? */
11370 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11378 * Set up a new kboard object with reasonable initial values.
11381 init_kboard (KBOARD
*kb
)
11383 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11384 KVAR (kb
, Vlast_command
) = Qnil
;
11385 KVAR (kb
, Vreal_last_command
) = Qnil
;
11386 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11387 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11388 KVAR (kb
, Vprefix_arg
) = Qnil
;
11389 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11390 KVAR (kb
, kbd_queue
) = Qnil
;
11391 kb
->kbd_queue_has_data
= 0;
11392 kb
->immediate_echo
= 0;
11393 KVAR (kb
, echo_string
) = Qnil
;
11394 kb
->echo_after_prompt
= -1;
11395 kb
->kbd_macro_buffer
= 0;
11396 kb
->kbd_macro_bufsize
= 0;
11397 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11398 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11399 kb
->reference_count
= 0;
11400 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11401 KVAR (kb
, system_key_syms
) = Qnil
;
11402 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11403 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11404 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11405 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11406 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11410 * Destroy the contents of a kboard object, but not the object itself.
11411 * We use this just before deleting it, or if we're going to initialize
11412 * it a second time.
11415 wipe_kboard (KBOARD
*kb
)
11417 xfree (kb
->kbd_macro_buffer
);
11420 /* Free KB and memory referenced from it. */
11423 delete_kboard (KBOARD
*kb
)
11427 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11430 *kbp
= kb
->next_kboard
;
11432 /* Prevent a dangling reference to KB. */
11433 if (kb
== current_kboard
11434 && FRAMEP (selected_frame
)
11435 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11437 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11439 if (current_kboard
== kb
)
11448 init_keyboard (void)
11450 /* This is correct before outermost invocation of the editor loop */
11451 command_loop_level
= -1;
11452 immediate_quit
= 0;
11453 quit_char
= Ctl ('g');
11454 Vunread_command_events
= Qnil
;
11455 unread_command_char
= -1;
11456 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11458 recent_keys_index
= 0;
11459 kbd_fetch_ptr
= kbd_buffer
;
11460 kbd_store_ptr
= kbd_buffer
;
11461 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11462 do_mouse_tracking
= Qnil
;
11465 interrupt_input_blocked
= 0;
11466 interrupt_input_pending
= 0;
11468 pending_signals
= 0;
11471 /* This means that command_loop_1 won't try to select anything the first
11473 internal_last_event_frame
= Qnil
;
11474 Vlast_event_frame
= internal_last_event_frame
;
11476 current_kboard
= initial_kboard
;
11477 /* Re-initialize the keyboard again. */
11478 wipe_kboard (current_kboard
);
11479 init_kboard (current_kboard
);
11480 /* A value of nil for Vwindow_system normally means a tty, but we also use
11481 it for the initial terminal since there is no window system there. */
11482 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11484 if (!noninteractive
)
11486 /* Before multi-tty support, these handlers used to be installed
11487 only if the current session was a tty session. Now an Emacs
11488 session may have multiple display types, so we always handle
11489 SIGINT. There is special code in interrupt_signal to exit
11490 Emacs on SIGINT when there are no termcap frames on the
11491 controlling terminal. */
11492 signal (SIGINT
, interrupt_signal
);
11494 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11495 SIGQUIT and we can't tell which one it will give us. */
11496 signal (SIGQUIT
, interrupt_signal
);
11497 #endif /* not DOS_NT */
11499 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11501 if (!noninteractive
)
11502 signal (SIGIO
, input_available_signal
);
11505 /* Use interrupt input by default, if it works and noninterrupt input
11506 has deficiencies. */
11508 #ifdef INTERRUPT_INPUT
11509 interrupt_input
= 1;
11511 interrupt_input
= 0;
11517 if (keyboard_init_hook
)
11518 (*keyboard_init_hook
) ();
11520 #ifdef POLL_FOR_INPUT
11522 poll_suppress_count
= 1;
11527 /* This type's only use is in syms_of_keyboard, to initialize the
11528 event header symbols and put properties on them. */
11529 struct event_head
{
11535 static const struct event_head head_table
[] = {
11536 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11537 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11538 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11539 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11540 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11541 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11542 /* `select-window' should be handled just like `switch-frame'
11543 in read_key_sequence. */
11544 {&Qselect_window
, "select-window", &Qswitch_frame
}
11548 syms_of_keyboard (void)
11550 pending_funcalls
= Qnil
;
11551 staticpro (&pending_funcalls
);
11553 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11554 staticpro (&Vlispy_mouse_stem
);
11557 DEFSYM (QCimage
, ":image");
11558 DEFSYM (Qhelp_echo
, "help-echo");
11559 DEFSYM (QCrtl
, ":rtl");
11561 staticpro (&item_properties
);
11562 item_properties
= Qnil
;
11564 staticpro (&tool_bar_item_properties
);
11565 tool_bar_item_properties
= Qnil
;
11566 staticpro (&tool_bar_items_vector
);
11567 tool_bar_items_vector
= Qnil
;
11569 staticpro (&real_this_command
);
11570 real_this_command
= Qnil
;
11572 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11573 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11574 DEFSYM (Qself_insert_command
, "self-insert-command");
11575 DEFSYM (Qforward_char
, "forward-char");
11576 DEFSYM (Qbackward_char
, "backward-char");
11577 DEFSYM (Qdisabled
, "disabled");
11578 DEFSYM (Qundefined
, "undefined");
11579 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11580 DEFSYM (Qpost_command_hook
, "post-command-hook");
11581 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11582 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11583 DEFSYM (Qfunction_key
, "function-key");
11584 DEFSYM (Qmouse_click
, "mouse-click");
11585 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11586 DEFSYM (Qsave_session
, "save-session");
11587 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11588 DEFSYM (Qmenu_enable
, "menu-enable");
11590 #if defined (WINDOWSNT)
11591 DEFSYM (Qlanguage_change
, "language-change");
11595 DEFSYM (Qdbus_event
, "dbus-event");
11598 #ifdef HAVE_XWIDGETS
11599 Qxwidget_event
= intern ("xwidget-event");
11600 staticpro (&Qxwidget_event
);
11602 DEFSYM (QCenable
, ":enable");
11603 DEFSYM (QCvisible
, ":visible");
11604 DEFSYM (QChelp
, ":help");
11605 DEFSYM (QCfilter
, ":filter");
11606 DEFSYM (QCbutton
, ":button");
11607 DEFSYM (QCkeys
, ":keys");
11608 DEFSYM (QCkey_sequence
, ":key-sequence");
11609 DEFSYM (QCtoggle
, ":toggle");
11610 DEFSYM (QCradio
, ":radio");
11611 DEFSYM (QClabel
, ":label");
11612 DEFSYM (QCvert_only
, ":vert-only");
11614 DEFSYM (Qmode_line
, "mode-line");
11615 DEFSYM (Qvertical_line
, "vertical-line");
11616 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11617 DEFSYM (Qmenu_bar
, "menu-bar");
11619 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11620 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11623 DEFSYM (Qabove_handle
, "above-handle");
11624 DEFSYM (Qhandle
, "handle");
11625 DEFSYM (Qbelow_handle
, "below-handle");
11626 DEFSYM (Qup
, "up");
11627 DEFSYM (Qdown
, "down");
11628 DEFSYM (Qtop
, "top");
11629 DEFSYM (Qbottom
, "bottom");
11630 DEFSYM (Qend_scroll
, "end-scroll");
11631 DEFSYM (Qratio
, "ratio");
11633 DEFSYM (Qevent_kind
, "event-kind");
11634 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11635 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11636 DEFSYM (Qmodifier_cache
, "modifier-cache");
11638 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11639 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11641 DEFSYM (Qpolling_period
, "polling-period");
11643 DEFSYM (Qx_set_selection
, "x-set-selection");
11644 DEFSYM (QPRIMARY
, "PRIMARY");
11645 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11647 DEFSYM (Qinput_method_function
, "input-method-function");
11648 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11649 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11651 DEFSYM (Qhelp_form_show
, "help-form-show");
11653 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11654 Fset (Qinput_method_use_echo_area
, Qnil
);
11656 last_point_position_buffer
= Qnil
;
11657 last_point_position_window
= Qnil
;
11661 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11663 for (i
= 0; i
< len
; i
++)
11665 const struct event_head
*p
= &head_table
[i
];
11666 *p
->var
= intern_c_string (p
->name
);
11667 staticpro (p
->var
);
11668 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11669 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11673 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11674 staticpro (&button_down_location
);
11675 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11676 staticpro (&mouse_syms
);
11677 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11678 / sizeof (lispy_wheel_names
[0])),
11680 staticpro (&wheel_syms
);
11684 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11686 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11687 for (i
= 0; i
< len
; i
++)
11688 if (modifier_names
[i
])
11689 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11690 staticpro (&modifier_symbols
);
11693 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11694 staticpro (&recent_keys
);
11696 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11697 staticpro (&this_command_keys
);
11699 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11700 staticpro (&raw_keybuf
);
11702 DEFSYM (Qextended_command_history
, "extended-command-history");
11703 Fset (Qextended_command_history
, Qnil
);
11705 accent_key_syms
= Qnil
;
11706 staticpro (&accent_key_syms
);
11708 func_key_syms
= Qnil
;
11709 staticpro (&func_key_syms
);
11711 drag_n_drop_syms
= Qnil
;
11712 staticpro (&drag_n_drop_syms
);
11714 unread_switch_frame
= Qnil
;
11715 staticpro (&unread_switch_frame
);
11717 internal_last_event_frame
= Qnil
;
11718 staticpro (&internal_last_event_frame
);
11720 read_key_sequence_cmd
= Qnil
;
11721 staticpro (&read_key_sequence_cmd
);
11722 read_key_sequence_remapped
= Qnil
;
11723 staticpro (&read_key_sequence_remapped
);
11725 menu_bar_one_keymap_changed_items
= Qnil
;
11726 staticpro (&menu_bar_one_keymap_changed_items
);
11728 menu_bar_items_vector
= Qnil
;
11729 staticpro (&menu_bar_items_vector
);
11731 help_form_saved_window_configs
= Qnil
;
11732 staticpro (&help_form_saved_window_configs
);
11734 defsubr (&Scurrent_idle_time
);
11735 defsubr (&Sevent_symbol_parse_modifiers
);
11736 defsubr (&Sevent_convert_list
);
11737 defsubr (&Sread_key_sequence
);
11738 defsubr (&Sread_key_sequence_vector
);
11739 defsubr (&Srecursive_edit
);
11740 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11741 defsubr (&Strack_mouse
);
11743 defsubr (&Sinput_pending_p
);
11744 defsubr (&Scommand_execute
);
11745 defsubr (&Srecent_keys
);
11746 defsubr (&Sthis_command_keys
);
11747 defsubr (&Sthis_command_keys_vector
);
11748 defsubr (&Sthis_single_command_keys
);
11749 defsubr (&Sthis_single_command_raw_keys
);
11750 defsubr (&Sreset_this_command_lengths
);
11751 defsubr (&Sclear_this_command_keys
);
11752 defsubr (&Ssuspend_emacs
);
11753 defsubr (&Sabort_recursive_edit
);
11754 defsubr (&Sexit_recursive_edit
);
11755 defsubr (&Srecursion_depth
);
11756 defsubr (&Stop_level
);
11757 defsubr (&Sdiscard_input
);
11758 defsubr (&Sopen_dribble_file
);
11759 defsubr (&Sset_input_interrupt_mode
);
11760 defsubr (&Sset_output_flow_control
);
11761 defsubr (&Sset_input_meta_mode
);
11762 defsubr (&Sset_quit_char
);
11763 defsubr (&Sset_input_mode
);
11764 defsubr (&Scurrent_input_mode
);
11765 defsubr (&Sexecute_extended_command
);
11766 defsubr (&Sposn_at_point
);
11767 defsubr (&Sposn_at_x_y
);
11769 DEFVAR_LISP ("last-command-event", last_command_event
,
11770 doc
: /* Last input event that was part of a command. */);
11772 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11773 doc
: /* Last input event in a command, except for mouse menu events.
11774 Mouse menus give back keys that don't look like mouse events;
11775 this variable holds the actual mouse event that led to the menu,
11776 so that you can determine whether the command was run by mouse or not. */);
11778 DEFVAR_LISP ("last-input-event", last_input_event
,
11779 doc
: /* Last input event. */);
11781 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11782 doc
: /* List of events to be read as the command input.
11783 These events are processed first, before actual keyboard input.
11784 Events read from this list are not normally added to `this-command-keys',
11785 as they will already have been added once as they were read for the first time.
11786 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11787 Vunread_command_events
= Qnil
;
11789 DEFVAR_INT ("unread-command-char", unread_command_char
,
11790 doc
: /* If not -1, an object to be read as next command input event. */);
11792 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11793 doc
: /* List of events to be processed as input by input methods.
11794 These events are processed before `unread-command-events'
11795 and actual keyboard input, but are not given to `input-method-function'. */);
11796 Vunread_post_input_method_events
= Qnil
;
11798 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11799 doc
: /* List of events to be processed as input by input methods.
11800 These events are processed after `unread-command-events', but
11801 before actual keyboard input.
11802 If there's an active input method, the events are given to
11803 `input-method-function'. */);
11804 Vunread_input_method_events
= Qnil
;
11806 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11807 doc
: /* Meta-prefix character code.
11808 Meta-foo as command input turns into this character followed by foo. */);
11809 XSETINT (meta_prefix_char
, 033);
11811 DEFVAR_KBOARD ("last-command", Vlast_command
,
11812 doc
: /* The last command executed.
11813 Normally a symbol with a function definition, but can be whatever was found
11814 in the keymap, or whatever the variable `this-command' was set to by that
11817 The value `mode-exit' is special; it means that the previous command
11818 read an event that told it to exit, and it did so and unread that event.
11819 In other words, the present command is the event that made the previous
11822 The value `kill-region' is special; it means that the previous command
11823 was a kill command.
11825 `last-command' has a separate binding for each terminal device.
11826 See Info node `(elisp)Multiple Terminals'. */);
11828 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11829 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11831 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11832 doc
: /* Last command that may be repeated.
11833 The last command executed that was not bound to an input event.
11834 This is the command `repeat' will try to repeat. */);
11836 DEFVAR_LISP ("this-command", Vthis_command
,
11837 doc
: /* The command now being executed.
11838 The command can set this variable; whatever is put here
11839 will be in `last-command' during the following command. */);
11840 Vthis_command
= Qnil
;
11842 DEFVAR_LISP ("this-command-keys-shift-translated",
11843 Vthis_command_keys_shift_translated
,
11844 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11845 Shift-translation occurs when there is no binding for the key sequence
11846 as entered, but a binding was found by changing an upper-case letter
11847 to lower-case, or a shifted function key to an unshifted one. */);
11848 Vthis_command_keys_shift_translated
= Qnil
;
11850 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11851 doc
: /* The command bound to the current key sequence before remapping.
11852 It equals `this-command' if the original command was not remapped through
11853 any of the active keymaps. Otherwise, the value of `this-command' is the
11854 result of looking up the original command in the active keymaps. */);
11855 Vthis_original_command
= Qnil
;
11857 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11858 doc
: /* *Number of input events between auto-saves.
11859 Zero means disable autosaving due to number of characters typed. */);
11860 auto_save_interval
= 300;
11862 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11863 doc
: /* *Number of seconds idle time before auto-save.
11864 Zero or nil means disable auto-saving due to idleness.
11865 After auto-saving due to this many seconds of idle time,
11866 Emacs also does a garbage collection if that seems to be warranted. */);
11867 XSETFASTINT (Vauto_save_timeout
, 30);
11869 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11870 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11871 The value may be integer or floating point. */);
11872 Vecho_keystrokes
= make_number (1);
11874 DEFVAR_INT ("polling-period", polling_period
,
11875 doc
: /* *Interval between polling for input during Lisp execution.
11876 The reason for polling is to make C-g work to stop a running program.
11877 Polling is needed only when using X windows and SIGIO does not work.
11878 Polling is automatically disabled in all other cases. */);
11879 polling_period
= 2;
11881 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11882 doc
: /* *Maximum time between mouse clicks to make a double-click.
11883 Measured in milliseconds. The value nil means disable double-click
11884 recognition; t means double-clicks have no time limit and are detected
11885 by position only. */);
11886 Vdouble_click_time
= make_number (500);
11888 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11889 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11890 On window-system frames, value is the number of pixels the mouse may have
11891 moved horizontally or vertically between two clicks to make a double-click.
11892 On non window-system frames, value is interpreted in units of 1/8 characters
11895 This variable is also the threshold for motion of the mouse
11896 to count as a drag. */);
11897 double_click_fuzz
= 3;
11899 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11900 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11901 inhibit_local_menu_bar_menus
= 0;
11903 DEFVAR_INT ("num-input-keys", num_input_keys
,
11904 doc
: /* Number of complete key sequences read as input so far.
11905 This includes key sequences read from keyboard macros.
11906 The number is effectively the number of interactive command invocations. */);
11907 num_input_keys
= 0;
11909 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11910 doc
: /* Number of input events read from the keyboard so far.
11911 This does not include events generated by keyboard macros. */);
11912 num_nonmacro_input_events
= 0;
11914 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11915 doc
: /* The frame in which the most recently read event occurred.
11916 If the last event came from a keyboard macro, this is set to `macro'. */);
11917 Vlast_event_frame
= Qnil
;
11919 /* This variable is set up in sysdep.c. */
11920 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11921 doc
: /* The ERASE character as set by the user with stty. */);
11923 DEFVAR_LISP ("help-char", Vhelp_char
,
11924 doc
: /* Character to recognize as meaning Help.
11925 When it is read, do `(eval help-form)', and display result if it's a string.
11926 If the value of `help-form' is nil, this char can be read normally. */);
11927 XSETINT (Vhelp_char
, Ctl ('H'));
11929 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11930 doc
: /* List of input events to recognize as meaning Help.
11931 These work just like the value of `help-char' (see that). */);
11932 Vhelp_event_list
= Qnil
;
11934 DEFVAR_LISP ("help-form", Vhelp_form
,
11935 doc
: /* Form to execute when character `help-char' is read.
11936 If the form returns a string, that string is displayed.
11937 If `help-form' is nil, the help char is not recognized. */);
11940 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11941 doc
: /* Command to run when `help-char' character follows a prefix key.
11942 This command is used only when there is no actual binding
11943 for that character after that prefix key. */);
11944 Vprefix_help_command
= Qnil
;
11946 DEFVAR_LISP ("top-level", Vtop_level
,
11947 doc
: /* Form to evaluate when Emacs starts up.
11948 Useful to set before you dump a modified Emacs. */);
11951 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11952 doc
: /* Translate table for local keyboard input, or nil.
11953 If non-nil, the value should be a char-table. Each character read
11954 from the keyboard is looked up in this char-table. If the value found
11955 there is non-nil, then it is used instead of the actual input character.
11957 The value can also be a string or vector, but this is considered obsolete.
11958 If it is a string or vector of length N, character codes N and up are left
11959 untranslated. In a vector, an element which is nil means "no translation".
11961 This is applied to the characters supplied to input methods, not their
11962 output. See also `translation-table-for-input'.
11964 This variable has a separate binding for each terminal.
11965 See Info node `(elisp)Multiple Terminals'. */);
11967 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11968 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11969 \(Even if the operating system has support for stopping a process.\) */);
11970 cannot_suspend
= 0;
11972 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11973 doc
: /* Non-nil means prompt with menus when appropriate.
11974 This is done when reading from a keymap that has a prompt string,
11975 for elements that have prompt strings.
11976 The menu is displayed on the screen
11977 if X menus were enabled at configuration
11978 time and the previous event was a mouse click prefix key.
11979 Otherwise, menu prompting uses the echo area. */);
11980 menu_prompting
= 1;
11982 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11983 doc
: /* Character to see next line of menu prompt.
11984 Type this character while in a menu prompt to rotate around the lines of it. */);
11985 XSETINT (menu_prompt_more_char
, ' ');
11987 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11988 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11989 Emacs applies the modifiers of the character stored here to each keyboard
11990 character it reads. For example, after evaluating the expression
11991 (setq extra-keyboard-modifiers ?\\C-x)
11992 all input characters will have the control modifier applied to them.
11994 Note that the character ?\\C-@, equivalent to the integer zero, does
11995 not count as a control character; rather, it counts as a character
11996 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11997 cancels any modification. */);
11998 extra_keyboard_modifiers
= 0;
12000 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
12001 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12002 The command loop sets this to nil before each command,
12003 and tests the value when the command returns.
12004 Buffer modification stores t in this variable. */);
12005 Vdeactivate_mark
= Qnil
;
12006 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
12008 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
12009 doc
: /* Normal hook run before each command is executed.
12010 If an unhandled error happens in running this hook,
12011 the function in which the error occurred is unconditionally removed, since
12012 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
12013 Vpre_command_hook
= Qnil
;
12015 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
12016 doc
: /* Normal hook run after each command is executed.
12017 If an unhandled error happens in running this hook,
12018 the function in which the error occurred is unconditionally removed, since
12019 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
12020 Vpost_command_hook
= Qnil
;
12023 DEFVAR_LISP ("echo-area-clear-hook", ...,
12024 doc
: /* Normal hook run when clearing the echo area. */);
12026 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
12027 Fset (Qecho_area_clear_hook
, Qnil
);
12029 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
12030 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12031 Vlucid_menu_bar_dirty_flag
= Qnil
;
12033 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
12034 doc
: /* List of menu bar items to move to the end of the menu bar.
12035 The elements of the list are event types that may have menu bar bindings. */);
12036 Vmenu_bar_final_items
= Qnil
;
12038 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
12039 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
12040 This is used internally by graphical displays that do not render
12041 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
12042 Vtool_bar_separator_image_expression
= Qnil
;
12044 DEFVAR_KBOARD ("overriding-terminal-local-map",
12045 Voverriding_terminal_local_map
,
12046 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12047 If this variable is non-nil, it is used as a keymap instead of the
12048 buffer's local map, and the minor mode keymaps and text property keymaps.
12049 It also replaces `overriding-local-map'.
12051 This variable is intended to let commands such as `universal-argument'
12052 set up a different keymap for reading the next command.
12054 `overriding-terminal-local-map' has a separate binding for each
12056 See Info node `(elisp)Multiple Terminals'. */);
12058 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
12059 doc
: /* Keymap that overrides all other local keymaps.
12060 If this variable is non-nil, it is used as a keymap--replacing the
12061 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12062 Voverriding_local_map
= Qnil
;
12064 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
12065 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12066 Otherwise, the menu bar continues to reflect the buffer's local map
12067 and the minor mode maps regardless of `overriding-local-map'. */);
12068 Voverriding_local_map_menu_flag
= Qnil
;
12070 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12071 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12072 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12074 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12075 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12077 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12078 doc
: /* Alist of system-specific X windows key symbols.
12079 Each element should have the form (N . SYMBOL) where N is the
12080 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12081 and SYMBOL is its name.
12083 `system-key-alist' has a separate binding for each terminal device.
12084 See Info node `(elisp)Multiple Terminals'. */);
12086 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12087 doc
: /* Keymap that translates key sequences to key sequences during input.
12088 This is used mainly for mapping key sequences into some preferred
12089 key events (symbols).
12091 The `read-key-sequence' function replaces any subsequence bound by
12092 `local-function-key-map' with its binding. More precisely, when the
12093 active keymaps have no binding for the current key sequence but
12094 `local-function-key-map' binds a suffix of the sequence to a vector or
12095 string, `read-key-sequence' replaces the matching suffix with its
12096 binding, and continues with the new sequence.
12098 If the binding is a function, it is called with one argument (the prompt)
12099 and its return value (a key sequence) is used.
12101 The events that come from bindings in `local-function-key-map' are not
12102 themselves looked up in `local-function-key-map'.
12104 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12105 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12106 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12107 typing `ESC O P x' would return [f1 x].
12109 `local-function-key-map' has a separate binding for each terminal
12110 device. See Info node `(elisp)Multiple Terminals'. If you need to
12111 define a binding on all terminals, change `function-key-map'
12112 instead. Initially, `local-function-key-map' is an empty keymap that
12113 has `function-key-map' as its parent on all terminal devices. */);
12115 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12116 doc
: /* Keymap that decodes input escape sequences.
12117 This is used mainly for mapping ASCII function key sequences into
12118 real Emacs function key events (symbols).
12120 The `read-key-sequence' function replaces any subsequence bound by
12121 `input-decode-map' with its binding. Contrary to `function-key-map',
12122 this map applies its rebinding regardless of the presence of an ordinary
12123 binding. So it is more like `key-translation-map' except that it applies
12124 before `function-key-map' rather than after.
12126 If the binding is a function, it is called with one argument (the prompt)
12127 and its return value (a key sequence) is used.
12129 The events that come from bindings in `input-decode-map' are not
12130 themselves looked up in `input-decode-map'.
12132 This variable is keyboard-local. */);
12134 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12135 doc
: /* The parent keymap of all `local-function-key-map' instances.
12136 Function key definitions that apply to all terminal devices should go
12137 here. If a mapping is defined in both the current
12138 `local-function-key-map' binding and this variable, then the local
12139 definition will take precedence. */);
12140 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12142 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12143 doc
: /* Keymap of key translations that can override keymaps.
12144 This keymap works like `function-key-map', but comes after that,
12145 and its non-prefix bindings override ordinary bindings.
12146 Another difference is that it is global rather than keyboard-local. */);
12147 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12149 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12150 doc
: /* List of deferred actions to be performed at a later time.
12151 The precise format isn't relevant here; we just check whether it is nil. */);
12152 Vdeferred_action_list
= Qnil
;
12154 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12155 doc
: /* Function to call to handle deferred actions, after each command.
12156 This function is called with no arguments after each command
12157 whenever `deferred-action-list' is non-nil. */);
12158 Vdeferred_action_function
= Qnil
;
12160 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12161 doc
: /* List of warnings to be displayed as soon as possible.
12162 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12163 as per the args of `display-warning' (which see).
12164 If this variable is non-nil, `delayed-warnings-hook' will be run
12165 immediately after running `post-command-hook'. */);
12166 Vdelayed_warnings_list
= Qnil
;
12168 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12169 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12170 The value can be a length of time to show the message for.
12171 If the value is non-nil and not a number, we wait 2 seconds. */);
12172 Vsuggest_key_bindings
= Qt
;
12174 DEFVAR_LISP ("timer-list", Vtimer_list
,
12175 doc
: /* List of active absolute time timers in order of increasing time. */);
12176 Vtimer_list
= Qnil
;
12178 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12179 doc
: /* List of active idle-time timers in order of increasing time. */);
12180 Vtimer_idle_list
= Qnil
;
12182 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12183 doc
: /* If non-nil, the function that implements the current input method.
12184 It's called with one argument, a printing character that was just read.
12185 \(That means a character with code 040...0176.)
12186 Typically this function uses `read-event' to read additional events.
12187 When it does so, it should first bind `input-method-function' to nil
12188 so it will not be called recursively.
12190 The function should return a list of zero or more events
12191 to be used as input. If it wants to put back some events
12192 to be reconsidered, separately, by the input method,
12193 it can add them to the beginning of `unread-command-events'.
12195 The input method function can find in `input-method-previous-message'
12196 the previous echo area message.
12198 The input method function should refer to the variables
12199 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12200 for guidance on what to do. */);
12201 Vinput_method_function
= Qnil
;
12203 DEFVAR_LISP ("input-method-previous-message",
12204 Vinput_method_previous_message
,
12205 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12206 This variable exists because `read-event' clears the echo area
12207 before running the input method. It is nil if there was no message. */);
12208 Vinput_method_previous_message
= Qnil
;
12210 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12211 doc
: /* If non-nil, the function that implements the display of help.
12212 It's called with one argument, the help string to display. */);
12213 Vshow_help_function
= Qnil
;
12215 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12216 doc
: /* If non-nil, suppress point adjustment after executing a command.
12218 After a command is executed, if point is moved into a region that has
12219 special properties (e.g. composition, display), we adjust point to
12220 the boundary of the region. But, when a command sets this variable to
12221 non-nil, we suppress the point adjustment.
12223 This variable is set to nil before reading a command, and is checked
12224 just after executing the command. */);
12225 Vdisable_point_adjustment
= Qnil
;
12227 DEFVAR_LISP ("global-disable-point-adjustment",
12228 Vglobal_disable_point_adjustment
,
12229 doc
: /* *If non-nil, always suppress point adjustment.
12231 The default value is nil, in which case, point adjustment are
12232 suppressed only after special commands that set
12233 `disable-point-adjustment' (which see) to non-nil. */);
12234 Vglobal_disable_point_adjustment
= Qnil
;
12236 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12237 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12238 If the value is not a number, such messages don't time out. */);
12239 Vminibuffer_message_timeout
= make_number (2);
12241 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12242 doc
: /* If non-nil, any keyboard input throws to this symbol.
12243 The value of that variable is passed to `quit-flag' and later causes a
12244 peculiar kind of quitting. */);
12245 Vthrow_on_input
= Qnil
;
12247 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12248 doc
: /* If non-nil, function to output error messages.
12249 The arguments are the error data, a list of the form
12250 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12251 such as just as `condition-case' would bind its variable to,
12252 the context (a string which normally goes at the start of the message),
12253 and the Lisp function within which the error was signaled. */);
12254 Vcommand_error_function
= Qnil
;
12256 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12257 Venable_disabled_menus_and_buttons
,
12258 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12260 Help functions bind this to allow help on disabled menu items
12261 and tool-bar buttons. */);
12262 Venable_disabled_menus_and_buttons
= Qnil
;
12264 DEFVAR_LISP ("select-active-regions",
12265 Vselect_active_regions
,
12266 doc
: /* If non-nil, an active region automatically sets the primary selection.
12267 If the value is `only', only temporarily active regions (usually made
12268 by mouse-dragging or shift-selection) set the window selection.
12270 This takes effect only when Transient Mark mode is enabled. */);
12271 Vselect_active_regions
= Qt
;
12273 DEFVAR_LISP ("saved-region-selection",
12274 Vsaved_region_selection
,
12275 doc
: /* Contents of active region prior to buffer modification.
12276 If `select-active-regions' is non-nil, Emacs sets this to the
12277 text in the region before modifying the buffer. The next
12278 `deactivate-mark' call uses this to set the window selection. */);
12279 Vsaved_region_selection
= Qnil
;
12281 DEFVAR_LISP ("debug-on-event",
12283 doc
: /* Enter debugger on this event. When Emacs
12284 receives the special event specified by this variable, it will try to
12285 break into the debugger as soon as possible instead of processing the
12286 event normally through `special-event-map'.
12288 Currently, the only supported values for this
12289 variable are `sigusr1' and `sigusr2'. */);
12290 Vdebug_on_event
= intern_c_string ("sigusr2");
12292 /* Create the initial keyboard. */
12293 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12294 init_kboard (initial_kboard
);
12295 /* Vwindow_system is left at t for now. */
12296 initial_kboard
->next_kboard
= all_kboards
;
12297 all_kboards
= initial_kboard
;
12301 keys_of_keyboard (void)
12303 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12304 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12305 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12306 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12307 initial_define_key (meta_map
, 'x', "execute-extended-command");
12309 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12310 "handle-delete-frame");
12311 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12312 "ns-put-working-text");
12313 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12314 "ns-unput-working-text");
12315 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12316 current-prefix-arg, as is done in `handle-switch-frame'.
12317 But `handle-switch-frame is not run from the special-map.
12318 Commands from that map are run in a special way that automatically
12319 preserves the prefix-arg. Restoring the prefix arg here is not just
12320 redundant but harmful:
12322 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12323 - after the first prompt, the exit-minibuffer-hook is run which may
12324 iconify a frame and thus push a `iconify-frame' event.
12325 - after running exit-minibuffer-hook, current-prefix-arg is
12326 restored to the non-nil value it had before the prompt.
12327 - we enter the second prompt.
12328 current-prefix-arg is non-nil, prefix-arg is nil.
12329 - before running the first real event, we run the special iconify-frame
12330 event, but we pass the `special' arg to execute-command so
12331 current-prefix-arg and prefix-arg are left untouched.
12332 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12333 - the next key event will have a spuriously non-nil current-prefix-arg. */
12334 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12336 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12338 /* Handling it at such a low-level causes read_key_sequence to get
12339 * confused because it doesn't realize that the current_buffer was
12340 * changed by read_char.
12342 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12343 * "handle-select-window"); */
12344 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12345 "handle-save-session");
12348 /* Define a special event which is raised for dbus callback
12350 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12351 "dbus-handle-event");
12354 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12358 /* Mark the pointers in the kboard objects.
12359 Called by the Fgarbage_collector. */
12361 mark_kboards (void)
12365 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12367 if (kb
->kbd_macro_buffer
)
12368 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12370 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12371 mark_object (KVAR (kb
, Vlast_command
));
12372 mark_object (KVAR (kb
, Vreal_last_command
));
12373 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12374 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12375 mark_object (KVAR (kb
, Vprefix_arg
));
12376 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12377 mark_object (KVAR (kb
, kbd_queue
));
12378 mark_object (KVAR (kb
, defining_kbd_macro
));
12379 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12380 mark_object (KVAR (kb
, Vsystem_key_alist
));
12381 mark_object (KVAR (kb
, system_key_syms
));
12382 mark_object (KVAR (kb
, Vwindow_system
));
12383 mark_object (KVAR (kb
, Vinput_decode_map
));
12384 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12385 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12386 mark_object (KVAR (kb
, echo_string
));
12389 struct input_event
*event
;
12390 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12392 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12393 event
= kbd_buffer
;
12394 if (event
->kind
!= SELECTION_REQUEST_EVENT
12395 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12397 mark_object (event
->x
);
12398 mark_object (event
->y
);
12400 mark_object (event
->frame_or_window
);
12401 mark_object (event
->arg
);