1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
47 #ifdef HAVE_GTK_AND_PTHREAD
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
100 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
101 static int single_kboard
;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled
;
106 static Lisp_Object Qdisabled_command_function
;
108 #define NUM_RECENT_KEYS (300)
110 /* Index for storing next element into recent_keys. */
111 static int recent_keys_index
;
113 /* Total number of elements stored into recent_keys. */
114 static int total_keys
;
116 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
117 static Lisp_Object recent_keys
;
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 int this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 static int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 static Lisp_Object raw_keybuf
;
134 static int raw_keybuf_count
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == 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 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
;
256 static Lisp_Object Qinput_method_function
;
258 static Lisp_Object Qdeactivate_mark
;
260 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
262 static Lisp_Object Qecho_area_clear_hook
;
264 /* Hooks to run before and after each command. */
265 static Lisp_Object Qpre_command_hook
;
266 static Lisp_Object Qpost_command_hook
;
268 static Lisp_Object Qdeferred_action_function
;
270 static Lisp_Object Qdelayed_warnings_hook
;
272 static Lisp_Object Qinput_method_exit_on_first_char
;
273 static Lisp_Object Qinput_method_use_echo_area
;
275 static Lisp_Object Qhelp_form_show
;
277 /* File in which we write all commands we read. */
278 static FILE *dribble
;
280 /* Nonzero if input is available. */
283 /* Circular buffer for pre-read keyboard input. */
285 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
287 /* Pointer to next available character in kbd_buffer.
288 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
289 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
290 next available char is in kbd_buffer[0]. */
291 static struct input_event
*kbd_fetch_ptr
;
293 /* Pointer to next place to store character in kbd_buffer. This
294 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
295 character should go in kbd_buffer[0]. */
296 static struct input_event
* volatile kbd_store_ptr
;
298 /* The above pair of variables forms a "queue empty" flag. When we
299 enqueue a non-hook event, we increment kbd_store_ptr. When we
300 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
301 there is input available if the two pointers are not equal.
303 Why not just have a flag set and cleared by the enqueuing and
304 dequeuing functions? Such a flag could be screwed up by interrupts
305 at inopportune times. */
307 /* Symbols to head events. */
308 static Lisp_Object Qmouse_movement
;
309 static Lisp_Object Qscroll_bar_movement
;
310 Lisp_Object Qswitch_frame
;
311 static Lisp_Object Qdelete_frame
;
312 static Lisp_Object Qiconify_frame
;
313 static Lisp_Object Qmake_frame_visible
;
314 static Lisp_Object Qselect_window
;
315 Lisp_Object Qhelp_echo
;
317 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
318 static Lisp_Object Qmouse_fixup_help_message
;
321 /* Symbols to denote kinds of events. */
322 static Lisp_Object Qfunction_key
;
323 Lisp_Object Qmouse_click
;
324 #if defined (WINDOWSNT)
325 Lisp_Object Qlanguage_change
;
327 static Lisp_Object Qdrag_n_drop
;
328 static Lisp_Object Qsave_session
;
330 static Lisp_Object Qdbus_event
;
332 static Lisp_Object Qconfig_changed_event
;
334 /* Lisp_Object Qmouse_movement; - also an event header */
336 /* Properties of event headers. */
337 Lisp_Object Qevent_kind
;
338 static Lisp_Object Qevent_symbol_elements
;
340 /* menu and tool bar item parts */
341 static Lisp_Object Qmenu_enable
;
342 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
343 Lisp_Object QCfilter
;
345 /* Non-nil disable property on a command means
346 do not execute it; call disabled-command-function's value instead. */
347 Lisp_Object QCtoggle
, QCradio
;
348 static Lisp_Object QCbutton
, QClabel
;
350 static Lisp_Object QCvert_only
;
352 /* An event header symbol HEAD may have a property named
353 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
354 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
355 mask of modifiers applied to it. If present, this is used to help
356 speed up parse_modifiers. */
357 Lisp_Object Qevent_symbol_element_mask
;
359 /* An unmodified event header BASE may have a property named
360 Qmodifier_cache, which is an alist mapping modifier masks onto
361 modified versions of BASE. If present, this helps speed up
363 static Lisp_Object Qmodifier_cache
;
365 /* Symbols to use for parts of windows. */
366 Lisp_Object Qmode_line
;
367 Lisp_Object Qvertical_line
;
368 static Lisp_Object Qvertical_scroll_bar
;
369 Lisp_Object Qmenu_bar
;
371 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
372 static Lisp_Object
command_loop (void);
373 static Lisp_Object Qextended_command_history
;
374 EMACS_TIME
timer_check (void);
376 static void record_menu_key (Lisp_Object c
);
377 static void echo_now (void);
378 static int echo_length (void);
380 static Lisp_Object Qpolling_period
;
382 /* Incremented whenever a timer is run. */
385 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
387 EMACS_TIME
*input_available_clear_time
;
389 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
390 Default is 1 if INTERRUPT_INPUT is defined. */
393 /* Nonzero while interrupts are temporarily deferred during redisplay. */
394 int interrupts_deferred
;
396 /* Allow m- file to inhibit use of FIONREAD. */
397 #ifdef BROKEN_FIONREAD
401 /* We are unable to use interrupts if FIONREAD is not available,
402 so flush SIGIO so we won't try. */
403 #if !defined (FIONREAD)
409 /* If we support a window system, turn on the code to poll periodically
410 to detect C-g. It isn't actually used when doing interrupt input. */
411 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
412 #define POLL_FOR_INPUT
415 /* The time when Emacs started being idle. */
417 static EMACS_TIME timer_idleness_start_time
;
419 /* After Emacs stops being idle, this saves the last value
420 of timer_idleness_start_time from when it was idle. */
422 static EMACS_TIME timer_last_idleness_start_time
;
425 /* Global variable declarations. */
427 /* Flags for readable_events. */
428 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
429 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
430 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
432 /* Function for init_keyboard to call with no args (if nonzero). */
433 static void (*keyboard_init_hook
) (void);
435 static int read_avail_input (int);
436 static void get_input_pending (int *, int);
437 static int readable_events (int);
438 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
440 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
442 static Lisp_Object
make_lispy_event (struct input_event
*);
443 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
444 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
445 enum scroll_bar_part
,
446 Lisp_Object
, Lisp_Object
,
449 static Lisp_Object
modify_event_symbol (EMACS_INT
, unsigned, Lisp_Object
,
450 Lisp_Object
, const char *const *,
451 Lisp_Object
*, EMACS_INT
);
452 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
453 static int help_char_p (Lisp_Object
);
454 static void save_getcjmp (jmp_buf);
455 static void restore_getcjmp (jmp_buf);
456 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
457 static void clear_event (struct input_event
*);
458 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
459 static void interrupt_signal (int signalnum
);
461 static void input_available_signal (int signo
);
463 static Lisp_Object (Fcommand_execute
) (Lisp_Object
, Lisp_Object
, Lisp_Object
,
465 static void handle_interrupt (void);
466 static void quit_throw_to_read_char (void) NO_RETURN
;
467 static void timer_start_idle (void);
468 static void timer_stop_idle (void);
469 static void timer_resume_idle (void);
470 static void handle_user_signal (int);
471 static char *find_user_signal_name (int);
472 static int store_user_signal_events (void);
475 /* Add C to the echo string, if echoing is going on.
476 C can be a character, which is printed prettily ("M-C-x" and all that
477 jazz), or a symbol, whose name is printed. */
480 echo_char (Lisp_Object c
)
482 if (current_kboard
->immediate_echo
)
484 int size
= KEY_DESCRIPTION_SIZE
+ 100;
485 char *buffer
= (char *) alloca (size
);
487 Lisp_Object echo_string
;
489 echo_string
= KVAR (current_kboard
, echo_string
);
491 /* If someone has passed us a composite event, use its head symbol. */
496 ptr
= push_key_description (XINT (c
), ptr
, 1);
498 else if (SYMBOLP (c
))
500 Lisp_Object name
= SYMBOL_NAME (c
);
501 int nbytes
= SBYTES (name
);
503 if (size
- (ptr
- buffer
) < nbytes
)
505 int offset
= ptr
- buffer
;
506 size
= max (2 * size
, size
+ nbytes
);
507 buffer
= (char *) alloca (size
);
508 ptr
= buffer
+ offset
;
511 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
512 STRING_MULTIBYTE (name
), 1);
515 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
518 const char *text
= " (Type ? for further options)";
519 int len
= strlen (text
);
521 if (size
- (ptr
- buffer
) < len
)
523 int offset
= ptr
- buffer
;
525 buffer
= (char *) alloca (size
);
526 ptr
= buffer
+ offset
;
529 memcpy (ptr
, text
, len
);
533 /* Replace a dash from echo_dash with a space, otherwise
534 add a space at the end as a separator between keys. */
535 if (STRINGP (echo_string
)
536 && SCHARS (echo_string
) > 1)
538 Lisp_Object last_char
, prev_char
, idx
;
540 idx
= make_number (SCHARS (echo_string
) - 2);
541 prev_char
= Faref (echo_string
, idx
);
543 idx
= make_number (SCHARS (echo_string
) - 1);
544 last_char
= Faref (echo_string
, idx
);
546 /* We test PREV_CHAR to make sure this isn't the echoing
548 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
549 Faset (echo_string
, idx
, make_number (' '));
551 echo_string
= concat2 (echo_string
, build_string (" "));
553 else if (STRINGP (echo_string
))
554 echo_string
= concat2 (echo_string
, build_string (" "));
556 KVAR (current_kboard
, echo_string
)
557 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
563 /* Temporarily add a dash to the end of the echo string if it's not
564 empty, so that it serves as a mini-prompt for the very next character. */
569 /* Do nothing if not echoing at all. */
570 if (NILP (KVAR (current_kboard
, echo_string
)))
573 if (this_command_key_count
== 0)
576 if (!current_kboard
->immediate_echo
577 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
580 /* Do nothing if we just printed a prompt. */
581 if (current_kboard
->echo_after_prompt
582 == SCHARS (KVAR (current_kboard
, echo_string
)))
585 /* Do nothing if we have already put a dash at the end. */
586 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
588 Lisp_Object last_char
, prev_char
, idx
;
590 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
591 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
593 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
594 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
596 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
600 /* Put a dash at the end of the buffer temporarily,
601 but make it go away when the next character is added. */
602 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
607 /* Display the current echo string, and begin echoing if not already
613 if (!current_kboard
->immediate_echo
)
616 current_kboard
->immediate_echo
= 1;
618 for (i
= 0; i
< this_command_key_count
; i
++)
622 /* Set before_command_echo_length to the value that would
623 have been saved before the start of this subcommand in
624 command_loop_1, if we had already been echoing then. */
625 if (i
== this_single_command_key_start
)
626 before_command_echo_length
= echo_length ();
628 c
= XVECTOR (this_command_keys
)->contents
[i
];
629 if (! (EVENT_HAS_PARAMETERS (c
)
630 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
634 /* Set before_command_echo_length to the value that would
635 have been saved before the start of this subcommand in
636 command_loop_1, if we had already been echoing then. */
637 if (this_command_key_count
== this_single_command_key_start
)
638 before_command_echo_length
= echo_length ();
640 /* Put a dash at the end to invite the user to type more. */
645 message3_nolog (KVAR (current_kboard
, echo_string
),
646 SBYTES (KVAR (current_kboard
, echo_string
)),
647 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
650 /* Record in what buffer we echoed, and from which kboard. */
651 echo_message_buffer
= echo_area_buffer
[0];
652 echo_kboard
= current_kboard
;
654 if (waiting_for_input
&& !NILP (Vquit_flag
))
655 quit_throw_to_read_char ();
658 /* Turn off echoing, for the start of a new command. */
661 cancel_echoing (void)
663 current_kboard
->immediate_echo
= 0;
664 current_kboard
->echo_after_prompt
= -1;
665 KVAR (current_kboard
, echo_string
) = Qnil
;
666 ok_to_echo_at_next_pause
= NULL
;
668 echo_message_buffer
= Qnil
;
671 /* Return the length of the current echo string. */
676 return (STRINGP (KVAR (current_kboard
, echo_string
))
677 ? SCHARS (KVAR (current_kboard
, echo_string
))
681 /* Truncate the current echo message to its first LEN chars.
682 This and echo_char get used by read_key_sequence when the user
683 switches frames while entering a key sequence. */
686 echo_truncate (EMACS_INT nchars
)
688 if (STRINGP (KVAR (current_kboard
, echo_string
)))
689 KVAR (current_kboard
, echo_string
)
690 = Fsubstring (KVAR (current_kboard
, echo_string
),
691 make_number (0), make_number (nchars
));
692 truncate_echo_area (nchars
);
696 /* Functions for manipulating this_command_keys. */
698 add_command_key (Lisp_Object key
)
700 #if 0 /* Not needed after we made Freset_this_command_lengths
701 do the job immediately. */
702 /* If reset-this-command-length was called recently, obey it now.
703 See the doc string of that function for an explanation of why. */
704 if (before_command_restore_flag
)
706 this_command_key_count
= before_command_key_count_1
;
707 if (this_command_key_count
< this_single_command_key_start
)
708 this_single_command_key_start
= this_command_key_count
;
709 echo_truncate (before_command_echo_length_1
);
710 before_command_restore_flag
= 0;
714 if (this_command_key_count
>= ASIZE (this_command_keys
))
715 this_command_keys
= larger_vector (this_command_keys
,
716 2 * ASIZE (this_command_keys
),
719 ASET (this_command_keys
, this_command_key_count
, key
);
720 ++this_command_key_count
;
725 recursive_edit_1 (void)
727 int count
= SPECPDL_INDEX ();
730 if (command_loop_level
> 0)
732 specbind (Qstandard_output
, Qt
);
733 specbind (Qstandard_input
, Qt
);
736 #ifdef HAVE_WINDOW_SYSTEM
737 /* The command loop has started an hourglass timer, so we have to
738 cancel it here, otherwise it will fire because the recursive edit
739 can take some time. Do not check for display_hourglass_p here,
740 because it could already be nil. */
744 /* This function may have been called from a debugger called from
745 within redisplay, for instance by Edebugging a function called
746 from fontification-functions. We want to allow redisplay in
747 the debugging session.
749 The recursive edit is left with a `(throw exit ...)'. The `exit'
750 tag is not caught anywhere in redisplay, i.e. when we leave the
751 recursive edit, the original redisplay leading to the recursive
752 edit will be unwound. The outcome should therefore be safe. */
753 specbind (Qinhibit_redisplay
, Qnil
);
756 val
= command_loop ();
758 Fsignal (Qquit
, Qnil
);
759 /* Handle throw from read_minibuf when using minibuffer
760 while it's active but we're in another window. */
762 xsignal1 (Qerror
, val
);
764 return unbind_to (count
, Qnil
);
767 /* When an auto-save happens, record the "time", and don't do again soon. */
770 record_auto_save (void)
772 last_auto_save
= num_nonmacro_input_events
;
775 /* Make an auto save happen as soon as possible at command level. */
779 force_auto_save_soon (void)
781 last_auto_save
= - auto_save_interval
- 1;
783 record_asynch_buffer_change ();
787 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
788 doc
: /* Invoke the editor command loop recursively.
789 To get out of the recursive edit, a command can do `(throw 'exit nil)';
790 that tells this function to return.
791 Alternatively, `(throw 'exit t)' makes this function signal an error.
792 This function is called by the editor initialization to begin editing. */)
795 int count
= SPECPDL_INDEX ();
798 /* If we enter while input is blocked, don't lock up here.
799 This may happen through the debugger during redisplay. */
803 command_loop_level
++;
804 update_mode_lines
= 1;
806 if (command_loop_level
807 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
808 buffer
= Fcurrent_buffer ();
812 /* If we leave recursive_edit_1 below with a `throw' for instance,
813 like it is done in the splash screen display, we have to
814 make sure that we restore single_kboard as command_loop_1
815 would have done if it were left normally. */
816 if (command_loop_level
> 0)
817 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
818 record_unwind_protect (recursive_edit_unwind
, buffer
);
821 return unbind_to (count
, Qnil
);
825 recursive_edit_unwind (Lisp_Object buffer
)
827 if (BUFFERP (buffer
))
828 Fset_buffer (buffer
);
830 command_loop_level
--;
831 update_mode_lines
= 1;
836 #if 0 /* These two functions are now replaced with
837 temporarily_switch_to_single_kboard. */
841 #if 0 /* Theory: if there's anything in Vunread_command_events,
842 it will right away be read by read_key_sequence,
843 and then if we do switch KBOARDS, it will go into the side
844 queue then. So we don't need to do anything special here -- rms. */
845 if (CONSP (Vunread_command_events
))
847 current_kboard
->kbd_queue
848 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
849 current_kboard
->kbd_queue_has_data
= 1;
851 Vunread_command_events
= Qnil
;
856 /* Switch to the single-kboard state, making current_kboard
857 the only KBOARD from which further input is accepted. */
860 single_kboard_state ()
866 /* If we're in single_kboard state for kboard KBOARD,
870 not_single_kboard_state (KBOARD
*kboard
)
872 if (kboard
== current_kboard
)
876 /* Maintain a stack of kboards, so other parts of Emacs
877 can switch temporarily to the kboard of a given frame
878 and then revert to the previous status. */
883 struct kboard_stack
*next
;
886 static struct kboard_stack
*kboard_stack
;
889 push_kboard (struct kboard
*k
)
891 struct kboard_stack
*p
892 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
894 p
->next
= kboard_stack
;
895 p
->kboard
= current_kboard
;
905 struct kboard_stack
*p
= kboard_stack
;
907 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
909 if (t
->kboard
== p
->kboard
)
911 current_kboard
= p
->kboard
;
918 /* The terminal we remembered has been deleted. */
919 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
922 kboard_stack
= p
->next
;
926 /* Switch to single_kboard mode, making current_kboard the only KBOARD
927 from which further input is accepted. If F is non-nil, set its
928 KBOARD as the current keyboard.
930 This function uses record_unwind_protect to return to the previous
933 If Emacs is already in single_kboard mode, and F's keyboard is
934 locked, then this function will throw an errow. */
937 temporarily_switch_to_single_kboard (struct frame
*f
)
939 int was_locked
= single_kboard
;
942 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
943 /* We can not switch keyboards while in single_kboard mode.
944 In rare cases, Lisp code may call `recursive-edit' (or
945 `read-minibuffer' or `y-or-n-p') after it switched to a
946 locked frame. For example, this is likely to happen
947 when server.el connects to a new terminal while Emacs is in
948 single_kboard mode. It is best to throw an error instead
949 of presenting the user with a frozen screen. */
950 error ("Terminal %d is locked, cannot read from it",
951 FRAME_TERMINAL (f
)->id
);
953 /* This call is unnecessary, but helps
954 `restore_kboard_configuration' discover if somebody changed
955 `current_kboard' behind our back. */
956 push_kboard (current_kboard
);
959 current_kboard
= FRAME_KBOARD (f
);
961 record_unwind_protect (restore_kboard_configuration
,
962 (was_locked
? Qt
: Qnil
));
965 #if 0 /* This function is not needed anymore. */
967 record_single_kboard_state ()
970 push_kboard (current_kboard
);
971 record_unwind_protect (restore_kboard_configuration
,
972 (single_kboard
? Qt
: Qnil
));
977 restore_kboard_configuration (Lisp_Object was_locked
)
979 if (NILP (was_locked
))
983 struct kboard
*prev
= current_kboard
;
986 /* The pop should not change the kboard. */
987 if (single_kboard
&& current_kboard
!= prev
)
994 /* Handle errors that are not handled at inner levels
995 by printing an error message and returning to the editor command loop. */
998 cmd_error (Lisp_Object data
)
1000 Lisp_Object old_level
, old_length
;
1001 char macroerror
[50];
1003 #ifdef HAVE_WINDOW_SYSTEM
1004 if (display_hourglass_p
)
1005 cancel_hourglass ();
1008 if (!NILP (executing_kbd_macro
))
1010 if (executing_kbd_macro_iterations
== 1)
1011 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1013 sprintf (macroerror
, "After %d kbd macro iterations: ",
1014 executing_kbd_macro_iterations
);
1019 Vstandard_output
= Qt
;
1020 Vstandard_input
= Qt
;
1021 Vexecuting_kbd_macro
= Qnil
;
1022 executing_kbd_macro
= Qnil
;
1023 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1024 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1027 /* Avoid unquittable loop if data contains a circular list. */
1028 old_level
= Vprint_level
;
1029 old_length
= Vprint_length
;
1030 XSETFASTINT (Vprint_level
, 10);
1031 XSETFASTINT (Vprint_length
, 10);
1032 cmd_error_internal (data
, macroerror
);
1033 Vprint_level
= old_level
;
1034 Vprint_length
= old_length
;
1038 Vinhibit_quit
= Qnil
;
1039 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1040 if (command_loop_level
== 0 && minibuf_level
== 0)
1041 any_kboard_state ();
1044 return make_number (0);
1047 /* Take actions on handling an error. DATA is the data that describes
1050 CONTEXT is a C-string containing ASCII characters only which
1051 describes the context in which the error happened. If we need to
1052 generalize CONTEXT to allow multibyte characters, make it a Lisp
1056 cmd_error_internal (Lisp_Object data
, const char *context
)
1058 struct frame
*sf
= SELECTED_FRAME ();
1060 /* The immediate context is not interesting for Quits,
1061 since they are asyncronous. */
1062 if (EQ (XCAR (data
), Qquit
))
1063 Vsignaling_function
= Qnil
;
1068 /* Use user's specified output function if any. */
1069 if (!NILP (Vcommand_error_function
))
1070 call3 (Vcommand_error_function
, data
,
1071 context
? build_string (context
) : empty_unibyte_string
,
1072 Vsignaling_function
);
1073 /* If the window system or terminal frame hasn't been initialized
1074 yet, or we're not interactive, write the message to stderr and exit. */
1075 else if (!sf
->glyphs_initialized_p
1076 /* The initial frame is a special non-displaying frame. It
1077 will be current in daemon mode when there are no frames
1078 to display, and in non-daemon mode before the real frame
1079 has finished initializing. If an error is thrown in the
1080 latter case while creating the frame, then the frame
1081 will never be displayed, so the safest thing to do is
1082 write to stderr and quit. In daemon mode, there are
1083 many other potential errors that do not prevent frames
1084 from being created, so continuing as normal is better in
1086 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1089 print_error_message (data
, Qexternal_debugging_output
,
1090 context
, Vsignaling_function
);
1091 Fterpri (Qexternal_debugging_output
);
1092 Fkill_emacs (make_number (-1));
1096 clear_message (1, 0);
1098 message_log_maybe_newline ();
1101 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1104 Vsignaling_function
= Qnil
;
1107 Lisp_Object
command_loop_1 (void);
1108 static Lisp_Object
command_loop_2 (Lisp_Object
);
1109 static Lisp_Object
top_level_1 (Lisp_Object
);
1111 /* Entry to editor-command-loop.
1112 This level has the catches for exiting/returning to editor command loop.
1113 It returns nil to exit recursive edit, t to abort it. */
1118 if (command_loop_level
> 0 || minibuf_level
> 0)
1121 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1122 executing_kbd_macro
= Qnil
;
1128 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1129 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1130 /* Reset single_kboard in case top-level set it while
1131 evaluating an -f option, or we are stuck there for some
1133 any_kboard_state ();
1135 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1136 executing_kbd_macro
= Qnil
;
1138 /* End of file in -batch run causes exit here. */
1144 /* Here we catch errors in execution of commands within the
1145 editing loop, and reenter the editing loop.
1146 When there is an error, cmd_error runs and returns a non-nil
1147 value to us. A value of nil means that command_loop_1 itself
1148 returned due to end of file (or end of kbd macro). */
1151 command_loop_2 (Lisp_Object ignore
)
1153 register Lisp_Object val
;
1156 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1157 while (!NILP (val
));
1165 return Feval (Vtop_level
, Qnil
);
1169 top_level_1 (Lisp_Object ignore
)
1171 /* On entry to the outer level, run the startup file */
1172 if (!NILP (Vtop_level
))
1173 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1174 else if (!NILP (Vpurify_flag
))
1175 message ("Bare impure Emacs (standard Lisp code not loaded)");
1177 message ("Bare Emacs (standard Lisp code not loaded)");
1181 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1182 doc
: /* Exit all recursive editing levels.
1183 This also exits all active minibuffers. */)
1186 #ifdef HAVE_WINDOW_SYSTEM
1187 if (display_hourglass_p
)
1188 cancel_hourglass ();
1191 /* Unblock input if we enter with input blocked. This may happen if
1192 redisplay traps e.g. during tool-bar update with input blocked. */
1193 while (INPUT_BLOCKED_P
)
1196 Fthrow (Qtop_level
, Qnil
);
1199 static Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1200 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1201 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1204 if (command_loop_level
> 0 || minibuf_level
> 0)
1205 Fthrow (Qexit
, Qnil
);
1207 error ("No recursive edit is in progress");
1210 static Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1211 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1212 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1215 if (command_loop_level
> 0 || minibuf_level
> 0)
1218 error ("No recursive edit is in progress");
1221 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1223 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1224 of this function. */
1227 tracking_off (Lisp_Object old_value
)
1229 do_mouse_tracking
= old_value
;
1230 if (NILP (old_value
))
1232 /* Redisplay may have been preempted because there was input
1233 available, and it assumes it will be called again after the
1234 input has been processed. If the only input available was
1235 the sort that we have just disabled, then we need to call
1237 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1239 redisplay_preserve_echo_area (6);
1240 get_input_pending (&input_pending
,
1241 READABLE_EVENTS_DO_TIMERS_NOW
);
1247 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1248 doc
: /* Evaluate BODY with mouse movement events enabled.
1249 Within a `track-mouse' form, mouse motion generates input events that
1250 you can read with `read-event'.
1251 Normally, mouse motion is ignored.
1252 usage: (track-mouse BODY...) */)
1255 int count
= SPECPDL_INDEX ();
1258 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1260 do_mouse_tracking
= Qt
;
1262 val
= Fprogn (args
);
1263 return unbind_to (count
, val
);
1266 /* If mouse has moved on some frame, return one of those frames.
1270 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1271 after resizing the tool-bar window. */
1273 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1276 int ignore_mouse_drag_p
;
1279 some_mouse_moved (void)
1281 Lisp_Object tail
, frame
;
1283 if (ignore_mouse_drag_p
)
1285 /* ignore_mouse_drag_p = 0; */
1289 FOR_EACH_FRAME (tail
, frame
)
1291 if (XFRAME (frame
)->mouse_moved
)
1292 return XFRAME (frame
);
1298 #endif /* HAVE_MOUSE || HAVE_GPM */
1300 /* This is the actual command reading loop,
1301 sans error-handling encapsulation. */
1303 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1305 void safe_run_hooks (Lisp_Object
);
1306 static void adjust_point_for_property (EMACS_INT
, int);
1308 /* Cancel hourglass from protect_unwind.
1310 #ifdef HAVE_WINDOW_SYSTEM
1312 cancel_hourglass_unwind (Lisp_Object arg
)
1314 cancel_hourglass ();
1319 /* FIXME: This is wrong rather than test window-system, we should call
1320 a new set-selection, which will then dispatch to x-set-selection, or
1321 tty-set-selection, or w32-set-selection, ... */
1322 EXFUN (Fwindow_system
, 1);
1325 command_loop_1 (void)
1328 Lisp_Object keybuf
[30];
1330 int prev_modiff
= 0;
1331 struct buffer
*prev_buffer
= NULL
;
1332 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1333 int was_locked
= single_kboard
;
1335 int already_adjusted
= 0;
1337 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1338 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1339 Vdeactivate_mark
= Qnil
;
1340 waiting_for_input
= 0;
1343 this_command_key_count
= 0;
1344 this_command_key_count_reset
= 0;
1345 this_single_command_key_start
= 0;
1347 if (NILP (Vmemory_full
))
1349 /* Make sure this hook runs after commands that get errors and
1350 throw to top level. */
1351 /* Note that the value cell will never directly contain nil
1352 if the symbol is a local variable. */
1353 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1354 safe_run_hooks (Qpost_command_hook
);
1356 /* If displaying a message, resize the echo area window to fit
1357 that message's size exactly. */
1358 if (!NILP (echo_area_buffer
[0]))
1359 resize_echo_area_exactly ();
1361 /* If there are warnings waiting, process them. */
1362 if (!NILP (Vdelayed_warnings_list
))
1363 safe_run_hooks (Qdelayed_warnings_hook
);
1365 if (!NILP (Vdeferred_action_list
))
1366 safe_run_hooks (Qdeferred_action_function
);
1369 /* Do this after running Vpost_command_hook, for consistency. */
1370 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1371 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1372 if (!CONSP (last_command_event
))
1373 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1377 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1380 /* Make sure the current window's buffer is selected. */
1381 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1382 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1384 /* Display any malloc warning that just came out. Use while because
1385 displaying one warning can cause another. */
1387 while (pending_malloc_warning
)
1388 display_malloc_warning ();
1390 Vdeactivate_mark
= Qnil
;
1392 /* If minibuffer on and echo area in use,
1393 wait a short time and redraw minibuffer. */
1396 && !NILP (echo_area_buffer
[0])
1397 && EQ (minibuf_window
, echo_area_window
)
1398 && NUMBERP (Vminibuffer_message_timeout
))
1400 /* Bind inhibit-quit to t so that C-g gets read in
1401 rather than quitting back to the minibuffer. */
1402 int count
= SPECPDL_INDEX ();
1403 specbind (Qinhibit_quit
, Qt
);
1405 sit_for (Vminibuffer_message_timeout
, 0, 2);
1407 /* Clear the echo area. */
1409 safe_run_hooks (Qecho_area_clear_hook
);
1411 unbind_to (count
, Qnil
);
1413 /* If a C-g came in before, treat it as input now. */
1414 if (!NILP (Vquit_flag
))
1417 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1422 /* Select the frame that the last event came from. Usually,
1423 switch-frame events will take care of this, but if some lisp
1424 code swallows a switch-frame event, we'll fix things up here.
1425 Is this a good idea? */
1426 if (FRAMEP (internal_last_event_frame
)
1427 && !EQ (internal_last_event_frame
, selected_frame
))
1428 Fselect_frame (internal_last_event_frame
, Qnil
);
1430 /* If it has changed current-menubar from previous value,
1431 really recompute the menubar from the value. */
1432 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1433 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1434 call0 (Qrecompute_lucid_menubar
);
1436 before_command_key_count
= this_command_key_count
;
1437 before_command_echo_length
= echo_length ();
1439 Vthis_command
= Qnil
;
1440 real_this_command
= Qnil
;
1441 Vthis_original_command
= Qnil
;
1442 Vthis_command_keys_shift_translated
= Qnil
;
1444 /* Read next key sequence; i gets its length. */
1445 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1448 /* A filter may have run while we were reading the input. */
1449 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1451 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1452 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1456 /* Now we have read a key sequence of length I,
1457 or else I is 0 and we found end of file. */
1459 if (i
== 0) /* End of file -- happens only in */
1460 return Qnil
; /* a kbd macro, at the end. */
1461 /* -1 means read_key_sequence got a menu that was rejected.
1462 Just loop around and read another command. */
1466 this_command_key_count
= 0;
1467 this_command_key_count_reset
= 0;
1468 this_single_command_key_start
= 0;
1472 last_command_event
= keybuf
[i
- 1];
1474 /* If the previous command tried to force a specific window-start,
1475 forget about that, in case this command moves point far away
1476 from that position. But also throw away beg_unchanged and
1477 end_unchanged information in that case, so that redisplay will
1478 update the whole window properly. */
1479 if (!NILP (XWINDOW (selected_window
)->force_start
))
1482 XWINDOW (selected_window
)->force_start
= Qnil
;
1483 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1484 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1487 cmd
= read_key_sequence_cmd
;
1488 if (!NILP (Vexecuting_kbd_macro
))
1490 if (!NILP (Vquit_flag
))
1492 Vexecuting_kbd_macro
= Qt
;
1493 QUIT
; /* Make some noise. */
1494 /* Will return since macro now empty. */
1498 /* Do redisplay processing after this command except in special
1499 cases identified below. */
1500 prev_buffer
= current_buffer
;
1501 prev_modiff
= MODIFF
;
1502 last_point_position
= PT
;
1503 last_point_position_window
= selected_window
;
1504 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1506 /* By default, we adjust point to a boundary of a region that
1507 has such a property that should be treated intangible
1508 (e.g. composition, display). But, some commands will set
1509 this variable differently. */
1510 Vdisable_point_adjustment
= Qnil
;
1512 /* Process filters and timers may have messed with deactivate-mark.
1513 reset it before we execute the command. */
1514 Vdeactivate_mark
= Qnil
;
1516 /* Remap command through active keymaps */
1517 Vthis_original_command
= cmd
;
1521 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1525 /* Execute the command. */
1527 Vthis_command
= cmd
;
1528 real_this_command
= cmd
;
1529 safe_run_hooks (Qpre_command_hook
);
1531 already_adjusted
= 0;
1533 if (NILP (Vthis_command
))
1535 /* nil means key is undefined. */
1536 Lisp_Object keys
= Fvector (i
, keybuf
);
1537 keys
= Fkey_description (keys
, Qnil
);
1539 message_with_string ("%s is undefined", keys
, 0);
1540 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1541 update_mode_lines
= 1;
1542 /* If this is a down-mouse event, don't reset prefix-arg;
1543 pass it to the command run by the up event. */
1544 if (EVENT_HAS_PARAMETERS (last_command_event
))
1546 Lisp_Object breakdown
1547 = parse_modifiers (EVENT_HEAD (last_command_event
));
1548 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1549 if (!(modifiers
& down_modifier
))
1550 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1553 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1557 /* Here for a command that isn't executed directly */
1559 #ifdef HAVE_WINDOW_SYSTEM
1560 int scount
= SPECPDL_INDEX ();
1562 if (display_hourglass_p
1563 && NILP (Vexecuting_kbd_macro
))
1565 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1570 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1572 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1574 #ifdef HAVE_WINDOW_SYSTEM
1575 /* Do not check display_hourglass_p here, because
1576 Fcommand_execute could change it, but we should cancel
1577 hourglass cursor anyway.
1578 But don't cancel the hourglass within a macro
1579 just because a command in the macro finishes. */
1580 if (NILP (Vexecuting_kbd_macro
))
1581 unbind_to (scount
, Qnil
);
1584 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1586 safe_run_hooks (Qpost_command_hook
);
1588 /* If displaying a message, resize the echo area window to fit
1589 that message's size exactly. */
1590 if (!NILP (echo_area_buffer
[0]))
1591 resize_echo_area_exactly ();
1593 /* If there are warnings waiting, process them. */
1594 if (!NILP (Vdelayed_warnings_list
))
1595 safe_run_hooks (Qdelayed_warnings_hook
);
1597 safe_run_hooks (Qdeferred_action_function
);
1599 /* If there is a prefix argument,
1600 1) We don't want Vlast_command to be ``universal-argument''
1601 (that would be dumb), so don't set Vlast_command,
1602 2) we want to leave echoing on so that the prefix will be
1603 echoed as part of this key sequence, so don't call
1605 3) we want to leave this_command_key_count non-zero, so that
1606 read_char will realize that it is re-reading a character, and
1607 not echo it a second time.
1609 If the command didn't actually create a prefix arg,
1610 but is merely a frame event that is transparent to prefix args,
1611 then the above doesn't apply. */
1612 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1614 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1615 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1616 if (!CONSP (last_command_event
))
1617 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1619 this_command_key_count
= 0;
1620 this_command_key_count_reset
= 0;
1621 this_single_command_key_start
= 0;
1624 if (!NILP (BVAR (current_buffer
, mark_active
))
1625 && !NILP (Vrun_hooks
))
1627 /* In Emacs 22, setting transient-mark-mode to `only' was a
1628 way of turning it on for just one command. This usage is
1629 obsolete, but support it anyway. */
1630 if (EQ (Vtransient_mark_mode
, Qidentity
))
1631 Vtransient_mark_mode
= Qnil
;
1632 else if (EQ (Vtransient_mark_mode
, Qonly
))
1633 Vtransient_mark_mode
= Qidentity
;
1635 if (!NILP (Vdeactivate_mark
))
1636 /* If `select-active-regions' is non-nil, this call to
1637 `deactivate-mark' also sets the PRIMARY selection. */
1638 call0 (Qdeactivate_mark
);
1641 /* Even if not deactivating the mark, set PRIMARY if
1642 `select-active-regions' is non-nil. */
1643 if (!NILP (Fwindow_system (Qnil
))
1644 /* Even if mark_active is non-nil, the actual buffer
1645 marker may not have been set yet (Bug#7044). */
1646 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1647 && (EQ (Vselect_active_regions
, Qonly
)
1648 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1649 : (!NILP (Vselect_active_regions
)
1650 && !NILP (Vtransient_mark_mode
)))
1651 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1654 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1657 call2 (Qx_set_selection
, QPRIMARY
,
1658 make_buffer_string (beg
, end
, 0));
1660 call2 (Qx_set_selection
, QPRIMARY
,
1661 make_buffer_string (end
, beg
, 0));
1662 /* Don't set empty selections. */
1665 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1667 Lisp_Object hook
= intern ("activate-mark-hook");
1668 Frun_hooks (1, &hook
);
1672 Vsaved_region_selection
= Qnil
;
1677 if (current_buffer
== prev_buffer
1678 && last_point_position
!= PT
1679 && NILP (Vdisable_point_adjustment
)
1680 && NILP (Vglobal_disable_point_adjustment
))
1682 if (last_point_position
> BEGV
1683 && last_point_position
< ZV
1684 && (composition_adjust_point (last_point_position
,
1685 last_point_position
)
1686 != last_point_position
))
1687 /* The last point was temporarily set within a grapheme
1688 cluster to prevent automatic composition. To recover
1689 the automatic composition, we must update the
1691 windows_or_buffers_changed
++;
1692 if (!already_adjusted
)
1693 adjust_point_for_property (last_point_position
,
1694 MODIFF
!= prev_modiff
);
1697 /* Install chars successfully executed in kbd macro. */
1699 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1700 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1701 finalize_kbd_macro_chars ();
1702 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1704 any_kboard_state ();
1709 /* Adjust point to a boundary of a region that has such a property
1710 that should be treated intangible. For the moment, we check
1711 `composition', `display' and `invisible' properties.
1712 LAST_PT is the last position of point. */
1715 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1718 Lisp_Object val
, overlay
, tmp
;
1719 /* When called after buffer modification, we should temporarily
1720 suppress the point adjustment for automatic composition so that a
1721 user can keep inserting another character at point or keep
1722 deleting characters around point. */
1723 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1724 EMACS_INT orig_pt
= PT
;
1726 /* FIXME: cycling is probably not necessary because these properties
1727 can't be usefully combined anyway. */
1728 while (check_composition
|| check_display
|| check_invisible
)
1730 /* FIXME: check `intangible'. */
1731 if (check_composition
1732 && PT
> BEGV
&& PT
< ZV
1733 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1736 check_display
= check_invisible
= 1;
1738 check_composition
= 0;
1740 && PT
> BEGV
&& PT
< ZV
1741 && !NILP (val
= get_char_property_and_overlay
1742 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1743 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1744 && (!OVERLAYP (overlay
)
1745 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1746 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1747 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1748 && (beg
< PT
/* && end > PT <- It's always the case. */
1749 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1752 SET_PT (PT
< last_pt
1753 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1755 check_composition
= check_invisible
= 1;
1758 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1760 int inv
, ellipsis
= 0;
1763 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1766 /* FIXME: We should stop if we find a spot between
1767 two runs of `invisible' where inserted text would
1768 be visible. This is important when we have two
1769 invisible boundaries that enclose an area: if the
1770 area is empty, we need this test in order to make
1771 it possible to place point in the middle rather
1772 than skip both boundaries. However, this code
1773 also stops anywhere in a non-sticky text-property,
1774 which breaks (e.g.) Org mode. */
1775 && (val
= get_pos_property (make_number (end
),
1777 TEXT_PROP_MEANS_INVISIBLE (val
))
1779 && !NILP (val
= get_char_property_and_overlay
1780 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1781 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1783 ellipsis
= ellipsis
|| inv
> 1
1784 || (OVERLAYP (overlay
)
1785 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1786 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1787 tmp
= Fnext_single_char_property_change
1788 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1789 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1793 && (val
= get_pos_property (make_number (beg
),
1795 TEXT_PROP_MEANS_INVISIBLE (val
))
1797 && !NILP (val
= get_char_property_and_overlay
1798 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1799 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1801 ellipsis
= ellipsis
|| inv
> 1
1802 || (OVERLAYP (overlay
)
1803 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1804 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1805 tmp
= Fprevious_single_char_property_change
1806 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1807 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1810 /* Move away from the inside area. */
1811 if (beg
< PT
&& end
> PT
)
1813 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1814 /* We haven't moved yet (so we don't need to fear
1815 infinite-looping) and we were outside the range
1816 before (so either end of the range still corresponds
1817 to a move in the right direction): pretend we moved
1818 less than we actually did, so that we still have
1819 more freedom below in choosing which end of the range
1821 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1822 /* We either have moved already or the last point
1823 was already in the range: we don't get to choose
1824 which end of the range we have to go to. */
1825 : (PT
< last_pt
? beg
: end
));
1826 check_composition
= check_display
= 1;
1828 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1829 the point to something other than its argument, due to
1830 point-motion hooks, intangibility, etc. */
1831 xassert (PT
== beg
|| PT
== end
);
1834 /* Pretend the area doesn't exist if the buffer is not
1836 if (!modified
&& !ellipsis
&& beg
< end
)
1838 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1839 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1840 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1841 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1842 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1843 /* We've already moved as far as we can. Trying to go
1844 to the other end would mean moving backwards and thus
1845 could lead to an infinite loop. */
1847 else if (val
= get_pos_property (make_number (PT
),
1849 TEXT_PROP_MEANS_INVISIBLE (val
)
1850 && (val
= get_pos_property
1851 (make_number (PT
== beg
? end
: beg
),
1853 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1854 (check_composition
= check_display
= 1,
1855 SET_PT (PT
== beg
? end
: beg
));
1858 check_invisible
= 0;
1862 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1865 safe_run_hooks_1 (void)
1867 eassert (CONSP (Vinhibit_quit
));
1868 return call0 (XCDR (Vinhibit_quit
));
1871 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1875 safe_run_hooks_error (Lisp_Object error_data
)
1878 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1879 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1880 Lisp_Object args
[4];
1881 args
[0] = build_string ("Error in %s (%s): %s");
1884 args
[3] = error_data
;
1890 Lisp_Object newval
= Qnil
;
1891 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1892 if (EQ (fun
, XCAR (val
)))
1895 newval
= Fcons (XCAR (val
), newval
);
1897 return Fset (hook
, Fnreverse (newval
));
1898 /* Not found in the local part of the hook. Let's look at the global
1901 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1902 : Fdefault_value (hook
));
1903 CONSP (val
); val
= XCDR (val
))
1904 if (EQ (fun
, XCAR (val
)))
1907 newval
= Fcons (XCAR (val
), newval
);
1909 return Fset_default (hook
, Fnreverse (newval
));
1915 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1917 eassert (nargs
== 1);
1918 if (CONSP (Vinhibit_quit
))
1919 XSETCDR (Vinhibit_quit
, args
[0]);
1921 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1923 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1927 /* If we get an error while running the hook, cause the hook variable
1928 to be nil. Also inhibit quits, so that C-g won't cause the hook
1929 to mysteriously evaporate. */
1932 safe_run_hooks (Lisp_Object hook
)
1934 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1935 to its body or to its handlers other than via globals such as
1936 dynamically-bound variables ;-) */
1937 int count
= SPECPDL_INDEX ();
1938 specbind (Qinhibit_quit
, hook
);
1940 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1942 unbind_to (count
, Qnil
);
1946 /* Nonzero means polling for input is temporarily suppressed. */
1948 int poll_suppress_count
;
1950 /* Asynchronous timer for polling. */
1952 static struct atimer
*poll_timer
;
1955 #ifdef POLL_FOR_INPUT
1957 /* Poll for input, so that we catch a C-g if it comes in. This
1958 function is called from x_make_frame_visible, see comment
1962 poll_for_input_1 (void)
1964 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1965 doing anything dangerous. */
1969 if (interrupt_input_blocked
== 0
1970 && !waiting_for_input
)
1971 read_avail_input (0);
1977 /* Timer callback function for poll_timer. TIMER is equal to
1981 poll_for_input (struct atimer
*timer
)
1983 if (poll_suppress_count
== 0)
1986 interrupt_input_pending
= 1;
1987 pending_signals
= 1;
1989 poll_for_input_1 ();
1994 #endif /* POLL_FOR_INPUT */
1996 /* Begin signals to poll for input, if they are appropriate.
1997 This function is called unconditionally from various places. */
2000 start_polling (void)
2002 #ifdef POLL_FOR_INPUT
2003 /* XXX This condition was (read_socket_hook && !interrupt_input),
2004 but read_socket_hook is not global anymore. Let's pretend that
2006 if (!interrupt_input
)
2008 /* Turn alarm handling on unconditionally. It might have
2009 been turned off in process.c. */
2010 turn_on_atimers (1);
2012 /* If poll timer doesn't exist, are we need one with
2013 a different interval, start a new one. */
2014 if (poll_timer
== NULL
2015 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2017 EMACS_TIME interval
;
2020 cancel_atimer (poll_timer
);
2022 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2023 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2024 poll_for_input
, NULL
);
2027 /* Let the timer's callback function poll for input
2028 if this becomes zero. */
2029 --poll_suppress_count
;
2034 /* Nonzero if we are using polling to handle input asynchronously. */
2037 input_polling_used (void)
2039 #ifdef POLL_FOR_INPUT
2040 /* XXX This condition was (read_socket_hook && !interrupt_input),
2041 but read_socket_hook is not global anymore. Let's pretend that
2043 return !interrupt_input
;
2049 /* Turn off polling. */
2054 #ifdef POLL_FOR_INPUT
2055 /* XXX This condition was (read_socket_hook && !interrupt_input),
2056 but read_socket_hook is not global anymore. Let's pretend that
2058 if (!interrupt_input
)
2059 ++poll_suppress_count
;
2063 /* Set the value of poll_suppress_count to COUNT
2064 and start or stop polling accordingly. */
2067 set_poll_suppress_count (int count
)
2069 #ifdef POLL_FOR_INPUT
2070 if (count
== 0 && poll_suppress_count
!= 0)
2072 poll_suppress_count
= 1;
2075 else if (count
!= 0 && poll_suppress_count
== 0)
2079 poll_suppress_count
= count
;
2083 /* Bind polling_period to a value at least N.
2084 But don't decrease it. */
2087 bind_polling_period (int n
)
2089 #ifdef POLL_FOR_INPUT
2090 int new = polling_period
;
2095 stop_other_atimers (poll_timer
);
2097 specbind (Qpolling_period
, make_number (new));
2098 /* Start a new alarm with the new period. */
2103 /* Apply the control modifier to CHARACTER. */
2106 make_ctrl_char (int c
)
2108 /* Save the upper bits here. */
2109 int upper
= c
& ~0177;
2111 if (! ASCII_BYTE_P (c
))
2112 return c
|= ctrl_modifier
;
2116 /* Everything in the columns containing the upper-case letters
2117 denotes a control character. */
2118 if (c
>= 0100 && c
< 0140)
2122 /* Set the shift modifier for a control char
2123 made from a shifted letter. But only for letters! */
2124 if (oc
>= 'A' && oc
<= 'Z')
2125 c
|= shift_modifier
;
2128 /* The lower-case letters denote control characters too. */
2129 else if (c
>= 'a' && c
<= 'z')
2132 /* Include the bits for control and shift
2133 only if the basic ASCII code can't indicate them. */
2137 /* Replace the high bits. */
2138 c
|= (upper
& ~ctrl_modifier
);
2143 /* Display the help-echo property of the character after the mouse pointer.
2144 Either show it in the echo area, or call show-help-function to display
2145 it by other means (maybe in a tooltip).
2147 If HELP is nil, that means clear the previous help echo.
2149 If HELP is a string, display that string. If HELP is a function,
2150 call it with OBJECT and POS as arguments; the function should
2151 return a help string or nil for none. For all other types of HELP,
2152 evaluate it to obtain a string.
2154 WINDOW is the window in which the help was generated, if any.
2155 It is nil if not in a window.
2157 If OBJECT is a buffer, POS is the position in the buffer where the
2158 `help-echo' text property was found.
2160 If OBJECT is an overlay, that overlay has a `help-echo' property,
2161 and POS is the position in the overlay's buffer under the mouse.
2163 If OBJECT is a string (an overlay string or a string displayed with
2164 the `display' property). POS is the position in that string under
2167 Note: this function may only be called with HELP nil or a string
2168 from X code running asynchronously. */
2171 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2174 if (!NILP (help
) && !STRINGP (help
))
2176 if (FUNCTIONP (help
))
2178 Lisp_Object args
[4];
2183 help
= safe_call (4, args
);
2186 help
= safe_eval (help
);
2188 if (!STRINGP (help
))
2192 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2193 if (!noninteractive
&& STRINGP (help
))
2195 /* The mouse-fixup-help-message Lisp function can call
2196 mouse_position_hook, which resets the mouse_moved flags.
2197 This causes trouble if we are trying to read a mouse motion
2198 event (i.e., if we are inside a `track-mouse' form), so we
2199 restore the mouse_moved flag. */
2200 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2201 help
= call1 (Qmouse_fixup_help_message
, help
);
2207 if (STRINGP (help
) || NILP (help
))
2209 if (!NILP (Vshow_help_function
))
2210 call1 (Vshow_help_function
, help
);
2211 help_echo_showing_p
= STRINGP (help
);
2217 /* Input of single characters from keyboard */
2219 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2220 struct timeval
*end_time
);
2221 static void record_char (Lisp_Object c
);
2223 static Lisp_Object help_form_saved_window_configs
;
2225 read_char_help_form_unwind (Lisp_Object arg
)
2227 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2228 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2229 if (!NILP (window_config
))
2230 Fset_window_configuration (window_config
);
2234 #define STOP_POLLING \
2235 do { if (! polling_stopped_here) stop_polling (); \
2236 polling_stopped_here = 1; } while (0)
2238 #define RESUME_POLLING \
2239 do { if (polling_stopped_here) start_polling (); \
2240 polling_stopped_here = 0; } while (0)
2242 /* read a character from the keyboard; call the redisplay if needed */
2243 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2244 -1 means do not do redisplay, but do do autosaving.
2247 /* The arguments MAPS and NMAPS are for menu prompting.
2248 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2250 PREV_EVENT is the previous input event, or nil if we are reading
2251 the first event of a key sequence (or not reading a key sequence).
2252 If PREV_EVENT is t, that is a "magic" value that says
2253 not to run input methods, but in other respects to act as if
2254 not reading a key sequence.
2256 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2257 if we used a mouse menu to read the input, or zero otherwise. If
2258 USED_MOUSE_MENU is null, we don't dereference it.
2260 Value is -2 when we find input on another keyboard. A second call
2261 to read_char will read it.
2263 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2264 specifying the maximum time to wait until. If no input arrives by
2265 that time, stop waiting and return nil.
2267 Value is t if we showed a menu and the user rejected it. */
2270 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2271 int *used_mouse_menu
, struct timeval
*end_time
)
2273 volatile Lisp_Object c
;
2275 jmp_buf local_getcjmp
;
2277 volatile int key_already_recorded
= 0;
2278 Lisp_Object tem
, save
;
2279 volatile Lisp_Object previous_echo_area_message
;
2280 volatile Lisp_Object also_record
;
2281 volatile int reread
;
2282 struct gcpro gcpro1
, gcpro2
;
2283 int volatile polling_stopped_here
= 0;
2284 struct kboard
*orig_kboard
= current_kboard
;
2288 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2289 before_command_key_count
= this_command_key_count
;
2290 before_command_echo_length
= echo_length ();
2293 previous_echo_area_message
= Qnil
;
2295 GCPRO2 (c
, previous_echo_area_message
);
2300 if (CONSP (Vunread_post_input_method_events
))
2302 c
= XCAR (Vunread_post_input_method_events
);
2303 Vunread_post_input_method_events
2304 = XCDR (Vunread_post_input_method_events
);
2306 /* Undo what read_char_x_menu_prompt did when it unread
2307 additional keys returned by Fx_popup_menu. */
2309 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2317 if (unread_command_char
!= -1)
2319 XSETINT (c
, unread_command_char
);
2320 unread_command_char
= -1;
2326 if (CONSP (Vunread_command_events
))
2328 int was_disabled
= 0;
2330 c
= XCAR (Vunread_command_events
);
2331 Vunread_command_events
= XCDR (Vunread_command_events
);
2335 /* Undo what sit-for did when it unread additional keys
2336 inside universal-argument. */
2339 && EQ (XCAR (c
), Qt
))
2345 /* Undo what read_char_x_menu_prompt did when it unread
2346 additional keys returned by Fx_popup_menu. */
2348 && EQ (XCDR (c
), Qdisabled
)
2349 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2355 /* If the queued event is something that used the mouse,
2356 set used_mouse_menu accordingly. */
2358 /* Also check was_disabled so last-nonmenu-event won't return
2359 a bad value when submenus are involved. (Bug#447) */
2360 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2361 *used_mouse_menu
= 1;
2363 goto reread_for_input_method
;
2366 if (CONSP (Vunread_input_method_events
))
2368 c
= XCAR (Vunread_input_method_events
);
2369 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2371 /* Undo what read_char_x_menu_prompt did when it unread
2372 additional keys returned by Fx_popup_menu. */
2374 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2378 goto reread_for_input_method
;
2381 this_command_key_count_reset
= 0;
2383 if (!NILP (Vexecuting_kbd_macro
))
2385 /* We set this to Qmacro; since that's not a frame, nobody will
2386 try to switch frames on us, and the selected window will
2389 Since this event came from a macro, it would be misleading to
2390 leave internal_last_event_frame set to wherever the last
2391 real event came from. Normally, a switch-frame event selects
2392 internal_last_event_frame after each command is read, but
2393 events read from a macro should never cause a new frame to be
2395 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2397 /* Exit the macro if we are at the end.
2398 Also, some things replace the macro with t
2399 to force an early exit. */
2400 if (EQ (Vexecuting_kbd_macro
, Qt
)
2401 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2407 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2408 if (STRINGP (Vexecuting_kbd_macro
)
2409 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2410 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2412 executing_kbd_macro_index
++;
2417 if (!NILP (unread_switch_frame
))
2419 c
= unread_switch_frame
;
2420 unread_switch_frame
= Qnil
;
2422 /* This event should make it into this_command_keys, and get echoed
2423 again, so we do not set `reread'. */
2427 /* if redisplay was requested */
2428 if (commandflag
>= 0)
2430 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2432 /* If there is pending input, process any events which are not
2433 user-visible, such as X selection_request events. */
2435 || detect_input_pending_run_timers (0))
2436 swallow_events (0); /* may clear input_pending */
2438 /* Redisplay if no pending input. */
2439 while (!input_pending
)
2441 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2442 redisplay_preserve_echo_area (5);
2447 /* Normal case: no input arrived during redisplay. */
2450 /* Input arrived and pre-empted redisplay.
2451 Process any events which are not user-visible. */
2453 /* If that cleared input_pending, try again to redisplay. */
2456 /* Prevent the redisplay we just did
2457 from messing up echoing of the input after the prompt. */
2458 if (commandflag
== 0 && echo_current
)
2459 echo_message_buffer
= echo_area_buffer
[0];
2463 /* Message turns off echoing unless more keystrokes turn it on again.
2465 The code in 20.x for the condition was
2467 1. echo_area_glyphs && *echo_area_glyphs
2468 2. && echo_area_glyphs != current_kboard->echobuf
2469 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2471 (1) means there's a current message displayed
2473 (2) means it's not the message from echoing from the current
2476 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2477 is set to a non-null value. This is done in read_char and it is
2478 set to echo_area_glyphs after a call to echo_char. That means
2479 ok_to_echo_at_next_pause is either null or
2480 current_kboard->echobuf with the appropriate current_kboard at
2483 So, condition (3) means in clear text ok_to_echo_at_next_pause
2484 must be either null, or the current message isn't from echoing at
2485 all, or it's from echoing from a different kboard than the
2488 if (/* There currently is something in the echo area. */
2489 !NILP (echo_area_buffer
[0])
2490 && (/* And it's either not from echoing. */
2491 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2492 /* Or it's an echo from a different kboard. */
2493 || echo_kboard
!= current_kboard
2494 /* Or we explicitly allow overwriting whatever there is. */
2495 || ok_to_echo_at_next_pause
== NULL
))
2500 /* Try reading a character via menu prompting in the minibuf.
2501 Try this before the sit-for, because the sit-for
2502 would do the wrong thing if we are supposed to do
2503 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2504 after a mouse event so don't try a minibuf menu. */
2506 if (nmaps
> 0 && INTERACTIVE
2507 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2508 /* Don't bring up a menu if we already have another event. */
2509 && NILP (Vunread_command_events
)
2510 && unread_command_char
< 0
2511 && !detect_input_pending_run_timers (0))
2513 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2515 if (INTEGERP (c
) && XINT (c
) == -2)
2516 return c
; /* wrong_kboard_jmpbuf */
2520 key_already_recorded
= 1;
2525 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2526 We will do that below, temporarily for short sections of code,
2527 when appropriate. local_getcjmp must be in effect
2528 around any call to sit_for or kbd_buffer_get_event;
2529 it *must not* be in effect when we call redisplay. */
2531 jmpcount
= SPECPDL_INDEX ();
2532 if (_setjmp (local_getcjmp
))
2534 /* Handle quits while reading the keyboard. */
2535 /* We must have saved the outer value of getcjmp here,
2536 so restore it now. */
2537 restore_getcjmp (save_jump
);
2538 unbind_to (jmpcount
, Qnil
);
2539 XSETINT (c
, quit_char
);
2540 internal_last_event_frame
= selected_frame
;
2541 Vlast_event_frame
= internal_last_event_frame
;
2542 /* If we report the quit char as an event,
2543 don't do so more than once. */
2544 if (!NILP (Vinhibit_quit
))
2548 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2549 if (kb
!= current_kboard
)
2551 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2552 /* We shouldn't get here if we were in single-kboard mode! */
2557 while (CONSP (XCDR (last
)))
2559 if (!NILP (XCDR (last
)))
2563 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2565 XSETCDR (last
, Fcons (c
, Qnil
));
2566 kb
->kbd_queue_has_data
= 1;
2567 current_kboard
= kb
;
2568 /* This is going to exit from read_char
2569 so we had better get rid of this frame's stuff. */
2571 return make_number (-2); /* wrong_kboard_jmpbuf */
2577 /* Start idle timers if no time limit is supplied. We don't do it
2578 if a time limit is supplied to avoid an infinite recursion in the
2579 situation where an idle timer calls `sit-for'. */
2582 timer_start_idle ();
2584 /* If in middle of key sequence and minibuffer not active,
2585 start echoing if enough time elapses. */
2587 if (minibuf_level
== 0
2589 && !current_kboard
->immediate_echo
2590 && this_command_key_count
> 0
2592 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2593 && NILP (Fzerop (Vecho_keystrokes
))
2594 && (/* No message. */
2595 NILP (echo_area_buffer
[0])
2596 /* Or empty message. */
2597 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2598 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2599 /* Or already echoing from same kboard. */
2600 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2601 /* Or not echoing before and echoing allowed. */
2602 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2604 /* After a mouse event, start echoing right away.
2605 This is because we are probably about to display a menu,
2606 and we don't want to delay before doing so. */
2607 if (EVENT_HAS_PARAMETERS (prev_event
))
2613 save_getcjmp (save_jump
);
2614 restore_getcjmp (local_getcjmp
);
2615 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2616 restore_getcjmp (save_jump
);
2618 && ! CONSP (Vunread_command_events
))
2623 /* Maybe auto save due to number of keystrokes. */
2625 if (commandflag
!= 0
2626 && auto_save_interval
> 0
2627 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2628 && !detect_input_pending_run_timers (0))
2630 Fdo_auto_save (Qnil
, Qnil
);
2631 /* Hooks can actually change some buffers in auto save. */
2635 /* Try reading using an X menu.
2636 This is never confused with reading using the minibuf
2637 because the recursive call of read_char in read_char_minibuf_menu_prompt
2638 does not pass on any keymaps. */
2640 if (nmaps
> 0 && INTERACTIVE
2641 && !NILP (prev_event
)
2642 && EVENT_HAS_PARAMETERS (prev_event
)
2643 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2644 && !EQ (XCAR (prev_event
), Qtool_bar
)
2645 /* Don't bring up a menu if we already have another event. */
2646 && NILP (Vunread_command_events
)
2647 && unread_command_char
< 0)
2649 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2651 /* Now that we have read an event, Emacs is not idle. */
2658 /* Maybe autosave and/or garbage collect due to idleness. */
2660 if (INTERACTIVE
&& NILP (c
))
2663 EMACS_INT buffer_size
;
2665 /* Slow down auto saves logarithmically in size of current buffer,
2666 and garbage collect while we're at it. */
2667 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2668 last_non_minibuf_size
= Z
- BEG
;
2669 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2671 while (buffer_size
> 64)
2672 delay_level
++, buffer_size
-= buffer_size
>> 2;
2673 if (delay_level
< 4) delay_level
= 4;
2674 /* delay_level is 4 for files under around 50k, 7 at 100k,
2675 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2677 /* Auto save if enough time goes by without input. */
2678 if (commandflag
!= 0
2679 && num_nonmacro_input_events
> last_auto_save
2680 && INTEGERP (Vauto_save_timeout
)
2681 && XINT (Vauto_save_timeout
) > 0)
2684 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2686 save_getcjmp (save_jump
);
2687 restore_getcjmp (local_getcjmp
);
2688 tem0
= sit_for (make_number (timeout
), 1, 1);
2689 restore_getcjmp (save_jump
);
2692 && ! CONSP (Vunread_command_events
))
2694 Fdo_auto_save (Qnil
, Qnil
);
2696 /* If we have auto-saved and there is still no input
2697 available, garbage collect if there has been enough
2698 consing going on to make it worthwhile. */
2699 if (!detect_input_pending_run_timers (0)
2700 && consing_since_gc
> gc_cons_threshold
/ 2)
2701 Fgarbage_collect ();
2708 /* Notify the caller if an autosave hook, or a timer, sentinel or
2709 filter in the sit_for calls above have changed the current
2710 kboard. This could happen if they use the minibuffer or start a
2711 recursive edit, like the fancy splash screen in server.el's
2712 filter. If this longjmp wasn't here, read_key_sequence would
2713 interpret the next key sequence using the wrong translation
2714 tables and function keymaps. */
2715 if (NILP (c
) && current_kboard
!= orig_kboard
)
2718 return make_number (-2); /* wrong_kboard_jmpbuf */
2721 /* If this has become non-nil here, it has been set by a timer
2722 or sentinel or filter. */
2723 if (CONSP (Vunread_command_events
))
2725 c
= XCAR (Vunread_command_events
);
2726 Vunread_command_events
= XCDR (Vunread_command_events
);
2729 /* Read something from current KBOARD's side queue, if possible. */
2733 if (current_kboard
->kbd_queue_has_data
)
2735 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2737 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2738 KVAR (current_kboard
, kbd_queue
)
2739 = XCDR (KVAR (current_kboard
, kbd_queue
));
2740 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2741 current_kboard
->kbd_queue_has_data
= 0;
2742 input_pending
= readable_events (0);
2743 if (EVENT_HAS_PARAMETERS (c
)
2744 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2745 internal_last_event_frame
= XCAR (XCDR (c
));
2746 Vlast_event_frame
= internal_last_event_frame
;
2750 /* If current_kboard's side queue is empty check the other kboards.
2751 If one of them has data that we have not yet seen here,
2752 switch to it and process the data waiting for it.
2754 Note: if the events queued up for another kboard
2755 have already been seen here, and therefore are not a complete command,
2756 the kbd_queue_has_data field is 0, so we skip that kboard here.
2757 That's to avoid an infinite loop switching between kboards here. */
2758 if (NILP (c
) && !single_kboard
)
2761 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2762 if (kb
->kbd_queue_has_data
)
2764 current_kboard
= kb
;
2765 /* This is going to exit from read_char
2766 so we had better get rid of this frame's stuff. */
2768 return make_number (-2); /* wrong_kboard_jmpbuf */
2776 /* Finally, we read from the main queue,
2777 and if that gives us something we can't use yet, we put it on the
2778 appropriate side queue and try again. */
2782 KBOARD
*kb
IF_LINT (= NULL
);
2787 EMACS_GET_TIME (now
);
2788 if (EMACS_TIME_GE (now
, *end_time
))
2792 /* Actually read a character, waiting if necessary. */
2793 save_getcjmp (save_jump
);
2794 restore_getcjmp (local_getcjmp
);
2796 timer_start_idle ();
2797 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2798 restore_getcjmp (save_jump
);
2800 if (! NILP (c
) && (kb
!= current_kboard
))
2802 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2805 while (CONSP (XCDR (last
)))
2807 if (!NILP (XCDR (last
)))
2811 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2813 XSETCDR (last
, Fcons (c
, Qnil
));
2814 kb
->kbd_queue_has_data
= 1;
2818 current_kboard
= kb
;
2819 /* This is going to exit from read_char
2820 so we had better get rid of this frame's stuff. */
2822 return make_number (-2);
2826 /* Terminate Emacs in batch mode if at eof. */
2827 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2828 Fkill_emacs (make_number (1));
2832 /* Add in any extra modifiers, where appropriate. */
2833 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2834 || ((extra_keyboard_modifiers
& 0177) < ' '
2835 && (extra_keyboard_modifiers
& 0177) != 0))
2836 XSETINT (c
, make_ctrl_char (XINT (c
)));
2838 /* Transfer any other modifier bits directly from
2839 extra_keyboard_modifiers to c. Ignore the actual character code
2840 in the low 16 bits of extra_keyboard_modifiers. */
2841 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2852 if (commandflag
>= 0
2853 && !input_pending
&& !detect_input_pending_run_timers (0))
2861 /* Buffer switch events are only for internal wakeups
2862 so don't show them to the user.
2863 Also, don't record a key if we already did. */
2864 if (BUFFERP (c
) || key_already_recorded
)
2867 /* Process special events within read_char
2868 and loop around to read another event. */
2871 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2876 struct buffer
*prev_buffer
= current_buffer
;
2877 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2878 int was_locked
= single_kboard
;
2879 int count
= SPECPDL_INDEX ();
2880 record_single_kboard_state ();
2883 last_input_event
= c
;
2884 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2886 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2887 /* We stopped being idle for this event; undo that. This
2888 prevents automatic window selection (under
2889 mouse_autoselect_window from acting as a real input event, for
2890 example banishing the mouse under mouse-avoidance-mode. */
2891 timer_resume_idle ();
2893 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2894 /* Resume allowing input from any kboard, if that was true before. */
2896 any_kboard_state ();
2897 unbind_to (count
, Qnil
);
2900 if (current_buffer
!= prev_buffer
)
2902 /* The command may have changed the keymaps. Pretend there
2903 is input in another keyboard and return. This will
2904 recalculate keymaps. */
2905 c
= make_number (-2);
2912 /* Handle things that only apply to characters. */
2915 /* If kbd_buffer_get_event gave us an EOF, return that. */
2919 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2920 && UNSIGNED_CMP (XFASTINT (c
), <,
2921 SCHARS (KVAR (current_kboard
,
2922 Vkeyboard_translate_table
))))
2923 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2924 && UNSIGNED_CMP (XFASTINT (c
), <,
2925 ASIZE (KVAR (current_kboard
,
2926 Vkeyboard_translate_table
))))
2927 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2931 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2932 /* nil in keyboard-translate-table means no translation. */
2938 /* If this event is a mouse click in the menu bar,
2939 return just menu-bar for now. Modify the mouse click event
2940 so we won't do this twice, then queue it up. */
2941 if (EVENT_HAS_PARAMETERS (c
)
2943 && CONSP (EVENT_START (c
))
2944 && CONSP (XCDR (EVENT_START (c
))))
2948 posn
= POSN_POSN (EVENT_START (c
));
2949 /* Handle menu-bar events:
2950 insert the dummy prefix event `menu-bar'. */
2951 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2953 /* Change menu-bar to (menu-bar) as the event "position". */
2954 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2957 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2962 /* Store these characters into recent_keys, the dribble file if any,
2963 and the keyboard macro being defined, if any. */
2965 if (! NILP (also_record
))
2966 record_char (also_record
);
2968 /* Wipe the echo area.
2969 But first, if we are about to use an input method,
2970 save the echo area contents for it to refer to. */
2972 && ! NILP (Vinput_method_function
)
2973 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2975 previous_echo_area_message
= Fcurrent_message ();
2976 Vinput_method_previous_message
= previous_echo_area_message
;
2979 /* Now wipe the echo area, except for help events which do their
2980 own stuff with the echo area. */
2982 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2983 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2985 if (!NILP (echo_area_buffer
[0]))
2986 safe_run_hooks (Qecho_area_clear_hook
);
2987 clear_message (1, 0);
2990 reread_for_input_method
:
2992 /* Pass this to the input method, if appropriate. */
2994 && ! NILP (Vinput_method_function
)
2995 /* Don't run the input method within a key sequence,
2996 after the first event of the key sequence. */
2997 && NILP (prev_event
)
2998 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3001 int key_count
, key_count_reset
;
3002 struct gcpro inner_gcpro1
;
3003 int count
= SPECPDL_INDEX ();
3005 /* Save the echo status. */
3006 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3007 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3008 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3009 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3012 if (before_command_restore_flag
)
3014 this_command_key_count
= before_command_key_count_1
;
3015 if (this_command_key_count
< this_single_command_key_start
)
3016 this_single_command_key_start
= this_command_key_count
;
3017 echo_truncate (before_command_echo_length_1
);
3018 before_command_restore_flag
= 0;
3022 /* Save the this_command_keys status. */
3023 key_count
= this_command_key_count
;
3024 key_count_reset
= this_command_key_count_reset
;
3027 keys
= Fcopy_sequence (this_command_keys
);
3030 GCPRO1_VAR (keys
, inner_gcpro
);
3032 /* Clear out this_command_keys. */
3033 this_command_key_count
= 0;
3034 this_command_key_count_reset
= 0;
3036 /* Now wipe the echo area. */
3037 if (!NILP (echo_area_buffer
[0]))
3038 safe_run_hooks (Qecho_area_clear_hook
);
3039 clear_message (1, 0);
3042 /* If we are not reading a key sequence,
3043 never use the echo area. */
3046 specbind (Qinput_method_use_echo_area
, Qt
);
3049 /* Call the input method. */
3050 tem
= call1 (Vinput_method_function
, c
);
3052 tem
= unbind_to (count
, tem
);
3054 /* Restore the saved echoing state
3055 and this_command_keys state. */
3056 this_command_key_count
= key_count
;
3057 this_command_key_count_reset
= key_count_reset
;
3059 this_command_keys
= keys
;
3062 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3063 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3064 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3065 if (saved_immediate_echo
)
3068 UNGCPRO_VAR (inner_gcpro
);
3070 /* The input method can return no events. */
3073 /* Bring back the previous message, if any. */
3074 if (! NILP (previous_echo_area_message
))
3075 message_with_string ("%s", previous_echo_area_message
, 0);
3078 /* It returned one event or more. */
3080 Vunread_post_input_method_events
3081 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3086 /* Display help if not echoing. */
3087 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3089 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3090 Lisp_Object help
, object
, position
, window
, htem
;
3092 htem
= Fcdr (XCDR (c
));
3095 window
= Fcar (htem
);
3097 object
= Fcar (htem
);
3099 position
= Fcar (htem
);
3101 show_help_echo (help
, window
, object
, position
);
3103 /* We stopped being idle for this event; undo that. */
3105 timer_resume_idle ();
3109 if ((! reread
|| this_command_key_count
== 0
3110 || this_command_key_count_reset
)
3114 /* Don't echo mouse motion events. */
3115 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3116 && NILP (Fzerop (Vecho_keystrokes
))
3117 && ! (EVENT_HAS_PARAMETERS (c
)
3118 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3121 if (! NILP (also_record
))
3122 echo_char (also_record
);
3123 /* Once we reread a character, echoing can happen
3124 the next time we pause to read a new one. */
3125 ok_to_echo_at_next_pause
= current_kboard
;
3128 /* Record this character as part of the current key. */
3129 add_command_key (c
);
3130 if (! NILP (also_record
))
3131 add_command_key (also_record
);
3134 last_input_event
= c
;
3137 /* Process the help character specially if enabled */
3138 if (!NILP (Vhelp_form
) && help_char_p (c
))
3140 int count
= SPECPDL_INDEX ();
3142 help_form_saved_window_configs
3143 = Fcons (Fcurrent_window_configuration (Qnil
),
3144 help_form_saved_window_configs
);
3145 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3146 call0 (Qhelp_form_show
);
3151 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3152 if (EVENT_HAS_PARAMETERS (c
)
3153 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3154 XSETCAR (help_form_saved_window_configs
, Qnil
);
3156 while (BUFFERP (c
));
3157 /* Remove the help from the frame */
3158 unbind_to (count
, Qnil
);
3161 if (EQ (c
, make_number (040)))
3165 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3166 while (BUFFERP (c
));
3175 /* Record a key that came from a mouse menu.
3176 Record it for echoing, for this-command-keys, and so on. */
3179 record_menu_key (Lisp_Object c
)
3181 /* Wipe the echo area. */
3182 clear_message (1, 0);
3187 before_command_key_count
= this_command_key_count
;
3188 before_command_echo_length
= echo_length ();
3191 /* Don't echo mouse motion events. */
3192 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3193 && NILP (Fzerop (Vecho_keystrokes
)))
3197 /* Once we reread a character, echoing can happen
3198 the next time we pause to read a new one. */
3199 ok_to_echo_at_next_pause
= 0;
3202 /* Record this character as part of the current key. */
3203 add_command_key (c
);
3205 /* Re-reading in the middle of a command */
3206 last_input_event
= c
;
3210 /* Return 1 if should recognize C as "the help character". */
3213 help_char_p (Lisp_Object c
)
3217 if (EQ (c
, Vhelp_char
))
3219 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3220 if (EQ (c
, XCAR (tail
)))
3225 /* Record the input event C in various ways. */
3228 record_char (Lisp_Object c
)
3232 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3234 /* To avoid filling recent_keys with help-echo and mouse-movement
3235 events, we filter out repeated help-echo events, only store the
3236 first and last in a series of mouse-movement events, and don't
3237 store repeated help-echo events which are only separated by
3238 mouse-movement events. */
3240 Lisp_Object ev1
, ev2
, ev3
;
3243 if ((ix1
= recent_keys_index
- 1) < 0)
3244 ix1
= NUM_RECENT_KEYS
- 1;
3245 ev1
= AREF (recent_keys
, ix1
);
3247 if ((ix2
= ix1
- 1) < 0)
3248 ix2
= NUM_RECENT_KEYS
- 1;
3249 ev2
= AREF (recent_keys
, ix2
);
3251 if ((ix3
= ix2
- 1) < 0)
3252 ix3
= NUM_RECENT_KEYS
- 1;
3253 ev3
= AREF (recent_keys
, ix3
);
3255 if (EQ (XCAR (c
), Qhelp_echo
))
3257 /* Don't record `help-echo' in recent_keys unless it shows some help
3258 message, and a different help than the previously recorded
3260 Lisp_Object help
, last_help
;
3262 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3263 if (!STRINGP (help
))
3265 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3266 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3268 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3269 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3270 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3272 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3273 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3274 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3275 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3278 else if (EQ (XCAR (c
), Qmouse_movement
))
3280 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3281 So additional mouse movement events replace the last element. */
3282 Lisp_Object last_window
, window
;
3284 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3285 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3286 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3287 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3288 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3290 ASET (recent_keys
, ix1
, c
);
3296 store_kbd_macro_char (c
);
3301 ASET (recent_keys
, recent_keys_index
, c
);
3302 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3303 recent_keys_index
= 0;
3305 else if (recorded
< 0)
3307 /* We need to remove one or two events from recent_keys.
3308 To do this, we simply put nil at those events and move the
3309 recent_keys_index backwards over those events. Usually,
3310 users will never see those nil events, as they will be
3311 overwritten by the command keys entered to see recent_keys
3314 while (recorded
++ < 0 && total_keys
> 0)
3316 if (total_keys
< NUM_RECENT_KEYS
)
3318 if (--recent_keys_index
< 0)
3319 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3320 ASET (recent_keys
, recent_keys_index
, Qnil
);
3324 num_nonmacro_input_events
++;
3326 /* Write c to the dribble file. If c is a lispy event, write
3327 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3328 If you, dear reader, have a better idea, you've got the source. :-) */
3334 if (XUINT (c
) < 0x100)
3335 putc (XUINT (c
), dribble
);
3337 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3341 Lisp_Object dribblee
;
3343 /* If it's a structured event, take the event header. */
3344 dribblee
= EVENT_HEAD (c
);
3346 if (SYMBOLP (dribblee
))
3348 putc ('<', dribble
);
3349 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3350 SBYTES (SYMBOL_NAME (dribblee
)),
3352 putc ('>', dribble
);
3361 /* Copy out or in the info on where C-g should throw to.
3362 This is used when running Lisp code from within get_char,
3363 in case get_char is called recursively.
3364 See read_process_output. */
3367 save_getcjmp (jmp_buf temp
)
3369 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3373 restore_getcjmp (jmp_buf temp
)
3375 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3378 /* Low level keyboard/mouse input.
3379 kbd_buffer_store_event places events in kbd_buffer, and
3380 kbd_buffer_get_event retrieves them. */
3382 /* Return true if there are any events in the queue that read-char
3383 would return. If this returns false, a read-char would block. */
3385 readable_events (int flags
)
3387 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3390 /* If the buffer contains only FOCUS_IN_EVENT events, and
3391 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3392 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3394 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3395 #ifdef USE_TOOLKIT_SCROLL_BARS
3396 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3400 struct input_event
*event
;
3402 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3409 #ifdef USE_TOOLKIT_SCROLL_BARS
3410 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3412 event
->kind
== FOCUS_IN_EVENT
)
3413 #ifdef USE_TOOLKIT_SCROLL_BARS
3414 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3415 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3416 && event
->part
== scroll_bar_handle
3417 && event
->modifiers
== 0)
3422 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3425 while (event
!= kbd_store_ptr
);
3431 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3432 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3433 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3438 if (current_kboard
->kbd_queue_has_data
)
3444 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3445 if (kb
->kbd_queue_has_data
)
3451 /* Set this for debugging, to have a way to get out */
3452 int stop_character EXTERNALLY_VISIBLE
;
3455 event_to_kboard (struct input_event
*event
)
3458 frame
= event
->frame_or_window
;
3460 frame
= XCAR (frame
);
3461 else if (WINDOWP (frame
))
3462 frame
= WINDOW_FRAME (XWINDOW (frame
));
3464 /* There are still some events that don't set this field.
3465 For now, just ignore the problem.
3466 Also ignore dead frames here. */
3467 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3470 return FRAME_KBOARD (XFRAME (frame
));
3474 /* Return the number of slots occupied in kbd_buffer. */
3477 kbd_buffer_nr_stored (void)
3479 return kbd_fetch_ptr
== kbd_store_ptr
3481 : (kbd_fetch_ptr
< kbd_store_ptr
3482 ? kbd_store_ptr
- kbd_fetch_ptr
3483 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3484 + (kbd_store_ptr
- kbd_buffer
)));
3486 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3489 kbd_buffer_store_event (register struct input_event
*event
)
3491 kbd_buffer_store_event_hold (event
, 0);
3494 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3496 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3497 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3498 Else, if EVENT is a quit event, store the quit event
3499 in HOLD_QUIT, and return (thus ignoring further events).
3501 This is used in read_avail_input to postpone the processing
3502 of the quit event until all subsequent input events have been
3503 parsed (and discarded).
3507 kbd_buffer_store_event_hold (register struct input_event
*event
,
3508 struct input_event
*hold_quit
)
3510 if (event
->kind
== NO_EVENT
)
3513 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3516 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3518 register int c
= event
->code
& 0377;
3520 if (event
->modifiers
& ctrl_modifier
)
3521 c
= make_ctrl_char (c
);
3523 c
|= (event
->modifiers
3524 & (meta_modifier
| alt_modifier
3525 | hyper_modifier
| super_modifier
));
3529 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3530 struct input_event
*sp
;
3532 if (single_kboard
&& kb
!= current_kboard
)
3534 KVAR (kb
, kbd_queue
)
3535 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3536 Fcons (make_number (c
), Qnil
));
3537 kb
->kbd_queue_has_data
= 1;
3538 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3540 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3543 if (event_to_kboard (sp
) == kb
)
3545 sp
->kind
= NO_EVENT
;
3546 sp
->frame_or_window
= Qnil
;
3555 memcpy (hold_quit
, event
, sizeof (*event
));
3559 /* If this results in a quit_char being returned to Emacs as
3560 input, set Vlast_event_frame properly. If this doesn't
3561 get returned to Emacs as an event, the next event read
3562 will set Vlast_event_frame again, so this is safe to do. */
3566 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3568 focus
= event
->frame_or_window
;
3569 internal_last_event_frame
= focus
;
3570 Vlast_event_frame
= focus
;
3573 last_event_timestamp
= event
->timestamp
;
3574 handle_interrupt ();
3578 if (c
&& c
== stop_character
)
3584 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3585 Just ignore the second one. */
3586 else if (event
->kind
== BUFFER_SWITCH_EVENT
3587 && kbd_fetch_ptr
!= kbd_store_ptr
3588 && ((kbd_store_ptr
== kbd_buffer
3589 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3590 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3593 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3594 kbd_store_ptr
= kbd_buffer
;
3596 /* Don't let the very last slot in the buffer become full,
3597 since that would make the two pointers equal,
3598 and that is indistinguishable from an empty buffer.
3599 Discard the event if it would fill the last slot. */
3600 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3602 *kbd_store_ptr
= *event
;
3605 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3607 /* Don't read keyboard input until we have processed kbd_buffer.
3608 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3609 hold_keyboard_input ();
3611 if (!noninteractive
)
3612 signal (SIGIO
, SIG_IGN
);
3616 #endif /* subprocesses */
3619 /* If we're inside while-no-input, and this event qualifies
3620 as input, set quit-flag to cause an interrupt. */
3621 if (!NILP (Vthrow_on_input
)
3622 && event
->kind
!= FOCUS_IN_EVENT
3623 && event
->kind
!= HELP_EVENT
3624 && event
->kind
!= DEICONIFY_EVENT
)
3626 Vquit_flag
= Vthrow_on_input
;
3627 /* If we're inside a function that wants immediate quits,
3629 if (immediate_quit
&& NILP (Vinhibit_quit
))
3639 /* Put an input event back in the head of the event queue. */
3642 kbd_buffer_unget_event (register struct input_event
*event
)
3644 if (kbd_fetch_ptr
== kbd_buffer
)
3645 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3647 /* Don't let the very last slot in the buffer become full, */
3648 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3651 *kbd_fetch_ptr
= *event
;
3656 /* Generate a HELP_EVENT input_event and store it in the keyboard
3659 HELP is the help form.
3661 FRAME and WINDOW are the frame and window where the help is
3662 generated. OBJECT is the Lisp object where the help was found (a
3663 buffer, a string, an overlay, or nil if neither from a string nor
3664 from a buffer). POS is the position within OBJECT where the help
3668 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3669 Lisp_Object object
, EMACS_INT pos
)
3671 struct input_event event
;
3675 event
.kind
= HELP_EVENT
;
3676 event
.frame_or_window
= frame
;
3678 event
.x
= WINDOWP (window
) ? window
: frame
;
3681 kbd_buffer_store_event (&event
);
3685 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3688 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3690 struct input_event event
;
3692 event
.kind
= HELP_EVENT
;
3693 event
.frame_or_window
= frame
;
3698 kbd_buffer_store_event (&event
);
3702 /* Discard any mouse events in the event buffer by setting them to
3705 discard_mouse_events (void)
3707 struct input_event
*sp
;
3708 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3710 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3713 if (sp
->kind
== MOUSE_CLICK_EVENT
3714 || sp
->kind
== WHEEL_EVENT
3715 || sp
->kind
== HORIZ_WHEEL_EVENT
3717 || sp
->kind
== GPM_CLICK_EVENT
3719 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3721 sp
->kind
= NO_EVENT
;
3727 /* Return non-zero if there are any real events waiting in the event
3728 buffer, not counting `NO_EVENT's.
3730 If DISCARD is non-zero, discard NO_EVENT events at the front of
3731 the input queue, possibly leaving the input queue empty if there
3732 are no real input events. */
3735 kbd_buffer_events_waiting (int discard
)
3737 struct input_event
*sp
;
3739 for (sp
= kbd_fetch_ptr
;
3740 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3743 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3750 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3754 /* Clear input event EVENT. */
3757 clear_event (struct input_event
*event
)
3759 event
->kind
= NO_EVENT
;
3763 /* Read one event from the event buffer, waiting if necessary.
3764 The value is a Lisp object representing the event.
3765 The value is nil for an event that should be ignored,
3766 or that was handled here.
3767 We always read and discard one event. */
3770 kbd_buffer_get_event (KBOARD
**kbp
,
3771 int *used_mouse_menu
,
3772 struct timeval
*end_time
)
3778 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3780 /* Start reading input again, we have processed enough so we can
3781 accept new events again. */
3782 unhold_keyboard_input ();
3784 if (!noninteractive
)
3785 signal (SIGIO
, input_available_signal
);
3789 #endif /* subprocesses */
3792 /* In case we are running as a daemon, only do this before
3793 detaching from the terminal. */
3794 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3798 *kbp
= current_kboard
;
3802 /* Wait until there is input available. */
3805 /* Break loop if there's an unread command event. Needed in
3806 moused window autoselection which uses a timer to insert such
3808 if (CONSP (Vunread_command_events
))
3811 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3813 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3814 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3818 /* If the quit flag is set, then read_char will return
3819 quit_char, so that counts as "available input." */
3820 if (!NILP (Vquit_flag
))
3821 quit_throw_to_read_char ();
3823 /* One way or another, wait until input is available; then, if
3824 interrupt handlers have not read it, read it now. */
3826 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3830 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3832 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3833 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3838 EMACS_TIME duration
;
3839 EMACS_GET_TIME (duration
);
3840 if (EMACS_TIME_GE (duration
, *end_time
))
3841 return Qnil
; /* finished waiting */
3844 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3845 wait_reading_process_output (EMACS_SECS (duration
),
3846 EMACS_USECS (duration
),
3847 -1, 1, Qnil
, NULL
, 0);
3851 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3853 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3854 /* Pass 1 for EXPECT since we just waited to have input. */
3855 read_avail_input (1);
3858 if (CONSP (Vunread_command_events
))
3861 first
= XCAR (Vunread_command_events
);
3862 Vunread_command_events
= XCDR (Vunread_command_events
);
3863 *kbp
= current_kboard
;
3867 /* At this point, we know that there is a readable event available
3868 somewhere. If the event queue is empty, then there must be a
3869 mouse movement enabled and available. */
3870 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3872 struct input_event
*event
;
3874 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3878 last_event_timestamp
= event
->timestamp
;
3880 *kbp
= event_to_kboard (event
);
3882 *kbp
= current_kboard
; /* Better than returning null ptr? */
3886 /* These two kinds of events get special handling
3887 and don't actually appear to the command loop.
3888 We return nil for them. */
3889 if (event
->kind
== SELECTION_REQUEST_EVENT
3890 || event
->kind
== SELECTION_CLEAR_EVENT
)
3893 struct input_event copy
;
3895 /* Remove it from the buffer before processing it,
3896 since otherwise swallow_events will see it
3897 and process it again. */
3899 kbd_fetch_ptr
= event
+ 1;
3900 input_pending
= readable_events (0);
3901 x_handle_selection_event (©
);
3903 /* We're getting selection request events, but we don't have
3909 #if defined (HAVE_NS)
3910 else if (event
->kind
== NS_TEXT_EVENT
)
3912 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3913 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3915 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3916 kbd_fetch_ptr
= event
+ 1;
3917 if (used_mouse_menu
)
3918 *used_mouse_menu
= 1;
3922 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3923 || defined (HAVE_NS)
3924 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3926 /* Make an event (delete-frame (FRAME)). */
3927 obj
= Fcons (event
->frame_or_window
, Qnil
);
3928 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3929 kbd_fetch_ptr
= event
+ 1;
3932 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3933 || defined (HAVE_NS)
3934 else if (event
->kind
== ICONIFY_EVENT
)
3936 /* Make an event (iconify-frame (FRAME)). */
3937 obj
= Fcons (event
->frame_or_window
, Qnil
);
3938 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3939 kbd_fetch_ptr
= event
+ 1;
3941 else if (event
->kind
== DEICONIFY_EVENT
)
3943 /* Make an event (make-frame-visible (FRAME)). */
3944 obj
= Fcons (event
->frame_or_window
, Qnil
);
3945 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3946 kbd_fetch_ptr
= event
+ 1;
3949 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3951 /* The value doesn't matter here; only the type is tested. */
3952 XSETBUFFER (obj
, current_buffer
);
3953 kbd_fetch_ptr
= event
+ 1;
3955 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3956 || defined(HAVE_NS) || defined (USE_GTK)
3957 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3959 kbd_fetch_ptr
= event
+ 1;
3960 input_pending
= readable_events (0);
3961 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3962 x_activate_menubar (XFRAME (event
->frame_or_window
));
3965 #if defined (WINDOWSNT)
3966 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3968 /* Make an event (language-change (FRAME CHARSET LCID)). */
3969 obj
= Fcons (event
->frame_or_window
, Qnil
);
3970 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3971 kbd_fetch_ptr
= event
+ 1;
3974 else if (event
->kind
== SAVE_SESSION_EVENT
)
3976 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3977 kbd_fetch_ptr
= event
+ 1;
3979 /* Just discard these, by returning nil.
3980 With MULTI_KBOARD, these events are used as placeholders
3981 when we need to randomly delete events from the queue.
3982 (They shouldn't otherwise be found in the buffer,
3983 but on some machines it appears they do show up
3984 even without MULTI_KBOARD.) */
3985 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3986 mouse events during a popup-menu call. */
3987 else if (event
->kind
== NO_EVENT
)
3988 kbd_fetch_ptr
= event
+ 1;
3989 else if (event
->kind
== HELP_EVENT
)
3991 Lisp_Object object
, position
, help
, frame
, window
;
3993 frame
= event
->frame_or_window
;
3994 object
= event
->arg
;
3995 position
= make_number (event
->code
);
3998 clear_event (event
);
4000 kbd_fetch_ptr
= event
+ 1;
4001 if (!WINDOWP (window
))
4003 obj
= Fcons (Qhelp_echo
,
4004 list5 (frame
, help
, window
, object
, position
));
4006 else if (event
->kind
== FOCUS_IN_EVENT
)
4008 /* Notification of a FocusIn event. The frame receiving the
4009 focus is in event->frame_or_window. Generate a
4010 switch-frame event if necessary. */
4011 Lisp_Object frame
, focus
;
4013 frame
= event
->frame_or_window
;
4014 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4018 if (!EQ (frame
, internal_last_event_frame
)
4019 && !EQ (frame
, selected_frame
))
4020 obj
= make_lispy_switch_frame (frame
);
4021 internal_last_event_frame
= frame
;
4022 kbd_fetch_ptr
= event
+ 1;
4025 else if (event
->kind
== DBUS_EVENT
)
4027 obj
= make_lispy_event (event
);
4028 kbd_fetch_ptr
= event
+ 1;
4031 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4033 obj
= make_lispy_event (event
);
4034 kbd_fetch_ptr
= event
+ 1;
4038 /* If this event is on a different frame, return a switch-frame this
4039 time, and leave the event in the queue for next time. */
4043 frame
= event
->frame_or_window
;
4045 frame
= XCAR (frame
);
4046 else if (WINDOWP (frame
))
4047 frame
= WINDOW_FRAME (XWINDOW (frame
));
4049 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4053 if (! EQ (frame
, internal_last_event_frame
)
4054 && !EQ (frame
, selected_frame
))
4055 obj
= make_lispy_switch_frame (frame
);
4056 internal_last_event_frame
= frame
;
4058 /* If we didn't decide to make a switch-frame event, go ahead
4059 and build a real event from the queue entry. */
4063 obj
= make_lispy_event (event
);
4065 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4066 || defined(HAVE_NS) || defined (USE_GTK)
4067 /* If this was a menu selection, then set the flag to inhibit
4068 writing to last_nonmenu_event. Don't do this if the event
4069 we're returning is (menu-bar), though; that indicates the
4070 beginning of the menu sequence, and we might as well leave
4071 that as the `event with parameters' for this selection. */
4073 && !EQ (event
->frame_or_window
, event
->arg
)
4074 && (event
->kind
== MENU_BAR_EVENT
4075 || event
->kind
== TOOL_BAR_EVENT
))
4076 *used_mouse_menu
= 1;
4079 /* certain system events are non-key events */
4081 && event
->kind
== NS_NONKEY_EVENT
)
4082 *used_mouse_menu
= 1;
4085 /* Wipe out this event, to catch bugs. */
4086 clear_event (event
);
4087 kbd_fetch_ptr
= event
+ 1;
4091 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4092 /* Try generating a mouse motion event. */
4093 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4095 FRAME_PTR f
= some_mouse_moved ();
4096 Lisp_Object bar_window
;
4097 enum scroll_bar_part part
;
4101 *kbp
= current_kboard
;
4102 /* Note that this uses F to determine which terminal to look at.
4103 If there is no valid info, it does not store anything
4104 so x remains nil. */
4107 /* XXX Can f or mouse_position_hook be NULL here? */
4108 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4109 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4114 /* Decide if we should generate a switch-frame event. Don't
4115 generate switch-frame events for motion outside of all Emacs
4121 frame
= FRAME_FOCUS_FRAME (f
);
4123 XSETFRAME (frame
, f
);
4125 if (! EQ (frame
, internal_last_event_frame
)
4126 && !EQ (frame
, selected_frame
))
4127 obj
= make_lispy_switch_frame (frame
);
4128 internal_last_event_frame
= frame
;
4131 /* If we didn't decide to make a switch-frame event, go ahead and
4132 return a mouse-motion event. */
4133 if (!NILP (x
) && NILP (obj
))
4134 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4136 #endif /* HAVE_MOUSE || HAVE GPM */
4138 /* We were promised by the above while loop that there was
4139 something for us to read! */
4142 input_pending
= readable_events (0);
4144 Vlast_event_frame
= internal_last_event_frame
;
4149 /* Process any events that are not user-visible,
4150 then return, without reading any user-visible events. */
4153 swallow_events (int do_display
)
4157 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4159 struct input_event
*event
;
4161 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4165 last_event_timestamp
= event
->timestamp
;
4167 /* These two kinds of events get special handling
4168 and don't actually appear to the command loop. */
4169 if (event
->kind
== SELECTION_REQUEST_EVENT
4170 || event
->kind
== SELECTION_CLEAR_EVENT
)
4173 struct input_event copy
;
4175 /* Remove it from the buffer before processing it,
4176 since otherwise swallow_events called recursively could see it
4177 and process it again. */
4179 kbd_fetch_ptr
= event
+ 1;
4180 input_pending
= readable_events (0);
4181 x_handle_selection_event (©
);
4183 /* We're getting selection request events, but we don't have
4192 old_timers_run
= timers_run
;
4193 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4195 if (timers_run
!= old_timers_run
&& do_display
)
4196 redisplay_preserve_echo_area (7);
4199 /* Record the start of when Emacs is idle,
4200 for the sake of running idle-time timers. */
4203 timer_start_idle (void)
4207 /* If we are already in the idle state, do nothing. */
4208 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4211 EMACS_GET_TIME (timer_idleness_start_time
);
4213 timer_last_idleness_start_time
= timer_idleness_start_time
;
4215 /* Mark all idle-time timers as once again candidates for running. */
4216 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4220 timer
= XCAR (timers
);
4222 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4224 XVECTOR (timer
)->contents
[0] = Qnil
;
4228 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4231 timer_stop_idle (void)
4233 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4236 /* Resume idle timer from last idle start time. */
4239 timer_resume_idle (void)
4241 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4244 timer_idleness_start_time
= timer_last_idleness_start_time
;
4247 /* This is only for debugging. */
4248 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4250 /* List of elisp functions to call, delayed because they were generated in
4251 a context where Elisp could not be safely run (e.g. redisplay, signal,
4252 ...). Each element has the form (FUN . ARGS). */
4253 Lisp_Object pending_funcalls
;
4255 /* Check whether a timer has fired. To prevent larger problems we simply
4256 disregard elements that are not proper timers. Do not make a circular
4257 timer list for the time being.
4259 Returns the time to wait until the next timer fires. If a
4260 timer is triggering now, return zero.
4261 If no timer is active, return -1.
4263 If a timer is ripe, we run it, with quitting turned off.
4264 In that case we return 0 to indicate that a new timer_check_2 call
4268 timer_check_2 (void)
4270 EMACS_TIME nexttime
;
4272 EMACS_TIME idleness_now
IF_LINT (= {0});
4273 Lisp_Object timers
, idle_timers
, chosen_timer
;
4274 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4276 EMACS_SET_SECS (nexttime
, -1);
4277 EMACS_SET_USECS (nexttime
, -1);
4279 /* Always consider the ordinary timers. */
4280 timers
= Vtimer_list
;
4281 /* Consider the idle timers only if Emacs is idle. */
4282 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4283 idle_timers
= Vtimer_idle_list
;
4286 chosen_timer
= Qnil
;
4287 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4289 /* First run the code that was delayed. */
4290 while (CONSP (pending_funcalls
))
4292 Lisp_Object funcall
= XCAR (pending_funcalls
);
4293 pending_funcalls
= XCDR (pending_funcalls
);
4294 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4297 if (CONSP (timers
) || CONSP (idle_timers
))
4299 EMACS_GET_TIME (now
);
4300 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4301 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4304 while (CONSP (timers
) || CONSP (idle_timers
))
4306 Lisp_Object
*vector
;
4307 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4308 EMACS_TIME timer_time
, idle_timer_time
;
4309 EMACS_TIME difference
;
4310 EMACS_TIME timer_difference
IF_LINT (= {0});
4311 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4313 /* Skip past invalid timers and timers already handled. */
4316 timer
= XCAR (timers
);
4317 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4319 timers
= XCDR (timers
);
4322 vector
= XVECTOR (timer
)->contents
;
4324 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4325 || !INTEGERP (vector
[3])
4326 || ! NILP (vector
[0]))
4328 timers
= XCDR (timers
);
4332 if (CONSP (idle_timers
))
4334 timer
= XCAR (idle_timers
);
4335 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4337 idle_timers
= XCDR (idle_timers
);
4340 vector
= XVECTOR (timer
)->contents
;
4342 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4343 || !INTEGERP (vector
[3])
4344 || ! NILP (vector
[0]))
4346 idle_timers
= XCDR (idle_timers
);
4351 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4352 based on the next ordinary timer.
4353 TIMER_DIFFERENCE is the distance in time from NOW to when
4354 this timer becomes ripe (negative if it's already ripe). */
4357 timer
= XCAR (timers
);
4358 vector
= XVECTOR (timer
)->contents
;
4359 EMACS_SET_SECS (timer_time
,
4360 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4361 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4362 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4365 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4366 based on the next idle timer. */
4367 if (CONSP (idle_timers
))
4369 idle_timer
= XCAR (idle_timers
);
4370 vector
= XVECTOR (idle_timer
)->contents
;
4371 EMACS_SET_SECS (idle_timer_time
,
4372 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4373 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4374 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4377 /* Decide which timer is the next timer,
4378 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4379 Also step down the list where we found that timer. */
4381 if (CONSP (timers
) && CONSP (idle_timers
))
4384 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4385 if (EMACS_TIME_NEG_P (temp
))
4387 chosen_timer
= timer
;
4388 timers
= XCDR (timers
);
4389 difference
= timer_difference
;
4393 chosen_timer
= idle_timer
;
4394 idle_timers
= XCDR (idle_timers
);
4395 difference
= idle_timer_difference
;
4398 else if (CONSP (timers
))
4400 chosen_timer
= timer
;
4401 timers
= XCDR (timers
);
4402 difference
= timer_difference
;
4406 chosen_timer
= idle_timer
;
4407 idle_timers
= XCDR (idle_timers
);
4408 difference
= idle_timer_difference
;
4410 vector
= XVECTOR (chosen_timer
)->contents
;
4412 /* If timer is ripe, run it if it hasn't been run. */
4413 if (EMACS_TIME_NEG_P (difference
)
4414 || (EMACS_SECS (difference
) == 0
4415 && EMACS_USECS (difference
) == 0))
4417 if (NILP (vector
[0]))
4419 int count
= SPECPDL_INDEX ();
4420 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4422 /* Mark the timer as triggered to prevent problems if the lisp
4423 code fails to reschedule it right. */
4426 specbind (Qinhibit_quit
, Qt
);
4428 call1 (Qtimer_event_handler
, chosen_timer
);
4429 Vdeactivate_mark
= old_deactivate_mark
;
4431 unbind_to (count
, Qnil
);
4433 /* Since we have handled the event,
4434 we don't need to tell the caller to wake up and do it. */
4435 /* But the caller must still wait for the next timer, so
4436 return 0 to indicate that. */
4439 EMACS_SET_SECS (nexttime
, 0);
4440 EMACS_SET_USECS (nexttime
, 0);
4443 /* When we encounter a timer that is still waiting,
4444 return the amount of time to wait before it is ripe. */
4451 /* No timers are pending in the future. */
4452 /* Return 0 if we generated an event, and -1 if not. */
4458 /* Check whether a timer has fired. To prevent larger problems we simply
4459 disregard elements that are not proper timers. Do not make a circular
4460 timer list for the time being.
4462 Returns the time to wait until the next timer fires.
4463 If no timer is active, return -1.
4465 As long as any timer is ripe, we run it. */
4470 EMACS_TIME nexttime
;
4474 nexttime
= timer_check_2 ();
4476 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4481 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4482 doc
: /* Return the current length of Emacs idleness, or nil.
4483 The value when Emacs is idle is a list of three integers. The first has
4484 the most significant 16 bits of the seconds, while the second has the least
4485 significant 16 bits. The third integer gives the microsecond count.
4487 The value when Emacs is not idle is nil.
4489 The microsecond count is zero on systems that do not provide
4490 resolution finer than a second. */)
4493 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4495 EMACS_TIME now
, idleness_now
;
4497 EMACS_GET_TIME (now
);
4498 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4500 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4501 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4502 make_number (EMACS_USECS (idleness_now
)));
4508 /* Caches for modify_event_symbol. */
4509 static Lisp_Object accent_key_syms
;
4510 static Lisp_Object func_key_syms
;
4511 static Lisp_Object mouse_syms
;
4512 static Lisp_Object wheel_syms
;
4513 static Lisp_Object drag_n_drop_syms
;
4515 /* This is a list of keysym codes for special "accent" characters.
4516 It parallels lispy_accent_keys. */
4518 static const int lispy_accent_codes
[] =
4520 #ifdef XK_dead_circumflex
4525 #ifdef XK_dead_grave
4530 #ifdef XK_dead_tilde
4535 #ifdef XK_dead_diaeresis
4540 #ifdef XK_dead_macron
4545 #ifdef XK_dead_degree
4550 #ifdef XK_dead_acute
4555 #ifdef XK_dead_cedilla
4560 #ifdef XK_dead_breve
4565 #ifdef XK_dead_ogonek
4570 #ifdef XK_dead_caron
4575 #ifdef XK_dead_doubleacute
4576 XK_dead_doubleacute
,
4580 #ifdef XK_dead_abovedot
4585 #ifdef XK_dead_abovering
4595 #ifdef XK_dead_belowdot
4600 #ifdef XK_dead_voiced_sound
4601 XK_dead_voiced_sound
,
4605 #ifdef XK_dead_semivoiced_sound
4606 XK_dead_semivoiced_sound
,
4622 /* This is a list of Lisp names for special "accent" characters.
4623 It parallels lispy_accent_codes. */
4625 static const char *const lispy_accent_keys
[] =
4643 "dead-voiced-sound",
4644 "dead-semivoiced-sound",
4650 #define FUNCTION_KEY_OFFSET 0x0
4652 const char *const lispy_function_keys
[] =
4656 0, /* VK_LBUTTON 0x01 */
4657 0, /* VK_RBUTTON 0x02 */
4658 "cancel", /* VK_CANCEL 0x03 */
4659 0, /* VK_MBUTTON 0x04 */
4661 0, 0, 0, /* 0x05 .. 0x07 */
4663 "backspace", /* VK_BACK 0x08 */
4664 "tab", /* VK_TAB 0x09 */
4666 0, 0, /* 0x0A .. 0x0B */
4668 "clear", /* VK_CLEAR 0x0C */
4669 "return", /* VK_RETURN 0x0D */
4671 0, 0, /* 0x0E .. 0x0F */
4673 0, /* VK_SHIFT 0x10 */
4674 0, /* VK_CONTROL 0x11 */
4675 0, /* VK_MENU 0x12 */
4676 "pause", /* VK_PAUSE 0x13 */
4677 "capslock", /* VK_CAPITAL 0x14 */
4678 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4680 "junja", /* VK_JUNJA 0x17 */
4681 "final", /* VK_FINAL 0x18 */
4682 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4684 "escape", /* VK_ESCAPE 0x1B */
4685 "convert", /* VK_CONVERT 0x1C */
4686 "non-convert", /* VK_NONCONVERT 0x1D */
4687 "accept", /* VK_ACCEPT 0x1E */
4688 "mode-change", /* VK_MODECHANGE 0x1F */
4689 0, /* VK_SPACE 0x20 */
4690 "prior", /* VK_PRIOR 0x21 */
4691 "next", /* VK_NEXT 0x22 */
4692 "end", /* VK_END 0x23 */
4693 "home", /* VK_HOME 0x24 */
4694 "left", /* VK_LEFT 0x25 */
4695 "up", /* VK_UP 0x26 */
4696 "right", /* VK_RIGHT 0x27 */
4697 "down", /* VK_DOWN 0x28 */
4698 "select", /* VK_SELECT 0x29 */
4699 "print", /* VK_PRINT 0x2A */
4700 "execute", /* VK_EXECUTE 0x2B */
4701 "snapshot", /* VK_SNAPSHOT 0x2C */
4702 "insert", /* VK_INSERT 0x2D */
4703 "delete", /* VK_DELETE 0x2E */
4704 "help", /* VK_HELP 0x2F */
4706 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4708 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4710 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4712 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4714 0, 0, 0, 0, 0, 0, 0, 0, 0,
4715 0, 0, 0, 0, 0, 0, 0, 0, 0,
4716 0, 0, 0, 0, 0, 0, 0, 0,
4718 "lwindow", /* VK_LWIN 0x5B */
4719 "rwindow", /* VK_RWIN 0x5C */
4720 "apps", /* VK_APPS 0x5D */
4723 "kp-0", /* VK_NUMPAD0 0x60 */
4724 "kp-1", /* VK_NUMPAD1 0x61 */
4725 "kp-2", /* VK_NUMPAD2 0x62 */
4726 "kp-3", /* VK_NUMPAD3 0x63 */
4727 "kp-4", /* VK_NUMPAD4 0x64 */
4728 "kp-5", /* VK_NUMPAD5 0x65 */
4729 "kp-6", /* VK_NUMPAD6 0x66 */
4730 "kp-7", /* VK_NUMPAD7 0x67 */
4731 "kp-8", /* VK_NUMPAD8 0x68 */
4732 "kp-9", /* VK_NUMPAD9 0x69 */
4733 "kp-multiply", /* VK_MULTIPLY 0x6A */
4734 "kp-add", /* VK_ADD 0x6B */
4735 "kp-separator", /* VK_SEPARATOR 0x6C */
4736 "kp-subtract", /* VK_SUBTRACT 0x6D */
4737 "kp-decimal", /* VK_DECIMAL 0x6E */
4738 "kp-divide", /* VK_DIVIDE 0x6F */
4739 "f1", /* VK_F1 0x70 */
4740 "f2", /* VK_F2 0x71 */
4741 "f3", /* VK_F3 0x72 */
4742 "f4", /* VK_F4 0x73 */
4743 "f5", /* VK_F5 0x74 */
4744 "f6", /* VK_F6 0x75 */
4745 "f7", /* VK_F7 0x76 */
4746 "f8", /* VK_F8 0x77 */
4747 "f9", /* VK_F9 0x78 */
4748 "f10", /* VK_F10 0x79 */
4749 "f11", /* VK_F11 0x7A */
4750 "f12", /* VK_F12 0x7B */
4751 "f13", /* VK_F13 0x7C */
4752 "f14", /* VK_F14 0x7D */
4753 "f15", /* VK_F15 0x7E */
4754 "f16", /* VK_F16 0x7F */
4755 "f17", /* VK_F17 0x80 */
4756 "f18", /* VK_F18 0x81 */
4757 "f19", /* VK_F19 0x82 */
4758 "f20", /* VK_F20 0x83 */
4759 "f21", /* VK_F21 0x84 */
4760 "f22", /* VK_F22 0x85 */
4761 "f23", /* VK_F23 0x86 */
4762 "f24", /* VK_F24 0x87 */
4764 0, 0, 0, 0, /* 0x88 .. 0x8B */
4765 0, 0, 0, 0, /* 0x8C .. 0x8F */
4767 "kp-numlock", /* VK_NUMLOCK 0x90 */
4768 "scroll", /* VK_SCROLL 0x91 */
4769 /* Not sure where the following block comes from.
4770 Windows headers have NEC and Fujitsu specific keys in
4771 this block, but nothing generic. */
4772 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4773 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4774 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4775 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4776 "kp-end", /* VK_NUMPAD_END 0x96 */
4777 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4778 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4779 "kp-up", /* VK_NUMPAD_UP 0x99 */
4780 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4781 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4782 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4783 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4785 0, 0, /* 0x9E .. 0x9F */
4788 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4789 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4790 * No other API or message will distinguish left and right keys this way.
4795 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4796 to enable them selectively, and gives access to a few more functions.
4797 See lispy_multimedia_keys below. */
4798 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4799 0, 0, 0, /* 0xAD .. 0xAF Volume */
4800 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4801 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4803 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4804 0, 0, 0, 0, 0, 0, 0, 0, 0,
4806 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4807 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4808 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4811 "ax", /* VK_OEM_AX 0xE1 */
4812 0, /* VK_OEM_102 0xE2 */
4813 "ico-help", /* VK_ICO_HELP 0xE3 */
4814 "ico-00", /* VK_ICO_00 0xE4 */
4815 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4816 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4817 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4819 "reset", /* VK_OEM_RESET 0xE9 */
4820 "jump", /* VK_OEM_JUMP 0xEA */
4821 "oem-pa1", /* VK_OEM_PA1 0xEB */
4822 "oem-pa2", /* VK_OEM_PA2 0xEC */
4823 "oem-pa3", /* VK_OEM_PA3 0xED */
4824 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4825 "cusel", /* VK_OEM_CUSEL 0xEF */
4826 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4827 "finish", /* VK_OEM_FINISH 0xF1 */
4828 "copy", /* VK_OEM_COPY 0xF2 */
4829 "auto", /* VK_OEM_AUTO 0xF3 */
4830 "enlw", /* VK_OEM_ENLW 0xF4 */
4831 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4832 "attn", /* VK_ATTN 0xF6 */
4833 "crsel", /* VK_CRSEL 0xF7 */
4834 "exsel", /* VK_EXSEL 0xF8 */
4835 "ereof", /* VK_EREOF 0xF9 */
4836 "play", /* VK_PLAY 0xFA */
4837 "zoom", /* VK_ZOOM 0xFB */
4838 "noname", /* VK_NONAME 0xFC */
4839 "pa1", /* VK_PA1 0xFD */
4840 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4844 /* Some of these duplicate the "Media keys" on newer keyboards,
4845 but they are delivered to the application in a different way. */
4846 static const char *const lispy_multimedia_keys
[] =
4854 "browser-favorites",
4891 "toggle-dictate-command",
4897 "media-fast-forward",
4900 "media-channel-down"
4903 #else /* not HAVE_NTGUI */
4905 /* This should be dealt with in XTread_socket now, and that doesn't
4906 depend on the client system having the Kana syms defined. See also
4907 the XK_kana_A case below. */
4910 static const char *const lispy_kana_keys
[] =
4912 /* X Keysym value */
4913 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4914 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4915 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4916 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4917 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4918 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4919 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4920 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4921 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4922 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4923 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4924 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4925 "kana-i", "kana-u", "kana-e", "kana-o",
4926 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4927 "prolongedsound", "kana-A", "kana-I", "kana-U",
4928 "kana-E", "kana-O", "kana-KA", "kana-KI",
4929 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4930 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4931 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4932 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4933 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4934 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4935 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4936 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4937 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4938 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4939 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4940 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4942 #endif /* XK_kana_A */
4945 #define FUNCTION_KEY_OFFSET 0xff00
4947 /* You'll notice that this table is arranged to be conveniently
4948 indexed by X Windows keysym values. */
4949 static const char *const lispy_function_keys
[] =
4951 /* X Keysym value */
4953 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4954 "backspace", "tab", "linefeed", "clear",
4956 0, 0, 0, "pause", /* 0xff10...1f */
4957 0, 0, 0, 0, 0, 0, 0, "escape",
4959 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4960 "romaji", "hiragana", "katakana", "hiragana-katakana",
4961 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4962 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4963 "eisu-toggle", /* 0xff30...3f */
4964 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4965 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4967 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4968 "down", "prior", "next", "end",
4969 "begin", 0, 0, 0, 0, 0, 0, 0,
4970 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4981 "break", /* 0xff6b */
4984 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4985 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4986 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4987 0, 0, 0, 0, 0, 0, 0, 0,
4988 "kp-tab", /* 0xff89 */
4990 "kp-enter", /* 0xff8d */
4992 "kp-f1", /* 0xff91 */
4996 "kp-home", /* 0xff95 */
5001 "kp-prior", /* kp-page-up */
5002 "kp-next", /* kp-page-down */
5008 0, 0, 0, 0, 0, 0, 0, 0, 0,
5009 "kp-multiply", /* 0xffaa */
5014 "kp-divide", /* 0xffaf */
5015 "kp-0", /* 0xffb0 */
5016 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5019 "kp-equal", /* 0xffbd */
5020 "f1", /* 0xffbe */ /* IsFunctionKey */
5022 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5023 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5024 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5025 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5026 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5027 0, 0, 0, 0, 0, 0, 0, 0,
5028 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5029 0, 0, 0, 0, 0, 0, 0, "delete"
5032 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5033 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5035 static const char *const iso_lispy_function_keys
[] =
5037 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5038 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5039 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5040 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5041 "iso-lefttab", /* 0xfe20 */
5042 "iso-move-line-up", "iso-move-line-down",
5043 "iso-partial-line-up", "iso-partial-line-down",
5044 "iso-partial-space-left", "iso-partial-space-right",
5045 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5046 "iso-release-margin-left", "iso-release-margin-right",
5047 "iso-release-both-margins",
5048 "iso-fast-cursor-left", "iso-fast-cursor-right",
5049 "iso-fast-cursor-up", "iso-fast-cursor-down",
5050 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5051 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5054 #endif /* not HAVE_NTGUI */
5056 static Lisp_Object Vlispy_mouse_stem
;
5058 static const char *const lispy_wheel_names
[] =
5060 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5063 /* drag-n-drop events are generated when a set of selected files are
5064 dragged from another application and dropped onto an Emacs window. */
5065 static const char *const lispy_drag_n_drop_names
[] =
5070 /* Scroll bar parts. */
5071 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5072 Lisp_Object Qup
, Qdown
, Qbottom
;
5073 static Lisp_Object Qend_scroll
;
5075 static Lisp_Object Qratio
;
5077 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5078 static Lisp_Object
*const scroll_bar_parts
[] = {
5079 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5080 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5083 /* A vector, indexed by button number, giving the down-going location
5084 of currently depressed buttons, both scroll bar and non-scroll bar.
5086 The elements have the form
5087 (BUTTON-NUMBER MODIFIER-MASK . REST)
5088 where REST is the cdr of a position as it would be reported in the event.
5090 The make_lispy_event function stores positions here to tell the
5091 difference between click and drag events, and to store the starting
5092 location to be included in drag events. */
5094 static Lisp_Object button_down_location
;
5096 /* Information about the most recent up-going button event: Which
5097 button, what location, and what time. */
5099 static int last_mouse_button
;
5100 static int last_mouse_x
;
5101 static int last_mouse_y
;
5102 static Time button_down_time
;
5104 /* The number of clicks in this multiple-click. */
5106 static int double_click_count
;
5108 /* X and Y are frame-relative coordinates for a click or wheel event.
5109 Return a Lisp-style event list. */
5112 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5115 enum window_part part
;
5116 Lisp_Object posn
= Qnil
;
5117 Lisp_Object extra_info
= Qnil
;
5118 /* Coordinate pixel positions to return. */
5119 int xret
= 0, yret
= 0;
5120 /* The window under frame pixel coordinates (x,y) */
5121 Lisp_Object window
= f
5122 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5125 if (WINDOWP (window
))
5127 /* It's a click in window window at frame coordinates (x,y) */
5128 struct window
*w
= XWINDOW (window
);
5129 Lisp_Object string_info
= Qnil
;
5130 EMACS_INT textpos
= -1;
5131 int col
= -1, row
= -1;
5132 int dx
= -1, dy
= -1;
5133 int width
= -1, height
= -1;
5134 Lisp_Object object
= Qnil
;
5136 /* Pixel coordinates relative to the window corner. */
5137 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5138 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5140 /* For text area clicks, return X, Y relative to the corner of
5141 this text area. Note that dX, dY etc are set below, by
5142 buffer_posn_from_coords. */
5143 if (part
== ON_TEXT
)
5145 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5146 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5148 /* For mode line and header line clicks, return X, Y relative to
5149 the left window edge. Use mode_line_string to look for a
5150 string on the click position. */
5151 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5156 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5157 /* Note that mode_line_string takes COL, ROW as pixels and
5158 converts them to characters. */
5161 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5162 &object
, &dx
, &dy
, &width
, &height
);
5163 if (STRINGP (string
))
5164 string_info
= Fcons (string
, make_number (charpos
));
5165 textpos
= (w
== XWINDOW (selected_window
)
5166 && current_buffer
== XBUFFER (w
->buffer
))
5167 ? PT
: XMARKER (w
->pointm
)->charpos
;
5172 /* For fringes and margins, Y is relative to the area's (and the
5173 window's) top edge, while X is meaningless. */
5174 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5179 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5182 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5183 &object
, &dx
, &dy
, &width
, &height
);
5184 if (STRINGP (string
))
5185 string_info
= Fcons (string
, make_number (charpos
));
5186 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5188 else if (part
== ON_LEFT_FRINGE
)
5190 posn
= Qleft_fringe
;
5193 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5194 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5195 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5197 else if (part
== ON_RIGHT_FRINGE
)
5199 posn
= Qright_fringe
;
5202 - window_box_width (w
, LEFT_MARGIN_AREA
)
5203 - window_box_width (w
, TEXT_AREA
)
5204 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5205 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5207 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5209 else if (part
== ON_VERTICAL_BORDER
)
5211 posn
= Qvertical_line
;
5216 /* Nothing special for part == ON_SCROLL_BAR. */
5218 /* For clicks in the text area, fringes, or margins, call
5219 buffer_posn_from_coords to extract TEXTPOS, the buffer
5220 position nearest to the click. */
5223 Lisp_Object string2
, object2
= Qnil
;
5224 struct display_pos p
;
5226 int width2
, height2
;
5227 /* The pixel X coordinate passed to buffer_posn_from_coords
5228 is the X coordinate relative to the text area for
5229 text-area and right-margin clicks, zero otherwise. */
5231 = (part
== ON_TEXT
) ? xret
5232 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5233 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5237 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5238 &object2
, &dx2
, &dy2
,
5240 textpos
= CHARPOS (p
.pos
);
5241 if (col
< 0) col
= x2
;
5242 if (row
< 0) row
= y2
;
5243 if (dx
< 0) dx
= dx2
;
5244 if (dy
< 0) dy
= dy2
;
5245 if (width
< 0) width
= width2
;
5246 if (height
< 0) height
= height2
;
5250 posn
= make_number (textpos
);
5251 if (STRINGP (string2
))
5252 string_info
= Fcons (string2
,
5253 make_number (CHARPOS (p
.string_pos
)));
5259 #ifdef HAVE_WINDOW_SYSTEM
5260 if (IMAGEP (object
))
5262 Lisp_Object image_map
, hotspot
;
5263 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5265 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5267 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5268 posn
= XCAR (hotspot
);
5275 Fcons (make_number (dx
), make_number (dy
)),
5276 Fcons (make_number (width
), make_number (height
)));
5279 extra_info
= Fcons (string_info
,
5280 Fcons (make_number (textpos
),
5281 Fcons (Fcons (make_number (col
),
5286 XSETFRAME (window
, f
);
5290 return Fcons (window
,
5292 Fcons (Fcons (make_number (xret
),
5293 make_number (yret
)),
5294 Fcons (make_number (t
),
5298 /* Given a struct input_event, build the lisp event which represents
5299 it. If EVENT is 0, build a mouse movement event from the mouse
5300 movement buffer, which should have a movement event in it.
5302 Note that events must be passed to this function in the order they
5303 are received; this function stores the location of button presses
5304 in order to build drag events when the button is released. */
5307 make_lispy_event (struct input_event
*event
)
5311 switch (SWITCH_ENUM_CAST (event
->kind
))
5313 /* A simple keystroke. */
5314 case ASCII_KEYSTROKE_EVENT
:
5315 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5317 Lisp_Object lispy_c
;
5318 EMACS_INT c
= event
->code
;
5319 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5322 eassert (c
== event
->code
);
5323 /* Turn ASCII characters into control characters
5325 if (event
->modifiers
& ctrl_modifier
)
5327 c
= make_ctrl_char (c
);
5328 event
->modifiers
&= ~ctrl_modifier
;
5332 /* Add in the other modifier bits. The shift key was taken care
5333 of by the X code. */
5334 c
|= (event
->modifiers
5335 & (meta_modifier
| alt_modifier
5336 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5337 /* Distinguish Shift-SPC from SPC. */
5338 if ((event
->code
) == 040
5339 && event
->modifiers
& shift_modifier
)
5340 c
|= shift_modifier
;
5341 button_down_time
= 0;
5342 XSETFASTINT (lispy_c
, c
);
5347 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5348 except that they are non-key events (last-nonmenu-event is nil). */
5349 case NS_NONKEY_EVENT
:
5352 /* A function key. The symbol may need to have modifier prefixes
5354 case NON_ASCII_KEYSTROKE_EVENT
:
5355 button_down_time
= 0;
5357 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5358 if (event
->code
== lispy_accent_codes
[i
])
5359 return modify_event_symbol (i
,
5361 Qfunction_key
, Qnil
,
5362 lispy_accent_keys
, &accent_key_syms
,
5363 (sizeof (lispy_accent_keys
)
5364 / sizeof (lispy_accent_keys
[0])));
5368 if (event
->code
>= 0x400 && event
->code
< 0x500)
5369 return modify_event_symbol (event
->code
- 0x400,
5370 event
->modifiers
& ~shift_modifier
,
5371 Qfunction_key
, Qnil
,
5372 lispy_kana_keys
, &func_key_syms
,
5373 (sizeof (lispy_kana_keys
)
5374 / sizeof (lispy_kana_keys
[0])));
5375 #endif /* XK_kana_A */
5378 #ifdef ISO_FUNCTION_KEY_OFFSET
5379 if (event
->code
< FUNCTION_KEY_OFFSET
5380 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5381 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5383 Qfunction_key
, Qnil
,
5384 iso_lispy_function_keys
, &func_key_syms
,
5385 (sizeof (iso_lispy_function_keys
)
5386 / sizeof (iso_lispy_function_keys
[0])));
5389 /* Handle system-specific or unknown keysyms. */
5390 if (event
->code
& (1 << 28)
5391 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5392 || (event
->code
- FUNCTION_KEY_OFFSET
5393 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5394 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5396 /* We need to use an alist rather than a vector as the cache
5397 since we can't make a vector long enuf. */
5398 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5399 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5400 return modify_event_symbol (event
->code
,
5403 KVAR (current_kboard
, Vsystem_key_alist
),
5404 0, &KVAR (current_kboard
, system_key_syms
),
5405 TYPE_MAXIMUM (EMACS_INT
));
5408 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5410 Qfunction_key
, Qnil
,
5411 lispy_function_keys
, &func_key_syms
,
5412 (sizeof (lispy_function_keys
)
5413 / sizeof (lispy_function_keys
[0])));
5416 case MULTIMEDIA_KEY_EVENT
:
5417 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5418 / sizeof (lispy_multimedia_keys
[0]))
5419 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5421 return modify_event_symbol (event
->code
, event
->modifiers
,
5422 Qfunction_key
, Qnil
,
5423 lispy_multimedia_keys
, &func_key_syms
,
5424 (sizeof (lispy_multimedia_keys
)
5425 / sizeof (lispy_multimedia_keys
[0])));
5431 /* A mouse click. Figure out where it is, decide whether it's
5432 a press, click or drag, and build the appropriate structure. */
5433 case MOUSE_CLICK_EVENT
:
5434 #ifndef USE_TOOLKIT_SCROLL_BARS
5435 case SCROLL_BAR_CLICK_EVENT
:
5438 int button
= event
->code
;
5440 Lisp_Object position
;
5441 Lisp_Object
*start_pos_ptr
;
5442 Lisp_Object start_pos
;
5446 /* Build the position as appropriate for this mouse click. */
5447 if (event
->kind
== MOUSE_CLICK_EVENT
)
5449 struct frame
*f
= XFRAME (event
->frame_or_window
);
5450 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5454 /* Ignore mouse events that were made on frame that
5455 have been deleted. */
5456 if (! FRAME_LIVE_P (f
))
5459 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5460 /* EVENT->x and EVENT->y are frame-relative pixel
5461 coordinates at this place. Under old redisplay, COLUMN
5462 and ROW are set to frame relative glyph coordinates
5463 which are then used to determine whether this click is
5464 in a menu (non-toolkit version). */
5465 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5466 &column
, &row
, NULL
, 1);
5468 /* In the non-toolkit version, clicks on the menu bar
5469 are ordinary button events in the event buffer.
5470 Distinguish them, and invoke the menu.
5472 (In the toolkit version, the toolkit handles the menu bar
5473 and Emacs doesn't know about it until after the user
5474 makes a selection.) */
5475 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5476 && (event
->modifiers
& down_modifier
))
5478 Lisp_Object items
, item
;
5480 /* Find the menu bar item under `column'. */
5482 items
= FRAME_MENU_BAR_ITEMS (f
);
5483 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5485 Lisp_Object pos
, string
;
5486 string
= AREF (items
, i
+ 1);
5487 pos
= AREF (items
, i
+ 3);
5490 if (column
>= XINT (pos
)
5491 && column
< XINT (pos
) + SCHARS (string
))
5493 item
= AREF (items
, i
);
5498 /* ELisp manual 2.4b says (x y) are window relative but
5499 code says they are frame-relative. */
5501 = Fcons (event
->frame_or_window
,
5503 Fcons (Fcons (event
->x
, event
->y
),
5504 Fcons (make_number (event
->timestamp
),
5507 return Fcons (item
, Fcons (position
, Qnil
));
5509 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5511 position
= make_lispy_position (f
, event
->x
, event
->y
,
5514 #ifndef USE_TOOLKIT_SCROLL_BARS
5517 /* It's a scrollbar click. */
5519 Lisp_Object portion_whole
;
5522 window
= event
->frame_or_window
;
5523 portion_whole
= Fcons (event
->x
, event
->y
);
5524 part
= *scroll_bar_parts
[(int) event
->part
];
5528 Fcons (Qvertical_scroll_bar
,
5529 Fcons (portion_whole
,
5530 Fcons (make_number (event
->timestamp
),
5531 Fcons (part
, Qnil
)))));
5533 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5535 if (button
>= ASIZE (button_down_location
))
5537 button_down_location
= larger_vector (button_down_location
,
5539 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5542 start_pos_ptr
= &AREF (button_down_location
, button
);
5543 start_pos
= *start_pos_ptr
;
5544 *start_pos_ptr
= Qnil
;
5547 /* On window-system frames, use the value of
5548 double-click-fuzz as is. On other frames, interpret it
5549 as a multiple of 1/8 characters. */
5553 if (WINDOWP (event
->frame_or_window
))
5554 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5555 else if (FRAMEP (event
->frame_or_window
))
5556 f
= XFRAME (event
->frame_or_window
);
5560 if (FRAME_WINDOW_P (f
))
5561 fuzz
= double_click_fuzz
;
5563 fuzz
= double_click_fuzz
/ 8;
5565 is_double
= (button
== last_mouse_button
5566 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5567 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5568 && button_down_time
!= 0
5569 && (EQ (Vdouble_click_time
, Qt
)
5570 || (NATNUMP (Vdouble_click_time
)
5571 && (event
->timestamp
- button_down_time
5572 < XFASTINT (Vdouble_click_time
)))));
5575 last_mouse_button
= button
;
5576 last_mouse_x
= XINT (event
->x
);
5577 last_mouse_y
= XINT (event
->y
);
5579 /* If this is a button press, squirrel away the location, so
5580 we can decide later whether it was a click or a drag. */
5581 if (event
->modifiers
& down_modifier
)
5585 double_click_count
++;
5586 event
->modifiers
|= ((double_click_count
> 2)
5591 double_click_count
= 1;
5592 button_down_time
= event
->timestamp
;
5593 *start_pos_ptr
= Fcopy_alist (position
);
5594 ignore_mouse_drag_p
= 0;
5597 /* Now we're releasing a button - check the co-ordinates to
5598 see if this was a click or a drag. */
5599 else if (event
->modifiers
& up_modifier
)
5601 /* If we did not see a down before this up, ignore the up.
5602 Probably this happened because the down event chose a
5603 menu item. It would be an annoyance to treat the
5604 release of the button that chose the menu item as a
5607 if (!CONSP (start_pos
))
5610 event
->modifiers
&= ~up_modifier
;
5613 Lisp_Object new_down
, down
;
5614 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5616 /* The third element of every position
5617 should be the (x,y) pair. */
5618 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5619 new_down
= Fcar (Fcdr (Fcdr (position
)));
5622 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5624 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5625 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5628 if (ignore_mouse_drag_p
)
5630 event
->modifiers
|= click_modifier
;
5631 ignore_mouse_drag_p
= 0;
5633 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5634 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5635 /* Maybe the mouse has moved a lot, caused scrolling, and
5636 eventually ended up at the same screen position (but
5637 not buffer position) in which case it is a drag, not
5639 /* FIXME: OTOH if the buffer position has changed
5640 because of a timer or process filter rather than
5641 because of mouse movement, it should be considered as
5642 a click. But mouse-drag-region completely ignores
5643 this case and it hasn't caused any real problem, so
5644 it's probably OK to ignore it as well. */
5645 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5646 /* Mouse hasn't moved (much). */
5647 event
->modifiers
|= click_modifier
;
5650 button_down_time
= 0;
5651 event
->modifiers
|= drag_modifier
;
5654 /* Don't check is_double; treat this as multiple
5655 if the down-event was multiple. */
5656 if (double_click_count
> 1)
5657 event
->modifiers
|= ((double_click_count
> 2)
5663 /* Every mouse event should either have the down_modifier or
5664 the up_modifier set. */
5668 /* Get the symbol we should use for the mouse click. */
5671 head
= modify_event_symbol (button
,
5673 Qmouse_click
, Vlispy_mouse_stem
,
5676 ASIZE (mouse_syms
));
5677 if (event
->modifiers
& drag_modifier
)
5682 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5685 Fcons (make_number (double_click_count
),
5695 case HORIZ_WHEEL_EVENT
:
5697 Lisp_Object position
;
5700 /* Build the position as appropriate for this mouse click. */
5701 struct frame
*f
= XFRAME (event
->frame_or_window
);
5703 /* Ignore wheel events that were made on frame that have been
5705 if (! FRAME_LIVE_P (f
))
5708 position
= make_lispy_position (f
, event
->x
, event
->y
,
5711 /* Set double or triple modifiers to indicate the wheel speed. */
5713 /* On window-system frames, use the value of
5714 double-click-fuzz as is. On other frames, interpret it
5715 as a multiple of 1/8 characters. */
5721 if (WINDOWP (event
->frame_or_window
))
5722 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5723 else if (FRAMEP (event
->frame_or_window
))
5724 fr
= XFRAME (event
->frame_or_window
);
5728 fuzz
= FRAME_WINDOW_P (fr
)
5729 ? double_click_fuzz
: double_click_fuzz
/ 8;
5731 if (event
->modifiers
& up_modifier
)
5733 /* Emit a wheel-up event. */
5734 event
->modifiers
&= ~up_modifier
;
5737 else if (event
->modifiers
& down_modifier
)
5739 /* Emit a wheel-down event. */
5740 event
->modifiers
&= ~down_modifier
;
5744 /* Every wheel event should either have the down_modifier or
5745 the up_modifier set. */
5748 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5751 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5752 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5753 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5754 && button_down_time
!= 0
5755 && (EQ (Vdouble_click_time
, Qt
)
5756 || (NATNUMP (Vdouble_click_time
)
5757 && (event
->timestamp
- button_down_time
5758 < XFASTINT (Vdouble_click_time
)))));
5761 double_click_count
++;
5762 event
->modifiers
|= ((double_click_count
> 2)
5768 double_click_count
= 1;
5769 event
->modifiers
|= click_modifier
;
5772 button_down_time
= event
->timestamp
;
5773 /* Use a negative value to distinguish wheel from mouse button. */
5774 last_mouse_button
= - (1 + symbol_num
);
5775 last_mouse_x
= XINT (event
->x
);
5776 last_mouse_y
= XINT (event
->y
);
5778 /* Get the symbol we should use for the wheel event. */
5779 head
= modify_event_symbol (symbol_num
,
5785 ASIZE (wheel_syms
));
5788 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5791 Fcons (make_number (double_click_count
),
5800 #ifdef USE_TOOLKIT_SCROLL_BARS
5802 /* We don't have down and up events if using toolkit scroll bars,
5803 so make this always a click event. Store in the `part' of
5804 the Lisp event a symbol which maps to the following actions:
5806 `above_handle' page up
5807 `below_handle' page down
5811 `bottom' bottom of buffer
5812 `handle' thumb has been dragged.
5813 `end-scroll' end of interaction with scroll bar
5815 The incoming input_event contains in its `part' member an
5816 index of type `enum scroll_bar_part' which we can use as an
5817 index in scroll_bar_parts to get the appropriate symbol. */
5819 case SCROLL_BAR_CLICK_EVENT
:
5821 Lisp_Object position
, head
, window
, portion_whole
, part
;
5823 window
= event
->frame_or_window
;
5824 portion_whole
= Fcons (event
->x
, event
->y
);
5825 part
= *scroll_bar_parts
[(int) event
->part
];
5829 Fcons (Qvertical_scroll_bar
,
5830 Fcons (portion_whole
,
5831 Fcons (make_number (event
->timestamp
),
5832 Fcons (part
, Qnil
)))));
5834 /* Always treat scroll bar events as clicks. */
5835 event
->modifiers
|= click_modifier
;
5836 event
->modifiers
&= ~up_modifier
;
5838 if (event
->code
>= ASIZE (mouse_syms
))
5839 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5841 /* Get the symbol we should use for the mouse click. */
5842 head
= modify_event_symbol (event
->code
,
5847 ASIZE (mouse_syms
));
5848 return Fcons (head
, Fcons (position
, Qnil
));
5851 #endif /* USE_TOOLKIT_SCROLL_BARS */
5853 case DRAG_N_DROP_EVENT
:
5856 Lisp_Object head
, position
;
5859 f
= XFRAME (event
->frame_or_window
);
5862 /* Ignore mouse events that were made on frames that
5863 have been deleted. */
5864 if (! FRAME_LIVE_P (f
))
5867 position
= make_lispy_position (f
, event
->x
, event
->y
,
5870 head
= modify_event_symbol (0, event
->modifiers
,
5872 lispy_drag_n_drop_names
,
5873 &drag_n_drop_syms
, 1);
5879 #endif /* HAVE_MOUSE */
5881 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5882 || defined(HAVE_NS) || defined (USE_GTK)
5883 case MENU_BAR_EVENT
:
5884 if (EQ (event
->arg
, event
->frame_or_window
))
5885 /* This is the prefix key. We translate this to
5886 `(menu_bar)' because the code in keyboard.c for menu
5887 events, which we use, relies on this. */
5888 return Fcons (Qmenu_bar
, Qnil
);
5892 case SELECT_WINDOW_EVENT
:
5893 /* Make an event (select-window (WINDOW)). */
5894 return Fcons (Qselect_window
,
5895 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5898 case TOOL_BAR_EVENT
:
5899 if (EQ (event
->arg
, event
->frame_or_window
))
5900 /* This is the prefix key. We translate this to
5901 `(tool_bar)' because the code in keyboard.c for tool bar
5902 events, which we use, relies on this. */
5903 return Fcons (Qtool_bar
, Qnil
);
5904 else if (SYMBOLP (event
->arg
))
5905 return apply_modifiers (event
->modifiers
, event
->arg
);
5908 case USER_SIGNAL_EVENT
:
5909 /* A user signal. */
5911 char *name
= find_user_signal_name (event
->code
);
5914 return intern (name
);
5917 case SAVE_SESSION_EVENT
:
5918 return Qsave_session
;
5923 return Fcons (Qdbus_event
, event
->arg
);
5925 #endif /* HAVE_DBUS */
5927 case CONFIG_CHANGED_EVENT
:
5928 return Fcons (Qconfig_changed_event
,
5930 Fcons (event
->frame_or_window
, Qnil
)));
5932 case GPM_CLICK_EVENT
:
5934 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5935 Lisp_Object head
, position
;
5936 Lisp_Object
*start_pos_ptr
;
5937 Lisp_Object start_pos
;
5938 int button
= event
->code
;
5940 if (button
>= ASIZE (button_down_location
))
5942 button_down_location
= larger_vector (button_down_location
,
5944 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5947 start_pos_ptr
= &AREF (button_down_location
, button
);
5948 start_pos
= *start_pos_ptr
;
5950 position
= make_lispy_position (f
, event
->x
, event
->y
,
5953 if (event
->modifiers
& down_modifier
)
5954 *start_pos_ptr
= Fcopy_alist (position
);
5955 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5957 if (!CONSP (start_pos
))
5959 event
->modifiers
&= ~up_modifier
;
5962 head
= modify_event_symbol (button
,
5964 Qmouse_click
, Vlispy_mouse_stem
,
5967 ASIZE (mouse_syms
));
5969 if (event
->modifiers
& drag_modifier
)
5974 else if (event
->modifiers
& double_modifier
)
5977 Fcons (make_number (2),
5979 else if (event
->modifiers
& triple_modifier
)
5982 Fcons (make_number (3),
5989 #endif /* HAVE_GPM */
5991 /* The 'kind' field of the event is something we don't recognize. */
5997 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6000 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6001 Lisp_Object x
, Lisp_Object y
, Time t
)
6003 /* Is it a scroll bar movement? */
6004 if (frame
&& ! NILP (bar_window
))
6006 Lisp_Object part_sym
;
6008 part_sym
= *scroll_bar_parts
[(int) part
];
6009 return Fcons (Qscroll_bar_movement
,
6010 Fcons (list5 (bar_window
,
6011 Qvertical_scroll_bar
,
6017 /* Or is it an ordinary mouse movement? */
6020 Lisp_Object position
;
6021 position
= make_lispy_position (frame
, x
, y
, t
);
6022 return list2 (Qmouse_movement
, position
);
6026 #endif /* HAVE_MOUSE || HAVE GPM */
6028 /* Construct a switch frame event. */
6030 make_lispy_switch_frame (Lisp_Object frame
)
6032 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6035 /* Manipulating modifiers. */
6037 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6039 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6040 SYMBOL's name of the end of the modifiers; the string from this
6041 position is the unmodified symbol name.
6043 This doesn't use any caches. */
6046 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6052 CHECK_SYMBOL (symbol
);
6055 name
= SYMBOL_NAME (symbol
);
6057 for (i
= 0; i
+2 <= SBYTES (name
); )
6059 EMACS_INT this_mod_end
= 0;
6062 /* See if the name continues with a modifier word.
6063 Check that the word appears, but don't check what follows it.
6064 Set this_mod and this_mod_end to record what we find. */
6066 switch (SREF (name
, i
))
6068 #define SINGLE_LETTER_MOD(BIT) \
6069 (this_mod_end = i + 1, this_mod = BIT)
6072 SINGLE_LETTER_MOD (alt_modifier
);
6076 SINGLE_LETTER_MOD (ctrl_modifier
);
6080 SINGLE_LETTER_MOD (hyper_modifier
);
6084 SINGLE_LETTER_MOD (meta_modifier
);
6088 SINGLE_LETTER_MOD (shift_modifier
);
6092 SINGLE_LETTER_MOD (super_modifier
);
6095 #undef SINGLE_LETTER_MOD
6097 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6098 if (i + LEN + 1 <= SBYTES (name) \
6099 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6101 this_mod_end = i + LEN; \
6106 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6107 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6108 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6112 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6114 #undef MULTI_LETTER_MOD
6118 /* If we found no modifier, stop looking for them. */
6119 if (this_mod_end
== 0)
6122 /* Check there is a dash after the modifier, so that it
6123 really is a modifier. */
6124 if (this_mod_end
>= SBYTES (name
)
6125 || SREF (name
, this_mod_end
) != '-')
6128 /* This modifier is real; look for another. */
6129 modifiers
|= this_mod
;
6130 i
= this_mod_end
+ 1;
6133 /* Should we include the `click' modifier? */
6134 if (! (modifiers
& (down_modifier
| drag_modifier
6135 | double_modifier
| triple_modifier
))
6136 && i
+ 7 == SBYTES (name
)
6137 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6138 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6139 modifiers
|= click_modifier
;
6141 if (! (modifiers
& (double_modifier
| triple_modifier
))
6142 && i
+ 6 < SBYTES (name
)
6143 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6144 modifiers
|= click_modifier
;
6152 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6153 prepended to the string BASE[0..BASE_LEN-1].
6154 This doesn't use any caches. */
6156 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6158 /* Since BASE could contain nulls, we can't use intern here; we have
6159 to use Fintern, which expects a genuine Lisp_String, and keeps a
6162 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6168 /* Only the event queue may use the `up' modifier; it should always
6169 be turned into a click or drag event before presented to lisp code. */
6170 if (modifiers
& up_modifier
)
6173 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6174 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6175 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6176 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6177 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6178 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6179 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6180 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6181 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6182 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6183 /* The click modifier is denoted by the absence of other modifiers. */
6187 mod_len
= p
- new_mods
;
6191 Lisp_Object new_name
;
6193 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6194 mod_len
+ base_len_byte
);
6195 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6196 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6198 return Fintern (new_name
, Qnil
);
6203 static const char *const modifier_names
[] =
6205 "up", "down", "drag", "click", "double", "triple", 0, 0,
6206 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6207 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6209 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6211 static Lisp_Object modifier_symbols
;
6213 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6215 lispy_modifier_list (int modifiers
)
6217 Lisp_Object modifier_list
;
6220 modifier_list
= Qnil
;
6221 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6222 if (modifiers
& (1<<i
))
6223 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6226 return modifier_list
;
6230 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6231 where UNMODIFIED is the unmodified form of SYMBOL,
6232 MASK is the set of modifiers present in SYMBOL's name.
6233 This is similar to parse_modifiers_uncached, but uses the cache in
6234 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6235 Qevent_symbol_elements property. */
6237 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6240 parse_modifiers (Lisp_Object symbol
)
6242 Lisp_Object elements
;
6244 if (INTEGERP (symbol
))
6245 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6246 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6248 else if (!SYMBOLP (symbol
))
6251 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6252 if (CONSP (elements
))
6257 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6258 Lisp_Object unmodified
;
6261 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6262 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6265 if (modifiers
& ~INTMASK
)
6267 XSETFASTINT (mask
, modifiers
);
6268 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6270 /* Cache the parsing results on SYMBOL. */
6271 Fput (symbol
, Qevent_symbol_element_mask
,
6273 Fput (symbol
, Qevent_symbol_elements
,
6274 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6276 /* Since we know that SYMBOL is modifiers applied to unmodified,
6277 it would be nice to put that in unmodified's cache.
6278 But we can't, since we're not sure that parse_modifiers is
6285 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6286 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6287 doc
: /* Parse the event symbol. For internal use. */)
6288 (Lisp_Object symbol
)
6290 /* Fill the cache if needed. */
6291 parse_modifiers (symbol
);
6292 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6293 and use the Lispier representation stored on Qevent_symbol_elements
6295 return Fget (symbol
, Qevent_symbol_elements
);
6298 /* Apply the modifiers MODIFIERS to the symbol BASE.
6299 BASE must be unmodified.
6301 This is like apply_modifiers_uncached, but uses BASE's
6302 Qmodifier_cache property, if present. It also builds
6303 Qevent_symbol_elements properties, since it has that info anyway.
6305 apply_modifiers copies the value of BASE's Qevent_kind property to
6306 the modified symbol. */
6308 apply_modifiers (int modifiers
, Lisp_Object base
)
6310 Lisp_Object cache
, idx
, entry
, new_symbol
;
6312 /* Mask out upper bits. We don't know where this value's been. */
6313 modifiers
&= INTMASK
;
6315 if (INTEGERP (base
))
6316 return make_number (XINT (base
) | modifiers
);
6318 /* The click modifier never figures into cache indices. */
6319 cache
= Fget (base
, Qmodifier_cache
);
6320 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6321 entry
= assq_no_quit (idx
, cache
);
6324 new_symbol
= XCDR (entry
);
6327 /* We have to create the symbol ourselves. */
6328 new_symbol
= apply_modifiers_uncached (modifiers
,
6329 SSDATA (SYMBOL_NAME (base
)),
6330 SCHARS (SYMBOL_NAME (base
)),
6331 SBYTES (SYMBOL_NAME (base
)));
6333 /* Add the new symbol to the base's cache. */
6334 entry
= Fcons (idx
, new_symbol
);
6335 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6337 /* We have the parsing info now for free, so we could add it to
6339 XSETFASTINT (idx, modifiers);
6340 Fput (new_symbol, Qevent_symbol_element_mask,
6341 Fcons (base, Fcons (idx, Qnil)));
6342 Fput (new_symbol, Qevent_symbol_elements,
6343 Fcons (base, lispy_modifier_list (modifiers)));
6344 Sadly, this is only correct if `base' is indeed a base event,
6345 which is not necessarily the case. -stef */
6348 /* Make sure this symbol is of the same kind as BASE.
6350 You'd think we could just set this once and for all when we
6351 intern the symbol above, but reorder_modifiers may call us when
6352 BASE's property isn't set right; we can't assume that just
6353 because it has a Qmodifier_cache property it must have its
6354 Qevent_kind set right as well. */
6355 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6359 kind
= Fget (base
, Qevent_kind
);
6361 Fput (new_symbol
, Qevent_kind
, kind
);
6368 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6369 return a symbol with the modifiers placed in the canonical order.
6370 Canonical order is alphabetical, except for down and drag, which
6371 always come last. The 'click' modifier is never written out.
6373 Fdefine_key calls this to make sure that (for example) C-M-foo
6374 and M-C-foo end up being equivalent in the keymap. */
6377 reorder_modifiers (Lisp_Object symbol
)
6379 /* It's hopefully okay to write the code this way, since everything
6380 will soon be in caches, and no consing will be done at all. */
6383 parsed
= parse_modifiers (symbol
);
6384 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6389 /* For handling events, we often want to produce a symbol whose name
6390 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6391 to some base, like the name of a function key or mouse button.
6392 modify_event_symbol produces symbols of this sort.
6394 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6395 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6398 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6399 into symbol names, or a string specifying a name stem used to
6400 construct a symbol name or the form `STEM-N', where N is the decimal
6401 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6402 non-nil; otherwise NAME_TABLE is used.
6404 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6405 persist between calls to modify_event_symbol that it can use to
6406 store a cache of the symbols it's generated for this NAME_TABLE
6407 before. The object stored there may be a vector or an alist.
6409 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6411 MODIFIERS is a set of modifier bits (as given in struct input_events)
6412 whose prefixes should be applied to the symbol name.
6414 SYMBOL_KIND is the value to be placed in the event_kind property of
6415 the returned symbol.
6417 The symbols we create are supposed to have an
6418 `event-symbol-elements' property, which lists the modifiers present
6419 in the symbol's name. */
6422 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6423 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6424 Lisp_Object
*symbol_table
, EMACS_INT table_size
)
6427 Lisp_Object symbol_int
;
6429 /* Get rid of the "vendor-specific" bit here. */
6430 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6432 /* Is this a request for a valid symbol? */
6433 if (symbol_num
< 0 || symbol_num
>= table_size
)
6436 if (CONSP (*symbol_table
))
6437 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6439 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6440 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6441 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6442 we've never used that symbol before. */
6445 if (! VECTORP (*symbol_table
)
6446 || ASIZE (*symbol_table
) != table_size
)
6450 XSETFASTINT (size
, table_size
);
6451 *symbol_table
= Fmake_vector (size
, Qnil
);
6454 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6457 /* Have we already used this symbol before? */
6460 /* No; let's create it. */
6461 if (CONSP (name_alist_or_stem
))
6462 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6463 else if (STRINGP (name_alist_or_stem
))
6465 int len
= SBYTES (name_alist_or_stem
);
6466 char *buf
= (char *) alloca (len
+ 50);
6467 sprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6468 XINT (symbol_int
) + 1);
6469 value
= intern (buf
);
6471 else if (name_table
!= 0 && name_table
[symbol_num
])
6472 value
= intern (name_table
[symbol_num
]);
6474 #ifdef HAVE_WINDOW_SYSTEM
6477 char *name
= x_get_keysym_name (symbol_num
);
6479 value
= intern (name
);
6486 sprintf (buf
, "key-%"pI
"d", symbol_num
);
6487 value
= intern (buf
);
6490 if (CONSP (*symbol_table
))
6491 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6493 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6495 /* Fill in the cache entries for this symbol; this also
6496 builds the Qevent_symbol_elements property, which the user
6498 apply_modifiers (modifiers
& click_modifier
, value
);
6499 Fput (value
, Qevent_kind
, symbol_kind
);
6502 /* Apply modifiers to that symbol. */
6503 return apply_modifiers (modifiers
, value
);
6506 /* Convert a list that represents an event type,
6507 such as (ctrl meta backspace), into the usual representation of that
6508 event type as a number or a symbol. */
6510 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6511 doc
: /* Convert the event description list EVENT-DESC to an event type.
6512 EVENT-DESC should contain one base event type (a character or symbol)
6513 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6514 drag, down, double or triple). The base must be last.
6515 The return value is an event type (a character or symbol) which
6516 has the same base event type and all the specified modifiers. */)
6517 (Lisp_Object event_desc
)
6525 while (CONSP (rest
))
6533 /* Given a symbol, see if it is a modifier name. */
6534 if (SYMBOLP (elt
) && CONSP (rest
))
6535 this = parse_solitary_modifier (elt
);
6539 else if (!NILP (base
))
6540 error ("Two bases given in one event");
6546 /* Let the symbol A refer to the character A. */
6547 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6548 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6550 if (INTEGERP (base
))
6552 /* Turn (shift a) into A. */
6553 if ((modifiers
& shift_modifier
) != 0
6554 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6556 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6557 modifiers
&= ~shift_modifier
;
6560 /* Turn (control a) into C-a. */
6561 if (modifiers
& ctrl_modifier
)
6562 return make_number ((modifiers
& ~ctrl_modifier
)
6563 | make_ctrl_char (XINT (base
)));
6565 return make_number (modifiers
| XINT (base
));
6567 else if (SYMBOLP (base
))
6568 return apply_modifiers (modifiers
, base
);
6571 error ("Invalid base event");
6576 /* Try to recognize SYMBOL as a modifier name.
6577 Return the modifier flag bit, or 0 if not recognized. */
6580 parse_solitary_modifier (Lisp_Object symbol
)
6582 Lisp_Object name
= SYMBOL_NAME (symbol
);
6584 switch (SREF (name
, 0))
6586 #define SINGLE_LETTER_MOD(BIT) \
6587 if (SBYTES (name) == 1) \
6590 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6591 if (LEN == SBYTES (name) \
6592 && ! strncmp (SSDATA (name), NAME, LEN)) \
6596 SINGLE_LETTER_MOD (alt_modifier
);
6600 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6604 SINGLE_LETTER_MOD (ctrl_modifier
);
6608 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6609 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6613 SINGLE_LETTER_MOD (hyper_modifier
);
6617 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6621 SINGLE_LETTER_MOD (meta_modifier
);
6625 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6629 SINGLE_LETTER_MOD (shift_modifier
);
6633 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6634 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6635 SINGLE_LETTER_MOD (super_modifier
);
6639 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6640 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6641 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6645 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6648 #undef SINGLE_LETTER_MOD
6649 #undef MULTI_LETTER_MOD
6655 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6656 Such a list is not valid as an event,
6657 but it can be a Lucid-style event type list. */
6660 lucid_event_type_list_p (Lisp_Object object
)
6664 if (! CONSP (object
))
6667 if (EQ (XCAR (object
), Qhelp_echo
)
6668 || EQ (XCAR (object
), Qvertical_line
)
6669 || EQ (XCAR (object
), Qmode_line
)
6670 || EQ (XCAR (object
), Qheader_line
))
6673 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6677 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6684 /* Store into *addr a value nonzero if terminal input chars are available.
6685 Serves the purpose of ioctl (0, FIONREAD, addr)
6686 but works even if FIONREAD does not exist.
6687 (In fact, this may actually read some input.)
6689 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6690 timer events that are ripe.
6691 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6692 events (FOCUS_IN_EVENT).
6693 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6694 movements and toolkit scroll bar thumb drags. */
6697 get_input_pending (int *addr
, int flags
)
6699 /* First of all, have we already counted some input? */
6700 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6702 /* If input is being read as it arrives, and we have none, there is none. */
6703 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6706 /* Try to read some input and see how much we get. */
6708 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6711 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6714 gobble_input (int expected
)
6717 if (interrupt_input
)
6720 mask
= sigblock (sigmask (SIGIO
));
6721 read_avail_input (expected
);
6725 #ifdef POLL_FOR_INPUT
6726 /* XXX This condition was (read_socket_hook && !interrupt_input),
6727 but read_socket_hook is not global anymore. Let's pretend that
6729 if (!interrupt_input
&& poll_suppress_count
== 0)
6732 mask
= sigblock (sigmask (SIGALRM
));
6733 read_avail_input (expected
);
6739 read_avail_input (expected
);
6742 /* Put a BUFFER_SWITCH_EVENT in the buffer
6743 so that read_key_sequence will notice the new current buffer. */
6746 record_asynch_buffer_change (void)
6748 struct input_event event
;
6752 event
.kind
= BUFFER_SWITCH_EVENT
;
6753 event
.frame_or_window
= Qnil
;
6756 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6757 The purpose of the event is to make read_key_sequence look up the
6758 keymaps again. If we aren't in read_key_sequence, we don't need one,
6759 and the event could cause trouble by messing up (input-pending-p).
6760 Note: Fwaiting_for_user_input_p always returns nil when async
6761 subprocesses aren't supported. */
6762 tem
= Fwaiting_for_user_input_p ();
6766 /* Make sure no interrupt happens while storing the event. */
6768 if (interrupt_input
)
6771 mask
= sigblock (sigmask (SIGIO
));
6772 kbd_buffer_store_event (&event
);
6779 kbd_buffer_store_event (&event
);
6784 /* Read any terminal input already buffered up by the system
6785 into the kbd_buffer, but do not wait.
6787 EXPECTED should be nonzero if the caller knows there is some input.
6789 Returns the number of keyboard chars read, or -1 meaning
6790 this is a bad time to try to read input. */
6793 read_avail_input (int expected
)
6799 /* Store pending user signal events, if any. */
6800 if (store_user_signal_events ())
6803 /* Loop through the available terminals, and call their input hooks. */
6807 struct terminal
*next
= t
->next_terminal
;
6809 if (t
->read_socket_hook
)
6812 struct input_event hold_quit
;
6814 EVENT_INIT (hold_quit
);
6815 hold_quit
.kind
= NO_EVENT
;
6817 /* No need for FIONREAD or fcntl; just say don't wait. */
6818 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6824 if (nr
== -1) /* Not OK to read input now. */
6828 else if (nr
== -2) /* Non-transient error. */
6830 /* The terminal device terminated; it should be closed. */
6832 /* Kill Emacs if this was our last terminal. */
6833 if (!terminal_list
->next_terminal
)
6834 /* Formerly simply reported no input, but that
6835 sometimes led to a failure of Emacs to terminate.
6836 SIGHUP seems appropriate if we can't reach the
6838 /* ??? Is it really right to send the signal just to
6839 this process rather than to the whole process
6840 group? Perhaps on systems with FIONREAD Emacs is
6841 alone in its group. */
6842 kill (getpid (), SIGHUP
);
6844 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6847 XSETTERMINAL (tmp
, t
);
6848 Fdelete_terminal (tmp
, Qnoelisp
);
6852 if (hold_quit
.kind
!= NO_EVENT
)
6853 kbd_buffer_store_event (&hold_quit
);
6862 frame_make_pointer_visible ();
6868 decode_keyboard_code (struct tty_display_info
*tty
,
6869 struct coding_system
*coding
,
6870 unsigned char *buf
, int nbytes
)
6872 unsigned char *src
= buf
;
6873 const unsigned char *p
;
6878 if (tty
->meta_key
!= 2)
6879 for (i
= 0; i
< nbytes
; i
++)
6881 if (coding
->carryover_bytes
> 0)
6883 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6884 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6885 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6886 nbytes
+= coding
->carryover_bytes
;
6888 coding
->destination
= alloca (nbytes
* 4);
6889 coding
->dst_bytes
= nbytes
* 4;
6890 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6891 if (coding
->produced_char
== 0)
6893 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6895 struct input_event event_buf
;
6897 EVENT_INIT (event_buf
);
6898 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6900 (ASCII_CHAR_P (event_buf
.code
)
6901 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6902 /* See the comment in tty_read_avail_input. */
6903 event_buf
.frame_or_window
= tty
->top_frame
;
6904 event_buf
.arg
= Qnil
;
6905 kbd_buffer_store_event (&event_buf
);
6909 /* This is the tty way of reading available input.
6911 Note that each terminal device has its own `struct terminal' object,
6912 and so this function is called once for each individual termcap
6913 terminal. The first parameter indicates which terminal to read from. */
6916 tty_read_avail_input (struct terminal
*terminal
,
6918 struct input_event
*hold_quit
)
6920 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6921 the kbd_buffer can really hold. That may prevent loss
6922 of characters on some systems when input is stuffed at us. */
6923 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6925 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6928 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6930 if (kbd_on_hold_p () || buffer_free
<= 0)
6932 #endif /* subprocesses */
6934 if (!terminal
->name
) /* Don't read from a dead terminal. */
6937 if (terminal
->type
!= output_termcap
6938 && terminal
->type
!= output_msdos_raw
)
6941 /* XXX I think the following code should be moved to separate hook
6942 functions in system-dependent files. */
6945 #else /* not WINDOWSNT */
6946 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6950 return 0; /* The terminal is suspended. */
6953 n_to_read
= dos_keysns ();
6957 cbuf
[0] = dos_keyread ();
6960 #else /* not MSDOS */
6965 struct input_event gpm_hold_quit
;
6966 int gpm
, fd
= gpm_fd
;
6968 EVENT_INIT (gpm_hold_quit
);
6969 gpm_hold_quit
.kind
= NO_EVENT
;
6971 /* gpm==1 if event received.
6972 gpm==0 if the GPM daemon has closed the connection, in which case
6973 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6974 we save it in `fd' so close_gpm can remove it from the
6976 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6977 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6978 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6981 /* Presumably the GPM daemon has closed the connection. */
6983 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6984 kbd_buffer_store_event (&gpm_hold_quit
);
6988 #endif /* HAVE_GPM */
6990 /* Determine how many characters we should *try* to read. */
6992 /* Find out how much input is available. */
6993 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6995 if (! noninteractive
)
6996 return -2; /* Close this terminal. */
7002 if (n_to_read
> sizeof cbuf
)
7003 n_to_read
= sizeof cbuf
;
7004 #else /* no FIONREAD */
7005 #if defined (USG) || defined(CYGWIN)
7006 /* Read some input if available, but don't wait. */
7007 n_to_read
= sizeof cbuf
;
7008 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7015 /* Don't read more than we can store. */
7016 if (n_to_read
> buffer_free
)
7017 n_to_read
= buffer_free
;
7018 #endif /* subprocesses */
7020 /* Now read; for one reason or another, this will not block.
7021 NREAD is set to the number of chars read. */
7024 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7025 /* POSIX infers that processes which are not in the session leader's
7026 process group won't get SIGHUP's at logout time. BSDI adheres to
7027 this part standard and returns -1 from read (0) with errno==EIO
7028 when the control tty is taken away.
7029 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7030 if (nread
== -1 && errno
== EIO
)
7031 return -2; /* Close this terminal. */
7032 #if defined (AIX) && defined (_BSD)
7033 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7034 This looks incorrect, but it isn't, because _BSD causes
7035 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7036 and that causes a value other than 0 when there is no input. */
7038 return -2; /* Close this terminal. */
7042 /* We used to retry the read if it was interrupted.
7043 But this does the wrong thing when O_NDELAY causes
7044 an EAGAIN error. Does anybody know of a situation
7045 where a retry is actually needed? */
7047 nread
< 0 && (errno
== EAGAIN
7061 #if defined (USG) || defined (CYGWIN)
7062 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7063 #endif /* USG or CYGWIN */
7064 #endif /* no FIONREAD */
7069 #endif /* not MSDOS */
7070 #endif /* not WINDOWSNT */
7072 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7073 & CODING_REQUIRE_DECODING_MASK
)
7075 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7078 /* Decode the key sequence except for those with meta
7080 for (i
= from
= 0; ; i
++)
7081 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7083 struct input_event buf
;
7085 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7090 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7091 buf
.modifiers
= meta_modifier
;
7092 buf
.code
= cbuf
[i
] & ~0x80;
7093 /* See the comment below. */
7094 buf
.frame_or_window
= tty
->top_frame
;
7096 kbd_buffer_store_event (&buf
);
7102 for (i
= 0; i
< nread
; i
++)
7104 struct input_event buf
;
7106 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7108 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7109 buf
.modifiers
= meta_modifier
;
7110 if (tty
->meta_key
!= 2)
7114 /* Set the frame corresponding to the active tty. Note that the
7115 value of selected_frame is not reliable here, redisplay tends
7116 to temporarily change it. */
7117 buf
.frame_or_window
= tty
->top_frame
;
7120 kbd_buffer_store_event (&buf
);
7121 /* Don't look at input that follows a C-g too closely.
7122 This reduces lossage due to autorepeat on C-g. */
7123 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7124 && buf
.code
== quit_char
)
7132 handle_async_input (void)
7134 interrupt_input_pending
= 0;
7136 pending_signals
= pending_atimers
;
7138 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7139 doing anything dangerous. */
7146 nread
= read_avail_input (1);
7147 /* -1 means it's not ok to read the input now.
7148 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7149 0 means there was no keyboard input available. */
7159 process_pending_signals (void)
7161 if (interrupt_input_pending
)
7162 handle_async_input ();
7163 do_pending_atimers ();
7166 #ifdef SIGIO /* for entire page */
7167 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7170 input_available_signal (int signo
)
7172 /* Must preserve main program's value of errno. */
7173 int old_errno
= errno
;
7174 SIGNAL_THREAD_CHECK (signo
);
7177 interrupt_input_pending
= 1;
7178 pending_signals
= 1;
7181 if (input_available_clear_time
)
7182 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7185 handle_async_input ();
7192 /* Send ourselves a SIGIO.
7194 This function exists so that the UNBLOCK_INPUT macro in
7195 blockinput.h can have some way to take care of input we put off
7196 dealing with, without assuming that every file which uses
7197 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7199 reinvoke_input_signal (void)
7202 handle_async_input ();
7208 /* User signal events. */
7210 struct user_signal_info
7212 /* Signal number. */
7215 /* Name of the signal. */
7218 /* Number of pending signals. */
7221 struct user_signal_info
*next
;
7224 /* List of user signals. */
7225 static struct user_signal_info
*user_signals
= NULL
;
7228 add_user_signal (int sig
, const char *name
)
7230 struct user_signal_info
*p
;
7232 for (p
= user_signals
; p
; p
= p
->next
)
7234 /* Already added. */
7237 p
= xmalloc (sizeof (struct user_signal_info
));
7239 p
->name
= xstrdup (name
);
7241 p
->next
= user_signals
;
7244 signal (sig
, handle_user_signal
);
7248 handle_user_signal (int sig
)
7250 int old_errno
= errno
;
7251 struct user_signal_info
*p
;
7252 const char *special_event_name
= NULL
;
7254 SIGNAL_THREAD_CHECK (sig
);
7256 if (SYMBOLP (Vdebug_on_event
))
7257 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7259 for (p
= user_signals
; p
; p
= p
->next
)
7262 if (special_event_name
&&
7263 strcmp (special_event_name
, p
->name
) == 0)
7265 /* Enter the debugger in many ways. */
7266 debug_on_next_call
= 1;
7269 Vinhibit_quit
= Qnil
;
7271 /* Eat the event. */
7277 if (interrupt_input
)
7278 kill (getpid (), SIGIO
);
7282 /* Tell wait_reading_process_output that it needs to wake
7283 up and look around. */
7284 if (input_available_clear_time
)
7285 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7294 find_user_signal_name (int sig
)
7296 struct user_signal_info
*p
;
7298 for (p
= user_signals
; p
; p
= p
->next
)
7306 store_user_signal_events (void)
7308 struct user_signal_info
*p
;
7309 struct input_event buf
;
7312 for (p
= user_signals
; p
; p
= p
->next
)
7313 if (p
->npending
> 0)
7319 memset (&buf
, 0, sizeof buf
);
7320 buf
.kind
= USER_SIGNAL_EVENT
;
7321 buf
.frame_or_window
= selected_frame
;
7323 nstored
+= p
->npending
;
7325 mask
= sigblock (sigmask (p
->sig
));
7329 kbd_buffer_store_event (&buf
);
7332 while (p
->npending
> 0);
7340 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7341 static Lisp_Object menu_bar_one_keymap_changed_items
;
7343 /* These variables hold the vector under construction within
7344 menu_bar_items and its subroutines, and the current index
7345 for storing into that vector. */
7346 static Lisp_Object menu_bar_items_vector
;
7347 static int menu_bar_items_index
;
7350 static const char* separator_names
[] = {
7355 "single-dashed-line",
7356 "double-dashed-line",
7358 "shadow-etched-out",
7359 "shadow-etched-in-dash",
7360 "shadow-etched-out-dash",
7361 "shadow-double-etched-in",
7362 "shadow-double-etched-out",
7363 "shadow-double-etched-in-dash",
7364 "shadow-double-etched-out-dash",
7368 /* Return non-zero if LABEL specifies a separator. */
7371 menu_separator_name_p (const char *label
)
7375 else if (strlen (label
) > 3
7376 && strncmp (label
, "--", 2) == 0
7381 for (i
= 0; separator_names
[i
]; ++i
)
7382 if (strcmp (label
, separator_names
[i
]) == 0)
7387 /* It's a separator if it contains only dashes. */
7388 while (*label
== '-')
7390 return (*label
== 0);
7397 /* Return a vector of menu items for a menu bar, appropriate
7398 to the current buffer. Each item has three elements in the vector:
7401 OLD is an old vector we can optionally reuse, or nil. */
7404 menu_bar_items (Lisp_Object old
)
7406 /* The number of keymaps we're scanning right now, and the number of
7407 keymaps we have allocated space for. */
7410 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7411 in the current keymaps, or nil where it is not a prefix. */
7414 Lisp_Object def
, tail
;
7419 /* In order to build the menus, we need to call the keymap
7420 accessors. They all call QUIT. But this function is called
7421 during redisplay, during which a quit is fatal. So inhibit
7422 quitting while building the menus.
7423 We do this instead of specbind because (1) errors will clear it anyway
7424 and (2) this avoids risk of specpdl overflow. */
7425 oquit
= Vinhibit_quit
;
7429 menu_bar_items_vector
= old
;
7431 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7432 menu_bar_items_index
= 0;
7434 /* Build our list of keymaps.
7435 If we recognize a function key and replace its escape sequence in
7436 keybuf with its symbol, or if the sequence starts with a mouse
7437 click and we need to switch buffers, we jump back here to rebuild
7438 the initial keymaps from the current buffer. */
7442 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7443 if (!NILP (Voverriding_local_map_menu_flag
))
7445 /* Yes, use them (if non-nil) as well as the global map. */
7446 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7448 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7449 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7450 if (!NILP (Voverriding_local_map
))
7451 maps
[nmaps
++] = Voverriding_local_map
;
7455 /* No, so use major and minor mode keymaps and keymap property.
7456 Note that menu-bar bindings in the local-map and keymap
7457 properties may not work reliable, as they are only
7458 recognized when the menu-bar (or mode-line) is updated,
7459 which does not normally happen after every command. */
7462 nminor
= current_minor_maps (NULL
, &tmaps
);
7463 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7465 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7466 maps
[nmaps
++] = tem
;
7467 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7469 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7471 maps
[nmaps
++] = current_global_map
;
7474 /* Look up in each map the dummy prefix key `menu-bar'. */
7476 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7477 if (!NILP (maps
[mapno
]))
7479 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7483 menu_bar_one_keymap_changed_items
= Qnil
;
7484 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7488 /* Move to the end those items that should be at the end. */
7490 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7493 int end
= menu_bar_items_index
;
7495 for (i
= 0; i
< end
; i
+= 4)
7496 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7498 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7499 /* Move the item at index I to the end,
7500 shifting all the others forward. */
7501 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7502 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7503 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7504 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7506 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7507 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7508 (end
- i
- 4) * sizeof (Lisp_Object
));
7509 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7510 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7511 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7512 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7517 /* Add nil, nil, nil, nil at the end. */
7519 int i
= menu_bar_items_index
;
7520 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7521 menu_bar_items_vector
=
7522 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7523 /* Add this item. */
7524 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7525 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7526 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7527 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7528 menu_bar_items_index
= i
;
7531 Vinhibit_quit
= oquit
;
7532 return menu_bar_items_vector
;
7535 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7536 If there's already an item for KEY, add this DEF to it. */
7538 Lisp_Object item_properties
;
7541 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7543 struct gcpro gcpro1
;
7547 if (EQ (item
, Qundefined
))
7549 /* If a map has an explicit `undefined' as definition,
7550 discard any previously made menu bar item. */
7552 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7553 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7555 if (menu_bar_items_index
> i
+ 4)
7556 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7557 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7558 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7559 menu_bar_items_index
-= 4;
7563 /* If this keymap has already contributed to this KEY,
7564 don't contribute to it a second time. */
7565 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7566 if (!NILP (tem
) || NILP (item
))
7569 menu_bar_one_keymap_changed_items
7570 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7572 /* We add to menu_bar_one_keymap_changed_items before doing the
7573 parse_menu_item, so that if it turns out it wasn't a menu item,
7574 it still correctly hides any further menu item. */
7576 i
= parse_menu_item (item
, 1);
7581 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7583 /* Find any existing item for this KEY. */
7584 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7585 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7588 /* If we did not find this KEY, add it at the end. */
7589 if (i
== menu_bar_items_index
)
7591 /* If vector is too small, get a bigger one. */
7592 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7593 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7594 /* Add this item. */
7595 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7596 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7597 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7598 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7599 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7600 menu_bar_items_index
= i
;
7602 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7606 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7607 /* If the new and the old items are not both keymaps,
7608 the lookup will only find `item'. */
7609 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7610 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7614 /* This is used as the handler when calling menu_item_eval_property. */
7616 menu_item_eval_property_1 (Lisp_Object arg
)
7618 /* If we got a quit from within the menu computation,
7619 quit all the way out of it. This takes care of C-] in the debugger. */
7620 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7621 Fsignal (Qquit
, Qnil
);
7627 eval_dyn (Lisp_Object form
)
7629 return Feval (form
, Qnil
);
7632 /* Evaluate an expression and return the result (or nil if something
7633 went wrong). Used to evaluate dynamic parts of menu items. */
7635 menu_item_eval_property (Lisp_Object sexpr
)
7637 int count
= SPECPDL_INDEX ();
7639 specbind (Qinhibit_redisplay
, Qt
);
7640 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7641 menu_item_eval_property_1
);
7642 return unbind_to (count
, val
);
7645 /* This function parses a menu item and leaves the result in the
7646 vector item_properties.
7647 ITEM is a key binding, a possible menu item.
7648 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7650 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7651 parse_menu_item returns true if the item is a menu item and false
7655 parse_menu_item (Lisp_Object item
, int inmenubar
)
7657 Lisp_Object def
, tem
, item_string
, start
;
7659 Lisp_Object keyhint
;
7668 /* Create item_properties vector if necessary. */
7669 if (NILP (item_properties
))
7671 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7673 /* Initialize optional entries. */
7674 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7675 ASET (item_properties
, i
, Qnil
);
7676 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7678 /* Save the item here to protect it from GC. */
7679 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7681 item_string
= XCAR (item
);
7685 if (STRINGP (item_string
))
7687 /* Old format menu item. */
7688 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7690 /* Maybe help string. */
7691 if (CONSP (item
) && STRINGP (XCAR (item
)))
7693 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7698 /* Maybe an obsolete key binding cache. */
7699 if (CONSP (item
) && CONSP (XCAR (item
))
7700 && (NILP (XCAR (XCAR (item
)))
7701 || VECTORP (XCAR (XCAR (item
)))))
7704 /* This is the real definition--the function to run. */
7705 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7707 /* Get enable property, if any. */
7710 tem
= Fget (item
, Qmenu_enable
);
7711 if (!NILP (Venable_disabled_menus_and_buttons
))
7712 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7713 else if (!NILP (tem
))
7714 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7717 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7719 /* New format menu item. */
7720 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7721 start
= XCDR (item
);
7724 /* We have a real binding. */
7725 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7727 item
= XCDR (start
);
7728 /* Is there an obsolete cache list with key equivalences. */
7729 if (CONSP (item
) && CONSP (XCAR (item
)))
7732 /* Parse properties. */
7733 while (CONSP (item
) && CONSP (XCDR (item
)))
7738 if (EQ (tem
, QCenable
))
7740 if (!NILP (Venable_disabled_menus_and_buttons
))
7741 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7743 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7745 else if (EQ (tem
, QCvisible
))
7747 /* If got a visible property and that evaluates to nil
7748 then ignore this item. */
7749 tem
= menu_item_eval_property (XCAR (item
));
7753 else if (EQ (tem
, QChelp
))
7754 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7755 else if (EQ (tem
, QCfilter
))
7757 else if (EQ (tem
, QCkey_sequence
))
7760 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7761 /* Be GC protected. Set keyhint to item instead of tem. */
7764 else if (EQ (tem
, QCkeys
))
7767 if (CONSP (tem
) || STRINGP (tem
))
7768 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7770 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7775 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7777 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7779 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7785 else if (inmenubar
|| !NILP (start
))
7789 return 0; /* not a menu item */
7791 /* If item string is not a string, evaluate it to get string.
7792 If we don't get a string, skip this item. */
7793 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7794 if (!(STRINGP (item_string
)))
7796 item_string
= menu_item_eval_property (item_string
);
7797 if (!STRINGP (item_string
))
7799 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7802 /* If got a filter apply it on definition. */
7803 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7806 def
= menu_item_eval_property (list2 (XCAR (filter
),
7807 list2 (Qquote
, def
)));
7809 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7812 /* Enable or disable selection of item. */
7813 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7816 tem
= menu_item_eval_property (tem
);
7817 if (inmenubar
&& NILP (tem
))
7818 return 0; /* Ignore disabled items in menu bar. */
7819 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7822 /* If we got no definition, this item is just unselectable text which
7823 is OK in a submenu but not in the menubar. */
7825 return (!inmenubar
);
7827 /* See if this is a separate pane or a submenu. */
7828 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7829 tem
= get_keymap (def
, 0, 1);
7830 /* For a subkeymap, just record its details and exit. */
7833 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7834 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7838 /* At the top level in the menu bar, do likewise for commands also.
7839 The menu bar does not display equivalent key bindings anyway.
7840 ITEM_PROPERTY_DEF is already set up properly. */
7844 { /* This is a command. See if there is an equivalent key binding. */
7845 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7847 /* The previous code preferred :key-sequence to :keys, so we
7848 preserve this behavior. */
7849 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7850 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7853 Lisp_Object prefix
= keyeq
;
7854 Lisp_Object keys
= Qnil
;
7858 def
= XCAR (prefix
);
7859 prefix
= XCDR (prefix
);
7862 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7864 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7866 keys
= XCAR (keyhint
);
7867 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7869 /* We have a suggested key. Is it bound to the command? */
7872 /* If the command is an alias for another
7873 (such as lmenu.el set it up), check if the
7874 original command matches the cached command. */
7875 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7880 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7884 tem
= Fkey_description (keys
, Qnil
);
7887 if (STRINGP (XCAR (prefix
)))
7888 tem
= concat2 (XCAR (prefix
), tem
);
7889 if (STRINGP (XCDR (prefix
)))
7890 tem
= concat2 (tem
, XCDR (prefix
));
7892 keyeq
= concat2 (build_string (" "), tem
);
7893 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7899 /* If we have an equivalent key binding, use that. */
7900 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7903 /* Include this when menu help is implemented.
7904 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7905 if (!(NILP (tem) || STRINGP (tem)))
7907 tem = menu_item_eval_property (tem);
7910 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7914 /* Handle radio buttons or toggle boxes. */
7915 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7917 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7918 menu_item_eval_property (tem
));
7925 /***********************************************************************
7927 ***********************************************************************/
7929 /* A vector holding tool bar items while they are parsed in function
7930 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7933 static Lisp_Object tool_bar_items_vector
;
7935 /* A vector holding the result of parse_tool_bar_item. Layout is like
7936 the one for a single item in tool_bar_items_vector. */
7938 static Lisp_Object tool_bar_item_properties
;
7940 /* Next free index in tool_bar_items_vector. */
7942 static int ntool_bar_items
;
7944 /* The symbols `:image' and `:rtl'. */
7946 static Lisp_Object QCimage
;
7947 static Lisp_Object QCrtl
;
7949 /* Function prototypes. */
7951 static void init_tool_bar_items (Lisp_Object
);
7952 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7953 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7954 static void append_tool_bar_item (void);
7957 /* Return a vector of tool bar items for keymaps currently in effect.
7958 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7959 tool bar items found. */
7962 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7971 /* In order to build the menus, we need to call the keymap
7972 accessors. They all call QUIT. But this function is called
7973 during redisplay, during which a quit is fatal. So inhibit
7974 quitting while building the menus. We do this instead of
7975 specbind because (1) errors will clear it anyway and (2) this
7976 avoids risk of specpdl overflow. */
7977 oquit
= Vinhibit_quit
;
7980 /* Initialize tool_bar_items_vector and protect it from GC. */
7981 init_tool_bar_items (reuse
);
7983 /* Build list of keymaps in maps. Set nmaps to the number of maps
7986 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7987 if (!NILP (Voverriding_local_map_menu_flag
))
7989 /* Yes, use them (if non-nil) as well as the global map. */
7990 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7992 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7993 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7994 if (!NILP (Voverriding_local_map
))
7995 maps
[nmaps
++] = Voverriding_local_map
;
7999 /* No, so use major and minor mode keymaps and keymap property.
8000 Note that tool-bar bindings in the local-map and keymap
8001 properties may not work reliable, as they are only
8002 recognized when the tool-bar (or mode-line) is updated,
8003 which does not normally happen after every command. */
8006 nminor
= current_minor_maps (NULL
, &tmaps
);
8007 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8009 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8010 maps
[nmaps
++] = tem
;
8011 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8013 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8016 /* Add global keymap at the end. */
8017 maps
[nmaps
++] = current_global_map
;
8019 /* Process maps in reverse order and look up in each map the prefix
8021 for (i
= nmaps
- 1; i
>= 0; --i
)
8022 if (!NILP (maps
[i
]))
8026 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8028 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8031 Vinhibit_quit
= oquit
;
8032 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8033 return tool_bar_items_vector
;
8037 /* Process the definition of KEY which is DEF. */
8040 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8043 struct gcpro gcpro1
, gcpro2
;
8045 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8049 if (EQ (def
, Qundefined
))
8051 /* If a map has an explicit `undefined' as definition,
8052 discard any previously made item. */
8053 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8055 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8057 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8059 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8060 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8061 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8062 * sizeof (Lisp_Object
)));
8063 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8068 else if (parse_tool_bar_item (key
, def
))
8069 /* Append a new tool bar item to tool_bar_items_vector. Accept
8070 more than one definition for the same key. */
8071 append_tool_bar_item ();
8077 /* Parse a tool bar item specification ITEM for key KEY and return the
8078 result in tool_bar_item_properties. Value is zero if ITEM is
8081 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8083 CAPTION is the caption of the item, If it's not a string, it is
8084 evaluated to get a string.
8086 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8087 as binding are currently ignored.
8089 The following properties are recognized:
8093 FORM is evaluated and specifies whether the tool bar item is
8094 enabled or disabled.
8098 FORM is evaluated and specifies whether the tool bar item is visible.
8100 - `:filter FUNCTION'
8102 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8103 result is stored as the new binding.
8105 - `:button (TYPE SELECTED)'
8107 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8108 and specifies whether the button is selected (pressed) or not.
8112 IMAGES is either a single image specification or a vector of four
8113 image specifications. See enum tool_bar_item_images.
8115 - `:help HELP-STRING'.
8117 Gives a help string to display for the tool bar item.
8119 - `:label LABEL-STRING'.
8121 A text label to show with the tool bar button if labels are enabled. */
8124 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8126 /* Access slot with index IDX of vector tool_bar_item_properties. */
8127 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8129 Lisp_Object filter
= Qnil
;
8130 Lisp_Object caption
;
8131 int i
, have_label
= 0;
8133 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8134 Rule out items that aren't lists, don't start with
8135 `menu-item' or whose rest following `tool-bar-item' is not a
8140 /* As an exception, allow old-style menu separators. */
8141 if (STRINGP (XCAR (item
)))
8142 item
= Fcons (XCAR (item
), Qnil
);
8143 else if (!EQ (XCAR (item
), Qmenu_item
)
8144 || (item
= XCDR (item
), !CONSP (item
)))
8147 /* Create tool_bar_item_properties vector if necessary. Reset it to
8149 if (VECTORP (tool_bar_item_properties
))
8151 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8155 tool_bar_item_properties
8156 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8159 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8160 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8162 /* Get the caption of the item. If the caption is not a string,
8163 evaluate it to get a string. If we don't get a string, skip this
8165 caption
= XCAR (item
);
8166 if (!STRINGP (caption
))
8168 caption
= menu_item_eval_property (caption
);
8169 if (!STRINGP (caption
))
8172 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8174 /* If the rest following the caption is not a list, the menu item is
8175 either a separator, or invalid. */
8179 if (menu_separator_name_p (SSDATA (caption
)))
8181 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8182 #if !defined (USE_GTK) && !defined (HAVE_NS)
8183 /* If we use build_desired_tool_bar_string to render the
8184 tool bar, the separator is rendered as an image. */
8185 PROP (TOOL_BAR_ITEM_IMAGES
)
8186 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8187 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8188 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8189 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8196 /* Store the binding. */
8197 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8200 /* Ignore cached key binding, if any. */
8201 if (CONSP (item
) && CONSP (XCAR (item
)))
8204 /* Process the rest of the properties. */
8205 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8207 Lisp_Object ikey
, value
;
8210 value
= XCAR (XCDR (item
));
8212 if (EQ (ikey
, QCenable
))
8214 /* `:enable FORM'. */
8215 if (!NILP (Venable_disabled_menus_and_buttons
))
8216 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8218 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8220 else if (EQ (ikey
, QCvisible
))
8222 /* `:visible FORM'. If got a visible property and that
8223 evaluates to nil then ignore this item. */
8224 if (NILP (menu_item_eval_property (value
)))
8227 else if (EQ (ikey
, QChelp
))
8228 /* `:help HELP-STRING'. */
8229 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8230 else if (EQ (ikey
, QCvert_only
))
8231 /* `:vert-only t/nil'. */
8232 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8233 else if (EQ (ikey
, QClabel
))
8235 const char *bad_label
= "!!?GARBLED ITEM?!!";
8236 /* `:label LABEL-STRING'. */
8237 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8239 : build_string (bad_label
);
8242 else if (EQ (ikey
, QCfilter
))
8243 /* ':filter FORM'. */
8245 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8247 /* `:button (TYPE . SELECTED)'. */
8248 Lisp_Object type
, selected
;
8250 type
= XCAR (value
);
8251 selected
= XCDR (value
);
8252 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8254 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8255 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8258 else if (EQ (ikey
, QCimage
)
8260 || (VECTORP (value
) && ASIZE (value
) == 4)))
8261 /* Value is either a single image specification or a vector
8262 of 4 such specifications for the different button states. */
8263 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8264 else if (EQ (ikey
, QCrtl
))
8266 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8272 /* Try to make one from caption and key. */
8273 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8274 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8275 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8276 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8278 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8279 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8280 Lisp_Object new_lbl
;
8281 ptrdiff_t caption_len
= strlen (capt
);
8283 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8286 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8288 buf
[caption_len
] = '\0';
8292 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8296 strcpy (buf
, label
);
8298 for (j
= 0; buf
[j
] != '\0'; ++j
)
8306 new_lbl
= Fupcase_initials (build_string (label
));
8307 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8308 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8310 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8314 /* If got a filter apply it on binding. */
8316 PROP (TOOL_BAR_ITEM_BINDING
)
8317 = menu_item_eval_property (list2 (filter
,
8319 PROP (TOOL_BAR_ITEM_BINDING
))));
8321 /* See if the binding is a keymap. Give up if it is. */
8322 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8325 /* Enable or disable selection of item. */
8326 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8327 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8328 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8330 /* Handle radio buttons or toggle boxes. */
8331 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8332 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8333 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8341 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8342 that can be reused. */
8345 init_tool_bar_items (Lisp_Object reuse
)
8347 if (VECTORP (reuse
))
8348 tool_bar_items_vector
= reuse
;
8350 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8351 ntool_bar_items
= 0;
8355 /* Append parsed tool bar item properties from
8356 tool_bar_item_properties */
8359 append_tool_bar_item (void)
8361 Lisp_Object
*to
, *from
;
8363 /* Enlarge tool_bar_items_vector if necessary. */
8364 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8365 >= ASIZE (tool_bar_items_vector
))
8366 tool_bar_items_vector
8367 = larger_vector (tool_bar_items_vector
,
8368 2 * ASIZE (tool_bar_items_vector
), Qnil
);
8370 /* Append entries from tool_bar_item_properties to the end of
8371 tool_bar_items_vector. */
8372 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8373 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8374 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8375 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8382 /* Read a character using menus based on maps in the array MAPS.
8383 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8384 Return t if we displayed a menu but the user rejected it.
8386 PREV_EVENT is the previous input event, or nil if we are reading
8387 the first event of a key sequence.
8389 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8390 if we used a mouse menu to read the input, or zero otherwise. If
8391 USED_MOUSE_MENU is null, we don't dereference it.
8393 The prompting is done based on the prompt-string of the map
8394 and the strings associated with various map elements.
8396 This can be done with X menus or with menus put in the minibuf.
8397 These are done in different ways, depending on how the input will be read.
8398 Menus using X are done after auto-saving in read-char, getting the input
8399 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8400 and do auto-saving in the inner call of read_char. */
8403 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8404 int *used_mouse_menu
)
8408 if (used_mouse_menu
)
8409 *used_mouse_menu
= 0;
8411 /* Use local over global Menu maps */
8413 if (! menu_prompting
)
8416 /* Optionally disregard all but the global map. */
8417 if (inhibit_local_menu_bar_menus
)
8419 maps
+= (nmaps
- 1);
8424 /* If we got to this point via a mouse click,
8425 use a real menu for mouse selection. */
8426 if (EVENT_HAS_PARAMETERS (prev_event
)
8427 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8428 && !EQ (XCAR (prev_event
), Qtool_bar
))
8430 /* Display the menu and get the selection. */
8431 Lisp_Object
*realmaps
8432 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8436 /* Use the maps that are not nil. */
8437 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8438 if (!NILP (maps
[mapno
]))
8439 realmaps
[nmaps1
++] = maps
[mapno
];
8441 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8446 record_menu_key (XCAR (value
));
8448 /* If we got multiple events, unread all but
8450 There is no way to prevent those unread events
8451 from showing up later in last_nonmenu_event.
8452 So turn symbol and integer events into lists,
8453 to indicate that they came from a mouse menu,
8454 so that when present in last_nonmenu_event
8455 they won't confuse things. */
8456 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8458 record_menu_key (XCAR (tem
));
8459 if (SYMBOLP (XCAR (tem
))
8460 || INTEGERP (XCAR (tem
)))
8461 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8464 /* If we got more than one event, put all but the first
8465 onto this list to be read later.
8466 Return just the first event now. */
8467 Vunread_command_events
8468 = nconc2 (XCDR (value
), Vunread_command_events
);
8469 value
= XCAR (value
);
8471 else if (NILP (value
))
8473 if (used_mouse_menu
)
8474 *used_mouse_menu
= 1;
8477 #endif /* HAVE_MENUS */
8481 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8482 We make this bigger when necessary, and never free it. */
8483 static char *read_char_minibuf_menu_text
;
8484 /* Size of that buffer. */
8485 static int read_char_minibuf_menu_width
;
8488 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8491 register Lisp_Object name
;
8493 /* FIXME: Use the minibuffer's frame width. */
8494 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8497 Lisp_Object rest
, vector
;
8503 if (! menu_prompting
)
8506 /* Get the menu name from the first map that has one (a prompt string). */
8507 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8509 name
= Fkeymap_prompt (maps
[mapno
]);
8514 /* If we don't have any menus, just read a character normally. */
8515 if (!STRINGP (name
))
8518 /* Make sure we have a big enough buffer for the menu text. */
8519 width
= max (width
, SBYTES (name
));
8520 if (read_char_minibuf_menu_text
== 0)
8522 read_char_minibuf_menu_width
= width
+ 4;
8523 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8525 else if (width
+ 4 > read_char_minibuf_menu_width
)
8527 read_char_minibuf_menu_width
= width
+ 4;
8528 read_char_minibuf_menu_text
8529 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8531 menu
= read_char_minibuf_menu_text
;
8533 /* Prompt string always starts with map's prompt, and a space. */
8534 strcpy (menu
, SSDATA (name
));
8535 nlength
= SBYTES (name
);
8536 menu
[nlength
++] = ':';
8537 menu
[nlength
++] = ' ';
8540 /* Start prompting at start of first map. */
8544 /* Present the documented bindings, a line at a time. */
8550 Lisp_Object orig_defn_macro
;
8552 /* Loop over elements of map. */
8557 /* If reached end of map, start at beginning of next map. */
8561 /* At end of last map, wrap around to first map if just starting,
8562 or end this line if already have something on it. */
8566 if (notfirst
|| nobindings
) break;
8571 /* Look at the next element of the map. */
8573 elt
= XVECTOR (vector
)->contents
[idx
];
8575 elt
= Fcar_safe (rest
);
8577 if (idx
< 0 && VECTORP (elt
))
8579 /* If we found a dense table in the keymap,
8580 advanced past it, but start scanning its contents. */
8581 rest
= Fcdr_safe (rest
);
8587 /* An ordinary element. */
8588 Lisp_Object event
, tem
;
8592 event
= Fcar_safe (elt
); /* alist */
8593 elt
= Fcdr_safe (elt
);
8597 XSETINT (event
, idx
); /* vector */
8600 /* Ignore the element if it has no prompt string. */
8601 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8603 /* 1 if the char to type matches the string. */
8605 Lisp_Object upcased_event
, downcased_event
;
8606 Lisp_Object desc
= Qnil
;
8608 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8610 upcased_event
= Fupcase (event
);
8611 downcased_event
= Fdowncase (event
);
8612 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8613 || XINT (downcased_event
) == SREF (s
, 0));
8615 desc
= Fsingle_key_description (event
, Qnil
);
8617 #if 0 /* It is redundant to list the equivalent key bindings because
8618 the prefix is what the user has already typed. */
8620 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8622 /* Insert equivalent keybinding. */
8623 s
= concat2 (s
, tem
);
8626 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8627 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8629 /* Insert button prefix. */
8630 Lisp_Object selected
8631 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8632 if (EQ (tem
, QCradio
))
8633 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8635 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8636 s
= concat2 (tem
, s
);
8640 /* If we have room for the prompt string, add it to this line.
8641 If this is the first on the line, always add it. */
8642 if ((SCHARS (s
) + i
+ 2
8643 + (char_matches
? 0 : SCHARS (desc
) + 3))
8649 /* Punctuate between strings. */
8652 strcpy (menu
+ i
, ", ");
8658 /* If the char to type doesn't match the string's
8659 first char, explicitly show what char to type. */
8662 /* Add as much of string as fits. */
8663 thiswidth
= SCHARS (desc
);
8664 if (thiswidth
+ i
> width
)
8665 thiswidth
= width
- i
;
8666 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8668 strcpy (menu
+ i
, " = ");
8672 /* Add as much of string as fits. */
8673 thiswidth
= SCHARS (s
);
8674 if (thiswidth
+ i
> width
)
8675 thiswidth
= width
- i
;
8676 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8682 /* If this element does not fit, end the line now,
8683 and save the element for the next line. */
8684 strcpy (menu
+ i
, "...");
8689 /* Move past this element. */
8690 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8691 /* Handle reaching end of dense table. */
8696 rest
= Fcdr_safe (rest
);
8700 /* Prompt with that and read response. */
8701 message2_nolog (menu
, strlen (menu
),
8702 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8704 /* Make believe its not a keyboard macro in case the help char
8705 is pressed. Help characters are not recorded because menu prompting
8706 is not used on replay.
8708 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8709 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8711 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8712 while (BUFFERP (obj
));
8713 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8715 if (!INTEGERP (obj
))
8717 else if (XINT (obj
) == -2)
8720 if (! EQ (obj
, menu_prompt_more_char
)
8721 && (!INTEGERP (menu_prompt_more_char
)
8722 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8724 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8725 store_kbd_macro_char (obj
);
8728 /* Help char - go round again */
8732 /* Reading key sequences. */
8734 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8735 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8736 keymap, or nil otherwise. Return the index of the first keymap in
8737 which KEY has any binding, or NMAPS if no map has a binding.
8739 If KEY is a meta ASCII character, treat it like meta-prefix-char
8740 followed by the corresponding non-meta character. Keymaps in
8741 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8744 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8747 NEXT may be the same array as CURRENT. */
8750 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8753 int i
, first_binding
;
8755 first_binding
= nmaps
;
8756 for (i
= nmaps
- 1; i
>= 0; i
--)
8758 if (! NILP (current
[i
]))
8760 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8761 if (! NILP (defs
[i
]))
8768 /* Given the set of bindings we've found, produce the next set of maps. */
8769 if (first_binding
< nmaps
)
8770 for (i
= 0; i
< nmaps
; i
++)
8771 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8773 return first_binding
;
8776 /* Structure used to keep track of partial application of key remapping
8777 such as Vfunction_key_map and Vkey_translation_map. */
8778 typedef struct keyremap
8780 /* This is the map originally specified for this use. */
8782 /* This is a submap reached by looking up, in PARENT,
8783 the events from START to END. */
8785 /* Positions [START, END) in the key sequence buffer
8786 are the key that we have scanned so far.
8787 Those events are the ones that we will replace
8788 if PAREHT maps them into a key sequence. */
8792 /* Lookup KEY in MAP.
8793 MAP is a keymap mapping keys to key vectors or functions.
8794 If the mapping is a function and DO_FUNCTION is non-zero, then
8795 the function is called with PROMPT as parameter and its return
8796 value is used as the return value of this function (after checking
8797 that it is indeed a vector). */
8800 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8805 next
= access_keymap (map
, key
, 1, 0, 1);
8807 /* Handle symbol with autoload definition. */
8808 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8809 && CONSP (XSYMBOL (next
)->function
)
8810 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8811 do_autoload (XSYMBOL (next
)->function
, next
);
8813 /* Handle a symbol whose function definition is a keymap
8815 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8816 && (ARRAYP (XSYMBOL (next
)->function
)
8817 || KEYMAPP (XSYMBOL (next
)->function
)))
8818 next
= XSYMBOL (next
)->function
;
8820 /* If the keymap gives a function, not an
8821 array, then call the function with one arg and use
8822 its value instead. */
8823 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8828 next
= call1 (next
, prompt
);
8829 /* If the function returned something invalid,
8830 barf--don't ignore it.
8831 (To ignore it safely, we would need to gcpro a bunch of
8832 other variables.) */
8833 if (! (VECTORP (next
) || STRINGP (next
)))
8834 error ("Function %s returns invalid key sequence",
8835 SSDATA (SYMBOL_NAME (tem
)));
8840 /* Do one step of the key remapping used for function-key-map and
8841 key-translation-map:
8842 KEYBUF is the buffer holding the input events.
8843 BUFSIZE is its maximum size.
8844 FKEY is a pointer to the keyremap structure to use.
8845 INPUT is the index of the last element in KEYBUF.
8846 DOIT if non-zero says that the remapping can actually take place.
8847 DIFF is used to return the number of keys added/removed by the remapping.
8848 PARENT is the root of the keymap.
8849 PROMPT is the prompt to use if the remapping happens through a function.
8850 The return value is non-zero if the remapping actually took place. */
8853 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8854 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8856 Lisp_Object next
, key
;
8858 key
= keybuf
[fkey
->end
++];
8860 if (KEYMAPP (fkey
->parent
))
8861 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8865 /* If keybuf[fkey->start..fkey->end] is bound in the
8866 map and we're in a position to do the key remapping, replace it with
8867 the binding and restart with fkey->start at the end. */
8868 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8870 int len
= XFASTINT (Flength (next
));
8873 *diff
= len
- (fkey
->end
- fkey
->start
);
8875 if (bufsize
- input
<= *diff
)
8876 error ("Key sequence too long");
8878 /* Shift the keys that follow fkey->end. */
8880 for (i
= fkey
->end
; i
< input
; i
++)
8881 keybuf
[i
+ *diff
] = keybuf
[i
];
8883 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8884 keybuf
[i
+ *diff
] = keybuf
[i
];
8885 /* Overwrite the old keys with the new ones. */
8886 for (i
= 0; i
< len
; i
++)
8887 keybuf
[fkey
->start
+ i
]
8888 = Faref (next
, make_number (i
));
8890 fkey
->start
= fkey
->end
+= *diff
;
8891 fkey
->map
= fkey
->parent
;
8896 fkey
->map
= get_keymap (next
, 0, 1);
8898 /* If we no longer have a bound suffix, try a new position for
8900 if (!CONSP (fkey
->map
))
8902 fkey
->end
= ++fkey
->start
;
8903 fkey
->map
= fkey
->parent
;
8908 /* Read a sequence of keys that ends with a non prefix character,
8909 storing it in KEYBUF, a buffer of size BUFSIZE.
8911 Return the length of the key sequence stored.
8912 Return -1 if the user rejected a command menu.
8914 Echo starting immediately unless `prompt' is 0.
8916 Where a key sequence ends depends on the currently active keymaps.
8917 These include any minor mode keymaps active in the current buffer,
8918 the current buffer's local map, and the global map.
8920 If a key sequence has no other bindings, we check Vfunction_key_map
8921 to see if some trailing subsequence might be the beginning of a
8922 function key's sequence. If so, we try to read the whole function
8923 key, and substitute its symbolic name into the key sequence.
8925 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8926 `double-' events into similar click events, if that would make them
8927 bound. We try to turn `triple-' events first into `double-' events,
8930 If we get a mouse click in a mode line, vertical divider, or other
8931 non-text area, we treat the click as if it were prefixed by the
8932 symbol denoting that area - `mode-line', `vertical-line', or
8935 If the sequence starts with a mouse click, we read the key sequence
8936 with respect to the buffer clicked on, not the current buffer.
8938 If the user switches frames in the midst of a key sequence, we put
8939 off the switch-frame event until later; the next call to
8940 read_char will return it.
8942 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8943 from the selected window's buffer. */
8946 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8947 int dont_downcase_last
, int can_return_switch_frame
,
8948 int fix_current_buffer
)
8950 Lisp_Object from_string
;
8951 int count
= SPECPDL_INDEX ();
8953 /* How many keys there are in the current key sequence. */
8956 /* The length of the echo buffer when we started reading, and
8957 the length of this_command_keys when we started reading. */
8958 int echo_start
IF_LINT (= 0);
8961 /* The number of keymaps we're scanning right now, and the number of
8962 keymaps we have allocated space for. */
8964 int nmaps_allocated
= 0;
8966 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8967 the current keymaps. */
8968 Lisp_Object
*defs
= NULL
;
8970 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8971 in the current keymaps, or nil where it is not a prefix. */
8972 Lisp_Object
*submaps
= NULL
;
8974 /* The local map to start out with at start of key sequence. */
8975 Lisp_Object orig_local_map
;
8977 /* The map from the `keymap' property to start out with at start of
8979 Lisp_Object orig_keymap
;
8981 /* 1 if we have already considered switching to the local-map property
8982 of the place where a mouse click occurred. */
8983 int localized_local_map
= 0;
8985 /* The index in submaps[] of the first keymap that has a binding for
8986 this key sequence. In other words, the lowest i such that
8987 submaps[i] is non-nil. */
8989 /* Index of the first key that has no binding.
8990 It is useless to try fkey.start larger than that. */
8993 /* If t < mock_input, then KEYBUF[t] should be read as the next
8996 We use this to recover after recognizing a function key. Once we
8997 realize that a suffix of the current key sequence is actually a
8998 function key's escape sequence, we replace the suffix with the
8999 function key's binding from Vfunction_key_map. Now keybuf
9000 contains a new and different key sequence, so the echo area,
9001 this_command_keys, and the submaps and defs arrays are wrong. In
9002 this situation, we set mock_input to t, set t to 0, and jump to
9003 restart_sequence; the loop will read keys from keybuf up until
9004 mock_input, thus rebuilding the state; and then it will resume
9005 reading characters from the keyboard. */
9008 /* If the sequence is unbound in submaps[], then
9009 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9010 and fkey.map is its binding.
9012 These might be > t, indicating that all function key scanning
9013 should hold off until t reaches them. We do this when we've just
9014 recognized a function key, to avoid searching for the function
9015 key's again in Vfunction_key_map. */
9018 /* Likewise, for key_translation_map and input-decode-map. */
9019 keyremap keytran
, indec
;
9021 /* Non-zero if we are trying to map a key by changing an upper-case
9022 letter to lower case, or a shifted function key to an unshifted
9024 int shift_translated
= 0;
9026 /* If we receive a `switch-frame' or `select-window' event in the middle of
9027 a key sequence, we put it off for later.
9028 While we're reading, we keep the event here. */
9029 Lisp_Object delayed_switch_frame
;
9031 /* See the comment below... */
9032 #if defined (GOBBLE_FIRST_EVENT)
9033 Lisp_Object first_event
;
9036 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9037 int original_uppercase_position
= -1;
9039 /* Gets around Microsoft compiler limitations. */
9042 struct buffer
*starting_buffer
;
9044 /* List of events for which a fake prefix key has been generated. */
9045 Lisp_Object fake_prefixed_keys
= Qnil
;
9047 #if defined (GOBBLE_FIRST_EVENT)
9051 struct gcpro outer_gcpro1
;
9053 GCPRO1_VAR (fake_prefixed_keys
, outer_gcpro
);
9054 raw_keybuf_count
= 0;
9056 last_nonmenu_event
= Qnil
;
9058 delayed_switch_frame
= Qnil
;
9064 /* Install the string STR as the beginning of the string of
9065 echoing, so that it serves as a prompt for the next
9067 KVAR (current_kboard
, echo_string
) = prompt
;
9068 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9071 else if (cursor_in_echo_area
9072 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9073 && NILP (Fzerop (Vecho_keystrokes
)))
9074 /* This doesn't put in a dash if the echo buffer is empty, so
9075 you don't always see a dash hanging out in the minibuffer. */
9079 /* Record the initial state of the echo area and this_command_keys;
9080 we will need to restore them if we replay a key sequence. */
9082 echo_start
= echo_length ();
9083 keys_start
= this_command_key_count
;
9084 this_single_command_key_start
= keys_start
;
9086 #if defined (GOBBLE_FIRST_EVENT)
9087 /* This doesn't quite work, because some of the things that read_char
9088 does cannot safely be bypassed. It seems too risky to try to make
9091 /* Read the first char of the sequence specially, before setting
9092 up any keymaps, in case a filter runs and switches buffers on us. */
9093 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9095 #endif /* GOBBLE_FIRST_EVENT */
9097 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9098 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9101 /* We jump here when we need to reinitialize fkey and keytran; this
9102 happens if we switch keyboards between rescans. */
9103 replay_entire_sequence
:
9105 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9106 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9107 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9108 indec
.start
= indec
.end
= 0;
9109 fkey
.start
= fkey
.end
= 0;
9110 keytran
.start
= keytran
.end
= 0;
9112 /* We jump here when the key sequence has been thoroughly changed, and
9113 we need to rescan it starting from the beginning. When we jump here,
9114 keybuf[0..mock_input] holds the sequence we should reread. */
9117 starting_buffer
= current_buffer
;
9118 first_unbound
= bufsize
+ 1;
9120 /* Build our list of keymaps.
9121 If we recognize a function key and replace its escape sequence in
9122 keybuf with its symbol, or if the sequence starts with a mouse
9123 click and we need to switch buffers, we jump back here to rebuild
9124 the initial keymaps from the current buffer. */
9127 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9129 if (2 > nmaps_allocated
)
9131 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9132 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9133 nmaps_allocated
= 2;
9135 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9137 else if (!NILP (Voverriding_local_map
))
9139 if (2 > nmaps_allocated
)
9141 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9142 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9143 nmaps_allocated
= 2;
9145 submaps
[nmaps
++] = Voverriding_local_map
;
9153 nminor
= current_minor_maps (0, &maps
);
9154 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9156 if (total
> nmaps_allocated
)
9158 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9159 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9160 nmaps_allocated
= total
;
9163 if (!NILP (orig_keymap
))
9164 submaps
[nmaps
++] = orig_keymap
;
9166 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9170 submaps
[nmaps
++] = orig_local_map
;
9172 submaps
[nmaps
++] = current_global_map
;
9174 /* Find an accurate initial value for first_binding. */
9175 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9176 if (! NILP (submaps
[first_binding
]))
9179 /* Start from the beginning in keybuf. */
9182 /* These are no-ops the first time through, but if we restart, they
9183 revert the echo area and this_command_keys to their original state. */
9184 this_command_key_count
= keys_start
;
9185 if (INTERACTIVE
&& t
< mock_input
)
9186 echo_truncate (echo_start
);
9188 /* If the best binding for the current key sequence is a keymap, or
9189 we may be looking at a function key's escape sequence, keep on
9191 while (first_binding
< nmaps
9192 /* Keep reading as long as there's a prefix binding. */
9193 ? !NILP (submaps
[first_binding
])
9194 /* Don't return in the middle of a possible function key sequence,
9195 if the only bindings we found were via case conversion.
9196 Thus, if ESC O a has a function-key-map translation
9197 and ESC o has a binding, don't return after ESC O,
9198 so that we can translate ESC O plus the next character. */
9199 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9202 int used_mouse_menu
= 0;
9204 /* Where the last real key started. If we need to throw away a
9205 key that has expanded into more than one element of keybuf
9206 (say, a mouse click on the mode line which is being treated
9207 as [mode-line (mouse-...)], then we backtrack to this point
9209 int last_real_key_start
;
9211 /* These variables are analogous to echo_start and keys_start;
9212 while those allow us to restart the entire key sequence,
9213 echo_local_start and keys_local_start allow us to throw away
9215 int echo_local_start
IF_LINT (= 0);
9216 int keys_local_start
, local_first_binding
;
9218 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9219 eassert (indec
.start
<= indec
.end
);
9220 eassert (fkey
.start
<= fkey
.end
);
9221 eassert (keytran
.start
<= keytran
.end
);
9222 /* key-translation-map is applied *after* function-key-map
9223 which is itself applied *after* input-decode-map. */
9224 eassert (fkey
.end
<= indec
.start
);
9225 eassert (keytran
.end
<= fkey
.start
);
9227 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9228 first_unbound
< keytran
.start
)
9229 { /* The prefix upto first_unbound has no binding and has
9230 no translation left to do either, so we know it's unbound.
9231 If we don't stop now, we risk staying here indefinitely
9232 (if the user keeps entering fkey or keytran prefixes
9233 like C-c ESC ESC ESC ESC ...) */
9235 for (i
= first_unbound
+ 1; i
< t
; i
++)
9236 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9237 mock_input
= t
- first_unbound
- 1;
9238 indec
.end
= indec
.start
-= first_unbound
+ 1;
9239 indec
.map
= indec
.parent
;
9240 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9241 fkey
.map
= fkey
.parent
;
9242 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9243 keytran
.map
= keytran
.parent
;
9244 goto replay_sequence
;
9248 error ("Key sequence too long");
9251 echo_local_start
= echo_length ();
9252 keys_local_start
= this_command_key_count
;
9253 local_first_binding
= first_binding
;
9256 /* These are no-ops, unless we throw away a keystroke below and
9257 jumped back up to replay_key; in that case, these restore the
9258 variables to their original state, allowing us to replay the
9260 if (INTERACTIVE
&& t
< mock_input
)
9261 echo_truncate (echo_local_start
);
9262 this_command_key_count
= keys_local_start
;
9263 first_binding
= local_first_binding
;
9265 /* By default, assume each event is "real". */
9266 last_real_key_start
= t
;
9268 /* Does mock_input indicate that we are re-reading a key sequence? */
9272 add_command_key (key
);
9273 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9274 && NILP (Fzerop (Vecho_keystrokes
)))
9278 /* If not, we should actually read a character. */
9282 KBOARD
*interrupted_kboard
= current_kboard
;
9283 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9284 key
= read_char (NILP (prompt
), nmaps
,
9285 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9286 &used_mouse_menu
, NULL
);
9287 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9288 /* When switching to a new tty (with a new keyboard),
9289 read_char returns the new buffer, rather than -2
9290 (Bug#5095). This is because `terminal-init-xterm'
9291 calls read-char, which eats the wrong_kboard_jmpbuf
9292 return. Any better way to fix this? -- cyd */
9293 || (interrupted_kboard
!= current_kboard
))
9298 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9299 if (k
== interrupted_kboard
)
9304 /* Don't touch interrupted_kboard when it's been
9306 delayed_switch_frame
= Qnil
;
9307 goto replay_entire_sequence
;
9310 if (!NILP (delayed_switch_frame
))
9312 KVAR (interrupted_kboard
, kbd_queue
)
9313 = Fcons (delayed_switch_frame
,
9314 KVAR (interrupted_kboard
, kbd_queue
));
9315 delayed_switch_frame
= Qnil
;
9319 KVAR (interrupted_kboard
, kbd_queue
)
9320 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9322 /* If the side queue is non-empty, ensure it begins with a
9323 switch-frame, so we'll replay it in the right context. */
9324 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9325 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9326 !(EVENT_HAS_PARAMETERS (key
)
9327 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9331 XSETFRAME (frame
, interrupted_frame
);
9332 KVAR (interrupted_kboard
, kbd_queue
)
9333 = Fcons (make_lispy_switch_frame (frame
),
9334 KVAR (interrupted_kboard
, kbd_queue
));
9337 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9338 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9339 goto replay_entire_sequence
;
9343 /* read_char returns t when it shows a menu and the user rejects it.
9347 unbind_to (count
, Qnil
);
9348 UNGCPRO_VAR (outer_gcpro
);
9352 /* read_char returns -1 at the end of a macro.
9353 Emacs 18 handles this by returning immediately with a
9354 zero, so that's what we'll do. */
9355 if (INTEGERP (key
) && XINT (key
) == -1)
9358 /* The Microsoft C compiler can't handle the goto that
9364 /* If the current buffer has been changed from under us, the
9365 keymap may have changed, so replay the sequence. */
9368 timer_resume_idle ();
9371 /* Reset the current buffer from the selected window
9372 in case something changed the former and not the latter.
9373 This is to be more consistent with the behavior
9374 of the command_loop_1. */
9375 if (fix_current_buffer
)
9377 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9379 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9380 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9383 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9384 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9385 goto replay_sequence
;
9388 /* If we have a quit that was typed in another frame, and
9389 quit_throw_to_read_char switched buffers,
9390 replay to get the right keymap. */
9392 && XINT (key
) == quit_char
9393 && current_buffer
!= starting_buffer
)
9396 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9400 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9401 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9402 goto replay_sequence
;
9407 if (EVENT_HAS_PARAMETERS (key
)
9408 /* Either a `switch-frame' or a `select-window' event. */
9409 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9411 /* If we're at the beginning of a key sequence, and the caller
9412 says it's okay, go ahead and return this event. If we're
9413 in the midst of a key sequence, delay it until the end. */
9414 if (t
> 0 || !can_return_switch_frame
)
9416 delayed_switch_frame
= key
;
9422 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9426 /* Clicks in non-text areas get prefixed by the symbol
9427 in their CHAR-ADDRESS field. For example, a click on
9428 the mode line is prefixed by the symbol `mode-line'.
9430 Furthermore, key sequences beginning with mouse clicks
9431 are read using the keymaps of the buffer clicked on, not
9432 the current buffer. So we may have to switch the buffer
9435 When we turn one event into two events, we must make sure
9436 that neither of the two looks like the original--so that,
9437 if we replay the events, they won't be expanded again.
9438 If not for this, such reexpansion could happen either here
9439 or when user programs play with this-command-keys. */
9440 if (EVENT_HAS_PARAMETERS (key
))
9445 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9446 if (EQ (kind
, Qmouse_click
))
9448 Lisp_Object window
, posn
;
9450 window
= POSN_WINDOW (EVENT_START (key
));
9451 posn
= POSN_POSN (EVENT_START (key
));
9454 || (!NILP (fake_prefixed_keys
)
9455 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9457 /* We're looking a second time at an event for which
9458 we generated a fake prefix key. Set
9459 last_real_key_start appropriately. */
9461 last_real_key_start
= t
- 1;
9464 if (last_real_key_start
== 0)
9466 /* Key sequences beginning with mouse clicks are
9467 read using the keymaps in the buffer clicked on,
9468 not the current buffer. If we're at the
9469 beginning of a key sequence, switch buffers. */
9470 if (WINDOWP (window
)
9471 && BUFFERP (XWINDOW (window
)->buffer
)
9472 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9474 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9478 /* Arrange to go back to the original buffer once we're
9479 done reading the key sequence. Note that we can't
9480 use save_excursion_{save,restore} here, because they
9481 save point as well as the current buffer; we don't
9482 want to save point, because redisplay may change it,
9483 to accommodate a Fset_window_start or something. We
9484 don't want to do this at the top of the function,
9485 because we may get input from a subprocess which
9486 wants to change the selected window and stuff (say,
9488 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9490 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9492 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9493 orig_local_map
= get_local_map (PT
, current_buffer
,
9495 orig_keymap
= get_local_map (PT
, current_buffer
,
9497 goto replay_sequence
;
9500 /* For a mouse click, get the local text-property keymap
9501 of the place clicked on, rather than point. */
9502 if (CONSP (XCDR (key
))
9503 && ! localized_local_map
)
9505 Lisp_Object map_here
, start
, pos
;
9507 localized_local_map
= 1;
9508 start
= EVENT_START (key
);
9510 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9512 pos
= POSN_BUFFER_POSN (start
);
9514 && XINT (pos
) >= BEGV
9515 && XINT (pos
) <= ZV
)
9517 map_here
= get_local_map (XINT (pos
),
9520 if (!EQ (map_here
, orig_local_map
))
9522 orig_local_map
= map_here
;
9523 ++localized_local_map
;
9526 map_here
= get_local_map (XINT (pos
),
9529 if (!EQ (map_here
, orig_keymap
))
9531 orig_keymap
= map_here
;
9532 ++localized_local_map
;
9535 if (localized_local_map
> 1)
9540 goto replay_sequence
;
9547 /* Expand mode-line and scroll-bar events into two events:
9548 use posn as a fake prefix key. */
9550 && (NILP (fake_prefixed_keys
)
9551 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9553 if (bufsize
- t
<= 1)
9554 error ("Key sequence too long");
9557 keybuf
[t
+ 1] = key
;
9560 /* Record that a fake prefix key has been generated
9561 for KEY. Don't modify the event; this would
9562 prevent proper action when the event is pushed
9563 back into unread-command-events. */
9564 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9566 /* If on a mode line string with a local keymap,
9567 reconsider the key sequence with that keymap. */
9568 if (string
= POSN_STRING (EVENT_START (key
)),
9569 (CONSP (string
) && STRINGP (XCAR (string
))))
9571 Lisp_Object pos
, map
, map2
;
9573 pos
= XCDR (string
);
9574 string
= XCAR (string
);
9576 && XINT (pos
) < SCHARS (string
))
9578 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9580 orig_local_map
= map
;
9581 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9584 if (!NILP (map
) || !NILP (map2
))
9585 goto replay_sequence
;
9591 else if (NILP (from_string
)
9592 && (string
= POSN_STRING (EVENT_START (key
)),
9593 (CONSP (string
) && STRINGP (XCAR (string
)))))
9595 /* For a click on a string, i.e. overlay string or a
9596 string displayed via the `display' property,
9597 consider `local-map' and `keymap' properties of
9599 Lisp_Object pos
, map
, map2
;
9601 pos
= XCDR (string
);
9602 string
= XCAR (string
);
9604 && XINT (pos
) < SCHARS (string
))
9606 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9608 orig_local_map
= map
;
9609 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9613 if (!NILP (map
) || !NILP (map2
))
9615 from_string
= string
;
9618 goto replay_sequence
;
9623 else if (CONSP (XCDR (key
))
9624 && CONSP (EVENT_START (key
))
9625 && CONSP (XCDR (EVENT_START (key
))))
9629 posn
= POSN_POSN (EVENT_START (key
));
9630 /* Handle menu-bar events:
9631 insert the dummy prefix event `menu-bar'. */
9632 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9634 if (bufsize
- t
<= 1)
9635 error ("Key sequence too long");
9639 /* Zap the position in key, so we know that we've
9640 expanded it, and don't try to do so again. */
9641 POSN_SET_POSN (EVENT_START (key
),
9642 Fcons (posn
, Qnil
));
9645 goto replay_sequence
;
9647 else if (CONSP (posn
))
9649 /* We're looking at the second event of a
9650 sequence which we expanded before. Set
9651 last_real_key_start appropriately. */
9652 if (last_real_key_start
== t
&& t
> 0)
9653 last_real_key_start
= t
- 1;
9658 /* We have finally decided that KEY is something we might want
9660 first_binding
= (follow_key (key
,
9661 nmaps
- first_binding
,
9662 submaps
+ first_binding
,
9663 defs
+ first_binding
,
9664 submaps
+ first_binding
)
9667 /* If KEY wasn't bound, we'll try some fallbacks. */
9668 if (first_binding
< nmaps
)
9669 /* This is needed for the following scenario:
9670 event 0: a down-event that gets dropped by calling replay_key.
9671 event 1: some normal prefix like C-h.
9672 After event 0, first_unbound is 0, after event 1 indec.start,
9673 fkey.start, and keytran.start are all 1, so when we see that
9674 C-h is bound, we need to update first_unbound. */
9675 first_unbound
= max (t
+ 1, first_unbound
);
9680 /* Remember the position to put an upper bound on indec.start. */
9681 first_unbound
= min (t
, first_unbound
);
9683 head
= EVENT_HEAD (key
);
9684 if (help_char_p (head
) && t
> 0)
9686 read_key_sequence_cmd
= Vprefix_help_command
;
9688 last_nonmenu_event
= key
;
9689 /* The Microsoft C compiler can't handle the goto that
9697 Lisp_Object breakdown
;
9700 breakdown
= parse_modifiers (head
);
9701 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9702 /* Attempt to reduce an unbound mouse event to a simpler
9703 event that is bound:
9704 Drags reduce to clicks.
9705 Double-clicks reduce to clicks.
9706 Triple-clicks reduce to double-clicks, then to clicks.
9707 Down-clicks are eliminated.
9708 Double-downs reduce to downs, then are eliminated.
9709 Triple-downs reduce to double-downs, then to downs,
9710 then are eliminated. */
9711 if (modifiers
& (down_modifier
| drag_modifier
9712 | double_modifier
| triple_modifier
))
9714 while (modifiers
& (down_modifier
| drag_modifier
9715 | double_modifier
| triple_modifier
))
9717 Lisp_Object new_head
, new_click
;
9718 if (modifiers
& triple_modifier
)
9719 modifiers
^= (double_modifier
| triple_modifier
);
9720 else if (modifiers
& double_modifier
)
9721 modifiers
&= ~double_modifier
;
9722 else if (modifiers
& drag_modifier
)
9723 modifiers
&= ~drag_modifier
;
9726 /* Dispose of this `down' event by simply jumping
9727 back to replay_key, to get another event.
9729 Note that if this event came from mock input,
9730 then just jumping back to replay_key will just
9731 hand it to us again. So we have to wipe out any
9734 We could delete keybuf[t] and shift everything
9735 after that to the left by one spot, but we'd also
9736 have to fix up any variable that points into
9737 keybuf, and shifting isn't really necessary
9740 Adding prefixes for non-textual mouse clicks
9741 creates two characters of mock input, and both
9742 must be thrown away. If we're only looking at
9743 the prefix now, we can just jump back to
9744 replay_key. On the other hand, if we've already
9745 processed the prefix, and now the actual click
9746 itself is giving us trouble, then we've lost the
9747 state of the keymaps we want to backtrack to, and
9748 we need to replay the whole sequence to rebuild
9751 Beyond that, only function key expansion could
9752 create more than two keys, but that should never
9753 generate mouse events, so it's okay to zero
9754 mock_input in that case too.
9756 FIXME: The above paragraph seems just plain
9757 wrong, if you consider things like
9758 xterm-mouse-mode. -stef
9760 Isn't this just the most wonderful code ever? */
9762 /* If mock_input > t + 1, the above simplification
9763 will actually end up dropping keys on the floor.
9764 This is probably OK for now, but even
9765 if mock_input <= t + 1, we need to adjust indec,
9767 Typical case [header-line down-mouse-N]:
9768 mock_input = 2, t = 1, fkey.end = 1,
9769 last_real_key_start = 0. */
9770 if (indec
.end
> last_real_key_start
)
9772 indec
.end
= indec
.start
9773 = min (last_real_key_start
, indec
.start
);
9774 indec
.map
= indec
.parent
;
9775 if (fkey
.end
> last_real_key_start
)
9777 fkey
.end
= fkey
.start
9778 = min (last_real_key_start
, fkey
.start
);
9779 fkey
.map
= fkey
.parent
;
9780 if (keytran
.end
> last_real_key_start
)
9782 keytran
.end
= keytran
.start
9783 = min (last_real_key_start
, keytran
.start
);
9784 keytran
.map
= keytran
.parent
;
9788 if (t
== last_real_key_start
)
9795 mock_input
= last_real_key_start
;
9796 goto replay_sequence
;
9801 = apply_modifiers (modifiers
, XCAR (breakdown
));
9803 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9805 /* Look for a binding for this new key. follow_key
9806 promises that it didn't munge submaps the
9807 last time we called it, since key was unbound. */
9809 = (follow_key (new_click
,
9810 nmaps
- local_first_binding
,
9811 submaps
+ local_first_binding
,
9812 defs
+ local_first_binding
,
9813 submaps
+ local_first_binding
)
9814 + local_first_binding
);
9816 /* If that click is bound, go for it. */
9817 if (first_binding
< nmaps
)
9822 /* Otherwise, we'll leave key set to the drag event. */
9829 /* Normally, last_nonmenu_event gets the previous key we read.
9830 But when a mouse popup menu is being used,
9831 we don't update last_nonmenu_event; it continues to hold the mouse
9832 event that preceded the first level of menu. */
9833 if (!used_mouse_menu
)
9834 last_nonmenu_event
= key
;
9836 /* Record what part of this_command_keys is the current key sequence. */
9837 this_single_command_key_start
= this_command_key_count
- t
;
9839 /* Look for this sequence in input-decode-map.
9840 Scan from indec.end until we find a bound suffix. */
9841 while (indec
.end
< t
)
9843 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9846 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9847 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9852 mock_input
= diff
+ max (t
, mock_input
);
9853 goto replay_sequence
;
9857 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9858 && indec
.start
>= t
)
9859 /* There is a binding and it's not a prefix.
9860 (and it doesn't have any input-decode-map translation pending).
9861 There is thus no function-key in this sequence.
9862 Moving fkey.start is important in this case to allow keytran.start
9863 to go over the sequence before we return (since we keep the
9864 invariant that keytran.end <= fkey.start). */
9867 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9870 /* If the sequence is unbound, see if we can hang a function key
9871 off the end of it. */
9872 /* Continue scan from fkey.end until we find a bound suffix. */
9873 while (fkey
.end
< indec
.start
)
9875 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9878 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9879 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9880 max (t
, mock_input
),
9881 /* If there's a binding (i.e.
9882 first_binding >= nmaps) we don't want
9883 to apply this function-key-mapping. */
9884 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9889 mock_input
= diff
+ max (t
, mock_input
);
9890 /* Adjust the input-decode-map counters. */
9892 indec
.start
+= diff
;
9894 goto replay_sequence
;
9898 /* Look for this sequence in key-translation-map.
9899 Scan from keytran.end until we find a bound suffix. */
9900 while (keytran
.end
< fkey
.start
)
9902 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9905 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9906 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9911 mock_input
= diff
+ max (t
, mock_input
);
9912 /* Adjust the function-key-map and input-decode-map counters. */
9914 indec
.start
+= diff
;
9918 goto replay_sequence
;
9922 /* If KEY is not defined in any of the keymaps,
9923 and cannot be part of a function key or translation,
9924 and is an upper case letter
9925 use the corresponding lower-case letter instead. */
9926 if (first_binding
>= nmaps
9927 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9929 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9930 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9931 || (XINT (key
) & shift_modifier
)))
9933 Lisp_Object new_key
;
9935 original_uppercase
= key
;
9936 original_uppercase_position
= t
- 1;
9938 if (XINT (key
) & shift_modifier
)
9939 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9941 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9942 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9944 /* We have to do this unconditionally, regardless of whether
9945 the lower-case char is defined in the keymaps, because they
9946 might get translated through function-key-map. */
9947 keybuf
[t
- 1] = new_key
;
9948 mock_input
= max (t
, mock_input
);
9949 shift_translated
= 1;
9951 goto replay_sequence
;
9953 /* If KEY is not defined in any of the keymaps,
9954 and cannot be part of a function key or translation,
9955 and is a shifted function key,
9956 use the corresponding unshifted function key instead. */
9957 if (first_binding
>= nmaps
9958 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9960 Lisp_Object breakdown
= parse_modifiers (key
);
9962 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9964 if (modifiers
& shift_modifier
9965 /* Treat uppercase keys as shifted. */
9967 && (KEY_TO_CHAR (key
)
9968 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9969 && uppercasep (KEY_TO_CHAR (key
))))
9972 = (modifiers
& shift_modifier
9973 ? apply_modifiers (modifiers
& ~shift_modifier
,
9975 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9977 original_uppercase
= key
;
9978 original_uppercase_position
= t
- 1;
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 /* Reset fkey (and consequently keytran) to apply
9986 function-key-map on the result, so that S-backspace is
9987 correctly mapped to DEL (via backspace). OTOH,
9988 input-decode-map doesn't need to go through it again. */
9989 fkey
.start
= fkey
.end
= 0;
9990 keytran
.start
= keytran
.end
= 0;
9991 shift_translated
= 1;
9993 goto replay_sequence
;
9998 read_key_sequence_cmd
= (first_binding
< nmaps
9999 ? defs
[first_binding
]
10002 unread_switch_frame
= delayed_switch_frame
;
10003 unbind_to (count
, Qnil
);
10005 /* Don't downcase the last character if the caller says don't.
10006 Don't downcase it if the result is undefined, either. */
10007 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10009 && t
- 1 == original_uppercase_position
)
10011 keybuf
[t
- 1] = original_uppercase
;
10012 shift_translated
= 0;
10015 if (shift_translated
)
10016 Vthis_command_keys_shift_translated
= Qt
;
10018 /* Occasionally we fabricate events, perhaps by expanding something
10019 according to function-key-map, or by adding a prefix symbol to a
10020 mouse click in the scroll bar or modeline. In this cases, return
10021 the entire generated key sequence, even if we hit an unbound
10022 prefix or a definition before the end. This means that you will
10023 be able to push back the event properly, and also means that
10024 read-key-sequence will always return a logical unit.
10027 for (; t
< mock_input
; t
++)
10029 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10030 && NILP (Fzerop (Vecho_keystrokes
)))
10031 echo_char (keybuf
[t
]);
10032 add_command_key (keybuf
[t
]);
10035 UNGCPRO_VAR (outer_gcpro
);
10039 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10040 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10041 The sequence is sufficient to specify a non-prefix command in the
10042 current local and global maps.
10044 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10045 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10046 as a continuation of the previous key.
10048 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10049 convert the last event to lower case. (Normally any upper case event
10050 is converted to lower case if the original event is undefined and the lower
10051 case equivalent is defined.) A non-nil value is appropriate for reading
10052 a key sequence to be defined.
10054 A C-g typed while in this function is treated like any other character,
10055 and `quit-flag' is not set.
10057 If the key sequence starts with a mouse click, then the sequence is read
10058 using the keymaps of the buffer of the window clicked in, not the buffer
10059 of the selected window as normal.
10061 `read-key-sequence' drops unbound button-down events, since you normally
10062 only care about the click or drag events which follow them. If a drag
10063 or multi-click event is unbound, but the corresponding click event would
10064 be bound, `read-key-sequence' turns the event into a click event at the
10065 drag's starting position. This means that you don't have to distinguish
10066 between click and drag, double, or triple events unless you want to.
10068 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10069 lines separating windows, and scroll bars with imaginary keys
10070 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10072 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10073 function will process a switch-frame event if the user switches frames
10074 before typing anything. If the user switches frames in the middle of a
10075 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10076 is nil, then the event will be put off until after the current key sequence.
10078 `read-key-sequence' checks `function-key-map' for function key
10079 sequences, where they wouldn't conflict with ordinary bindings. See
10080 `function-key-map' for more details.
10082 The optional fifth argument CMD-LOOP, if non-nil, means
10083 that this key sequence is being read by something that will
10084 read commands one after another. It should be nil if the caller
10085 will read just one key sequence. */)
10086 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10088 Lisp_Object keybuf
[30];
10090 struct gcpro gcpro1
;
10091 int count
= SPECPDL_INDEX ();
10093 if (!NILP (prompt
))
10094 CHECK_STRING (prompt
);
10097 specbind (Qinput_method_exit_on_first_char
,
10098 (NILP (cmd_loop
) ? Qt
: Qnil
));
10099 specbind (Qinput_method_use_echo_area
,
10100 (NILP (cmd_loop
) ? Qt
: Qnil
));
10102 memset (keybuf
, 0, sizeof keybuf
);
10103 GCPRO1 (keybuf
[0]);
10104 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10106 if (NILP (continue_echo
))
10108 this_command_key_count
= 0;
10109 this_command_key_count_reset
= 0;
10110 this_single_command_key_start
= 0;
10113 #ifdef HAVE_WINDOW_SYSTEM
10114 if (display_hourglass_p
)
10115 cancel_hourglass ();
10118 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10119 prompt
, ! NILP (dont_downcase_last
),
10120 ! NILP (can_return_switch_frame
), 0);
10122 #if 0 /* The following is fine for code reading a key sequence and
10123 then proceeding with a lenghty computation, but it's not good
10124 for code reading keys in a loop, like an input method. */
10125 #ifdef HAVE_WINDOW_SYSTEM
10126 if (display_hourglass_p
)
10127 start_hourglass ();
10137 return unbind_to (count
, make_event_array (i
, keybuf
));
10140 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10141 Sread_key_sequence_vector
, 1, 5, 0,
10142 doc
: /* Like `read-key-sequence' but always return a vector. */)
10143 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10145 Lisp_Object keybuf
[30];
10147 struct gcpro gcpro1
;
10148 int count
= SPECPDL_INDEX ();
10150 if (!NILP (prompt
))
10151 CHECK_STRING (prompt
);
10154 specbind (Qinput_method_exit_on_first_char
,
10155 (NILP (cmd_loop
) ? Qt
: Qnil
));
10156 specbind (Qinput_method_use_echo_area
,
10157 (NILP (cmd_loop
) ? Qt
: Qnil
));
10159 memset (keybuf
, 0, sizeof keybuf
);
10160 GCPRO1 (keybuf
[0]);
10161 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10163 if (NILP (continue_echo
))
10165 this_command_key_count
= 0;
10166 this_command_key_count_reset
= 0;
10167 this_single_command_key_start
= 0;
10170 #ifdef HAVE_WINDOW_SYSTEM
10171 if (display_hourglass_p
)
10172 cancel_hourglass ();
10175 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10176 prompt
, ! NILP (dont_downcase_last
),
10177 ! NILP (can_return_switch_frame
), 0);
10179 #ifdef HAVE_WINDOW_SYSTEM
10180 if (display_hourglass_p
)
10181 start_hourglass ();
10190 return unbind_to (count
, Fvector (i
, keybuf
));
10193 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10194 doc
: /* Execute CMD as an editor command.
10195 CMD must be a symbol that satisfies the `commandp' predicate.
10196 Optional second arg RECORD-FLAG non-nil
10197 means unconditionally put this command in `command-history'.
10198 Otherwise, that is done only if an arg is read using the minibuffer.
10199 The argument KEYS specifies the value to use instead of (this-command-keys)
10200 when reading the arguments; if it is nil, (this-command-keys) is used.
10201 The argument SPECIAL, if non-nil, means that this command is executing
10202 a special event, so ignore the prefix argument and don't clear it. */)
10203 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10205 register Lisp_Object final
;
10206 register Lisp_Object tem
;
10207 Lisp_Object prefixarg
;
10209 debug_on_next_call
= 0;
10211 if (NILP (special
))
10213 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10214 Vcurrent_prefix_arg
= prefixarg
;
10215 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10222 tem
= Fget (cmd
, Qdisabled
);
10225 tem
= Fsymbol_value (Qdisabled_command_function
);
10227 return Frun_hooks (1, &Qdisabled_command_function
);
10233 final
= Findirect_function (cmd
, Qnil
);
10235 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10237 struct gcpro gcpro1
, gcpro2
;
10239 GCPRO2 (cmd
, prefixarg
);
10240 do_autoload (final
, cmd
);
10247 if (STRINGP (final
) || VECTORP (final
))
10249 /* If requested, place the macro in the command history. For
10250 other sorts of commands, call-interactively takes care of
10252 if (!NILP (record_flag
))
10255 = Fcons (Fcons (Qexecute_kbd_macro
,
10256 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10259 /* Don't keep command history around forever. */
10260 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10262 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10264 XSETCDR (tem
, Qnil
);
10268 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10271 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10272 /* Don't call Fcall_interactively directly because we want to make
10273 sure the backtrace has an entry for `call-interactively'.
10274 For the same reason, pass `cmd' rather than `final'. */
10275 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10282 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10284 doc
: /* Read function name, then read its arguments and call it.
10286 To pass a numeric argument to the command you are invoking with, specify
10287 the numeric argument to this command.
10289 Noninteractively, the argument PREFIXARG is the prefix argument to
10290 give to the command you invoke, if it asks for an argument. */)
10291 (Lisp_Object prefixarg
)
10293 Lisp_Object function
;
10294 EMACS_INT saved_last_point_position
;
10295 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10296 Lisp_Object bindings
, value
;
10297 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10298 #ifdef HAVE_WINDOW_SYSTEM
10299 /* The call to Fcompleting_read will start and cancel the hourglass,
10300 but if the hourglass was already scheduled, this means that no
10301 hourglass will be shown for the actual M-x command itself.
10302 So we restart it if it is already scheduled. Note that checking
10303 hourglass_shown_p is not enough, normally the hourglass is not shown,
10304 just scheduled to be shown. */
10305 int hstarted
= hourglass_started ();
10308 saved_keys
= Fvector (this_command_key_count
,
10309 XVECTOR (this_command_keys
)->contents
);
10310 saved_last_point_position_buffer
= last_point_position_buffer
;
10311 saved_last_point_position
= last_point_position
;
10312 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10314 function
= call0 (intern ("read-extended-command"));
10316 #ifdef HAVE_WINDOW_SYSTEM
10317 if (hstarted
) start_hourglass ();
10320 if (STRINGP (function
) && SCHARS (function
) == 0)
10321 error ("No command name given");
10323 /* Set this_command_keys to the concatenation of saved_keys and
10324 function, followed by a RET. */
10329 this_command_key_count
= 0;
10330 this_command_key_count_reset
= 0;
10331 this_single_command_key_start
= 0;
10333 keys
= XVECTOR (saved_keys
)->contents
;
10334 for (i
= 0; i
< ASIZE (saved_keys
); i
++)
10335 add_command_key (keys
[i
]);
10337 for (i
= 0; i
< SCHARS (function
); i
++)
10338 add_command_key (Faref (function
, make_number (i
)));
10340 add_command_key (make_number ('\015'));
10343 last_point_position
= saved_last_point_position
;
10344 last_point_position_buffer
= saved_last_point_position_buffer
;
10348 function
= Fintern (function
, Qnil
);
10349 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10350 Vthis_command
= function
;
10351 real_this_command
= function
;
10353 /* If enabled, show which key runs this command. */
10354 if (!NILP (Vsuggest_key_bindings
)
10355 && NILP (Vexecuting_kbd_macro
)
10356 && SYMBOLP (function
))
10357 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10363 GCPRO3 (bindings
, value
, function
);
10364 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10366 /* If the command has a key binding, print it now. */
10367 if (!NILP (bindings
)
10368 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10371 /* But first wait, and skip the message if there is input. */
10372 Lisp_Object waited
;
10374 /* If this command displayed something in the echo area;
10375 wait a few seconds, then display our suggestion message. */
10376 if (NILP (echo_area_buffer
[0]))
10377 waited
= sit_for (make_number (0), 0, 2);
10378 else if (NUMBERP (Vsuggest_key_bindings
))
10379 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10381 waited
= sit_for (make_number (2), 0, 2);
10383 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10385 Lisp_Object binding
;
10387 int message_p
= push_message ();
10388 int count
= SPECPDL_INDEX ();
10390 record_unwind_protect (pop_message_unwind
, Qnil
);
10391 binding
= Fkey_description (bindings
, Qnil
);
10394 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10397 sprintf (newmessage
, "You can run the command `%s' with %s",
10398 SDATA (SYMBOL_NAME (function
)),
10400 message2 (newmessage
,
10401 strlen (newmessage
),
10402 STRING_MULTIBYTE (binding
));
10403 if (NUMBERP (Vsuggest_key_bindings
))
10404 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10406 waited
= sit_for (make_number (2), 0, 2);
10408 if (!NILP (waited
) && message_p
)
10409 restore_message ();
10411 unbind_to (count
, Qnil
);
10415 RETURN_UNGCPRO (value
);
10419 /* Return nonzero if input events are pending. */
10422 detect_input_pending (void)
10424 if (!input_pending
)
10425 get_input_pending (&input_pending
, 0);
10427 return input_pending
;
10430 /* Return nonzero if input events other than mouse movements are
10434 detect_input_pending_ignore_squeezables (void)
10436 if (!input_pending
)
10437 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10439 return input_pending
;
10442 /* Return nonzero if input events are pending, and run any pending timers. */
10445 detect_input_pending_run_timers (int do_display
)
10447 int old_timers_run
= timers_run
;
10449 if (!input_pending
)
10450 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10452 if (old_timers_run
!= timers_run
&& do_display
)
10454 redisplay_preserve_echo_area (8);
10455 /* The following fixes a bug when using lazy-lock with
10456 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10457 from an idle timer function. The symptom of the bug is that
10458 the cursor sometimes doesn't become visible until the next X
10459 event is processed. --gerd. */
10461 Lisp_Object tail
, frame
;
10462 FOR_EACH_FRAME (tail
, frame
)
10463 if (FRAME_RIF (XFRAME (frame
)))
10464 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10468 return input_pending
;
10471 /* This is called in some cases before a possible quit.
10472 It cases the next call to detect_input_pending to recompute input_pending.
10473 So calling this function unnecessarily can't do any harm. */
10476 clear_input_pending (void)
10481 /* Return nonzero if there are pending requeued events.
10482 This isn't used yet. The hope is to make wait_reading_process_output
10483 call it, and return if it runs Lisp code that unreads something.
10484 The problem is, kbd_buffer_get_event needs to be fixed to know what
10485 to do in that case. It isn't trivial. */
10488 requeued_events_pending_p (void)
10490 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10494 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10495 doc
: /* Return t if command input is currently available with no wait.
10496 Actually, the value is nil only if we can be sure that no input is available;
10497 if there is a doubt, the value is t. */)
10500 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10501 || !NILP (Vunread_post_input_method_events
)
10502 || !NILP (Vunread_input_method_events
))
10505 get_input_pending (&input_pending
,
10506 READABLE_EVENTS_DO_TIMERS_NOW
10507 | READABLE_EVENTS_FILTER_EVENTS
);
10508 return input_pending
> 0 ? Qt
: Qnil
;
10511 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10512 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10515 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10518 if (total_keys
< NUM_RECENT_KEYS
)
10519 return Fvector (total_keys
, keys
);
10522 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10523 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10524 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10525 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10526 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10531 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10532 doc
: /* Return the key sequence that invoked this command.
10533 However, if the command has called `read-key-sequence', it returns
10534 the last key sequence that has been read.
10535 The value is a string or a vector.
10537 See also `this-command-keys-vector'. */)
10540 return make_event_array (this_command_key_count
,
10541 XVECTOR (this_command_keys
)->contents
);
10544 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10545 doc
: /* Return the key sequence that invoked this command, as a vector.
10546 However, if the command has called `read-key-sequence', it returns
10547 the last key sequence that has been read.
10549 See also `this-command-keys'. */)
10552 return Fvector (this_command_key_count
,
10553 XVECTOR (this_command_keys
)->contents
);
10556 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10557 Sthis_single_command_keys
, 0, 0, 0,
10558 doc
: /* Return the key sequence that invoked this command.
10559 More generally, it returns the last key sequence read, either by
10560 the command loop or by `read-key-sequence'.
10561 Unlike `this-command-keys', this function's value
10562 does not include prefix arguments.
10563 The value is always a vector. */)
10566 return Fvector (this_command_key_count
10567 - this_single_command_key_start
,
10568 (XVECTOR (this_command_keys
)->contents
10569 + this_single_command_key_start
));
10572 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10573 Sthis_single_command_raw_keys
, 0, 0, 0,
10574 doc
: /* Return the raw events that were read for this command.
10575 More generally, it returns the last key sequence read, either by
10576 the command loop or by `read-key-sequence'.
10577 Unlike `this-single-command-keys', this function's value
10578 shows the events before all translations (except for input methods).
10579 The value is always a vector. */)
10582 return Fvector (raw_keybuf_count
,
10583 (XVECTOR (raw_keybuf
)->contents
));
10586 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10587 Sreset_this_command_lengths
, 0, 0, 0,
10588 doc
: /* Make the unread events replace the last command and echo.
10589 Used in `universal-argument-other-key'.
10591 `universal-argument-other-key' rereads the event just typed.
10592 It then gets translated through `function-key-map'.
10593 The translated event has to replace the real events,
10594 both in the value of (this-command-keys) and in echoing.
10595 To achieve this, `universal-argument-other-key' calls
10596 `reset-this-command-lengths', which discards the record of reading
10597 these events the first time. */)
10600 this_command_key_count
= before_command_key_count
;
10601 if (this_command_key_count
< this_single_command_key_start
)
10602 this_single_command_key_start
= this_command_key_count
;
10604 echo_truncate (before_command_echo_length
);
10606 /* Cause whatever we put into unread-command-events
10607 to echo as if it were being freshly read from the keyboard. */
10608 this_command_key_count_reset
= 1;
10613 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10614 Sclear_this_command_keys
, 0, 1, 0,
10615 doc
: /* Clear out the vector that `this-command-keys' returns.
10616 Also clear the record of the last 100 events, unless optional arg
10617 KEEP-RECORD is non-nil. */)
10618 (Lisp_Object keep_record
)
10622 this_command_key_count
= 0;
10623 this_command_key_count_reset
= 0;
10625 if (NILP (keep_record
))
10627 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10628 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10630 recent_keys_index
= 0;
10635 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10636 doc
: /* Return the current depth in recursive edits. */)
10640 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10644 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10645 "FOpen dribble file: ",
10646 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10647 If FILE is nil, close any open dribble file.
10648 The file will be closed when Emacs exits. */)
10660 file
= Fexpand_file_name (file
, Qnil
);
10661 dribble
= fopen (SSDATA (file
), "w");
10663 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10668 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10669 doc
: /* Discard the contents of the terminal input buffer.
10670 Also end any kbd macro being defined. */)
10673 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10675 /* Discard the last command from the macro. */
10676 Fcancel_kbd_macro_events ();
10680 update_mode_lines
++;
10682 Vunread_command_events
= Qnil
;
10683 unread_command_char
= -1;
10685 discard_tty_input ();
10687 kbd_fetch_ptr
= kbd_store_ptr
;
10693 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10694 doc
: /* Stop Emacs and return to superior process. You can resume later.
10695 If `cannot-suspend' is non-nil, or if the system doesn't support job
10696 control, run a subshell instead.
10698 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10699 to be read as terminal input by Emacs's parent, after suspension.
10701 Before suspending, run the normal hook `suspend-hook'.
10702 After resumption run the normal hook `suspend-resume-hook'.
10704 Some operating systems cannot stop the Emacs process and resume it later.
10705 On such systems, Emacs starts a subshell instead of suspending. */)
10706 (Lisp_Object stuffstring
)
10708 int count
= SPECPDL_INDEX ();
10709 int old_height
, old_width
;
10711 struct gcpro gcpro1
;
10714 if (tty_list
&& tty_list
->next
)
10715 error ("There are other tty frames open; close them before suspending Emacs");
10717 if (!NILP (stuffstring
))
10718 CHECK_STRING (stuffstring
);
10720 /* Run the functions in suspend-hook. */
10721 hook
= intern ("suspend-hook");
10722 Frun_hooks (1, &hook
);
10724 GCPRO1 (stuffstring
);
10725 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10726 reset_all_sys_modes ();
10727 /* sys_suspend can get an error if it tries to fork a subshell
10728 and the system resources aren't available for that. */
10729 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10731 stuff_buffered_input (stuffstring
);
10732 if (cannot_suspend
)
10736 unbind_to (count
, Qnil
);
10738 /* Check if terminal/window size has changed.
10739 Note that this is not useful when we are running directly
10740 with a window system; but suspend should be disabled in that case. */
10741 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10742 if (width
!= old_width
|| height
!= old_height
)
10743 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10745 /* Run suspend-resume-hook. */
10746 hook
= intern ("suspend-resume-hook");
10747 Frun_hooks (1, &hook
);
10753 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10754 Then in any case stuff anything Emacs has read ahead and not used. */
10757 stuff_buffered_input (Lisp_Object stuffstring
)
10759 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10760 register unsigned char *p
;
10762 if (STRINGP (stuffstring
))
10764 register EMACS_INT count
;
10766 p
= SDATA (stuffstring
);
10767 count
= SBYTES (stuffstring
);
10768 while (count
-- > 0)
10773 /* Anything we have read ahead, put back for the shell to read. */
10774 /* ?? What should this do when we have multiple keyboards??
10775 Should we ignore anything that was typed in at the "wrong" kboard?
10777 rms: we should stuff everything back into the kboard
10779 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10782 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10783 kbd_fetch_ptr
= kbd_buffer
;
10784 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10785 stuff_char (kbd_fetch_ptr
->code
);
10787 clear_event (kbd_fetch_ptr
);
10791 #endif /* SIGTSTP */
10795 set_waiting_for_input (struct timeval
*time_to_clear
)
10797 input_available_clear_time
= time_to_clear
;
10799 /* Tell handle_interrupt to throw back to read_char, */
10800 waiting_for_input
= 1;
10802 /* If handle_interrupt was called before and buffered a C-g,
10803 make it run again now, to avoid timing error. */
10804 if (!NILP (Vquit_flag
))
10805 quit_throw_to_read_char ();
10809 clear_waiting_for_input (void)
10811 /* Tell handle_interrupt not to throw back to read_char, */
10812 waiting_for_input
= 0;
10813 input_available_clear_time
= 0;
10816 /* The SIGINT handler.
10818 If we have a frame on the controlling tty, we assume that the
10819 SIGINT was generated by C-g, so we call handle_interrupt.
10820 Otherwise, the handler kills Emacs. */
10823 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10824 /* compilers complain in signal calls. */
10826 /* Must preserve main program's value of errno. */
10827 int old_errno
= errno
;
10828 struct terminal
*terminal
;
10830 SIGNAL_THREAD_CHECK (signalnum
);
10832 /* See if we have an active terminal on our controlling tty. */
10833 terminal
= get_named_tty ("/dev/tty");
10836 /* If there are no frames there, let's pretend that we are a
10837 well-behaving UN*X program and quit. */
10838 Fkill_emacs (Qnil
);
10842 /* Otherwise, the SIGINT was probably generated by C-g. */
10844 /* Set internal_last_event_frame to the top frame of the
10845 controlling tty, if we have a frame there. We disable the
10846 interrupt key on secondary ttys, so the SIGINT must have come
10847 from the controlling tty. */
10848 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10850 handle_interrupt ();
10856 /* This routine is called at interrupt level in response to C-g.
10858 It is called from the SIGINT handler or kbd_buffer_store_event.
10860 If `waiting_for_input' is non zero, then unless `echoing' is
10861 nonzero, immediately throw back to read_char.
10863 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10864 eval to throw, when it gets a chance. If quit-flag is already
10865 non-nil, it stops the job right away. */
10868 handle_interrupt (void)
10874 /* XXX This code needs to be revised for multi-tty support. */
10875 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10877 /* If SIGINT isn't blocked, don't let us be interrupted by
10878 another SIGINT, it might be harmful due to non-reentrancy
10879 in I/O functions. */
10880 sigblock (sigmask (SIGINT
));
10883 reset_all_sys_modes ();
10885 #ifdef SIGTSTP /* Support possible in later USG versions */
10887 * On systems which can suspend the current process and return to the original
10888 * shell, this command causes the user to end up back at the shell.
10889 * The "Auto-save" and "Abort" questions are not asked until
10890 * the user elects to return to emacs, at which point he can save the current
10891 * job and either dump core or continue.
10895 /* Perhaps should really fork an inferior shell?
10896 But that would not provide any way to get back
10897 to the original shell, ever. */
10898 printf ("No support for stopping a process on this operating system;\n");
10899 printf ("you can continue or abort.\n");
10900 #endif /* not SIGTSTP */
10902 /* We must remain inside the screen area when the internal terminal
10903 is used. Note that [Enter] is not echoed by dos. */
10904 cursor_to (SELECTED_FRAME (), 0, 0);
10906 /* It doesn't work to autosave while GC is in progress;
10907 the code used for auto-saving doesn't cope with the mark bit. */
10908 if (!gc_in_progress
)
10910 printf ("Auto-save? (y or n) ");
10912 if (((c
= getchar ()) & ~040) == 'Y')
10914 Fdo_auto_save (Qt
, Qnil
);
10916 printf ("\r\nAuto-save done");
10917 #else /* not MSDOS */
10918 printf ("Auto-save done\n");
10919 #endif /* not MSDOS */
10921 while (c
!= '\n') c
= getchar ();
10925 /* During GC, it must be safe to reenable quitting again. */
10926 Vinhibit_quit
= Qnil
;
10929 #endif /* not MSDOS */
10930 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10931 printf ("but will instead do a real quit after garbage collection ends\r\n");
10936 printf ("\r\nAbort? (y or n) ");
10937 #else /* not MSDOS */
10938 printf ("Abort (and dump core)? (y or n) ");
10939 #endif /* not MSDOS */
10941 if (((c
= getchar ()) & ~040) == 'Y')
10943 while (c
!= '\n') c
= getchar ();
10945 printf ("\r\nContinuing...\r\n");
10946 #else /* not MSDOS */
10947 printf ("Continuing...\n");
10948 #endif /* not MSDOS */
10950 init_all_sys_modes ();
10955 /* If executing a function that wants to be interrupted out of
10956 and the user has not deferred quitting by binding `inhibit-quit'
10957 then quit right away. */
10958 if (immediate_quit
&& NILP (Vinhibit_quit
))
10960 struct gl_state_s saved
;
10961 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10963 immediate_quit
= 0;
10966 GCPRO4 (saved
.object
, saved
.global_code
,
10967 saved
.current_syntax_table
, saved
.old_prop
);
10968 Fsignal (Qquit
, Qnil
);
10969 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10974 /* Else request quit when it's safe */
10978 /* TODO: The longjmp in this call throws the NS event loop integration off,
10979 and it seems to do fine without this. Probably some attention
10980 needs to be paid to the setting of waiting_for_input in
10981 wait_reading_process_output() under HAVE_NS because of the call
10982 to ns_select there (needed because otherwise events aren't picked up
10983 outside of polling since we don't get SIGIO like X and we don't have a
10984 separate event loop thread like W32. */
10986 if (waiting_for_input
&& !echoing
)
10987 quit_throw_to_read_char ();
10991 /* Handle a C-g by making read_char return C-g. */
10994 quit_throw_to_read_char (void)
10997 /* Prevent another signal from doing this before we finish. */
10998 clear_waiting_for_input ();
11001 Vunread_command_events
= Qnil
;
11002 unread_command_char
= -1;
11004 #if 0 /* Currently, sit_for is called from read_char without turning
11005 off polling. And that can call set_waiting_for_input.
11006 It seems to be harmless. */
11007 #ifdef POLL_FOR_INPUT
11008 /* May be > 1 if in recursive minibuffer. */
11009 if (poll_suppress_count
== 0)
11013 if (FRAMEP (internal_last_event_frame
)
11014 && !EQ (internal_last_event_frame
, selected_frame
))
11015 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11018 _longjmp (getcjmp
, 1);
11021 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
11022 Sset_input_interrupt_mode
, 1, 1, 0,
11023 doc
: /* Set interrupt mode of reading keyboard input.
11024 If INTERRUPT is non-nil, Emacs will use input interrupts;
11025 otherwise Emacs uses CBREAK mode.
11027 See also `current-input-mode'. */)
11028 (Lisp_Object interrupt
)
11030 int new_interrupt_input
;
11032 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11033 #ifdef HAVE_X_WINDOWS
11034 if (x_display_list
!= NULL
)
11036 /* When using X, don't give the user a real choice,
11037 because we haven't implemented the mechanisms to support it. */
11038 new_interrupt_input
= 1;
11041 #endif /* HAVE_X_WINDOWS */
11042 new_interrupt_input
= !NILP (interrupt
);
11043 #else /* not SIGIO */
11044 new_interrupt_input
= 0;
11045 #endif /* not SIGIO */
11047 if (new_interrupt_input
!= interrupt_input
)
11049 #ifdef POLL_FOR_INPUT
11053 /* this causes startup screen to be restored and messes with the mouse */
11054 reset_all_sys_modes ();
11055 interrupt_input
= new_interrupt_input
;
11056 init_all_sys_modes ();
11058 interrupt_input
= new_interrupt_input
;
11061 #ifdef POLL_FOR_INPUT
11062 poll_suppress_count
= 1;
11069 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11070 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11071 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11072 C-q in key sequences.
11074 This setting only has an effect on tty terminals and only when
11075 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11077 See also `current-input-mode'. */)
11078 (Lisp_Object flow
, Lisp_Object terminal
)
11080 struct terminal
*t
= get_terminal (terminal
, 1);
11081 struct tty_display_info
*tty
;
11082 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11084 tty
= t
->display_info
.tty
;
11086 if (tty
->flow_control
!= !NILP (flow
))
11089 /* this causes startup screen to be restored and messes with the mouse */
11090 reset_sys_modes (tty
);
11093 tty
->flow_control
= !NILP (flow
);
11096 init_sys_modes (tty
);
11102 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11103 doc
: /* Enable or disable 8-bit input on TERMINAL.
11104 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11105 bit as the Meta modifier.
11107 If META is nil, Emacs will ignore the top bit, on the assumption it is
11110 Otherwise, Emacs will accept and pass through 8-bit input without
11111 specially interpreting the top bit.
11113 This setting only has an effect on tty terminal devices.
11115 Optional parameter TERMINAL specifies the tty terminal device to use.
11116 It may be a terminal object, a frame, or nil for the terminal used by
11117 the currently selected frame.
11119 See also `current-input-mode'. */)
11120 (Lisp_Object meta
, Lisp_Object terminal
)
11122 struct terminal
*t
= get_terminal (terminal
, 1);
11123 struct tty_display_info
*tty
;
11126 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11128 tty
= t
->display_info
.tty
;
11132 else if (EQ (meta
, Qt
))
11137 if (tty
->meta_key
!= new_meta
)
11140 /* this causes startup screen to be restored and messes with the mouse */
11141 reset_sys_modes (tty
);
11144 tty
->meta_key
= new_meta
;
11147 init_sys_modes (tty
);
11153 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11154 doc
: /* Specify character used for quitting.
11155 QUIT must be an ASCII character.
11157 This function only has an effect on the controlling tty of the Emacs
11160 See also `current-input-mode'. */)
11163 struct terminal
*t
= get_named_tty ("/dev/tty");
11164 struct tty_display_info
*tty
;
11165 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11167 tty
= t
->display_info
.tty
;
11169 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11170 error ("QUIT must be an ASCII character");
11173 /* this causes startup screen to be restored and messes with the mouse */
11174 reset_sys_modes (tty
);
11177 /* Don't let this value be out of range. */
11178 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11181 init_sys_modes (tty
);
11187 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11188 doc
: /* Set mode of reading keyboard input.
11189 First arg INTERRUPT non-nil means use input interrupts;
11190 nil means use CBREAK mode.
11191 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11192 (no effect except in CBREAK mode).
11193 Third arg META t means accept 8-bit input (for a Meta key).
11194 META nil means ignore the top bit, on the assumption it is parity.
11195 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11196 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11197 See also `current-input-mode'. */)
11198 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11200 Fset_input_interrupt_mode (interrupt
);
11201 Fset_output_flow_control (flow
, Qnil
);
11202 Fset_input_meta_mode (meta
, Qnil
);
11204 Fset_quit_char (quit
);
11208 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11209 doc
: /* Return information about the way Emacs currently reads keyboard input.
11210 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11211 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11212 nil, Emacs is using CBREAK mode.
11213 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11214 terminal; this does not apply if Emacs uses interrupt-driven input.
11215 META is t if accepting 8-bit input with 8th bit as Meta flag.
11216 META nil means ignoring the top bit, on the assumption it is parity.
11217 META is neither t nor nil if accepting 8-bit input and using
11218 all 8 bits as the character code.
11219 QUIT is the character Emacs currently uses to quit.
11220 The elements of this list correspond to the arguments of
11221 `set-input-mode'. */)
11224 Lisp_Object val
[4];
11225 struct frame
*sf
= XFRAME (selected_frame
);
11227 val
[0] = interrupt_input
? Qt
: Qnil
;
11228 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11230 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11231 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11233 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11240 XSETFASTINT (val
[3], quit_char
);
11242 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11245 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11246 doc
: /* Return position information for pixel coordinates X and Y.
11247 By default, X and Y are relative to text area of the selected window.
11248 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11249 If optional fourth arg WHOLE is non-nil, X is relative to the left
11250 edge of the window.
11252 The return value is similar to a mouse click position:
11253 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11254 IMAGE (DX . DY) (WIDTH . HEIGHT))
11255 The `posn-' functions access elements of such lists. */)
11256 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11261 if (NILP (frame_or_window
))
11262 frame_or_window
= selected_window
;
11264 if (WINDOWP (frame_or_window
))
11268 CHECK_LIVE_WINDOW (frame_or_window
);
11270 w
= XWINDOW (frame_or_window
);
11271 XSETINT (x
, (XINT (x
)
11272 + WINDOW_LEFT_EDGE_X (w
)
11274 ? window_box_left_offset (w
, TEXT_AREA
)
11276 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11277 frame_or_window
= w
->frame
;
11280 CHECK_LIVE_FRAME (frame_or_window
);
11282 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11285 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11286 doc
: /* Return position information for buffer POS in WINDOW.
11287 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11289 Return nil if position is not visible in window. Otherwise,
11290 the return value is similar to that returned by `event-start' for
11291 a mouse click at the upper left corner of the glyph corresponding
11292 to the given buffer position:
11293 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11294 IMAGE (DX . DY) (WIDTH . HEIGHT))
11295 The `posn-' functions access elements of such lists. */)
11296 (Lisp_Object pos
, Lisp_Object window
)
11301 window
= selected_window
;
11303 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11306 Lisp_Object x
= XCAR (tem
);
11307 Lisp_Object y
= XCAR (XCDR (tem
));
11309 /* Point invisible due to hscrolling? */
11312 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11320 * Set up a new kboard object with reasonable initial values.
11323 init_kboard (KBOARD
*kb
)
11325 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11326 KVAR (kb
, Vlast_command
) = Qnil
;
11327 KVAR (kb
, Vreal_last_command
) = Qnil
;
11328 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11329 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11330 KVAR (kb
, Vprefix_arg
) = Qnil
;
11331 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11332 KVAR (kb
, kbd_queue
) = Qnil
;
11333 kb
->kbd_queue_has_data
= 0;
11334 kb
->immediate_echo
= 0;
11335 KVAR (kb
, echo_string
) = Qnil
;
11336 kb
->echo_after_prompt
= -1;
11337 kb
->kbd_macro_buffer
= 0;
11338 kb
->kbd_macro_bufsize
= 0;
11339 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11340 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11341 kb
->reference_count
= 0;
11342 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11343 KVAR (kb
, system_key_syms
) = Qnil
;
11344 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11345 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11346 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11347 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11348 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11352 * Destroy the contents of a kboard object, but not the object itself.
11353 * We use this just before deleting it, or if we're going to initialize
11354 * it a second time.
11357 wipe_kboard (KBOARD
*kb
)
11359 xfree (kb
->kbd_macro_buffer
);
11362 /* Free KB and memory referenced from it. */
11365 delete_kboard (KBOARD
*kb
)
11369 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11372 *kbp
= kb
->next_kboard
;
11374 /* Prevent a dangling reference to KB. */
11375 if (kb
== current_kboard
11376 && FRAMEP (selected_frame
)
11377 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11379 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11381 if (current_kboard
== kb
)
11390 init_keyboard (void)
11392 /* This is correct before outermost invocation of the editor loop */
11393 command_loop_level
= -1;
11394 immediate_quit
= 0;
11395 quit_char
= Ctl ('g');
11396 Vunread_command_events
= Qnil
;
11397 unread_command_char
= -1;
11398 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11400 recent_keys_index
= 0;
11401 kbd_fetch_ptr
= kbd_buffer
;
11402 kbd_store_ptr
= kbd_buffer
;
11403 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11404 do_mouse_tracking
= Qnil
;
11407 interrupt_input_blocked
= 0;
11408 interrupt_input_pending
= 0;
11410 pending_signals
= 0;
11413 /* This means that command_loop_1 won't try to select anything the first
11415 internal_last_event_frame
= Qnil
;
11416 Vlast_event_frame
= internal_last_event_frame
;
11418 current_kboard
= initial_kboard
;
11419 /* Re-initialize the keyboard again. */
11420 wipe_kboard (current_kboard
);
11421 init_kboard (current_kboard
);
11422 /* A value of nil for Vwindow_system normally means a tty, but we also use
11423 it for the initial terminal since there is no window system there. */
11424 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11426 if (!noninteractive
)
11428 /* Before multi-tty support, these handlers used to be installed
11429 only if the current session was a tty session. Now an Emacs
11430 session may have multiple display types, so we always handle
11431 SIGINT. There is special code in interrupt_signal to exit
11432 Emacs on SIGINT when there are no termcap frames on the
11433 controlling terminal. */
11434 signal (SIGINT
, interrupt_signal
);
11436 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11437 SIGQUIT and we can't tell which one it will give us. */
11438 signal (SIGQUIT
, interrupt_signal
);
11439 #endif /* not DOS_NT */
11441 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11443 if (!noninteractive
)
11444 signal (SIGIO
, input_available_signal
);
11447 /* Use interrupt input by default, if it works and noninterrupt input
11448 has deficiencies. */
11450 #ifdef INTERRUPT_INPUT
11451 interrupt_input
= 1;
11453 interrupt_input
= 0;
11459 if (keyboard_init_hook
)
11460 (*keyboard_init_hook
) ();
11462 #ifdef POLL_FOR_INPUT
11464 poll_suppress_count
= 1;
11469 /* This type's only use is in syms_of_keyboard, to initialize the
11470 event header symbols and put properties on them. */
11471 struct event_head
{
11477 static const struct event_head head_table
[] = {
11478 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11479 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11480 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11481 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11482 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11483 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11484 /* `select-window' should be handled just like `switch-frame'
11485 in read_key_sequence. */
11486 {&Qselect_window
, "select-window", &Qswitch_frame
}
11490 syms_of_keyboard (void)
11492 pending_funcalls
= Qnil
;
11493 staticpro (&pending_funcalls
);
11495 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11496 staticpro (&Vlispy_mouse_stem
);
11499 DEFSYM (QCimage
, ":image");
11500 DEFSYM (Qhelp_echo
, "help-echo");
11501 DEFSYM (QCrtl
, ":rtl");
11503 staticpro (&item_properties
);
11504 item_properties
= Qnil
;
11506 staticpro (&tool_bar_item_properties
);
11507 tool_bar_item_properties
= Qnil
;
11508 staticpro (&tool_bar_items_vector
);
11509 tool_bar_items_vector
= Qnil
;
11511 staticpro (&real_this_command
);
11512 real_this_command
= Qnil
;
11514 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11515 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11516 DEFSYM (Qself_insert_command
, "self-insert-command");
11517 DEFSYM (Qforward_char
, "forward-char");
11518 DEFSYM (Qbackward_char
, "backward-char");
11519 DEFSYM (Qdisabled
, "disabled");
11520 DEFSYM (Qundefined
, "undefined");
11521 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11522 DEFSYM (Qpost_command_hook
, "post-command-hook");
11523 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11524 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11525 DEFSYM (Qfunction_key
, "function-key");
11526 DEFSYM (Qmouse_click
, "mouse-click");
11527 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11528 DEFSYM (Qsave_session
, "save-session");
11529 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11530 DEFSYM (Qmenu_enable
, "menu-enable");
11532 #if defined (WINDOWSNT)
11533 DEFSYM (Qlanguage_change
, "language-change");
11537 DEFSYM (Qdbus_event
, "dbus-event");
11540 DEFSYM (QCenable
, ":enable");
11541 DEFSYM (QCvisible
, ":visible");
11542 DEFSYM (QChelp
, ":help");
11543 DEFSYM (QCfilter
, ":filter");
11544 DEFSYM (QCbutton
, ":button");
11545 DEFSYM (QCkeys
, ":keys");
11546 DEFSYM (QCkey_sequence
, ":key-sequence");
11547 DEFSYM (QCtoggle
, ":toggle");
11548 DEFSYM (QCradio
, ":radio");
11549 DEFSYM (QClabel
, ":label");
11550 DEFSYM (QCvert_only
, ":vert-only");
11552 DEFSYM (Qmode_line
, "mode-line");
11553 DEFSYM (Qvertical_line
, "vertical-line");
11554 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11555 DEFSYM (Qmenu_bar
, "menu-bar");
11557 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11558 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11561 DEFSYM (Qabove_handle
, "above-handle");
11562 DEFSYM (Qhandle
, "handle");
11563 DEFSYM (Qbelow_handle
, "below-handle");
11564 DEFSYM (Qup
, "up");
11565 DEFSYM (Qdown
, "down");
11566 DEFSYM (Qtop
, "top");
11567 DEFSYM (Qbottom
, "bottom");
11568 DEFSYM (Qend_scroll
, "end-scroll");
11569 DEFSYM (Qratio
, "ratio");
11571 DEFSYM (Qevent_kind
, "event-kind");
11572 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11573 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11574 DEFSYM (Qmodifier_cache
, "modifier-cache");
11576 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11577 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11579 DEFSYM (Qpolling_period
, "polling-period");
11581 DEFSYM (Qx_set_selection
, "x-set-selection");
11582 DEFSYM (QPRIMARY
, "PRIMARY");
11583 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11585 DEFSYM (Qinput_method_function
, "input-method-function");
11586 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11587 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11589 DEFSYM (Qhelp_form_show
, "help-form-show");
11591 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11592 Fset (Qinput_method_use_echo_area
, Qnil
);
11594 last_point_position_buffer
= Qnil
;
11595 last_point_position_window
= Qnil
;
11599 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11601 for (i
= 0; i
< len
; i
++)
11603 const struct event_head
*p
= &head_table
[i
];
11604 *p
->var
= intern_c_string (p
->name
);
11605 staticpro (p
->var
);
11606 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11607 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11611 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11612 staticpro (&button_down_location
);
11613 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11614 staticpro (&mouse_syms
);
11615 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11616 / sizeof (lispy_wheel_names
[0])),
11618 staticpro (&wheel_syms
);
11622 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11624 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11625 for (i
= 0; i
< len
; i
++)
11626 if (modifier_names
[i
])
11627 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11628 staticpro (&modifier_symbols
);
11631 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11632 staticpro (&recent_keys
);
11634 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11635 staticpro (&this_command_keys
);
11637 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11638 staticpro (&raw_keybuf
);
11640 DEFSYM (Qextended_command_history
, "extended-command-history");
11641 Fset (Qextended_command_history
, Qnil
);
11643 accent_key_syms
= Qnil
;
11644 staticpro (&accent_key_syms
);
11646 func_key_syms
= Qnil
;
11647 staticpro (&func_key_syms
);
11649 drag_n_drop_syms
= Qnil
;
11650 staticpro (&drag_n_drop_syms
);
11652 unread_switch_frame
= Qnil
;
11653 staticpro (&unread_switch_frame
);
11655 internal_last_event_frame
= Qnil
;
11656 staticpro (&internal_last_event_frame
);
11658 read_key_sequence_cmd
= Qnil
;
11659 staticpro (&read_key_sequence_cmd
);
11661 menu_bar_one_keymap_changed_items
= Qnil
;
11662 staticpro (&menu_bar_one_keymap_changed_items
);
11664 menu_bar_items_vector
= Qnil
;
11665 staticpro (&menu_bar_items_vector
);
11667 help_form_saved_window_configs
= Qnil
;
11668 staticpro (&help_form_saved_window_configs
);
11670 defsubr (&Scurrent_idle_time
);
11671 defsubr (&Sevent_symbol_parse_modifiers
);
11672 defsubr (&Sevent_convert_list
);
11673 defsubr (&Sread_key_sequence
);
11674 defsubr (&Sread_key_sequence_vector
);
11675 defsubr (&Srecursive_edit
);
11676 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11677 defsubr (&Strack_mouse
);
11679 defsubr (&Sinput_pending_p
);
11680 defsubr (&Scommand_execute
);
11681 defsubr (&Srecent_keys
);
11682 defsubr (&Sthis_command_keys
);
11683 defsubr (&Sthis_command_keys_vector
);
11684 defsubr (&Sthis_single_command_keys
);
11685 defsubr (&Sthis_single_command_raw_keys
);
11686 defsubr (&Sreset_this_command_lengths
);
11687 defsubr (&Sclear_this_command_keys
);
11688 defsubr (&Ssuspend_emacs
);
11689 defsubr (&Sabort_recursive_edit
);
11690 defsubr (&Sexit_recursive_edit
);
11691 defsubr (&Srecursion_depth
);
11692 defsubr (&Stop_level
);
11693 defsubr (&Sdiscard_input
);
11694 defsubr (&Sopen_dribble_file
);
11695 defsubr (&Sset_input_interrupt_mode
);
11696 defsubr (&Sset_output_flow_control
);
11697 defsubr (&Sset_input_meta_mode
);
11698 defsubr (&Sset_quit_char
);
11699 defsubr (&Sset_input_mode
);
11700 defsubr (&Scurrent_input_mode
);
11701 defsubr (&Sexecute_extended_command
);
11702 defsubr (&Sposn_at_point
);
11703 defsubr (&Sposn_at_x_y
);
11705 DEFVAR_LISP ("last-command-event", last_command_event
,
11706 doc
: /* Last input event that was part of a command. */);
11708 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11709 doc
: /* Last input event in a command, except for mouse menu events.
11710 Mouse menus give back keys that don't look like mouse events;
11711 this variable holds the actual mouse event that led to the menu,
11712 so that you can determine whether the command was run by mouse or not. */);
11714 DEFVAR_LISP ("last-input-event", last_input_event
,
11715 doc
: /* Last input event. */);
11717 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11718 doc
: /* List of events to be read as the command input.
11719 These events are processed first, before actual keyboard input.
11720 Events read from this list are not normally added to `this-command-keys',
11721 as they will already have been added once as they were read for the first time.
11722 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11723 Vunread_command_events
= Qnil
;
11725 DEFVAR_INT ("unread-command-char", unread_command_char
,
11726 doc
: /* If not -1, an object to be read as next command input event. */);
11728 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11729 doc
: /* List of events to be processed as input by input methods.
11730 These events are processed before `unread-command-events'
11731 and actual keyboard input, but are not given to `input-method-function'. */);
11732 Vunread_post_input_method_events
= Qnil
;
11734 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11735 doc
: /* List of events to be processed as input by input methods.
11736 These events are processed after `unread-command-events', but
11737 before actual keyboard input.
11738 If there's an active input method, the events are given to
11739 `input-method-function'. */);
11740 Vunread_input_method_events
= Qnil
;
11742 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11743 doc
: /* Meta-prefix character code.
11744 Meta-foo as command input turns into this character followed by foo. */);
11745 XSETINT (meta_prefix_char
, 033);
11747 DEFVAR_KBOARD ("last-command", Vlast_command
,
11748 doc
: /* The last command executed.
11749 Normally a symbol with a function definition, but can be whatever was found
11750 in the keymap, or whatever the variable `this-command' was set to by that
11753 The value `mode-exit' is special; it means that the previous command
11754 read an event that told it to exit, and it did so and unread that event.
11755 In other words, the present command is the event that made the previous
11758 The value `kill-region' is special; it means that the previous command
11759 was a kill command.
11761 `last-command' has a separate binding for each terminal device.
11762 See Info node `(elisp)Multiple Terminals'. */);
11764 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11765 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11767 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11768 doc
: /* Last command that may be repeated.
11769 The last command executed that was not bound to an input event.
11770 This is the command `repeat' will try to repeat. */);
11772 DEFVAR_LISP ("this-command", Vthis_command
,
11773 doc
: /* The command now being executed.
11774 The command can set this variable; whatever is put here
11775 will be in `last-command' during the following command. */);
11776 Vthis_command
= Qnil
;
11778 DEFVAR_LISP ("this-command-keys-shift-translated",
11779 Vthis_command_keys_shift_translated
,
11780 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11781 Shift-translation occurs when there is no binding for the key sequence
11782 as entered, but a binding was found by changing an upper-case letter
11783 to lower-case, or a shifted function key to an unshifted one. */);
11784 Vthis_command_keys_shift_translated
= Qnil
;
11786 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11787 doc
: /* The command bound to the current key sequence before remapping.
11788 It equals `this-command' if the original command was not remapped through
11789 any of the active keymaps. Otherwise, the value of `this-command' is the
11790 result of looking up the original command in the active keymaps. */);
11791 Vthis_original_command
= Qnil
;
11793 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11794 doc
: /* *Number of input events between auto-saves.
11795 Zero means disable autosaving due to number of characters typed. */);
11796 auto_save_interval
= 300;
11798 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11799 doc
: /* *Number of seconds idle time before auto-save.
11800 Zero or nil means disable auto-saving due to idleness.
11801 After auto-saving due to this many seconds of idle time,
11802 Emacs also does a garbage collection if that seems to be warranted. */);
11803 XSETFASTINT (Vauto_save_timeout
, 30);
11805 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11806 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11807 The value may be integer or floating point. */);
11808 Vecho_keystrokes
= make_number (1);
11810 DEFVAR_INT ("polling-period", polling_period
,
11811 doc
: /* *Interval between polling for input during Lisp execution.
11812 The reason for polling is to make C-g work to stop a running program.
11813 Polling is needed only when using X windows and SIGIO does not work.
11814 Polling is automatically disabled in all other cases. */);
11815 polling_period
= 2;
11817 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11818 doc
: /* *Maximum time between mouse clicks to make a double-click.
11819 Measured in milliseconds. The value nil means disable double-click
11820 recognition; t means double-clicks have no time limit and are detected
11821 by position only. */);
11822 Vdouble_click_time
= make_number (500);
11824 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11825 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11826 On window-system frames, value is the number of pixels the mouse may have
11827 moved horizontally or vertically between two clicks to make a double-click.
11828 On non window-system frames, value is interpreted in units of 1/8 characters
11831 This variable is also the threshold for motion of the mouse
11832 to count as a drag. */);
11833 double_click_fuzz
= 3;
11835 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11836 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11837 inhibit_local_menu_bar_menus
= 0;
11839 DEFVAR_INT ("num-input-keys", num_input_keys
,
11840 doc
: /* Number of complete key sequences read as input so far.
11841 This includes key sequences read from keyboard macros.
11842 The number is effectively the number of interactive command invocations. */);
11843 num_input_keys
= 0;
11845 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11846 doc
: /* Number of input events read from the keyboard so far.
11847 This does not include events generated by keyboard macros. */);
11848 num_nonmacro_input_events
= 0;
11850 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11851 doc
: /* The frame in which the most recently read event occurred.
11852 If the last event came from a keyboard macro, this is set to `macro'. */);
11853 Vlast_event_frame
= Qnil
;
11855 /* This variable is set up in sysdep.c. */
11856 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11857 doc
: /* The ERASE character as set by the user with stty. */);
11859 DEFVAR_LISP ("help-char", Vhelp_char
,
11860 doc
: /* Character to recognize as meaning Help.
11861 When it is read, do `(eval help-form)', and display result if it's a string.
11862 If the value of `help-form' is nil, this char can be read normally. */);
11863 XSETINT (Vhelp_char
, Ctl ('H'));
11865 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11866 doc
: /* List of input events to recognize as meaning Help.
11867 These work just like the value of `help-char' (see that). */);
11868 Vhelp_event_list
= Qnil
;
11870 DEFVAR_LISP ("help-form", Vhelp_form
,
11871 doc
: /* Form to execute when character `help-char' is read.
11872 If the form returns a string, that string is displayed.
11873 If `help-form' is nil, the help char is not recognized. */);
11876 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11877 doc
: /* Command to run when `help-char' character follows a prefix key.
11878 This command is used only when there is no actual binding
11879 for that character after that prefix key. */);
11880 Vprefix_help_command
= Qnil
;
11882 DEFVAR_LISP ("top-level", Vtop_level
,
11883 doc
: /* Form to evaluate when Emacs starts up.
11884 Useful to set before you dump a modified Emacs. */);
11887 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11888 doc
: /* Translate table for local keyboard input, or nil.
11889 If non-nil, the value should be a char-table. Each character read
11890 from the keyboard is looked up in this char-table. If the value found
11891 there is non-nil, then it is used instead of the actual input character.
11893 The value can also be a string or vector, but this is considered obsolete.
11894 If it is a string or vector of length N, character codes N and up are left
11895 untranslated. In a vector, an element which is nil means "no translation".
11897 This is applied to the characters supplied to input methods, not their
11898 output. See also `translation-table-for-input'.
11900 This variable has a separate binding for each terminal.
11901 See Info node `(elisp)Multiple Terminals'. */);
11903 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11904 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11905 \(Even if the operating system has support for stopping a process.\) */);
11906 cannot_suspend
= 0;
11908 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11909 doc
: /* Non-nil means prompt with menus when appropriate.
11910 This is done when reading from a keymap that has a prompt string,
11911 for elements that have prompt strings.
11912 The menu is displayed on the screen
11913 if X menus were enabled at configuration
11914 time and the previous event was a mouse click prefix key.
11915 Otherwise, menu prompting uses the echo area. */);
11916 menu_prompting
= 1;
11918 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11919 doc
: /* Character to see next line of menu prompt.
11920 Type this character while in a menu prompt to rotate around the lines of it. */);
11921 XSETINT (menu_prompt_more_char
, ' ');
11923 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11924 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11925 Emacs applies the modifiers of the character stored here to each keyboard
11926 character it reads. For example, after evaluating the expression
11927 (setq extra-keyboard-modifiers ?\\C-x)
11928 all input characters will have the control modifier applied to them.
11930 Note that the character ?\\C-@, equivalent to the integer zero, does
11931 not count as a control character; rather, it counts as a character
11932 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11933 cancels any modification. */);
11934 extra_keyboard_modifiers
= 0;
11936 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11937 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11938 The command loop sets this to nil before each command,
11939 and tests the value when the command returns.
11940 Buffer modification stores t in this variable. */);
11941 Vdeactivate_mark
= Qnil
;
11942 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11944 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11945 doc
: /* Normal hook run before each command is executed.
11946 If an unhandled error happens in running this hook,
11947 the function in which the error occurred is unconditionally removed, since
11948 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11949 Vpre_command_hook
= Qnil
;
11951 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11952 doc
: /* Normal hook run after each command is executed.
11953 If an unhandled error happens in running this hook,
11954 the function in which the error occurred is unconditionally removed, since
11955 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11956 Vpost_command_hook
= Qnil
;
11959 DEFVAR_LISP ("echo-area-clear-hook", ...,
11960 doc
: /* Normal hook run when clearing the echo area. */);
11962 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11963 Fset (Qecho_area_clear_hook
, Qnil
);
11965 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11966 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11967 Vlucid_menu_bar_dirty_flag
= Qnil
;
11969 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11970 doc
: /* List of menu bar items to move to the end of the menu bar.
11971 The elements of the list are event types that may have menu bar bindings. */);
11972 Vmenu_bar_final_items
= Qnil
;
11974 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11975 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11976 This is used internally by graphical displays that do not render
11977 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11978 Vtool_bar_separator_image_expression
= Qnil
;
11980 DEFVAR_KBOARD ("overriding-terminal-local-map",
11981 Voverriding_terminal_local_map
,
11982 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11983 If this variable is non-nil, it is used as a keymap instead of the
11984 buffer's local map, and the minor mode keymaps and text property keymaps.
11985 It also replaces `overriding-local-map'.
11987 This variable is intended to let commands such as `universal-argument'
11988 set up a different keymap for reading the next command.
11990 `overriding-terminal-local-map' has a separate binding for each
11992 See Info node `(elisp)Multiple Terminals'. */);
11994 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11995 doc
: /* Keymap that overrides all other local keymaps.
11996 If this variable is non-nil, it is used as a keymap--replacing the
11997 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11998 Voverriding_local_map
= Qnil
;
12000 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
12001 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12002 Otherwise, the menu bar continues to reflect the buffer's local map
12003 and the minor mode maps regardless of `overriding-local-map'. */);
12004 Voverriding_local_map_menu_flag
= Qnil
;
12006 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12007 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12008 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12010 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12011 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12013 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12014 doc
: /* Alist of system-specific X windows key symbols.
12015 Each element should have the form (N . SYMBOL) where N is the
12016 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12017 and SYMBOL is its name.
12019 `system-key-alist' has a separate binding for each terminal device.
12020 See Info node `(elisp)Multiple Terminals'. */);
12022 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12023 doc
: /* Keymap that translates key sequences to key sequences during input.
12024 This is used mainly for mapping key sequences into some preferred
12025 key events (symbols).
12027 The `read-key-sequence' function replaces any subsequence bound by
12028 `local-function-key-map' with its binding. More precisely, when the
12029 active keymaps have no binding for the current key sequence but
12030 `local-function-key-map' binds a suffix of the sequence to a vector or
12031 string, `read-key-sequence' replaces the matching suffix with its
12032 binding, and continues with the new sequence.
12034 If the binding is a function, it is called with one argument (the prompt)
12035 and its return value (a key sequence) is used.
12037 The events that come from bindings in `local-function-key-map' are not
12038 themselves looked up in `local-function-key-map'.
12040 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12041 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12042 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12043 typing `ESC O P x' would return [f1 x].
12045 `local-function-key-map' has a separate binding for each terminal
12046 device. See Info node `(elisp)Multiple Terminals'. If you need to
12047 define a binding on all terminals, change `function-key-map'
12048 instead. Initially, `local-function-key-map' is an empty keymap that
12049 has `function-key-map' as its parent on all terminal devices. */);
12051 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12052 doc
: /* Keymap that decodes input escape sequences.
12053 This is used mainly for mapping ASCII function key sequences into
12054 real Emacs function key events (symbols).
12056 The `read-key-sequence' function replaces any subsequence bound by
12057 `input-decode-map' with its binding. Contrary to `function-key-map',
12058 this map applies its rebinding regardless of the presence of an ordinary
12059 binding. So it is more like `key-translation-map' except that it applies
12060 before `function-key-map' rather than after.
12062 If the binding is a function, it is called with one argument (the prompt)
12063 and its return value (a key sequence) is used.
12065 The events that come from bindings in `input-decode-map' are not
12066 themselves looked up in `input-decode-map'.
12068 This variable is keyboard-local. */);
12070 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12071 doc
: /* The parent keymap of all `local-function-key-map' instances.
12072 Function key definitions that apply to all terminal devices should go
12073 here. If a mapping is defined in both the current
12074 `local-function-key-map' binding and this variable, then the local
12075 definition will take precendence. */);
12076 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12078 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12079 doc
: /* Keymap of key translations that can override keymaps.
12080 This keymap works like `function-key-map', but comes after that,
12081 and its non-prefix bindings override ordinary bindings.
12082 Another difference is that it is global rather than keyboard-local. */);
12083 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12085 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12086 doc
: /* List of deferred actions to be performed at a later time.
12087 The precise format isn't relevant here; we just check whether it is nil. */);
12088 Vdeferred_action_list
= Qnil
;
12090 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12091 doc
: /* Function to call to handle deferred actions, after each command.
12092 This function is called with no arguments after each command
12093 whenever `deferred-action-list' is non-nil. */);
12094 Vdeferred_action_function
= Qnil
;
12096 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12097 doc
: /* List of warnings to be displayed as soon as possible.
12098 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12099 as per the args of `display-warning' (which see).
12100 If this variable is non-nil, `delayed-warnings-hook' will be run
12101 immediately after running `post-command-hook'. */);
12102 Vdelayed_warnings_list
= Qnil
;
12104 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12105 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12106 The value can be a length of time to show the message for.
12107 If the value is non-nil and not a number, we wait 2 seconds. */);
12108 Vsuggest_key_bindings
= Qt
;
12110 DEFVAR_LISP ("timer-list", Vtimer_list
,
12111 doc
: /* List of active absolute time timers in order of increasing time. */);
12112 Vtimer_list
= Qnil
;
12114 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12115 doc
: /* List of active idle-time timers in order of increasing time. */);
12116 Vtimer_idle_list
= Qnil
;
12118 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12119 doc
: /* If non-nil, the function that implements the current input method.
12120 It's called with one argument, a printing character that was just read.
12121 \(That means a character with code 040...0176.)
12122 Typically this function uses `read-event' to read additional events.
12123 When it does so, it should first bind `input-method-function' to nil
12124 so it will not be called recursively.
12126 The function should return a list of zero or more events
12127 to be used as input. If it wants to put back some events
12128 to be reconsidered, separately, by the input method,
12129 it can add them to the beginning of `unread-command-events'.
12131 The input method function can find in `input-method-previous-message'
12132 the previous echo area message.
12134 The input method function should refer to the variables
12135 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12136 for guidance on what to do. */);
12137 Vinput_method_function
= Qnil
;
12139 DEFVAR_LISP ("input-method-previous-message",
12140 Vinput_method_previous_message
,
12141 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12142 This variable exists because `read-event' clears the echo area
12143 before running the input method. It is nil if there was no message. */);
12144 Vinput_method_previous_message
= Qnil
;
12146 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12147 doc
: /* If non-nil, the function that implements the display of help.
12148 It's called with one argument, the help string to display. */);
12149 Vshow_help_function
= Qnil
;
12151 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12152 doc
: /* If non-nil, suppress point adjustment after executing a command.
12154 After a command is executed, if point is moved into a region that has
12155 special properties (e.g. composition, display), we adjust point to
12156 the boundary of the region. But, when a command sets this variable to
12157 non-nil, we suppress the point adjustment.
12159 This variable is set to nil before reading a command, and is checked
12160 just after executing the command. */);
12161 Vdisable_point_adjustment
= Qnil
;
12163 DEFVAR_LISP ("global-disable-point-adjustment",
12164 Vglobal_disable_point_adjustment
,
12165 doc
: /* *If non-nil, always suppress point adjustment.
12167 The default value is nil, in which case, point adjustment are
12168 suppressed only after special commands that set
12169 `disable-point-adjustment' (which see) to non-nil. */);
12170 Vglobal_disable_point_adjustment
= Qnil
;
12172 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12173 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12174 If the value is not a number, such messages don't time out. */);
12175 Vminibuffer_message_timeout
= make_number (2);
12177 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12178 doc
: /* If non-nil, any keyboard input throws to this symbol.
12179 The value of that variable is passed to `quit-flag' and later causes a
12180 peculiar kind of quitting. */);
12181 Vthrow_on_input
= Qnil
;
12183 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12184 doc
: /* If non-nil, function to output error messages.
12185 The arguments are the error data, a list of the form
12186 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12187 such as just as `condition-case' would bind its variable to,
12188 the context (a string which normally goes at the start of the message),
12189 and the Lisp function within which the error was signaled. */);
12190 Vcommand_error_function
= Qnil
;
12192 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12193 Venable_disabled_menus_and_buttons
,
12194 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12196 Help functions bind this to allow help on disabled menu items
12197 and tool-bar buttons. */);
12198 Venable_disabled_menus_and_buttons
= Qnil
;
12200 DEFVAR_LISP ("select-active-regions",
12201 Vselect_active_regions
,
12202 doc
: /* If non-nil, an active region automatically sets the primary selection.
12203 If the value is `only', only temporarily active regions (usually made
12204 by mouse-dragging or shift-selection) set the window selection.
12206 This takes effect only when Transient Mark mode is enabled. */);
12207 Vselect_active_regions
= Qt
;
12209 DEFVAR_LISP ("saved-region-selection",
12210 Vsaved_region_selection
,
12211 doc
: /* Contents of active region prior to buffer modification.
12212 If `select-active-regions' is non-nil, Emacs sets this to the
12213 text in the region before modifying the buffer. The next
12214 `deactivate-mark' call uses this to set the window selection. */);
12215 Vsaved_region_selection
= Qnil
;
12217 DEFVAR_LISP ("debug-on-event",
12219 doc
: /* Enter debugger on this event. When Emacs
12220 receives the special event specifed by this variable, it will try to
12221 break into the debugger as soon as possible instead of processing the
12222 event normally through `special-event-map'.
12224 Currently, the only supported values for this
12225 variable are `sigusr1' and `sigusr2'. */);
12226 Vdebug_on_event
= intern_c_string ("sigusr2");
12228 /* Create the initial keyboard. */
12229 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12230 init_kboard (initial_kboard
);
12231 /* Vwindow_system is left at t for now. */
12232 initial_kboard
->next_kboard
= all_kboards
;
12233 all_kboards
= initial_kboard
;
12237 keys_of_keyboard (void)
12239 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12240 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12241 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12242 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12243 initial_define_key (meta_map
, 'x', "execute-extended-command");
12245 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12246 "handle-delete-frame");
12247 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12248 "ns-put-working-text");
12249 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12250 "ns-unput-working-text");
12251 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12252 current-prefix-arg, as is done in `handle-switch-frame'.
12253 But `handle-switch-frame is not run from the special-map.
12254 Commands from that map are run in a special way that automatically
12255 preserves the prefix-arg. Restoring the prefix arg here is not just
12256 redundant but harmful:
12258 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12259 - after the first prompt, the exit-minibuffer-hook is run which may
12260 iconify a frame and thus push a `iconify-frame' event.
12261 - after running exit-minibuffer-hook, current-prefix-arg is
12262 restored to the non-nil value it had before the prompt.
12263 - we enter the second prompt.
12264 current-prefix-arg is non-nil, prefix-arg is nil.
12265 - before running the first real event, we run the special iconify-frame
12266 event, but we pass the `special' arg to execute-command so
12267 current-prefix-arg and prefix-arg are left untouched.
12268 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12269 - the next key event will have a spuriously non-nil current-prefix-arg. */
12270 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12272 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12274 /* Handling it at such a low-level causes read_key_sequence to get
12275 * confused because it doesn't realize that the current_buffer was
12276 * changed by read_char.
12278 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12279 * "handle-select-window"); */
12280 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12281 "handle-save-session");
12284 /* Define a special event which is raised for dbus callback
12286 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12287 "dbus-handle-event");
12290 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12294 /* Mark the pointers in the kboard objects.
12295 Called by the Fgarbage_collector. */
12297 mark_kboards (void)
12301 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12303 if (kb
->kbd_macro_buffer
)
12304 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12306 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12307 mark_object (KVAR (kb
, Vlast_command
));
12308 mark_object (KVAR (kb
, Vreal_last_command
));
12309 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12310 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12311 mark_object (KVAR (kb
, Vprefix_arg
));
12312 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12313 mark_object (KVAR (kb
, kbd_queue
));
12314 mark_object (KVAR (kb
, defining_kbd_macro
));
12315 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12316 mark_object (KVAR (kb
, Vsystem_key_alist
));
12317 mark_object (KVAR (kb
, system_key_syms
));
12318 mark_object (KVAR (kb
, Vwindow_system
));
12319 mark_object (KVAR (kb
, Vinput_decode_map
));
12320 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12321 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12322 mark_object (KVAR (kb
, echo_string
));
12325 struct input_event
*event
;
12326 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12328 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12329 event
= kbd_buffer
;
12330 if (event
->kind
!= SELECTION_REQUEST_EVENT
12331 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12333 mark_object (event
->x
);
12334 mark_object (event
->y
);
12336 mark_object (event
->frame_or_window
);
12337 mark_object (event
->arg
);