1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
47 #ifdef HAVE_GTK_AND_PTHREAD
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
101 /* Non-nil disable property on a command means
102 do not execute it; call disabled-command-function's value instead. */
103 Lisp_Object Qdisabled
, Qdisabled_command_function
;
105 #define NUM_RECENT_KEYS (300)
106 int recent_keys_index
; /* Index for storing next element into recent_keys */
107 int total_keys
; /* Total number of elements stored into recent_keys */
108 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
110 /* Vector holding the key sequence that invoked the current command.
111 It is reused for each command, and it may be longer than the current
112 sequence; this_command_key_count indicates how many elements
113 actually mean something.
114 It's easier to staticpro a single Lisp_Object than an array. */
115 Lisp_Object this_command_keys
;
116 int this_command_key_count
;
118 /* 1 after calling Freset_this_command_lengths.
120 int this_command_key_count_reset
;
122 /* This vector is used as a buffer to record the events that were actually read
123 by read_key_sequence. */
124 Lisp_Object raw_keybuf
;
125 int raw_keybuf_count
;
127 #define GROW_RAW_KEYBUF \
128 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
129 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
131 /* Number of elements of this_command_keys
132 that precede this key sequence. */
133 int this_single_command_key_start
;
135 /* Record values of this_command_key_count and echo_length ()
136 before this command was read. */
137 static int before_command_key_count
;
138 static int before_command_echo_length
;
140 /* For longjmp to where kbd input is being done. */
142 static jmp_buf getcjmp
;
144 /* True while doing kbd input. */
145 int waiting_for_input
;
147 /* True while displaying for echoing. Delays C-g throwing. */
151 /* Non-null means we can start echoing at the next input pause even
152 though there is something in the echo area. */
154 static struct kboard
*ok_to_echo_at_next_pause
;
156 /* The kboard last echoing, or null for none. Reset to 0 in
157 cancel_echoing. If non-null, and a current echo area message
158 exists, and echo_message_buffer is eq to the current message
159 buffer, we know that the message comes from echo_kboard. */
161 struct kboard
*echo_kboard
;
163 /* The buffer used for echoing. Set in echo_now, reset in
166 Lisp_Object echo_message_buffer
;
168 /* Nonzero means C-g should cause immediate error-signal. */
171 /* Character that causes a quit. Normally C-g.
173 If we are running on an ordinary terminal, this must be an ordinary
174 ASCII char, since we want to make it our interrupt character.
176 If we are not running on an ordinary terminal, it still needs to be
177 an ordinary ASCII char. This character needs to be recognized in
178 the input interrupt handler. At this point, the keystroke is
179 represented as a struct input_event, while the desired quit
180 character is specified as a lispy event. The mapping from struct
181 input_events to lispy events cannot run in an interrupt handler,
182 and the reverse mapping is difficult for anything but ASCII
185 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
189 /* Current depth in recursive edits. */
190 int command_loop_level
;
192 /* If not Qnil, this is a switch-frame event which we decided to put
193 off until the end of a key sequence. This should be read as the
194 next command input, after any unread_command_events.
196 read_key_sequence uses this to delay switch-frame events until the
197 end of the key sequence; Fread_char uses it to put off switch-frame
198 events until a non-ASCII event is acceptable as input. */
199 Lisp_Object unread_switch_frame
;
201 /* Last size recorded for a current buffer which is not a minibuffer. */
202 static EMACS_INT last_non_minibuf_size
;
204 /* Total number of times read_char has returned, modulo SIZE_MAX + 1. */
205 size_t num_input_events
;
207 /* Value of num_nonmacro_input_events as of last auto save. */
211 /* This is like Vthis_command, except that commands never set it. */
212 Lisp_Object real_this_command
;
214 /* The value of point when the last command was started. */
215 EMACS_INT last_point_position
;
217 /* The buffer that was current when the last command was started. */
218 Lisp_Object last_point_position_buffer
;
220 /* The window that was selected when the last command was started. */
221 Lisp_Object last_point_position_window
;
223 /* The frame in which the last input event occurred, or Qmacro if the
224 last event came from a macro. We use this to determine when to
225 generate switch-frame events. This may be cleared by functions
226 like Fselect_frame, to make sure that a switch-frame event is
227 generated by the next character. */
228 Lisp_Object internal_last_event_frame
;
230 /* The timestamp of the last input event we received from the X server.
231 X Windows wants this for selection ownership. */
232 unsigned long last_event_timestamp
;
234 Lisp_Object Qx_set_selection
, QPRIMARY
, Qhandle_switch_frame
;
236 Lisp_Object Qself_insert_command
;
237 Lisp_Object Qforward_char
;
238 Lisp_Object Qbackward_char
;
239 Lisp_Object Qundefined
;
240 Lisp_Object Qtimer_event_handler
;
242 /* read_key_sequence stores here the command definition of the
243 key sequence that it reads. */
244 Lisp_Object read_key_sequence_cmd
;
246 Lisp_Object Qinput_method_function
;
248 Lisp_Object Qdeactivate_mark
;
250 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
252 Lisp_Object Qecho_area_clear_hook
;
254 /* Hooks to run before and after each command. */
255 Lisp_Object Qpre_command_hook
;
256 Lisp_Object Qpost_command_hook
;
258 Lisp_Object Qdeferred_action_function
;
260 Lisp_Object Qinput_method_exit_on_first_char
;
261 Lisp_Object Qinput_method_use_echo_area
;
263 /* File in which we write all commands we read. */
266 /* Nonzero if input is available. */
269 /* Circular buffer for pre-read keyboard input. */
271 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
273 /* Pointer to next available character in kbd_buffer.
274 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
275 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
276 next available char is in kbd_buffer[0]. */
277 static struct input_event
*kbd_fetch_ptr
;
279 /* Pointer to next place to store character in kbd_buffer. This
280 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
281 character should go in kbd_buffer[0]. */
282 static struct input_event
* volatile kbd_store_ptr
;
284 /* The above pair of variables forms a "queue empty" flag. When we
285 enqueue a non-hook event, we increment kbd_store_ptr. When we
286 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
287 there is input available if the two pointers are not equal.
289 Why not just have a flag set and cleared by the enqueuing and
290 dequeuing functions? Such a flag could be screwed up by interrupts
291 at inopportune times. */
293 /* Symbols to head events. */
294 Lisp_Object Qmouse_movement
;
295 Lisp_Object Qscroll_bar_movement
;
296 Lisp_Object Qswitch_frame
;
297 Lisp_Object Qdelete_frame
;
298 Lisp_Object Qiconify_frame
;
299 Lisp_Object Qmake_frame_visible
;
300 Lisp_Object Qselect_window
;
301 Lisp_Object Qhelp_echo
;
303 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
304 Lisp_Object Qmouse_fixup_help_message
;
307 /* Symbols to denote kinds of events. */
308 Lisp_Object Qfunction_key
;
309 Lisp_Object Qmouse_click
;
310 #if defined (WINDOWSNT)
311 Lisp_Object Qlanguage_change
;
313 Lisp_Object Qdrag_n_drop
;
314 Lisp_Object Qsave_session
;
316 Lisp_Object Qdbus_event
;
318 Lisp_Object Qconfig_changed_event
;
320 /* Lisp_Object Qmouse_movement; - also an event header */
322 /* Properties of event headers. */
323 Lisp_Object Qevent_kind
;
324 Lisp_Object Qevent_symbol_elements
;
326 /* menu and tool bar item parts */
327 Lisp_Object Qmenu_enable
;
328 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
329 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
, QCvert_only
;
331 /* An event header symbol HEAD may have a property named
332 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
333 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
334 mask of modifiers applied to it. If present, this is used to help
335 speed up parse_modifiers. */
336 Lisp_Object Qevent_symbol_element_mask
;
338 /* An unmodified event header BASE may have a property named
339 Qmodifier_cache, which is an alist mapping modifier masks onto
340 modified versions of BASE. If present, this helps speed up
342 Lisp_Object Qmodifier_cache
;
344 /* Symbols to use for parts of windows. */
345 Lisp_Object Qmode_line
;
346 Lisp_Object Qvertical_line
;
347 Lisp_Object Qvertical_scroll_bar
;
348 Lisp_Object Qmenu_bar
;
350 Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
), command_loop (void);
351 Lisp_Object
Fthis_command_keys (void);
352 Lisp_Object Qextended_command_history
;
353 EMACS_TIME
timer_check (void);
355 static void record_menu_key (Lisp_Object c
);
356 static int echo_length (void);
358 Lisp_Object Qpolling_period
;
360 /* Incremented whenever a timer is run. */
363 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
365 EMACS_TIME
*input_available_clear_time
;
367 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
368 Default is 1 if INTERRUPT_INPUT is defined. */
371 /* Nonzero while interrupts are temporarily deferred during redisplay. */
372 int interrupts_deferred
;
374 /* Allow m- file to inhibit use of FIONREAD. */
375 #ifdef BROKEN_FIONREAD
379 /* We are unable to use interrupts if FIONREAD is not available,
380 so flush SIGIO so we won't try. */
381 #if !defined (FIONREAD)
387 /* If we support a window system, turn on the code to poll periodically
388 to detect C-g. It isn't actually used when doing interrupt input. */
389 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
390 #define POLL_FOR_INPUT
393 /* The time when Emacs started being idle. */
395 static EMACS_TIME timer_idleness_start_time
;
397 /* After Emacs stops being idle, this saves the last value
398 of timer_idleness_start_time from when it was idle. */
400 static EMACS_TIME timer_last_idleness_start_time
;
403 /* Global variable declarations. */
405 /* Flags for readable_events. */
406 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
407 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
408 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
410 /* Function for init_keyboard to call with no args (if nonzero). */
411 void (*keyboard_init_hook
) (void);
413 static int read_avail_input (int);
414 static void get_input_pending (int *, int);
415 static int readable_events (int);
416 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
418 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
420 static Lisp_Object
make_lispy_event (struct input_event
*);
421 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
422 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
423 enum scroll_bar_part
,
424 Lisp_Object
, Lisp_Object
,
427 static Lisp_Object
modify_event_symbol (EMACS_INT
, unsigned, Lisp_Object
,
428 Lisp_Object
, const char *const *,
429 Lisp_Object
*, unsigned);
430 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
431 static void save_getcjmp (jmp_buf);
432 static void restore_getcjmp (jmp_buf);
433 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
434 static void clear_event (struct input_event
*);
435 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
436 static void interrupt_signal (int signalnum
);
438 static void input_available_signal (int signo
);
440 static void handle_interrupt (void);
441 static void timer_start_idle (void);
442 static void timer_stop_idle (void);
443 static void timer_resume_idle (void);
444 static void handle_user_signal (int);
445 static char *find_user_signal_name (int);
446 static int store_user_signal_events (void);
449 /* Add C to the echo string, if echoing is going on.
450 C can be a character, which is printed prettily ("M-C-x" and all that
451 jazz), or a symbol, whose name is printed. */
454 echo_char (Lisp_Object c
)
456 if (current_kboard
->immediate_echo
)
458 int size
= KEY_DESCRIPTION_SIZE
+ 100;
459 char *buffer
= (char *) alloca (size
);
461 Lisp_Object echo_string
;
463 echo_string
= KVAR (current_kboard
, echo_string
);
465 /* If someone has passed us a composite event, use its head symbol. */
470 ptr
= push_key_description (XINT (c
), ptr
, 1);
472 else if (SYMBOLP (c
))
474 Lisp_Object name
= SYMBOL_NAME (c
);
475 int nbytes
= SBYTES (name
);
477 if (size
- (ptr
- buffer
) < nbytes
)
479 int offset
= ptr
- buffer
;
480 size
= max (2 * size
, size
+ nbytes
);
481 buffer
= (char *) alloca (size
);
482 ptr
= buffer
+ offset
;
485 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
486 STRING_MULTIBYTE (name
), 1);
489 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
492 const char *text
= " (Type ? for further options)";
493 int len
= strlen (text
);
495 if (size
- (ptr
- buffer
) < len
)
497 int offset
= ptr
- buffer
;
499 buffer
= (char *) alloca (size
);
500 ptr
= buffer
+ offset
;
503 memcpy (ptr
, text
, len
);
507 /* Replace a dash from echo_dash with a space, otherwise
508 add a space at the end as a separator between keys. */
509 if (STRINGP (echo_string
)
510 && SCHARS (echo_string
) > 1)
512 Lisp_Object last_char
, prev_char
, idx
;
514 idx
= make_number (SCHARS (echo_string
) - 2);
515 prev_char
= Faref (echo_string
, idx
);
517 idx
= make_number (SCHARS (echo_string
) - 1);
518 last_char
= Faref (echo_string
, idx
);
520 /* We test PREV_CHAR to make sure this isn't the echoing
522 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
523 Faset (echo_string
, idx
, make_number (' '));
525 echo_string
= concat2 (echo_string
, build_string (" "));
527 else if (STRINGP (echo_string
))
528 echo_string
= concat2 (echo_string
, build_string (" "));
530 KVAR (current_kboard
, echo_string
)
531 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
537 /* Temporarily add a dash to the end of the echo string if it's not
538 empty, so that it serves as a mini-prompt for the very next character. */
543 /* Do nothing if not echoing at all. */
544 if (NILP (KVAR (current_kboard
, echo_string
)))
547 if (this_command_key_count
== 0)
550 if (!current_kboard
->immediate_echo
551 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
554 /* Do nothing if we just printed a prompt. */
555 if (current_kboard
->echo_after_prompt
556 == SCHARS (KVAR (current_kboard
, echo_string
)))
559 /* Do nothing if we have already put a dash at the end. */
560 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
562 Lisp_Object last_char
, prev_char
, idx
;
564 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
565 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
567 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
568 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
570 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
574 /* Put a dash at the end of the buffer temporarily,
575 but make it go away when the next character is added. */
576 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
581 /* Display the current echo string, and begin echoing if not already
587 if (!current_kboard
->immediate_echo
)
590 current_kboard
->immediate_echo
= 1;
592 for (i
= 0; i
< this_command_key_count
; i
++)
596 /* Set before_command_echo_length to the value that would
597 have been saved before the start of this subcommand in
598 command_loop_1, if we had already been echoing then. */
599 if (i
== this_single_command_key_start
)
600 before_command_echo_length
= echo_length ();
602 c
= XVECTOR (this_command_keys
)->contents
[i
];
603 if (! (EVENT_HAS_PARAMETERS (c
)
604 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
608 /* Set before_command_echo_length to the value that would
609 have been saved before the start of this subcommand in
610 command_loop_1, if we had already been echoing then. */
611 if (this_command_key_count
== this_single_command_key_start
)
612 before_command_echo_length
= echo_length ();
614 /* Put a dash at the end to invite the user to type more. */
619 message3_nolog (KVAR (current_kboard
, echo_string
),
620 SBYTES (KVAR (current_kboard
, echo_string
)),
621 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
624 /* Record in what buffer we echoed, and from which kboard. */
625 echo_message_buffer
= echo_area_buffer
[0];
626 echo_kboard
= current_kboard
;
628 if (waiting_for_input
&& !NILP (Vquit_flag
))
629 quit_throw_to_read_char ();
632 /* Turn off echoing, for the start of a new command. */
635 cancel_echoing (void)
637 current_kboard
->immediate_echo
= 0;
638 current_kboard
->echo_after_prompt
= -1;
639 KVAR (current_kboard
, echo_string
) = Qnil
;
640 ok_to_echo_at_next_pause
= NULL
;
642 echo_message_buffer
= Qnil
;
645 /* Return the length of the current echo string. */
650 return (STRINGP (KVAR (current_kboard
, echo_string
))
651 ? SCHARS (KVAR (current_kboard
, echo_string
))
655 /* Truncate the current echo message to its first LEN chars.
656 This and echo_char get used by read_key_sequence when the user
657 switches frames while entering a key sequence. */
660 echo_truncate (EMACS_INT nchars
)
662 if (STRINGP (KVAR (current_kboard
, echo_string
)))
663 KVAR (current_kboard
, echo_string
)
664 = Fsubstring (KVAR (current_kboard
, echo_string
),
665 make_number (0), make_number (nchars
));
666 truncate_echo_area (nchars
);
670 /* Functions for manipulating this_command_keys. */
672 add_command_key (Lisp_Object key
)
674 #if 0 /* Not needed after we made Freset_this_command_lengths
675 do the job immediately. */
676 /* If reset-this-command-length was called recently, obey it now.
677 See the doc string of that function for an explanation of why. */
678 if (before_command_restore_flag
)
680 this_command_key_count
= before_command_key_count_1
;
681 if (this_command_key_count
< this_single_command_key_start
)
682 this_single_command_key_start
= this_command_key_count
;
683 echo_truncate (before_command_echo_length_1
);
684 before_command_restore_flag
= 0;
688 if (this_command_key_count
>= ASIZE (this_command_keys
))
689 this_command_keys
= larger_vector (this_command_keys
,
690 2 * ASIZE (this_command_keys
),
693 ASET (this_command_keys
, this_command_key_count
, key
);
694 ++this_command_key_count
;
699 recursive_edit_1 (void)
701 int count
= SPECPDL_INDEX ();
704 if (command_loop_level
> 0)
706 specbind (Qstandard_output
, Qt
);
707 specbind (Qstandard_input
, Qt
);
710 #ifdef HAVE_WINDOW_SYSTEM
711 /* The command loop has started an hourglass timer, so we have to
712 cancel it here, otherwise it will fire because the recursive edit
713 can take some time. Do not check for display_hourglass_p here,
714 because it could already be nil. */
718 /* This function may have been called from a debugger called from
719 within redisplay, for instance by Edebugging a function called
720 from fontification-functions. We want to allow redisplay in
721 the debugging session.
723 The recursive edit is left with a `(throw exit ...)'. The `exit'
724 tag is not caught anywhere in redisplay, i.e. when we leave the
725 recursive edit, the original redisplay leading to the recursive
726 edit will be unwound. The outcome should therefore be safe. */
727 specbind (Qinhibit_redisplay
, Qnil
);
730 val
= command_loop ();
732 Fsignal (Qquit
, Qnil
);
733 /* Handle throw from read_minibuf when using minibuffer
734 while it's active but we're in another window. */
736 xsignal1 (Qerror
, val
);
738 return unbind_to (count
, Qnil
);
741 /* When an auto-save happens, record the "time", and don't do again soon. */
744 record_auto_save (void)
746 last_auto_save
= num_nonmacro_input_events
;
749 /* Make an auto save happen as soon as possible at command level. */
752 force_auto_save_soon (void)
754 last_auto_save
= - auto_save_interval
- 1;
756 record_asynch_buffer_change ();
759 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
760 doc
: /* Invoke the editor command loop recursively.
761 To get out of the recursive edit, a command can do `(throw 'exit nil)';
762 that tells this function to return.
763 Alternatively, `(throw 'exit t)' makes this function signal an error.
764 This function is called by the editor initialization to begin editing. */)
767 int count
= SPECPDL_INDEX ();
770 /* If we enter while input is blocked, don't lock up here.
771 This may happen through the debugger during redisplay. */
775 command_loop_level
++;
776 update_mode_lines
= 1;
778 if (command_loop_level
779 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
780 buffer
= Fcurrent_buffer ();
784 /* If we leave recursive_edit_1 below with a `throw' for instance,
785 like it is done in the splash screen display, we have to
786 make sure that we restore single_kboard as command_loop_1
787 would have done if it were left normally. */
788 if (command_loop_level
> 0)
789 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
790 record_unwind_protect (recursive_edit_unwind
, buffer
);
793 return unbind_to (count
, Qnil
);
797 recursive_edit_unwind (Lisp_Object buffer
)
799 if (BUFFERP (buffer
))
800 Fset_buffer (buffer
);
802 command_loop_level
--;
803 update_mode_lines
= 1;
808 #if 0 /* These two functions are now replaced with
809 temporarily_switch_to_single_kboard. */
813 #if 0 /* Theory: if there's anything in Vunread_command_events,
814 it will right away be read by read_key_sequence,
815 and then if we do switch KBOARDS, it will go into the side
816 queue then. So we don't need to do anything special here -- rms. */
817 if (CONSP (Vunread_command_events
))
819 current_kboard
->kbd_queue
820 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
821 current_kboard
->kbd_queue_has_data
= 1;
823 Vunread_command_events
= Qnil
;
828 /* Switch to the single-kboard state, making current_kboard
829 the only KBOARD from which further input is accepted. */
832 single_kboard_state ()
838 /* If we're in single_kboard state for kboard KBOARD,
842 not_single_kboard_state (KBOARD
*kboard
)
844 if (kboard
== current_kboard
)
848 /* Maintain a stack of kboards, so other parts of Emacs
849 can switch temporarily to the kboard of a given frame
850 and then revert to the previous status. */
855 struct kboard_stack
*next
;
858 static struct kboard_stack
*kboard_stack
;
861 push_kboard (struct kboard
*k
)
863 struct kboard_stack
*p
864 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
866 p
->next
= kboard_stack
;
867 p
->kboard
= current_kboard
;
877 struct kboard_stack
*p
= kboard_stack
;
879 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
881 if (t
->kboard
== p
->kboard
)
883 current_kboard
= p
->kboard
;
890 /* The terminal we remembered has been deleted. */
891 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
894 kboard_stack
= p
->next
;
898 /* Switch to single_kboard mode, making current_kboard the only KBOARD
899 from which further input is accepted. If F is non-nil, set its
900 KBOARD as the current keyboard.
902 This function uses record_unwind_protect to return to the previous
905 If Emacs is already in single_kboard mode, and F's keyboard is
906 locked, then this function will throw an errow. */
909 temporarily_switch_to_single_kboard (struct frame
*f
)
911 int was_locked
= single_kboard
;
914 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
915 /* We can not switch keyboards while in single_kboard mode.
916 In rare cases, Lisp code may call `recursive-edit' (or
917 `read-minibuffer' or `y-or-n-p') after it switched to a
918 locked frame. For example, this is likely to happen
919 when server.el connects to a new terminal while Emacs is in
920 single_kboard mode. It is best to throw an error instead
921 of presenting the user with a frozen screen. */
922 error ("Terminal %d is locked, cannot read from it",
923 FRAME_TERMINAL (f
)->id
);
925 /* This call is unnecessary, but helps
926 `restore_kboard_configuration' discover if somebody changed
927 `current_kboard' behind our back. */
928 push_kboard (current_kboard
);
931 current_kboard
= FRAME_KBOARD (f
);
933 record_unwind_protect (restore_kboard_configuration
,
934 (was_locked
? Qt
: Qnil
));
937 #if 0 /* This function is not needed anymore. */
939 record_single_kboard_state ()
942 push_kboard (current_kboard
);
943 record_unwind_protect (restore_kboard_configuration
,
944 (single_kboard
? Qt
: Qnil
));
949 restore_kboard_configuration (Lisp_Object was_locked
)
951 if (NILP (was_locked
))
955 struct kboard
*prev
= current_kboard
;
958 /* The pop should not change the kboard. */
959 if (single_kboard
&& current_kboard
!= prev
)
966 /* Handle errors that are not handled at inner levels
967 by printing an error message and returning to the editor command loop. */
970 cmd_error (Lisp_Object data
)
972 Lisp_Object old_level
, old_length
;
975 #ifdef HAVE_WINDOW_SYSTEM
976 if (display_hourglass_p
)
980 if (!NILP (executing_kbd_macro
))
982 if (executing_kbd_macro_iterations
== 1)
983 sprintf (macroerror
, "After 1 kbd macro iteration: ");
985 sprintf (macroerror
, "After %d kbd macro iterations: ",
986 executing_kbd_macro_iterations
);
991 Vstandard_output
= Qt
;
992 Vstandard_input
= Qt
;
993 Vexecuting_kbd_macro
= Qnil
;
994 executing_kbd_macro
= Qnil
;
995 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
996 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
999 /* Avoid unquittable loop if data contains a circular list. */
1000 old_level
= Vprint_level
;
1001 old_length
= Vprint_length
;
1002 XSETFASTINT (Vprint_level
, 10);
1003 XSETFASTINT (Vprint_length
, 10);
1004 cmd_error_internal (data
, macroerror
);
1005 Vprint_level
= old_level
;
1006 Vprint_length
= old_length
;
1010 Vinhibit_quit
= Qnil
;
1011 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1012 if (command_loop_level
== 0 && minibuf_level
== 0)
1013 any_kboard_state ();
1016 return make_number (0);
1019 /* Take actions on handling an error. DATA is the data that describes
1022 CONTEXT is a C-string containing ASCII characters only which
1023 describes the context in which the error happened. If we need to
1024 generalize CONTEXT to allow multibyte characters, make it a Lisp
1028 cmd_error_internal (Lisp_Object data
, const char *context
)
1030 struct frame
*sf
= SELECTED_FRAME ();
1032 /* The immediate context is not interesting for Quits,
1033 since they are asyncronous. */
1034 if (EQ (XCAR (data
), Qquit
))
1035 Vsignaling_function
= Qnil
;
1040 /* Use user's specified output function if any. */
1041 if (!NILP (Vcommand_error_function
))
1042 call3 (Vcommand_error_function
, data
,
1043 context
? build_string (context
) : empty_unibyte_string
,
1044 Vsignaling_function
);
1045 /* If the window system or terminal frame hasn't been initialized
1046 yet, or we're not interactive, write the message to stderr and exit. */
1047 else if (!sf
->glyphs_initialized_p
1048 /* The initial frame is a special non-displaying frame. It
1049 will be current in daemon mode when there are no frames
1050 to display, and in non-daemon mode before the real frame
1051 has finished initializing. If an error is thrown in the
1052 latter case while creating the frame, then the frame
1053 will never be displayed, so the safest thing to do is
1054 write to stderr and quit. In daemon mode, there are
1055 many other potential errors that do not prevent frames
1056 from being created, so continuing as normal is better in
1058 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1061 print_error_message (data
, Qexternal_debugging_output
,
1062 context
, Vsignaling_function
);
1063 Fterpri (Qexternal_debugging_output
);
1064 Fkill_emacs (make_number (-1));
1068 clear_message (1, 0);
1070 message_log_maybe_newline ();
1073 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1076 Vsignaling_function
= Qnil
;
1079 Lisp_Object
command_loop_1 (void);
1080 Lisp_Object
command_loop_2 (Lisp_Object
);
1081 Lisp_Object
top_level_1 (Lisp_Object
);
1083 /* Entry to editor-command-loop.
1084 This level has the catches for exiting/returning to editor command loop.
1085 It returns nil to exit recursive edit, t to abort it. */
1090 if (command_loop_level
> 0 || minibuf_level
> 0)
1093 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1094 executing_kbd_macro
= Qnil
;
1100 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1101 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1102 /* Reset single_kboard in case top-level set it while
1103 evaluating an -f option, or we are stuck there for some
1105 any_kboard_state ();
1107 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1108 executing_kbd_macro
= Qnil
;
1110 /* End of file in -batch run causes exit here. */
1116 /* Here we catch errors in execution of commands within the
1117 editing loop, and reenter the editing loop.
1118 When there is an error, cmd_error runs and returns a non-nil
1119 value to us. A value of nil means that command_loop_1 itself
1120 returned due to end of file (or end of kbd macro). */
1123 command_loop_2 (Lisp_Object ignore
)
1125 register Lisp_Object val
;
1128 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1129 while (!NILP (val
));
1137 return Feval (Vtop_level
, Qnil
);
1141 top_level_1 (Lisp_Object ignore
)
1143 /* On entry to the outer level, run the startup file */
1144 if (!NILP (Vtop_level
))
1145 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1146 else if (!NILP (Vpurify_flag
))
1147 message ("Bare impure Emacs (standard Lisp code not loaded)");
1149 message ("Bare Emacs (standard Lisp code not loaded)");
1153 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1154 doc
: /* Exit all recursive editing levels.
1155 This also exits all active minibuffers. */)
1158 #ifdef HAVE_WINDOW_SYSTEM
1159 if (display_hourglass_p
)
1160 cancel_hourglass ();
1163 /* Unblock input if we enter with input blocked. This may happen if
1164 redisplay traps e.g. during tool-bar update with input blocked. */
1165 while (INPUT_BLOCKED_P
)
1168 Fthrow (Qtop_level
, Qnil
);
1171 Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1172 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1173 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1176 if (command_loop_level
> 0 || minibuf_level
> 0)
1177 Fthrow (Qexit
, Qnil
);
1179 error ("No recursive edit is in progress");
1182 Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1183 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1184 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1187 if (command_loop_level
> 0 || minibuf_level
> 0)
1190 error ("No recursive edit is in progress");
1193 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1195 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1196 of this function. */
1199 tracking_off (Lisp_Object old_value
)
1201 do_mouse_tracking
= old_value
;
1202 if (NILP (old_value
))
1204 /* Redisplay may have been preempted because there was input
1205 available, and it assumes it will be called again after the
1206 input has been processed. If the only input available was
1207 the sort that we have just disabled, then we need to call
1209 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1211 redisplay_preserve_echo_area (6);
1212 get_input_pending (&input_pending
,
1213 READABLE_EVENTS_DO_TIMERS_NOW
);
1219 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1220 doc
: /* Evaluate BODY with mouse movement events enabled.
1221 Within a `track-mouse' form, mouse motion generates input events that
1222 you can read with `read-event'.
1223 Normally, mouse motion is ignored.
1224 usage: (track-mouse BODY...) */)
1227 int count
= SPECPDL_INDEX ();
1230 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1232 do_mouse_tracking
= Qt
;
1234 val
= Fprogn (args
);
1235 return unbind_to (count
, val
);
1238 /* If mouse has moved on some frame, return one of those frames.
1242 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1243 after resizing the tool-bar window. */
1245 int ignore_mouse_drag_p
;
1248 some_mouse_moved (void)
1250 Lisp_Object tail
, frame
;
1252 if (ignore_mouse_drag_p
)
1254 /* ignore_mouse_drag_p = 0; */
1258 FOR_EACH_FRAME (tail
, frame
)
1260 if (XFRAME (frame
)->mouse_moved
)
1261 return XFRAME (frame
);
1267 #endif /* HAVE_MOUSE || HAVE_GPM */
1269 /* This is the actual command reading loop,
1270 sans error-handling encapsulation. */
1272 static int read_key_sequence (Lisp_Object
*, size_t, Lisp_Object
,
1274 void safe_run_hooks (Lisp_Object
);
1275 static void adjust_point_for_property (EMACS_INT
, int);
1277 /* Cancel hourglass from protect_unwind.
1279 #ifdef HAVE_WINDOW_SYSTEM
1281 cancel_hourglass_unwind (Lisp_Object arg
)
1283 cancel_hourglass ();
1288 /* FIXME: This is wrong rather than test window-system, we should call
1289 a new set-selection, which will then dispatch to x-set-selection, or
1290 tty-set-selection, or w32-set-selection, ... */
1291 EXFUN (Fwindow_system
, 1);
1294 command_loop_1 (void)
1297 Lisp_Object keybuf
[30];
1299 int prev_modiff
= 0;
1300 struct buffer
*prev_buffer
= NULL
;
1301 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1302 int was_locked
= single_kboard
;
1304 int already_adjusted
= 0;
1306 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1307 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1308 Vdeactivate_mark
= Qnil
;
1309 waiting_for_input
= 0;
1312 this_command_key_count
= 0;
1313 this_command_key_count_reset
= 0;
1314 this_single_command_key_start
= 0;
1316 if (NILP (Vmemory_full
))
1318 /* Make sure this hook runs after commands that get errors and
1319 throw to top level. */
1320 /* Note that the value cell will never directly contain nil
1321 if the symbol is a local variable. */
1322 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1323 safe_run_hooks (Qpost_command_hook
);
1325 /* If displaying a message, resize the echo area window to fit
1326 that message's size exactly. */
1327 if (!NILP (echo_area_buffer
[0]))
1328 resize_echo_area_exactly ();
1330 if (!NILP (Vdeferred_action_list
))
1331 safe_run_hooks (Qdeferred_action_function
);
1334 /* Do this after running Vpost_command_hook, for consistency. */
1335 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1336 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1337 if (!CONSP (last_command_event
))
1338 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1342 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1345 /* Make sure the current window's buffer is selected. */
1346 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1347 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1349 /* Display any malloc warning that just came out. Use while because
1350 displaying one warning can cause another. */
1352 while (pending_malloc_warning
)
1353 display_malloc_warning ();
1355 Vdeactivate_mark
= Qnil
;
1357 /* If minibuffer on and echo area in use,
1358 wait a short time and redraw minibuffer. */
1361 && !NILP (echo_area_buffer
[0])
1362 && EQ (minibuf_window
, echo_area_window
)
1363 && NUMBERP (Vminibuffer_message_timeout
))
1365 /* Bind inhibit-quit to t so that C-g gets read in
1366 rather than quitting back to the minibuffer. */
1367 int count
= SPECPDL_INDEX ();
1368 specbind (Qinhibit_quit
, Qt
);
1370 sit_for (Vminibuffer_message_timeout
, 0, 2);
1372 /* Clear the echo area. */
1374 safe_run_hooks (Qecho_area_clear_hook
);
1376 unbind_to (count
, Qnil
);
1378 /* If a C-g came in before, treat it as input now. */
1379 if (!NILP (Vquit_flag
))
1382 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1387 /* Select the frame that the last event came from. Usually,
1388 switch-frame events will take care of this, but if some lisp
1389 code swallows a switch-frame event, we'll fix things up here.
1390 Is this a good idea? */
1391 if (FRAMEP (internal_last_event_frame
)
1392 && !EQ (internal_last_event_frame
, selected_frame
))
1393 Fselect_frame (internal_last_event_frame
, Qnil
);
1395 /* If it has changed current-menubar from previous value,
1396 really recompute the menubar from the value. */
1397 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1398 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1399 call0 (Qrecompute_lucid_menubar
);
1401 before_command_key_count
= this_command_key_count
;
1402 before_command_echo_length
= echo_length ();
1404 Vthis_command
= Qnil
;
1405 real_this_command
= Qnil
;
1406 Vthis_original_command
= Qnil
;
1407 Vthis_command_keys_shift_translated
= Qnil
;
1409 /* Read next key sequence; i gets its length. */
1410 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1413 /* A filter may have run while we were reading the input. */
1414 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1416 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1417 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1421 /* Now we have read a key sequence of length I,
1422 or else I is 0 and we found end of file. */
1424 if (i
== 0) /* End of file -- happens only in */
1425 return Qnil
; /* a kbd macro, at the end. */
1426 /* -1 means read_key_sequence got a menu that was rejected.
1427 Just loop around and read another command. */
1431 this_command_key_count
= 0;
1432 this_command_key_count_reset
= 0;
1433 this_single_command_key_start
= 0;
1437 last_command_event
= keybuf
[i
- 1];
1439 /* If the previous command tried to force a specific window-start,
1440 forget about that, in case this command moves point far away
1441 from that position. But also throw away beg_unchanged and
1442 end_unchanged information in that case, so that redisplay will
1443 update the whole window properly. */
1444 if (!NILP (XWINDOW (selected_window
)->force_start
))
1447 XWINDOW (selected_window
)->force_start
= Qnil
;
1448 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1449 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1452 cmd
= read_key_sequence_cmd
;
1453 if (!NILP (Vexecuting_kbd_macro
))
1455 if (!NILP (Vquit_flag
))
1457 Vexecuting_kbd_macro
= Qt
;
1458 QUIT
; /* Make some noise. */
1459 /* Will return since macro now empty. */
1463 /* Do redisplay processing after this command except in special
1464 cases identified below. */
1465 prev_buffer
= current_buffer
;
1466 prev_modiff
= MODIFF
;
1467 last_point_position
= PT
;
1468 last_point_position_window
= selected_window
;
1469 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1471 /* By default, we adjust point to a boundary of a region that
1472 has such a property that should be treated intangible
1473 (e.g. composition, display). But, some commands will set
1474 this variable differently. */
1475 Vdisable_point_adjustment
= Qnil
;
1477 /* Process filters and timers may have messed with deactivate-mark.
1478 reset it before we execute the command. */
1479 Vdeactivate_mark
= Qnil
;
1481 /* Remap command through active keymaps */
1482 Vthis_original_command
= cmd
;
1486 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1490 /* Execute the command. */
1492 Vthis_command
= cmd
;
1493 real_this_command
= cmd
;
1494 safe_run_hooks (Qpre_command_hook
);
1496 already_adjusted
= 0;
1498 if (NILP (Vthis_command
))
1500 /* nil means key is undefined. */
1501 Lisp_Object keys
= Fvector (i
, keybuf
);
1502 keys
= Fkey_description (keys
, Qnil
);
1504 message_with_string ("%s is undefined", keys
, 0);
1505 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1506 update_mode_lines
= 1;
1507 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1511 /* Here for a command that isn't executed directly */
1513 #ifdef HAVE_WINDOW_SYSTEM
1514 int scount
= SPECPDL_INDEX ();
1516 if (display_hourglass_p
1517 && NILP (Vexecuting_kbd_macro
))
1519 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1524 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1526 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1528 #ifdef HAVE_WINDOW_SYSTEM
1529 /* Do not check display_hourglass_p here, because
1530 Fcommand_execute could change it, but we should cancel
1531 hourglass cursor anyway.
1532 But don't cancel the hourglass within a macro
1533 just because a command in the macro finishes. */
1534 if (NILP (Vexecuting_kbd_macro
))
1535 unbind_to (scount
, Qnil
);
1538 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1540 safe_run_hooks (Qpost_command_hook
);
1542 /* If displaying a message, resize the echo area window to fit
1543 that message's size exactly. */
1544 if (!NILP (echo_area_buffer
[0]))
1545 resize_echo_area_exactly ();
1547 safe_run_hooks (Qdeferred_action_function
);
1549 /* If there is a prefix argument,
1550 1) We don't want Vlast_command to be ``universal-argument''
1551 (that would be dumb), so don't set Vlast_command,
1552 2) we want to leave echoing on so that the prefix will be
1553 echoed as part of this key sequence, so don't call
1555 3) we want to leave this_command_key_count non-zero, so that
1556 read_char will realize that it is re-reading a character, and
1557 not echo it a second time.
1559 If the command didn't actually create a prefix arg,
1560 but is merely a frame event that is transparent to prefix args,
1561 then the above doesn't apply. */
1562 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1564 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1565 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1566 if (!CONSP (last_command_event
))
1567 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1569 this_command_key_count
= 0;
1570 this_command_key_count_reset
= 0;
1571 this_single_command_key_start
= 0;
1574 if (!NILP (BVAR (current_buffer
, mark_active
))
1575 && !NILP (Vrun_hooks
))
1577 /* In Emacs 22, setting transient-mark-mode to `only' was a
1578 way of turning it on for just one command. This usage is
1579 obsolete, but support it anyway. */
1580 if (EQ (Vtransient_mark_mode
, Qidentity
))
1581 Vtransient_mark_mode
= Qnil
;
1582 else if (EQ (Vtransient_mark_mode
, Qonly
))
1583 Vtransient_mark_mode
= Qidentity
;
1585 if (!NILP (Vdeactivate_mark
))
1586 /* If `select-active-regions' is non-nil, this call to
1587 `deactivate-mark' also sets the PRIMARY selection. */
1588 call0 (Qdeactivate_mark
);
1591 /* Even if not deactivating the mark, set PRIMARY if
1592 `select-active-regions' is non-nil. */
1593 if (!NILP (Fwindow_system (Qnil
))
1594 /* Even if mark_active is non-nil, the actual buffer
1595 marker may not have been set yet (Bug#7044). */
1596 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1597 && (EQ (Vselect_active_regions
, Qonly
)
1598 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1599 : (!NILP (Vselect_active_regions
)
1600 && !NILP (Vtransient_mark_mode
)))
1601 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1604 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1607 call2 (Qx_set_selection
, QPRIMARY
,
1608 make_buffer_string (beg
, end
, 0));
1610 call2 (Qx_set_selection
, QPRIMARY
,
1611 make_buffer_string (end
, beg
, 0));
1612 /* Don't set empty selections. */
1615 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1617 Lisp_Object hook
= intern ("activate-mark-hook");
1618 Frun_hooks (1, &hook
);
1622 Vsaved_region_selection
= Qnil
;
1627 if (current_buffer
== prev_buffer
1628 && last_point_position
!= PT
1629 && NILP (Vdisable_point_adjustment
)
1630 && NILP (Vglobal_disable_point_adjustment
))
1632 if (last_point_position
> BEGV
1633 && last_point_position
< ZV
1634 && (composition_adjust_point (last_point_position
,
1635 last_point_position
)
1636 != last_point_position
))
1637 /* The last point was temporarily set within a grapheme
1638 cluster to prevent automatic composition. To recover
1639 the automatic composition, we must update the
1641 windows_or_buffers_changed
++;
1642 if (!already_adjusted
)
1643 adjust_point_for_property (last_point_position
,
1644 MODIFF
!= prev_modiff
);
1647 /* Install chars successfully executed in kbd macro. */
1649 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1650 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1651 finalize_kbd_macro_chars ();
1652 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1654 any_kboard_state ();
1659 /* Adjust point to a boundary of a region that has such a property
1660 that should be treated intangible. For the moment, we check
1661 `composition', `display' and `invisible' properties.
1662 LAST_PT is the last position of point. */
1665 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1668 Lisp_Object val
, overlay
, tmp
;
1669 /* When called after buffer modification, we should temporarily
1670 suppress the point adjustment for automatic composition so that a
1671 user can keep inserting another character at point or keep
1672 deleting characters around point. */
1673 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1674 EMACS_INT orig_pt
= PT
;
1676 /* FIXME: cycling is probably not necessary because these properties
1677 can't be usefully combined anyway. */
1678 while (check_composition
|| check_display
|| check_invisible
)
1680 /* FIXME: check `intangible'. */
1681 if (check_composition
1682 && PT
> BEGV
&& PT
< ZV
1683 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1686 check_display
= check_invisible
= 1;
1688 check_composition
= 0;
1690 && PT
> BEGV
&& PT
< ZV
1691 && !NILP (val
= get_char_property_and_overlay
1692 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1693 && display_prop_intangible_p (val
)
1694 && (!OVERLAYP (overlay
)
1695 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1696 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1697 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1698 && (beg
< PT
/* && end > PT <- It's always the case. */
1699 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1702 SET_PT (PT
< last_pt
1703 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1705 check_composition
= check_invisible
= 1;
1708 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1710 int inv
, ellipsis
= 0;
1713 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1716 /* FIXME: We should stop if we find a spot between
1717 two runs of `invisible' where inserted text would
1718 be visible. This is important when we have two
1719 invisible boundaries that enclose an area: if the
1720 area is empty, we need this test in order to make
1721 it possible to place point in the middle rather
1722 than skip both boundaries. However, this code
1723 also stops anywhere in a non-sticky text-property,
1724 which breaks (e.g.) Org mode. */
1725 && (val
= get_pos_property (make_number (end
),
1727 TEXT_PROP_MEANS_INVISIBLE (val
))
1729 && !NILP (val
= get_char_property_and_overlay
1730 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1731 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1733 ellipsis
= ellipsis
|| inv
> 1
1734 || (OVERLAYP (overlay
)
1735 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1736 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1737 tmp
= Fnext_single_char_property_change
1738 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1739 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1743 && (val
= get_pos_property (make_number (beg
),
1745 TEXT_PROP_MEANS_INVISIBLE (val
))
1747 && !NILP (val
= get_char_property_and_overlay
1748 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1749 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1751 ellipsis
= ellipsis
|| inv
> 1
1752 || (OVERLAYP (overlay
)
1753 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1754 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1755 tmp
= Fprevious_single_char_property_change
1756 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1757 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1760 /* Move away from the inside area. */
1761 if (beg
< PT
&& end
> PT
)
1763 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1764 /* We haven't moved yet (so we don't need to fear
1765 infinite-looping) and we were outside the range
1766 before (so either end of the range still corresponds
1767 to a move in the right direction): pretend we moved
1768 less than we actually did, so that we still have
1769 more freedom below in choosing which end of the range
1771 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1772 /* We either have moved already or the last point
1773 was already in the range: we don't get to choose
1774 which end of the range we have to go to. */
1775 : (PT
< last_pt
? beg
: end
));
1776 check_composition
= check_display
= 1;
1778 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1779 the point to something other than its argument, due to
1780 point-motion hooks, intangibility, etc. */
1781 xassert (PT
== beg
|| PT
== end
);
1784 /* Pretend the area doesn't exist if the buffer is not
1786 if (!modified
&& !ellipsis
&& beg
< end
)
1788 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1789 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1790 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1791 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1792 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1793 /* We've already moved as far as we can. Trying to go
1794 to the other end would mean moving backwards and thus
1795 could lead to an infinite loop. */
1797 else if (val
= get_pos_property (make_number (PT
),
1799 TEXT_PROP_MEANS_INVISIBLE (val
)
1800 && (val
= get_pos_property
1801 (make_number (PT
== beg
? end
: beg
),
1803 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1804 (check_composition
= check_display
= 1,
1805 SET_PT (PT
== beg
? end
: beg
));
1808 check_invisible
= 0;
1812 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1815 safe_run_hooks_1 (void)
1817 eassert (CONSP (Vinhibit_quit
));
1818 return call0 (XCDR (Vinhibit_quit
));
1821 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1825 safe_run_hooks_error (Lisp_Object error_data
)
1828 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1829 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1830 Lisp_Object args
[4];
1831 args
[0] = build_string ("Error in %s (%s): %s");
1834 args
[3] = error_data
;
1840 Lisp_Object newval
= Qnil
;
1841 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1842 if (EQ (fun
, XCAR (val
)))
1845 newval
= Fcons (XCAR (val
), newval
);
1847 return Fset (hook
, Fnreverse (newval
));
1848 /* Not found in the local part of the hook. Let's look at the global
1851 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1852 : Fdefault_value (hook
));
1853 CONSP (val
); val
= XCDR (val
))
1854 if (EQ (fun
, XCAR (val
)))
1857 newval
= Fcons (XCAR (val
), newval
);
1859 return Fset_default (hook
, Fnreverse (newval
));
1865 safe_run_hook_funcall (size_t nargs
, Lisp_Object
*args
)
1867 eassert (nargs
== 1);
1868 if (CONSP (Vinhibit_quit
))
1869 XSETCDR (Vinhibit_quit
, args
[0]);
1871 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1873 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1877 /* If we get an error while running the hook, cause the hook variable
1878 to be nil. Also inhibit quits, so that C-g won't cause the hook
1879 to mysteriously evaporate. */
1882 safe_run_hooks (Lisp_Object hook
)
1884 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1885 to its body or to its handlers other than via globals such as
1886 dynamically-bound variables ;-) */
1887 int count
= SPECPDL_INDEX ();
1888 specbind (Qinhibit_quit
, hook
);
1890 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1892 unbind_to (count
, Qnil
);
1896 /* Nonzero means polling for input is temporarily suppressed. */
1898 int poll_suppress_count
;
1900 /* Asynchronous timer for polling. */
1902 struct atimer
*poll_timer
;
1905 #ifdef POLL_FOR_INPUT
1907 /* Poll for input, so that we catch a C-g if it comes in. This
1908 function is called from x_make_frame_visible, see comment
1912 poll_for_input_1 (void)
1914 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1915 doing anything dangerous. */
1919 if (interrupt_input_blocked
== 0
1920 && !waiting_for_input
)
1921 read_avail_input (0);
1927 /* Timer callback function for poll_timer. TIMER is equal to
1931 poll_for_input (struct atimer
*timer
)
1933 if (poll_suppress_count
== 0)
1936 interrupt_input_pending
= 1;
1937 pending_signals
= 1;
1939 poll_for_input_1 ();
1944 #endif /* POLL_FOR_INPUT */
1946 /* Begin signals to poll for input, if they are appropriate.
1947 This function is called unconditionally from various places. */
1950 start_polling (void)
1952 #ifdef POLL_FOR_INPUT
1953 /* XXX This condition was (read_socket_hook && !interrupt_input),
1954 but read_socket_hook is not global anymore. Let's pretend that
1956 if (!interrupt_input
)
1958 /* Turn alarm handling on unconditionally. It might have
1959 been turned off in process.c. */
1960 turn_on_atimers (1);
1962 /* If poll timer doesn't exist, are we need one with
1963 a different interval, start a new one. */
1964 if (poll_timer
== NULL
1965 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1967 EMACS_TIME interval
;
1970 cancel_atimer (poll_timer
);
1972 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1973 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1974 poll_for_input
, NULL
);
1977 /* Let the timer's callback function poll for input
1978 if this becomes zero. */
1979 --poll_suppress_count
;
1984 /* Nonzero if we are using polling to handle input asynchronously. */
1987 input_polling_used (void)
1989 #ifdef POLL_FOR_INPUT
1990 /* XXX This condition was (read_socket_hook && !interrupt_input),
1991 but read_socket_hook is not global anymore. Let's pretend that
1993 return !interrupt_input
;
1999 /* Turn off polling. */
2004 #ifdef POLL_FOR_INPUT
2005 /* XXX This condition was (read_socket_hook && !interrupt_input),
2006 but read_socket_hook is not global anymore. Let's pretend that
2008 if (!interrupt_input
)
2009 ++poll_suppress_count
;
2013 /* Set the value of poll_suppress_count to COUNT
2014 and start or stop polling accordingly. */
2017 set_poll_suppress_count (int count
)
2019 #ifdef POLL_FOR_INPUT
2020 if (count
== 0 && poll_suppress_count
!= 0)
2022 poll_suppress_count
= 1;
2025 else if (count
!= 0 && poll_suppress_count
== 0)
2029 poll_suppress_count
= count
;
2033 /* Bind polling_period to a value at least N.
2034 But don't decrease it. */
2037 bind_polling_period (int n
)
2039 #ifdef POLL_FOR_INPUT
2040 int new = polling_period
;
2045 stop_other_atimers (poll_timer
);
2047 specbind (Qpolling_period
, make_number (new));
2048 /* Start a new alarm with the new period. */
2053 /* Apply the control modifier to CHARACTER. */
2056 make_ctrl_char (int c
)
2058 /* Save the upper bits here. */
2059 int upper
= c
& ~0177;
2061 if (! ASCII_BYTE_P (c
))
2062 return c
|= ctrl_modifier
;
2066 /* Everything in the columns containing the upper-case letters
2067 denotes a control character. */
2068 if (c
>= 0100 && c
< 0140)
2072 /* Set the shift modifier for a control char
2073 made from a shifted letter. But only for letters! */
2074 if (oc
>= 'A' && oc
<= 'Z')
2075 c
|= shift_modifier
;
2078 /* The lower-case letters denote control characters too. */
2079 else if (c
>= 'a' && c
<= 'z')
2082 /* Include the bits for control and shift
2083 only if the basic ASCII code can't indicate them. */
2087 /* Replace the high bits. */
2088 c
|= (upper
& ~ctrl_modifier
);
2093 /* Display the help-echo property of the character after the mouse pointer.
2094 Either show it in the echo area, or call show-help-function to display
2095 it by other means (maybe in a tooltip).
2097 If HELP is nil, that means clear the previous help echo.
2099 If HELP is a string, display that string. If HELP is a function,
2100 call it with OBJECT and POS as arguments; the function should
2101 return a help string or nil for none. For all other types of HELP,
2102 evaluate it to obtain a string.
2104 WINDOW is the window in which the help was generated, if any.
2105 It is nil if not in a window.
2107 If OBJECT is a buffer, POS is the position in the buffer where the
2108 `help-echo' text property was found.
2110 If OBJECT is an overlay, that overlay has a `help-echo' property,
2111 and POS is the position in the overlay's buffer under the mouse.
2113 If OBJECT is a string (an overlay string or a string displayed with
2114 the `display' property). POS is the position in that string under
2117 Note: this function may only be called with HELP nil or a string
2118 from X code running asynchronously. */
2121 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2124 if (!NILP (help
) && !STRINGP (help
))
2126 if (FUNCTIONP (help
))
2128 Lisp_Object args
[4];
2133 help
= safe_call (4, args
);
2136 help
= safe_eval (help
);
2138 if (!STRINGP (help
))
2142 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2143 if (!noninteractive
&& STRINGP (help
))
2145 /* The mouse-fixup-help-message Lisp function can call
2146 mouse_position_hook, which resets the mouse_moved flags.
2147 This causes trouble if we are trying to read a mouse motion
2148 event (i.e., if we are inside a `track-mouse' form), so we
2149 restore the mouse_moved flag. */
2150 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2151 help
= call1 (Qmouse_fixup_help_message
, help
);
2157 if (STRINGP (help
) || NILP (help
))
2159 if (!NILP (Vshow_help_function
))
2160 call1 (Vshow_help_function
, help
);
2161 help_echo_showing_p
= STRINGP (help
);
2167 /* Input of single characters from keyboard */
2169 Lisp_Object
print_help (Lisp_Object object
);
2170 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2171 struct timeval
*end_time
);
2172 static void record_char (Lisp_Object c
);
2174 static Lisp_Object help_form_saved_window_configs
;
2176 read_char_help_form_unwind (Lisp_Object arg
)
2178 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2179 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2180 if (!NILP (window_config
))
2181 Fset_window_configuration (window_config
);
2185 #define STOP_POLLING \
2186 do { if (! polling_stopped_here) stop_polling (); \
2187 polling_stopped_here = 1; } while (0)
2189 #define RESUME_POLLING \
2190 do { if (polling_stopped_here) start_polling (); \
2191 polling_stopped_here = 0; } while (0)
2193 /* read a character from the keyboard; call the redisplay if needed */
2194 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2195 -1 means do not do redisplay, but do do autosaving.
2198 /* The arguments MAPS and NMAPS are for menu prompting.
2199 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2201 PREV_EVENT is the previous input event, or nil if we are reading
2202 the first event of a key sequence (or not reading a key sequence).
2203 If PREV_EVENT is t, that is a "magic" value that says
2204 not to run input methods, but in other respects to act as if
2205 not reading a key sequence.
2207 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2208 if we used a mouse menu to read the input, or zero otherwise. If
2209 USED_MOUSE_MENU is null, we don't dereference it.
2211 Value is -2 when we find input on another keyboard. A second call
2212 to read_char will read it.
2214 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2215 specifying the maximum time to wait until. If no input arrives by
2216 that time, stop waiting and return nil.
2218 Value is t if we showed a menu and the user rejected it. */
2221 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2222 int *used_mouse_menu
, struct timeval
*end_time
)
2224 volatile Lisp_Object c
;
2226 jmp_buf local_getcjmp
;
2228 volatile int key_already_recorded
= 0;
2229 Lisp_Object tem
, save
;
2230 volatile Lisp_Object previous_echo_area_message
;
2231 volatile Lisp_Object also_record
;
2232 volatile int reread
;
2233 struct gcpro gcpro1
, gcpro2
;
2234 int polling_stopped_here
= 0;
2235 struct kboard
*orig_kboard
= current_kboard
;
2239 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2240 before_command_key_count
= this_command_key_count
;
2241 before_command_echo_length
= echo_length ();
2244 previous_echo_area_message
= Qnil
;
2246 GCPRO2 (c
, previous_echo_area_message
);
2251 if (CONSP (Vunread_post_input_method_events
))
2253 c
= XCAR (Vunread_post_input_method_events
);
2254 Vunread_post_input_method_events
2255 = XCDR (Vunread_post_input_method_events
);
2257 /* Undo what read_char_x_menu_prompt did when it unread
2258 additional keys returned by Fx_popup_menu. */
2260 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2268 if (unread_command_char
!= -1)
2270 XSETINT (c
, unread_command_char
);
2271 unread_command_char
= -1;
2277 if (CONSP (Vunread_command_events
))
2279 int was_disabled
= 0;
2281 c
= XCAR (Vunread_command_events
);
2282 Vunread_command_events
= XCDR (Vunread_command_events
);
2286 /* Undo what sit-for did when it unread additional keys
2287 inside universal-argument. */
2290 && EQ (XCAR (c
), Qt
))
2296 /* Undo what read_char_x_menu_prompt did when it unread
2297 additional keys returned by Fx_popup_menu. */
2299 && EQ (XCDR (c
), Qdisabled
)
2300 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2306 /* If the queued event is something that used the mouse,
2307 set used_mouse_menu accordingly. */
2309 /* Also check was_disabled so last-nonmenu-event won't return
2310 a bad value when submenus are involved. (Bug#447) */
2311 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2312 *used_mouse_menu
= 1;
2314 goto reread_for_input_method
;
2317 if (CONSP (Vunread_input_method_events
))
2319 c
= XCAR (Vunread_input_method_events
);
2320 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2322 /* Undo what read_char_x_menu_prompt did when it unread
2323 additional keys returned by Fx_popup_menu. */
2325 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2329 goto reread_for_input_method
;
2332 this_command_key_count_reset
= 0;
2334 if (!NILP (Vexecuting_kbd_macro
))
2336 /* We set this to Qmacro; since that's not a frame, nobody will
2337 try to switch frames on us, and the selected window will
2340 Since this event came from a macro, it would be misleading to
2341 leave internal_last_event_frame set to wherever the last
2342 real event came from. Normally, a switch-frame event selects
2343 internal_last_event_frame after each command is read, but
2344 events read from a macro should never cause a new frame to be
2346 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2348 /* Exit the macro if we are at the end.
2349 Also, some things replace the macro with t
2350 to force an early exit. */
2351 if (EQ (Vexecuting_kbd_macro
, Qt
)
2352 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2358 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2359 if (STRINGP (Vexecuting_kbd_macro
)
2360 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2361 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2363 executing_kbd_macro_index
++;
2368 if (!NILP (unread_switch_frame
))
2370 c
= unread_switch_frame
;
2371 unread_switch_frame
= Qnil
;
2373 /* This event should make it into this_command_keys, and get echoed
2374 again, so we do not set `reread'. */
2378 /* if redisplay was requested */
2379 if (commandflag
>= 0)
2381 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2383 /* If there is pending input, process any events which are not
2384 user-visible, such as X selection_request events. */
2386 || detect_input_pending_run_timers (0))
2387 swallow_events (0); /* may clear input_pending */
2389 /* Redisplay if no pending input. */
2390 while (!input_pending
)
2392 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2393 redisplay_preserve_echo_area (5);
2398 /* Normal case: no input arrived during redisplay. */
2401 /* Input arrived and pre-empted redisplay.
2402 Process any events which are not user-visible. */
2404 /* If that cleared input_pending, try again to redisplay. */
2407 /* Prevent the redisplay we just did
2408 from messing up echoing of the input after the prompt. */
2409 if (commandflag
== 0 && echo_current
)
2410 echo_message_buffer
= echo_area_buffer
[0];
2414 /* Message turns off echoing unless more keystrokes turn it on again.
2416 The code in 20.x for the condition was
2418 1. echo_area_glyphs && *echo_area_glyphs
2419 2. && echo_area_glyphs != current_kboard->echobuf
2420 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2422 (1) means there's a current message displayed
2424 (2) means it's not the message from echoing from the current
2427 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2428 is set to a non-null value. This is done in read_char and it is
2429 set to echo_area_glyphs after a call to echo_char. That means
2430 ok_to_echo_at_next_pause is either null or
2431 current_kboard->echobuf with the appropriate current_kboard at
2434 So, condition (3) means in clear text ok_to_echo_at_next_pause
2435 must be either null, or the current message isn't from echoing at
2436 all, or it's from echoing from a different kboard than the
2439 if (/* There currently is something in the echo area. */
2440 !NILP (echo_area_buffer
[0])
2441 && (/* And it's either not from echoing. */
2442 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2443 /* Or it's an echo from a different kboard. */
2444 || echo_kboard
!= current_kboard
2445 /* Or we explicitly allow overwriting whatever there is. */
2446 || ok_to_echo_at_next_pause
== NULL
))
2451 /* Try reading a character via menu prompting in the minibuf.
2452 Try this before the sit-for, because the sit-for
2453 would do the wrong thing if we are supposed to do
2454 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2455 after a mouse event so don't try a minibuf menu. */
2457 if (nmaps
> 0 && INTERACTIVE
2458 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2459 /* Don't bring up a menu if we already have another event. */
2460 && NILP (Vunread_command_events
)
2461 && unread_command_char
< 0
2462 && !detect_input_pending_run_timers (0))
2464 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2466 if (INTEGERP (c
) && XINT (c
) == -2)
2467 return c
; /* wrong_kboard_jmpbuf */
2471 key_already_recorded
= 1;
2476 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2477 We will do that below, temporarily for short sections of code,
2478 when appropriate. local_getcjmp must be in effect
2479 around any call to sit_for or kbd_buffer_get_event;
2480 it *must not* be in effect when we call redisplay. */
2482 jmpcount
= SPECPDL_INDEX ();
2483 if (_setjmp (local_getcjmp
))
2485 /* Handle quits while reading the keyboard. */
2486 /* We must have saved the outer value of getcjmp here,
2487 so restore it now. */
2488 restore_getcjmp (save_jump
);
2489 unbind_to (jmpcount
, Qnil
);
2490 XSETINT (c
, quit_char
);
2491 internal_last_event_frame
= selected_frame
;
2492 Vlast_event_frame
= internal_last_event_frame
;
2493 /* If we report the quit char as an event,
2494 don't do so more than once. */
2495 if (!NILP (Vinhibit_quit
))
2499 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2500 if (kb
!= current_kboard
)
2502 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2503 /* We shouldn't get here if we were in single-kboard mode! */
2508 while (CONSP (XCDR (last
)))
2510 if (!NILP (XCDR (last
)))
2514 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2516 XSETCDR (last
, Fcons (c
, Qnil
));
2517 kb
->kbd_queue_has_data
= 1;
2518 current_kboard
= kb
;
2519 /* This is going to exit from read_char
2520 so we had better get rid of this frame's stuff. */
2522 return make_number (-2); /* wrong_kboard_jmpbuf */
2528 /* Start idle timers if no time limit is supplied. We don't do it
2529 if a time limit is supplied to avoid an infinite recursion in the
2530 situation where an idle timer calls `sit-for'. */
2533 timer_start_idle ();
2535 /* If in middle of key sequence and minibuffer not active,
2536 start echoing if enough time elapses. */
2538 if (minibuf_level
== 0
2540 && !current_kboard
->immediate_echo
2541 && this_command_key_count
> 0
2543 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2544 && NILP (Fzerop (Vecho_keystrokes
))
2545 && (/* No message. */
2546 NILP (echo_area_buffer
[0])
2547 /* Or empty message. */
2548 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2549 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2550 /* Or already echoing from same kboard. */
2551 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2552 /* Or not echoing before and echoing allowed. */
2553 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2555 /* After a mouse event, start echoing right away.
2556 This is because we are probably about to display a menu,
2557 and we don't want to delay before doing so. */
2558 if (EVENT_HAS_PARAMETERS (prev_event
))
2564 save_getcjmp (save_jump
);
2565 restore_getcjmp (local_getcjmp
);
2566 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2567 restore_getcjmp (save_jump
);
2569 && ! CONSP (Vunread_command_events
))
2574 /* Maybe auto save due to number of keystrokes. */
2576 if (commandflag
!= 0
2577 && auto_save_interval
> 0
2578 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2579 && !detect_input_pending_run_timers (0))
2581 Fdo_auto_save (Qnil
, Qnil
);
2582 /* Hooks can actually change some buffers in auto save. */
2586 /* Try reading using an X menu.
2587 This is never confused with reading using the minibuf
2588 because the recursive call of read_char in read_char_minibuf_menu_prompt
2589 does not pass on any keymaps. */
2591 if (nmaps
> 0 && INTERACTIVE
2592 && !NILP (prev_event
)
2593 && EVENT_HAS_PARAMETERS (prev_event
)
2594 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2595 && !EQ (XCAR (prev_event
), Qtool_bar
)
2596 /* Don't bring up a menu if we already have another event. */
2597 && NILP (Vunread_command_events
)
2598 && unread_command_char
< 0)
2600 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2602 /* Now that we have read an event, Emacs is not idle. */
2609 /* Maybe autosave and/or garbage collect due to idleness. */
2611 if (INTERACTIVE
&& NILP (c
))
2614 EMACS_INT buffer_size
;
2616 /* Slow down auto saves logarithmically in size of current buffer,
2617 and garbage collect while we're at it. */
2618 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2619 last_non_minibuf_size
= Z
- BEG
;
2620 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2622 while (buffer_size
> 64)
2623 delay_level
++, buffer_size
-= buffer_size
>> 2;
2624 if (delay_level
< 4) delay_level
= 4;
2625 /* delay_level is 4 for files under around 50k, 7 at 100k,
2626 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2628 /* Auto save if enough time goes by without input. */
2629 if (commandflag
!= 0
2630 && num_nonmacro_input_events
> last_auto_save
2631 && INTEGERP (Vauto_save_timeout
)
2632 && XINT (Vauto_save_timeout
) > 0)
2635 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2637 save_getcjmp (save_jump
);
2638 restore_getcjmp (local_getcjmp
);
2639 tem0
= sit_for (make_number (timeout
), 1, 1);
2640 restore_getcjmp (save_jump
);
2643 && ! CONSP (Vunread_command_events
))
2645 Fdo_auto_save (Qnil
, Qnil
);
2647 /* If we have auto-saved and there is still no input
2648 available, garbage collect if there has been enough
2649 consing going on to make it worthwhile. */
2650 if (!detect_input_pending_run_timers (0)
2651 && consing_since_gc
> gc_cons_threshold
/ 2)
2652 Fgarbage_collect ();
2659 /* Notify the caller if an autosave hook, or a timer, sentinel or
2660 filter in the sit_for calls above have changed the current
2661 kboard. This could happen if they use the minibuffer or start a
2662 recursive edit, like the fancy splash screen in server.el's
2663 filter. If this longjmp wasn't here, read_key_sequence would
2664 interpret the next key sequence using the wrong translation
2665 tables and function keymaps. */
2666 if (NILP (c
) && current_kboard
!= orig_kboard
)
2669 return make_number (-2); /* wrong_kboard_jmpbuf */
2672 /* If this has become non-nil here, it has been set by a timer
2673 or sentinel or filter. */
2674 if (CONSP (Vunread_command_events
))
2676 c
= XCAR (Vunread_command_events
);
2677 Vunread_command_events
= XCDR (Vunread_command_events
);
2680 /* Read something from current KBOARD's side queue, if possible. */
2684 if (current_kboard
->kbd_queue_has_data
)
2686 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2688 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2689 KVAR (current_kboard
, kbd_queue
)
2690 = XCDR (KVAR (current_kboard
, kbd_queue
));
2691 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2692 current_kboard
->kbd_queue_has_data
= 0;
2693 input_pending
= readable_events (0);
2694 if (EVENT_HAS_PARAMETERS (c
)
2695 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2696 internal_last_event_frame
= XCAR (XCDR (c
));
2697 Vlast_event_frame
= internal_last_event_frame
;
2701 /* If current_kboard's side queue is empty check the other kboards.
2702 If one of them has data that we have not yet seen here,
2703 switch to it and process the data waiting for it.
2705 Note: if the events queued up for another kboard
2706 have already been seen here, and therefore are not a complete command,
2707 the kbd_queue_has_data field is 0, so we skip that kboard here.
2708 That's to avoid an infinite loop switching between kboards here. */
2709 if (NILP (c
) && !single_kboard
)
2712 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2713 if (kb
->kbd_queue_has_data
)
2715 current_kboard
= kb
;
2716 /* This is going to exit from read_char
2717 so we had better get rid of this frame's stuff. */
2719 return make_number (-2); /* wrong_kboard_jmpbuf */
2727 /* Finally, we read from the main queue,
2728 and if that gives us something we can't use yet, we put it on the
2729 appropriate side queue and try again. */
2733 KBOARD
*kb
IF_LINT (= NULL
);
2738 EMACS_GET_TIME (now
);
2739 if (EMACS_TIME_GE (now
, *end_time
))
2743 /* Actually read a character, waiting if necessary. */
2744 save_getcjmp (save_jump
);
2745 restore_getcjmp (local_getcjmp
);
2747 timer_start_idle ();
2748 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2749 restore_getcjmp (save_jump
);
2751 if (! NILP (c
) && (kb
!= current_kboard
))
2753 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2756 while (CONSP (XCDR (last
)))
2758 if (!NILP (XCDR (last
)))
2762 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2764 XSETCDR (last
, Fcons (c
, Qnil
));
2765 kb
->kbd_queue_has_data
= 1;
2769 current_kboard
= kb
;
2770 /* This is going to exit from read_char
2771 so we had better get rid of this frame's stuff. */
2773 return make_number (-2);
2777 /* Terminate Emacs in batch mode if at eof. */
2778 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2779 Fkill_emacs (make_number (1));
2783 /* Add in any extra modifiers, where appropriate. */
2784 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2785 || ((extra_keyboard_modifiers
& 0177) < ' '
2786 && (extra_keyboard_modifiers
& 0177) != 0))
2787 XSETINT (c
, make_ctrl_char (XINT (c
)));
2789 /* Transfer any other modifier bits directly from
2790 extra_keyboard_modifiers to c. Ignore the actual character code
2791 in the low 16 bits of extra_keyboard_modifiers. */
2792 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2803 if (commandflag
>= 0
2804 && !input_pending
&& !detect_input_pending_run_timers (0))
2812 /* Buffer switch events are only for internal wakeups
2813 so don't show them to the user.
2814 Also, don't record a key if we already did. */
2815 if (BUFFERP (c
) || key_already_recorded
)
2818 /* Process special events within read_char
2819 and loop around to read another event. */
2822 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2827 struct buffer
*prev_buffer
= current_buffer
;
2828 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2829 int was_locked
= single_kboard
;
2830 int count
= SPECPDL_INDEX ();
2831 record_single_kboard_state ();
2834 last_input_event
= c
;
2835 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2837 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2838 /* We stopped being idle for this event; undo that. This
2839 prevents automatic window selection (under
2840 mouse_autoselect_window from acting as a real input event, for
2841 example banishing the mouse under mouse-avoidance-mode. */
2842 timer_resume_idle ();
2844 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2845 /* Resume allowing input from any kboard, if that was true before. */
2847 any_kboard_state ();
2848 unbind_to (count
, Qnil
);
2851 if (current_buffer
!= prev_buffer
)
2853 /* The command may have changed the keymaps. Pretend there
2854 is input in another keyboard and return. This will
2855 recalculate keymaps. */
2856 c
= make_number (-2);
2863 /* Handle things that only apply to characters. */
2866 /* If kbd_buffer_get_event gave us an EOF, return that. */
2870 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2871 && SCHARS (KVAR (current_kboard
, Vkeyboard_translate_table
)) > (unsigned) XFASTINT (c
))
2872 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2873 && XVECTOR (KVAR (current_kboard
, Vkeyboard_translate_table
))->size
> (unsigned) XFASTINT (c
))
2874 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2878 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2879 /* nil in keyboard-translate-table means no translation. */
2885 /* If this event is a mouse click in the menu bar,
2886 return just menu-bar for now. Modify the mouse click event
2887 so we won't do this twice, then queue it up. */
2888 if (EVENT_HAS_PARAMETERS (c
)
2890 && CONSP (EVENT_START (c
))
2891 && CONSP (XCDR (EVENT_START (c
))))
2895 posn
= POSN_POSN (EVENT_START (c
));
2896 /* Handle menu-bar events:
2897 insert the dummy prefix event `menu-bar'. */
2898 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2900 /* Change menu-bar to (menu-bar) as the event "position". */
2901 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2904 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2909 /* Store these characters into recent_keys, the dribble file if any,
2910 and the keyboard macro being defined, if any. */
2912 if (! NILP (also_record
))
2913 record_char (also_record
);
2915 /* Wipe the echo area.
2916 But first, if we are about to use an input method,
2917 save the echo area contents for it to refer to. */
2919 && ! NILP (Vinput_method_function
)
2920 && (unsigned) XINT (c
) >= ' '
2921 && (unsigned) XINT (c
) != 127
2922 && (unsigned) XINT (c
) < 256)
2924 previous_echo_area_message
= Fcurrent_message ();
2925 Vinput_method_previous_message
= previous_echo_area_message
;
2928 /* Now wipe the echo area, except for help events which do their
2929 own stuff with the echo area. */
2931 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2932 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2934 if (!NILP (echo_area_buffer
[0]))
2935 safe_run_hooks (Qecho_area_clear_hook
);
2936 clear_message (1, 0);
2939 reread_for_input_method
:
2941 /* Pass this to the input method, if appropriate. */
2943 && ! NILP (Vinput_method_function
)
2944 /* Don't run the input method within a key sequence,
2945 after the first event of the key sequence. */
2946 && NILP (prev_event
)
2947 && (unsigned) XINT (c
) >= ' '
2948 && (unsigned) XINT (c
) != 127
2949 && (unsigned) XINT (c
) < 256)
2952 int key_count
, key_count_reset
;
2953 struct gcpro inner_gcpro1
;
2954 int count
= SPECPDL_INDEX ();
2956 /* Save the echo status. */
2957 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2958 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2959 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2960 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2963 if (before_command_restore_flag
)
2965 this_command_key_count
= before_command_key_count_1
;
2966 if (this_command_key_count
< this_single_command_key_start
)
2967 this_single_command_key_start
= this_command_key_count
;
2968 echo_truncate (before_command_echo_length_1
);
2969 before_command_restore_flag
= 0;
2973 /* Save the this_command_keys status. */
2974 key_count
= this_command_key_count
;
2975 key_count_reset
= this_command_key_count_reset
;
2978 keys
= Fcopy_sequence (this_command_keys
);
2981 GCPRO1_VAR (keys
, inner_gcpro
);
2983 /* Clear out this_command_keys. */
2984 this_command_key_count
= 0;
2985 this_command_key_count_reset
= 0;
2987 /* Now wipe the echo area. */
2988 if (!NILP (echo_area_buffer
[0]))
2989 safe_run_hooks (Qecho_area_clear_hook
);
2990 clear_message (1, 0);
2993 /* If we are not reading a key sequence,
2994 never use the echo area. */
2997 specbind (Qinput_method_use_echo_area
, Qt
);
3000 /* Call the input method. */
3001 tem
= call1 (Vinput_method_function
, c
);
3003 tem
= unbind_to (count
, tem
);
3005 /* Restore the saved echoing state
3006 and this_command_keys state. */
3007 this_command_key_count
= key_count
;
3008 this_command_key_count_reset
= key_count_reset
;
3010 this_command_keys
= keys
;
3013 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3014 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3015 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3016 if (saved_immediate_echo
)
3019 UNGCPRO_VAR (inner_gcpro
);
3021 /* The input method can return no events. */
3024 /* Bring back the previous message, if any. */
3025 if (! NILP (previous_echo_area_message
))
3026 message_with_string ("%s", previous_echo_area_message
, 0);
3029 /* It returned one event or more. */
3031 Vunread_post_input_method_events
3032 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3037 /* Display help if not echoing. */
3038 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3040 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3041 Lisp_Object help
, object
, position
, window
, htem
;
3043 htem
= Fcdr (XCDR (c
));
3046 window
= Fcar (htem
);
3048 object
= Fcar (htem
);
3050 position
= Fcar (htem
);
3052 show_help_echo (help
, window
, object
, position
);
3054 /* We stopped being idle for this event; undo that. */
3056 timer_resume_idle ();
3060 if ((! reread
|| this_command_key_count
== 0
3061 || this_command_key_count_reset
)
3065 /* Don't echo mouse motion events. */
3066 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3067 && NILP (Fzerop (Vecho_keystrokes
))
3068 && ! (EVENT_HAS_PARAMETERS (c
)
3069 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3072 if (! NILP (also_record
))
3073 echo_char (also_record
);
3074 /* Once we reread a character, echoing can happen
3075 the next time we pause to read a new one. */
3076 ok_to_echo_at_next_pause
= current_kboard
;
3079 /* Record this character as part of the current key. */
3080 add_command_key (c
);
3081 if (! NILP (also_record
))
3082 add_command_key (also_record
);
3085 last_input_event
= c
;
3088 /* Process the help character specially if enabled */
3089 if (!NILP (Vhelp_form
) && help_char_p (c
))
3092 int count
= SPECPDL_INDEX ();
3094 help_form_saved_window_configs
3095 = Fcons (Fcurrent_window_configuration (Qnil
),
3096 help_form_saved_window_configs
);
3097 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3099 tem0
= Feval (Vhelp_form
, Qnil
);
3101 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3106 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3107 if (EVENT_HAS_PARAMETERS (c
)
3108 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3109 XSETCAR (help_form_saved_window_configs
, Qnil
);
3111 while (BUFFERP (c
));
3112 /* Remove the help from the frame */
3113 unbind_to (count
, Qnil
);
3116 if (EQ (c
, make_number (040)))
3120 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3121 while (BUFFERP (c
));
3130 /* Record a key that came from a mouse menu.
3131 Record it for echoing, for this-command-keys, and so on. */
3134 record_menu_key (Lisp_Object c
)
3136 /* Wipe the echo area. */
3137 clear_message (1, 0);
3142 before_command_key_count
= this_command_key_count
;
3143 before_command_echo_length
= echo_length ();
3146 /* Don't echo mouse motion events. */
3147 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3148 && NILP (Fzerop (Vecho_keystrokes
)))
3152 /* Once we reread a character, echoing can happen
3153 the next time we pause to read a new one. */
3154 ok_to_echo_at_next_pause
= 0;
3157 /* Record this character as part of the current key. */
3158 add_command_key (c
);
3160 /* Re-reading in the middle of a command */
3161 last_input_event
= c
;
3165 /* Return 1 if should recognize C as "the help character". */
3168 help_char_p (Lisp_Object c
)
3172 if (EQ (c
, Vhelp_char
))
3174 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3175 if (EQ (c
, XCAR (tail
)))
3180 /* Record the input event C in various ways. */
3183 record_char (Lisp_Object c
)
3187 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3189 /* To avoid filling recent_keys with help-echo and mouse-movement
3190 events, we filter out repeated help-echo events, only store the
3191 first and last in a series of mouse-movement events, and don't
3192 store repeated help-echo events which are only separated by
3193 mouse-movement events. */
3195 Lisp_Object ev1
, ev2
, ev3
;
3198 if ((ix1
= recent_keys_index
- 1) < 0)
3199 ix1
= NUM_RECENT_KEYS
- 1;
3200 ev1
= AREF (recent_keys
, ix1
);
3202 if ((ix2
= ix1
- 1) < 0)
3203 ix2
= NUM_RECENT_KEYS
- 1;
3204 ev2
= AREF (recent_keys
, ix2
);
3206 if ((ix3
= ix2
- 1) < 0)
3207 ix3
= NUM_RECENT_KEYS
- 1;
3208 ev3
= AREF (recent_keys
, ix3
);
3210 if (EQ (XCAR (c
), Qhelp_echo
))
3212 /* Don't record `help-echo' in recent_keys unless it shows some help
3213 message, and a different help than the previously recorded
3215 Lisp_Object help
, last_help
;
3217 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3218 if (!STRINGP (help
))
3220 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3221 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3223 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3224 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3225 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3227 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3228 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3229 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3230 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3233 else if (EQ (XCAR (c
), Qmouse_movement
))
3235 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3236 So additional mouse movement events replace the last element. */
3237 Lisp_Object last_window
, window
;
3239 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3240 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3241 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3242 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3243 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3245 ASET (recent_keys
, ix1
, c
);
3251 store_kbd_macro_char (c
);
3256 ASET (recent_keys
, recent_keys_index
, c
);
3257 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3258 recent_keys_index
= 0;
3260 else if (recorded
< 0)
3262 /* We need to remove one or two events from recent_keys.
3263 To do this, we simply put nil at those events and move the
3264 recent_keys_index backwards over those events. Usually,
3265 users will never see those nil events, as they will be
3266 overwritten by the command keys entered to see recent_keys
3269 while (recorded
++ < 0 && total_keys
> 0)
3271 if (total_keys
< NUM_RECENT_KEYS
)
3273 if (--recent_keys_index
< 0)
3274 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3275 ASET (recent_keys
, recent_keys_index
, Qnil
);
3279 num_nonmacro_input_events
++;
3281 /* Write c to the dribble file. If c is a lispy event, write
3282 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3283 If you, dear reader, have a better idea, you've got the source. :-) */
3289 if (XUINT (c
) < 0x100)
3290 putc (XINT (c
), dribble
);
3292 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3296 Lisp_Object dribblee
;
3298 /* If it's a structured event, take the event header. */
3299 dribblee
= EVENT_HEAD (c
);
3301 if (SYMBOLP (dribblee
))
3303 putc ('<', dribble
);
3304 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3305 SBYTES (SYMBOL_NAME (dribblee
)),
3307 putc ('>', dribble
);
3317 print_help (Lisp_Object object
)
3319 struct buffer
*old
= current_buffer
;
3320 Fprinc (object
, Qnil
);
3321 set_buffer_internal (XBUFFER (Vstandard_output
));
3322 call0 (intern ("help-mode"));
3323 set_buffer_internal (old
);
3327 /* Copy out or in the info on where C-g should throw to.
3328 This is used when running Lisp code from within get_char,
3329 in case get_char is called recursively.
3330 See read_process_output. */
3333 save_getcjmp (jmp_buf temp
)
3335 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3339 restore_getcjmp (jmp_buf temp
)
3341 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3344 /* Low level keyboard/mouse input.
3345 kbd_buffer_store_event places events in kbd_buffer, and
3346 kbd_buffer_get_event retrieves them. */
3348 /* Return true if there are any events in the queue that read-char
3349 would return. If this returns false, a read-char would block. */
3351 readable_events (int flags
)
3353 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3356 /* If the buffer contains only FOCUS_IN_EVENT events, and
3357 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3358 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3360 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3361 #ifdef USE_TOOLKIT_SCROLL_BARS
3362 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3366 struct input_event
*event
;
3368 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3375 #ifdef USE_TOOLKIT_SCROLL_BARS
3376 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3378 event
->kind
== FOCUS_IN_EVENT
)
3379 #ifdef USE_TOOLKIT_SCROLL_BARS
3380 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3381 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3382 && event
->part
== scroll_bar_handle
3383 && event
->modifiers
== 0)
3388 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3391 while (event
!= kbd_store_ptr
);
3397 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3398 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3399 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3404 if (current_kboard
->kbd_queue_has_data
)
3410 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3411 if (kb
->kbd_queue_has_data
)
3417 /* Set this for debugging, to have a way to get out */
3421 event_to_kboard (struct input_event
*event
)
3424 frame
= event
->frame_or_window
;
3426 frame
= XCAR (frame
);
3427 else if (WINDOWP (frame
))
3428 frame
= WINDOW_FRAME (XWINDOW (frame
));
3430 /* There are still some events that don't set this field.
3431 For now, just ignore the problem.
3432 Also ignore dead frames here. */
3433 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3436 return FRAME_KBOARD (XFRAME (frame
));
3440 /* Return the number of slots occupied in kbd_buffer. */
3443 kbd_buffer_nr_stored (void)
3445 return kbd_fetch_ptr
== kbd_store_ptr
3447 : (kbd_fetch_ptr
< kbd_store_ptr
3448 ? kbd_store_ptr
- kbd_fetch_ptr
3449 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3450 + (kbd_store_ptr
- kbd_buffer
)));
3452 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3455 kbd_buffer_store_event (register struct input_event
*event
)
3457 kbd_buffer_store_event_hold (event
, 0);
3460 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3462 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3463 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3464 Else, if EVENT is a quit event, store the quit event
3465 in HOLD_QUIT, and return (thus ignoring further events).
3467 This is used in read_avail_input to postpone the processing
3468 of the quit event until all subsequent input events have been
3469 parsed (and discarded).
3473 kbd_buffer_store_event_hold (register struct input_event
*event
,
3474 struct input_event
*hold_quit
)
3476 if (event
->kind
== NO_EVENT
)
3479 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3482 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3484 register int c
= event
->code
& 0377;
3486 if (event
->modifiers
& ctrl_modifier
)
3487 c
= make_ctrl_char (c
);
3489 c
|= (event
->modifiers
3490 & (meta_modifier
| alt_modifier
3491 | hyper_modifier
| super_modifier
));
3495 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3496 struct input_event
*sp
;
3498 if (single_kboard
&& kb
!= current_kboard
)
3500 KVAR (kb
, kbd_queue
)
3501 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3502 Fcons (make_number (c
), Qnil
));
3503 kb
->kbd_queue_has_data
= 1;
3504 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3506 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3509 if (event_to_kboard (sp
) == kb
)
3511 sp
->kind
= NO_EVENT
;
3512 sp
->frame_or_window
= Qnil
;
3521 memcpy (hold_quit
, event
, sizeof (*event
));
3525 /* If this results in a quit_char being returned to Emacs as
3526 input, set Vlast_event_frame properly. If this doesn't
3527 get returned to Emacs as an event, the next event read
3528 will set Vlast_event_frame again, so this is safe to do. */
3532 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3534 focus
= event
->frame_or_window
;
3535 internal_last_event_frame
= focus
;
3536 Vlast_event_frame
= focus
;
3539 last_event_timestamp
= event
->timestamp
;
3540 handle_interrupt ();
3544 if (c
&& c
== stop_character
)
3550 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3551 Just ignore the second one. */
3552 else if (event
->kind
== BUFFER_SWITCH_EVENT
3553 && kbd_fetch_ptr
!= kbd_store_ptr
3554 && ((kbd_store_ptr
== kbd_buffer
3555 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3556 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3559 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3560 kbd_store_ptr
= kbd_buffer
;
3562 /* Don't let the very last slot in the buffer become full,
3563 since that would make the two pointers equal,
3564 and that is indistinguishable from an empty buffer.
3565 Discard the event if it would fill the last slot. */
3566 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3568 *kbd_store_ptr
= *event
;
3571 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3573 /* Don't read keyboard input until we have processed kbd_buffer.
3574 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3575 hold_keyboard_input ();
3577 if (!noninteractive
)
3578 signal (SIGIO
, SIG_IGN
);
3582 #endif /* subprocesses */
3585 /* If we're inside while-no-input, and this event qualifies
3586 as input, set quit-flag to cause an interrupt. */
3587 if (!NILP (Vthrow_on_input
)
3588 && event
->kind
!= FOCUS_IN_EVENT
3589 && event
->kind
!= HELP_EVENT
3590 && event
->kind
!= DEICONIFY_EVENT
)
3592 Vquit_flag
= Vthrow_on_input
;
3593 /* If we're inside a function that wants immediate quits,
3595 if (immediate_quit
&& NILP (Vinhibit_quit
))
3605 /* Put an input event back in the head of the event queue. */
3608 kbd_buffer_unget_event (register struct input_event
*event
)
3610 if (kbd_fetch_ptr
== kbd_buffer
)
3611 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3613 /* Don't let the very last slot in the buffer become full, */
3614 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3617 *kbd_fetch_ptr
= *event
;
3622 /* Generate a HELP_EVENT input_event and store it in the keyboard
3625 HELP is the help form.
3627 FRAME and WINDOW are the frame and window where the help is
3628 generated. OBJECT is the Lisp object where the help was found (a
3629 buffer, a string, an overlay, or nil if neither from a string nor
3630 from a buffer). POS is the position within OBJECT where the help
3634 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3635 Lisp_Object object
, EMACS_INT pos
)
3637 struct input_event event
;
3641 event
.kind
= HELP_EVENT
;
3642 event
.frame_or_window
= frame
;
3644 event
.x
= WINDOWP (window
) ? window
: frame
;
3647 kbd_buffer_store_event (&event
);
3651 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3654 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3656 struct input_event event
;
3658 event
.kind
= HELP_EVENT
;
3659 event
.frame_or_window
= frame
;
3664 kbd_buffer_store_event (&event
);
3668 /* Discard any mouse events in the event buffer by setting them to
3671 discard_mouse_events (void)
3673 struct input_event
*sp
;
3674 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3676 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3679 if (sp
->kind
== MOUSE_CLICK_EVENT
3680 || sp
->kind
== WHEEL_EVENT
3681 || sp
->kind
== HORIZ_WHEEL_EVENT
3683 || sp
->kind
== GPM_CLICK_EVENT
3685 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3687 sp
->kind
= NO_EVENT
;
3693 /* Return non-zero if there are any real events waiting in the event
3694 buffer, not counting `NO_EVENT's.
3696 If DISCARD is non-zero, discard NO_EVENT events at the front of
3697 the input queue, possibly leaving the input queue empty if there
3698 are no real input events. */
3701 kbd_buffer_events_waiting (int discard
)
3703 struct input_event
*sp
;
3705 for (sp
= kbd_fetch_ptr
;
3706 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3709 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3716 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3720 /* Clear input event EVENT. */
3723 clear_event (struct input_event
*event
)
3725 event
->kind
= NO_EVENT
;
3729 /* Read one event from the event buffer, waiting if necessary.
3730 The value is a Lisp object representing the event.
3731 The value is nil for an event that should be ignored,
3732 or that was handled here.
3733 We always read and discard one event. */
3736 kbd_buffer_get_event (KBOARD
**kbp
,
3737 int *used_mouse_menu
,
3738 struct timeval
*end_time
)
3744 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3746 /* Start reading input again, we have processed enough so we can
3747 accept new events again. */
3748 unhold_keyboard_input ();
3750 if (!noninteractive
)
3751 signal (SIGIO
, input_available_signal
);
3755 #endif /* subprocesses */
3758 /* In case we are running as a daemon, only do this before
3759 detaching from the terminal. */
3760 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3764 *kbp
= current_kboard
;
3768 /* Wait until there is input available. */
3771 /* Break loop if there's an unread command event. Needed in
3772 moused window autoselection which uses a timer to insert such
3774 if (CONSP (Vunread_command_events
))
3777 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3779 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3780 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3784 /* If the quit flag is set, then read_char will return
3785 quit_char, so that counts as "available input." */
3786 if (!NILP (Vquit_flag
))
3787 quit_throw_to_read_char ();
3789 /* One way or another, wait until input is available; then, if
3790 interrupt handlers have not read it, read it now. */
3792 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3796 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3798 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3799 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3804 EMACS_TIME duration
;
3805 EMACS_GET_TIME (duration
);
3806 if (EMACS_TIME_GE (duration
, *end_time
))
3807 return Qnil
; /* finished waiting */
3810 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3811 wait_reading_process_output (EMACS_SECS (duration
),
3812 EMACS_USECS (duration
),
3813 -1, 1, Qnil
, NULL
, 0);
3817 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3819 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3820 /* Pass 1 for EXPECT since we just waited to have input. */
3821 read_avail_input (1);
3824 if (CONSP (Vunread_command_events
))
3827 first
= XCAR (Vunread_command_events
);
3828 Vunread_command_events
= XCDR (Vunread_command_events
);
3829 *kbp
= current_kboard
;
3833 /* At this point, we know that there is a readable event available
3834 somewhere. If the event queue is empty, then there must be a
3835 mouse movement enabled and available. */
3836 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3838 struct input_event
*event
;
3840 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3844 last_event_timestamp
= event
->timestamp
;
3846 *kbp
= event_to_kboard (event
);
3848 *kbp
= current_kboard
; /* Better than returning null ptr? */
3852 /* These two kinds of events get special handling
3853 and don't actually appear to the command loop.
3854 We return nil for them. */
3855 if (event
->kind
== SELECTION_REQUEST_EVENT
3856 || event
->kind
== SELECTION_CLEAR_EVENT
)
3859 struct input_event copy
;
3861 /* Remove it from the buffer before processing it,
3862 since otherwise swallow_events will see it
3863 and process it again. */
3865 kbd_fetch_ptr
= event
+ 1;
3866 input_pending
= readable_events (0);
3867 x_handle_selection_event (©
);
3869 /* We're getting selection request events, but we don't have
3875 #if defined (HAVE_NS)
3876 else if (event
->kind
== NS_TEXT_EVENT
)
3878 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3879 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3881 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3882 kbd_fetch_ptr
= event
+ 1;
3883 if (used_mouse_menu
)
3884 *used_mouse_menu
= 1;
3888 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3889 || defined (HAVE_NS)
3890 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3892 /* Make an event (delete-frame (FRAME)). */
3893 obj
= Fcons (event
->frame_or_window
, Qnil
);
3894 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3895 kbd_fetch_ptr
= event
+ 1;
3898 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3899 || defined (HAVE_NS)
3900 else if (event
->kind
== ICONIFY_EVENT
)
3902 /* Make an event (iconify-frame (FRAME)). */
3903 obj
= Fcons (event
->frame_or_window
, Qnil
);
3904 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3905 kbd_fetch_ptr
= event
+ 1;
3907 else if (event
->kind
== DEICONIFY_EVENT
)
3909 /* Make an event (make-frame-visible (FRAME)). */
3910 obj
= Fcons (event
->frame_or_window
, Qnil
);
3911 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3912 kbd_fetch_ptr
= event
+ 1;
3915 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3917 /* The value doesn't matter here; only the type is tested. */
3918 XSETBUFFER (obj
, current_buffer
);
3919 kbd_fetch_ptr
= event
+ 1;
3921 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3922 || defined(HAVE_NS) || defined (USE_GTK)
3923 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3925 kbd_fetch_ptr
= event
+ 1;
3926 input_pending
= readable_events (0);
3927 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3928 x_activate_menubar (XFRAME (event
->frame_or_window
));
3931 #if defined (WINDOWSNT)
3932 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3934 /* Make an event (language-change (FRAME CHARSET LCID)). */
3935 obj
= Fcons (event
->frame_or_window
, Qnil
);
3936 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3937 kbd_fetch_ptr
= event
+ 1;
3940 else if (event
->kind
== SAVE_SESSION_EVENT
)
3942 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3943 kbd_fetch_ptr
= event
+ 1;
3945 /* Just discard these, by returning nil.
3946 With MULTI_KBOARD, these events are used as placeholders
3947 when we need to randomly delete events from the queue.
3948 (They shouldn't otherwise be found in the buffer,
3949 but on some machines it appears they do show up
3950 even without MULTI_KBOARD.) */
3951 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3952 mouse events during a popup-menu call. */
3953 else if (event
->kind
== NO_EVENT
)
3954 kbd_fetch_ptr
= event
+ 1;
3955 else if (event
->kind
== HELP_EVENT
)
3957 Lisp_Object object
, position
, help
, frame
, window
;
3959 frame
= event
->frame_or_window
;
3960 object
= event
->arg
;
3961 position
= make_number (event
->code
);
3964 clear_event (event
);
3966 kbd_fetch_ptr
= event
+ 1;
3967 if (!WINDOWP (window
))
3969 obj
= Fcons (Qhelp_echo
,
3970 list5 (frame
, help
, window
, object
, position
));
3972 else if (event
->kind
== FOCUS_IN_EVENT
)
3974 /* Notification of a FocusIn event. The frame receiving the
3975 focus is in event->frame_or_window. Generate a
3976 switch-frame event if necessary. */
3977 Lisp_Object frame
, focus
;
3979 frame
= event
->frame_or_window
;
3980 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3984 if (!EQ (frame
, internal_last_event_frame
)
3985 && !EQ (frame
, selected_frame
))
3986 obj
= make_lispy_switch_frame (frame
);
3987 internal_last_event_frame
= frame
;
3988 kbd_fetch_ptr
= event
+ 1;
3991 else if (event
->kind
== DBUS_EVENT
)
3993 obj
= make_lispy_event (event
);
3994 kbd_fetch_ptr
= event
+ 1;
3997 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3999 obj
= make_lispy_event (event
);
4000 kbd_fetch_ptr
= event
+ 1;
4004 /* If this event is on a different frame, return a switch-frame this
4005 time, and leave the event in the queue for next time. */
4009 frame
= event
->frame_or_window
;
4011 frame
= XCAR (frame
);
4012 else if (WINDOWP (frame
))
4013 frame
= WINDOW_FRAME (XWINDOW (frame
));
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
;
4024 /* If we didn't decide to make a switch-frame event, go ahead
4025 and build a real event from the queue entry. */
4029 obj
= make_lispy_event (event
);
4031 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4032 || defined(HAVE_NS) || defined (USE_GTK)
4033 /* If this was a menu selection, then set the flag to inhibit
4034 writing to last_nonmenu_event. Don't do this if the event
4035 we're returning is (menu-bar), though; that indicates the
4036 beginning of the menu sequence, and we might as well leave
4037 that as the `event with parameters' for this selection. */
4039 && !EQ (event
->frame_or_window
, event
->arg
)
4040 && (event
->kind
== MENU_BAR_EVENT
4041 || event
->kind
== TOOL_BAR_EVENT
))
4042 *used_mouse_menu
= 1;
4045 /* certain system events are non-key events */
4047 && event
->kind
== NS_NONKEY_EVENT
)
4048 *used_mouse_menu
= 1;
4051 /* Wipe out this event, to catch bugs. */
4052 clear_event (event
);
4053 kbd_fetch_ptr
= event
+ 1;
4057 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4058 /* Try generating a mouse motion event. */
4059 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4061 FRAME_PTR f
= some_mouse_moved ();
4062 Lisp_Object bar_window
;
4063 enum scroll_bar_part part
;
4067 *kbp
= current_kboard
;
4068 /* Note that this uses F to determine which terminal to look at.
4069 If there is no valid info, it does not store anything
4070 so x remains nil. */
4073 /* XXX Can f or mouse_position_hook be NULL here? */
4074 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4075 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4080 /* Decide if we should generate a switch-frame event. Don't
4081 generate switch-frame events for motion outside of all Emacs
4087 frame
= FRAME_FOCUS_FRAME (f
);
4089 XSETFRAME (frame
, f
);
4091 if (! EQ (frame
, internal_last_event_frame
)
4092 && !EQ (frame
, selected_frame
))
4093 obj
= make_lispy_switch_frame (frame
);
4094 internal_last_event_frame
= frame
;
4097 /* If we didn't decide to make a switch-frame event, go ahead and
4098 return a mouse-motion event. */
4099 if (!NILP (x
) && NILP (obj
))
4100 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4102 #endif /* HAVE_MOUSE || HAVE GPM */
4104 /* We were promised by the above while loop that there was
4105 something for us to read! */
4108 input_pending
= readable_events (0);
4110 Vlast_event_frame
= internal_last_event_frame
;
4115 /* Process any events that are not user-visible,
4116 then return, without reading any user-visible events. */
4119 swallow_events (int do_display
)
4123 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4125 struct input_event
*event
;
4127 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4131 last_event_timestamp
= event
->timestamp
;
4133 /* These two kinds of events get special handling
4134 and don't actually appear to the command loop. */
4135 if (event
->kind
== SELECTION_REQUEST_EVENT
4136 || event
->kind
== SELECTION_CLEAR_EVENT
)
4139 struct input_event copy
;
4141 /* Remove it from the buffer before processing it,
4142 since otherwise swallow_events called recursively could see it
4143 and process it again. */
4145 kbd_fetch_ptr
= event
+ 1;
4146 input_pending
= readable_events (0);
4147 x_handle_selection_event (©
);
4149 /* We're getting selection request events, but we don't have
4158 old_timers_run
= timers_run
;
4159 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4161 if (timers_run
!= old_timers_run
&& do_display
)
4162 redisplay_preserve_echo_area (7);
4165 /* Record the start of when Emacs is idle,
4166 for the sake of running idle-time timers. */
4169 timer_start_idle (void)
4173 /* If we are already in the idle state, do nothing. */
4174 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4177 EMACS_GET_TIME (timer_idleness_start_time
);
4179 timer_last_idleness_start_time
= timer_idleness_start_time
;
4181 /* Mark all idle-time timers as once again candidates for running. */
4182 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4186 timer
= XCAR (timers
);
4188 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4190 XVECTOR (timer
)->contents
[0] = Qnil
;
4194 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4197 timer_stop_idle (void)
4199 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4202 /* Resume idle timer from last idle start time. */
4205 timer_resume_idle (void)
4207 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4210 timer_idleness_start_time
= timer_last_idleness_start_time
;
4213 /* This is only for debugging. */
4214 struct input_event last_timer_event
;
4216 /* List of elisp functions to call, delayed because they were generated in
4217 a context where Elisp could not be safely run (e.g. redisplay, signal,
4218 ...). Each element has the form (FUN . ARGS). */
4219 Lisp_Object pending_funcalls
;
4221 /* Check whether a timer has fired. To prevent larger problems we simply
4222 disregard elements that are not proper timers. Do not make a circular
4223 timer list for the time being.
4225 Returns the time to wait until the next timer fires. If a
4226 timer is triggering now, return zero.
4227 If no timer is active, return -1.
4229 If a timer is ripe, we run it, with quitting turned off.
4230 In that case we return 0 to indicate that a new timer_check_2 call
4234 timer_check_2 (void)
4236 EMACS_TIME nexttime
;
4238 EMACS_TIME idleness_now
IF_LINT (= {0});
4239 Lisp_Object timers
, idle_timers
, chosen_timer
;
4240 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4242 EMACS_SET_SECS (nexttime
, -1);
4243 EMACS_SET_USECS (nexttime
, -1);
4245 /* Always consider the ordinary timers. */
4246 timers
= Vtimer_list
;
4247 /* Consider the idle timers only if Emacs is idle. */
4248 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4249 idle_timers
= Vtimer_idle_list
;
4252 chosen_timer
= Qnil
;
4253 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4255 /* First run the code that was delayed. */
4256 while (CONSP (pending_funcalls
))
4258 Lisp_Object funcall
= XCAR (pending_funcalls
);
4259 pending_funcalls
= XCDR (pending_funcalls
);
4260 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4263 if (CONSP (timers
) || CONSP (idle_timers
))
4265 EMACS_GET_TIME (now
);
4266 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4267 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4270 while (CONSP (timers
) || CONSP (idle_timers
))
4272 Lisp_Object
*vector
;
4273 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4274 EMACS_TIME timer_time
, idle_timer_time
;
4275 EMACS_TIME difference
;
4276 EMACS_TIME timer_difference
IF_LINT (= {0});
4277 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4279 /* Skip past invalid timers and timers already handled. */
4282 timer
= XCAR (timers
);
4283 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4285 timers
= XCDR (timers
);
4288 vector
= XVECTOR (timer
)->contents
;
4290 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4291 || !INTEGERP (vector
[3])
4292 || ! NILP (vector
[0]))
4294 timers
= XCDR (timers
);
4298 if (CONSP (idle_timers
))
4300 timer
= XCAR (idle_timers
);
4301 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4303 idle_timers
= XCDR (idle_timers
);
4306 vector
= XVECTOR (timer
)->contents
;
4308 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4309 || !INTEGERP (vector
[3])
4310 || ! NILP (vector
[0]))
4312 idle_timers
= XCDR (idle_timers
);
4317 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4318 based on the next ordinary timer.
4319 TIMER_DIFFERENCE is the distance in time from NOW to when
4320 this timer becomes ripe (negative if it's already ripe). */
4323 timer
= XCAR (timers
);
4324 vector
= XVECTOR (timer
)->contents
;
4325 EMACS_SET_SECS (timer_time
,
4326 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4327 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4328 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4331 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4332 based on the next idle timer. */
4333 if (CONSP (idle_timers
))
4335 idle_timer
= XCAR (idle_timers
);
4336 vector
= XVECTOR (idle_timer
)->contents
;
4337 EMACS_SET_SECS (idle_timer_time
,
4338 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4339 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4340 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4343 /* Decide which timer is the next timer,
4344 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4345 Also step down the list where we found that timer. */
4347 if (CONSP (timers
) && CONSP (idle_timers
))
4350 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4351 if (EMACS_TIME_NEG_P (temp
))
4353 chosen_timer
= timer
;
4354 timers
= XCDR (timers
);
4355 difference
= timer_difference
;
4359 chosen_timer
= idle_timer
;
4360 idle_timers
= XCDR (idle_timers
);
4361 difference
= idle_timer_difference
;
4364 else if (CONSP (timers
))
4366 chosen_timer
= timer
;
4367 timers
= XCDR (timers
);
4368 difference
= timer_difference
;
4372 chosen_timer
= idle_timer
;
4373 idle_timers
= XCDR (idle_timers
);
4374 difference
= idle_timer_difference
;
4376 vector
= XVECTOR (chosen_timer
)->contents
;
4378 /* If timer is ripe, run it if it hasn't been run. */
4379 if (EMACS_TIME_NEG_P (difference
)
4380 || (EMACS_SECS (difference
) == 0
4381 && EMACS_USECS (difference
) == 0))
4383 if (NILP (vector
[0]))
4385 int count
= SPECPDL_INDEX ();
4386 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4388 /* Mark the timer as triggered to prevent problems if the lisp
4389 code fails to reschedule it right. */
4392 specbind (Qinhibit_quit
, Qt
);
4394 call1 (Qtimer_event_handler
, chosen_timer
);
4395 Vdeactivate_mark
= old_deactivate_mark
;
4397 unbind_to (count
, Qnil
);
4399 /* Since we have handled the event,
4400 we don't need to tell the caller to wake up and do it. */
4401 /* But the caller must still wait for the next timer, so
4402 return 0 to indicate that. */
4405 EMACS_SET_SECS (nexttime
, 0);
4406 EMACS_SET_USECS (nexttime
, 0);
4409 /* When we encounter a timer that is still waiting,
4410 return the amount of time to wait before it is ripe. */
4417 /* No timers are pending in the future. */
4418 /* Return 0 if we generated an event, and -1 if not. */
4424 /* Check whether a timer has fired. To prevent larger problems we simply
4425 disregard elements that are not proper timers. Do not make a circular
4426 timer list for the time being.
4428 Returns the time to wait until the next timer fires.
4429 If no timer is active, return -1.
4431 As long as any timer is ripe, we run it. */
4436 EMACS_TIME nexttime
;
4440 nexttime
= timer_check_2 ();
4442 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4447 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4448 doc
: /* Return the current length of Emacs idleness, or nil.
4449 The value when Emacs is idle is a list of three integers. The first has
4450 the most significant 16 bits of the seconds, while the second has the least
4451 significant 16 bits. The third integer gives the microsecond count.
4453 The value when Emacs is not idle is nil.
4455 The microsecond count is zero on systems that do not provide
4456 resolution finer than a second. */)
4459 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4461 EMACS_TIME now
, idleness_now
;
4463 EMACS_GET_TIME (now
);
4464 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4466 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4467 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4468 make_number (EMACS_USECS (idleness_now
)));
4474 /* Caches for modify_event_symbol. */
4475 static Lisp_Object accent_key_syms
;
4476 static Lisp_Object func_key_syms
;
4477 static Lisp_Object mouse_syms
;
4478 static Lisp_Object wheel_syms
;
4479 static Lisp_Object drag_n_drop_syms
;
4481 /* This is a list of keysym codes for special "accent" characters.
4482 It parallels lispy_accent_keys. */
4484 static const int lispy_accent_codes
[] =
4486 #ifdef XK_dead_circumflex
4491 #ifdef XK_dead_grave
4496 #ifdef XK_dead_tilde
4501 #ifdef XK_dead_diaeresis
4506 #ifdef XK_dead_macron
4511 #ifdef XK_dead_degree
4516 #ifdef XK_dead_acute
4521 #ifdef XK_dead_cedilla
4526 #ifdef XK_dead_breve
4531 #ifdef XK_dead_ogonek
4536 #ifdef XK_dead_caron
4541 #ifdef XK_dead_doubleacute
4542 XK_dead_doubleacute
,
4546 #ifdef XK_dead_abovedot
4551 #ifdef XK_dead_abovering
4561 #ifdef XK_dead_belowdot
4566 #ifdef XK_dead_voiced_sound
4567 XK_dead_voiced_sound
,
4571 #ifdef XK_dead_semivoiced_sound
4572 XK_dead_semivoiced_sound
,
4588 /* This is a list of Lisp names for special "accent" characters.
4589 It parallels lispy_accent_codes. */
4591 static const char *const lispy_accent_keys
[] =
4609 "dead-voiced-sound",
4610 "dead-semivoiced-sound",
4616 #define FUNCTION_KEY_OFFSET 0x0
4618 const char *const lispy_function_keys
[] =
4622 0, /* VK_LBUTTON 0x01 */
4623 0, /* VK_RBUTTON 0x02 */
4624 "cancel", /* VK_CANCEL 0x03 */
4625 0, /* VK_MBUTTON 0x04 */
4627 0, 0, 0, /* 0x05 .. 0x07 */
4629 "backspace", /* VK_BACK 0x08 */
4630 "tab", /* VK_TAB 0x09 */
4632 0, 0, /* 0x0A .. 0x0B */
4634 "clear", /* VK_CLEAR 0x0C */
4635 "return", /* VK_RETURN 0x0D */
4637 0, 0, /* 0x0E .. 0x0F */
4639 0, /* VK_SHIFT 0x10 */
4640 0, /* VK_CONTROL 0x11 */
4641 0, /* VK_MENU 0x12 */
4642 "pause", /* VK_PAUSE 0x13 */
4643 "capslock", /* VK_CAPITAL 0x14 */
4644 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4646 "junja", /* VK_JUNJA 0x17 */
4647 "final", /* VK_FINAL 0x18 */
4648 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4650 "escape", /* VK_ESCAPE 0x1B */
4651 "convert", /* VK_CONVERT 0x1C */
4652 "non-convert", /* VK_NONCONVERT 0x1D */
4653 "accept", /* VK_ACCEPT 0x1E */
4654 "mode-change", /* VK_MODECHANGE 0x1F */
4655 0, /* VK_SPACE 0x20 */
4656 "prior", /* VK_PRIOR 0x21 */
4657 "next", /* VK_NEXT 0x22 */
4658 "end", /* VK_END 0x23 */
4659 "home", /* VK_HOME 0x24 */
4660 "left", /* VK_LEFT 0x25 */
4661 "up", /* VK_UP 0x26 */
4662 "right", /* VK_RIGHT 0x27 */
4663 "down", /* VK_DOWN 0x28 */
4664 "select", /* VK_SELECT 0x29 */
4665 "print", /* VK_PRINT 0x2A */
4666 "execute", /* VK_EXECUTE 0x2B */
4667 "snapshot", /* VK_SNAPSHOT 0x2C */
4668 "insert", /* VK_INSERT 0x2D */
4669 "delete", /* VK_DELETE 0x2E */
4670 "help", /* VK_HELP 0x2F */
4672 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4674 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4676 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4678 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4680 0, 0, 0, 0, 0, 0, 0, 0, 0,
4681 0, 0, 0, 0, 0, 0, 0, 0, 0,
4682 0, 0, 0, 0, 0, 0, 0, 0,
4684 "lwindow", /* VK_LWIN 0x5B */
4685 "rwindow", /* VK_RWIN 0x5C */
4686 "apps", /* VK_APPS 0x5D */
4689 "kp-0", /* VK_NUMPAD0 0x60 */
4690 "kp-1", /* VK_NUMPAD1 0x61 */
4691 "kp-2", /* VK_NUMPAD2 0x62 */
4692 "kp-3", /* VK_NUMPAD3 0x63 */
4693 "kp-4", /* VK_NUMPAD4 0x64 */
4694 "kp-5", /* VK_NUMPAD5 0x65 */
4695 "kp-6", /* VK_NUMPAD6 0x66 */
4696 "kp-7", /* VK_NUMPAD7 0x67 */
4697 "kp-8", /* VK_NUMPAD8 0x68 */
4698 "kp-9", /* VK_NUMPAD9 0x69 */
4699 "kp-multiply", /* VK_MULTIPLY 0x6A */
4700 "kp-add", /* VK_ADD 0x6B */
4701 "kp-separator", /* VK_SEPARATOR 0x6C */
4702 "kp-subtract", /* VK_SUBTRACT 0x6D */
4703 "kp-decimal", /* VK_DECIMAL 0x6E */
4704 "kp-divide", /* VK_DIVIDE 0x6F */
4705 "f1", /* VK_F1 0x70 */
4706 "f2", /* VK_F2 0x71 */
4707 "f3", /* VK_F3 0x72 */
4708 "f4", /* VK_F4 0x73 */
4709 "f5", /* VK_F5 0x74 */
4710 "f6", /* VK_F6 0x75 */
4711 "f7", /* VK_F7 0x76 */
4712 "f8", /* VK_F8 0x77 */
4713 "f9", /* VK_F9 0x78 */
4714 "f10", /* VK_F10 0x79 */
4715 "f11", /* VK_F11 0x7A */
4716 "f12", /* VK_F12 0x7B */
4717 "f13", /* VK_F13 0x7C */
4718 "f14", /* VK_F14 0x7D */
4719 "f15", /* VK_F15 0x7E */
4720 "f16", /* VK_F16 0x7F */
4721 "f17", /* VK_F17 0x80 */
4722 "f18", /* VK_F18 0x81 */
4723 "f19", /* VK_F19 0x82 */
4724 "f20", /* VK_F20 0x83 */
4725 "f21", /* VK_F21 0x84 */
4726 "f22", /* VK_F22 0x85 */
4727 "f23", /* VK_F23 0x86 */
4728 "f24", /* VK_F24 0x87 */
4730 0, 0, 0, 0, /* 0x88 .. 0x8B */
4731 0, 0, 0, 0, /* 0x8C .. 0x8F */
4733 "kp-numlock", /* VK_NUMLOCK 0x90 */
4734 "scroll", /* VK_SCROLL 0x91 */
4735 /* Not sure where the following block comes from.
4736 Windows headers have NEC and Fujitsu specific keys in
4737 this block, but nothing generic. */
4738 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4739 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4740 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4741 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4742 "kp-end", /* VK_NUMPAD_END 0x96 */
4743 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4744 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4745 "kp-up", /* VK_NUMPAD_UP 0x99 */
4746 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4747 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4748 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4749 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4751 0, 0, /* 0x9E .. 0x9F */
4754 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4755 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4756 * No other API or message will distinguish left and right keys this way.
4761 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4762 to enable them selectively, and gives access to a few more functions.
4763 See lispy_multimedia_keys below. */
4764 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4765 0, 0, 0, /* 0xAD .. 0xAF Volume */
4766 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4767 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4769 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4770 0, 0, 0, 0, 0, 0, 0, 0, 0,
4772 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4773 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4774 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4777 "ax", /* VK_OEM_AX 0xE1 */
4778 0, /* VK_OEM_102 0xE2 */
4779 "ico-help", /* VK_ICO_HELP 0xE3 */
4780 "ico-00", /* VK_ICO_00 0xE4 */
4781 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4782 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4783 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4785 "reset", /* VK_OEM_RESET 0xE9 */
4786 "jump", /* VK_OEM_JUMP 0xEA */
4787 "oem-pa1", /* VK_OEM_PA1 0xEB */
4788 "oem-pa2", /* VK_OEM_PA2 0xEC */
4789 "oem-pa3", /* VK_OEM_PA3 0xED */
4790 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4791 "cusel", /* VK_OEM_CUSEL 0xEF */
4792 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4793 "finish", /* VK_OEM_FINISH 0xF1 */
4794 "copy", /* VK_OEM_COPY 0xF2 */
4795 "auto", /* VK_OEM_AUTO 0xF3 */
4796 "enlw", /* VK_OEM_ENLW 0xF4 */
4797 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4798 "attn", /* VK_ATTN 0xF6 */
4799 "crsel", /* VK_CRSEL 0xF7 */
4800 "exsel", /* VK_EXSEL 0xF8 */
4801 "ereof", /* VK_EREOF 0xF9 */
4802 "play", /* VK_PLAY 0xFA */
4803 "zoom", /* VK_ZOOM 0xFB */
4804 "noname", /* VK_NONAME 0xFC */
4805 "pa1", /* VK_PA1 0xFD */
4806 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4810 /* Some of these duplicate the "Media keys" on newer keyboards,
4811 but they are delivered to the application in a different way. */
4812 static const char *const lispy_multimedia_keys
[] =
4820 "browser-favorites",
4857 "toggle-dictate-command",
4863 "media-fast-forward",
4866 "media-channel-down"
4869 #else /* not HAVE_NTGUI */
4871 /* This should be dealt with in XTread_socket now, and that doesn't
4872 depend on the client system having the Kana syms defined. See also
4873 the XK_kana_A case below. */
4876 static const char *const lispy_kana_keys
[] =
4878 /* X Keysym value */
4879 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4880 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4881 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4882 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4883 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4884 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4885 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4886 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4887 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4888 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4889 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4890 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4891 "kana-i", "kana-u", "kana-e", "kana-o",
4892 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4893 "prolongedsound", "kana-A", "kana-I", "kana-U",
4894 "kana-E", "kana-O", "kana-KA", "kana-KI",
4895 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4896 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4897 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4898 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4899 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4900 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4901 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4902 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4903 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4904 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4905 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4906 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4908 #endif /* XK_kana_A */
4911 #define FUNCTION_KEY_OFFSET 0xff00
4913 /* You'll notice that this table is arranged to be conveniently
4914 indexed by X Windows keysym values. */
4915 static const char *const lispy_function_keys
[] =
4917 /* X Keysym value */
4919 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4920 "backspace", "tab", "linefeed", "clear",
4922 0, 0, 0, "pause", /* 0xff10...1f */
4923 0, 0, 0, 0, 0, 0, 0, "escape",
4925 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4926 "romaji", "hiragana", "katakana", "hiragana-katakana",
4927 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4928 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4929 "eisu-toggle", /* 0xff30...3f */
4930 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4931 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4933 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4934 "down", "prior", "next", "end",
4935 "begin", 0, 0, 0, 0, 0, 0, 0,
4936 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4947 "break", /* 0xff6b */
4950 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4951 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4952 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4953 0, 0, 0, 0, 0, 0, 0, 0,
4954 "kp-tab", /* 0xff89 */
4956 "kp-enter", /* 0xff8d */
4958 "kp-f1", /* 0xff91 */
4962 "kp-home", /* 0xff95 */
4967 "kp-prior", /* kp-page-up */
4968 "kp-next", /* kp-page-down */
4974 0, 0, 0, 0, 0, 0, 0, 0, 0,
4975 "kp-multiply", /* 0xffaa */
4980 "kp-divide", /* 0xffaf */
4981 "kp-0", /* 0xffb0 */
4982 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4985 "kp-equal", /* 0xffbd */
4986 "f1", /* 0xffbe */ /* IsFunctionKey */
4988 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4989 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4990 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4991 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4992 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4993 0, 0, 0, 0, 0, 0, 0, 0,
4994 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4995 0, 0, 0, 0, 0, 0, 0, "delete"
4998 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4999 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5001 static const char *const iso_lispy_function_keys
[] =
5003 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5004 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5005 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5006 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5007 "iso-lefttab", /* 0xfe20 */
5008 "iso-move-line-up", "iso-move-line-down",
5009 "iso-partial-line-up", "iso-partial-line-down",
5010 "iso-partial-space-left", "iso-partial-space-right",
5011 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5012 "iso-release-margin-left", "iso-release-margin-right",
5013 "iso-release-both-margins",
5014 "iso-fast-cursor-left", "iso-fast-cursor-right",
5015 "iso-fast-cursor-up", "iso-fast-cursor-down",
5016 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5017 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5020 #endif /* not HAVE_NTGUI */
5022 Lisp_Object Vlispy_mouse_stem
;
5024 static const char *const lispy_wheel_names
[] =
5026 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5029 /* drag-n-drop events are generated when a set of selected files are
5030 dragged from another application and dropped onto an Emacs window. */
5031 static const char *const lispy_drag_n_drop_names
[] =
5036 /* Scroll bar parts. */
5037 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5038 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5039 Lisp_Object Qtop
, Qratio
;
5041 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5042 static Lisp_Object
*const scroll_bar_parts
[] = {
5043 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5044 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5047 /* A vector, indexed by button number, giving the down-going location
5048 of currently depressed buttons, both scroll bar and non-scroll bar.
5050 The elements have the form
5051 (BUTTON-NUMBER MODIFIER-MASK . REST)
5052 where REST is the cdr of a position as it would be reported in the event.
5054 The make_lispy_event function stores positions here to tell the
5055 difference between click and drag events, and to store the starting
5056 location to be included in drag events. */
5058 static Lisp_Object button_down_location
;
5060 /* Information about the most recent up-going button event: Which
5061 button, what location, and what time. */
5063 static int last_mouse_button
;
5064 static int last_mouse_x
;
5065 static int last_mouse_y
;
5066 static unsigned long button_down_time
;
5068 /* The number of clicks in this multiple-click. */
5070 int double_click_count
;
5072 /* X and Y are frame-relative coordinates for a click or wheel event.
5073 Return a Lisp-style event list. */
5076 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5079 enum window_part part
;
5080 Lisp_Object posn
= Qnil
;
5081 Lisp_Object extra_info
= Qnil
;
5082 /* Coordinate pixel positions to return. */
5083 int xret
= 0, yret
= 0;
5084 /* The window under frame pixel coordinates (x,y) */
5085 Lisp_Object window
= f
5086 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5089 if (WINDOWP (window
))
5091 /* It's a click in window window at frame coordinates (x,y) */
5092 struct window
*w
= XWINDOW (window
);
5093 Lisp_Object string_info
= Qnil
;
5094 EMACS_INT textpos
= -1;
5095 int col
= -1, row
= -1;
5096 int dx
= -1, dy
= -1;
5097 int width
= -1, height
= -1;
5098 Lisp_Object object
= Qnil
;
5100 /* Pixel coordinates relative to the window corner. */
5101 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5102 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5104 /* For text area clicks, return X, Y relative to the corner of
5105 this text area. Note that dX, dY etc are set below, by
5106 buffer_posn_from_coords. */
5107 if (part
== ON_TEXT
)
5109 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5110 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5112 /* For mode line and header line clicks, return X, Y relative to
5113 the left window edge. Use mode_line_string to look for a
5114 string on the click position. */
5115 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5120 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5121 /* Note that mode_line_string takes COL, ROW as pixels and
5122 converts them to characters. */
5125 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5126 &object
, &dx
, &dy
, &width
, &height
);
5127 if (STRINGP (string
))
5128 string_info
= Fcons (string
, make_number (charpos
));
5129 textpos
= (w
== XWINDOW (selected_window
)
5130 && current_buffer
== XBUFFER (w
->buffer
))
5131 ? PT
: XMARKER (w
->pointm
)->charpos
;
5136 /* For fringes and margins, Y is relative to the area's (and the
5137 window's) top edge, while X is meaningless. */
5138 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5143 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5146 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5147 &object
, &dx
, &dy
, &width
, &height
);
5148 if (STRINGP (string
))
5149 string_info
= Fcons (string
, make_number (charpos
));
5150 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5152 else if (part
== ON_LEFT_FRINGE
)
5154 posn
= Qleft_fringe
;
5157 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5158 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5159 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5161 else if (part
== ON_RIGHT_FRINGE
)
5163 posn
= Qright_fringe
;
5166 - window_box_width (w
, LEFT_MARGIN_AREA
)
5167 - window_box_width (w
, TEXT_AREA
)
5168 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5169 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5171 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5173 else if (part
== ON_VERTICAL_BORDER
)
5175 posn
= Qvertical_line
;
5180 /* Nothing special for part == ON_SCROLL_BAR. */
5182 /* For clicks in the text area, fringes, or margins, call
5183 buffer_posn_from_coords to extract TEXTPOS, the buffer
5184 position nearest to the click. */
5187 Lisp_Object string2
, object2
= Qnil
;
5188 struct display_pos p
;
5190 int width2
, height2
;
5191 /* The pixel X coordinate passed to buffer_posn_from_coords
5192 is the X coordinate relative to the text area for
5193 text-area and right-margin clicks, zero otherwise. */
5195 = (part
== ON_TEXT
) ? xret
5196 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5197 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5201 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5202 &object2
, &dx2
, &dy2
,
5204 textpos
= CHARPOS (p
.pos
);
5205 if (col
< 0) col
= x2
;
5206 if (row
< 0) row
= y2
;
5207 if (dx
< 0) dx
= dx2
;
5208 if (dy
< 0) dy
= dy2
;
5209 if (width
< 0) width
= width2
;
5210 if (height
< 0) height
= height2
;
5214 posn
= make_number (textpos
);
5215 if (STRINGP (string2
))
5216 string_info
= Fcons (string2
,
5217 make_number (CHARPOS (p
.string_pos
)));
5223 #ifdef HAVE_WINDOW_SYSTEM
5224 if (IMAGEP (object
))
5226 Lisp_Object image_map
, hotspot
;
5227 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5229 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5231 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5232 posn
= XCAR (hotspot
);
5239 Fcons (make_number (dx
), make_number (dy
)),
5240 Fcons (make_number (width
), make_number (height
)));
5243 extra_info
= Fcons (string_info
,
5244 Fcons (make_number (textpos
),
5245 Fcons (Fcons (make_number (col
),
5250 XSETFRAME (window
, f
);
5254 return Fcons (window
,
5256 Fcons (Fcons (make_number (xret
),
5257 make_number (yret
)),
5258 Fcons (make_number (t
),
5262 /* Given a struct input_event, build the lisp event which represents
5263 it. If EVENT is 0, build a mouse movement event from the mouse
5264 movement buffer, which should have a movement event in it.
5266 Note that events must be passed to this function in the order they
5267 are received; this function stores the location of button presses
5268 in order to build drag events when the button is released. */
5271 make_lispy_event (struct input_event
*event
)
5275 switch (SWITCH_ENUM_CAST (event
->kind
))
5277 /* A simple keystroke. */
5278 case ASCII_KEYSTROKE_EVENT
:
5279 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5281 Lisp_Object lispy_c
;
5282 EMACS_INT c
= event
->code
;
5283 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5286 eassert (c
== event
->code
);
5287 /* Turn ASCII characters into control characters
5289 if (event
->modifiers
& ctrl_modifier
)
5291 c
= make_ctrl_char (c
);
5292 event
->modifiers
&= ~ctrl_modifier
;
5296 /* Add in the other modifier bits. The shift key was taken care
5297 of by the X code. */
5298 c
|= (event
->modifiers
5299 & (meta_modifier
| alt_modifier
5300 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5301 /* Distinguish Shift-SPC from SPC. */
5302 if ((event
->code
) == 040
5303 && event
->modifiers
& shift_modifier
)
5304 c
|= shift_modifier
;
5305 button_down_time
= 0;
5306 XSETFASTINT (lispy_c
, c
);
5311 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5312 except that they are non-key events (last-nonmenu-event is nil). */
5313 case NS_NONKEY_EVENT
:
5316 /* A function key. The symbol may need to have modifier prefixes
5318 case NON_ASCII_KEYSTROKE_EVENT
:
5319 button_down_time
= 0;
5321 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5322 if (event
->code
== lispy_accent_codes
[i
])
5323 return modify_event_symbol (i
,
5325 Qfunction_key
, Qnil
,
5326 lispy_accent_keys
, &accent_key_syms
,
5327 (sizeof (lispy_accent_keys
)
5328 / sizeof (lispy_accent_keys
[0])));
5332 if (event
->code
>= 0x400 && event
->code
< 0x500)
5333 return modify_event_symbol (event
->code
- 0x400,
5334 event
->modifiers
& ~shift_modifier
,
5335 Qfunction_key
, Qnil
,
5336 lispy_kana_keys
, &func_key_syms
,
5337 (sizeof (lispy_kana_keys
)
5338 / sizeof (lispy_kana_keys
[0])));
5339 #endif /* XK_kana_A */
5342 #ifdef ISO_FUNCTION_KEY_OFFSET
5343 if (event
->code
< FUNCTION_KEY_OFFSET
5344 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5345 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5347 Qfunction_key
, Qnil
,
5348 iso_lispy_function_keys
, &func_key_syms
,
5349 (sizeof (iso_lispy_function_keys
)
5350 / sizeof (iso_lispy_function_keys
[0])));
5353 /* Handle system-specific or unknown keysyms. */
5354 if (event
->code
& (1 << 28)
5355 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5356 || (event
->code
- FUNCTION_KEY_OFFSET
5357 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5358 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5360 /* We need to use an alist rather than a vector as the cache
5361 since we can't make a vector long enuf. */
5362 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5363 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5364 return modify_event_symbol (event
->code
,
5367 KVAR (current_kboard
, Vsystem_key_alist
),
5368 0, &KVAR (current_kboard
, system_key_syms
),
5372 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5374 Qfunction_key
, Qnil
,
5375 lispy_function_keys
, &func_key_syms
,
5376 (sizeof (lispy_function_keys
)
5377 / sizeof (lispy_function_keys
[0])));
5380 case MULTIMEDIA_KEY_EVENT
:
5381 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5382 / sizeof (lispy_multimedia_keys
[0]))
5383 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5385 return modify_event_symbol (event
->code
, event
->modifiers
,
5386 Qfunction_key
, Qnil
,
5387 lispy_multimedia_keys
, &func_key_syms
,
5388 (sizeof (lispy_multimedia_keys
)
5389 / sizeof (lispy_multimedia_keys
[0])));
5395 /* A mouse click. Figure out where it is, decide whether it's
5396 a press, click or drag, and build the appropriate structure. */
5397 case MOUSE_CLICK_EVENT
:
5398 #ifndef USE_TOOLKIT_SCROLL_BARS
5399 case SCROLL_BAR_CLICK_EVENT
:
5402 int button
= event
->code
;
5404 Lisp_Object position
;
5405 Lisp_Object
*start_pos_ptr
;
5406 Lisp_Object start_pos
;
5410 /* Build the position as appropriate for this mouse click. */
5411 if (event
->kind
== MOUSE_CLICK_EVENT
)
5413 struct frame
*f
= XFRAME (event
->frame_or_window
);
5414 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5418 /* Ignore mouse events that were made on frame that
5419 have been deleted. */
5420 if (! FRAME_LIVE_P (f
))
5423 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5424 /* EVENT->x and EVENT->y are frame-relative pixel
5425 coordinates at this place. Under old redisplay, COLUMN
5426 and ROW are set to frame relative glyph coordinates
5427 which are then used to determine whether this click is
5428 in a menu (non-toolkit version). */
5429 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5430 &column
, &row
, NULL
, 1);
5432 /* In the non-toolkit version, clicks on the menu bar
5433 are ordinary button events in the event buffer.
5434 Distinguish them, and invoke the menu.
5436 (In the toolkit version, the toolkit handles the menu bar
5437 and Emacs doesn't know about it until after the user
5438 makes a selection.) */
5439 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5440 && (event
->modifiers
& down_modifier
))
5442 Lisp_Object items
, item
;
5445 /* Find the menu bar item under `column'. */
5447 items
= FRAME_MENU_BAR_ITEMS (f
);
5448 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5450 Lisp_Object pos
, string
;
5451 string
= AREF (items
, i
+ 1);
5452 pos
= AREF (items
, i
+ 3);
5455 if (column
>= XINT (pos
)
5456 && column
< XINT (pos
) + SCHARS (string
))
5458 item
= AREF (items
, i
);
5463 /* ELisp manual 2.4b says (x y) are window relative but
5464 code says they are frame-relative. */
5466 = Fcons (event
->frame_or_window
,
5468 Fcons (Fcons (event
->x
, event
->y
),
5469 Fcons (make_number (event
->timestamp
),
5472 return Fcons (item
, Fcons (position
, Qnil
));
5474 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5476 position
= make_lispy_position (f
, event
->x
, event
->y
,
5479 #ifndef USE_TOOLKIT_SCROLL_BARS
5482 /* It's a scrollbar click. */
5484 Lisp_Object portion_whole
;
5487 window
= event
->frame_or_window
;
5488 portion_whole
= Fcons (event
->x
, event
->y
);
5489 part
= *scroll_bar_parts
[(int) event
->part
];
5493 Fcons (Qvertical_scroll_bar
,
5494 Fcons (portion_whole
,
5495 Fcons (make_number (event
->timestamp
),
5496 Fcons (part
, Qnil
)))));
5498 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5500 if (button
>= ASIZE (button_down_location
))
5502 button_down_location
= larger_vector (button_down_location
,
5504 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5507 start_pos_ptr
= &AREF (button_down_location
, button
);
5508 start_pos
= *start_pos_ptr
;
5509 *start_pos_ptr
= Qnil
;
5512 /* On window-system frames, use the value of
5513 double-click-fuzz as is. On other frames, interpret it
5514 as a multiple of 1/8 characters. */
5518 if (WINDOWP (event
->frame_or_window
))
5519 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5520 else if (FRAMEP (event
->frame_or_window
))
5521 f
= XFRAME (event
->frame_or_window
);
5525 if (FRAME_WINDOW_P (f
))
5526 fuzz
= double_click_fuzz
;
5528 fuzz
= double_click_fuzz
/ 8;
5530 is_double
= (button
== last_mouse_button
5531 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5532 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5533 && button_down_time
!= 0
5534 && (EQ (Vdouble_click_time
, Qt
)
5535 || (INTEGERP (Vdouble_click_time
)
5536 && ((int)(event
->timestamp
- button_down_time
)
5537 < XINT (Vdouble_click_time
)))));
5540 last_mouse_button
= button
;
5541 last_mouse_x
= XINT (event
->x
);
5542 last_mouse_y
= XINT (event
->y
);
5544 /* If this is a button press, squirrel away the location, so
5545 we can decide later whether it was a click or a drag. */
5546 if (event
->modifiers
& down_modifier
)
5550 double_click_count
++;
5551 event
->modifiers
|= ((double_click_count
> 2)
5556 double_click_count
= 1;
5557 button_down_time
= event
->timestamp
;
5558 *start_pos_ptr
= Fcopy_alist (position
);
5559 ignore_mouse_drag_p
= 0;
5562 /* Now we're releasing a button - check the co-ordinates to
5563 see if this was a click or a drag. */
5564 else if (event
->modifiers
& up_modifier
)
5566 /* If we did not see a down before this up, ignore the up.
5567 Probably this happened because the down event chose a
5568 menu item. It would be an annoyance to treat the
5569 release of the button that chose the menu item as a
5572 if (!CONSP (start_pos
))
5575 event
->modifiers
&= ~up_modifier
;
5578 Lisp_Object new_down
, down
;
5579 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5581 /* The third element of every position
5582 should be the (x,y) pair. */
5583 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5584 new_down
= Fcar (Fcdr (Fcdr (position
)));
5587 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5589 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5590 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5593 if (ignore_mouse_drag_p
)
5595 event
->modifiers
|= click_modifier
;
5596 ignore_mouse_drag_p
= 0;
5598 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5599 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5600 /* Maybe the mouse has moved a lot, caused scrolling, and
5601 eventually ended up at the same screen position (but
5602 not buffer position) in which case it is a drag, not
5604 /* FIXME: OTOH if the buffer position has changed
5605 because of a timer or process filter rather than
5606 because of mouse movement, it should be considered as
5607 a click. But mouse-drag-region completely ignores
5608 this case and it hasn't caused any real problem, so
5609 it's probably OK to ignore it as well. */
5610 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5611 /* Mouse hasn't moved (much). */
5612 event
->modifiers
|= click_modifier
;
5615 button_down_time
= 0;
5616 event
->modifiers
|= drag_modifier
;
5619 /* Don't check is_double; treat this as multiple
5620 if the down-event was multiple. */
5621 if (double_click_count
> 1)
5622 event
->modifiers
|= ((double_click_count
> 2)
5628 /* Every mouse event should either have the down_modifier or
5629 the up_modifier set. */
5633 /* Get the symbol we should use for the mouse click. */
5636 head
= modify_event_symbol (button
,
5638 Qmouse_click
, Vlispy_mouse_stem
,
5641 XVECTOR (mouse_syms
)->size
);
5642 if (event
->modifiers
& drag_modifier
)
5647 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5650 Fcons (make_number (double_click_count
),
5660 case HORIZ_WHEEL_EVENT
:
5662 Lisp_Object position
;
5665 /* Build the position as appropriate for this mouse click. */
5666 struct frame
*f
= XFRAME (event
->frame_or_window
);
5668 /* Ignore wheel events that were made on frame that have been
5670 if (! FRAME_LIVE_P (f
))
5673 position
= make_lispy_position (f
, event
->x
, event
->y
,
5676 /* Set double or triple modifiers to indicate the wheel speed. */
5678 /* On window-system frames, use the value of
5679 double-click-fuzz as is. On other frames, interpret it
5680 as a multiple of 1/8 characters. */
5686 if (WINDOWP (event
->frame_or_window
))
5687 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5688 else if (FRAMEP (event
->frame_or_window
))
5689 fr
= XFRAME (event
->frame_or_window
);
5693 fuzz
= FRAME_WINDOW_P (fr
)
5694 ? double_click_fuzz
: double_click_fuzz
/ 8;
5696 if (event
->modifiers
& up_modifier
)
5698 /* Emit a wheel-up event. */
5699 event
->modifiers
&= ~up_modifier
;
5702 else if (event
->modifiers
& down_modifier
)
5704 /* Emit a wheel-down event. */
5705 event
->modifiers
&= ~down_modifier
;
5709 /* Every wheel event should either have the down_modifier or
5710 the up_modifier set. */
5713 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5716 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5717 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5718 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5719 && button_down_time
!= 0
5720 && (EQ (Vdouble_click_time
, Qt
)
5721 || (INTEGERP (Vdouble_click_time
)
5722 && ((int)(event
->timestamp
- button_down_time
)
5723 < XINT (Vdouble_click_time
)))));
5726 double_click_count
++;
5727 event
->modifiers
|= ((double_click_count
> 2)
5733 double_click_count
= 1;
5734 event
->modifiers
|= click_modifier
;
5737 button_down_time
= event
->timestamp
;
5738 /* Use a negative value to distinguish wheel from mouse button. */
5739 last_mouse_button
= - (1 + symbol_num
);
5740 last_mouse_x
= XINT (event
->x
);
5741 last_mouse_y
= XINT (event
->y
);
5743 /* Get the symbol we should use for the wheel event. */
5744 head
= modify_event_symbol (symbol_num
,
5750 ASIZE (wheel_syms
));
5753 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5756 Fcons (make_number (double_click_count
),
5765 #ifdef USE_TOOLKIT_SCROLL_BARS
5767 /* We don't have down and up events if using toolkit scroll bars,
5768 so make this always a click event. Store in the `part' of
5769 the Lisp event a symbol which maps to the following actions:
5771 `above_handle' page up
5772 `below_handle' page down
5776 `bottom' bottom of buffer
5777 `handle' thumb has been dragged.
5778 `end-scroll' end of interaction with scroll bar
5780 The incoming input_event contains in its `part' member an
5781 index of type `enum scroll_bar_part' which we can use as an
5782 index in scroll_bar_parts to get the appropriate symbol. */
5784 case SCROLL_BAR_CLICK_EVENT
:
5786 Lisp_Object position
, head
, window
, portion_whole
, part
;
5788 window
= event
->frame_or_window
;
5789 portion_whole
= Fcons (event
->x
, event
->y
);
5790 part
= *scroll_bar_parts
[(int) event
->part
];
5794 Fcons (Qvertical_scroll_bar
,
5795 Fcons (portion_whole
,
5796 Fcons (make_number (event
->timestamp
),
5797 Fcons (part
, Qnil
)))));
5799 /* Always treat scroll bar events as clicks. */
5800 event
->modifiers
|= click_modifier
;
5801 event
->modifiers
&= ~up_modifier
;
5803 if (event
->code
>= ASIZE (mouse_syms
))
5804 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5806 /* Get the symbol we should use for the mouse click. */
5807 head
= modify_event_symbol (event
->code
,
5812 XVECTOR (mouse_syms
)->size
);
5813 return Fcons (head
, Fcons (position
, Qnil
));
5816 #endif /* USE_TOOLKIT_SCROLL_BARS */
5818 case DRAG_N_DROP_EVENT
:
5821 Lisp_Object head
, position
;
5824 f
= XFRAME (event
->frame_or_window
);
5827 /* Ignore mouse events that were made on frames that
5828 have been deleted. */
5829 if (! FRAME_LIVE_P (f
))
5832 position
= make_lispy_position (f
, event
->x
, event
->y
,
5835 head
= modify_event_symbol (0, event
->modifiers
,
5837 lispy_drag_n_drop_names
,
5838 &drag_n_drop_syms
, 1);
5844 #endif /* HAVE_MOUSE */
5846 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5847 || defined(HAVE_NS) || defined (USE_GTK)
5848 case MENU_BAR_EVENT
:
5849 if (EQ (event
->arg
, event
->frame_or_window
))
5850 /* This is the prefix key. We translate this to
5851 `(menu_bar)' because the code in keyboard.c for menu
5852 events, which we use, relies on this. */
5853 return Fcons (Qmenu_bar
, Qnil
);
5857 case SELECT_WINDOW_EVENT
:
5858 /* Make an event (select-window (WINDOW)). */
5859 return Fcons (Qselect_window
,
5860 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5863 case TOOL_BAR_EVENT
:
5864 if (EQ (event
->arg
, event
->frame_or_window
))
5865 /* This is the prefix key. We translate this to
5866 `(tool_bar)' because the code in keyboard.c for tool bar
5867 events, which we use, relies on this. */
5868 return Fcons (Qtool_bar
, Qnil
);
5869 else if (SYMBOLP (event
->arg
))
5870 return apply_modifiers (event
->modifiers
, event
->arg
);
5873 case USER_SIGNAL_EVENT
:
5874 /* A user signal. */
5876 char *name
= find_user_signal_name (event
->code
);
5879 return intern (name
);
5882 case SAVE_SESSION_EVENT
:
5883 return Qsave_session
;
5888 return Fcons (Qdbus_event
, event
->arg
);
5890 #endif /* HAVE_DBUS */
5892 case CONFIG_CHANGED_EVENT
:
5893 return Fcons (Qconfig_changed_event
,
5895 Fcons (event
->frame_or_window
, Qnil
)));
5897 case GPM_CLICK_EVENT
:
5899 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5900 Lisp_Object head
, position
;
5901 Lisp_Object
*start_pos_ptr
;
5902 Lisp_Object start_pos
;
5903 int button
= event
->code
;
5905 if (button
>= ASIZE (button_down_location
))
5907 button_down_location
= larger_vector (button_down_location
,
5909 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5912 start_pos_ptr
= &AREF (button_down_location
, button
);
5913 start_pos
= *start_pos_ptr
;
5915 position
= make_lispy_position (f
, event
->x
, event
->y
,
5918 if (event
->modifiers
& down_modifier
)
5919 *start_pos_ptr
= Fcopy_alist (position
);
5920 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5922 if (!CONSP (start_pos
))
5924 event
->modifiers
&= ~up_modifier
;
5927 head
= modify_event_symbol (button
,
5929 Qmouse_click
, Vlispy_mouse_stem
,
5932 XVECTOR (mouse_syms
)->size
);
5934 if (event
->modifiers
& drag_modifier
)
5939 else if (event
->modifiers
& double_modifier
)
5942 Fcons (make_number (2),
5944 else if (event
->modifiers
& triple_modifier
)
5947 Fcons (make_number (3),
5954 #endif /* HAVE_GPM */
5956 /* The 'kind' field of the event is something we don't recognize. */
5962 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
5965 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5966 Lisp_Object x
, Lisp_Object y
, unsigned long t
)
5968 /* Is it a scroll bar movement? */
5969 if (frame
&& ! NILP (bar_window
))
5971 Lisp_Object part_sym
;
5973 part_sym
= *scroll_bar_parts
[(int) part
];
5974 return Fcons (Qscroll_bar_movement
,
5975 Fcons (list5 (bar_window
,
5976 Qvertical_scroll_bar
,
5982 /* Or is it an ordinary mouse movement? */
5985 Lisp_Object position
;
5986 position
= make_lispy_position (frame
, x
, y
, t
);
5987 return list2 (Qmouse_movement
, position
);
5991 #endif /* HAVE_MOUSE || HAVE GPM */
5993 /* Construct a switch frame event. */
5995 make_lispy_switch_frame (Lisp_Object frame
)
5997 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6000 /* Manipulating modifiers. */
6002 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6004 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6005 SYMBOL's name of the end of the modifiers; the string from this
6006 position is the unmodified symbol name.
6008 This doesn't use any caches. */
6011 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6017 CHECK_SYMBOL (symbol
);
6020 name
= SYMBOL_NAME (symbol
);
6022 for (i
= 0; i
+2 <= SBYTES (name
); )
6024 EMACS_INT this_mod_end
= 0;
6027 /* See if the name continues with a modifier word.
6028 Check that the word appears, but don't check what follows it.
6029 Set this_mod and this_mod_end to record what we find. */
6031 switch (SREF (name
, i
))
6033 #define SINGLE_LETTER_MOD(BIT) \
6034 (this_mod_end = i + 1, this_mod = BIT)
6037 SINGLE_LETTER_MOD (alt_modifier
);
6041 SINGLE_LETTER_MOD (ctrl_modifier
);
6045 SINGLE_LETTER_MOD (hyper_modifier
);
6049 SINGLE_LETTER_MOD (meta_modifier
);
6053 SINGLE_LETTER_MOD (shift_modifier
);
6057 SINGLE_LETTER_MOD (super_modifier
);
6060 #undef SINGLE_LETTER_MOD
6062 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6063 if (i + LEN + 1 <= SBYTES (name) \
6064 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6066 this_mod_end = i + LEN; \
6071 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6072 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6073 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6077 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6079 #undef MULTI_LETTER_MOD
6083 /* If we found no modifier, stop looking for them. */
6084 if (this_mod_end
== 0)
6087 /* Check there is a dash after the modifier, so that it
6088 really is a modifier. */
6089 if (this_mod_end
>= SBYTES (name
)
6090 || SREF (name
, this_mod_end
) != '-')
6093 /* This modifier is real; look for another. */
6094 modifiers
|= this_mod
;
6095 i
= this_mod_end
+ 1;
6098 /* Should we include the `click' modifier? */
6099 if (! (modifiers
& (down_modifier
| drag_modifier
6100 | double_modifier
| triple_modifier
))
6101 && i
+ 7 == SBYTES (name
)
6102 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6103 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6104 modifiers
|= click_modifier
;
6106 if (! (modifiers
& (double_modifier
| triple_modifier
))
6107 && i
+ 6 < SBYTES (name
)
6108 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6109 modifiers
|= click_modifier
;
6117 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6118 prepended to the string BASE[0..BASE_LEN-1].
6119 This doesn't use any caches. */
6121 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6123 /* Since BASE could contain nulls, we can't use intern here; we have
6124 to use Fintern, which expects a genuine Lisp_String, and keeps a
6127 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6133 /* Only the event queue may use the `up' modifier; it should always
6134 be turned into a click or drag event before presented to lisp code. */
6135 if (modifiers
& up_modifier
)
6138 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6139 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6140 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6141 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6142 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6143 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6144 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6145 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6146 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6147 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6148 /* The click modifier is denoted by the absence of other modifiers. */
6152 mod_len
= p
- new_mods
;
6156 Lisp_Object new_name
;
6158 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6159 mod_len
+ base_len_byte
);
6160 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6161 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6163 return Fintern (new_name
, Qnil
);
6168 static const char *const modifier_names
[] =
6170 "up", "down", "drag", "click", "double", "triple", 0, 0,
6171 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6172 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6174 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6176 static Lisp_Object modifier_symbols
;
6178 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6180 lispy_modifier_list (int modifiers
)
6182 Lisp_Object modifier_list
;
6185 modifier_list
= Qnil
;
6186 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6187 if (modifiers
& (1<<i
))
6188 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6191 return modifier_list
;
6195 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6196 where UNMODIFIED is the unmodified form of SYMBOL,
6197 MASK is the set of modifiers present in SYMBOL's name.
6198 This is similar to parse_modifiers_uncached, but uses the cache in
6199 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6200 Qevent_symbol_elements property. */
6202 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6205 parse_modifiers (Lisp_Object symbol
)
6207 Lisp_Object elements
;
6209 if (INTEGERP (symbol
))
6210 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6211 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6213 else if (!SYMBOLP (symbol
))
6216 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6217 if (CONSP (elements
))
6222 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6223 Lisp_Object unmodified
;
6226 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6227 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6230 if (modifiers
& ~INTMASK
)
6232 XSETFASTINT (mask
, modifiers
);
6233 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6235 /* Cache the parsing results on SYMBOL. */
6236 Fput (symbol
, Qevent_symbol_element_mask
,
6238 Fput (symbol
, Qevent_symbol_elements
,
6239 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6241 /* Since we know that SYMBOL is modifiers applied to unmodified,
6242 it would be nice to put that in unmodified's cache.
6243 But we can't, since we're not sure that parse_modifiers is
6250 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6251 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6252 doc
: /* Parse the event symbol. For internal use. */)
6253 (Lisp_Object symbol
)
6255 /* Fill the cache if needed. */
6256 parse_modifiers (symbol
);
6257 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6258 and use the Lispier representation stored on Qevent_symbol_elements
6260 return Fget (symbol
, Qevent_symbol_elements
);
6263 /* Apply the modifiers MODIFIERS to the symbol BASE.
6264 BASE must be unmodified.
6266 This is like apply_modifiers_uncached, but uses BASE's
6267 Qmodifier_cache property, if present. It also builds
6268 Qevent_symbol_elements properties, since it has that info anyway.
6270 apply_modifiers copies the value of BASE's Qevent_kind property to
6271 the modified symbol. */
6273 apply_modifiers (int modifiers
, Lisp_Object base
)
6275 Lisp_Object cache
, idx
, entry
, new_symbol
;
6277 /* Mask out upper bits. We don't know where this value's been. */
6278 modifiers
&= INTMASK
;
6280 if (INTEGERP (base
))
6281 return make_number (XINT (base
) | modifiers
);
6283 /* The click modifier never figures into cache indices. */
6284 cache
= Fget (base
, Qmodifier_cache
);
6285 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6286 entry
= assq_no_quit (idx
, cache
);
6289 new_symbol
= XCDR (entry
);
6292 /* We have to create the symbol ourselves. */
6293 new_symbol
= apply_modifiers_uncached (modifiers
,
6294 SSDATA (SYMBOL_NAME (base
)),
6295 SCHARS (SYMBOL_NAME (base
)),
6296 SBYTES (SYMBOL_NAME (base
)));
6298 /* Add the new symbol to the base's cache. */
6299 entry
= Fcons (idx
, new_symbol
);
6300 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6302 /* We have the parsing info now for free, so we could add it to
6304 XSETFASTINT (idx, modifiers);
6305 Fput (new_symbol, Qevent_symbol_element_mask,
6306 Fcons (base, Fcons (idx, Qnil)));
6307 Fput (new_symbol, Qevent_symbol_elements,
6308 Fcons (base, lispy_modifier_list (modifiers)));
6309 Sadly, this is only correct if `base' is indeed a base event,
6310 which is not necessarily the case. -stef */
6313 /* Make sure this symbol is of the same kind as BASE.
6315 You'd think we could just set this once and for all when we
6316 intern the symbol above, but reorder_modifiers may call us when
6317 BASE's property isn't set right; we can't assume that just
6318 because it has a Qmodifier_cache property it must have its
6319 Qevent_kind set right as well. */
6320 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6324 kind
= Fget (base
, Qevent_kind
);
6326 Fput (new_symbol
, Qevent_kind
, kind
);
6333 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6334 return a symbol with the modifiers placed in the canonical order.
6335 Canonical order is alphabetical, except for down and drag, which
6336 always come last. The 'click' modifier is never written out.
6338 Fdefine_key calls this to make sure that (for example) C-M-foo
6339 and M-C-foo end up being equivalent in the keymap. */
6342 reorder_modifiers (Lisp_Object symbol
)
6344 /* It's hopefully okay to write the code this way, since everything
6345 will soon be in caches, and no consing will be done at all. */
6348 parsed
= parse_modifiers (symbol
);
6349 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6354 /* For handling events, we often want to produce a symbol whose name
6355 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6356 to some base, like the name of a function key or mouse button.
6357 modify_event_symbol produces symbols of this sort.
6359 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6360 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6363 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6364 into symbol names, or a string specifying a name stem used to
6365 construct a symbol name or the form `STEM-N', where N is the decimal
6366 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6367 non-nil; otherwise NAME_TABLE is used.
6369 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6370 persist between calls to modify_event_symbol that it can use to
6371 store a cache of the symbols it's generated for this NAME_TABLE
6372 before. The object stored there may be a vector or an alist.
6374 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6376 MODIFIERS is a set of modifier bits (as given in struct input_events)
6377 whose prefixes should be applied to the symbol name.
6379 SYMBOL_KIND is the value to be placed in the event_kind property of
6380 the returned symbol.
6382 The symbols we create are supposed to have an
6383 `event-symbol-elements' property, which lists the modifiers present
6384 in the symbol's name. */
6387 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6388 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6389 Lisp_Object
*symbol_table
, unsigned int table_size
)
6392 Lisp_Object symbol_int
;
6394 /* Get rid of the "vendor-specific" bit here. */
6395 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6397 /* Is this a request for a valid symbol? */
6398 if (symbol_num
< 0 || symbol_num
>= table_size
)
6401 if (CONSP (*symbol_table
))
6402 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6404 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6405 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6406 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6407 we've never used that symbol before. */
6410 if (! VECTORP (*symbol_table
)
6411 || XVECTOR (*symbol_table
)->size
!= table_size
)
6415 XSETFASTINT (size
, table_size
);
6416 *symbol_table
= Fmake_vector (size
, Qnil
);
6419 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6422 /* Have we already used this symbol before? */
6425 /* No; let's create it. */
6426 if (CONSP (name_alist_or_stem
))
6427 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6428 else if (STRINGP (name_alist_or_stem
))
6430 int len
= SBYTES (name_alist_or_stem
);
6431 char *buf
= (char *) alloca (len
+ 50);
6432 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6433 (long) XINT (symbol_int
) + 1);
6434 value
= intern (buf
);
6436 else if (name_table
!= 0 && name_table
[symbol_num
])
6437 value
= intern (name_table
[symbol_num
]);
6439 #ifdef HAVE_WINDOW_SYSTEM
6442 char *name
= x_get_keysym_name (symbol_num
);
6444 value
= intern (name
);
6451 sprintf (buf
, "key-%ld", (long)symbol_num
);
6452 value
= intern (buf
);
6455 if (CONSP (*symbol_table
))
6456 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6458 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6460 /* Fill in the cache entries for this symbol; this also
6461 builds the Qevent_symbol_elements property, which the user
6463 apply_modifiers (modifiers
& click_modifier
, value
);
6464 Fput (value
, Qevent_kind
, symbol_kind
);
6467 /* Apply modifiers to that symbol. */
6468 return apply_modifiers (modifiers
, value
);
6471 /* Convert a list that represents an event type,
6472 such as (ctrl meta backspace), into the usual representation of that
6473 event type as a number or a symbol. */
6475 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6476 doc
: /* Convert the event description list EVENT-DESC to an event type.
6477 EVENT-DESC should contain one base event type (a character or symbol)
6478 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6479 drag, down, double or triple). The base must be last.
6480 The return value is an event type (a character or symbol) which
6481 has the same base event type and all the specified modifiers. */)
6482 (Lisp_Object event_desc
)
6490 while (CONSP (rest
))
6498 /* Given a symbol, see if it is a modifier name. */
6499 if (SYMBOLP (elt
) && CONSP (rest
))
6500 this = parse_solitary_modifier (elt
);
6504 else if (!NILP (base
))
6505 error ("Two bases given in one event");
6511 /* Let the symbol A refer to the character A. */
6512 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6513 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6515 if (INTEGERP (base
))
6517 /* Turn (shift a) into A. */
6518 if ((modifiers
& shift_modifier
) != 0
6519 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6521 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6522 modifiers
&= ~shift_modifier
;
6525 /* Turn (control a) into C-a. */
6526 if (modifiers
& ctrl_modifier
)
6527 return make_number ((modifiers
& ~ctrl_modifier
)
6528 | make_ctrl_char (XINT (base
)));
6530 return make_number (modifiers
| XINT (base
));
6532 else if (SYMBOLP (base
))
6533 return apply_modifiers (modifiers
, base
);
6536 error ("Invalid base event");
6541 /* Try to recognize SYMBOL as a modifier name.
6542 Return the modifier flag bit, or 0 if not recognized. */
6545 parse_solitary_modifier (Lisp_Object symbol
)
6547 Lisp_Object name
= SYMBOL_NAME (symbol
);
6549 switch (SREF (name
, 0))
6551 #define SINGLE_LETTER_MOD(BIT) \
6552 if (SBYTES (name) == 1) \
6555 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6556 if (LEN == SBYTES (name) \
6557 && ! strncmp (SSDATA (name), NAME, LEN)) \
6561 SINGLE_LETTER_MOD (alt_modifier
);
6565 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6569 SINGLE_LETTER_MOD (ctrl_modifier
);
6573 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6574 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6578 SINGLE_LETTER_MOD (hyper_modifier
);
6582 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6586 SINGLE_LETTER_MOD (meta_modifier
);
6590 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6594 SINGLE_LETTER_MOD (shift_modifier
);
6598 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6599 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6600 SINGLE_LETTER_MOD (super_modifier
);
6604 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6605 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6606 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6610 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6613 #undef SINGLE_LETTER_MOD
6614 #undef MULTI_LETTER_MOD
6620 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6621 Such a list is not valid as an event,
6622 but it can be a Lucid-style event type list. */
6625 lucid_event_type_list_p (Lisp_Object object
)
6629 if (! CONSP (object
))
6632 if (EQ (XCAR (object
), Qhelp_echo
)
6633 || EQ (XCAR (object
), Qvertical_line
)
6634 || EQ (XCAR (object
), Qmode_line
)
6635 || EQ (XCAR (object
), Qheader_line
))
6638 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6642 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6649 /* Store into *addr a value nonzero if terminal input chars are available.
6650 Serves the purpose of ioctl (0, FIONREAD, addr)
6651 but works even if FIONREAD does not exist.
6652 (In fact, this may actually read some input.)
6654 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6655 timer events that are ripe.
6656 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6657 events (FOCUS_IN_EVENT).
6658 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6659 movements and toolkit scroll bar thumb drags. */
6662 get_input_pending (int *addr
, int flags
)
6664 /* First of all, have we already counted some input? */
6665 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6667 /* If input is being read as it arrives, and we have none, there is none. */
6668 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6671 /* Try to read some input and see how much we get. */
6673 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6676 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6679 gobble_input (int expected
)
6682 if (interrupt_input
)
6685 mask
= sigblock (sigmask (SIGIO
));
6686 read_avail_input (expected
);
6690 #ifdef POLL_FOR_INPUT
6691 /* XXX This condition was (read_socket_hook && !interrupt_input),
6692 but read_socket_hook is not global anymore. Let's pretend that
6694 if (!interrupt_input
&& poll_suppress_count
== 0)
6697 mask
= sigblock (sigmask (SIGALRM
));
6698 read_avail_input (expected
);
6704 read_avail_input (expected
);
6707 /* Put a BUFFER_SWITCH_EVENT in the buffer
6708 so that read_key_sequence will notice the new current buffer. */
6711 record_asynch_buffer_change (void)
6713 struct input_event event
;
6717 event
.kind
= BUFFER_SWITCH_EVENT
;
6718 event
.frame_or_window
= Qnil
;
6721 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6722 The purpose of the event is to make read_key_sequence look up the
6723 keymaps again. If we aren't in read_key_sequence, we don't need one,
6724 and the event could cause trouble by messing up (input-pending-p).
6725 Note: Fwaiting_for_user_input_p always returns nil when async
6726 subprocesses aren't supported. */
6727 tem
= Fwaiting_for_user_input_p ();
6731 /* Make sure no interrupt happens while storing the event. */
6733 if (interrupt_input
)
6736 mask
= sigblock (sigmask (SIGIO
));
6737 kbd_buffer_store_event (&event
);
6744 kbd_buffer_store_event (&event
);
6749 /* Read any terminal input already buffered up by the system
6750 into the kbd_buffer, but do not wait.
6752 EXPECTED should be nonzero if the caller knows there is some input.
6754 Returns the number of keyboard chars read, or -1 meaning
6755 this is a bad time to try to read input. */
6758 read_avail_input (int expected
)
6764 /* Store pending user signal events, if any. */
6765 if (store_user_signal_events ())
6768 /* Loop through the available terminals, and call their input hooks. */
6772 struct terminal
*next
= t
->next_terminal
;
6774 if (t
->read_socket_hook
)
6777 struct input_event hold_quit
;
6779 EVENT_INIT (hold_quit
);
6780 hold_quit
.kind
= NO_EVENT
;
6782 /* No need for FIONREAD or fcntl; just say don't wait. */
6783 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6789 if (nr
== -1) /* Not OK to read input now. */
6793 else if (nr
== -2) /* Non-transient error. */
6795 /* The terminal device terminated; it should be closed. */
6797 /* Kill Emacs if this was our last terminal. */
6798 if (!terminal_list
->next_terminal
)
6799 /* Formerly simply reported no input, but that
6800 sometimes led to a failure of Emacs to terminate.
6801 SIGHUP seems appropriate if we can't reach the
6803 /* ??? Is it really right to send the signal just to
6804 this process rather than to the whole process
6805 group? Perhaps on systems with FIONREAD Emacs is
6806 alone in its group. */
6807 kill (getpid (), SIGHUP
);
6809 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6812 XSETTERMINAL (tmp
, t
);
6813 Fdelete_terminal (tmp
, Qnoelisp
);
6817 if (hold_quit
.kind
!= NO_EVENT
)
6818 kbd_buffer_store_event (&hold_quit
);
6827 frame_make_pointer_visible ();
6833 decode_keyboard_code (struct tty_display_info
*tty
,
6834 struct coding_system
*coding
,
6835 unsigned char *buf
, int nbytes
)
6837 unsigned char *src
= buf
;
6838 const unsigned char *p
;
6843 if (tty
->meta_key
!= 2)
6844 for (i
= 0; i
< nbytes
; i
++)
6846 if (coding
->carryover_bytes
> 0)
6848 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6849 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6850 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6851 nbytes
+= coding
->carryover_bytes
;
6853 coding
->destination
= alloca (nbytes
* 4);
6854 coding
->dst_bytes
= nbytes
* 4;
6855 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6856 if (coding
->produced_char
== 0)
6858 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6860 struct input_event event_buf
;
6862 EVENT_INIT (event_buf
);
6863 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6865 (ASCII_CHAR_P (event_buf
.code
)
6866 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6867 /* See the comment in tty_read_avail_input. */
6868 event_buf
.frame_or_window
= tty
->top_frame
;
6869 event_buf
.arg
= Qnil
;
6870 kbd_buffer_store_event (&event_buf
);
6874 /* This is the tty way of reading available input.
6876 Note that each terminal device has its own `struct terminal' object,
6877 and so this function is called once for each individual termcap
6878 terminal. The first parameter indicates which terminal to read from. */
6881 tty_read_avail_input (struct terminal
*terminal
,
6883 struct input_event
*hold_quit
)
6885 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6886 the kbd_buffer can really hold. That may prevent loss
6887 of characters on some systems when input is stuffed at us. */
6888 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6890 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6893 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6895 if (kbd_on_hold_p () || buffer_free
<= 0)
6897 #endif /* subprocesses */
6899 if (!terminal
->name
) /* Don't read from a dead terminal. */
6902 if (terminal
->type
!= output_termcap
6903 && terminal
->type
!= output_msdos_raw
)
6906 /* XXX I think the following code should be moved to separate hook
6907 functions in system-dependent files. */
6910 #else /* not WINDOWSNT */
6911 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6915 return 0; /* The terminal is suspended. */
6918 n_to_read
= dos_keysns ();
6922 cbuf
[0] = dos_keyread ();
6925 #else /* not MSDOS */
6930 struct input_event gpm_hold_quit
;
6931 int gpm
, fd
= gpm_fd
;
6933 EVENT_INIT (gpm_hold_quit
);
6934 gpm_hold_quit
.kind
= NO_EVENT
;
6936 /* gpm==1 if event received.
6937 gpm==0 if the GPM daemon has closed the connection, in which case
6938 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6939 we save it in `fd' so close_gpm can remove it from the
6941 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6942 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6943 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6946 /* Presumably the GPM daemon has closed the connection. */
6948 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6949 kbd_buffer_store_event (&gpm_hold_quit
);
6953 #endif /* HAVE_GPM */
6955 /* Determine how many characters we should *try* to read. */
6957 /* Find out how much input is available. */
6958 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6960 if (! noninteractive
)
6961 return -2; /* Close this terminal. */
6967 if (n_to_read
> sizeof cbuf
)
6968 n_to_read
= sizeof cbuf
;
6969 #else /* no FIONREAD */
6970 #if defined (USG) || defined(CYGWIN)
6971 /* Read some input if available, but don't wait. */
6972 n_to_read
= sizeof cbuf
;
6973 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6980 /* Don't read more than we can store. */
6981 if (n_to_read
> buffer_free
)
6982 n_to_read
= buffer_free
;
6983 #endif /* subprocesses */
6985 /* Now read; for one reason or another, this will not block.
6986 NREAD is set to the number of chars read. */
6989 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6990 /* POSIX infers that processes which are not in the session leader's
6991 process group won't get SIGHUP's at logout time. BSDI adheres to
6992 this part standard and returns -1 from read (0) with errno==EIO
6993 when the control tty is taken away.
6994 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6995 if (nread
== -1 && errno
== EIO
)
6996 return -2; /* Close this terminal. */
6997 #if defined (AIX) && defined (_BSD)
6998 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6999 This looks incorrect, but it isn't, because _BSD causes
7000 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7001 and that causes a value other than 0 when there is no input. */
7003 return -2; /* Close this terminal. */
7007 /* We used to retry the read if it was interrupted.
7008 But this does the wrong thing when O_NDELAY causes
7009 an EAGAIN error. Does anybody know of a situation
7010 where a retry is actually needed? */
7012 nread
< 0 && (errno
== EAGAIN
7026 #if defined (USG) || defined (CYGWIN)
7027 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7028 #endif /* USG or CYGWIN */
7029 #endif /* no FIONREAD */
7034 #endif /* not MSDOS */
7035 #endif /* not WINDOWSNT */
7037 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7038 & CODING_REQUIRE_DECODING_MASK
)
7040 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7043 /* Decode the key sequence except for those with meta
7045 for (i
= from
= 0; ; i
++)
7046 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7048 struct input_event buf
;
7050 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7055 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7056 buf
.modifiers
= meta_modifier
;
7057 buf
.code
= cbuf
[i
] & ~0x80;
7058 /* See the comment below. */
7059 buf
.frame_or_window
= tty
->top_frame
;
7061 kbd_buffer_store_event (&buf
);
7067 for (i
= 0; i
< nread
; i
++)
7069 struct input_event buf
;
7071 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7073 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7074 buf
.modifiers
= meta_modifier
;
7075 if (tty
->meta_key
!= 2)
7079 /* Set the frame corresponding to the active tty. Note that the
7080 value of selected_frame is not reliable here, redisplay tends
7081 to temporarily change it. */
7082 buf
.frame_or_window
= tty
->top_frame
;
7085 kbd_buffer_store_event (&buf
);
7086 /* Don't look at input that follows a C-g too closely.
7087 This reduces lossage due to autorepeat on C-g. */
7088 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7089 && buf
.code
== quit_char
)
7097 handle_async_input (void)
7099 interrupt_input_pending
= 0;
7101 pending_signals
= pending_atimers
;
7103 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7104 doing anything dangerous. */
7111 nread
= read_avail_input (1);
7112 /* -1 means it's not ok to read the input now.
7113 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7114 0 means there was no keyboard input available. */
7124 process_pending_signals (void)
7126 if (interrupt_input_pending
)
7127 handle_async_input ();
7128 do_pending_atimers ();
7131 #ifdef SIGIO /* for entire page */
7132 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7135 input_available_signal (int signo
)
7137 /* Must preserve main program's value of errno. */
7138 int old_errno
= errno
;
7139 SIGNAL_THREAD_CHECK (signo
);
7142 interrupt_input_pending
= 1;
7143 pending_signals
= 1;
7146 if (input_available_clear_time
)
7147 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7150 handle_async_input ();
7157 /* Send ourselves a SIGIO.
7159 This function exists so that the UNBLOCK_INPUT macro in
7160 blockinput.h can have some way to take care of input we put off
7161 dealing with, without assuming that every file which uses
7162 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7164 reinvoke_input_signal (void)
7167 handle_async_input ();
7173 /* User signal events. */
7175 struct user_signal_info
7177 /* Signal number. */
7180 /* Name of the signal. */
7183 /* Number of pending signals. */
7186 struct user_signal_info
*next
;
7189 /* List of user signals. */
7190 static struct user_signal_info
*user_signals
= NULL
;
7193 add_user_signal (int sig
, const char *name
)
7195 struct user_signal_info
*p
;
7197 for (p
= user_signals
; p
; p
= p
->next
)
7199 /* Already added. */
7202 p
= xmalloc (sizeof (struct user_signal_info
));
7204 p
->name
= xstrdup (name
);
7206 p
->next
= user_signals
;
7209 signal (sig
, handle_user_signal
);
7213 handle_user_signal (int sig
)
7215 int old_errno
= errno
;
7216 struct user_signal_info
*p
;
7218 SIGNAL_THREAD_CHECK (sig
);
7220 for (p
= user_signals
; p
; p
= p
->next
)
7225 if (interrupt_input
)
7226 kill (getpid (), SIGIO
);
7230 /* Tell wait_reading_process_output that it needs to wake
7231 up and look around. */
7232 if (input_available_clear_time
)
7233 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7242 find_user_signal_name (int sig
)
7244 struct user_signal_info
*p
;
7246 for (p
= user_signals
; p
; p
= p
->next
)
7254 store_user_signal_events (void)
7256 struct user_signal_info
*p
;
7257 struct input_event buf
;
7260 for (p
= user_signals
; p
; p
= p
->next
)
7261 if (p
->npending
> 0)
7267 memset (&buf
, 0, sizeof buf
);
7268 buf
.kind
= USER_SIGNAL_EVENT
;
7269 buf
.frame_or_window
= selected_frame
;
7271 nstored
+= p
->npending
;
7273 mask
= sigblock (sigmask (p
->sig
));
7277 kbd_buffer_store_event (&buf
);
7280 while (p
->npending
> 0);
7288 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7289 static Lisp_Object menu_bar_one_keymap_changed_items
;
7291 /* These variables hold the vector under construction within
7292 menu_bar_items and its subroutines, and the current index
7293 for storing into that vector. */
7294 static Lisp_Object menu_bar_items_vector
;
7295 static int menu_bar_items_index
;
7298 static const char* separator_names
[] = {
7303 "single-dashed-line",
7304 "double-dashed-line",
7306 "shadow-etched-out",
7307 "shadow-etched-in-dash",
7308 "shadow-etched-out-dash",
7309 "shadow-double-etched-in",
7310 "shadow-double-etched-out",
7311 "shadow-double-etched-in-dash",
7312 "shadow-double-etched-out-dash",
7316 /* Return non-zero if LABEL specifies a separator. */
7319 menu_separator_name_p (const char *label
)
7323 else if (strlen (label
) > 3
7324 && strncmp (label
, "--", 2) == 0
7329 for (i
= 0; separator_names
[i
]; ++i
)
7330 if (strcmp (label
, separator_names
[i
]) == 0)
7335 /* It's a separator if it contains only dashes. */
7336 while (*label
== '-')
7338 return (*label
== 0);
7345 /* Return a vector of menu items for a menu bar, appropriate
7346 to the current buffer. Each item has three elements in the vector:
7349 OLD is an old vector we can optionally reuse, or nil. */
7352 menu_bar_items (Lisp_Object old
)
7354 /* The number of keymaps we're scanning right now, and the number of
7355 keymaps we have allocated space for. */
7358 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7359 in the current keymaps, or nil where it is not a prefix. */
7362 Lisp_Object def
, tail
;
7367 /* In order to build the menus, we need to call the keymap
7368 accessors. They all call QUIT. But this function is called
7369 during redisplay, during which a quit is fatal. So inhibit
7370 quitting while building the menus.
7371 We do this instead of specbind because (1) errors will clear it anyway
7372 and (2) this avoids risk of specpdl overflow. */
7373 oquit
= Vinhibit_quit
;
7377 menu_bar_items_vector
= old
;
7379 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7380 menu_bar_items_index
= 0;
7382 /* Build our list of keymaps.
7383 If we recognize a function key and replace its escape sequence in
7384 keybuf with its symbol, or if the sequence starts with a mouse
7385 click and we need to switch buffers, we jump back here to rebuild
7386 the initial keymaps from the current buffer. */
7390 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7391 if (!NILP (Voverriding_local_map_menu_flag
))
7393 /* Yes, use them (if non-nil) as well as the global map. */
7394 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7396 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7397 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7398 if (!NILP (Voverriding_local_map
))
7399 maps
[nmaps
++] = Voverriding_local_map
;
7403 /* No, so use major and minor mode keymaps and keymap property.
7404 Note that menu-bar bindings in the local-map and keymap
7405 properties may not work reliable, as they are only
7406 recognized when the menu-bar (or mode-line) is updated,
7407 which does not normally happen after every command. */
7410 nminor
= current_minor_maps (NULL
, &tmaps
);
7411 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7413 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7414 maps
[nmaps
++] = tem
;
7415 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7417 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7419 maps
[nmaps
++] = current_global_map
;
7422 /* Look up in each map the dummy prefix key `menu-bar'. */
7424 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7425 if (!NILP (maps
[mapno
]))
7427 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7431 menu_bar_one_keymap_changed_items
= Qnil
;
7432 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7436 /* Move to the end those items that should be at the end. */
7438 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7441 int end
= menu_bar_items_index
;
7443 for (i
= 0; i
< end
; i
+= 4)
7444 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7446 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7447 /* Move the item at index I to the end,
7448 shifting all the others forward. */
7449 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7450 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7451 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7452 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7454 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7455 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7456 (end
- i
- 4) * sizeof (Lisp_Object
));
7457 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7458 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7459 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7460 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7465 /* Add nil, nil, nil, nil at the end. */
7467 int i
= menu_bar_items_index
;
7468 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7469 menu_bar_items_vector
=
7470 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7471 /* Add this item. */
7472 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7473 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7474 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7475 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7476 menu_bar_items_index
= i
;
7479 Vinhibit_quit
= oquit
;
7480 return menu_bar_items_vector
;
7483 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7484 If there's already an item for KEY, add this DEF to it. */
7486 Lisp_Object item_properties
;
7489 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7491 struct gcpro gcpro1
;
7495 if (EQ (item
, Qundefined
))
7497 /* If a map has an explicit `undefined' as definition,
7498 discard any previously made menu bar item. */
7500 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7501 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7503 if (menu_bar_items_index
> i
+ 4)
7504 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7505 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7506 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7507 menu_bar_items_index
-= 4;
7511 /* If this keymap has already contributed to this KEY,
7512 don't contribute to it a second time. */
7513 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7514 if (!NILP (tem
) || NILP (item
))
7517 menu_bar_one_keymap_changed_items
7518 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7520 /* We add to menu_bar_one_keymap_changed_items before doing the
7521 parse_menu_item, so that if it turns out it wasn't a menu item,
7522 it still correctly hides any further menu item. */
7524 i
= parse_menu_item (item
, 1);
7529 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7531 /* Find any existing item for this KEY. */
7532 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7533 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7536 /* If we did not find this KEY, add it at the end. */
7537 if (i
== menu_bar_items_index
)
7539 /* If vector is too small, get a bigger one. */
7540 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7541 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7542 /* Add this item. */
7543 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7544 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7545 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7546 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7547 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7548 menu_bar_items_index
= i
;
7550 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7554 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7555 /* If the new and the old items are not both keymaps,
7556 the lookup will only find `item'. */
7557 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7558 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7562 /* This is used as the handler when calling menu_item_eval_property. */
7564 menu_item_eval_property_1 (Lisp_Object arg
)
7566 /* If we got a quit from within the menu computation,
7567 quit all the way out of it. This takes care of C-] in the debugger. */
7568 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7569 Fsignal (Qquit
, Qnil
);
7575 eval_dyn (Lisp_Object form
)
7577 return Feval (form
, Qnil
);
7580 /* Evaluate an expression and return the result (or nil if something
7581 went wrong). Used to evaluate dynamic parts of menu items. */
7583 menu_item_eval_property (Lisp_Object sexpr
)
7585 int count
= SPECPDL_INDEX ();
7587 specbind (Qinhibit_redisplay
, Qt
);
7588 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7589 menu_item_eval_property_1
);
7590 return unbind_to (count
, val
);
7593 /* This function parses a menu item and leaves the result in the
7594 vector item_properties.
7595 ITEM is a key binding, a possible menu item.
7596 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7598 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7599 parse_menu_item returns true if the item is a menu item and false
7603 parse_menu_item (Lisp_Object item
, int inmenubar
)
7605 Lisp_Object def
, tem
, item_string
, start
;
7607 Lisp_Object keyhint
;
7616 /* Create item_properties vector if necessary. */
7617 if (NILP (item_properties
))
7619 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7621 /* Initialize optional entries. */
7622 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7623 ASET (item_properties
, i
, Qnil
);
7624 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7626 /* Save the item here to protect it from GC. */
7627 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7629 item_string
= XCAR (item
);
7633 if (STRINGP (item_string
))
7635 /* Old format menu item. */
7636 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7638 /* Maybe help string. */
7639 if (CONSP (item
) && STRINGP (XCAR (item
)))
7641 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7646 /* Maybe an obsolete key binding cache. */
7647 if (CONSP (item
) && CONSP (XCAR (item
))
7648 && (NILP (XCAR (XCAR (item
)))
7649 || VECTORP (XCAR (XCAR (item
)))))
7652 /* This is the real definition--the function to run. */
7653 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7655 /* Get enable property, if any. */
7658 tem
= Fget (item
, Qmenu_enable
);
7659 if (!NILP (Venable_disabled_menus_and_buttons
))
7660 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7661 else if (!NILP (tem
))
7662 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7665 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7667 /* New format menu item. */
7668 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7669 start
= XCDR (item
);
7672 /* We have a real binding. */
7673 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7675 item
= XCDR (start
);
7676 /* Is there an obsolete cache list with key equivalences. */
7677 if (CONSP (item
) && CONSP (XCAR (item
)))
7680 /* Parse properties. */
7681 while (CONSP (item
) && CONSP (XCDR (item
)))
7686 if (EQ (tem
, QCenable
))
7688 if (!NILP (Venable_disabled_menus_and_buttons
))
7689 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7691 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7693 else if (EQ (tem
, QCvisible
))
7695 /* If got a visible property and that evaluates to nil
7696 then ignore this item. */
7697 tem
= menu_item_eval_property (XCAR (item
));
7701 else if (EQ (tem
, QChelp
))
7702 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7703 else if (EQ (tem
, QCfilter
))
7705 else if (EQ (tem
, QCkey_sequence
))
7708 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7709 /* Be GC protected. Set keyhint to item instead of tem. */
7712 else if (EQ (tem
, QCkeys
))
7715 if (CONSP (tem
) || STRINGP (tem
))
7716 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7718 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7723 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7725 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7727 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7733 else if (inmenubar
|| !NILP (start
))
7737 return 0; /* not a menu item */
7739 /* If item string is not a string, evaluate it to get string.
7740 If we don't get a string, skip this item. */
7741 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7742 if (!(STRINGP (item_string
)))
7744 item_string
= menu_item_eval_property (item_string
);
7745 if (!STRINGP (item_string
))
7747 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7750 /* If got a filter apply it on definition. */
7751 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7754 def
= menu_item_eval_property (list2 (XCAR (filter
),
7755 list2 (Qquote
, def
)));
7757 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7760 /* Enable or disable selection of item. */
7761 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7764 tem
= menu_item_eval_property (tem
);
7765 if (inmenubar
&& NILP (tem
))
7766 return 0; /* Ignore disabled items in menu bar. */
7767 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7770 /* If we got no definition, this item is just unselectable text which
7771 is OK in a submenu but not in the menubar. */
7773 return (inmenubar
? 0 : 1);
7775 /* See if this is a separate pane or a submenu. */
7776 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7777 tem
= get_keymap (def
, 0, 1);
7778 /* For a subkeymap, just record its details and exit. */
7781 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7782 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7786 /* At the top level in the menu bar, do likewise for commands also.
7787 The menu bar does not display equivalent key bindings anyway.
7788 ITEM_PROPERTY_DEF is already set up properly. */
7792 { /* This is a command. See if there is an equivalent key binding. */
7793 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7795 /* The previous code preferred :key-sequence to :keys, so we
7796 preserve this behavior. */
7797 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7798 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7801 Lisp_Object prefix
= keyeq
;
7802 Lisp_Object keys
= Qnil
;
7806 def
= XCAR (prefix
);
7807 prefix
= XCDR (prefix
);
7810 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7812 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7814 keys
= XCAR (keyhint
);
7815 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7817 /* We have a suggested key. Is it bound to the command? */
7820 /* If the command is an alias for another
7821 (such as lmenu.el set it up), check if the
7822 original command matches the cached command. */
7823 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7828 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7832 tem
= Fkey_description (keys
, Qnil
);
7835 if (STRINGP (XCAR (prefix
)))
7836 tem
= concat2 (XCAR (prefix
), tem
);
7837 if (STRINGP (XCDR (prefix
)))
7838 tem
= concat2 (tem
, XCDR (prefix
));
7840 keyeq
= concat2 (build_string (" "), tem
);
7841 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7847 /* If we have an equivalent key binding, use that. */
7848 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7851 /* Include this when menu help is implemented.
7852 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7853 if (!(NILP (tem) || STRINGP (tem)))
7855 tem = menu_item_eval_property (tem);
7858 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7862 /* Handle radio buttons or toggle boxes. */
7863 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7865 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7866 menu_item_eval_property (tem
));
7873 /***********************************************************************
7875 ***********************************************************************/
7877 /* A vector holding tool bar items while they are parsed in function
7878 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7881 static Lisp_Object tool_bar_items_vector
;
7883 /* A vector holding the result of parse_tool_bar_item. Layout is like
7884 the one for a single item in tool_bar_items_vector. */
7886 static Lisp_Object tool_bar_item_properties
;
7888 /* Next free index in tool_bar_items_vector. */
7890 static int ntool_bar_items
;
7892 /* The symbols `:image' and `:rtl'. */
7894 Lisp_Object QCimage
;
7897 /* Function prototypes. */
7899 static void init_tool_bar_items (Lisp_Object
);
7900 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7901 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7902 static void append_tool_bar_item (void);
7905 /* Return a vector of tool bar items for keymaps currently in effect.
7906 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7907 tool bar items found. */
7910 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7919 /* In order to build the menus, we need to call the keymap
7920 accessors. They all call QUIT. But this function is called
7921 during redisplay, during which a quit is fatal. So inhibit
7922 quitting while building the menus. We do this instead of
7923 specbind because (1) errors will clear it anyway and (2) this
7924 avoids risk of specpdl overflow. */
7925 oquit
= Vinhibit_quit
;
7928 /* Initialize tool_bar_items_vector and protect it from GC. */
7929 init_tool_bar_items (reuse
);
7931 /* Build list of keymaps in maps. Set nmaps to the number of maps
7934 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7935 if (!NILP (Voverriding_local_map_menu_flag
))
7937 /* Yes, use them (if non-nil) as well as the global map. */
7938 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7940 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7941 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7942 if (!NILP (Voverriding_local_map
))
7943 maps
[nmaps
++] = Voverriding_local_map
;
7947 /* No, so use major and minor mode keymaps and keymap property.
7948 Note that tool-bar bindings in the local-map and keymap
7949 properties may not work reliable, as they are only
7950 recognized when the tool-bar (or mode-line) is updated,
7951 which does not normally happen after every command. */
7954 nminor
= current_minor_maps (NULL
, &tmaps
);
7955 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7957 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7958 maps
[nmaps
++] = tem
;
7959 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7961 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7964 /* Add global keymap at the end. */
7965 maps
[nmaps
++] = current_global_map
;
7967 /* Process maps in reverse order and look up in each map the prefix
7969 for (i
= nmaps
- 1; i
>= 0; --i
)
7970 if (!NILP (maps
[i
]))
7974 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7976 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7979 Vinhibit_quit
= oquit
;
7980 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7981 return tool_bar_items_vector
;
7985 /* Process the definition of KEY which is DEF. */
7988 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7991 struct gcpro gcpro1
, gcpro2
;
7993 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7997 if (EQ (def
, Qundefined
))
7999 /* If a map has an explicit `undefined' as definition,
8000 discard any previously made item. */
8001 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8003 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8005 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8007 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8008 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8009 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8010 * sizeof (Lisp_Object
)));
8011 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8016 else if (parse_tool_bar_item (key
, def
))
8017 /* Append a new tool bar item to tool_bar_items_vector. Accept
8018 more than one definition for the same key. */
8019 append_tool_bar_item ();
8025 /* Parse a tool bar item specification ITEM for key KEY and return the
8026 result in tool_bar_item_properties. Value is zero if ITEM is
8029 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8031 CAPTION is the caption of the item, If it's not a string, it is
8032 evaluated to get a string.
8034 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8035 as binding are currently ignored.
8037 The following properties are recognized:
8041 FORM is evaluated and specifies whether the tool bar item is
8042 enabled or disabled.
8046 FORM is evaluated and specifies whether the tool bar item is visible.
8048 - `:filter FUNCTION'
8050 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8051 result is stored as the new binding.
8053 - `:button (TYPE SELECTED)'
8055 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8056 and specifies whether the button is selected (pressed) or not.
8060 IMAGES is either a single image specification or a vector of four
8061 image specifications. See enum tool_bar_item_images.
8063 - `:help HELP-STRING'.
8065 Gives a help string to display for the tool bar item.
8067 - `:label LABEL-STRING'.
8069 A text label to show with the tool bar button if labels are enabled. */
8072 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8074 /* Access slot with index IDX of vector tool_bar_item_properties. */
8075 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8077 Lisp_Object filter
= Qnil
;
8078 Lisp_Object caption
;
8079 int i
, have_label
= 0;
8081 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8082 Rule out items that aren't lists, don't start with
8083 `menu-item' or whose rest following `tool-bar-item' is not a
8088 /* As an exception, allow old-style menu separators. */
8089 if (STRINGP (XCAR (item
)))
8090 item
= Fcons (XCAR (item
), Qnil
);
8091 else if (!EQ (XCAR (item
), Qmenu_item
)
8092 || (item
= XCDR (item
), !CONSP (item
)))
8095 /* Create tool_bar_item_properties vector if necessary. Reset it to
8097 if (VECTORP (tool_bar_item_properties
))
8099 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8103 tool_bar_item_properties
8104 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8107 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8108 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8110 /* Get the caption of the item. If the caption is not a string,
8111 evaluate it to get a string. If we don't get a string, skip this
8113 caption
= XCAR (item
);
8114 if (!STRINGP (caption
))
8116 caption
= menu_item_eval_property (caption
);
8117 if (!STRINGP (caption
))
8120 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8122 /* If the rest following the caption is not a list, the menu item is
8123 either a separator, or invalid. */
8127 if (menu_separator_name_p (SSDATA (caption
)))
8129 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8130 #if !defined (USE_GTK) && !defined (HAVE_NS)
8131 /* If we use build_desired_tool_bar_string to render the
8132 tool bar, the separator is rendered as an image. */
8133 PROP (TOOL_BAR_ITEM_IMAGES
)
8134 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8135 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8136 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8137 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8144 /* Store the binding. */
8145 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8148 /* Ignore cached key binding, if any. */
8149 if (CONSP (item
) && CONSP (XCAR (item
)))
8152 /* Process the rest of the properties. */
8153 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8155 Lisp_Object ikey
, value
;
8158 value
= XCAR (XCDR (item
));
8160 if (EQ (ikey
, QCenable
))
8162 /* `:enable FORM'. */
8163 if (!NILP (Venable_disabled_menus_and_buttons
))
8164 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8166 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8168 else if (EQ (ikey
, QCvisible
))
8170 /* `:visible FORM'. If got a visible property and that
8171 evaluates to nil then ignore this item. */
8172 if (NILP (menu_item_eval_property (value
)))
8175 else if (EQ (ikey
, QChelp
))
8176 /* `:help HELP-STRING'. */
8177 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8178 else if (EQ (ikey
, QCvert_only
))
8179 /* `:vert-only t/nil'. */
8180 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8181 else if (EQ (ikey
, QClabel
))
8183 const char *bad_label
= "!!?GARBLED ITEM?!!";
8184 /* `:label LABEL-STRING'. */
8185 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8187 : make_string (bad_label
, strlen (bad_label
));
8190 else if (EQ (ikey
, QCfilter
))
8191 /* ':filter FORM'. */
8193 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8195 /* `:button (TYPE . SELECTED)'. */
8196 Lisp_Object type
, selected
;
8198 type
= XCAR (value
);
8199 selected
= XCDR (value
);
8200 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8202 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8203 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8206 else if (EQ (ikey
, QCimage
)
8208 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8209 /* Value is either a single image specification or a vector
8210 of 4 such specifications for the different button states. */
8211 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8212 else if (EQ (ikey
, Qrtl
))
8214 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8220 /* Try to make one from caption and key. */
8221 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8222 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8223 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8224 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8225 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8226 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8227 Lisp_Object new_lbl
;
8228 size_t caption_len
= strlen (capt
);
8230 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8233 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8235 buf
[caption_len
] = '\0';
8239 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8243 strcpy (buf
, label
);
8245 for (j
= 0; buf
[j
] != '\0'; ++j
)
8253 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8254 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8255 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8257 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8261 /* If got a filter apply it on binding. */
8263 PROP (TOOL_BAR_ITEM_BINDING
)
8264 = menu_item_eval_property (list2 (filter
,
8266 PROP (TOOL_BAR_ITEM_BINDING
))));
8268 /* See if the binding is a keymap. Give up if it is. */
8269 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8272 /* Enable or disable selection of item. */
8273 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8274 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8275 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8277 /* Handle radio buttons or toggle boxes. */
8278 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8279 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8280 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8288 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8289 that can be reused. */
8292 init_tool_bar_items (Lisp_Object reuse
)
8294 if (VECTORP (reuse
))
8295 tool_bar_items_vector
= reuse
;
8297 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8298 ntool_bar_items
= 0;
8302 /* Append parsed tool bar item properties from
8303 tool_bar_item_properties */
8306 append_tool_bar_item (void)
8308 Lisp_Object
*to
, *from
;
8310 /* Enlarge tool_bar_items_vector if necessary. */
8311 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8312 >= XVECTOR (tool_bar_items_vector
)->size
)
8313 tool_bar_items_vector
8314 = larger_vector (tool_bar_items_vector
,
8315 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8317 /* Append entries from tool_bar_item_properties to the end of
8318 tool_bar_items_vector. */
8319 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8320 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8321 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8322 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8329 /* Read a character using menus based on maps in the array MAPS.
8330 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8331 Return t if we displayed a menu but the user rejected it.
8333 PREV_EVENT is the previous input event, or nil if we are reading
8334 the first event of a key sequence.
8336 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8337 if we used a mouse menu to read the input, or zero otherwise. If
8338 USED_MOUSE_MENU is null, we don't dereference it.
8340 The prompting is done based on the prompt-string of the map
8341 and the strings associated with various map elements.
8343 This can be done with X menus or with menus put in the minibuf.
8344 These are done in different ways, depending on how the input will be read.
8345 Menus using X are done after auto-saving in read-char, getting the input
8346 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8347 and do auto-saving in the inner call of read_char. */
8350 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8351 int *used_mouse_menu
)
8355 if (used_mouse_menu
)
8356 *used_mouse_menu
= 0;
8358 /* Use local over global Menu maps */
8360 if (! menu_prompting
)
8363 /* Optionally disregard all but the global map. */
8364 if (inhibit_local_menu_bar_menus
)
8366 maps
+= (nmaps
- 1);
8371 /* If we got to this point via a mouse click,
8372 use a real menu for mouse selection. */
8373 if (EVENT_HAS_PARAMETERS (prev_event
)
8374 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8375 && !EQ (XCAR (prev_event
), Qtool_bar
))
8377 /* Display the menu and get the selection. */
8378 Lisp_Object
*realmaps
8379 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8383 /* Use the maps that are not nil. */
8384 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8385 if (!NILP (maps
[mapno
]))
8386 realmaps
[nmaps1
++] = maps
[mapno
];
8388 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8393 record_menu_key (XCAR (value
));
8395 /* If we got multiple events, unread all but
8397 There is no way to prevent those unread events
8398 from showing up later in last_nonmenu_event.
8399 So turn symbol and integer events into lists,
8400 to indicate that they came from a mouse menu,
8401 so that when present in last_nonmenu_event
8402 they won't confuse things. */
8403 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8405 record_menu_key (XCAR (tem
));
8406 if (SYMBOLP (XCAR (tem
))
8407 || INTEGERP (XCAR (tem
)))
8408 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8411 /* If we got more than one event, put all but the first
8412 onto this list to be read later.
8413 Return just the first event now. */
8414 Vunread_command_events
8415 = nconc2 (XCDR (value
), Vunread_command_events
);
8416 value
= XCAR (value
);
8418 else if (NILP (value
))
8420 if (used_mouse_menu
)
8421 *used_mouse_menu
= 1;
8424 #endif /* HAVE_MENUS */
8428 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8429 We make this bigger when necessary, and never free it. */
8430 static char *read_char_minibuf_menu_text
;
8431 /* Size of that buffer. */
8432 static int read_char_minibuf_menu_width
;
8435 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8438 register Lisp_Object name
;
8440 /* FIXME: Use the minibuffer's frame width. */
8441 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8444 Lisp_Object rest
, vector
;
8450 if (! menu_prompting
)
8453 /* Get the menu name from the first map that has one (a prompt string). */
8454 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8456 name
= Fkeymap_prompt (maps
[mapno
]);
8461 /* If we don't have any menus, just read a character normally. */
8462 if (!STRINGP (name
))
8465 /* Make sure we have a big enough buffer for the menu text. */
8466 width
= max (width
, SBYTES (name
));
8467 if (read_char_minibuf_menu_text
== 0)
8469 read_char_minibuf_menu_width
= width
+ 4;
8470 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8472 else if (width
+ 4 > read_char_minibuf_menu_width
)
8474 read_char_minibuf_menu_width
= width
+ 4;
8475 read_char_minibuf_menu_text
8476 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8478 menu
= read_char_minibuf_menu_text
;
8480 /* Prompt string always starts with map's prompt, and a space. */
8481 strcpy (menu
, SSDATA (name
));
8482 nlength
= SBYTES (name
);
8483 menu
[nlength
++] = ':';
8484 menu
[nlength
++] = ' ';
8487 /* Start prompting at start of first map. */
8491 /* Present the documented bindings, a line at a time. */
8497 Lisp_Object orig_defn_macro
;
8499 /* Loop over elements of map. */
8504 /* If reached end of map, start at beginning of next map. */
8508 /* At end of last map, wrap around to first map if just starting,
8509 or end this line if already have something on it. */
8513 if (notfirst
|| nobindings
) break;
8518 /* Look at the next element of the map. */
8520 elt
= XVECTOR (vector
)->contents
[idx
];
8522 elt
= Fcar_safe (rest
);
8524 if (idx
< 0 && VECTORP (elt
))
8526 /* If we found a dense table in the keymap,
8527 advanced past it, but start scanning its contents. */
8528 rest
= Fcdr_safe (rest
);
8534 /* An ordinary element. */
8535 Lisp_Object event
, tem
;
8539 event
= Fcar_safe (elt
); /* alist */
8540 elt
= Fcdr_safe (elt
);
8544 XSETINT (event
, idx
); /* vector */
8547 /* Ignore the element if it has no prompt string. */
8548 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8550 /* 1 if the char to type matches the string. */
8552 Lisp_Object upcased_event
, downcased_event
;
8553 Lisp_Object desc
= Qnil
;
8555 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8557 upcased_event
= Fupcase (event
);
8558 downcased_event
= Fdowncase (event
);
8559 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8560 || XINT (downcased_event
) == SREF (s
, 0));
8562 desc
= Fsingle_key_description (event
, Qnil
);
8564 #if 0 /* It is redundant to list the equivalent key bindings because
8565 the prefix is what the user has already typed. */
8567 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8569 /* Insert equivalent keybinding. */
8570 s
= concat2 (s
, tem
);
8573 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8574 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8576 /* Insert button prefix. */
8577 Lisp_Object selected
8578 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8579 if (EQ (tem
, QCradio
))
8580 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8582 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8583 s
= concat2 (tem
, s
);
8587 /* If we have room for the prompt string, add it to this line.
8588 If this is the first on the line, always add it. */
8589 if ((SCHARS (s
) + i
+ 2
8590 + (char_matches
? 0 : SCHARS (desc
) + 3))
8596 /* Punctuate between strings. */
8599 strcpy (menu
+ i
, ", ");
8605 /* If the char to type doesn't match the string's
8606 first char, explicitly show what char to type. */
8609 /* Add as much of string as fits. */
8610 thiswidth
= SCHARS (desc
);
8611 if (thiswidth
+ i
> width
)
8612 thiswidth
= width
- i
;
8613 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8615 strcpy (menu
+ i
, " = ");
8619 /* Add as much of string as fits. */
8620 thiswidth
= SCHARS (s
);
8621 if (thiswidth
+ i
> width
)
8622 thiswidth
= width
- i
;
8623 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8629 /* If this element does not fit, end the line now,
8630 and save the element for the next line. */
8631 strcpy (menu
+ i
, "...");
8636 /* Move past this element. */
8637 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8638 /* Handle reaching end of dense table. */
8643 rest
= Fcdr_safe (rest
);
8647 /* Prompt with that and read response. */
8648 message2_nolog (menu
, strlen (menu
),
8649 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8651 /* Make believe its not a keyboard macro in case the help char
8652 is pressed. Help characters are not recorded because menu prompting
8653 is not used on replay.
8655 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8656 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8658 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8659 while (BUFFERP (obj
));
8660 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8662 if (!INTEGERP (obj
))
8664 else if (XINT (obj
) == -2)
8667 if (! EQ (obj
, menu_prompt_more_char
)
8668 && (!INTEGERP (menu_prompt_more_char
)
8669 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8671 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8672 store_kbd_macro_char (obj
);
8675 /* Help char - go round again */
8679 /* Reading key sequences. */
8681 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8682 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8683 keymap, or nil otherwise. Return the index of the first keymap in
8684 which KEY has any binding, or NMAPS if no map has a binding.
8686 If KEY is a meta ASCII character, treat it like meta-prefix-char
8687 followed by the corresponding non-meta character. Keymaps in
8688 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8691 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8694 NEXT may be the same array as CURRENT. */
8697 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8700 int i
, first_binding
;
8702 first_binding
= nmaps
;
8703 for (i
= nmaps
- 1; i
>= 0; i
--)
8705 if (! NILP (current
[i
]))
8707 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8708 if (! NILP (defs
[i
]))
8715 /* Given the set of bindings we've found, produce the next set of maps. */
8716 if (first_binding
< nmaps
)
8717 for (i
= 0; i
< nmaps
; i
++)
8718 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8720 return first_binding
;
8723 /* Structure used to keep track of partial application of key remapping
8724 such as Vfunction_key_map and Vkey_translation_map. */
8725 typedef struct keyremap
8727 /* This is the map originally specified for this use. */
8729 /* This is a submap reached by looking up, in PARENT,
8730 the events from START to END. */
8732 /* Positions [START, END) in the key sequence buffer
8733 are the key that we have scanned so far.
8734 Those events are the ones that we will replace
8735 if PAREHT maps them into a key sequence. */
8739 /* Lookup KEY in MAP.
8740 MAP is a keymap mapping keys to key vectors or functions.
8741 If the mapping is a function and DO_FUNCTION is non-zero, then
8742 the function is called with PROMPT as parameter and its return
8743 value is used as the return value of this function (after checking
8744 that it is indeed a vector). */
8747 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8752 next
= access_keymap (map
, key
, 1, 0, 1);
8754 /* Handle symbol with autoload definition. */
8755 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8756 && CONSP (XSYMBOL (next
)->function
)
8757 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8758 do_autoload (XSYMBOL (next
)->function
, next
);
8760 /* Handle a symbol whose function definition is a keymap
8762 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8763 && (ARRAYP (XSYMBOL (next
)->function
)
8764 || KEYMAPP (XSYMBOL (next
)->function
)))
8765 next
= XSYMBOL (next
)->function
;
8767 /* If the keymap gives a function, not an
8768 array, then call the function with one arg and use
8769 its value instead. */
8770 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8775 next
= call1 (next
, prompt
);
8776 /* If the function returned something invalid,
8777 barf--don't ignore it.
8778 (To ignore it safely, we would need to gcpro a bunch of
8779 other variables.) */
8780 if (! (VECTORP (next
) || STRINGP (next
)))
8781 error ("Function %s returns invalid key sequence", tem
);
8786 /* Do one step of the key remapping used for function-key-map and
8787 key-translation-map:
8788 KEYBUF is the buffer holding the input events.
8789 BUFSIZE is its maximum size.
8790 FKEY is a pointer to the keyremap structure to use.
8791 INPUT is the index of the last element in KEYBUF.
8792 DOIT if non-zero says that the remapping can actually take place.
8793 DIFF is used to return the number of keys added/removed by the remapping.
8794 PARENT is the root of the keymap.
8795 PROMPT is the prompt to use if the remapping happens through a function.
8796 The return value is non-zero if the remapping actually took place. */
8799 keyremap_step (Lisp_Object
*keybuf
, size_t bufsize
, volatile keyremap
*fkey
,
8800 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8802 Lisp_Object next
, key
;
8804 key
= keybuf
[fkey
->end
++];
8806 if (KEYMAPP (fkey
->parent
))
8807 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8811 /* If keybuf[fkey->start..fkey->end] is bound in the
8812 map and we're in a position to do the key remapping, replace it with
8813 the binding and restart with fkey->start at the end. */
8814 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8816 int len
= XFASTINT (Flength (next
));
8819 *diff
= len
- (fkey
->end
- fkey
->start
);
8821 if (input
+ *diff
>= bufsize
)
8822 error ("Key sequence too long");
8824 /* Shift the keys that follow fkey->end. */
8826 for (i
= fkey
->end
; i
< input
; i
++)
8827 keybuf
[i
+ *diff
] = keybuf
[i
];
8829 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8830 keybuf
[i
+ *diff
] = keybuf
[i
];
8831 /* Overwrite the old keys with the new ones. */
8832 for (i
= 0; i
< len
; i
++)
8833 keybuf
[fkey
->start
+ i
]
8834 = Faref (next
, make_number (i
));
8836 fkey
->start
= fkey
->end
+= *diff
;
8837 fkey
->map
= fkey
->parent
;
8842 fkey
->map
= get_keymap (next
, 0, 1);
8844 /* If we no longer have a bound suffix, try a new position for
8846 if (!CONSP (fkey
->map
))
8848 fkey
->end
= ++fkey
->start
;
8849 fkey
->map
= fkey
->parent
;
8854 /* Read a sequence of keys that ends with a non prefix character,
8855 storing it in KEYBUF, a buffer of size BUFSIZE.
8857 Return the length of the key sequence stored.
8858 Return -1 if the user rejected a command menu.
8860 Echo starting immediately unless `prompt' is 0.
8862 Where a key sequence ends depends on the currently active keymaps.
8863 These include any minor mode keymaps active in the current buffer,
8864 the current buffer's local map, and the global map.
8866 If a key sequence has no other bindings, we check Vfunction_key_map
8867 to see if some trailing subsequence might be the beginning of a
8868 function key's sequence. If so, we try to read the whole function
8869 key, and substitute its symbolic name into the key sequence.
8871 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8872 `double-' events into similar click events, if that would make them
8873 bound. We try to turn `triple-' events first into `double-' events,
8876 If we get a mouse click in a mode line, vertical divider, or other
8877 non-text area, we treat the click as if it were prefixed by the
8878 symbol denoting that area - `mode-line', `vertical-line', or
8881 If the sequence starts with a mouse click, we read the key sequence
8882 with respect to the buffer clicked on, not the current buffer.
8884 If the user switches frames in the midst of a key sequence, we put
8885 off the switch-frame event until later; the next call to
8886 read_char will return it.
8888 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8889 from the selected window's buffer. */
8892 read_key_sequence (Lisp_Object
*keybuf
, size_t bufsize
, Lisp_Object prompt
,
8893 int dont_downcase_last
, int can_return_switch_frame
,
8894 int fix_current_buffer
)
8896 Lisp_Object from_string
;
8897 int count
= SPECPDL_INDEX ();
8899 /* How many keys there are in the current key sequence. */
8902 /* The length of the echo buffer when we started reading, and
8903 the length of this_command_keys when we started reading. */
8904 int echo_start
IF_LINT (= 0);
8907 /* The number of keymaps we're scanning right now, and the number of
8908 keymaps we have allocated space for. */
8910 int nmaps_allocated
= 0;
8912 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8913 the current keymaps. */
8914 Lisp_Object
*defs
= NULL
;
8916 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8917 in the current keymaps, or nil where it is not a prefix. */
8918 Lisp_Object
*submaps
= NULL
;
8920 /* The local map to start out with at start of key sequence. */
8921 Lisp_Object orig_local_map
;
8923 /* The map from the `keymap' property to start out with at start of
8925 Lisp_Object orig_keymap
;
8927 /* 1 if we have already considered switching to the local-map property
8928 of the place where a mouse click occurred. */
8929 int localized_local_map
= 0;
8931 /* The index in submaps[] of the first keymap that has a binding for
8932 this key sequence. In other words, the lowest i such that
8933 submaps[i] is non-nil. */
8935 /* Index of the first key that has no binding.
8936 It is useless to try fkey.start larger than that. */
8939 /* If t < mock_input, then KEYBUF[t] should be read as the next
8942 We use this to recover after recognizing a function key. Once we
8943 realize that a suffix of the current key sequence is actually a
8944 function key's escape sequence, we replace the suffix with the
8945 function key's binding from Vfunction_key_map. Now keybuf
8946 contains a new and different key sequence, so the echo area,
8947 this_command_keys, and the submaps and defs arrays are wrong. In
8948 this situation, we set mock_input to t, set t to 0, and jump to
8949 restart_sequence; the loop will read keys from keybuf up until
8950 mock_input, thus rebuilding the state; and then it will resume
8951 reading characters from the keyboard. */
8954 /* If the sequence is unbound in submaps[], then
8955 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8956 and fkey.map is its binding.
8958 These might be > t, indicating that all function key scanning
8959 should hold off until t reaches them. We do this when we've just
8960 recognized a function key, to avoid searching for the function
8961 key's again in Vfunction_key_map. */
8964 /* Likewise, for key_translation_map and input-decode-map. */
8965 keyremap keytran
, indec
;
8967 /* Non-zero if we are trying to map a key by changing an upper-case
8968 letter to lower case, or a shifted function key to an unshifted
8970 int shift_translated
= 0;
8972 /* If we receive a `switch-frame' or `select-window' event in the middle of
8973 a key sequence, we put it off for later.
8974 While we're reading, we keep the event here. */
8975 Lisp_Object delayed_switch_frame
;
8977 /* See the comment below... */
8978 #if defined (GOBBLE_FIRST_EVENT)
8979 Lisp_Object first_event
;
8982 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8983 int original_uppercase_position
= -1;
8985 /* Gets around Microsoft compiler limitations. */
8988 struct buffer
*starting_buffer
;
8990 /* List of events for which a fake prefix key has been generated. */
8991 Lisp_Object fake_prefixed_keys
= Qnil
;
8993 #if defined (GOBBLE_FIRST_EVENT)
8997 struct gcpro outer_gcpro1
;
8999 GCPRO1_VAR (fake_prefixed_keys
, outer_gcpro
);
9000 raw_keybuf_count
= 0;
9002 last_nonmenu_event
= Qnil
;
9004 delayed_switch_frame
= Qnil
;
9010 /* Install the string STR as the beginning of the string of
9011 echoing, so that it serves as a prompt for the next
9013 KVAR (current_kboard
, echo_string
) = prompt
;
9014 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9017 else if (cursor_in_echo_area
9018 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9019 && NILP (Fzerop (Vecho_keystrokes
)))
9020 /* This doesn't put in a dash if the echo buffer is empty, so
9021 you don't always see a dash hanging out in the minibuffer. */
9025 /* Record the initial state of the echo area and this_command_keys;
9026 we will need to restore them if we replay a key sequence. */
9028 echo_start
= echo_length ();
9029 keys_start
= this_command_key_count
;
9030 this_single_command_key_start
= keys_start
;
9032 #if defined (GOBBLE_FIRST_EVENT)
9033 /* This doesn't quite work, because some of the things that read_char
9034 does cannot safely be bypassed. It seems too risky to try to make
9037 /* Read the first char of the sequence specially, before setting
9038 up any keymaps, in case a filter runs and switches buffers on us. */
9039 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9041 #endif /* GOBBLE_FIRST_EVENT */
9043 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9044 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9047 /* We jump here when we need to reinitialize fkey and keytran; this
9048 happens if we switch keyboards between rescans. */
9049 replay_entire_sequence
:
9051 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9052 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9053 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9054 indec
.start
= indec
.end
= 0;
9055 fkey
.start
= fkey
.end
= 0;
9056 keytran
.start
= keytran
.end
= 0;
9058 /* We jump here when the key sequence has been thoroughly changed, and
9059 we need to rescan it starting from the beginning. When we jump here,
9060 keybuf[0..mock_input] holds the sequence we should reread. */
9063 starting_buffer
= current_buffer
;
9064 first_unbound
= bufsize
+ 1;
9066 /* Build our list of keymaps.
9067 If we recognize a function key and replace its escape sequence in
9068 keybuf with its symbol, or if the sequence starts with a mouse
9069 click and we need to switch buffers, we jump back here to rebuild
9070 the initial keymaps from the current buffer. */
9073 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9075 if (2 > nmaps_allocated
)
9077 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9078 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9079 nmaps_allocated
= 2;
9081 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9083 else if (!NILP (Voverriding_local_map
))
9085 if (2 > nmaps_allocated
)
9087 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9088 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9089 nmaps_allocated
= 2;
9091 submaps
[nmaps
++] = Voverriding_local_map
;
9099 nminor
= current_minor_maps (0, &maps
);
9100 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9102 if (total
> nmaps_allocated
)
9104 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9105 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9106 nmaps_allocated
= total
;
9109 if (!NILP (orig_keymap
))
9110 submaps
[nmaps
++] = orig_keymap
;
9112 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9116 submaps
[nmaps
++] = orig_local_map
;
9118 submaps
[nmaps
++] = current_global_map
;
9120 /* Find an accurate initial value for first_binding. */
9121 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9122 if (! NILP (submaps
[first_binding
]))
9125 /* Start from the beginning in keybuf. */
9128 /* These are no-ops the first time through, but if we restart, they
9129 revert the echo area and this_command_keys to their original state. */
9130 this_command_key_count
= keys_start
;
9131 if (INTERACTIVE
&& t
< mock_input
)
9132 echo_truncate (echo_start
);
9134 /* If the best binding for the current key sequence is a keymap, or
9135 we may be looking at a function key's escape sequence, keep on
9137 while (first_binding
< nmaps
9138 /* Keep reading as long as there's a prefix binding. */
9139 ? !NILP (submaps
[first_binding
])
9140 /* Don't return in the middle of a possible function key sequence,
9141 if the only bindings we found were via case conversion.
9142 Thus, if ESC O a has a function-key-map translation
9143 and ESC o has a binding, don't return after ESC O,
9144 so that we can translate ESC O plus the next character. */
9145 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9148 int used_mouse_menu
= 0;
9150 /* Where the last real key started. If we need to throw away a
9151 key that has expanded into more than one element of keybuf
9152 (say, a mouse click on the mode line which is being treated
9153 as [mode-line (mouse-...)], then we backtrack to this point
9155 int last_real_key_start
;
9157 /* These variables are analogous to echo_start and keys_start;
9158 while those allow us to restart the entire key sequence,
9159 echo_local_start and keys_local_start allow us to throw away
9161 int echo_local_start
IF_LINT (= 0);
9162 int keys_local_start
, local_first_binding
;
9164 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9165 eassert (indec
.start
<= indec
.end
);
9166 eassert (fkey
.start
<= fkey
.end
);
9167 eassert (keytran
.start
<= keytran
.end
);
9168 /* key-translation-map is applied *after* function-key-map
9169 which is itself applied *after* input-decode-map. */
9170 eassert (fkey
.end
<= indec
.start
);
9171 eassert (keytran
.end
<= fkey
.start
);
9173 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9174 first_unbound
< keytran
.start
)
9175 { /* The prefix upto first_unbound has no binding and has
9176 no translation left to do either, so we know it's unbound.
9177 If we don't stop now, we risk staying here indefinitely
9178 (if the user keeps entering fkey or keytran prefixes
9179 like C-c ESC ESC ESC ESC ...) */
9181 for (i
= first_unbound
+ 1; i
< t
; i
++)
9182 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9183 mock_input
= t
- first_unbound
- 1;
9184 indec
.end
= indec
.start
-= first_unbound
+ 1;
9185 indec
.map
= indec
.parent
;
9186 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9187 fkey
.map
= fkey
.parent
;
9188 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9189 keytran
.map
= keytran
.parent
;
9190 goto replay_sequence
;
9194 error ("Key sequence too long");
9197 echo_local_start
= echo_length ();
9198 keys_local_start
= this_command_key_count
;
9199 local_first_binding
= first_binding
;
9202 /* These are no-ops, unless we throw away a keystroke below and
9203 jumped back up to replay_key; in that case, these restore the
9204 variables to their original state, allowing us to replay the
9206 if (INTERACTIVE
&& t
< mock_input
)
9207 echo_truncate (echo_local_start
);
9208 this_command_key_count
= keys_local_start
;
9209 first_binding
= local_first_binding
;
9211 /* By default, assume each event is "real". */
9212 last_real_key_start
= t
;
9214 /* Does mock_input indicate that we are re-reading a key sequence? */
9218 add_command_key (key
);
9219 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9220 && NILP (Fzerop (Vecho_keystrokes
)))
9224 /* If not, we should actually read a character. */
9228 KBOARD
*interrupted_kboard
= current_kboard
;
9229 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9230 key
= read_char (NILP (prompt
), nmaps
,
9231 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9232 &used_mouse_menu
, NULL
);
9233 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9234 /* When switching to a new tty (with a new keyboard),
9235 read_char returns the new buffer, rather than -2
9236 (Bug#5095). This is because `terminal-init-xterm'
9237 calls read-char, which eats the wrong_kboard_jmpbuf
9238 return. Any better way to fix this? -- cyd */
9239 || (interrupted_kboard
!= current_kboard
))
9244 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9245 if (k
== interrupted_kboard
)
9250 /* Don't touch interrupted_kboard when it's been
9252 delayed_switch_frame
= Qnil
;
9253 goto replay_entire_sequence
;
9256 if (!NILP (delayed_switch_frame
))
9258 KVAR (interrupted_kboard
, kbd_queue
)
9259 = Fcons (delayed_switch_frame
,
9260 KVAR (interrupted_kboard
, kbd_queue
));
9261 delayed_switch_frame
= Qnil
;
9265 KVAR (interrupted_kboard
, kbd_queue
)
9266 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9268 /* If the side queue is non-empty, ensure it begins with a
9269 switch-frame, so we'll replay it in the right context. */
9270 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9271 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9272 !(EVENT_HAS_PARAMETERS (key
)
9273 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9277 XSETFRAME (frame
, interrupted_frame
);
9278 KVAR (interrupted_kboard
, kbd_queue
)
9279 = Fcons (make_lispy_switch_frame (frame
),
9280 KVAR (interrupted_kboard
, kbd_queue
));
9283 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9284 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9285 goto replay_entire_sequence
;
9289 /* read_char returns t when it shows a menu and the user rejects it.
9293 unbind_to (count
, Qnil
);
9294 UNGCPRO_VAR (outer_gcpro
);
9298 /* read_char returns -1 at the end of a macro.
9299 Emacs 18 handles this by returning immediately with a
9300 zero, so that's what we'll do. */
9301 if (INTEGERP (key
) && XINT (key
) == -1)
9304 /* The Microsoft C compiler can't handle the goto that
9310 /* If the current buffer has been changed from under us, the
9311 keymap may have changed, so replay the sequence. */
9314 timer_resume_idle ();
9317 /* Reset the current buffer from the selected window
9318 in case something changed the former and not the latter.
9319 This is to be more consistent with the behavior
9320 of the command_loop_1. */
9321 if (fix_current_buffer
)
9323 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9325 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9326 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9329 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9330 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9331 goto replay_sequence
;
9334 /* If we have a quit that was typed in another frame, and
9335 quit_throw_to_read_char switched buffers,
9336 replay to get the right keymap. */
9338 && XINT (key
) == quit_char
9339 && current_buffer
!= starting_buffer
)
9342 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9346 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9347 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9348 goto replay_sequence
;
9353 if (EVENT_HAS_PARAMETERS (key
)
9354 /* Either a `switch-frame' or a `select-window' event. */
9355 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9357 /* If we're at the beginning of a key sequence, and the caller
9358 says it's okay, go ahead and return this event. If we're
9359 in the midst of a key sequence, delay it until the end. */
9360 if (t
> 0 || !can_return_switch_frame
)
9362 delayed_switch_frame
= key
;
9368 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9372 /* Clicks in non-text areas get prefixed by the symbol
9373 in their CHAR-ADDRESS field. For example, a click on
9374 the mode line is prefixed by the symbol `mode-line'.
9376 Furthermore, key sequences beginning with mouse clicks
9377 are read using the keymaps of the buffer clicked on, not
9378 the current buffer. So we may have to switch the buffer
9381 When we turn one event into two events, we must make sure
9382 that neither of the two looks like the original--so that,
9383 if we replay the events, they won't be expanded again.
9384 If not for this, such reexpansion could happen either here
9385 or when user programs play with this-command-keys. */
9386 if (EVENT_HAS_PARAMETERS (key
))
9391 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9392 if (EQ (kind
, Qmouse_click
))
9394 Lisp_Object window
, posn
;
9396 window
= POSN_WINDOW (EVENT_START (key
));
9397 posn
= POSN_POSN (EVENT_START (key
));
9400 || (!NILP (fake_prefixed_keys
)
9401 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9403 /* We're looking a second time at an event for which
9404 we generated a fake prefix key. Set
9405 last_real_key_start appropriately. */
9407 last_real_key_start
= t
- 1;
9410 if (last_real_key_start
== 0)
9412 /* Key sequences beginning with mouse clicks are
9413 read using the keymaps in the buffer clicked on,
9414 not the current buffer. If we're at the
9415 beginning of a key sequence, switch buffers. */
9416 if (WINDOWP (window
)
9417 && BUFFERP (XWINDOW (window
)->buffer
)
9418 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9420 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9424 /* Arrange to go back to the original buffer once we're
9425 done reading the key sequence. Note that we can't
9426 use save_excursion_{save,restore} here, because they
9427 save point as well as the current buffer; we don't
9428 want to save point, because redisplay may change it,
9429 to accommodate a Fset_window_start or something. We
9430 don't want to do this at the top of the function,
9431 because we may get input from a subprocess which
9432 wants to change the selected window and stuff (say,
9434 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9436 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9438 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9439 orig_local_map
= get_local_map (PT
, current_buffer
,
9441 orig_keymap
= get_local_map (PT
, current_buffer
,
9443 goto replay_sequence
;
9446 /* For a mouse click, get the local text-property keymap
9447 of the place clicked on, rather than point. */
9448 if (CONSP (XCDR (key
))
9449 && ! localized_local_map
)
9451 Lisp_Object map_here
, start
, pos
;
9453 localized_local_map
= 1;
9454 start
= EVENT_START (key
);
9456 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9458 pos
= POSN_BUFFER_POSN (start
);
9460 && XINT (pos
) >= BEGV
9461 && XINT (pos
) <= ZV
)
9463 map_here
= get_local_map (XINT (pos
),
9466 if (!EQ (map_here
, orig_local_map
))
9468 orig_local_map
= map_here
;
9469 ++localized_local_map
;
9472 map_here
= get_local_map (XINT (pos
),
9475 if (!EQ (map_here
, orig_keymap
))
9477 orig_keymap
= map_here
;
9478 ++localized_local_map
;
9481 if (localized_local_map
> 1)
9486 goto replay_sequence
;
9493 /* Expand mode-line and scroll-bar events into two events:
9494 use posn as a fake prefix key. */
9496 && (NILP (fake_prefixed_keys
)
9497 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9499 if (t
+ 1 >= bufsize
)
9500 error ("Key sequence too long");
9503 keybuf
[t
+ 1] = key
;
9506 /* Record that a fake prefix key has been generated
9507 for KEY. Don't modify the event; this would
9508 prevent proper action when the event is pushed
9509 back into unread-command-events. */
9510 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9512 /* If on a mode line string with a local keymap,
9513 reconsider the key sequence with that keymap. */
9514 if (string
= POSN_STRING (EVENT_START (key
)),
9515 (CONSP (string
) && STRINGP (XCAR (string
))))
9517 Lisp_Object pos
, map
, map2
;
9519 pos
= XCDR (string
);
9520 string
= XCAR (string
);
9522 && XINT (pos
) < SCHARS (string
))
9524 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9526 orig_local_map
= map
;
9527 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9530 if (!NILP (map
) || !NILP (map2
))
9531 goto replay_sequence
;
9537 else if (NILP (from_string
)
9538 && (string
= POSN_STRING (EVENT_START (key
)),
9539 (CONSP (string
) && STRINGP (XCAR (string
)))))
9541 /* For a click on a string, i.e. overlay string or a
9542 string displayed via the `display' property,
9543 consider `local-map' and `keymap' properties of
9545 Lisp_Object pos
, map
, map2
;
9547 pos
= XCDR (string
);
9548 string
= XCAR (string
);
9550 && XINT (pos
) < SCHARS (string
))
9552 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9554 orig_local_map
= map
;
9555 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9559 if (!NILP (map
) || !NILP (map2
))
9561 from_string
= string
;
9564 goto replay_sequence
;
9569 else if (CONSP (XCDR (key
))
9570 && CONSP (EVENT_START (key
))
9571 && CONSP (XCDR (EVENT_START (key
))))
9575 posn
= POSN_POSN (EVENT_START (key
));
9576 /* Handle menu-bar events:
9577 insert the dummy prefix event `menu-bar'. */
9578 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9580 if (t
+ 1 >= bufsize
)
9581 error ("Key sequence too long");
9585 /* Zap the position in key, so we know that we've
9586 expanded it, and don't try to do so again. */
9587 POSN_SET_POSN (EVENT_START (key
),
9588 Fcons (posn
, Qnil
));
9591 goto replay_sequence
;
9593 else if (CONSP (posn
))
9595 /* We're looking at the second event of a
9596 sequence which we expanded before. Set
9597 last_real_key_start appropriately. */
9598 if (last_real_key_start
== t
&& t
> 0)
9599 last_real_key_start
= t
- 1;
9604 /* We have finally decided that KEY is something we might want
9606 first_binding
= (follow_key (key
,
9607 nmaps
- first_binding
,
9608 submaps
+ first_binding
,
9609 defs
+ first_binding
,
9610 submaps
+ first_binding
)
9613 /* If KEY wasn't bound, we'll try some fallbacks. */
9614 if (first_binding
< nmaps
)
9615 /* This is needed for the following scenario:
9616 event 0: a down-event that gets dropped by calling replay_key.
9617 event 1: some normal prefix like C-h.
9618 After event 0, first_unbound is 0, after event 1 indec.start,
9619 fkey.start, and keytran.start are all 1, so when we see that
9620 C-h is bound, we need to update first_unbound. */
9621 first_unbound
= max (t
+ 1, first_unbound
);
9626 /* Remember the position to put an upper bound on indec.start. */
9627 first_unbound
= min (t
, first_unbound
);
9629 head
= EVENT_HEAD (key
);
9630 if (help_char_p (head
) && t
> 0)
9632 read_key_sequence_cmd
= Vprefix_help_command
;
9634 last_nonmenu_event
= key
;
9635 /* The Microsoft C compiler can't handle the goto that
9643 Lisp_Object breakdown
;
9646 breakdown
= parse_modifiers (head
);
9647 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9648 /* Attempt to reduce an unbound mouse event to a simpler
9649 event that is bound:
9650 Drags reduce to clicks.
9651 Double-clicks reduce to clicks.
9652 Triple-clicks reduce to double-clicks, then to clicks.
9653 Down-clicks are eliminated.
9654 Double-downs reduce to downs, then are eliminated.
9655 Triple-downs reduce to double-downs, then to downs,
9656 then are eliminated. */
9657 if (modifiers
& (down_modifier
| drag_modifier
9658 | double_modifier
| triple_modifier
))
9660 while (modifiers
& (down_modifier
| drag_modifier
9661 | double_modifier
| triple_modifier
))
9663 Lisp_Object new_head
, new_click
;
9664 if (modifiers
& triple_modifier
)
9665 modifiers
^= (double_modifier
| triple_modifier
);
9666 else if (modifiers
& double_modifier
)
9667 modifiers
&= ~double_modifier
;
9668 else if (modifiers
& drag_modifier
)
9669 modifiers
&= ~drag_modifier
;
9672 /* Dispose of this `down' event by simply jumping
9673 back to replay_key, to get another event.
9675 Note that if this event came from mock input,
9676 then just jumping back to replay_key will just
9677 hand it to us again. So we have to wipe out any
9680 We could delete keybuf[t] and shift everything
9681 after that to the left by one spot, but we'd also
9682 have to fix up any variable that points into
9683 keybuf, and shifting isn't really necessary
9686 Adding prefixes for non-textual mouse clicks
9687 creates two characters of mock input, and both
9688 must be thrown away. If we're only looking at
9689 the prefix now, we can just jump back to
9690 replay_key. On the other hand, if we've already
9691 processed the prefix, and now the actual click
9692 itself is giving us trouble, then we've lost the
9693 state of the keymaps we want to backtrack to, and
9694 we need to replay the whole sequence to rebuild
9697 Beyond that, only function key expansion could
9698 create more than two keys, but that should never
9699 generate mouse events, so it's okay to zero
9700 mock_input in that case too.
9702 FIXME: The above paragraph seems just plain
9703 wrong, if you consider things like
9704 xterm-mouse-mode. -stef
9706 Isn't this just the most wonderful code ever? */
9708 /* If mock_input > t + 1, the above simplification
9709 will actually end up dropping keys on the floor.
9710 This is probably OK for now, but even
9711 if mock_input <= t + 1, we need to adjust indec,
9713 Typical case [header-line down-mouse-N]:
9714 mock_input = 2, t = 1, fkey.end = 1,
9715 last_real_key_start = 0. */
9716 if (indec
.end
> last_real_key_start
)
9718 indec
.end
= indec
.start
9719 = min (last_real_key_start
, indec
.start
);
9720 indec
.map
= indec
.parent
;
9721 if (fkey
.end
> last_real_key_start
)
9723 fkey
.end
= fkey
.start
9724 = min (last_real_key_start
, fkey
.start
);
9725 fkey
.map
= fkey
.parent
;
9726 if (keytran
.end
> last_real_key_start
)
9728 keytran
.end
= keytran
.start
9729 = min (last_real_key_start
, keytran
.start
);
9730 keytran
.map
= keytran
.parent
;
9734 if (t
== last_real_key_start
)
9741 mock_input
= last_real_key_start
;
9742 goto replay_sequence
;
9747 = apply_modifiers (modifiers
, XCAR (breakdown
));
9749 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9751 /* Look for a binding for this new key. follow_key
9752 promises that it didn't munge submaps the
9753 last time we called it, since key was unbound. */
9755 = (follow_key (new_click
,
9756 nmaps
- local_first_binding
,
9757 submaps
+ local_first_binding
,
9758 defs
+ local_first_binding
,
9759 submaps
+ local_first_binding
)
9760 + local_first_binding
);
9762 /* If that click is bound, go for it. */
9763 if (first_binding
< nmaps
)
9768 /* Otherwise, we'll leave key set to the drag event. */
9775 /* Normally, last_nonmenu_event gets the previous key we read.
9776 But when a mouse popup menu is being used,
9777 we don't update last_nonmenu_event; it continues to hold the mouse
9778 event that preceded the first level of menu. */
9779 if (!used_mouse_menu
)
9780 last_nonmenu_event
= key
;
9782 /* Record what part of this_command_keys is the current key sequence. */
9783 this_single_command_key_start
= this_command_key_count
- t
;
9785 /* Look for this sequence in input-decode-map.
9786 Scan from indec.end until we find a bound suffix. */
9787 while (indec
.end
< t
)
9789 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9792 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9793 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9798 mock_input
= diff
+ max (t
, mock_input
);
9799 goto replay_sequence
;
9803 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9804 && indec
.start
>= t
)
9805 /* There is a binding and it's not a prefix.
9806 (and it doesn't have any input-decode-map translation pending).
9807 There is thus no function-key in this sequence.
9808 Moving fkey.start is important in this case to allow keytran.start
9809 to go over the sequence before we return (since we keep the
9810 invariant that keytran.end <= fkey.start). */
9813 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9816 /* If the sequence is unbound, see if we can hang a function key
9817 off the end of it. */
9818 /* Continue scan from fkey.end until we find a bound suffix. */
9819 while (fkey
.end
< indec
.start
)
9821 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9824 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9825 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9826 max (t
, mock_input
),
9827 /* If there's a binding (i.e.
9828 first_binding >= nmaps) we don't want
9829 to apply this function-key-mapping. */
9830 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9835 mock_input
= diff
+ max (t
, mock_input
);
9836 /* Adjust the input-decode-map counters. */
9838 indec
.start
+= diff
;
9840 goto replay_sequence
;
9844 /* Look for this sequence in key-translation-map.
9845 Scan from keytran.end until we find a bound suffix. */
9846 while (keytran
.end
< fkey
.start
)
9848 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9851 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9852 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9857 mock_input
= diff
+ max (t
, mock_input
);
9858 /* Adjust the function-key-map and input-decode-map counters. */
9860 indec
.start
+= diff
;
9864 goto replay_sequence
;
9868 /* If KEY is not defined in any of the keymaps,
9869 and cannot be part of a function key or translation,
9870 and is an upper case letter
9871 use the corresponding lower-case letter instead. */
9872 if (first_binding
>= nmaps
9873 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9875 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9876 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9877 || (XINT (key
) & shift_modifier
)))
9879 Lisp_Object new_key
;
9881 original_uppercase
= key
;
9882 original_uppercase_position
= t
- 1;
9884 if (XINT (key
) & shift_modifier
)
9885 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9887 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9888 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9890 /* We have to do this unconditionally, regardless of whether
9891 the lower-case char is defined in the keymaps, because they
9892 might get translated through function-key-map. */
9893 keybuf
[t
- 1] = new_key
;
9894 mock_input
= max (t
, mock_input
);
9895 shift_translated
= 1;
9897 goto replay_sequence
;
9899 /* If KEY is not defined in any of the keymaps,
9900 and cannot be part of a function key or translation,
9901 and is a shifted function key,
9902 use the corresponding unshifted function key instead. */
9903 if (first_binding
>= nmaps
9904 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9906 Lisp_Object breakdown
= parse_modifiers (key
);
9908 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9910 if (modifiers
& shift_modifier
9911 /* Treat uppercase keys as shifted. */
9913 && (KEY_TO_CHAR (key
)
9914 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->size
)
9915 && uppercasep (KEY_TO_CHAR (key
))))
9918 = (modifiers
& shift_modifier
9919 ? apply_modifiers (modifiers
& ~shift_modifier
,
9921 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9923 original_uppercase
= key
;
9924 original_uppercase_position
= t
- 1;
9926 /* We have to do this unconditionally, regardless of whether
9927 the lower-case char is defined in the keymaps, because they
9928 might get translated through function-key-map. */
9929 keybuf
[t
- 1] = new_key
;
9930 mock_input
= max (t
, mock_input
);
9931 /* Reset fkey (and consequently keytran) to apply
9932 function-key-map on the result, so that S-backspace is
9933 correctly mapped to DEL (via backspace). OTOH,
9934 input-decode-map doesn't need to go through it again. */
9935 fkey
.start
= fkey
.end
= 0;
9936 keytran
.start
= keytran
.end
= 0;
9937 shift_translated
= 1;
9939 goto replay_sequence
;
9944 read_key_sequence_cmd
= (first_binding
< nmaps
9945 ? defs
[first_binding
]
9948 unread_switch_frame
= delayed_switch_frame
;
9949 unbind_to (count
, Qnil
);
9951 /* Don't downcase the last character if the caller says don't.
9952 Don't downcase it if the result is undefined, either. */
9953 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9955 && t
- 1 == original_uppercase_position
)
9957 keybuf
[t
- 1] = original_uppercase
;
9958 shift_translated
= 0;
9961 if (shift_translated
)
9962 Vthis_command_keys_shift_translated
= Qt
;
9964 /* Occasionally we fabricate events, perhaps by expanding something
9965 according to function-key-map, or by adding a prefix symbol to a
9966 mouse click in the scroll bar or modeline. In this cases, return
9967 the entire generated key sequence, even if we hit an unbound
9968 prefix or a definition before the end. This means that you will
9969 be able to push back the event properly, and also means that
9970 read-key-sequence will always return a logical unit.
9973 for (; t
< mock_input
; t
++)
9975 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9976 && NILP (Fzerop (Vecho_keystrokes
)))
9977 echo_char (keybuf
[t
]);
9978 add_command_key (keybuf
[t
]);
9981 UNGCPRO_VAR (outer_gcpro
);
9985 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9986 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9987 The sequence is sufficient to specify a non-prefix command in the
9988 current local and global maps.
9990 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9991 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9992 as a continuation of the previous key.
9994 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9995 convert the last event to lower case. (Normally any upper case event
9996 is converted to lower case if the original event is undefined and the lower
9997 case equivalent is defined.) A non-nil value is appropriate for reading
9998 a key sequence to be defined.
10000 A C-g typed while in this function is treated like any other character,
10001 and `quit-flag' is not set.
10003 If the key sequence starts with a mouse click, then the sequence is read
10004 using the keymaps of the buffer of the window clicked in, not the buffer
10005 of the selected window as normal.
10007 `read-key-sequence' drops unbound button-down events, since you normally
10008 only care about the click or drag events which follow them. If a drag
10009 or multi-click event is unbound, but the corresponding click event would
10010 be bound, `read-key-sequence' turns the event into a click event at the
10011 drag's starting position. This means that you don't have to distinguish
10012 between click and drag, double, or triple events unless you want to.
10014 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10015 lines separating windows, and scroll bars with imaginary keys
10016 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10018 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10019 function will process a switch-frame event if the user switches frames
10020 before typing anything. If the user switches frames in the middle of a
10021 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10022 is nil, then the event will be put off until after the current key sequence.
10024 `read-key-sequence' checks `function-key-map' for function key
10025 sequences, where they wouldn't conflict with ordinary bindings. See
10026 `function-key-map' for more details.
10028 The optional fifth argument CMD-LOOP, if non-nil, means
10029 that this key sequence is being read by something that will
10030 read commands one after another. It should be nil if the caller
10031 will read just one key sequence. */)
10032 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10034 Lisp_Object keybuf
[30];
10036 struct gcpro gcpro1
;
10037 int count
= SPECPDL_INDEX ();
10039 if (!NILP (prompt
))
10040 CHECK_STRING (prompt
);
10043 specbind (Qinput_method_exit_on_first_char
,
10044 (NILP (cmd_loop
) ? Qt
: Qnil
));
10045 specbind (Qinput_method_use_echo_area
,
10046 (NILP (cmd_loop
) ? Qt
: Qnil
));
10048 memset (keybuf
, 0, sizeof keybuf
);
10049 GCPRO1 (keybuf
[0]);
10050 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10052 if (NILP (continue_echo
))
10054 this_command_key_count
= 0;
10055 this_command_key_count_reset
= 0;
10056 this_single_command_key_start
= 0;
10059 #ifdef HAVE_WINDOW_SYSTEM
10060 if (display_hourglass_p
)
10061 cancel_hourglass ();
10064 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10065 prompt
, ! NILP (dont_downcase_last
),
10066 ! NILP (can_return_switch_frame
), 0);
10068 #if 0 /* The following is fine for code reading a key sequence and
10069 then proceeding with a lenghty computation, but it's not good
10070 for code reading keys in a loop, like an input method. */
10071 #ifdef HAVE_WINDOW_SYSTEM
10072 if (display_hourglass_p
)
10073 start_hourglass ();
10083 return unbind_to (count
, make_event_array (i
, keybuf
));
10086 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10087 Sread_key_sequence_vector
, 1, 5, 0,
10088 doc
: /* Like `read-key-sequence' but always return a vector. */)
10089 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10091 Lisp_Object keybuf
[30];
10093 struct gcpro gcpro1
;
10094 int count
= SPECPDL_INDEX ();
10096 if (!NILP (prompt
))
10097 CHECK_STRING (prompt
);
10100 specbind (Qinput_method_exit_on_first_char
,
10101 (NILP (cmd_loop
) ? Qt
: Qnil
));
10102 specbind (Qinput_method_use_echo_area
,
10103 (NILP (cmd_loop
) ? Qt
: Qnil
));
10105 memset (keybuf
, 0, sizeof keybuf
);
10106 GCPRO1 (keybuf
[0]);
10107 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10109 if (NILP (continue_echo
))
10111 this_command_key_count
= 0;
10112 this_command_key_count_reset
= 0;
10113 this_single_command_key_start
= 0;
10116 #ifdef HAVE_WINDOW_SYSTEM
10117 if (display_hourglass_p
)
10118 cancel_hourglass ();
10121 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10122 prompt
, ! NILP (dont_downcase_last
),
10123 ! NILP (can_return_switch_frame
), 0);
10125 #ifdef HAVE_WINDOW_SYSTEM
10126 if (display_hourglass_p
)
10127 start_hourglass ();
10136 return unbind_to (count
, Fvector (i
, keybuf
));
10139 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10140 doc
: /* Execute CMD as an editor command.
10141 CMD must be a symbol that satisfies the `commandp' predicate.
10142 Optional second arg RECORD-FLAG non-nil
10143 means unconditionally put this command in `command-history'.
10144 Otherwise, that is done only if an arg is read using the minibuffer.
10145 The argument KEYS specifies the value to use instead of (this-command-keys)
10146 when reading the arguments; if it is nil, (this-command-keys) is used.
10147 The argument SPECIAL, if non-nil, means that this command is executing
10148 a special event, so ignore the prefix argument and don't clear it. */)
10149 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10151 register Lisp_Object final
;
10152 register Lisp_Object tem
;
10153 Lisp_Object prefixarg
;
10155 debug_on_next_call
= 0;
10157 if (NILP (special
))
10159 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10160 Vcurrent_prefix_arg
= prefixarg
;
10161 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10168 tem
= Fget (cmd
, Qdisabled
);
10171 tem
= Fsymbol_value (Qdisabled_command_function
);
10173 return Frun_hooks (1, &Qdisabled_command_function
);
10179 final
= Findirect_function (cmd
, Qnil
);
10181 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10183 struct gcpro gcpro1
, gcpro2
;
10185 GCPRO2 (cmd
, prefixarg
);
10186 do_autoload (final
, cmd
);
10193 if (STRINGP (final
) || VECTORP (final
))
10195 /* If requested, place the macro in the command history. For
10196 other sorts of commands, call-interactively takes care of
10198 if (!NILP (record_flag
))
10201 = Fcons (Fcons (Qexecute_kbd_macro
,
10202 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10205 /* Don't keep command history around forever. */
10206 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10208 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10210 XSETCDR (tem
, Qnil
);
10214 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10217 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10218 /* Don't call Fcall_interactively directly because we want to make
10219 sure the backtrace has an entry for `call-interactively'.
10220 For the same reason, pass `cmd' rather than `final'. */
10221 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10228 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10230 doc
: /* Read function name, then read its arguments and call it.
10232 To pass a numeric argument to the command you are invoking with, specify
10233 the numeric argument to this command.
10235 Noninteractively, the argument PREFIXARG is the prefix argument to
10236 give to the command you invoke, if it asks for an argument. */)
10237 (Lisp_Object prefixarg
)
10239 Lisp_Object function
;
10240 EMACS_INT saved_last_point_position
;
10241 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10242 Lisp_Object bindings
, value
;
10243 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10244 #ifdef HAVE_WINDOW_SYSTEM
10245 /* The call to Fcompleting_read will start and cancel the hourglass,
10246 but if the hourglass was already scheduled, this means that no
10247 hourglass will be shown for the actual M-x command itself.
10248 So we restart it if it is already scheduled. Note that checking
10249 hourglass_shown_p is not enough, normally the hourglass is not shown,
10250 just scheduled to be shown. */
10251 int hstarted
= hourglass_started ();
10254 saved_keys
= Fvector (this_command_key_count
,
10255 XVECTOR (this_command_keys
)->contents
);
10256 saved_last_point_position_buffer
= last_point_position_buffer
;
10257 saved_last_point_position
= last_point_position
;
10258 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10260 function
= call0 (intern ("read-extended-command"));
10262 #ifdef HAVE_WINDOW_SYSTEM
10263 if (hstarted
) start_hourglass ();
10266 if (STRINGP (function
) && SCHARS (function
) == 0)
10267 error ("No command name given");
10269 /* Set this_command_keys to the concatenation of saved_keys and
10270 function, followed by a RET. */
10275 this_command_key_count
= 0;
10276 this_command_key_count_reset
= 0;
10277 this_single_command_key_start
= 0;
10279 keys
= XVECTOR (saved_keys
)->contents
;
10280 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10281 add_command_key (keys
[i
]);
10283 for (i
= 0; i
< SCHARS (function
); i
++)
10284 add_command_key (Faref (function
, make_number (i
)));
10286 add_command_key (make_number ('\015'));
10289 last_point_position
= saved_last_point_position
;
10290 last_point_position_buffer
= saved_last_point_position_buffer
;
10294 function
= Fintern (function
, Qnil
);
10295 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10296 Vthis_command
= function
;
10297 real_this_command
= function
;
10299 /* If enabled, show which key runs this command. */
10300 if (!NILP (Vsuggest_key_bindings
)
10301 && NILP (Vexecuting_kbd_macro
)
10302 && SYMBOLP (function
))
10303 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10309 GCPRO3 (bindings
, value
, function
);
10310 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10312 /* If the command has a key binding, print it now. */
10313 if (!NILP (bindings
)
10314 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10317 /* But first wait, and skip the message if there is input. */
10318 Lisp_Object waited
;
10320 /* If this command displayed something in the echo area;
10321 wait a few seconds, then display our suggestion message. */
10322 if (NILP (echo_area_buffer
[0]))
10323 waited
= sit_for (make_number (0), 0, 2);
10324 else if (NUMBERP (Vsuggest_key_bindings
))
10325 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10327 waited
= sit_for (make_number (2), 0, 2);
10329 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10331 Lisp_Object binding
;
10333 int message_p
= push_message ();
10334 int count
= SPECPDL_INDEX ();
10336 record_unwind_protect (pop_message_unwind
, Qnil
);
10337 binding
= Fkey_description (bindings
, Qnil
);
10340 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10343 sprintf (newmessage
, "You can run the command `%s' with %s",
10344 SDATA (SYMBOL_NAME (function
)),
10346 message2 (newmessage
,
10347 strlen (newmessage
),
10348 STRING_MULTIBYTE (binding
));
10349 if (NUMBERP (Vsuggest_key_bindings
))
10350 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10352 waited
= sit_for (make_number (2), 0, 2);
10354 if (!NILP (waited
) && message_p
)
10355 restore_message ();
10357 unbind_to (count
, Qnil
);
10361 RETURN_UNGCPRO (value
);
10365 /* Return nonzero if input events are pending. */
10368 detect_input_pending (void)
10370 if (!input_pending
)
10371 get_input_pending (&input_pending
, 0);
10373 return input_pending
;
10376 /* Return nonzero if input events other than mouse movements are
10380 detect_input_pending_ignore_squeezables (void)
10382 if (!input_pending
)
10383 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10385 return input_pending
;
10388 /* Return nonzero if input events are pending, and run any pending timers. */
10391 detect_input_pending_run_timers (int do_display
)
10393 int old_timers_run
= timers_run
;
10395 if (!input_pending
)
10396 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10398 if (old_timers_run
!= timers_run
&& do_display
)
10400 redisplay_preserve_echo_area (8);
10401 /* The following fixes a bug when using lazy-lock with
10402 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10403 from an idle timer function. The symptom of the bug is that
10404 the cursor sometimes doesn't become visible until the next X
10405 event is processed. --gerd. */
10407 Lisp_Object tail
, frame
;
10408 FOR_EACH_FRAME (tail
, frame
)
10409 if (FRAME_RIF (XFRAME (frame
)))
10410 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10414 return input_pending
;
10417 /* This is called in some cases before a possible quit.
10418 It cases the next call to detect_input_pending to recompute input_pending.
10419 So calling this function unnecessarily can't do any harm. */
10422 clear_input_pending (void)
10427 /* Return nonzero if there are pending requeued events.
10428 This isn't used yet. The hope is to make wait_reading_process_output
10429 call it, and return if it runs Lisp code that unreads something.
10430 The problem is, kbd_buffer_get_event needs to be fixed to know what
10431 to do in that case. It isn't trivial. */
10434 requeued_events_pending_p (void)
10436 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10440 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10441 doc
: /* Return t if command input is currently available with no wait.
10442 Actually, the value is nil only if we can be sure that no input is available;
10443 if there is a doubt, the value is t. */)
10446 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10447 || !NILP (Vunread_post_input_method_events
)
10448 || !NILP (Vunread_input_method_events
))
10451 get_input_pending (&input_pending
,
10452 READABLE_EVENTS_DO_TIMERS_NOW
10453 | READABLE_EVENTS_FILTER_EVENTS
);
10454 return input_pending
> 0 ? Qt
: Qnil
;
10457 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10458 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10461 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10464 if (total_keys
< NUM_RECENT_KEYS
)
10465 return Fvector (total_keys
, keys
);
10468 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10469 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10470 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10471 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10472 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10477 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10478 doc
: /* Return the key sequence that invoked this command.
10479 However, if the command has called `read-key-sequence', it returns
10480 the last key sequence that has been read.
10481 The value is a string or a vector.
10483 See also `this-command-keys-vector'. */)
10486 return make_event_array (this_command_key_count
,
10487 XVECTOR (this_command_keys
)->contents
);
10490 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10491 doc
: /* Return the key sequence that invoked this command, as a vector.
10492 However, if the command has called `read-key-sequence', it returns
10493 the last key sequence that has been read.
10495 See also `this-command-keys'. */)
10498 return Fvector (this_command_key_count
,
10499 XVECTOR (this_command_keys
)->contents
);
10502 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10503 Sthis_single_command_keys
, 0, 0, 0,
10504 doc
: /* Return the key sequence that invoked this command.
10505 More generally, it returns the last key sequence read, either by
10506 the command loop or by `read-key-sequence'.
10507 Unlike `this-command-keys', this function's value
10508 does not include prefix arguments.
10509 The value is always a vector. */)
10512 return Fvector (this_command_key_count
10513 - this_single_command_key_start
,
10514 (XVECTOR (this_command_keys
)->contents
10515 + this_single_command_key_start
));
10518 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10519 Sthis_single_command_raw_keys
, 0, 0, 0,
10520 doc
: /* Return the raw events that were read for this command.
10521 More generally, it returns the last key sequence read, either by
10522 the command loop or by `read-key-sequence'.
10523 Unlike `this-single-command-keys', this function's value
10524 shows the events before all translations (except for input methods).
10525 The value is always a vector. */)
10528 return Fvector (raw_keybuf_count
,
10529 (XVECTOR (raw_keybuf
)->contents
));
10532 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10533 Sreset_this_command_lengths
, 0, 0, 0,
10534 doc
: /* Make the unread events replace the last command and echo.
10535 Used in `universal-argument-other-key'.
10537 `universal-argument-other-key' rereads the event just typed.
10538 It then gets translated through `function-key-map'.
10539 The translated event has to replace the real events,
10540 both in the value of (this-command-keys) and in echoing.
10541 To achieve this, `universal-argument-other-key' calls
10542 `reset-this-command-lengths', which discards the record of reading
10543 these events the first time. */)
10546 this_command_key_count
= before_command_key_count
;
10547 if (this_command_key_count
< this_single_command_key_start
)
10548 this_single_command_key_start
= this_command_key_count
;
10550 echo_truncate (before_command_echo_length
);
10552 /* Cause whatever we put into unread-command-events
10553 to echo as if it were being freshly read from the keyboard. */
10554 this_command_key_count_reset
= 1;
10559 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10560 Sclear_this_command_keys
, 0, 1, 0,
10561 doc
: /* Clear out the vector that `this-command-keys' returns.
10562 Also clear the record of the last 100 events, unless optional arg
10563 KEEP-RECORD is non-nil. */)
10564 (Lisp_Object keep_record
)
10568 this_command_key_count
= 0;
10569 this_command_key_count_reset
= 0;
10571 if (NILP (keep_record
))
10573 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10574 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10576 recent_keys_index
= 0;
10581 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10582 doc
: /* Return the current depth in recursive edits. */)
10586 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10590 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10591 "FOpen dribble file: ",
10592 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10593 If FILE is nil, close any open dribble file. */)
10605 file
= Fexpand_file_name (file
, Qnil
);
10606 dribble
= fopen (SSDATA (file
), "w");
10608 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10613 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10614 doc
: /* Discard the contents of the terminal input buffer.
10615 Also end any kbd macro being defined. */)
10618 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10620 /* Discard the last command from the macro. */
10621 Fcancel_kbd_macro_events ();
10625 update_mode_lines
++;
10627 Vunread_command_events
= Qnil
;
10628 unread_command_char
= -1;
10630 discard_tty_input ();
10632 kbd_fetch_ptr
= kbd_store_ptr
;
10638 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10639 doc
: /* Stop Emacs and return to superior process. You can resume later.
10640 If `cannot-suspend' is non-nil, or if the system doesn't support job
10641 control, run a subshell instead.
10643 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10644 to be read as terminal input by Emacs's parent, after suspension.
10646 Before suspending, run the normal hook `suspend-hook'.
10647 After resumption run the normal hook `suspend-resume-hook'.
10649 Some operating systems cannot stop the Emacs process and resume it later.
10650 On such systems, Emacs starts a subshell instead of suspending. */)
10651 (Lisp_Object stuffstring
)
10653 int count
= SPECPDL_INDEX ();
10654 int old_height
, old_width
;
10656 struct gcpro gcpro1
;
10659 if (tty_list
&& tty_list
->next
)
10660 error ("There are other tty frames open; close them before suspending Emacs");
10662 if (!NILP (stuffstring
))
10663 CHECK_STRING (stuffstring
);
10665 /* Run the functions in suspend-hook. */
10666 hook
= intern ("suspend-hook");
10667 Frun_hooks (1, &hook
);
10669 GCPRO1 (stuffstring
);
10670 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10671 reset_all_sys_modes ();
10672 /* sys_suspend can get an error if it tries to fork a subshell
10673 and the system resources aren't available for that. */
10674 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10676 stuff_buffered_input (stuffstring
);
10677 if (cannot_suspend
)
10681 unbind_to (count
, Qnil
);
10683 /* Check if terminal/window size has changed.
10684 Note that this is not useful when we are running directly
10685 with a window system; but suspend should be disabled in that case. */
10686 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10687 if (width
!= old_width
|| height
!= old_height
)
10688 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10690 /* Run suspend-resume-hook. */
10691 hook
= intern ("suspend-resume-hook");
10692 Frun_hooks (1, &hook
);
10698 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10699 Then in any case stuff anything Emacs has read ahead and not used. */
10702 stuff_buffered_input (Lisp_Object stuffstring
)
10704 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10705 register unsigned char *p
;
10707 if (STRINGP (stuffstring
))
10709 register EMACS_INT count
;
10711 p
= SDATA (stuffstring
);
10712 count
= SBYTES (stuffstring
);
10713 while (count
-- > 0)
10718 /* Anything we have read ahead, put back for the shell to read. */
10719 /* ?? What should this do when we have multiple keyboards??
10720 Should we ignore anything that was typed in at the "wrong" kboard?
10722 rms: we should stuff everything back into the kboard
10724 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10727 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10728 kbd_fetch_ptr
= kbd_buffer
;
10729 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10730 stuff_char (kbd_fetch_ptr
->code
);
10732 clear_event (kbd_fetch_ptr
);
10736 #endif /* SIGTSTP */
10740 set_waiting_for_input (struct timeval
*time_to_clear
)
10742 input_available_clear_time
= time_to_clear
;
10744 /* Tell handle_interrupt to throw back to read_char, */
10745 waiting_for_input
= 1;
10747 /* If handle_interrupt was called before and buffered a C-g,
10748 make it run again now, to avoid timing error. */
10749 if (!NILP (Vquit_flag
))
10750 quit_throw_to_read_char ();
10754 clear_waiting_for_input (void)
10756 /* Tell handle_interrupt not to throw back to read_char, */
10757 waiting_for_input
= 0;
10758 input_available_clear_time
= 0;
10761 /* The SIGINT handler.
10763 If we have a frame on the controlling tty, we assume that the
10764 SIGINT was generated by C-g, so we call handle_interrupt.
10765 Otherwise, the handler kills Emacs. */
10768 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10769 /* compilers complain in signal calls. */
10771 /* Must preserve main program's value of errno. */
10772 int old_errno
= errno
;
10773 struct terminal
*terminal
;
10775 SIGNAL_THREAD_CHECK (signalnum
);
10777 /* See if we have an active terminal on our controlling tty. */
10778 terminal
= get_named_tty ("/dev/tty");
10781 /* If there are no frames there, let's pretend that we are a
10782 well-behaving UN*X program and quit. */
10783 Fkill_emacs (Qnil
);
10787 /* Otherwise, the SIGINT was probably generated by C-g. */
10789 /* Set internal_last_event_frame to the top frame of the
10790 controlling tty, if we have a frame there. We disable the
10791 interrupt key on secondary ttys, so the SIGINT must have come
10792 from the controlling tty. */
10793 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10795 handle_interrupt ();
10801 /* This routine is called at interrupt level in response to C-g.
10803 It is called from the SIGINT handler or kbd_buffer_store_event.
10805 If `waiting_for_input' is non zero, then unless `echoing' is
10806 nonzero, immediately throw back to read_char.
10808 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10809 eval to throw, when it gets a chance. If quit-flag is already
10810 non-nil, it stops the job right away. */
10813 handle_interrupt (void)
10819 /* XXX This code needs to be revised for multi-tty support. */
10820 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10822 /* If SIGINT isn't blocked, don't let us be interrupted by
10823 another SIGINT, it might be harmful due to non-reentrancy
10824 in I/O functions. */
10825 sigblock (sigmask (SIGINT
));
10828 reset_all_sys_modes ();
10830 #ifdef SIGTSTP /* Support possible in later USG versions */
10832 * On systems which can suspend the current process and return to the original
10833 * shell, this command causes the user to end up back at the shell.
10834 * The "Auto-save" and "Abort" questions are not asked until
10835 * the user elects to return to emacs, at which point he can save the current
10836 * job and either dump core or continue.
10840 /* Perhaps should really fork an inferior shell?
10841 But that would not provide any way to get back
10842 to the original shell, ever. */
10843 printf ("No support for stopping a process on this operating system;\n");
10844 printf ("you can continue or abort.\n");
10845 #endif /* not SIGTSTP */
10847 /* We must remain inside the screen area when the internal terminal
10848 is used. Note that [Enter] is not echoed by dos. */
10849 cursor_to (SELECTED_FRAME (), 0, 0);
10851 /* It doesn't work to autosave while GC is in progress;
10852 the code used for auto-saving doesn't cope with the mark bit. */
10853 if (!gc_in_progress
)
10855 printf ("Auto-save? (y or n) ");
10857 if (((c
= getchar ()) & ~040) == 'Y')
10859 Fdo_auto_save (Qt
, Qnil
);
10861 printf ("\r\nAuto-save done");
10862 #else /* not MSDOS */
10863 printf ("Auto-save done\n");
10864 #endif /* not MSDOS */
10866 while (c
!= '\n') c
= getchar ();
10870 /* During GC, it must be safe to reenable quitting again. */
10871 Vinhibit_quit
= Qnil
;
10874 #endif /* not MSDOS */
10875 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10876 printf ("but will instead do a real quit after garbage collection ends\r\n");
10881 printf ("\r\nAbort? (y or n) ");
10882 #else /* not MSDOS */
10883 printf ("Abort (and dump core)? (y or n) ");
10884 #endif /* not MSDOS */
10886 if (((c
= getchar ()) & ~040) == 'Y')
10888 while (c
!= '\n') c
= getchar ();
10890 printf ("\r\nContinuing...\r\n");
10891 #else /* not MSDOS */
10892 printf ("Continuing...\n");
10893 #endif /* not MSDOS */
10895 init_all_sys_modes ();
10900 /* If executing a function that wants to be interrupted out of
10901 and the user has not deferred quitting by binding `inhibit-quit'
10902 then quit right away. */
10903 if (immediate_quit
&& NILP (Vinhibit_quit
))
10905 struct gl_state_s saved
;
10906 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10908 immediate_quit
= 0;
10911 GCPRO4 (saved
.object
, saved
.global_code
,
10912 saved
.current_syntax_table
, saved
.old_prop
);
10913 Fsignal (Qquit
, Qnil
);
10914 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10919 /* Else request quit when it's safe */
10923 /* TODO: The longjmp in this call throws the NS event loop integration off,
10924 and it seems to do fine without this. Probably some attention
10925 needs to be paid to the setting of waiting_for_input in
10926 wait_reading_process_output() under HAVE_NS because of the call
10927 to ns_select there (needed because otherwise events aren't picked up
10928 outside of polling since we don't get SIGIO like X and we don't have a
10929 separate event loop thread like W32. */
10931 if (waiting_for_input
&& !echoing
)
10932 quit_throw_to_read_char ();
10936 /* Handle a C-g by making read_char return C-g. */
10939 quit_throw_to_read_char (void)
10942 /* Prevent another signal from doing this before we finish. */
10943 clear_waiting_for_input ();
10946 Vunread_command_events
= Qnil
;
10947 unread_command_char
= -1;
10949 #if 0 /* Currently, sit_for is called from read_char without turning
10950 off polling. And that can call set_waiting_for_input.
10951 It seems to be harmless. */
10952 #ifdef POLL_FOR_INPUT
10953 /* May be > 1 if in recursive minibuffer. */
10954 if (poll_suppress_count
== 0)
10958 if (FRAMEP (internal_last_event_frame
)
10959 && !EQ (internal_last_event_frame
, selected_frame
))
10960 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10963 _longjmp (getcjmp
, 1);
10966 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
10967 doc
: /* Set interrupt mode of reading keyboard input.
10968 If INTERRUPT is non-nil, Emacs will use input interrupts;
10969 otherwise Emacs uses CBREAK mode.
10971 See also `current-input-mode'. */)
10972 (Lisp_Object interrupt
)
10974 int new_interrupt_input
;
10976 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10977 #ifdef HAVE_X_WINDOWS
10978 if (x_display_list
!= NULL
)
10980 /* When using X, don't give the user a real choice,
10981 because we haven't implemented the mechanisms to support it. */
10982 new_interrupt_input
= 1;
10985 #endif /* HAVE_X_WINDOWS */
10986 new_interrupt_input
= !NILP (interrupt
);
10987 #else /* not SIGIO */
10988 new_interrupt_input
= 0;
10989 #endif /* not SIGIO */
10991 if (new_interrupt_input
!= interrupt_input
)
10993 #ifdef POLL_FOR_INPUT
10997 /* this causes startup screen to be restored and messes with the mouse */
10998 reset_all_sys_modes ();
10999 interrupt_input
= new_interrupt_input
;
11000 init_all_sys_modes ();
11002 interrupt_input
= new_interrupt_input
;
11005 #ifdef POLL_FOR_INPUT
11006 poll_suppress_count
= 1;
11013 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11014 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11015 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11016 C-q in key sequences.
11018 This setting only has an effect on tty terminals and only when
11019 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11021 See also `current-input-mode'. */)
11022 (Lisp_Object flow
, Lisp_Object terminal
)
11024 struct terminal
*t
= get_terminal (terminal
, 1);
11025 struct tty_display_info
*tty
;
11026 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11028 tty
= t
->display_info
.tty
;
11030 if (tty
->flow_control
!= !NILP (flow
))
11033 /* this causes startup screen to be restored and messes with the mouse */
11034 reset_sys_modes (tty
);
11037 tty
->flow_control
= !NILP (flow
);
11040 init_sys_modes (tty
);
11046 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11047 doc
: /* Enable or disable 8-bit input on TERMINAL.
11048 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11049 bit as the Meta modifier.
11051 If META is nil, Emacs will ignore the top bit, on the assumption it is
11054 Otherwise, Emacs will accept and pass through 8-bit input without
11055 specially interpreting the top bit.
11057 This setting only has an effect on tty terminal devices.
11059 Optional parameter TERMINAL specifies the tty terminal device to use.
11060 It may be a terminal object, a frame, or nil for the terminal used by
11061 the currently selected frame.
11063 See also `current-input-mode'. */)
11064 (Lisp_Object meta
, Lisp_Object terminal
)
11066 struct terminal
*t
= get_terminal (terminal
, 1);
11067 struct tty_display_info
*tty
;
11070 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11072 tty
= t
->display_info
.tty
;
11076 else if (EQ (meta
, Qt
))
11081 if (tty
->meta_key
!= new_meta
)
11084 /* this causes startup screen to be restored and messes with the mouse */
11085 reset_sys_modes (tty
);
11088 tty
->meta_key
= new_meta
;
11091 init_sys_modes (tty
);
11097 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11098 doc
: /* Specify character used for quitting.
11099 QUIT must be an ASCII character.
11101 This function only has an effect on the controlling tty of the Emacs
11104 See also `current-input-mode'. */)
11107 struct terminal
*t
= get_named_tty ("/dev/tty");
11108 struct tty_display_info
*tty
;
11109 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11111 tty
= t
->display_info
.tty
;
11113 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11114 error ("QUIT must be an ASCII character");
11117 /* this causes startup screen to be restored and messes with the mouse */
11118 reset_sys_modes (tty
);
11121 /* Don't let this value be out of range. */
11122 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11125 init_sys_modes (tty
);
11131 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11132 doc
: /* Set mode of reading keyboard input.
11133 First arg INTERRUPT non-nil means use input interrupts;
11134 nil means use CBREAK mode.
11135 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11136 (no effect except in CBREAK mode).
11137 Third arg META t means accept 8-bit input (for a Meta key).
11138 META nil means ignore the top bit, on the assumption it is parity.
11139 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11140 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11141 See also `current-input-mode'. */)
11142 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11144 Fset_input_interrupt_mode (interrupt
);
11145 Fset_output_flow_control (flow
, Qnil
);
11146 Fset_input_meta_mode (meta
, Qnil
);
11148 Fset_quit_char (quit
);
11152 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11153 doc
: /* Return information about the way Emacs currently reads keyboard input.
11154 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11155 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11156 nil, Emacs is using CBREAK mode.
11157 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11158 terminal; this does not apply if Emacs uses interrupt-driven input.
11159 META is t if accepting 8-bit input with 8th bit as Meta flag.
11160 META nil means ignoring the top bit, on the assumption it is parity.
11161 META is neither t nor nil if accepting 8-bit input and using
11162 all 8 bits as the character code.
11163 QUIT is the character Emacs currently uses to quit.
11164 The elements of this list correspond to the arguments of
11165 `set-input-mode'. */)
11168 Lisp_Object val
[4];
11169 struct frame
*sf
= XFRAME (selected_frame
);
11171 val
[0] = interrupt_input
? Qt
: Qnil
;
11172 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11174 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11175 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11177 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11184 XSETFASTINT (val
[3], quit_char
);
11186 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11189 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11190 doc
: /* Return position information for pixel coordinates X and Y.
11191 By default, X and Y are relative to text area of the selected window.
11192 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11193 If optional fourth arg WHOLE is non-nil, X is relative to the left
11194 edge of the window.
11196 The return value is similar to a mouse click position:
11197 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11198 IMAGE (DX . DY) (WIDTH . HEIGHT))
11199 The `posn-' functions access elements of such lists. */)
11200 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11205 if (NILP (frame_or_window
))
11206 frame_or_window
= selected_window
;
11208 if (WINDOWP (frame_or_window
))
11212 CHECK_LIVE_WINDOW (frame_or_window
);
11214 w
= XWINDOW (frame_or_window
);
11215 XSETINT (x
, (XINT (x
)
11216 + WINDOW_LEFT_EDGE_X (w
)
11218 ? window_box_left_offset (w
, TEXT_AREA
)
11220 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11221 frame_or_window
= w
->frame
;
11224 CHECK_LIVE_FRAME (frame_or_window
);
11226 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11229 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11230 doc
: /* Return position information for buffer POS in WINDOW.
11231 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11233 Return nil if position is not visible in window. Otherwise,
11234 the return value is similar to that returned by `event-start' for
11235 a mouse click at the upper left corner of the glyph corresponding
11236 to the given buffer position:
11237 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11238 IMAGE (DX . DY) (WIDTH . HEIGHT))
11239 The `posn-' functions access elements of such lists. */)
11240 (Lisp_Object pos
, Lisp_Object window
)
11245 window
= selected_window
;
11247 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11250 Lisp_Object x
= XCAR (tem
);
11251 Lisp_Object y
= XCAR (XCDR (tem
));
11253 /* Point invisible due to hscrolling? */
11256 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11264 * Set up a new kboard object with reasonable initial values.
11267 init_kboard (KBOARD
*kb
)
11269 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11270 KVAR (kb
, Vlast_command
) = Qnil
;
11271 KVAR (kb
, Vreal_last_command
) = Qnil
;
11272 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11273 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11274 KVAR (kb
, Vprefix_arg
) = Qnil
;
11275 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11276 KVAR (kb
, kbd_queue
) = Qnil
;
11277 kb
->kbd_queue_has_data
= 0;
11278 kb
->immediate_echo
= 0;
11279 KVAR (kb
, echo_string
) = Qnil
;
11280 kb
->echo_after_prompt
= -1;
11281 kb
->kbd_macro_buffer
= 0;
11282 kb
->kbd_macro_bufsize
= 0;
11283 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11284 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11285 kb
->reference_count
= 0;
11286 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11287 KVAR (kb
, system_key_syms
) = Qnil
;
11288 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11289 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11290 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11291 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11292 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11296 * Destroy the contents of a kboard object, but not the object itself.
11297 * We use this just before deleting it, or if we're going to initialize
11298 * it a second time.
11301 wipe_kboard (KBOARD
*kb
)
11303 xfree (kb
->kbd_macro_buffer
);
11306 /* Free KB and memory referenced from it. */
11309 delete_kboard (KBOARD
*kb
)
11313 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11316 *kbp
= kb
->next_kboard
;
11318 /* Prevent a dangling reference to KB. */
11319 if (kb
== current_kboard
11320 && FRAMEP (selected_frame
)
11321 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11323 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11325 if (current_kboard
== kb
)
11334 init_keyboard (void)
11336 /* This is correct before outermost invocation of the editor loop */
11337 command_loop_level
= -1;
11338 immediate_quit
= 0;
11339 quit_char
= Ctl ('g');
11340 Vunread_command_events
= Qnil
;
11341 unread_command_char
= -1;
11342 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11344 recent_keys_index
= 0;
11345 kbd_fetch_ptr
= kbd_buffer
;
11346 kbd_store_ptr
= kbd_buffer
;
11347 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11348 do_mouse_tracking
= Qnil
;
11351 interrupt_input_blocked
= 0;
11352 interrupt_input_pending
= 0;
11354 pending_signals
= 0;
11357 /* This means that command_loop_1 won't try to select anything the first
11359 internal_last_event_frame
= Qnil
;
11360 Vlast_event_frame
= internal_last_event_frame
;
11362 current_kboard
= initial_kboard
;
11363 /* Re-initialize the keyboard again. */
11364 wipe_kboard (current_kboard
);
11365 init_kboard (current_kboard
);
11366 /* A value of nil for Vwindow_system normally means a tty, but we also use
11367 it for the initial terminal since there is no window system there. */
11368 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11370 if (!noninteractive
)
11372 /* Before multi-tty support, these handlers used to be installed
11373 only if the current session was a tty session. Now an Emacs
11374 session may have multiple display types, so we always handle
11375 SIGINT. There is special code in interrupt_signal to exit
11376 Emacs on SIGINT when there are no termcap frames on the
11377 controlling terminal. */
11378 signal (SIGINT
, interrupt_signal
);
11380 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11381 SIGQUIT and we can't tell which one it will give us. */
11382 signal (SIGQUIT
, interrupt_signal
);
11383 #endif /* not DOS_NT */
11385 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11387 if (!noninteractive
)
11388 signal (SIGIO
, input_available_signal
);
11391 /* Use interrupt input by default, if it works and noninterrupt input
11392 has deficiencies. */
11394 #ifdef INTERRUPT_INPUT
11395 interrupt_input
= 1;
11397 interrupt_input
= 0;
11403 if (keyboard_init_hook
)
11404 (*keyboard_init_hook
) ();
11406 #ifdef POLL_FOR_INPUT
11408 poll_suppress_count
= 1;
11413 /* This type's only use is in syms_of_keyboard, to initialize the
11414 event header symbols and put properties on them. */
11415 struct event_head
{
11421 static const struct event_head head_table
[] = {
11422 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11423 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11424 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11425 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11426 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11427 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11428 /* `select-window' should be handled just like `switch-frame'
11429 in read_key_sequence. */
11430 {&Qselect_window
, "select-window", &Qswitch_frame
}
11434 syms_of_keyboard (void)
11436 pending_funcalls
= Qnil
;
11437 staticpro (&pending_funcalls
);
11439 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11440 staticpro (&Vlispy_mouse_stem
);
11443 QCimage
= intern_c_string (":image");
11444 staticpro (&QCimage
);
11446 staticpro (&Qhelp_echo
);
11447 Qhelp_echo
= intern_c_string ("help-echo");
11450 Qrtl
= intern_c_string (":rtl");
11452 staticpro (&item_properties
);
11453 item_properties
= Qnil
;
11455 staticpro (&tool_bar_item_properties
);
11456 tool_bar_item_properties
= Qnil
;
11457 staticpro (&tool_bar_items_vector
);
11458 tool_bar_items_vector
= Qnil
;
11460 staticpro (&real_this_command
);
11461 real_this_command
= Qnil
;
11463 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11464 staticpro (&Qtimer_event_handler
);
11466 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11467 staticpro (&Qdisabled_command_function
);
11469 Qself_insert_command
= intern_c_string ("self-insert-command");
11470 staticpro (&Qself_insert_command
);
11472 Qforward_char
= intern_c_string ("forward-char");
11473 staticpro (&Qforward_char
);
11475 Qbackward_char
= intern_c_string ("backward-char");
11476 staticpro (&Qbackward_char
);
11478 Qdisabled
= intern_c_string ("disabled");
11479 staticpro (&Qdisabled
);
11481 Qundefined
= intern_c_string ("undefined");
11482 staticpro (&Qundefined
);
11484 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11485 staticpro (&Qpre_command_hook
);
11487 Qpost_command_hook
= intern_c_string ("post-command-hook");
11488 staticpro (&Qpost_command_hook
);
11490 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11491 staticpro (&Qdeferred_action_function
);
11493 Qfunction_key
= intern_c_string ("function-key");
11494 staticpro (&Qfunction_key
);
11495 Qmouse_click
= intern_c_string ("mouse-click");
11496 staticpro (&Qmouse_click
);
11497 #if defined (WINDOWSNT)
11498 Qlanguage_change
= intern_c_string ("language-change");
11499 staticpro (&Qlanguage_change
);
11501 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11502 staticpro (&Qdrag_n_drop
);
11504 Qsave_session
= intern_c_string ("save-session");
11505 staticpro (&Qsave_session
);
11508 Qdbus_event
= intern_c_string ("dbus-event");
11509 staticpro (&Qdbus_event
);
11512 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11513 staticpro (&Qconfig_changed_event
);
11515 Qmenu_enable
= intern_c_string ("menu-enable");
11516 staticpro (&Qmenu_enable
);
11517 QCenable
= intern_c_string (":enable");
11518 staticpro (&QCenable
);
11519 QCvisible
= intern_c_string (":visible");
11520 staticpro (&QCvisible
);
11521 QChelp
= intern_c_string (":help");
11522 staticpro (&QChelp
);
11523 QCfilter
= intern_c_string (":filter");
11524 staticpro (&QCfilter
);
11525 QCbutton
= intern_c_string (":button");
11526 staticpro (&QCbutton
);
11527 QCkeys
= intern_c_string (":keys");
11528 staticpro (&QCkeys
);
11529 QCkey_sequence
= intern_c_string (":key-sequence");
11530 staticpro (&QCkey_sequence
);
11531 QCtoggle
= intern_c_string (":toggle");
11532 staticpro (&QCtoggle
);
11533 QCradio
= intern_c_string (":radio");
11534 staticpro (&QCradio
);
11535 QClabel
= intern_c_string (":label");
11536 staticpro (&QClabel
);
11537 QCvert_only
= intern_c_string (":vert-only");
11538 staticpro (&QCvert_only
);
11540 Qmode_line
= intern_c_string ("mode-line");
11541 staticpro (&Qmode_line
);
11542 Qvertical_line
= intern_c_string ("vertical-line");
11543 staticpro (&Qvertical_line
);
11544 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11545 staticpro (&Qvertical_scroll_bar
);
11546 Qmenu_bar
= intern_c_string ("menu-bar");
11547 staticpro (&Qmenu_bar
);
11549 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11550 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11551 staticpro (&Qmouse_fixup_help_message
);
11554 Qabove_handle
= intern_c_string ("above-handle");
11555 staticpro (&Qabove_handle
);
11556 Qhandle
= intern_c_string ("handle");
11557 staticpro (&Qhandle
);
11558 Qbelow_handle
= intern_c_string ("below-handle");
11559 staticpro (&Qbelow_handle
);
11560 Qup
= intern_c_string ("up");
11562 Qdown
= intern_c_string ("down");
11563 staticpro (&Qdown
);
11564 Qtop
= intern_c_string ("top");
11566 Qbottom
= intern_c_string ("bottom");
11567 staticpro (&Qbottom
);
11568 Qend_scroll
= intern_c_string ("end-scroll");
11569 staticpro (&Qend_scroll
);
11570 Qratio
= intern_c_string ("ratio");
11571 staticpro (&Qratio
);
11573 Qevent_kind
= intern_c_string ("event-kind");
11574 staticpro (&Qevent_kind
);
11575 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11576 staticpro (&Qevent_symbol_elements
);
11577 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11578 staticpro (&Qevent_symbol_element_mask
);
11579 Qmodifier_cache
= intern_c_string ("modifier-cache");
11580 staticpro (&Qmodifier_cache
);
11582 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11583 staticpro (&Qrecompute_lucid_menubar
);
11584 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11585 staticpro (&Qactivate_menubar_hook
);
11587 Qpolling_period
= intern_c_string ("polling-period");
11588 staticpro (&Qpolling_period
);
11590 Qinput_method_function
= intern_c_string ("input-method-function");
11591 staticpro (&Qinput_method_function
);
11593 Qx_set_selection
= intern_c_string ("x-set-selection");
11594 staticpro (&Qx_set_selection
);
11595 QPRIMARY
= intern_c_string ("PRIMARY");
11596 staticpro (&QPRIMARY
);
11597 Qhandle_switch_frame
= intern_c_string ("handle-switch-frame");
11598 staticpro (&Qhandle_switch_frame
);
11600 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11601 staticpro (&Qinput_method_exit_on_first_char
);
11602 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11603 staticpro (&Qinput_method_use_echo_area
);
11605 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11606 Fset (Qinput_method_use_echo_area
, Qnil
);
11608 last_point_position_buffer
= Qnil
;
11609 last_point_position_window
= Qnil
;
11613 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11615 for (i
= 0; i
< len
; i
++)
11617 const struct event_head
*p
= &head_table
[i
];
11618 *p
->var
= intern_c_string (p
->name
);
11619 staticpro (p
->var
);
11620 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11621 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11625 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11626 staticpro (&button_down_location
);
11627 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11628 staticpro (&mouse_syms
);
11629 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11630 / sizeof (lispy_wheel_names
[0])),
11632 staticpro (&wheel_syms
);
11636 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11638 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11639 for (i
= 0; i
< len
; i
++)
11640 if (modifier_names
[i
])
11641 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11642 staticpro (&modifier_symbols
);
11645 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11646 staticpro (&recent_keys
);
11648 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11649 staticpro (&this_command_keys
);
11651 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11652 staticpro (&raw_keybuf
);
11654 Qextended_command_history
= intern_c_string ("extended-command-history");
11655 Fset (Qextended_command_history
, Qnil
);
11656 staticpro (&Qextended_command_history
);
11658 accent_key_syms
= Qnil
;
11659 staticpro (&accent_key_syms
);
11661 func_key_syms
= Qnil
;
11662 staticpro (&func_key_syms
);
11664 drag_n_drop_syms
= Qnil
;
11665 staticpro (&drag_n_drop_syms
);
11667 unread_switch_frame
= Qnil
;
11668 staticpro (&unread_switch_frame
);
11670 internal_last_event_frame
= Qnil
;
11671 staticpro (&internal_last_event_frame
);
11673 read_key_sequence_cmd
= Qnil
;
11674 staticpro (&read_key_sequence_cmd
);
11676 menu_bar_one_keymap_changed_items
= Qnil
;
11677 staticpro (&menu_bar_one_keymap_changed_items
);
11679 menu_bar_items_vector
= Qnil
;
11680 staticpro (&menu_bar_items_vector
);
11682 help_form_saved_window_configs
= Qnil
;
11683 staticpro (&help_form_saved_window_configs
);
11685 defsubr (&Scurrent_idle_time
);
11686 defsubr (&Sevent_symbol_parse_modifiers
);
11687 defsubr (&Sevent_convert_list
);
11688 defsubr (&Sread_key_sequence
);
11689 defsubr (&Sread_key_sequence_vector
);
11690 defsubr (&Srecursive_edit
);
11691 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11692 defsubr (&Strack_mouse
);
11694 defsubr (&Sinput_pending_p
);
11695 defsubr (&Scommand_execute
);
11696 defsubr (&Srecent_keys
);
11697 defsubr (&Sthis_command_keys
);
11698 defsubr (&Sthis_command_keys_vector
);
11699 defsubr (&Sthis_single_command_keys
);
11700 defsubr (&Sthis_single_command_raw_keys
);
11701 defsubr (&Sreset_this_command_lengths
);
11702 defsubr (&Sclear_this_command_keys
);
11703 defsubr (&Ssuspend_emacs
);
11704 defsubr (&Sabort_recursive_edit
);
11705 defsubr (&Sexit_recursive_edit
);
11706 defsubr (&Srecursion_depth
);
11707 defsubr (&Stop_level
);
11708 defsubr (&Sdiscard_input
);
11709 defsubr (&Sopen_dribble_file
);
11710 defsubr (&Sset_input_interrupt_mode
);
11711 defsubr (&Sset_output_flow_control
);
11712 defsubr (&Sset_input_meta_mode
);
11713 defsubr (&Sset_quit_char
);
11714 defsubr (&Sset_input_mode
);
11715 defsubr (&Scurrent_input_mode
);
11716 defsubr (&Sexecute_extended_command
);
11717 defsubr (&Sposn_at_point
);
11718 defsubr (&Sposn_at_x_y
);
11720 DEFVAR_LISP ("last-command-event", last_command_event
,
11721 doc
: /* Last input event that was part of a command. */);
11723 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11724 doc
: /* Last input event in a command, except for mouse menu events.
11725 Mouse menus give back keys that don't look like mouse events;
11726 this variable holds the actual mouse event that led to the menu,
11727 so that you can determine whether the command was run by mouse or not. */);
11729 DEFVAR_LISP ("last-input-event", last_input_event
,
11730 doc
: /* Last input event. */);
11732 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11733 doc
: /* List of events to be read as the command input.
11734 These events are processed first, before actual keyboard input.
11735 Events read from this list are not normally added to `this-command-keys',
11736 as they will already have been added once as they were read for the first time.
11737 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11738 Vunread_command_events
= Qnil
;
11740 DEFVAR_INT ("unread-command-char", unread_command_char
,
11741 doc
: /* If not -1, an object to be read as next command input event. */);
11743 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11744 doc
: /* List of events to be processed as input by input methods.
11745 These events are processed before `unread-command-events'
11746 and actual keyboard input, but are not given to `input-method-function'. */);
11747 Vunread_post_input_method_events
= Qnil
;
11749 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11750 doc
: /* List of events to be processed as input by input methods.
11751 These events are processed after `unread-command-events', but
11752 before actual keyboard input.
11753 If there's an active input method, the events are given to
11754 `input-method-function'. */);
11755 Vunread_input_method_events
= Qnil
;
11757 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11758 doc
: /* Meta-prefix character code.
11759 Meta-foo as command input turns into this character followed by foo. */);
11760 XSETINT (meta_prefix_char
, 033);
11762 DEFVAR_KBOARD ("last-command", Vlast_command
,
11763 doc
: /* The last command executed.
11764 Normally a symbol with a function definition, but can be whatever was found
11765 in the keymap, or whatever the variable `this-command' was set to by that
11768 The value `mode-exit' is special; it means that the previous command
11769 read an event that told it to exit, and it did so and unread that event.
11770 In other words, the present command is the event that made the previous
11773 The value `kill-region' is special; it means that the previous command
11774 was a kill command.
11776 `last-command' has a separate binding for each terminal device.
11777 See Info node `(elisp)Multiple Terminals'. */);
11779 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11780 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11782 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11783 doc
: /* Last command that may be repeated.
11784 The last command executed that was not bound to an input event.
11785 This is the command `repeat' will try to repeat. */);
11787 DEFVAR_LISP ("this-command", Vthis_command
,
11788 doc
: /* The command now being executed.
11789 The command can set this variable; whatever is put here
11790 will be in `last-command' during the following command. */);
11791 Vthis_command
= Qnil
;
11793 DEFVAR_LISP ("this-command-keys-shift-translated",
11794 Vthis_command_keys_shift_translated
,
11795 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11796 Shift-translation occurs when there is no binding for the key sequence
11797 as entered, but a binding was found by changing an upper-case letter
11798 to lower-case, or a shifted function key to an unshifted one. */);
11799 Vthis_command_keys_shift_translated
= Qnil
;
11801 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11802 doc
: /* The command bound to the current key sequence before remapping.
11803 It equals `this-command' if the original command was not remapped through
11804 any of the active keymaps. Otherwise, the value of `this-command' is the
11805 result of looking up the original command in the active keymaps. */);
11806 Vthis_original_command
= Qnil
;
11808 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11809 doc
: /* *Number of input events between auto-saves.
11810 Zero means disable autosaving due to number of characters typed. */);
11811 auto_save_interval
= 300;
11813 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11814 doc
: /* *Number of seconds idle time before auto-save.
11815 Zero or nil means disable auto-saving due to idleness.
11816 After auto-saving due to this many seconds of idle time,
11817 Emacs also does a garbage collection if that seems to be warranted. */);
11818 XSETFASTINT (Vauto_save_timeout
, 30);
11820 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11821 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11822 The value may be integer or floating point. */);
11823 Vecho_keystrokes
= make_number (1);
11825 DEFVAR_INT ("polling-period", polling_period
,
11826 doc
: /* *Interval between polling for input during Lisp execution.
11827 The reason for polling is to make C-g work to stop a running program.
11828 Polling is needed only when using X windows and SIGIO does not work.
11829 Polling is automatically disabled in all other cases. */);
11830 polling_period
= 2;
11832 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11833 doc
: /* *Maximum time between mouse clicks to make a double-click.
11834 Measured in milliseconds. The value nil means disable double-click
11835 recognition; t means double-clicks have no time limit and are detected
11836 by position only. */);
11837 Vdouble_click_time
= make_number (500);
11839 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11840 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11841 On window-system frames, value is the number of pixels the mouse may have
11842 moved horizontally or vertically between two clicks to make a double-click.
11843 On non window-system frames, value is interpreted in units of 1/8 characters
11846 This variable is also the threshold for motion of the mouse
11847 to count as a drag. */);
11848 double_click_fuzz
= 3;
11850 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11851 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11852 inhibit_local_menu_bar_menus
= 0;
11854 DEFVAR_INT ("num-input-keys", num_input_keys
,
11855 doc
: /* Number of complete key sequences read as input so far.
11856 This includes key sequences read from keyboard macros.
11857 The number is effectively the number of interactive command invocations. */);
11858 num_input_keys
= 0;
11860 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11861 doc
: /* Number of input events read from the keyboard so far.
11862 This does not include events generated by keyboard macros. */);
11863 num_nonmacro_input_events
= 0;
11865 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11866 doc
: /* The frame in which the most recently read event occurred.
11867 If the last event came from a keyboard macro, this is set to `macro'. */);
11868 Vlast_event_frame
= Qnil
;
11870 /* This variable is set up in sysdep.c. */
11871 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11872 doc
: /* The ERASE character as set by the user with stty. */);
11874 DEFVAR_LISP ("help-char", Vhelp_char
,
11875 doc
: /* Character to recognize as meaning Help.
11876 When it is read, do `(eval help-form)', and display result if it's a string.
11877 If the value of `help-form' is nil, this char can be read normally. */);
11878 XSETINT (Vhelp_char
, Ctl ('H'));
11880 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11881 doc
: /* List of input events to recognize as meaning Help.
11882 These work just like the value of `help-char' (see that). */);
11883 Vhelp_event_list
= Qnil
;
11885 DEFVAR_LISP ("help-form", Vhelp_form
,
11886 doc
: /* Form to execute when character `help-char' is read.
11887 If the form returns a string, that string is displayed.
11888 If `help-form' is nil, the help char is not recognized. */);
11891 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11892 doc
: /* Command to run when `help-char' character follows a prefix key.
11893 This command is used only when there is no actual binding
11894 for that character after that prefix key. */);
11895 Vprefix_help_command
= Qnil
;
11897 DEFVAR_LISP ("top-level", Vtop_level
,
11898 doc
: /* Form to evaluate when Emacs starts up.
11899 Useful to set before you dump a modified Emacs. */);
11902 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11903 doc
: /* Translate table for local keyboard input, or nil.
11904 If non-nil, the value should be a char-table. Each character read
11905 from the keyboard is looked up in this char-table. If the value found
11906 there is non-nil, then it is used instead of the actual input character.
11908 The value can also be a string or vector, but this is considered obsolete.
11909 If it is a string or vector of length N, character codes N and up are left
11910 untranslated. In a vector, an element which is nil means "no translation".
11912 This is applied to the characters supplied to input methods, not their
11913 output. See also `translation-table-for-input'.
11915 This variable has a separate binding for each terminal.
11916 See Info node `(elisp)Multiple Terminals'. */);
11918 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11919 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11920 \(Even if the operating system has support for stopping a process.\) */);
11921 cannot_suspend
= 0;
11923 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11924 doc
: /* Non-nil means prompt with menus when appropriate.
11925 This is done when reading from a keymap that has a prompt string,
11926 for elements that have prompt strings.
11927 The menu is displayed on the screen
11928 if X menus were enabled at configuration
11929 time and the previous event was a mouse click prefix key.
11930 Otherwise, menu prompting uses the echo area. */);
11931 menu_prompting
= 1;
11933 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11934 doc
: /* Character to see next line of menu prompt.
11935 Type this character while in a menu prompt to rotate around the lines of it. */);
11936 XSETINT (menu_prompt_more_char
, ' ');
11938 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11939 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11940 Emacs applies the modifiers of the character stored here to each keyboard
11941 character it reads. For example, after evaluating the expression
11942 (setq extra-keyboard-modifiers ?\\C-x)
11943 all input characters will have the control modifier applied to them.
11945 Note that the character ?\\C-@, equivalent to the integer zero, does
11946 not count as a control character; rather, it counts as a character
11947 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11948 cancels any modification. */);
11949 extra_keyboard_modifiers
= 0;
11951 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11952 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11953 The command loop sets this to nil before each command,
11954 and tests the value when the command returns.
11955 Buffer modification stores t in this variable. */);
11956 Vdeactivate_mark
= Qnil
;
11957 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
11958 staticpro (&Qdeactivate_mark
);
11960 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11961 doc
: /* Normal hook run before each command is executed.
11962 If an unhandled error happens in running this hook,
11963 the function in which the error occurred is unconditionally removed, since
11964 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11965 Vpre_command_hook
= Qnil
;
11967 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11968 doc
: /* Normal hook run after each command is executed.
11969 If an unhandled error happens in running this hook,
11970 the function in which the error occurred is unconditionally removed, since
11971 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11972 Vpost_command_hook
= Qnil
;
11975 DEFVAR_LISP ("echo-area-clear-hook", ...,
11976 doc
: /* Normal hook run when clearing the echo area. */);
11978 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
11979 staticpro (&Qecho_area_clear_hook
);
11980 Fset (Qecho_area_clear_hook
, Qnil
);
11982 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11983 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11984 Vlucid_menu_bar_dirty_flag
= Qnil
;
11986 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11987 doc
: /* List of menu bar items to move to the end of the menu bar.
11988 The elements of the list are event types that may have menu bar bindings. */);
11989 Vmenu_bar_final_items
= Qnil
;
11991 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11992 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11993 This is used internally by graphical displays that do not render
11994 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11995 Vtool_bar_separator_image_expression
= Qnil
;
11997 DEFVAR_KBOARD ("overriding-terminal-local-map",
11998 Voverriding_terminal_local_map
,
11999 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12000 If this variable is non-nil, it is used as a keymap instead of the
12001 buffer's local map, and the minor mode keymaps and text property keymaps.
12002 It also replaces `overriding-local-map'.
12004 This variable is intended to let commands such as `universal-argument'
12005 set up a different keymap for reading the next command.
12007 `overriding-terminal-local-map' has a separate binding for each
12009 See Info node `(elisp)Multiple Terminals'. */);
12011 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
12012 doc
: /* Keymap that overrides all other local keymaps.
12013 If this variable is non-nil, it is used as a keymap--replacing the
12014 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12015 Voverriding_local_map
= Qnil
;
12017 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
12018 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12019 Otherwise, the menu bar continues to reflect the buffer's local map
12020 and the minor mode maps regardless of `overriding-local-map'. */);
12021 Voverriding_local_map_menu_flag
= Qnil
;
12023 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12024 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12025 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12027 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12028 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12030 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12031 doc
: /* Alist of system-specific X windows key symbols.
12032 Each element should have the form (N . SYMBOL) where N is the
12033 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12034 and SYMBOL is its name.
12036 `system-key-alist' has a separate binding for each terminal device.
12037 See Info node `(elisp)Multiple Terminals'. */);
12039 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12040 doc
: /* Keymap that translates key sequences to key sequences during input.
12041 This is used mainly for mapping key sequences into some preferred
12042 key events (symbols).
12044 The `read-key-sequence' function replaces any subsequence bound by
12045 `local-function-key-map' with its binding. More precisely, when the
12046 active keymaps have no binding for the current key sequence but
12047 `local-function-key-map' binds a suffix of the sequence to a vector or
12048 string, `read-key-sequence' replaces the matching suffix with its
12049 binding, and continues with the new sequence.
12051 If the binding is a function, it is called with one argument (the prompt)
12052 and its return value (a key sequence) is used.
12054 The events that come from bindings in `local-function-key-map' are not
12055 themselves looked up in `local-function-key-map'.
12057 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12058 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12059 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12060 typing `ESC O P x' would return [f1 x].
12062 `local-function-key-map' has a separate binding for each terminal
12063 device. See Info node `(elisp)Multiple Terminals'. If you need to
12064 define a binding on all terminals, change `function-key-map'
12065 instead. Initially, `local-function-key-map' is an empty keymap that
12066 has `function-key-map' as its parent on all terminal devices. */);
12068 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12069 doc
: /* Keymap that decodes input escape sequences.
12070 This is used mainly for mapping ASCII function key sequences into
12071 real Emacs function key events (symbols).
12073 The `read-key-sequence' function replaces any subsequence bound by
12074 `input-decode-map' with its binding. Contrary to `function-key-map',
12075 this map applies its rebinding regardless of the presence of an ordinary
12076 binding. So it is more like `key-translation-map' except that it applies
12077 before `function-key-map' rather than after.
12079 If the binding is a function, it is called with one argument (the prompt)
12080 and its return value (a key sequence) is used.
12082 The events that come from bindings in `input-decode-map' are not
12083 themselves looked up in `input-decode-map'.
12085 This variable is keyboard-local. */);
12087 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12088 doc
: /* The parent keymap of all `local-function-key-map' instances.
12089 Function key definitions that apply to all terminal devices should go
12090 here. If a mapping is defined in both the current
12091 `local-function-key-map' binding and this variable, then the local
12092 definition will take precendence. */);
12093 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12095 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12096 doc
: /* Keymap of key translations that can override keymaps.
12097 This keymap works like `function-key-map', but comes after that,
12098 and its non-prefix bindings override ordinary bindings.
12099 Another difference is that it is global rather than keyboard-local. */);
12100 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12102 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12103 doc
: /* List of deferred actions to be performed at a later time.
12104 The precise format isn't relevant here; we just check whether it is nil. */);
12105 Vdeferred_action_list
= Qnil
;
12107 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12108 doc
: /* Function to call to handle deferred actions, after each command.
12109 This function is called with no arguments after each command
12110 whenever `deferred-action-list' is non-nil. */);
12111 Vdeferred_action_function
= Qnil
;
12113 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12114 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12115 The value can be a length of time to show the message for.
12116 If the value is non-nil and not a number, we wait 2 seconds. */);
12117 Vsuggest_key_bindings
= Qt
;
12119 DEFVAR_LISP ("timer-list", Vtimer_list
,
12120 doc
: /* List of active absolute time timers in order of increasing time. */);
12121 Vtimer_list
= Qnil
;
12123 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12124 doc
: /* List of active idle-time timers in order of increasing time. */);
12125 Vtimer_idle_list
= Qnil
;
12127 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12128 doc
: /* If non-nil, the function that implements the current input method.
12129 It's called with one argument, a printing character that was just read.
12130 \(That means a character with code 040...0176.)
12131 Typically this function uses `read-event' to read additional events.
12132 When it does so, it should first bind `input-method-function' to nil
12133 so it will not be called recursively.
12135 The function should return a list of zero or more events
12136 to be used as input. If it wants to put back some events
12137 to be reconsidered, separately, by the input method,
12138 it can add them to the beginning of `unread-command-events'.
12140 The input method function can find in `input-method-previous-message'
12141 the previous echo area message.
12143 The input method function should refer to the variables
12144 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12145 for guidance on what to do. */);
12146 Vinput_method_function
= Qnil
;
12148 DEFVAR_LISP ("input-method-previous-message",
12149 Vinput_method_previous_message
,
12150 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12151 This variable exists because `read-event' clears the echo area
12152 before running the input method. It is nil if there was no message. */);
12153 Vinput_method_previous_message
= Qnil
;
12155 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12156 doc
: /* If non-nil, the function that implements the display of help.
12157 It's called with one argument, the help string to display. */);
12158 Vshow_help_function
= Qnil
;
12160 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12161 doc
: /* If non-nil, suppress point adjustment after executing a command.
12163 After a command is executed, if point is moved into a region that has
12164 special properties (e.g. composition, display), we adjust point to
12165 the boundary of the region. But, when a command sets this variable to
12166 non-nil, we suppress the point adjustment.
12168 This variable is set to nil before reading a command, and is checked
12169 just after executing the command. */);
12170 Vdisable_point_adjustment
= Qnil
;
12172 DEFVAR_LISP ("global-disable-point-adjustment",
12173 Vglobal_disable_point_adjustment
,
12174 doc
: /* *If non-nil, always suppress point adjustment.
12176 The default value is nil, in which case, point adjustment are
12177 suppressed only after special commands that set
12178 `disable-point-adjustment' (which see) to non-nil. */);
12179 Vglobal_disable_point_adjustment
= Qnil
;
12181 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12182 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12183 If the value is not a number, such messages don't time out. */);
12184 Vminibuffer_message_timeout
= make_number (2);
12186 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12187 doc
: /* If non-nil, any keyboard input throws to this symbol.
12188 The value of that variable is passed to `quit-flag' and later causes a
12189 peculiar kind of quitting. */);
12190 Vthrow_on_input
= Qnil
;
12192 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12193 doc
: /* If non-nil, function to output error messages.
12194 The arguments are the error data, a list of the form
12195 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12196 such as just as `condition-case' would bind its variable to,
12197 the context (a string which normally goes at the start of the message),
12198 and the Lisp function within which the error was signaled. */);
12199 Vcommand_error_function
= Qnil
;
12201 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12202 Venable_disabled_menus_and_buttons
,
12203 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12205 Help functions bind this to allow help on disabled menu items
12206 and tool-bar buttons. */);
12207 Venable_disabled_menus_and_buttons
= Qnil
;
12209 DEFVAR_LISP ("select-active-regions",
12210 Vselect_active_regions
,
12211 doc
: /* If non-nil, an active region automatically sets the primary selection.
12212 If the value is `only', only temporarily active regions (usually made
12213 by mouse-dragging or shift-selection) set the window selection.
12215 This takes effect only when Transient Mark mode is enabled. */);
12216 Vselect_active_regions
= Qt
;
12218 DEFVAR_LISP ("saved-region-selection",
12219 Vsaved_region_selection
,
12220 doc
: /* Contents of active region prior to buffer modification.
12221 If `select-active-regions' is non-nil, Emacs sets this to the
12222 text in the region before modifying the buffer. The next
12223 `deactivate-mark' call uses this to set the window selection. */);
12224 Vsaved_region_selection
= Qnil
;
12226 /* Create the initial keyboard. */
12227 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12228 init_kboard (initial_kboard
);
12229 /* Vwindow_system is left at t for now. */
12230 initial_kboard
->next_kboard
= all_kboards
;
12231 all_kboards
= initial_kboard
;
12235 keys_of_keyboard (void)
12237 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12238 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12239 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12240 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12241 initial_define_key (meta_map
, 'x', "execute-extended-command");
12243 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12244 "handle-delete-frame");
12245 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12246 "ns-put-working-text");
12247 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12248 "ns-unput-working-text");
12249 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12250 current-prefix-arg, as is done in `handle-switch-frame'.
12251 But `handle-switch-frame is not run from the special-map.
12252 Commands from that map are run in a special way that automatically
12253 preserves the prefix-arg. Restoring the prefix arg here is not just
12254 redundant but harmful:
12256 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12257 - after the first prompt, the exit-minibuffer-hook is run which may
12258 iconify a frame and thus push a `iconify-frame' event.
12259 - after running exit-minibuffer-hook, current-prefix-arg is
12260 restored to the non-nil value it had before the prompt.
12261 - we enter the second prompt.
12262 current-prefix-arg is non-nil, prefix-arg is nil.
12263 - before running the first real event, we run the special iconify-frame
12264 event, but we pass the `special' arg to execute-command so
12265 current-prefix-arg and prefix-arg are left untouched.
12266 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12267 - the next key event will have a spuriously non-nil current-prefix-arg. */
12268 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12270 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12272 /* Handling it at such a low-level causes read_key_sequence to get
12273 * confused because it doesn't realize that the current_buffer was
12274 * changed by read_char.
12276 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12277 * "handle-select-window"); */
12278 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12279 "handle-save-session");
12282 /* Define a special event which is raised for dbus callback
12284 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12285 "dbus-handle-event");
12288 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12292 /* Mark the pointers in the kboard objects.
12293 Called by the Fgarbage_collector. */
12295 mark_kboards (void)
12299 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12301 if (kb
->kbd_macro_buffer
)
12302 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12304 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12305 mark_object (KVAR (kb
, Vlast_command
));
12306 mark_object (KVAR (kb
, Vreal_last_command
));
12307 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12308 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12309 mark_object (KVAR (kb
, Vprefix_arg
));
12310 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12311 mark_object (KVAR (kb
, kbd_queue
));
12312 mark_object (KVAR (kb
, defining_kbd_macro
));
12313 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12314 mark_object (KVAR (kb
, Vsystem_key_alist
));
12315 mark_object (KVAR (kb
, system_key_syms
));
12316 mark_object (KVAR (kb
, Vwindow_system
));
12317 mark_object (KVAR (kb
, Vinput_decode_map
));
12318 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12319 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12320 mark_object (KVAR (kb
, echo_string
));
12323 struct input_event
*event
;
12324 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12326 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12327 event
= kbd_buffer
;
12328 if (event
->kind
!= SELECTION_REQUEST_EVENT
12329 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12331 mark_object (event
->x
);
12332 mark_object (event
->y
);
12334 mark_object (event
->frame_or_window
);
12335 mark_object (event
->arg
);