1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985-1989, 1993-1997, 1999-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
27 #include "termhooks.h"
33 #include "character.h"
35 #include "dispextern.h"
37 #include "intervals.h"
39 #include "blockinput.h"
46 #ifdef HAVE_GTK_AND_PTHREAD
53 #include <sys/ioctl.h>
54 #endif /* not MSDOS */
56 #include "syssignal.h"
58 #include <sys/types.h>
62 /* This is to get the definitions of the XK_ symbols. */
69 #endif /* HAVE_NTGUI */
75 /* Variables for blockinput.h: */
77 /* Non-zero if interrupt input is blocked right now. */
78 volatile int interrupt_input_blocked
;
80 /* Nonzero means an input interrupt has arrived
81 during the current critical section. */
82 int interrupt_input_pending
;
84 /* This var should be (interrupt_input_pending || pending_atimers).
85 The QUIT macro checks this instead of interrupt_input_pending and
86 pending_atimers separately, to reduce code size. So, any code that
87 changes interrupt_input_pending or pending_atimers should update
93 #define KBD_BUFFER_SIZE 4096
95 KBOARD
*initial_kboard
;
96 KBOARD
*current_kboard
;
100 /* Non-nil disable property on a command means
101 do not execute it; call disabled-command-function's value instead. */
102 Lisp_Object Qdisabled
, Qdisabled_command_function
;
104 #define NUM_RECENT_KEYS (300)
105 int recent_keys_index
; /* Index for storing next element into recent_keys */
106 int total_keys
; /* Total number of elements stored into recent_keys */
107 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
109 /* Vector holding the key sequence that invoked the current command.
110 It is reused for each command, and it may be longer than the current
111 sequence; this_command_key_count indicates how many elements
112 actually mean something.
113 It's easier to staticpro a single Lisp_Object than an array. */
114 Lisp_Object this_command_keys
;
115 int this_command_key_count
;
117 /* 1 after calling Freset_this_command_lengths.
119 int this_command_key_count_reset
;
121 /* This vector is used as a buffer to record the events that were actually read
122 by read_key_sequence. */
123 Lisp_Object raw_keybuf
;
124 int raw_keybuf_count
;
126 #define GROW_RAW_KEYBUF \
127 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
128 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 int this_single_command_key_start
;
134 /* Record values of this_command_key_count and echo_length ()
135 before this command was read. */
136 static int before_command_key_count
;
137 static int before_command_echo_length
;
139 /* For longjmp to where kbd input is being done. */
141 static jmp_buf getcjmp
;
143 /* True while doing kbd input. */
144 int waiting_for_input
;
146 /* True while displaying for echoing. Delays C-g throwing. */
150 /* Non-null means we can start echoing at the next input pause even
151 though there is something in the echo area. */
153 static struct kboard
*ok_to_echo_at_next_pause
;
155 /* The kboard last echoing, or null for none. Reset to 0 in
156 cancel_echoing. If non-null, and a current echo area message
157 exists, and echo_message_buffer is eq to the current message
158 buffer, we know that the message comes from echo_kboard. */
160 struct kboard
*echo_kboard
;
162 /* The buffer used for echoing. Set in echo_now, reset in
165 Lisp_Object echo_message_buffer
;
167 /* Nonzero means C-g should cause immediate error-signal. */
170 /* Character that causes a quit. Normally C-g.
172 If we are running on an ordinary terminal, this must be an ordinary
173 ASCII char, since we want to make it our interrupt character.
175 If we are not running on an ordinary terminal, it still needs to be
176 an ordinary ASCII char. This character needs to be recognized in
177 the input interrupt handler. At this point, the keystroke is
178 represented as a struct input_event, while the desired quit
179 character is specified as a lispy event. The mapping from struct
180 input_events to lispy events cannot run in an interrupt handler,
181 and the reverse mapping is difficult for anything but ASCII
184 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
188 /* Current depth in recursive edits. */
189 int command_loop_level
;
191 /* If not Qnil, this is a switch-frame event which we decided to put
192 off until the end of a key sequence. This should be read as the
193 next command input, after any unread_command_events.
195 read_key_sequence uses this to delay switch-frame events until the
196 end of the key sequence; Fread_char uses it to put off switch-frame
197 events until a non-ASCII event is acceptable as input. */
198 Lisp_Object unread_switch_frame
;
200 /* Last size recorded for a current buffer which is not a minibuffer. */
201 static EMACS_INT last_non_minibuf_size
;
203 /* Total number of times read_char has returned. */
204 int num_input_events
;
206 /* Value of num_nonmacro_input_events as of last auto save. */
210 /* This is like Vthis_command, except that commands never set it. */
211 Lisp_Object real_this_command
;
213 /* The value of point when the last command was started. */
214 EMACS_INT last_point_position
;
216 /* The buffer that was current when the last command was started. */
217 Lisp_Object last_point_position_buffer
;
219 /* The window that was selected when the last command was started. */
220 Lisp_Object last_point_position_window
;
222 /* The frame in which the last input event occurred, or Qmacro if the
223 last event came from a macro. We use this to determine when to
224 generate switch-frame events. This may be cleared by functions
225 like Fselect_frame, to make sure that a switch-frame event is
226 generated by the next character. */
227 Lisp_Object internal_last_event_frame
;
229 /* The timestamp of the last input event we received from the X server.
230 X Windows wants this for selection ownership. */
231 unsigned long last_event_timestamp
;
233 Lisp_Object Qx_set_selection
, QPRIMARY
, Qhandle_switch_frame
;
235 Lisp_Object Qself_insert_command
;
236 Lisp_Object Qforward_char
;
237 Lisp_Object Qbackward_char
;
238 Lisp_Object Qundefined
;
239 Lisp_Object Qtimer_event_handler
;
241 /* read_key_sequence stores here the command definition of the
242 key sequence that it reads. */
243 Lisp_Object read_key_sequence_cmd
;
245 Lisp_Object Qinput_method_function
;
247 Lisp_Object Qdeactivate_mark
;
249 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
251 Lisp_Object Qecho_area_clear_hook
;
253 /* Hooks to run before and after each command. */
254 Lisp_Object Qpre_command_hook
;
255 Lisp_Object Qpost_command_hook
;
256 Lisp_Object Qcommand_hook_internal
;
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 (int do_it_now
);
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 SIGTYPE
interrupt_signal (int signalnum
);
438 static SIGTYPE
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 SIGTYPE
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
= 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
), 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 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 (current_kboard
->echo_string
))
547 if (this_command_key_count
== 0)
550 if (!current_kboard
->immediate_echo
551 && SCHARS (current_kboard
->echo_string
) == 0)
554 /* Do nothing if we just printed a prompt. */
555 if (current_kboard
->echo_after_prompt
556 == SCHARS (current_kboard
->echo_string
))
559 /* Do nothing if we have already put a dash at the end. */
560 if (SCHARS (current_kboard
->echo_string
) > 1)
562 Lisp_Object last_char
, prev_char
, idx
;
564 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
565 prev_char
= Faref (current_kboard
->echo_string
, idx
);
567 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
568 last_char
= Faref (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 current_kboard
->echo_string
= concat2 (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 (current_kboard
->echo_string
,
620 SBYTES (current_kboard
->echo_string
),
621 STRING_MULTIBYTE (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 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 (current_kboard
->echo_string
)
651 ? SCHARS (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 (current_kboard
->echo_string
))
663 current_kboard
->echo_string
664 = Fsubstring (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 current_kboard
->Vprefix_arg
= Qnil
;
996 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
);
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 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1172 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1175 if (command_loop_level
> 0 || minibuf_level
> 0)
1176 Fthrow (Qexit
, Qnil
);
1178 error ("No recursive edit is in progress");
1181 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1182 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1185 if (command_loop_level
> 0 || minibuf_level
> 0)
1188 error ("No recursive edit is in progress");
1191 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1193 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1194 of this function. */
1197 tracking_off (Lisp_Object old_value
)
1199 do_mouse_tracking
= old_value
;
1200 if (NILP (old_value
))
1202 /* Redisplay may have been preempted because there was input
1203 available, and it assumes it will be called again after the
1204 input has been processed. If the only input available was
1205 the sort that we have just disabled, then we need to call
1207 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1209 redisplay_preserve_echo_area (6);
1210 get_input_pending (&input_pending
,
1211 READABLE_EVENTS_DO_TIMERS_NOW
);
1217 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1218 doc
: /* Evaluate BODY with mouse movement events enabled.
1219 Within a `track-mouse' form, mouse motion generates input events that
1220 you can read with `read-event'.
1221 Normally, mouse motion is ignored.
1222 usage: (track-mouse BODY...) */)
1225 int count
= SPECPDL_INDEX ();
1228 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1230 do_mouse_tracking
= Qt
;
1232 val
= Fprogn (args
);
1233 return unbind_to (count
, val
);
1236 /* If mouse has moved on some frame, return one of those frames.
1240 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1241 after resizing the tool-bar window. */
1243 int ignore_mouse_drag_p
;
1246 some_mouse_moved (void)
1248 Lisp_Object tail
, frame
;
1250 if (ignore_mouse_drag_p
)
1252 /* ignore_mouse_drag_p = 0; */
1256 FOR_EACH_FRAME (tail
, frame
)
1258 if (XFRAME (frame
)->mouse_moved
)
1259 return XFRAME (frame
);
1265 #endif /* HAVE_MOUSE || HAVE_GPM */
1267 /* This is the actual command reading loop,
1268 sans error-handling encapsulation. */
1270 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1272 void safe_run_hooks (Lisp_Object
);
1273 static void adjust_point_for_property (EMACS_INT
, int);
1275 /* Cancel hourglass from protect_unwind.
1277 #ifdef HAVE_WINDOW_SYSTEM
1279 cancel_hourglass_unwind (Lisp_Object arg
)
1281 cancel_hourglass ();
1286 /* FIXME: This is wrong rather than test window-system, we should call
1287 a new set-selection, which will then dispatch to x-set-selection, or
1288 tty-set-selection, or w32-set-selection, ... */
1289 EXFUN (Fwindow_system
, 1);
1292 command_loop_1 (void)
1295 Lisp_Object keybuf
[30];
1297 int prev_modiff
= 0;
1298 struct buffer
*prev_buffer
= NULL
;
1299 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1300 int was_locked
= single_kboard
;
1302 int already_adjusted
= 0;
1304 current_kboard
->Vprefix_arg
= Qnil
;
1305 current_kboard
->Vlast_prefix_arg
= Qnil
;
1306 Vdeactivate_mark
= Qnil
;
1307 waiting_for_input
= 0;
1310 this_command_key_count
= 0;
1311 this_command_key_count_reset
= 0;
1312 this_single_command_key_start
= 0;
1314 if (NILP (Vmemory_full
))
1316 /* Make sure this hook runs after commands that get errors and
1317 throw to top level. */
1318 /* Note that the value cell will never directly contain nil
1319 if the symbol is a local variable. */
1320 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1321 safe_run_hooks (Qpost_command_hook
);
1323 /* If displaying a message, resize the echo area window to fit
1324 that message's size exactly. */
1325 if (!NILP (echo_area_buffer
[0]))
1326 resize_echo_area_exactly ();
1328 if (!NILP (Vdeferred_action_list
))
1329 safe_run_hooks (Qdeferred_action_function
);
1332 /* Do this after running Vpost_command_hook, for consistency. */
1333 current_kboard
->Vlast_command
= Vthis_command
;
1334 current_kboard
->Vreal_last_command
= real_this_command
;
1335 if (!CONSP (last_command_event
))
1336 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1340 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1343 /* Make sure the current window's buffer is selected. */
1344 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1345 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1347 /* Display any malloc warning that just came out. Use while because
1348 displaying one warning can cause another. */
1350 while (pending_malloc_warning
)
1351 display_malloc_warning ();
1353 Vdeactivate_mark
= Qnil
;
1355 /* If minibuffer on and echo area in use,
1356 wait a short time and redraw minibuffer. */
1359 && !NILP (echo_area_buffer
[0])
1360 && EQ (minibuf_window
, echo_area_window
)
1361 && NUMBERP (Vminibuffer_message_timeout
))
1363 /* Bind inhibit-quit to t so that C-g gets read in
1364 rather than quitting back to the minibuffer. */
1365 int count
= SPECPDL_INDEX ();
1366 specbind (Qinhibit_quit
, Qt
);
1368 sit_for (Vminibuffer_message_timeout
, 0, 2);
1370 /* Clear the echo area. */
1372 safe_run_hooks (Qecho_area_clear_hook
);
1374 unbind_to (count
, Qnil
);
1376 /* If a C-g came in before, treat it as input now. */
1377 if (!NILP (Vquit_flag
))
1380 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1385 /* Select the frame that the last event came from. Usually,
1386 switch-frame events will take care of this, but if some lisp
1387 code swallows a switch-frame event, we'll fix things up here.
1388 Is this a good idea? */
1389 if (FRAMEP (internal_last_event_frame
)
1390 && !EQ (internal_last_event_frame
, selected_frame
))
1391 Fselect_frame (internal_last_event_frame
, Qnil
);
1393 /* If it has changed current-menubar from previous value,
1394 really recompute the menubar from the value. */
1395 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1396 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1397 call0 (Qrecompute_lucid_menubar
);
1399 before_command_key_count
= this_command_key_count
;
1400 before_command_echo_length
= echo_length ();
1402 Vthis_command
= Qnil
;
1403 real_this_command
= Qnil
;
1404 Vthis_original_command
= Qnil
;
1405 Vthis_command_keys_shift_translated
= Qnil
;
1407 /* Read next key sequence; i gets its length. */
1408 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1411 /* A filter may have run while we were reading the input. */
1412 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1414 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1415 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1419 /* Now we have read a key sequence of length I,
1420 or else I is 0 and we found end of file. */
1422 if (i
== 0) /* End of file -- happens only in */
1423 return Qnil
; /* a kbd macro, at the end. */
1424 /* -1 means read_key_sequence got a menu that was rejected.
1425 Just loop around and read another command. */
1429 this_command_key_count
= 0;
1430 this_command_key_count_reset
= 0;
1431 this_single_command_key_start
= 0;
1435 last_command_event
= keybuf
[i
- 1];
1437 /* If the previous command tried to force a specific window-start,
1438 forget about that, in case this command moves point far away
1439 from that position. But also throw away beg_unchanged and
1440 end_unchanged information in that case, so that redisplay will
1441 update the whole window properly. */
1442 if (!NILP (XWINDOW (selected_window
)->force_start
))
1445 XWINDOW (selected_window
)->force_start
= Qnil
;
1446 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1447 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1450 cmd
= read_key_sequence_cmd
;
1451 if (!NILP (Vexecuting_kbd_macro
))
1453 if (!NILP (Vquit_flag
))
1455 Vexecuting_kbd_macro
= Qt
;
1456 QUIT
; /* Make some noise. */
1457 /* Will return since macro now empty. */
1461 /* Do redisplay processing after this command except in special
1462 cases identified below. */
1463 prev_buffer
= current_buffer
;
1464 prev_modiff
= MODIFF
;
1465 last_point_position
= PT
;
1466 last_point_position_window
= selected_window
;
1467 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1469 /* By default, we adjust point to a boundary of a region that
1470 has such a property that should be treated intangible
1471 (e.g. composition, display). But, some commands will set
1472 this variable differently. */
1473 Vdisable_point_adjustment
= Qnil
;
1475 /* Process filters and timers may have messed with deactivate-mark.
1476 reset it before we execute the command. */
1477 Vdeactivate_mark
= Qnil
;
1479 /* Remap command through active keymaps */
1480 Vthis_original_command
= cmd
;
1484 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1488 /* Execute the command. */
1490 Vthis_command
= cmd
;
1491 real_this_command
= cmd
;
1492 /* Note that the value cell will never directly contain nil
1493 if the symbol is a local variable. */
1494 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1495 safe_run_hooks (Qpre_command_hook
);
1497 already_adjusted
= 0;
1499 if (NILP (Vthis_command
))
1501 /* nil means key is undefined. */
1502 Lisp_Object keys
= Fvector (i
, keybuf
);
1503 keys
= Fkey_description (keys
, Qnil
);
1505 message_with_string ("%s is undefined", keys
, 0);
1506 current_kboard
->defining_kbd_macro
= Qnil
;
1507 update_mode_lines
= 1;
1508 current_kboard
->Vprefix_arg
= Qnil
;
1512 /* Here for a command that isn't executed directly */
1514 #ifdef HAVE_WINDOW_SYSTEM
1515 int scount
= SPECPDL_INDEX ();
1517 if (display_hourglass_p
1518 && NILP (Vexecuting_kbd_macro
))
1520 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1525 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1527 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1529 #ifdef HAVE_WINDOW_SYSTEM
1530 /* Do not check display_hourglass_p here, because
1531 Fcommand_execute could change it, but we should cancel
1532 hourglass cursor anyway.
1533 But don't cancel the hourglass within a macro
1534 just because a command in the macro finishes. */
1535 if (NILP (Vexecuting_kbd_macro
))
1536 unbind_to (scount
, Qnil
);
1539 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1541 /* Note that the value cell will never directly contain nil
1542 if the symbol is a local variable. */
1543 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1544 safe_run_hooks (Qpost_command_hook
);
1546 /* If displaying a message, resize the echo area window to fit
1547 that message's size exactly. */
1548 if (!NILP (echo_area_buffer
[0]))
1549 resize_echo_area_exactly ();
1551 if (!NILP (Vdeferred_action_list
))
1552 safe_run_hooks (Qdeferred_action_function
);
1554 /* If there is a prefix argument,
1555 1) We don't want Vlast_command to be ``universal-argument''
1556 (that would be dumb), so don't set Vlast_command,
1557 2) we want to leave echoing on so that the prefix will be
1558 echoed as part of this key sequence, so don't call
1560 3) we want to leave this_command_key_count non-zero, so that
1561 read_char will realize that it is re-reading a character, and
1562 not echo it a second time.
1564 If the command didn't actually create a prefix arg,
1565 but is merely a frame event that is transparent to prefix args,
1566 then the above doesn't apply. */
1567 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1569 current_kboard
->Vlast_command
= Vthis_command
;
1570 current_kboard
->Vreal_last_command
= real_this_command
;
1571 if (!CONSP (last_command_event
))
1572 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1574 this_command_key_count
= 0;
1575 this_command_key_count_reset
= 0;
1576 this_single_command_key_start
= 0;
1579 if (!NILP (current_buffer
->mark_active
)
1580 && !NILP (Vrun_hooks
))
1582 /* In Emacs 22, setting transient-mark-mode to `only' was a
1583 way of turning it on for just one command. This usage is
1584 obsolete, but support it anyway. */
1585 if (EQ (Vtransient_mark_mode
, Qidentity
))
1586 Vtransient_mark_mode
= Qnil
;
1587 else if (EQ (Vtransient_mark_mode
, Qonly
))
1588 Vtransient_mark_mode
= Qidentity
;
1590 if (!NILP (Vdeactivate_mark
))
1591 /* If `select-active-regions' is non-nil, this call to
1592 `deactivate-mark' also sets the PRIMARY selection. */
1593 call0 (Qdeactivate_mark
);
1596 /* Even if not deactivating the mark, set PRIMARY if
1597 `select-active-regions' is non-nil. */
1598 if (!NILP (Fwindow_system (Qnil
))
1599 /* Even if mark_active is non-nil, the actual buffer
1600 marker may not have been set yet (Bug#7044). */
1601 && XMARKER (current_buffer
->mark
)->buffer
1602 && (EQ (Vselect_active_regions
, Qonly
)
1603 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1604 : (!NILP (Vselect_active_regions
)
1605 && !NILP (Vtransient_mark_mode
)))
1606 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1609 XINT (Fmarker_position (current_buffer
->mark
));
1612 call2 (Qx_set_selection
, QPRIMARY
,
1613 make_buffer_string (beg
, end
, 0));
1615 call2 (Qx_set_selection
, QPRIMARY
,
1616 make_buffer_string (end
, beg
, 0));
1617 /* Don't set empty selections. */
1620 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1621 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1624 Vsaved_region_selection
= Qnil
;
1629 if (current_buffer
== prev_buffer
1630 && last_point_position
!= PT
1631 && NILP (Vdisable_point_adjustment
)
1632 && NILP (Vglobal_disable_point_adjustment
))
1634 if (last_point_position
> BEGV
1635 && last_point_position
< ZV
1636 && (composition_adjust_point (last_point_position
,
1637 last_point_position
)
1638 != last_point_position
))
1639 /* The last point was temporarily set within a grapheme
1640 cluster to prevent automatic composition. To recover
1641 the automatic composition, we must update the
1643 windows_or_buffers_changed
++;
1644 if (!already_adjusted
)
1645 adjust_point_for_property (last_point_position
,
1646 MODIFF
!= prev_modiff
);
1649 /* Install chars successfully executed in kbd macro. */
1651 if (!NILP (current_kboard
->defining_kbd_macro
)
1652 && NILP (current_kboard
->Vprefix_arg
))
1653 finalize_kbd_macro_chars ();
1654 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1656 any_kboard_state ();
1661 /* Adjust point to a boundary of a region that has such a property
1662 that should be treated intangible. For the moment, we check
1663 `composition', `display' and `invisible' properties.
1664 LAST_PT is the last position of point. */
1667 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1670 Lisp_Object val
, overlay
, tmp
;
1671 /* When called after buffer modification, we should temporarily
1672 suppress the point adjustment for automatic composition so that a
1673 user can keep inserting another character at point or keep
1674 deleting characters around point. */
1675 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1676 EMACS_INT orig_pt
= PT
;
1678 /* FIXME: cycling is probably not necessary because these properties
1679 can't be usefully combined anyway. */
1680 while (check_composition
|| check_display
|| check_invisible
)
1682 /* FIXME: check `intangible'. */
1683 if (check_composition
1684 && PT
> BEGV
&& PT
< ZV
1685 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1688 check_display
= check_invisible
= 1;
1690 check_composition
= 0;
1692 && PT
> BEGV
&& PT
< ZV
1693 && !NILP (val
= get_char_property_and_overlay
1694 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1695 && display_prop_intangible_p (val
)
1696 && (!OVERLAYP (overlay
)
1697 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1698 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1699 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1700 && (beg
< PT
/* && end > PT <- It's always the case. */
1701 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1704 SET_PT (PT
< last_pt
1705 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1707 check_composition
= check_invisible
= 1;
1710 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1712 int inv
, ellipsis
= 0;
1715 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1718 /* FIXME: We should stop if we find a spot between
1719 two runs of `invisible' where inserted text would
1720 be visible. This is important when we have two
1721 invisible boundaries that enclose an area: if the
1722 area is empty, we need this test in order to make
1723 it possible to place point in the middle rather
1724 than skip both boundaries. However, this code
1725 also stops anywhere in a non-sticky text-property,
1726 which breaks (e.g.) Org mode. */
1727 && (val
= get_pos_property (make_number (end
),
1729 TEXT_PROP_MEANS_INVISIBLE (val
))
1731 && !NILP (val
= get_char_property_and_overlay
1732 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1733 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1735 ellipsis
= ellipsis
|| inv
> 1
1736 || (OVERLAYP (overlay
)
1737 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1738 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1739 tmp
= Fnext_single_char_property_change
1740 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1741 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1745 && (val
= get_pos_property (make_number (beg
),
1747 TEXT_PROP_MEANS_INVISIBLE (val
))
1749 && !NILP (val
= get_char_property_and_overlay
1750 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1751 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1753 ellipsis
= ellipsis
|| inv
> 1
1754 || (OVERLAYP (overlay
)
1755 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1756 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1757 tmp
= Fprevious_single_char_property_change
1758 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1759 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1762 /* Move away from the inside area. */
1763 if (beg
< PT
&& end
> PT
)
1765 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1766 /* We haven't moved yet (so we don't need to fear
1767 infinite-looping) and we were outside the range
1768 before (so either end of the range still corresponds
1769 to a move in the right direction): pretend we moved
1770 less than we actually did, so that we still have
1771 more freedom below in choosing which end of the range
1773 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1774 /* We either have moved already or the last point
1775 was already in the range: we don't get to choose
1776 which end of the range we have to go to. */
1777 : (PT
< last_pt
? beg
: end
));
1778 check_composition
= check_display
= 1;
1780 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1781 the point to something other than its argument, due to
1782 point-motion hooks, intangibility, etc. */
1783 xassert (PT
== beg
|| PT
== end
);
1786 /* Pretend the area doesn't exist if the buffer is not
1788 if (!modified
&& !ellipsis
&& beg
< end
)
1790 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1791 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1792 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1793 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1794 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1795 /* We've already moved as far as we can. Trying to go
1796 to the other end would mean moving backwards and thus
1797 could lead to an infinite loop. */
1799 else if (val
= get_pos_property (make_number (PT
),
1801 TEXT_PROP_MEANS_INVISIBLE (val
)
1802 && (val
= get_pos_property
1803 (make_number (PT
== beg
? end
: beg
),
1805 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1806 (check_composition
= check_display
= 1,
1807 SET_PT (PT
== beg
? end
: beg
));
1810 check_invisible
= 0;
1814 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1817 safe_run_hooks_1 (void)
1819 if (NILP (Vrun_hooks
))
1821 return call1 (Vrun_hooks
, Vinhibit_quit
);
1824 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1827 safe_run_hooks_error (Lisp_Object data
)
1829 Lisp_Object args
[3];
1830 args
[0] = build_string ("Error in %s: %s");
1831 args
[1] = Vinhibit_quit
;
1834 return Fset (Vinhibit_quit
, Qnil
);
1837 /* If we get an error while running the hook, cause the hook variable
1838 to be nil. Also inhibit quits, so that C-g won't cause the hook
1839 to mysteriously evaporate. */
1842 safe_run_hooks (Lisp_Object hook
)
1844 int count
= SPECPDL_INDEX ();
1845 specbind (Qinhibit_quit
, hook
);
1847 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1849 unbind_to (count
, Qnil
);
1853 /* Nonzero means polling for input is temporarily suppressed. */
1855 int poll_suppress_count
;
1857 /* Asynchronous timer for polling. */
1859 struct atimer
*poll_timer
;
1862 #ifdef POLL_FOR_INPUT
1864 /* Poll for input, so that we catch a C-g if it comes in. This
1865 function is called from x_make_frame_visible, see comment
1869 poll_for_input_1 (void)
1871 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1872 doing anything dangerous. */
1876 if (interrupt_input_blocked
== 0
1877 && !waiting_for_input
)
1878 read_avail_input (0);
1884 /* Timer callback function for poll_timer. TIMER is equal to
1888 poll_for_input (struct atimer
*timer
)
1890 if (poll_suppress_count
== 0)
1893 interrupt_input_pending
= 1;
1894 pending_signals
= 1;
1896 poll_for_input_1 ();
1901 #endif /* POLL_FOR_INPUT */
1903 /* Begin signals to poll for input, if they are appropriate.
1904 This function is called unconditionally from various places. */
1907 start_polling (void)
1909 #ifdef POLL_FOR_INPUT
1910 /* XXX This condition was (read_socket_hook && !interrupt_input),
1911 but read_socket_hook is not global anymore. Let's pretend that
1913 if (!interrupt_input
)
1915 /* Turn alarm handling on unconditionally. It might have
1916 been turned off in process.c. */
1917 turn_on_atimers (1);
1919 /* If poll timer doesn't exist, are we need one with
1920 a different interval, start a new one. */
1921 if (poll_timer
== NULL
1922 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1924 EMACS_TIME interval
;
1927 cancel_atimer (poll_timer
);
1929 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1930 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1931 poll_for_input
, NULL
);
1934 /* Let the timer's callback function poll for input
1935 if this becomes zero. */
1936 --poll_suppress_count
;
1941 /* Nonzero if we are using polling to handle input asynchronously. */
1944 input_polling_used (void)
1946 #ifdef POLL_FOR_INPUT
1947 /* XXX This condition was (read_socket_hook && !interrupt_input),
1948 but read_socket_hook is not global anymore. Let's pretend that
1950 return !interrupt_input
;
1956 /* Turn off polling. */
1961 #ifdef POLL_FOR_INPUT
1962 /* XXX This condition was (read_socket_hook && !interrupt_input),
1963 but read_socket_hook is not global anymore. Let's pretend that
1965 if (!interrupt_input
)
1966 ++poll_suppress_count
;
1970 /* Set the value of poll_suppress_count to COUNT
1971 and start or stop polling accordingly. */
1974 set_poll_suppress_count (int count
)
1976 #ifdef POLL_FOR_INPUT
1977 if (count
== 0 && poll_suppress_count
!= 0)
1979 poll_suppress_count
= 1;
1982 else if (count
!= 0 && poll_suppress_count
== 0)
1986 poll_suppress_count
= count
;
1990 /* Bind polling_period to a value at least N.
1991 But don't decrease it. */
1994 bind_polling_period (int n
)
1996 #ifdef POLL_FOR_INPUT
1997 int new = polling_period
;
2002 stop_other_atimers (poll_timer
);
2004 specbind (Qpolling_period
, make_number (new));
2005 /* Start a new alarm with the new period. */
2010 /* Apply the control modifier to CHARACTER. */
2013 make_ctrl_char (int c
)
2015 /* Save the upper bits here. */
2016 int upper
= c
& ~0177;
2018 if (! ASCII_BYTE_P (c
))
2019 return c
|= ctrl_modifier
;
2023 /* Everything in the columns containing the upper-case letters
2024 denotes a control character. */
2025 if (c
>= 0100 && c
< 0140)
2029 /* Set the shift modifier for a control char
2030 made from a shifted letter. But only for letters! */
2031 if (oc
>= 'A' && oc
<= 'Z')
2032 c
|= shift_modifier
;
2035 /* The lower-case letters denote control characters too. */
2036 else if (c
>= 'a' && c
<= 'z')
2039 /* Include the bits for control and shift
2040 only if the basic ASCII code can't indicate them. */
2044 /* Replace the high bits. */
2045 c
|= (upper
& ~ctrl_modifier
);
2050 /* Display the help-echo property of the character after the mouse pointer.
2051 Either show it in the echo area, or call show-help-function to display
2052 it by other means (maybe in a tooltip).
2054 If HELP is nil, that means clear the previous help echo.
2056 If HELP is a string, display that string. If HELP is a function,
2057 call it with OBJECT and POS as arguments; the function should
2058 return a help string or nil for none. For all other types of HELP,
2059 evaluate it to obtain a string.
2061 WINDOW is the window in which the help was generated, if any.
2062 It is nil if not in a window.
2064 If OBJECT is a buffer, POS is the position in the buffer where the
2065 `help-echo' text property was found.
2067 If OBJECT is an overlay, that overlay has a `help-echo' property,
2068 and POS is the position in the overlay's buffer under the mouse.
2070 If OBJECT is a string (an overlay string or a string displayed with
2071 the `display' property). POS is the position in that string under
2074 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2075 echo overwrites a keystroke echo currently displayed in the echo
2078 Note: this function may only be called with HELP nil or a string
2079 from X code running asynchronously. */
2082 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2083 Lisp_Object pos
, int ok_to_overwrite_keystroke_echo
)
2085 if (!NILP (help
) && !STRINGP (help
))
2087 if (FUNCTIONP (help
))
2089 Lisp_Object args
[4];
2094 help
= safe_call (4, args
);
2097 help
= safe_eval (help
);
2099 if (!STRINGP (help
))
2103 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2104 if (!noninteractive
&& STRINGP (help
))
2106 /* The mouse-fixup-help-message Lisp function can call
2107 mouse_position_hook, which resets the mouse_moved flags.
2108 This causes trouble if we are trying to read a mouse motion
2109 event (i.e., if we are inside a `track-mouse' form), so we
2110 restore the mouse_moved flag. */
2111 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2112 help
= call1 (Qmouse_fixup_help_message
, help
);
2118 if (STRINGP (help
) || NILP (help
))
2120 if (!NILP (Vshow_help_function
))
2121 call1 (Vshow_help_function
, help
);
2122 help_echo_showing_p
= STRINGP (help
);
2128 /* Input of single characters from keyboard */
2130 Lisp_Object
print_help (Lisp_Object object
);
2131 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2132 struct timeval
*end_time
);
2133 static void record_char (Lisp_Object c
);
2135 static Lisp_Object help_form_saved_window_configs
;
2137 read_char_help_form_unwind (Lisp_Object arg
)
2139 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2140 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2141 if (!NILP (window_config
))
2142 Fset_window_configuration (window_config
);
2146 #define STOP_POLLING \
2147 do { if (! polling_stopped_here) stop_polling (); \
2148 polling_stopped_here = 1; } while (0)
2150 #define RESUME_POLLING \
2151 do { if (polling_stopped_here) start_polling (); \
2152 polling_stopped_here = 0; } while (0)
2154 /* read a character from the keyboard; call the redisplay if needed */
2155 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2156 -1 means do not do redisplay, but do do autosaving.
2159 /* The arguments MAPS and NMAPS are for menu prompting.
2160 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2162 PREV_EVENT is the previous input event, or nil if we are reading
2163 the first event of a key sequence (or not reading a key sequence).
2164 If PREV_EVENT is t, that is a "magic" value that says
2165 not to run input methods, but in other respects to act as if
2166 not reading a key sequence.
2168 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2169 if we used a mouse menu to read the input, or zero otherwise. If
2170 USED_MOUSE_MENU is null, we don't dereference it.
2172 Value is -2 when we find input on another keyboard. A second call
2173 to read_char will read it.
2175 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2176 specifying the maximum time to wait until. If no input arrives by
2177 that time, stop waiting and return nil.
2179 Value is t if we showed a menu and the user rejected it. */
2182 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2183 int *used_mouse_menu
, struct timeval
*end_time
)
2185 volatile Lisp_Object c
;
2186 int count
, jmpcount
;
2187 jmp_buf local_getcjmp
;
2189 volatile int key_already_recorded
= 0;
2190 Lisp_Object tem
, save
;
2191 volatile Lisp_Object previous_echo_area_message
;
2192 volatile Lisp_Object also_record
;
2193 volatile int reread
;
2194 struct gcpro gcpro1
, gcpro2
;
2195 int polling_stopped_here
= 0;
2196 struct kboard
*orig_kboard
= current_kboard
;
2200 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2201 before_command_key_count
= this_command_key_count
;
2202 before_command_echo_length
= echo_length ();
2205 previous_echo_area_message
= Qnil
;
2207 GCPRO2 (c
, previous_echo_area_message
);
2212 if (CONSP (Vunread_post_input_method_events
))
2214 c
= XCAR (Vunread_post_input_method_events
);
2215 Vunread_post_input_method_events
2216 = XCDR (Vunread_post_input_method_events
);
2218 /* Undo what read_char_x_menu_prompt did when it unread
2219 additional keys returned by Fx_popup_menu. */
2221 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2229 if (unread_command_char
!= -1)
2231 XSETINT (c
, unread_command_char
);
2232 unread_command_char
= -1;
2238 if (CONSP (Vunread_command_events
))
2240 int was_disabled
= 0;
2242 c
= XCAR (Vunread_command_events
);
2243 Vunread_command_events
= XCDR (Vunread_command_events
);
2247 /* Undo what sit-for did when it unread additional keys
2248 inside universal-argument. */
2251 && EQ (XCAR (c
), Qt
))
2257 /* Undo what read_char_x_menu_prompt did when it unread
2258 additional keys returned by Fx_popup_menu. */
2260 && EQ (XCDR (c
), Qdisabled
)
2261 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2267 /* If the queued event is something that used the mouse,
2268 set used_mouse_menu accordingly. */
2270 /* Also check was_disabled so last-nonmenu-event won't return
2271 a bad value when submenus are involved. (Bug#447) */
2272 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2273 *used_mouse_menu
= 1;
2275 goto reread_for_input_method
;
2278 if (CONSP (Vunread_input_method_events
))
2280 c
= XCAR (Vunread_input_method_events
);
2281 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2283 /* Undo what read_char_x_menu_prompt did when it unread
2284 additional keys returned by Fx_popup_menu. */
2286 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2290 goto reread_for_input_method
;
2293 this_command_key_count_reset
= 0;
2295 if (!NILP (Vexecuting_kbd_macro
))
2297 /* We set this to Qmacro; since that's not a frame, nobody will
2298 try to switch frames on us, and the selected window will
2301 Since this event came from a macro, it would be misleading to
2302 leave internal_last_event_frame set to wherever the last
2303 real event came from. Normally, a switch-frame event selects
2304 internal_last_event_frame after each command is read, but
2305 events read from a macro should never cause a new frame to be
2307 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2309 /* Exit the macro if we are at the end.
2310 Also, some things replace the macro with t
2311 to force an early exit. */
2312 if (EQ (Vexecuting_kbd_macro
, Qt
)
2313 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2319 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2320 if (STRINGP (Vexecuting_kbd_macro
)
2321 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2322 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2324 executing_kbd_macro_index
++;
2329 if (!NILP (unread_switch_frame
))
2331 c
= unread_switch_frame
;
2332 unread_switch_frame
= Qnil
;
2334 /* This event should make it into this_command_keys, and get echoed
2335 again, so we do not set `reread'. */
2339 /* if redisplay was requested */
2340 if (commandflag
>= 0)
2342 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2344 /* If there is pending input, process any events which are not
2345 user-visible, such as X selection_request events. */
2347 || detect_input_pending_run_timers (0))
2348 swallow_events (0); /* may clear input_pending */
2350 /* Redisplay if no pending input. */
2351 while (!input_pending
)
2353 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2354 redisplay_preserve_echo_area (5);
2359 /* Normal case: no input arrived during redisplay. */
2362 /* Input arrived and pre-empted redisplay.
2363 Process any events which are not user-visible. */
2365 /* If that cleared input_pending, try again to redisplay. */
2368 /* Prevent the redisplay we just did
2369 from messing up echoing of the input after the prompt. */
2370 if (commandflag
== 0 && echo_current
)
2371 echo_message_buffer
= echo_area_buffer
[0];
2375 /* Message turns off echoing unless more keystrokes turn it on again.
2377 The code in 20.x for the condition was
2379 1. echo_area_glyphs && *echo_area_glyphs
2380 2. && echo_area_glyphs != current_kboard->echobuf
2381 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2383 (1) means there's a current message displayed
2385 (2) means it's not the message from echoing from the current
2388 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2389 is set to a non-null value. This is done in read_char and it is
2390 set to echo_area_glyphs after a call to echo_char. That means
2391 ok_to_echo_at_next_pause is either null or
2392 current_kboard->echobuf with the appropriate current_kboard at
2395 So, condition (3) means in clear text ok_to_echo_at_next_pause
2396 must be either null, or the current message isn't from echoing at
2397 all, or it's from echoing from a different kboard than the
2400 if (/* There currently is something in the echo area. */
2401 !NILP (echo_area_buffer
[0])
2402 && (/* And it's either not from echoing. */
2403 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2404 /* Or it's an echo from a different kboard. */
2405 || echo_kboard
!= current_kboard
2406 /* Or we explicitly allow overwriting whatever there is. */
2407 || ok_to_echo_at_next_pause
== NULL
))
2412 /* Try reading a character via menu prompting in the minibuf.
2413 Try this before the sit-for, because the sit-for
2414 would do the wrong thing if we are supposed to do
2415 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2416 after a mouse event so don't try a minibuf menu. */
2418 if (nmaps
> 0 && INTERACTIVE
2419 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2420 /* Don't bring up a menu if we already have another event. */
2421 && NILP (Vunread_command_events
)
2422 && unread_command_char
< 0
2423 && !detect_input_pending_run_timers (0))
2425 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2427 if (INTEGERP (c
) && XINT (c
) == -2)
2428 return c
; /* wrong_kboard_jmpbuf */
2432 key_already_recorded
= 1;
2437 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2438 We will do that below, temporarily for short sections of code,
2439 when appropriate. local_getcjmp must be in effect
2440 around any call to sit_for or kbd_buffer_get_event;
2441 it *must not* be in effect when we call redisplay. */
2443 jmpcount
= SPECPDL_INDEX ();
2444 if (_setjmp (local_getcjmp
))
2446 /* Handle quits while reading the keyboard. */
2447 /* We must have saved the outer value of getcjmp here,
2448 so restore it now. */
2449 restore_getcjmp (save_jump
);
2450 unbind_to (jmpcount
, Qnil
);
2451 XSETINT (c
, quit_char
);
2452 internal_last_event_frame
= selected_frame
;
2453 Vlast_event_frame
= internal_last_event_frame
;
2454 /* If we report the quit char as an event,
2455 don't do so more than once. */
2456 if (!NILP (Vinhibit_quit
))
2460 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2461 if (kb
!= current_kboard
)
2463 Lisp_Object link
= kb
->kbd_queue
;
2464 /* We shouldn't get here if we were in single-kboard mode! */
2469 while (CONSP (XCDR (link
)))
2471 if (!NILP (XCDR (link
)))
2475 kb
->kbd_queue
= Fcons (c
, Qnil
);
2477 XSETCDR (link
, Fcons (c
, Qnil
));
2478 kb
->kbd_queue_has_data
= 1;
2479 current_kboard
= kb
;
2480 /* This is going to exit from read_char
2481 so we had better get rid of this frame's stuff. */
2483 return make_number (-2); /* wrong_kboard_jmpbuf */
2489 /* Start idle timers if no time limit is supplied. We don't do it
2490 if a time limit is supplied to avoid an infinite recursion in the
2491 situation where an idle timer calls `sit-for'. */
2494 timer_start_idle ();
2496 /* If in middle of key sequence and minibuffer not active,
2497 start echoing if enough time elapses. */
2499 if (minibuf_level
== 0
2501 && !current_kboard
->immediate_echo
2502 && this_command_key_count
> 0
2504 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2505 && NILP (Fzerop (Vecho_keystrokes
))
2506 && (/* No message. */
2507 NILP (echo_area_buffer
[0])
2508 /* Or empty message. */
2509 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2510 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2511 /* Or already echoing from same kboard. */
2512 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2513 /* Or not echoing before and echoing allowed. */
2514 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2516 /* After a mouse event, start echoing right away.
2517 This is because we are probably about to display a menu,
2518 and we don't want to delay before doing so. */
2519 if (EVENT_HAS_PARAMETERS (prev_event
))
2525 save_getcjmp (save_jump
);
2526 restore_getcjmp (local_getcjmp
);
2527 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2528 restore_getcjmp (save_jump
);
2530 && ! CONSP (Vunread_command_events
))
2535 /* Maybe auto save due to number of keystrokes. */
2537 if (commandflag
!= 0
2538 && auto_save_interval
> 0
2539 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2540 && !detect_input_pending_run_timers (0))
2542 Fdo_auto_save (Qnil
, Qnil
);
2543 /* Hooks can actually change some buffers in auto save. */
2547 /* Try reading using an X menu.
2548 This is never confused with reading using the minibuf
2549 because the recursive call of read_char in read_char_minibuf_menu_prompt
2550 does not pass on any keymaps. */
2552 if (nmaps
> 0 && INTERACTIVE
2553 && !NILP (prev_event
)
2554 && EVENT_HAS_PARAMETERS (prev_event
)
2555 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2556 && !EQ (XCAR (prev_event
), Qtool_bar
)
2557 /* Don't bring up a menu if we already have another event. */
2558 && NILP (Vunread_command_events
)
2559 && unread_command_char
< 0)
2561 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2563 /* Now that we have read an event, Emacs is not idle. */
2570 /* Maybe autosave and/or garbage collect due to idleness. */
2572 if (INTERACTIVE
&& NILP (c
))
2575 EMACS_INT buffer_size
;
2577 /* Slow down auto saves logarithmically in size of current buffer,
2578 and garbage collect while we're at it. */
2579 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2580 last_non_minibuf_size
= Z
- BEG
;
2581 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2583 while (buffer_size
> 64)
2584 delay_level
++, buffer_size
-= buffer_size
>> 2;
2585 if (delay_level
< 4) delay_level
= 4;
2586 /* delay_level is 4 for files under around 50k, 7 at 100k,
2587 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2589 /* Auto save if enough time goes by without input. */
2590 if (commandflag
!= 0
2591 && num_nonmacro_input_events
> last_auto_save
2592 && INTEGERP (Vauto_save_timeout
)
2593 && XINT (Vauto_save_timeout
) > 0)
2596 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2598 save_getcjmp (save_jump
);
2599 restore_getcjmp (local_getcjmp
);
2600 tem0
= sit_for (make_number (timeout
), 1, 1);
2601 restore_getcjmp (save_jump
);
2604 && ! CONSP (Vunread_command_events
))
2606 Fdo_auto_save (Qnil
, Qnil
);
2608 /* If we have auto-saved and there is still no input
2609 available, garbage collect if there has been enough
2610 consing going on to make it worthwhile. */
2611 if (!detect_input_pending_run_timers (0)
2612 && consing_since_gc
> gc_cons_threshold
/ 2)
2613 Fgarbage_collect ();
2620 /* Notify the caller if an autosave hook, or a timer, sentinel or
2621 filter in the sit_for calls above have changed the current
2622 kboard. This could happen if they use the minibuffer or start a
2623 recursive edit, like the fancy splash screen in server.el's
2624 filter. If this longjmp wasn't here, read_key_sequence would
2625 interpret the next key sequence using the wrong translation
2626 tables and function keymaps. */
2627 if (NILP (c
) && current_kboard
!= orig_kboard
)
2630 return make_number (-2); /* wrong_kboard_jmpbuf */
2633 /* If this has become non-nil here, it has been set by a timer
2634 or sentinel or filter. */
2635 if (CONSP (Vunread_command_events
))
2637 c
= XCAR (Vunread_command_events
);
2638 Vunread_command_events
= XCDR (Vunread_command_events
);
2641 /* Read something from current KBOARD's side queue, if possible. */
2645 if (current_kboard
->kbd_queue_has_data
)
2647 if (!CONSP (current_kboard
->kbd_queue
))
2649 c
= XCAR (current_kboard
->kbd_queue
);
2650 current_kboard
->kbd_queue
2651 = XCDR (current_kboard
->kbd_queue
);
2652 if (NILP (current_kboard
->kbd_queue
))
2653 current_kboard
->kbd_queue_has_data
= 0;
2654 input_pending
= readable_events (0);
2655 if (EVENT_HAS_PARAMETERS (c
)
2656 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2657 internal_last_event_frame
= XCAR (XCDR (c
));
2658 Vlast_event_frame
= internal_last_event_frame
;
2662 /* If current_kboard's side queue is empty check the other kboards.
2663 If one of them has data that we have not yet seen here,
2664 switch to it and process the data waiting for it.
2666 Note: if the events queued up for another kboard
2667 have already been seen here, and therefore are not a complete command,
2668 the kbd_queue_has_data field is 0, so we skip that kboard here.
2669 That's to avoid an infinite loop switching between kboards here. */
2670 if (NILP (c
) && !single_kboard
)
2673 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2674 if (kb
->kbd_queue_has_data
)
2676 current_kboard
= kb
;
2677 /* This is going to exit from read_char
2678 so we had better get rid of this frame's stuff. */
2680 return make_number (-2); /* wrong_kboard_jmpbuf */
2688 /* Finally, we read from the main queue,
2689 and if that gives us something we can't use yet, we put it on the
2690 appropriate side queue and try again. */
2699 EMACS_GET_TIME (now
);
2700 if (EMACS_TIME_GE (now
, *end_time
))
2704 /* Actually read a character, waiting if necessary. */
2705 save_getcjmp (save_jump
);
2706 restore_getcjmp (local_getcjmp
);
2708 timer_start_idle ();
2709 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2710 restore_getcjmp (save_jump
);
2712 if (! NILP (c
) && (kb
!= current_kboard
))
2714 Lisp_Object link
= kb
->kbd_queue
;
2717 while (CONSP (XCDR (link
)))
2719 if (!NILP (XCDR (link
)))
2723 kb
->kbd_queue
= Fcons (c
, Qnil
);
2725 XSETCDR (link
, Fcons (c
, Qnil
));
2726 kb
->kbd_queue_has_data
= 1;
2730 current_kboard
= kb
;
2731 /* This is going to exit from read_char
2732 so we had better get rid of this frame's stuff. */
2734 return make_number (-2);
2738 /* Terminate Emacs in batch mode if at eof. */
2739 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2740 Fkill_emacs (make_number (1));
2744 /* Add in any extra modifiers, where appropriate. */
2745 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2746 || ((extra_keyboard_modifiers
& 0177) < ' '
2747 && (extra_keyboard_modifiers
& 0177) != 0))
2748 XSETINT (c
, make_ctrl_char (XINT (c
)));
2750 /* Transfer any other modifier bits directly from
2751 extra_keyboard_modifiers to c. Ignore the actual character code
2752 in the low 16 bits of extra_keyboard_modifiers. */
2753 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2764 if (commandflag
>= 0
2765 && !input_pending
&& !detect_input_pending_run_timers (0))
2773 /* Buffer switch events are only for internal wakeups
2774 so don't show them to the user.
2775 Also, don't record a key if we already did. */
2776 if (BUFFERP (c
) || key_already_recorded
)
2779 /* Process special events within read_char
2780 and loop around to read another event. */
2783 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2788 struct buffer
*prev_buffer
= current_buffer
;
2789 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2790 int was_locked
= single_kboard
;
2791 int count
= SPECPDL_INDEX ();
2792 record_single_kboard_state ();
2795 last_input_event
= c
;
2796 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2798 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2799 /* We stopped being idle for this event; undo that. This
2800 prevents automatic window selection (under
2801 mouse_autoselect_window from acting as a real input event, for
2802 example banishing the mouse under mouse-avoidance-mode. */
2803 timer_resume_idle ();
2805 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2806 /* Resume allowing input from any kboard, if that was true before. */
2808 any_kboard_state ();
2809 unbind_to (count
, Qnil
);
2812 if (current_buffer
!= prev_buffer
)
2814 /* The command may have changed the keymaps. Pretend there
2815 is input in another keyboard and return. This will
2816 recalculate keymaps. */
2817 c
= make_number (-2);
2824 /* Handle things that only apply to characters. */
2827 /* If kbd_buffer_get_event gave us an EOF, return that. */
2831 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
2832 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2833 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
2834 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2835 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
2839 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
2840 /* nil in keyboard-translate-table means no translation. */
2846 /* If this event is a mouse click in the menu bar,
2847 return just menu-bar for now. Modify the mouse click event
2848 so we won't do this twice, then queue it up. */
2849 if (EVENT_HAS_PARAMETERS (c
)
2851 && CONSP (EVENT_START (c
))
2852 && CONSP (XCDR (EVENT_START (c
))))
2856 posn
= POSN_POSN (EVENT_START (c
));
2857 /* Handle menu-bar events:
2858 insert the dummy prefix event `menu-bar'. */
2859 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2861 /* Change menu-bar to (menu-bar) as the event "position". */
2862 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2865 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2870 /* Store these characters into recent_keys, the dribble file if any,
2871 and the keyboard macro being defined, if any. */
2873 if (! NILP (also_record
))
2874 record_char (also_record
);
2876 /* Wipe the echo area.
2877 But first, if we are about to use an input method,
2878 save the echo area contents for it to refer to. */
2880 && ! NILP (Vinput_method_function
)
2881 && (unsigned) XINT (c
) >= ' '
2882 && (unsigned) XINT (c
) != 127
2883 && (unsigned) XINT (c
) < 256)
2885 previous_echo_area_message
= Fcurrent_message ();
2886 Vinput_method_previous_message
= previous_echo_area_message
;
2889 /* Now wipe the echo area, except for help events which do their
2890 own stuff with the echo area. */
2892 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2893 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2895 if (!NILP (echo_area_buffer
[0]))
2896 safe_run_hooks (Qecho_area_clear_hook
);
2897 clear_message (1, 0);
2900 reread_for_input_method
:
2902 /* Pass this to the input method, if appropriate. */
2904 && ! NILP (Vinput_method_function
)
2905 /* Don't run the input method within a key sequence,
2906 after the first event of the key sequence. */
2907 && NILP (prev_event
)
2908 && (unsigned) XINT (c
) >= ' '
2909 && (unsigned) XINT (c
) != 127
2910 && (unsigned) XINT (c
) < 256)
2913 int key_count
, key_count_reset
;
2914 struct gcpro gcpro1
;
2915 int count
= SPECPDL_INDEX ();
2917 /* Save the echo status. */
2918 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2919 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2920 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
2921 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2924 if (before_command_restore_flag
)
2926 this_command_key_count
= before_command_key_count_1
;
2927 if (this_command_key_count
< this_single_command_key_start
)
2928 this_single_command_key_start
= this_command_key_count
;
2929 echo_truncate (before_command_echo_length_1
);
2930 before_command_restore_flag
= 0;
2934 /* Save the this_command_keys status. */
2935 key_count
= this_command_key_count
;
2936 key_count_reset
= this_command_key_count_reset
;
2939 keys
= Fcopy_sequence (this_command_keys
);
2944 /* Clear out this_command_keys. */
2945 this_command_key_count
= 0;
2946 this_command_key_count_reset
= 0;
2948 /* Now wipe the echo area. */
2949 if (!NILP (echo_area_buffer
[0]))
2950 safe_run_hooks (Qecho_area_clear_hook
);
2951 clear_message (1, 0);
2954 /* If we are not reading a key sequence,
2955 never use the echo area. */
2958 specbind (Qinput_method_use_echo_area
, Qt
);
2961 /* Call the input method. */
2962 tem
= call1 (Vinput_method_function
, c
);
2964 tem
= unbind_to (count
, tem
);
2966 /* Restore the saved echoing state
2967 and this_command_keys state. */
2968 this_command_key_count
= key_count
;
2969 this_command_key_count_reset
= key_count_reset
;
2971 this_command_keys
= keys
;
2974 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2975 current_kboard
->echo_string
= saved_echo_string
;
2976 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2977 if (saved_immediate_echo
)
2982 /* The input method can return no events. */
2985 /* Bring back the previous message, if any. */
2986 if (! NILP (previous_echo_area_message
))
2987 message_with_string ("%s", previous_echo_area_message
, 0);
2990 /* It returned one event or more. */
2992 Vunread_post_input_method_events
2993 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2998 /* Display help if not echoing. */
2999 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3001 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3002 Lisp_Object help
, object
, position
, window
, tem
;
3004 tem
= Fcdr (XCDR (c
));
3007 window
= Fcar (tem
);
3009 object
= Fcar (tem
);
3011 position
= Fcar (tem
);
3013 show_help_echo (help
, window
, object
, position
, 0);
3015 /* We stopped being idle for this event; undo that. */
3017 timer_resume_idle ();
3021 if ((! reread
|| this_command_key_count
== 0
3022 || this_command_key_count_reset
)
3026 /* Don't echo mouse motion events. */
3027 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3028 && NILP (Fzerop (Vecho_keystrokes
))
3029 && ! (EVENT_HAS_PARAMETERS (c
)
3030 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3033 if (! NILP (also_record
))
3034 echo_char (also_record
);
3035 /* Once we reread a character, echoing can happen
3036 the next time we pause to read a new one. */
3037 ok_to_echo_at_next_pause
= current_kboard
;
3040 /* Record this character as part of the current key. */
3041 add_command_key (c
);
3042 if (! NILP (also_record
))
3043 add_command_key (also_record
);
3046 last_input_event
= c
;
3049 /* Process the help character specially if enabled */
3050 if (!NILP (Vhelp_form
) && help_char_p (c
))
3053 count
= SPECPDL_INDEX ();
3055 help_form_saved_window_configs
3056 = Fcons (Fcurrent_window_configuration (Qnil
),
3057 help_form_saved_window_configs
);
3058 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3060 tem0
= Feval (Vhelp_form
);
3062 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3067 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3068 if (EVENT_HAS_PARAMETERS (c
)
3069 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3070 XSETCAR (help_form_saved_window_configs
, Qnil
);
3072 while (BUFFERP (c
));
3073 /* Remove the help from the frame */
3074 unbind_to (count
, Qnil
);
3077 if (EQ (c
, make_number (040)))
3081 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3082 while (BUFFERP (c
));
3091 /* Record a key that came from a mouse menu.
3092 Record it for echoing, for this-command-keys, and so on. */
3095 record_menu_key (Lisp_Object c
)
3097 /* Wipe the echo area. */
3098 clear_message (1, 0);
3103 before_command_key_count
= this_command_key_count
;
3104 before_command_echo_length
= echo_length ();
3107 /* Don't echo mouse motion events. */
3108 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3109 && NILP (Fzerop (Vecho_keystrokes
)))
3113 /* Once we reread a character, echoing can happen
3114 the next time we pause to read a new one. */
3115 ok_to_echo_at_next_pause
= 0;
3118 /* Record this character as part of the current key. */
3119 add_command_key (c
);
3121 /* Re-reading in the middle of a command */
3122 last_input_event
= c
;
3126 /* Return 1 if should recognize C as "the help character". */
3129 help_char_p (Lisp_Object c
)
3133 if (EQ (c
, Vhelp_char
))
3135 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3136 if (EQ (c
, XCAR (tail
)))
3141 /* Record the input event C in various ways. */
3144 record_char (Lisp_Object c
)
3148 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3150 /* To avoid filling recent_keys with help-echo and mouse-movement
3151 events, we filter out repeated help-echo events, only store the
3152 first and last in a series of mouse-movement events, and don't
3153 store repeated help-echo events which are only separated by
3154 mouse-movement events. */
3156 Lisp_Object ev1
, ev2
, ev3
;
3159 if ((ix1
= recent_keys_index
- 1) < 0)
3160 ix1
= NUM_RECENT_KEYS
- 1;
3161 ev1
= AREF (recent_keys
, ix1
);
3163 if ((ix2
= ix1
- 1) < 0)
3164 ix2
= NUM_RECENT_KEYS
- 1;
3165 ev2
= AREF (recent_keys
, ix2
);
3167 if ((ix3
= ix2
- 1) < 0)
3168 ix3
= NUM_RECENT_KEYS
- 1;
3169 ev3
= AREF (recent_keys
, ix3
);
3171 if (EQ (XCAR (c
), Qhelp_echo
))
3173 /* Don't record `help-echo' in recent_keys unless it shows some help
3174 message, and a different help than the previously recorded
3176 Lisp_Object help
, last_help
;
3178 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3179 if (!STRINGP (help
))
3181 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3182 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3184 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3185 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3186 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3188 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3189 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3190 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3191 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3194 else if (EQ (XCAR (c
), Qmouse_movement
))
3196 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3197 So additional mouse movement events replace the last element. */
3198 Lisp_Object last_window
, window
;
3200 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3201 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3202 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3203 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3204 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3206 ASET (recent_keys
, ix1
, c
);
3212 store_kbd_macro_char (c
);
3217 ASET (recent_keys
, recent_keys_index
, c
);
3218 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3219 recent_keys_index
= 0;
3221 else if (recorded
< 0)
3223 /* We need to remove one or two events from recent_keys.
3224 To do this, we simply put nil at those events and move the
3225 recent_keys_index backwards over those events. Usually,
3226 users will never see those nil events, as they will be
3227 overwritten by the command keys entered to see recent_keys
3230 while (recorded
++ < 0 && total_keys
> 0)
3232 if (total_keys
< NUM_RECENT_KEYS
)
3234 if (--recent_keys_index
< 0)
3235 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3236 ASET (recent_keys
, recent_keys_index
, Qnil
);
3240 num_nonmacro_input_events
++;
3242 /* Write c to the dribble file. If c is a lispy event, write
3243 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3244 If you, dear reader, have a better idea, you've got the source. :-) */
3250 if (XUINT (c
) < 0x100)
3251 putc (XINT (c
), dribble
);
3253 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3257 Lisp_Object dribblee
;
3259 /* If it's a structured event, take the event header. */
3260 dribblee
= EVENT_HEAD (c
);
3262 if (SYMBOLP (dribblee
))
3264 putc ('<', dribble
);
3265 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3266 SBYTES (SYMBOL_NAME (dribblee
)),
3268 putc ('>', dribble
);
3278 print_help (Lisp_Object object
)
3280 struct buffer
*old
= current_buffer
;
3281 Fprinc (object
, Qnil
);
3282 set_buffer_internal (XBUFFER (Vstandard_output
));
3283 call0 (intern ("help-mode"));
3284 set_buffer_internal (old
);
3288 /* Copy out or in the info on where C-g should throw to.
3289 This is used when running Lisp code from within get_char,
3290 in case get_char is called recursively.
3291 See read_process_output. */
3294 save_getcjmp (jmp_buf temp
)
3296 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3300 restore_getcjmp (jmp_buf temp
)
3302 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3305 /* Low level keyboard/mouse input.
3306 kbd_buffer_store_event places events in kbd_buffer, and
3307 kbd_buffer_get_event retrieves them. */
3309 /* Return true if there are any events in the queue that read-char
3310 would return. If this returns false, a read-char would block. */
3312 readable_events (int flags
)
3314 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3317 /* If the buffer contains only FOCUS_IN_EVENT events, and
3318 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3319 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3321 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3322 #ifdef USE_TOOLKIT_SCROLL_BARS
3323 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3327 struct input_event
*event
;
3329 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3336 #ifdef USE_TOOLKIT_SCROLL_BARS
3337 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3339 event
->kind
== FOCUS_IN_EVENT
)
3340 #ifdef USE_TOOLKIT_SCROLL_BARS
3341 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3342 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3343 && event
->part
== scroll_bar_handle
3344 && event
->modifiers
== 0)
3349 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3352 while (event
!= kbd_store_ptr
);
3358 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3359 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3360 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3365 if (current_kboard
->kbd_queue_has_data
)
3371 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3372 if (kb
->kbd_queue_has_data
)
3378 /* Set this for debugging, to have a way to get out */
3382 event_to_kboard (struct input_event
*event
)
3385 frame
= event
->frame_or_window
;
3387 frame
= XCAR (frame
);
3388 else if (WINDOWP (frame
))
3389 frame
= WINDOW_FRAME (XWINDOW (frame
));
3391 /* There are still some events that don't set this field.
3392 For now, just ignore the problem.
3393 Also ignore dead frames here. */
3394 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3397 return FRAME_KBOARD (XFRAME (frame
));
3401 /* Return the number of slots occupied in kbd_buffer. */
3404 kbd_buffer_nr_stored (void)
3406 return kbd_fetch_ptr
== kbd_store_ptr
3408 : (kbd_fetch_ptr
< kbd_store_ptr
3409 ? kbd_store_ptr
- kbd_fetch_ptr
3410 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3411 + (kbd_store_ptr
- kbd_buffer
)));
3413 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3416 kbd_buffer_store_event (register struct input_event
*event
)
3418 kbd_buffer_store_event_hold (event
, 0);
3421 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3423 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3424 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3425 Else, if EVENT is a quit event, store the quit event
3426 in HOLD_QUIT, and return (thus ignoring further events).
3428 This is used in read_avail_input to postpone the processing
3429 of the quit event until all subsequent input events have been
3430 parsed (and discarded).
3434 kbd_buffer_store_event_hold (register struct input_event
*event
,
3435 struct input_event
*hold_quit
)
3437 if (event
->kind
== NO_EVENT
)
3440 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3443 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3445 register int c
= event
->code
& 0377;
3447 if (event
->modifiers
& ctrl_modifier
)
3448 c
= make_ctrl_char (c
);
3450 c
|= (event
->modifiers
3451 & (meta_modifier
| alt_modifier
3452 | hyper_modifier
| super_modifier
));
3456 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3457 struct input_event
*sp
;
3459 if (single_kboard
&& kb
!= current_kboard
)
3462 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3463 Fcons (make_number (c
), Qnil
));
3464 kb
->kbd_queue_has_data
= 1;
3465 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3467 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3470 if (event_to_kboard (sp
) == kb
)
3472 sp
->kind
= NO_EVENT
;
3473 sp
->frame_or_window
= Qnil
;
3482 memcpy (hold_quit
, event
, sizeof (*event
));
3486 /* If this results in a quit_char being returned to Emacs as
3487 input, set Vlast_event_frame properly. If this doesn't
3488 get returned to Emacs as an event, the next event read
3489 will set Vlast_event_frame again, so this is safe to do. */
3493 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3495 focus
= event
->frame_or_window
;
3496 internal_last_event_frame
= focus
;
3497 Vlast_event_frame
= focus
;
3500 last_event_timestamp
= event
->timestamp
;
3501 handle_interrupt ();
3505 if (c
&& c
== stop_character
)
3511 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3512 Just ignore the second one. */
3513 else if (event
->kind
== BUFFER_SWITCH_EVENT
3514 && kbd_fetch_ptr
!= kbd_store_ptr
3515 && ((kbd_store_ptr
== kbd_buffer
3516 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3517 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3520 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3521 kbd_store_ptr
= kbd_buffer
;
3523 /* Don't let the very last slot in the buffer become full,
3524 since that would make the two pointers equal,
3525 and that is indistinguishable from an empty buffer.
3526 Discard the event if it would fill the last slot. */
3527 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3529 *kbd_store_ptr
= *event
;
3532 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3534 /* Don't read keyboard input until we have processed kbd_buffer.
3535 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3536 hold_keyboard_input ();
3538 if (!noninteractive
)
3539 signal (SIGIO
, SIG_IGN
);
3543 #endif /* subprocesses */
3546 /* If we're inside while-no-input, and this event qualifies
3547 as input, set quit-flag to cause an interrupt. */
3548 if (!NILP (Vthrow_on_input
)
3549 && event
->kind
!= FOCUS_IN_EVENT
3550 && event
->kind
!= HELP_EVENT
3551 && event
->kind
!= DEICONIFY_EVENT
)
3553 Vquit_flag
= Vthrow_on_input
;
3554 /* If we're inside a function that wants immediate quits,
3556 if (immediate_quit
&& NILP (Vinhibit_quit
))
3566 /* Put an input event back in the head of the event queue. */
3569 kbd_buffer_unget_event (register struct input_event
*event
)
3571 if (kbd_fetch_ptr
== kbd_buffer
)
3572 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3574 /* Don't let the very last slot in the buffer become full, */
3575 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3578 *kbd_fetch_ptr
= *event
;
3583 /* Generate a HELP_EVENT input_event and store it in the keyboard
3586 HELP is the help form.
3588 FRAME and WINDOW are the frame and window where the help is
3589 generated. OBJECT is the Lisp object where the help was found (a
3590 buffer, a string, an overlay, or nil if neither from a string nor
3591 from a buffer). POS is the position within OBJECT where the help
3595 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3596 Lisp_Object object
, EMACS_INT pos
)
3598 struct input_event event
;
3602 event
.kind
= HELP_EVENT
;
3603 event
.frame_or_window
= frame
;
3605 event
.x
= WINDOWP (window
) ? window
: frame
;
3608 kbd_buffer_store_event (&event
);
3612 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3615 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3617 struct input_event event
;
3619 event
.kind
= HELP_EVENT
;
3620 event
.frame_or_window
= frame
;
3625 kbd_buffer_store_event (&event
);
3629 /* Discard any mouse events in the event buffer by setting them to
3632 discard_mouse_events (void)
3634 struct input_event
*sp
;
3635 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3637 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3640 if (sp
->kind
== MOUSE_CLICK_EVENT
3641 || sp
->kind
== WHEEL_EVENT
3642 || sp
->kind
== HORIZ_WHEEL_EVENT
3644 || sp
->kind
== GPM_CLICK_EVENT
3646 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3648 sp
->kind
= NO_EVENT
;
3654 /* Return non-zero if there are any real events waiting in the event
3655 buffer, not counting `NO_EVENT's.
3657 If DISCARD is non-zero, discard NO_EVENT events at the front of
3658 the input queue, possibly leaving the input queue empty if there
3659 are no real input events. */
3662 kbd_buffer_events_waiting (int discard
)
3664 struct input_event
*sp
;
3666 for (sp
= kbd_fetch_ptr
;
3667 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3670 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3677 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3681 /* Clear input event EVENT. */
3684 clear_event (struct input_event
*event
)
3686 event
->kind
= NO_EVENT
;
3690 /* Read one event from the event buffer, waiting if necessary.
3691 The value is a Lisp object representing the event.
3692 The value is nil for an event that should be ignored,
3693 or that was handled here.
3694 We always read and discard one event. */
3697 kbd_buffer_get_event (KBOARD
**kbp
,
3698 int *used_mouse_menu
,
3699 struct timeval
*end_time
)
3705 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3707 /* Start reading input again, we have processed enough so we can
3708 accept new events again. */
3709 unhold_keyboard_input ();
3711 if (!noninteractive
)
3712 signal (SIGIO
, input_available_signal
);
3716 #endif /* subprocesses */
3719 /* In case we are running as a daemon, only do this before
3720 detaching from the terminal. */
3721 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3725 *kbp
= current_kboard
;
3729 /* Wait until there is input available. */
3732 /* Break loop if there's an unread command event. Needed in
3733 moused window autoselection which uses a timer to insert such
3735 if (CONSP (Vunread_command_events
))
3738 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3740 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3741 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3745 /* If the quit flag is set, then read_char will return
3746 quit_char, so that counts as "available input." */
3747 if (!NILP (Vquit_flag
))
3748 quit_throw_to_read_char ();
3750 /* One way or another, wait until input is available; then, if
3751 interrupt handlers have not read it, read it now. */
3753 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3757 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3759 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3760 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3765 EMACS_TIME duration
;
3766 EMACS_GET_TIME (duration
);
3767 if (EMACS_TIME_GE (duration
, *end_time
))
3768 return Qnil
; /* finished waiting */
3771 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3772 wait_reading_process_output (EMACS_SECS (duration
),
3773 EMACS_USECS (duration
),
3774 -1, 1, Qnil
, NULL
, 0);
3778 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3780 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3781 /* Pass 1 for EXPECT since we just waited to have input. */
3782 read_avail_input (1);
3785 if (CONSP (Vunread_command_events
))
3788 first
= XCAR (Vunread_command_events
);
3789 Vunread_command_events
= XCDR (Vunread_command_events
);
3790 *kbp
= current_kboard
;
3794 /* At this point, we know that there is a readable event available
3795 somewhere. If the event queue is empty, then there must be a
3796 mouse movement enabled and available. */
3797 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3799 struct input_event
*event
;
3801 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3805 last_event_timestamp
= event
->timestamp
;
3807 *kbp
= event_to_kboard (event
);
3809 *kbp
= current_kboard
; /* Better than returning null ptr? */
3813 /* These two kinds of events get special handling
3814 and don't actually appear to the command loop.
3815 We return nil for them. */
3816 if (event
->kind
== SELECTION_REQUEST_EVENT
3817 || event
->kind
== SELECTION_CLEAR_EVENT
)
3820 struct input_event copy
;
3822 /* Remove it from the buffer before processing it,
3823 since otherwise swallow_events will see it
3824 and process it again. */
3826 kbd_fetch_ptr
= event
+ 1;
3827 input_pending
= readable_events (0);
3828 x_handle_selection_event (©
);
3830 /* We're getting selection request events, but we don't have
3836 #if defined (HAVE_NS)
3837 else if (event
->kind
== NS_TEXT_EVENT
)
3839 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3840 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3842 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3843 kbd_fetch_ptr
= event
+ 1;
3844 if (used_mouse_menu
)
3845 *used_mouse_menu
= 1;
3849 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3850 || defined (HAVE_NS)
3851 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3853 /* Make an event (delete-frame (FRAME)). */
3854 obj
= Fcons (event
->frame_or_window
, Qnil
);
3855 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3856 kbd_fetch_ptr
= event
+ 1;
3859 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3860 || defined (HAVE_NS)
3861 else if (event
->kind
== ICONIFY_EVENT
)
3863 /* Make an event (iconify-frame (FRAME)). */
3864 obj
= Fcons (event
->frame_or_window
, Qnil
);
3865 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3866 kbd_fetch_ptr
= event
+ 1;
3868 else if (event
->kind
== DEICONIFY_EVENT
)
3870 /* Make an event (make-frame-visible (FRAME)). */
3871 obj
= Fcons (event
->frame_or_window
, Qnil
);
3872 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3873 kbd_fetch_ptr
= event
+ 1;
3876 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3878 /* The value doesn't matter here; only the type is tested. */
3879 XSETBUFFER (obj
, current_buffer
);
3880 kbd_fetch_ptr
= event
+ 1;
3882 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3883 || defined(HAVE_NS) || defined (USE_GTK)
3884 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3886 kbd_fetch_ptr
= event
+ 1;
3887 input_pending
= readable_events (0);
3888 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3889 x_activate_menubar (XFRAME (event
->frame_or_window
));
3892 #if defined (WINDOWSNT)
3893 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3895 /* Make an event (language-change (FRAME CHARSET LCID)). */
3896 obj
= Fcons (event
->frame_or_window
, Qnil
);
3897 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3898 kbd_fetch_ptr
= event
+ 1;
3901 else if (event
->kind
== SAVE_SESSION_EVENT
)
3903 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3904 kbd_fetch_ptr
= event
+ 1;
3906 /* Just discard these, by returning nil.
3907 With MULTI_KBOARD, these events are used as placeholders
3908 when we need to randomly delete events from the queue.
3909 (They shouldn't otherwise be found in the buffer,
3910 but on some machines it appears they do show up
3911 even without MULTI_KBOARD.) */
3912 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3913 mouse events during a popup-menu call. */
3914 else if (event
->kind
== NO_EVENT
)
3915 kbd_fetch_ptr
= event
+ 1;
3916 else if (event
->kind
== HELP_EVENT
)
3918 Lisp_Object object
, position
, help
, frame
, window
;
3920 frame
= event
->frame_or_window
;
3921 object
= event
->arg
;
3922 position
= make_number (event
->code
);
3925 clear_event (event
);
3927 kbd_fetch_ptr
= event
+ 1;
3928 if (!WINDOWP (window
))
3930 obj
= Fcons (Qhelp_echo
,
3931 list5 (frame
, help
, window
, object
, position
));
3933 else if (event
->kind
== FOCUS_IN_EVENT
)
3935 /* Notification of a FocusIn event. The frame receiving the
3936 focus is in event->frame_or_window. Generate a
3937 switch-frame event if necessary. */
3938 Lisp_Object frame
, focus
;
3940 frame
= event
->frame_or_window
;
3941 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3945 if (!EQ (frame
, internal_last_event_frame
)
3946 && !EQ (frame
, selected_frame
))
3947 obj
= make_lispy_switch_frame (frame
);
3948 internal_last_event_frame
= frame
;
3949 kbd_fetch_ptr
= event
+ 1;
3952 else if (event
->kind
== DBUS_EVENT
)
3954 obj
= make_lispy_event (event
);
3955 kbd_fetch_ptr
= event
+ 1;
3958 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3960 obj
= make_lispy_event (event
);
3961 kbd_fetch_ptr
= event
+ 1;
3965 /* If this event is on a different frame, return a switch-frame this
3966 time, and leave the event in the queue for next time. */
3970 frame
= event
->frame_or_window
;
3972 frame
= XCAR (frame
);
3973 else if (WINDOWP (frame
))
3974 frame
= WINDOW_FRAME (XWINDOW (frame
));
3976 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3980 if (! EQ (frame
, internal_last_event_frame
)
3981 && !EQ (frame
, selected_frame
))
3982 obj
= make_lispy_switch_frame (frame
);
3983 internal_last_event_frame
= frame
;
3985 /* If we didn't decide to make a switch-frame event, go ahead
3986 and build a real event from the queue entry. */
3990 obj
= make_lispy_event (event
);
3992 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3993 || defined(HAVE_NS) || defined (USE_GTK)
3994 /* If this was a menu selection, then set the flag to inhibit
3995 writing to last_nonmenu_event. Don't do this if the event
3996 we're returning is (menu-bar), though; that indicates the
3997 beginning of the menu sequence, and we might as well leave
3998 that as the `event with parameters' for this selection. */
4000 && !EQ (event
->frame_or_window
, event
->arg
)
4001 && (event
->kind
== MENU_BAR_EVENT
4002 || event
->kind
== TOOL_BAR_EVENT
))
4003 *used_mouse_menu
= 1;
4006 /* certain system events are non-key events */
4008 && event
->kind
== NS_NONKEY_EVENT
)
4009 *used_mouse_menu
= 1;
4012 /* Wipe out this event, to catch bugs. */
4013 clear_event (event
);
4014 kbd_fetch_ptr
= event
+ 1;
4018 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4019 /* Try generating a mouse motion event. */
4020 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4022 FRAME_PTR f
= some_mouse_moved ();
4023 Lisp_Object bar_window
;
4024 enum scroll_bar_part part
;
4028 *kbp
= current_kboard
;
4029 /* Note that this uses F to determine which terminal to look at.
4030 If there is no valid info, it does not store anything
4031 so x remains nil. */
4034 /* XXX Can f or mouse_position_hook be NULL here? */
4035 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4036 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4037 &part
, &x
, &y
, &time
);
4041 /* Decide if we should generate a switch-frame event. Don't
4042 generate switch-frame events for motion outside of all Emacs
4048 frame
= FRAME_FOCUS_FRAME (f
);
4050 XSETFRAME (frame
, f
);
4052 if (! EQ (frame
, internal_last_event_frame
)
4053 && !EQ (frame
, selected_frame
))
4054 obj
= make_lispy_switch_frame (frame
);
4055 internal_last_event_frame
= frame
;
4058 /* If we didn't decide to make a switch-frame event, go ahead and
4059 return a mouse-motion event. */
4060 if (!NILP (x
) && NILP (obj
))
4061 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4063 #endif /* HAVE_MOUSE || HAVE GPM */
4065 /* We were promised by the above while loop that there was
4066 something for us to read! */
4069 input_pending
= readable_events (0);
4071 Vlast_event_frame
= internal_last_event_frame
;
4076 /* Process any events that are not user-visible,
4077 then return, without reading any user-visible events. */
4080 swallow_events (int do_display
)
4084 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4086 struct input_event
*event
;
4088 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4092 last_event_timestamp
= event
->timestamp
;
4094 /* These two kinds of events get special handling
4095 and don't actually appear to the command loop. */
4096 if (event
->kind
== SELECTION_REQUEST_EVENT
4097 || event
->kind
== SELECTION_CLEAR_EVENT
)
4100 struct input_event copy
;
4102 /* Remove it from the buffer before processing it,
4103 since otherwise swallow_events called recursively could see it
4104 and process it again. */
4106 kbd_fetch_ptr
= event
+ 1;
4107 input_pending
= readable_events (0);
4108 x_handle_selection_event (©
);
4110 /* We're getting selection request events, but we don't have
4119 old_timers_run
= timers_run
;
4120 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4122 if (timers_run
!= old_timers_run
&& do_display
)
4123 redisplay_preserve_echo_area (7);
4126 /* Record the start of when Emacs is idle,
4127 for the sake of running idle-time timers. */
4130 timer_start_idle (void)
4134 /* If we are already in the idle state, do nothing. */
4135 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4138 EMACS_GET_TIME (timer_idleness_start_time
);
4140 timer_last_idleness_start_time
= timer_idleness_start_time
;
4142 /* Mark all idle-time timers as once again candidates for running. */
4143 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4147 timer
= XCAR (timers
);
4149 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4151 XVECTOR (timer
)->contents
[0] = Qnil
;
4155 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4158 timer_stop_idle (void)
4160 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4163 /* Resume idle timer from last idle start time. */
4166 timer_resume_idle (void)
4168 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4171 timer_idleness_start_time
= timer_last_idleness_start_time
;
4174 /* This is only for debugging. */
4175 struct input_event last_timer_event
;
4177 /* List of elisp functions to call, delayed because they were generated in
4178 a context where Elisp could not be safely run (e.g. redisplay, signal,
4179 ...). Each element has the form (FUN . ARGS). */
4180 Lisp_Object pending_funcalls
;
4182 /* Check whether a timer has fired. To prevent larger problems we simply
4183 disregard elements that are not proper timers. Do not make a circular
4184 timer list for the time being.
4186 Returns the time to wait until the next timer fires. If a
4187 timer is triggering now, return zero.
4188 If no timer is active, return -1.
4190 If a timer is ripe, we run it, with quitting turned off.
4191 In that case we return 0 to indicate that a new timer_check_2 call
4195 timer_check_2 (void)
4197 EMACS_TIME nexttime
;
4198 EMACS_TIME now
, idleness_now
;
4199 Lisp_Object timers
, idle_timers
, chosen_timer
;
4200 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4202 EMACS_SET_SECS (nexttime
, -1);
4203 EMACS_SET_USECS (nexttime
, -1);
4205 /* Always consider the ordinary timers. */
4206 timers
= Vtimer_list
;
4207 /* Consider the idle timers only if Emacs is idle. */
4208 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4209 idle_timers
= Vtimer_idle_list
;
4212 chosen_timer
= Qnil
;
4213 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4215 /* First run the code that was delayed. */
4216 while (CONSP (pending_funcalls
))
4218 Lisp_Object funcall
= XCAR (pending_funcalls
);
4219 pending_funcalls
= XCDR (pending_funcalls
);
4220 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4223 if (CONSP (timers
) || CONSP (idle_timers
))
4225 EMACS_GET_TIME (now
);
4226 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4227 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4230 while (CONSP (timers
) || CONSP (idle_timers
))
4232 Lisp_Object
*vector
;
4233 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4234 EMACS_TIME timer_time
, idle_timer_time
;
4235 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4237 /* Skip past invalid timers and timers already handled. */
4240 timer
= XCAR (timers
);
4241 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4243 timers
= XCDR (timers
);
4246 vector
= XVECTOR (timer
)->contents
;
4248 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4249 || !INTEGERP (vector
[3])
4250 || ! NILP (vector
[0]))
4252 timers
= XCDR (timers
);
4256 if (!NILP (idle_timers
))
4258 timer
= XCAR (idle_timers
);
4259 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4261 idle_timers
= XCDR (idle_timers
);
4264 vector
= XVECTOR (timer
)->contents
;
4266 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4267 || !INTEGERP (vector
[3])
4268 || ! NILP (vector
[0]))
4270 idle_timers
= XCDR (idle_timers
);
4275 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4276 based on the next ordinary timer.
4277 TIMER_DIFFERENCE is the distance in time from NOW to when
4278 this timer becomes ripe (negative if it's already ripe). */
4281 timer
= XCAR (timers
);
4282 vector
= XVECTOR (timer
)->contents
;
4283 EMACS_SET_SECS (timer_time
,
4284 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4285 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4286 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4289 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4290 based on the next idle timer. */
4291 if (!NILP (idle_timers
))
4293 idle_timer
= XCAR (idle_timers
);
4294 vector
= XVECTOR (idle_timer
)->contents
;
4295 EMACS_SET_SECS (idle_timer_time
,
4296 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4297 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4298 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4301 /* Decide which timer is the next timer,
4302 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4303 Also step down the list where we found that timer. */
4305 if (! NILP (timers
) && ! NILP (idle_timers
))
4308 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4309 if (EMACS_TIME_NEG_P (temp
))
4311 chosen_timer
= timer
;
4312 timers
= XCDR (timers
);
4313 difference
= timer_difference
;
4317 chosen_timer
= idle_timer
;
4318 idle_timers
= XCDR (idle_timers
);
4319 difference
= idle_timer_difference
;
4322 else if (! NILP (timers
))
4324 chosen_timer
= timer
;
4325 timers
= XCDR (timers
);
4326 difference
= timer_difference
;
4330 chosen_timer
= idle_timer
;
4331 idle_timers
= XCDR (idle_timers
);
4332 difference
= idle_timer_difference
;
4334 vector
= XVECTOR (chosen_timer
)->contents
;
4336 /* If timer is ripe, run it if it hasn't been run. */
4337 if (EMACS_TIME_NEG_P (difference
)
4338 || (EMACS_SECS (difference
) == 0
4339 && EMACS_USECS (difference
) == 0))
4341 if (NILP (vector
[0]))
4343 int count
= SPECPDL_INDEX ();
4344 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4346 /* Mark the timer as triggered to prevent problems if the lisp
4347 code fails to reschedule it right. */
4350 specbind (Qinhibit_quit
, Qt
);
4352 call1 (Qtimer_event_handler
, chosen_timer
);
4353 Vdeactivate_mark
= old_deactivate_mark
;
4355 unbind_to (count
, Qnil
);
4357 /* Since we have handled the event,
4358 we don't need to tell the caller to wake up and do it. */
4359 /* But the caller must still wait for the next timer, so
4360 return 0 to indicate that. */
4363 EMACS_SET_SECS (nexttime
, 0);
4364 EMACS_SET_USECS (nexttime
, 0);
4367 /* When we encounter a timer that is still waiting,
4368 return the amount of time to wait before it is ripe. */
4375 /* No timers are pending in the future. */
4376 /* Return 0 if we generated an event, and -1 if not. */
4382 /* Check whether a timer has fired. To prevent larger problems we simply
4383 disregard elements that are not proper timers. Do not make a circular
4384 timer list for the time being.
4386 Returns the time to wait until the next timer fires.
4387 If no timer is active, return -1.
4389 As long as any timer is ripe, we run it.
4391 DO_IT_NOW is now ignored. It used to mean that we should
4392 run the timer directly instead of queueing a timer-event.
4393 Now we always run timers directly. */
4396 timer_check (int do_it_now
)
4398 EMACS_TIME nexttime
;
4402 nexttime
= timer_check_2 ();
4404 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4409 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4410 doc
: /* Return the current length of Emacs idleness, or nil.
4411 The value when Emacs is idle is a list of three integers. The first has
4412 the most significant 16 bits of the seconds, while the second has the least
4413 significant 16 bits. The third integer gives the microsecond count.
4415 The value when Emacs is not idle is nil.
4417 The microsecond count is zero on systems that do not provide
4418 resolution finer than a second. */)
4421 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4423 EMACS_TIME now
, idleness_now
;
4425 EMACS_GET_TIME (now
);
4426 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4428 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4429 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4430 make_number (EMACS_USECS (idleness_now
)));
4436 /* Caches for modify_event_symbol. */
4437 static Lisp_Object accent_key_syms
;
4438 static Lisp_Object func_key_syms
;
4439 static Lisp_Object mouse_syms
;
4440 static Lisp_Object wheel_syms
;
4441 static Lisp_Object drag_n_drop_syms
;
4443 /* This is a list of keysym codes for special "accent" characters.
4444 It parallels lispy_accent_keys. */
4446 static const int lispy_accent_codes
[] =
4448 #ifdef XK_dead_circumflex
4453 #ifdef XK_dead_grave
4458 #ifdef XK_dead_tilde
4463 #ifdef XK_dead_diaeresis
4468 #ifdef XK_dead_macron
4473 #ifdef XK_dead_degree
4478 #ifdef XK_dead_acute
4483 #ifdef XK_dead_cedilla
4488 #ifdef XK_dead_breve
4493 #ifdef XK_dead_ogonek
4498 #ifdef XK_dead_caron
4503 #ifdef XK_dead_doubleacute
4504 XK_dead_doubleacute
,
4508 #ifdef XK_dead_abovedot
4513 #ifdef XK_dead_abovering
4523 #ifdef XK_dead_belowdot
4528 #ifdef XK_dead_voiced_sound
4529 XK_dead_voiced_sound
,
4533 #ifdef XK_dead_semivoiced_sound
4534 XK_dead_semivoiced_sound
,
4550 /* This is a list of Lisp names for special "accent" characters.
4551 It parallels lispy_accent_codes. */
4553 static const char *const lispy_accent_keys
[] =
4571 "dead-voiced-sound",
4572 "dead-semivoiced-sound",
4578 #define FUNCTION_KEY_OFFSET 0x0
4580 const char *const lispy_function_keys
[] =
4584 0, /* VK_LBUTTON 0x01 */
4585 0, /* VK_RBUTTON 0x02 */
4586 "cancel", /* VK_CANCEL 0x03 */
4587 0, /* VK_MBUTTON 0x04 */
4589 0, 0, 0, /* 0x05 .. 0x07 */
4591 "backspace", /* VK_BACK 0x08 */
4592 "tab", /* VK_TAB 0x09 */
4594 0, 0, /* 0x0A .. 0x0B */
4596 "clear", /* VK_CLEAR 0x0C */
4597 "return", /* VK_RETURN 0x0D */
4599 0, 0, /* 0x0E .. 0x0F */
4601 0, /* VK_SHIFT 0x10 */
4602 0, /* VK_CONTROL 0x11 */
4603 0, /* VK_MENU 0x12 */
4604 "pause", /* VK_PAUSE 0x13 */
4605 "capslock", /* VK_CAPITAL 0x14 */
4606 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4608 "junja", /* VK_JUNJA 0x17 */
4609 "final", /* VK_FINAL 0x18 */
4610 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4612 "escape", /* VK_ESCAPE 0x1B */
4613 "convert", /* VK_CONVERT 0x1C */
4614 "non-convert", /* VK_NONCONVERT 0x1D */
4615 "accept", /* VK_ACCEPT 0x1E */
4616 "mode-change", /* VK_MODECHANGE 0x1F */
4617 0, /* VK_SPACE 0x20 */
4618 "prior", /* VK_PRIOR 0x21 */
4619 "next", /* VK_NEXT 0x22 */
4620 "end", /* VK_END 0x23 */
4621 "home", /* VK_HOME 0x24 */
4622 "left", /* VK_LEFT 0x25 */
4623 "up", /* VK_UP 0x26 */
4624 "right", /* VK_RIGHT 0x27 */
4625 "down", /* VK_DOWN 0x28 */
4626 "select", /* VK_SELECT 0x29 */
4627 "print", /* VK_PRINT 0x2A */
4628 "execute", /* VK_EXECUTE 0x2B */
4629 "snapshot", /* VK_SNAPSHOT 0x2C */
4630 "insert", /* VK_INSERT 0x2D */
4631 "delete", /* VK_DELETE 0x2E */
4632 "help", /* VK_HELP 0x2F */
4634 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4636 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4638 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4640 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4642 0, 0, 0, 0, 0, 0, 0, 0, 0,
4643 0, 0, 0, 0, 0, 0, 0, 0, 0,
4644 0, 0, 0, 0, 0, 0, 0, 0,
4646 "lwindow", /* VK_LWIN 0x5B */
4647 "rwindow", /* VK_RWIN 0x5C */
4648 "apps", /* VK_APPS 0x5D */
4651 "kp-0", /* VK_NUMPAD0 0x60 */
4652 "kp-1", /* VK_NUMPAD1 0x61 */
4653 "kp-2", /* VK_NUMPAD2 0x62 */
4654 "kp-3", /* VK_NUMPAD3 0x63 */
4655 "kp-4", /* VK_NUMPAD4 0x64 */
4656 "kp-5", /* VK_NUMPAD5 0x65 */
4657 "kp-6", /* VK_NUMPAD6 0x66 */
4658 "kp-7", /* VK_NUMPAD7 0x67 */
4659 "kp-8", /* VK_NUMPAD8 0x68 */
4660 "kp-9", /* VK_NUMPAD9 0x69 */
4661 "kp-multiply", /* VK_MULTIPLY 0x6A */
4662 "kp-add", /* VK_ADD 0x6B */
4663 "kp-separator", /* VK_SEPARATOR 0x6C */
4664 "kp-subtract", /* VK_SUBTRACT 0x6D */
4665 "kp-decimal", /* VK_DECIMAL 0x6E */
4666 "kp-divide", /* VK_DIVIDE 0x6F */
4667 "f1", /* VK_F1 0x70 */
4668 "f2", /* VK_F2 0x71 */
4669 "f3", /* VK_F3 0x72 */
4670 "f4", /* VK_F4 0x73 */
4671 "f5", /* VK_F5 0x74 */
4672 "f6", /* VK_F6 0x75 */
4673 "f7", /* VK_F7 0x76 */
4674 "f8", /* VK_F8 0x77 */
4675 "f9", /* VK_F9 0x78 */
4676 "f10", /* VK_F10 0x79 */
4677 "f11", /* VK_F11 0x7A */
4678 "f12", /* VK_F12 0x7B */
4679 "f13", /* VK_F13 0x7C */
4680 "f14", /* VK_F14 0x7D */
4681 "f15", /* VK_F15 0x7E */
4682 "f16", /* VK_F16 0x7F */
4683 "f17", /* VK_F17 0x80 */
4684 "f18", /* VK_F18 0x81 */
4685 "f19", /* VK_F19 0x82 */
4686 "f20", /* VK_F20 0x83 */
4687 "f21", /* VK_F21 0x84 */
4688 "f22", /* VK_F22 0x85 */
4689 "f23", /* VK_F23 0x86 */
4690 "f24", /* VK_F24 0x87 */
4692 0, 0, 0, 0, /* 0x88 .. 0x8B */
4693 0, 0, 0, 0, /* 0x8C .. 0x8F */
4695 "kp-numlock", /* VK_NUMLOCK 0x90 */
4696 "scroll", /* VK_SCROLL 0x91 */
4697 /* Not sure where the following block comes from.
4698 Windows headers have NEC and Fujitsu specific keys in
4699 this block, but nothing generic. */
4700 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4701 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4702 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4703 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4704 "kp-end", /* VK_NUMPAD_END 0x96 */
4705 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4706 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4707 "kp-up", /* VK_NUMPAD_UP 0x99 */
4708 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4709 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4710 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4711 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4713 0, 0, /* 0x9E .. 0x9F */
4716 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4717 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4718 * No other API or message will distinguish left and right keys this way.
4723 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4724 to enable them selectively, and gives access to a few more functions.
4725 See lispy_multimedia_keys below. */
4726 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4727 0, 0, 0, /* 0xAD .. 0xAF Volume */
4728 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4729 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4731 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4732 0, 0, 0, 0, 0, 0, 0, 0, 0,
4734 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4735 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4736 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4739 "ax", /* VK_OEM_AX 0xE1 */
4740 0, /* VK_OEM_102 0xE2 */
4741 "ico-help", /* VK_ICO_HELP 0xE3 */
4742 "ico-00", /* VK_ICO_00 0xE4 */
4743 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4744 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4745 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4747 "reset", /* VK_OEM_RESET 0xE9 */
4748 "jump", /* VK_OEM_JUMP 0xEA */
4749 "oem-pa1", /* VK_OEM_PA1 0xEB */
4750 "oem-pa2", /* VK_OEM_PA2 0xEC */
4751 "oem-pa3", /* VK_OEM_PA3 0xED */
4752 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4753 "cusel", /* VK_OEM_CUSEL 0xEF */
4754 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4755 "finish", /* VK_OEM_FINISH 0xF1 */
4756 "copy", /* VK_OEM_COPY 0xF2 */
4757 "auto", /* VK_OEM_AUTO 0xF3 */
4758 "enlw", /* VK_OEM_ENLW 0xF4 */
4759 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4760 "attn", /* VK_ATTN 0xF6 */
4761 "crsel", /* VK_CRSEL 0xF7 */
4762 "exsel", /* VK_EXSEL 0xF8 */
4763 "ereof", /* VK_EREOF 0xF9 */
4764 "play", /* VK_PLAY 0xFA */
4765 "zoom", /* VK_ZOOM 0xFB */
4766 "noname", /* VK_NONAME 0xFC */
4767 "pa1", /* VK_PA1 0xFD */
4768 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4772 /* Some of these duplicate the "Media keys" on newer keyboards,
4773 but they are delivered to the application in a different way. */
4774 static const char *const lispy_multimedia_keys
[] =
4782 "browser-favorites",
4819 "toggle-dictate-command",
4825 "media-fast-forward",
4828 "media-channel-down"
4831 #else /* not HAVE_NTGUI */
4833 /* This should be dealt with in XTread_socket now, and that doesn't
4834 depend on the client system having the Kana syms defined. See also
4835 the XK_kana_A case below. */
4838 static const char *const lispy_kana_keys
[] =
4840 /* X Keysym value */
4841 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4842 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4843 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4844 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4845 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4846 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4847 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4848 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4849 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4850 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4851 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4852 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4853 "kana-i", "kana-u", "kana-e", "kana-o",
4854 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4855 "prolongedsound", "kana-A", "kana-I", "kana-U",
4856 "kana-E", "kana-O", "kana-KA", "kana-KI",
4857 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4858 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4859 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4860 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4861 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4862 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4863 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4864 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4865 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4866 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4867 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4868 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4870 #endif /* XK_kana_A */
4873 #define FUNCTION_KEY_OFFSET 0xff00
4875 /* You'll notice that this table is arranged to be conveniently
4876 indexed by X Windows keysym values. */
4877 static const char *const lispy_function_keys
[] =
4879 /* X Keysym value */
4881 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4882 "backspace", "tab", "linefeed", "clear",
4884 0, 0, 0, "pause", /* 0xff10...1f */
4885 0, 0, 0, 0, 0, 0, 0, "escape",
4887 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4888 "romaji", "hiragana", "katakana", "hiragana-katakana",
4889 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4890 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4891 "eisu-toggle", /* 0xff30...3f */
4892 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4893 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4895 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4896 "down", "prior", "next", "end",
4897 "begin", 0, 0, 0, 0, 0, 0, 0,
4898 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4909 "break", /* 0xff6b */
4912 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4913 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4914 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4915 0, 0, 0, 0, 0, 0, 0, 0,
4916 "kp-tab", /* 0xff89 */
4918 "kp-enter", /* 0xff8d */
4920 "kp-f1", /* 0xff91 */
4924 "kp-home", /* 0xff95 */
4929 "kp-prior", /* kp-page-up */
4930 "kp-next", /* kp-page-down */
4936 0, 0, 0, 0, 0, 0, 0, 0, 0,
4937 "kp-multiply", /* 0xffaa */
4942 "kp-divide", /* 0xffaf */
4943 "kp-0", /* 0xffb0 */
4944 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4947 "kp-equal", /* 0xffbd */
4948 "f1", /* 0xffbe */ /* IsFunctionKey */
4950 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4951 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4952 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4953 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4954 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4955 0, 0, 0, 0, 0, 0, 0, 0,
4956 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4957 0, 0, 0, 0, 0, 0, 0, "delete"
4960 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4961 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4963 static const char *const iso_lispy_function_keys
[] =
4965 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4966 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4967 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4968 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4969 "iso-lefttab", /* 0xfe20 */
4970 "iso-move-line-up", "iso-move-line-down",
4971 "iso-partial-line-up", "iso-partial-line-down",
4972 "iso-partial-space-left", "iso-partial-space-right",
4973 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4974 "iso-release-margin-left", "iso-release-margin-right",
4975 "iso-release-both-margins",
4976 "iso-fast-cursor-left", "iso-fast-cursor-right",
4977 "iso-fast-cursor-up", "iso-fast-cursor-down",
4978 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4979 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4982 #endif /* not HAVE_NTGUI */
4984 Lisp_Object Vlispy_mouse_stem
;
4986 static const char *const lispy_wheel_names
[] =
4988 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
4991 /* drag-n-drop events are generated when a set of selected files are
4992 dragged from another application and dropped onto an Emacs window. */
4993 static const char *const lispy_drag_n_drop_names
[] =
4998 /* Scroll bar parts. */
4999 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5000 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5001 Lisp_Object Qtop
, Qratio
;
5003 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5004 static Lisp_Object
*const scroll_bar_parts
[] = {
5005 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5006 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5009 /* A vector, indexed by button number, giving the down-going location
5010 of currently depressed buttons, both scroll bar and non-scroll bar.
5012 The elements have the form
5013 (BUTTON-NUMBER MODIFIER-MASK . REST)
5014 where REST is the cdr of a position as it would be reported in the event.
5016 The make_lispy_event function stores positions here to tell the
5017 difference between click and drag events, and to store the starting
5018 location to be included in drag events. */
5020 static Lisp_Object button_down_location
;
5022 /* Information about the most recent up-going button event: Which
5023 button, what location, and what time. */
5025 static int last_mouse_button
;
5026 static int last_mouse_x
;
5027 static int last_mouse_y
;
5028 static unsigned long button_down_time
;
5030 /* The number of clicks in this multiple-click. */
5032 int double_click_count
;
5034 /* X and Y are frame-relative coordinates for a click or wheel event.
5035 Return a Lisp-style event list. */
5038 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5041 enum window_part part
;
5042 Lisp_Object posn
= Qnil
;
5043 Lisp_Object extra_info
= Qnil
;
5044 /* Coordinate pixel positions to return. */
5045 int xret
= 0, yret
= 0;
5046 /* The window under frame pixel coordinates (x,y) */
5047 Lisp_Object window
= f
5048 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5051 if (WINDOWP (window
))
5053 /* It's a click in window window at frame coordinates (x,y) */
5054 struct window
*w
= XWINDOW (window
);
5055 Lisp_Object string_info
= Qnil
;
5056 EMACS_INT textpos
= -1;
5057 int col
= -1, row
= -1;
5058 int dx
= -1, dy
= -1;
5059 int width
= -1, height
= -1;
5060 Lisp_Object object
= Qnil
;
5062 /* Pixel coordinates relative to the window corner. */
5063 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5064 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5066 /* For text area clicks, return X, Y relative to the corner of
5067 this text area. Note that dX, dY etc are set below, by
5068 buffer_posn_from_coords. */
5069 if (part
== ON_TEXT
)
5071 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5072 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5074 /* For mode line and header line clicks, return X, Y relative to
5075 the left window edge. Use mode_line_string to look for a
5076 string on the click position. */
5077 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5082 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5083 /* Note that mode_line_string takes COL, ROW as pixels and
5084 converts them to characters. */
5087 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5088 &object
, &dx
, &dy
, &width
, &height
);
5089 if (STRINGP (string
))
5090 string_info
= Fcons (string
, make_number (charpos
));
5091 textpos
= (w
== XWINDOW (selected_window
)
5092 && current_buffer
== XBUFFER (w
->buffer
))
5093 ? PT
: XMARKER (w
->pointm
)->charpos
;
5098 /* For fringes and margins, Y is relative to the area's (and the
5099 window's) top edge, while X is meaningless. */
5100 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5105 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5108 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5109 &object
, &dx
, &dy
, &width
, &height
);
5110 if (STRINGP (string
))
5111 string_info
= Fcons (string
, make_number (charpos
));
5112 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5114 else if (part
== ON_LEFT_FRINGE
)
5116 posn
= Qleft_fringe
;
5119 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5120 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5121 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5123 else if (part
== ON_RIGHT_FRINGE
)
5125 posn
= Qright_fringe
;
5128 - window_box_width (w
, LEFT_MARGIN_AREA
)
5129 - window_box_width (w
, TEXT_AREA
)
5130 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5131 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5133 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5135 else if (part
== ON_VERTICAL_BORDER
)
5137 posn
= Qvertical_line
;
5142 /* Nothing special for part == ON_SCROLL_BAR. */
5144 /* For clicks in the text area, fringes, or margins, call
5145 buffer_posn_from_coords to extract TEXTPOS, the buffer
5146 position nearest to the click. */
5149 Lisp_Object string2
, object2
= Qnil
;
5150 struct display_pos p
;
5152 int width2
, height2
;
5153 /* The pixel X coordinate passed to buffer_posn_from_coords
5154 is the X coordinate relative to the text area for
5155 text-area clicks, zero otherwise. */
5156 int x2
= (part
== ON_TEXT
) ? xret
: 0;
5159 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5160 &object2
, &dx2
, &dy2
,
5162 textpos
= CHARPOS (p
.pos
);
5163 if (col
< 0) col
= x2
;
5164 if (row
< 0) row
= y2
;
5165 if (dx
< 0) dx
= dx2
;
5166 if (dy
< 0) dy
= dy2
;
5167 if (width
< 0) width
= width2
;
5168 if (height
< 0) height
= height2
;
5172 posn
= make_number (textpos
);
5173 if (STRINGP (string2
))
5174 string_info
= Fcons (string2
,
5175 make_number (CHARPOS (p
.string_pos
)));
5181 #ifdef HAVE_WINDOW_SYSTEM
5182 if (IMAGEP (object
))
5184 Lisp_Object image_map
, hotspot
;
5185 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5187 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5189 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5190 posn
= XCAR (hotspot
);
5197 Fcons (make_number (dx
), make_number (dy
)),
5198 Fcons (make_number (width
), make_number (height
)));
5201 extra_info
= Fcons (string_info
,
5202 Fcons (make_number (textpos
),
5203 Fcons (Fcons (make_number (col
),
5208 XSETFRAME (window
, f
);
5212 return Fcons (window
,
5214 Fcons (Fcons (make_number (xret
),
5215 make_number (yret
)),
5216 Fcons (make_number (time
),
5220 /* Given a struct input_event, build the lisp event which represents
5221 it. If EVENT is 0, build a mouse movement event from the mouse
5222 movement buffer, which should have a movement event in it.
5224 Note that events must be passed to this function in the order they
5225 are received; this function stores the location of button presses
5226 in order to build drag events when the button is released. */
5229 make_lispy_event (struct input_event
*event
)
5233 switch (SWITCH_ENUM_CAST (event
->kind
))
5235 /* A simple keystroke. */
5236 case ASCII_KEYSTROKE_EVENT
:
5237 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5239 Lisp_Object lispy_c
;
5240 EMACS_INT c
= event
->code
;
5241 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5244 eassert (c
== event
->code
);
5245 /* Turn ASCII characters into control characters
5247 if (event
->modifiers
& ctrl_modifier
)
5249 c
= make_ctrl_char (c
);
5250 event
->modifiers
&= ~ctrl_modifier
;
5254 /* Add in the other modifier bits. The shift key was taken care
5255 of by the X code. */
5256 c
|= (event
->modifiers
5257 & (meta_modifier
| alt_modifier
5258 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5259 /* Distinguish Shift-SPC from SPC. */
5260 if ((event
->code
) == 040
5261 && event
->modifiers
& shift_modifier
)
5262 c
|= shift_modifier
;
5263 button_down_time
= 0;
5264 XSETFASTINT (lispy_c
, c
);
5269 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5270 except that they are non-key events (last-nonmenu-event is nil). */
5271 case NS_NONKEY_EVENT
:
5274 /* A function key. The symbol may need to have modifier prefixes
5276 case NON_ASCII_KEYSTROKE_EVENT
:
5277 button_down_time
= 0;
5279 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5280 if (event
->code
== lispy_accent_codes
[i
])
5281 return modify_event_symbol (i
,
5283 Qfunction_key
, Qnil
,
5284 lispy_accent_keys
, &accent_key_syms
,
5285 (sizeof (lispy_accent_keys
)
5286 / sizeof (lispy_accent_keys
[0])));
5290 if (event
->code
>= 0x400 && event
->code
< 0x500)
5291 return modify_event_symbol (event
->code
- 0x400,
5292 event
->modifiers
& ~shift_modifier
,
5293 Qfunction_key
, Qnil
,
5294 lispy_kana_keys
, &func_key_syms
,
5295 (sizeof (lispy_kana_keys
)
5296 / sizeof (lispy_kana_keys
[0])));
5297 #endif /* XK_kana_A */
5300 #ifdef ISO_FUNCTION_KEY_OFFSET
5301 if (event
->code
< FUNCTION_KEY_OFFSET
5302 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5303 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5305 Qfunction_key
, Qnil
,
5306 iso_lispy_function_keys
, &func_key_syms
,
5307 (sizeof (iso_lispy_function_keys
)
5308 / sizeof (iso_lispy_function_keys
[0])));
5311 /* Handle system-specific or unknown keysyms. */
5312 if (event
->code
& (1 << 28)
5313 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5314 || (event
->code
- FUNCTION_KEY_OFFSET
5315 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5316 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5318 /* We need to use an alist rather than a vector as the cache
5319 since we can't make a vector long enuf. */
5320 if (NILP (current_kboard
->system_key_syms
))
5321 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5322 return modify_event_symbol (event
->code
,
5325 current_kboard
->Vsystem_key_alist
,
5326 0, ¤t_kboard
->system_key_syms
,
5330 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5332 Qfunction_key
, Qnil
,
5333 lispy_function_keys
, &func_key_syms
,
5334 (sizeof (lispy_function_keys
)
5335 / sizeof (lispy_function_keys
[0])));
5338 case MULTIMEDIA_KEY_EVENT
:
5339 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5340 / sizeof (lispy_multimedia_keys
[0]))
5341 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5343 return modify_event_symbol (event
->code
, event
->modifiers
,
5344 Qfunction_key
, Qnil
,
5345 lispy_multimedia_keys
, &func_key_syms
,
5346 (sizeof (lispy_multimedia_keys
)
5347 / sizeof (lispy_multimedia_keys
[0])));
5353 /* A mouse click. Figure out where it is, decide whether it's
5354 a press, click or drag, and build the appropriate structure. */
5355 case MOUSE_CLICK_EVENT
:
5356 #ifndef USE_TOOLKIT_SCROLL_BARS
5357 case SCROLL_BAR_CLICK_EVENT
:
5360 int button
= event
->code
;
5362 Lisp_Object position
;
5363 Lisp_Object
*start_pos_ptr
;
5364 Lisp_Object start_pos
;
5368 /* Build the position as appropriate for this mouse click. */
5369 if (event
->kind
== MOUSE_CLICK_EVENT
)
5371 struct frame
*f
= XFRAME (event
->frame_or_window
);
5372 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5376 /* Ignore mouse events that were made on frame that
5377 have been deleted. */
5378 if (! FRAME_LIVE_P (f
))
5381 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5382 /* EVENT->x and EVENT->y are frame-relative pixel
5383 coordinates at this place. Under old redisplay, COLUMN
5384 and ROW are set to frame relative glyph coordinates
5385 which are then used to determine whether this click is
5386 in a menu (non-toolkit version). */
5387 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5388 &column
, &row
, NULL
, 1);
5390 /* In the non-toolkit version, clicks on the menu bar
5391 are ordinary button events in the event buffer.
5392 Distinguish them, and invoke the menu.
5394 (In the toolkit version, the toolkit handles the menu bar
5395 and Emacs doesn't know about it until after the user
5396 makes a selection.) */
5397 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5398 && (event
->modifiers
& down_modifier
))
5400 Lisp_Object items
, item
;
5404 /* Find the menu bar item under `column'. */
5406 items
= FRAME_MENU_BAR_ITEMS (f
);
5407 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5409 Lisp_Object pos
, string
;
5410 string
= AREF (items
, i
+ 1);
5411 pos
= AREF (items
, i
+ 3);
5414 if (column
>= XINT (pos
)
5415 && column
< XINT (pos
) + SCHARS (string
))
5417 item
= AREF (items
, i
);
5422 /* ELisp manual 2.4b says (x y) are window relative but
5423 code says they are frame-relative. */
5425 = Fcons (event
->frame_or_window
,
5427 Fcons (Fcons (event
->x
, event
->y
),
5428 Fcons (make_number (event
->timestamp
),
5431 return Fcons (item
, Fcons (position
, Qnil
));
5433 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5435 position
= make_lispy_position (f
, event
->x
, event
->y
,
5438 #ifndef USE_TOOLKIT_SCROLL_BARS
5441 /* It's a scrollbar click. */
5443 Lisp_Object portion_whole
;
5446 window
= event
->frame_or_window
;
5447 portion_whole
= Fcons (event
->x
, event
->y
);
5448 part
= *scroll_bar_parts
[(int) event
->part
];
5452 Fcons (Qvertical_scroll_bar
,
5453 Fcons (portion_whole
,
5454 Fcons (make_number (event
->timestamp
),
5455 Fcons (part
, Qnil
)))));
5457 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5459 if (button
>= ASIZE (button_down_location
))
5461 button_down_location
= larger_vector (button_down_location
,
5463 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5466 start_pos_ptr
= &AREF (button_down_location
, button
);
5467 start_pos
= *start_pos_ptr
;
5468 *start_pos_ptr
= Qnil
;
5471 /* On window-system frames, use the value of
5472 double-click-fuzz as is. On other frames, interpret it
5473 as a multiple of 1/8 characters. */
5477 if (WINDOWP (event
->frame_or_window
))
5478 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5479 else if (FRAMEP (event
->frame_or_window
))
5480 f
= XFRAME (event
->frame_or_window
);
5484 if (FRAME_WINDOW_P (f
))
5485 fuzz
= double_click_fuzz
;
5487 fuzz
= double_click_fuzz
/ 8;
5489 is_double
= (button
== last_mouse_button
5490 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5491 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5492 && button_down_time
!= 0
5493 && (EQ (Vdouble_click_time
, Qt
)
5494 || (INTEGERP (Vdouble_click_time
)
5495 && ((int)(event
->timestamp
- button_down_time
)
5496 < XINT (Vdouble_click_time
)))));
5499 last_mouse_button
= button
;
5500 last_mouse_x
= XINT (event
->x
);
5501 last_mouse_y
= XINT (event
->y
);
5503 /* If this is a button press, squirrel away the location, so
5504 we can decide later whether it was a click or a drag. */
5505 if (event
->modifiers
& down_modifier
)
5509 double_click_count
++;
5510 event
->modifiers
|= ((double_click_count
> 2)
5515 double_click_count
= 1;
5516 button_down_time
= event
->timestamp
;
5517 *start_pos_ptr
= Fcopy_alist (position
);
5518 ignore_mouse_drag_p
= 0;
5521 /* Now we're releasing a button - check the co-ordinates to
5522 see if this was a click or a drag. */
5523 else if (event
->modifiers
& up_modifier
)
5525 /* If we did not see a down before this up, ignore the up.
5526 Probably this happened because the down event chose a
5527 menu item. It would be an annoyance to treat the
5528 release of the button that chose the menu item as a
5531 if (!CONSP (start_pos
))
5534 event
->modifiers
&= ~up_modifier
;
5537 Lisp_Object new_down
, down
;
5538 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5540 /* The third element of every position
5541 should be the (x,y) pair. */
5542 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5543 new_down
= Fcar (Fcdr (Fcdr (position
)));
5546 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5548 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5549 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5552 if (ignore_mouse_drag_p
)
5554 event
->modifiers
|= click_modifier
;
5555 ignore_mouse_drag_p
= 0;
5557 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5558 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5559 /* Maybe the mouse has moved a lot, caused scrolling, and
5560 eventually ended up at the same screen position (but
5561 not buffer position) in which case it is a drag, not
5563 /* FIXME: OTOH if the buffer position has changed
5564 because of a timer or process filter rather than
5565 because of mouse movement, it should be considered as
5566 a click. But mouse-drag-region completely ignores
5567 this case and it hasn't caused any real problem, so
5568 it's probably OK to ignore it as well. */
5569 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5570 /* Mouse hasn't moved (much). */
5571 event
->modifiers
|= click_modifier
;
5574 button_down_time
= 0;
5575 event
->modifiers
|= drag_modifier
;
5578 /* Don't check is_double; treat this as multiple
5579 if the down-event was multiple. */
5580 if (double_click_count
> 1)
5581 event
->modifiers
|= ((double_click_count
> 2)
5587 /* Every mouse event should either have the down_modifier or
5588 the up_modifier set. */
5592 /* Get the symbol we should use for the mouse click. */
5595 head
= modify_event_symbol (button
,
5597 Qmouse_click
, Vlispy_mouse_stem
,
5600 XVECTOR (mouse_syms
)->size
);
5601 if (event
->modifiers
& drag_modifier
)
5606 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5609 Fcons (make_number (double_click_count
),
5619 case HORIZ_WHEEL_EVENT
:
5621 Lisp_Object position
;
5624 /* Build the position as appropriate for this mouse click. */
5625 struct frame
*f
= XFRAME (event
->frame_or_window
);
5627 /* Ignore wheel events that were made on frame that have been
5629 if (! FRAME_LIVE_P (f
))
5632 position
= make_lispy_position (f
, event
->x
, event
->y
,
5635 /* Set double or triple modifiers to indicate the wheel speed. */
5637 /* On window-system frames, use the value of
5638 double-click-fuzz as is. On other frames, interpret it
5639 as a multiple of 1/8 characters. */
5645 if (WINDOWP (event
->frame_or_window
))
5646 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5647 else if (FRAMEP (event
->frame_or_window
))
5648 f
= XFRAME (event
->frame_or_window
);
5652 fuzz
= FRAME_WINDOW_P (f
)
5653 ? double_click_fuzz
: double_click_fuzz
/ 8;
5655 if (event
->modifiers
& up_modifier
)
5657 /* Emit a wheel-up event. */
5658 event
->modifiers
&= ~up_modifier
;
5661 else if (event
->modifiers
& down_modifier
)
5663 /* Emit a wheel-down event. */
5664 event
->modifiers
&= ~down_modifier
;
5668 /* Every wheel event should either have the down_modifier or
5669 the up_modifier set. */
5672 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5675 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5676 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5677 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5678 && button_down_time
!= 0
5679 && (EQ (Vdouble_click_time
, Qt
)
5680 || (INTEGERP (Vdouble_click_time
)
5681 && ((int)(event
->timestamp
- button_down_time
)
5682 < XINT (Vdouble_click_time
)))));
5685 double_click_count
++;
5686 event
->modifiers
|= ((double_click_count
> 2)
5692 double_click_count
= 1;
5693 event
->modifiers
|= click_modifier
;
5696 button_down_time
= event
->timestamp
;
5697 /* Use a negative value to distinguish wheel from mouse button. */
5698 last_mouse_button
= - (1 + symbol_num
);
5699 last_mouse_x
= XINT (event
->x
);
5700 last_mouse_y
= XINT (event
->y
);
5702 /* Get the symbol we should use for the wheel event. */
5703 head
= modify_event_symbol (symbol_num
,
5709 ASIZE (wheel_syms
));
5712 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5715 Fcons (make_number (double_click_count
),
5724 #ifdef USE_TOOLKIT_SCROLL_BARS
5726 /* We don't have down and up events if using toolkit scroll bars,
5727 so make this always a click event. Store in the `part' of
5728 the Lisp event a symbol which maps to the following actions:
5730 `above_handle' page up
5731 `below_handle' page down
5735 `bottom' bottom of buffer
5736 `handle' thumb has been dragged.
5737 `end-scroll' end of interaction with scroll bar
5739 The incoming input_event contains in its `part' member an
5740 index of type `enum scroll_bar_part' which we can use as an
5741 index in scroll_bar_parts to get the appropriate symbol. */
5743 case SCROLL_BAR_CLICK_EVENT
:
5745 Lisp_Object position
, head
, window
, portion_whole
, part
;
5747 window
= event
->frame_or_window
;
5748 portion_whole
= Fcons (event
->x
, event
->y
);
5749 part
= *scroll_bar_parts
[(int) event
->part
];
5753 Fcons (Qvertical_scroll_bar
,
5754 Fcons (portion_whole
,
5755 Fcons (make_number (event
->timestamp
),
5756 Fcons (part
, Qnil
)))));
5758 /* Always treat scroll bar events as clicks. */
5759 event
->modifiers
|= click_modifier
;
5760 event
->modifiers
&= ~up_modifier
;
5762 if (event
->code
>= ASIZE (mouse_syms
))
5763 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5765 /* Get the symbol we should use for the mouse click. */
5766 head
= modify_event_symbol (event
->code
,
5771 XVECTOR (mouse_syms
)->size
);
5772 return Fcons (head
, Fcons (position
, Qnil
));
5775 #endif /* USE_TOOLKIT_SCROLL_BARS */
5777 case DRAG_N_DROP_EVENT
:
5780 Lisp_Object head
, position
;
5783 f
= XFRAME (event
->frame_or_window
);
5786 /* Ignore mouse events that were made on frames that
5787 have been deleted. */
5788 if (! FRAME_LIVE_P (f
))
5791 position
= make_lispy_position (f
, event
->x
, event
->y
,
5794 head
= modify_event_symbol (0, event
->modifiers
,
5796 lispy_drag_n_drop_names
,
5797 &drag_n_drop_syms
, 1);
5803 #endif /* HAVE_MOUSE */
5805 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5806 || defined(HAVE_NS) || defined (USE_GTK)
5807 case MENU_BAR_EVENT
:
5808 if (EQ (event
->arg
, event
->frame_or_window
))
5809 /* This is the prefix key. We translate this to
5810 `(menu_bar)' because the code in keyboard.c for menu
5811 events, which we use, relies on this. */
5812 return Fcons (Qmenu_bar
, Qnil
);
5816 case SELECT_WINDOW_EVENT
:
5817 /* Make an event (select-window (WINDOW)). */
5818 return Fcons (Qselect_window
,
5819 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5822 case TOOL_BAR_EVENT
:
5823 if (EQ (event
->arg
, event
->frame_or_window
))
5824 /* This is the prefix key. We translate this to
5825 `(tool_bar)' because the code in keyboard.c for tool bar
5826 events, which we use, relies on this. */
5827 return Fcons (Qtool_bar
, Qnil
);
5828 else if (SYMBOLP (event
->arg
))
5829 return apply_modifiers (event
->modifiers
, event
->arg
);
5832 case USER_SIGNAL_EVENT
:
5833 /* A user signal. */
5835 char *name
= find_user_signal_name (event
->code
);
5838 return intern (name
);
5841 case SAVE_SESSION_EVENT
:
5842 return Qsave_session
;
5847 return Fcons (Qdbus_event
, event
->arg
);
5849 #endif /* HAVE_DBUS */
5851 case CONFIG_CHANGED_EVENT
:
5852 return Fcons (Qconfig_changed_event
,
5854 Fcons (event
->frame_or_window
, Qnil
)));
5856 case GPM_CLICK_EVENT
:
5858 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5859 Lisp_Object head
, position
;
5860 Lisp_Object
*start_pos_ptr
;
5861 Lisp_Object start_pos
;
5862 int button
= event
->code
;
5864 if (button
>= ASIZE (button_down_location
))
5866 button_down_location
= larger_vector (button_down_location
,
5868 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5871 start_pos_ptr
= &AREF (button_down_location
, button
);
5872 start_pos
= *start_pos_ptr
;
5874 position
= make_lispy_position (f
, event
->x
, event
->y
,
5877 if (event
->modifiers
& down_modifier
)
5878 *start_pos_ptr
= Fcopy_alist (position
);
5879 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5881 if (!CONSP (start_pos
))
5883 event
->modifiers
&= ~up_modifier
;
5886 head
= modify_event_symbol (button
,
5888 Qmouse_click
, Vlispy_mouse_stem
,
5891 XVECTOR (mouse_syms
)->size
);
5893 if (event
->modifiers
& drag_modifier
)
5898 else if (event
->modifiers
& double_modifier
)
5901 Fcons (make_number (2),
5903 else if (event
->modifiers
& triple_modifier
)
5906 Fcons (make_number (3),
5913 #endif /* HAVE_GPM */
5915 /* The 'kind' field of the event is something we don't recognize. */
5921 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
5924 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5925 Lisp_Object x
, Lisp_Object y
, unsigned long time
)
5927 /* Is it a scroll bar movement? */
5928 if (frame
&& ! NILP (bar_window
))
5930 Lisp_Object part_sym
;
5932 part_sym
= *scroll_bar_parts
[(int) part
];
5933 return Fcons (Qscroll_bar_movement
,
5934 Fcons (list5 (bar_window
,
5935 Qvertical_scroll_bar
,
5941 /* Or is it an ordinary mouse movement? */
5944 Lisp_Object position
;
5945 position
= make_lispy_position (frame
, x
, y
, time
);
5946 return list2 (Qmouse_movement
, position
);
5950 #endif /* HAVE_MOUSE || HAVE GPM */
5952 /* Construct a switch frame event. */
5954 make_lispy_switch_frame (Lisp_Object frame
)
5956 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5959 /* Manipulating modifiers. */
5961 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5963 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5964 SYMBOL's name of the end of the modifiers; the string from this
5965 position is the unmodified symbol name.
5967 This doesn't use any caches. */
5970 parse_modifiers_uncached (Lisp_Object symbol
, int *modifier_end
)
5976 CHECK_SYMBOL (symbol
);
5979 name
= SYMBOL_NAME (symbol
);
5981 for (i
= 0; i
+2 <= SBYTES (name
); )
5983 int this_mod_end
= 0;
5986 /* See if the name continues with a modifier word.
5987 Check that the word appears, but don't check what follows it.
5988 Set this_mod and this_mod_end to record what we find. */
5990 switch (SREF (name
, i
))
5992 #define SINGLE_LETTER_MOD(BIT) \
5993 (this_mod_end = i + 1, this_mod = BIT)
5996 SINGLE_LETTER_MOD (alt_modifier
);
6000 SINGLE_LETTER_MOD (ctrl_modifier
);
6004 SINGLE_LETTER_MOD (hyper_modifier
);
6008 SINGLE_LETTER_MOD (meta_modifier
);
6012 SINGLE_LETTER_MOD (shift_modifier
);
6016 SINGLE_LETTER_MOD (super_modifier
);
6019 #undef SINGLE_LETTER_MOD
6021 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6022 if (i + LEN + 1 <= SBYTES (name) \
6023 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6025 this_mod_end = i + LEN; \
6030 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6031 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6032 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6036 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6038 #undef MULTI_LETTER_MOD
6042 /* If we found no modifier, stop looking for them. */
6043 if (this_mod_end
== 0)
6046 /* Check there is a dash after the modifier, so that it
6047 really is a modifier. */
6048 if (this_mod_end
>= SBYTES (name
)
6049 || SREF (name
, this_mod_end
) != '-')
6052 /* This modifier is real; look for another. */
6053 modifiers
|= this_mod
;
6054 i
= this_mod_end
+ 1;
6057 /* Should we include the `click' modifier? */
6058 if (! (modifiers
& (down_modifier
| drag_modifier
6059 | double_modifier
| triple_modifier
))
6060 && i
+ 7 == SBYTES (name
)
6061 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6062 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6063 modifiers
|= click_modifier
;
6065 if (! (modifiers
& (double_modifier
| triple_modifier
))
6066 && i
+ 6 < SBYTES (name
)
6067 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6068 modifiers
|= click_modifier
;
6076 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6077 prepended to the string BASE[0..BASE_LEN-1].
6078 This doesn't use any caches. */
6080 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6082 /* Since BASE could contain nulls, we can't use intern here; we have
6083 to use Fintern, which expects a genuine Lisp_String, and keeps a
6086 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6092 /* Only the event queue may use the `up' modifier; it should always
6093 be turned into a click or drag event before presented to lisp code. */
6094 if (modifiers
& up_modifier
)
6097 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6098 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6099 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6100 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6101 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6102 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6103 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6104 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6105 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6106 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6107 /* The click modifier is denoted by the absence of other modifiers. */
6111 mod_len
= p
- new_mods
;
6115 Lisp_Object new_name
;
6117 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6118 mod_len
+ base_len_byte
);
6119 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6120 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6122 return Fintern (new_name
, Qnil
);
6127 static const char *const modifier_names
[] =
6129 "up", "down", "drag", "click", "double", "triple", 0, 0,
6130 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6131 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6133 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6135 static Lisp_Object modifier_symbols
;
6137 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6139 lispy_modifier_list (int modifiers
)
6141 Lisp_Object modifier_list
;
6144 modifier_list
= Qnil
;
6145 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6146 if (modifiers
& (1<<i
))
6147 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6150 return modifier_list
;
6154 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6155 where UNMODIFIED is the unmodified form of SYMBOL,
6156 MASK is the set of modifiers present in SYMBOL's name.
6157 This is similar to parse_modifiers_uncached, but uses the cache in
6158 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6159 Qevent_symbol_elements property. */
6161 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6164 parse_modifiers (Lisp_Object symbol
)
6166 Lisp_Object elements
;
6168 if (INTEGERP (symbol
))
6169 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6170 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6172 else if (!SYMBOLP (symbol
))
6175 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6176 if (CONSP (elements
))
6181 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6182 Lisp_Object unmodified
;
6185 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6186 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6189 if (modifiers
& ~INTMASK
)
6191 XSETFASTINT (mask
, modifiers
);
6192 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6194 /* Cache the parsing results on SYMBOL. */
6195 Fput (symbol
, Qevent_symbol_element_mask
,
6197 Fput (symbol
, Qevent_symbol_elements
,
6198 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6200 /* Since we know that SYMBOL is modifiers applied to unmodified,
6201 it would be nice to put that in unmodified's cache.
6202 But we can't, since we're not sure that parse_modifiers is
6209 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6210 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6211 doc
: /* Parse the event symbol. For internal use. */)
6212 (Lisp_Object symbol
)
6214 /* Fill the cache if needed. */
6215 parse_modifiers (symbol
);
6216 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6217 and use the Lispier representation stored on Qevent_symbol_elements
6219 return Fget (symbol
, Qevent_symbol_elements
);
6222 /* Apply the modifiers MODIFIERS to the symbol BASE.
6223 BASE must be unmodified.
6225 This is like apply_modifiers_uncached, but uses BASE's
6226 Qmodifier_cache property, if present. It also builds
6227 Qevent_symbol_elements properties, since it has that info anyway.
6229 apply_modifiers copies the value of BASE's Qevent_kind property to
6230 the modified symbol. */
6232 apply_modifiers (int modifiers
, Lisp_Object base
)
6234 Lisp_Object cache
, index
, entry
, new_symbol
;
6236 /* Mask out upper bits. We don't know where this value's been. */
6237 modifiers
&= INTMASK
;
6239 if (INTEGERP (base
))
6240 return make_number (XINT (base
) | modifiers
);
6242 /* The click modifier never figures into cache indices. */
6243 cache
= Fget (base
, Qmodifier_cache
);
6244 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6245 entry
= assq_no_quit (index
, cache
);
6248 new_symbol
= XCDR (entry
);
6251 /* We have to create the symbol ourselves. */
6252 new_symbol
= apply_modifiers_uncached (modifiers
,
6253 SDATA (SYMBOL_NAME (base
)),
6254 SCHARS (SYMBOL_NAME (base
)),
6255 SBYTES (SYMBOL_NAME (base
)));
6257 /* Add the new symbol to the base's cache. */
6258 entry
= Fcons (index
, new_symbol
);
6259 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6261 /* We have the parsing info now for free, so we could add it to
6263 XSETFASTINT (index, modifiers);
6264 Fput (new_symbol, Qevent_symbol_element_mask,
6265 Fcons (base, Fcons (index, Qnil)));
6266 Fput (new_symbol, Qevent_symbol_elements,
6267 Fcons (base, lispy_modifier_list (modifiers)));
6268 Sadly, this is only correct if `base' is indeed a base event,
6269 which is not necessarily the case. -stef */
6272 /* Make sure this symbol is of the same kind as BASE.
6274 You'd think we could just set this once and for all when we
6275 intern the symbol above, but reorder_modifiers may call us when
6276 BASE's property isn't set right; we can't assume that just
6277 because it has a Qmodifier_cache property it must have its
6278 Qevent_kind set right as well. */
6279 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6283 kind
= Fget (base
, Qevent_kind
);
6285 Fput (new_symbol
, Qevent_kind
, kind
);
6292 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6293 return a symbol with the modifiers placed in the canonical order.
6294 Canonical order is alphabetical, except for down and drag, which
6295 always come last. The 'click' modifier is never written out.
6297 Fdefine_key calls this to make sure that (for example) C-M-foo
6298 and M-C-foo end up being equivalent in the keymap. */
6301 reorder_modifiers (Lisp_Object symbol
)
6303 /* It's hopefully okay to write the code this way, since everything
6304 will soon be in caches, and no consing will be done at all. */
6307 parsed
= parse_modifiers (symbol
);
6308 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6313 /* For handling events, we often want to produce a symbol whose name
6314 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6315 to some base, like the name of a function key or mouse button.
6316 modify_event_symbol produces symbols of this sort.
6318 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6319 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6322 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6323 into symbol names, or a string specifying a name stem used to
6324 construct a symbol name or the form `STEM-N', where N is the decimal
6325 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6326 non-nil; otherwise NAME_TABLE is used.
6328 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6329 persist between calls to modify_event_symbol that it can use to
6330 store a cache of the symbols it's generated for this NAME_TABLE
6331 before. The object stored there may be a vector or an alist.
6333 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6335 MODIFIERS is a set of modifier bits (as given in struct input_events)
6336 whose prefixes should be applied to the symbol name.
6338 SYMBOL_KIND is the value to be placed in the event_kind property of
6339 the returned symbol.
6341 The symbols we create are supposed to have an
6342 `event-symbol-elements' property, which lists the modifiers present
6343 in the symbol's name. */
6346 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6347 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6348 Lisp_Object
*symbol_table
, unsigned int table_size
)
6351 Lisp_Object symbol_int
;
6353 /* Get rid of the "vendor-specific" bit here. */
6354 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6356 /* Is this a request for a valid symbol? */
6357 if (symbol_num
< 0 || symbol_num
>= table_size
)
6360 if (CONSP (*symbol_table
))
6361 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6363 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6364 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6365 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6366 we've never used that symbol before. */
6369 if (! VECTORP (*symbol_table
)
6370 || XVECTOR (*symbol_table
)->size
!= table_size
)
6374 XSETFASTINT (size
, table_size
);
6375 *symbol_table
= Fmake_vector (size
, Qnil
);
6378 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6381 /* Have we already used this symbol before? */
6384 /* No; let's create it. */
6385 if (CONSP (name_alist_or_stem
))
6386 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6387 else if (STRINGP (name_alist_or_stem
))
6389 int len
= SBYTES (name_alist_or_stem
);
6390 char *buf
= (char *) alloca (len
+ 50);
6391 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6392 (long) XINT (symbol_int
) + 1);
6393 value
= intern (buf
);
6395 else if (name_table
!= 0 && name_table
[symbol_num
])
6396 value
= intern (name_table
[symbol_num
]);
6398 #ifdef HAVE_WINDOW_SYSTEM
6401 char *name
= x_get_keysym_name (symbol_num
);
6403 value
= intern (name
);
6410 sprintf (buf
, "key-%ld", (long)symbol_num
);
6411 value
= intern (buf
);
6414 if (CONSP (*symbol_table
))
6415 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6417 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6419 /* Fill in the cache entries for this symbol; this also
6420 builds the Qevent_symbol_elements property, which the user
6422 apply_modifiers (modifiers
& click_modifier
, value
);
6423 Fput (value
, Qevent_kind
, symbol_kind
);
6426 /* Apply modifiers to that symbol. */
6427 return apply_modifiers (modifiers
, value
);
6430 /* Convert a list that represents an event type,
6431 such as (ctrl meta backspace), into the usual representation of that
6432 event type as a number or a symbol. */
6434 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6435 doc
: /* Convert the event description list EVENT-DESC to an event type.
6436 EVENT-DESC should contain one base event type (a character or symbol)
6437 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6438 drag, down, double or triple). The base must be last.
6439 The return value is an event type (a character or symbol) which
6440 has the same base event type and all the specified modifiers. */)
6441 (Lisp_Object event_desc
)
6449 while (CONSP (rest
))
6457 /* Given a symbol, see if it is a modifier name. */
6458 if (SYMBOLP (elt
) && CONSP (rest
))
6459 this = parse_solitary_modifier (elt
);
6463 else if (!NILP (base
))
6464 error ("Two bases given in one event");
6470 /* Let the symbol A refer to the character A. */
6471 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6472 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6474 if (INTEGERP (base
))
6476 /* Turn (shift a) into A. */
6477 if ((modifiers
& shift_modifier
) != 0
6478 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6480 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6481 modifiers
&= ~shift_modifier
;
6484 /* Turn (control a) into C-a. */
6485 if (modifiers
& ctrl_modifier
)
6486 return make_number ((modifiers
& ~ctrl_modifier
)
6487 | make_ctrl_char (XINT (base
)));
6489 return make_number (modifiers
| XINT (base
));
6491 else if (SYMBOLP (base
))
6492 return apply_modifiers (modifiers
, base
);
6495 error ("Invalid base event");
6500 /* Try to recognize SYMBOL as a modifier name.
6501 Return the modifier flag bit, or 0 if not recognized. */
6504 parse_solitary_modifier (Lisp_Object symbol
)
6506 Lisp_Object name
= SYMBOL_NAME (symbol
);
6508 switch (SREF (name
, 0))
6510 #define SINGLE_LETTER_MOD(BIT) \
6511 if (SBYTES (name) == 1) \
6514 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6515 if (LEN == SBYTES (name) \
6516 && ! strncmp (SDATA (name), NAME, LEN)) \
6520 SINGLE_LETTER_MOD (alt_modifier
);
6524 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6528 SINGLE_LETTER_MOD (ctrl_modifier
);
6532 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6533 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6537 SINGLE_LETTER_MOD (hyper_modifier
);
6541 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6545 SINGLE_LETTER_MOD (meta_modifier
);
6549 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6553 SINGLE_LETTER_MOD (shift_modifier
);
6557 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6558 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6559 SINGLE_LETTER_MOD (super_modifier
);
6563 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6564 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6565 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6569 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6572 #undef SINGLE_LETTER_MOD
6573 #undef MULTI_LETTER_MOD
6579 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6580 Such a list is not valid as an event,
6581 but it can be a Lucid-style event type list. */
6584 lucid_event_type_list_p (Lisp_Object object
)
6588 if (! CONSP (object
))
6591 if (EQ (XCAR (object
), Qhelp_echo
)
6592 || EQ (XCAR (object
), Qvertical_line
)
6593 || EQ (XCAR (object
), Qmode_line
)
6594 || EQ (XCAR (object
), Qheader_line
))
6597 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6601 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6608 /* Store into *addr a value nonzero if terminal input chars are available.
6609 Serves the purpose of ioctl (0, FIONREAD, addr)
6610 but works even if FIONREAD does not exist.
6611 (In fact, this may actually read some input.)
6613 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6614 timer events that are ripe.
6615 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6616 events (FOCUS_IN_EVENT).
6617 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6618 movements and toolkit scroll bar thumb drags. */
6621 get_input_pending (int *addr
, int flags
)
6623 /* First of all, have we already counted some input? */
6624 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6626 /* If input is being read as it arrives, and we have none, there is none. */
6627 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6630 /* Try to read some input and see how much we get. */
6632 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6635 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6638 gobble_input (int expected
)
6641 if (interrupt_input
)
6644 mask
= sigblock (sigmask (SIGIO
));
6645 read_avail_input (expected
);
6649 #ifdef POLL_FOR_INPUT
6650 /* XXX This condition was (read_socket_hook && !interrupt_input),
6651 but read_socket_hook is not global anymore. Let's pretend that
6653 if (!interrupt_input
&& poll_suppress_count
== 0)
6656 mask
= sigblock (sigmask (SIGALRM
));
6657 read_avail_input (expected
);
6663 read_avail_input (expected
);
6666 /* Put a BUFFER_SWITCH_EVENT in the buffer
6667 so that read_key_sequence will notice the new current buffer. */
6670 record_asynch_buffer_change (void)
6672 struct input_event event
;
6676 event
.kind
= BUFFER_SWITCH_EVENT
;
6677 event
.frame_or_window
= Qnil
;
6680 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6681 The purpose of the event is to make read_key_sequence look up the
6682 keymaps again. If we aren't in read_key_sequence, we don't need one,
6683 and the event could cause trouble by messing up (input-pending-p).
6684 Note: Fwaiting_for_user_input_p always returns nil when async
6685 subprocesses aren't supported. */
6686 tem
= Fwaiting_for_user_input_p ();
6690 /* Make sure no interrupt happens while storing the event. */
6692 if (interrupt_input
)
6695 mask
= sigblock (sigmask (SIGIO
));
6696 kbd_buffer_store_event (&event
);
6703 kbd_buffer_store_event (&event
);
6708 /* Read any terminal input already buffered up by the system
6709 into the kbd_buffer, but do not wait.
6711 EXPECTED should be nonzero if the caller knows there is some input.
6713 Returns the number of keyboard chars read, or -1 meaning
6714 this is a bad time to try to read input. */
6717 read_avail_input (int expected
)
6723 /* Store pending user signal events, if any. */
6724 if (store_user_signal_events ())
6727 /* Loop through the available terminals, and call their input hooks. */
6731 struct terminal
*next
= t
->next_terminal
;
6733 if (t
->read_socket_hook
)
6736 struct input_event hold_quit
;
6738 EVENT_INIT (hold_quit
);
6739 hold_quit
.kind
= NO_EVENT
;
6741 /* No need for FIONREAD or fcntl; just say don't wait. */
6742 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6748 if (nr
== -1) /* Not OK to read input now. */
6752 else if (nr
== -2) /* Non-transient error. */
6754 /* The terminal device terminated; it should be closed. */
6756 /* Kill Emacs if this was our last terminal. */
6757 if (!terminal_list
->next_terminal
)
6758 /* Formerly simply reported no input, but that
6759 sometimes led to a failure of Emacs to terminate.
6760 SIGHUP seems appropriate if we can't reach the
6762 /* ??? Is it really right to send the signal just to
6763 this process rather than to the whole process
6764 group? Perhaps on systems with FIONREAD Emacs is
6765 alone in its group. */
6766 kill (getpid (), SIGHUP
);
6768 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6771 XSETTERMINAL (tmp
, t
);
6772 Fdelete_terminal (tmp
, Qnoelisp
);
6776 if (hold_quit
.kind
!= NO_EVENT
)
6777 kbd_buffer_store_event (&hold_quit
);
6786 frame_make_pointer_visible ();
6792 decode_keyboard_code (struct tty_display_info
*tty
,
6793 struct coding_system
*coding
,
6794 unsigned char *buf
, int nbytes
)
6796 unsigned char *src
= buf
;
6797 const unsigned char *p
;
6802 if (tty
->meta_key
!= 2)
6803 for (i
= 0; i
< nbytes
; i
++)
6805 if (coding
->carryover_bytes
> 0)
6807 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6808 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6809 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6810 nbytes
+= coding
->carryover_bytes
;
6812 coding
->destination
= alloca (nbytes
* 4);
6813 coding
->dst_bytes
= nbytes
* 4;
6814 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6815 if (coding
->produced_char
== 0)
6817 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6819 struct input_event buf
;
6822 buf
.code
= STRING_CHAR_ADVANCE (p
);
6823 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
6824 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6825 /* See the comment in tty_read_avail_input. */
6826 buf
.frame_or_window
= tty
->top_frame
;
6828 kbd_buffer_store_event (&buf
);
6832 /* This is the tty way of reading available input.
6834 Note that each terminal device has its own `struct terminal' object,
6835 and so this function is called once for each individual termcap
6836 terminal. The first parameter indicates which terminal to read from. */
6839 tty_read_avail_input (struct terminal
*terminal
,
6841 struct input_event
*hold_quit
)
6843 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6844 the kbd_buffer can really hold. That may prevent loss
6845 of characters on some systems when input is stuffed at us. */
6846 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6848 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6851 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6853 if (kbd_on_hold_p () || buffer_free
<= 0)
6855 #endif /* subprocesses */
6857 if (!terminal
->name
) /* Don't read from a dead terminal. */
6860 if (terminal
->type
!= output_termcap
6861 && terminal
->type
!= output_msdos_raw
)
6864 /* XXX I think the following code should be moved to separate hook
6865 functions in system-dependent files. */
6868 #else /* not WINDOWSNT */
6869 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6873 return 0; /* The terminal is suspended. */
6876 n_to_read
= dos_keysns ();
6880 cbuf
[0] = dos_keyread ();
6883 #else /* not MSDOS */
6888 struct input_event hold_quit
;
6889 int gpm
, fd
= gpm_fd
;
6891 EVENT_INIT (hold_quit
);
6892 hold_quit
.kind
= NO_EVENT
;
6894 /* gpm==1 if event received.
6895 gpm==0 if the GPM daemon has closed the connection, in which case
6896 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6897 we save it in `fd' so close_gpm can remove it from the
6899 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6900 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6901 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
6904 /* Presumably the GPM daemon has closed the connection. */
6906 if (hold_quit
.kind
!= NO_EVENT
)
6907 kbd_buffer_store_event (&hold_quit
);
6911 #endif /* HAVE_GPM */
6913 /* Determine how many characters we should *try* to read. */
6915 /* Find out how much input is available. */
6916 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6918 if (! noninteractive
)
6919 return -2; /* Close this terminal. */
6925 if (n_to_read
> sizeof cbuf
)
6926 n_to_read
= sizeof cbuf
;
6927 #else /* no FIONREAD */
6928 #if defined (USG) || defined(CYGWIN)
6929 /* Read some input if available, but don't wait. */
6930 n_to_read
= sizeof cbuf
;
6931 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6938 /* Don't read more than we can store. */
6939 if (n_to_read
> buffer_free
)
6940 n_to_read
= buffer_free
;
6941 #endif /* subprocesses */
6943 /* Now read; for one reason or another, this will not block.
6944 NREAD is set to the number of chars read. */
6947 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6948 /* POSIX infers that processes which are not in the session leader's
6949 process group won't get SIGHUP's at logout time. BSDI adheres to
6950 this part standard and returns -1 from read (0) with errno==EIO
6951 when the control tty is taken away.
6952 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6953 if (nread
== -1 && errno
== EIO
)
6954 return -2; /* Close this terminal. */
6955 #if defined (AIX) && defined (_BSD)
6956 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6957 This looks incorrect, but it isn't, because _BSD causes
6958 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6959 and that causes a value other than 0 when there is no input. */
6961 return -2; /* Close this terminal. */
6965 /* We used to retry the read if it was interrupted.
6966 But this does the wrong thing when O_NDELAY causes
6967 an EAGAIN error. Does anybody know of a situation
6968 where a retry is actually needed? */
6970 nread
< 0 && (errno
== EAGAIN
6984 #if defined (USG) || defined (CYGWIN)
6985 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6986 #endif /* USG or CYGWIN */
6987 #endif /* no FIONREAD */
6992 #endif /* not MSDOS */
6993 #endif /* not WINDOWSNT */
6995 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
6996 & CODING_REQUIRE_DECODING_MASK
)
6998 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7001 /* Decode the key sequence except for those with meta
7003 for (i
= from
= 0; ; i
++)
7004 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7006 struct input_event buf
;
7008 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7013 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7014 buf
.modifiers
= meta_modifier
;
7015 buf
.code
= cbuf
[i
] & ~0x80;
7016 /* See the comment below. */
7017 buf
.frame_or_window
= tty
->top_frame
;
7019 kbd_buffer_store_event (&buf
);
7025 for (i
= 0; i
< nread
; i
++)
7027 struct input_event buf
;
7029 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7031 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7032 buf
.modifiers
= meta_modifier
;
7033 if (tty
->meta_key
!= 2)
7037 /* Set the frame corresponding to the active tty. Note that the
7038 value of selected_frame is not reliable here, redisplay tends
7039 to temporarily change it. */
7040 buf
.frame_or_window
= tty
->top_frame
;
7043 kbd_buffer_store_event (&buf
);
7044 /* Don't look at input that follows a C-g too closely.
7045 This reduces lossage due to autorepeat on C-g. */
7046 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7047 && buf
.code
== quit_char
)
7055 handle_async_input (void)
7057 interrupt_input_pending
= 0;
7059 pending_signals
= pending_atimers
;
7061 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7062 doing anything dangerous. */
7069 nread
= read_avail_input (1);
7070 /* -1 means it's not ok to read the input now.
7071 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7072 0 means there was no keyboard input available. */
7082 process_pending_signals (void)
7084 if (interrupt_input_pending
)
7085 handle_async_input ();
7086 do_pending_atimers ();
7089 #ifdef SIGIO /* for entire page */
7090 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7093 input_available_signal (int signo
)
7095 /* Must preserve main program's value of errno. */
7096 int old_errno
= errno
;
7097 SIGNAL_THREAD_CHECK (signo
);
7100 interrupt_input_pending
= 1;
7101 pending_signals
= 1;
7104 if (input_available_clear_time
)
7105 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7108 handle_async_input ();
7115 /* Send ourselves a SIGIO.
7117 This function exists so that the UNBLOCK_INPUT macro in
7118 blockinput.h can have some way to take care of input we put off
7119 dealing with, without assuming that every file which uses
7120 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7122 reinvoke_input_signal (void)
7125 handle_async_input ();
7131 /* User signal events. */
7133 struct user_signal_info
7135 /* Signal number. */
7138 /* Name of the signal. */
7141 /* Number of pending signals. */
7144 struct user_signal_info
*next
;
7147 /* List of user signals. */
7148 static struct user_signal_info
*user_signals
= NULL
;
7151 add_user_signal (int sig
, const char *name
)
7153 struct user_signal_info
*p
;
7155 for (p
= user_signals
; p
; p
= p
->next
)
7157 /* Already added. */
7160 p
= xmalloc (sizeof (struct user_signal_info
));
7162 p
->name
= xstrdup (name
);
7164 p
->next
= user_signals
;
7167 signal (sig
, handle_user_signal
);
7171 handle_user_signal (int sig
)
7173 int old_errno
= errno
;
7174 struct user_signal_info
*p
;
7176 SIGNAL_THREAD_CHECK (sig
);
7178 for (p
= user_signals
; p
; p
= p
->next
)
7183 if (interrupt_input
)
7184 kill (getpid (), SIGIO
);
7188 /* Tell wait_reading_process_output that it needs to wake
7189 up and look around. */
7190 if (input_available_clear_time
)
7191 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7200 find_user_signal_name (int sig
)
7202 struct user_signal_info
*p
;
7204 for (p
= user_signals
; p
; p
= p
->next
)
7212 store_user_signal_events (void)
7214 struct user_signal_info
*p
;
7215 struct input_event buf
;
7218 for (p
= user_signals
; p
; p
= p
->next
)
7219 if (p
->npending
> 0)
7225 memset (&buf
, 0, sizeof buf
);
7226 buf
.kind
= USER_SIGNAL_EVENT
;
7227 buf
.frame_or_window
= selected_frame
;
7229 nstored
+= p
->npending
;
7231 mask
= sigblock (sigmask (p
->sig
));
7235 kbd_buffer_store_event (&buf
);
7238 while (p
->npending
> 0);
7246 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7247 static Lisp_Object menu_bar_one_keymap_changed_items
;
7249 /* These variables hold the vector under construction within
7250 menu_bar_items and its subroutines, and the current index
7251 for storing into that vector. */
7252 static Lisp_Object menu_bar_items_vector
;
7253 static int menu_bar_items_index
;
7256 static const char* separator_names
[] = {
7261 "single-dashed-line",
7262 "double-dashed-line",
7264 "shadow-etched-out",
7265 "shadow-etched-in-dash",
7266 "shadow-etched-out-dash",
7267 "shadow-double-etched-in",
7268 "shadow-double-etched-out",
7269 "shadow-double-etched-in-dash",
7270 "shadow-double-etched-out-dash",
7274 /* Return non-zero if LABEL specifies a separator. */
7277 menu_separator_name_p (const char *label
)
7281 else if (strlen (label
) > 3
7282 && strncmp (label
, "--", 2) == 0
7287 for (i
= 0; separator_names
[i
]; ++i
)
7288 if (strcmp (label
, separator_names
[i
]) == 0)
7293 /* It's a separator if it contains only dashes. */
7294 while (*label
== '-')
7296 return (*label
== 0);
7303 /* Return a vector of menu items for a menu bar, appropriate
7304 to the current buffer. Each item has three elements in the vector:
7307 OLD is an old vector we can optionally reuse, or nil. */
7310 menu_bar_items (Lisp_Object old
)
7312 /* The number of keymaps we're scanning right now, and the number of
7313 keymaps we have allocated space for. */
7316 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7317 in the current keymaps, or nil where it is not a prefix. */
7320 Lisp_Object def
, tail
;
7329 /* In order to build the menus, we need to call the keymap
7330 accessors. They all call QUIT. But this function is called
7331 during redisplay, during which a quit is fatal. So inhibit
7332 quitting while building the menus.
7333 We do this instead of specbind because (1) errors will clear it anyway
7334 and (2) this avoids risk of specpdl overflow. */
7335 oquit
= Vinhibit_quit
;
7339 menu_bar_items_vector
= old
;
7341 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7342 menu_bar_items_index
= 0;
7344 /* Build our list of keymaps.
7345 If we recognize a function key and replace its escape sequence in
7346 keybuf with its symbol, or if the sequence starts with a mouse
7347 click and we need to switch buffers, we jump back here to rebuild
7348 the initial keymaps from the current buffer. */
7352 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7353 if (!NILP (Voverriding_local_map_menu_flag
))
7355 /* Yes, use them (if non-nil) as well as the global map. */
7356 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7358 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7359 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7360 if (!NILP (Voverriding_local_map
))
7361 maps
[nmaps
++] = Voverriding_local_map
;
7365 /* No, so use major and minor mode keymaps and keymap property.
7366 Note that menu-bar bindings in the local-map and keymap
7367 properties may not work reliable, as they are only
7368 recognized when the menu-bar (or mode-line) is updated,
7369 which does not normally happen after every command. */
7372 nminor
= current_minor_maps (NULL
, &tmaps
);
7373 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7375 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7376 maps
[nmaps
++] = tem
;
7377 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7379 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7381 maps
[nmaps
++] = current_global_map
;
7384 /* Look up in each map the dummy prefix key `menu-bar'. */
7388 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7389 if (!NILP (maps
[mapno
]))
7391 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7395 menu_bar_one_keymap_changed_items
= Qnil
;
7396 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7400 /* Move to the end those items that should be at the end. */
7402 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7405 int end
= menu_bar_items_index
;
7407 for (i
= 0; i
< end
; i
+= 4)
7408 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7410 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7411 /* Move the item at index I to the end,
7412 shifting all the others forward. */
7413 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7414 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7415 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7416 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7418 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7419 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7420 (end
- i
- 4) * sizeof (Lisp_Object
));
7421 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7422 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7423 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7424 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7429 /* Add nil, nil, nil, nil at the end. */
7430 i
= menu_bar_items_index
;
7431 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7432 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7433 /* Add this item. */
7434 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7435 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7436 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7437 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7438 menu_bar_items_index
= i
;
7440 Vinhibit_quit
= oquit
;
7441 return menu_bar_items_vector
;
7444 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7445 If there's already an item for KEY, add this DEF to it. */
7447 Lisp_Object item_properties
;
7450 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7452 struct gcpro gcpro1
;
7456 if (EQ (item
, Qundefined
))
7458 /* If a map has an explicit `undefined' as definition,
7459 discard any previously made menu bar item. */
7461 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7462 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7464 if (menu_bar_items_index
> i
+ 4)
7465 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7466 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7467 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7468 menu_bar_items_index
-= 4;
7472 /* If this keymap has already contributed to this KEY,
7473 don't contribute to it a second time. */
7474 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7475 if (!NILP (tem
) || NILP (item
))
7478 menu_bar_one_keymap_changed_items
7479 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7481 /* We add to menu_bar_one_keymap_changed_items before doing the
7482 parse_menu_item, so that if it turns out it wasn't a menu item,
7483 it still correctly hides any further menu item. */
7485 i
= parse_menu_item (item
, 1);
7490 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7492 /* Find any existing item for this KEY. */
7493 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7494 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7497 /* If we did not find this KEY, add it at the end. */
7498 if (i
== menu_bar_items_index
)
7500 /* If vector is too small, get a bigger one. */
7501 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7502 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7503 /* Add this item. */
7504 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7505 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7506 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7507 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7508 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7509 menu_bar_items_index
= i
;
7511 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7515 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7516 /* If the new and the old items are not both keymaps,
7517 the lookup will only find `item'. */
7518 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7519 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7523 /* This is used as the handler when calling menu_item_eval_property. */
7525 menu_item_eval_property_1 (Lisp_Object arg
)
7527 /* If we got a quit from within the menu computation,
7528 quit all the way out of it. This takes care of C-] in the debugger. */
7529 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7530 Fsignal (Qquit
, Qnil
);
7535 /* Evaluate an expression and return the result (or nil if something
7536 went wrong). Used to evaluate dynamic parts of menu items. */
7538 menu_item_eval_property (Lisp_Object sexpr
)
7540 int count
= SPECPDL_INDEX ();
7542 specbind (Qinhibit_redisplay
, Qt
);
7543 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7544 menu_item_eval_property_1
);
7545 return unbind_to (count
, val
);
7548 /* This function parses a menu item and leaves the result in the
7549 vector item_properties.
7550 ITEM is a key binding, a possible menu item.
7551 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7553 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7554 parse_menu_item returns true if the item is a menu item and false
7558 parse_menu_item (Lisp_Object item
, int inmenubar
)
7560 Lisp_Object def
, tem
, item_string
, start
;
7562 Lisp_Object keyhint
;
7571 /* Create item_properties vector if necessary. */
7572 if (NILP (item_properties
))
7574 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7576 /* Initialize optional entries. */
7577 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7578 ASET (item_properties
, i
, Qnil
);
7579 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7581 /* Save the item here to protect it from GC. */
7582 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7584 item_string
= XCAR (item
);
7588 if (STRINGP (item_string
))
7590 /* Old format menu item. */
7591 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7593 /* Maybe help string. */
7594 if (CONSP (item
) && STRINGP (XCAR (item
)))
7596 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7601 /* Maybe an obsolete key binding cache. */
7602 if (CONSP (item
) && CONSP (XCAR (item
))
7603 && (NILP (XCAR (XCAR (item
)))
7604 || VECTORP (XCAR (XCAR (item
)))))
7607 /* This is the real definition--the function to run. */
7608 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7610 /* Get enable property, if any. */
7613 tem
= Fget (item
, Qmenu_enable
);
7614 if (!NILP (Venable_disabled_menus_and_buttons
))
7615 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7616 else if (!NILP (tem
))
7617 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7620 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7622 /* New format menu item. */
7623 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7624 start
= XCDR (item
);
7627 /* We have a real binding. */
7628 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7630 item
= XCDR (start
);
7631 /* Is there an obsolete cache list with key equivalences. */
7632 if (CONSP (item
) && CONSP (XCAR (item
)))
7635 /* Parse properties. */
7636 while (CONSP (item
) && CONSP (XCDR (item
)))
7641 if (EQ (tem
, QCenable
))
7643 if (!NILP (Venable_disabled_menus_and_buttons
))
7644 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7646 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7648 else if (EQ (tem
, QCvisible
))
7650 /* If got a visible property and that evaluates to nil
7651 then ignore this item. */
7652 tem
= menu_item_eval_property (XCAR (item
));
7656 else if (EQ (tem
, QChelp
))
7657 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7658 else if (EQ (tem
, QCfilter
))
7660 else if (EQ (tem
, QCkey_sequence
))
7663 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7664 /* Be GC protected. Set keyhint to item instead of tem. */
7667 else if (EQ (tem
, QCkeys
))
7670 if (CONSP (tem
) || STRINGP (tem
))
7671 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7673 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7678 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7680 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7682 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7688 else if (inmenubar
|| !NILP (start
))
7692 return 0; /* not a menu item */
7694 /* If item string is not a string, evaluate it to get string.
7695 If we don't get a string, skip this item. */
7696 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7697 if (!(STRINGP (item_string
)))
7699 item_string
= menu_item_eval_property (item_string
);
7700 if (!STRINGP (item_string
))
7702 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7705 /* If got a filter apply it on definition. */
7706 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7709 def
= menu_item_eval_property (list2 (XCAR (filter
),
7710 list2 (Qquote
, def
)));
7712 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7715 /* Enable or disable selection of item. */
7716 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7719 tem
= menu_item_eval_property (tem
);
7720 if (inmenubar
&& NILP (tem
))
7721 return 0; /* Ignore disabled items in menu bar. */
7722 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7725 /* If we got no definition, this item is just unselectable text which
7726 is OK in a submenu but not in the menubar. */
7728 return (inmenubar
? 0 : 1);
7730 /* See if this is a separate pane or a submenu. */
7731 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7732 tem
= get_keymap (def
, 0, 1);
7733 /* For a subkeymap, just record its details and exit. */
7736 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7737 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7741 /* At the top level in the menu bar, do likewise for commands also.
7742 The menu bar does not display equivalent key bindings anyway.
7743 ITEM_PROPERTY_DEF is already set up properly. */
7747 { /* This is a command. See if there is an equivalent key binding. */
7748 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7750 /* The previous code preferred :key-sequence to :keys, so we
7751 preserve this behavior. */
7752 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7753 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7756 Lisp_Object prefix
= keyeq
;
7757 Lisp_Object keys
= Qnil
;
7761 def
= XCAR (prefix
);
7762 prefix
= XCDR (prefix
);
7765 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7767 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7769 keys
= XCAR (keyhint
);
7770 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7772 /* We have a suggested key. Is it bound to the command? */
7775 /* If the command is an alias for another
7776 (such as lmenu.el set it up), check if the
7777 original command matches the cached command. */
7778 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7783 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7787 tem
= Fkey_description (keys
, Qnil
);
7790 if (STRINGP (XCAR (prefix
)))
7791 tem
= concat2 (XCAR (prefix
), tem
);
7792 if (STRINGP (XCDR (prefix
)))
7793 tem
= concat2 (tem
, XCDR (prefix
));
7795 keyeq
= concat2 (build_string (" "), tem
);
7796 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7802 /* If we have an equivalent key binding, use that. */
7803 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7806 /* Include this when menu help is implemented.
7807 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7808 if (!(NILP (tem) || STRINGP (tem)))
7810 tem = menu_item_eval_property (tem);
7813 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7817 /* Handle radio buttons or toggle boxes. */
7818 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7820 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7821 menu_item_eval_property (tem
));
7828 /***********************************************************************
7830 ***********************************************************************/
7832 /* A vector holding tool bar items while they are parsed in function
7833 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7836 static Lisp_Object tool_bar_items_vector
;
7838 /* A vector holding the result of parse_tool_bar_item. Layout is like
7839 the one for a single item in tool_bar_items_vector. */
7841 static Lisp_Object tool_bar_item_properties
;
7843 /* Next free index in tool_bar_items_vector. */
7845 static int ntool_bar_items
;
7847 /* The symbols `:image' and `:rtl'. */
7849 Lisp_Object QCimage
;
7852 /* Function prototypes. */
7854 static void init_tool_bar_items (Lisp_Object
);
7855 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7856 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7857 static void append_tool_bar_item (void);
7860 /* Return a vector of tool bar items for keymaps currently in effect.
7861 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7862 tool bar items found. */
7865 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7874 /* In order to build the menus, we need to call the keymap
7875 accessors. They all call QUIT. But this function is called
7876 during redisplay, during which a quit is fatal. So inhibit
7877 quitting while building the menus. We do this instead of
7878 specbind because (1) errors will clear it anyway and (2) this
7879 avoids risk of specpdl overflow. */
7880 oquit
= Vinhibit_quit
;
7883 /* Initialize tool_bar_items_vector and protect it from GC. */
7884 init_tool_bar_items (reuse
);
7886 /* Build list of keymaps in maps. Set nmaps to the number of maps
7889 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7890 if (!NILP (Voverriding_local_map_menu_flag
))
7892 /* Yes, use them (if non-nil) as well as the global map. */
7893 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7895 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7896 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7897 if (!NILP (Voverriding_local_map
))
7898 maps
[nmaps
++] = Voverriding_local_map
;
7902 /* No, so use major and minor mode keymaps and keymap property.
7903 Note that tool-bar bindings in the local-map and keymap
7904 properties may not work reliable, as they are only
7905 recognized when the tool-bar (or mode-line) is updated,
7906 which does not normally happen after every command. */
7909 nminor
= current_minor_maps (NULL
, &tmaps
);
7910 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7912 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7913 maps
[nmaps
++] = tem
;
7914 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7916 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7919 /* Add global keymap at the end. */
7920 maps
[nmaps
++] = current_global_map
;
7922 /* Process maps in reverse order and look up in each map the prefix
7924 for (i
= nmaps
- 1; i
>= 0; --i
)
7925 if (!NILP (maps
[i
]))
7929 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7931 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7934 Vinhibit_quit
= oquit
;
7935 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7936 return tool_bar_items_vector
;
7940 /* Process the definition of KEY which is DEF. */
7943 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7946 struct gcpro gcpro1
, gcpro2
;
7948 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7952 if (EQ (def
, Qundefined
))
7954 /* If a map has an explicit `undefined' as definition,
7955 discard any previously made item. */
7956 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7958 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7960 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7962 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7963 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7964 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7965 * sizeof (Lisp_Object
)));
7966 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7971 else if (parse_tool_bar_item (key
, def
))
7972 /* Append a new tool bar item to tool_bar_items_vector. Accept
7973 more than one definition for the same key. */
7974 append_tool_bar_item ();
7980 /* Parse a tool bar item specification ITEM for key KEY and return the
7981 result in tool_bar_item_properties. Value is zero if ITEM is
7984 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7986 CAPTION is the caption of the item, If it's not a string, it is
7987 evaluated to get a string.
7989 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7990 as binding are currently ignored.
7992 The following properties are recognized:
7996 FORM is evaluated and specifies whether the tool bar item is
7997 enabled or disabled.
8001 FORM is evaluated and specifies whether the tool bar item is visible.
8003 - `:filter FUNCTION'
8005 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8006 result is stored as the new binding.
8008 - `:button (TYPE SELECTED)'
8010 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8011 and specifies whether the button is selected (pressed) or not.
8015 IMAGES is either a single image specification or a vector of four
8016 image specifications. See enum tool_bar_item_images.
8018 - `:help HELP-STRING'.
8020 Gives a help string to display for the tool bar item.
8022 - `:label LABEL-STRING'.
8024 A text label to show with the tool bar button if labels are enabled. */
8027 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8029 /* Access slot with index IDX of vector tool_bar_item_properties. */
8030 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8032 Lisp_Object filter
= Qnil
;
8033 Lisp_Object caption
;
8034 int i
, have_label
= 0;
8036 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8037 Rule out items that aren't lists, don't start with
8038 `menu-item' or whose rest following `tool-bar-item' is not a
8043 /* As an exception, allow old-style menu separators. */
8044 if (STRINGP (XCAR (item
)))
8045 item
= Fcons (XCAR (item
), Qnil
);
8046 else if (!EQ (XCAR (item
), Qmenu_item
)
8047 || (item
= XCDR (item
), !CONSP (item
)))
8050 /* Create tool_bar_item_properties vector if necessary. Reset it to
8052 if (VECTORP (tool_bar_item_properties
))
8054 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8058 tool_bar_item_properties
8059 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8062 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8063 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8065 /* Get the caption of the item. If the caption is not a string,
8066 evaluate it to get a string. If we don't get a string, skip this
8068 caption
= XCAR (item
);
8069 if (!STRINGP (caption
))
8071 caption
= menu_item_eval_property (caption
);
8072 if (!STRINGP (caption
))
8075 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8077 /* If the rest following the caption is not a list, the menu item is
8078 either a separator, or invalid. */
8082 if (menu_separator_name_p (SDATA (caption
)))
8084 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8085 #if !defined (USE_GTK) && !defined (HAVE_NS)
8086 /* If we use build_desired_tool_bar_string to render the
8087 tool bar, the separator is rendered as an image. */
8088 PROP (TOOL_BAR_ITEM_IMAGES
)
8089 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8090 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8091 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8092 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8099 /* Store the binding. */
8100 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8103 /* Ignore cached key binding, if any. */
8104 if (CONSP (item
) && CONSP (XCAR (item
)))
8107 /* Process the rest of the properties. */
8108 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8110 Lisp_Object key
, value
;
8113 value
= XCAR (XCDR (item
));
8115 if (EQ (key
, QCenable
))
8117 /* `:enable FORM'. */
8118 if (!NILP (Venable_disabled_menus_and_buttons
))
8119 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8121 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8123 else if (EQ (key
, QCvisible
))
8125 /* `:visible FORM'. If got a visible property and that
8126 evaluates to nil then ignore this item. */
8127 if (NILP (menu_item_eval_property (value
)))
8130 else if (EQ (key
, QChelp
))
8131 /* `:help HELP-STRING'. */
8132 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8133 else if (EQ (key
, QCvert_only
))
8134 /* `:vert-only t/nil'. */
8135 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8136 else if (EQ (key
, QClabel
))
8138 const char *bad_label
= "!!?GARBLED ITEM?!!";
8139 /* `:label LABEL-STRING'. */
8140 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8142 : make_string (bad_label
, strlen (bad_label
));
8145 else if (EQ (key
, QCfilter
))
8146 /* ':filter FORM'. */
8148 else if (EQ (key
, QCbutton
) && CONSP (value
))
8150 /* `:button (TYPE . SELECTED)'. */
8151 Lisp_Object type
, selected
;
8153 type
= XCAR (value
);
8154 selected
= XCDR (value
);
8155 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8157 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8158 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8161 else if (EQ (key
, QCimage
)
8163 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8164 /* Value is either a single image specification or a vector
8165 of 4 such specifications for the different button states. */
8166 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8167 else if (EQ (key
, Qrtl
))
8169 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8175 /* Try to make one from caption and key. */
8176 Lisp_Object key
= PROP (TOOL_BAR_ITEM_KEY
);
8177 Lisp_Object capt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8178 const char *label
= SYMBOLP (key
) ? SSDATA (SYMBOL_NAME (key
)) : "";
8179 const char *caption
= STRINGP (capt
) ? SSDATA (capt
) : "";
8180 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8181 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8182 Lisp_Object new_lbl
;
8183 size_t caption_len
= strlen (caption
);
8185 if (caption_len
<= max_lbl
&& caption
[0] != '\0')
8187 strcpy (buf
, caption
);
8188 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8190 buf
[caption_len
] = '\0';
8191 label
= caption
= buf
;
8194 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8198 strcpy (buf
, label
);
8200 for (i
= 0; buf
[i
] != '\0'; ++i
)
8209 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8210 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8211 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8213 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8217 /* If got a filter apply it on binding. */
8219 PROP (TOOL_BAR_ITEM_BINDING
)
8220 = menu_item_eval_property (list2 (filter
,
8222 PROP (TOOL_BAR_ITEM_BINDING
))));
8224 /* See if the binding is a keymap. Give up if it is. */
8225 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8228 /* Enable or disable selection of item. */
8229 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8230 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8231 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8233 /* Handle radio buttons or toggle boxes. */
8234 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8235 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8236 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8244 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8245 that can be reused. */
8248 init_tool_bar_items (Lisp_Object reuse
)
8250 if (VECTORP (reuse
))
8251 tool_bar_items_vector
= reuse
;
8253 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8254 ntool_bar_items
= 0;
8258 /* Append parsed tool bar item properties from
8259 tool_bar_item_properties */
8262 append_tool_bar_item (void)
8264 Lisp_Object
*to
, *from
;
8266 /* Enlarge tool_bar_items_vector if necessary. */
8267 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8268 >= XVECTOR (tool_bar_items_vector
)->size
)
8269 tool_bar_items_vector
8270 = larger_vector (tool_bar_items_vector
,
8271 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8273 /* Append entries from tool_bar_item_properties to the end of
8274 tool_bar_items_vector. */
8275 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8276 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8277 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8278 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8285 /* Read a character using menus based on maps in the array MAPS.
8286 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8287 Return t if we displayed a menu but the user rejected it.
8289 PREV_EVENT is the previous input event, or nil if we are reading
8290 the first event of a key sequence.
8292 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8293 if we used a mouse menu to read the input, or zero otherwise. If
8294 USED_MOUSE_MENU is null, we don't dereference it.
8296 The prompting is done based on the prompt-string of the map
8297 and the strings associated with various map elements.
8299 This can be done with X menus or with menus put in the minibuf.
8300 These are done in different ways, depending on how the input will be read.
8301 Menus using X are done after auto-saving in read-char, getting the input
8302 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8303 and do auto-saving in the inner call of read_char. */
8306 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8307 int *used_mouse_menu
)
8311 if (used_mouse_menu
)
8312 *used_mouse_menu
= 0;
8314 /* Use local over global Menu maps */
8316 if (! menu_prompting
)
8319 /* Optionally disregard all but the global map. */
8320 if (inhibit_local_menu_bar_menus
)
8322 maps
+= (nmaps
- 1);
8327 /* If we got to this point via a mouse click,
8328 use a real menu for mouse selection. */
8329 if (EVENT_HAS_PARAMETERS (prev_event
)
8330 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8331 && !EQ (XCAR (prev_event
), Qtool_bar
))
8333 /* Display the menu and get the selection. */
8334 Lisp_Object
*realmaps
8335 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8339 /* Use the maps that are not nil. */
8340 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8341 if (!NILP (maps
[mapno
]))
8342 realmaps
[nmaps1
++] = maps
[mapno
];
8344 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8349 record_menu_key (XCAR (value
));
8351 /* If we got multiple events, unread all but
8353 There is no way to prevent those unread events
8354 from showing up later in last_nonmenu_event.
8355 So turn symbol and integer events into lists,
8356 to indicate that they came from a mouse menu,
8357 so that when present in last_nonmenu_event
8358 they won't confuse things. */
8359 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8361 record_menu_key (XCAR (tem
));
8362 if (SYMBOLP (XCAR (tem
))
8363 || INTEGERP (XCAR (tem
)))
8364 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8367 /* If we got more than one event, put all but the first
8368 onto this list to be read later.
8369 Return just the first event now. */
8370 Vunread_command_events
8371 = nconc2 (XCDR (value
), Vunread_command_events
);
8372 value
= XCAR (value
);
8374 else if (NILP (value
))
8376 if (used_mouse_menu
)
8377 *used_mouse_menu
= 1;
8380 #endif /* HAVE_MENUS */
8384 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8385 We make this bigger when necessary, and never free it. */
8386 static char *read_char_minibuf_menu_text
;
8387 /* Size of that buffer. */
8388 static int read_char_minibuf_menu_width
;
8391 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8394 register Lisp_Object name
;
8396 /* FIXME: Use the minibuffer's frame width. */
8397 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8400 Lisp_Object rest
, vector
;
8406 if (! menu_prompting
)
8409 /* Get the menu name from the first map that has one (a prompt string). */
8410 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8412 name
= Fkeymap_prompt (maps
[mapno
]);
8417 /* If we don't have any menus, just read a character normally. */
8418 if (!STRINGP (name
))
8421 /* Make sure we have a big enough buffer for the menu text. */
8422 width
= max (width
, SBYTES (name
));
8423 if (read_char_minibuf_menu_text
== 0)
8425 read_char_minibuf_menu_width
= width
+ 4;
8426 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8428 else if (width
+ 4 > read_char_minibuf_menu_width
)
8430 read_char_minibuf_menu_width
= width
+ 4;
8431 read_char_minibuf_menu_text
8432 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8434 menu
= read_char_minibuf_menu_text
;
8436 /* Prompt string always starts with map's prompt, and a space. */
8437 strcpy (menu
, SDATA (name
));
8438 nlength
= SBYTES (name
);
8439 menu
[nlength
++] = ':';
8440 menu
[nlength
++] = ' ';
8443 /* Start prompting at start of first map. */
8447 /* Present the documented bindings, a line at a time. */
8454 Lisp_Object orig_defn_macro
;
8456 /* Loop over elements of map. */
8461 /* If reached end of map, start at beginning of next map. */
8465 /* At end of last map, wrap around to first map if just starting,
8466 or end this line if already have something on it. */
8470 if (notfirst
|| nobindings
) break;
8475 /* Look at the next element of the map. */
8477 elt
= XVECTOR (vector
)->contents
[idx
];
8479 elt
= Fcar_safe (rest
);
8481 if (idx
< 0 && VECTORP (elt
))
8483 /* If we found a dense table in the keymap,
8484 advanced past it, but start scanning its contents. */
8485 rest
= Fcdr_safe (rest
);
8491 /* An ordinary element. */
8492 Lisp_Object event
, tem
;
8496 event
= Fcar_safe (elt
); /* alist */
8497 elt
= Fcdr_safe (elt
);
8501 XSETINT (event
, idx
); /* vector */
8504 /* Ignore the element if it has no prompt string. */
8505 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8507 /* 1 if the char to type matches the string. */
8509 Lisp_Object upcased_event
, downcased_event
;
8510 Lisp_Object desc
= Qnil
;
8512 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8514 upcased_event
= Fupcase (event
);
8515 downcased_event
= Fdowncase (event
);
8516 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8517 || XINT (downcased_event
) == SREF (s
, 0));
8519 desc
= Fsingle_key_description (event
, Qnil
);
8521 #if 0 /* It is redundant to list the equivalent key bindings because
8522 the prefix is what the user has already typed. */
8524 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8526 /* Insert equivalent keybinding. */
8527 s
= concat2 (s
, tem
);
8530 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8531 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8533 /* Insert button prefix. */
8534 Lisp_Object selected
8535 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8536 if (EQ (tem
, QCradio
))
8537 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8539 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8540 s
= concat2 (tem
, s
);
8544 /* If we have room for the prompt string, add it to this line.
8545 If this is the first on the line, always add it. */
8546 if ((SCHARS (s
) + i
+ 2
8547 + (char_matches
? 0 : SCHARS (desc
) + 3))
8553 /* Punctuate between strings. */
8556 strcpy (menu
+ i
, ", ");
8562 /* If the char to type doesn't match the string's
8563 first char, explicitly show what char to type. */
8566 /* Add as much of string as fits. */
8567 thiswidth
= SCHARS (desc
);
8568 if (thiswidth
+ i
> width
)
8569 thiswidth
= width
- i
;
8570 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8572 strcpy (menu
+ i
, " = ");
8576 /* Add as much of string as fits. */
8577 thiswidth
= SCHARS (s
);
8578 if (thiswidth
+ i
> width
)
8579 thiswidth
= width
- i
;
8580 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8586 /* If this element does not fit, end the line now,
8587 and save the element for the next line. */
8588 strcpy (menu
+ i
, "...");
8593 /* Move past this element. */
8594 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8595 /* Handle reaching end of dense table. */
8600 rest
= Fcdr_safe (rest
);
8604 /* Prompt with that and read response. */
8605 message2_nolog (menu
, strlen (menu
),
8606 ! NILP (current_buffer
->enable_multibyte_characters
));
8608 /* Make believe its not a keyboard macro in case the help char
8609 is pressed. Help characters are not recorded because menu prompting
8610 is not used on replay.
8612 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8613 current_kboard
->defining_kbd_macro
= Qnil
;
8615 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8616 while (BUFFERP (obj
));
8617 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8619 if (!INTEGERP (obj
))
8621 else if (XINT (obj
) == -2)
8626 if (! EQ (obj
, menu_prompt_more_char
)
8627 && (!INTEGERP (menu_prompt_more_char
)
8628 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8630 if (!NILP (current_kboard
->defining_kbd_macro
))
8631 store_kbd_macro_char (obj
);
8634 /* Help char - go round again */
8638 /* Reading key sequences. */
8640 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8641 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8642 keymap, or nil otherwise. Return the index of the first keymap in
8643 which KEY has any binding, or NMAPS if no map has a binding.
8645 If KEY is a meta ASCII character, treat it like meta-prefix-char
8646 followed by the corresponding non-meta character. Keymaps in
8647 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8650 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8653 NEXT may be the same array as CURRENT. */
8656 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8659 int i
, first_binding
;
8661 first_binding
= nmaps
;
8662 for (i
= nmaps
- 1; i
>= 0; i
--)
8664 if (! NILP (current
[i
]))
8666 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8667 if (! NILP (defs
[i
]))
8674 /* Given the set of bindings we've found, produce the next set of maps. */
8675 if (first_binding
< nmaps
)
8676 for (i
= 0; i
< nmaps
; i
++)
8677 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8679 return first_binding
;
8682 /* Structure used to keep track of partial application of key remapping
8683 such as Vfunction_key_map and Vkey_translation_map. */
8684 typedef struct keyremap
8686 /* This is the map originally specified for this use. */
8688 /* This is a submap reached by looking up, in PARENT,
8689 the events from START to END. */
8691 /* Positions [START, END) in the key sequence buffer
8692 are the key that we have scanned so far.
8693 Those events are the ones that we will replace
8694 if PAREHT maps them into a key sequence. */
8698 /* Lookup KEY in MAP.
8699 MAP is a keymap mapping keys to key vectors or functions.
8700 If the mapping is a function and DO_FUNCTION is non-zero, then
8701 the function is called with PROMPT as parameter and its return
8702 value is used as the return value of this function (after checking
8703 that it is indeed a vector). */
8706 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8711 next
= access_keymap (map
, key
, 1, 0, 1);
8713 /* Handle symbol with autoload definition. */
8714 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8715 && CONSP (XSYMBOL (next
)->function
)
8716 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8717 do_autoload (XSYMBOL (next
)->function
, next
);
8719 /* Handle a symbol whose function definition is a keymap
8721 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8722 && (ARRAYP (XSYMBOL (next
)->function
)
8723 || KEYMAPP (XSYMBOL (next
)->function
)))
8724 next
= XSYMBOL (next
)->function
;
8726 /* If the keymap gives a function, not an
8727 array, then call the function with one arg and use
8728 its value instead. */
8729 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8734 next
= call1 (next
, prompt
);
8735 /* If the function returned something invalid,
8736 barf--don't ignore it.
8737 (To ignore it safely, we would need to gcpro a bunch of
8738 other variables.) */
8739 if (! (VECTORP (next
) || STRINGP (next
)))
8740 error ("Function %s returns invalid key sequence", tem
);
8745 /* Do one step of the key remapping used for function-key-map and
8746 key-translation-map:
8747 KEYBUF is the buffer holding the input events.
8748 BUFSIZE is its maximum size.
8749 FKEY is a pointer to the keyremap structure to use.
8750 INPUT is the index of the last element in KEYBUF.
8751 DOIT if non-zero says that the remapping can actually take place.
8752 DIFF is used to return the number of keys added/removed by the remapping.
8753 PARENT is the root of the keymap.
8754 PROMPT is the prompt to use if the remapping happens through a function.
8755 The return value is non-zero if the remapping actually took place. */
8758 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8759 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8761 Lisp_Object next
, key
;
8763 key
= keybuf
[fkey
->end
++];
8765 if (KEYMAPP (fkey
->parent
))
8766 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8770 /* If keybuf[fkey->start..fkey->end] is bound in the
8771 map and we're in a position to do the key remapping, replace it with
8772 the binding and restart with fkey->start at the end. */
8773 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8775 int len
= XFASTINT (Flength (next
));
8778 *diff
= len
- (fkey
->end
- fkey
->start
);
8780 if (input
+ *diff
>= bufsize
)
8781 error ("Key sequence too long");
8783 /* Shift the keys that follow fkey->end. */
8785 for (i
= fkey
->end
; i
< input
; i
++)
8786 keybuf
[i
+ *diff
] = keybuf
[i
];
8788 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8789 keybuf
[i
+ *diff
] = keybuf
[i
];
8790 /* Overwrite the old keys with the new ones. */
8791 for (i
= 0; i
< len
; i
++)
8792 keybuf
[fkey
->start
+ i
]
8793 = Faref (next
, make_number (i
));
8795 fkey
->start
= fkey
->end
+= *diff
;
8796 fkey
->map
= fkey
->parent
;
8801 fkey
->map
= get_keymap (next
, 0, 1);
8803 /* If we no longer have a bound suffix, try a new position for
8805 if (!CONSP (fkey
->map
))
8807 fkey
->end
= ++fkey
->start
;
8808 fkey
->map
= fkey
->parent
;
8813 /* Read a sequence of keys that ends with a non prefix character,
8814 storing it in KEYBUF, a buffer of size BUFSIZE.
8816 Return the length of the key sequence stored.
8817 Return -1 if the user rejected a command menu.
8819 Echo starting immediately unless `prompt' is 0.
8821 Where a key sequence ends depends on the currently active keymaps.
8822 These include any minor mode keymaps active in the current buffer,
8823 the current buffer's local map, and the global map.
8825 If a key sequence has no other bindings, we check Vfunction_key_map
8826 to see if some trailing subsequence might be the beginning of a
8827 function key's sequence. If so, we try to read the whole function
8828 key, and substitute its symbolic name into the key sequence.
8830 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8831 `double-' events into similar click events, if that would make them
8832 bound. We try to turn `triple-' events first into `double-' events,
8835 If we get a mouse click in a mode line, vertical divider, or other
8836 non-text area, we treat the click as if it were prefixed by the
8837 symbol denoting that area - `mode-line', `vertical-line', or
8840 If the sequence starts with a mouse click, we read the key sequence
8841 with respect to the buffer clicked on, not the current buffer.
8843 If the user switches frames in the midst of a key sequence, we put
8844 off the switch-frame event until later; the next call to
8845 read_char will return it.
8847 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8848 from the selected window's buffer. */
8851 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8852 int dont_downcase_last
, int can_return_switch_frame
,
8853 int fix_current_buffer
)
8855 Lisp_Object from_string
;
8856 int count
= SPECPDL_INDEX ();
8858 /* How many keys there are in the current key sequence. */
8861 /* The length of the echo buffer when we started reading, and
8862 the length of this_command_keys when we started reading. */
8866 /* The number of keymaps we're scanning right now, and the number of
8867 keymaps we have allocated space for. */
8869 int nmaps_allocated
= 0;
8871 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8872 the current keymaps. */
8873 Lisp_Object
*defs
= NULL
;
8875 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8876 in the current keymaps, or nil where it is not a prefix. */
8877 Lisp_Object
*submaps
= NULL
;
8879 /* The local map to start out with at start of key sequence. */
8880 Lisp_Object orig_local_map
;
8882 /* The map from the `keymap' property to start out with at start of
8884 Lisp_Object orig_keymap
;
8886 /* 1 if we have already considered switching to the local-map property
8887 of the place where a mouse click occurred. */
8888 int localized_local_map
= 0;
8890 /* The index in submaps[] of the first keymap that has a binding for
8891 this key sequence. In other words, the lowest i such that
8892 submaps[i] is non-nil. */
8894 /* Index of the first key that has no binding.
8895 It is useless to try fkey.start larger than that. */
8898 /* If t < mock_input, then KEYBUF[t] should be read as the next
8901 We use this to recover after recognizing a function key. Once we
8902 realize that a suffix of the current key sequence is actually a
8903 function key's escape sequence, we replace the suffix with the
8904 function key's binding from Vfunction_key_map. Now keybuf
8905 contains a new and different key sequence, so the echo area,
8906 this_command_keys, and the submaps and defs arrays are wrong. In
8907 this situation, we set mock_input to t, set t to 0, and jump to
8908 restart_sequence; the loop will read keys from keybuf up until
8909 mock_input, thus rebuilding the state; and then it will resume
8910 reading characters from the keyboard. */
8913 /* If the sequence is unbound in submaps[], then
8914 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8915 and fkey.map is its binding.
8917 These might be > t, indicating that all function key scanning
8918 should hold off until t reaches them. We do this when we've just
8919 recognized a function key, to avoid searching for the function
8920 key's again in Vfunction_key_map. */
8923 /* Likewise, for key_translation_map and input-decode-map. */
8924 keyremap keytran
, indec
;
8926 /* Non-zero if we are trying to map a key by changing an upper-case
8927 letter to lower case, or a shifted function key to an unshifted
8929 int shift_translated
= 0;
8931 /* If we receive a `switch-frame' or `select-window' event in the middle of
8932 a key sequence, we put it off for later.
8933 While we're reading, we keep the event here. */
8934 Lisp_Object delayed_switch_frame
;
8936 /* See the comment below... */
8937 #if defined (GOBBLE_FIRST_EVENT)
8938 Lisp_Object first_event
;
8941 Lisp_Object original_uppercase
;
8942 int original_uppercase_position
= -1;
8944 /* Gets around Microsoft compiler limitations. */
8947 struct buffer
*starting_buffer
;
8949 /* List of events for which a fake prefix key has been generated. */
8950 Lisp_Object fake_prefixed_keys
= Qnil
;
8952 #if defined (GOBBLE_FIRST_EVENT)
8956 struct gcpro gcpro1
;
8958 GCPRO1 (fake_prefixed_keys
);
8959 raw_keybuf_count
= 0;
8961 last_nonmenu_event
= Qnil
;
8963 delayed_switch_frame
= Qnil
;
8969 /* Install the string STR as the beginning of the string of
8970 echoing, so that it serves as a prompt for the next
8972 current_kboard
->echo_string
= prompt
;
8973 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8976 else if (cursor_in_echo_area
8977 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8978 && NILP (Fzerop (Vecho_keystrokes
)))
8979 /* This doesn't put in a dash if the echo buffer is empty, so
8980 you don't always see a dash hanging out in the minibuffer. */
8984 /* Record the initial state of the echo area and this_command_keys;
8985 we will need to restore them if we replay a key sequence. */
8987 echo_start
= echo_length ();
8988 keys_start
= this_command_key_count
;
8989 this_single_command_key_start
= keys_start
;
8991 #if defined (GOBBLE_FIRST_EVENT)
8992 /* This doesn't quite work, because some of the things that read_char
8993 does cannot safely be bypassed. It seems too risky to try to make
8996 /* Read the first char of the sequence specially, before setting
8997 up any keymaps, in case a filter runs and switches buffers on us. */
8998 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9000 #endif /* GOBBLE_FIRST_EVENT */
9002 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9003 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9006 /* We jump here when we need to reinitialize fkey and keytran; this
9007 happens if we switch keyboards between rescans. */
9008 replay_entire_sequence
:
9010 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9011 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9012 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9013 indec
.start
= indec
.end
= 0;
9014 fkey
.start
= fkey
.end
= 0;
9015 keytran
.start
= keytran
.end
= 0;
9017 /* We jump here when the key sequence has been thoroughly changed, and
9018 we need to rescan it starting from the beginning. When we jump here,
9019 keybuf[0..mock_input] holds the sequence we should reread. */
9022 starting_buffer
= current_buffer
;
9023 first_unbound
= bufsize
+ 1;
9025 /* Build our list of keymaps.
9026 If we recognize a function key and replace its escape sequence in
9027 keybuf with its symbol, or if the sequence starts with a mouse
9028 click and we need to switch buffers, we jump back here to rebuild
9029 the initial keymaps from the current buffer. */
9032 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9034 if (2 > nmaps_allocated
)
9036 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9037 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9038 nmaps_allocated
= 2;
9040 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9042 else if (!NILP (Voverriding_local_map
))
9044 if (2 > nmaps_allocated
)
9046 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9047 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9048 nmaps_allocated
= 2;
9050 submaps
[nmaps
++] = Voverriding_local_map
;
9058 nminor
= current_minor_maps (0, &maps
);
9059 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9061 if (total
> nmaps_allocated
)
9063 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9064 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9065 nmaps_allocated
= total
;
9068 if (!NILP (orig_keymap
))
9069 submaps
[nmaps
++] = orig_keymap
;
9071 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9075 submaps
[nmaps
++] = orig_local_map
;
9077 submaps
[nmaps
++] = current_global_map
;
9079 /* Find an accurate initial value for first_binding. */
9080 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9081 if (! NILP (submaps
[first_binding
]))
9084 /* Start from the beginning in keybuf. */
9087 /* These are no-ops the first time through, but if we restart, they
9088 revert the echo area and this_command_keys to their original state. */
9089 this_command_key_count
= keys_start
;
9090 if (INTERACTIVE
&& t
< mock_input
)
9091 echo_truncate (echo_start
);
9093 /* If the best binding for the current key sequence is a keymap, or
9094 we may be looking at a function key's escape sequence, keep on
9096 while (first_binding
< nmaps
9097 /* Keep reading as long as there's a prefix binding. */
9098 ? !NILP (submaps
[first_binding
])
9099 /* Don't return in the middle of a possible function key sequence,
9100 if the only bindings we found were via case conversion.
9101 Thus, if ESC O a has a function-key-map translation
9102 and ESC o has a binding, don't return after ESC O,
9103 so that we can translate ESC O plus the next character. */
9104 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9107 int used_mouse_menu
= 0;
9109 /* Where the last real key started. If we need to throw away a
9110 key that has expanded into more than one element of keybuf
9111 (say, a mouse click on the mode line which is being treated
9112 as [mode-line (mouse-...)], then we backtrack to this point
9114 int last_real_key_start
;
9116 /* These variables are analogous to echo_start and keys_start;
9117 while those allow us to restart the entire key sequence,
9118 echo_local_start and keys_local_start allow us to throw away
9120 int echo_local_start
, keys_local_start
, local_first_binding
;
9122 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9123 eassert (indec
.start
<= indec
.end
);
9124 eassert (fkey
.start
<= fkey
.end
);
9125 eassert (keytran
.start
<= keytran
.end
);
9126 /* key-translation-map is applied *after* function-key-map
9127 which is itself applied *after* input-decode-map. */
9128 eassert (fkey
.end
<= indec
.start
);
9129 eassert (keytran
.end
<= fkey
.start
);
9131 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9132 first_unbound
< keytran
.start
)
9133 { /* The prefix upto first_unbound has no binding and has
9134 no translation left to do either, so we know it's unbound.
9135 If we don't stop now, we risk staying here indefinitely
9136 (if the user keeps entering fkey or keytran prefixes
9137 like C-c ESC ESC ESC ESC ...) */
9139 for (i
= first_unbound
+ 1; i
< t
; i
++)
9140 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9141 mock_input
= t
- first_unbound
- 1;
9142 indec
.end
= indec
.start
-= first_unbound
+ 1;
9143 indec
.map
= indec
.parent
;
9144 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9145 fkey
.map
= fkey
.parent
;
9146 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9147 keytran
.map
= keytran
.parent
;
9148 goto replay_sequence
;
9152 error ("Key sequence too long");
9155 echo_local_start
= echo_length ();
9156 keys_local_start
= this_command_key_count
;
9157 local_first_binding
= first_binding
;
9160 /* These are no-ops, unless we throw away a keystroke below and
9161 jumped back up to replay_key; in that case, these restore the
9162 variables to their original state, allowing us to replay the
9164 if (INTERACTIVE
&& t
< mock_input
)
9165 echo_truncate (echo_local_start
);
9166 this_command_key_count
= keys_local_start
;
9167 first_binding
= local_first_binding
;
9169 /* By default, assume each event is "real". */
9170 last_real_key_start
= t
;
9172 /* Does mock_input indicate that we are re-reading a key sequence? */
9176 add_command_key (key
);
9177 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9178 && NILP (Fzerop (Vecho_keystrokes
)))
9182 /* If not, we should actually read a character. */
9186 KBOARD
*interrupted_kboard
= current_kboard
;
9187 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9188 key
= read_char (NILP (prompt
), nmaps
,
9189 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9190 &used_mouse_menu
, NULL
);
9191 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9192 /* When switching to a new tty (with a new keyboard),
9193 read_char returns the new buffer, rather than -2
9194 (Bug#5095). This is because `terminal-init-xterm'
9195 calls read-char, which eats the wrong_kboard_jmpbuf
9196 return. Any better way to fix this? -- cyd */
9197 || (interrupted_kboard
!= current_kboard
))
9202 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9203 if (k
== interrupted_kboard
)
9208 /* Don't touch interrupted_kboard when it's been
9210 delayed_switch_frame
= Qnil
;
9211 goto replay_entire_sequence
;
9214 if (!NILP (delayed_switch_frame
))
9216 interrupted_kboard
->kbd_queue
9217 = Fcons (delayed_switch_frame
,
9218 interrupted_kboard
->kbd_queue
);
9219 delayed_switch_frame
= Qnil
;
9223 interrupted_kboard
->kbd_queue
9224 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9226 /* If the side queue is non-empty, ensure it begins with a
9227 switch-frame, so we'll replay it in the right context. */
9228 if (CONSP (interrupted_kboard
->kbd_queue
)
9229 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9230 !(EVENT_HAS_PARAMETERS (key
)
9231 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9235 XSETFRAME (frame
, interrupted_frame
);
9236 interrupted_kboard
->kbd_queue
9237 = Fcons (make_lispy_switch_frame (frame
),
9238 interrupted_kboard
->kbd_queue
);
9241 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9242 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9243 goto replay_entire_sequence
;
9247 /* read_char returns t when it shows a menu and the user rejects it.
9251 unbind_to (count
, Qnil
);
9256 /* read_char returns -1 at the end of a macro.
9257 Emacs 18 handles this by returning immediately with a
9258 zero, so that's what we'll do. */
9259 if (INTEGERP (key
) && XINT (key
) == -1)
9262 /* The Microsoft C compiler can't handle the goto that
9268 /* If the current buffer has been changed from under us, the
9269 keymap may have changed, so replay the sequence. */
9272 timer_resume_idle ();
9275 /* Reset the current buffer from the selected window
9276 in case something changed the former and not the latter.
9277 This is to be more consistent with the behavior
9278 of the command_loop_1. */
9279 if (fix_current_buffer
)
9281 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9283 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9284 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9287 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9288 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9289 goto replay_sequence
;
9292 /* If we have a quit that was typed in another frame, and
9293 quit_throw_to_read_char switched buffers,
9294 replay to get the right keymap. */
9296 && XINT (key
) == quit_char
9297 && current_buffer
!= starting_buffer
)
9300 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9304 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9305 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9306 goto replay_sequence
;
9311 if (EVENT_HAS_PARAMETERS (key
)
9312 /* Either a `switch-frame' or a `select-window' event. */
9313 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9315 /* If we're at the beginning of a key sequence, and the caller
9316 says it's okay, go ahead and return this event. If we're
9317 in the midst of a key sequence, delay it until the end. */
9318 if (t
> 0 || !can_return_switch_frame
)
9320 delayed_switch_frame
= key
;
9326 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9330 /* Clicks in non-text areas get prefixed by the symbol
9331 in their CHAR-ADDRESS field. For example, a click on
9332 the mode line is prefixed by the symbol `mode-line'.
9334 Furthermore, key sequences beginning with mouse clicks
9335 are read using the keymaps of the buffer clicked on, not
9336 the current buffer. So we may have to switch the buffer
9339 When we turn one event into two events, we must make sure
9340 that neither of the two looks like the original--so that,
9341 if we replay the events, they won't be expanded again.
9342 If not for this, such reexpansion could happen either here
9343 or when user programs play with this-command-keys. */
9344 if (EVENT_HAS_PARAMETERS (key
))
9349 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9350 if (EQ (kind
, Qmouse_click
))
9352 Lisp_Object window
, posn
;
9354 window
= POSN_WINDOW (EVENT_START (key
));
9355 posn
= POSN_POSN (EVENT_START (key
));
9358 || (!NILP (fake_prefixed_keys
)
9359 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9361 /* We're looking a second time at an event for which
9362 we generated a fake prefix key. Set
9363 last_real_key_start appropriately. */
9365 last_real_key_start
= t
- 1;
9368 /* Key sequences beginning with mouse clicks are
9369 read using the keymaps in the buffer clicked on,
9370 not the current buffer. If we're at the
9371 beginning of a key sequence, switch buffers. */
9372 if (last_real_key_start
== 0
9374 && BUFFERP (XWINDOW (window
)->buffer
)
9375 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9377 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9381 /* Arrange to go back to the original buffer once we're
9382 done reading the key sequence. Note that we can't
9383 use save_excursion_{save,restore} here, because they
9384 save point as well as the current buffer; we don't
9385 want to save point, because redisplay may change it,
9386 to accommodate a Fset_window_start or something. We
9387 don't want to do this at the top of the function,
9388 because we may get input from a subprocess which
9389 wants to change the selected window and stuff (say,
9391 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9393 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9395 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9396 orig_local_map
= get_local_map (PT
, current_buffer
,
9398 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9399 goto replay_sequence
;
9402 /* For a mouse click, get the local text-property keymap
9403 of the place clicked on, rather than point. */
9404 if (last_real_key_start
== 0
9405 && CONSP (XCDR (key
))
9406 && ! localized_local_map
)
9408 Lisp_Object map_here
, start
, pos
;
9410 localized_local_map
= 1;
9411 start
= EVENT_START (key
);
9413 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9415 pos
= POSN_BUFFER_POSN (start
);
9417 && XINT (pos
) >= BEGV
9418 && XINT (pos
) <= ZV
)
9420 map_here
= get_local_map (XINT (pos
),
9421 current_buffer
, Qlocal_map
);
9422 if (!EQ (map_here
, orig_local_map
))
9424 orig_local_map
= map_here
;
9425 ++localized_local_map
;
9428 map_here
= get_local_map (XINT (pos
),
9429 current_buffer
, Qkeymap
);
9430 if (!EQ (map_here
, orig_keymap
))
9432 orig_keymap
= map_here
;
9433 ++localized_local_map
;
9436 if (localized_local_map
> 1)
9441 goto replay_sequence
;
9447 /* Expand mode-line and scroll-bar events into two events:
9448 use posn as a fake prefix key. */
9450 && (NILP (fake_prefixed_keys
)
9451 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9453 if (t
+ 1 >= bufsize
)
9454 error ("Key sequence too long");
9457 keybuf
[t
+ 1] = key
;
9460 /* Record that a fake prefix key has been generated
9461 for KEY. Don't modify the event; this would
9462 prevent proper action when the event is pushed
9463 back into unread-command-events. */
9464 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9466 /* If on a mode line string with a local keymap,
9467 reconsider the key sequence with that keymap. */
9468 if (string
= POSN_STRING (EVENT_START (key
)),
9469 (CONSP (string
) && STRINGP (XCAR (string
))))
9471 Lisp_Object pos
, map
, map2
;
9473 pos
= XCDR (string
);
9474 string
= XCAR (string
);
9476 && XINT (pos
) < SCHARS (string
))
9478 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9480 orig_local_map
= map
;
9481 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9484 if (!NILP (map
) || !NILP (map2
))
9485 goto replay_sequence
;
9491 else if (NILP (from_string
)
9492 && (string
= POSN_STRING (EVENT_START (key
)),
9493 (CONSP (string
) && STRINGP (XCAR (string
)))))
9495 /* For a click on a string, i.e. overlay string or a
9496 string displayed via the `display' property,
9497 consider `local-map' and `keymap' properties of
9499 Lisp_Object pos
, map
, map2
;
9501 pos
= XCDR (string
);
9502 string
= XCAR (string
);
9504 && XINT (pos
) < SCHARS (string
))
9506 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9508 orig_local_map
= map
;
9509 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9513 if (!NILP (map
) || !NILP (map2
))
9515 from_string
= string
;
9518 goto replay_sequence
;
9523 else if (CONSP (XCDR (key
))
9524 && CONSP (EVENT_START (key
))
9525 && CONSP (XCDR (EVENT_START (key
))))
9529 posn
= POSN_POSN (EVENT_START (key
));
9530 /* Handle menu-bar events:
9531 insert the dummy prefix event `menu-bar'. */
9532 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9534 if (t
+ 1 >= bufsize
)
9535 error ("Key sequence too long");
9539 /* Zap the position in key, so we know that we've
9540 expanded it, and don't try to do so again. */
9541 POSN_SET_POSN (EVENT_START (key
),
9542 Fcons (posn
, Qnil
));
9545 goto replay_sequence
;
9547 else if (CONSP (posn
))
9549 /* We're looking at the second event of a
9550 sequence which we expanded before. Set
9551 last_real_key_start appropriately. */
9552 if (last_real_key_start
== t
&& t
> 0)
9553 last_real_key_start
= t
- 1;
9558 /* We have finally decided that KEY is something we might want
9560 first_binding
= (follow_key (key
,
9561 nmaps
- first_binding
,
9562 submaps
+ first_binding
,
9563 defs
+ first_binding
,
9564 submaps
+ first_binding
)
9567 /* If KEY wasn't bound, we'll try some fallbacks. */
9568 if (first_binding
< nmaps
)
9569 /* This is needed for the following scenario:
9570 event 0: a down-event that gets dropped by calling replay_key.
9571 event 1: some normal prefix like C-h.
9572 After event 0, first_unbound is 0, after event 1 indec.start,
9573 fkey.start, and keytran.start are all 1, so when we see that
9574 C-h is bound, we need to update first_unbound. */
9575 first_unbound
= max (t
+ 1, first_unbound
);
9580 /* Remember the position to put an upper bound on indec.start. */
9581 first_unbound
= min (t
, first_unbound
);
9583 head
= EVENT_HEAD (key
);
9584 if (help_char_p (head
) && t
> 0)
9586 read_key_sequence_cmd
= Vprefix_help_command
;
9588 last_nonmenu_event
= key
;
9589 /* The Microsoft C compiler can't handle the goto that
9597 Lisp_Object breakdown
;
9600 breakdown
= parse_modifiers (head
);
9601 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9602 /* Attempt to reduce an unbound mouse event to a simpler
9603 event that is bound:
9604 Drags reduce to clicks.
9605 Double-clicks reduce to clicks.
9606 Triple-clicks reduce to double-clicks, then to clicks.
9607 Down-clicks are eliminated.
9608 Double-downs reduce to downs, then are eliminated.
9609 Triple-downs reduce to double-downs, then to downs,
9610 then are eliminated. */
9611 if (modifiers
& (down_modifier
| drag_modifier
9612 | double_modifier
| triple_modifier
))
9614 while (modifiers
& (down_modifier
| drag_modifier
9615 | double_modifier
| triple_modifier
))
9617 Lisp_Object new_head
, new_click
;
9618 if (modifiers
& triple_modifier
)
9619 modifiers
^= (double_modifier
| triple_modifier
);
9620 else if (modifiers
& double_modifier
)
9621 modifiers
&= ~double_modifier
;
9622 else if (modifiers
& drag_modifier
)
9623 modifiers
&= ~drag_modifier
;
9626 /* Dispose of this `down' event by simply jumping
9627 back to replay_key, to get another event.
9629 Note that if this event came from mock input,
9630 then just jumping back to replay_key will just
9631 hand it to us again. So we have to wipe out any
9634 We could delete keybuf[t] and shift everything
9635 after that to the left by one spot, but we'd also
9636 have to fix up any variable that points into
9637 keybuf, and shifting isn't really necessary
9640 Adding prefixes for non-textual mouse clicks
9641 creates two characters of mock input, and both
9642 must be thrown away. If we're only looking at
9643 the prefix now, we can just jump back to
9644 replay_key. On the other hand, if we've already
9645 processed the prefix, and now the actual click
9646 itself is giving us trouble, then we've lost the
9647 state of the keymaps we want to backtrack to, and
9648 we need to replay the whole sequence to rebuild
9651 Beyond that, only function key expansion could
9652 create more than two keys, but that should never
9653 generate mouse events, so it's okay to zero
9654 mock_input in that case too.
9656 FIXME: The above paragraph seems just plain
9657 wrong, if you consider things like
9658 xterm-mouse-mode. -stef
9660 Isn't this just the most wonderful code ever? */
9662 /* If mock_input > t + 1, the above simplification
9663 will actually end up dropping keys on the floor.
9664 This is probably OK for now, but even
9665 if mock_input <= t + 1, we need to adjust indec,
9667 Typical case [header-line down-mouse-N]:
9668 mock_input = 2, t = 1, fkey.end = 1,
9669 last_real_key_start = 0. */
9670 if (indec
.end
> last_real_key_start
)
9672 indec
.end
= indec
.start
9673 = min (last_real_key_start
, indec
.start
);
9674 indec
.map
= indec
.parent
;
9675 if (fkey
.end
> last_real_key_start
)
9677 fkey
.end
= fkey
.start
9678 = min (last_real_key_start
, fkey
.start
);
9679 fkey
.map
= fkey
.parent
;
9680 if (keytran
.end
> last_real_key_start
)
9682 keytran
.end
= keytran
.start
9683 = min (last_real_key_start
, keytran
.start
);
9684 keytran
.map
= keytran
.parent
;
9688 if (t
== last_real_key_start
)
9695 mock_input
= last_real_key_start
;
9696 goto replay_sequence
;
9701 = apply_modifiers (modifiers
, XCAR (breakdown
));
9703 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9705 /* Look for a binding for this new key. follow_key
9706 promises that it didn't munge submaps the
9707 last time we called it, since key was unbound. */
9709 = (follow_key (new_click
,
9710 nmaps
- local_first_binding
,
9711 submaps
+ local_first_binding
,
9712 defs
+ local_first_binding
,
9713 submaps
+ local_first_binding
)
9714 + local_first_binding
);
9716 /* If that click is bound, go for it. */
9717 if (first_binding
< nmaps
)
9722 /* Otherwise, we'll leave key set to the drag event. */
9729 /* Normally, last_nonmenu_event gets the previous key we read.
9730 But when a mouse popup menu is being used,
9731 we don't update last_nonmenu_event; it continues to hold the mouse
9732 event that preceded the first level of menu. */
9733 if (!used_mouse_menu
)
9734 last_nonmenu_event
= key
;
9736 /* Record what part of this_command_keys is the current key sequence. */
9737 this_single_command_key_start
= this_command_key_count
- t
;
9739 /* Look for this sequence in input-decode-map.
9740 Scan from indec.end until we find a bound suffix. */
9741 while (indec
.end
< t
)
9743 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9746 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9747 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9752 mock_input
= diff
+ max (t
, mock_input
);
9753 goto replay_sequence
;
9757 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9758 && indec
.start
>= t
)
9759 /* There is a binding and it's not a prefix.
9760 (and it doesn't have any input-decode-map translation pending).
9761 There is thus no function-key in this sequence.
9762 Moving fkey.start is important in this case to allow keytran.start
9763 to go over the sequence before we return (since we keep the
9764 invariant that keytran.end <= fkey.start). */
9767 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9770 /* If the sequence is unbound, see if we can hang a function key
9771 off the end of it. */
9772 /* Continue scan from fkey.end until we find a bound suffix. */
9773 while (fkey
.end
< indec
.start
)
9775 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9778 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9779 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9780 max (t
, mock_input
),
9781 /* If there's a binding (i.e.
9782 first_binding >= nmaps) we don't want
9783 to apply this function-key-mapping. */
9784 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9789 mock_input
= diff
+ max (t
, mock_input
);
9790 /* Adjust the input-decode-map counters. */
9792 indec
.start
+= diff
;
9794 goto replay_sequence
;
9798 /* Look for this sequence in key-translation-map.
9799 Scan from keytran.end until we find a bound suffix. */
9800 while (keytran
.end
< fkey
.start
)
9802 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9805 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9806 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9811 mock_input
= diff
+ max (t
, mock_input
);
9812 /* Adjust the function-key-map and input-decode-map counters. */
9814 indec
.start
+= diff
;
9818 goto replay_sequence
;
9822 /* If KEY is not defined in any of the keymaps,
9823 and cannot be part of a function key or translation,
9824 and is an upper case letter
9825 use the corresponding lower-case letter instead. */
9826 if (first_binding
>= nmaps
9827 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9829 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9830 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9831 || (XINT (key
) & shift_modifier
)))
9833 Lisp_Object new_key
;
9835 original_uppercase
= key
;
9836 original_uppercase_position
= t
- 1;
9838 if (XINT (key
) & shift_modifier
)
9839 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9841 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9842 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9844 /* We have to do this unconditionally, regardless of whether
9845 the lower-case char is defined in the keymaps, because they
9846 might get translated through function-key-map. */
9847 keybuf
[t
- 1] = new_key
;
9848 mock_input
= max (t
, mock_input
);
9849 shift_translated
= 1;
9851 goto replay_sequence
;
9853 /* If KEY is not defined in any of the keymaps,
9854 and cannot be part of a function key or translation,
9855 and is a shifted function key,
9856 use the corresponding unshifted function key instead. */
9857 if (first_binding
>= nmaps
9858 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9860 Lisp_Object breakdown
= parse_modifiers (key
);
9862 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9864 if (modifiers
& shift_modifier
9865 /* Treat uppercase keys as shifted. */
9867 && (KEY_TO_CHAR (key
)
9868 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9869 && UPPERCASEP (KEY_TO_CHAR (key
))))
9872 = (modifiers
& shift_modifier
9873 ? apply_modifiers (modifiers
& ~shift_modifier
,
9875 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
9877 original_uppercase
= key
;
9878 original_uppercase_position
= t
- 1;
9880 /* We have to do this unconditionally, regardless of whether
9881 the lower-case char is defined in the keymaps, because they
9882 might get translated through function-key-map. */
9883 keybuf
[t
- 1] = new_key
;
9884 mock_input
= max (t
, mock_input
);
9885 /* Reset fkey (and consequently keytran) to apply
9886 function-key-map on the result, so that S-backspace is
9887 correctly mapped to DEL (via backspace). OTOH,
9888 input-decode-map doesn't need to go through it again. */
9889 fkey
.start
= fkey
.end
= 0;
9890 keytran
.start
= keytran
.end
= 0;
9891 shift_translated
= 1;
9893 goto replay_sequence
;
9898 read_key_sequence_cmd
= (first_binding
< nmaps
9899 ? defs
[first_binding
]
9902 unread_switch_frame
= delayed_switch_frame
;
9903 unbind_to (count
, Qnil
);
9905 /* Don't downcase the last character if the caller says don't.
9906 Don't downcase it if the result is undefined, either. */
9907 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9909 && t
- 1 == original_uppercase_position
)
9911 keybuf
[t
- 1] = original_uppercase
;
9912 shift_translated
= 0;
9915 if (shift_translated
)
9916 Vthis_command_keys_shift_translated
= Qt
;
9918 /* Occasionally we fabricate events, perhaps by expanding something
9919 according to function-key-map, or by adding a prefix symbol to a
9920 mouse click in the scroll bar or modeline. In this cases, return
9921 the entire generated key sequence, even if we hit an unbound
9922 prefix or a definition before the end. This means that you will
9923 be able to push back the event properly, and also means that
9924 read-key-sequence will always return a logical unit.
9927 for (; t
< mock_input
; t
++)
9929 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9930 && NILP (Fzerop (Vecho_keystrokes
)))
9931 echo_char (keybuf
[t
]);
9932 add_command_key (keybuf
[t
]);
9939 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9940 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9941 The sequence is sufficient to specify a non-prefix command in the
9942 current local and global maps.
9944 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9945 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9946 as a continuation of the previous key.
9948 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9949 convert the last event to lower case. (Normally any upper case event
9950 is converted to lower case if the original event is undefined and the lower
9951 case equivalent is defined.) A non-nil value is appropriate for reading
9952 a key sequence to be defined.
9954 A C-g typed while in this function is treated like any other character,
9955 and `quit-flag' is not set.
9957 If the key sequence starts with a mouse click, then the sequence is read
9958 using the keymaps of the buffer of the window clicked in, not the buffer
9959 of the selected window as normal.
9961 `read-key-sequence' drops unbound button-down events, since you normally
9962 only care about the click or drag events which follow them. If a drag
9963 or multi-click event is unbound, but the corresponding click event would
9964 be bound, `read-key-sequence' turns the event into a click event at the
9965 drag's starting position. This means that you don't have to distinguish
9966 between click and drag, double, or triple events unless you want to.
9968 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9969 lines separating windows, and scroll bars with imaginary keys
9970 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9972 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9973 function will process a switch-frame event if the user switches frames
9974 before typing anything. If the user switches frames in the middle of a
9975 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9976 is nil, then the event will be put off until after the current key sequence.
9978 `read-key-sequence' checks `function-key-map' for function key
9979 sequences, where they wouldn't conflict with ordinary bindings. See
9980 `function-key-map' for more details.
9982 The optional fifth argument COMMAND-LOOP, if non-nil, means
9983 that this key sequence is being read by something that will
9984 read commands one after another. It should be nil if the caller
9985 will read just one key sequence. */)
9986 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
9988 Lisp_Object keybuf
[30];
9990 struct gcpro gcpro1
;
9991 int count
= SPECPDL_INDEX ();
9994 CHECK_STRING (prompt
);
9997 specbind (Qinput_method_exit_on_first_char
,
9998 (NILP (command_loop
) ? Qt
: Qnil
));
9999 specbind (Qinput_method_use_echo_area
,
10000 (NILP (command_loop
) ? Qt
: Qnil
));
10002 memset (keybuf
, 0, sizeof keybuf
);
10003 GCPRO1 (keybuf
[0]);
10004 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10006 if (NILP (continue_echo
))
10008 this_command_key_count
= 0;
10009 this_command_key_count_reset
= 0;
10010 this_single_command_key_start
= 0;
10013 #ifdef HAVE_WINDOW_SYSTEM
10014 if (display_hourglass_p
)
10015 cancel_hourglass ();
10018 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10019 prompt
, ! NILP (dont_downcase_last
),
10020 ! NILP (can_return_switch_frame
), 0);
10022 #if 0 /* The following is fine for code reading a key sequence and
10023 then proceeding with a lenghty computation, but it's not good
10024 for code reading keys in a loop, like an input method. */
10025 #ifdef HAVE_WINDOW_SYSTEM
10026 if (display_hourglass_p
)
10027 start_hourglass ();
10037 return unbind_to (count
, make_event_array (i
, keybuf
));
10040 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10041 Sread_key_sequence_vector
, 1, 5, 0,
10042 doc
: /* Like `read-key-sequence' but always return a vector. */)
10043 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10045 Lisp_Object keybuf
[30];
10047 struct gcpro gcpro1
;
10048 int count
= SPECPDL_INDEX ();
10050 if (!NILP (prompt
))
10051 CHECK_STRING (prompt
);
10054 specbind (Qinput_method_exit_on_first_char
,
10055 (NILP (command_loop
) ? Qt
: Qnil
));
10056 specbind (Qinput_method_use_echo_area
,
10057 (NILP (command_loop
) ? Qt
: Qnil
));
10059 memset (keybuf
, 0, sizeof keybuf
);
10060 GCPRO1 (keybuf
[0]);
10061 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10063 if (NILP (continue_echo
))
10065 this_command_key_count
= 0;
10066 this_command_key_count_reset
= 0;
10067 this_single_command_key_start
= 0;
10070 #ifdef HAVE_WINDOW_SYSTEM
10071 if (display_hourglass_p
)
10072 cancel_hourglass ();
10075 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10076 prompt
, ! NILP (dont_downcase_last
),
10077 ! NILP (can_return_switch_frame
), 0);
10079 #ifdef HAVE_WINDOW_SYSTEM
10080 if (display_hourglass_p
)
10081 start_hourglass ();
10090 return unbind_to (count
, Fvector (i
, keybuf
));
10093 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10094 doc
: /* Execute CMD as an editor command.
10095 CMD must be a symbol that satisfies the `commandp' predicate.
10096 Optional second arg RECORD-FLAG non-nil
10097 means unconditionally put this command in `command-history'.
10098 Otherwise, that is done only if an arg is read using the minibuffer.
10099 The argument KEYS specifies the value to use instead of (this-command-keys)
10100 when reading the arguments; if it is nil, (this-command-keys) is used.
10101 The argument SPECIAL, if non-nil, means that this command is executing
10102 a special event, so ignore the prefix argument and don't clear it. */)
10103 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10105 register Lisp_Object final
;
10106 register Lisp_Object tem
;
10107 Lisp_Object prefixarg
;
10109 debug_on_next_call
= 0;
10111 if (NILP (special
))
10113 prefixarg
= current_kboard
->Vprefix_arg
;
10114 Vcurrent_prefix_arg
= prefixarg
;
10115 current_kboard
->Vprefix_arg
= Qnil
;
10122 tem
= Fget (cmd
, Qdisabled
);
10123 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10125 tem
= Fsymbol_value (Qdisabled_command_function
);
10127 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10133 final
= Findirect_function (cmd
, Qnil
);
10135 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10137 struct gcpro gcpro1
, gcpro2
;
10139 GCPRO2 (cmd
, prefixarg
);
10140 do_autoload (final
, cmd
);
10147 if (STRINGP (final
) || VECTORP (final
))
10149 /* If requested, place the macro in the command history. For
10150 other sorts of commands, call-interactively takes care of
10152 if (!NILP (record_flag
))
10155 = Fcons (Fcons (Qexecute_kbd_macro
,
10156 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10159 /* Don't keep command history around forever. */
10160 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10162 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10164 XSETCDR (tem
, Qnil
);
10168 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10171 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10172 /* Don't call Fcall_interactively directly because we want to make
10173 sure the backtrace has an entry for `call-interactively'.
10174 For the same reason, pass `cmd' rather than `final'. */
10175 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10182 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10184 doc
: /* Read function name, then read its arguments and call it.
10186 To pass a numeric argument to the command you are invoking with, specify
10187 the numeric argument to this command.
10189 Noninteractively, the argument PREFIXARG is the prefix argument to
10190 give to the command you invoke, if it asks for an argument. */)
10191 (Lisp_Object prefixarg
)
10193 Lisp_Object function
;
10194 EMACS_INT saved_last_point_position
;
10195 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10196 Lisp_Object bindings
, value
;
10197 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10198 #ifdef HAVE_WINDOW_SYSTEM
10199 /* The call to Fcompleting_read will start and cancel the hourglass,
10200 but if the hourglass was already scheduled, this means that no
10201 hourglass will be shown for the actual M-x command itself.
10202 So we restart it if it is already scheduled. Note that checking
10203 hourglass_shown_p is not enough, normally the hourglass is not shown,
10204 just scheduled to be shown. */
10205 int hstarted
= hourglass_started ();
10208 saved_keys
= Fvector (this_command_key_count
,
10209 XVECTOR (this_command_keys
)->contents
);
10210 saved_last_point_position_buffer
= last_point_position_buffer
;
10211 saved_last_point_position
= last_point_position
;
10212 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10214 function
= call0 (intern ("read-extended-command"));
10216 #ifdef HAVE_WINDOW_SYSTEM
10217 if (hstarted
) start_hourglass ();
10220 if (STRINGP (function
) && SCHARS (function
) == 0)
10221 error ("No command name given");
10223 /* Set this_command_keys to the concatenation of saved_keys and
10224 function, followed by a RET. */
10229 this_command_key_count
= 0;
10230 this_command_key_count_reset
= 0;
10231 this_single_command_key_start
= 0;
10233 keys
= XVECTOR (saved_keys
)->contents
;
10234 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10235 add_command_key (keys
[i
]);
10237 for (i
= 0; i
< SCHARS (function
); i
++)
10238 add_command_key (Faref (function
, make_number (i
)));
10240 add_command_key (make_number ('\015'));
10243 last_point_position
= saved_last_point_position
;
10244 last_point_position_buffer
= saved_last_point_position_buffer
;
10248 function
= Fintern (function
, Qnil
);
10249 current_kboard
->Vprefix_arg
= prefixarg
;
10250 Vthis_command
= function
;
10251 real_this_command
= function
;
10253 /* If enabled, show which key runs this command. */
10254 if (!NILP (Vsuggest_key_bindings
)
10255 && NILP (Vexecuting_kbd_macro
)
10256 && SYMBOLP (function
))
10257 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10263 GCPRO3 (bindings
, value
, function
);
10264 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10266 /* If the command has a key binding, print it now. */
10267 if (!NILP (bindings
)
10268 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10271 /* But first wait, and skip the message if there is input. */
10272 Lisp_Object waited
;
10274 /* If this command displayed something in the echo area;
10275 wait a few seconds, then display our suggestion message. */
10276 if (NILP (echo_area_buffer
[0]))
10277 waited
= sit_for (make_number (0), 0, 2);
10278 else if (NUMBERP (Vsuggest_key_bindings
))
10279 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10281 waited
= sit_for (make_number (2), 0, 2);
10283 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10285 Lisp_Object binding
;
10287 int message_p
= push_message ();
10288 int count
= SPECPDL_INDEX ();
10290 record_unwind_protect (pop_message_unwind
, Qnil
);
10291 binding
= Fkey_description (bindings
, Qnil
);
10294 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10297 sprintf (newmessage
, "You can run the command `%s' with %s",
10298 SDATA (SYMBOL_NAME (function
)),
10300 message2_nolog (newmessage
,
10301 strlen (newmessage
),
10302 STRING_MULTIBYTE (binding
));
10303 if (NUMBERP (Vsuggest_key_bindings
))
10304 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10306 waited
= sit_for (make_number (2), 0, 2);
10308 if (!NILP (waited
) && message_p
)
10309 restore_message ();
10311 unbind_to (count
, Qnil
);
10315 RETURN_UNGCPRO (value
);
10319 /* Return nonzero if input events are pending. */
10322 detect_input_pending (void)
10324 if (!input_pending
)
10325 get_input_pending (&input_pending
, 0);
10327 return input_pending
;
10330 /* Return nonzero if input events other than mouse movements are
10334 detect_input_pending_ignore_squeezables (void)
10336 if (!input_pending
)
10337 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10339 return input_pending
;
10342 /* Return nonzero if input events are pending, and run any pending timers. */
10345 detect_input_pending_run_timers (int do_display
)
10347 int old_timers_run
= timers_run
;
10349 if (!input_pending
)
10350 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10352 if (old_timers_run
!= timers_run
&& do_display
)
10354 redisplay_preserve_echo_area (8);
10355 /* The following fixes a bug when using lazy-lock with
10356 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10357 from an idle timer function. The symptom of the bug is that
10358 the cursor sometimes doesn't become visible until the next X
10359 event is processed. --gerd. */
10361 Lisp_Object tail
, frame
;
10362 FOR_EACH_FRAME (tail
, frame
)
10363 if (FRAME_RIF (XFRAME (frame
)))
10364 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10368 return input_pending
;
10371 /* This is called in some cases before a possible quit.
10372 It cases the next call to detect_input_pending to recompute input_pending.
10373 So calling this function unnecessarily can't do any harm. */
10376 clear_input_pending (void)
10381 /* Return nonzero if there are pending requeued events.
10382 This isn't used yet. The hope is to make wait_reading_process_output
10383 call it, and return if it runs Lisp code that unreads something.
10384 The problem is, kbd_buffer_get_event needs to be fixed to know what
10385 to do in that case. It isn't trivial. */
10388 requeued_events_pending_p (void)
10390 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10394 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10395 doc
: /* Return t if command input is currently available with no wait.
10396 Actually, the value is nil only if we can be sure that no input is available;
10397 if there is a doubt, the value is t. */)
10400 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10401 || !NILP (Vunread_post_input_method_events
)
10402 || !NILP (Vunread_input_method_events
))
10405 get_input_pending (&input_pending
,
10406 READABLE_EVENTS_DO_TIMERS_NOW
10407 | READABLE_EVENTS_FILTER_EVENTS
);
10408 return input_pending
> 0 ? Qt
: Qnil
;
10411 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10412 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10415 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10418 if (total_keys
< NUM_RECENT_KEYS
)
10419 return Fvector (total_keys
, keys
);
10422 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10423 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10424 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10425 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10426 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10431 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10432 doc
: /* Return the key sequence that invoked this command.
10433 However, if the command has called `read-key-sequence', it returns
10434 the last key sequence that has been read.
10435 The value is a string or a vector.
10437 See also `this-command-keys-vector'. */)
10440 return make_event_array (this_command_key_count
,
10441 XVECTOR (this_command_keys
)->contents
);
10444 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10445 doc
: /* Return the key sequence that invoked this command, as a vector.
10446 However, if the command has called `read-key-sequence', it returns
10447 the last key sequence that has been read.
10449 See also `this-command-keys'. */)
10452 return Fvector (this_command_key_count
,
10453 XVECTOR (this_command_keys
)->contents
);
10456 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10457 Sthis_single_command_keys
, 0, 0, 0,
10458 doc
: /* Return the key sequence that invoked this command.
10459 More generally, it returns the last key sequence read, either by
10460 the command loop or by `read-key-sequence'.
10461 Unlike `this-command-keys', this function's value
10462 does not include prefix arguments.
10463 The value is always a vector. */)
10466 return Fvector (this_command_key_count
10467 - this_single_command_key_start
,
10468 (XVECTOR (this_command_keys
)->contents
10469 + this_single_command_key_start
));
10472 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10473 Sthis_single_command_raw_keys
, 0, 0, 0,
10474 doc
: /* Return the raw events that were read for this command.
10475 More generally, it returns the last key sequence read, either by
10476 the command loop or by `read-key-sequence'.
10477 Unlike `this-single-command-keys', this function's value
10478 shows the events before all translations (except for input methods).
10479 The value is always a vector. */)
10482 return Fvector (raw_keybuf_count
,
10483 (XVECTOR (raw_keybuf
)->contents
));
10486 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10487 Sreset_this_command_lengths
, 0, 0, 0,
10488 doc
: /* Make the unread events replace the last command and echo.
10489 Used in `universal-argument-other-key'.
10491 `universal-argument-other-key' rereads the event just typed.
10492 It then gets translated through `function-key-map'.
10493 The translated event has to replace the real events,
10494 both in the value of (this-command-keys) and in echoing.
10495 To achieve this, `universal-argument-other-key' calls
10496 `reset-this-command-lengths', which discards the record of reading
10497 these events the first time. */)
10500 this_command_key_count
= before_command_key_count
;
10501 if (this_command_key_count
< this_single_command_key_start
)
10502 this_single_command_key_start
= this_command_key_count
;
10504 echo_truncate (before_command_echo_length
);
10506 /* Cause whatever we put into unread-command-events
10507 to echo as if it were being freshly read from the keyboard. */
10508 this_command_key_count_reset
= 1;
10513 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10514 Sclear_this_command_keys
, 0, 1, 0,
10515 doc
: /* Clear out the vector that `this-command-keys' returns.
10516 Also clear the record of the last 100 events, unless optional arg
10517 KEEP-RECORD is non-nil. */)
10518 (Lisp_Object keep_record
)
10522 this_command_key_count
= 0;
10523 this_command_key_count_reset
= 0;
10525 if (NILP (keep_record
))
10527 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10528 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10530 recent_keys_index
= 0;
10535 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10536 doc
: /* Return the current depth in recursive edits. */)
10540 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10544 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10545 "FOpen dribble file: ",
10546 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10547 If FILE is nil, close any open dribble file. */)
10559 file
= Fexpand_file_name (file
, Qnil
);
10560 dribble
= fopen (SDATA (file
), "w");
10562 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10567 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10568 doc
: /* Discard the contents of the terminal input buffer.
10569 Also end any kbd macro being defined. */)
10572 if (!NILP (current_kboard
->defining_kbd_macro
))
10574 /* Discard the last command from the macro. */
10575 Fcancel_kbd_macro_events ();
10579 update_mode_lines
++;
10581 Vunread_command_events
= Qnil
;
10582 unread_command_char
= -1;
10584 discard_tty_input ();
10586 kbd_fetch_ptr
= kbd_store_ptr
;
10592 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10593 doc
: /* Stop Emacs and return to superior process. You can resume later.
10594 If `cannot-suspend' is non-nil, or if the system doesn't support job
10595 control, run a subshell instead.
10597 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10598 to be read as terminal input by Emacs's parent, after suspension.
10600 Before suspending, run the normal hook `suspend-hook'.
10601 After resumption run the normal hook `suspend-resume-hook'.
10603 Some operating systems cannot stop the Emacs process and resume it later.
10604 On such systems, Emacs starts a subshell instead of suspending. */)
10605 (Lisp_Object stuffstring
)
10607 int count
= SPECPDL_INDEX ();
10608 int old_height
, old_width
;
10610 struct gcpro gcpro1
;
10612 if (tty_list
&& tty_list
->next
)
10613 error ("There are other tty frames open; close them before suspending Emacs");
10615 if (!NILP (stuffstring
))
10616 CHECK_STRING (stuffstring
);
10618 /* Run the functions in suspend-hook. */
10619 if (!NILP (Vrun_hooks
))
10620 call1 (Vrun_hooks
, intern ("suspend-hook"));
10622 GCPRO1 (stuffstring
);
10623 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10624 reset_all_sys_modes ();
10625 /* sys_suspend can get an error if it tries to fork a subshell
10626 and the system resources aren't available for that. */
10627 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10629 stuff_buffered_input (stuffstring
);
10630 if (cannot_suspend
)
10634 unbind_to (count
, Qnil
);
10636 /* Check if terminal/window size has changed.
10637 Note that this is not useful when we are running directly
10638 with a window system; but suspend should be disabled in that case. */
10639 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10640 if (width
!= old_width
|| height
!= old_height
)
10641 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10643 /* Run suspend-resume-hook. */
10644 if (!NILP (Vrun_hooks
))
10645 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10651 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10652 Then in any case stuff anything Emacs has read ahead and not used. */
10655 stuff_buffered_input (Lisp_Object stuffstring
)
10657 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10658 register unsigned char *p
;
10660 if (STRINGP (stuffstring
))
10662 register EMACS_INT count
;
10664 p
= SDATA (stuffstring
);
10665 count
= SBYTES (stuffstring
);
10666 while (count
-- > 0)
10671 /* Anything we have read ahead, put back for the shell to read. */
10672 /* ?? What should this do when we have multiple keyboards??
10673 Should we ignore anything that was typed in at the "wrong" kboard?
10675 rms: we should stuff everything back into the kboard
10677 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10680 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10681 kbd_fetch_ptr
= kbd_buffer
;
10682 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10683 stuff_char (kbd_fetch_ptr
->code
);
10685 clear_event (kbd_fetch_ptr
);
10689 #endif /* SIGTSTP */
10693 set_waiting_for_input (struct timeval
*time_to_clear
)
10695 input_available_clear_time
= time_to_clear
;
10697 /* Tell handle_interrupt to throw back to read_char, */
10698 waiting_for_input
= 1;
10700 /* If handle_interrupt was called before and buffered a C-g,
10701 make it run again now, to avoid timing error. */
10702 if (!NILP (Vquit_flag
))
10703 quit_throw_to_read_char ();
10707 clear_waiting_for_input (void)
10709 /* Tell handle_interrupt not to throw back to read_char, */
10710 waiting_for_input
= 0;
10711 input_available_clear_time
= 0;
10714 /* The SIGINT handler.
10716 If we have a frame on the controlling tty, we assume that the
10717 SIGINT was generated by C-g, so we call handle_interrupt.
10718 Otherwise, the handler kills Emacs. */
10721 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10722 /* compilers complain in signal calls. */
10724 /* Must preserve main program's value of errno. */
10725 int old_errno
= errno
;
10726 struct terminal
*terminal
;
10728 SIGNAL_THREAD_CHECK (signalnum
);
10730 /* See if we have an active terminal on our controlling tty. */
10731 terminal
= get_named_tty ("/dev/tty");
10734 /* If there are no frames there, let's pretend that we are a
10735 well-behaving UN*X program and quit. */
10736 Fkill_emacs (Qnil
);
10740 /* Otherwise, the SIGINT was probably generated by C-g. */
10742 /* Set internal_last_event_frame to the top frame of the
10743 controlling tty, if we have a frame there. We disable the
10744 interrupt key on secondary ttys, so the SIGINT must have come
10745 from the controlling tty. */
10746 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10748 handle_interrupt ();
10754 /* This routine is called at interrupt level in response to C-g.
10756 It is called from the SIGINT handler or kbd_buffer_store_event.
10758 If `waiting_for_input' is non zero, then unless `echoing' is
10759 nonzero, immediately throw back to read_char.
10761 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10762 eval to throw, when it gets a chance. If quit-flag is already
10763 non-nil, it stops the job right away. */
10766 handle_interrupt (void)
10772 /* XXX This code needs to be revised for multi-tty support. */
10773 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10775 /* If SIGINT isn't blocked, don't let us be interrupted by
10776 another SIGINT, it might be harmful due to non-reentrancy
10777 in I/O functions. */
10778 sigblock (sigmask (SIGINT
));
10781 reset_all_sys_modes ();
10783 #ifdef SIGTSTP /* Support possible in later USG versions */
10785 * On systems which can suspend the current process and return to the original
10786 * shell, this command causes the user to end up back at the shell.
10787 * The "Auto-save" and "Abort" questions are not asked until
10788 * the user elects to return to emacs, at which point he can save the current
10789 * job and either dump core or continue.
10793 /* Perhaps should really fork an inferior shell?
10794 But that would not provide any way to get back
10795 to the original shell, ever. */
10796 printf ("No support for stopping a process on this operating system;\n");
10797 printf ("you can continue or abort.\n");
10798 #endif /* not SIGTSTP */
10800 /* We must remain inside the screen area when the internal terminal
10801 is used. Note that [Enter] is not echoed by dos. */
10802 cursor_to (SELECTED_FRAME (), 0, 0);
10804 /* It doesn't work to autosave while GC is in progress;
10805 the code used for auto-saving doesn't cope with the mark bit. */
10806 if (!gc_in_progress
)
10808 printf ("Auto-save? (y or n) ");
10810 if (((c
= getchar ()) & ~040) == 'Y')
10812 Fdo_auto_save (Qt
, Qnil
);
10814 printf ("\r\nAuto-save done");
10815 #else /* not MSDOS */
10816 printf ("Auto-save done\n");
10817 #endif /* not MSDOS */
10819 while (c
!= '\n') c
= getchar ();
10823 /* During GC, it must be safe to reenable quitting again. */
10824 Vinhibit_quit
= Qnil
;
10827 #endif /* not MSDOS */
10828 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10829 printf ("but will instead do a real quit after garbage collection ends\r\n");
10834 printf ("\r\nAbort? (y or n) ");
10835 #else /* not MSDOS */
10836 printf ("Abort (and dump core)? (y or n) ");
10837 #endif /* not MSDOS */
10839 if (((c
= getchar ()) & ~040) == 'Y')
10841 while (c
!= '\n') c
= getchar ();
10843 printf ("\r\nContinuing...\r\n");
10844 #else /* not MSDOS */
10845 printf ("Continuing...\n");
10846 #endif /* not MSDOS */
10848 init_all_sys_modes ();
10853 /* If executing a function that wants to be interrupted out of
10854 and the user has not deferred quitting by binding `inhibit-quit'
10855 then quit right away. */
10856 if (immediate_quit
&& NILP (Vinhibit_quit
))
10858 struct gl_state_s saved
;
10859 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10861 immediate_quit
= 0;
10864 GCPRO4 (saved
.object
, saved
.global_code
,
10865 saved
.current_syntax_table
, saved
.old_prop
);
10866 Fsignal (Qquit
, Qnil
);
10867 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10872 /* Else request quit when it's safe */
10876 /* TODO: The longjmp in this call throws the NS event loop integration off,
10877 and it seems to do fine without this. Probably some attention
10878 needs to be paid to the setting of waiting_for_input in
10879 wait_reading_process_output() under HAVE_NS because of the call
10880 to ns_select there (needed because otherwise events aren't picked up
10881 outside of polling since we don't get SIGIO like X and we don't have a
10882 separate event loop thread like W32. */
10884 if (waiting_for_input
&& !echoing
)
10885 quit_throw_to_read_char ();
10889 /* Handle a C-g by making read_char return C-g. */
10892 quit_throw_to_read_char (void)
10895 /* Prevent another signal from doing this before we finish. */
10896 clear_waiting_for_input ();
10899 Vunread_command_events
= Qnil
;
10900 unread_command_char
= -1;
10902 #if 0 /* Currently, sit_for is called from read_char without turning
10903 off polling. And that can call set_waiting_for_input.
10904 It seems to be harmless. */
10905 #ifdef POLL_FOR_INPUT
10906 /* May be > 1 if in recursive minibuffer. */
10907 if (poll_suppress_count
== 0)
10911 if (FRAMEP (internal_last_event_frame
)
10912 && !EQ (internal_last_event_frame
, selected_frame
))
10913 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10916 _longjmp (getcjmp
, 1);
10919 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
10920 doc
: /* Set interrupt mode of reading keyboard input.
10921 If INTERRUPT is non-nil, Emacs will use input interrupts;
10922 otherwise Emacs uses CBREAK mode.
10924 See also `current-input-mode'. */)
10925 (Lisp_Object interrupt
)
10927 int new_interrupt_input
;
10929 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10930 #ifdef HAVE_X_WINDOWS
10931 if (x_display_list
!= NULL
)
10933 /* When using X, don't give the user a real choice,
10934 because we haven't implemented the mechanisms to support it. */
10935 new_interrupt_input
= 1;
10938 #endif /* HAVE_X_WINDOWS */
10939 new_interrupt_input
= !NILP (interrupt
);
10940 #else /* not SIGIO */
10941 new_interrupt_input
= 0;
10942 #endif /* not SIGIO */
10944 if (new_interrupt_input
!= interrupt_input
)
10946 #ifdef POLL_FOR_INPUT
10950 /* this causes startup screen to be restored and messes with the mouse */
10951 reset_all_sys_modes ();
10952 interrupt_input
= new_interrupt_input
;
10953 init_all_sys_modes ();
10955 interrupt_input
= new_interrupt_input
;
10958 #ifdef POLL_FOR_INPUT
10959 poll_suppress_count
= 1;
10966 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10967 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10968 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10969 C-q in key sequences.
10971 This setting only has an effect on tty terminals and only when
10972 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10974 See also `current-input-mode'. */)
10975 (Lisp_Object flow
, Lisp_Object terminal
)
10977 struct terminal
*t
= get_terminal (terminal
, 1);
10978 struct tty_display_info
*tty
;
10979 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10981 tty
= t
->display_info
.tty
;
10983 if (tty
->flow_control
!= !NILP (flow
))
10986 /* this causes startup screen to be restored and messes with the mouse */
10987 reset_sys_modes (tty
);
10990 tty
->flow_control
= !NILP (flow
);
10993 init_sys_modes (tty
);
10999 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11000 doc
: /* Enable or disable 8-bit input on TERMINAL.
11001 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11002 bit as the Meta modifier.
11004 If META is nil, Emacs will ignore the top bit, on the assumption it is
11007 Otherwise, Emacs will accept and pass through 8-bit input without
11008 specially interpreting the top bit.
11010 This setting only has an effect on tty terminal devices.
11012 Optional parameter TERMINAL specifies the tty terminal device to use.
11013 It may be a terminal object, a frame, or nil for the terminal used by
11014 the currently selected frame.
11016 See also `current-input-mode'. */)
11017 (Lisp_Object meta
, Lisp_Object terminal
)
11019 struct terminal
*t
= get_terminal (terminal
, 1);
11020 struct tty_display_info
*tty
;
11023 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11025 tty
= t
->display_info
.tty
;
11029 else if (EQ (meta
, Qt
))
11034 if (tty
->meta_key
!= new_meta
)
11037 /* this causes startup screen to be restored and messes with the mouse */
11038 reset_sys_modes (tty
);
11041 tty
->meta_key
= new_meta
;
11044 init_sys_modes (tty
);
11050 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11051 doc
: /* Specify character used for quitting.
11052 QUIT must be an ASCII character.
11054 This function only has an effect on the controlling tty of the Emacs
11057 See also `current-input-mode'. */)
11060 struct terminal
*t
= get_named_tty ("/dev/tty");
11061 struct tty_display_info
*tty
;
11062 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11064 tty
= t
->display_info
.tty
;
11066 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11067 error ("QUIT must be an ASCII character");
11070 /* this causes startup screen to be restored and messes with the mouse */
11071 reset_sys_modes (tty
);
11074 /* Don't let this value be out of range. */
11075 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11078 init_sys_modes (tty
);
11084 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11085 doc
: /* Set mode of reading keyboard input.
11086 First arg INTERRUPT non-nil means use input interrupts;
11087 nil means use CBREAK mode.
11088 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11089 (no effect except in CBREAK mode).
11090 Third arg META t means accept 8-bit input (for a Meta key).
11091 META nil means ignore the top bit, on the assumption it is parity.
11092 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11093 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11094 See also `current-input-mode'. */)
11095 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11097 Fset_input_interrupt_mode (interrupt
);
11098 Fset_output_flow_control (flow
, Qnil
);
11099 Fset_input_meta_mode (meta
, Qnil
);
11101 Fset_quit_char (quit
);
11105 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11106 doc
: /* Return information about the way Emacs currently reads keyboard input.
11107 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11108 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11109 nil, Emacs is using CBREAK mode.
11110 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11111 terminal; this does not apply if Emacs uses interrupt-driven input.
11112 META is t if accepting 8-bit input with 8th bit as Meta flag.
11113 META nil means ignoring the top bit, on the assumption it is parity.
11114 META is neither t nor nil if accepting 8-bit input and using
11115 all 8 bits as the character code.
11116 QUIT is the character Emacs currently uses to quit.
11117 The elements of this list correspond to the arguments of
11118 `set-input-mode'. */)
11121 Lisp_Object val
[4];
11122 struct frame
*sf
= XFRAME (selected_frame
);
11124 val
[0] = interrupt_input
? Qt
: Qnil
;
11125 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11127 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11128 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11130 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11137 XSETFASTINT (val
[3], quit_char
);
11139 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11142 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11143 doc
: /* Return position information for pixel coordinates X and Y.
11144 By default, X and Y are relative to text area of the selected window.
11145 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11146 If optional fourth arg WHOLE is non-nil, X is relative to the left
11147 edge of the window.
11149 The return value is similar to a mouse click position:
11150 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11151 IMAGE (DX . DY) (WIDTH . HEIGHT))
11152 The `posn-' functions access elements of such lists. */)
11153 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11158 if (NILP (frame_or_window
))
11159 frame_or_window
= selected_window
;
11161 if (WINDOWP (frame_or_window
))
11165 CHECK_LIVE_WINDOW (frame_or_window
);
11167 w
= XWINDOW (frame_or_window
);
11168 XSETINT (x
, (XINT (x
)
11169 + WINDOW_LEFT_EDGE_X (w
)
11171 ? window_box_left_offset (w
, TEXT_AREA
)
11173 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11174 frame_or_window
= w
->frame
;
11177 CHECK_LIVE_FRAME (frame_or_window
);
11179 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11182 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11183 doc
: /* Return position information for buffer POS in WINDOW.
11184 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11186 Return nil if position is not visible in window. Otherwise,
11187 the return value is similar to that returned by `event-start' for
11188 a mouse click at the upper left corner of the glyph corresponding
11189 to the given buffer position:
11190 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11191 IMAGE (DX . DY) (WIDTH . HEIGHT))
11192 The `posn-' functions access elements of such lists. */)
11193 (Lisp_Object pos
, Lisp_Object window
)
11198 window
= selected_window
;
11200 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11203 Lisp_Object x
= XCAR (tem
);
11204 Lisp_Object y
= XCAR (XCDR (tem
));
11206 /* Point invisible due to hscrolling? */
11209 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11217 * Set up a new kboard object with reasonable initial values.
11220 init_kboard (KBOARD
*kb
)
11222 kb
->Voverriding_terminal_local_map
= Qnil
;
11223 kb
->Vlast_command
= Qnil
;
11224 kb
->Vreal_last_command
= Qnil
;
11225 kb
->Vkeyboard_translate_table
= Qnil
;
11226 kb
->Vlast_repeatable_command
= Qnil
;
11227 kb
->Vprefix_arg
= Qnil
;
11228 kb
->Vlast_prefix_arg
= Qnil
;
11229 kb
->kbd_queue
= Qnil
;
11230 kb
->kbd_queue_has_data
= 0;
11231 kb
->immediate_echo
= 0;
11232 kb
->echo_string
= Qnil
;
11233 kb
->echo_after_prompt
= -1;
11234 kb
->kbd_macro_buffer
= 0;
11235 kb
->kbd_macro_bufsize
= 0;
11236 kb
->defining_kbd_macro
= Qnil
;
11237 kb
->Vlast_kbd_macro
= Qnil
;
11238 kb
->reference_count
= 0;
11239 kb
->Vsystem_key_alist
= Qnil
;
11240 kb
->system_key_syms
= Qnil
;
11241 kb
->Vwindow_system
= Qt
; /* Unset. */
11242 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11243 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11244 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11245 kb
->Vdefault_minibuffer_frame
= Qnil
;
11249 * Destroy the contents of a kboard object, but not the object itself.
11250 * We use this just before deleting it, or if we're going to initialize
11251 * it a second time.
11254 wipe_kboard (KBOARD
*kb
)
11256 xfree (kb
->kbd_macro_buffer
);
11259 /* Free KB and memory referenced from it. */
11262 delete_kboard (KBOARD
*kb
)
11266 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11269 *kbp
= kb
->next_kboard
;
11271 /* Prevent a dangling reference to KB. */
11272 if (kb
== current_kboard
11273 && FRAMEP (selected_frame
)
11274 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11276 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11278 if (current_kboard
== kb
)
11287 init_keyboard (void)
11289 /* This is correct before outermost invocation of the editor loop */
11290 command_loop_level
= -1;
11291 immediate_quit
= 0;
11292 quit_char
= Ctl ('g');
11293 Vunread_command_events
= Qnil
;
11294 unread_command_char
= -1;
11295 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11297 recent_keys_index
= 0;
11298 kbd_fetch_ptr
= kbd_buffer
;
11299 kbd_store_ptr
= kbd_buffer
;
11300 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11301 do_mouse_tracking
= Qnil
;
11304 interrupt_input_blocked
= 0;
11305 interrupt_input_pending
= 0;
11307 pending_signals
= 0;
11310 /* This means that command_loop_1 won't try to select anything the first
11312 internal_last_event_frame
= Qnil
;
11313 Vlast_event_frame
= internal_last_event_frame
;
11315 current_kboard
= initial_kboard
;
11316 /* Re-initialize the keyboard again. */
11317 wipe_kboard (current_kboard
);
11318 init_kboard (current_kboard
);
11319 /* A value of nil for Vwindow_system normally means a tty, but we also use
11320 it for the initial terminal since there is no window system there. */
11321 current_kboard
->Vwindow_system
= Qnil
;
11323 if (!noninteractive
)
11325 /* Before multi-tty support, these handlers used to be installed
11326 only if the current session was a tty session. Now an Emacs
11327 session may have multiple display types, so we always handle
11328 SIGINT. There is special code in interrupt_signal to exit
11329 Emacs on SIGINT when there are no termcap frames on the
11330 controlling terminal. */
11331 signal (SIGINT
, interrupt_signal
);
11333 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11334 SIGQUIT and we can't tell which one it will give us. */
11335 signal (SIGQUIT
, interrupt_signal
);
11336 #endif /* not DOS_NT */
11338 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11340 if (!noninteractive
)
11341 signal (SIGIO
, input_available_signal
);
11344 /* Use interrupt input by default, if it works and noninterrupt input
11345 has deficiencies. */
11347 #ifdef INTERRUPT_INPUT
11348 interrupt_input
= 1;
11350 interrupt_input
= 0;
11356 if (keyboard_init_hook
)
11357 (*keyboard_init_hook
) ();
11359 #ifdef POLL_FOR_INPUT
11361 poll_suppress_count
= 1;
11366 /* This type's only use is in syms_of_keyboard, to initialize the
11367 event header symbols and put properties on them. */
11368 struct event_head
{
11374 static const struct event_head head_table
[] = {
11375 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11376 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11377 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11378 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11379 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11380 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11381 /* `select-window' should be handled just like `switch-frame'
11382 in read_key_sequence. */
11383 {&Qselect_window
, "select-window", &Qswitch_frame
}
11387 syms_of_keyboard (void)
11389 pending_funcalls
= Qnil
;
11390 staticpro (&pending_funcalls
);
11392 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11393 staticpro (&Vlispy_mouse_stem
);
11396 QCimage
= intern_c_string (":image");
11397 staticpro (&QCimage
);
11399 staticpro (&Qhelp_echo
);
11400 Qhelp_echo
= intern_c_string ("help-echo");
11403 Qrtl
= intern_c_string (":rtl");
11405 staticpro (&item_properties
);
11406 item_properties
= Qnil
;
11408 staticpro (&tool_bar_item_properties
);
11409 tool_bar_item_properties
= Qnil
;
11410 staticpro (&tool_bar_items_vector
);
11411 tool_bar_items_vector
= Qnil
;
11413 staticpro (&real_this_command
);
11414 real_this_command
= Qnil
;
11416 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11417 staticpro (&Qtimer_event_handler
);
11419 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11420 staticpro (&Qdisabled_command_function
);
11422 Qself_insert_command
= intern_c_string ("self-insert-command");
11423 staticpro (&Qself_insert_command
);
11425 Qforward_char
= intern_c_string ("forward-char");
11426 staticpro (&Qforward_char
);
11428 Qbackward_char
= intern_c_string ("backward-char");
11429 staticpro (&Qbackward_char
);
11431 Qdisabled
= intern_c_string ("disabled");
11432 staticpro (&Qdisabled
);
11434 Qundefined
= intern_c_string ("undefined");
11435 staticpro (&Qundefined
);
11437 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11438 staticpro (&Qpre_command_hook
);
11440 Qpost_command_hook
= intern_c_string ("post-command-hook");
11441 staticpro (&Qpost_command_hook
);
11443 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11444 staticpro (&Qdeferred_action_function
);
11446 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11447 staticpro (&Qcommand_hook_internal
);
11449 Qfunction_key
= intern_c_string ("function-key");
11450 staticpro (&Qfunction_key
);
11451 Qmouse_click
= intern_c_string ("mouse-click");
11452 staticpro (&Qmouse_click
);
11453 #if defined (WINDOWSNT)
11454 Qlanguage_change
= intern_c_string ("language-change");
11455 staticpro (&Qlanguage_change
);
11457 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11458 staticpro (&Qdrag_n_drop
);
11460 Qsave_session
= intern_c_string ("save-session");
11461 staticpro (&Qsave_session
);
11464 Qdbus_event
= intern_c_string ("dbus-event");
11465 staticpro (&Qdbus_event
);
11468 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11469 staticpro (&Qconfig_changed_event
);
11471 Qmenu_enable
= intern_c_string ("menu-enable");
11472 staticpro (&Qmenu_enable
);
11473 QCenable
= intern_c_string (":enable");
11474 staticpro (&QCenable
);
11475 QCvisible
= intern_c_string (":visible");
11476 staticpro (&QCvisible
);
11477 QChelp
= intern_c_string (":help");
11478 staticpro (&QChelp
);
11479 QCfilter
= intern_c_string (":filter");
11480 staticpro (&QCfilter
);
11481 QCbutton
= intern_c_string (":button");
11482 staticpro (&QCbutton
);
11483 QCkeys
= intern_c_string (":keys");
11484 staticpro (&QCkeys
);
11485 QCkey_sequence
= intern_c_string (":key-sequence");
11486 staticpro (&QCkey_sequence
);
11487 QCtoggle
= intern_c_string (":toggle");
11488 staticpro (&QCtoggle
);
11489 QCradio
= intern_c_string (":radio");
11490 staticpro (&QCradio
);
11491 QClabel
= intern_c_string (":label");
11492 staticpro (&QClabel
);
11493 QCvert_only
= intern_c_string (":vert-only");
11494 staticpro (&QCvert_only
);
11496 Qmode_line
= intern_c_string ("mode-line");
11497 staticpro (&Qmode_line
);
11498 Qvertical_line
= intern_c_string ("vertical-line");
11499 staticpro (&Qvertical_line
);
11500 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11501 staticpro (&Qvertical_scroll_bar
);
11502 Qmenu_bar
= intern_c_string ("menu-bar");
11503 staticpro (&Qmenu_bar
);
11505 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11506 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11507 staticpro (&Qmouse_fixup_help_message
);
11510 Qabove_handle
= intern_c_string ("above-handle");
11511 staticpro (&Qabove_handle
);
11512 Qhandle
= intern_c_string ("handle");
11513 staticpro (&Qhandle
);
11514 Qbelow_handle
= intern_c_string ("below-handle");
11515 staticpro (&Qbelow_handle
);
11516 Qup
= intern_c_string ("up");
11518 Qdown
= intern_c_string ("down");
11519 staticpro (&Qdown
);
11520 Qtop
= intern_c_string ("top");
11522 Qbottom
= intern_c_string ("bottom");
11523 staticpro (&Qbottom
);
11524 Qend_scroll
= intern_c_string ("end-scroll");
11525 staticpro (&Qend_scroll
);
11526 Qratio
= intern_c_string ("ratio");
11527 staticpro (&Qratio
);
11529 Qevent_kind
= intern_c_string ("event-kind");
11530 staticpro (&Qevent_kind
);
11531 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11532 staticpro (&Qevent_symbol_elements
);
11533 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11534 staticpro (&Qevent_symbol_element_mask
);
11535 Qmodifier_cache
= intern_c_string ("modifier-cache");
11536 staticpro (&Qmodifier_cache
);
11538 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11539 staticpro (&Qrecompute_lucid_menubar
);
11540 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11541 staticpro (&Qactivate_menubar_hook
);
11543 Qpolling_period
= intern_c_string ("polling-period");
11544 staticpro (&Qpolling_period
);
11546 Qinput_method_function
= intern_c_string ("input-method-function");
11547 staticpro (&Qinput_method_function
);
11549 Qx_set_selection
= intern_c_string ("x-set-selection");
11550 staticpro (&Qx_set_selection
);
11551 QPRIMARY
= intern_c_string ("PRIMARY");
11552 staticpro (&QPRIMARY
);
11553 Qhandle_switch_frame
= intern_c_string ("handle-switch-frame");
11554 staticpro (&Qhandle_switch_frame
);
11556 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11557 staticpro (&Qinput_method_exit_on_first_char
);
11558 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11559 staticpro (&Qinput_method_use_echo_area
);
11561 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11562 Fset (Qinput_method_use_echo_area
, Qnil
);
11564 last_point_position_buffer
= Qnil
;
11565 last_point_position_window
= Qnil
;
11568 const struct event_head
*p
;
11570 for (p
= head_table
;
11571 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11574 *p
->var
= intern_c_string (p
->name
);
11575 staticpro (p
->var
);
11576 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11577 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11581 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11582 staticpro (&button_down_location
);
11583 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11584 staticpro (&mouse_syms
);
11585 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11586 / sizeof (lispy_wheel_names
[0])),
11588 staticpro (&wheel_syms
);
11592 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11594 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11595 for (i
= 0; i
< len
; i
++)
11596 if (modifier_names
[i
])
11597 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11598 staticpro (&modifier_symbols
);
11601 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11602 staticpro (&recent_keys
);
11604 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11605 staticpro (&this_command_keys
);
11607 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11608 staticpro (&raw_keybuf
);
11610 Qextended_command_history
= intern_c_string ("extended-command-history");
11611 Fset (Qextended_command_history
, Qnil
);
11612 staticpro (&Qextended_command_history
);
11614 accent_key_syms
= Qnil
;
11615 staticpro (&accent_key_syms
);
11617 func_key_syms
= Qnil
;
11618 staticpro (&func_key_syms
);
11620 drag_n_drop_syms
= Qnil
;
11621 staticpro (&drag_n_drop_syms
);
11623 unread_switch_frame
= Qnil
;
11624 staticpro (&unread_switch_frame
);
11626 internal_last_event_frame
= Qnil
;
11627 staticpro (&internal_last_event_frame
);
11629 read_key_sequence_cmd
= Qnil
;
11630 staticpro (&read_key_sequence_cmd
);
11632 menu_bar_one_keymap_changed_items
= Qnil
;
11633 staticpro (&menu_bar_one_keymap_changed_items
);
11635 menu_bar_items_vector
= Qnil
;
11636 staticpro (&menu_bar_items_vector
);
11638 help_form_saved_window_configs
= Qnil
;
11639 staticpro (&help_form_saved_window_configs
);
11641 defsubr (&Scurrent_idle_time
);
11642 defsubr (&Sevent_symbol_parse_modifiers
);
11643 defsubr (&Sevent_convert_list
);
11644 defsubr (&Sread_key_sequence
);
11645 defsubr (&Sread_key_sequence_vector
);
11646 defsubr (&Srecursive_edit
);
11647 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11648 defsubr (&Strack_mouse
);
11650 defsubr (&Sinput_pending_p
);
11651 defsubr (&Scommand_execute
);
11652 defsubr (&Srecent_keys
);
11653 defsubr (&Sthis_command_keys
);
11654 defsubr (&Sthis_command_keys_vector
);
11655 defsubr (&Sthis_single_command_keys
);
11656 defsubr (&Sthis_single_command_raw_keys
);
11657 defsubr (&Sreset_this_command_lengths
);
11658 defsubr (&Sclear_this_command_keys
);
11659 defsubr (&Ssuspend_emacs
);
11660 defsubr (&Sabort_recursive_edit
);
11661 defsubr (&Sexit_recursive_edit
);
11662 defsubr (&Srecursion_depth
);
11663 defsubr (&Stop_level
);
11664 defsubr (&Sdiscard_input
);
11665 defsubr (&Sopen_dribble_file
);
11666 defsubr (&Sset_input_interrupt_mode
);
11667 defsubr (&Sset_output_flow_control
);
11668 defsubr (&Sset_input_meta_mode
);
11669 defsubr (&Sset_quit_char
);
11670 defsubr (&Sset_input_mode
);
11671 defsubr (&Scurrent_input_mode
);
11672 defsubr (&Sexecute_extended_command
);
11673 defsubr (&Sposn_at_point
);
11674 defsubr (&Sposn_at_x_y
);
11676 DEFVAR_LISP ("last-command-event", last_command_event
,
11677 doc
: /* Last input event that was part of a command. */);
11679 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11680 doc
: /* Last input event in a command, except for mouse menu events.
11681 Mouse menus give back keys that don't look like mouse events;
11682 this variable holds the actual mouse event that led to the menu,
11683 so that you can determine whether the command was run by mouse or not. */);
11685 DEFVAR_LISP ("last-input-event", last_input_event
,
11686 doc
: /* Last input event. */);
11688 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11689 doc
: /* List of events to be read as the command input.
11690 These events are processed first, before actual keyboard input.
11691 Events read from this list are not normally added to `this-command-keys',
11692 as they will already have been added once as they were read for the first time.
11693 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11694 Vunread_command_events
= Qnil
;
11696 DEFVAR_INT ("unread-command-char", unread_command_char
,
11697 doc
: /* If not -1, an object to be read as next command input event. */);
11699 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11700 doc
: /* List of events to be processed as input by input methods.
11701 These events are processed before `unread-command-events'
11702 and actual keyboard input, but are not given to `input-method-function'. */);
11703 Vunread_post_input_method_events
= Qnil
;
11705 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11706 doc
: /* List of events to be processed as input by input methods.
11707 These events are processed after `unread-command-events', but
11708 before actual keyboard input.
11709 If there's an active input method, the events are given to
11710 `input-method-function'. */);
11711 Vunread_input_method_events
= Qnil
;
11713 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11714 doc
: /* Meta-prefix character code.
11715 Meta-foo as command input turns into this character followed by foo. */);
11716 XSETINT (meta_prefix_char
, 033);
11718 DEFVAR_KBOARD ("last-command", Vlast_command
,
11719 doc
: /* The last command executed.
11720 Normally a symbol with a function definition, but can be whatever was found
11721 in the keymap, or whatever the variable `this-command' was set to by that
11724 The value `mode-exit' is special; it means that the previous command
11725 read an event that told it to exit, and it did so and unread that event.
11726 In other words, the present command is the event that made the previous
11729 The value `kill-region' is special; it means that the previous command
11730 was a kill command.
11732 `last-command' has a separate binding for each terminal device.
11733 See Info node `(elisp)Multiple Terminals'. */);
11735 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11736 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11738 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11739 doc
: /* Last command that may be repeated.
11740 The last command executed that was not bound to an input event.
11741 This is the command `repeat' will try to repeat. */);
11743 DEFVAR_LISP ("this-command", Vthis_command
,
11744 doc
: /* The command now being executed.
11745 The command can set this variable; whatever is put here
11746 will be in `last-command' during the following command. */);
11747 Vthis_command
= Qnil
;
11749 DEFVAR_LISP ("this-command-keys-shift-translated",
11750 Vthis_command_keys_shift_translated
,
11751 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11752 Shift-translation occurs when there is no binding for the key sequence
11753 as entered, but a binding was found by changing an upper-case letter
11754 to lower-case, or a shifted function key to an unshifted one. */);
11755 Vthis_command_keys_shift_translated
= Qnil
;
11757 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11758 doc
: /* The command bound to the current key sequence before remapping.
11759 It equals `this-command' if the original command was not remapped through
11760 any of the active keymaps. Otherwise, the value of `this-command' is the
11761 result of looking up the original command in the active keymaps. */);
11762 Vthis_original_command
= Qnil
;
11764 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11765 doc
: /* *Number of input events between auto-saves.
11766 Zero means disable autosaving due to number of characters typed. */);
11767 auto_save_interval
= 300;
11769 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11770 doc
: /* *Number of seconds idle time before auto-save.
11771 Zero or nil means disable auto-saving due to idleness.
11772 After auto-saving due to this many seconds of idle time,
11773 Emacs also does a garbage collection if that seems to be warranted. */);
11774 XSETFASTINT (Vauto_save_timeout
, 30);
11776 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11777 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11778 The value may be integer or floating point. */);
11779 Vecho_keystrokes
= make_number (1);
11781 DEFVAR_INT ("polling-period", polling_period
,
11782 doc
: /* *Interval between polling for input during Lisp execution.
11783 The reason for polling is to make C-g work to stop a running program.
11784 Polling is needed only when using X windows and SIGIO does not work.
11785 Polling is automatically disabled in all other cases. */);
11786 polling_period
= 2;
11788 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11789 doc
: /* *Maximum time between mouse clicks to make a double-click.
11790 Measured in milliseconds. The value nil means disable double-click
11791 recognition; t means double-clicks have no time limit and are detected
11792 by position only. */);
11793 Vdouble_click_time
= make_number (500);
11795 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11796 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11797 On window-system frames, value is the number of pixels the mouse may have
11798 moved horizontally or vertically between two clicks to make a double-click.
11799 On non window-system frames, value is interpreted in units of 1/8 characters
11802 This variable is also the threshold for motion of the mouse
11803 to count as a drag. */);
11804 double_click_fuzz
= 3;
11806 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11807 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11808 inhibit_local_menu_bar_menus
= 0;
11810 DEFVAR_INT ("num-input-keys", num_input_keys
,
11811 doc
: /* Number of complete key sequences read as input so far.
11812 This includes key sequences read from keyboard macros.
11813 The number is effectively the number of interactive command invocations. */);
11814 num_input_keys
= 0;
11816 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11817 doc
: /* Number of input events read from the keyboard so far.
11818 This does not include events generated by keyboard macros. */);
11819 num_nonmacro_input_events
= 0;
11821 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11822 doc
: /* The frame in which the most recently read event occurred.
11823 If the last event came from a keyboard macro, this is set to `macro'. */);
11824 Vlast_event_frame
= Qnil
;
11826 /* This variable is set up in sysdep.c. */
11827 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11828 doc
: /* The ERASE character as set by the user with stty. */);
11830 DEFVAR_LISP ("help-char", Vhelp_char
,
11831 doc
: /* Character to recognize as meaning Help.
11832 When it is read, do `(eval help-form)', and display result if it's a string.
11833 If the value of `help-form' is nil, this char can be read normally. */);
11834 XSETINT (Vhelp_char
, Ctl ('H'));
11836 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11837 doc
: /* List of input events to recognize as meaning Help.
11838 These work just like the value of `help-char' (see that). */);
11839 Vhelp_event_list
= Qnil
;
11841 DEFVAR_LISP ("help-form", Vhelp_form
,
11842 doc
: /* Form to execute when character `help-char' is read.
11843 If the form returns a string, that string is displayed.
11844 If `help-form' is nil, the help char is not recognized. */);
11847 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11848 doc
: /* Command to run when `help-char' character follows a prefix key.
11849 This command is used only when there is no actual binding
11850 for that character after that prefix key. */);
11851 Vprefix_help_command
= Qnil
;
11853 DEFVAR_LISP ("top-level", Vtop_level
,
11854 doc
: /* Form to evaluate when Emacs starts up.
11855 Useful to set before you dump a modified Emacs. */);
11858 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11859 doc
: /* Translate table for local keyboard input, or nil.
11860 If non-nil, the value should be a char-table. Each character read
11861 from the keyboard is looked up in this char-table. If the value found
11862 there is non-nil, then it is used instead of the actual input character.
11864 The value can also be a string or vector, but this is considered obsolete.
11865 If it is a string or vector of length N, character codes N and up are left
11866 untranslated. In a vector, an element which is nil means "no translation".
11868 This is applied to the characters supplied to input methods, not their
11869 output. See also `translation-table-for-input'.
11871 This variable has a separate binding for each terminal.
11872 See Info node `(elisp)Multiple Terminals'. */);
11874 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11875 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11876 \(Even if the operating system has support for stopping a process.\) */);
11877 cannot_suspend
= 0;
11879 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11880 doc
: /* Non-nil means prompt with menus when appropriate.
11881 This is done when reading from a keymap that has a prompt string,
11882 for elements that have prompt strings.
11883 The menu is displayed on the screen
11884 if X menus were enabled at configuration
11885 time and the previous event was a mouse click prefix key.
11886 Otherwise, menu prompting uses the echo area. */);
11887 menu_prompting
= 1;
11889 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11890 doc
: /* Character to see next line of menu prompt.
11891 Type this character while in a menu prompt to rotate around the lines of it. */);
11892 XSETINT (menu_prompt_more_char
, ' ');
11894 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11895 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11896 Emacs applies the modifiers of the character stored here to each keyboard
11897 character it reads. For example, after evaluating the expression
11898 (setq extra-keyboard-modifiers ?\\C-x)
11899 all input characters will have the control modifier applied to them.
11901 Note that the character ?\\C-@, equivalent to the integer zero, does
11902 not count as a control character; rather, it counts as a character
11903 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11904 cancels any modification. */);
11905 extra_keyboard_modifiers
= 0;
11907 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11908 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11909 The command loop sets this to nil before each command,
11910 and tests the value when the command returns.
11911 Buffer modification stores t in this variable. */);
11912 Vdeactivate_mark
= Qnil
;
11913 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
11914 staticpro (&Qdeactivate_mark
);
11916 DEFVAR_LISP ("command-hook-internal", Vcommand_hook_internal
,
11917 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
11918 Vcommand_hook_internal
= Qnil
;
11920 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11921 doc
: /* Normal hook run before each command is executed.
11922 If an unhandled error happens in running this hook,
11923 the hook value is set to nil, since otherwise the error
11924 might happen repeatedly and make Emacs nonfunctional. */);
11925 Vpre_command_hook
= Qnil
;
11927 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11928 doc
: /* Normal hook run after each command is executed.
11929 If an unhandled error happens in running this hook,
11930 the hook value is set to nil, since otherwise the error
11931 might happen repeatedly and make Emacs nonfunctional. */);
11932 Vpost_command_hook
= Qnil
;
11935 DEFVAR_LISP ("echo-area-clear-hook", ...,
11936 doc
: /* Normal hook run when clearing the echo area. */);
11938 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
11939 staticpro (&Qecho_area_clear_hook
);
11940 Fset (Qecho_area_clear_hook
, Qnil
);
11942 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11943 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11944 Vlucid_menu_bar_dirty_flag
= Qnil
;
11946 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11947 doc
: /* List of menu bar items to move to the end of the menu bar.
11948 The elements of the list are event types that may have menu bar bindings. */);
11949 Vmenu_bar_final_items
= Qnil
;
11951 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11952 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11953 This is used internally by graphical displays that do not render
11954 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11955 Vtool_bar_separator_image_expression
= Qnil
;
11957 DEFVAR_KBOARD ("overriding-terminal-local-map",
11958 Voverriding_terminal_local_map
,
11959 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11960 If this variable is non-nil, it is used as a keymap instead of the
11961 buffer's local map, and the minor mode keymaps and text property keymaps.
11962 It also replaces `overriding-local-map'.
11964 This variable is intended to let commands such as `universal-argument'
11965 set up a different keymap for reading the next command.
11967 `overriding-terminal-local-map' has a separate binding for each
11969 See Info node `(elisp)Multiple Terminals'. */);
11971 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11972 doc
: /* Keymap that overrides all other local keymaps.
11973 If this variable is non-nil, it is used as a keymap--replacing the
11974 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11975 Voverriding_local_map
= Qnil
;
11977 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11978 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11979 Otherwise, the menu bar continues to reflect the buffer's local map
11980 and the minor mode maps regardless of `overriding-local-map'. */);
11981 Voverriding_local_map_menu_flag
= Qnil
;
11983 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11984 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11985 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11987 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11988 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11990 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11991 doc
: /* Alist of system-specific X windows key symbols.
11992 Each element should have the form (N . SYMBOL) where N is the
11993 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11994 and SYMBOL is its name.
11996 `system-key-alist' has a separate binding for each terminal device.
11997 See Info node `(elisp)Multiple Terminals'. */);
11999 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12000 doc
: /* Keymap that translates key sequences to key sequences during input.
12001 This is used mainly for mapping key sequences into some preferred
12002 key events (symbols).
12004 The `read-key-sequence' function replaces any subsequence bound by
12005 `local-function-key-map' with its binding. More precisely, when the
12006 active keymaps have no binding for the current key sequence but
12007 `local-function-key-map' binds a suffix of the sequence to a vector or
12008 string, `read-key-sequence' replaces the matching suffix with its
12009 binding, and continues with the new sequence.
12011 If the binding is a function, it is called with one argument (the prompt)
12012 and its return value (a key sequence) is used.
12014 The events that come from bindings in `local-function-key-map' are not
12015 themselves looked up in `local-function-key-map'.
12017 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12018 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12019 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12020 typing `ESC O P x' would return [f1 x].
12022 `local-function-key-map' has a separate binding for each terminal
12023 device. See Info node `(elisp)Multiple Terminals'. If you need to
12024 define a binding on all terminals, change `function-key-map'
12025 instead. Initially, `local-function-key-map' is an empty keymap that
12026 has `function-key-map' as its parent on all terminal devices. */);
12028 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12029 doc
: /* Keymap that decodes input escape sequences.
12030 This is used mainly for mapping ASCII function key sequences into
12031 real Emacs function key events (symbols).
12033 The `read-key-sequence' function replaces any subsequence bound by
12034 `input-decode-map' with its binding. Contrary to `function-key-map',
12035 this map applies its rebinding regardless of the presence of an ordinary
12036 binding. So it is more like `key-translation-map' except that it applies
12037 before `function-key-map' rather than after.
12039 If the binding is a function, it is called with one argument (the prompt)
12040 and its return value (a key sequence) is used.
12042 The events that come from bindings in `input-decode-map' are not
12043 themselves looked up in `input-decode-map'.
12045 This variable is keyboard-local. */);
12047 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12048 doc
: /* The parent keymap of all `local-function-key-map' instances.
12049 Function key definitions that apply to all terminal devices should go
12050 here. If a mapping is defined in both the current
12051 `local-function-key-map' binding and this variable, then the local
12052 definition will take precendence. */);
12053 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12055 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12056 doc
: /* Keymap of key translations that can override keymaps.
12057 This keymap works like `function-key-map', but comes after that,
12058 and its non-prefix bindings override ordinary bindings.
12059 Another difference is that it is global rather than keyboard-local. */);
12060 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12062 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12063 doc
: /* List of deferred actions to be performed at a later time.
12064 The precise format isn't relevant here; we just check whether it is nil. */);
12065 Vdeferred_action_list
= Qnil
;
12067 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12068 doc
: /* Function to call to handle deferred actions, after each command.
12069 This function is called with no arguments after each command
12070 whenever `deferred-action-list' is non-nil. */);
12071 Vdeferred_action_function
= Qnil
;
12073 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12074 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12075 The value can be a length of time to show the message for.
12076 If the value is non-nil and not a number, we wait 2 seconds. */);
12077 Vsuggest_key_bindings
= Qt
;
12079 DEFVAR_LISP ("timer-list", Vtimer_list
,
12080 doc
: /* List of active absolute time timers in order of increasing time. */);
12081 Vtimer_list
= Qnil
;
12083 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12084 doc
: /* List of active idle-time timers in order of increasing time. */);
12085 Vtimer_idle_list
= Qnil
;
12087 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12088 doc
: /* If non-nil, the function that implements the current input method.
12089 It's called with one argument, a printing character that was just read.
12090 \(That means a character with code 040...0176.)
12091 Typically this function uses `read-event' to read additional events.
12092 When it does so, it should first bind `input-method-function' to nil
12093 so it will not be called recursively.
12095 The function should return a list of zero or more events
12096 to be used as input. If it wants to put back some events
12097 to be reconsidered, separately, by the input method,
12098 it can add them to the beginning of `unread-command-events'.
12100 The input method function can find in `input-method-previous-message'
12101 the previous echo area message.
12103 The input method function should refer to the variables
12104 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12105 for guidance on what to do. */);
12106 Vinput_method_function
= Qnil
;
12108 DEFVAR_LISP ("input-method-previous-message",
12109 Vinput_method_previous_message
,
12110 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12111 This variable exists because `read-event' clears the echo area
12112 before running the input method. It is nil if there was no message. */);
12113 Vinput_method_previous_message
= Qnil
;
12115 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12116 doc
: /* If non-nil, the function that implements the display of help.
12117 It's called with one argument, the help string to display. */);
12118 Vshow_help_function
= Qnil
;
12120 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12121 doc
: /* If non-nil, suppress point adjustment after executing a command.
12123 After a command is executed, if point is moved into a region that has
12124 special properties (e.g. composition, display), we adjust point to
12125 the boundary of the region. But, when a command sets this variable to
12126 non-nil, we suppress the point adjustment.
12128 This variable is set to nil before reading a command, and is checked
12129 just after executing the command. */);
12130 Vdisable_point_adjustment
= Qnil
;
12132 DEFVAR_LISP ("global-disable-point-adjustment",
12133 Vglobal_disable_point_adjustment
,
12134 doc
: /* *If non-nil, always suppress point adjustment.
12136 The default value is nil, in which case, point adjustment are
12137 suppressed only after special commands that set
12138 `disable-point-adjustment' (which see) to non-nil. */);
12139 Vglobal_disable_point_adjustment
= Qnil
;
12141 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12142 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12143 If the value is not a number, such messages don't time out. */);
12144 Vminibuffer_message_timeout
= make_number (2);
12146 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12147 doc
: /* If non-nil, any keyboard input throws to this symbol.
12148 The value of that variable is passed to `quit-flag' and later causes a
12149 peculiar kind of quitting. */);
12150 Vthrow_on_input
= Qnil
;
12152 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12153 doc
: /* If non-nil, function to output error messages.
12154 The arguments are the error data, a list of the form
12155 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12156 such as just as `condition-case' would bind its variable to,
12157 the context (a string which normally goes at the start of the message),
12158 and the Lisp function within which the error was signaled. */);
12159 Vcommand_error_function
= Qnil
;
12161 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12162 Venable_disabled_menus_and_buttons
,
12163 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12165 Help functions bind this to allow help on disabled menu items
12166 and tool-bar buttons. */);
12167 Venable_disabled_menus_and_buttons
= Qnil
;
12169 DEFVAR_LISP ("select-active-regions",
12170 Vselect_active_regions
,
12171 doc
: /* If non-nil, an active region automatically sets the primary selection.
12172 If the value is `only', only temporarily active regions (usually made
12173 by mouse-dragging or shift-selection) set the window selection.
12175 This takes effect only when Transient Mark mode is enabled. */);
12176 Vselect_active_regions
= Qt
;
12178 DEFVAR_LISP ("saved-region-selection",
12179 Vsaved_region_selection
,
12180 doc
: /* Contents of active region prior to buffer modification.
12181 If `select-active-regions' is non-nil, Emacs sets this to the
12182 text in the region before modifying the buffer. The next
12183 `deactivate-mark' call uses this to set the window selection. */);
12184 Vsaved_region_selection
= Qnil
;
12186 /* Create the initial keyboard. */
12187 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12188 init_kboard (initial_kboard
);
12189 /* Vwindow_system is left at t for now. */
12190 initial_kboard
->next_kboard
= all_kboards
;
12191 all_kboards
= initial_kboard
;
12195 keys_of_keyboard (void)
12197 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12198 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12199 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12200 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12201 initial_define_key (meta_map
, 'x', "execute-extended-command");
12203 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12204 "handle-delete-frame");
12205 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12206 "ns-put-working-text");
12207 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12208 "ns-unput-working-text");
12209 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12210 current-prefix-arg, as is done in `handle-switch-frame'.
12211 But `handle-switch-frame is not run from the special-map.
12212 Commands from that map are run in a special way that automatically
12213 preserves the prefix-arg. Restoring the prefix arg here is not just
12214 redundant but harmful:
12216 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12217 - after the first prompt, the exit-minibuffer-hook is run which may
12218 iconify a frame and thus push a `iconify-frame' event.
12219 - after running exit-minibuffer-hook, current-prefix-arg is
12220 restored to the non-nil value it had before the prompt.
12221 - we enter the second prompt.
12222 current-prefix-arg is non-nil, prefix-arg is nil.
12223 - before running the first real event, we run the special iconify-frame
12224 event, but we pass the `special' arg to execute-command so
12225 current-prefix-arg and prefix-arg are left untouched.
12226 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12227 - the next key event will have a spuriously non-nil current-prefix-arg. */
12228 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12230 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12232 /* Handling it at such a low-level causes read_key_sequence to get
12233 * confused because it doesn't realize that the current_buffer was
12234 * changed by read_char.
12236 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12237 * "handle-select-window"); */
12238 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12239 "handle-save-session");
12242 /* Define a special event which is raised for dbus callback
12244 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12245 "dbus-handle-event");
12248 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12252 /* Mark the pointers in the kboard objects.
12253 Called by the Fgarbage_collector. */
12255 mark_kboards (void)
12259 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12261 if (kb
->kbd_macro_buffer
)
12262 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12264 mark_object (kb
->Voverriding_terminal_local_map
);
12265 mark_object (kb
->Vlast_command
);
12266 mark_object (kb
->Vreal_last_command
);
12267 mark_object (kb
->Vkeyboard_translate_table
);
12268 mark_object (kb
->Vlast_repeatable_command
);
12269 mark_object (kb
->Vprefix_arg
);
12270 mark_object (kb
->Vlast_prefix_arg
);
12271 mark_object (kb
->kbd_queue
);
12272 mark_object (kb
->defining_kbd_macro
);
12273 mark_object (kb
->Vlast_kbd_macro
);
12274 mark_object (kb
->Vsystem_key_alist
);
12275 mark_object (kb
->system_key_syms
);
12276 mark_object (kb
->Vwindow_system
);
12277 mark_object (kb
->Vinput_decode_map
);
12278 mark_object (kb
->Vlocal_function_key_map
);
12279 mark_object (kb
->Vdefault_minibuffer_frame
);
12280 mark_object (kb
->echo_string
);
12283 struct input_event
*event
;
12284 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12286 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12287 event
= kbd_buffer
;
12288 if (event
->kind
!= SELECTION_REQUEST_EVENT
12289 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12291 mark_object (event
->x
);
12292 mark_object (event
->y
);
12294 mark_object (event
->frame_or_window
);
12295 mark_object (event
->arg
);