1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
100 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
101 static int single_kboard
;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled
;
106 static Lisp_Object Qdisabled_command_function
;
108 #define NUM_RECENT_KEYS (300)
110 /* Index for storing next element into recent_keys. */
111 static int recent_keys_index
;
113 /* Total number of elements stored into recent_keys. */
114 static int total_keys
;
116 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
117 static Lisp_Object recent_keys
;
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 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 (ptrdiff_t, Lisp_Object
*,
440 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
442 static Lisp_Object
make_lispy_event (struct input_event
*);
443 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
444 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
445 enum scroll_bar_part
,
446 Lisp_Object
, Lisp_Object
,
449 static Lisp_Object
modify_event_symbol (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
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2271 Lisp_Object prev_event
,
2272 int *used_mouse_menu
, struct timeval
*end_time
)
2274 volatile Lisp_Object c
;
2276 jmp_buf local_getcjmp
;
2278 volatile int key_already_recorded
= 0;
2279 Lisp_Object tem
, save
;
2280 volatile Lisp_Object previous_echo_area_message
;
2281 volatile Lisp_Object also_record
;
2282 volatile int reread
;
2283 struct gcpro gcpro1
, gcpro2
;
2284 int volatile polling_stopped_here
= 0;
2285 struct kboard
*orig_kboard
= current_kboard
;
2289 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2290 before_command_key_count
= this_command_key_count
;
2291 before_command_echo_length
= echo_length ();
2294 previous_echo_area_message
= Qnil
;
2296 GCPRO2 (c
, previous_echo_area_message
);
2301 if (CONSP (Vunread_post_input_method_events
))
2303 c
= XCAR (Vunread_post_input_method_events
);
2304 Vunread_post_input_method_events
2305 = XCDR (Vunread_post_input_method_events
);
2307 /* Undo what read_char_x_menu_prompt did when it unread
2308 additional keys returned by Fx_popup_menu. */
2310 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2318 if (unread_command_char
!= -1)
2320 XSETINT (c
, unread_command_char
);
2321 unread_command_char
= -1;
2327 if (CONSP (Vunread_command_events
))
2329 int was_disabled
= 0;
2331 c
= XCAR (Vunread_command_events
);
2332 Vunread_command_events
= XCDR (Vunread_command_events
);
2336 /* Undo what sit-for did when it unread additional keys
2337 inside universal-argument. */
2340 && EQ (XCAR (c
), Qt
))
2346 /* Undo what read_char_x_menu_prompt did when it unread
2347 additional keys returned by Fx_popup_menu. */
2349 && EQ (XCDR (c
), Qdisabled
)
2350 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2356 /* If the queued event is something that used the mouse,
2357 set used_mouse_menu accordingly. */
2359 /* Also check was_disabled so last-nonmenu-event won't return
2360 a bad value when submenus are involved. (Bug#447) */
2361 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2362 *used_mouse_menu
= 1;
2364 goto reread_for_input_method
;
2367 if (CONSP (Vunread_input_method_events
))
2369 c
= XCAR (Vunread_input_method_events
);
2370 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2372 /* Undo what read_char_x_menu_prompt did when it unread
2373 additional keys returned by Fx_popup_menu. */
2375 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2379 goto reread_for_input_method
;
2382 this_command_key_count_reset
= 0;
2384 if (!NILP (Vexecuting_kbd_macro
))
2386 /* We set this to Qmacro; since that's not a frame, nobody will
2387 try to switch frames on us, and the selected window will
2390 Since this event came from a macro, it would be misleading to
2391 leave internal_last_event_frame set to wherever the last
2392 real event came from. Normally, a switch-frame event selects
2393 internal_last_event_frame after each command is read, but
2394 events read from a macro should never cause a new frame to be
2396 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2398 /* Exit the macro if we are at the end.
2399 Also, some things replace the macro with t
2400 to force an early exit. */
2401 if (EQ (Vexecuting_kbd_macro
, Qt
)
2402 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2408 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2409 if (STRINGP (Vexecuting_kbd_macro
)
2410 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2411 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2413 executing_kbd_macro_index
++;
2418 if (!NILP (unread_switch_frame
))
2420 c
= unread_switch_frame
;
2421 unread_switch_frame
= Qnil
;
2423 /* This event should make it into this_command_keys, and get echoed
2424 again, so we do not set `reread'. */
2428 /* if redisplay was requested */
2429 if (commandflag
>= 0)
2431 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2433 /* If there is pending input, process any events which are not
2434 user-visible, such as X selection_request events. */
2436 || detect_input_pending_run_timers (0))
2437 swallow_events (0); /* may clear input_pending */
2439 /* Redisplay if no pending input. */
2440 while (!input_pending
)
2442 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2443 redisplay_preserve_echo_area (5);
2448 /* Normal case: no input arrived during redisplay. */
2451 /* Input arrived and pre-empted redisplay.
2452 Process any events which are not user-visible. */
2454 /* If that cleared input_pending, try again to redisplay. */
2457 /* Prevent the redisplay we just did
2458 from messing up echoing of the input after the prompt. */
2459 if (commandflag
== 0 && echo_current
)
2460 echo_message_buffer
= echo_area_buffer
[0];
2464 /* Message turns off echoing unless more keystrokes turn it on again.
2466 The code in 20.x for the condition was
2468 1. echo_area_glyphs && *echo_area_glyphs
2469 2. && echo_area_glyphs != current_kboard->echobuf
2470 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2472 (1) means there's a current message displayed
2474 (2) means it's not the message from echoing from the current
2477 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2478 is set to a non-null value. This is done in read_char and it is
2479 set to echo_area_glyphs after a call to echo_char. That means
2480 ok_to_echo_at_next_pause is either null or
2481 current_kboard->echobuf with the appropriate current_kboard at
2484 So, condition (3) means in clear text ok_to_echo_at_next_pause
2485 must be either null, or the current message isn't from echoing at
2486 all, or it's from echoing from a different kboard than the
2489 if (/* There currently is something in the echo area. */
2490 !NILP (echo_area_buffer
[0])
2491 && (/* And it's either not from echoing. */
2492 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2493 /* Or it's an echo from a different kboard. */
2494 || echo_kboard
!= current_kboard
2495 /* Or we explicitly allow overwriting whatever there is. */
2496 || ok_to_echo_at_next_pause
== NULL
))
2501 /* Try reading a character via menu prompting in the minibuf.
2502 Try this before the sit-for, because the sit-for
2503 would do the wrong thing if we are supposed to do
2504 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2505 after a mouse event so don't try a minibuf menu. */
2507 if (nmaps
> 0 && INTERACTIVE
2508 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2509 /* Don't bring up a menu if we already have another event. */
2510 && NILP (Vunread_command_events
)
2511 && unread_command_char
< 0
2512 && !detect_input_pending_run_timers (0))
2514 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2516 if (INTEGERP (c
) && XINT (c
) == -2)
2517 return c
; /* wrong_kboard_jmpbuf */
2521 key_already_recorded
= 1;
2526 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2527 We will do that below, temporarily for short sections of code,
2528 when appropriate. local_getcjmp must be in effect
2529 around any call to sit_for or kbd_buffer_get_event;
2530 it *must not* be in effect when we call redisplay. */
2532 jmpcount
= SPECPDL_INDEX ();
2533 if (_setjmp (local_getcjmp
))
2535 /* Handle quits while reading the keyboard. */
2536 /* We must have saved the outer value of getcjmp here,
2537 so restore it now. */
2538 restore_getcjmp (save_jump
);
2539 unbind_to (jmpcount
, Qnil
);
2540 XSETINT (c
, quit_char
);
2541 internal_last_event_frame
= selected_frame
;
2542 Vlast_event_frame
= internal_last_event_frame
;
2543 /* If we report the quit char as an event,
2544 don't do so more than once. */
2545 if (!NILP (Vinhibit_quit
))
2549 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2550 if (kb
!= current_kboard
)
2552 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2553 /* We shouldn't get here if we were in single-kboard mode! */
2558 while (CONSP (XCDR (last
)))
2560 if (!NILP (XCDR (last
)))
2564 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2566 XSETCDR (last
, Fcons (c
, Qnil
));
2567 kb
->kbd_queue_has_data
= 1;
2568 current_kboard
= kb
;
2569 /* This is going to exit from read_char
2570 so we had better get rid of this frame's stuff. */
2572 return make_number (-2); /* wrong_kboard_jmpbuf */
2578 /* Start idle timers if no time limit is supplied. We don't do it
2579 if a time limit is supplied to avoid an infinite recursion in the
2580 situation where an idle timer calls `sit-for'. */
2583 timer_start_idle ();
2585 /* If in middle of key sequence and minibuffer not active,
2586 start echoing if enough time elapses. */
2588 if (minibuf_level
== 0
2590 && !current_kboard
->immediate_echo
2591 && this_command_key_count
> 0
2593 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2594 && NILP (Fzerop (Vecho_keystrokes
))
2595 && (/* No message. */
2596 NILP (echo_area_buffer
[0])
2597 /* Or empty message. */
2598 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2599 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2600 /* Or already echoing from same kboard. */
2601 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2602 /* Or not echoing before and echoing allowed. */
2603 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2605 /* After a mouse event, start echoing right away.
2606 This is because we are probably about to display a menu,
2607 and we don't want to delay before doing so. */
2608 if (EVENT_HAS_PARAMETERS (prev_event
))
2614 save_getcjmp (save_jump
);
2615 restore_getcjmp (local_getcjmp
);
2616 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2617 restore_getcjmp (save_jump
);
2619 && ! CONSP (Vunread_command_events
))
2624 /* Maybe auto save due to number of keystrokes. */
2626 if (commandflag
!= 0
2627 && auto_save_interval
> 0
2628 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2629 && !detect_input_pending_run_timers (0))
2631 Fdo_auto_save (Qnil
, Qnil
);
2632 /* Hooks can actually change some buffers in auto save. */
2636 /* Try reading using an X menu.
2637 This is never confused with reading using the minibuf
2638 because the recursive call of read_char in read_char_minibuf_menu_prompt
2639 does not pass on any keymaps. */
2641 if (nmaps
> 0 && INTERACTIVE
2642 && !NILP (prev_event
)
2643 && EVENT_HAS_PARAMETERS (prev_event
)
2644 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2645 && !EQ (XCAR (prev_event
), Qtool_bar
)
2646 /* Don't bring up a menu if we already have another event. */
2647 && NILP (Vunread_command_events
)
2648 && unread_command_char
< 0)
2650 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2652 /* Now that we have read an event, Emacs is not idle. */
2659 /* Maybe autosave and/or garbage collect due to idleness. */
2661 if (INTERACTIVE
&& NILP (c
))
2664 EMACS_INT buffer_size
;
2666 /* Slow down auto saves logarithmically in size of current buffer,
2667 and garbage collect while we're at it. */
2668 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2669 last_non_minibuf_size
= Z
- BEG
;
2670 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2672 while (buffer_size
> 64)
2673 delay_level
++, buffer_size
-= buffer_size
>> 2;
2674 if (delay_level
< 4) delay_level
= 4;
2675 /* delay_level is 4 for files under around 50k, 7 at 100k,
2676 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2678 /* Auto save if enough time goes by without input. */
2679 if (commandflag
!= 0
2680 && num_nonmacro_input_events
> last_auto_save
2681 && INTEGERP (Vauto_save_timeout
)
2682 && XINT (Vauto_save_timeout
) > 0)
2685 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2687 save_getcjmp (save_jump
);
2688 restore_getcjmp (local_getcjmp
);
2689 tem0
= sit_for (make_number (timeout
), 1, 1);
2690 restore_getcjmp (save_jump
);
2693 && ! CONSP (Vunread_command_events
))
2695 Fdo_auto_save (Qnil
, Qnil
);
2697 /* If we have auto-saved and there is still no input
2698 available, garbage collect if there has been enough
2699 consing going on to make it worthwhile. */
2700 if (!detect_input_pending_run_timers (0)
2701 && consing_since_gc
> gc_cons_threshold
/ 2)
2702 Fgarbage_collect ();
2709 /* Notify the caller if an autosave hook, or a timer, sentinel or
2710 filter in the sit_for calls above have changed the current
2711 kboard. This could happen if they use the minibuffer or start a
2712 recursive edit, like the fancy splash screen in server.el's
2713 filter. If this longjmp wasn't here, read_key_sequence would
2714 interpret the next key sequence using the wrong translation
2715 tables and function keymaps. */
2716 if (NILP (c
) && current_kboard
!= orig_kboard
)
2719 return make_number (-2); /* wrong_kboard_jmpbuf */
2722 /* If this has become non-nil here, it has been set by a timer
2723 or sentinel or filter. */
2724 if (CONSP (Vunread_command_events
))
2726 c
= XCAR (Vunread_command_events
);
2727 Vunread_command_events
= XCDR (Vunread_command_events
);
2730 /* Read something from current KBOARD's side queue, if possible. */
2734 if (current_kboard
->kbd_queue_has_data
)
2736 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2738 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2739 KVAR (current_kboard
, kbd_queue
)
2740 = XCDR (KVAR (current_kboard
, kbd_queue
));
2741 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2742 current_kboard
->kbd_queue_has_data
= 0;
2743 input_pending
= readable_events (0);
2744 if (EVENT_HAS_PARAMETERS (c
)
2745 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2746 internal_last_event_frame
= XCAR (XCDR (c
));
2747 Vlast_event_frame
= internal_last_event_frame
;
2751 /* If current_kboard's side queue is empty check the other kboards.
2752 If one of them has data that we have not yet seen here,
2753 switch to it and process the data waiting for it.
2755 Note: if the events queued up for another kboard
2756 have already been seen here, and therefore are not a complete command,
2757 the kbd_queue_has_data field is 0, so we skip that kboard here.
2758 That's to avoid an infinite loop switching between kboards here. */
2759 if (NILP (c
) && !single_kboard
)
2762 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2763 if (kb
->kbd_queue_has_data
)
2765 current_kboard
= kb
;
2766 /* This is going to exit from read_char
2767 so we had better get rid of this frame's stuff. */
2769 return make_number (-2); /* wrong_kboard_jmpbuf */
2777 /* Finally, we read from the main queue,
2778 and if that gives us something we can't use yet, we put it on the
2779 appropriate side queue and try again. */
2783 KBOARD
*kb
IF_LINT (= NULL
);
2788 EMACS_GET_TIME (now
);
2789 if (EMACS_TIME_GE (now
, *end_time
))
2793 /* Actually read a character, waiting if necessary. */
2794 save_getcjmp (save_jump
);
2795 restore_getcjmp (local_getcjmp
);
2797 timer_start_idle ();
2798 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2799 restore_getcjmp (save_jump
);
2801 if (! NILP (c
) && (kb
!= current_kboard
))
2803 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2806 while (CONSP (XCDR (last
)))
2808 if (!NILP (XCDR (last
)))
2812 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2814 XSETCDR (last
, Fcons (c
, Qnil
));
2815 kb
->kbd_queue_has_data
= 1;
2819 current_kboard
= kb
;
2820 /* This is going to exit from read_char
2821 so we had better get rid of this frame's stuff. */
2823 return make_number (-2);
2827 /* Terminate Emacs in batch mode if at eof. */
2828 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2829 Fkill_emacs (make_number (1));
2833 /* Add in any extra modifiers, where appropriate. */
2834 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2835 || ((extra_keyboard_modifiers
& 0177) < ' '
2836 && (extra_keyboard_modifiers
& 0177) != 0))
2837 XSETINT (c
, make_ctrl_char (XINT (c
)));
2839 /* Transfer any other modifier bits directly from
2840 extra_keyboard_modifiers to c. Ignore the actual character code
2841 in the low 16 bits of extra_keyboard_modifiers. */
2842 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2853 if (commandflag
>= 0
2854 && !input_pending
&& !detect_input_pending_run_timers (0))
2862 /* Buffer switch events are only for internal wakeups
2863 so don't show them to the user.
2864 Also, don't record a key if we already did. */
2865 if (BUFFERP (c
) || key_already_recorded
)
2868 /* Process special events within read_char
2869 and loop around to read another event. */
2872 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2877 struct buffer
*prev_buffer
= current_buffer
;
2878 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2879 int was_locked
= single_kboard
;
2880 int count
= SPECPDL_INDEX ();
2881 record_single_kboard_state ();
2884 last_input_event
= c
;
2885 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2887 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2888 /* We stopped being idle for this event; undo that. This
2889 prevents automatic window selection (under
2890 mouse_autoselect_window from acting as a real input event, for
2891 example banishing the mouse under mouse-avoidance-mode. */
2892 timer_resume_idle ();
2894 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2895 /* Resume allowing input from any kboard, if that was true before. */
2897 any_kboard_state ();
2898 unbind_to (count
, Qnil
);
2901 if (current_buffer
!= prev_buffer
)
2903 /* The command may have changed the keymaps. Pretend there
2904 is input in another keyboard and return. This will
2905 recalculate keymaps. */
2906 c
= make_number (-2);
2913 /* Handle things that only apply to characters. */
2916 /* If kbd_buffer_get_event gave us an EOF, return that. */
2920 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2921 && UNSIGNED_CMP (XFASTINT (c
), <,
2922 SCHARS (KVAR (current_kboard
,
2923 Vkeyboard_translate_table
))))
2924 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2925 && UNSIGNED_CMP (XFASTINT (c
), <,
2926 ASIZE (KVAR (current_kboard
,
2927 Vkeyboard_translate_table
))))
2928 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2932 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2933 /* nil in keyboard-translate-table means no translation. */
2939 /* If this event is a mouse click in the menu bar,
2940 return just menu-bar for now. Modify the mouse click event
2941 so we won't do this twice, then queue it up. */
2942 if (EVENT_HAS_PARAMETERS (c
)
2944 && CONSP (EVENT_START (c
))
2945 && CONSP (XCDR (EVENT_START (c
))))
2949 posn
= POSN_POSN (EVENT_START (c
));
2950 /* Handle menu-bar events:
2951 insert the dummy prefix event `menu-bar'. */
2952 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2954 /* Change menu-bar to (menu-bar) as the event "position". */
2955 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2958 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2963 /* Store these characters into recent_keys, the dribble file if any,
2964 and the keyboard macro being defined, if any. */
2966 if (! NILP (also_record
))
2967 record_char (also_record
);
2969 /* Wipe the echo area.
2970 But first, if we are about to use an input method,
2971 save the echo area contents for it to refer to. */
2973 && ! NILP (Vinput_method_function
)
2974 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2976 previous_echo_area_message
= Fcurrent_message ();
2977 Vinput_method_previous_message
= previous_echo_area_message
;
2980 /* Now wipe the echo area, except for help events which do their
2981 own stuff with the echo area. */
2983 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2984 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2986 if (!NILP (echo_area_buffer
[0]))
2987 safe_run_hooks (Qecho_area_clear_hook
);
2988 clear_message (1, 0);
2991 reread_for_input_method
:
2993 /* Pass this to the input method, if appropriate. */
2995 && ! NILP (Vinput_method_function
)
2996 /* Don't run the input method within a key sequence,
2997 after the first event of the key sequence. */
2998 && NILP (prev_event
)
2999 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3002 int key_count
, key_count_reset
;
3003 struct gcpro inner_gcpro1
;
3004 int count
= SPECPDL_INDEX ();
3006 /* Save the echo status. */
3007 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3008 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3009 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3010 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3013 if (before_command_restore_flag
)
3015 this_command_key_count
= before_command_key_count_1
;
3016 if (this_command_key_count
< this_single_command_key_start
)
3017 this_single_command_key_start
= this_command_key_count
;
3018 echo_truncate (before_command_echo_length_1
);
3019 before_command_restore_flag
= 0;
3023 /* Save the this_command_keys status. */
3024 key_count
= this_command_key_count
;
3025 key_count_reset
= this_command_key_count_reset
;
3028 keys
= Fcopy_sequence (this_command_keys
);
3031 GCPRO1_VAR (keys
, inner_gcpro
);
3033 /* Clear out this_command_keys. */
3034 this_command_key_count
= 0;
3035 this_command_key_count_reset
= 0;
3037 /* Now wipe the echo area. */
3038 if (!NILP (echo_area_buffer
[0]))
3039 safe_run_hooks (Qecho_area_clear_hook
);
3040 clear_message (1, 0);
3043 /* If we are not reading a key sequence,
3044 never use the echo area. */
3047 specbind (Qinput_method_use_echo_area
, Qt
);
3050 /* Call the input method. */
3051 tem
= call1 (Vinput_method_function
, c
);
3053 tem
= unbind_to (count
, tem
);
3055 /* Restore the saved echoing state
3056 and this_command_keys state. */
3057 this_command_key_count
= key_count
;
3058 this_command_key_count_reset
= key_count_reset
;
3060 this_command_keys
= keys
;
3063 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3064 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3065 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3066 if (saved_immediate_echo
)
3069 UNGCPRO_VAR (inner_gcpro
);
3071 /* The input method can return no events. */
3074 /* Bring back the previous message, if any. */
3075 if (! NILP (previous_echo_area_message
))
3076 message_with_string ("%s", previous_echo_area_message
, 0);
3079 /* It returned one event or more. */
3081 Vunread_post_input_method_events
3082 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3087 /* Display help if not echoing. */
3088 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3090 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3091 Lisp_Object help
, object
, position
, window
, htem
;
3093 htem
= Fcdr (XCDR (c
));
3096 window
= Fcar (htem
);
3098 object
= Fcar (htem
);
3100 position
= Fcar (htem
);
3102 show_help_echo (help
, window
, object
, position
);
3104 /* We stopped being idle for this event; undo that. */
3106 timer_resume_idle ();
3110 if ((! reread
|| this_command_key_count
== 0
3111 || this_command_key_count_reset
)
3115 /* Don't echo mouse motion events. */
3116 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3117 && NILP (Fzerop (Vecho_keystrokes
))
3118 && ! (EVENT_HAS_PARAMETERS (c
)
3119 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3122 if (! NILP (also_record
))
3123 echo_char (also_record
);
3124 /* Once we reread a character, echoing can happen
3125 the next time we pause to read a new one. */
3126 ok_to_echo_at_next_pause
= current_kboard
;
3129 /* Record this character as part of the current key. */
3130 add_command_key (c
);
3131 if (! NILP (also_record
))
3132 add_command_key (also_record
);
3135 last_input_event
= c
;
3138 /* Process the help character specially if enabled */
3139 if (!NILP (Vhelp_form
) && help_char_p (c
))
3141 int count
= SPECPDL_INDEX ();
3143 help_form_saved_window_configs
3144 = Fcons (Fcurrent_window_configuration (Qnil
),
3145 help_form_saved_window_configs
);
3146 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3147 call0 (Qhelp_form_show
);
3152 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3153 if (EVENT_HAS_PARAMETERS (c
)
3154 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3155 XSETCAR (help_form_saved_window_configs
, Qnil
);
3157 while (BUFFERP (c
));
3158 /* Remove the help from the frame */
3159 unbind_to (count
, Qnil
);
3162 if (EQ (c
, make_number (040)))
3166 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3167 while (BUFFERP (c
));
3176 /* Record a key that came from a mouse menu.
3177 Record it for echoing, for this-command-keys, and so on. */
3180 record_menu_key (Lisp_Object c
)
3182 /* Wipe the echo area. */
3183 clear_message (1, 0);
3188 before_command_key_count
= this_command_key_count
;
3189 before_command_echo_length
= echo_length ();
3192 /* Don't echo mouse motion events. */
3193 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3194 && NILP (Fzerop (Vecho_keystrokes
)))
3198 /* Once we reread a character, echoing can happen
3199 the next time we pause to read a new one. */
3200 ok_to_echo_at_next_pause
= 0;
3203 /* Record this character as part of the current key. */
3204 add_command_key (c
);
3206 /* Re-reading in the middle of a command */
3207 last_input_event
= c
;
3211 /* Return 1 if should recognize C as "the help character". */
3214 help_char_p (Lisp_Object c
)
3218 if (EQ (c
, Vhelp_char
))
3220 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3221 if (EQ (c
, XCAR (tail
)))
3226 /* Record the input event C in various ways. */
3229 record_char (Lisp_Object c
)
3233 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3235 /* To avoid filling recent_keys with help-echo and mouse-movement
3236 events, we filter out repeated help-echo events, only store the
3237 first and last in a series of mouse-movement events, and don't
3238 store repeated help-echo events which are only separated by
3239 mouse-movement events. */
3241 Lisp_Object ev1
, ev2
, ev3
;
3244 if ((ix1
= recent_keys_index
- 1) < 0)
3245 ix1
= NUM_RECENT_KEYS
- 1;
3246 ev1
= AREF (recent_keys
, ix1
);
3248 if ((ix2
= ix1
- 1) < 0)
3249 ix2
= NUM_RECENT_KEYS
- 1;
3250 ev2
= AREF (recent_keys
, ix2
);
3252 if ((ix3
= ix2
- 1) < 0)
3253 ix3
= NUM_RECENT_KEYS
- 1;
3254 ev3
= AREF (recent_keys
, ix3
);
3256 if (EQ (XCAR (c
), Qhelp_echo
))
3258 /* Don't record `help-echo' in recent_keys unless it shows some help
3259 message, and a different help than the previously recorded
3261 Lisp_Object help
, last_help
;
3263 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3264 if (!STRINGP (help
))
3266 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3267 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3269 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3270 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3271 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3273 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3274 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3275 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3276 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3279 else if (EQ (XCAR (c
), Qmouse_movement
))
3281 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3282 So additional mouse movement events replace the last element. */
3283 Lisp_Object last_window
, window
;
3285 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3286 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3287 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3288 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3289 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3291 ASET (recent_keys
, ix1
, c
);
3297 store_kbd_macro_char (c
);
3302 ASET (recent_keys
, recent_keys_index
, c
);
3303 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3304 recent_keys_index
= 0;
3306 else if (recorded
< 0)
3308 /* We need to remove one or two events from recent_keys.
3309 To do this, we simply put nil at those events and move the
3310 recent_keys_index backwards over those events. Usually,
3311 users will never see those nil events, as they will be
3312 overwritten by the command keys entered to see recent_keys
3315 while (recorded
++ < 0 && total_keys
> 0)
3317 if (total_keys
< NUM_RECENT_KEYS
)
3319 if (--recent_keys_index
< 0)
3320 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3321 ASET (recent_keys
, recent_keys_index
, Qnil
);
3325 num_nonmacro_input_events
++;
3327 /* Write c to the dribble file. If c is a lispy event, write
3328 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3329 If you, dear reader, have a better idea, you've got the source. :-) */
3335 if (XUINT (c
) < 0x100)
3336 putc (XUINT (c
), dribble
);
3338 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3342 Lisp_Object dribblee
;
3344 /* If it's a structured event, take the event header. */
3345 dribblee
= EVENT_HEAD (c
);
3347 if (SYMBOLP (dribblee
))
3349 putc ('<', dribble
);
3350 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3351 SBYTES (SYMBOL_NAME (dribblee
)),
3353 putc ('>', dribble
);
3362 /* Copy out or in the info on where C-g should throw to.
3363 This is used when running Lisp code from within get_char,
3364 in case get_char is called recursively.
3365 See read_process_output. */
3368 save_getcjmp (jmp_buf temp
)
3370 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3374 restore_getcjmp (jmp_buf temp
)
3376 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3379 /* Low level keyboard/mouse input.
3380 kbd_buffer_store_event places events in kbd_buffer, and
3381 kbd_buffer_get_event retrieves them. */
3383 /* Return true if there are any events in the queue that read-char
3384 would return. If this returns false, a read-char would block. */
3386 readable_events (int flags
)
3388 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3391 /* If the buffer contains only FOCUS_IN_EVENT events, and
3392 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3393 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3395 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3396 #ifdef USE_TOOLKIT_SCROLL_BARS
3397 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3401 struct input_event
*event
;
3403 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3410 #ifdef USE_TOOLKIT_SCROLL_BARS
3411 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3413 event
->kind
== FOCUS_IN_EVENT
)
3414 #ifdef USE_TOOLKIT_SCROLL_BARS
3415 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3416 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3417 && event
->part
== scroll_bar_handle
3418 && event
->modifiers
== 0)
3423 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3426 while (event
!= kbd_store_ptr
);
3432 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3433 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3434 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3439 if (current_kboard
->kbd_queue_has_data
)
3445 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3446 if (kb
->kbd_queue_has_data
)
3452 /* Set this for debugging, to have a way to get out */
3453 int stop_character EXTERNALLY_VISIBLE
;
3456 event_to_kboard (struct input_event
*event
)
3459 frame
= event
->frame_or_window
;
3461 frame
= XCAR (frame
);
3462 else if (WINDOWP (frame
))
3463 frame
= WINDOW_FRAME (XWINDOW (frame
));
3465 /* There are still some events that don't set this field.
3466 For now, just ignore the problem.
3467 Also ignore dead frames here. */
3468 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3471 return FRAME_KBOARD (XFRAME (frame
));
3475 /* Return the number of slots occupied in kbd_buffer. */
3478 kbd_buffer_nr_stored (void)
3480 return kbd_fetch_ptr
== kbd_store_ptr
3482 : (kbd_fetch_ptr
< kbd_store_ptr
3483 ? kbd_store_ptr
- kbd_fetch_ptr
3484 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3485 + (kbd_store_ptr
- kbd_buffer
)));
3487 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3490 kbd_buffer_store_event (register struct input_event
*event
)
3492 kbd_buffer_store_event_hold (event
, 0);
3495 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3497 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3498 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3499 Else, if EVENT is a quit event, store the quit event
3500 in HOLD_QUIT, and return (thus ignoring further events).
3502 This is used in read_avail_input to postpone the processing
3503 of the quit event until all subsequent input events have been
3504 parsed (and discarded).
3508 kbd_buffer_store_event_hold (register struct input_event
*event
,
3509 struct input_event
*hold_quit
)
3511 if (event
->kind
== NO_EVENT
)
3514 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3517 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3519 register int c
= event
->code
& 0377;
3521 if (event
->modifiers
& ctrl_modifier
)
3522 c
= make_ctrl_char (c
);
3524 c
|= (event
->modifiers
3525 & (meta_modifier
| alt_modifier
3526 | hyper_modifier
| super_modifier
));
3530 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3531 struct input_event
*sp
;
3533 if (single_kboard
&& kb
!= current_kboard
)
3535 KVAR (kb
, kbd_queue
)
3536 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3537 Fcons (make_number (c
), Qnil
));
3538 kb
->kbd_queue_has_data
= 1;
3539 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3541 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3544 if (event_to_kboard (sp
) == kb
)
3546 sp
->kind
= NO_EVENT
;
3547 sp
->frame_or_window
= Qnil
;
3556 memcpy (hold_quit
, event
, sizeof (*event
));
3560 /* If this results in a quit_char being returned to Emacs as
3561 input, set Vlast_event_frame properly. If this doesn't
3562 get returned to Emacs as an event, the next event read
3563 will set Vlast_event_frame again, so this is safe to do. */
3567 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3569 focus
= event
->frame_or_window
;
3570 internal_last_event_frame
= focus
;
3571 Vlast_event_frame
= focus
;
3574 last_event_timestamp
= event
->timestamp
;
3575 handle_interrupt ();
3579 if (c
&& c
== stop_character
)
3585 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3586 Just ignore the second one. */
3587 else if (event
->kind
== BUFFER_SWITCH_EVENT
3588 && kbd_fetch_ptr
!= kbd_store_ptr
3589 && ((kbd_store_ptr
== kbd_buffer
3590 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3591 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3594 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3595 kbd_store_ptr
= kbd_buffer
;
3597 /* Don't let the very last slot in the buffer become full,
3598 since that would make the two pointers equal,
3599 and that is indistinguishable from an empty buffer.
3600 Discard the event if it would fill the last slot. */
3601 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3603 *kbd_store_ptr
= *event
;
3606 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3608 /* Don't read keyboard input until we have processed kbd_buffer.
3609 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3610 hold_keyboard_input ();
3612 if (!noninteractive
)
3613 signal (SIGIO
, SIG_IGN
);
3617 #endif /* subprocesses */
3620 /* If we're inside while-no-input, and this event qualifies
3621 as input, set quit-flag to cause an interrupt. */
3622 if (!NILP (Vthrow_on_input
)
3623 && event
->kind
!= FOCUS_IN_EVENT
3624 && event
->kind
!= HELP_EVENT
3625 && event
->kind
!= DEICONIFY_EVENT
)
3627 Vquit_flag
= Vthrow_on_input
;
3628 /* If we're inside a function that wants immediate quits,
3630 if (immediate_quit
&& NILP (Vinhibit_quit
))
3640 /* Put an input event back in the head of the event queue. */
3643 kbd_buffer_unget_event (register struct input_event
*event
)
3645 if (kbd_fetch_ptr
== kbd_buffer
)
3646 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3648 /* Don't let the very last slot in the buffer become full, */
3649 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3652 *kbd_fetch_ptr
= *event
;
3657 /* Generate a HELP_EVENT input_event and store it in the keyboard
3660 HELP is the help form.
3662 FRAME and WINDOW are the frame and window where the help is
3663 generated. OBJECT is the Lisp object where the help was found (a
3664 buffer, a string, an overlay, or nil if neither from a string nor
3665 from a buffer). POS is the position within OBJECT where the help
3669 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3670 Lisp_Object object
, EMACS_INT pos
)
3672 struct input_event event
;
3676 event
.kind
= HELP_EVENT
;
3677 event
.frame_or_window
= frame
;
3679 event
.x
= WINDOWP (window
) ? window
: frame
;
3682 kbd_buffer_store_event (&event
);
3686 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3689 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3691 struct input_event event
;
3693 event
.kind
= HELP_EVENT
;
3694 event
.frame_or_window
= frame
;
3699 kbd_buffer_store_event (&event
);
3703 /* Discard any mouse events in the event buffer by setting them to
3706 discard_mouse_events (void)
3708 struct input_event
*sp
;
3709 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3711 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3714 if (sp
->kind
== MOUSE_CLICK_EVENT
3715 || sp
->kind
== WHEEL_EVENT
3716 || sp
->kind
== HORIZ_WHEEL_EVENT
3718 || sp
->kind
== GPM_CLICK_EVENT
3720 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3722 sp
->kind
= NO_EVENT
;
3728 /* Return non-zero if there are any real events waiting in the event
3729 buffer, not counting `NO_EVENT's.
3731 If DISCARD is non-zero, discard NO_EVENT events at the front of
3732 the input queue, possibly leaving the input queue empty if there
3733 are no real input events. */
3736 kbd_buffer_events_waiting (int discard
)
3738 struct input_event
*sp
;
3740 for (sp
= kbd_fetch_ptr
;
3741 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3744 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3751 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3755 /* Clear input event EVENT. */
3758 clear_event (struct input_event
*event
)
3760 event
->kind
= NO_EVENT
;
3764 /* Read one event from the event buffer, waiting if necessary.
3765 The value is a Lisp object representing the event.
3766 The value is nil for an event that should be ignored,
3767 or that was handled here.
3768 We always read and discard one event. */
3771 kbd_buffer_get_event (KBOARD
**kbp
,
3772 int *used_mouse_menu
,
3773 struct timeval
*end_time
)
3779 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3781 /* Start reading input again, we have processed enough so we can
3782 accept new events again. */
3783 unhold_keyboard_input ();
3785 if (!noninteractive
)
3786 signal (SIGIO
, input_available_signal
);
3790 #endif /* subprocesses */
3793 /* In case we are running as a daemon, only do this before
3794 detaching from the terminal. */
3795 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3799 *kbp
= current_kboard
;
3803 /* Wait until there is input available. */
3806 /* Break loop if there's an unread command event. Needed in
3807 moused window autoselection which uses a timer to insert such
3809 if (CONSP (Vunread_command_events
))
3812 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3814 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3815 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3819 /* If the quit flag is set, then read_char will return
3820 quit_char, so that counts as "available input." */
3821 if (!NILP (Vquit_flag
))
3822 quit_throw_to_read_char ();
3824 /* One way or another, wait until input is available; then, if
3825 interrupt handlers have not read it, read it now. */
3827 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3831 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3833 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3834 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3839 EMACS_TIME duration
;
3840 EMACS_GET_TIME (duration
);
3841 if (EMACS_TIME_GE (duration
, *end_time
))
3842 return Qnil
; /* finished waiting */
3845 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3846 wait_reading_process_output (EMACS_SECS (duration
),
3847 EMACS_USECS (duration
),
3848 -1, 1, Qnil
, NULL
, 0);
3852 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3854 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3855 /* Pass 1 for EXPECT since we just waited to have input. */
3856 read_avail_input (1);
3859 if (CONSP (Vunread_command_events
))
3862 first
= XCAR (Vunread_command_events
);
3863 Vunread_command_events
= XCDR (Vunread_command_events
);
3864 *kbp
= current_kboard
;
3868 /* At this point, we know that there is a readable event available
3869 somewhere. If the event queue is empty, then there must be a
3870 mouse movement enabled and available. */
3871 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3873 struct input_event
*event
;
3875 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3879 last_event_timestamp
= event
->timestamp
;
3881 *kbp
= event_to_kboard (event
);
3883 *kbp
= current_kboard
; /* Better than returning null ptr? */
3887 /* These two kinds of events get special handling
3888 and don't actually appear to the command loop.
3889 We return nil for them. */
3890 if (event
->kind
== SELECTION_REQUEST_EVENT
3891 || event
->kind
== SELECTION_CLEAR_EVENT
)
3894 struct input_event copy
;
3896 /* Remove it from the buffer before processing it,
3897 since otherwise swallow_events will see it
3898 and process it again. */
3900 kbd_fetch_ptr
= event
+ 1;
3901 input_pending
= readable_events (0);
3902 x_handle_selection_event (©
);
3904 /* We're getting selection request events, but we don't have
3910 #if defined (HAVE_NS)
3911 else if (event
->kind
== NS_TEXT_EVENT
)
3913 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3914 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3916 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3917 kbd_fetch_ptr
= event
+ 1;
3918 if (used_mouse_menu
)
3919 *used_mouse_menu
= 1;
3923 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3924 || defined (HAVE_NS)
3925 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3927 /* Make an event (delete-frame (FRAME)). */
3928 obj
= Fcons (event
->frame_or_window
, Qnil
);
3929 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3930 kbd_fetch_ptr
= event
+ 1;
3933 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3934 || defined (HAVE_NS)
3935 else if (event
->kind
== ICONIFY_EVENT
)
3937 /* Make an event (iconify-frame (FRAME)). */
3938 obj
= Fcons (event
->frame_or_window
, Qnil
);
3939 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3940 kbd_fetch_ptr
= event
+ 1;
3942 else if (event
->kind
== DEICONIFY_EVENT
)
3944 /* Make an event (make-frame-visible (FRAME)). */
3945 obj
= Fcons (event
->frame_or_window
, Qnil
);
3946 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3947 kbd_fetch_ptr
= event
+ 1;
3950 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3952 /* The value doesn't matter here; only the type is tested. */
3953 XSETBUFFER (obj
, current_buffer
);
3954 kbd_fetch_ptr
= event
+ 1;
3956 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3957 || defined(HAVE_NS) || defined (USE_GTK)
3958 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3960 kbd_fetch_ptr
= event
+ 1;
3961 input_pending
= readable_events (0);
3962 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3963 x_activate_menubar (XFRAME (event
->frame_or_window
));
3966 #if defined (WINDOWSNT)
3967 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3969 /* Make an event (language-change (FRAME CHARSET LCID)). */
3970 obj
= Fcons (event
->frame_or_window
, Qnil
);
3971 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3972 kbd_fetch_ptr
= event
+ 1;
3975 else if (event
->kind
== SAVE_SESSION_EVENT
)
3977 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3978 kbd_fetch_ptr
= event
+ 1;
3980 /* Just discard these, by returning nil.
3981 With MULTI_KBOARD, these events are used as placeholders
3982 when we need to randomly delete events from the queue.
3983 (They shouldn't otherwise be found in the buffer,
3984 but on some machines it appears they do show up
3985 even without MULTI_KBOARD.) */
3986 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3987 mouse events during a popup-menu call. */
3988 else if (event
->kind
== NO_EVENT
)
3989 kbd_fetch_ptr
= event
+ 1;
3990 else if (event
->kind
== HELP_EVENT
)
3992 Lisp_Object object
, position
, help
, frame
, window
;
3994 frame
= event
->frame_or_window
;
3995 object
= event
->arg
;
3996 position
= make_number (event
->code
);
3999 clear_event (event
);
4001 kbd_fetch_ptr
= event
+ 1;
4002 if (!WINDOWP (window
))
4004 obj
= Fcons (Qhelp_echo
,
4005 list5 (frame
, help
, window
, object
, position
));
4007 else if (event
->kind
== FOCUS_IN_EVENT
)
4009 /* Notification of a FocusIn event. The frame receiving the
4010 focus is in event->frame_or_window. Generate a
4011 switch-frame event if necessary. */
4012 Lisp_Object frame
, focus
;
4014 frame
= event
->frame_or_window
;
4015 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4019 if (!EQ (frame
, internal_last_event_frame
)
4020 && !EQ (frame
, selected_frame
))
4021 obj
= make_lispy_switch_frame (frame
);
4022 internal_last_event_frame
= frame
;
4023 kbd_fetch_ptr
= event
+ 1;
4026 else if (event
->kind
== DBUS_EVENT
)
4028 obj
= make_lispy_event (event
);
4029 kbd_fetch_ptr
= event
+ 1;
4032 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4034 obj
= make_lispy_event (event
);
4035 kbd_fetch_ptr
= event
+ 1;
4039 /* If this event is on a different frame, return a switch-frame this
4040 time, and leave the event in the queue for next time. */
4044 frame
= event
->frame_or_window
;
4046 frame
= XCAR (frame
);
4047 else if (WINDOWP (frame
))
4048 frame
= WINDOW_FRAME (XWINDOW (frame
));
4050 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4054 if (! EQ (frame
, internal_last_event_frame
)
4055 && !EQ (frame
, selected_frame
))
4056 obj
= make_lispy_switch_frame (frame
);
4057 internal_last_event_frame
= frame
;
4059 /* If we didn't decide to make a switch-frame event, go ahead
4060 and build a real event from the queue entry. */
4064 obj
= make_lispy_event (event
);
4066 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4067 || defined(HAVE_NS) || defined (USE_GTK)
4068 /* If this was a menu selection, then set the flag to inhibit
4069 writing to last_nonmenu_event. Don't do this if the event
4070 we're returning is (menu-bar), though; that indicates the
4071 beginning of the menu sequence, and we might as well leave
4072 that as the `event with parameters' for this selection. */
4074 && !EQ (event
->frame_or_window
, event
->arg
)
4075 && (event
->kind
== MENU_BAR_EVENT
4076 || event
->kind
== TOOL_BAR_EVENT
))
4077 *used_mouse_menu
= 1;
4080 /* certain system events are non-key events */
4082 && event
->kind
== NS_NONKEY_EVENT
)
4083 *used_mouse_menu
= 1;
4086 /* Wipe out this event, to catch bugs. */
4087 clear_event (event
);
4088 kbd_fetch_ptr
= event
+ 1;
4092 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4093 /* Try generating a mouse motion event. */
4094 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4096 FRAME_PTR f
= some_mouse_moved ();
4097 Lisp_Object bar_window
;
4098 enum scroll_bar_part part
;
4102 *kbp
= current_kboard
;
4103 /* Note that this uses F to determine which terminal to look at.
4104 If there is no valid info, it does not store anything
4105 so x remains nil. */
4108 /* XXX Can f or mouse_position_hook be NULL here? */
4109 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4110 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4115 /* Decide if we should generate a switch-frame event. Don't
4116 generate switch-frame events for motion outside of all Emacs
4122 frame
= FRAME_FOCUS_FRAME (f
);
4124 XSETFRAME (frame
, f
);
4126 if (! EQ (frame
, internal_last_event_frame
)
4127 && !EQ (frame
, selected_frame
))
4128 obj
= make_lispy_switch_frame (frame
);
4129 internal_last_event_frame
= frame
;
4132 /* If we didn't decide to make a switch-frame event, go ahead and
4133 return a mouse-motion event. */
4134 if (!NILP (x
) && NILP (obj
))
4135 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4137 #endif /* HAVE_MOUSE || HAVE GPM */
4139 /* We were promised by the above while loop that there was
4140 something for us to read! */
4143 input_pending
= readable_events (0);
4145 Vlast_event_frame
= internal_last_event_frame
;
4150 /* Process any events that are not user-visible,
4151 then return, without reading any user-visible events. */
4154 swallow_events (int do_display
)
4158 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4160 struct input_event
*event
;
4162 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4166 last_event_timestamp
= event
->timestamp
;
4168 /* These two kinds of events get special handling
4169 and don't actually appear to the command loop. */
4170 if (event
->kind
== SELECTION_REQUEST_EVENT
4171 || event
->kind
== SELECTION_CLEAR_EVENT
)
4174 struct input_event copy
;
4176 /* Remove it from the buffer before processing it,
4177 since otherwise swallow_events called recursively could see it
4178 and process it again. */
4180 kbd_fetch_ptr
= event
+ 1;
4181 input_pending
= readable_events (0);
4182 x_handle_selection_event (©
);
4184 /* We're getting selection request events, but we don't have
4193 old_timers_run
= timers_run
;
4194 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4196 if (timers_run
!= old_timers_run
&& do_display
)
4197 redisplay_preserve_echo_area (7);
4200 /* Record the start of when Emacs is idle,
4201 for the sake of running idle-time timers. */
4204 timer_start_idle (void)
4208 /* If we are already in the idle state, do nothing. */
4209 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4212 EMACS_GET_TIME (timer_idleness_start_time
);
4214 timer_last_idleness_start_time
= timer_idleness_start_time
;
4216 /* Mark all idle-time timers as once again candidates for running. */
4217 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4221 timer
= XCAR (timers
);
4223 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4225 XVECTOR (timer
)->contents
[0] = Qnil
;
4229 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4232 timer_stop_idle (void)
4234 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4237 /* Resume idle timer from last idle start time. */
4240 timer_resume_idle (void)
4242 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4245 timer_idleness_start_time
= timer_last_idleness_start_time
;
4248 /* This is only for debugging. */
4249 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4251 /* List of elisp functions to call, delayed because they were generated in
4252 a context where Elisp could not be safely run (e.g. redisplay, signal,
4253 ...). Each element has the form (FUN . ARGS). */
4254 Lisp_Object pending_funcalls
;
4256 /* Check whether a timer has fired. To prevent larger problems we simply
4257 disregard elements that are not proper timers. Do not make a circular
4258 timer list for the time being.
4260 Returns the time to wait until the next timer fires. If a
4261 timer is triggering now, return zero.
4262 If no timer is active, return -1.
4264 If a timer is ripe, we run it, with quitting turned off.
4265 In that case we return 0 to indicate that a new timer_check_2 call
4269 timer_check_2 (void)
4271 EMACS_TIME nexttime
;
4273 EMACS_TIME idleness_now
IF_LINT (= {0});
4274 Lisp_Object timers
, idle_timers
, chosen_timer
;
4275 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4277 EMACS_SET_SECS (nexttime
, -1);
4278 EMACS_SET_USECS (nexttime
, -1);
4280 /* Always consider the ordinary timers. */
4281 timers
= Vtimer_list
;
4282 /* Consider the idle timers only if Emacs is idle. */
4283 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4284 idle_timers
= Vtimer_idle_list
;
4287 chosen_timer
= Qnil
;
4288 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4290 /* First run the code that was delayed. */
4291 while (CONSP (pending_funcalls
))
4293 Lisp_Object funcall
= XCAR (pending_funcalls
);
4294 pending_funcalls
= XCDR (pending_funcalls
);
4295 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4298 if (CONSP (timers
) || CONSP (idle_timers
))
4300 EMACS_GET_TIME (now
);
4301 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4302 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4305 while (CONSP (timers
) || CONSP (idle_timers
))
4307 Lisp_Object
*vector
;
4308 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4309 EMACS_TIME timer_time
, idle_timer_time
;
4310 EMACS_TIME difference
;
4311 EMACS_TIME timer_difference
IF_LINT (= {0});
4312 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4314 /* Skip past invalid timers and timers already handled. */
4317 timer
= XCAR (timers
);
4318 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4320 timers
= XCDR (timers
);
4323 vector
= XVECTOR (timer
)->contents
;
4325 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4326 || !INTEGERP (vector
[3])
4327 || ! NILP (vector
[0]))
4329 timers
= XCDR (timers
);
4333 if (CONSP (idle_timers
))
4335 timer
= XCAR (idle_timers
);
4336 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4338 idle_timers
= XCDR (idle_timers
);
4341 vector
= XVECTOR (timer
)->contents
;
4343 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4344 || !INTEGERP (vector
[3])
4345 || ! NILP (vector
[0]))
4347 idle_timers
= XCDR (idle_timers
);
4352 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4353 based on the next ordinary timer.
4354 TIMER_DIFFERENCE is the distance in time from NOW to when
4355 this timer becomes ripe (negative if it's already ripe). */
4358 timer
= XCAR (timers
);
4359 vector
= XVECTOR (timer
)->contents
;
4360 EMACS_SET_SECS (timer_time
,
4361 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4362 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4363 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4366 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4367 based on the next idle timer. */
4368 if (CONSP (idle_timers
))
4370 idle_timer
= XCAR (idle_timers
);
4371 vector
= XVECTOR (idle_timer
)->contents
;
4372 EMACS_SET_SECS (idle_timer_time
,
4373 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4374 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4375 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4378 /* Decide which timer is the next timer,
4379 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4380 Also step down the list where we found that timer. */
4382 if (CONSP (timers
) && CONSP (idle_timers
))
4385 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4386 if (EMACS_TIME_NEG_P (temp
))
4388 chosen_timer
= timer
;
4389 timers
= XCDR (timers
);
4390 difference
= timer_difference
;
4394 chosen_timer
= idle_timer
;
4395 idle_timers
= XCDR (idle_timers
);
4396 difference
= idle_timer_difference
;
4399 else if (CONSP (timers
))
4401 chosen_timer
= timer
;
4402 timers
= XCDR (timers
);
4403 difference
= timer_difference
;
4407 chosen_timer
= idle_timer
;
4408 idle_timers
= XCDR (idle_timers
);
4409 difference
= idle_timer_difference
;
4411 vector
= XVECTOR (chosen_timer
)->contents
;
4413 /* If timer is ripe, run it if it hasn't been run. */
4414 if (EMACS_TIME_NEG_P (difference
)
4415 || (EMACS_SECS (difference
) == 0
4416 && EMACS_USECS (difference
) == 0))
4418 if (NILP (vector
[0]))
4420 int count
= SPECPDL_INDEX ();
4421 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4423 /* Mark the timer as triggered to prevent problems if the lisp
4424 code fails to reschedule it right. */
4427 specbind (Qinhibit_quit
, Qt
);
4429 call1 (Qtimer_event_handler
, chosen_timer
);
4430 Vdeactivate_mark
= old_deactivate_mark
;
4432 unbind_to (count
, Qnil
);
4434 /* Since we have handled the event,
4435 we don't need to tell the caller to wake up and do it. */
4436 /* But the caller must still wait for the next timer, so
4437 return 0 to indicate that. */
4440 EMACS_SET_SECS (nexttime
, 0);
4441 EMACS_SET_USECS (nexttime
, 0);
4444 /* When we encounter a timer that is still waiting,
4445 return the amount of time to wait before it is ripe. */
4452 /* No timers are pending in the future. */
4453 /* Return 0 if we generated an event, and -1 if not. */
4459 /* Check whether a timer has fired. To prevent larger problems we simply
4460 disregard elements that are not proper timers. Do not make a circular
4461 timer list for the time being.
4463 Returns the time to wait until the next timer fires.
4464 If no timer is active, return -1.
4466 As long as any timer is ripe, we run it. */
4471 EMACS_TIME nexttime
;
4475 nexttime
= timer_check_2 ();
4477 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4482 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4483 doc
: /* Return the current length of Emacs idleness, or nil.
4484 The value when Emacs is idle is a list of three integers. The first has
4485 the most significant 16 bits of the seconds, while the second has the least
4486 significant 16 bits. The third integer gives the microsecond count.
4488 The value when Emacs is not idle is nil.
4490 The microsecond count is zero on systems that do not provide
4491 resolution finer than a second. */)
4494 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4496 EMACS_TIME now
, idleness_now
;
4498 EMACS_GET_TIME (now
);
4499 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4501 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4502 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4503 make_number (EMACS_USECS (idleness_now
)));
4509 /* Caches for modify_event_symbol. */
4510 static Lisp_Object accent_key_syms
;
4511 static Lisp_Object func_key_syms
;
4512 static Lisp_Object mouse_syms
;
4513 static Lisp_Object wheel_syms
;
4514 static Lisp_Object drag_n_drop_syms
;
4516 /* This is a list of keysym codes for special "accent" characters.
4517 It parallels lispy_accent_keys. */
4519 static const int lispy_accent_codes
[] =
4521 #ifdef XK_dead_circumflex
4526 #ifdef XK_dead_grave
4531 #ifdef XK_dead_tilde
4536 #ifdef XK_dead_diaeresis
4541 #ifdef XK_dead_macron
4546 #ifdef XK_dead_degree
4551 #ifdef XK_dead_acute
4556 #ifdef XK_dead_cedilla
4561 #ifdef XK_dead_breve
4566 #ifdef XK_dead_ogonek
4571 #ifdef XK_dead_caron
4576 #ifdef XK_dead_doubleacute
4577 XK_dead_doubleacute
,
4581 #ifdef XK_dead_abovedot
4586 #ifdef XK_dead_abovering
4596 #ifdef XK_dead_belowdot
4601 #ifdef XK_dead_voiced_sound
4602 XK_dead_voiced_sound
,
4606 #ifdef XK_dead_semivoiced_sound
4607 XK_dead_semivoiced_sound
,
4623 /* This is a list of Lisp names for special "accent" characters.
4624 It parallels lispy_accent_codes. */
4626 static const char *const lispy_accent_keys
[] =
4644 "dead-voiced-sound",
4645 "dead-semivoiced-sound",
4651 #define FUNCTION_KEY_OFFSET 0x0
4653 const char *const lispy_function_keys
[] =
4657 0, /* VK_LBUTTON 0x01 */
4658 0, /* VK_RBUTTON 0x02 */
4659 "cancel", /* VK_CANCEL 0x03 */
4660 0, /* VK_MBUTTON 0x04 */
4662 0, 0, 0, /* 0x05 .. 0x07 */
4664 "backspace", /* VK_BACK 0x08 */
4665 "tab", /* VK_TAB 0x09 */
4667 0, 0, /* 0x0A .. 0x0B */
4669 "clear", /* VK_CLEAR 0x0C */
4670 "return", /* VK_RETURN 0x0D */
4672 0, 0, /* 0x0E .. 0x0F */
4674 0, /* VK_SHIFT 0x10 */
4675 0, /* VK_CONTROL 0x11 */
4676 0, /* VK_MENU 0x12 */
4677 "pause", /* VK_PAUSE 0x13 */
4678 "capslock", /* VK_CAPITAL 0x14 */
4679 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4681 "junja", /* VK_JUNJA 0x17 */
4682 "final", /* VK_FINAL 0x18 */
4683 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4685 "escape", /* VK_ESCAPE 0x1B */
4686 "convert", /* VK_CONVERT 0x1C */
4687 "non-convert", /* VK_NONCONVERT 0x1D */
4688 "accept", /* VK_ACCEPT 0x1E */
4689 "mode-change", /* VK_MODECHANGE 0x1F */
4690 0, /* VK_SPACE 0x20 */
4691 "prior", /* VK_PRIOR 0x21 */
4692 "next", /* VK_NEXT 0x22 */
4693 "end", /* VK_END 0x23 */
4694 "home", /* VK_HOME 0x24 */
4695 "left", /* VK_LEFT 0x25 */
4696 "up", /* VK_UP 0x26 */
4697 "right", /* VK_RIGHT 0x27 */
4698 "down", /* VK_DOWN 0x28 */
4699 "select", /* VK_SELECT 0x29 */
4700 "print", /* VK_PRINT 0x2A */
4701 "execute", /* VK_EXECUTE 0x2B */
4702 "snapshot", /* VK_SNAPSHOT 0x2C */
4703 "insert", /* VK_INSERT 0x2D */
4704 "delete", /* VK_DELETE 0x2E */
4705 "help", /* VK_HELP 0x2F */
4707 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4709 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4711 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4713 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4715 0, 0, 0, 0, 0, 0, 0, 0, 0,
4716 0, 0, 0, 0, 0, 0, 0, 0, 0,
4717 0, 0, 0, 0, 0, 0, 0, 0,
4719 "lwindow", /* VK_LWIN 0x5B */
4720 "rwindow", /* VK_RWIN 0x5C */
4721 "apps", /* VK_APPS 0x5D */
4724 "kp-0", /* VK_NUMPAD0 0x60 */
4725 "kp-1", /* VK_NUMPAD1 0x61 */
4726 "kp-2", /* VK_NUMPAD2 0x62 */
4727 "kp-3", /* VK_NUMPAD3 0x63 */
4728 "kp-4", /* VK_NUMPAD4 0x64 */
4729 "kp-5", /* VK_NUMPAD5 0x65 */
4730 "kp-6", /* VK_NUMPAD6 0x66 */
4731 "kp-7", /* VK_NUMPAD7 0x67 */
4732 "kp-8", /* VK_NUMPAD8 0x68 */
4733 "kp-9", /* VK_NUMPAD9 0x69 */
4734 "kp-multiply", /* VK_MULTIPLY 0x6A */
4735 "kp-add", /* VK_ADD 0x6B */
4736 "kp-separator", /* VK_SEPARATOR 0x6C */
4737 "kp-subtract", /* VK_SUBTRACT 0x6D */
4738 "kp-decimal", /* VK_DECIMAL 0x6E */
4739 "kp-divide", /* VK_DIVIDE 0x6F */
4740 "f1", /* VK_F1 0x70 */
4741 "f2", /* VK_F2 0x71 */
4742 "f3", /* VK_F3 0x72 */
4743 "f4", /* VK_F4 0x73 */
4744 "f5", /* VK_F5 0x74 */
4745 "f6", /* VK_F6 0x75 */
4746 "f7", /* VK_F7 0x76 */
4747 "f8", /* VK_F8 0x77 */
4748 "f9", /* VK_F9 0x78 */
4749 "f10", /* VK_F10 0x79 */
4750 "f11", /* VK_F11 0x7A */
4751 "f12", /* VK_F12 0x7B */
4752 "f13", /* VK_F13 0x7C */
4753 "f14", /* VK_F14 0x7D */
4754 "f15", /* VK_F15 0x7E */
4755 "f16", /* VK_F16 0x7F */
4756 "f17", /* VK_F17 0x80 */
4757 "f18", /* VK_F18 0x81 */
4758 "f19", /* VK_F19 0x82 */
4759 "f20", /* VK_F20 0x83 */
4760 "f21", /* VK_F21 0x84 */
4761 "f22", /* VK_F22 0x85 */
4762 "f23", /* VK_F23 0x86 */
4763 "f24", /* VK_F24 0x87 */
4765 0, 0, 0, 0, /* 0x88 .. 0x8B */
4766 0, 0, 0, 0, /* 0x8C .. 0x8F */
4768 "kp-numlock", /* VK_NUMLOCK 0x90 */
4769 "scroll", /* VK_SCROLL 0x91 */
4770 /* Not sure where the following block comes from.
4771 Windows headers have NEC and Fujitsu specific keys in
4772 this block, but nothing generic. */
4773 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4774 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4775 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4776 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4777 "kp-end", /* VK_NUMPAD_END 0x96 */
4778 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4779 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4780 "kp-up", /* VK_NUMPAD_UP 0x99 */
4781 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4782 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4783 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4784 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4786 0, 0, /* 0x9E .. 0x9F */
4789 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4790 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4791 * No other API or message will distinguish left and right keys this way.
4796 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4797 to enable them selectively, and gives access to a few more functions.
4798 See lispy_multimedia_keys below. */
4799 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4800 0, 0, 0, /* 0xAD .. 0xAF Volume */
4801 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4802 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4804 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4805 0, 0, 0, 0, 0, 0, 0, 0, 0,
4807 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4808 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4809 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4812 "ax", /* VK_OEM_AX 0xE1 */
4813 0, /* VK_OEM_102 0xE2 */
4814 "ico-help", /* VK_ICO_HELP 0xE3 */
4815 "ico-00", /* VK_ICO_00 0xE4 */
4816 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4817 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4818 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4820 "reset", /* VK_OEM_RESET 0xE9 */
4821 "jump", /* VK_OEM_JUMP 0xEA */
4822 "oem-pa1", /* VK_OEM_PA1 0xEB */
4823 "oem-pa2", /* VK_OEM_PA2 0xEC */
4824 "oem-pa3", /* VK_OEM_PA3 0xED */
4825 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4826 "cusel", /* VK_OEM_CUSEL 0xEF */
4827 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4828 "finish", /* VK_OEM_FINISH 0xF1 */
4829 "copy", /* VK_OEM_COPY 0xF2 */
4830 "auto", /* VK_OEM_AUTO 0xF3 */
4831 "enlw", /* VK_OEM_ENLW 0xF4 */
4832 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4833 "attn", /* VK_ATTN 0xF6 */
4834 "crsel", /* VK_CRSEL 0xF7 */
4835 "exsel", /* VK_EXSEL 0xF8 */
4836 "ereof", /* VK_EREOF 0xF9 */
4837 "play", /* VK_PLAY 0xFA */
4838 "zoom", /* VK_ZOOM 0xFB */
4839 "noname", /* VK_NONAME 0xFC */
4840 "pa1", /* VK_PA1 0xFD */
4841 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4845 /* Some of these duplicate the "Media keys" on newer keyboards,
4846 but they are delivered to the application in a different way. */
4847 static const char *const lispy_multimedia_keys
[] =
4855 "browser-favorites",
4892 "toggle-dictate-command",
4898 "media-fast-forward",
4901 "media-channel-down"
4904 #else /* not HAVE_NTGUI */
4906 /* This should be dealt with in XTread_socket now, and that doesn't
4907 depend on the client system having the Kana syms defined. See also
4908 the XK_kana_A case below. */
4911 static const char *const lispy_kana_keys
[] =
4913 /* X Keysym value */
4914 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4915 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4916 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4917 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4918 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4919 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4920 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4921 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4922 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4923 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4924 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4925 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4926 "kana-i", "kana-u", "kana-e", "kana-o",
4927 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4928 "prolongedsound", "kana-A", "kana-I", "kana-U",
4929 "kana-E", "kana-O", "kana-KA", "kana-KI",
4930 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4931 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4932 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4933 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4934 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4935 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4936 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4937 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4938 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4939 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4940 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4941 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4943 #endif /* XK_kana_A */
4946 #define FUNCTION_KEY_OFFSET 0xff00
4948 /* You'll notice that this table is arranged to be conveniently
4949 indexed by X Windows keysym values. */
4950 static const char *const lispy_function_keys
[] =
4952 /* X Keysym value */
4954 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4955 "backspace", "tab", "linefeed", "clear",
4957 0, 0, 0, "pause", /* 0xff10...1f */
4958 0, 0, 0, 0, 0, 0, 0, "escape",
4960 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4961 "romaji", "hiragana", "katakana", "hiragana-katakana",
4962 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4963 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4964 "eisu-toggle", /* 0xff30...3f */
4965 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4966 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4968 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4969 "down", "prior", "next", "end",
4970 "begin", 0, 0, 0, 0, 0, 0, 0,
4971 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4982 "break", /* 0xff6b */
4985 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4986 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4987 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4988 0, 0, 0, 0, 0, 0, 0, 0,
4989 "kp-tab", /* 0xff89 */
4991 "kp-enter", /* 0xff8d */
4993 "kp-f1", /* 0xff91 */
4997 "kp-home", /* 0xff95 */
5002 "kp-prior", /* kp-page-up */
5003 "kp-next", /* kp-page-down */
5009 0, 0, 0, 0, 0, 0, 0, 0, 0,
5010 "kp-multiply", /* 0xffaa */
5015 "kp-divide", /* 0xffaf */
5016 "kp-0", /* 0xffb0 */
5017 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5020 "kp-equal", /* 0xffbd */
5021 "f1", /* 0xffbe */ /* IsFunctionKey */
5023 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5024 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5025 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5026 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5027 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5028 0, 0, 0, 0, 0, 0, 0, 0,
5029 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5030 0, 0, 0, 0, 0, 0, 0, "delete"
5033 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5034 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5036 static const char *const iso_lispy_function_keys
[] =
5038 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5039 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5040 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5041 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5042 "iso-lefttab", /* 0xfe20 */
5043 "iso-move-line-up", "iso-move-line-down",
5044 "iso-partial-line-up", "iso-partial-line-down",
5045 "iso-partial-space-left", "iso-partial-space-right",
5046 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5047 "iso-release-margin-left", "iso-release-margin-right",
5048 "iso-release-both-margins",
5049 "iso-fast-cursor-left", "iso-fast-cursor-right",
5050 "iso-fast-cursor-up", "iso-fast-cursor-down",
5051 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5052 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5055 #endif /* not HAVE_NTGUI */
5057 static Lisp_Object Vlispy_mouse_stem
;
5059 static const char *const lispy_wheel_names
[] =
5061 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5064 /* drag-n-drop events are generated when a set of selected files are
5065 dragged from another application and dropped onto an Emacs window. */
5066 static const char *const lispy_drag_n_drop_names
[] =
5071 /* Scroll bar parts. */
5072 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5073 Lisp_Object Qup
, Qdown
, Qbottom
;
5074 static Lisp_Object Qend_scroll
;
5076 static Lisp_Object Qratio
;
5078 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5079 static Lisp_Object
*const scroll_bar_parts
[] = {
5080 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5081 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5084 /* A vector, indexed by button number, giving the down-going location
5085 of currently depressed buttons, both scroll bar and non-scroll bar.
5087 The elements have the form
5088 (BUTTON-NUMBER MODIFIER-MASK . REST)
5089 where REST is the cdr of a position as it would be reported in the event.
5091 The make_lispy_event function stores positions here to tell the
5092 difference between click and drag events, and to store the starting
5093 location to be included in drag events. */
5095 static Lisp_Object button_down_location
;
5097 /* Information about the most recent up-going button event: Which
5098 button, what location, and what time. */
5100 static int last_mouse_button
;
5101 static int last_mouse_x
;
5102 static int last_mouse_y
;
5103 static Time button_down_time
;
5105 /* The number of clicks in this multiple-click. */
5107 static int double_click_count
;
5109 /* X and Y are frame-relative coordinates for a click or wheel event.
5110 Return a Lisp-style event list. */
5113 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5116 enum window_part part
;
5117 Lisp_Object posn
= Qnil
;
5118 Lisp_Object extra_info
= Qnil
;
5119 /* Coordinate pixel positions to return. */
5120 int xret
= 0, yret
= 0;
5121 /* The window under frame pixel coordinates (x,y) */
5122 Lisp_Object window
= f
5123 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5126 if (WINDOWP (window
))
5128 /* It's a click in window window at frame coordinates (x,y) */
5129 struct window
*w
= XWINDOW (window
);
5130 Lisp_Object string_info
= Qnil
;
5131 EMACS_INT textpos
= -1;
5132 int col
= -1, row
= -1;
5133 int dx
= -1, dy
= -1;
5134 int width
= -1, height
= -1;
5135 Lisp_Object object
= Qnil
;
5137 /* Pixel coordinates relative to the window corner. */
5138 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5139 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5141 /* For text area clicks, return X, Y relative to the corner of
5142 this text area. Note that dX, dY etc are set below, by
5143 buffer_posn_from_coords. */
5144 if (part
== ON_TEXT
)
5146 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5147 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5149 /* For mode line and header line clicks, return X, Y relative to
5150 the left window edge. Use mode_line_string to look for a
5151 string on the click position. */
5152 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5157 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5158 /* Note that mode_line_string takes COL, ROW as pixels and
5159 converts them to characters. */
5162 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5163 &object
, &dx
, &dy
, &width
, &height
);
5164 if (STRINGP (string
))
5165 string_info
= Fcons (string
, make_number (charpos
));
5166 textpos
= (w
== XWINDOW (selected_window
)
5167 && current_buffer
== XBUFFER (w
->buffer
))
5168 ? PT
: XMARKER (w
->pointm
)->charpos
;
5173 /* For fringes and margins, Y is relative to the area's (and the
5174 window's) top edge, while X is meaningless. */
5175 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5180 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5183 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5184 &object
, &dx
, &dy
, &width
, &height
);
5185 if (STRINGP (string
))
5186 string_info
= Fcons (string
, make_number (charpos
));
5187 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5189 else if (part
== ON_LEFT_FRINGE
)
5191 posn
= Qleft_fringe
;
5194 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5195 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5196 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5198 else if (part
== ON_RIGHT_FRINGE
)
5200 posn
= Qright_fringe
;
5203 - window_box_width (w
, LEFT_MARGIN_AREA
)
5204 - window_box_width (w
, TEXT_AREA
)
5205 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5206 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5208 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5210 else if (part
== ON_VERTICAL_BORDER
)
5212 posn
= Qvertical_line
;
5217 /* Nothing special for part == ON_SCROLL_BAR. */
5219 /* For clicks in the text area, fringes, or margins, call
5220 buffer_posn_from_coords to extract TEXTPOS, the buffer
5221 position nearest to the click. */
5224 Lisp_Object string2
, object2
= Qnil
;
5225 struct display_pos p
;
5227 int width2
, height2
;
5228 /* The pixel X coordinate passed to buffer_posn_from_coords
5229 is the X coordinate relative to the text area for
5230 text-area and right-margin clicks, zero otherwise. */
5232 = (part
== ON_TEXT
) ? xret
5233 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5234 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5238 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5239 &object2
, &dx2
, &dy2
,
5241 textpos
= CHARPOS (p
.pos
);
5242 if (col
< 0) col
= x2
;
5243 if (row
< 0) row
= y2
;
5244 if (dx
< 0) dx
= dx2
;
5245 if (dy
< 0) dy
= dy2
;
5246 if (width
< 0) width
= width2
;
5247 if (height
< 0) height
= height2
;
5251 posn
= make_number (textpos
);
5252 if (STRINGP (string2
))
5253 string_info
= Fcons (string2
,
5254 make_number (CHARPOS (p
.string_pos
)));
5260 #ifdef HAVE_WINDOW_SYSTEM
5261 if (IMAGEP (object
))
5263 Lisp_Object image_map
, hotspot
;
5264 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5266 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5268 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5269 posn
= XCAR (hotspot
);
5276 Fcons (make_number (dx
), make_number (dy
)),
5277 Fcons (make_number (width
), make_number (height
)));
5280 extra_info
= Fcons (string_info
,
5281 Fcons (make_number (textpos
),
5282 Fcons (Fcons (make_number (col
),
5287 XSETFRAME (window
, f
);
5291 return Fcons (window
,
5293 Fcons (Fcons (make_number (xret
),
5294 make_number (yret
)),
5295 Fcons (make_number (t
),
5299 /* Given a struct input_event, build the lisp event which represents
5300 it. If EVENT is 0, build a mouse movement event from the mouse
5301 movement buffer, which should have a movement event in it.
5303 Note that events must be passed to this function in the order they
5304 are received; this function stores the location of button presses
5305 in order to build drag events when the button is released. */
5308 make_lispy_event (struct input_event
*event
)
5312 switch (SWITCH_ENUM_CAST (event
->kind
))
5314 /* A simple keystroke. */
5315 case ASCII_KEYSTROKE_EVENT
:
5316 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5318 Lisp_Object lispy_c
;
5319 EMACS_INT c
= event
->code
;
5320 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5323 eassert (c
== event
->code
);
5324 /* Turn ASCII characters into control characters
5326 if (event
->modifiers
& ctrl_modifier
)
5328 c
= make_ctrl_char (c
);
5329 event
->modifiers
&= ~ctrl_modifier
;
5333 /* Add in the other modifier bits. The shift key was taken care
5334 of by the X code. */
5335 c
|= (event
->modifiers
5336 & (meta_modifier
| alt_modifier
5337 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5338 /* Distinguish Shift-SPC from SPC. */
5339 if ((event
->code
) == 040
5340 && event
->modifiers
& shift_modifier
)
5341 c
|= shift_modifier
;
5342 button_down_time
= 0;
5343 XSETFASTINT (lispy_c
, c
);
5348 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5349 except that they are non-key events (last-nonmenu-event is nil). */
5350 case NS_NONKEY_EVENT
:
5353 /* A function key. The symbol may need to have modifier prefixes
5355 case NON_ASCII_KEYSTROKE_EVENT
:
5356 button_down_time
= 0;
5358 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5359 if (event
->code
== lispy_accent_codes
[i
])
5360 return modify_event_symbol (i
,
5362 Qfunction_key
, Qnil
,
5363 lispy_accent_keys
, &accent_key_syms
,
5364 (sizeof (lispy_accent_keys
)
5365 / sizeof (lispy_accent_keys
[0])));
5369 if (event
->code
>= 0x400 && event
->code
< 0x500)
5370 return modify_event_symbol (event
->code
- 0x400,
5371 event
->modifiers
& ~shift_modifier
,
5372 Qfunction_key
, Qnil
,
5373 lispy_kana_keys
, &func_key_syms
,
5374 (sizeof (lispy_kana_keys
)
5375 / sizeof (lispy_kana_keys
[0])));
5376 #endif /* XK_kana_A */
5379 #ifdef ISO_FUNCTION_KEY_OFFSET
5380 if (event
->code
< FUNCTION_KEY_OFFSET
5381 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5382 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5384 Qfunction_key
, Qnil
,
5385 iso_lispy_function_keys
, &func_key_syms
,
5386 (sizeof (iso_lispy_function_keys
)
5387 / sizeof (iso_lispy_function_keys
[0])));
5390 /* Handle system-specific or unknown keysyms. */
5391 if (event
->code
& (1 << 28)
5392 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5393 || (event
->code
- FUNCTION_KEY_OFFSET
5394 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5395 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5397 /* We need to use an alist rather than a vector as the cache
5398 since we can't make a vector long enuf. */
5399 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5400 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5401 return modify_event_symbol (event
->code
,
5404 KVAR (current_kboard
, Vsystem_key_alist
),
5405 0, &KVAR (current_kboard
, system_key_syms
),
5406 TYPE_MAXIMUM (EMACS_INT
));
5409 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5411 Qfunction_key
, Qnil
,
5412 lispy_function_keys
, &func_key_syms
,
5413 (sizeof (lispy_function_keys
)
5414 / sizeof (lispy_function_keys
[0])));
5417 case MULTIMEDIA_KEY_EVENT
:
5418 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5419 / sizeof (lispy_multimedia_keys
[0]))
5420 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5422 return modify_event_symbol (event
->code
, event
->modifiers
,
5423 Qfunction_key
, Qnil
,
5424 lispy_multimedia_keys
, &func_key_syms
,
5425 (sizeof (lispy_multimedia_keys
)
5426 / sizeof (lispy_multimedia_keys
[0])));
5432 /* A mouse click. Figure out where it is, decide whether it's
5433 a press, click or drag, and build the appropriate structure. */
5434 case MOUSE_CLICK_EVENT
:
5435 #ifndef USE_TOOLKIT_SCROLL_BARS
5436 case SCROLL_BAR_CLICK_EVENT
:
5439 int button
= event
->code
;
5441 Lisp_Object position
;
5442 Lisp_Object
*start_pos_ptr
;
5443 Lisp_Object start_pos
;
5447 /* Build the position as appropriate for this mouse click. */
5448 if (event
->kind
== MOUSE_CLICK_EVENT
)
5450 struct frame
*f
= XFRAME (event
->frame_or_window
);
5451 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5455 /* Ignore mouse events that were made on frame that
5456 have been deleted. */
5457 if (! FRAME_LIVE_P (f
))
5460 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5461 /* EVENT->x and EVENT->y are frame-relative pixel
5462 coordinates at this place. Under old redisplay, COLUMN
5463 and ROW are set to frame relative glyph coordinates
5464 which are then used to determine whether this click is
5465 in a menu (non-toolkit version). */
5466 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5467 &column
, &row
, NULL
, 1);
5469 /* In the non-toolkit version, clicks on the menu bar
5470 are ordinary button events in the event buffer.
5471 Distinguish them, and invoke the menu.
5473 (In the toolkit version, the toolkit handles the menu bar
5474 and Emacs doesn't know about it until after the user
5475 makes a selection.) */
5476 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5477 && (event
->modifiers
& down_modifier
))
5479 Lisp_Object items
, item
;
5481 /* Find the menu bar item under `column'. */
5483 items
= FRAME_MENU_BAR_ITEMS (f
);
5484 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5486 Lisp_Object pos
, string
;
5487 string
= AREF (items
, i
+ 1);
5488 pos
= AREF (items
, i
+ 3);
5491 if (column
>= XINT (pos
)
5492 && column
< XINT (pos
) + SCHARS (string
))
5494 item
= AREF (items
, i
);
5499 /* ELisp manual 2.4b says (x y) are window relative but
5500 code says they are frame-relative. */
5502 = Fcons (event
->frame_or_window
,
5504 Fcons (Fcons (event
->x
, event
->y
),
5505 Fcons (make_number (event
->timestamp
),
5508 return Fcons (item
, Fcons (position
, Qnil
));
5510 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5512 position
= make_lispy_position (f
, event
->x
, event
->y
,
5515 #ifndef USE_TOOLKIT_SCROLL_BARS
5518 /* It's a scrollbar click. */
5520 Lisp_Object portion_whole
;
5523 window
= event
->frame_or_window
;
5524 portion_whole
= Fcons (event
->x
, event
->y
);
5525 part
= *scroll_bar_parts
[(int) event
->part
];
5529 Fcons (Qvertical_scroll_bar
,
5530 Fcons (portion_whole
,
5531 Fcons (make_number (event
->timestamp
),
5532 Fcons (part
, Qnil
)))));
5534 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5536 if (button
>= ASIZE (button_down_location
))
5538 button_down_location
= larger_vector (button_down_location
,
5540 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5543 start_pos_ptr
= &AREF (button_down_location
, button
);
5544 start_pos
= *start_pos_ptr
;
5545 *start_pos_ptr
= Qnil
;
5548 /* On window-system frames, use the value of
5549 double-click-fuzz as is. On other frames, interpret it
5550 as a multiple of 1/8 characters. */
5554 if (WINDOWP (event
->frame_or_window
))
5555 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5556 else if (FRAMEP (event
->frame_or_window
))
5557 f
= XFRAME (event
->frame_or_window
);
5561 if (FRAME_WINDOW_P (f
))
5562 fuzz
= double_click_fuzz
;
5564 fuzz
= double_click_fuzz
/ 8;
5566 is_double
= (button
== last_mouse_button
5567 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5568 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5569 && button_down_time
!= 0
5570 && (EQ (Vdouble_click_time
, Qt
)
5571 || (NATNUMP (Vdouble_click_time
)
5572 && (event
->timestamp
- button_down_time
5573 < XFASTINT (Vdouble_click_time
)))));
5576 last_mouse_button
= button
;
5577 last_mouse_x
= XINT (event
->x
);
5578 last_mouse_y
= XINT (event
->y
);
5580 /* If this is a button press, squirrel away the location, so
5581 we can decide later whether it was a click or a drag. */
5582 if (event
->modifiers
& down_modifier
)
5586 double_click_count
++;
5587 event
->modifiers
|= ((double_click_count
> 2)
5592 double_click_count
= 1;
5593 button_down_time
= event
->timestamp
;
5594 *start_pos_ptr
= Fcopy_alist (position
);
5595 ignore_mouse_drag_p
= 0;
5598 /* Now we're releasing a button - check the co-ordinates to
5599 see if this was a click or a drag. */
5600 else if (event
->modifiers
& up_modifier
)
5602 /* If we did not see a down before this up, ignore the up.
5603 Probably this happened because the down event chose a
5604 menu item. It would be an annoyance to treat the
5605 release of the button that chose the menu item as a
5608 if (!CONSP (start_pos
))
5611 event
->modifiers
&= ~up_modifier
;
5614 Lisp_Object new_down
, down
;
5615 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5617 /* The third element of every position
5618 should be the (x,y) pair. */
5619 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5620 new_down
= Fcar (Fcdr (Fcdr (position
)));
5623 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5625 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5626 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5629 if (ignore_mouse_drag_p
)
5631 event
->modifiers
|= click_modifier
;
5632 ignore_mouse_drag_p
= 0;
5634 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5635 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5636 /* Maybe the mouse has moved a lot, caused scrolling, and
5637 eventually ended up at the same screen position (but
5638 not buffer position) in which case it is a drag, not
5640 /* FIXME: OTOH if the buffer position has changed
5641 because of a timer or process filter rather than
5642 because of mouse movement, it should be considered as
5643 a click. But mouse-drag-region completely ignores
5644 this case and it hasn't caused any real problem, so
5645 it's probably OK to ignore it as well. */
5646 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5647 /* Mouse hasn't moved (much). */
5648 event
->modifiers
|= click_modifier
;
5651 button_down_time
= 0;
5652 event
->modifiers
|= drag_modifier
;
5655 /* Don't check is_double; treat this as multiple
5656 if the down-event was multiple. */
5657 if (double_click_count
> 1)
5658 event
->modifiers
|= ((double_click_count
> 2)
5664 /* Every mouse event should either have the down_modifier or
5665 the up_modifier set. */
5669 /* Get the symbol we should use for the mouse click. */
5672 head
= modify_event_symbol (button
,
5674 Qmouse_click
, Vlispy_mouse_stem
,
5677 ASIZE (mouse_syms
));
5678 if (event
->modifiers
& drag_modifier
)
5683 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5686 Fcons (make_number (double_click_count
),
5696 case HORIZ_WHEEL_EVENT
:
5698 Lisp_Object position
;
5701 /* Build the position as appropriate for this mouse click. */
5702 struct frame
*f
= XFRAME (event
->frame_or_window
);
5704 /* Ignore wheel events that were made on frame that have been
5706 if (! FRAME_LIVE_P (f
))
5709 position
= make_lispy_position (f
, event
->x
, event
->y
,
5712 /* Set double or triple modifiers to indicate the wheel speed. */
5714 /* On window-system frames, use the value of
5715 double-click-fuzz as is. On other frames, interpret it
5716 as a multiple of 1/8 characters. */
5722 if (WINDOWP (event
->frame_or_window
))
5723 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5724 else if (FRAMEP (event
->frame_or_window
))
5725 fr
= XFRAME (event
->frame_or_window
);
5729 fuzz
= FRAME_WINDOW_P (fr
)
5730 ? double_click_fuzz
: double_click_fuzz
/ 8;
5732 if (event
->modifiers
& up_modifier
)
5734 /* Emit a wheel-up event. */
5735 event
->modifiers
&= ~up_modifier
;
5738 else if (event
->modifiers
& down_modifier
)
5740 /* Emit a wheel-down event. */
5741 event
->modifiers
&= ~down_modifier
;
5745 /* Every wheel event should either have the down_modifier or
5746 the up_modifier set. */
5749 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5752 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5753 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5754 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5755 && button_down_time
!= 0
5756 && (EQ (Vdouble_click_time
, Qt
)
5757 || (NATNUMP (Vdouble_click_time
)
5758 && (event
->timestamp
- button_down_time
5759 < XFASTINT (Vdouble_click_time
)))));
5762 double_click_count
++;
5763 event
->modifiers
|= ((double_click_count
> 2)
5769 double_click_count
= 1;
5770 event
->modifiers
|= click_modifier
;
5773 button_down_time
= event
->timestamp
;
5774 /* Use a negative value to distinguish wheel from mouse button. */
5775 last_mouse_button
= - (1 + symbol_num
);
5776 last_mouse_x
= XINT (event
->x
);
5777 last_mouse_y
= XINT (event
->y
);
5779 /* Get the symbol we should use for the wheel event. */
5780 head
= modify_event_symbol (symbol_num
,
5786 ASIZE (wheel_syms
));
5789 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5792 Fcons (make_number (double_click_count
),
5801 #ifdef USE_TOOLKIT_SCROLL_BARS
5803 /* We don't have down and up events if using toolkit scroll bars,
5804 so make this always a click event. Store in the `part' of
5805 the Lisp event a symbol which maps to the following actions:
5807 `above_handle' page up
5808 `below_handle' page down
5812 `bottom' bottom of buffer
5813 `handle' thumb has been dragged.
5814 `end-scroll' end of interaction with scroll bar
5816 The incoming input_event contains in its `part' member an
5817 index of type `enum scroll_bar_part' which we can use as an
5818 index in scroll_bar_parts to get the appropriate symbol. */
5820 case SCROLL_BAR_CLICK_EVENT
:
5822 Lisp_Object position
, head
, window
, portion_whole
, part
;
5824 window
= event
->frame_or_window
;
5825 portion_whole
= Fcons (event
->x
, event
->y
);
5826 part
= *scroll_bar_parts
[(int) event
->part
];
5830 Fcons (Qvertical_scroll_bar
,
5831 Fcons (portion_whole
,
5832 Fcons (make_number (event
->timestamp
),
5833 Fcons (part
, Qnil
)))));
5835 /* Always treat scroll bar events as clicks. */
5836 event
->modifiers
|= click_modifier
;
5837 event
->modifiers
&= ~up_modifier
;
5839 if (event
->code
>= ASIZE (mouse_syms
))
5840 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5842 /* Get the symbol we should use for the mouse click. */
5843 head
= modify_event_symbol (event
->code
,
5848 ASIZE (mouse_syms
));
5849 return Fcons (head
, Fcons (position
, Qnil
));
5852 #endif /* USE_TOOLKIT_SCROLL_BARS */
5854 case DRAG_N_DROP_EVENT
:
5857 Lisp_Object head
, position
;
5860 f
= XFRAME (event
->frame_or_window
);
5863 /* Ignore mouse events that were made on frames that
5864 have been deleted. */
5865 if (! FRAME_LIVE_P (f
))
5868 position
= make_lispy_position (f
, event
->x
, event
->y
,
5871 head
= modify_event_symbol (0, event
->modifiers
,
5873 lispy_drag_n_drop_names
,
5874 &drag_n_drop_syms
, 1);
5880 #endif /* HAVE_MOUSE */
5882 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5883 || defined(HAVE_NS) || defined (USE_GTK)
5884 case MENU_BAR_EVENT
:
5885 if (EQ (event
->arg
, event
->frame_or_window
))
5886 /* This is the prefix key. We translate this to
5887 `(menu_bar)' because the code in keyboard.c for menu
5888 events, which we use, relies on this. */
5889 return Fcons (Qmenu_bar
, Qnil
);
5893 case SELECT_WINDOW_EVENT
:
5894 /* Make an event (select-window (WINDOW)). */
5895 return Fcons (Qselect_window
,
5896 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5899 case TOOL_BAR_EVENT
:
5900 if (EQ (event
->arg
, event
->frame_or_window
))
5901 /* This is the prefix key. We translate this to
5902 `(tool_bar)' because the code in keyboard.c for tool bar
5903 events, which we use, relies on this. */
5904 return Fcons (Qtool_bar
, Qnil
);
5905 else if (SYMBOLP (event
->arg
))
5906 return apply_modifiers (event
->modifiers
, event
->arg
);
5909 case USER_SIGNAL_EVENT
:
5910 /* A user signal. */
5912 char *name
= find_user_signal_name (event
->code
);
5915 return intern (name
);
5918 case SAVE_SESSION_EVENT
:
5919 return Qsave_session
;
5924 return Fcons (Qdbus_event
, event
->arg
);
5926 #endif /* HAVE_DBUS */
5928 case CONFIG_CHANGED_EVENT
:
5929 return Fcons (Qconfig_changed_event
,
5931 Fcons (event
->frame_or_window
, Qnil
)));
5933 case GPM_CLICK_EVENT
:
5935 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5936 Lisp_Object head
, position
;
5937 Lisp_Object
*start_pos_ptr
;
5938 Lisp_Object start_pos
;
5939 int button
= event
->code
;
5941 if (button
>= ASIZE (button_down_location
))
5943 button_down_location
= larger_vector (button_down_location
,
5945 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5948 start_pos_ptr
= &AREF (button_down_location
, button
);
5949 start_pos
= *start_pos_ptr
;
5951 position
= make_lispy_position (f
, event
->x
, event
->y
,
5954 if (event
->modifiers
& down_modifier
)
5955 *start_pos_ptr
= Fcopy_alist (position
);
5956 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5958 if (!CONSP (start_pos
))
5960 event
->modifiers
&= ~up_modifier
;
5963 head
= modify_event_symbol (button
,
5965 Qmouse_click
, Vlispy_mouse_stem
,
5968 ASIZE (mouse_syms
));
5970 if (event
->modifiers
& drag_modifier
)
5975 else if (event
->modifiers
& double_modifier
)
5978 Fcons (make_number (2),
5980 else if (event
->modifiers
& triple_modifier
)
5983 Fcons (make_number (3),
5990 #endif /* HAVE_GPM */
5992 /* The 'kind' field of the event is something we don't recognize. */
5998 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6001 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6002 Lisp_Object x
, Lisp_Object y
, Time t
)
6004 /* Is it a scroll bar movement? */
6005 if (frame
&& ! NILP (bar_window
))
6007 Lisp_Object part_sym
;
6009 part_sym
= *scroll_bar_parts
[(int) part
];
6010 return Fcons (Qscroll_bar_movement
,
6011 Fcons (list5 (bar_window
,
6012 Qvertical_scroll_bar
,
6018 /* Or is it an ordinary mouse movement? */
6021 Lisp_Object position
;
6022 position
= make_lispy_position (frame
, x
, y
, t
);
6023 return list2 (Qmouse_movement
, position
);
6027 #endif /* HAVE_MOUSE || HAVE GPM */
6029 /* Construct a switch frame event. */
6031 make_lispy_switch_frame (Lisp_Object frame
)
6033 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6036 /* Manipulating modifiers. */
6038 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6040 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6041 SYMBOL's name of the end of the modifiers; the string from this
6042 position is the unmodified symbol name.
6044 This doesn't use any caches. */
6047 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6053 CHECK_SYMBOL (symbol
);
6056 name
= SYMBOL_NAME (symbol
);
6058 for (i
= 0; i
+2 <= SBYTES (name
); )
6060 EMACS_INT this_mod_end
= 0;
6063 /* See if the name continues with a modifier word.
6064 Check that the word appears, but don't check what follows it.
6065 Set this_mod and this_mod_end to record what we find. */
6067 switch (SREF (name
, i
))
6069 #define SINGLE_LETTER_MOD(BIT) \
6070 (this_mod_end = i + 1, this_mod = BIT)
6073 SINGLE_LETTER_MOD (alt_modifier
);
6077 SINGLE_LETTER_MOD (ctrl_modifier
);
6081 SINGLE_LETTER_MOD (hyper_modifier
);
6085 SINGLE_LETTER_MOD (meta_modifier
);
6089 SINGLE_LETTER_MOD (shift_modifier
);
6093 SINGLE_LETTER_MOD (super_modifier
);
6096 #undef SINGLE_LETTER_MOD
6098 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6099 if (i + LEN + 1 <= SBYTES (name) \
6100 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6102 this_mod_end = i + LEN; \
6107 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6108 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6109 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6113 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6115 #undef MULTI_LETTER_MOD
6119 /* If we found no modifier, stop looking for them. */
6120 if (this_mod_end
== 0)
6123 /* Check there is a dash after the modifier, so that it
6124 really is a modifier. */
6125 if (this_mod_end
>= SBYTES (name
)
6126 || SREF (name
, this_mod_end
) != '-')
6129 /* This modifier is real; look for another. */
6130 modifiers
|= this_mod
;
6131 i
= this_mod_end
+ 1;
6134 /* Should we include the `click' modifier? */
6135 if (! (modifiers
& (down_modifier
| drag_modifier
6136 | double_modifier
| triple_modifier
))
6137 && i
+ 7 == SBYTES (name
)
6138 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6139 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6140 modifiers
|= click_modifier
;
6142 if (! (modifiers
& (double_modifier
| triple_modifier
))
6143 && i
+ 6 < SBYTES (name
)
6144 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6145 modifiers
|= click_modifier
;
6153 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6154 prepended to the string BASE[0..BASE_LEN-1].
6155 This doesn't use any caches. */
6157 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6159 /* Since BASE could contain nulls, we can't use intern here; we have
6160 to use Fintern, which expects a genuine Lisp_String, and keeps a
6163 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6169 /* Only the event queue may use the `up' modifier; it should always
6170 be turned into a click or drag event before presented to lisp code. */
6171 if (modifiers
& up_modifier
)
6174 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6175 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6176 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6177 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6178 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6179 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6180 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6181 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6182 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6183 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6184 /* The click modifier is denoted by the absence of other modifiers. */
6188 mod_len
= p
- new_mods
;
6192 Lisp_Object new_name
;
6194 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6195 mod_len
+ base_len_byte
);
6196 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6197 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6199 return Fintern (new_name
, Qnil
);
6204 static const char *const modifier_names
[] =
6206 "up", "down", "drag", "click", "double", "triple", 0, 0,
6207 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6208 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6210 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6212 static Lisp_Object modifier_symbols
;
6214 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6216 lispy_modifier_list (int modifiers
)
6218 Lisp_Object modifier_list
;
6221 modifier_list
= Qnil
;
6222 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6223 if (modifiers
& (1<<i
))
6224 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6227 return modifier_list
;
6231 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6232 where UNMODIFIED is the unmodified form of SYMBOL,
6233 MASK is the set of modifiers present in SYMBOL's name.
6234 This is similar to parse_modifiers_uncached, but uses the cache in
6235 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6236 Qevent_symbol_elements property. */
6238 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6241 parse_modifiers (Lisp_Object symbol
)
6243 Lisp_Object elements
;
6245 if (INTEGERP (symbol
))
6246 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6247 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6249 else if (!SYMBOLP (symbol
))
6252 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6253 if (CONSP (elements
))
6258 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6259 Lisp_Object unmodified
;
6262 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6263 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6266 if (modifiers
& ~INTMASK
)
6268 XSETFASTINT (mask
, modifiers
);
6269 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6271 /* Cache the parsing results on SYMBOL. */
6272 Fput (symbol
, Qevent_symbol_element_mask
,
6274 Fput (symbol
, Qevent_symbol_elements
,
6275 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6277 /* Since we know that SYMBOL is modifiers applied to unmodified,
6278 it would be nice to put that in unmodified's cache.
6279 But we can't, since we're not sure that parse_modifiers is
6286 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6287 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6288 doc
: /* Parse the event symbol. For internal use. */)
6289 (Lisp_Object symbol
)
6291 /* Fill the cache if needed. */
6292 parse_modifiers (symbol
);
6293 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6294 and use the Lispier representation stored on Qevent_symbol_elements
6296 return Fget (symbol
, Qevent_symbol_elements
);
6299 /* Apply the modifiers MODIFIERS to the symbol BASE.
6300 BASE must be unmodified.
6302 This is like apply_modifiers_uncached, but uses BASE's
6303 Qmodifier_cache property, if present. It also builds
6304 Qevent_symbol_elements properties, since it has that info anyway.
6306 apply_modifiers copies the value of BASE's Qevent_kind property to
6307 the modified symbol. */
6309 apply_modifiers (int modifiers
, Lisp_Object base
)
6311 Lisp_Object cache
, idx
, entry
, new_symbol
;
6313 /* Mask out upper bits. We don't know where this value's been. */
6314 modifiers
&= INTMASK
;
6316 if (INTEGERP (base
))
6317 return make_number (XINT (base
) | modifiers
);
6319 /* The click modifier never figures into cache indices. */
6320 cache
= Fget (base
, Qmodifier_cache
);
6321 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6322 entry
= assq_no_quit (idx
, cache
);
6325 new_symbol
= XCDR (entry
);
6328 /* We have to create the symbol ourselves. */
6329 new_symbol
= apply_modifiers_uncached (modifiers
,
6330 SSDATA (SYMBOL_NAME (base
)),
6331 SCHARS (SYMBOL_NAME (base
)),
6332 SBYTES (SYMBOL_NAME (base
)));
6334 /* Add the new symbol to the base's cache. */
6335 entry
= Fcons (idx
, new_symbol
);
6336 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6338 /* We have the parsing info now for free, so we could add it to
6340 XSETFASTINT (idx, modifiers);
6341 Fput (new_symbol, Qevent_symbol_element_mask,
6342 Fcons (base, Fcons (idx, Qnil)));
6343 Fput (new_symbol, Qevent_symbol_elements,
6344 Fcons (base, lispy_modifier_list (modifiers)));
6345 Sadly, this is only correct if `base' is indeed a base event,
6346 which is not necessarily the case. -stef */
6349 /* Make sure this symbol is of the same kind as BASE.
6351 You'd think we could just set this once and for all when we
6352 intern the symbol above, but reorder_modifiers may call us when
6353 BASE's property isn't set right; we can't assume that just
6354 because it has a Qmodifier_cache property it must have its
6355 Qevent_kind set right as well. */
6356 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6360 kind
= Fget (base
, Qevent_kind
);
6362 Fput (new_symbol
, Qevent_kind
, kind
);
6369 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6370 return a symbol with the modifiers placed in the canonical order.
6371 Canonical order is alphabetical, except for down and drag, which
6372 always come last. The 'click' modifier is never written out.
6374 Fdefine_key calls this to make sure that (for example) C-M-foo
6375 and M-C-foo end up being equivalent in the keymap. */
6378 reorder_modifiers (Lisp_Object symbol
)
6380 /* It's hopefully okay to write the code this way, since everything
6381 will soon be in caches, and no consing will be done at all. */
6384 parsed
= parse_modifiers (symbol
);
6385 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6390 /* For handling events, we often want to produce a symbol whose name
6391 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6392 to some base, like the name of a function key or mouse button.
6393 modify_event_symbol produces symbols of this sort.
6395 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6396 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6399 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6400 into symbol names, or a string specifying a name stem used to
6401 construct a symbol name or the form `STEM-N', where N is the decimal
6402 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6403 non-nil; otherwise NAME_TABLE is used.
6405 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6406 persist between calls to modify_event_symbol that it can use to
6407 store a cache of the symbols it's generated for this NAME_TABLE
6408 before. The object stored there may be a vector or an alist.
6410 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6412 MODIFIERS is a set of modifier bits (as given in struct input_events)
6413 whose prefixes should be applied to the symbol name.
6415 SYMBOL_KIND is the value to be placed in the event_kind property of
6416 the returned symbol.
6418 The symbols we create are supposed to have an
6419 `event-symbol-elements' property, which lists the modifiers present
6420 in the symbol's name. */
6423 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6424 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6425 Lisp_Object
*symbol_table
, EMACS_INT table_size
)
6428 Lisp_Object symbol_int
;
6430 /* Get rid of the "vendor-specific" bit here. */
6431 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6433 /* Is this a request for a valid symbol? */
6434 if (symbol_num
< 0 || symbol_num
>= table_size
)
6437 if (CONSP (*symbol_table
))
6438 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6440 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6441 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6442 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6443 we've never used that symbol before. */
6446 if (! VECTORP (*symbol_table
)
6447 || ASIZE (*symbol_table
) != table_size
)
6451 XSETFASTINT (size
, table_size
);
6452 *symbol_table
= Fmake_vector (size
, Qnil
);
6455 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6458 /* Have we already used this symbol before? */
6461 /* No; let's create it. */
6462 if (CONSP (name_alist_or_stem
))
6463 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6464 else if (STRINGP (name_alist_or_stem
))
6466 int len
= SBYTES (name_alist_or_stem
);
6467 char *buf
= (char *) alloca (len
+ 50);
6468 sprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6469 XINT (symbol_int
) + 1);
6470 value
= intern (buf
);
6472 else if (name_table
!= 0 && name_table
[symbol_num
])
6473 value
= intern (name_table
[symbol_num
]);
6475 #ifdef HAVE_WINDOW_SYSTEM
6478 char *name
= x_get_keysym_name (symbol_num
);
6480 value
= intern (name
);
6487 sprintf (buf
, "key-%"pI
"d", symbol_num
);
6488 value
= intern (buf
);
6491 if (CONSP (*symbol_table
))
6492 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6494 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6496 /* Fill in the cache entries for this symbol; this also
6497 builds the Qevent_symbol_elements property, which the user
6499 apply_modifiers (modifiers
& click_modifier
, value
);
6500 Fput (value
, Qevent_kind
, symbol_kind
);
6503 /* Apply modifiers to that symbol. */
6504 return apply_modifiers (modifiers
, value
);
6507 /* Convert a list that represents an event type,
6508 such as (ctrl meta backspace), into the usual representation of that
6509 event type as a number or a symbol. */
6511 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6512 doc
: /* Convert the event description list EVENT-DESC to an event type.
6513 EVENT-DESC should contain one base event type (a character or symbol)
6514 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6515 drag, down, double or triple). The base must be last.
6516 The return value is an event type (a character or symbol) which
6517 has the same base event type and all the specified modifiers. */)
6518 (Lisp_Object event_desc
)
6526 while (CONSP (rest
))
6534 /* Given a symbol, see if it is a modifier name. */
6535 if (SYMBOLP (elt
) && CONSP (rest
))
6536 this = parse_solitary_modifier (elt
);
6540 else if (!NILP (base
))
6541 error ("Two bases given in one event");
6547 /* Let the symbol A refer to the character A. */
6548 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6549 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6551 if (INTEGERP (base
))
6553 /* Turn (shift a) into A. */
6554 if ((modifiers
& shift_modifier
) != 0
6555 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6557 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6558 modifiers
&= ~shift_modifier
;
6561 /* Turn (control a) into C-a. */
6562 if (modifiers
& ctrl_modifier
)
6563 return make_number ((modifiers
& ~ctrl_modifier
)
6564 | make_ctrl_char (XINT (base
)));
6566 return make_number (modifiers
| XINT (base
));
6568 else if (SYMBOLP (base
))
6569 return apply_modifiers (modifiers
, base
);
6572 error ("Invalid base event");
6577 /* Try to recognize SYMBOL as a modifier name.
6578 Return the modifier flag bit, or 0 if not recognized. */
6581 parse_solitary_modifier (Lisp_Object symbol
)
6583 Lisp_Object name
= SYMBOL_NAME (symbol
);
6585 switch (SREF (name
, 0))
6587 #define SINGLE_LETTER_MOD(BIT) \
6588 if (SBYTES (name) == 1) \
6591 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6592 if (LEN == SBYTES (name) \
6593 && ! strncmp (SSDATA (name), NAME, LEN)) \
6597 SINGLE_LETTER_MOD (alt_modifier
);
6601 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6605 SINGLE_LETTER_MOD (ctrl_modifier
);
6609 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6610 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6614 SINGLE_LETTER_MOD (hyper_modifier
);
6618 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6622 SINGLE_LETTER_MOD (meta_modifier
);
6626 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6630 SINGLE_LETTER_MOD (shift_modifier
);
6634 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6635 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6636 SINGLE_LETTER_MOD (super_modifier
);
6640 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6641 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6642 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6646 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6649 #undef SINGLE_LETTER_MOD
6650 #undef MULTI_LETTER_MOD
6656 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6657 Such a list is not valid as an event,
6658 but it can be a Lucid-style event type list. */
6661 lucid_event_type_list_p (Lisp_Object object
)
6665 if (! CONSP (object
))
6668 if (EQ (XCAR (object
), Qhelp_echo
)
6669 || EQ (XCAR (object
), Qvertical_line
)
6670 || EQ (XCAR (object
), Qmode_line
)
6671 || EQ (XCAR (object
), Qheader_line
))
6674 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6678 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6685 /* Store into *addr a value nonzero if terminal input chars are available.
6686 Serves the purpose of ioctl (0, FIONREAD, addr)
6687 but works even if FIONREAD does not exist.
6688 (In fact, this may actually read some input.)
6690 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6691 timer events that are ripe.
6692 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6693 events (FOCUS_IN_EVENT).
6694 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6695 movements and toolkit scroll bar thumb drags. */
6698 get_input_pending (int *addr
, int flags
)
6700 /* First of all, have we already counted some input? */
6701 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6703 /* If input is being read as it arrives, and we have none, there is none. */
6704 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6707 /* Try to read some input and see how much we get. */
6709 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6712 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6715 gobble_input (int expected
)
6718 if (interrupt_input
)
6721 mask
= sigblock (sigmask (SIGIO
));
6722 read_avail_input (expected
);
6726 #ifdef POLL_FOR_INPUT
6727 /* XXX This condition was (read_socket_hook && !interrupt_input),
6728 but read_socket_hook is not global anymore. Let's pretend that
6730 if (!interrupt_input
&& poll_suppress_count
== 0)
6733 mask
= sigblock (sigmask (SIGALRM
));
6734 read_avail_input (expected
);
6740 read_avail_input (expected
);
6743 /* Put a BUFFER_SWITCH_EVENT in the buffer
6744 so that read_key_sequence will notice the new current buffer. */
6747 record_asynch_buffer_change (void)
6749 struct input_event event
;
6753 event
.kind
= BUFFER_SWITCH_EVENT
;
6754 event
.frame_or_window
= Qnil
;
6757 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6758 The purpose of the event is to make read_key_sequence look up the
6759 keymaps again. If we aren't in read_key_sequence, we don't need one,
6760 and the event could cause trouble by messing up (input-pending-p).
6761 Note: Fwaiting_for_user_input_p always returns nil when async
6762 subprocesses aren't supported. */
6763 tem
= Fwaiting_for_user_input_p ();
6767 /* Make sure no interrupt happens while storing the event. */
6769 if (interrupt_input
)
6772 mask
= sigblock (sigmask (SIGIO
));
6773 kbd_buffer_store_event (&event
);
6780 kbd_buffer_store_event (&event
);
6785 /* Read any terminal input already buffered up by the system
6786 into the kbd_buffer, but do not wait.
6788 EXPECTED should be nonzero if the caller knows there is some input.
6790 Returns the number of keyboard chars read, or -1 meaning
6791 this is a bad time to try to read input. */
6794 read_avail_input (int expected
)
6800 /* Store pending user signal events, if any. */
6801 if (store_user_signal_events ())
6804 /* Loop through the available terminals, and call their input hooks. */
6808 struct terminal
*next
= t
->next_terminal
;
6810 if (t
->read_socket_hook
)
6813 struct input_event hold_quit
;
6815 EVENT_INIT (hold_quit
);
6816 hold_quit
.kind
= NO_EVENT
;
6818 /* No need for FIONREAD or fcntl; just say don't wait. */
6819 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6825 if (nr
== -1) /* Not OK to read input now. */
6829 else if (nr
== -2) /* Non-transient error. */
6831 /* The terminal device terminated; it should be closed. */
6833 /* Kill Emacs if this was our last terminal. */
6834 if (!terminal_list
->next_terminal
)
6835 /* Formerly simply reported no input, but that
6836 sometimes led to a failure of Emacs to terminate.
6837 SIGHUP seems appropriate if we can't reach the
6839 /* ??? Is it really right to send the signal just to
6840 this process rather than to the whole process
6841 group? Perhaps on systems with FIONREAD Emacs is
6842 alone in its group. */
6843 kill (getpid (), SIGHUP
);
6845 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6848 XSETTERMINAL (tmp
, t
);
6849 Fdelete_terminal (tmp
, Qnoelisp
);
6853 if (hold_quit
.kind
!= NO_EVENT
)
6854 kbd_buffer_store_event (&hold_quit
);
6863 frame_make_pointer_visible ();
6869 decode_keyboard_code (struct tty_display_info
*tty
,
6870 struct coding_system
*coding
,
6871 unsigned char *buf
, int nbytes
)
6873 unsigned char *src
= buf
;
6874 const unsigned char *p
;
6879 if (tty
->meta_key
!= 2)
6880 for (i
= 0; i
< nbytes
; i
++)
6882 if (coding
->carryover_bytes
> 0)
6884 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6885 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6886 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6887 nbytes
+= coding
->carryover_bytes
;
6889 coding
->destination
= alloca (nbytes
* 4);
6890 coding
->dst_bytes
= nbytes
* 4;
6891 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6892 if (coding
->produced_char
== 0)
6894 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6896 struct input_event event_buf
;
6898 EVENT_INIT (event_buf
);
6899 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6901 (ASCII_CHAR_P (event_buf
.code
)
6902 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6903 /* See the comment in tty_read_avail_input. */
6904 event_buf
.frame_or_window
= tty
->top_frame
;
6905 event_buf
.arg
= Qnil
;
6906 kbd_buffer_store_event (&event_buf
);
6910 /* This is the tty way of reading available input.
6912 Note that each terminal device has its own `struct terminal' object,
6913 and so this function is called once for each individual termcap
6914 terminal. The first parameter indicates which terminal to read from. */
6917 tty_read_avail_input (struct terminal
*terminal
,
6919 struct input_event
*hold_quit
)
6921 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6922 the kbd_buffer can really hold. That may prevent loss
6923 of characters on some systems when input is stuffed at us. */
6924 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6926 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6929 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6931 if (kbd_on_hold_p () || buffer_free
<= 0)
6933 #endif /* subprocesses */
6935 if (!terminal
->name
) /* Don't read from a dead terminal. */
6938 if (terminal
->type
!= output_termcap
6939 && terminal
->type
!= output_msdos_raw
)
6942 /* XXX I think the following code should be moved to separate hook
6943 functions in system-dependent files. */
6946 #else /* not WINDOWSNT */
6947 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6951 return 0; /* The terminal is suspended. */
6954 n_to_read
= dos_keysns ();
6958 cbuf
[0] = dos_keyread ();
6961 #else /* not MSDOS */
6966 struct input_event gpm_hold_quit
;
6967 int gpm
, fd
= gpm_fd
;
6969 EVENT_INIT (gpm_hold_quit
);
6970 gpm_hold_quit
.kind
= NO_EVENT
;
6972 /* gpm==1 if event received.
6973 gpm==0 if the GPM daemon has closed the connection, in which case
6974 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6975 we save it in `fd' so close_gpm can remove it from the
6977 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6978 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6979 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6982 /* Presumably the GPM daemon has closed the connection. */
6984 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6985 kbd_buffer_store_event (&gpm_hold_quit
);
6989 #endif /* HAVE_GPM */
6991 /* Determine how many characters we should *try* to read. */
6993 /* Find out how much input is available. */
6994 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6996 if (! noninteractive
)
6997 return -2; /* Close this terminal. */
7003 if (n_to_read
> sizeof cbuf
)
7004 n_to_read
= sizeof cbuf
;
7005 #else /* no FIONREAD */
7006 #if defined (USG) || defined(CYGWIN)
7007 /* Read some input if available, but don't wait. */
7008 n_to_read
= sizeof cbuf
;
7009 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7016 /* Don't read more than we can store. */
7017 if (n_to_read
> buffer_free
)
7018 n_to_read
= buffer_free
;
7019 #endif /* subprocesses */
7021 /* Now read; for one reason or another, this will not block.
7022 NREAD is set to the number of chars read. */
7025 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7026 /* POSIX infers that processes which are not in the session leader's
7027 process group won't get SIGHUP's at logout time. BSDI adheres to
7028 this part standard and returns -1 from read (0) with errno==EIO
7029 when the control tty is taken away.
7030 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7031 if (nread
== -1 && errno
== EIO
)
7032 return -2; /* Close this terminal. */
7033 #if defined (AIX) && defined (_BSD)
7034 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7035 This looks incorrect, but it isn't, because _BSD causes
7036 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7037 and that causes a value other than 0 when there is no input. */
7039 return -2; /* Close this terminal. */
7043 /* We used to retry the read if it was interrupted.
7044 But this does the wrong thing when O_NDELAY causes
7045 an EAGAIN error. Does anybody know of a situation
7046 where a retry is actually needed? */
7048 nread
< 0 && (errno
== EAGAIN
7062 #if defined (USG) || defined (CYGWIN)
7063 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7064 #endif /* USG or CYGWIN */
7065 #endif /* no FIONREAD */
7070 #endif /* not MSDOS */
7071 #endif /* not WINDOWSNT */
7073 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7074 & CODING_REQUIRE_DECODING_MASK
)
7076 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7079 /* Decode the key sequence except for those with meta
7081 for (i
= from
= 0; ; i
++)
7082 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7084 struct input_event buf
;
7086 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7091 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7092 buf
.modifiers
= meta_modifier
;
7093 buf
.code
= cbuf
[i
] & ~0x80;
7094 /* See the comment below. */
7095 buf
.frame_or_window
= tty
->top_frame
;
7097 kbd_buffer_store_event (&buf
);
7103 for (i
= 0; i
< nread
; i
++)
7105 struct input_event buf
;
7107 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7109 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7110 buf
.modifiers
= meta_modifier
;
7111 if (tty
->meta_key
!= 2)
7115 /* Set the frame corresponding to the active tty. Note that the
7116 value of selected_frame is not reliable here, redisplay tends
7117 to temporarily change it. */
7118 buf
.frame_or_window
= tty
->top_frame
;
7121 kbd_buffer_store_event (&buf
);
7122 /* Don't look at input that follows a C-g too closely.
7123 This reduces lossage due to autorepeat on C-g. */
7124 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7125 && buf
.code
== quit_char
)
7133 handle_async_input (void)
7135 interrupt_input_pending
= 0;
7137 pending_signals
= pending_atimers
;
7139 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7140 doing anything dangerous. */
7147 nread
= read_avail_input (1);
7148 /* -1 means it's not ok to read the input now.
7149 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7150 0 means there was no keyboard input available. */
7160 process_pending_signals (void)
7162 if (interrupt_input_pending
)
7163 handle_async_input ();
7164 do_pending_atimers ();
7167 #ifdef SIGIO /* for entire page */
7168 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7171 input_available_signal (int signo
)
7173 /* Must preserve main program's value of errno. */
7174 int old_errno
= errno
;
7175 SIGNAL_THREAD_CHECK (signo
);
7178 interrupt_input_pending
= 1;
7179 pending_signals
= 1;
7182 if (input_available_clear_time
)
7183 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7186 handle_async_input ();
7193 /* Send ourselves a SIGIO.
7195 This function exists so that the UNBLOCK_INPUT macro in
7196 blockinput.h can have some way to take care of input we put off
7197 dealing with, without assuming that every file which uses
7198 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7200 reinvoke_input_signal (void)
7203 handle_async_input ();
7209 /* User signal events. */
7211 struct user_signal_info
7213 /* Signal number. */
7216 /* Name of the signal. */
7219 /* Number of pending signals. */
7222 struct user_signal_info
*next
;
7225 /* List of user signals. */
7226 static struct user_signal_info
*user_signals
= NULL
;
7229 add_user_signal (int sig
, const char *name
)
7231 struct user_signal_info
*p
;
7233 for (p
= user_signals
; p
; p
= p
->next
)
7235 /* Already added. */
7238 p
= xmalloc (sizeof (struct user_signal_info
));
7240 p
->name
= xstrdup (name
);
7242 p
->next
= user_signals
;
7245 signal (sig
, handle_user_signal
);
7249 handle_user_signal (int sig
)
7251 int old_errno
= errno
;
7252 struct user_signal_info
*p
;
7253 const char *special_event_name
= NULL
;
7255 SIGNAL_THREAD_CHECK (sig
);
7257 if (SYMBOLP (Vdebug_on_event
))
7258 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7260 for (p
= user_signals
; p
; p
= p
->next
)
7263 if (special_event_name
&&
7264 strcmp (special_event_name
, p
->name
) == 0)
7266 /* Enter the debugger in many ways. */
7267 debug_on_next_call
= 1;
7270 Vinhibit_quit
= Qnil
;
7272 /* Eat the event. */
7278 if (interrupt_input
)
7279 kill (getpid (), SIGIO
);
7283 /* Tell wait_reading_process_output that it needs to wake
7284 up and look around. */
7285 if (input_available_clear_time
)
7286 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7295 find_user_signal_name (int sig
)
7297 struct user_signal_info
*p
;
7299 for (p
= user_signals
; p
; p
= p
->next
)
7307 store_user_signal_events (void)
7309 struct user_signal_info
*p
;
7310 struct input_event buf
;
7313 for (p
= user_signals
; p
; p
= p
->next
)
7314 if (p
->npending
> 0)
7320 memset (&buf
, 0, sizeof buf
);
7321 buf
.kind
= USER_SIGNAL_EVENT
;
7322 buf
.frame_or_window
= selected_frame
;
7324 nstored
+= p
->npending
;
7326 mask
= sigblock (sigmask (p
->sig
));
7330 kbd_buffer_store_event (&buf
);
7333 while (p
->npending
> 0);
7341 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7342 static Lisp_Object menu_bar_one_keymap_changed_items
;
7344 /* These variables hold the vector under construction within
7345 menu_bar_items and its subroutines, and the current index
7346 for storing into that vector. */
7347 static Lisp_Object menu_bar_items_vector
;
7348 static int menu_bar_items_index
;
7351 static const char* separator_names
[] = {
7356 "single-dashed-line",
7357 "double-dashed-line",
7359 "shadow-etched-out",
7360 "shadow-etched-in-dash",
7361 "shadow-etched-out-dash",
7362 "shadow-double-etched-in",
7363 "shadow-double-etched-out",
7364 "shadow-double-etched-in-dash",
7365 "shadow-double-etched-out-dash",
7369 /* Return non-zero if LABEL specifies a separator. */
7372 menu_separator_name_p (const char *label
)
7376 else if (strlen (label
) > 3
7377 && strncmp (label
, "--", 2) == 0
7382 for (i
= 0; separator_names
[i
]; ++i
)
7383 if (strcmp (label
, separator_names
[i
]) == 0)
7388 /* It's a separator if it contains only dashes. */
7389 while (*label
== '-')
7391 return (*label
== 0);
7398 /* Return a vector of menu items for a menu bar, appropriate
7399 to the current buffer. Each item has three elements in the vector:
7402 OLD is an old vector we can optionally reuse, or nil. */
7405 menu_bar_items (Lisp_Object old
)
7407 /* The number of keymaps we're scanning right now, and the number of
7408 keymaps we have allocated space for. */
7411 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7412 in the current keymaps, or nil where it is not a prefix. */
7415 Lisp_Object def
, tail
;
7420 /* In order to build the menus, we need to call the keymap
7421 accessors. They all call QUIT. But this function is called
7422 during redisplay, during which a quit is fatal. So inhibit
7423 quitting while building the menus.
7424 We do this instead of specbind because (1) errors will clear it anyway
7425 and (2) this avoids risk of specpdl overflow. */
7426 oquit
= Vinhibit_quit
;
7430 menu_bar_items_vector
= old
;
7432 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7433 menu_bar_items_index
= 0;
7435 /* Build our list of keymaps.
7436 If we recognize a function key and replace its escape sequence in
7437 keybuf with its symbol, or if the sequence starts with a mouse
7438 click and we need to switch buffers, we jump back here to rebuild
7439 the initial keymaps from the current buffer. */
7443 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7444 if (!NILP (Voverriding_local_map_menu_flag
))
7446 /* Yes, use them (if non-nil) as well as the global map. */
7447 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7449 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7450 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7451 if (!NILP (Voverriding_local_map
))
7452 maps
[nmaps
++] = Voverriding_local_map
;
7456 /* No, so use major and minor mode keymaps and keymap property.
7457 Note that menu-bar bindings in the local-map and keymap
7458 properties may not work reliable, as they are only
7459 recognized when the menu-bar (or mode-line) is updated,
7460 which does not normally happen after every command. */
7463 nminor
= current_minor_maps (NULL
, &tmaps
);
7464 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7466 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7467 maps
[nmaps
++] = tem
;
7468 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7470 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7472 maps
[nmaps
++] = current_global_map
;
7475 /* Look up in each map the dummy prefix key `menu-bar'. */
7477 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7478 if (!NILP (maps
[mapno
]))
7480 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7484 menu_bar_one_keymap_changed_items
= Qnil
;
7485 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7489 /* Move to the end those items that should be at the end. */
7491 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7494 int end
= menu_bar_items_index
;
7496 for (i
= 0; i
< end
; i
+= 4)
7497 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7499 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7500 /* Move the item at index I to the end,
7501 shifting all the others forward. */
7502 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7503 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7504 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7505 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7507 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7508 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7509 (end
- i
- 4) * sizeof (Lisp_Object
));
7510 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7511 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7512 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7513 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7518 /* Add nil, nil, nil, nil at the end. */
7520 int i
= menu_bar_items_index
;
7521 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7522 menu_bar_items_vector
=
7523 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7524 /* Add this item. */
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 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7529 menu_bar_items_index
= i
;
7532 Vinhibit_quit
= oquit
;
7533 return menu_bar_items_vector
;
7536 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7537 If there's already an item for KEY, add this DEF to it. */
7539 Lisp_Object item_properties
;
7542 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7544 struct gcpro gcpro1
;
7548 if (EQ (item
, Qundefined
))
7550 /* If a map has an explicit `undefined' as definition,
7551 discard any previously made menu bar item. */
7553 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7554 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7556 if (menu_bar_items_index
> i
+ 4)
7557 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7558 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7559 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7560 menu_bar_items_index
-= 4;
7564 /* If this keymap has already contributed to this KEY,
7565 don't contribute to it a second time. */
7566 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7567 if (!NILP (tem
) || NILP (item
))
7570 menu_bar_one_keymap_changed_items
7571 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7573 /* We add to menu_bar_one_keymap_changed_items before doing the
7574 parse_menu_item, so that if it turns out it wasn't a menu item,
7575 it still correctly hides any further menu item. */
7577 i
= parse_menu_item (item
, 1);
7582 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7584 /* Find any existing item for this KEY. */
7585 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7586 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7589 /* If we did not find this KEY, add it at the end. */
7590 if (i
== menu_bar_items_index
)
7592 /* If vector is too small, get a bigger one. */
7593 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7594 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7595 /* Add this item. */
7596 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7597 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7598 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7599 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7600 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7601 menu_bar_items_index
= i
;
7603 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7607 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7608 /* If the new and the old items are not both keymaps,
7609 the lookup will only find `item'. */
7610 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7611 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7615 /* This is used as the handler when calling menu_item_eval_property. */
7617 menu_item_eval_property_1 (Lisp_Object arg
)
7619 /* If we got a quit from within the menu computation,
7620 quit all the way out of it. This takes care of C-] in the debugger. */
7621 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7622 Fsignal (Qquit
, Qnil
);
7628 eval_dyn (Lisp_Object form
)
7630 return Feval (form
, Qnil
);
7633 /* Evaluate an expression and return the result (or nil if something
7634 went wrong). Used to evaluate dynamic parts of menu items. */
7636 menu_item_eval_property (Lisp_Object sexpr
)
7638 int count
= SPECPDL_INDEX ();
7640 specbind (Qinhibit_redisplay
, Qt
);
7641 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7642 menu_item_eval_property_1
);
7643 return unbind_to (count
, val
);
7646 /* This function parses a menu item and leaves the result in the
7647 vector item_properties.
7648 ITEM is a key binding, a possible menu item.
7649 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7651 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7652 parse_menu_item returns true if the item is a menu item and false
7656 parse_menu_item (Lisp_Object item
, int inmenubar
)
7658 Lisp_Object def
, tem
, item_string
, start
;
7660 Lisp_Object keyhint
;
7669 /* Create item_properties vector if necessary. */
7670 if (NILP (item_properties
))
7672 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7674 /* Initialize optional entries. */
7675 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7676 ASET (item_properties
, i
, Qnil
);
7677 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7679 /* Save the item here to protect it from GC. */
7680 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7682 item_string
= XCAR (item
);
7686 if (STRINGP (item_string
))
7688 /* Old format menu item. */
7689 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7691 /* Maybe help string. */
7692 if (CONSP (item
) && STRINGP (XCAR (item
)))
7694 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7699 /* Maybe an obsolete key binding cache. */
7700 if (CONSP (item
) && CONSP (XCAR (item
))
7701 && (NILP (XCAR (XCAR (item
)))
7702 || VECTORP (XCAR (XCAR (item
)))))
7705 /* This is the real definition--the function to run. */
7706 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7708 /* Get enable property, if any. */
7711 tem
= Fget (item
, Qmenu_enable
);
7712 if (!NILP (Venable_disabled_menus_and_buttons
))
7713 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7714 else if (!NILP (tem
))
7715 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7718 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7720 /* New format menu item. */
7721 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7722 start
= XCDR (item
);
7725 /* We have a real binding. */
7726 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7728 item
= XCDR (start
);
7729 /* Is there an obsolete cache list with key equivalences. */
7730 if (CONSP (item
) && CONSP (XCAR (item
)))
7733 /* Parse properties. */
7734 while (CONSP (item
) && CONSP (XCDR (item
)))
7739 if (EQ (tem
, QCenable
))
7741 if (!NILP (Venable_disabled_menus_and_buttons
))
7742 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7744 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7746 else if (EQ (tem
, QCvisible
))
7748 /* If got a visible property and that evaluates to nil
7749 then ignore this item. */
7750 tem
= menu_item_eval_property (XCAR (item
));
7754 else if (EQ (tem
, QChelp
))
7755 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7756 else if (EQ (tem
, QCfilter
))
7758 else if (EQ (tem
, QCkey_sequence
))
7761 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7762 /* Be GC protected. Set keyhint to item instead of tem. */
7765 else if (EQ (tem
, QCkeys
))
7768 if (CONSP (tem
) || STRINGP (tem
))
7769 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7771 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7776 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7778 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7780 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7786 else if (inmenubar
|| !NILP (start
))
7790 return 0; /* not a menu item */
7792 /* If item string is not a string, evaluate it to get string.
7793 If we don't get a string, skip this item. */
7794 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7795 if (!(STRINGP (item_string
)))
7797 item_string
= menu_item_eval_property (item_string
);
7798 if (!STRINGP (item_string
))
7800 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7803 /* If got a filter apply it on definition. */
7804 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7807 def
= menu_item_eval_property (list2 (XCAR (filter
),
7808 list2 (Qquote
, def
)));
7810 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7813 /* Enable or disable selection of item. */
7814 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7817 tem
= menu_item_eval_property (tem
);
7818 if (inmenubar
&& NILP (tem
))
7819 return 0; /* Ignore disabled items in menu bar. */
7820 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7823 /* If we got no definition, this item is just unselectable text which
7824 is OK in a submenu but not in the menubar. */
7826 return (!inmenubar
);
7828 /* See if this is a separate pane or a submenu. */
7829 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7830 tem
= get_keymap (def
, 0, 1);
7831 /* For a subkeymap, just record its details and exit. */
7834 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7835 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7839 /* At the top level in the menu bar, do likewise for commands also.
7840 The menu bar does not display equivalent key bindings anyway.
7841 ITEM_PROPERTY_DEF is already set up properly. */
7845 { /* This is a command. See if there is an equivalent key binding. */
7846 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7848 /* The previous code preferred :key-sequence to :keys, so we
7849 preserve this behavior. */
7850 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7851 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7854 Lisp_Object prefix
= keyeq
;
7855 Lisp_Object keys
= Qnil
;
7859 def
= XCAR (prefix
);
7860 prefix
= XCDR (prefix
);
7863 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7865 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7867 keys
= XCAR (keyhint
);
7868 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7870 /* We have a suggested key. Is it bound to the command? */
7873 /* If the command is an alias for another
7874 (such as lmenu.el set it up), check if the
7875 original command matches the cached command. */
7876 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7881 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7885 tem
= Fkey_description (keys
, Qnil
);
7888 if (STRINGP (XCAR (prefix
)))
7889 tem
= concat2 (XCAR (prefix
), tem
);
7890 if (STRINGP (XCDR (prefix
)))
7891 tem
= concat2 (tem
, XCDR (prefix
));
7893 keyeq
= concat2 (build_string (" "), tem
);
7894 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7900 /* If we have an equivalent key binding, use that. */
7901 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7904 /* Include this when menu help is implemented.
7905 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7906 if (!(NILP (tem) || STRINGP (tem)))
7908 tem = menu_item_eval_property (tem);
7911 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7915 /* Handle radio buttons or toggle boxes. */
7916 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7918 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7919 menu_item_eval_property (tem
));
7926 /***********************************************************************
7928 ***********************************************************************/
7930 /* A vector holding tool bar items while they are parsed in function
7931 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7934 static Lisp_Object tool_bar_items_vector
;
7936 /* A vector holding the result of parse_tool_bar_item. Layout is like
7937 the one for a single item in tool_bar_items_vector. */
7939 static Lisp_Object tool_bar_item_properties
;
7941 /* Next free index in tool_bar_items_vector. */
7943 static int ntool_bar_items
;
7945 /* The symbols `:image' and `:rtl'. */
7947 static Lisp_Object QCimage
;
7948 static Lisp_Object QCrtl
;
7950 /* Function prototypes. */
7952 static void init_tool_bar_items (Lisp_Object
);
7953 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7954 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7955 static void append_tool_bar_item (void);
7958 /* Return a vector of tool bar items for keymaps currently in effect.
7959 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7960 tool bar items found. */
7963 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7972 /* In order to build the menus, we need to call the keymap
7973 accessors. They all call QUIT. But this function is called
7974 during redisplay, during which a quit is fatal. So inhibit
7975 quitting while building the menus. We do this instead of
7976 specbind because (1) errors will clear it anyway and (2) this
7977 avoids risk of specpdl overflow. */
7978 oquit
= Vinhibit_quit
;
7981 /* Initialize tool_bar_items_vector and protect it from GC. */
7982 init_tool_bar_items (reuse
);
7984 /* Build list of keymaps in maps. Set nmaps to the number of maps
7987 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7988 if (!NILP (Voverriding_local_map_menu_flag
))
7990 /* Yes, use them (if non-nil) as well as the global map. */
7991 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7993 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7994 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7995 if (!NILP (Voverriding_local_map
))
7996 maps
[nmaps
++] = Voverriding_local_map
;
8000 /* No, so use major and minor mode keymaps and keymap property.
8001 Note that tool-bar bindings in the local-map and keymap
8002 properties may not work reliable, as they are only
8003 recognized when the tool-bar (or mode-line) is updated,
8004 which does not normally happen after every command. */
8007 nminor
= current_minor_maps (NULL
, &tmaps
);
8008 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8010 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8011 maps
[nmaps
++] = tem
;
8012 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8014 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8017 /* Add global keymap at the end. */
8018 maps
[nmaps
++] = current_global_map
;
8020 /* Process maps in reverse order and look up in each map the prefix
8022 for (i
= nmaps
- 1; i
>= 0; --i
)
8023 if (!NILP (maps
[i
]))
8027 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8029 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8032 Vinhibit_quit
= oquit
;
8033 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8034 return tool_bar_items_vector
;
8038 /* Process the definition of KEY which is DEF. */
8041 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8044 struct gcpro gcpro1
, gcpro2
;
8046 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8050 if (EQ (def
, Qundefined
))
8052 /* If a map has an explicit `undefined' as definition,
8053 discard any previously made item. */
8054 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8056 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8058 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8060 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8061 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8062 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8063 * sizeof (Lisp_Object
)));
8064 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8069 else if (parse_tool_bar_item (key
, def
))
8070 /* Append a new tool bar item to tool_bar_items_vector. Accept
8071 more than one definition for the same key. */
8072 append_tool_bar_item ();
8078 /* Parse a tool bar item specification ITEM for key KEY and return the
8079 result in tool_bar_item_properties. Value is zero if ITEM is
8082 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8084 CAPTION is the caption of the item, If it's not a string, it is
8085 evaluated to get a string.
8087 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8088 as binding are currently ignored.
8090 The following properties are recognized:
8094 FORM is evaluated and specifies whether the tool bar item is
8095 enabled or disabled.
8099 FORM is evaluated and specifies whether the tool bar item is visible.
8101 - `:filter FUNCTION'
8103 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8104 result is stored as the new binding.
8106 - `:button (TYPE SELECTED)'
8108 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8109 and specifies whether the button is selected (pressed) or not.
8113 IMAGES is either a single image specification or a vector of four
8114 image specifications. See enum tool_bar_item_images.
8116 - `:help HELP-STRING'.
8118 Gives a help string to display for the tool bar item.
8120 - `:label LABEL-STRING'.
8122 A text label to show with the tool bar button if labels are enabled. */
8125 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8127 /* Access slot with index IDX of vector tool_bar_item_properties. */
8128 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8130 Lisp_Object filter
= Qnil
;
8131 Lisp_Object caption
;
8132 int i
, have_label
= 0;
8134 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8135 Rule out items that aren't lists, don't start with
8136 `menu-item' or whose rest following `tool-bar-item' is not a
8141 /* As an exception, allow old-style menu separators. */
8142 if (STRINGP (XCAR (item
)))
8143 item
= Fcons (XCAR (item
), Qnil
);
8144 else if (!EQ (XCAR (item
), Qmenu_item
)
8145 || (item
= XCDR (item
), !CONSP (item
)))
8148 /* Create tool_bar_item_properties vector if necessary. Reset it to
8150 if (VECTORP (tool_bar_item_properties
))
8152 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8156 tool_bar_item_properties
8157 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8160 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8161 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8163 /* Get the caption of the item. If the caption is not a string,
8164 evaluate it to get a string. If we don't get a string, skip this
8166 caption
= XCAR (item
);
8167 if (!STRINGP (caption
))
8169 caption
= menu_item_eval_property (caption
);
8170 if (!STRINGP (caption
))
8173 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8175 /* If the rest following the caption is not a list, the menu item is
8176 either a separator, or invalid. */
8180 if (menu_separator_name_p (SSDATA (caption
)))
8182 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8183 #if !defined (USE_GTK) && !defined (HAVE_NS)
8184 /* If we use build_desired_tool_bar_string to render the
8185 tool bar, the separator is rendered as an image. */
8186 PROP (TOOL_BAR_ITEM_IMAGES
)
8187 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8188 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8189 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8190 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8197 /* Store the binding. */
8198 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8201 /* Ignore cached key binding, if any. */
8202 if (CONSP (item
) && CONSP (XCAR (item
)))
8205 /* Process the rest of the properties. */
8206 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8208 Lisp_Object ikey
, value
;
8211 value
= XCAR (XCDR (item
));
8213 if (EQ (ikey
, QCenable
))
8215 /* `:enable FORM'. */
8216 if (!NILP (Venable_disabled_menus_and_buttons
))
8217 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8219 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8221 else if (EQ (ikey
, QCvisible
))
8223 /* `:visible FORM'. If got a visible property and that
8224 evaluates to nil then ignore this item. */
8225 if (NILP (menu_item_eval_property (value
)))
8228 else if (EQ (ikey
, QChelp
))
8229 /* `:help HELP-STRING'. */
8230 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8231 else if (EQ (ikey
, QCvert_only
))
8232 /* `:vert-only t/nil'. */
8233 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8234 else if (EQ (ikey
, QClabel
))
8236 const char *bad_label
= "!!?GARBLED ITEM?!!";
8237 /* `:label LABEL-STRING'. */
8238 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8240 : build_string (bad_label
);
8243 else if (EQ (ikey
, QCfilter
))
8244 /* ':filter FORM'. */
8246 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8248 /* `:button (TYPE . SELECTED)'. */
8249 Lisp_Object type
, selected
;
8251 type
= XCAR (value
);
8252 selected
= XCDR (value
);
8253 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8255 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8256 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8259 else if (EQ (ikey
, QCimage
)
8261 || (VECTORP (value
) && ASIZE (value
) == 4)))
8262 /* Value is either a single image specification or a vector
8263 of 4 such specifications for the different button states. */
8264 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8265 else if (EQ (ikey
, QCrtl
))
8267 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8273 /* Try to make one from caption and key. */
8274 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8275 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8276 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8277 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8279 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8280 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8281 Lisp_Object new_lbl
;
8282 ptrdiff_t caption_len
= strlen (capt
);
8284 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8287 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8289 buf
[caption_len
] = '\0';
8293 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8297 strcpy (buf
, label
);
8299 for (j
= 0; buf
[j
] != '\0'; ++j
)
8307 new_lbl
= Fupcase_initials (build_string (label
));
8308 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8309 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8311 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8315 /* If got a filter apply it on binding. */
8317 PROP (TOOL_BAR_ITEM_BINDING
)
8318 = menu_item_eval_property (list2 (filter
,
8320 PROP (TOOL_BAR_ITEM_BINDING
))));
8322 /* See if the binding is a keymap. Give up if it is. */
8323 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8326 /* Enable or disable selection of item. */
8327 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8328 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8329 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8331 /* Handle radio buttons or toggle boxes. */
8332 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8333 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8334 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8342 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8343 that can be reused. */
8346 init_tool_bar_items (Lisp_Object reuse
)
8348 if (VECTORP (reuse
))
8349 tool_bar_items_vector
= reuse
;
8351 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8352 ntool_bar_items
= 0;
8356 /* Append parsed tool bar item properties from
8357 tool_bar_item_properties */
8360 append_tool_bar_item (void)
8362 Lisp_Object
*to
, *from
;
8364 /* Enlarge tool_bar_items_vector if necessary. */
8365 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8366 >= ASIZE (tool_bar_items_vector
))
8367 tool_bar_items_vector
8368 = larger_vector (tool_bar_items_vector
,
8369 2 * ASIZE (tool_bar_items_vector
), Qnil
);
8371 /* Append entries from tool_bar_item_properties to the end of
8372 tool_bar_items_vector. */
8373 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8374 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8375 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8376 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8383 /* Read a character using menus based on maps in the array MAPS.
8384 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8385 Return t if we displayed a menu but the user rejected it.
8387 PREV_EVENT is the previous input event, or nil if we are reading
8388 the first event of a key sequence.
8390 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8391 if we used a mouse menu to read the input, or zero otherwise. If
8392 USED_MOUSE_MENU is null, we don't dereference it.
8394 The prompting is done based on the prompt-string of the map
8395 and the strings associated with various map elements.
8397 This can be done with X menus or with menus put in the minibuf.
8398 These are done in different ways, depending on how the input will be read.
8399 Menus using X are done after auto-saving in read-char, getting the input
8400 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8401 and do auto-saving in the inner call of read_char. */
8404 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8405 Lisp_Object prev_event
, int *used_mouse_menu
)
8409 if (used_mouse_menu
)
8410 *used_mouse_menu
= 0;
8412 /* Use local over global Menu maps */
8414 if (! menu_prompting
)
8417 /* Optionally disregard all but the global map. */
8418 if (inhibit_local_menu_bar_menus
)
8420 maps
+= (nmaps
- 1);
8425 /* If we got to this point via a mouse click,
8426 use a real menu for mouse selection. */
8427 if (EVENT_HAS_PARAMETERS (prev_event
)
8428 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8429 && !EQ (XCAR (prev_event
), Qtool_bar
))
8431 /* Display the menu and get the selection. */
8432 Lisp_Object
*realmaps
8433 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8435 ptrdiff_t nmaps1
= 0;
8437 /* Use the maps that are not nil. */
8438 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8439 if (!NILP (maps
[mapno
]))
8440 realmaps
[nmaps1
++] = maps
[mapno
];
8442 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8447 record_menu_key (XCAR (value
));
8449 /* If we got multiple events, unread all but
8451 There is no way to prevent those unread events
8452 from showing up later in last_nonmenu_event.
8453 So turn symbol and integer events into lists,
8454 to indicate that they came from a mouse menu,
8455 so that when present in last_nonmenu_event
8456 they won't confuse things. */
8457 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8459 record_menu_key (XCAR (tem
));
8460 if (SYMBOLP (XCAR (tem
))
8461 || INTEGERP (XCAR (tem
)))
8462 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8465 /* If we got more than one event, put all but the first
8466 onto this list to be read later.
8467 Return just the first event now. */
8468 Vunread_command_events
8469 = nconc2 (XCDR (value
), Vunread_command_events
);
8470 value
= XCAR (value
);
8472 else if (NILP (value
))
8474 if (used_mouse_menu
)
8475 *used_mouse_menu
= 1;
8478 #endif /* HAVE_MENUS */
8482 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8483 We make this bigger when necessary, and never free it. */
8484 static char *read_char_minibuf_menu_text
;
8485 /* Size of that buffer. */
8486 static ptrdiff_t read_char_minibuf_menu_width
;
8489 read_char_minibuf_menu_prompt (int commandflag
,
8490 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8493 register Lisp_Object name
;
8495 /* FIXME: Use the minibuffer's frame width. */
8496 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8499 Lisp_Object rest
, vector
;
8505 if (! menu_prompting
)
8508 /* Get the menu name from the first map that has one (a prompt string). */
8509 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8511 name
= Fkeymap_prompt (maps
[mapno
]);
8516 /* If we don't have any menus, just read a character normally. */
8517 if (!STRINGP (name
))
8520 /* Make sure we have a big enough buffer for the menu text. */
8521 width
= max (width
, SBYTES (name
));
8522 if (STRING_BYTES_BOUND
- 4 < width
)
8523 memory_full (SIZE_MAX
);
8524 if (width
+ 4 > read_char_minibuf_menu_width
)
8526 read_char_minibuf_menu_text
8527 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8528 read_char_minibuf_menu_width
= width
+ 4;
8530 menu
= read_char_minibuf_menu_text
;
8532 /* Prompt string always starts with map's prompt, and a space. */
8533 strcpy (menu
, SSDATA (name
));
8534 nlength
= SBYTES (name
);
8535 menu
[nlength
++] = ':';
8536 menu
[nlength
++] = ' ';
8539 /* Start prompting at start of first map. */
8543 /* Present the documented bindings, a line at a time. */
8547 ptrdiff_t i
= nlength
;
8549 Lisp_Object orig_defn_macro
;
8551 /* Loop over elements of map. */
8556 /* If reached end of map, start at beginning of next map. */
8560 /* At end of last map, wrap around to first map if just starting,
8561 or end this line if already have something on it. */
8565 if (notfirst
|| nobindings
) break;
8570 /* Look at the next element of the map. */
8572 elt
= XVECTOR (vector
)->contents
[idx
];
8574 elt
= Fcar_safe (rest
);
8576 if (idx
< 0 && VECTORP (elt
))
8578 /* If we found a dense table in the keymap,
8579 advanced past it, but start scanning its contents. */
8580 rest
= Fcdr_safe (rest
);
8586 /* An ordinary element. */
8587 Lisp_Object event
, tem
;
8591 event
= Fcar_safe (elt
); /* alist */
8592 elt
= Fcdr_safe (elt
);
8596 XSETINT (event
, idx
); /* vector */
8599 /* Ignore the element if it has no prompt string. */
8600 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8602 /* 1 if the char to type matches the string. */
8604 Lisp_Object upcased_event
, downcased_event
;
8605 Lisp_Object desc
= Qnil
;
8607 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8609 upcased_event
= Fupcase (event
);
8610 downcased_event
= Fdowncase (event
);
8611 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8612 || XINT (downcased_event
) == SREF (s
, 0));
8614 desc
= Fsingle_key_description (event
, Qnil
);
8616 #if 0 /* It is redundant to list the equivalent key bindings because
8617 the prefix is what the user has already typed. */
8619 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8621 /* Insert equivalent keybinding. */
8622 s
= concat2 (s
, tem
);
8625 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8626 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8628 /* Insert button prefix. */
8629 Lisp_Object selected
8630 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8631 if (EQ (tem
, QCradio
))
8632 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8634 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8635 s
= concat2 (tem
, s
);
8639 /* If we have room for the prompt string, add it to this line.
8640 If this is the first on the line, always add it. */
8641 if ((SCHARS (s
) + i
+ 2
8642 + (char_matches
? 0 : SCHARS (desc
) + 3))
8646 ptrdiff_t thiswidth
;
8648 /* Punctuate between strings. */
8651 strcpy (menu
+ i
, ", ");
8657 /* If the char to type doesn't match the string's
8658 first char, explicitly show what char to type. */
8661 /* Add as much of string as fits. */
8662 thiswidth
= min (SCHARS (desc
), width
- i
);
8663 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8665 strcpy (menu
+ i
, " = ");
8669 /* Add as much of string as fits. */
8670 thiswidth
= min (SCHARS (s
), width
- i
);
8671 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8677 /* If this element does not fit, end the line now,
8678 and save the element for the next line. */
8679 strcpy (menu
+ i
, "...");
8684 /* Move past this element. */
8685 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8686 /* Handle reaching end of dense table. */
8691 rest
= Fcdr_safe (rest
);
8695 /* Prompt with that and read response. */
8696 message2_nolog (menu
, strlen (menu
),
8697 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8699 /* Make believe its not a keyboard macro in case the help char
8700 is pressed. Help characters are not recorded because menu prompting
8701 is not used on replay.
8703 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8704 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8706 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8707 while (BUFFERP (obj
));
8708 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8710 if (!INTEGERP (obj
))
8712 else if (XINT (obj
) == -2)
8715 if (! EQ (obj
, menu_prompt_more_char
)
8716 && (!INTEGERP (menu_prompt_more_char
)
8717 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8719 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8720 store_kbd_macro_char (obj
);
8723 /* Help char - go round again */
8727 /* Reading key sequences. */
8729 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8730 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8731 keymap, or nil otherwise. Return the index of the first keymap in
8732 which KEY has any binding, or NMAPS if no map has a binding.
8734 If KEY is a meta ASCII character, treat it like meta-prefix-char
8735 followed by the corresponding non-meta character. Keymaps in
8736 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8739 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8742 NEXT may be the same array as CURRENT. */
8745 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8746 Lisp_Object
*defs
, Lisp_Object
*next
)
8748 ptrdiff_t i
, first_binding
;
8750 first_binding
= nmaps
;
8751 for (i
= nmaps
- 1; i
>= 0; i
--)
8753 if (! NILP (current
[i
]))
8755 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8756 if (! NILP (defs
[i
]))
8763 /* Given the set of bindings we've found, produce the next set of maps. */
8764 if (first_binding
< nmaps
)
8765 for (i
= 0; i
< nmaps
; i
++)
8766 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8768 return first_binding
;
8771 /* Structure used to keep track of partial application of key remapping
8772 such as Vfunction_key_map and Vkey_translation_map. */
8773 typedef struct keyremap
8775 /* This is the map originally specified for this use. */
8777 /* This is a submap reached by looking up, in PARENT,
8778 the events from START to END. */
8780 /* Positions [START, END) in the key sequence buffer
8781 are the key that we have scanned so far.
8782 Those events are the ones that we will replace
8783 if PAREHT maps them into a key sequence. */
8787 /* Lookup KEY in MAP.
8788 MAP is a keymap mapping keys to key vectors or functions.
8789 If the mapping is a function and DO_FUNCTION is non-zero, then
8790 the function is called with PROMPT as parameter and its return
8791 value is used as the return value of this function (after checking
8792 that it is indeed a vector). */
8795 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8800 next
= access_keymap (map
, key
, 1, 0, 1);
8802 /* Handle symbol with autoload definition. */
8803 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8804 && CONSP (XSYMBOL (next
)->function
)
8805 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8806 do_autoload (XSYMBOL (next
)->function
, next
);
8808 /* Handle a symbol whose function definition is a keymap
8810 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8811 && (ARRAYP (XSYMBOL (next
)->function
)
8812 || KEYMAPP (XSYMBOL (next
)->function
)))
8813 next
= XSYMBOL (next
)->function
;
8815 /* If the keymap gives a function, not an
8816 array, then call the function with one arg and use
8817 its value instead. */
8818 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8823 next
= call1 (next
, prompt
);
8824 /* If the function returned something invalid,
8825 barf--don't ignore it.
8826 (To ignore it safely, we would need to gcpro a bunch of
8827 other variables.) */
8828 if (! (VECTORP (next
) || STRINGP (next
)))
8829 error ("Function %s returns invalid key sequence",
8830 SSDATA (SYMBOL_NAME (tem
)));
8835 /* Do one step of the key remapping used for function-key-map and
8836 key-translation-map:
8837 KEYBUF is the buffer holding the input events.
8838 BUFSIZE is its maximum size.
8839 FKEY is a pointer to the keyremap structure to use.
8840 INPUT is the index of the last element in KEYBUF.
8841 DOIT if non-zero says that the remapping can actually take place.
8842 DIFF is used to return the number of keys added/removed by the remapping.
8843 PARENT is the root of the keymap.
8844 PROMPT is the prompt to use if the remapping happens through a function.
8845 The return value is non-zero if the remapping actually took place. */
8848 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8849 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8851 Lisp_Object next
, key
;
8853 key
= keybuf
[fkey
->end
++];
8855 if (KEYMAPP (fkey
->parent
))
8856 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8860 /* If keybuf[fkey->start..fkey->end] is bound in the
8861 map and we're in a position to do the key remapping, replace it with
8862 the binding and restart with fkey->start at the end. */
8863 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8865 int len
= XFASTINT (Flength (next
));
8868 *diff
= len
- (fkey
->end
- fkey
->start
);
8870 if (bufsize
- input
<= *diff
)
8871 error ("Key sequence too long");
8873 /* Shift the keys that follow fkey->end. */
8875 for (i
= fkey
->end
; i
< input
; i
++)
8876 keybuf
[i
+ *diff
] = keybuf
[i
];
8878 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8879 keybuf
[i
+ *diff
] = keybuf
[i
];
8880 /* Overwrite the old keys with the new ones. */
8881 for (i
= 0; i
< len
; i
++)
8882 keybuf
[fkey
->start
+ i
]
8883 = Faref (next
, make_number (i
));
8885 fkey
->start
= fkey
->end
+= *diff
;
8886 fkey
->map
= fkey
->parent
;
8891 fkey
->map
= get_keymap (next
, 0, 1);
8893 /* If we no longer have a bound suffix, try a new position for
8895 if (!CONSP (fkey
->map
))
8897 fkey
->end
= ++fkey
->start
;
8898 fkey
->map
= fkey
->parent
;
8903 /* Read a sequence of keys that ends with a non prefix character,
8904 storing it in KEYBUF, a buffer of size BUFSIZE.
8906 Return the length of the key sequence stored.
8907 Return -1 if the user rejected a command menu.
8909 Echo starting immediately unless `prompt' is 0.
8911 Where a key sequence ends depends on the currently active keymaps.
8912 These include any minor mode keymaps active in the current buffer,
8913 the current buffer's local map, and the global map.
8915 If a key sequence has no other bindings, we check Vfunction_key_map
8916 to see if some trailing subsequence might be the beginning of a
8917 function key's sequence. If so, we try to read the whole function
8918 key, and substitute its symbolic name into the key sequence.
8920 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8921 `double-' events into similar click events, if that would make them
8922 bound. We try to turn `triple-' events first into `double-' events,
8925 If we get a mouse click in a mode line, vertical divider, or other
8926 non-text area, we treat the click as if it were prefixed by the
8927 symbol denoting that area - `mode-line', `vertical-line', or
8930 If the sequence starts with a mouse click, we read the key sequence
8931 with respect to the buffer clicked on, not the current buffer.
8933 If the user switches frames in the midst of a key sequence, we put
8934 off the switch-frame event until later; the next call to
8935 read_char will return it.
8937 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8938 from the selected window's buffer. */
8941 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8942 int dont_downcase_last
, int can_return_switch_frame
,
8943 int fix_current_buffer
)
8945 Lisp_Object from_string
;
8946 int count
= SPECPDL_INDEX ();
8948 /* How many keys there are in the current key sequence. */
8951 /* The length of the echo buffer when we started reading, and
8952 the length of this_command_keys when we started reading. */
8953 int echo_start
IF_LINT (= 0);
8956 /* The number of keymaps we're scanning right now, and the number of
8957 keymaps we have allocated space for. */
8959 ptrdiff_t nmaps_allocated
= 0;
8961 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8962 the current keymaps. */
8963 Lisp_Object
*defs
= NULL
;
8965 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8966 in the current keymaps, or nil where it is not a prefix. */
8967 Lisp_Object
*submaps
= NULL
;
8969 /* The local map to start out with at start of key sequence. */
8970 Lisp_Object orig_local_map
;
8972 /* The map from the `keymap' property to start out with at start of
8974 Lisp_Object orig_keymap
;
8976 /* 1 if we have already considered switching to the local-map property
8977 of the place where a mouse click occurred. */
8978 int localized_local_map
= 0;
8980 /* The index in submaps[] of the first keymap that has a binding for
8981 this key sequence. In other words, the lowest i such that
8982 submaps[i] is non-nil. */
8983 ptrdiff_t first_binding
;
8984 /* Index of the first key that has no binding.
8985 It is useless to try fkey.start larger than that. */
8988 /* If t < mock_input, then KEYBUF[t] should be read as the next
8991 We use this to recover after recognizing a function key. Once we
8992 realize that a suffix of the current key sequence is actually a
8993 function key's escape sequence, we replace the suffix with the
8994 function key's binding from Vfunction_key_map. Now keybuf
8995 contains a new and different key sequence, so the echo area,
8996 this_command_keys, and the submaps and defs arrays are wrong. In
8997 this situation, we set mock_input to t, set t to 0, and jump to
8998 restart_sequence; the loop will read keys from keybuf up until
8999 mock_input, thus rebuilding the state; and then it will resume
9000 reading characters from the keyboard. */
9003 /* If the sequence is unbound in submaps[], then
9004 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9005 and fkey.map is its binding.
9007 These might be > t, indicating that all function key scanning
9008 should hold off until t reaches them. We do this when we've just
9009 recognized a function key, to avoid searching for the function
9010 key's again in Vfunction_key_map. */
9013 /* Likewise, for key_translation_map and input-decode-map. */
9014 keyremap keytran
, indec
;
9016 /* Non-zero if we are trying to map a key by changing an upper-case
9017 letter to lower case, or a shifted function key to an unshifted
9019 int shift_translated
= 0;
9021 /* If we receive a `switch-frame' or `select-window' event in the middle of
9022 a key sequence, we put it off for later.
9023 While we're reading, we keep the event here. */
9024 Lisp_Object delayed_switch_frame
;
9026 /* See the comment below... */
9027 #if defined (GOBBLE_FIRST_EVENT)
9028 Lisp_Object first_event
;
9031 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9032 int original_uppercase_position
= -1;
9034 /* Gets around Microsoft compiler limitations. */
9037 struct buffer
*starting_buffer
;
9039 /* List of events for which a fake prefix key has been generated. */
9040 Lisp_Object fake_prefixed_keys
= Qnil
;
9042 #if defined (GOBBLE_FIRST_EVENT)
9046 struct gcpro outer_gcpro1
;
9048 GCPRO1_VAR (fake_prefixed_keys
, outer_gcpro
);
9049 raw_keybuf_count
= 0;
9051 last_nonmenu_event
= Qnil
;
9053 delayed_switch_frame
= Qnil
;
9059 /* Install the string STR as the beginning of the string of
9060 echoing, so that it serves as a prompt for the next
9062 KVAR (current_kboard
, echo_string
) = prompt
;
9063 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9066 else if (cursor_in_echo_area
9067 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9068 && NILP (Fzerop (Vecho_keystrokes
)))
9069 /* This doesn't put in a dash if the echo buffer is empty, so
9070 you don't always see a dash hanging out in the minibuffer. */
9074 /* Record the initial state of the echo area and this_command_keys;
9075 we will need to restore them if we replay a key sequence. */
9077 echo_start
= echo_length ();
9078 keys_start
= this_command_key_count
;
9079 this_single_command_key_start
= keys_start
;
9081 #if defined (GOBBLE_FIRST_EVENT)
9082 /* This doesn't quite work, because some of the things that read_char
9083 does cannot safely be bypassed. It seems too risky to try to make
9086 /* Read the first char of the sequence specially, before setting
9087 up any keymaps, in case a filter runs and switches buffers on us. */
9088 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9090 #endif /* GOBBLE_FIRST_EVENT */
9092 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9093 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9096 /* We jump here when we need to reinitialize fkey and keytran; this
9097 happens if we switch keyboards between rescans. */
9098 replay_entire_sequence
:
9100 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9101 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9102 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9103 indec
.start
= indec
.end
= 0;
9104 fkey
.start
= fkey
.end
= 0;
9105 keytran
.start
= keytran
.end
= 0;
9107 /* We jump here when the key sequence has been thoroughly changed, and
9108 we need to rescan it starting from the beginning. When we jump here,
9109 keybuf[0..mock_input] holds the sequence we should reread. */
9112 starting_buffer
= current_buffer
;
9113 first_unbound
= bufsize
+ 1;
9115 /* Build our list of keymaps.
9116 If we recognize a function key and replace its escape sequence in
9117 keybuf with its symbol, or if the sequence starts with a mouse
9118 click and we need to switch buffers, we jump back here to rebuild
9119 the initial keymaps from the current buffer. */
9122 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9124 if (2 > nmaps_allocated
)
9126 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9127 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9128 nmaps_allocated
= 2;
9130 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9132 else if (!NILP (Voverriding_local_map
))
9134 if (2 > nmaps_allocated
)
9136 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9137 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9138 nmaps_allocated
= 2;
9140 submaps
[nmaps
++] = Voverriding_local_map
;
9148 nminor
= current_minor_maps (0, &maps
);
9149 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9151 if (total
> nmaps_allocated
)
9153 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9154 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9155 nmaps_allocated
= total
;
9158 if (!NILP (orig_keymap
))
9159 submaps
[nmaps
++] = orig_keymap
;
9161 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9165 submaps
[nmaps
++] = orig_local_map
;
9167 submaps
[nmaps
++] = current_global_map
;
9169 /* Find an accurate initial value for first_binding. */
9170 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9171 if (! NILP (submaps
[first_binding
]))
9174 /* Start from the beginning in keybuf. */
9177 /* These are no-ops the first time through, but if we restart, they
9178 revert the echo area and this_command_keys to their original state. */
9179 this_command_key_count
= keys_start
;
9180 if (INTERACTIVE
&& t
< mock_input
)
9181 echo_truncate (echo_start
);
9183 /* If the best binding for the current key sequence is a keymap, or
9184 we may be looking at a function key's escape sequence, keep on
9186 while (first_binding
< nmaps
9187 /* Keep reading as long as there's a prefix binding. */
9188 ? !NILP (submaps
[first_binding
])
9189 /* Don't return in the middle of a possible function key sequence,
9190 if the only bindings we found were via case conversion.
9191 Thus, if ESC O a has a function-key-map translation
9192 and ESC o has a binding, don't return after ESC O,
9193 so that we can translate ESC O plus the next character. */
9194 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9197 int used_mouse_menu
= 0;
9199 /* Where the last real key started. If we need to throw away a
9200 key that has expanded into more than one element of keybuf
9201 (say, a mouse click on the mode line which is being treated
9202 as [mode-line (mouse-...)], then we backtrack to this point
9204 int last_real_key_start
;
9206 /* These variables are analogous to echo_start and keys_start;
9207 while those allow us to restart the entire key sequence,
9208 echo_local_start and keys_local_start allow us to throw away
9210 int echo_local_start
IF_LINT (= 0);
9211 int keys_local_start
;
9212 ptrdiff_t local_first_binding
;
9214 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9215 eassert (indec
.start
<= indec
.end
);
9216 eassert (fkey
.start
<= fkey
.end
);
9217 eassert (keytran
.start
<= keytran
.end
);
9218 /* key-translation-map is applied *after* function-key-map
9219 which is itself applied *after* input-decode-map. */
9220 eassert (fkey
.end
<= indec
.start
);
9221 eassert (keytran
.end
<= fkey
.start
);
9223 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9224 first_unbound
< keytran
.start
)
9225 { /* The prefix upto first_unbound has no binding and has
9226 no translation left to do either, so we know it's unbound.
9227 If we don't stop now, we risk staying here indefinitely
9228 (if the user keeps entering fkey or keytran prefixes
9229 like C-c ESC ESC ESC ESC ...) */
9231 for (i
= first_unbound
+ 1; i
< t
; i
++)
9232 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9233 mock_input
= t
- first_unbound
- 1;
9234 indec
.end
= indec
.start
-= first_unbound
+ 1;
9235 indec
.map
= indec
.parent
;
9236 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9237 fkey
.map
= fkey
.parent
;
9238 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9239 keytran
.map
= keytran
.parent
;
9240 goto replay_sequence
;
9244 error ("Key sequence too long");
9247 echo_local_start
= echo_length ();
9248 keys_local_start
= this_command_key_count
;
9249 local_first_binding
= first_binding
;
9252 /* These are no-ops, unless we throw away a keystroke below and
9253 jumped back up to replay_key; in that case, these restore the
9254 variables to their original state, allowing us to replay the
9256 if (INTERACTIVE
&& t
< mock_input
)
9257 echo_truncate (echo_local_start
);
9258 this_command_key_count
= keys_local_start
;
9259 first_binding
= local_first_binding
;
9261 /* By default, assume each event is "real". */
9262 last_real_key_start
= t
;
9264 /* Does mock_input indicate that we are re-reading a key sequence? */
9268 add_command_key (key
);
9269 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9270 && NILP (Fzerop (Vecho_keystrokes
)))
9274 /* If not, we should actually read a character. */
9278 KBOARD
*interrupted_kboard
= current_kboard
;
9279 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9280 key
= read_char (NILP (prompt
), nmaps
,
9281 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9282 &used_mouse_menu
, NULL
);
9283 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9284 /* When switching to a new tty (with a new keyboard),
9285 read_char returns the new buffer, rather than -2
9286 (Bug#5095). This is because `terminal-init-xterm'
9287 calls read-char, which eats the wrong_kboard_jmpbuf
9288 return. Any better way to fix this? -- cyd */
9289 || (interrupted_kboard
!= current_kboard
))
9294 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9295 if (k
== interrupted_kboard
)
9300 /* Don't touch interrupted_kboard when it's been
9302 delayed_switch_frame
= Qnil
;
9303 goto replay_entire_sequence
;
9306 if (!NILP (delayed_switch_frame
))
9308 KVAR (interrupted_kboard
, kbd_queue
)
9309 = Fcons (delayed_switch_frame
,
9310 KVAR (interrupted_kboard
, kbd_queue
));
9311 delayed_switch_frame
= Qnil
;
9315 KVAR (interrupted_kboard
, kbd_queue
)
9316 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9318 /* If the side queue is non-empty, ensure it begins with a
9319 switch-frame, so we'll replay it in the right context. */
9320 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9321 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9322 !(EVENT_HAS_PARAMETERS (key
)
9323 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9327 XSETFRAME (frame
, interrupted_frame
);
9328 KVAR (interrupted_kboard
, kbd_queue
)
9329 = Fcons (make_lispy_switch_frame (frame
),
9330 KVAR (interrupted_kboard
, kbd_queue
));
9333 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9334 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9335 goto replay_entire_sequence
;
9339 /* read_char returns t when it shows a menu and the user rejects it.
9343 unbind_to (count
, Qnil
);
9344 UNGCPRO_VAR (outer_gcpro
);
9348 /* read_char returns -1 at the end of a macro.
9349 Emacs 18 handles this by returning immediately with a
9350 zero, so that's what we'll do. */
9351 if (INTEGERP (key
) && XINT (key
) == -1)
9354 /* The Microsoft C compiler can't handle the goto that
9360 /* If the current buffer has been changed from under us, the
9361 keymap may have changed, so replay the sequence. */
9364 timer_resume_idle ();
9367 /* Reset the current buffer from the selected window
9368 in case something changed the former and not the latter.
9369 This is to be more consistent with the behavior
9370 of the command_loop_1. */
9371 if (fix_current_buffer
)
9373 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9375 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9376 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9379 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9380 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9381 goto replay_sequence
;
9384 /* If we have a quit that was typed in another frame, and
9385 quit_throw_to_read_char switched buffers,
9386 replay to get the right keymap. */
9388 && XINT (key
) == quit_char
9389 && current_buffer
!= starting_buffer
)
9392 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9396 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9397 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9398 goto replay_sequence
;
9403 if (EVENT_HAS_PARAMETERS (key
)
9404 /* Either a `switch-frame' or a `select-window' event. */
9405 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9407 /* If we're at the beginning of a key sequence, and the caller
9408 says it's okay, go ahead and return this event. If we're
9409 in the midst of a key sequence, delay it until the end. */
9410 if (t
> 0 || !can_return_switch_frame
)
9412 delayed_switch_frame
= key
;
9418 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9422 /* Clicks in non-text areas get prefixed by the symbol
9423 in their CHAR-ADDRESS field. For example, a click on
9424 the mode line is prefixed by the symbol `mode-line'.
9426 Furthermore, key sequences beginning with mouse clicks
9427 are read using the keymaps of the buffer clicked on, not
9428 the current buffer. So we may have to switch the buffer
9431 When we turn one event into two events, we must make sure
9432 that neither of the two looks like the original--so that,
9433 if we replay the events, they won't be expanded again.
9434 If not for this, such reexpansion could happen either here
9435 or when user programs play with this-command-keys. */
9436 if (EVENT_HAS_PARAMETERS (key
))
9441 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9442 if (EQ (kind
, Qmouse_click
))
9444 Lisp_Object window
, posn
;
9446 window
= POSN_WINDOW (EVENT_START (key
));
9447 posn
= POSN_POSN (EVENT_START (key
));
9450 || (!NILP (fake_prefixed_keys
)
9451 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9453 /* We're looking a second time at an event for which
9454 we generated a fake prefix key. Set
9455 last_real_key_start appropriately. */
9457 last_real_key_start
= t
- 1;
9460 if (last_real_key_start
== 0)
9462 /* Key sequences beginning with mouse clicks are
9463 read using the keymaps in the buffer clicked on,
9464 not the current buffer. If we're at the
9465 beginning of a key sequence, switch buffers. */
9466 if (WINDOWP (window
)
9467 && BUFFERP (XWINDOW (window
)->buffer
)
9468 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9470 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9474 /* Arrange to go back to the original buffer once we're
9475 done reading the key sequence. Note that we can't
9476 use save_excursion_{save,restore} here, because they
9477 save point as well as the current buffer; we don't
9478 want to save point, because redisplay may change it,
9479 to accommodate a Fset_window_start or something. We
9480 don't want to do this at the top of the function,
9481 because we may get input from a subprocess which
9482 wants to change the selected window and stuff (say,
9484 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9486 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9488 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9489 orig_local_map
= get_local_map (PT
, current_buffer
,
9491 orig_keymap
= get_local_map (PT
, current_buffer
,
9493 goto replay_sequence
;
9496 /* For a mouse click, get the local text-property keymap
9497 of the place clicked on, rather than point. */
9498 if (CONSP (XCDR (key
))
9499 && ! localized_local_map
)
9501 Lisp_Object map_here
, start
, pos
;
9503 localized_local_map
= 1;
9504 start
= EVENT_START (key
);
9506 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9508 pos
= POSN_BUFFER_POSN (start
);
9510 && XINT (pos
) >= BEGV
9511 && XINT (pos
) <= ZV
)
9513 map_here
= get_local_map (XINT (pos
),
9516 if (!EQ (map_here
, orig_local_map
))
9518 orig_local_map
= map_here
;
9519 ++localized_local_map
;
9522 map_here
= get_local_map (XINT (pos
),
9525 if (!EQ (map_here
, orig_keymap
))
9527 orig_keymap
= map_here
;
9528 ++localized_local_map
;
9531 if (localized_local_map
> 1)
9536 goto replay_sequence
;
9543 /* Expand mode-line and scroll-bar events into two events:
9544 use posn as a fake prefix key. */
9546 && (NILP (fake_prefixed_keys
)
9547 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9549 if (bufsize
- t
<= 1)
9550 error ("Key sequence too long");
9553 keybuf
[t
+ 1] = key
;
9556 /* Record that a fake prefix key has been generated
9557 for KEY. Don't modify the event; this would
9558 prevent proper action when the event is pushed
9559 back into unread-command-events. */
9560 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9562 /* If on a mode line string with a local keymap,
9563 reconsider the key sequence with that keymap. */
9564 if (string
= POSN_STRING (EVENT_START (key
)),
9565 (CONSP (string
) && STRINGP (XCAR (string
))))
9567 Lisp_Object pos
, map
, map2
;
9569 pos
= XCDR (string
);
9570 string
= XCAR (string
);
9572 && XINT (pos
) < SCHARS (string
))
9574 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9576 orig_local_map
= map
;
9577 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9580 if (!NILP (map
) || !NILP (map2
))
9581 goto replay_sequence
;
9587 else if (NILP (from_string
)
9588 && (string
= POSN_STRING (EVENT_START (key
)),
9589 (CONSP (string
) && STRINGP (XCAR (string
)))))
9591 /* For a click on a string, i.e. overlay string or a
9592 string displayed via the `display' property,
9593 consider `local-map' and `keymap' properties of
9595 Lisp_Object pos
, map
, map2
;
9597 pos
= XCDR (string
);
9598 string
= XCAR (string
);
9600 && XINT (pos
) < SCHARS (string
))
9602 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9604 orig_local_map
= map
;
9605 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9609 if (!NILP (map
) || !NILP (map2
))
9611 from_string
= string
;
9614 goto replay_sequence
;
9619 else if (CONSP (XCDR (key
))
9620 && CONSP (EVENT_START (key
))
9621 && CONSP (XCDR (EVENT_START (key
))))
9625 posn
= POSN_POSN (EVENT_START (key
));
9626 /* Handle menu-bar events:
9627 insert the dummy prefix event `menu-bar'. */
9628 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9630 if (bufsize
- t
<= 1)
9631 error ("Key sequence too long");
9635 /* Zap the position in key, so we know that we've
9636 expanded it, and don't try to do so again. */
9637 POSN_SET_POSN (EVENT_START (key
),
9638 Fcons (posn
, Qnil
));
9641 goto replay_sequence
;
9643 else if (CONSP (posn
))
9645 /* We're looking at the second event of a
9646 sequence which we expanded before. Set
9647 last_real_key_start appropriately. */
9648 if (last_real_key_start
== t
&& t
> 0)
9649 last_real_key_start
= t
- 1;
9654 /* We have finally decided that KEY is something we might want
9656 first_binding
= (follow_key (key
,
9657 nmaps
- first_binding
,
9658 submaps
+ first_binding
,
9659 defs
+ first_binding
,
9660 submaps
+ first_binding
)
9663 /* If KEY wasn't bound, we'll try some fallbacks. */
9664 if (first_binding
< nmaps
)
9665 /* This is needed for the following scenario:
9666 event 0: a down-event that gets dropped by calling replay_key.
9667 event 1: some normal prefix like C-h.
9668 After event 0, first_unbound is 0, after event 1 indec.start,
9669 fkey.start, and keytran.start are all 1, so when we see that
9670 C-h is bound, we need to update first_unbound. */
9671 first_unbound
= max (t
+ 1, first_unbound
);
9676 /* Remember the position to put an upper bound on indec.start. */
9677 first_unbound
= min (t
, first_unbound
);
9679 head
= EVENT_HEAD (key
);
9680 if (help_char_p (head
) && t
> 0)
9682 read_key_sequence_cmd
= Vprefix_help_command
;
9684 last_nonmenu_event
= key
;
9685 /* The Microsoft C compiler can't handle the goto that
9693 Lisp_Object breakdown
;
9696 breakdown
= parse_modifiers (head
);
9697 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9698 /* Attempt to reduce an unbound mouse event to a simpler
9699 event that is bound:
9700 Drags reduce to clicks.
9701 Double-clicks reduce to clicks.
9702 Triple-clicks reduce to double-clicks, then to clicks.
9703 Down-clicks are eliminated.
9704 Double-downs reduce to downs, then are eliminated.
9705 Triple-downs reduce to double-downs, then to downs,
9706 then are eliminated. */
9707 if (modifiers
& (down_modifier
| drag_modifier
9708 | double_modifier
| triple_modifier
))
9710 while (modifiers
& (down_modifier
| drag_modifier
9711 | double_modifier
| triple_modifier
))
9713 Lisp_Object new_head
, new_click
;
9714 if (modifiers
& triple_modifier
)
9715 modifiers
^= (double_modifier
| triple_modifier
);
9716 else if (modifiers
& double_modifier
)
9717 modifiers
&= ~double_modifier
;
9718 else if (modifiers
& drag_modifier
)
9719 modifiers
&= ~drag_modifier
;
9722 /* Dispose of this `down' event by simply jumping
9723 back to replay_key, to get another event.
9725 Note that if this event came from mock input,
9726 then just jumping back to replay_key will just
9727 hand it to us again. So we have to wipe out any
9730 We could delete keybuf[t] and shift everything
9731 after that to the left by one spot, but we'd also
9732 have to fix up any variable that points into
9733 keybuf, and shifting isn't really necessary
9736 Adding prefixes for non-textual mouse clicks
9737 creates two characters of mock input, and both
9738 must be thrown away. If we're only looking at
9739 the prefix now, we can just jump back to
9740 replay_key. On the other hand, if we've already
9741 processed the prefix, and now the actual click
9742 itself is giving us trouble, then we've lost the
9743 state of the keymaps we want to backtrack to, and
9744 we need to replay the whole sequence to rebuild
9747 Beyond that, only function key expansion could
9748 create more than two keys, but that should never
9749 generate mouse events, so it's okay to zero
9750 mock_input in that case too.
9752 FIXME: The above paragraph seems just plain
9753 wrong, if you consider things like
9754 xterm-mouse-mode. -stef
9756 Isn't this just the most wonderful code ever? */
9758 /* If mock_input > t + 1, the above simplification
9759 will actually end up dropping keys on the floor.
9760 This is probably OK for now, but even
9761 if mock_input <= t + 1, we need to adjust indec,
9763 Typical case [header-line down-mouse-N]:
9764 mock_input = 2, t = 1, fkey.end = 1,
9765 last_real_key_start = 0. */
9766 if (indec
.end
> last_real_key_start
)
9768 indec
.end
= indec
.start
9769 = min (last_real_key_start
, indec
.start
);
9770 indec
.map
= indec
.parent
;
9771 if (fkey
.end
> last_real_key_start
)
9773 fkey
.end
= fkey
.start
9774 = min (last_real_key_start
, fkey
.start
);
9775 fkey
.map
= fkey
.parent
;
9776 if (keytran
.end
> last_real_key_start
)
9778 keytran
.end
= keytran
.start
9779 = min (last_real_key_start
, keytran
.start
);
9780 keytran
.map
= keytran
.parent
;
9784 if (t
== last_real_key_start
)
9791 mock_input
= last_real_key_start
;
9792 goto replay_sequence
;
9797 = apply_modifiers (modifiers
, XCAR (breakdown
));
9799 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9801 /* Look for a binding for this new key. follow_key
9802 promises that it didn't munge submaps the
9803 last time we called it, since key was unbound. */
9805 = (follow_key (new_click
,
9806 nmaps
- local_first_binding
,
9807 submaps
+ local_first_binding
,
9808 defs
+ local_first_binding
,
9809 submaps
+ local_first_binding
)
9810 + local_first_binding
);
9812 /* If that click is bound, go for it. */
9813 if (first_binding
< nmaps
)
9818 /* Otherwise, we'll leave key set to the drag event. */
9825 /* Normally, last_nonmenu_event gets the previous key we read.
9826 But when a mouse popup menu is being used,
9827 we don't update last_nonmenu_event; it continues to hold the mouse
9828 event that preceded the first level of menu. */
9829 if (!used_mouse_menu
)
9830 last_nonmenu_event
= key
;
9832 /* Record what part of this_command_keys is the current key sequence. */
9833 this_single_command_key_start
= this_command_key_count
- t
;
9835 /* Look for this sequence in input-decode-map.
9836 Scan from indec.end until we find a bound suffix. */
9837 while (indec
.end
< t
)
9839 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9842 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9843 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9848 mock_input
= diff
+ max (t
, mock_input
);
9849 goto replay_sequence
;
9853 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9854 && indec
.start
>= t
)
9855 /* There is a binding and it's not a prefix.
9856 (and it doesn't have any input-decode-map translation pending).
9857 There is thus no function-key in this sequence.
9858 Moving fkey.start is important in this case to allow keytran.start
9859 to go over the sequence before we return (since we keep the
9860 invariant that keytran.end <= fkey.start). */
9863 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9866 /* If the sequence is unbound, see if we can hang a function key
9867 off the end of it. */
9868 /* Continue scan from fkey.end until we find a bound suffix. */
9869 while (fkey
.end
< indec
.start
)
9871 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9874 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9875 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9876 max (t
, mock_input
),
9877 /* If there's a binding (i.e.
9878 first_binding >= nmaps) we don't want
9879 to apply this function-key-mapping. */
9880 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9885 mock_input
= diff
+ max (t
, mock_input
);
9886 /* Adjust the input-decode-map counters. */
9888 indec
.start
+= diff
;
9890 goto replay_sequence
;
9894 /* Look for this sequence in key-translation-map.
9895 Scan from keytran.end until we find a bound suffix. */
9896 while (keytran
.end
< fkey
.start
)
9898 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9901 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9902 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9907 mock_input
= diff
+ max (t
, mock_input
);
9908 /* Adjust the function-key-map and input-decode-map counters. */
9910 indec
.start
+= diff
;
9914 goto replay_sequence
;
9918 /* If KEY is not defined in any of the keymaps,
9919 and cannot be part of a function key or translation,
9920 and is an upper case letter
9921 use the corresponding lower-case letter instead. */
9922 if (first_binding
>= nmaps
9923 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9925 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9926 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9927 || (XINT (key
) & shift_modifier
)))
9929 Lisp_Object new_key
;
9931 original_uppercase
= key
;
9932 original_uppercase_position
= t
- 1;
9934 if (XINT (key
) & shift_modifier
)
9935 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9937 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9938 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9940 /* We have to do this unconditionally, regardless of whether
9941 the lower-case char is defined in the keymaps, because they
9942 might get translated through function-key-map. */
9943 keybuf
[t
- 1] = new_key
;
9944 mock_input
= max (t
, mock_input
);
9945 shift_translated
= 1;
9947 goto replay_sequence
;
9949 /* If KEY is not defined in any of the keymaps,
9950 and cannot be part of a function key or translation,
9951 and is a shifted function key,
9952 use the corresponding unshifted function key instead. */
9953 if (first_binding
>= nmaps
9954 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9956 Lisp_Object breakdown
= parse_modifiers (key
);
9958 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9960 if (modifiers
& shift_modifier
9961 /* Treat uppercase keys as shifted. */
9963 && (KEY_TO_CHAR (key
)
9964 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9965 && uppercasep (KEY_TO_CHAR (key
))))
9968 = (modifiers
& shift_modifier
9969 ? apply_modifiers (modifiers
& ~shift_modifier
,
9971 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9973 original_uppercase
= key
;
9974 original_uppercase_position
= t
- 1;
9976 /* We have to do this unconditionally, regardless of whether
9977 the lower-case char is defined in the keymaps, because they
9978 might get translated through function-key-map. */
9979 keybuf
[t
- 1] = new_key
;
9980 mock_input
= max (t
, mock_input
);
9981 /* Reset fkey (and consequently keytran) to apply
9982 function-key-map on the result, so that S-backspace is
9983 correctly mapped to DEL (via backspace). OTOH,
9984 input-decode-map doesn't need to go through it again. */
9985 fkey
.start
= fkey
.end
= 0;
9986 keytran
.start
= keytran
.end
= 0;
9987 shift_translated
= 1;
9989 goto replay_sequence
;
9994 read_key_sequence_cmd
= (first_binding
< nmaps
9995 ? defs
[first_binding
]
9998 unread_switch_frame
= delayed_switch_frame
;
9999 unbind_to (count
, Qnil
);
10001 /* Don't downcase the last character if the caller says don't.
10002 Don't downcase it if the result is undefined, either. */
10003 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10005 && t
- 1 == original_uppercase_position
)
10007 keybuf
[t
- 1] = original_uppercase
;
10008 shift_translated
= 0;
10011 if (shift_translated
)
10012 Vthis_command_keys_shift_translated
= Qt
;
10014 /* Occasionally we fabricate events, perhaps by expanding something
10015 according to function-key-map, or by adding a prefix symbol to a
10016 mouse click in the scroll bar or modeline. In this cases, return
10017 the entire generated key sequence, even if we hit an unbound
10018 prefix or a definition before the end. This means that you will
10019 be able to push back the event properly, and also means that
10020 read-key-sequence will always return a logical unit.
10023 for (; t
< mock_input
; t
++)
10025 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10026 && NILP (Fzerop (Vecho_keystrokes
)))
10027 echo_char (keybuf
[t
]);
10028 add_command_key (keybuf
[t
]);
10031 UNGCPRO_VAR (outer_gcpro
);
10035 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10036 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10037 The sequence is sufficient to specify a non-prefix command in the
10038 current local and global maps.
10040 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10041 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10042 as a continuation of the previous key.
10044 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10045 convert the last event to lower case. (Normally any upper case event
10046 is converted to lower case if the original event is undefined and the lower
10047 case equivalent is defined.) A non-nil value is appropriate for reading
10048 a key sequence to be defined.
10050 A C-g typed while in this function is treated like any other character,
10051 and `quit-flag' is not set.
10053 If the key sequence starts with a mouse click, then the sequence is read
10054 using the keymaps of the buffer of the window clicked in, not the buffer
10055 of the selected window as normal.
10057 `read-key-sequence' drops unbound button-down events, since you normally
10058 only care about the click or drag events which follow them. If a drag
10059 or multi-click event is unbound, but the corresponding click event would
10060 be bound, `read-key-sequence' turns the event into a click event at the
10061 drag's starting position. This means that you don't have to distinguish
10062 between click and drag, double, or triple events unless you want to.
10064 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10065 lines separating windows, and scroll bars with imaginary keys
10066 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10068 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10069 function will process a switch-frame event if the user switches frames
10070 before typing anything. If the user switches frames in the middle of a
10071 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10072 is nil, then the event will be put off until after the current key sequence.
10074 `read-key-sequence' checks `function-key-map' for function key
10075 sequences, where they wouldn't conflict with ordinary bindings. See
10076 `function-key-map' for more details.
10078 The optional fifth argument CMD-LOOP, if non-nil, means
10079 that this key sequence is being read by something that will
10080 read commands one after another. It should be nil if the caller
10081 will read just one key sequence. */)
10082 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10084 Lisp_Object keybuf
[30];
10086 struct gcpro gcpro1
;
10087 int count
= SPECPDL_INDEX ();
10089 if (!NILP (prompt
))
10090 CHECK_STRING (prompt
);
10093 specbind (Qinput_method_exit_on_first_char
,
10094 (NILP (cmd_loop
) ? Qt
: Qnil
));
10095 specbind (Qinput_method_use_echo_area
,
10096 (NILP (cmd_loop
) ? Qt
: Qnil
));
10098 memset (keybuf
, 0, sizeof keybuf
);
10099 GCPRO1 (keybuf
[0]);
10100 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10102 if (NILP (continue_echo
))
10104 this_command_key_count
= 0;
10105 this_command_key_count_reset
= 0;
10106 this_single_command_key_start
= 0;
10109 #ifdef HAVE_WINDOW_SYSTEM
10110 if (display_hourglass_p
)
10111 cancel_hourglass ();
10114 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10115 prompt
, ! NILP (dont_downcase_last
),
10116 ! NILP (can_return_switch_frame
), 0);
10118 #if 0 /* The following is fine for code reading a key sequence and
10119 then proceeding with a lenghty computation, but it's not good
10120 for code reading keys in a loop, like an input method. */
10121 #ifdef HAVE_WINDOW_SYSTEM
10122 if (display_hourglass_p
)
10123 start_hourglass ();
10133 return unbind_to (count
, make_event_array (i
, keybuf
));
10136 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10137 Sread_key_sequence_vector
, 1, 5, 0,
10138 doc
: /* Like `read-key-sequence' but always return a vector. */)
10139 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10141 Lisp_Object keybuf
[30];
10143 struct gcpro gcpro1
;
10144 int count
= SPECPDL_INDEX ();
10146 if (!NILP (prompt
))
10147 CHECK_STRING (prompt
);
10150 specbind (Qinput_method_exit_on_first_char
,
10151 (NILP (cmd_loop
) ? Qt
: Qnil
));
10152 specbind (Qinput_method_use_echo_area
,
10153 (NILP (cmd_loop
) ? Qt
: Qnil
));
10155 memset (keybuf
, 0, sizeof keybuf
);
10156 GCPRO1 (keybuf
[0]);
10157 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10159 if (NILP (continue_echo
))
10161 this_command_key_count
= 0;
10162 this_command_key_count_reset
= 0;
10163 this_single_command_key_start
= 0;
10166 #ifdef HAVE_WINDOW_SYSTEM
10167 if (display_hourglass_p
)
10168 cancel_hourglass ();
10171 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10172 prompt
, ! NILP (dont_downcase_last
),
10173 ! NILP (can_return_switch_frame
), 0);
10175 #ifdef HAVE_WINDOW_SYSTEM
10176 if (display_hourglass_p
)
10177 start_hourglass ();
10186 return unbind_to (count
, Fvector (i
, keybuf
));
10189 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10190 doc
: /* Execute CMD as an editor command.
10191 CMD must be a symbol that satisfies the `commandp' predicate.
10192 Optional second arg RECORD-FLAG non-nil
10193 means unconditionally put this command in `command-history'.
10194 Otherwise, that is done only if an arg is read using the minibuffer.
10195 The argument KEYS specifies the value to use instead of (this-command-keys)
10196 when reading the arguments; if it is nil, (this-command-keys) is used.
10197 The argument SPECIAL, if non-nil, means that this command is executing
10198 a special event, so ignore the prefix argument and don't clear it. */)
10199 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10201 register Lisp_Object final
;
10202 register Lisp_Object tem
;
10203 Lisp_Object prefixarg
;
10205 debug_on_next_call
= 0;
10207 if (NILP (special
))
10209 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10210 Vcurrent_prefix_arg
= prefixarg
;
10211 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10218 tem
= Fget (cmd
, Qdisabled
);
10221 tem
= Fsymbol_value (Qdisabled_command_function
);
10223 return Frun_hooks (1, &Qdisabled_command_function
);
10229 final
= Findirect_function (cmd
, Qnil
);
10231 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10233 struct gcpro gcpro1
, gcpro2
;
10235 GCPRO2 (cmd
, prefixarg
);
10236 do_autoload (final
, cmd
);
10243 if (STRINGP (final
) || VECTORP (final
))
10245 /* If requested, place the macro in the command history. For
10246 other sorts of commands, call-interactively takes care of
10248 if (!NILP (record_flag
))
10251 = Fcons (Fcons (Qexecute_kbd_macro
,
10252 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10255 /* Don't keep command history around forever. */
10256 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10258 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10260 XSETCDR (tem
, Qnil
);
10264 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10267 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10268 /* Don't call Fcall_interactively directly because we want to make
10269 sure the backtrace has an entry for `call-interactively'.
10270 For the same reason, pass `cmd' rather than `final'. */
10271 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10278 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10280 doc
: /* Read function name, then read its arguments and call it.
10282 To pass a numeric argument to the command you are invoking with, specify
10283 the numeric argument to this command.
10285 Noninteractively, the argument PREFIXARG is the prefix argument to
10286 give to the command you invoke, if it asks for an argument. */)
10287 (Lisp_Object prefixarg
)
10289 Lisp_Object function
;
10290 EMACS_INT saved_last_point_position
;
10291 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10292 Lisp_Object bindings
, value
;
10293 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10294 #ifdef HAVE_WINDOW_SYSTEM
10295 /* The call to Fcompleting_read will start and cancel the hourglass,
10296 but if the hourglass was already scheduled, this means that no
10297 hourglass will be shown for the actual M-x command itself.
10298 So we restart it if it is already scheduled. Note that checking
10299 hourglass_shown_p is not enough, normally the hourglass is not shown,
10300 just scheduled to be shown. */
10301 int hstarted
= hourglass_started ();
10304 saved_keys
= Fvector (this_command_key_count
,
10305 XVECTOR (this_command_keys
)->contents
);
10306 saved_last_point_position_buffer
= last_point_position_buffer
;
10307 saved_last_point_position
= last_point_position
;
10308 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10310 function
= call0 (intern ("read-extended-command"));
10312 #ifdef HAVE_WINDOW_SYSTEM
10313 if (hstarted
) start_hourglass ();
10316 if (STRINGP (function
) && SCHARS (function
) == 0)
10317 error ("No command name given");
10319 /* Set this_command_keys to the concatenation of saved_keys and
10320 function, followed by a RET. */
10325 this_command_key_count
= 0;
10326 this_command_key_count_reset
= 0;
10327 this_single_command_key_start
= 0;
10329 keys
= XVECTOR (saved_keys
)->contents
;
10330 for (i
= 0; i
< ASIZE (saved_keys
); i
++)
10331 add_command_key (keys
[i
]);
10333 for (i
= 0; i
< SCHARS (function
); i
++)
10334 add_command_key (Faref (function
, make_number (i
)));
10336 add_command_key (make_number ('\015'));
10339 last_point_position
= saved_last_point_position
;
10340 last_point_position_buffer
= saved_last_point_position_buffer
;
10344 function
= Fintern (function
, Qnil
);
10345 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10346 Vthis_command
= function
;
10347 real_this_command
= function
;
10349 /* If enabled, show which key runs this command. */
10350 if (!NILP (Vsuggest_key_bindings
)
10351 && NILP (Vexecuting_kbd_macro
)
10352 && SYMBOLP (function
))
10353 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10359 GCPRO3 (bindings
, value
, function
);
10360 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10362 /* If the command has a key binding, print it now. */
10363 if (!NILP (bindings
)
10364 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10367 /* But first wait, and skip the message if there is input. */
10368 Lisp_Object waited
;
10370 /* If this command displayed something in the echo area;
10371 wait a few seconds, then display our suggestion message. */
10372 if (NILP (echo_area_buffer
[0]))
10373 waited
= sit_for (make_number (0), 0, 2);
10374 else if (NUMBERP (Vsuggest_key_bindings
))
10375 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10377 waited
= sit_for (make_number (2), 0, 2);
10379 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10381 Lisp_Object binding
;
10383 int message_p
= push_message ();
10384 int count
= SPECPDL_INDEX ();
10386 record_unwind_protect (pop_message_unwind
, Qnil
);
10387 binding
= Fkey_description (bindings
, Qnil
);
10390 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10393 sprintf (newmessage
, "You can run the command `%s' with %s",
10394 SDATA (SYMBOL_NAME (function
)),
10396 message2 (newmessage
,
10397 strlen (newmessage
),
10398 STRING_MULTIBYTE (binding
));
10399 if (NUMBERP (Vsuggest_key_bindings
))
10400 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10402 waited
= sit_for (make_number (2), 0, 2);
10404 if (!NILP (waited
) && message_p
)
10405 restore_message ();
10407 unbind_to (count
, Qnil
);
10411 RETURN_UNGCPRO (value
);
10415 /* Return nonzero if input events are pending. */
10418 detect_input_pending (void)
10420 if (!input_pending
)
10421 get_input_pending (&input_pending
, 0);
10423 return input_pending
;
10426 /* Return nonzero if input events other than mouse movements are
10430 detect_input_pending_ignore_squeezables (void)
10432 if (!input_pending
)
10433 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10435 return input_pending
;
10438 /* Return nonzero if input events are pending, and run any pending timers. */
10441 detect_input_pending_run_timers (int do_display
)
10443 int old_timers_run
= timers_run
;
10445 if (!input_pending
)
10446 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10448 if (old_timers_run
!= timers_run
&& do_display
)
10450 redisplay_preserve_echo_area (8);
10451 /* The following fixes a bug when using lazy-lock with
10452 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10453 from an idle timer function. The symptom of the bug is that
10454 the cursor sometimes doesn't become visible until the next X
10455 event is processed. --gerd. */
10457 Lisp_Object tail
, frame
;
10458 FOR_EACH_FRAME (tail
, frame
)
10459 if (FRAME_RIF (XFRAME (frame
)))
10460 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10464 return input_pending
;
10467 /* This is called in some cases before a possible quit.
10468 It cases the next call to detect_input_pending to recompute input_pending.
10469 So calling this function unnecessarily can't do any harm. */
10472 clear_input_pending (void)
10477 /* Return nonzero if there are pending requeued events.
10478 This isn't used yet. The hope is to make wait_reading_process_output
10479 call it, and return if it runs Lisp code that unreads something.
10480 The problem is, kbd_buffer_get_event needs to be fixed to know what
10481 to do in that case. It isn't trivial. */
10484 requeued_events_pending_p (void)
10486 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10490 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10491 doc
: /* Return t if command input is currently available with no wait.
10492 Actually, the value is nil only if we can be sure that no input is available;
10493 if there is a doubt, the value is t. */)
10496 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10497 || !NILP (Vunread_post_input_method_events
)
10498 || !NILP (Vunread_input_method_events
))
10501 get_input_pending (&input_pending
,
10502 READABLE_EVENTS_DO_TIMERS_NOW
10503 | READABLE_EVENTS_FILTER_EVENTS
);
10504 return input_pending
> 0 ? Qt
: Qnil
;
10507 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10508 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10511 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10514 if (total_keys
< NUM_RECENT_KEYS
)
10515 return Fvector (total_keys
, keys
);
10518 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10519 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10520 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10521 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10522 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10527 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10528 doc
: /* Return the key sequence that invoked this command.
10529 However, if the command has called `read-key-sequence', it returns
10530 the last key sequence that has been read.
10531 The value is a string or a vector.
10533 See also `this-command-keys-vector'. */)
10536 return make_event_array (this_command_key_count
,
10537 XVECTOR (this_command_keys
)->contents
);
10540 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10541 doc
: /* Return the key sequence that invoked this command, as a vector.
10542 However, if the command has called `read-key-sequence', it returns
10543 the last key sequence that has been read.
10545 See also `this-command-keys'. */)
10548 return Fvector (this_command_key_count
,
10549 XVECTOR (this_command_keys
)->contents
);
10552 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10553 Sthis_single_command_keys
, 0, 0, 0,
10554 doc
: /* Return the key sequence that invoked this command.
10555 More generally, it returns the last key sequence read, either by
10556 the command loop or by `read-key-sequence'.
10557 Unlike `this-command-keys', this function's value
10558 does not include prefix arguments.
10559 The value is always a vector. */)
10562 return Fvector (this_command_key_count
10563 - this_single_command_key_start
,
10564 (XVECTOR (this_command_keys
)->contents
10565 + this_single_command_key_start
));
10568 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10569 Sthis_single_command_raw_keys
, 0, 0, 0,
10570 doc
: /* Return the raw events that were read for this command.
10571 More generally, it returns the last key sequence read, either by
10572 the command loop or by `read-key-sequence'.
10573 Unlike `this-single-command-keys', this function's value
10574 shows the events before all translations (except for input methods).
10575 The value is always a vector. */)
10578 return Fvector (raw_keybuf_count
,
10579 (XVECTOR (raw_keybuf
)->contents
));
10582 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10583 Sreset_this_command_lengths
, 0, 0, 0,
10584 doc
: /* Make the unread events replace the last command and echo.
10585 Used in `universal-argument-other-key'.
10587 `universal-argument-other-key' rereads the event just typed.
10588 It then gets translated through `function-key-map'.
10589 The translated event has to replace the real events,
10590 both in the value of (this-command-keys) and in echoing.
10591 To achieve this, `universal-argument-other-key' calls
10592 `reset-this-command-lengths', which discards the record of reading
10593 these events the first time. */)
10596 this_command_key_count
= before_command_key_count
;
10597 if (this_command_key_count
< this_single_command_key_start
)
10598 this_single_command_key_start
= this_command_key_count
;
10600 echo_truncate (before_command_echo_length
);
10602 /* Cause whatever we put into unread-command-events
10603 to echo as if it were being freshly read from the keyboard. */
10604 this_command_key_count_reset
= 1;
10609 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10610 Sclear_this_command_keys
, 0, 1, 0,
10611 doc
: /* Clear out the vector that `this-command-keys' returns.
10612 Also clear the record of the last 100 events, unless optional arg
10613 KEEP-RECORD is non-nil. */)
10614 (Lisp_Object keep_record
)
10618 this_command_key_count
= 0;
10619 this_command_key_count_reset
= 0;
10621 if (NILP (keep_record
))
10623 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10624 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10626 recent_keys_index
= 0;
10631 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10632 doc
: /* Return the current depth in recursive edits. */)
10636 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10640 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10641 "FOpen dribble file: ",
10642 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10643 If FILE is nil, close any open dribble file.
10644 The file will be closed when Emacs exits. */)
10656 file
= Fexpand_file_name (file
, Qnil
);
10657 dribble
= fopen (SSDATA (file
), "w");
10659 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10664 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10665 doc
: /* Discard the contents of the terminal input buffer.
10666 Also end any kbd macro being defined. */)
10669 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10671 /* Discard the last command from the macro. */
10672 Fcancel_kbd_macro_events ();
10676 update_mode_lines
++;
10678 Vunread_command_events
= Qnil
;
10679 unread_command_char
= -1;
10681 discard_tty_input ();
10683 kbd_fetch_ptr
= kbd_store_ptr
;
10689 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10690 doc
: /* Stop Emacs and return to superior process. You can resume later.
10691 If `cannot-suspend' is non-nil, or if the system doesn't support job
10692 control, run a subshell instead.
10694 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10695 to be read as terminal input by Emacs's parent, after suspension.
10697 Before suspending, run the normal hook `suspend-hook'.
10698 After resumption run the normal hook `suspend-resume-hook'.
10700 Some operating systems cannot stop the Emacs process and resume it later.
10701 On such systems, Emacs starts a subshell instead of suspending. */)
10702 (Lisp_Object stuffstring
)
10704 int count
= SPECPDL_INDEX ();
10705 int old_height
, old_width
;
10707 struct gcpro gcpro1
;
10710 if (tty_list
&& tty_list
->next
)
10711 error ("There are other tty frames open; close them before suspending Emacs");
10713 if (!NILP (stuffstring
))
10714 CHECK_STRING (stuffstring
);
10716 /* Run the functions in suspend-hook. */
10717 hook
= intern ("suspend-hook");
10718 Frun_hooks (1, &hook
);
10720 GCPRO1 (stuffstring
);
10721 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10722 reset_all_sys_modes ();
10723 /* sys_suspend can get an error if it tries to fork a subshell
10724 and the system resources aren't available for that. */
10725 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10727 stuff_buffered_input (stuffstring
);
10728 if (cannot_suspend
)
10732 unbind_to (count
, Qnil
);
10734 /* Check if terminal/window size has changed.
10735 Note that this is not useful when we are running directly
10736 with a window system; but suspend should be disabled in that case. */
10737 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10738 if (width
!= old_width
|| height
!= old_height
)
10739 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10741 /* Run suspend-resume-hook. */
10742 hook
= intern ("suspend-resume-hook");
10743 Frun_hooks (1, &hook
);
10749 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10750 Then in any case stuff anything Emacs has read ahead and not used. */
10753 stuff_buffered_input (Lisp_Object stuffstring
)
10755 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10756 register unsigned char *p
;
10758 if (STRINGP (stuffstring
))
10760 register EMACS_INT count
;
10762 p
= SDATA (stuffstring
);
10763 count
= SBYTES (stuffstring
);
10764 while (count
-- > 0)
10769 /* Anything we have read ahead, put back for the shell to read. */
10770 /* ?? What should this do when we have multiple keyboards??
10771 Should we ignore anything that was typed in at the "wrong" kboard?
10773 rms: we should stuff everything back into the kboard
10775 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10778 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10779 kbd_fetch_ptr
= kbd_buffer
;
10780 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10781 stuff_char (kbd_fetch_ptr
->code
);
10783 clear_event (kbd_fetch_ptr
);
10787 #endif /* SIGTSTP */
10791 set_waiting_for_input (struct timeval
*time_to_clear
)
10793 input_available_clear_time
= time_to_clear
;
10795 /* Tell handle_interrupt to throw back to read_char, */
10796 waiting_for_input
= 1;
10798 /* If handle_interrupt was called before and buffered a C-g,
10799 make it run again now, to avoid timing error. */
10800 if (!NILP (Vquit_flag
))
10801 quit_throw_to_read_char ();
10805 clear_waiting_for_input (void)
10807 /* Tell handle_interrupt not to throw back to read_char, */
10808 waiting_for_input
= 0;
10809 input_available_clear_time
= 0;
10812 /* The SIGINT handler.
10814 If we have a frame on the controlling tty, we assume that the
10815 SIGINT was generated by C-g, so we call handle_interrupt.
10816 Otherwise, the handler kills Emacs. */
10819 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10820 /* compilers complain in signal calls. */
10822 /* Must preserve main program's value of errno. */
10823 int old_errno
= errno
;
10824 struct terminal
*terminal
;
10826 SIGNAL_THREAD_CHECK (signalnum
);
10828 /* See if we have an active terminal on our controlling tty. */
10829 terminal
= get_named_tty ("/dev/tty");
10832 /* If there are no frames there, let's pretend that we are a
10833 well-behaving UN*X program and quit. */
10834 Fkill_emacs (Qnil
);
10838 /* Otherwise, the SIGINT was probably generated by C-g. */
10840 /* Set internal_last_event_frame to the top frame of the
10841 controlling tty, if we have a frame there. We disable the
10842 interrupt key on secondary ttys, so the SIGINT must have come
10843 from the controlling tty. */
10844 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10846 handle_interrupt ();
10852 /* This routine is called at interrupt level in response to C-g.
10854 It is called from the SIGINT handler or kbd_buffer_store_event.
10856 If `waiting_for_input' is non zero, then unless `echoing' is
10857 nonzero, immediately throw back to read_char.
10859 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10860 eval to throw, when it gets a chance. If quit-flag is already
10861 non-nil, it stops the job right away. */
10864 handle_interrupt (void)
10870 /* XXX This code needs to be revised for multi-tty support. */
10871 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10873 /* If SIGINT isn't blocked, don't let us be interrupted by
10874 another SIGINT, it might be harmful due to non-reentrancy
10875 in I/O functions. */
10876 sigblock (sigmask (SIGINT
));
10879 reset_all_sys_modes ();
10881 #ifdef SIGTSTP /* Support possible in later USG versions */
10883 * On systems which can suspend the current process and return to the original
10884 * shell, this command causes the user to end up back at the shell.
10885 * The "Auto-save" and "Abort" questions are not asked until
10886 * the user elects to return to emacs, at which point he can save the current
10887 * job and either dump core or continue.
10891 /* Perhaps should really fork an inferior shell?
10892 But that would not provide any way to get back
10893 to the original shell, ever. */
10894 printf ("No support for stopping a process on this operating system;\n");
10895 printf ("you can continue or abort.\n");
10896 #endif /* not SIGTSTP */
10898 /* We must remain inside the screen area when the internal terminal
10899 is used. Note that [Enter] is not echoed by dos. */
10900 cursor_to (SELECTED_FRAME (), 0, 0);
10902 /* It doesn't work to autosave while GC is in progress;
10903 the code used for auto-saving doesn't cope with the mark bit. */
10904 if (!gc_in_progress
)
10906 printf ("Auto-save? (y or n) ");
10908 if (((c
= getchar ()) & ~040) == 'Y')
10910 Fdo_auto_save (Qt
, Qnil
);
10912 printf ("\r\nAuto-save done");
10913 #else /* not MSDOS */
10914 printf ("Auto-save done\n");
10915 #endif /* not MSDOS */
10917 while (c
!= '\n') c
= getchar ();
10921 /* During GC, it must be safe to reenable quitting again. */
10922 Vinhibit_quit
= Qnil
;
10925 #endif /* not MSDOS */
10926 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10927 printf ("but will instead do a real quit after garbage collection ends\r\n");
10932 printf ("\r\nAbort? (y or n) ");
10933 #else /* not MSDOS */
10934 printf ("Abort (and dump core)? (y or n) ");
10935 #endif /* not MSDOS */
10937 if (((c
= getchar ()) & ~040) == 'Y')
10939 while (c
!= '\n') c
= getchar ();
10941 printf ("\r\nContinuing...\r\n");
10942 #else /* not MSDOS */
10943 printf ("Continuing...\n");
10944 #endif /* not MSDOS */
10946 init_all_sys_modes ();
10951 /* If executing a function that wants to be interrupted out of
10952 and the user has not deferred quitting by binding `inhibit-quit'
10953 then quit right away. */
10954 if (immediate_quit
&& NILP (Vinhibit_quit
))
10956 struct gl_state_s saved
;
10957 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10959 immediate_quit
= 0;
10962 GCPRO4 (saved
.object
, saved
.global_code
,
10963 saved
.current_syntax_table
, saved
.old_prop
);
10964 Fsignal (Qquit
, Qnil
);
10965 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10970 /* Else request quit when it's safe */
10974 /* TODO: The longjmp in this call throws the NS event loop integration off,
10975 and it seems to do fine without this. Probably some attention
10976 needs to be paid to the setting of waiting_for_input in
10977 wait_reading_process_output() under HAVE_NS because of the call
10978 to ns_select there (needed because otherwise events aren't picked up
10979 outside of polling since we don't get SIGIO like X and we don't have a
10980 separate event loop thread like W32. */
10982 if (waiting_for_input
&& !echoing
)
10983 quit_throw_to_read_char ();
10987 /* Handle a C-g by making read_char return C-g. */
10990 quit_throw_to_read_char (void)
10993 /* Prevent another signal from doing this before we finish. */
10994 clear_waiting_for_input ();
10997 Vunread_command_events
= Qnil
;
10998 unread_command_char
= -1;
11000 #if 0 /* Currently, sit_for is called from read_char without turning
11001 off polling. And that can call set_waiting_for_input.
11002 It seems to be harmless. */
11003 #ifdef POLL_FOR_INPUT
11004 /* May be > 1 if in recursive minibuffer. */
11005 if (poll_suppress_count
== 0)
11009 if (FRAMEP (internal_last_event_frame
)
11010 && !EQ (internal_last_event_frame
, selected_frame
))
11011 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11014 _longjmp (getcjmp
, 1);
11017 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
11018 Sset_input_interrupt_mode
, 1, 1, 0,
11019 doc
: /* Set interrupt mode of reading keyboard input.
11020 If INTERRUPT is non-nil, Emacs will use input interrupts;
11021 otherwise Emacs uses CBREAK mode.
11023 See also `current-input-mode'. */)
11024 (Lisp_Object interrupt
)
11026 int new_interrupt_input
;
11028 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11029 #ifdef HAVE_X_WINDOWS
11030 if (x_display_list
!= NULL
)
11032 /* When using X, don't give the user a real choice,
11033 because we haven't implemented the mechanisms to support it. */
11034 new_interrupt_input
= 1;
11037 #endif /* HAVE_X_WINDOWS */
11038 new_interrupt_input
= !NILP (interrupt
);
11039 #else /* not SIGIO */
11040 new_interrupt_input
= 0;
11041 #endif /* not SIGIO */
11043 if (new_interrupt_input
!= interrupt_input
)
11045 #ifdef POLL_FOR_INPUT
11049 /* this causes startup screen to be restored and messes with the mouse */
11050 reset_all_sys_modes ();
11051 interrupt_input
= new_interrupt_input
;
11052 init_all_sys_modes ();
11054 interrupt_input
= new_interrupt_input
;
11057 #ifdef POLL_FOR_INPUT
11058 poll_suppress_count
= 1;
11065 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11066 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11067 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11068 C-q in key sequences.
11070 This setting only has an effect on tty terminals and only when
11071 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11073 See also `current-input-mode'. */)
11074 (Lisp_Object flow
, Lisp_Object terminal
)
11076 struct terminal
*t
= get_terminal (terminal
, 1);
11077 struct tty_display_info
*tty
;
11078 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11080 tty
= t
->display_info
.tty
;
11082 if (tty
->flow_control
!= !NILP (flow
))
11085 /* this causes startup screen to be restored and messes with the mouse */
11086 reset_sys_modes (tty
);
11089 tty
->flow_control
= !NILP (flow
);
11092 init_sys_modes (tty
);
11098 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11099 doc
: /* Enable or disable 8-bit input on TERMINAL.
11100 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11101 bit as the Meta modifier.
11103 If META is nil, Emacs will ignore the top bit, on the assumption it is
11106 Otherwise, Emacs will accept and pass through 8-bit input without
11107 specially interpreting the top bit.
11109 This setting only has an effect on tty terminal devices.
11111 Optional parameter TERMINAL specifies the tty terminal device to use.
11112 It may be a terminal object, a frame, or nil for the terminal used by
11113 the currently selected frame.
11115 See also `current-input-mode'. */)
11116 (Lisp_Object meta
, Lisp_Object terminal
)
11118 struct terminal
*t
= get_terminal (terminal
, 1);
11119 struct tty_display_info
*tty
;
11122 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11124 tty
= t
->display_info
.tty
;
11128 else if (EQ (meta
, Qt
))
11133 if (tty
->meta_key
!= new_meta
)
11136 /* this causes startup screen to be restored and messes with the mouse */
11137 reset_sys_modes (tty
);
11140 tty
->meta_key
= new_meta
;
11143 init_sys_modes (tty
);
11149 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11150 doc
: /* Specify character used for quitting.
11151 QUIT must be an ASCII character.
11153 This function only has an effect on the controlling tty of the Emacs
11156 See also `current-input-mode'. */)
11159 struct terminal
*t
= get_named_tty ("/dev/tty");
11160 struct tty_display_info
*tty
;
11161 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11163 tty
= t
->display_info
.tty
;
11165 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11166 error ("QUIT must be an ASCII character");
11169 /* this causes startup screen to be restored and messes with the mouse */
11170 reset_sys_modes (tty
);
11173 /* Don't let this value be out of range. */
11174 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11177 init_sys_modes (tty
);
11183 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11184 doc
: /* Set mode of reading keyboard input.
11185 First arg INTERRUPT non-nil means use input interrupts;
11186 nil means use CBREAK mode.
11187 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11188 (no effect except in CBREAK mode).
11189 Third arg META t means accept 8-bit input (for a Meta key).
11190 META nil means ignore the top bit, on the assumption it is parity.
11191 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11192 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11193 See also `current-input-mode'. */)
11194 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11196 Fset_input_interrupt_mode (interrupt
);
11197 Fset_output_flow_control (flow
, Qnil
);
11198 Fset_input_meta_mode (meta
, Qnil
);
11200 Fset_quit_char (quit
);
11204 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11205 doc
: /* Return information about the way Emacs currently reads keyboard input.
11206 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11207 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11208 nil, Emacs is using CBREAK mode.
11209 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11210 terminal; this does not apply if Emacs uses interrupt-driven input.
11211 META is t if accepting 8-bit input with 8th bit as Meta flag.
11212 META nil means ignoring the top bit, on the assumption it is parity.
11213 META is neither t nor nil if accepting 8-bit input and using
11214 all 8 bits as the character code.
11215 QUIT is the character Emacs currently uses to quit.
11216 The elements of this list correspond to the arguments of
11217 `set-input-mode'. */)
11220 Lisp_Object val
[4];
11221 struct frame
*sf
= XFRAME (selected_frame
);
11223 val
[0] = interrupt_input
? Qt
: Qnil
;
11224 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11226 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11227 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11229 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11236 XSETFASTINT (val
[3], quit_char
);
11238 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11241 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11242 doc
: /* Return position information for pixel coordinates X and Y.
11243 By default, X and Y are relative to text area of the selected window.
11244 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11245 If optional fourth arg WHOLE is non-nil, X is relative to the left
11246 edge of the window.
11248 The return value is similar to a mouse click position:
11249 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11250 IMAGE (DX . DY) (WIDTH . HEIGHT))
11251 The `posn-' functions access elements of such lists. */)
11252 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11257 if (NILP (frame_or_window
))
11258 frame_or_window
= selected_window
;
11260 if (WINDOWP (frame_or_window
))
11264 CHECK_LIVE_WINDOW (frame_or_window
);
11266 w
= XWINDOW (frame_or_window
);
11267 XSETINT (x
, (XINT (x
)
11268 + WINDOW_LEFT_EDGE_X (w
)
11270 ? window_box_left_offset (w
, TEXT_AREA
)
11272 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11273 frame_or_window
= w
->frame
;
11276 CHECK_LIVE_FRAME (frame_or_window
);
11278 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11281 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11282 doc
: /* Return position information for buffer POS in WINDOW.
11283 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11285 Return nil if position is not visible in window. Otherwise,
11286 the return value is similar to that returned by `event-start' for
11287 a mouse click at the upper left corner of the glyph corresponding
11288 to the given buffer position:
11289 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11290 IMAGE (DX . DY) (WIDTH . HEIGHT))
11291 The `posn-' functions access elements of such lists. */)
11292 (Lisp_Object pos
, Lisp_Object window
)
11297 window
= selected_window
;
11299 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11302 Lisp_Object x
= XCAR (tem
);
11303 Lisp_Object y
= XCAR (XCDR (tem
));
11305 /* Point invisible due to hscrolling? */
11308 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11316 * Set up a new kboard object with reasonable initial values.
11319 init_kboard (KBOARD
*kb
)
11321 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11322 KVAR (kb
, Vlast_command
) = Qnil
;
11323 KVAR (kb
, Vreal_last_command
) = Qnil
;
11324 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11325 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11326 KVAR (kb
, Vprefix_arg
) = Qnil
;
11327 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11328 KVAR (kb
, kbd_queue
) = Qnil
;
11329 kb
->kbd_queue_has_data
= 0;
11330 kb
->immediate_echo
= 0;
11331 KVAR (kb
, echo_string
) = Qnil
;
11332 kb
->echo_after_prompt
= -1;
11333 kb
->kbd_macro_buffer
= 0;
11334 kb
->kbd_macro_bufsize
= 0;
11335 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11336 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11337 kb
->reference_count
= 0;
11338 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11339 KVAR (kb
, system_key_syms
) = Qnil
;
11340 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11341 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11342 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11343 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11344 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11348 * Destroy the contents of a kboard object, but not the object itself.
11349 * We use this just before deleting it, or if we're going to initialize
11350 * it a second time.
11353 wipe_kboard (KBOARD
*kb
)
11355 xfree (kb
->kbd_macro_buffer
);
11358 /* Free KB and memory referenced from it. */
11361 delete_kboard (KBOARD
*kb
)
11365 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11368 *kbp
= kb
->next_kboard
;
11370 /* Prevent a dangling reference to KB. */
11371 if (kb
== current_kboard
11372 && FRAMEP (selected_frame
)
11373 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11375 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11377 if (current_kboard
== kb
)
11386 init_keyboard (void)
11388 /* This is correct before outermost invocation of the editor loop */
11389 command_loop_level
= -1;
11390 immediate_quit
= 0;
11391 quit_char
= Ctl ('g');
11392 Vunread_command_events
= Qnil
;
11393 unread_command_char
= -1;
11394 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11396 recent_keys_index
= 0;
11397 kbd_fetch_ptr
= kbd_buffer
;
11398 kbd_store_ptr
= kbd_buffer
;
11399 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11400 do_mouse_tracking
= Qnil
;
11403 interrupt_input_blocked
= 0;
11404 interrupt_input_pending
= 0;
11406 pending_signals
= 0;
11409 /* This means that command_loop_1 won't try to select anything the first
11411 internal_last_event_frame
= Qnil
;
11412 Vlast_event_frame
= internal_last_event_frame
;
11414 current_kboard
= initial_kboard
;
11415 /* Re-initialize the keyboard again. */
11416 wipe_kboard (current_kboard
);
11417 init_kboard (current_kboard
);
11418 /* A value of nil for Vwindow_system normally means a tty, but we also use
11419 it for the initial terminal since there is no window system there. */
11420 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11422 if (!noninteractive
)
11424 /* Before multi-tty support, these handlers used to be installed
11425 only if the current session was a tty session. Now an Emacs
11426 session may have multiple display types, so we always handle
11427 SIGINT. There is special code in interrupt_signal to exit
11428 Emacs on SIGINT when there are no termcap frames on the
11429 controlling terminal. */
11430 signal (SIGINT
, interrupt_signal
);
11432 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11433 SIGQUIT and we can't tell which one it will give us. */
11434 signal (SIGQUIT
, interrupt_signal
);
11435 #endif /* not DOS_NT */
11437 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11439 if (!noninteractive
)
11440 signal (SIGIO
, input_available_signal
);
11443 /* Use interrupt input by default, if it works and noninterrupt input
11444 has deficiencies. */
11446 #ifdef INTERRUPT_INPUT
11447 interrupt_input
= 1;
11449 interrupt_input
= 0;
11455 if (keyboard_init_hook
)
11456 (*keyboard_init_hook
) ();
11458 #ifdef POLL_FOR_INPUT
11460 poll_suppress_count
= 1;
11465 /* This type's only use is in syms_of_keyboard, to initialize the
11466 event header symbols and put properties on them. */
11467 struct event_head
{
11473 static const struct event_head head_table
[] = {
11474 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11475 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11476 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11477 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11478 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11479 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11480 /* `select-window' should be handled just like `switch-frame'
11481 in read_key_sequence. */
11482 {&Qselect_window
, "select-window", &Qswitch_frame
}
11486 syms_of_keyboard (void)
11488 pending_funcalls
= Qnil
;
11489 staticpro (&pending_funcalls
);
11491 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11492 staticpro (&Vlispy_mouse_stem
);
11495 DEFSYM (QCimage
, ":image");
11496 DEFSYM (Qhelp_echo
, "help-echo");
11497 DEFSYM (QCrtl
, ":rtl");
11499 staticpro (&item_properties
);
11500 item_properties
= Qnil
;
11502 staticpro (&tool_bar_item_properties
);
11503 tool_bar_item_properties
= Qnil
;
11504 staticpro (&tool_bar_items_vector
);
11505 tool_bar_items_vector
= Qnil
;
11507 staticpro (&real_this_command
);
11508 real_this_command
= Qnil
;
11510 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11511 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11512 DEFSYM (Qself_insert_command
, "self-insert-command");
11513 DEFSYM (Qforward_char
, "forward-char");
11514 DEFSYM (Qbackward_char
, "backward-char");
11515 DEFSYM (Qdisabled
, "disabled");
11516 DEFSYM (Qundefined
, "undefined");
11517 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11518 DEFSYM (Qpost_command_hook
, "post-command-hook");
11519 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11520 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11521 DEFSYM (Qfunction_key
, "function-key");
11522 DEFSYM (Qmouse_click
, "mouse-click");
11523 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11524 DEFSYM (Qsave_session
, "save-session");
11525 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11526 DEFSYM (Qmenu_enable
, "menu-enable");
11528 #if defined (WINDOWSNT)
11529 DEFSYM (Qlanguage_change
, "language-change");
11533 DEFSYM (Qdbus_event
, "dbus-event");
11536 DEFSYM (QCenable
, ":enable");
11537 DEFSYM (QCvisible
, ":visible");
11538 DEFSYM (QChelp
, ":help");
11539 DEFSYM (QCfilter
, ":filter");
11540 DEFSYM (QCbutton
, ":button");
11541 DEFSYM (QCkeys
, ":keys");
11542 DEFSYM (QCkey_sequence
, ":key-sequence");
11543 DEFSYM (QCtoggle
, ":toggle");
11544 DEFSYM (QCradio
, ":radio");
11545 DEFSYM (QClabel
, ":label");
11546 DEFSYM (QCvert_only
, ":vert-only");
11548 DEFSYM (Qmode_line
, "mode-line");
11549 DEFSYM (Qvertical_line
, "vertical-line");
11550 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11551 DEFSYM (Qmenu_bar
, "menu-bar");
11553 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11554 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11557 DEFSYM (Qabove_handle
, "above-handle");
11558 DEFSYM (Qhandle
, "handle");
11559 DEFSYM (Qbelow_handle
, "below-handle");
11560 DEFSYM (Qup
, "up");
11561 DEFSYM (Qdown
, "down");
11562 DEFSYM (Qtop
, "top");
11563 DEFSYM (Qbottom
, "bottom");
11564 DEFSYM (Qend_scroll
, "end-scroll");
11565 DEFSYM (Qratio
, "ratio");
11567 DEFSYM (Qevent_kind
, "event-kind");
11568 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11569 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11570 DEFSYM (Qmodifier_cache
, "modifier-cache");
11572 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11573 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11575 DEFSYM (Qpolling_period
, "polling-period");
11577 DEFSYM (Qx_set_selection
, "x-set-selection");
11578 DEFSYM (QPRIMARY
, "PRIMARY");
11579 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11581 DEFSYM (Qinput_method_function
, "input-method-function");
11582 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11583 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11585 DEFSYM (Qhelp_form_show
, "help-form-show");
11587 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11588 Fset (Qinput_method_use_echo_area
, Qnil
);
11590 last_point_position_buffer
= Qnil
;
11591 last_point_position_window
= Qnil
;
11595 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11597 for (i
= 0; i
< len
; i
++)
11599 const struct event_head
*p
= &head_table
[i
];
11600 *p
->var
= intern_c_string (p
->name
);
11601 staticpro (p
->var
);
11602 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11603 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11607 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11608 staticpro (&button_down_location
);
11609 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11610 staticpro (&mouse_syms
);
11611 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11612 / sizeof (lispy_wheel_names
[0])),
11614 staticpro (&wheel_syms
);
11618 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11620 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11621 for (i
= 0; i
< len
; i
++)
11622 if (modifier_names
[i
])
11623 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11624 staticpro (&modifier_symbols
);
11627 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11628 staticpro (&recent_keys
);
11630 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11631 staticpro (&this_command_keys
);
11633 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11634 staticpro (&raw_keybuf
);
11636 DEFSYM (Qextended_command_history
, "extended-command-history");
11637 Fset (Qextended_command_history
, Qnil
);
11639 accent_key_syms
= Qnil
;
11640 staticpro (&accent_key_syms
);
11642 func_key_syms
= Qnil
;
11643 staticpro (&func_key_syms
);
11645 drag_n_drop_syms
= Qnil
;
11646 staticpro (&drag_n_drop_syms
);
11648 unread_switch_frame
= Qnil
;
11649 staticpro (&unread_switch_frame
);
11651 internal_last_event_frame
= Qnil
;
11652 staticpro (&internal_last_event_frame
);
11654 read_key_sequence_cmd
= Qnil
;
11655 staticpro (&read_key_sequence_cmd
);
11657 menu_bar_one_keymap_changed_items
= Qnil
;
11658 staticpro (&menu_bar_one_keymap_changed_items
);
11660 menu_bar_items_vector
= Qnil
;
11661 staticpro (&menu_bar_items_vector
);
11663 help_form_saved_window_configs
= Qnil
;
11664 staticpro (&help_form_saved_window_configs
);
11666 defsubr (&Scurrent_idle_time
);
11667 defsubr (&Sevent_symbol_parse_modifiers
);
11668 defsubr (&Sevent_convert_list
);
11669 defsubr (&Sread_key_sequence
);
11670 defsubr (&Sread_key_sequence_vector
);
11671 defsubr (&Srecursive_edit
);
11672 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11673 defsubr (&Strack_mouse
);
11675 defsubr (&Sinput_pending_p
);
11676 defsubr (&Scommand_execute
);
11677 defsubr (&Srecent_keys
);
11678 defsubr (&Sthis_command_keys
);
11679 defsubr (&Sthis_command_keys_vector
);
11680 defsubr (&Sthis_single_command_keys
);
11681 defsubr (&Sthis_single_command_raw_keys
);
11682 defsubr (&Sreset_this_command_lengths
);
11683 defsubr (&Sclear_this_command_keys
);
11684 defsubr (&Ssuspend_emacs
);
11685 defsubr (&Sabort_recursive_edit
);
11686 defsubr (&Sexit_recursive_edit
);
11687 defsubr (&Srecursion_depth
);
11688 defsubr (&Stop_level
);
11689 defsubr (&Sdiscard_input
);
11690 defsubr (&Sopen_dribble_file
);
11691 defsubr (&Sset_input_interrupt_mode
);
11692 defsubr (&Sset_output_flow_control
);
11693 defsubr (&Sset_input_meta_mode
);
11694 defsubr (&Sset_quit_char
);
11695 defsubr (&Sset_input_mode
);
11696 defsubr (&Scurrent_input_mode
);
11697 defsubr (&Sexecute_extended_command
);
11698 defsubr (&Sposn_at_point
);
11699 defsubr (&Sposn_at_x_y
);
11701 DEFVAR_LISP ("last-command-event", last_command_event
,
11702 doc
: /* Last input event that was part of a command. */);
11704 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11705 doc
: /* Last input event in a command, except for mouse menu events.
11706 Mouse menus give back keys that don't look like mouse events;
11707 this variable holds the actual mouse event that led to the menu,
11708 so that you can determine whether the command was run by mouse or not. */);
11710 DEFVAR_LISP ("last-input-event", last_input_event
,
11711 doc
: /* Last input event. */);
11713 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11714 doc
: /* List of events to be read as the command input.
11715 These events are processed first, before actual keyboard input.
11716 Events read from this list are not normally added to `this-command-keys',
11717 as they will already have been added once as they were read for the first time.
11718 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11719 Vunread_command_events
= Qnil
;
11721 DEFVAR_INT ("unread-command-char", unread_command_char
,
11722 doc
: /* If not -1, an object to be read as next command input event. */);
11724 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11725 doc
: /* List of events to be processed as input by input methods.
11726 These events are processed before `unread-command-events'
11727 and actual keyboard input, but are not given to `input-method-function'. */);
11728 Vunread_post_input_method_events
= Qnil
;
11730 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11731 doc
: /* List of events to be processed as input by input methods.
11732 These events are processed after `unread-command-events', but
11733 before actual keyboard input.
11734 If there's an active input method, the events are given to
11735 `input-method-function'. */);
11736 Vunread_input_method_events
= Qnil
;
11738 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11739 doc
: /* Meta-prefix character code.
11740 Meta-foo as command input turns into this character followed by foo. */);
11741 XSETINT (meta_prefix_char
, 033);
11743 DEFVAR_KBOARD ("last-command", Vlast_command
,
11744 doc
: /* The last command executed.
11745 Normally a symbol with a function definition, but can be whatever was found
11746 in the keymap, or whatever the variable `this-command' was set to by that
11749 The value `mode-exit' is special; it means that the previous command
11750 read an event that told it to exit, and it did so and unread that event.
11751 In other words, the present command is the event that made the previous
11754 The value `kill-region' is special; it means that the previous command
11755 was a kill command.
11757 `last-command' has a separate binding for each terminal device.
11758 See Info node `(elisp)Multiple Terminals'. */);
11760 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11761 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11763 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11764 doc
: /* Last command that may be repeated.
11765 The last command executed that was not bound to an input event.
11766 This is the command `repeat' will try to repeat. */);
11768 DEFVAR_LISP ("this-command", Vthis_command
,
11769 doc
: /* The command now being executed.
11770 The command can set this variable; whatever is put here
11771 will be in `last-command' during the following command. */);
11772 Vthis_command
= Qnil
;
11774 DEFVAR_LISP ("this-command-keys-shift-translated",
11775 Vthis_command_keys_shift_translated
,
11776 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11777 Shift-translation occurs when there is no binding for the key sequence
11778 as entered, but a binding was found by changing an upper-case letter
11779 to lower-case, or a shifted function key to an unshifted one. */);
11780 Vthis_command_keys_shift_translated
= Qnil
;
11782 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11783 doc
: /* The command bound to the current key sequence before remapping.
11784 It equals `this-command' if the original command was not remapped through
11785 any of the active keymaps. Otherwise, the value of `this-command' is the
11786 result of looking up the original command in the active keymaps. */);
11787 Vthis_original_command
= Qnil
;
11789 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11790 doc
: /* *Number of input events between auto-saves.
11791 Zero means disable autosaving due to number of characters typed. */);
11792 auto_save_interval
= 300;
11794 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11795 doc
: /* *Number of seconds idle time before auto-save.
11796 Zero or nil means disable auto-saving due to idleness.
11797 After auto-saving due to this many seconds of idle time,
11798 Emacs also does a garbage collection if that seems to be warranted. */);
11799 XSETFASTINT (Vauto_save_timeout
, 30);
11801 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11802 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11803 The value may be integer or floating point. */);
11804 Vecho_keystrokes
= make_number (1);
11806 DEFVAR_INT ("polling-period", polling_period
,
11807 doc
: /* *Interval between polling for input during Lisp execution.
11808 The reason for polling is to make C-g work to stop a running program.
11809 Polling is needed only when using X windows and SIGIO does not work.
11810 Polling is automatically disabled in all other cases. */);
11811 polling_period
= 2;
11813 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11814 doc
: /* *Maximum time between mouse clicks to make a double-click.
11815 Measured in milliseconds. The value nil means disable double-click
11816 recognition; t means double-clicks have no time limit and are detected
11817 by position only. */);
11818 Vdouble_click_time
= make_number (500);
11820 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11821 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11822 On window-system frames, value is the number of pixels the mouse may have
11823 moved horizontally or vertically between two clicks to make a double-click.
11824 On non window-system frames, value is interpreted in units of 1/8 characters
11827 This variable is also the threshold for motion of the mouse
11828 to count as a drag. */);
11829 double_click_fuzz
= 3;
11831 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11832 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11833 inhibit_local_menu_bar_menus
= 0;
11835 DEFVAR_INT ("num-input-keys", num_input_keys
,
11836 doc
: /* Number of complete key sequences read as input so far.
11837 This includes key sequences read from keyboard macros.
11838 The number is effectively the number of interactive command invocations. */);
11839 num_input_keys
= 0;
11841 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11842 doc
: /* Number of input events read from the keyboard so far.
11843 This does not include events generated by keyboard macros. */);
11844 num_nonmacro_input_events
= 0;
11846 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11847 doc
: /* The frame in which the most recently read event occurred.
11848 If the last event came from a keyboard macro, this is set to `macro'. */);
11849 Vlast_event_frame
= Qnil
;
11851 /* This variable is set up in sysdep.c. */
11852 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11853 doc
: /* The ERASE character as set by the user with stty. */);
11855 DEFVAR_LISP ("help-char", Vhelp_char
,
11856 doc
: /* Character to recognize as meaning Help.
11857 When it is read, do `(eval help-form)', and display result if it's a string.
11858 If the value of `help-form' is nil, this char can be read normally. */);
11859 XSETINT (Vhelp_char
, Ctl ('H'));
11861 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11862 doc
: /* List of input events to recognize as meaning Help.
11863 These work just like the value of `help-char' (see that). */);
11864 Vhelp_event_list
= Qnil
;
11866 DEFVAR_LISP ("help-form", Vhelp_form
,
11867 doc
: /* Form to execute when character `help-char' is read.
11868 If the form returns a string, that string is displayed.
11869 If `help-form' is nil, the help char is not recognized. */);
11872 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11873 doc
: /* Command to run when `help-char' character follows a prefix key.
11874 This command is used only when there is no actual binding
11875 for that character after that prefix key. */);
11876 Vprefix_help_command
= Qnil
;
11878 DEFVAR_LISP ("top-level", Vtop_level
,
11879 doc
: /* Form to evaluate when Emacs starts up.
11880 Useful to set before you dump a modified Emacs. */);
11883 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11884 doc
: /* Translate table for local keyboard input, or nil.
11885 If non-nil, the value should be a char-table. Each character read
11886 from the keyboard is looked up in this char-table. If the value found
11887 there is non-nil, then it is used instead of the actual input character.
11889 The value can also be a string or vector, but this is considered obsolete.
11890 If it is a string or vector of length N, character codes N and up are left
11891 untranslated. In a vector, an element which is nil means "no translation".
11893 This is applied to the characters supplied to input methods, not their
11894 output. See also `translation-table-for-input'.
11896 This variable has a separate binding for each terminal.
11897 See Info node `(elisp)Multiple Terminals'. */);
11899 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11900 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11901 \(Even if the operating system has support for stopping a process.\) */);
11902 cannot_suspend
= 0;
11904 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11905 doc
: /* Non-nil means prompt with menus when appropriate.
11906 This is done when reading from a keymap that has a prompt string,
11907 for elements that have prompt strings.
11908 The menu is displayed on the screen
11909 if X menus were enabled at configuration
11910 time and the previous event was a mouse click prefix key.
11911 Otherwise, menu prompting uses the echo area. */);
11912 menu_prompting
= 1;
11914 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11915 doc
: /* Character to see next line of menu prompt.
11916 Type this character while in a menu prompt to rotate around the lines of it. */);
11917 XSETINT (menu_prompt_more_char
, ' ');
11919 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11920 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11921 Emacs applies the modifiers of the character stored here to each keyboard
11922 character it reads. For example, after evaluating the expression
11923 (setq extra-keyboard-modifiers ?\\C-x)
11924 all input characters will have the control modifier applied to them.
11926 Note that the character ?\\C-@, equivalent to the integer zero, does
11927 not count as a control character; rather, it counts as a character
11928 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11929 cancels any modification. */);
11930 extra_keyboard_modifiers
= 0;
11932 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11933 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11934 The command loop sets this to nil before each command,
11935 and tests the value when the command returns.
11936 Buffer modification stores t in this variable. */);
11937 Vdeactivate_mark
= Qnil
;
11938 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11940 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11941 doc
: /* Normal hook run before each command is executed.
11942 If an unhandled error happens in running this hook,
11943 the function in which the error occurred is unconditionally removed, since
11944 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11945 Vpre_command_hook
= Qnil
;
11947 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11948 doc
: /* Normal hook run after each command is executed.
11949 If an unhandled error happens in running this hook,
11950 the function in which the error occurred is unconditionally removed, since
11951 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11952 Vpost_command_hook
= Qnil
;
11955 DEFVAR_LISP ("echo-area-clear-hook", ...,
11956 doc
: /* Normal hook run when clearing the echo area. */);
11958 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11959 Fset (Qecho_area_clear_hook
, Qnil
);
11961 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11962 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11963 Vlucid_menu_bar_dirty_flag
= Qnil
;
11965 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11966 doc
: /* List of menu bar items to move to the end of the menu bar.
11967 The elements of the list are event types that may have menu bar bindings. */);
11968 Vmenu_bar_final_items
= Qnil
;
11970 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11971 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11972 This is used internally by graphical displays that do not render
11973 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11974 Vtool_bar_separator_image_expression
= Qnil
;
11976 DEFVAR_KBOARD ("overriding-terminal-local-map",
11977 Voverriding_terminal_local_map
,
11978 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11979 If this variable is non-nil, it is used as a keymap instead of the
11980 buffer's local map, and the minor mode keymaps and text property keymaps.
11981 It also replaces `overriding-local-map'.
11983 This variable is intended to let commands such as `universal-argument'
11984 set up a different keymap for reading the next command.
11986 `overriding-terminal-local-map' has a separate binding for each
11988 See Info node `(elisp)Multiple Terminals'. */);
11990 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11991 doc
: /* Keymap that overrides all other local keymaps.
11992 If this variable is non-nil, it is used as a keymap--replacing the
11993 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11994 Voverriding_local_map
= Qnil
;
11996 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11997 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11998 Otherwise, the menu bar continues to reflect the buffer's local map
11999 and the minor mode maps regardless of `overriding-local-map'. */);
12000 Voverriding_local_map_menu_flag
= Qnil
;
12002 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12003 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12004 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12006 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12007 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12009 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12010 doc
: /* Alist of system-specific X windows key symbols.
12011 Each element should have the form (N . SYMBOL) where N is the
12012 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12013 and SYMBOL is its name.
12015 `system-key-alist' has a separate binding for each terminal device.
12016 See Info node `(elisp)Multiple Terminals'. */);
12018 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12019 doc
: /* Keymap that translates key sequences to key sequences during input.
12020 This is used mainly for mapping key sequences into some preferred
12021 key events (symbols).
12023 The `read-key-sequence' function replaces any subsequence bound by
12024 `local-function-key-map' with its binding. More precisely, when the
12025 active keymaps have no binding for the current key sequence but
12026 `local-function-key-map' binds a suffix of the sequence to a vector or
12027 string, `read-key-sequence' replaces the matching suffix with its
12028 binding, and continues with the new sequence.
12030 If the binding is a function, it is called with one argument (the prompt)
12031 and its return value (a key sequence) is used.
12033 The events that come from bindings in `local-function-key-map' are not
12034 themselves looked up in `local-function-key-map'.
12036 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12037 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12038 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12039 typing `ESC O P x' would return [f1 x].
12041 `local-function-key-map' has a separate binding for each terminal
12042 device. See Info node `(elisp)Multiple Terminals'. If you need to
12043 define a binding on all terminals, change `function-key-map'
12044 instead. Initially, `local-function-key-map' is an empty keymap that
12045 has `function-key-map' as its parent on all terminal devices. */);
12047 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12048 doc
: /* Keymap that decodes input escape sequences.
12049 This is used mainly for mapping ASCII function key sequences into
12050 real Emacs function key events (symbols).
12052 The `read-key-sequence' function replaces any subsequence bound by
12053 `input-decode-map' with its binding. Contrary to `function-key-map',
12054 this map applies its rebinding regardless of the presence of an ordinary
12055 binding. So it is more like `key-translation-map' except that it applies
12056 before `function-key-map' rather than after.
12058 If the binding is a function, it is called with one argument (the prompt)
12059 and its return value (a key sequence) is used.
12061 The events that come from bindings in `input-decode-map' are not
12062 themselves looked up in `input-decode-map'.
12064 This variable is keyboard-local. */);
12066 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12067 doc
: /* The parent keymap of all `local-function-key-map' instances.
12068 Function key definitions that apply to all terminal devices should go
12069 here. If a mapping is defined in both the current
12070 `local-function-key-map' binding and this variable, then the local
12071 definition will take precendence. */);
12072 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12074 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12075 doc
: /* Keymap of key translations that can override keymaps.
12076 This keymap works like `function-key-map', but comes after that,
12077 and its non-prefix bindings override ordinary bindings.
12078 Another difference is that it is global rather than keyboard-local. */);
12079 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12081 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12082 doc
: /* List of deferred actions to be performed at a later time.
12083 The precise format isn't relevant here; we just check whether it is nil. */);
12084 Vdeferred_action_list
= Qnil
;
12086 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12087 doc
: /* Function to call to handle deferred actions, after each command.
12088 This function is called with no arguments after each command
12089 whenever `deferred-action-list' is non-nil. */);
12090 Vdeferred_action_function
= Qnil
;
12092 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12093 doc
: /* List of warnings to be displayed as soon as possible.
12094 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12095 as per the args of `display-warning' (which see).
12096 If this variable is non-nil, `delayed-warnings-hook' will be run
12097 immediately after running `post-command-hook'. */);
12098 Vdelayed_warnings_list
= Qnil
;
12100 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12101 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12102 The value can be a length of time to show the message for.
12103 If the value is non-nil and not a number, we wait 2 seconds. */);
12104 Vsuggest_key_bindings
= Qt
;
12106 DEFVAR_LISP ("timer-list", Vtimer_list
,
12107 doc
: /* List of active absolute time timers in order of increasing time. */);
12108 Vtimer_list
= Qnil
;
12110 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12111 doc
: /* List of active idle-time timers in order of increasing time. */);
12112 Vtimer_idle_list
= Qnil
;
12114 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12115 doc
: /* If non-nil, the function that implements the current input method.
12116 It's called with one argument, a printing character that was just read.
12117 \(That means a character with code 040...0176.)
12118 Typically this function uses `read-event' to read additional events.
12119 When it does so, it should first bind `input-method-function' to nil
12120 so it will not be called recursively.
12122 The function should return a list of zero or more events
12123 to be used as input. If it wants to put back some events
12124 to be reconsidered, separately, by the input method,
12125 it can add them to the beginning of `unread-command-events'.
12127 The input method function can find in `input-method-previous-message'
12128 the previous echo area message.
12130 The input method function should refer to the variables
12131 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12132 for guidance on what to do. */);
12133 Vinput_method_function
= Qnil
;
12135 DEFVAR_LISP ("input-method-previous-message",
12136 Vinput_method_previous_message
,
12137 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12138 This variable exists because `read-event' clears the echo area
12139 before running the input method. It is nil if there was no message. */);
12140 Vinput_method_previous_message
= Qnil
;
12142 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12143 doc
: /* If non-nil, the function that implements the display of help.
12144 It's called with one argument, the help string to display. */);
12145 Vshow_help_function
= Qnil
;
12147 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12148 doc
: /* If non-nil, suppress point adjustment after executing a command.
12150 After a command is executed, if point is moved into a region that has
12151 special properties (e.g. composition, display), we adjust point to
12152 the boundary of the region. But, when a command sets this variable to
12153 non-nil, we suppress the point adjustment.
12155 This variable is set to nil before reading a command, and is checked
12156 just after executing the command. */);
12157 Vdisable_point_adjustment
= Qnil
;
12159 DEFVAR_LISP ("global-disable-point-adjustment",
12160 Vglobal_disable_point_adjustment
,
12161 doc
: /* *If non-nil, always suppress point adjustment.
12163 The default value is nil, in which case, point adjustment are
12164 suppressed only after special commands that set
12165 `disable-point-adjustment' (which see) to non-nil. */);
12166 Vglobal_disable_point_adjustment
= Qnil
;
12168 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12169 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12170 If the value is not a number, such messages don't time out. */);
12171 Vminibuffer_message_timeout
= make_number (2);
12173 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12174 doc
: /* If non-nil, any keyboard input throws to this symbol.
12175 The value of that variable is passed to `quit-flag' and later causes a
12176 peculiar kind of quitting. */);
12177 Vthrow_on_input
= Qnil
;
12179 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12180 doc
: /* If non-nil, function to output error messages.
12181 The arguments are the error data, a list of the form
12182 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12183 such as just as `condition-case' would bind its variable to,
12184 the context (a string which normally goes at the start of the message),
12185 and the Lisp function within which the error was signaled. */);
12186 Vcommand_error_function
= Qnil
;
12188 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12189 Venable_disabled_menus_and_buttons
,
12190 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12192 Help functions bind this to allow help on disabled menu items
12193 and tool-bar buttons. */);
12194 Venable_disabled_menus_and_buttons
= Qnil
;
12196 DEFVAR_LISP ("select-active-regions",
12197 Vselect_active_regions
,
12198 doc
: /* If non-nil, an active region automatically sets the primary selection.
12199 If the value is `only', only temporarily active regions (usually made
12200 by mouse-dragging or shift-selection) set the window selection.
12202 This takes effect only when Transient Mark mode is enabled. */);
12203 Vselect_active_regions
= Qt
;
12205 DEFVAR_LISP ("saved-region-selection",
12206 Vsaved_region_selection
,
12207 doc
: /* Contents of active region prior to buffer modification.
12208 If `select-active-regions' is non-nil, Emacs sets this to the
12209 text in the region before modifying the buffer. The next
12210 `deactivate-mark' call uses this to set the window selection. */);
12211 Vsaved_region_selection
= Qnil
;
12213 DEFVAR_LISP ("debug-on-event",
12215 doc
: /* Enter debugger on this event. When Emacs
12216 receives the special event specifed by this variable, it will try to
12217 break into the debugger as soon as possible instead of processing the
12218 event normally through `special-event-map'.
12220 Currently, the only supported values for this
12221 variable are `sigusr1' and `sigusr2'. */);
12222 Vdebug_on_event
= intern_c_string ("sigusr2");
12224 /* Create the initial keyboard. */
12225 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12226 init_kboard (initial_kboard
);
12227 /* Vwindow_system is left at t for now. */
12228 initial_kboard
->next_kboard
= all_kboards
;
12229 all_kboards
= initial_kboard
;
12233 keys_of_keyboard (void)
12235 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12236 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12237 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12238 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12239 initial_define_key (meta_map
, 'x', "execute-extended-command");
12241 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12242 "handle-delete-frame");
12243 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12244 "ns-put-working-text");
12245 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12246 "ns-unput-working-text");
12247 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12248 current-prefix-arg, as is done in `handle-switch-frame'.
12249 But `handle-switch-frame is not run from the special-map.
12250 Commands from that map are run in a special way that automatically
12251 preserves the prefix-arg. Restoring the prefix arg here is not just
12252 redundant but harmful:
12254 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12255 - after the first prompt, the exit-minibuffer-hook is run which may
12256 iconify a frame and thus push a `iconify-frame' event.
12257 - after running exit-minibuffer-hook, current-prefix-arg is
12258 restored to the non-nil value it had before the prompt.
12259 - we enter the second prompt.
12260 current-prefix-arg is non-nil, prefix-arg is nil.
12261 - before running the first real event, we run the special iconify-frame
12262 event, but we pass the `special' arg to execute-command so
12263 current-prefix-arg and prefix-arg are left untouched.
12264 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12265 - the next key event will have a spuriously non-nil current-prefix-arg. */
12266 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12268 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12270 /* Handling it at such a low-level causes read_key_sequence to get
12271 * confused because it doesn't realize that the current_buffer was
12272 * changed by read_char.
12274 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12275 * "handle-select-window"); */
12276 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12277 "handle-save-session");
12280 /* Define a special event which is raised for dbus callback
12282 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12283 "dbus-handle-event");
12286 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12290 /* Mark the pointers in the kboard objects.
12291 Called by the Fgarbage_collector. */
12293 mark_kboards (void)
12297 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12299 if (kb
->kbd_macro_buffer
)
12300 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12302 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12303 mark_object (KVAR (kb
, Vlast_command
));
12304 mark_object (KVAR (kb
, Vreal_last_command
));
12305 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12306 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12307 mark_object (KVAR (kb
, Vprefix_arg
));
12308 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12309 mark_object (KVAR (kb
, kbd_queue
));
12310 mark_object (KVAR (kb
, defining_kbd_macro
));
12311 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12312 mark_object (KVAR (kb
, Vsystem_key_alist
));
12313 mark_object (KVAR (kb
, system_key_syms
));
12314 mark_object (KVAR (kb
, Vwindow_system
));
12315 mark_object (KVAR (kb
, Vinput_decode_map
));
12316 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12317 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12318 mark_object (KVAR (kb
, echo_string
));
12321 struct input_event
*event
;
12322 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12324 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12325 event
= kbd_buffer
;
12326 if (event
->kind
!= SELECTION_REQUEST_EVENT
12327 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12329 mark_object (event
->x
);
12330 mark_object (event
->y
);
12332 mark_object (event
->frame_or_window
);
12333 mark_object (event
->arg
);