1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
47 #ifdef HAVE_GTK_AND_PTHREAD
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
101 /* Non-nil disable property on a command means
102 do not execute it; call disabled-command-function's value instead. */
103 Lisp_Object Qdisabled
, Qdisabled_command_function
;
105 #define NUM_RECENT_KEYS (300)
106 int recent_keys_index
; /* Index for storing next element into recent_keys */
107 int total_keys
; /* Total number of elements stored into recent_keys */
108 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
110 /* Vector holding the key sequence that invoked the current command.
111 It is reused for each command, and it may be longer than the current
112 sequence; this_command_key_count indicates how many elements
113 actually mean something.
114 It's easier to staticpro a single Lisp_Object than an array. */
115 Lisp_Object this_command_keys
;
116 int this_command_key_count
;
118 /* 1 after calling Freset_this_command_lengths.
120 int this_command_key_count_reset
;
122 /* This vector is used as a buffer to record the events that were actually read
123 by read_key_sequence. */
124 Lisp_Object raw_keybuf
;
125 int raw_keybuf_count
;
127 #define GROW_RAW_KEYBUF \
128 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
129 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
131 /* Number of elements of this_command_keys
132 that precede this key sequence. */
133 int this_single_command_key_start
;
135 /* Record values of this_command_key_count and echo_length ()
136 before this command was read. */
137 static int before_command_key_count
;
138 static int before_command_echo_length
;
140 /* For longjmp to where kbd input is being done. */
142 static jmp_buf getcjmp
;
144 /* True while doing kbd input. */
145 int waiting_for_input
;
147 /* True while displaying for echoing. Delays C-g throwing. */
151 /* Non-null means we can start echoing at the next input pause even
152 though there is something in the echo area. */
154 static struct kboard
*ok_to_echo_at_next_pause
;
156 /* The kboard last echoing, or null for none. Reset to 0 in
157 cancel_echoing. If non-null, and a current echo area message
158 exists, and echo_message_buffer is eq to the current message
159 buffer, we know that the message comes from echo_kboard. */
161 struct kboard
*echo_kboard
;
163 /* The buffer used for echoing. Set in echo_now, reset in
166 Lisp_Object echo_message_buffer
;
168 /* Nonzero means C-g should cause immediate error-signal. */
171 /* Character that causes a quit. Normally C-g.
173 If we are running on an ordinary terminal, this must be an ordinary
174 ASCII char, since we want to make it our interrupt character.
176 If we are not running on an ordinary terminal, it still needs to be
177 an ordinary ASCII char. This character needs to be recognized in
178 the input interrupt handler. At this point, the keystroke is
179 represented as a struct input_event, while the desired quit
180 character is specified as a lispy event. The mapping from struct
181 input_events to lispy events cannot run in an interrupt handler,
182 and the reverse mapping is difficult for anything but ASCII
185 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
189 /* Current depth in recursive edits. */
190 int command_loop_level
;
192 /* If not Qnil, this is a switch-frame event which we decided to put
193 off until the end of a key sequence. This should be read as the
194 next command input, after any unread_command_events.
196 read_key_sequence uses this to delay switch-frame events until the
197 end of the key sequence; Fread_char uses it to put off switch-frame
198 events until a non-ASCII event is acceptable as input. */
199 Lisp_Object unread_switch_frame
;
201 /* Last size recorded for a current buffer which is not a minibuffer. */
202 static EMACS_INT last_non_minibuf_size
;
204 /* Total number of times read_char has returned, modulo SIZE_MAX + 1. */
205 size_t num_input_events
;
207 /* Value of num_nonmacro_input_events as of last auto save. */
211 /* This is like Vthis_command, except that commands never set it. */
212 Lisp_Object real_this_command
;
214 /* The value of point when the last command was started. */
215 EMACS_INT last_point_position
;
217 /* The buffer that was current when the last command was started. */
218 Lisp_Object last_point_position_buffer
;
220 /* The window that was selected when the last command was started. */
221 Lisp_Object last_point_position_window
;
223 /* The frame in which the last input event occurred, or Qmacro if the
224 last event came from a macro. We use this to determine when to
225 generate switch-frame events. This may be cleared by functions
226 like Fselect_frame, to make sure that a switch-frame event is
227 generated by the next character. */
228 Lisp_Object internal_last_event_frame
;
230 /* The timestamp of the last input event we received from the X server.
231 X Windows wants this for selection ownership. */
232 unsigned long last_event_timestamp
;
234 Lisp_Object Qx_set_selection
, QPRIMARY
, Qhandle_switch_frame
;
236 Lisp_Object Qself_insert_command
;
237 Lisp_Object Qforward_char
;
238 Lisp_Object Qbackward_char
;
239 Lisp_Object Qundefined
;
240 Lisp_Object Qtimer_event_handler
;
242 /* read_key_sequence stores here the command definition of the
243 key sequence that it reads. */
244 Lisp_Object read_key_sequence_cmd
;
246 Lisp_Object Qinput_method_function
;
248 Lisp_Object Qdeactivate_mark
;
250 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
252 Lisp_Object Qecho_area_clear_hook
;
254 /* Hooks to run before and after each command. */
255 Lisp_Object Qpre_command_hook
;
256 Lisp_Object Qpost_command_hook
;
258 Lisp_Object Qdeferred_action_function
;
260 Lisp_Object Qinput_method_exit_on_first_char
;
261 Lisp_Object Qinput_method_use_echo_area
;
263 /* File in which we write all commands we read. */
266 /* Nonzero if input is available. */
269 /* Circular buffer for pre-read keyboard input. */
271 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
273 /* Pointer to next available character in kbd_buffer.
274 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
275 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
276 next available char is in kbd_buffer[0]. */
277 static struct input_event
*kbd_fetch_ptr
;
279 /* Pointer to next place to store character in kbd_buffer. This
280 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
281 character should go in kbd_buffer[0]. */
282 static struct input_event
* volatile kbd_store_ptr
;
284 /* The above pair of variables forms a "queue empty" flag. When we
285 enqueue a non-hook event, we increment kbd_store_ptr. When we
286 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
287 there is input available if the two pointers are not equal.
289 Why not just have a flag set and cleared by the enqueuing and
290 dequeuing functions? Such a flag could be screwed up by interrupts
291 at inopportune times. */
293 /* Symbols to head events. */
294 Lisp_Object Qmouse_movement
;
295 Lisp_Object Qscroll_bar_movement
;
296 Lisp_Object Qswitch_frame
;
297 Lisp_Object Qdelete_frame
;
298 Lisp_Object Qiconify_frame
;
299 Lisp_Object Qmake_frame_visible
;
300 Lisp_Object Qselect_window
;
301 Lisp_Object Qhelp_echo
;
303 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
304 Lisp_Object Qmouse_fixup_help_message
;
307 /* Symbols to denote kinds of events. */
308 Lisp_Object Qfunction_key
;
309 Lisp_Object Qmouse_click
;
310 #if defined (WINDOWSNT)
311 Lisp_Object Qlanguage_change
;
313 Lisp_Object Qdrag_n_drop
;
314 Lisp_Object Qsave_session
;
316 Lisp_Object Qdbus_event
;
318 Lisp_Object Qconfig_changed_event
;
320 /* Lisp_Object Qmouse_movement; - also an event header */
322 /* Properties of event headers. */
323 Lisp_Object Qevent_kind
;
324 Lisp_Object Qevent_symbol_elements
;
326 /* menu and tool bar item parts */
327 Lisp_Object Qmenu_enable
;
328 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
329 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
, QCvert_only
;
331 /* An event header symbol HEAD may have a property named
332 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
333 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
334 mask of modifiers applied to it. If present, this is used to help
335 speed up parse_modifiers. */
336 Lisp_Object Qevent_symbol_element_mask
;
338 /* An unmodified event header BASE may have a property named
339 Qmodifier_cache, which is an alist mapping modifier masks onto
340 modified versions of BASE. If present, this helps speed up
342 Lisp_Object Qmodifier_cache
;
344 /* Symbols to use for parts of windows. */
345 Lisp_Object Qmode_line
;
346 Lisp_Object Qvertical_line
;
347 Lisp_Object Qvertical_scroll_bar
;
348 Lisp_Object Qmenu_bar
;
350 Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
), command_loop (void);
351 Lisp_Object
Fthis_command_keys (void);
352 Lisp_Object Qextended_command_history
;
353 EMACS_TIME
timer_check (void);
355 static void record_menu_key (Lisp_Object c
);
356 static int echo_length (void);
358 Lisp_Object Qpolling_period
;
360 /* Incremented whenever a timer is run. */
363 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
365 EMACS_TIME
*input_available_clear_time
;
367 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
368 Default is 1 if INTERRUPT_INPUT is defined. */
371 /* Nonzero while interrupts are temporarily deferred during redisplay. */
372 int interrupts_deferred
;
374 /* Allow m- file to inhibit use of FIONREAD. */
375 #ifdef BROKEN_FIONREAD
379 /* We are unable to use interrupts if FIONREAD is not available,
380 so flush SIGIO so we won't try. */
381 #if !defined (FIONREAD)
387 /* If we support a window system, turn on the code to poll periodically
388 to detect C-g. It isn't actually used when doing interrupt input. */
389 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
390 #define POLL_FOR_INPUT
393 /* The time when Emacs started being idle. */
395 static EMACS_TIME timer_idleness_start_time
;
397 /* After Emacs stops being idle, this saves the last value
398 of timer_idleness_start_time from when it was idle. */
400 static EMACS_TIME timer_last_idleness_start_time
;
403 /* Global variable declarations. */
405 /* Flags for readable_events. */
406 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
407 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
408 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
410 /* Function for init_keyboard to call with no args (if nonzero). */
411 void (*keyboard_init_hook
) (void);
413 static int read_avail_input (int);
414 static void get_input_pending (int *, int);
415 static int readable_events (int);
416 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
418 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
420 static Lisp_Object
make_lispy_event (struct input_event
*);
421 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
422 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
423 enum scroll_bar_part
,
424 Lisp_Object
, Lisp_Object
,
427 static Lisp_Object
modify_event_symbol (EMACS_INT
, unsigned, Lisp_Object
,
428 Lisp_Object
, const char *const *,
429 Lisp_Object
*, unsigned);
430 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
431 static void save_getcjmp (jmp_buf);
432 static void restore_getcjmp (jmp_buf);
433 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
434 static void clear_event (struct input_event
*);
435 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
436 static void interrupt_signal (int signalnum
);
438 static void input_available_signal (int signo
);
440 static void handle_interrupt (void);
441 static void timer_start_idle (void);
442 static void timer_stop_idle (void);
443 static void timer_resume_idle (void);
444 static void handle_user_signal (int);
445 static char *find_user_signal_name (int);
446 static int store_user_signal_events (void);
449 /* Add C to the echo string, if echoing is going on.
450 C can be a character, which is printed prettily ("M-C-x" and all that
451 jazz), or a symbol, whose name is printed. */
454 echo_char (Lisp_Object c
)
456 if (current_kboard
->immediate_echo
)
458 int size
= KEY_DESCRIPTION_SIZE
+ 100;
459 char *buffer
= (char *) alloca (size
);
461 Lisp_Object echo_string
;
463 echo_string
= KVAR (current_kboard
, echo_string
);
465 /* If someone has passed us a composite event, use its head symbol. */
470 ptr
= push_key_description (XINT (c
), ptr
, 1);
472 else if (SYMBOLP (c
))
474 Lisp_Object name
= SYMBOL_NAME (c
);
475 int nbytes
= SBYTES (name
);
477 if (size
- (ptr
- buffer
) < nbytes
)
479 int offset
= ptr
- buffer
;
480 size
= max (2 * size
, size
+ nbytes
);
481 buffer
= (char *) alloca (size
);
482 ptr
= buffer
+ offset
;
485 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
486 STRING_MULTIBYTE (name
), 1);
489 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
492 const char *text
= " (Type ? for further options)";
493 int len
= strlen (text
);
495 if (size
- (ptr
- buffer
) < len
)
497 int offset
= ptr
- buffer
;
499 buffer
= (char *) alloca (size
);
500 ptr
= buffer
+ offset
;
503 memcpy (ptr
, text
, len
);
507 /* Replace a dash from echo_dash with a space, otherwise
508 add a space at the end as a separator between keys. */
509 if (STRINGP (echo_string
)
510 && SCHARS (echo_string
) > 1)
512 Lisp_Object last_char
, prev_char
, idx
;
514 idx
= make_number (SCHARS (echo_string
) - 2);
515 prev_char
= Faref (echo_string
, idx
);
517 idx
= make_number (SCHARS (echo_string
) - 1);
518 last_char
= Faref (echo_string
, idx
);
520 /* We test PREV_CHAR to make sure this isn't the echoing
522 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
523 Faset (echo_string
, idx
, make_number (' '));
525 echo_string
= concat2 (echo_string
, build_string (" "));
527 else if (STRINGP (echo_string
))
528 echo_string
= concat2 (echo_string
, build_string (" "));
530 KVAR (current_kboard
, echo_string
)
531 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
537 /* Temporarily add a dash to the end of the echo string if it's not
538 empty, so that it serves as a mini-prompt for the very next character. */
543 /* Do nothing if not echoing at all. */
544 if (NILP (KVAR (current_kboard
, echo_string
)))
547 if (this_command_key_count
== 0)
550 if (!current_kboard
->immediate_echo
551 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
554 /* Do nothing if we just printed a prompt. */
555 if (current_kboard
->echo_after_prompt
556 == SCHARS (KVAR (current_kboard
, echo_string
)))
559 /* Do nothing if we have already put a dash at the end. */
560 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
562 Lisp_Object last_char
, prev_char
, idx
;
564 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
565 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
567 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
568 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
570 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
574 /* Put a dash at the end of the buffer temporarily,
575 but make it go away when the next character is added. */
576 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
581 /* Display the current echo string, and begin echoing if not already
587 if (!current_kboard
->immediate_echo
)
590 current_kboard
->immediate_echo
= 1;
592 for (i
= 0; i
< this_command_key_count
; i
++)
596 /* Set before_command_echo_length to the value that would
597 have been saved before the start of this subcommand in
598 command_loop_1, if we had already been echoing then. */
599 if (i
== this_single_command_key_start
)
600 before_command_echo_length
= echo_length ();
602 c
= XVECTOR (this_command_keys
)->contents
[i
];
603 if (! (EVENT_HAS_PARAMETERS (c
)
604 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
608 /* Set before_command_echo_length to the value that would
609 have been saved before the start of this subcommand in
610 command_loop_1, if we had already been echoing then. */
611 if (this_command_key_count
== this_single_command_key_start
)
612 before_command_echo_length
= echo_length ();
614 /* Put a dash at the end to invite the user to type more. */
619 message3_nolog (KVAR (current_kboard
, echo_string
),
620 SBYTES (KVAR (current_kboard
, echo_string
)),
621 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
624 /* Record in what buffer we echoed, and from which kboard. */
625 echo_message_buffer
= echo_area_buffer
[0];
626 echo_kboard
= current_kboard
;
628 if (waiting_for_input
&& !NILP (Vquit_flag
))
629 quit_throw_to_read_char ();
632 /* Turn off echoing, for the start of a new command. */
635 cancel_echoing (void)
637 current_kboard
->immediate_echo
= 0;
638 current_kboard
->echo_after_prompt
= -1;
639 KVAR (current_kboard
, echo_string
) = Qnil
;
640 ok_to_echo_at_next_pause
= NULL
;
642 echo_message_buffer
= Qnil
;
645 /* Return the length of the current echo string. */
650 return (STRINGP (KVAR (current_kboard
, echo_string
))
651 ? SCHARS (KVAR (current_kboard
, echo_string
))
655 /* Truncate the current echo message to its first LEN chars.
656 This and echo_char get used by read_key_sequence when the user
657 switches frames while entering a key sequence. */
660 echo_truncate (EMACS_INT nchars
)
662 if (STRINGP (KVAR (current_kboard
, echo_string
)))
663 KVAR (current_kboard
, echo_string
)
664 = Fsubstring (KVAR (current_kboard
, echo_string
),
665 make_number (0), make_number (nchars
));
666 truncate_echo_area (nchars
);
670 /* Functions for manipulating this_command_keys. */
672 add_command_key (Lisp_Object key
)
674 #if 0 /* Not needed after we made Freset_this_command_lengths
675 do the job immediately. */
676 /* If reset-this-command-length was called recently, obey it now.
677 See the doc string of that function for an explanation of why. */
678 if (before_command_restore_flag
)
680 this_command_key_count
= before_command_key_count_1
;
681 if (this_command_key_count
< this_single_command_key_start
)
682 this_single_command_key_start
= this_command_key_count
;
683 echo_truncate (before_command_echo_length_1
);
684 before_command_restore_flag
= 0;
688 if (this_command_key_count
>= ASIZE (this_command_keys
))
689 this_command_keys
= larger_vector (this_command_keys
,
690 2 * ASIZE (this_command_keys
),
693 ASET (this_command_keys
, this_command_key_count
, key
);
694 ++this_command_key_count
;
699 recursive_edit_1 (void)
701 int count
= SPECPDL_INDEX ();
704 if (command_loop_level
> 0)
706 specbind (Qstandard_output
, Qt
);
707 specbind (Qstandard_input
, Qt
);
710 #ifdef HAVE_WINDOW_SYSTEM
711 /* The command loop has started an hourglass timer, so we have to
712 cancel it here, otherwise it will fire because the recursive edit
713 can take some time. Do not check for display_hourglass_p here,
714 because it could already be nil. */
718 /* This function may have been called from a debugger called from
719 within redisplay, for instance by Edebugging a function called
720 from fontification-functions. We want to allow redisplay in
721 the debugging session.
723 The recursive edit is left with a `(throw exit ...)'. The `exit'
724 tag is not caught anywhere in redisplay, i.e. when we leave the
725 recursive edit, the original redisplay leading to the recursive
726 edit will be unwound. The outcome should therefore be safe. */
727 specbind (Qinhibit_redisplay
, Qnil
);
730 val
= command_loop ();
732 Fsignal (Qquit
, Qnil
);
733 /* Handle throw from read_minibuf when using minibuffer
734 while it's active but we're in another window. */
736 xsignal1 (Qerror
, val
);
738 return unbind_to (count
, Qnil
);
741 /* When an auto-save happens, record the "time", and don't do again soon. */
744 record_auto_save (void)
746 last_auto_save
= num_nonmacro_input_events
;
749 /* Make an auto save happen as soon as possible at command level. */
752 force_auto_save_soon (void)
754 last_auto_save
= - auto_save_interval
- 1;
756 record_asynch_buffer_change ();
759 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
760 doc
: /* Invoke the editor command loop recursively.
761 To get out of the recursive edit, a command can do `(throw 'exit nil)';
762 that tells this function to return.
763 Alternatively, `(throw 'exit t)' makes this function signal an error.
764 This function is called by the editor initialization to begin editing. */)
767 int count
= SPECPDL_INDEX ();
770 /* If we enter while input is blocked, don't lock up here.
771 This may happen through the debugger during redisplay. */
775 command_loop_level
++;
776 update_mode_lines
= 1;
778 if (command_loop_level
779 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
780 buffer
= Fcurrent_buffer ();
784 /* If we leave recursive_edit_1 below with a `throw' for instance,
785 like it is done in the splash screen display, we have to
786 make sure that we restore single_kboard as command_loop_1
787 would have done if it were left normally. */
788 if (command_loop_level
> 0)
789 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
790 record_unwind_protect (recursive_edit_unwind
, buffer
);
793 return unbind_to (count
, Qnil
);
797 recursive_edit_unwind (Lisp_Object buffer
)
799 if (BUFFERP (buffer
))
800 Fset_buffer (buffer
);
802 command_loop_level
--;
803 update_mode_lines
= 1;
808 #if 0 /* These two functions are now replaced with
809 temporarily_switch_to_single_kboard. */
813 #if 0 /* Theory: if there's anything in Vunread_command_events,
814 it will right away be read by read_key_sequence,
815 and then if we do switch KBOARDS, it will go into the side
816 queue then. So we don't need to do anything special here -- rms. */
817 if (CONSP (Vunread_command_events
))
819 current_kboard
->kbd_queue
820 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
821 current_kboard
->kbd_queue_has_data
= 1;
823 Vunread_command_events
= Qnil
;
828 /* Switch to the single-kboard state, making current_kboard
829 the only KBOARD from which further input is accepted. */
832 single_kboard_state ()
838 /* If we're in single_kboard state for kboard KBOARD,
842 not_single_kboard_state (KBOARD
*kboard
)
844 if (kboard
== current_kboard
)
848 /* Maintain a stack of kboards, so other parts of Emacs
849 can switch temporarily to the kboard of a given frame
850 and then revert to the previous status. */
855 struct kboard_stack
*next
;
858 static struct kboard_stack
*kboard_stack
;
861 push_kboard (struct kboard
*k
)
863 struct kboard_stack
*p
864 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
866 p
->next
= kboard_stack
;
867 p
->kboard
= current_kboard
;
877 struct kboard_stack
*p
= kboard_stack
;
879 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
881 if (t
->kboard
== p
->kboard
)
883 current_kboard
= p
->kboard
;
890 /* The terminal we remembered has been deleted. */
891 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
894 kboard_stack
= p
->next
;
898 /* Switch to single_kboard mode, making current_kboard the only KBOARD
899 from which further input is accepted. If F is non-nil, set its
900 KBOARD as the current keyboard.
902 This function uses record_unwind_protect to return to the previous
905 If Emacs is already in single_kboard mode, and F's keyboard is
906 locked, then this function will throw an errow. */
909 temporarily_switch_to_single_kboard (struct frame
*f
)
911 int was_locked
= single_kboard
;
914 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
915 /* We can not switch keyboards while in single_kboard mode.
916 In rare cases, Lisp code may call `recursive-edit' (or
917 `read-minibuffer' or `y-or-n-p') after it switched to a
918 locked frame. For example, this is likely to happen
919 when server.el connects to a new terminal while Emacs is in
920 single_kboard mode. It is best to throw an error instead
921 of presenting the user with a frozen screen. */
922 error ("Terminal %d is locked, cannot read from it",
923 FRAME_TERMINAL (f
)->id
);
925 /* This call is unnecessary, but helps
926 `restore_kboard_configuration' discover if somebody changed
927 `current_kboard' behind our back. */
928 push_kboard (current_kboard
);
931 current_kboard
= FRAME_KBOARD (f
);
933 record_unwind_protect (restore_kboard_configuration
,
934 (was_locked
? Qt
: Qnil
));
937 #if 0 /* This function is not needed anymore. */
939 record_single_kboard_state ()
942 push_kboard (current_kboard
);
943 record_unwind_protect (restore_kboard_configuration
,
944 (single_kboard
? Qt
: Qnil
));
949 restore_kboard_configuration (Lisp_Object was_locked
)
951 if (NILP (was_locked
))
955 struct kboard
*prev
= current_kboard
;
958 /* The pop should not change the kboard. */
959 if (single_kboard
&& current_kboard
!= prev
)
966 /* Handle errors that are not handled at inner levels
967 by printing an error message and returning to the editor command loop. */
970 cmd_error (Lisp_Object data
)
972 Lisp_Object old_level
, old_length
;
975 #ifdef HAVE_WINDOW_SYSTEM
976 if (display_hourglass_p
)
980 if (!NILP (executing_kbd_macro
))
982 if (executing_kbd_macro_iterations
== 1)
983 sprintf (macroerror
, "After 1 kbd macro iteration: ");
985 sprintf (macroerror
, "After %d kbd macro iterations: ",
986 executing_kbd_macro_iterations
);
991 Vstandard_output
= Qt
;
992 Vstandard_input
= Qt
;
993 Vexecuting_kbd_macro
= Qnil
;
994 executing_kbd_macro
= Qnil
;
995 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
996 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
999 /* Avoid unquittable loop if data contains a circular list. */
1000 old_level
= Vprint_level
;
1001 old_length
= Vprint_length
;
1002 XSETFASTINT (Vprint_level
, 10);
1003 XSETFASTINT (Vprint_length
, 10);
1004 cmd_error_internal (data
, macroerror
);
1005 Vprint_level
= old_level
;
1006 Vprint_length
= old_length
;
1010 Vinhibit_quit
= Qnil
;
1011 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1012 if (command_loop_level
== 0 && minibuf_level
== 0)
1013 any_kboard_state ();
1016 return make_number (0);
1019 /* Take actions on handling an error. DATA is the data that describes
1022 CONTEXT is a C-string containing ASCII characters only which
1023 describes the context in which the error happened. If we need to
1024 generalize CONTEXT to allow multibyte characters, make it a Lisp
1028 cmd_error_internal (Lisp_Object data
, const char *context
)
1030 struct frame
*sf
= SELECTED_FRAME ();
1032 /* The immediate context is not interesting for Quits,
1033 since they are asyncronous. */
1034 if (EQ (XCAR (data
), Qquit
))
1035 Vsignaling_function
= Qnil
;
1040 /* Use user's specified output function if any. */
1041 if (!NILP (Vcommand_error_function
))
1042 call3 (Vcommand_error_function
, data
,
1043 context
? build_string (context
) : empty_unibyte_string
,
1044 Vsignaling_function
);
1045 /* If the window system or terminal frame hasn't been initialized
1046 yet, or we're not interactive, write the message to stderr and exit. */
1047 else if (!sf
->glyphs_initialized_p
1048 /* The initial frame is a special non-displaying frame. It
1049 will be current in daemon mode when there are no frames
1050 to display, and in non-daemon mode before the real frame
1051 has finished initializing. If an error is thrown in the
1052 latter case while creating the frame, then the frame
1053 will never be displayed, so the safest thing to do is
1054 write to stderr and quit. In daemon mode, there are
1055 many other potential errors that do not prevent frames
1056 from being created, so continuing as normal is better in
1058 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1061 print_error_message (data
, Qexternal_debugging_output
,
1062 context
, Vsignaling_function
);
1063 Fterpri (Qexternal_debugging_output
);
1064 Fkill_emacs (make_number (-1));
1068 clear_message (1, 0);
1070 message_log_maybe_newline ();
1073 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1076 Vsignaling_function
= Qnil
;
1079 Lisp_Object
command_loop_1 (void);
1080 Lisp_Object
command_loop_2 (Lisp_Object
);
1081 Lisp_Object
top_level_1 (Lisp_Object
);
1083 /* Entry to editor-command-loop.
1084 This level has the catches for exiting/returning to editor command loop.
1085 It returns nil to exit recursive edit, t to abort it. */
1090 if (command_loop_level
> 0 || minibuf_level
> 0)
1093 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1094 executing_kbd_macro
= Qnil
;
1100 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1101 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1102 /* Reset single_kboard in case top-level set it while
1103 evaluating an -f option, or we are stuck there for some
1105 any_kboard_state ();
1107 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1108 executing_kbd_macro
= Qnil
;
1110 /* End of file in -batch run causes exit here. */
1116 /* Here we catch errors in execution of commands within the
1117 editing loop, and reenter the editing loop.
1118 When there is an error, cmd_error runs and returns a non-nil
1119 value to us. A value of nil means that command_loop_1 itself
1120 returned due to end of file (or end of kbd macro). */
1123 command_loop_2 (Lisp_Object ignore
)
1125 register Lisp_Object val
;
1128 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1129 while (!NILP (val
));
1137 return Feval (Vtop_level
, Qnil
);
1141 top_level_1 (Lisp_Object ignore
)
1143 /* On entry to the outer level, run the startup file */
1144 if (!NILP (Vtop_level
))
1145 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1146 else if (!NILP (Vpurify_flag
))
1147 message ("Bare impure Emacs (standard Lisp code not loaded)");
1149 message ("Bare Emacs (standard Lisp code not loaded)");
1153 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1154 doc
: /* Exit all recursive editing levels.
1155 This also exits all active minibuffers. */)
1158 #ifdef HAVE_WINDOW_SYSTEM
1159 if (display_hourglass_p
)
1160 cancel_hourglass ();
1163 /* Unblock input if we enter with input blocked. This may happen if
1164 redisplay traps e.g. during tool-bar update with input blocked. */
1165 while (INPUT_BLOCKED_P
)
1168 Fthrow (Qtop_level
, Qnil
);
1171 Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1172 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1173 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1176 if (command_loop_level
> 0 || minibuf_level
> 0)
1177 Fthrow (Qexit
, Qnil
);
1179 error ("No recursive edit is in progress");
1182 Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1183 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1184 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1187 if (command_loop_level
> 0 || minibuf_level
> 0)
1190 error ("No recursive edit is in progress");
1193 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1195 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1196 of this function. */
1199 tracking_off (Lisp_Object old_value
)
1201 do_mouse_tracking
= old_value
;
1202 if (NILP (old_value
))
1204 /* Redisplay may have been preempted because there was input
1205 available, and it assumes it will be called again after the
1206 input has been processed. If the only input available was
1207 the sort that we have just disabled, then we need to call
1209 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1211 redisplay_preserve_echo_area (6);
1212 get_input_pending (&input_pending
,
1213 READABLE_EVENTS_DO_TIMERS_NOW
);
1219 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1220 doc
: /* Evaluate BODY with mouse movement events enabled.
1221 Within a `track-mouse' form, mouse motion generates input events that
1222 you can read with `read-event'.
1223 Normally, mouse motion is ignored.
1224 usage: (track-mouse BODY...) */)
1227 int count
= SPECPDL_INDEX ();
1230 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1232 do_mouse_tracking
= Qt
;
1234 val
= Fprogn (args
);
1235 return unbind_to (count
, val
);
1238 /* If mouse has moved on some frame, return one of those frames.
1242 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1243 after resizing the tool-bar window. */
1245 int ignore_mouse_drag_p
;
1248 some_mouse_moved (void)
1250 Lisp_Object tail
, frame
;
1252 if (ignore_mouse_drag_p
)
1254 /* ignore_mouse_drag_p = 0; */
1258 FOR_EACH_FRAME (tail
, frame
)
1260 if (XFRAME (frame
)->mouse_moved
)
1261 return XFRAME (frame
);
1267 #endif /* HAVE_MOUSE || HAVE_GPM */
1269 /* This is the actual command reading loop,
1270 sans error-handling encapsulation. */
1272 static int read_key_sequence (Lisp_Object
*, size_t, Lisp_Object
,
1274 void safe_run_hooks (Lisp_Object
);
1275 static void adjust_point_for_property (EMACS_INT
, int);
1277 /* Cancel hourglass from protect_unwind.
1279 #ifdef HAVE_WINDOW_SYSTEM
1281 cancel_hourglass_unwind (Lisp_Object arg
)
1283 cancel_hourglass ();
1288 /* FIXME: This is wrong rather than test window-system, we should call
1289 a new set-selection, which will then dispatch to x-set-selection, or
1290 tty-set-selection, or w32-set-selection, ... */
1291 EXFUN (Fwindow_system
, 1);
1294 command_loop_1 (void)
1297 Lisp_Object keybuf
[30];
1299 int prev_modiff
= 0;
1300 struct buffer
*prev_buffer
= NULL
;
1301 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1302 int was_locked
= single_kboard
;
1304 int already_adjusted
= 0;
1306 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1307 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1308 Vdeactivate_mark
= Qnil
;
1309 waiting_for_input
= 0;
1312 this_command_key_count
= 0;
1313 this_command_key_count_reset
= 0;
1314 this_single_command_key_start
= 0;
1316 if (NILP (Vmemory_full
))
1318 /* Make sure this hook runs after commands that get errors and
1319 throw to top level. */
1320 /* Note that the value cell will never directly contain nil
1321 if the symbol is a local variable. */
1322 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1323 safe_run_hooks (Qpost_command_hook
);
1325 /* If displaying a message, resize the echo area window to fit
1326 that message's size exactly. */
1327 if (!NILP (echo_area_buffer
[0]))
1328 resize_echo_area_exactly ();
1330 if (!NILP (Vdeferred_action_list
))
1331 safe_run_hooks (Qdeferred_action_function
);
1334 /* Do this after running Vpost_command_hook, for consistency. */
1335 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1336 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1337 if (!CONSP (last_command_event
))
1338 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1342 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1345 /* Make sure the current window's buffer is selected. */
1346 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1347 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1349 /* Display any malloc warning that just came out. Use while because
1350 displaying one warning can cause another. */
1352 while (pending_malloc_warning
)
1353 display_malloc_warning ();
1355 Vdeactivate_mark
= Qnil
;
1357 /* If minibuffer on and echo area in use,
1358 wait a short time and redraw minibuffer. */
1361 && !NILP (echo_area_buffer
[0])
1362 && EQ (minibuf_window
, echo_area_window
)
1363 && NUMBERP (Vminibuffer_message_timeout
))
1365 /* Bind inhibit-quit to t so that C-g gets read in
1366 rather than quitting back to the minibuffer. */
1367 int count
= SPECPDL_INDEX ();
1368 specbind (Qinhibit_quit
, Qt
);
1370 sit_for (Vminibuffer_message_timeout
, 0, 2);
1372 /* Clear the echo area. */
1374 safe_run_hooks (Qecho_area_clear_hook
);
1376 unbind_to (count
, Qnil
);
1378 /* If a C-g came in before, treat it as input now. */
1379 if (!NILP (Vquit_flag
))
1382 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1387 /* Select the frame that the last event came from. Usually,
1388 switch-frame events will take care of this, but if some lisp
1389 code swallows a switch-frame event, we'll fix things up here.
1390 Is this a good idea? */
1391 if (FRAMEP (internal_last_event_frame
)
1392 && !EQ (internal_last_event_frame
, selected_frame
))
1393 Fselect_frame (internal_last_event_frame
, Qnil
);
1395 /* If it has changed current-menubar from previous value,
1396 really recompute the menubar from the value. */
1397 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1398 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1399 call0 (Qrecompute_lucid_menubar
);
1401 before_command_key_count
= this_command_key_count
;
1402 before_command_echo_length
= echo_length ();
1404 Vthis_command
= Qnil
;
1405 real_this_command
= Qnil
;
1406 Vthis_original_command
= Qnil
;
1407 Vthis_command_keys_shift_translated
= Qnil
;
1409 /* Read next key sequence; i gets its length. */
1410 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1413 /* A filter may have run while we were reading the input. */
1414 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1416 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1417 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1421 /* Now we have read a key sequence of length I,
1422 or else I is 0 and we found end of file. */
1424 if (i
== 0) /* End of file -- happens only in */
1425 return Qnil
; /* a kbd macro, at the end. */
1426 /* -1 means read_key_sequence got a menu that was rejected.
1427 Just loop around and read another command. */
1431 this_command_key_count
= 0;
1432 this_command_key_count_reset
= 0;
1433 this_single_command_key_start
= 0;
1437 last_command_event
= keybuf
[i
- 1];
1439 /* If the previous command tried to force a specific window-start,
1440 forget about that, in case this command moves point far away
1441 from that position. But also throw away beg_unchanged and
1442 end_unchanged information in that case, so that redisplay will
1443 update the whole window properly. */
1444 if (!NILP (XWINDOW (selected_window
)->force_start
))
1447 XWINDOW (selected_window
)->force_start
= Qnil
;
1448 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1449 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1452 cmd
= read_key_sequence_cmd
;
1453 if (!NILP (Vexecuting_kbd_macro
))
1455 if (!NILP (Vquit_flag
))
1457 Vexecuting_kbd_macro
= Qt
;
1458 QUIT
; /* Make some noise. */
1459 /* Will return since macro now empty. */
1463 /* Do redisplay processing after this command except in special
1464 cases identified below. */
1465 prev_buffer
= current_buffer
;
1466 prev_modiff
= MODIFF
;
1467 last_point_position
= PT
;
1468 last_point_position_window
= selected_window
;
1469 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1471 /* By default, we adjust point to a boundary of a region that
1472 has such a property that should be treated intangible
1473 (e.g. composition, display). But, some commands will set
1474 this variable differently. */
1475 Vdisable_point_adjustment
= Qnil
;
1477 /* Process filters and timers may have messed with deactivate-mark.
1478 reset it before we execute the command. */
1479 Vdeactivate_mark
= Qnil
;
1481 /* Remap command through active keymaps */
1482 Vthis_original_command
= cmd
;
1486 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1490 /* Execute the command. */
1492 Vthis_command
= cmd
;
1493 real_this_command
= cmd
;
1494 safe_run_hooks (Qpre_command_hook
);
1496 already_adjusted
= 0;
1498 if (NILP (Vthis_command
))
1500 /* nil means key is undefined. */
1501 Lisp_Object keys
= Fvector (i
, keybuf
);
1502 keys
= Fkey_description (keys
, Qnil
);
1504 message_with_string ("%s is undefined", keys
, 0);
1505 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1506 update_mode_lines
= 1;
1507 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1511 /* Here for a command that isn't executed directly */
1513 #ifdef HAVE_WINDOW_SYSTEM
1514 int scount
= SPECPDL_INDEX ();
1516 if (display_hourglass_p
1517 && NILP (Vexecuting_kbd_macro
))
1519 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1524 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1526 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1528 #ifdef HAVE_WINDOW_SYSTEM
1529 /* Do not check display_hourglass_p here, because
1530 Fcommand_execute could change it, but we should cancel
1531 hourglass cursor anyway.
1532 But don't cancel the hourglass within a macro
1533 just because a command in the macro finishes. */
1534 if (NILP (Vexecuting_kbd_macro
))
1535 unbind_to (scount
, Qnil
);
1538 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1540 safe_run_hooks (Qpost_command_hook
);
1542 /* If displaying a message, resize the echo area window to fit
1543 that message's size exactly. */
1544 if (!NILP (echo_area_buffer
[0]))
1545 resize_echo_area_exactly ();
1547 safe_run_hooks (Qdeferred_action_function
);
1549 /* If there is a prefix argument,
1550 1) We don't want Vlast_command to be ``universal-argument''
1551 (that would be dumb), so don't set Vlast_command,
1552 2) we want to leave echoing on so that the prefix will be
1553 echoed as part of this key sequence, so don't call
1555 3) we want to leave this_command_key_count non-zero, so that
1556 read_char will realize that it is re-reading a character, and
1557 not echo it a second time.
1559 If the command didn't actually create a prefix arg,
1560 but is merely a frame event that is transparent to prefix args,
1561 then the above doesn't apply. */
1562 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1564 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1565 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1566 if (!CONSP (last_command_event
))
1567 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1569 this_command_key_count
= 0;
1570 this_command_key_count_reset
= 0;
1571 this_single_command_key_start
= 0;
1574 if (!NILP (BVAR (current_buffer
, mark_active
))
1575 && !NILP (Vrun_hooks
))
1577 /* In Emacs 22, setting transient-mark-mode to `only' was a
1578 way of turning it on for just one command. This usage is
1579 obsolete, but support it anyway. */
1580 if (EQ (Vtransient_mark_mode
, Qidentity
))
1581 Vtransient_mark_mode
= Qnil
;
1582 else if (EQ (Vtransient_mark_mode
, Qonly
))
1583 Vtransient_mark_mode
= Qidentity
;
1585 if (!NILP (Vdeactivate_mark
))
1586 /* If `select-active-regions' is non-nil, this call to
1587 `deactivate-mark' also sets the PRIMARY selection. */
1588 call0 (Qdeactivate_mark
);
1591 /* Even if not deactivating the mark, set PRIMARY if
1592 `select-active-regions' is non-nil. */
1593 if (!NILP (Fwindow_system (Qnil
))
1594 /* Even if mark_active is non-nil, the actual buffer
1595 marker may not have been set yet (Bug#7044). */
1596 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1597 && (EQ (Vselect_active_regions
, Qonly
)
1598 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1599 : (!NILP (Vselect_active_regions
)
1600 && !NILP (Vtransient_mark_mode
)))
1601 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1604 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1607 call2 (Qx_set_selection
, QPRIMARY
,
1608 make_buffer_string (beg
, end
, 0));
1610 call2 (Qx_set_selection
, QPRIMARY
,
1611 make_buffer_string (end
, beg
, 0));
1612 /* Don't set empty selections. */
1615 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1617 Lisp_Object hook
= intern ("activate-mark-hook");
1618 Frun_hooks (1, &hook
);
1622 Vsaved_region_selection
= Qnil
;
1627 if (current_buffer
== prev_buffer
1628 && last_point_position
!= PT
1629 && NILP (Vdisable_point_adjustment
)
1630 && NILP (Vglobal_disable_point_adjustment
))
1632 if (last_point_position
> BEGV
1633 && last_point_position
< ZV
1634 && (composition_adjust_point (last_point_position
,
1635 last_point_position
)
1636 != last_point_position
))
1637 /* The last point was temporarily set within a grapheme
1638 cluster to prevent automatic composition. To recover
1639 the automatic composition, we must update the
1641 windows_or_buffers_changed
++;
1642 if (!already_adjusted
)
1643 adjust_point_for_property (last_point_position
,
1644 MODIFF
!= prev_modiff
);
1647 /* Install chars successfully executed in kbd macro. */
1649 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1650 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1651 finalize_kbd_macro_chars ();
1652 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1654 any_kboard_state ();
1659 /* Adjust point to a boundary of a region that has such a property
1660 that should be treated intangible. For the moment, we check
1661 `composition', `display' and `invisible' properties.
1662 LAST_PT is the last position of point. */
1665 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1668 Lisp_Object val
, overlay
, tmp
;
1669 /* When called after buffer modification, we should temporarily
1670 suppress the point adjustment for automatic composition so that a
1671 user can keep inserting another character at point or keep
1672 deleting characters around point. */
1673 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1674 EMACS_INT orig_pt
= PT
;
1676 /* FIXME: cycling is probably not necessary because these properties
1677 can't be usefully combined anyway. */
1678 while (check_composition
|| check_display
|| check_invisible
)
1680 /* FIXME: check `intangible'. */
1681 if (check_composition
1682 && PT
> BEGV
&& PT
< ZV
1683 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1686 check_display
= check_invisible
= 1;
1688 check_composition
= 0;
1690 && PT
> BEGV
&& PT
< ZV
1691 && !NILP (val
= get_char_property_and_overlay
1692 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1693 && display_prop_intangible_p (val
)
1694 && (!OVERLAYP (overlay
)
1695 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1696 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1697 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1698 && (beg
< PT
/* && end > PT <- It's always the case. */
1699 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1702 SET_PT (PT
< last_pt
1703 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1705 check_composition
= check_invisible
= 1;
1708 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1710 int inv
, ellipsis
= 0;
1713 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1716 /* FIXME: We should stop if we find a spot between
1717 two runs of `invisible' where inserted text would
1718 be visible. This is important when we have two
1719 invisible boundaries that enclose an area: if the
1720 area is empty, we need this test in order to make
1721 it possible to place point in the middle rather
1722 than skip both boundaries. However, this code
1723 also stops anywhere in a non-sticky text-property,
1724 which breaks (e.g.) Org mode. */
1725 && (val
= get_pos_property (make_number (end
),
1727 TEXT_PROP_MEANS_INVISIBLE (val
))
1729 && !NILP (val
= get_char_property_and_overlay
1730 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1731 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1733 ellipsis
= ellipsis
|| inv
> 1
1734 || (OVERLAYP (overlay
)
1735 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1736 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1737 tmp
= Fnext_single_char_property_change
1738 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1739 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1743 && (val
= get_pos_property (make_number (beg
),
1745 TEXT_PROP_MEANS_INVISIBLE (val
))
1747 && !NILP (val
= get_char_property_and_overlay
1748 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1749 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1751 ellipsis
= ellipsis
|| inv
> 1
1752 || (OVERLAYP (overlay
)
1753 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1754 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1755 tmp
= Fprevious_single_char_property_change
1756 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1757 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1760 /* Move away from the inside area. */
1761 if (beg
< PT
&& end
> PT
)
1763 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1764 /* We haven't moved yet (so we don't need to fear
1765 infinite-looping) and we were outside the range
1766 before (so either end of the range still corresponds
1767 to a move in the right direction): pretend we moved
1768 less than we actually did, so that we still have
1769 more freedom below in choosing which end of the range
1771 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1772 /* We either have moved already or the last point
1773 was already in the range: we don't get to choose
1774 which end of the range we have to go to. */
1775 : (PT
< last_pt
? beg
: end
));
1776 check_composition
= check_display
= 1;
1778 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1779 the point to something other than its argument, due to
1780 point-motion hooks, intangibility, etc. */
1781 xassert (PT
== beg
|| PT
== end
);
1784 /* Pretend the area doesn't exist if the buffer is not
1786 if (!modified
&& !ellipsis
&& beg
< end
)
1788 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1789 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1790 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1791 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1792 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1793 /* We've already moved as far as we can. Trying to go
1794 to the other end would mean moving backwards and thus
1795 could lead to an infinite loop. */
1797 else if (val
= get_pos_property (make_number (PT
),
1799 TEXT_PROP_MEANS_INVISIBLE (val
)
1800 && (val
= get_pos_property
1801 (make_number (PT
== beg
? end
: beg
),
1803 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1804 (check_composition
= check_display
= 1,
1805 SET_PT (PT
== beg
? end
: beg
));
1808 check_invisible
= 0;
1812 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1815 safe_run_hooks_1 (void)
1817 eassert (CONSP (Vinhibit_quit
));
1818 return call0 (XCDR (Vinhibit_quit
));
1821 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1825 safe_run_hooks_error (Lisp_Object error_data
)
1828 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1829 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1830 Lisp_Object args
[4];
1831 args
[0] = build_string ("Error in %s (%s): %s");
1834 args
[3] = error_data
;
1840 Lisp_Object newval
= Qnil
;
1841 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1842 if (EQ (fun
, XCAR (val
)))
1845 newval
= Fcons (XCAR (val
), newval
);
1847 return Fset (hook
, Fnreverse (newval
));
1848 /* Not found in the local part of the hook. Let's look at the global
1851 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1852 : Fdefault_value (hook
));
1853 CONSP (val
); val
= XCDR (val
))
1854 if (EQ (fun
, XCAR (val
)))
1857 newval
= Fcons (XCAR (val
), newval
);
1859 return Fset_default (hook
, Fnreverse (newval
));
1865 safe_run_hook_funcall (size_t nargs
, Lisp_Object
*args
)
1867 eassert (nargs
== 1);
1868 if (CONSP (Vinhibit_quit
))
1869 XSETCDR (Vinhibit_quit
, args
[0]);
1871 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1873 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1877 /* If we get an error while running the hook, cause the hook variable
1878 to be nil. Also inhibit quits, so that C-g won't cause the hook
1879 to mysteriously evaporate. */
1882 safe_run_hooks (Lisp_Object hook
)
1884 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1885 to its body or to its handlers other than via globals such as
1886 dynamically-bound variables ;-) */
1887 int count
= SPECPDL_INDEX ();
1888 specbind (Qinhibit_quit
, hook
);
1890 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1892 unbind_to (count
, Qnil
);
1896 /* Nonzero means polling for input is temporarily suppressed. */
1898 int poll_suppress_count
;
1900 /* Asynchronous timer for polling. */
1902 struct atimer
*poll_timer
;
1905 #ifdef POLL_FOR_INPUT
1907 /* Poll for input, so that we catch a C-g if it comes in. This
1908 function is called from x_make_frame_visible, see comment
1912 poll_for_input_1 (void)
1914 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1915 doing anything dangerous. */
1919 if (interrupt_input_blocked
== 0
1920 && !waiting_for_input
)
1921 read_avail_input (0);
1927 /* Timer callback function for poll_timer. TIMER is equal to
1931 poll_for_input (struct atimer
*timer
)
1933 if (poll_suppress_count
== 0)
1936 interrupt_input_pending
= 1;
1937 pending_signals
= 1;
1939 poll_for_input_1 ();
1944 #endif /* POLL_FOR_INPUT */
1946 /* Begin signals to poll for input, if they are appropriate.
1947 This function is called unconditionally from various places. */
1950 start_polling (void)
1952 #ifdef POLL_FOR_INPUT
1953 /* XXX This condition was (read_socket_hook && !interrupt_input),
1954 but read_socket_hook is not global anymore. Let's pretend that
1956 if (!interrupt_input
)
1958 /* Turn alarm handling on unconditionally. It might have
1959 been turned off in process.c. */
1960 turn_on_atimers (1);
1962 /* If poll timer doesn't exist, are we need one with
1963 a different interval, start a new one. */
1964 if (poll_timer
== NULL
1965 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1967 EMACS_TIME interval
;
1970 cancel_atimer (poll_timer
);
1972 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1973 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1974 poll_for_input
, NULL
);
1977 /* Let the timer's callback function poll for input
1978 if this becomes zero. */
1979 --poll_suppress_count
;
1984 /* Nonzero if we are using polling to handle input asynchronously. */
1987 input_polling_used (void)
1989 #ifdef POLL_FOR_INPUT
1990 /* XXX This condition was (read_socket_hook && !interrupt_input),
1991 but read_socket_hook is not global anymore. Let's pretend that
1993 return !interrupt_input
;
1999 /* Turn off polling. */
2004 #ifdef POLL_FOR_INPUT
2005 /* XXX This condition was (read_socket_hook && !interrupt_input),
2006 but read_socket_hook is not global anymore. Let's pretend that
2008 if (!interrupt_input
)
2009 ++poll_suppress_count
;
2013 /* Set the value of poll_suppress_count to COUNT
2014 and start or stop polling accordingly. */
2017 set_poll_suppress_count (int count
)
2019 #ifdef POLL_FOR_INPUT
2020 if (count
== 0 && poll_suppress_count
!= 0)
2022 poll_suppress_count
= 1;
2025 else if (count
!= 0 && poll_suppress_count
== 0)
2029 poll_suppress_count
= count
;
2033 /* Bind polling_period to a value at least N.
2034 But don't decrease it. */
2037 bind_polling_period (int n
)
2039 #ifdef POLL_FOR_INPUT
2040 int new = polling_period
;
2045 stop_other_atimers (poll_timer
);
2047 specbind (Qpolling_period
, make_number (new));
2048 /* Start a new alarm with the new period. */
2053 /* Apply the control modifier to CHARACTER. */
2056 make_ctrl_char (int c
)
2058 /* Save the upper bits here. */
2059 int upper
= c
& ~0177;
2061 if (! ASCII_BYTE_P (c
))
2062 return c
|= ctrl_modifier
;
2066 /* Everything in the columns containing the upper-case letters
2067 denotes a control character. */
2068 if (c
>= 0100 && c
< 0140)
2072 /* Set the shift modifier for a control char
2073 made from a shifted letter. But only for letters! */
2074 if (oc
>= 'A' && oc
<= 'Z')
2075 c
|= shift_modifier
;
2078 /* The lower-case letters denote control characters too. */
2079 else if (c
>= 'a' && c
<= 'z')
2082 /* Include the bits for control and shift
2083 only if the basic ASCII code can't indicate them. */
2087 /* Replace the high bits. */
2088 c
|= (upper
& ~ctrl_modifier
);
2093 /* Display the help-echo property of the character after the mouse pointer.
2094 Either show it in the echo area, or call show-help-function to display
2095 it by other means (maybe in a tooltip).
2097 If HELP is nil, that means clear the previous help echo.
2099 If HELP is a string, display that string. If HELP is a function,
2100 call it with OBJECT and POS as arguments; the function should
2101 return a help string or nil for none. For all other types of HELP,
2102 evaluate it to obtain a string.
2104 WINDOW is the window in which the help was generated, if any.
2105 It is nil if not in a window.
2107 If OBJECT is a buffer, POS is the position in the buffer where the
2108 `help-echo' text property was found.
2110 If OBJECT is an overlay, that overlay has a `help-echo' property,
2111 and POS is the position in the overlay's buffer under the mouse.
2113 If OBJECT is a string (an overlay string or a string displayed with
2114 the `display' property). POS is the position in that string under
2117 Note: this function may only be called with HELP nil or a string
2118 from X code running asynchronously. */
2121 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2124 if (!NILP (help
) && !STRINGP (help
))
2126 if (FUNCTIONP (help
))
2128 Lisp_Object args
[4];
2133 help
= safe_call (4, args
);
2136 help
= safe_eval (help
);
2138 if (!STRINGP (help
))
2142 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2143 if (!noninteractive
&& STRINGP (help
))
2145 /* The mouse-fixup-help-message Lisp function can call
2146 mouse_position_hook, which resets the mouse_moved flags.
2147 This causes trouble if we are trying to read a mouse motion
2148 event (i.e., if we are inside a `track-mouse' form), so we
2149 restore the mouse_moved flag. */
2150 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2151 help
= call1 (Qmouse_fixup_help_message
, help
);
2157 if (STRINGP (help
) || NILP (help
))
2159 if (!NILP (Vshow_help_function
))
2160 call1 (Vshow_help_function
, help
);
2161 help_echo_showing_p
= STRINGP (help
);
2167 /* Input of single characters from keyboard */
2169 Lisp_Object
print_help (Lisp_Object object
);
2170 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2171 struct timeval
*end_time
);
2172 static void record_char (Lisp_Object c
);
2174 static Lisp_Object help_form_saved_window_configs
;
2176 read_char_help_form_unwind (Lisp_Object arg
)
2178 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2179 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2180 if (!NILP (window_config
))
2181 Fset_window_configuration (window_config
);
2185 #define STOP_POLLING \
2186 do { if (! polling_stopped_here) stop_polling (); \
2187 polling_stopped_here = 1; } while (0)
2189 #define RESUME_POLLING \
2190 do { if (polling_stopped_here) start_polling (); \
2191 polling_stopped_here = 0; } while (0)
2193 /* read a character from the keyboard; call the redisplay if needed */
2194 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2195 -1 means do not do redisplay, but do do autosaving.
2198 /* The arguments MAPS and NMAPS are for menu prompting.
2199 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2201 PREV_EVENT is the previous input event, or nil if we are reading
2202 the first event of a key sequence (or not reading a key sequence).
2203 If PREV_EVENT is t, that is a "magic" value that says
2204 not to run input methods, but in other respects to act as if
2205 not reading a key sequence.
2207 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2208 if we used a mouse menu to read the input, or zero otherwise. If
2209 USED_MOUSE_MENU is null, we don't dereference it.
2211 Value is -2 when we find input on another keyboard. A second call
2212 to read_char will read it.
2214 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2215 specifying the maximum time to wait until. If no input arrives by
2216 that time, stop waiting and return nil.
2218 Value is t if we showed a menu and the user rejected it. */
2221 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2222 int *used_mouse_menu
, struct timeval
*end_time
)
2224 volatile Lisp_Object c
;
2226 jmp_buf local_getcjmp
;
2228 volatile int key_already_recorded
= 0;
2229 Lisp_Object tem
, save
;
2230 volatile Lisp_Object previous_echo_area_message
;
2231 volatile Lisp_Object also_record
;
2232 volatile int reread
;
2233 struct gcpro gcpro1
, gcpro2
;
2234 int polling_stopped_here
= 0;
2235 struct kboard
*orig_kboard
= current_kboard
;
2239 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2240 before_command_key_count
= this_command_key_count
;
2241 before_command_echo_length
= echo_length ();
2244 previous_echo_area_message
= Qnil
;
2246 GCPRO2 (c
, previous_echo_area_message
);
2251 if (CONSP (Vunread_post_input_method_events
))
2253 c
= XCAR (Vunread_post_input_method_events
);
2254 Vunread_post_input_method_events
2255 = XCDR (Vunread_post_input_method_events
);
2257 /* Undo what read_char_x_menu_prompt did when it unread
2258 additional keys returned by Fx_popup_menu. */
2260 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2268 if (unread_command_char
!= -1)
2270 XSETINT (c
, unread_command_char
);
2271 unread_command_char
= -1;
2277 if (CONSP (Vunread_command_events
))
2279 int was_disabled
= 0;
2281 c
= XCAR (Vunread_command_events
);
2282 Vunread_command_events
= XCDR (Vunread_command_events
);
2286 /* Undo what sit-for did when it unread additional keys
2287 inside universal-argument. */
2290 && EQ (XCAR (c
), Qt
))
2296 /* Undo what read_char_x_menu_prompt did when it unread
2297 additional keys returned by Fx_popup_menu. */
2299 && EQ (XCDR (c
), Qdisabled
)
2300 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2306 /* If the queued event is something that used the mouse,
2307 set used_mouse_menu accordingly. */
2309 /* Also check was_disabled so last-nonmenu-event won't return
2310 a bad value when submenus are involved. (Bug#447) */
2311 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2312 *used_mouse_menu
= 1;
2314 goto reread_for_input_method
;
2317 if (CONSP (Vunread_input_method_events
))
2319 c
= XCAR (Vunread_input_method_events
);
2320 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2322 /* Undo what read_char_x_menu_prompt did when it unread
2323 additional keys returned by Fx_popup_menu. */
2325 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2329 goto reread_for_input_method
;
2332 this_command_key_count_reset
= 0;
2334 if (!NILP (Vexecuting_kbd_macro
))
2336 /* We set this to Qmacro; since that's not a frame, nobody will
2337 try to switch frames on us, and the selected window will
2340 Since this event came from a macro, it would be misleading to
2341 leave internal_last_event_frame set to wherever the last
2342 real event came from. Normally, a switch-frame event selects
2343 internal_last_event_frame after each command is read, but
2344 events read from a macro should never cause a new frame to be
2346 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2348 /* Exit the macro if we are at the end.
2349 Also, some things replace the macro with t
2350 to force an early exit. */
2351 if (EQ (Vexecuting_kbd_macro
, Qt
)
2352 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2358 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2359 if (STRINGP (Vexecuting_kbd_macro
)
2360 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2361 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2363 executing_kbd_macro_index
++;
2368 if (!NILP (unread_switch_frame
))
2370 c
= unread_switch_frame
;
2371 unread_switch_frame
= Qnil
;
2373 /* This event should make it into this_command_keys, and get echoed
2374 again, so we do not set `reread'. */
2378 /* if redisplay was requested */
2379 if (commandflag
>= 0)
2381 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2383 /* If there is pending input, process any events which are not
2384 user-visible, such as X selection_request events. */
2386 || detect_input_pending_run_timers (0))
2387 swallow_events (0); /* may clear input_pending */
2389 /* Redisplay if no pending input. */
2390 while (!input_pending
)
2392 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2393 redisplay_preserve_echo_area (5);
2398 /* Normal case: no input arrived during redisplay. */
2401 /* Input arrived and pre-empted redisplay.
2402 Process any events which are not user-visible. */
2404 /* If that cleared input_pending, try again to redisplay. */
2407 /* Prevent the redisplay we just did
2408 from messing up echoing of the input after the prompt. */
2409 if (commandflag
== 0 && echo_current
)
2410 echo_message_buffer
= echo_area_buffer
[0];
2414 /* Message turns off echoing unless more keystrokes turn it on again.
2416 The code in 20.x for the condition was
2418 1. echo_area_glyphs && *echo_area_glyphs
2419 2. && echo_area_glyphs != current_kboard->echobuf
2420 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2422 (1) means there's a current message displayed
2424 (2) means it's not the message from echoing from the current
2427 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2428 is set to a non-null value. This is done in read_char and it is
2429 set to echo_area_glyphs after a call to echo_char. That means
2430 ok_to_echo_at_next_pause is either null or
2431 current_kboard->echobuf with the appropriate current_kboard at
2434 So, condition (3) means in clear text ok_to_echo_at_next_pause
2435 must be either null, or the current message isn't from echoing at
2436 all, or it's from echoing from a different kboard than the
2439 if (/* There currently is something in the echo area. */
2440 !NILP (echo_area_buffer
[0])
2441 && (/* And it's either not from echoing. */
2442 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2443 /* Or it's an echo from a different kboard. */
2444 || echo_kboard
!= current_kboard
2445 /* Or we explicitly allow overwriting whatever there is. */
2446 || ok_to_echo_at_next_pause
== NULL
))
2451 /* Try reading a character via menu prompting in the minibuf.
2452 Try this before the sit-for, because the sit-for
2453 would do the wrong thing if we are supposed to do
2454 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2455 after a mouse event so don't try a minibuf menu. */
2457 if (nmaps
> 0 && INTERACTIVE
2458 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2459 /* Don't bring up a menu if we already have another event. */
2460 && NILP (Vunread_command_events
)
2461 && unread_command_char
< 0
2462 && !detect_input_pending_run_timers (0))
2464 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2466 if (INTEGERP (c
) && XINT (c
) == -2)
2467 return c
; /* wrong_kboard_jmpbuf */
2471 key_already_recorded
= 1;
2476 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2477 We will do that below, temporarily for short sections of code,
2478 when appropriate. local_getcjmp must be in effect
2479 around any call to sit_for or kbd_buffer_get_event;
2480 it *must not* be in effect when we call redisplay. */
2482 jmpcount
= SPECPDL_INDEX ();
2483 if (_setjmp (local_getcjmp
))
2485 /* Handle quits while reading the keyboard. */
2486 /* We must have saved the outer value of getcjmp here,
2487 so restore it now. */
2488 restore_getcjmp (save_jump
);
2489 unbind_to (jmpcount
, Qnil
);
2490 XSETINT (c
, quit_char
);
2491 internal_last_event_frame
= selected_frame
;
2492 Vlast_event_frame
= internal_last_event_frame
;
2493 /* If we report the quit char as an event,
2494 don't do so more than once. */
2495 if (!NILP (Vinhibit_quit
))
2499 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2500 if (kb
!= current_kboard
)
2502 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2503 /* We shouldn't get here if we were in single-kboard mode! */
2508 while (CONSP (XCDR (last
)))
2510 if (!NILP (XCDR (last
)))
2514 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2516 XSETCDR (last
, Fcons (c
, Qnil
));
2517 kb
->kbd_queue_has_data
= 1;
2518 current_kboard
= kb
;
2519 /* This is going to exit from read_char
2520 so we had better get rid of this frame's stuff. */
2522 return make_number (-2); /* wrong_kboard_jmpbuf */
2528 /* Start idle timers if no time limit is supplied. We don't do it
2529 if a time limit is supplied to avoid an infinite recursion in the
2530 situation where an idle timer calls `sit-for'. */
2533 timer_start_idle ();
2535 /* If in middle of key sequence and minibuffer not active,
2536 start echoing if enough time elapses. */
2538 if (minibuf_level
== 0
2540 && !current_kboard
->immediate_echo
2541 && this_command_key_count
> 0
2543 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2544 && NILP (Fzerop (Vecho_keystrokes
))
2545 && (/* No message. */
2546 NILP (echo_area_buffer
[0])
2547 /* Or empty message. */
2548 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2549 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2550 /* Or already echoing from same kboard. */
2551 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2552 /* Or not echoing before and echoing allowed. */
2553 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2555 /* After a mouse event, start echoing right away.
2556 This is because we are probably about to display a menu,
2557 and we don't want to delay before doing so. */
2558 if (EVENT_HAS_PARAMETERS (prev_event
))
2564 save_getcjmp (save_jump
);
2565 restore_getcjmp (local_getcjmp
);
2566 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2567 restore_getcjmp (save_jump
);
2569 && ! CONSP (Vunread_command_events
))
2574 /* Maybe auto save due to number of keystrokes. */
2576 if (commandflag
!= 0
2577 && auto_save_interval
> 0
2578 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2579 && !detect_input_pending_run_timers (0))
2581 Fdo_auto_save (Qnil
, Qnil
);
2582 /* Hooks can actually change some buffers in auto save. */
2586 /* Try reading using an X menu.
2587 This is never confused with reading using the minibuf
2588 because the recursive call of read_char in read_char_minibuf_menu_prompt
2589 does not pass on any keymaps. */
2591 if (nmaps
> 0 && INTERACTIVE
2592 && !NILP (prev_event
)
2593 && EVENT_HAS_PARAMETERS (prev_event
)
2594 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2595 && !EQ (XCAR (prev_event
), Qtool_bar
)
2596 /* Don't bring up a menu if we already have another event. */
2597 && NILP (Vunread_command_events
)
2598 && unread_command_char
< 0)
2600 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2602 /* Now that we have read an event, Emacs is not idle. */
2609 /* Maybe autosave and/or garbage collect due to idleness. */
2611 if (INTERACTIVE
&& NILP (c
))
2614 EMACS_INT buffer_size
;
2616 /* Slow down auto saves logarithmically in size of current buffer,
2617 and garbage collect while we're at it. */
2618 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2619 last_non_minibuf_size
= Z
- BEG
;
2620 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2622 while (buffer_size
> 64)
2623 delay_level
++, buffer_size
-= buffer_size
>> 2;
2624 if (delay_level
< 4) delay_level
= 4;
2625 /* delay_level is 4 for files under around 50k, 7 at 100k,
2626 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2628 /* Auto save if enough time goes by without input. */
2629 if (commandflag
!= 0
2630 && num_nonmacro_input_events
> last_auto_save
2631 && INTEGERP (Vauto_save_timeout
)
2632 && XINT (Vauto_save_timeout
) > 0)
2635 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2637 save_getcjmp (save_jump
);
2638 restore_getcjmp (local_getcjmp
);
2639 tem0
= sit_for (make_number (timeout
), 1, 1);
2640 restore_getcjmp (save_jump
);
2643 && ! CONSP (Vunread_command_events
))
2645 Fdo_auto_save (Qnil
, Qnil
);
2647 /* If we have auto-saved and there is still no input
2648 available, garbage collect if there has been enough
2649 consing going on to make it worthwhile. */
2650 if (!detect_input_pending_run_timers (0)
2651 && consing_since_gc
> gc_cons_threshold
/ 2)
2652 Fgarbage_collect ();
2659 /* Notify the caller if an autosave hook, or a timer, sentinel or
2660 filter in the sit_for calls above have changed the current
2661 kboard. This could happen if they use the minibuffer or start a
2662 recursive edit, like the fancy splash screen in server.el's
2663 filter. If this longjmp wasn't here, read_key_sequence would
2664 interpret the next key sequence using the wrong translation
2665 tables and function keymaps. */
2666 if (NILP (c
) && current_kboard
!= orig_kboard
)
2669 return make_number (-2); /* wrong_kboard_jmpbuf */
2672 /* If this has become non-nil here, it has been set by a timer
2673 or sentinel or filter. */
2674 if (CONSP (Vunread_command_events
))
2676 c
= XCAR (Vunread_command_events
);
2677 Vunread_command_events
= XCDR (Vunread_command_events
);
2680 /* Read something from current KBOARD's side queue, if possible. */
2684 if (current_kboard
->kbd_queue_has_data
)
2686 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2688 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2689 KVAR (current_kboard
, kbd_queue
)
2690 = XCDR (KVAR (current_kboard
, kbd_queue
));
2691 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2692 current_kboard
->kbd_queue_has_data
= 0;
2693 input_pending
= readable_events (0);
2694 if (EVENT_HAS_PARAMETERS (c
)
2695 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2696 internal_last_event_frame
= XCAR (XCDR (c
));
2697 Vlast_event_frame
= internal_last_event_frame
;
2701 /* If current_kboard's side queue is empty check the other kboards.
2702 If one of them has data that we have not yet seen here,
2703 switch to it and process the data waiting for it.
2705 Note: if the events queued up for another kboard
2706 have already been seen here, and therefore are not a complete command,
2707 the kbd_queue_has_data field is 0, so we skip that kboard here.
2708 That's to avoid an infinite loop switching between kboards here. */
2709 if (NILP (c
) && !single_kboard
)
2712 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2713 if (kb
->kbd_queue_has_data
)
2715 current_kboard
= kb
;
2716 /* This is going to exit from read_char
2717 so we had better get rid of this frame's stuff. */
2719 return make_number (-2); /* wrong_kboard_jmpbuf */
2727 /* Finally, we read from the main queue,
2728 and if that gives us something we can't use yet, we put it on the
2729 appropriate side queue and try again. */
2733 KBOARD
*kb
IF_LINT (= NULL
);
2738 EMACS_GET_TIME (now
);
2739 if (EMACS_TIME_GE (now
, *end_time
))
2743 /* Actually read a character, waiting if necessary. */
2744 save_getcjmp (save_jump
);
2745 restore_getcjmp (local_getcjmp
);
2747 timer_start_idle ();
2748 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2749 restore_getcjmp (save_jump
);
2751 if (! NILP (c
) && (kb
!= current_kboard
))
2753 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2756 while (CONSP (XCDR (last
)))
2758 if (!NILP (XCDR (last
)))
2762 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2764 XSETCDR (last
, Fcons (c
, Qnil
));
2765 kb
->kbd_queue_has_data
= 1;
2769 current_kboard
= kb
;
2770 /* This is going to exit from read_char
2771 so we had better get rid of this frame's stuff. */
2773 return make_number (-2);
2777 /* Terminate Emacs in batch mode if at eof. */
2778 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2779 Fkill_emacs (make_number (1));
2783 /* Add in any extra modifiers, where appropriate. */
2784 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2785 || ((extra_keyboard_modifiers
& 0177) < ' '
2786 && (extra_keyboard_modifiers
& 0177) != 0))
2787 XSETINT (c
, make_ctrl_char (XINT (c
)));
2789 /* Transfer any other modifier bits directly from
2790 extra_keyboard_modifiers to c. Ignore the actual character code
2791 in the low 16 bits of extra_keyboard_modifiers. */
2792 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2803 if (commandflag
>= 0
2804 && !input_pending
&& !detect_input_pending_run_timers (0))
2812 /* Buffer switch events are only for internal wakeups
2813 so don't show them to the user.
2814 Also, don't record a key if we already did. */
2815 if (BUFFERP (c
) || key_already_recorded
)
2818 /* Process special events within read_char
2819 and loop around to read another event. */
2822 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2827 struct buffer
*prev_buffer
= current_buffer
;
2828 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2829 int was_locked
= single_kboard
;
2830 int count
= SPECPDL_INDEX ();
2831 record_single_kboard_state ();
2834 last_input_event
= c
;
2835 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2837 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2838 /* We stopped being idle for this event; undo that. This
2839 prevents automatic window selection (under
2840 mouse_autoselect_window from acting as a real input event, for
2841 example banishing the mouse under mouse-avoidance-mode. */
2842 timer_resume_idle ();
2844 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2845 /* Resume allowing input from any kboard, if that was true before. */
2847 any_kboard_state ();
2848 unbind_to (count
, Qnil
);
2851 if (current_buffer
!= prev_buffer
)
2853 /* The command may have changed the keymaps. Pretend there
2854 is input in another keyboard and return. This will
2855 recalculate keymaps. */
2856 c
= make_number (-2);
2863 /* Handle things that only apply to characters. */
2866 /* If kbd_buffer_get_event gave us an EOF, return that. */
2870 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2871 && SCHARS (KVAR (current_kboard
, Vkeyboard_translate_table
)) > (unsigned) XFASTINT (c
))
2872 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2873 && XVECTOR (KVAR (current_kboard
, Vkeyboard_translate_table
))->size
> (unsigned) XFASTINT (c
))
2874 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2878 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2879 /* nil in keyboard-translate-table means no translation. */
2885 /* If this event is a mouse click in the menu bar,
2886 return just menu-bar for now. Modify the mouse click event
2887 so we won't do this twice, then queue it up. */
2888 if (EVENT_HAS_PARAMETERS (c
)
2890 && CONSP (EVENT_START (c
))
2891 && CONSP (XCDR (EVENT_START (c
))))
2895 posn
= POSN_POSN (EVENT_START (c
));
2896 /* Handle menu-bar events:
2897 insert the dummy prefix event `menu-bar'. */
2898 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2900 /* Change menu-bar to (menu-bar) as the event "position". */
2901 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2904 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2909 /* Store these characters into recent_keys, the dribble file if any,
2910 and the keyboard macro being defined, if any. */
2912 if (! NILP (also_record
))
2913 record_char (also_record
);
2915 /* Wipe the echo area.
2916 But first, if we are about to use an input method,
2917 save the echo area contents for it to refer to. */
2919 && ! NILP (Vinput_method_function
)
2920 && (unsigned) XINT (c
) >= ' '
2921 && (unsigned) XINT (c
) != 127
2922 && (unsigned) XINT (c
) < 256)
2924 previous_echo_area_message
= Fcurrent_message ();
2925 Vinput_method_previous_message
= previous_echo_area_message
;
2928 /* Now wipe the echo area, except for help events which do their
2929 own stuff with the echo area. */
2931 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2932 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2934 if (!NILP (echo_area_buffer
[0]))
2935 safe_run_hooks (Qecho_area_clear_hook
);
2936 clear_message (1, 0);
2939 reread_for_input_method
:
2941 /* Pass this to the input method, if appropriate. */
2943 && ! NILP (Vinput_method_function
)
2944 /* Don't run the input method within a key sequence,
2945 after the first event of the key sequence. */
2946 && NILP (prev_event
)
2947 && (unsigned) XINT (c
) >= ' '
2948 && (unsigned) XINT (c
) != 127
2949 && (unsigned) XINT (c
) < 256)
2952 int key_count
, key_count_reset
;
2953 struct gcpro inner_gcpro1
;
2954 int count
= SPECPDL_INDEX ();
2956 /* Save the echo status. */
2957 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2958 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2959 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2960 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2963 if (before_command_restore_flag
)
2965 this_command_key_count
= before_command_key_count_1
;
2966 if (this_command_key_count
< this_single_command_key_start
)
2967 this_single_command_key_start
= this_command_key_count
;
2968 echo_truncate (before_command_echo_length_1
);
2969 before_command_restore_flag
= 0;
2973 /* Save the this_command_keys status. */
2974 key_count
= this_command_key_count
;
2975 key_count_reset
= this_command_key_count_reset
;
2978 keys
= Fcopy_sequence (this_command_keys
);
2981 GCPRO1_VAR (keys
, inner_gcpro
);
2983 /* Clear out this_command_keys. */
2984 this_command_key_count
= 0;
2985 this_command_key_count_reset
= 0;
2987 /* Now wipe the echo area. */
2988 if (!NILP (echo_area_buffer
[0]))
2989 safe_run_hooks (Qecho_area_clear_hook
);
2990 clear_message (1, 0);
2993 /* If we are not reading a key sequence,
2994 never use the echo area. */
2997 specbind (Qinput_method_use_echo_area
, Qt
);
3000 /* Call the input method. */
3001 tem
= call1 (Vinput_method_function
, c
);
3003 tem
= unbind_to (count
, tem
);
3005 /* Restore the saved echoing state
3006 and this_command_keys state. */
3007 this_command_key_count
= key_count
;
3008 this_command_key_count_reset
= key_count_reset
;
3010 this_command_keys
= keys
;
3013 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3014 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3015 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3016 if (saved_immediate_echo
)
3019 UNGCPRO_VAR (inner_gcpro
);
3021 /* The input method can return no events. */
3024 /* Bring back the previous message, if any. */
3025 if (! NILP (previous_echo_area_message
))
3026 message_with_string ("%s", previous_echo_area_message
, 0);
3029 /* It returned one event or more. */
3031 Vunread_post_input_method_events
3032 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3037 /* Display help if not echoing. */
3038 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3040 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3041 Lisp_Object help
, object
, position
, window
, htem
;
3043 htem
= Fcdr (XCDR (c
));
3046 window
= Fcar (htem
);
3048 object
= Fcar (htem
);
3050 position
= Fcar (htem
);
3052 show_help_echo (help
, window
, object
, position
);
3054 /* We stopped being idle for this event; undo that. */
3056 timer_resume_idle ();
3060 if ((! reread
|| this_command_key_count
== 0
3061 || this_command_key_count_reset
)
3065 /* Don't echo mouse motion events. */
3066 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3067 && NILP (Fzerop (Vecho_keystrokes
))
3068 && ! (EVENT_HAS_PARAMETERS (c
)
3069 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3072 if (! NILP (also_record
))
3073 echo_char (also_record
);
3074 /* Once we reread a character, echoing can happen
3075 the next time we pause to read a new one. */
3076 ok_to_echo_at_next_pause
= current_kboard
;
3079 /* Record this character as part of the current key. */
3080 add_command_key (c
);
3081 if (! NILP (also_record
))
3082 add_command_key (also_record
);
3085 last_input_event
= c
;
3088 /* Process the help character specially if enabled */
3089 if (!NILP (Vhelp_form
) && help_char_p (c
))
3092 int count
= SPECPDL_INDEX ();
3094 help_form_saved_window_configs
3095 = Fcons (Fcurrent_window_configuration (Qnil
),
3096 help_form_saved_window_configs
);
3097 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3099 tem0
= Feval (Vhelp_form
, Qnil
);
3101 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3106 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3107 if (EVENT_HAS_PARAMETERS (c
)
3108 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3109 XSETCAR (help_form_saved_window_configs
, Qnil
);
3111 while (BUFFERP (c
));
3112 /* Remove the help from the frame */
3113 unbind_to (count
, Qnil
);
3116 if (EQ (c
, make_number (040)))
3120 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3121 while (BUFFERP (c
));
3130 /* Record a key that came from a mouse menu.
3131 Record it for echoing, for this-command-keys, and so on. */
3134 record_menu_key (Lisp_Object c
)
3136 /* Wipe the echo area. */
3137 clear_message (1, 0);
3142 before_command_key_count
= this_command_key_count
;
3143 before_command_echo_length
= echo_length ();
3146 /* Don't echo mouse motion events. */
3147 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3148 && NILP (Fzerop (Vecho_keystrokes
)))
3152 /* Once we reread a character, echoing can happen
3153 the next time we pause to read a new one. */
3154 ok_to_echo_at_next_pause
= 0;
3157 /* Record this character as part of the current key. */
3158 add_command_key (c
);
3160 /* Re-reading in the middle of a command */
3161 last_input_event
= c
;
3165 /* Return 1 if should recognize C as "the help character". */
3168 help_char_p (Lisp_Object c
)
3172 if (EQ (c
, Vhelp_char
))
3174 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3175 if (EQ (c
, XCAR (tail
)))
3180 /* Record the input event C in various ways. */
3183 record_char (Lisp_Object c
)
3187 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3189 /* To avoid filling recent_keys with help-echo and mouse-movement
3190 events, we filter out repeated help-echo events, only store the
3191 first and last in a series of mouse-movement events, and don't
3192 store repeated help-echo events which are only separated by
3193 mouse-movement events. */
3195 Lisp_Object ev1
, ev2
, ev3
;
3198 if ((ix1
= recent_keys_index
- 1) < 0)
3199 ix1
= NUM_RECENT_KEYS
- 1;
3200 ev1
= AREF (recent_keys
, ix1
);
3202 if ((ix2
= ix1
- 1) < 0)
3203 ix2
= NUM_RECENT_KEYS
- 1;
3204 ev2
= AREF (recent_keys
, ix2
);
3206 if ((ix3
= ix2
- 1) < 0)
3207 ix3
= NUM_RECENT_KEYS
- 1;
3208 ev3
= AREF (recent_keys
, ix3
);
3210 if (EQ (XCAR (c
), Qhelp_echo
))
3212 /* Don't record `help-echo' in recent_keys unless it shows some help
3213 message, and a different help than the previously recorded
3215 Lisp_Object help
, last_help
;
3217 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3218 if (!STRINGP (help
))
3220 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3221 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3223 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3224 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3225 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3227 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3228 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3229 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3230 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3233 else if (EQ (XCAR (c
), Qmouse_movement
))
3235 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3236 So additional mouse movement events replace the last element. */
3237 Lisp_Object last_window
, window
;
3239 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3240 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3241 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3242 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3243 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3245 ASET (recent_keys
, ix1
, c
);
3251 store_kbd_macro_char (c
);
3256 ASET (recent_keys
, recent_keys_index
, c
);
3257 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3258 recent_keys_index
= 0;
3260 else if (recorded
< 0)
3262 /* We need to remove one or two events from recent_keys.
3263 To do this, we simply put nil at those events and move the
3264 recent_keys_index backwards over those events. Usually,
3265 users will never see those nil events, as they will be
3266 overwritten by the command keys entered to see recent_keys
3269 while (recorded
++ < 0 && total_keys
> 0)
3271 if (total_keys
< NUM_RECENT_KEYS
)
3273 if (--recent_keys_index
< 0)
3274 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3275 ASET (recent_keys
, recent_keys_index
, Qnil
);
3279 num_nonmacro_input_events
++;
3281 /* Write c to the dribble file. If c is a lispy event, write
3282 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3283 If you, dear reader, have a better idea, you've got the source. :-) */
3289 if (XUINT (c
) < 0x100)
3290 putc (XINT (c
), dribble
);
3292 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3296 Lisp_Object dribblee
;
3298 /* If it's a structured event, take the event header. */
3299 dribblee
= EVENT_HEAD (c
);
3301 if (SYMBOLP (dribblee
))
3303 putc ('<', dribble
);
3304 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3305 SBYTES (SYMBOL_NAME (dribblee
)),
3307 putc ('>', dribble
);
3317 print_help (Lisp_Object object
)
3319 struct buffer
*old
= current_buffer
;
3320 Fprinc (object
, Qnil
);
3321 set_buffer_internal (XBUFFER (Vstandard_output
));
3322 call0 (intern ("help-mode"));
3323 set_buffer_internal (old
);
3327 /* Copy out or in the info on where C-g should throw to.
3328 This is used when running Lisp code from within get_char,
3329 in case get_char is called recursively.
3330 See read_process_output. */
3333 save_getcjmp (jmp_buf temp
)
3335 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3339 restore_getcjmp (jmp_buf temp
)
3341 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3344 /* Low level keyboard/mouse input.
3345 kbd_buffer_store_event places events in kbd_buffer, and
3346 kbd_buffer_get_event retrieves them. */
3348 /* Return true if there are any events in the queue that read-char
3349 would return. If this returns false, a read-char would block. */
3351 readable_events (int flags
)
3353 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3356 /* If the buffer contains only FOCUS_IN_EVENT events, and
3357 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3358 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3360 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3361 #ifdef USE_TOOLKIT_SCROLL_BARS
3362 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3366 struct input_event
*event
;
3368 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3375 #ifdef USE_TOOLKIT_SCROLL_BARS
3376 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3378 event
->kind
== FOCUS_IN_EVENT
)
3379 #ifdef USE_TOOLKIT_SCROLL_BARS
3380 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3381 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3382 && event
->part
== scroll_bar_handle
3383 && event
->modifiers
== 0)
3388 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3391 while (event
!= kbd_store_ptr
);
3397 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3398 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3399 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3404 if (current_kboard
->kbd_queue_has_data
)
3410 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3411 if (kb
->kbd_queue_has_data
)
3417 /* Set this for debugging, to have a way to get out */
3421 event_to_kboard (struct input_event
*event
)
3424 frame
= event
->frame_or_window
;
3426 frame
= XCAR (frame
);
3427 else if (WINDOWP (frame
))
3428 frame
= WINDOW_FRAME (XWINDOW (frame
));
3430 /* There are still some events that don't set this field.
3431 For now, just ignore the problem.
3432 Also ignore dead frames here. */
3433 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3436 return FRAME_KBOARD (XFRAME (frame
));
3440 /* Return the number of slots occupied in kbd_buffer. */
3443 kbd_buffer_nr_stored (void)
3445 return kbd_fetch_ptr
== kbd_store_ptr
3447 : (kbd_fetch_ptr
< kbd_store_ptr
3448 ? kbd_store_ptr
- kbd_fetch_ptr
3449 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3450 + (kbd_store_ptr
- kbd_buffer
)));
3452 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3455 kbd_buffer_store_event (register struct input_event
*event
)
3457 kbd_buffer_store_event_hold (event
, 0);
3460 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3462 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3463 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3464 Else, if EVENT is a quit event, store the quit event
3465 in HOLD_QUIT, and return (thus ignoring further events).
3467 This is used in read_avail_input to postpone the processing
3468 of the quit event until all subsequent input events have been
3469 parsed (and discarded).
3473 kbd_buffer_store_event_hold (register struct input_event
*event
,
3474 struct input_event
*hold_quit
)
3476 if (event
->kind
== NO_EVENT
)
3479 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3482 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3484 register int c
= event
->code
& 0377;
3486 if (event
->modifiers
& ctrl_modifier
)
3487 c
= make_ctrl_char (c
);
3489 c
|= (event
->modifiers
3490 & (meta_modifier
| alt_modifier
3491 | hyper_modifier
| super_modifier
));
3495 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3496 struct input_event
*sp
;
3498 if (single_kboard
&& kb
!= current_kboard
)
3500 KVAR (kb
, kbd_queue
)
3501 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3502 Fcons (make_number (c
), Qnil
));
3503 kb
->kbd_queue_has_data
= 1;
3504 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3506 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3509 if (event_to_kboard (sp
) == kb
)
3511 sp
->kind
= NO_EVENT
;
3512 sp
->frame_or_window
= Qnil
;
3521 memcpy (hold_quit
, event
, sizeof (*event
));
3525 /* If this results in a quit_char being returned to Emacs as
3526 input, set Vlast_event_frame properly. If this doesn't
3527 get returned to Emacs as an event, the next event read
3528 will set Vlast_event_frame again, so this is safe to do. */
3532 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3534 focus
= event
->frame_or_window
;
3535 internal_last_event_frame
= focus
;
3536 Vlast_event_frame
= focus
;
3539 last_event_timestamp
= event
->timestamp
;
3540 handle_interrupt ();
3544 if (c
&& c
== stop_character
)
3550 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3551 Just ignore the second one. */
3552 else if (event
->kind
== BUFFER_SWITCH_EVENT
3553 && kbd_fetch_ptr
!= kbd_store_ptr
3554 && ((kbd_store_ptr
== kbd_buffer
3555 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3556 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3559 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3560 kbd_store_ptr
= kbd_buffer
;
3562 /* Don't let the very last slot in the buffer become full,
3563 since that would make the two pointers equal,
3564 and that is indistinguishable from an empty buffer.
3565 Discard the event if it would fill the last slot. */
3566 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3568 *kbd_store_ptr
= *event
;
3571 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3573 /* Don't read keyboard input until we have processed kbd_buffer.
3574 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3575 hold_keyboard_input ();
3577 if (!noninteractive
)
3578 signal (SIGIO
, SIG_IGN
);
3582 #endif /* subprocesses */
3585 /* If we're inside while-no-input, and this event qualifies
3586 as input, set quit-flag to cause an interrupt. */
3587 if (!NILP (Vthrow_on_input
)
3588 && event
->kind
!= FOCUS_IN_EVENT
3589 && event
->kind
!= HELP_EVENT
3590 && event
->kind
!= DEICONIFY_EVENT
)
3592 Vquit_flag
= Vthrow_on_input
;
3593 /* If we're inside a function that wants immediate quits,
3595 if (immediate_quit
&& NILP (Vinhibit_quit
))
3605 /* Put an input event back in the head of the event queue. */
3608 kbd_buffer_unget_event (register struct input_event
*event
)
3610 if (kbd_fetch_ptr
== kbd_buffer
)
3611 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3613 /* Don't let the very last slot in the buffer become full, */
3614 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3617 *kbd_fetch_ptr
= *event
;
3622 /* Generate a HELP_EVENT input_event and store it in the keyboard
3625 HELP is the help form.
3627 FRAME and WINDOW are the frame and window where the help is
3628 generated. OBJECT is the Lisp object where the help was found (a
3629 buffer, a string, an overlay, or nil if neither from a string nor
3630 from a buffer). POS is the position within OBJECT where the help
3634 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3635 Lisp_Object object
, EMACS_INT pos
)
3637 struct input_event event
;
3641 event
.kind
= HELP_EVENT
;
3642 event
.frame_or_window
= frame
;
3644 event
.x
= WINDOWP (window
) ? window
: frame
;
3647 kbd_buffer_store_event (&event
);
3651 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3654 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3656 struct input_event event
;
3658 event
.kind
= HELP_EVENT
;
3659 event
.frame_or_window
= frame
;
3664 kbd_buffer_store_event (&event
);
3668 /* Discard any mouse events in the event buffer by setting them to
3671 discard_mouse_events (void)
3673 struct input_event
*sp
;
3674 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3676 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3679 if (sp
->kind
== MOUSE_CLICK_EVENT
3680 || sp
->kind
== WHEEL_EVENT
3681 || sp
->kind
== HORIZ_WHEEL_EVENT
3683 || sp
->kind
== GPM_CLICK_EVENT
3685 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3687 sp
->kind
= NO_EVENT
;
3693 /* Return non-zero if there are any real events waiting in the event
3694 buffer, not counting `NO_EVENT's.
3696 If DISCARD is non-zero, discard NO_EVENT events at the front of
3697 the input queue, possibly leaving the input queue empty if there
3698 are no real input events. */
3701 kbd_buffer_events_waiting (int discard
)
3703 struct input_event
*sp
;
3705 for (sp
= kbd_fetch_ptr
;
3706 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3709 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3716 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3720 /* Clear input event EVENT. */
3723 clear_event (struct input_event
*event
)
3725 event
->kind
= NO_EVENT
;
3729 /* Read one event from the event buffer, waiting if necessary.
3730 The value is a Lisp object representing the event.
3731 The value is nil for an event that should be ignored,
3732 or that was handled here.
3733 We always read and discard one event. */
3736 kbd_buffer_get_event (KBOARD
**kbp
,
3737 int *used_mouse_menu
,
3738 struct timeval
*end_time
)
3744 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3746 /* Start reading input again, we have processed enough so we can
3747 accept new events again. */
3748 unhold_keyboard_input ();
3750 if (!noninteractive
)
3751 signal (SIGIO
, input_available_signal
);
3755 #endif /* subprocesses */
3758 /* In case we are running as a daemon, only do this before
3759 detaching from the terminal. */
3760 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3764 *kbp
= current_kboard
;
3768 /* Wait until there is input available. */
3771 /* Break loop if there's an unread command event. Needed in
3772 moused window autoselection which uses a timer to insert such
3774 if (CONSP (Vunread_command_events
))
3777 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3779 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3780 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3784 /* If the quit flag is set, then read_char will return
3785 quit_char, so that counts as "available input." */
3786 if (!NILP (Vquit_flag
))
3787 quit_throw_to_read_char ();
3789 /* One way or another, wait until input is available; then, if
3790 interrupt handlers have not read it, read it now. */
3792 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3796 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3798 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3799 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3804 EMACS_TIME duration
;
3805 EMACS_GET_TIME (duration
);
3806 if (EMACS_TIME_GE (duration
, *end_time
))
3807 return Qnil
; /* finished waiting */
3810 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3811 wait_reading_process_output (EMACS_SECS (duration
),
3812 EMACS_USECS (duration
),
3813 -1, 1, Qnil
, NULL
, 0);
3817 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3819 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3820 /* Pass 1 for EXPECT since we just waited to have input. */
3821 read_avail_input (1);
3824 if (CONSP (Vunread_command_events
))
3827 first
= XCAR (Vunread_command_events
);
3828 Vunread_command_events
= XCDR (Vunread_command_events
);
3829 *kbp
= current_kboard
;
3833 /* At this point, we know that there is a readable event available
3834 somewhere. If the event queue is empty, then there must be a
3835 mouse movement enabled and available. */
3836 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3838 struct input_event
*event
;
3840 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3844 last_event_timestamp
= event
->timestamp
;
3846 *kbp
= event_to_kboard (event
);
3848 *kbp
= current_kboard
; /* Better than returning null ptr? */
3852 /* These two kinds of events get special handling
3853 and don't actually appear to the command loop.
3854 We return nil for them. */
3855 if (event
->kind
== SELECTION_REQUEST_EVENT
3856 || event
->kind
== SELECTION_CLEAR_EVENT
)
3859 struct input_event copy
;
3861 /* Remove it from the buffer before processing it,
3862 since otherwise swallow_events will see it
3863 and process it again. */
3865 kbd_fetch_ptr
= event
+ 1;
3866 input_pending
= readable_events (0);
3867 x_handle_selection_event (©
);
3869 /* We're getting selection request events, but we don't have
3875 #if defined (HAVE_NS)
3876 else if (event
->kind
== NS_TEXT_EVENT
)
3878 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3879 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3881 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3882 kbd_fetch_ptr
= event
+ 1;
3883 if (used_mouse_menu
)
3884 *used_mouse_menu
= 1;
3888 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3889 || defined (HAVE_NS)
3890 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3892 /* Make an event (delete-frame (FRAME)). */
3893 obj
= Fcons (event
->frame_or_window
, Qnil
);
3894 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3895 kbd_fetch_ptr
= event
+ 1;
3898 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3899 || defined (HAVE_NS)
3900 else if (event
->kind
== ICONIFY_EVENT
)
3902 /* Make an event (iconify-frame (FRAME)). */
3903 obj
= Fcons (event
->frame_or_window
, Qnil
);
3904 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3905 kbd_fetch_ptr
= event
+ 1;
3907 else if (event
->kind
== DEICONIFY_EVENT
)
3909 /* Make an event (make-frame-visible (FRAME)). */
3910 obj
= Fcons (event
->frame_or_window
, Qnil
);
3911 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3912 kbd_fetch_ptr
= event
+ 1;
3915 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3917 /* The value doesn't matter here; only the type is tested. */
3918 XSETBUFFER (obj
, current_buffer
);
3919 kbd_fetch_ptr
= event
+ 1;
3921 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3922 || defined(HAVE_NS) || defined (USE_GTK)
3923 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3925 kbd_fetch_ptr
= event
+ 1;
3926 input_pending
= readable_events (0);
3927 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3928 x_activate_menubar (XFRAME (event
->frame_or_window
));
3931 #if defined (WINDOWSNT)
3932 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3934 /* Make an event (language-change (FRAME CHARSET LCID)). */
3935 obj
= Fcons (event
->frame_or_window
, Qnil
);
3936 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3937 kbd_fetch_ptr
= event
+ 1;
3940 else if (event
->kind
== SAVE_SESSION_EVENT
)
3942 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3943 kbd_fetch_ptr
= event
+ 1;
3945 /* Just discard these, by returning nil.
3946 With MULTI_KBOARD, these events are used as placeholders
3947 when we need to randomly delete events from the queue.
3948 (They shouldn't otherwise be found in the buffer,
3949 but on some machines it appears they do show up
3950 even without MULTI_KBOARD.) */
3951 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3952 mouse events during a popup-menu call. */
3953 else if (event
->kind
== NO_EVENT
)
3954 kbd_fetch_ptr
= event
+ 1;
3955 else if (event
->kind
== HELP_EVENT
)
3957 Lisp_Object object
, position
, help
, frame
, window
;
3959 frame
= event
->frame_or_window
;
3960 object
= event
->arg
;
3961 position
= make_number (event
->code
);
3964 clear_event (event
);
3966 kbd_fetch_ptr
= event
+ 1;
3967 if (!WINDOWP (window
))
3969 obj
= Fcons (Qhelp_echo
,
3970 list5 (frame
, help
, window
, object
, position
));
3972 else if (event
->kind
== FOCUS_IN_EVENT
)
3974 /* Notification of a FocusIn event. The frame receiving the
3975 focus is in event->frame_or_window. Generate a
3976 switch-frame event if necessary. */
3977 Lisp_Object frame
, focus
;
3979 frame
= event
->frame_or_window
;
3980 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3984 if (!EQ (frame
, internal_last_event_frame
)
3985 && !EQ (frame
, selected_frame
))
3986 obj
= make_lispy_switch_frame (frame
);
3987 internal_last_event_frame
= frame
;
3988 kbd_fetch_ptr
= event
+ 1;
3991 else if (event
->kind
== DBUS_EVENT
)
3993 obj
= make_lispy_event (event
);
3994 kbd_fetch_ptr
= event
+ 1;
3997 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3999 obj
= make_lispy_event (event
);
4000 kbd_fetch_ptr
= event
+ 1;
4004 /* If this event is on a different frame, return a switch-frame this
4005 time, and leave the event in the queue for next time. */
4009 frame
= event
->frame_or_window
;
4011 frame
= XCAR (frame
);
4012 else if (WINDOWP (frame
))
4013 frame
= WINDOW_FRAME (XWINDOW (frame
));
4015 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4019 if (! EQ (frame
, internal_last_event_frame
)
4020 && !EQ (frame
, selected_frame
))
4021 obj
= make_lispy_switch_frame (frame
);
4022 internal_last_event_frame
= frame
;
4024 /* If we didn't decide to make a switch-frame event, go ahead
4025 and build a real event from the queue entry. */
4029 obj
= make_lispy_event (event
);
4031 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4032 || defined(HAVE_NS) || defined (USE_GTK)
4033 /* If this was a menu selection, then set the flag to inhibit
4034 writing to last_nonmenu_event. Don't do this if the event
4035 we're returning is (menu-bar), though; that indicates the
4036 beginning of the menu sequence, and we might as well leave
4037 that as the `event with parameters' for this selection. */
4039 && !EQ (event
->frame_or_window
, event
->arg
)
4040 && (event
->kind
== MENU_BAR_EVENT
4041 || event
->kind
== TOOL_BAR_EVENT
))
4042 *used_mouse_menu
= 1;
4045 /* certain system events are non-key events */
4047 && event
->kind
== NS_NONKEY_EVENT
)
4048 *used_mouse_menu
= 1;
4051 /* Wipe out this event, to catch bugs. */
4052 clear_event (event
);
4053 kbd_fetch_ptr
= event
+ 1;
4057 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4058 /* Try generating a mouse motion event. */
4059 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4061 FRAME_PTR f
= some_mouse_moved ();
4062 Lisp_Object bar_window
;
4063 enum scroll_bar_part part
;
4067 *kbp
= current_kboard
;
4068 /* Note that this uses F to determine which terminal to look at.
4069 If there is no valid info, it does not store anything
4070 so x remains nil. */
4073 /* XXX Can f or mouse_position_hook be NULL here? */
4074 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4075 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4080 /* Decide if we should generate a switch-frame event. Don't
4081 generate switch-frame events for motion outside of all Emacs
4087 frame
= FRAME_FOCUS_FRAME (f
);
4089 XSETFRAME (frame
, f
);
4091 if (! EQ (frame
, internal_last_event_frame
)
4092 && !EQ (frame
, selected_frame
))
4093 obj
= make_lispy_switch_frame (frame
);
4094 internal_last_event_frame
= frame
;
4097 /* If we didn't decide to make a switch-frame event, go ahead and
4098 return a mouse-motion event. */
4099 if (!NILP (x
) && NILP (obj
))
4100 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4102 #endif /* HAVE_MOUSE || HAVE GPM */
4104 /* We were promised by the above while loop that there was
4105 something for us to read! */
4108 input_pending
= readable_events (0);
4110 Vlast_event_frame
= internal_last_event_frame
;
4115 /* Process any events that are not user-visible,
4116 then return, without reading any user-visible events. */
4119 swallow_events (int do_display
)
4123 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4125 struct input_event
*event
;
4127 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4131 last_event_timestamp
= event
->timestamp
;
4133 /* These two kinds of events get special handling
4134 and don't actually appear to the command loop. */
4135 if (event
->kind
== SELECTION_REQUEST_EVENT
4136 || event
->kind
== SELECTION_CLEAR_EVENT
)
4139 struct input_event copy
;
4141 /* Remove it from the buffer before processing it,
4142 since otherwise swallow_events called recursively could see it
4143 and process it again. */
4145 kbd_fetch_ptr
= event
+ 1;
4146 input_pending
= readable_events (0);
4147 x_handle_selection_event (©
);
4149 /* We're getting selection request events, but we don't have
4158 old_timers_run
= timers_run
;
4159 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4161 if (timers_run
!= old_timers_run
&& do_display
)
4162 redisplay_preserve_echo_area (7);
4165 /* Record the start of when Emacs is idle,
4166 for the sake of running idle-time timers. */
4169 timer_start_idle (void)
4173 /* If we are already in the idle state, do nothing. */
4174 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4177 EMACS_GET_TIME (timer_idleness_start_time
);
4179 timer_last_idleness_start_time
= timer_idleness_start_time
;
4181 /* Mark all idle-time timers as once again candidates for running. */
4182 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4186 timer
= XCAR (timers
);
4188 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4190 XVECTOR (timer
)->contents
[0] = Qnil
;
4194 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4197 timer_stop_idle (void)
4199 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4202 /* Resume idle timer from last idle start time. */
4205 timer_resume_idle (void)
4207 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4210 timer_idleness_start_time
= timer_last_idleness_start_time
;
4213 /* This is only for debugging. */
4214 struct input_event last_timer_event
;
4216 /* List of elisp functions to call, delayed because they were generated in
4217 a context where Elisp could not be safely run (e.g. redisplay, signal,
4218 ...). Each element has the form (FUN . ARGS). */
4219 Lisp_Object pending_funcalls
;
4221 /* Check whether a timer has fired. To prevent larger problems we simply
4222 disregard elements that are not proper timers. Do not make a circular
4223 timer list for the time being.
4225 Returns the time to wait until the next timer fires. If a
4226 timer is triggering now, return zero.
4227 If no timer is active, return -1.
4229 If a timer is ripe, we run it, with quitting turned off.
4230 In that case we return 0 to indicate that a new timer_check_2 call
4234 timer_check_2 (void)
4236 EMACS_TIME nexttime
;
4237 EMACS_TIME now
, idleness_now
;
4238 Lisp_Object timers
, idle_timers
, chosen_timer
;
4239 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4241 EMACS_SET_SECS (nexttime
, -1);
4242 EMACS_SET_USECS (nexttime
, -1);
4244 /* Always consider the ordinary timers. */
4245 timers
= Vtimer_list
;
4246 /* Consider the idle timers only if Emacs is idle. */
4247 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4248 idle_timers
= Vtimer_idle_list
;
4251 chosen_timer
= Qnil
;
4252 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4254 /* First run the code that was delayed. */
4255 while (CONSP (pending_funcalls
))
4257 Lisp_Object funcall
= XCAR (pending_funcalls
);
4258 pending_funcalls
= XCDR (pending_funcalls
);
4259 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4262 if (CONSP (timers
) || CONSP (idle_timers
))
4264 EMACS_GET_TIME (now
);
4265 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4266 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4269 while (CONSP (timers
) || CONSP (idle_timers
))
4271 Lisp_Object
*vector
;
4272 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4273 EMACS_TIME timer_time
, idle_timer_time
;
4274 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4276 /* Skip past invalid timers and timers already handled. */
4279 timer
= XCAR (timers
);
4280 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4282 timers
= XCDR (timers
);
4285 vector
= XVECTOR (timer
)->contents
;
4287 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4288 || !INTEGERP (vector
[3])
4289 || ! NILP (vector
[0]))
4291 timers
= XCDR (timers
);
4295 if (!NILP (idle_timers
))
4297 timer
= XCAR (idle_timers
);
4298 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4300 idle_timers
= XCDR (idle_timers
);
4303 vector
= XVECTOR (timer
)->contents
;
4305 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4306 || !INTEGERP (vector
[3])
4307 || ! NILP (vector
[0]))
4309 idle_timers
= XCDR (idle_timers
);
4314 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4315 based on the next ordinary timer.
4316 TIMER_DIFFERENCE is the distance in time from NOW to when
4317 this timer becomes ripe (negative if it's already ripe). */
4320 timer
= XCAR (timers
);
4321 vector
= XVECTOR (timer
)->contents
;
4322 EMACS_SET_SECS (timer_time
,
4323 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4324 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4325 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4328 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4329 based on the next idle timer. */
4330 if (!NILP (idle_timers
))
4332 idle_timer
= XCAR (idle_timers
);
4333 vector
= XVECTOR (idle_timer
)->contents
;
4334 EMACS_SET_SECS (idle_timer_time
,
4335 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4336 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4337 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4340 /* Decide which timer is the next timer,
4341 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4342 Also step down the list where we found that timer. */
4344 if (! NILP (timers
) && ! NILP (idle_timers
))
4347 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4348 if (EMACS_TIME_NEG_P (temp
))
4350 chosen_timer
= timer
;
4351 timers
= XCDR (timers
);
4352 difference
= timer_difference
;
4356 chosen_timer
= idle_timer
;
4357 idle_timers
= XCDR (idle_timers
);
4358 difference
= idle_timer_difference
;
4361 else if (! NILP (timers
))
4363 chosen_timer
= timer
;
4364 timers
= XCDR (timers
);
4365 difference
= timer_difference
;
4369 chosen_timer
= idle_timer
;
4370 idle_timers
= XCDR (idle_timers
);
4371 difference
= idle_timer_difference
;
4373 vector
= XVECTOR (chosen_timer
)->contents
;
4375 /* If timer is ripe, run it if it hasn't been run. */
4376 if (EMACS_TIME_NEG_P (difference
)
4377 || (EMACS_SECS (difference
) == 0
4378 && EMACS_USECS (difference
) == 0))
4380 if (NILP (vector
[0]))
4382 int count
= SPECPDL_INDEX ();
4383 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4385 /* Mark the timer as triggered to prevent problems if the lisp
4386 code fails to reschedule it right. */
4389 specbind (Qinhibit_quit
, Qt
);
4391 call1 (Qtimer_event_handler
, chosen_timer
);
4392 Vdeactivate_mark
= old_deactivate_mark
;
4394 unbind_to (count
, Qnil
);
4396 /* Since we have handled the event,
4397 we don't need to tell the caller to wake up and do it. */
4398 /* But the caller must still wait for the next timer, so
4399 return 0 to indicate that. */
4402 EMACS_SET_SECS (nexttime
, 0);
4403 EMACS_SET_USECS (nexttime
, 0);
4406 /* When we encounter a timer that is still waiting,
4407 return the amount of time to wait before it is ripe. */
4414 /* No timers are pending in the future. */
4415 /* Return 0 if we generated an event, and -1 if not. */
4421 /* Check whether a timer has fired. To prevent larger problems we simply
4422 disregard elements that are not proper timers. Do not make a circular
4423 timer list for the time being.
4425 Returns the time to wait until the next timer fires.
4426 If no timer is active, return -1.
4428 As long as any timer is ripe, we run it. */
4433 EMACS_TIME nexttime
;
4437 nexttime
= timer_check_2 ();
4439 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4444 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4445 doc
: /* Return the current length of Emacs idleness, or nil.
4446 The value when Emacs is idle is a list of three integers. The first has
4447 the most significant 16 bits of the seconds, while the second has the least
4448 significant 16 bits. The third integer gives the microsecond count.
4450 The value when Emacs is not idle is nil.
4452 The microsecond count is zero on systems that do not provide
4453 resolution finer than a second. */)
4456 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4458 EMACS_TIME now
, idleness_now
;
4460 EMACS_GET_TIME (now
);
4461 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4463 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4464 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4465 make_number (EMACS_USECS (idleness_now
)));
4471 /* Caches for modify_event_symbol. */
4472 static Lisp_Object accent_key_syms
;
4473 static Lisp_Object func_key_syms
;
4474 static Lisp_Object mouse_syms
;
4475 static Lisp_Object wheel_syms
;
4476 static Lisp_Object drag_n_drop_syms
;
4478 /* This is a list of keysym codes for special "accent" characters.
4479 It parallels lispy_accent_keys. */
4481 static const int lispy_accent_codes
[] =
4483 #ifdef XK_dead_circumflex
4488 #ifdef XK_dead_grave
4493 #ifdef XK_dead_tilde
4498 #ifdef XK_dead_diaeresis
4503 #ifdef XK_dead_macron
4508 #ifdef XK_dead_degree
4513 #ifdef XK_dead_acute
4518 #ifdef XK_dead_cedilla
4523 #ifdef XK_dead_breve
4528 #ifdef XK_dead_ogonek
4533 #ifdef XK_dead_caron
4538 #ifdef XK_dead_doubleacute
4539 XK_dead_doubleacute
,
4543 #ifdef XK_dead_abovedot
4548 #ifdef XK_dead_abovering
4558 #ifdef XK_dead_belowdot
4563 #ifdef XK_dead_voiced_sound
4564 XK_dead_voiced_sound
,
4568 #ifdef XK_dead_semivoiced_sound
4569 XK_dead_semivoiced_sound
,
4585 /* This is a list of Lisp names for special "accent" characters.
4586 It parallels lispy_accent_codes. */
4588 static const char *const lispy_accent_keys
[] =
4606 "dead-voiced-sound",
4607 "dead-semivoiced-sound",
4613 #define FUNCTION_KEY_OFFSET 0x0
4615 const char *const lispy_function_keys
[] =
4619 0, /* VK_LBUTTON 0x01 */
4620 0, /* VK_RBUTTON 0x02 */
4621 "cancel", /* VK_CANCEL 0x03 */
4622 0, /* VK_MBUTTON 0x04 */
4624 0, 0, 0, /* 0x05 .. 0x07 */
4626 "backspace", /* VK_BACK 0x08 */
4627 "tab", /* VK_TAB 0x09 */
4629 0, 0, /* 0x0A .. 0x0B */
4631 "clear", /* VK_CLEAR 0x0C */
4632 "return", /* VK_RETURN 0x0D */
4634 0, 0, /* 0x0E .. 0x0F */
4636 0, /* VK_SHIFT 0x10 */
4637 0, /* VK_CONTROL 0x11 */
4638 0, /* VK_MENU 0x12 */
4639 "pause", /* VK_PAUSE 0x13 */
4640 "capslock", /* VK_CAPITAL 0x14 */
4641 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4643 "junja", /* VK_JUNJA 0x17 */
4644 "final", /* VK_FINAL 0x18 */
4645 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4647 "escape", /* VK_ESCAPE 0x1B */
4648 "convert", /* VK_CONVERT 0x1C */
4649 "non-convert", /* VK_NONCONVERT 0x1D */
4650 "accept", /* VK_ACCEPT 0x1E */
4651 "mode-change", /* VK_MODECHANGE 0x1F */
4652 0, /* VK_SPACE 0x20 */
4653 "prior", /* VK_PRIOR 0x21 */
4654 "next", /* VK_NEXT 0x22 */
4655 "end", /* VK_END 0x23 */
4656 "home", /* VK_HOME 0x24 */
4657 "left", /* VK_LEFT 0x25 */
4658 "up", /* VK_UP 0x26 */
4659 "right", /* VK_RIGHT 0x27 */
4660 "down", /* VK_DOWN 0x28 */
4661 "select", /* VK_SELECT 0x29 */
4662 "print", /* VK_PRINT 0x2A */
4663 "execute", /* VK_EXECUTE 0x2B */
4664 "snapshot", /* VK_SNAPSHOT 0x2C */
4665 "insert", /* VK_INSERT 0x2D */
4666 "delete", /* VK_DELETE 0x2E */
4667 "help", /* VK_HELP 0x2F */
4669 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4671 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4673 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4675 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4677 0, 0, 0, 0, 0, 0, 0, 0, 0,
4678 0, 0, 0, 0, 0, 0, 0, 0, 0,
4679 0, 0, 0, 0, 0, 0, 0, 0,
4681 "lwindow", /* VK_LWIN 0x5B */
4682 "rwindow", /* VK_RWIN 0x5C */
4683 "apps", /* VK_APPS 0x5D */
4686 "kp-0", /* VK_NUMPAD0 0x60 */
4687 "kp-1", /* VK_NUMPAD1 0x61 */
4688 "kp-2", /* VK_NUMPAD2 0x62 */
4689 "kp-3", /* VK_NUMPAD3 0x63 */
4690 "kp-4", /* VK_NUMPAD4 0x64 */
4691 "kp-5", /* VK_NUMPAD5 0x65 */
4692 "kp-6", /* VK_NUMPAD6 0x66 */
4693 "kp-7", /* VK_NUMPAD7 0x67 */
4694 "kp-8", /* VK_NUMPAD8 0x68 */
4695 "kp-9", /* VK_NUMPAD9 0x69 */
4696 "kp-multiply", /* VK_MULTIPLY 0x6A */
4697 "kp-add", /* VK_ADD 0x6B */
4698 "kp-separator", /* VK_SEPARATOR 0x6C */
4699 "kp-subtract", /* VK_SUBTRACT 0x6D */
4700 "kp-decimal", /* VK_DECIMAL 0x6E */
4701 "kp-divide", /* VK_DIVIDE 0x6F */
4702 "f1", /* VK_F1 0x70 */
4703 "f2", /* VK_F2 0x71 */
4704 "f3", /* VK_F3 0x72 */
4705 "f4", /* VK_F4 0x73 */
4706 "f5", /* VK_F5 0x74 */
4707 "f6", /* VK_F6 0x75 */
4708 "f7", /* VK_F7 0x76 */
4709 "f8", /* VK_F8 0x77 */
4710 "f9", /* VK_F9 0x78 */
4711 "f10", /* VK_F10 0x79 */
4712 "f11", /* VK_F11 0x7A */
4713 "f12", /* VK_F12 0x7B */
4714 "f13", /* VK_F13 0x7C */
4715 "f14", /* VK_F14 0x7D */
4716 "f15", /* VK_F15 0x7E */
4717 "f16", /* VK_F16 0x7F */
4718 "f17", /* VK_F17 0x80 */
4719 "f18", /* VK_F18 0x81 */
4720 "f19", /* VK_F19 0x82 */
4721 "f20", /* VK_F20 0x83 */
4722 "f21", /* VK_F21 0x84 */
4723 "f22", /* VK_F22 0x85 */
4724 "f23", /* VK_F23 0x86 */
4725 "f24", /* VK_F24 0x87 */
4727 0, 0, 0, 0, /* 0x88 .. 0x8B */
4728 0, 0, 0, 0, /* 0x8C .. 0x8F */
4730 "kp-numlock", /* VK_NUMLOCK 0x90 */
4731 "scroll", /* VK_SCROLL 0x91 */
4732 /* Not sure where the following block comes from.
4733 Windows headers have NEC and Fujitsu specific keys in
4734 this block, but nothing generic. */
4735 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4736 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4737 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4738 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4739 "kp-end", /* VK_NUMPAD_END 0x96 */
4740 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4741 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4742 "kp-up", /* VK_NUMPAD_UP 0x99 */
4743 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4744 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4745 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4746 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4748 0, 0, /* 0x9E .. 0x9F */
4751 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4752 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4753 * No other API or message will distinguish left and right keys this way.
4758 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4759 to enable them selectively, and gives access to a few more functions.
4760 See lispy_multimedia_keys below. */
4761 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4762 0, 0, 0, /* 0xAD .. 0xAF Volume */
4763 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4764 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4766 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4767 0, 0, 0, 0, 0, 0, 0, 0, 0,
4769 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4770 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4771 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4774 "ax", /* VK_OEM_AX 0xE1 */
4775 0, /* VK_OEM_102 0xE2 */
4776 "ico-help", /* VK_ICO_HELP 0xE3 */
4777 "ico-00", /* VK_ICO_00 0xE4 */
4778 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4779 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4780 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4782 "reset", /* VK_OEM_RESET 0xE9 */
4783 "jump", /* VK_OEM_JUMP 0xEA */
4784 "oem-pa1", /* VK_OEM_PA1 0xEB */
4785 "oem-pa2", /* VK_OEM_PA2 0xEC */
4786 "oem-pa3", /* VK_OEM_PA3 0xED */
4787 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4788 "cusel", /* VK_OEM_CUSEL 0xEF */
4789 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4790 "finish", /* VK_OEM_FINISH 0xF1 */
4791 "copy", /* VK_OEM_COPY 0xF2 */
4792 "auto", /* VK_OEM_AUTO 0xF3 */
4793 "enlw", /* VK_OEM_ENLW 0xF4 */
4794 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4795 "attn", /* VK_ATTN 0xF6 */
4796 "crsel", /* VK_CRSEL 0xF7 */
4797 "exsel", /* VK_EXSEL 0xF8 */
4798 "ereof", /* VK_EREOF 0xF9 */
4799 "play", /* VK_PLAY 0xFA */
4800 "zoom", /* VK_ZOOM 0xFB */
4801 "noname", /* VK_NONAME 0xFC */
4802 "pa1", /* VK_PA1 0xFD */
4803 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4807 /* Some of these duplicate the "Media keys" on newer keyboards,
4808 but they are delivered to the application in a different way. */
4809 static const char *const lispy_multimedia_keys
[] =
4817 "browser-favorites",
4854 "toggle-dictate-command",
4860 "media-fast-forward",
4863 "media-channel-down"
4866 #else /* not HAVE_NTGUI */
4868 /* This should be dealt with in XTread_socket now, and that doesn't
4869 depend on the client system having the Kana syms defined. See also
4870 the XK_kana_A case below. */
4873 static const char *const lispy_kana_keys
[] =
4875 /* X Keysym value */
4876 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4877 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4878 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4879 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4880 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4881 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4882 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4883 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4884 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4885 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4886 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4887 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4888 "kana-i", "kana-u", "kana-e", "kana-o",
4889 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4890 "prolongedsound", "kana-A", "kana-I", "kana-U",
4891 "kana-E", "kana-O", "kana-KA", "kana-KI",
4892 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4893 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4894 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4895 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4896 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4897 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4898 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4899 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4900 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4901 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4902 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4903 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4905 #endif /* XK_kana_A */
4908 #define FUNCTION_KEY_OFFSET 0xff00
4910 /* You'll notice that this table is arranged to be conveniently
4911 indexed by X Windows keysym values. */
4912 static const char *const lispy_function_keys
[] =
4914 /* X Keysym value */
4916 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4917 "backspace", "tab", "linefeed", "clear",
4919 0, 0, 0, "pause", /* 0xff10...1f */
4920 0, 0, 0, 0, 0, 0, 0, "escape",
4922 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4923 "romaji", "hiragana", "katakana", "hiragana-katakana",
4924 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4925 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4926 "eisu-toggle", /* 0xff30...3f */
4927 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4928 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4930 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4931 "down", "prior", "next", "end",
4932 "begin", 0, 0, 0, 0, 0, 0, 0,
4933 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4944 "break", /* 0xff6b */
4947 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4948 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4949 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4950 0, 0, 0, 0, 0, 0, 0, 0,
4951 "kp-tab", /* 0xff89 */
4953 "kp-enter", /* 0xff8d */
4955 "kp-f1", /* 0xff91 */
4959 "kp-home", /* 0xff95 */
4964 "kp-prior", /* kp-page-up */
4965 "kp-next", /* kp-page-down */
4971 0, 0, 0, 0, 0, 0, 0, 0, 0,
4972 "kp-multiply", /* 0xffaa */
4977 "kp-divide", /* 0xffaf */
4978 "kp-0", /* 0xffb0 */
4979 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4982 "kp-equal", /* 0xffbd */
4983 "f1", /* 0xffbe */ /* IsFunctionKey */
4985 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4986 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4987 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4988 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4989 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4990 0, 0, 0, 0, 0, 0, 0, 0,
4991 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4992 0, 0, 0, 0, 0, 0, 0, "delete"
4995 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4996 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4998 static const char *const iso_lispy_function_keys
[] =
5000 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5001 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5002 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5003 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5004 "iso-lefttab", /* 0xfe20 */
5005 "iso-move-line-up", "iso-move-line-down",
5006 "iso-partial-line-up", "iso-partial-line-down",
5007 "iso-partial-space-left", "iso-partial-space-right",
5008 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5009 "iso-release-margin-left", "iso-release-margin-right",
5010 "iso-release-both-margins",
5011 "iso-fast-cursor-left", "iso-fast-cursor-right",
5012 "iso-fast-cursor-up", "iso-fast-cursor-down",
5013 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5014 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5017 #endif /* not HAVE_NTGUI */
5019 Lisp_Object Vlispy_mouse_stem
;
5021 static const char *const lispy_wheel_names
[] =
5023 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5026 /* drag-n-drop events are generated when a set of selected files are
5027 dragged from another application and dropped onto an Emacs window. */
5028 static const char *const lispy_drag_n_drop_names
[] =
5033 /* Scroll bar parts. */
5034 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5035 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5036 Lisp_Object Qtop
, Qratio
;
5038 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5039 static Lisp_Object
*const scroll_bar_parts
[] = {
5040 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5041 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5044 /* A vector, indexed by button number, giving the down-going location
5045 of currently depressed buttons, both scroll bar and non-scroll bar.
5047 The elements have the form
5048 (BUTTON-NUMBER MODIFIER-MASK . REST)
5049 where REST is the cdr of a position as it would be reported in the event.
5051 The make_lispy_event function stores positions here to tell the
5052 difference between click and drag events, and to store the starting
5053 location to be included in drag events. */
5055 static Lisp_Object button_down_location
;
5057 /* Information about the most recent up-going button event: Which
5058 button, what location, and what time. */
5060 static int last_mouse_button
;
5061 static int last_mouse_x
;
5062 static int last_mouse_y
;
5063 static unsigned long button_down_time
;
5065 /* The number of clicks in this multiple-click. */
5067 int double_click_count
;
5069 /* X and Y are frame-relative coordinates for a click or wheel event.
5070 Return a Lisp-style event list. */
5073 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5076 enum window_part part
;
5077 Lisp_Object posn
= Qnil
;
5078 Lisp_Object extra_info
= Qnil
;
5079 /* Coordinate pixel positions to return. */
5080 int xret
= 0, yret
= 0;
5081 /* The window under frame pixel coordinates (x,y) */
5082 Lisp_Object window
= f
5083 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5086 if (WINDOWP (window
))
5088 /* It's a click in window window at frame coordinates (x,y) */
5089 struct window
*w
= XWINDOW (window
);
5090 Lisp_Object string_info
= Qnil
;
5091 EMACS_INT textpos
= -1;
5092 int col
= -1, row
= -1;
5093 int dx
= -1, dy
= -1;
5094 int width
= -1, height
= -1;
5095 Lisp_Object object
= Qnil
;
5097 /* Pixel coordinates relative to the window corner. */
5098 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5099 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5101 /* For text area clicks, return X, Y relative to the corner of
5102 this text area. Note that dX, dY etc are set below, by
5103 buffer_posn_from_coords. */
5104 if (part
== ON_TEXT
)
5106 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5107 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5109 /* For mode line and header line clicks, return X, Y relative to
5110 the left window edge. Use mode_line_string to look for a
5111 string on the click position. */
5112 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5117 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5118 /* Note that mode_line_string takes COL, ROW as pixels and
5119 converts them to characters. */
5122 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5123 &object
, &dx
, &dy
, &width
, &height
);
5124 if (STRINGP (string
))
5125 string_info
= Fcons (string
, make_number (charpos
));
5126 textpos
= (w
== XWINDOW (selected_window
)
5127 && current_buffer
== XBUFFER (w
->buffer
))
5128 ? PT
: XMARKER (w
->pointm
)->charpos
;
5133 /* For fringes and margins, Y is relative to the area's (and the
5134 window's) top edge, while X is meaningless. */
5135 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5140 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5143 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5144 &object
, &dx
, &dy
, &width
, &height
);
5145 if (STRINGP (string
))
5146 string_info
= Fcons (string
, make_number (charpos
));
5147 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5149 else if (part
== ON_LEFT_FRINGE
)
5151 posn
= Qleft_fringe
;
5154 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5155 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5156 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5158 else if (part
== ON_RIGHT_FRINGE
)
5160 posn
= Qright_fringe
;
5163 - window_box_width (w
, LEFT_MARGIN_AREA
)
5164 - window_box_width (w
, TEXT_AREA
)
5165 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5166 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5168 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5170 else if (part
== ON_VERTICAL_BORDER
)
5172 posn
= Qvertical_line
;
5177 /* Nothing special for part == ON_SCROLL_BAR. */
5179 /* For clicks in the text area, fringes, or margins, call
5180 buffer_posn_from_coords to extract TEXTPOS, the buffer
5181 position nearest to the click. */
5184 Lisp_Object string2
, object2
= Qnil
;
5185 struct display_pos p
;
5187 int width2
, height2
;
5188 /* The pixel X coordinate passed to buffer_posn_from_coords
5189 is the X coordinate relative to the text area for
5190 text-area and right-margin clicks, zero otherwise. */
5192 = (part
== ON_TEXT
) ? xret
5193 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5194 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5198 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5199 &object2
, &dx2
, &dy2
,
5201 textpos
= CHARPOS (p
.pos
);
5202 if (col
< 0) col
= x2
;
5203 if (row
< 0) row
= y2
;
5204 if (dx
< 0) dx
= dx2
;
5205 if (dy
< 0) dy
= dy2
;
5206 if (width
< 0) width
= width2
;
5207 if (height
< 0) height
= height2
;
5211 posn
= make_number (textpos
);
5212 if (STRINGP (string2
))
5213 string_info
= Fcons (string2
,
5214 make_number (CHARPOS (p
.string_pos
)));
5220 #ifdef HAVE_WINDOW_SYSTEM
5221 if (IMAGEP (object
))
5223 Lisp_Object image_map
, hotspot
;
5224 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5226 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5228 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5229 posn
= XCAR (hotspot
);
5236 Fcons (make_number (dx
), make_number (dy
)),
5237 Fcons (make_number (width
), make_number (height
)));
5240 extra_info
= Fcons (string_info
,
5241 Fcons (make_number (textpos
),
5242 Fcons (Fcons (make_number (col
),
5247 XSETFRAME (window
, f
);
5251 return Fcons (window
,
5253 Fcons (Fcons (make_number (xret
),
5254 make_number (yret
)),
5255 Fcons (make_number (t
),
5259 /* Given a struct input_event, build the lisp event which represents
5260 it. If EVENT is 0, build a mouse movement event from the mouse
5261 movement buffer, which should have a movement event in it.
5263 Note that events must be passed to this function in the order they
5264 are received; this function stores the location of button presses
5265 in order to build drag events when the button is released. */
5268 make_lispy_event (struct input_event
*event
)
5272 switch (SWITCH_ENUM_CAST (event
->kind
))
5274 /* A simple keystroke. */
5275 case ASCII_KEYSTROKE_EVENT
:
5276 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5278 Lisp_Object lispy_c
;
5279 EMACS_INT c
= event
->code
;
5280 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5283 eassert (c
== event
->code
);
5284 /* Turn ASCII characters into control characters
5286 if (event
->modifiers
& ctrl_modifier
)
5288 c
= make_ctrl_char (c
);
5289 event
->modifiers
&= ~ctrl_modifier
;
5293 /* Add in the other modifier bits. The shift key was taken care
5294 of by the X code. */
5295 c
|= (event
->modifiers
5296 & (meta_modifier
| alt_modifier
5297 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5298 /* Distinguish Shift-SPC from SPC. */
5299 if ((event
->code
) == 040
5300 && event
->modifiers
& shift_modifier
)
5301 c
|= shift_modifier
;
5302 button_down_time
= 0;
5303 XSETFASTINT (lispy_c
, c
);
5308 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5309 except that they are non-key events (last-nonmenu-event is nil). */
5310 case NS_NONKEY_EVENT
:
5313 /* A function key. The symbol may need to have modifier prefixes
5315 case NON_ASCII_KEYSTROKE_EVENT
:
5316 button_down_time
= 0;
5318 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5319 if (event
->code
== lispy_accent_codes
[i
])
5320 return modify_event_symbol (i
,
5322 Qfunction_key
, Qnil
,
5323 lispy_accent_keys
, &accent_key_syms
,
5324 (sizeof (lispy_accent_keys
)
5325 / sizeof (lispy_accent_keys
[0])));
5329 if (event
->code
>= 0x400 && event
->code
< 0x500)
5330 return modify_event_symbol (event
->code
- 0x400,
5331 event
->modifiers
& ~shift_modifier
,
5332 Qfunction_key
, Qnil
,
5333 lispy_kana_keys
, &func_key_syms
,
5334 (sizeof (lispy_kana_keys
)
5335 / sizeof (lispy_kana_keys
[0])));
5336 #endif /* XK_kana_A */
5339 #ifdef ISO_FUNCTION_KEY_OFFSET
5340 if (event
->code
< FUNCTION_KEY_OFFSET
5341 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5342 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5344 Qfunction_key
, Qnil
,
5345 iso_lispy_function_keys
, &func_key_syms
,
5346 (sizeof (iso_lispy_function_keys
)
5347 / sizeof (iso_lispy_function_keys
[0])));
5350 /* Handle system-specific or unknown keysyms. */
5351 if (event
->code
& (1 << 28)
5352 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5353 || (event
->code
- FUNCTION_KEY_OFFSET
5354 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5355 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5357 /* We need to use an alist rather than a vector as the cache
5358 since we can't make a vector long enuf. */
5359 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5360 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5361 return modify_event_symbol (event
->code
,
5364 KVAR (current_kboard
, Vsystem_key_alist
),
5365 0, &KVAR (current_kboard
, system_key_syms
),
5369 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5371 Qfunction_key
, Qnil
,
5372 lispy_function_keys
, &func_key_syms
,
5373 (sizeof (lispy_function_keys
)
5374 / sizeof (lispy_function_keys
[0])));
5377 case MULTIMEDIA_KEY_EVENT
:
5378 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5379 / sizeof (lispy_multimedia_keys
[0]))
5380 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5382 return modify_event_symbol (event
->code
, event
->modifiers
,
5383 Qfunction_key
, Qnil
,
5384 lispy_multimedia_keys
, &func_key_syms
,
5385 (sizeof (lispy_multimedia_keys
)
5386 / sizeof (lispy_multimedia_keys
[0])));
5392 /* A mouse click. Figure out where it is, decide whether it's
5393 a press, click or drag, and build the appropriate structure. */
5394 case MOUSE_CLICK_EVENT
:
5395 #ifndef USE_TOOLKIT_SCROLL_BARS
5396 case SCROLL_BAR_CLICK_EVENT
:
5399 int button
= event
->code
;
5401 Lisp_Object position
;
5402 Lisp_Object
*start_pos_ptr
;
5403 Lisp_Object start_pos
;
5407 /* Build the position as appropriate for this mouse click. */
5408 if (event
->kind
== MOUSE_CLICK_EVENT
)
5410 struct frame
*f
= XFRAME (event
->frame_or_window
);
5411 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5415 /* Ignore mouse events that were made on frame that
5416 have been deleted. */
5417 if (! FRAME_LIVE_P (f
))
5420 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5421 /* EVENT->x and EVENT->y are frame-relative pixel
5422 coordinates at this place. Under old redisplay, COLUMN
5423 and ROW are set to frame relative glyph coordinates
5424 which are then used to determine whether this click is
5425 in a menu (non-toolkit version). */
5426 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5427 &column
, &row
, NULL
, 1);
5429 /* In the non-toolkit version, clicks on the menu bar
5430 are ordinary button events in the event buffer.
5431 Distinguish them, and invoke the menu.
5433 (In the toolkit version, the toolkit handles the menu bar
5434 and Emacs doesn't know about it until after the user
5435 makes a selection.) */
5436 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5437 && (event
->modifiers
& down_modifier
))
5439 Lisp_Object items
, item
;
5442 /* Find the menu bar item under `column'. */
5444 items
= FRAME_MENU_BAR_ITEMS (f
);
5445 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5447 Lisp_Object pos
, string
;
5448 string
= AREF (items
, i
+ 1);
5449 pos
= AREF (items
, i
+ 3);
5452 if (column
>= XINT (pos
)
5453 && column
< XINT (pos
) + SCHARS (string
))
5455 item
= AREF (items
, i
);
5460 /* ELisp manual 2.4b says (x y) are window relative but
5461 code says they are frame-relative. */
5463 = Fcons (event
->frame_or_window
,
5465 Fcons (Fcons (event
->x
, event
->y
),
5466 Fcons (make_number (event
->timestamp
),
5469 return Fcons (item
, Fcons (position
, Qnil
));
5471 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5473 position
= make_lispy_position (f
, event
->x
, event
->y
,
5476 #ifndef USE_TOOLKIT_SCROLL_BARS
5479 /* It's a scrollbar click. */
5481 Lisp_Object portion_whole
;
5484 window
= event
->frame_or_window
;
5485 portion_whole
= Fcons (event
->x
, event
->y
);
5486 part
= *scroll_bar_parts
[(int) event
->part
];
5490 Fcons (Qvertical_scroll_bar
,
5491 Fcons (portion_whole
,
5492 Fcons (make_number (event
->timestamp
),
5493 Fcons (part
, Qnil
)))));
5495 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5497 if (button
>= ASIZE (button_down_location
))
5499 button_down_location
= larger_vector (button_down_location
,
5501 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5504 start_pos_ptr
= &AREF (button_down_location
, button
);
5505 start_pos
= *start_pos_ptr
;
5506 *start_pos_ptr
= Qnil
;
5509 /* On window-system frames, use the value of
5510 double-click-fuzz as is. On other frames, interpret it
5511 as a multiple of 1/8 characters. */
5515 if (WINDOWP (event
->frame_or_window
))
5516 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5517 else if (FRAMEP (event
->frame_or_window
))
5518 f
= XFRAME (event
->frame_or_window
);
5522 if (FRAME_WINDOW_P (f
))
5523 fuzz
= double_click_fuzz
;
5525 fuzz
= double_click_fuzz
/ 8;
5527 is_double
= (button
== last_mouse_button
5528 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5529 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5530 && button_down_time
!= 0
5531 && (EQ (Vdouble_click_time
, Qt
)
5532 || (INTEGERP (Vdouble_click_time
)
5533 && ((int)(event
->timestamp
- button_down_time
)
5534 < XINT (Vdouble_click_time
)))));
5537 last_mouse_button
= button
;
5538 last_mouse_x
= XINT (event
->x
);
5539 last_mouse_y
= XINT (event
->y
);
5541 /* If this is a button press, squirrel away the location, so
5542 we can decide later whether it was a click or a drag. */
5543 if (event
->modifiers
& down_modifier
)
5547 double_click_count
++;
5548 event
->modifiers
|= ((double_click_count
> 2)
5553 double_click_count
= 1;
5554 button_down_time
= event
->timestamp
;
5555 *start_pos_ptr
= Fcopy_alist (position
);
5556 ignore_mouse_drag_p
= 0;
5559 /* Now we're releasing a button - check the co-ordinates to
5560 see if this was a click or a drag. */
5561 else if (event
->modifiers
& up_modifier
)
5563 /* If we did not see a down before this up, ignore the up.
5564 Probably this happened because the down event chose a
5565 menu item. It would be an annoyance to treat the
5566 release of the button that chose the menu item as a
5569 if (!CONSP (start_pos
))
5572 event
->modifiers
&= ~up_modifier
;
5575 Lisp_Object new_down
, down
;
5576 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5578 /* The third element of every position
5579 should be the (x,y) pair. */
5580 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5581 new_down
= Fcar (Fcdr (Fcdr (position
)));
5584 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5586 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5587 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5590 if (ignore_mouse_drag_p
)
5592 event
->modifiers
|= click_modifier
;
5593 ignore_mouse_drag_p
= 0;
5595 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5596 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5597 /* Maybe the mouse has moved a lot, caused scrolling, and
5598 eventually ended up at the same screen position (but
5599 not buffer position) in which case it is a drag, not
5601 /* FIXME: OTOH if the buffer position has changed
5602 because of a timer or process filter rather than
5603 because of mouse movement, it should be considered as
5604 a click. But mouse-drag-region completely ignores
5605 this case and it hasn't caused any real problem, so
5606 it's probably OK to ignore it as well. */
5607 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5608 /* Mouse hasn't moved (much). */
5609 event
->modifiers
|= click_modifier
;
5612 button_down_time
= 0;
5613 event
->modifiers
|= drag_modifier
;
5616 /* Don't check is_double; treat this as multiple
5617 if the down-event was multiple. */
5618 if (double_click_count
> 1)
5619 event
->modifiers
|= ((double_click_count
> 2)
5625 /* Every mouse event should either have the down_modifier or
5626 the up_modifier set. */
5630 /* Get the symbol we should use for the mouse click. */
5633 head
= modify_event_symbol (button
,
5635 Qmouse_click
, Vlispy_mouse_stem
,
5638 XVECTOR (mouse_syms
)->size
);
5639 if (event
->modifiers
& drag_modifier
)
5644 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5647 Fcons (make_number (double_click_count
),
5657 case HORIZ_WHEEL_EVENT
:
5659 Lisp_Object position
;
5662 /* Build the position as appropriate for this mouse click. */
5663 struct frame
*f
= XFRAME (event
->frame_or_window
);
5665 /* Ignore wheel events that were made on frame that have been
5667 if (! FRAME_LIVE_P (f
))
5670 position
= make_lispy_position (f
, event
->x
, event
->y
,
5673 /* Set double or triple modifiers to indicate the wheel speed. */
5675 /* On window-system frames, use the value of
5676 double-click-fuzz as is. On other frames, interpret it
5677 as a multiple of 1/8 characters. */
5683 if (WINDOWP (event
->frame_or_window
))
5684 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5685 else if (FRAMEP (event
->frame_or_window
))
5686 fr
= XFRAME (event
->frame_or_window
);
5690 fuzz
= FRAME_WINDOW_P (fr
)
5691 ? double_click_fuzz
: double_click_fuzz
/ 8;
5693 if (event
->modifiers
& up_modifier
)
5695 /* Emit a wheel-up event. */
5696 event
->modifiers
&= ~up_modifier
;
5699 else if (event
->modifiers
& down_modifier
)
5701 /* Emit a wheel-down event. */
5702 event
->modifiers
&= ~down_modifier
;
5706 /* Every wheel event should either have the down_modifier or
5707 the up_modifier set. */
5710 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5713 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5714 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5715 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5716 && button_down_time
!= 0
5717 && (EQ (Vdouble_click_time
, Qt
)
5718 || (INTEGERP (Vdouble_click_time
)
5719 && ((int)(event
->timestamp
- button_down_time
)
5720 < XINT (Vdouble_click_time
)))));
5723 double_click_count
++;
5724 event
->modifiers
|= ((double_click_count
> 2)
5730 double_click_count
= 1;
5731 event
->modifiers
|= click_modifier
;
5734 button_down_time
= event
->timestamp
;
5735 /* Use a negative value to distinguish wheel from mouse button. */
5736 last_mouse_button
= - (1 + symbol_num
);
5737 last_mouse_x
= XINT (event
->x
);
5738 last_mouse_y
= XINT (event
->y
);
5740 /* Get the symbol we should use for the wheel event. */
5741 head
= modify_event_symbol (symbol_num
,
5747 ASIZE (wheel_syms
));
5750 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5753 Fcons (make_number (double_click_count
),
5762 #ifdef USE_TOOLKIT_SCROLL_BARS
5764 /* We don't have down and up events if using toolkit scroll bars,
5765 so make this always a click event. Store in the `part' of
5766 the Lisp event a symbol which maps to the following actions:
5768 `above_handle' page up
5769 `below_handle' page down
5773 `bottom' bottom of buffer
5774 `handle' thumb has been dragged.
5775 `end-scroll' end of interaction with scroll bar
5777 The incoming input_event contains in its `part' member an
5778 index of type `enum scroll_bar_part' which we can use as an
5779 index in scroll_bar_parts to get the appropriate symbol. */
5781 case SCROLL_BAR_CLICK_EVENT
:
5783 Lisp_Object position
, head
, window
, portion_whole
, part
;
5785 window
= event
->frame_or_window
;
5786 portion_whole
= Fcons (event
->x
, event
->y
);
5787 part
= *scroll_bar_parts
[(int) event
->part
];
5791 Fcons (Qvertical_scroll_bar
,
5792 Fcons (portion_whole
,
5793 Fcons (make_number (event
->timestamp
),
5794 Fcons (part
, Qnil
)))));
5796 /* Always treat scroll bar events as clicks. */
5797 event
->modifiers
|= click_modifier
;
5798 event
->modifiers
&= ~up_modifier
;
5800 if (event
->code
>= ASIZE (mouse_syms
))
5801 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5803 /* Get the symbol we should use for the mouse click. */
5804 head
= modify_event_symbol (event
->code
,
5809 XVECTOR (mouse_syms
)->size
);
5810 return Fcons (head
, Fcons (position
, Qnil
));
5813 #endif /* USE_TOOLKIT_SCROLL_BARS */
5815 case DRAG_N_DROP_EVENT
:
5818 Lisp_Object head
, position
;
5821 f
= XFRAME (event
->frame_or_window
);
5824 /* Ignore mouse events that were made on frames that
5825 have been deleted. */
5826 if (! FRAME_LIVE_P (f
))
5829 position
= make_lispy_position (f
, event
->x
, event
->y
,
5832 head
= modify_event_symbol (0, event
->modifiers
,
5834 lispy_drag_n_drop_names
,
5835 &drag_n_drop_syms
, 1);
5841 #endif /* HAVE_MOUSE */
5843 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5844 || defined(HAVE_NS) || defined (USE_GTK)
5845 case MENU_BAR_EVENT
:
5846 if (EQ (event
->arg
, event
->frame_or_window
))
5847 /* This is the prefix key. We translate this to
5848 `(menu_bar)' because the code in keyboard.c for menu
5849 events, which we use, relies on this. */
5850 return Fcons (Qmenu_bar
, Qnil
);
5854 case SELECT_WINDOW_EVENT
:
5855 /* Make an event (select-window (WINDOW)). */
5856 return Fcons (Qselect_window
,
5857 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5860 case TOOL_BAR_EVENT
:
5861 if (EQ (event
->arg
, event
->frame_or_window
))
5862 /* This is the prefix key. We translate this to
5863 `(tool_bar)' because the code in keyboard.c for tool bar
5864 events, which we use, relies on this. */
5865 return Fcons (Qtool_bar
, Qnil
);
5866 else if (SYMBOLP (event
->arg
))
5867 return apply_modifiers (event
->modifiers
, event
->arg
);
5870 case USER_SIGNAL_EVENT
:
5871 /* A user signal. */
5873 char *name
= find_user_signal_name (event
->code
);
5876 return intern (name
);
5879 case SAVE_SESSION_EVENT
:
5880 return Qsave_session
;
5885 return Fcons (Qdbus_event
, event
->arg
);
5887 #endif /* HAVE_DBUS */
5889 case CONFIG_CHANGED_EVENT
:
5890 return Fcons (Qconfig_changed_event
,
5892 Fcons (event
->frame_or_window
, Qnil
)));
5894 case GPM_CLICK_EVENT
:
5896 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5897 Lisp_Object head
, position
;
5898 Lisp_Object
*start_pos_ptr
;
5899 Lisp_Object start_pos
;
5900 int button
= event
->code
;
5902 if (button
>= ASIZE (button_down_location
))
5904 button_down_location
= larger_vector (button_down_location
,
5906 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5909 start_pos_ptr
= &AREF (button_down_location
, button
);
5910 start_pos
= *start_pos_ptr
;
5912 position
= make_lispy_position (f
, event
->x
, event
->y
,
5915 if (event
->modifiers
& down_modifier
)
5916 *start_pos_ptr
= Fcopy_alist (position
);
5917 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5919 if (!CONSP (start_pos
))
5921 event
->modifiers
&= ~up_modifier
;
5924 head
= modify_event_symbol (button
,
5926 Qmouse_click
, Vlispy_mouse_stem
,
5929 XVECTOR (mouse_syms
)->size
);
5931 if (event
->modifiers
& drag_modifier
)
5936 else if (event
->modifiers
& double_modifier
)
5939 Fcons (make_number (2),
5941 else if (event
->modifiers
& triple_modifier
)
5944 Fcons (make_number (3),
5951 #endif /* HAVE_GPM */
5953 /* The 'kind' field of the event is something we don't recognize. */
5959 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
5962 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5963 Lisp_Object x
, Lisp_Object y
, unsigned long t
)
5965 /* Is it a scroll bar movement? */
5966 if (frame
&& ! NILP (bar_window
))
5968 Lisp_Object part_sym
;
5970 part_sym
= *scroll_bar_parts
[(int) part
];
5971 return Fcons (Qscroll_bar_movement
,
5972 Fcons (list5 (bar_window
,
5973 Qvertical_scroll_bar
,
5979 /* Or is it an ordinary mouse movement? */
5982 Lisp_Object position
;
5983 position
= make_lispy_position (frame
, x
, y
, t
);
5984 return list2 (Qmouse_movement
, position
);
5988 #endif /* HAVE_MOUSE || HAVE GPM */
5990 /* Construct a switch frame event. */
5992 make_lispy_switch_frame (Lisp_Object frame
)
5994 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5997 /* Manipulating modifiers. */
5999 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6001 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6002 SYMBOL's name of the end of the modifiers; the string from this
6003 position is the unmodified symbol name.
6005 This doesn't use any caches. */
6008 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6014 CHECK_SYMBOL (symbol
);
6017 name
= SYMBOL_NAME (symbol
);
6019 for (i
= 0; i
+2 <= SBYTES (name
); )
6021 EMACS_INT this_mod_end
= 0;
6024 /* See if the name continues with a modifier word.
6025 Check that the word appears, but don't check what follows it.
6026 Set this_mod and this_mod_end to record what we find. */
6028 switch (SREF (name
, i
))
6030 #define SINGLE_LETTER_MOD(BIT) \
6031 (this_mod_end = i + 1, this_mod = BIT)
6034 SINGLE_LETTER_MOD (alt_modifier
);
6038 SINGLE_LETTER_MOD (ctrl_modifier
);
6042 SINGLE_LETTER_MOD (hyper_modifier
);
6046 SINGLE_LETTER_MOD (meta_modifier
);
6050 SINGLE_LETTER_MOD (shift_modifier
);
6054 SINGLE_LETTER_MOD (super_modifier
);
6057 #undef SINGLE_LETTER_MOD
6059 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6060 if (i + LEN + 1 <= SBYTES (name) \
6061 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6063 this_mod_end = i + LEN; \
6068 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6069 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6070 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6074 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6076 #undef MULTI_LETTER_MOD
6080 /* If we found no modifier, stop looking for them. */
6081 if (this_mod_end
== 0)
6084 /* Check there is a dash after the modifier, so that it
6085 really is a modifier. */
6086 if (this_mod_end
>= SBYTES (name
)
6087 || SREF (name
, this_mod_end
) != '-')
6090 /* This modifier is real; look for another. */
6091 modifiers
|= this_mod
;
6092 i
= this_mod_end
+ 1;
6095 /* Should we include the `click' modifier? */
6096 if (! (modifiers
& (down_modifier
| drag_modifier
6097 | double_modifier
| triple_modifier
))
6098 && i
+ 7 == SBYTES (name
)
6099 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6100 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6101 modifiers
|= click_modifier
;
6103 if (! (modifiers
& (double_modifier
| triple_modifier
))
6104 && i
+ 6 < SBYTES (name
)
6105 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6106 modifiers
|= click_modifier
;
6114 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6115 prepended to the string BASE[0..BASE_LEN-1].
6116 This doesn't use any caches. */
6118 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6120 /* Since BASE could contain nulls, we can't use intern here; we have
6121 to use Fintern, which expects a genuine Lisp_String, and keeps a
6124 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6130 /* Only the event queue may use the `up' modifier; it should always
6131 be turned into a click or drag event before presented to lisp code. */
6132 if (modifiers
& up_modifier
)
6135 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6136 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6137 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6138 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6139 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6140 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6141 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6142 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6143 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6144 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6145 /* The click modifier is denoted by the absence of other modifiers. */
6149 mod_len
= p
- new_mods
;
6153 Lisp_Object new_name
;
6155 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6156 mod_len
+ base_len_byte
);
6157 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6158 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6160 return Fintern (new_name
, Qnil
);
6165 static const char *const modifier_names
[] =
6167 "up", "down", "drag", "click", "double", "triple", 0, 0,
6168 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6169 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6171 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6173 static Lisp_Object modifier_symbols
;
6175 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6177 lispy_modifier_list (int modifiers
)
6179 Lisp_Object modifier_list
;
6182 modifier_list
= Qnil
;
6183 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6184 if (modifiers
& (1<<i
))
6185 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6188 return modifier_list
;
6192 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6193 where UNMODIFIED is the unmodified form of SYMBOL,
6194 MASK is the set of modifiers present in SYMBOL's name.
6195 This is similar to parse_modifiers_uncached, but uses the cache in
6196 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6197 Qevent_symbol_elements property. */
6199 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6202 parse_modifiers (Lisp_Object symbol
)
6204 Lisp_Object elements
;
6206 if (INTEGERP (symbol
))
6207 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6208 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6210 else if (!SYMBOLP (symbol
))
6213 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6214 if (CONSP (elements
))
6219 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6220 Lisp_Object unmodified
;
6223 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6224 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6227 if (modifiers
& ~INTMASK
)
6229 XSETFASTINT (mask
, modifiers
);
6230 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6232 /* Cache the parsing results on SYMBOL. */
6233 Fput (symbol
, Qevent_symbol_element_mask
,
6235 Fput (symbol
, Qevent_symbol_elements
,
6236 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6238 /* Since we know that SYMBOL is modifiers applied to unmodified,
6239 it would be nice to put that in unmodified's cache.
6240 But we can't, since we're not sure that parse_modifiers is
6247 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6248 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6249 doc
: /* Parse the event symbol. For internal use. */)
6250 (Lisp_Object symbol
)
6252 /* Fill the cache if needed. */
6253 parse_modifiers (symbol
);
6254 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6255 and use the Lispier representation stored on Qevent_symbol_elements
6257 return Fget (symbol
, Qevent_symbol_elements
);
6260 /* Apply the modifiers MODIFIERS to the symbol BASE.
6261 BASE must be unmodified.
6263 This is like apply_modifiers_uncached, but uses BASE's
6264 Qmodifier_cache property, if present. It also builds
6265 Qevent_symbol_elements properties, since it has that info anyway.
6267 apply_modifiers copies the value of BASE's Qevent_kind property to
6268 the modified symbol. */
6270 apply_modifiers (int modifiers
, Lisp_Object base
)
6272 Lisp_Object cache
, idx
, entry
, new_symbol
;
6274 /* Mask out upper bits. We don't know where this value's been. */
6275 modifiers
&= INTMASK
;
6277 if (INTEGERP (base
))
6278 return make_number (XINT (base
) | modifiers
);
6280 /* The click modifier never figures into cache indices. */
6281 cache
= Fget (base
, Qmodifier_cache
);
6282 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6283 entry
= assq_no_quit (idx
, cache
);
6286 new_symbol
= XCDR (entry
);
6289 /* We have to create the symbol ourselves. */
6290 new_symbol
= apply_modifiers_uncached (modifiers
,
6291 SSDATA (SYMBOL_NAME (base
)),
6292 SCHARS (SYMBOL_NAME (base
)),
6293 SBYTES (SYMBOL_NAME (base
)));
6295 /* Add the new symbol to the base's cache. */
6296 entry
= Fcons (idx
, new_symbol
);
6297 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6299 /* We have the parsing info now for free, so we could add it to
6301 XSETFASTINT (idx, modifiers);
6302 Fput (new_symbol, Qevent_symbol_element_mask,
6303 Fcons (base, Fcons (idx, Qnil)));
6304 Fput (new_symbol, Qevent_symbol_elements,
6305 Fcons (base, lispy_modifier_list (modifiers)));
6306 Sadly, this is only correct if `base' is indeed a base event,
6307 which is not necessarily the case. -stef */
6310 /* Make sure this symbol is of the same kind as BASE.
6312 You'd think we could just set this once and for all when we
6313 intern the symbol above, but reorder_modifiers may call us when
6314 BASE's property isn't set right; we can't assume that just
6315 because it has a Qmodifier_cache property it must have its
6316 Qevent_kind set right as well. */
6317 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6321 kind
= Fget (base
, Qevent_kind
);
6323 Fput (new_symbol
, Qevent_kind
, kind
);
6330 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6331 return a symbol with the modifiers placed in the canonical order.
6332 Canonical order is alphabetical, except for down and drag, which
6333 always come last. The 'click' modifier is never written out.
6335 Fdefine_key calls this to make sure that (for example) C-M-foo
6336 and M-C-foo end up being equivalent in the keymap. */
6339 reorder_modifiers (Lisp_Object symbol
)
6341 /* It's hopefully okay to write the code this way, since everything
6342 will soon be in caches, and no consing will be done at all. */
6345 parsed
= parse_modifiers (symbol
);
6346 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6351 /* For handling events, we often want to produce a symbol whose name
6352 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6353 to some base, like the name of a function key or mouse button.
6354 modify_event_symbol produces symbols of this sort.
6356 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6357 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6360 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6361 into symbol names, or a string specifying a name stem used to
6362 construct a symbol name or the form `STEM-N', where N is the decimal
6363 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6364 non-nil; otherwise NAME_TABLE is used.
6366 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6367 persist between calls to modify_event_symbol that it can use to
6368 store a cache of the symbols it's generated for this NAME_TABLE
6369 before. The object stored there may be a vector or an alist.
6371 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6373 MODIFIERS is a set of modifier bits (as given in struct input_events)
6374 whose prefixes should be applied to the symbol name.
6376 SYMBOL_KIND is the value to be placed in the event_kind property of
6377 the returned symbol.
6379 The symbols we create are supposed to have an
6380 `event-symbol-elements' property, which lists the modifiers present
6381 in the symbol's name. */
6384 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6385 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6386 Lisp_Object
*symbol_table
, unsigned int table_size
)
6389 Lisp_Object symbol_int
;
6391 /* Get rid of the "vendor-specific" bit here. */
6392 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6394 /* Is this a request for a valid symbol? */
6395 if (symbol_num
< 0 || symbol_num
>= table_size
)
6398 if (CONSP (*symbol_table
))
6399 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6401 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6402 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6403 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6404 we've never used that symbol before. */
6407 if (! VECTORP (*symbol_table
)
6408 || XVECTOR (*symbol_table
)->size
!= table_size
)
6412 XSETFASTINT (size
, table_size
);
6413 *symbol_table
= Fmake_vector (size
, Qnil
);
6416 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6419 /* Have we already used this symbol before? */
6422 /* No; let's create it. */
6423 if (CONSP (name_alist_or_stem
))
6424 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6425 else if (STRINGP (name_alist_or_stem
))
6427 int len
= SBYTES (name_alist_or_stem
);
6428 char *buf
= (char *) alloca (len
+ 50);
6429 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6430 (long) XINT (symbol_int
) + 1);
6431 value
= intern (buf
);
6433 else if (name_table
!= 0 && name_table
[symbol_num
])
6434 value
= intern (name_table
[symbol_num
]);
6436 #ifdef HAVE_WINDOW_SYSTEM
6439 char *name
= x_get_keysym_name (symbol_num
);
6441 value
= intern (name
);
6448 sprintf (buf
, "key-%ld", (long)symbol_num
);
6449 value
= intern (buf
);
6452 if (CONSP (*symbol_table
))
6453 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6455 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6457 /* Fill in the cache entries for this symbol; this also
6458 builds the Qevent_symbol_elements property, which the user
6460 apply_modifiers (modifiers
& click_modifier
, value
);
6461 Fput (value
, Qevent_kind
, symbol_kind
);
6464 /* Apply modifiers to that symbol. */
6465 return apply_modifiers (modifiers
, value
);
6468 /* Convert a list that represents an event type,
6469 such as (ctrl meta backspace), into the usual representation of that
6470 event type as a number or a symbol. */
6472 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6473 doc
: /* Convert the event description list EVENT-DESC to an event type.
6474 EVENT-DESC should contain one base event type (a character or symbol)
6475 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6476 drag, down, double or triple). The base must be last.
6477 The return value is an event type (a character or symbol) which
6478 has the same base event type and all the specified modifiers. */)
6479 (Lisp_Object event_desc
)
6487 while (CONSP (rest
))
6495 /* Given a symbol, see if it is a modifier name. */
6496 if (SYMBOLP (elt
) && CONSP (rest
))
6497 this = parse_solitary_modifier (elt
);
6501 else if (!NILP (base
))
6502 error ("Two bases given in one event");
6508 /* Let the symbol A refer to the character A. */
6509 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6510 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6512 if (INTEGERP (base
))
6514 /* Turn (shift a) into A. */
6515 if ((modifiers
& shift_modifier
) != 0
6516 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6518 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6519 modifiers
&= ~shift_modifier
;
6522 /* Turn (control a) into C-a. */
6523 if (modifiers
& ctrl_modifier
)
6524 return make_number ((modifiers
& ~ctrl_modifier
)
6525 | make_ctrl_char (XINT (base
)));
6527 return make_number (modifiers
| XINT (base
));
6529 else if (SYMBOLP (base
))
6530 return apply_modifiers (modifiers
, base
);
6533 error ("Invalid base event");
6538 /* Try to recognize SYMBOL as a modifier name.
6539 Return the modifier flag bit, or 0 if not recognized. */
6542 parse_solitary_modifier (Lisp_Object symbol
)
6544 Lisp_Object name
= SYMBOL_NAME (symbol
);
6546 switch (SREF (name
, 0))
6548 #define SINGLE_LETTER_MOD(BIT) \
6549 if (SBYTES (name) == 1) \
6552 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6553 if (LEN == SBYTES (name) \
6554 && ! strncmp (SSDATA (name), NAME, LEN)) \
6558 SINGLE_LETTER_MOD (alt_modifier
);
6562 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6566 SINGLE_LETTER_MOD (ctrl_modifier
);
6570 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6571 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6575 SINGLE_LETTER_MOD (hyper_modifier
);
6579 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6583 SINGLE_LETTER_MOD (meta_modifier
);
6587 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6591 SINGLE_LETTER_MOD (shift_modifier
);
6595 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6596 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6597 SINGLE_LETTER_MOD (super_modifier
);
6601 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6602 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6603 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6607 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6610 #undef SINGLE_LETTER_MOD
6611 #undef MULTI_LETTER_MOD
6617 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6618 Such a list is not valid as an event,
6619 but it can be a Lucid-style event type list. */
6622 lucid_event_type_list_p (Lisp_Object object
)
6626 if (! CONSP (object
))
6629 if (EQ (XCAR (object
), Qhelp_echo
)
6630 || EQ (XCAR (object
), Qvertical_line
)
6631 || EQ (XCAR (object
), Qmode_line
)
6632 || EQ (XCAR (object
), Qheader_line
))
6635 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6639 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6646 /* Store into *addr a value nonzero if terminal input chars are available.
6647 Serves the purpose of ioctl (0, FIONREAD, addr)
6648 but works even if FIONREAD does not exist.
6649 (In fact, this may actually read some input.)
6651 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6652 timer events that are ripe.
6653 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6654 events (FOCUS_IN_EVENT).
6655 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6656 movements and toolkit scroll bar thumb drags. */
6659 get_input_pending (int *addr
, int flags
)
6661 /* First of all, have we already counted some input? */
6662 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6664 /* If input is being read as it arrives, and we have none, there is none. */
6665 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6668 /* Try to read some input and see how much we get. */
6670 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6673 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6676 gobble_input (int expected
)
6679 if (interrupt_input
)
6682 mask
= sigblock (sigmask (SIGIO
));
6683 read_avail_input (expected
);
6687 #ifdef POLL_FOR_INPUT
6688 /* XXX This condition was (read_socket_hook && !interrupt_input),
6689 but read_socket_hook is not global anymore. Let's pretend that
6691 if (!interrupt_input
&& poll_suppress_count
== 0)
6694 mask
= sigblock (sigmask (SIGALRM
));
6695 read_avail_input (expected
);
6701 read_avail_input (expected
);
6704 /* Put a BUFFER_SWITCH_EVENT in the buffer
6705 so that read_key_sequence will notice the new current buffer. */
6708 record_asynch_buffer_change (void)
6710 struct input_event event
;
6714 event
.kind
= BUFFER_SWITCH_EVENT
;
6715 event
.frame_or_window
= Qnil
;
6718 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6719 The purpose of the event is to make read_key_sequence look up the
6720 keymaps again. If we aren't in read_key_sequence, we don't need one,
6721 and the event could cause trouble by messing up (input-pending-p).
6722 Note: Fwaiting_for_user_input_p always returns nil when async
6723 subprocesses aren't supported. */
6724 tem
= Fwaiting_for_user_input_p ();
6728 /* Make sure no interrupt happens while storing the event. */
6730 if (interrupt_input
)
6733 mask
= sigblock (sigmask (SIGIO
));
6734 kbd_buffer_store_event (&event
);
6741 kbd_buffer_store_event (&event
);
6746 /* Read any terminal input already buffered up by the system
6747 into the kbd_buffer, but do not wait.
6749 EXPECTED should be nonzero if the caller knows there is some input.
6751 Returns the number of keyboard chars read, or -1 meaning
6752 this is a bad time to try to read input. */
6755 read_avail_input (int expected
)
6761 /* Store pending user signal events, if any. */
6762 if (store_user_signal_events ())
6765 /* Loop through the available terminals, and call their input hooks. */
6769 struct terminal
*next
= t
->next_terminal
;
6771 if (t
->read_socket_hook
)
6774 struct input_event hold_quit
;
6776 EVENT_INIT (hold_quit
);
6777 hold_quit
.kind
= NO_EVENT
;
6779 /* No need for FIONREAD or fcntl; just say don't wait. */
6780 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6786 if (nr
== -1) /* Not OK to read input now. */
6790 else if (nr
== -2) /* Non-transient error. */
6792 /* The terminal device terminated; it should be closed. */
6794 /* Kill Emacs if this was our last terminal. */
6795 if (!terminal_list
->next_terminal
)
6796 /* Formerly simply reported no input, but that
6797 sometimes led to a failure of Emacs to terminate.
6798 SIGHUP seems appropriate if we can't reach the
6800 /* ??? Is it really right to send the signal just to
6801 this process rather than to the whole process
6802 group? Perhaps on systems with FIONREAD Emacs is
6803 alone in its group. */
6804 kill (getpid (), SIGHUP
);
6806 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6809 XSETTERMINAL (tmp
, t
);
6810 Fdelete_terminal (tmp
, Qnoelisp
);
6814 if (hold_quit
.kind
!= NO_EVENT
)
6815 kbd_buffer_store_event (&hold_quit
);
6824 frame_make_pointer_visible ();
6830 decode_keyboard_code (struct tty_display_info
*tty
,
6831 struct coding_system
*coding
,
6832 unsigned char *buf
, int nbytes
)
6834 unsigned char *src
= buf
;
6835 const unsigned char *p
;
6840 if (tty
->meta_key
!= 2)
6841 for (i
= 0; i
< nbytes
; i
++)
6843 if (coding
->carryover_bytes
> 0)
6845 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6846 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6847 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6848 nbytes
+= coding
->carryover_bytes
;
6850 coding
->destination
= alloca (nbytes
* 4);
6851 coding
->dst_bytes
= nbytes
* 4;
6852 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6853 if (coding
->produced_char
== 0)
6855 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6857 struct input_event event_buf
;
6859 EVENT_INIT (event_buf
);
6860 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6862 (ASCII_CHAR_P (event_buf
.code
)
6863 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6864 /* See the comment in tty_read_avail_input. */
6865 event_buf
.frame_or_window
= tty
->top_frame
;
6866 event_buf
.arg
= Qnil
;
6867 kbd_buffer_store_event (&event_buf
);
6871 /* This is the tty way of reading available input.
6873 Note that each terminal device has its own `struct terminal' object,
6874 and so this function is called once for each individual termcap
6875 terminal. The first parameter indicates which terminal to read from. */
6878 tty_read_avail_input (struct terminal
*terminal
,
6880 struct input_event
*hold_quit
)
6882 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6883 the kbd_buffer can really hold. That may prevent loss
6884 of characters on some systems when input is stuffed at us. */
6885 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6887 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6890 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6892 if (kbd_on_hold_p () || buffer_free
<= 0)
6894 #endif /* subprocesses */
6896 if (!terminal
->name
) /* Don't read from a dead terminal. */
6899 if (terminal
->type
!= output_termcap
6900 && terminal
->type
!= output_msdos_raw
)
6903 /* XXX I think the following code should be moved to separate hook
6904 functions in system-dependent files. */
6907 #else /* not WINDOWSNT */
6908 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6912 return 0; /* The terminal is suspended. */
6915 n_to_read
= dos_keysns ();
6919 cbuf
[0] = dos_keyread ();
6922 #else /* not MSDOS */
6927 struct input_event gpm_hold_quit
;
6928 int gpm
, fd
= gpm_fd
;
6930 EVENT_INIT (gpm_hold_quit
);
6931 gpm_hold_quit
.kind
= NO_EVENT
;
6933 /* gpm==1 if event received.
6934 gpm==0 if the GPM daemon has closed the connection, in which case
6935 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6936 we save it in `fd' so close_gpm can remove it from the
6938 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6939 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6940 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6943 /* Presumably the GPM daemon has closed the connection. */
6945 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6946 kbd_buffer_store_event (&gpm_hold_quit
);
6950 #endif /* HAVE_GPM */
6952 /* Determine how many characters we should *try* to read. */
6954 /* Find out how much input is available. */
6955 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6957 if (! noninteractive
)
6958 return -2; /* Close this terminal. */
6964 if (n_to_read
> sizeof cbuf
)
6965 n_to_read
= sizeof cbuf
;
6966 #else /* no FIONREAD */
6967 #if defined (USG) || defined(CYGWIN)
6968 /* Read some input if available, but don't wait. */
6969 n_to_read
= sizeof cbuf
;
6970 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6977 /* Don't read more than we can store. */
6978 if (n_to_read
> buffer_free
)
6979 n_to_read
= buffer_free
;
6980 #endif /* subprocesses */
6982 /* Now read; for one reason or another, this will not block.
6983 NREAD is set to the number of chars read. */
6986 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6987 /* POSIX infers that processes which are not in the session leader's
6988 process group won't get SIGHUP's at logout time. BSDI adheres to
6989 this part standard and returns -1 from read (0) with errno==EIO
6990 when the control tty is taken away.
6991 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6992 if (nread
== -1 && errno
== EIO
)
6993 return -2; /* Close this terminal. */
6994 #if defined (AIX) && defined (_BSD)
6995 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6996 This looks incorrect, but it isn't, because _BSD causes
6997 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6998 and that causes a value other than 0 when there is no input. */
7000 return -2; /* Close this terminal. */
7004 /* We used to retry the read if it was interrupted.
7005 But this does the wrong thing when O_NDELAY causes
7006 an EAGAIN error. Does anybody know of a situation
7007 where a retry is actually needed? */
7009 nread
< 0 && (errno
== EAGAIN
7023 #if defined (USG) || defined (CYGWIN)
7024 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7025 #endif /* USG or CYGWIN */
7026 #endif /* no FIONREAD */
7031 #endif /* not MSDOS */
7032 #endif /* not WINDOWSNT */
7034 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7035 & CODING_REQUIRE_DECODING_MASK
)
7037 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7040 /* Decode the key sequence except for those with meta
7042 for (i
= from
= 0; ; i
++)
7043 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7045 struct input_event buf
;
7047 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7052 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7053 buf
.modifiers
= meta_modifier
;
7054 buf
.code
= cbuf
[i
] & ~0x80;
7055 /* See the comment below. */
7056 buf
.frame_or_window
= tty
->top_frame
;
7058 kbd_buffer_store_event (&buf
);
7064 for (i
= 0; i
< nread
; i
++)
7066 struct input_event buf
;
7068 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7070 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7071 buf
.modifiers
= meta_modifier
;
7072 if (tty
->meta_key
!= 2)
7076 /* Set the frame corresponding to the active tty. Note that the
7077 value of selected_frame is not reliable here, redisplay tends
7078 to temporarily change it. */
7079 buf
.frame_or_window
= tty
->top_frame
;
7082 kbd_buffer_store_event (&buf
);
7083 /* Don't look at input that follows a C-g too closely.
7084 This reduces lossage due to autorepeat on C-g. */
7085 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7086 && buf
.code
== quit_char
)
7094 handle_async_input (void)
7096 interrupt_input_pending
= 0;
7098 pending_signals
= pending_atimers
;
7100 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7101 doing anything dangerous. */
7108 nread
= read_avail_input (1);
7109 /* -1 means it's not ok to read the input now.
7110 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7111 0 means there was no keyboard input available. */
7121 process_pending_signals (void)
7123 if (interrupt_input_pending
)
7124 handle_async_input ();
7125 do_pending_atimers ();
7128 #ifdef SIGIO /* for entire page */
7129 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7132 input_available_signal (int signo
)
7134 /* Must preserve main program's value of errno. */
7135 int old_errno
= errno
;
7136 SIGNAL_THREAD_CHECK (signo
);
7139 interrupt_input_pending
= 1;
7140 pending_signals
= 1;
7143 if (input_available_clear_time
)
7144 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7147 handle_async_input ();
7154 /* Send ourselves a SIGIO.
7156 This function exists so that the UNBLOCK_INPUT macro in
7157 blockinput.h can have some way to take care of input we put off
7158 dealing with, without assuming that every file which uses
7159 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7161 reinvoke_input_signal (void)
7164 handle_async_input ();
7170 /* User signal events. */
7172 struct user_signal_info
7174 /* Signal number. */
7177 /* Name of the signal. */
7180 /* Number of pending signals. */
7183 struct user_signal_info
*next
;
7186 /* List of user signals. */
7187 static struct user_signal_info
*user_signals
= NULL
;
7190 add_user_signal (int sig
, const char *name
)
7192 struct user_signal_info
*p
;
7194 for (p
= user_signals
; p
; p
= p
->next
)
7196 /* Already added. */
7199 p
= xmalloc (sizeof (struct user_signal_info
));
7201 p
->name
= xstrdup (name
);
7203 p
->next
= user_signals
;
7206 signal (sig
, handle_user_signal
);
7210 handle_user_signal (int sig
)
7212 int old_errno
= errno
;
7213 struct user_signal_info
*p
;
7215 SIGNAL_THREAD_CHECK (sig
);
7217 for (p
= user_signals
; p
; p
= p
->next
)
7222 if (interrupt_input
)
7223 kill (getpid (), SIGIO
);
7227 /* Tell wait_reading_process_output that it needs to wake
7228 up and look around. */
7229 if (input_available_clear_time
)
7230 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7239 find_user_signal_name (int sig
)
7241 struct user_signal_info
*p
;
7243 for (p
= user_signals
; p
; p
= p
->next
)
7251 store_user_signal_events (void)
7253 struct user_signal_info
*p
;
7254 struct input_event buf
;
7257 for (p
= user_signals
; p
; p
= p
->next
)
7258 if (p
->npending
> 0)
7264 memset (&buf
, 0, sizeof buf
);
7265 buf
.kind
= USER_SIGNAL_EVENT
;
7266 buf
.frame_or_window
= selected_frame
;
7268 nstored
+= p
->npending
;
7270 mask
= sigblock (sigmask (p
->sig
));
7274 kbd_buffer_store_event (&buf
);
7277 while (p
->npending
> 0);
7285 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7286 static Lisp_Object menu_bar_one_keymap_changed_items
;
7288 /* These variables hold the vector under construction within
7289 menu_bar_items and its subroutines, and the current index
7290 for storing into that vector. */
7291 static Lisp_Object menu_bar_items_vector
;
7292 static int menu_bar_items_index
;
7295 static const char* separator_names
[] = {
7300 "single-dashed-line",
7301 "double-dashed-line",
7303 "shadow-etched-out",
7304 "shadow-etched-in-dash",
7305 "shadow-etched-out-dash",
7306 "shadow-double-etched-in",
7307 "shadow-double-etched-out",
7308 "shadow-double-etched-in-dash",
7309 "shadow-double-etched-out-dash",
7313 /* Return non-zero if LABEL specifies a separator. */
7316 menu_separator_name_p (const char *label
)
7320 else if (strlen (label
) > 3
7321 && strncmp (label
, "--", 2) == 0
7326 for (i
= 0; separator_names
[i
]; ++i
)
7327 if (strcmp (label
, separator_names
[i
]) == 0)
7332 /* It's a separator if it contains only dashes. */
7333 while (*label
== '-')
7335 return (*label
== 0);
7342 /* Return a vector of menu items for a menu bar, appropriate
7343 to the current buffer. Each item has three elements in the vector:
7346 OLD is an old vector we can optionally reuse, or nil. */
7349 menu_bar_items (Lisp_Object old
)
7351 /* The number of keymaps we're scanning right now, and the number of
7352 keymaps we have allocated space for. */
7355 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7356 in the current keymaps, or nil where it is not a prefix. */
7359 Lisp_Object def
, tail
;
7366 /* In order to build the menus, we need to call the keymap
7367 accessors. They all call QUIT. But this function is called
7368 during redisplay, during which a quit is fatal. So inhibit
7369 quitting while building the menus.
7370 We do this instead of specbind because (1) errors will clear it anyway
7371 and (2) this avoids risk of specpdl overflow. */
7372 oquit
= Vinhibit_quit
;
7376 menu_bar_items_vector
= old
;
7378 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7379 menu_bar_items_index
= 0;
7381 /* Build our list of keymaps.
7382 If we recognize a function key and replace its escape sequence in
7383 keybuf with its symbol, or if the sequence starts with a mouse
7384 click and we need to switch buffers, we jump back here to rebuild
7385 the initial keymaps from the current buffer. */
7389 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7390 if (!NILP (Voverriding_local_map_menu_flag
))
7392 /* Yes, use them (if non-nil) as well as the global map. */
7393 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7395 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7396 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7397 if (!NILP (Voverriding_local_map
))
7398 maps
[nmaps
++] = Voverriding_local_map
;
7402 /* No, so use major and minor mode keymaps and keymap property.
7403 Note that menu-bar bindings in the local-map and keymap
7404 properties may not work reliable, as they are only
7405 recognized when the menu-bar (or mode-line) is updated,
7406 which does not normally happen after every command. */
7409 nminor
= current_minor_maps (NULL
, &tmaps
);
7410 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7412 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7413 maps
[nmaps
++] = tem
;
7414 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7416 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7418 maps
[nmaps
++] = current_global_map
;
7421 /* Look up in each map the dummy prefix key `menu-bar'. */
7425 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7426 if (!NILP (maps
[mapno
]))
7428 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7432 menu_bar_one_keymap_changed_items
= Qnil
;
7433 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7437 /* Move to the end those items that should be at the end. */
7439 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7442 int end
= menu_bar_items_index
;
7444 for (i
= 0; i
< end
; i
+= 4)
7445 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7447 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7448 /* Move the item at index I to the end,
7449 shifting all the others forward. */
7450 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7451 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7452 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7453 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7455 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7456 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7457 (end
- i
- 4) * sizeof (Lisp_Object
));
7458 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7459 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7460 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7461 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7466 /* Add nil, nil, nil, nil at the end. */
7468 int i
= menu_bar_items_index
;
7469 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7470 menu_bar_items_vector
=
7471 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7472 /* Add this item. */
7473 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7474 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7475 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7476 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7477 menu_bar_items_index
= i
;
7480 Vinhibit_quit
= oquit
;
7481 return menu_bar_items_vector
;
7484 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7485 If there's already an item for KEY, add this DEF to it. */
7487 Lisp_Object item_properties
;
7490 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7492 struct gcpro gcpro1
;
7496 if (EQ (item
, Qundefined
))
7498 /* If a map has an explicit `undefined' as definition,
7499 discard any previously made menu bar item. */
7501 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7502 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7504 if (menu_bar_items_index
> i
+ 4)
7505 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7506 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7507 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7508 menu_bar_items_index
-= 4;
7512 /* If this keymap has already contributed to this KEY,
7513 don't contribute to it a second time. */
7514 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7515 if (!NILP (tem
) || NILP (item
))
7518 menu_bar_one_keymap_changed_items
7519 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7521 /* We add to menu_bar_one_keymap_changed_items before doing the
7522 parse_menu_item, so that if it turns out it wasn't a menu item,
7523 it still correctly hides any further menu item. */
7525 i
= parse_menu_item (item
, 1);
7530 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7532 /* Find any existing item for this KEY. */
7533 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7534 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7537 /* If we did not find this KEY, add it at the end. */
7538 if (i
== menu_bar_items_index
)
7540 /* If vector is too small, get a bigger one. */
7541 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7542 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7543 /* Add this item. */
7544 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7545 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7546 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7547 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7548 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7549 menu_bar_items_index
= i
;
7551 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7555 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7556 /* If the new and the old items are not both keymaps,
7557 the lookup will only find `item'. */
7558 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7559 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7563 /* This is used as the handler when calling menu_item_eval_property. */
7565 menu_item_eval_property_1 (Lisp_Object arg
)
7567 /* If we got a quit from within the menu computation,
7568 quit all the way out of it. This takes care of C-] in the debugger. */
7569 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7570 Fsignal (Qquit
, Qnil
);
7576 eval_dyn (Lisp_Object form
)
7578 return Feval (form
, Qnil
);
7581 /* Evaluate an expression and return the result (or nil if something
7582 went wrong). Used to evaluate dynamic parts of menu items. */
7584 menu_item_eval_property (Lisp_Object sexpr
)
7586 int count
= SPECPDL_INDEX ();
7588 specbind (Qinhibit_redisplay
, Qt
);
7589 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7590 menu_item_eval_property_1
);
7591 return unbind_to (count
, val
);
7594 /* This function parses a menu item and leaves the result in the
7595 vector item_properties.
7596 ITEM is a key binding, a possible menu item.
7597 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7599 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7600 parse_menu_item returns true if the item is a menu item and false
7604 parse_menu_item (Lisp_Object item
, int inmenubar
)
7606 Lisp_Object def
, tem
, item_string
, start
;
7608 Lisp_Object keyhint
;
7617 /* Create item_properties vector if necessary. */
7618 if (NILP (item_properties
))
7620 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7622 /* Initialize optional entries. */
7623 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7624 ASET (item_properties
, i
, Qnil
);
7625 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7627 /* Save the item here to protect it from GC. */
7628 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7630 item_string
= XCAR (item
);
7634 if (STRINGP (item_string
))
7636 /* Old format menu item. */
7637 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7639 /* Maybe help string. */
7640 if (CONSP (item
) && STRINGP (XCAR (item
)))
7642 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7647 /* Maybe an obsolete key binding cache. */
7648 if (CONSP (item
) && CONSP (XCAR (item
))
7649 && (NILP (XCAR (XCAR (item
)))
7650 || VECTORP (XCAR (XCAR (item
)))))
7653 /* This is the real definition--the function to run. */
7654 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7656 /* Get enable property, if any. */
7659 tem
= Fget (item
, Qmenu_enable
);
7660 if (!NILP (Venable_disabled_menus_and_buttons
))
7661 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7662 else if (!NILP (tem
))
7663 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7666 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7668 /* New format menu item. */
7669 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7670 start
= XCDR (item
);
7673 /* We have a real binding. */
7674 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7676 item
= XCDR (start
);
7677 /* Is there an obsolete cache list with key equivalences. */
7678 if (CONSP (item
) && CONSP (XCAR (item
)))
7681 /* Parse properties. */
7682 while (CONSP (item
) && CONSP (XCDR (item
)))
7687 if (EQ (tem
, QCenable
))
7689 if (!NILP (Venable_disabled_menus_and_buttons
))
7690 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7692 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7694 else if (EQ (tem
, QCvisible
))
7696 /* If got a visible property and that evaluates to nil
7697 then ignore this item. */
7698 tem
= menu_item_eval_property (XCAR (item
));
7702 else if (EQ (tem
, QChelp
))
7703 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7704 else if (EQ (tem
, QCfilter
))
7706 else if (EQ (tem
, QCkey_sequence
))
7709 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7710 /* Be GC protected. Set keyhint to item instead of tem. */
7713 else if (EQ (tem
, QCkeys
))
7716 if (CONSP (tem
) || STRINGP (tem
))
7717 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7719 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7724 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7726 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7728 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7734 else if (inmenubar
|| !NILP (start
))
7738 return 0; /* not a menu item */
7740 /* If item string is not a string, evaluate it to get string.
7741 If we don't get a string, skip this item. */
7742 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7743 if (!(STRINGP (item_string
)))
7745 item_string
= menu_item_eval_property (item_string
);
7746 if (!STRINGP (item_string
))
7748 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7751 /* If got a filter apply it on definition. */
7752 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7755 def
= menu_item_eval_property (list2 (XCAR (filter
),
7756 list2 (Qquote
, def
)));
7758 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7761 /* Enable or disable selection of item. */
7762 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7765 tem
= menu_item_eval_property (tem
);
7766 if (inmenubar
&& NILP (tem
))
7767 return 0; /* Ignore disabled items in menu bar. */
7768 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7771 /* If we got no definition, this item is just unselectable text which
7772 is OK in a submenu but not in the menubar. */
7774 return (inmenubar
? 0 : 1);
7776 /* See if this is a separate pane or a submenu. */
7777 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7778 tem
= get_keymap (def
, 0, 1);
7779 /* For a subkeymap, just record its details and exit. */
7782 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7783 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7787 /* At the top level in the menu bar, do likewise for commands also.
7788 The menu bar does not display equivalent key bindings anyway.
7789 ITEM_PROPERTY_DEF is already set up properly. */
7793 { /* This is a command. See if there is an equivalent key binding. */
7794 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7796 /* The previous code preferred :key-sequence to :keys, so we
7797 preserve this behavior. */
7798 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7799 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7802 Lisp_Object prefix
= keyeq
;
7803 Lisp_Object keys
= Qnil
;
7807 def
= XCAR (prefix
);
7808 prefix
= XCDR (prefix
);
7811 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7813 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7815 keys
= XCAR (keyhint
);
7816 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7818 /* We have a suggested key. Is it bound to the command? */
7821 /* If the command is an alias for another
7822 (such as lmenu.el set it up), check if the
7823 original command matches the cached command. */
7824 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7829 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7833 tem
= Fkey_description (keys
, Qnil
);
7836 if (STRINGP (XCAR (prefix
)))
7837 tem
= concat2 (XCAR (prefix
), tem
);
7838 if (STRINGP (XCDR (prefix
)))
7839 tem
= concat2 (tem
, XCDR (prefix
));
7841 keyeq
= concat2 (build_string (" "), tem
);
7842 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7848 /* If we have an equivalent key binding, use that. */
7849 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7852 /* Include this when menu help is implemented.
7853 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7854 if (!(NILP (tem) || STRINGP (tem)))
7856 tem = menu_item_eval_property (tem);
7859 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7863 /* Handle radio buttons or toggle boxes. */
7864 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7866 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7867 menu_item_eval_property (tem
));
7874 /***********************************************************************
7876 ***********************************************************************/
7878 /* A vector holding tool bar items while they are parsed in function
7879 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7882 static Lisp_Object tool_bar_items_vector
;
7884 /* A vector holding the result of parse_tool_bar_item. Layout is like
7885 the one for a single item in tool_bar_items_vector. */
7887 static Lisp_Object tool_bar_item_properties
;
7889 /* Next free index in tool_bar_items_vector. */
7891 static int ntool_bar_items
;
7893 /* The symbols `:image' and `:rtl'. */
7895 Lisp_Object QCimage
;
7898 /* Function prototypes. */
7900 static void init_tool_bar_items (Lisp_Object
);
7901 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7902 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7903 static void append_tool_bar_item (void);
7906 /* Return a vector of tool bar items for keymaps currently in effect.
7907 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7908 tool bar items found. */
7911 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7920 /* In order to build the menus, we need to call the keymap
7921 accessors. They all call QUIT. But this function is called
7922 during redisplay, during which a quit is fatal. So inhibit
7923 quitting while building the menus. We do this instead of
7924 specbind because (1) errors will clear it anyway and (2) this
7925 avoids risk of specpdl overflow. */
7926 oquit
= Vinhibit_quit
;
7929 /* Initialize tool_bar_items_vector and protect it from GC. */
7930 init_tool_bar_items (reuse
);
7932 /* Build list of keymaps in maps. Set nmaps to the number of maps
7935 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7936 if (!NILP (Voverriding_local_map_menu_flag
))
7938 /* Yes, use them (if non-nil) as well as the global map. */
7939 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7941 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7942 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7943 if (!NILP (Voverriding_local_map
))
7944 maps
[nmaps
++] = Voverriding_local_map
;
7948 /* No, so use major and minor mode keymaps and keymap property.
7949 Note that tool-bar bindings in the local-map and keymap
7950 properties may not work reliable, as they are only
7951 recognized when the tool-bar (or mode-line) is updated,
7952 which does not normally happen after every command. */
7955 nminor
= current_minor_maps (NULL
, &tmaps
);
7956 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7958 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7959 maps
[nmaps
++] = tem
;
7960 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7962 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7965 /* Add global keymap at the end. */
7966 maps
[nmaps
++] = current_global_map
;
7968 /* Process maps in reverse order and look up in each map the prefix
7970 for (i
= nmaps
- 1; i
>= 0; --i
)
7971 if (!NILP (maps
[i
]))
7975 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7977 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7980 Vinhibit_quit
= oquit
;
7981 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7982 return tool_bar_items_vector
;
7986 /* Process the definition of KEY which is DEF. */
7989 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7992 struct gcpro gcpro1
, gcpro2
;
7994 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7998 if (EQ (def
, Qundefined
))
8000 /* If a map has an explicit `undefined' as definition,
8001 discard any previously made item. */
8002 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8004 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8006 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8008 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8009 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8010 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8011 * sizeof (Lisp_Object
)));
8012 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8017 else if (parse_tool_bar_item (key
, def
))
8018 /* Append a new tool bar item to tool_bar_items_vector. Accept
8019 more than one definition for the same key. */
8020 append_tool_bar_item ();
8026 /* Parse a tool bar item specification ITEM for key KEY and return the
8027 result in tool_bar_item_properties. Value is zero if ITEM is
8030 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8032 CAPTION is the caption of the item, If it's not a string, it is
8033 evaluated to get a string.
8035 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8036 as binding are currently ignored.
8038 The following properties are recognized:
8042 FORM is evaluated and specifies whether the tool bar item is
8043 enabled or disabled.
8047 FORM is evaluated and specifies whether the tool bar item is visible.
8049 - `:filter FUNCTION'
8051 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8052 result is stored as the new binding.
8054 - `:button (TYPE SELECTED)'
8056 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8057 and specifies whether the button is selected (pressed) or not.
8061 IMAGES is either a single image specification or a vector of four
8062 image specifications. See enum tool_bar_item_images.
8064 - `:help HELP-STRING'.
8066 Gives a help string to display for the tool bar item.
8068 - `:label LABEL-STRING'.
8070 A text label to show with the tool bar button if labels are enabled. */
8073 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8075 /* Access slot with index IDX of vector tool_bar_item_properties. */
8076 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8078 Lisp_Object filter
= Qnil
;
8079 Lisp_Object caption
;
8080 int i
, have_label
= 0;
8082 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8083 Rule out items that aren't lists, don't start with
8084 `menu-item' or whose rest following `tool-bar-item' is not a
8089 /* As an exception, allow old-style menu separators. */
8090 if (STRINGP (XCAR (item
)))
8091 item
= Fcons (XCAR (item
), Qnil
);
8092 else if (!EQ (XCAR (item
), Qmenu_item
)
8093 || (item
= XCDR (item
), !CONSP (item
)))
8096 /* Create tool_bar_item_properties vector if necessary. Reset it to
8098 if (VECTORP (tool_bar_item_properties
))
8100 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8104 tool_bar_item_properties
8105 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8108 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8109 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8111 /* Get the caption of the item. If the caption is not a string,
8112 evaluate it to get a string. If we don't get a string, skip this
8114 caption
= XCAR (item
);
8115 if (!STRINGP (caption
))
8117 caption
= menu_item_eval_property (caption
);
8118 if (!STRINGP (caption
))
8121 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8123 /* If the rest following the caption is not a list, the menu item is
8124 either a separator, or invalid. */
8128 if (menu_separator_name_p (SSDATA (caption
)))
8130 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8131 #if !defined (USE_GTK) && !defined (HAVE_NS)
8132 /* If we use build_desired_tool_bar_string to render the
8133 tool bar, the separator is rendered as an image. */
8134 PROP (TOOL_BAR_ITEM_IMAGES
)
8135 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8136 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8137 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8138 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8145 /* Store the binding. */
8146 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8149 /* Ignore cached key binding, if any. */
8150 if (CONSP (item
) && CONSP (XCAR (item
)))
8153 /* Process the rest of the properties. */
8154 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8156 Lisp_Object ikey
, value
;
8159 value
= XCAR (XCDR (item
));
8161 if (EQ (ikey
, QCenable
))
8163 /* `:enable FORM'. */
8164 if (!NILP (Venable_disabled_menus_and_buttons
))
8165 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8167 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8169 else if (EQ (ikey
, QCvisible
))
8171 /* `:visible FORM'. If got a visible property and that
8172 evaluates to nil then ignore this item. */
8173 if (NILP (menu_item_eval_property (value
)))
8176 else if (EQ (ikey
, QChelp
))
8177 /* `:help HELP-STRING'. */
8178 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8179 else if (EQ (ikey
, QCvert_only
))
8180 /* `:vert-only t/nil'. */
8181 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8182 else if (EQ (ikey
, QClabel
))
8184 const char *bad_label
= "!!?GARBLED ITEM?!!";
8185 /* `:label LABEL-STRING'. */
8186 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8188 : make_string (bad_label
, strlen (bad_label
));
8191 else if (EQ (ikey
, QCfilter
))
8192 /* ':filter FORM'. */
8194 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8196 /* `:button (TYPE . SELECTED)'. */
8197 Lisp_Object type
, selected
;
8199 type
= XCAR (value
);
8200 selected
= XCDR (value
);
8201 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8203 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8204 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8207 else if (EQ (ikey
, QCimage
)
8209 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8210 /* Value is either a single image specification or a vector
8211 of 4 such specifications for the different button states. */
8212 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8213 else if (EQ (ikey
, Qrtl
))
8215 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8221 /* Try to make one from caption and key. */
8222 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8223 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8224 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8225 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8226 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8227 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8228 Lisp_Object new_lbl
;
8229 size_t caption_len
= strlen (capt
);
8231 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8234 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8236 buf
[caption_len
] = '\0';
8240 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8244 strcpy (buf
, label
);
8246 for (j
= 0; buf
[j
] != '\0'; ++j
)
8254 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8255 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8256 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8258 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8262 /* If got a filter apply it on binding. */
8264 PROP (TOOL_BAR_ITEM_BINDING
)
8265 = menu_item_eval_property (list2 (filter
,
8267 PROP (TOOL_BAR_ITEM_BINDING
))));
8269 /* See if the binding is a keymap. Give up if it is. */
8270 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8273 /* Enable or disable selection of item. */
8274 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8275 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8276 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8278 /* Handle radio buttons or toggle boxes. */
8279 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8280 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8281 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8289 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8290 that can be reused. */
8293 init_tool_bar_items (Lisp_Object reuse
)
8295 if (VECTORP (reuse
))
8296 tool_bar_items_vector
= reuse
;
8298 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8299 ntool_bar_items
= 0;
8303 /* Append parsed tool bar item properties from
8304 tool_bar_item_properties */
8307 append_tool_bar_item (void)
8309 Lisp_Object
*to
, *from
;
8311 /* Enlarge tool_bar_items_vector if necessary. */
8312 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8313 >= XVECTOR (tool_bar_items_vector
)->size
)
8314 tool_bar_items_vector
8315 = larger_vector (tool_bar_items_vector
,
8316 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8318 /* Append entries from tool_bar_item_properties to the end of
8319 tool_bar_items_vector. */
8320 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8321 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8322 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8323 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8330 /* Read a character using menus based on maps in the array MAPS.
8331 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8332 Return t if we displayed a menu but the user rejected it.
8334 PREV_EVENT is the previous input event, or nil if we are reading
8335 the first event of a key sequence.
8337 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8338 if we used a mouse menu to read the input, or zero otherwise. If
8339 USED_MOUSE_MENU is null, we don't dereference it.
8341 The prompting is done based on the prompt-string of the map
8342 and the strings associated with various map elements.
8344 This can be done with X menus or with menus put in the minibuf.
8345 These are done in different ways, depending on how the input will be read.
8346 Menus using X are done after auto-saving in read-char, getting the input
8347 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8348 and do auto-saving in the inner call of read_char. */
8351 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8352 int *used_mouse_menu
)
8356 if (used_mouse_menu
)
8357 *used_mouse_menu
= 0;
8359 /* Use local over global Menu maps */
8361 if (! menu_prompting
)
8364 /* Optionally disregard all but the global map. */
8365 if (inhibit_local_menu_bar_menus
)
8367 maps
+= (nmaps
- 1);
8372 /* If we got to this point via a mouse click,
8373 use a real menu for mouse selection. */
8374 if (EVENT_HAS_PARAMETERS (prev_event
)
8375 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8376 && !EQ (XCAR (prev_event
), Qtool_bar
))
8378 /* Display the menu and get the selection. */
8379 Lisp_Object
*realmaps
8380 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8384 /* Use the maps that are not nil. */
8385 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8386 if (!NILP (maps
[mapno
]))
8387 realmaps
[nmaps1
++] = maps
[mapno
];
8389 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8394 record_menu_key (XCAR (value
));
8396 /* If we got multiple events, unread all but
8398 There is no way to prevent those unread events
8399 from showing up later in last_nonmenu_event.
8400 So turn symbol and integer events into lists,
8401 to indicate that they came from a mouse menu,
8402 so that when present in last_nonmenu_event
8403 they won't confuse things. */
8404 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8406 record_menu_key (XCAR (tem
));
8407 if (SYMBOLP (XCAR (tem
))
8408 || INTEGERP (XCAR (tem
)))
8409 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8412 /* If we got more than one event, put all but the first
8413 onto this list to be read later.
8414 Return just the first event now. */
8415 Vunread_command_events
8416 = nconc2 (XCDR (value
), Vunread_command_events
);
8417 value
= XCAR (value
);
8419 else if (NILP (value
))
8421 if (used_mouse_menu
)
8422 *used_mouse_menu
= 1;
8425 #endif /* HAVE_MENUS */
8429 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8430 We make this bigger when necessary, and never free it. */
8431 static char *read_char_minibuf_menu_text
;
8432 /* Size of that buffer. */
8433 static int read_char_minibuf_menu_width
;
8436 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8439 register Lisp_Object name
;
8441 /* FIXME: Use the minibuffer's frame width. */
8442 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8445 Lisp_Object rest
, vector
;
8451 if (! menu_prompting
)
8454 /* Get the menu name from the first map that has one (a prompt string). */
8455 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8457 name
= Fkeymap_prompt (maps
[mapno
]);
8462 /* If we don't have any menus, just read a character normally. */
8463 if (!STRINGP (name
))
8466 /* Make sure we have a big enough buffer for the menu text. */
8467 width
= max (width
, SBYTES (name
));
8468 if (read_char_minibuf_menu_text
== 0)
8470 read_char_minibuf_menu_width
= width
+ 4;
8471 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8473 else if (width
+ 4 > read_char_minibuf_menu_width
)
8475 read_char_minibuf_menu_width
= width
+ 4;
8476 read_char_minibuf_menu_text
8477 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8479 menu
= read_char_minibuf_menu_text
;
8481 /* Prompt string always starts with map's prompt, and a space. */
8482 strcpy (menu
, SSDATA (name
));
8483 nlength
= SBYTES (name
);
8484 menu
[nlength
++] = ':';
8485 menu
[nlength
++] = ' ';
8488 /* Start prompting at start of first map. */
8492 /* Present the documented bindings, a line at a time. */
8499 Lisp_Object orig_defn_macro
;
8501 /* Loop over elements of map. */
8506 /* If reached end of map, start at beginning of next map. */
8510 /* At end of last map, wrap around to first map if just starting,
8511 or end this line if already have something on it. */
8515 if (notfirst
|| nobindings
) break;
8520 /* Look at the next element of the map. */
8522 elt
= XVECTOR (vector
)->contents
[idx
];
8524 elt
= Fcar_safe (rest
);
8526 if (idx
< 0 && VECTORP (elt
))
8528 /* If we found a dense table in the keymap,
8529 advanced past it, but start scanning its contents. */
8530 rest
= Fcdr_safe (rest
);
8536 /* An ordinary element. */
8537 Lisp_Object event
, tem
;
8541 event
= Fcar_safe (elt
); /* alist */
8542 elt
= Fcdr_safe (elt
);
8546 XSETINT (event
, idx
); /* vector */
8549 /* Ignore the element if it has no prompt string. */
8550 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8552 /* 1 if the char to type matches the string. */
8554 Lisp_Object upcased_event
, downcased_event
;
8555 Lisp_Object desc
= Qnil
;
8557 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8559 upcased_event
= Fupcase (event
);
8560 downcased_event
= Fdowncase (event
);
8561 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8562 || XINT (downcased_event
) == SREF (s
, 0));
8564 desc
= Fsingle_key_description (event
, Qnil
);
8566 #if 0 /* It is redundant to list the equivalent key bindings because
8567 the prefix is what the user has already typed. */
8569 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8571 /* Insert equivalent keybinding. */
8572 s
= concat2 (s
, tem
);
8575 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8576 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8578 /* Insert button prefix. */
8579 Lisp_Object selected
8580 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8581 if (EQ (tem
, QCradio
))
8582 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8584 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8585 s
= concat2 (tem
, s
);
8589 /* If we have room for the prompt string, add it to this line.
8590 If this is the first on the line, always add it. */
8591 if ((SCHARS (s
) + i
+ 2
8592 + (char_matches
? 0 : SCHARS (desc
) + 3))
8598 /* Punctuate between strings. */
8601 strcpy (menu
+ i
, ", ");
8607 /* If the char to type doesn't match the string's
8608 first char, explicitly show what char to type. */
8611 /* Add as much of string as fits. */
8612 thiswidth
= SCHARS (desc
);
8613 if (thiswidth
+ i
> width
)
8614 thiswidth
= width
- i
;
8615 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8617 strcpy (menu
+ i
, " = ");
8621 /* Add as much of string as fits. */
8622 thiswidth
= SCHARS (s
);
8623 if (thiswidth
+ i
> width
)
8624 thiswidth
= width
- i
;
8625 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8631 /* If this element does not fit, end the line now,
8632 and save the element for the next line. */
8633 strcpy (menu
+ i
, "...");
8638 /* Move past this element. */
8639 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8640 /* Handle reaching end of dense table. */
8645 rest
= Fcdr_safe (rest
);
8649 /* Prompt with that and read response. */
8650 message2_nolog (menu
, strlen (menu
),
8651 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8653 /* Make believe its not a keyboard macro in case the help char
8654 is pressed. Help characters are not recorded because menu prompting
8655 is not used on replay.
8657 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8658 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8660 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8661 while (BUFFERP (obj
));
8662 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8664 if (!INTEGERP (obj
))
8666 else if (XINT (obj
) == -2)
8671 if (! EQ (obj
, menu_prompt_more_char
)
8672 && (!INTEGERP (menu_prompt_more_char
)
8673 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8675 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8676 store_kbd_macro_char (obj
);
8679 /* Help char - go round again */
8683 /* Reading key sequences. */
8685 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8686 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8687 keymap, or nil otherwise. Return the index of the first keymap in
8688 which KEY has any binding, or NMAPS if no map has a binding.
8690 If KEY is a meta ASCII character, treat it like meta-prefix-char
8691 followed by the corresponding non-meta character. Keymaps in
8692 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8695 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8698 NEXT may be the same array as CURRENT. */
8701 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8704 int i
, first_binding
;
8706 first_binding
= nmaps
;
8707 for (i
= nmaps
- 1; i
>= 0; i
--)
8709 if (! NILP (current
[i
]))
8711 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8712 if (! NILP (defs
[i
]))
8719 /* Given the set of bindings we've found, produce the next set of maps. */
8720 if (first_binding
< nmaps
)
8721 for (i
= 0; i
< nmaps
; i
++)
8722 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8724 return first_binding
;
8727 /* Structure used to keep track of partial application of key remapping
8728 such as Vfunction_key_map and Vkey_translation_map. */
8729 typedef struct keyremap
8731 /* This is the map originally specified for this use. */
8733 /* This is a submap reached by looking up, in PARENT,
8734 the events from START to END. */
8736 /* Positions [START, END) in the key sequence buffer
8737 are the key that we have scanned so far.
8738 Those events are the ones that we will replace
8739 if PAREHT maps them into a key sequence. */
8743 /* Lookup KEY in MAP.
8744 MAP is a keymap mapping keys to key vectors or functions.
8745 If the mapping is a function and DO_FUNCTION is non-zero, then
8746 the function is called with PROMPT as parameter and its return
8747 value is used as the return value of this function (after checking
8748 that it is indeed a vector). */
8751 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8756 next
= access_keymap (map
, key
, 1, 0, 1);
8758 /* Handle symbol with autoload definition. */
8759 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8760 && CONSP (XSYMBOL (next
)->function
)
8761 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8762 do_autoload (XSYMBOL (next
)->function
, next
);
8764 /* Handle a symbol whose function definition is a keymap
8766 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8767 && (ARRAYP (XSYMBOL (next
)->function
)
8768 || KEYMAPP (XSYMBOL (next
)->function
)))
8769 next
= XSYMBOL (next
)->function
;
8771 /* If the keymap gives a function, not an
8772 array, then call the function with one arg and use
8773 its value instead. */
8774 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8779 next
= call1 (next
, prompt
);
8780 /* If the function returned something invalid,
8781 barf--don't ignore it.
8782 (To ignore it safely, we would need to gcpro a bunch of
8783 other variables.) */
8784 if (! (VECTORP (next
) || STRINGP (next
)))
8785 error ("Function %s returns invalid key sequence", tem
);
8790 /* Do one step of the key remapping used for function-key-map and
8791 key-translation-map:
8792 KEYBUF is the buffer holding the input events.
8793 BUFSIZE is its maximum size.
8794 FKEY is a pointer to the keyremap structure to use.
8795 INPUT is the index of the last element in KEYBUF.
8796 DOIT if non-zero says that the remapping can actually take place.
8797 DIFF is used to return the number of keys added/removed by the remapping.
8798 PARENT is the root of the keymap.
8799 PROMPT is the prompt to use if the remapping happens through a function.
8800 The return value is non-zero if the remapping actually took place. */
8803 keyremap_step (Lisp_Object
*keybuf
, size_t bufsize
, volatile keyremap
*fkey
,
8804 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8806 Lisp_Object next
, key
;
8808 key
= keybuf
[fkey
->end
++];
8810 if (KEYMAPP (fkey
->parent
))
8811 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8815 /* If keybuf[fkey->start..fkey->end] is bound in the
8816 map and we're in a position to do the key remapping, replace it with
8817 the binding and restart with fkey->start at the end. */
8818 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8820 int len
= XFASTINT (Flength (next
));
8823 *diff
= len
- (fkey
->end
- fkey
->start
);
8825 if (input
+ *diff
>= bufsize
)
8826 error ("Key sequence too long");
8828 /* Shift the keys that follow fkey->end. */
8830 for (i
= fkey
->end
; i
< input
; i
++)
8831 keybuf
[i
+ *diff
] = keybuf
[i
];
8833 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8834 keybuf
[i
+ *diff
] = keybuf
[i
];
8835 /* Overwrite the old keys with the new ones. */
8836 for (i
= 0; i
< len
; i
++)
8837 keybuf
[fkey
->start
+ i
]
8838 = Faref (next
, make_number (i
));
8840 fkey
->start
= fkey
->end
+= *diff
;
8841 fkey
->map
= fkey
->parent
;
8846 fkey
->map
= get_keymap (next
, 0, 1);
8848 /* If we no longer have a bound suffix, try a new position for
8850 if (!CONSP (fkey
->map
))
8852 fkey
->end
= ++fkey
->start
;
8853 fkey
->map
= fkey
->parent
;
8858 /* Read a sequence of keys that ends with a non prefix character,
8859 storing it in KEYBUF, a buffer of size BUFSIZE.
8861 Return the length of the key sequence stored.
8862 Return -1 if the user rejected a command menu.
8864 Echo starting immediately unless `prompt' is 0.
8866 Where a key sequence ends depends on the currently active keymaps.
8867 These include any minor mode keymaps active in the current buffer,
8868 the current buffer's local map, and the global map.
8870 If a key sequence has no other bindings, we check Vfunction_key_map
8871 to see if some trailing subsequence might be the beginning of a
8872 function key's sequence. If so, we try to read the whole function
8873 key, and substitute its symbolic name into the key sequence.
8875 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8876 `double-' events into similar click events, if that would make them
8877 bound. We try to turn `triple-' events first into `double-' events,
8880 If we get a mouse click in a mode line, vertical divider, or other
8881 non-text area, we treat the click as if it were prefixed by the
8882 symbol denoting that area - `mode-line', `vertical-line', or
8885 If the sequence starts with a mouse click, we read the key sequence
8886 with respect to the buffer clicked on, not the current buffer.
8888 If the user switches frames in the midst of a key sequence, we put
8889 off the switch-frame event until later; the next call to
8890 read_char will return it.
8892 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8893 from the selected window's buffer. */
8896 read_key_sequence (Lisp_Object
*keybuf
, size_t bufsize
, Lisp_Object prompt
,
8897 int dont_downcase_last
, int can_return_switch_frame
,
8898 int fix_current_buffer
)
8900 Lisp_Object from_string
;
8901 int count
= SPECPDL_INDEX ();
8903 /* How many keys there are in the current key sequence. */
8906 /* The length of the echo buffer when we started reading, and
8907 the length of this_command_keys when we started reading. */
8908 int echo_start
IF_LINT (= 0);
8911 /* The number of keymaps we're scanning right now, and the number of
8912 keymaps we have allocated space for. */
8914 int nmaps_allocated
= 0;
8916 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8917 the current keymaps. */
8918 Lisp_Object
*defs
= NULL
;
8920 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8921 in the current keymaps, or nil where it is not a prefix. */
8922 Lisp_Object
*submaps
= NULL
;
8924 /* The local map to start out with at start of key sequence. */
8925 Lisp_Object orig_local_map
;
8927 /* The map from the `keymap' property to start out with at start of
8929 Lisp_Object orig_keymap
;
8931 /* 1 if we have already considered switching to the local-map property
8932 of the place where a mouse click occurred. */
8933 int localized_local_map
= 0;
8935 /* The index in submaps[] of the first keymap that has a binding for
8936 this key sequence. In other words, the lowest i such that
8937 submaps[i] is non-nil. */
8939 /* Index of the first key that has no binding.
8940 It is useless to try fkey.start larger than that. */
8943 /* If t < mock_input, then KEYBUF[t] should be read as the next
8946 We use this to recover after recognizing a function key. Once we
8947 realize that a suffix of the current key sequence is actually a
8948 function key's escape sequence, we replace the suffix with the
8949 function key's binding from Vfunction_key_map. Now keybuf
8950 contains a new and different key sequence, so the echo area,
8951 this_command_keys, and the submaps and defs arrays are wrong. In
8952 this situation, we set mock_input to t, set t to 0, and jump to
8953 restart_sequence; the loop will read keys from keybuf up until
8954 mock_input, thus rebuilding the state; and then it will resume
8955 reading characters from the keyboard. */
8958 /* If the sequence is unbound in submaps[], then
8959 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8960 and fkey.map is its binding.
8962 These might be > t, indicating that all function key scanning
8963 should hold off until t reaches them. We do this when we've just
8964 recognized a function key, to avoid searching for the function
8965 key's again in Vfunction_key_map. */
8968 /* Likewise, for key_translation_map and input-decode-map. */
8969 keyremap keytran
, indec
;
8971 /* Non-zero if we are trying to map a key by changing an upper-case
8972 letter to lower case, or a shifted function key to an unshifted
8974 int shift_translated
= 0;
8976 /* If we receive a `switch-frame' or `select-window' event in the middle of
8977 a key sequence, we put it off for later.
8978 While we're reading, we keep the event here. */
8979 Lisp_Object delayed_switch_frame
;
8981 /* See the comment below... */
8982 #if defined (GOBBLE_FIRST_EVENT)
8983 Lisp_Object first_event
;
8986 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8987 int original_uppercase_position
= -1;
8989 /* Gets around Microsoft compiler limitations. */
8992 struct buffer
*starting_buffer
;
8994 /* List of events for which a fake prefix key has been generated. */
8995 Lisp_Object fake_prefixed_keys
= Qnil
;
8997 #if defined (GOBBLE_FIRST_EVENT)
9001 struct gcpro outer_gcpro1
;
9003 GCPRO1_VAR (fake_prefixed_keys
, outer_gcpro
);
9004 raw_keybuf_count
= 0;
9006 last_nonmenu_event
= Qnil
;
9008 delayed_switch_frame
= Qnil
;
9014 /* Install the string STR as the beginning of the string of
9015 echoing, so that it serves as a prompt for the next
9017 KVAR (current_kboard
, echo_string
) = prompt
;
9018 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9021 else if (cursor_in_echo_area
9022 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9023 && NILP (Fzerop (Vecho_keystrokes
)))
9024 /* This doesn't put in a dash if the echo buffer is empty, so
9025 you don't always see a dash hanging out in the minibuffer. */
9029 /* Record the initial state of the echo area and this_command_keys;
9030 we will need to restore them if we replay a key sequence. */
9032 echo_start
= echo_length ();
9033 keys_start
= this_command_key_count
;
9034 this_single_command_key_start
= keys_start
;
9036 #if defined (GOBBLE_FIRST_EVENT)
9037 /* This doesn't quite work, because some of the things that read_char
9038 does cannot safely be bypassed. It seems too risky to try to make
9041 /* Read the first char of the sequence specially, before setting
9042 up any keymaps, in case a filter runs and switches buffers on us. */
9043 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9045 #endif /* GOBBLE_FIRST_EVENT */
9047 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9048 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9051 /* We jump here when we need to reinitialize fkey and keytran; this
9052 happens if we switch keyboards between rescans. */
9053 replay_entire_sequence
:
9055 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9056 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9057 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9058 indec
.start
= indec
.end
= 0;
9059 fkey
.start
= fkey
.end
= 0;
9060 keytran
.start
= keytran
.end
= 0;
9062 /* We jump here when the key sequence has been thoroughly changed, and
9063 we need to rescan it starting from the beginning. When we jump here,
9064 keybuf[0..mock_input] holds the sequence we should reread. */
9067 starting_buffer
= current_buffer
;
9068 first_unbound
= bufsize
+ 1;
9070 /* Build our list of keymaps.
9071 If we recognize a function key and replace its escape sequence in
9072 keybuf with its symbol, or if the sequence starts with a mouse
9073 click and we need to switch buffers, we jump back here to rebuild
9074 the initial keymaps from the current buffer. */
9077 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9079 if (2 > nmaps_allocated
)
9081 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9082 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9083 nmaps_allocated
= 2;
9085 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9087 else if (!NILP (Voverriding_local_map
))
9089 if (2 > nmaps_allocated
)
9091 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9092 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9093 nmaps_allocated
= 2;
9095 submaps
[nmaps
++] = Voverriding_local_map
;
9103 nminor
= current_minor_maps (0, &maps
);
9104 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9106 if (total
> nmaps_allocated
)
9108 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9109 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9110 nmaps_allocated
= total
;
9113 if (!NILP (orig_keymap
))
9114 submaps
[nmaps
++] = orig_keymap
;
9116 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9120 submaps
[nmaps
++] = orig_local_map
;
9122 submaps
[nmaps
++] = current_global_map
;
9124 /* Find an accurate initial value for first_binding. */
9125 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9126 if (! NILP (submaps
[first_binding
]))
9129 /* Start from the beginning in keybuf. */
9132 /* These are no-ops the first time through, but if we restart, they
9133 revert the echo area and this_command_keys to their original state. */
9134 this_command_key_count
= keys_start
;
9135 if (INTERACTIVE
&& t
< mock_input
)
9136 echo_truncate (echo_start
);
9138 /* If the best binding for the current key sequence is a keymap, or
9139 we may be looking at a function key's escape sequence, keep on
9141 while (first_binding
< nmaps
9142 /* Keep reading as long as there's a prefix binding. */
9143 ? !NILP (submaps
[first_binding
])
9144 /* Don't return in the middle of a possible function key sequence,
9145 if the only bindings we found were via case conversion.
9146 Thus, if ESC O a has a function-key-map translation
9147 and ESC o has a binding, don't return after ESC O,
9148 so that we can translate ESC O plus the next character. */
9149 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9152 int used_mouse_menu
= 0;
9154 /* Where the last real key started. If we need to throw away a
9155 key that has expanded into more than one element of keybuf
9156 (say, a mouse click on the mode line which is being treated
9157 as [mode-line (mouse-...)], then we backtrack to this point
9159 int last_real_key_start
;
9161 /* These variables are analogous to echo_start and keys_start;
9162 while those allow us to restart the entire key sequence,
9163 echo_local_start and keys_local_start allow us to throw away
9165 int echo_local_start
IF_LINT (= 0);
9166 int keys_local_start
, local_first_binding
;
9168 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9169 eassert (indec
.start
<= indec
.end
);
9170 eassert (fkey
.start
<= fkey
.end
);
9171 eassert (keytran
.start
<= keytran
.end
);
9172 /* key-translation-map is applied *after* function-key-map
9173 which is itself applied *after* input-decode-map. */
9174 eassert (fkey
.end
<= indec
.start
);
9175 eassert (keytran
.end
<= fkey
.start
);
9177 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9178 first_unbound
< keytran
.start
)
9179 { /* The prefix upto first_unbound has no binding and has
9180 no translation left to do either, so we know it's unbound.
9181 If we don't stop now, we risk staying here indefinitely
9182 (if the user keeps entering fkey or keytran prefixes
9183 like C-c ESC ESC ESC ESC ...) */
9185 for (i
= first_unbound
+ 1; i
< t
; i
++)
9186 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9187 mock_input
= t
- first_unbound
- 1;
9188 indec
.end
= indec
.start
-= first_unbound
+ 1;
9189 indec
.map
= indec
.parent
;
9190 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9191 fkey
.map
= fkey
.parent
;
9192 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9193 keytran
.map
= keytran
.parent
;
9194 goto replay_sequence
;
9198 error ("Key sequence too long");
9201 echo_local_start
= echo_length ();
9202 keys_local_start
= this_command_key_count
;
9203 local_first_binding
= first_binding
;
9206 /* These are no-ops, unless we throw away a keystroke below and
9207 jumped back up to replay_key; in that case, these restore the
9208 variables to their original state, allowing us to replay the
9210 if (INTERACTIVE
&& t
< mock_input
)
9211 echo_truncate (echo_local_start
);
9212 this_command_key_count
= keys_local_start
;
9213 first_binding
= local_first_binding
;
9215 /* By default, assume each event is "real". */
9216 last_real_key_start
= t
;
9218 /* Does mock_input indicate that we are re-reading a key sequence? */
9222 add_command_key (key
);
9223 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9224 && NILP (Fzerop (Vecho_keystrokes
)))
9228 /* If not, we should actually read a character. */
9232 KBOARD
*interrupted_kboard
= current_kboard
;
9233 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9234 key
= read_char (NILP (prompt
), nmaps
,
9235 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9236 &used_mouse_menu
, NULL
);
9237 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9238 /* When switching to a new tty (with a new keyboard),
9239 read_char returns the new buffer, rather than -2
9240 (Bug#5095). This is because `terminal-init-xterm'
9241 calls read-char, which eats the wrong_kboard_jmpbuf
9242 return. Any better way to fix this? -- cyd */
9243 || (interrupted_kboard
!= current_kboard
))
9248 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9249 if (k
== interrupted_kboard
)
9254 /* Don't touch interrupted_kboard when it's been
9256 delayed_switch_frame
= Qnil
;
9257 goto replay_entire_sequence
;
9260 if (!NILP (delayed_switch_frame
))
9262 KVAR (interrupted_kboard
, kbd_queue
)
9263 = Fcons (delayed_switch_frame
,
9264 KVAR (interrupted_kboard
, kbd_queue
));
9265 delayed_switch_frame
= Qnil
;
9269 KVAR (interrupted_kboard
, kbd_queue
)
9270 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9272 /* If the side queue is non-empty, ensure it begins with a
9273 switch-frame, so we'll replay it in the right context. */
9274 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9275 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9276 !(EVENT_HAS_PARAMETERS (key
)
9277 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9281 XSETFRAME (frame
, interrupted_frame
);
9282 KVAR (interrupted_kboard
, kbd_queue
)
9283 = Fcons (make_lispy_switch_frame (frame
),
9284 KVAR (interrupted_kboard
, kbd_queue
));
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_entire_sequence
;
9293 /* read_char returns t when it shows a menu and the user rejects it.
9297 unbind_to (count
, Qnil
);
9298 UNGCPRO_VAR (outer_gcpro
);
9302 /* read_char returns -1 at the end of a macro.
9303 Emacs 18 handles this by returning immediately with a
9304 zero, so that's what we'll do. */
9305 if (INTEGERP (key
) && XINT (key
) == -1)
9308 /* The Microsoft C compiler can't handle the goto that
9314 /* If the current buffer has been changed from under us, the
9315 keymap may have changed, so replay the sequence. */
9318 timer_resume_idle ();
9321 /* Reset the current buffer from the selected window
9322 in case something changed the former and not the latter.
9323 This is to be more consistent with the behavior
9324 of the command_loop_1. */
9325 if (fix_current_buffer
)
9327 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9329 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9330 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9333 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9334 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9335 goto replay_sequence
;
9338 /* If we have a quit that was typed in another frame, and
9339 quit_throw_to_read_char switched buffers,
9340 replay to get the right keymap. */
9342 && XINT (key
) == quit_char
9343 && current_buffer
!= starting_buffer
)
9346 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9350 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9351 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9352 goto replay_sequence
;
9357 if (EVENT_HAS_PARAMETERS (key
)
9358 /* Either a `switch-frame' or a `select-window' event. */
9359 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9361 /* If we're at the beginning of a key sequence, and the caller
9362 says it's okay, go ahead and return this event. If we're
9363 in the midst of a key sequence, delay it until the end. */
9364 if (t
> 0 || !can_return_switch_frame
)
9366 delayed_switch_frame
= key
;
9372 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9376 /* Clicks in non-text areas get prefixed by the symbol
9377 in their CHAR-ADDRESS field. For example, a click on
9378 the mode line is prefixed by the symbol `mode-line'.
9380 Furthermore, key sequences beginning with mouse clicks
9381 are read using the keymaps of the buffer clicked on, not
9382 the current buffer. So we may have to switch the buffer
9385 When we turn one event into two events, we must make sure
9386 that neither of the two looks like the original--so that,
9387 if we replay the events, they won't be expanded again.
9388 If not for this, such reexpansion could happen either here
9389 or when user programs play with this-command-keys. */
9390 if (EVENT_HAS_PARAMETERS (key
))
9395 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9396 if (EQ (kind
, Qmouse_click
))
9398 Lisp_Object window
, posn
;
9400 window
= POSN_WINDOW (EVENT_START (key
));
9401 posn
= POSN_POSN (EVENT_START (key
));
9404 || (!NILP (fake_prefixed_keys
)
9405 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9407 /* We're looking a second time at an event for which
9408 we generated a fake prefix key. Set
9409 last_real_key_start appropriately. */
9411 last_real_key_start
= t
- 1;
9414 if (last_real_key_start
== 0)
9416 /* Key sequences beginning with mouse clicks are
9417 read using the keymaps in the buffer clicked on,
9418 not the current buffer. If we're at the
9419 beginning of a key sequence, switch buffers. */
9420 if (WINDOWP (window
)
9421 && BUFFERP (XWINDOW (window
)->buffer
)
9422 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9424 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9428 /* Arrange to go back to the original buffer once we're
9429 done reading the key sequence. Note that we can't
9430 use save_excursion_{save,restore} here, because they
9431 save point as well as the current buffer; we don't
9432 want to save point, because redisplay may change it,
9433 to accommodate a Fset_window_start or something. We
9434 don't want to do this at the top of the function,
9435 because we may get input from a subprocess which
9436 wants to change the selected window and stuff (say,
9438 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9440 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9442 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9443 orig_local_map
= get_local_map (PT
, current_buffer
,
9445 orig_keymap
= get_local_map (PT
, current_buffer
,
9447 goto replay_sequence
;
9450 /* For a mouse click, get the local text-property keymap
9451 of the place clicked on, rather than point. */
9452 if (CONSP (XCDR (key
))
9453 && ! localized_local_map
)
9455 Lisp_Object map_here
, start
, pos
;
9457 localized_local_map
= 1;
9458 start
= EVENT_START (key
);
9460 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9462 pos
= POSN_BUFFER_POSN (start
);
9464 && XINT (pos
) >= BEGV
9465 && XINT (pos
) <= ZV
)
9467 map_here
= get_local_map (XINT (pos
),
9470 if (!EQ (map_here
, orig_local_map
))
9472 orig_local_map
= map_here
;
9473 ++localized_local_map
;
9476 map_here
= get_local_map (XINT (pos
),
9479 if (!EQ (map_here
, orig_keymap
))
9481 orig_keymap
= map_here
;
9482 ++localized_local_map
;
9485 if (localized_local_map
> 1)
9490 goto replay_sequence
;
9497 /* Expand mode-line and scroll-bar events into two events:
9498 use posn as a fake prefix key. */
9500 && (NILP (fake_prefixed_keys
)
9501 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9503 if (t
+ 1 >= bufsize
)
9504 error ("Key sequence too long");
9507 keybuf
[t
+ 1] = key
;
9510 /* Record that a fake prefix key has been generated
9511 for KEY. Don't modify the event; this would
9512 prevent proper action when the event is pushed
9513 back into unread-command-events. */
9514 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9516 /* If on a mode line string with a local keymap,
9517 reconsider the key sequence with that keymap. */
9518 if (string
= POSN_STRING (EVENT_START (key
)),
9519 (CONSP (string
) && STRINGP (XCAR (string
))))
9521 Lisp_Object pos
, map
, map2
;
9523 pos
= XCDR (string
);
9524 string
= XCAR (string
);
9526 && XINT (pos
) < SCHARS (string
))
9528 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9530 orig_local_map
= map
;
9531 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9534 if (!NILP (map
) || !NILP (map2
))
9535 goto replay_sequence
;
9541 else if (NILP (from_string
)
9542 && (string
= POSN_STRING (EVENT_START (key
)),
9543 (CONSP (string
) && STRINGP (XCAR (string
)))))
9545 /* For a click on a string, i.e. overlay string or a
9546 string displayed via the `display' property,
9547 consider `local-map' and `keymap' properties of
9549 Lisp_Object pos
, map
, map2
;
9551 pos
= XCDR (string
);
9552 string
= XCAR (string
);
9554 && XINT (pos
) < SCHARS (string
))
9556 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9558 orig_local_map
= map
;
9559 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9563 if (!NILP (map
) || !NILP (map2
))
9565 from_string
= string
;
9568 goto replay_sequence
;
9573 else if (CONSP (XCDR (key
))
9574 && CONSP (EVENT_START (key
))
9575 && CONSP (XCDR (EVENT_START (key
))))
9579 posn
= POSN_POSN (EVENT_START (key
));
9580 /* Handle menu-bar events:
9581 insert the dummy prefix event `menu-bar'. */
9582 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9584 if (t
+ 1 >= bufsize
)
9585 error ("Key sequence too long");
9589 /* Zap the position in key, so we know that we've
9590 expanded it, and don't try to do so again. */
9591 POSN_SET_POSN (EVENT_START (key
),
9592 Fcons (posn
, Qnil
));
9595 goto replay_sequence
;
9597 else if (CONSP (posn
))
9599 /* We're looking at the second event of a
9600 sequence which we expanded before. Set
9601 last_real_key_start appropriately. */
9602 if (last_real_key_start
== t
&& t
> 0)
9603 last_real_key_start
= t
- 1;
9608 /* We have finally decided that KEY is something we might want
9610 first_binding
= (follow_key (key
,
9611 nmaps
- first_binding
,
9612 submaps
+ first_binding
,
9613 defs
+ first_binding
,
9614 submaps
+ first_binding
)
9617 /* If KEY wasn't bound, we'll try some fallbacks. */
9618 if (first_binding
< nmaps
)
9619 /* This is needed for the following scenario:
9620 event 0: a down-event that gets dropped by calling replay_key.
9621 event 1: some normal prefix like C-h.
9622 After event 0, first_unbound is 0, after event 1 indec.start,
9623 fkey.start, and keytran.start are all 1, so when we see that
9624 C-h is bound, we need to update first_unbound. */
9625 first_unbound
= max (t
+ 1, first_unbound
);
9630 /* Remember the position to put an upper bound on indec.start. */
9631 first_unbound
= min (t
, first_unbound
);
9633 head
= EVENT_HEAD (key
);
9634 if (help_char_p (head
) && t
> 0)
9636 read_key_sequence_cmd
= Vprefix_help_command
;
9638 last_nonmenu_event
= key
;
9639 /* The Microsoft C compiler can't handle the goto that
9647 Lisp_Object breakdown
;
9650 breakdown
= parse_modifiers (head
);
9651 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9652 /* Attempt to reduce an unbound mouse event to a simpler
9653 event that is bound:
9654 Drags reduce to clicks.
9655 Double-clicks reduce to clicks.
9656 Triple-clicks reduce to double-clicks, then to clicks.
9657 Down-clicks are eliminated.
9658 Double-downs reduce to downs, then are eliminated.
9659 Triple-downs reduce to double-downs, then to downs,
9660 then are eliminated. */
9661 if (modifiers
& (down_modifier
| drag_modifier
9662 | double_modifier
| triple_modifier
))
9664 while (modifiers
& (down_modifier
| drag_modifier
9665 | double_modifier
| triple_modifier
))
9667 Lisp_Object new_head
, new_click
;
9668 if (modifiers
& triple_modifier
)
9669 modifiers
^= (double_modifier
| triple_modifier
);
9670 else if (modifiers
& double_modifier
)
9671 modifiers
&= ~double_modifier
;
9672 else if (modifiers
& drag_modifier
)
9673 modifiers
&= ~drag_modifier
;
9676 /* Dispose of this `down' event by simply jumping
9677 back to replay_key, to get another event.
9679 Note that if this event came from mock input,
9680 then just jumping back to replay_key will just
9681 hand it to us again. So we have to wipe out any
9684 We could delete keybuf[t] and shift everything
9685 after that to the left by one spot, but we'd also
9686 have to fix up any variable that points into
9687 keybuf, and shifting isn't really necessary
9690 Adding prefixes for non-textual mouse clicks
9691 creates two characters of mock input, and both
9692 must be thrown away. If we're only looking at
9693 the prefix now, we can just jump back to
9694 replay_key. On the other hand, if we've already
9695 processed the prefix, and now the actual click
9696 itself is giving us trouble, then we've lost the
9697 state of the keymaps we want to backtrack to, and
9698 we need to replay the whole sequence to rebuild
9701 Beyond that, only function key expansion could
9702 create more than two keys, but that should never
9703 generate mouse events, so it's okay to zero
9704 mock_input in that case too.
9706 FIXME: The above paragraph seems just plain
9707 wrong, if you consider things like
9708 xterm-mouse-mode. -stef
9710 Isn't this just the most wonderful code ever? */
9712 /* If mock_input > t + 1, the above simplification
9713 will actually end up dropping keys on the floor.
9714 This is probably OK for now, but even
9715 if mock_input <= t + 1, we need to adjust indec,
9717 Typical case [header-line down-mouse-N]:
9718 mock_input = 2, t = 1, fkey.end = 1,
9719 last_real_key_start = 0. */
9720 if (indec
.end
> last_real_key_start
)
9722 indec
.end
= indec
.start
9723 = min (last_real_key_start
, indec
.start
);
9724 indec
.map
= indec
.parent
;
9725 if (fkey
.end
> last_real_key_start
)
9727 fkey
.end
= fkey
.start
9728 = min (last_real_key_start
, fkey
.start
);
9729 fkey
.map
= fkey
.parent
;
9730 if (keytran
.end
> last_real_key_start
)
9732 keytran
.end
= keytran
.start
9733 = min (last_real_key_start
, keytran
.start
);
9734 keytran
.map
= keytran
.parent
;
9738 if (t
== last_real_key_start
)
9745 mock_input
= last_real_key_start
;
9746 goto replay_sequence
;
9751 = apply_modifiers (modifiers
, XCAR (breakdown
));
9753 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9755 /* Look for a binding for this new key. follow_key
9756 promises that it didn't munge submaps the
9757 last time we called it, since key was unbound. */
9759 = (follow_key (new_click
,
9760 nmaps
- local_first_binding
,
9761 submaps
+ local_first_binding
,
9762 defs
+ local_first_binding
,
9763 submaps
+ local_first_binding
)
9764 + local_first_binding
);
9766 /* If that click is bound, go for it. */
9767 if (first_binding
< nmaps
)
9772 /* Otherwise, we'll leave key set to the drag event. */
9779 /* Normally, last_nonmenu_event gets the previous key we read.
9780 But when a mouse popup menu is being used,
9781 we don't update last_nonmenu_event; it continues to hold the mouse
9782 event that preceded the first level of menu. */
9783 if (!used_mouse_menu
)
9784 last_nonmenu_event
= key
;
9786 /* Record what part of this_command_keys is the current key sequence. */
9787 this_single_command_key_start
= this_command_key_count
- t
;
9789 /* Look for this sequence in input-decode-map.
9790 Scan from indec.end until we find a bound suffix. */
9791 while (indec
.end
< t
)
9793 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9796 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9797 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9802 mock_input
= diff
+ max (t
, mock_input
);
9803 goto replay_sequence
;
9807 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9808 && indec
.start
>= t
)
9809 /* There is a binding and it's not a prefix.
9810 (and it doesn't have any input-decode-map translation pending).
9811 There is thus no function-key in this sequence.
9812 Moving fkey.start is important in this case to allow keytran.start
9813 to go over the sequence before we return (since we keep the
9814 invariant that keytran.end <= fkey.start). */
9817 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9820 /* If the sequence is unbound, see if we can hang a function key
9821 off the end of it. */
9822 /* Continue scan from fkey.end until we find a bound suffix. */
9823 while (fkey
.end
< indec
.start
)
9825 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9828 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9829 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9830 max (t
, mock_input
),
9831 /* If there's a binding (i.e.
9832 first_binding >= nmaps) we don't want
9833 to apply this function-key-mapping. */
9834 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9839 mock_input
= diff
+ max (t
, mock_input
);
9840 /* Adjust the input-decode-map counters. */
9842 indec
.start
+= diff
;
9844 goto replay_sequence
;
9848 /* Look for this sequence in key-translation-map.
9849 Scan from keytran.end until we find a bound suffix. */
9850 while (keytran
.end
< fkey
.start
)
9852 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9855 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9856 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9861 mock_input
= diff
+ max (t
, mock_input
);
9862 /* Adjust the function-key-map and input-decode-map counters. */
9864 indec
.start
+= diff
;
9868 goto replay_sequence
;
9872 /* If KEY is not defined in any of the keymaps,
9873 and cannot be part of a function key or translation,
9874 and is an upper case letter
9875 use the corresponding lower-case letter instead. */
9876 if (first_binding
>= nmaps
9877 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9879 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9880 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9881 || (XINT (key
) & shift_modifier
)))
9883 Lisp_Object new_key
;
9885 original_uppercase
= key
;
9886 original_uppercase_position
= t
- 1;
9888 if (XINT (key
) & shift_modifier
)
9889 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9891 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9892 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9894 /* We have to do this unconditionally, regardless of whether
9895 the lower-case char is defined in the keymaps, because they
9896 might get translated through function-key-map. */
9897 keybuf
[t
- 1] = new_key
;
9898 mock_input
= max (t
, mock_input
);
9899 shift_translated
= 1;
9901 goto replay_sequence
;
9903 /* If KEY is not defined in any of the keymaps,
9904 and cannot be part of a function key or translation,
9905 and is a shifted function key,
9906 use the corresponding unshifted function key instead. */
9907 if (first_binding
>= nmaps
9908 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9910 Lisp_Object breakdown
= parse_modifiers (key
);
9912 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9914 if (modifiers
& shift_modifier
9915 /* Treat uppercase keys as shifted. */
9917 && (KEY_TO_CHAR (key
)
9918 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->size
)
9919 && uppercasep (KEY_TO_CHAR (key
))))
9922 = (modifiers
& shift_modifier
9923 ? apply_modifiers (modifiers
& ~shift_modifier
,
9925 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9927 original_uppercase
= key
;
9928 original_uppercase_position
= t
- 1;
9930 /* We have to do this unconditionally, regardless of whether
9931 the lower-case char is defined in the keymaps, because they
9932 might get translated through function-key-map. */
9933 keybuf
[t
- 1] = new_key
;
9934 mock_input
= max (t
, mock_input
);
9935 /* Reset fkey (and consequently keytran) to apply
9936 function-key-map on the result, so that S-backspace is
9937 correctly mapped to DEL (via backspace). OTOH,
9938 input-decode-map doesn't need to go through it again. */
9939 fkey
.start
= fkey
.end
= 0;
9940 keytran
.start
= keytran
.end
= 0;
9941 shift_translated
= 1;
9943 goto replay_sequence
;
9948 read_key_sequence_cmd
= (first_binding
< nmaps
9949 ? defs
[first_binding
]
9952 unread_switch_frame
= delayed_switch_frame
;
9953 unbind_to (count
, Qnil
);
9955 /* Don't downcase the last character if the caller says don't.
9956 Don't downcase it if the result is undefined, either. */
9957 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9959 && t
- 1 == original_uppercase_position
)
9961 keybuf
[t
- 1] = original_uppercase
;
9962 shift_translated
= 0;
9965 if (shift_translated
)
9966 Vthis_command_keys_shift_translated
= Qt
;
9968 /* Occasionally we fabricate events, perhaps by expanding something
9969 according to function-key-map, or by adding a prefix symbol to a
9970 mouse click in the scroll bar or modeline. In this cases, return
9971 the entire generated key sequence, even if we hit an unbound
9972 prefix or a definition before the end. This means that you will
9973 be able to push back the event properly, and also means that
9974 read-key-sequence will always return a logical unit.
9977 for (; t
< mock_input
; t
++)
9979 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9980 && NILP (Fzerop (Vecho_keystrokes
)))
9981 echo_char (keybuf
[t
]);
9982 add_command_key (keybuf
[t
]);
9985 UNGCPRO_VAR (outer_gcpro
);
9989 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9990 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9991 The sequence is sufficient to specify a non-prefix command in the
9992 current local and global maps.
9994 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9995 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9996 as a continuation of the previous key.
9998 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9999 convert the last event to lower case. (Normally any upper case event
10000 is converted to lower case if the original event is undefined and the lower
10001 case equivalent is defined.) A non-nil value is appropriate for reading
10002 a key sequence to be defined.
10004 A C-g typed while in this function is treated like any other character,
10005 and `quit-flag' is not set.
10007 If the key sequence starts with a mouse click, then the sequence is read
10008 using the keymaps of the buffer of the window clicked in, not the buffer
10009 of the selected window as normal.
10011 `read-key-sequence' drops unbound button-down events, since you normally
10012 only care about the click or drag events which follow them. If a drag
10013 or multi-click event is unbound, but the corresponding click event would
10014 be bound, `read-key-sequence' turns the event into a click event at the
10015 drag's starting position. This means that you don't have to distinguish
10016 between click and drag, double, or triple events unless you want to.
10018 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10019 lines separating windows, and scroll bars with imaginary keys
10020 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10022 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10023 function will process a switch-frame event if the user switches frames
10024 before typing anything. If the user switches frames in the middle of a
10025 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10026 is nil, then the event will be put off until after the current key sequence.
10028 `read-key-sequence' checks `function-key-map' for function key
10029 sequences, where they wouldn't conflict with ordinary bindings. See
10030 `function-key-map' for more details.
10032 The optional fifth argument CMD-LOOP, if non-nil, means
10033 that this key sequence is being read by something that will
10034 read commands one after another. It should be nil if the caller
10035 will read just one key sequence. */)
10036 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10038 Lisp_Object keybuf
[30];
10040 struct gcpro gcpro1
;
10041 int count
= SPECPDL_INDEX ();
10043 if (!NILP (prompt
))
10044 CHECK_STRING (prompt
);
10047 specbind (Qinput_method_exit_on_first_char
,
10048 (NILP (cmd_loop
) ? Qt
: Qnil
));
10049 specbind (Qinput_method_use_echo_area
,
10050 (NILP (cmd_loop
) ? Qt
: Qnil
));
10052 memset (keybuf
, 0, sizeof keybuf
);
10053 GCPRO1 (keybuf
[0]);
10054 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10056 if (NILP (continue_echo
))
10058 this_command_key_count
= 0;
10059 this_command_key_count_reset
= 0;
10060 this_single_command_key_start
= 0;
10063 #ifdef HAVE_WINDOW_SYSTEM
10064 if (display_hourglass_p
)
10065 cancel_hourglass ();
10068 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10069 prompt
, ! NILP (dont_downcase_last
),
10070 ! NILP (can_return_switch_frame
), 0);
10072 #if 0 /* The following is fine for code reading a key sequence and
10073 then proceeding with a lenghty computation, but it's not good
10074 for code reading keys in a loop, like an input method. */
10075 #ifdef HAVE_WINDOW_SYSTEM
10076 if (display_hourglass_p
)
10077 start_hourglass ();
10087 return unbind_to (count
, make_event_array (i
, keybuf
));
10090 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10091 Sread_key_sequence_vector
, 1, 5, 0,
10092 doc
: /* Like `read-key-sequence' but always return a vector. */)
10093 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10095 Lisp_Object keybuf
[30];
10097 struct gcpro gcpro1
;
10098 int count
= SPECPDL_INDEX ();
10100 if (!NILP (prompt
))
10101 CHECK_STRING (prompt
);
10104 specbind (Qinput_method_exit_on_first_char
,
10105 (NILP (cmd_loop
) ? Qt
: Qnil
));
10106 specbind (Qinput_method_use_echo_area
,
10107 (NILP (cmd_loop
) ? Qt
: Qnil
));
10109 memset (keybuf
, 0, sizeof keybuf
);
10110 GCPRO1 (keybuf
[0]);
10111 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10113 if (NILP (continue_echo
))
10115 this_command_key_count
= 0;
10116 this_command_key_count_reset
= 0;
10117 this_single_command_key_start
= 0;
10120 #ifdef HAVE_WINDOW_SYSTEM
10121 if (display_hourglass_p
)
10122 cancel_hourglass ();
10125 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10126 prompt
, ! NILP (dont_downcase_last
),
10127 ! NILP (can_return_switch_frame
), 0);
10129 #ifdef HAVE_WINDOW_SYSTEM
10130 if (display_hourglass_p
)
10131 start_hourglass ();
10140 return unbind_to (count
, Fvector (i
, keybuf
));
10143 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10144 doc
: /* Execute CMD as an editor command.
10145 CMD must be a symbol that satisfies the `commandp' predicate.
10146 Optional second arg RECORD-FLAG non-nil
10147 means unconditionally put this command in `command-history'.
10148 Otherwise, that is done only if an arg is read using the minibuffer.
10149 The argument KEYS specifies the value to use instead of (this-command-keys)
10150 when reading the arguments; if it is nil, (this-command-keys) is used.
10151 The argument SPECIAL, if non-nil, means that this command is executing
10152 a special event, so ignore the prefix argument and don't clear it. */)
10153 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10155 register Lisp_Object final
;
10156 register Lisp_Object tem
;
10157 Lisp_Object prefixarg
;
10159 debug_on_next_call
= 0;
10161 if (NILP (special
))
10163 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10164 Vcurrent_prefix_arg
= prefixarg
;
10165 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10172 tem
= Fget (cmd
, Qdisabled
);
10175 tem
= Fsymbol_value (Qdisabled_command_function
);
10177 return Frun_hooks (1, &Qdisabled_command_function
);
10183 final
= Findirect_function (cmd
, Qnil
);
10185 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10187 struct gcpro gcpro1
, gcpro2
;
10189 GCPRO2 (cmd
, prefixarg
);
10190 do_autoload (final
, cmd
);
10197 if (STRINGP (final
) || VECTORP (final
))
10199 /* If requested, place the macro in the command history. For
10200 other sorts of commands, call-interactively takes care of
10202 if (!NILP (record_flag
))
10205 = Fcons (Fcons (Qexecute_kbd_macro
,
10206 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10209 /* Don't keep command history around forever. */
10210 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10212 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10214 XSETCDR (tem
, Qnil
);
10218 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10221 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10222 /* Don't call Fcall_interactively directly because we want to make
10223 sure the backtrace has an entry for `call-interactively'.
10224 For the same reason, pass `cmd' rather than `final'. */
10225 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10232 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10234 doc
: /* Read function name, then read its arguments and call it.
10236 To pass a numeric argument to the command you are invoking with, specify
10237 the numeric argument to this command.
10239 Noninteractively, the argument PREFIXARG is the prefix argument to
10240 give to the command you invoke, if it asks for an argument. */)
10241 (Lisp_Object prefixarg
)
10243 Lisp_Object function
;
10244 EMACS_INT saved_last_point_position
;
10245 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10246 Lisp_Object bindings
, value
;
10247 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10248 #ifdef HAVE_WINDOW_SYSTEM
10249 /* The call to Fcompleting_read will start and cancel the hourglass,
10250 but if the hourglass was already scheduled, this means that no
10251 hourglass will be shown for the actual M-x command itself.
10252 So we restart it if it is already scheduled. Note that checking
10253 hourglass_shown_p is not enough, normally the hourglass is not shown,
10254 just scheduled to be shown. */
10255 int hstarted
= hourglass_started ();
10258 saved_keys
= Fvector (this_command_key_count
,
10259 XVECTOR (this_command_keys
)->contents
);
10260 saved_last_point_position_buffer
= last_point_position_buffer
;
10261 saved_last_point_position
= last_point_position
;
10262 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10264 function
= call0 (intern ("read-extended-command"));
10266 #ifdef HAVE_WINDOW_SYSTEM
10267 if (hstarted
) start_hourglass ();
10270 if (STRINGP (function
) && SCHARS (function
) == 0)
10271 error ("No command name given");
10273 /* Set this_command_keys to the concatenation of saved_keys and
10274 function, followed by a RET. */
10279 this_command_key_count
= 0;
10280 this_command_key_count_reset
= 0;
10281 this_single_command_key_start
= 0;
10283 keys
= XVECTOR (saved_keys
)->contents
;
10284 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10285 add_command_key (keys
[i
]);
10287 for (i
= 0; i
< SCHARS (function
); i
++)
10288 add_command_key (Faref (function
, make_number (i
)));
10290 add_command_key (make_number ('\015'));
10293 last_point_position
= saved_last_point_position
;
10294 last_point_position_buffer
= saved_last_point_position_buffer
;
10298 function
= Fintern (function
, Qnil
);
10299 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10300 Vthis_command
= function
;
10301 real_this_command
= function
;
10303 /* If enabled, show which key runs this command. */
10304 if (!NILP (Vsuggest_key_bindings
)
10305 && NILP (Vexecuting_kbd_macro
)
10306 && SYMBOLP (function
))
10307 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10313 GCPRO3 (bindings
, value
, function
);
10314 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10316 /* If the command has a key binding, print it now. */
10317 if (!NILP (bindings
)
10318 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10321 /* But first wait, and skip the message if there is input. */
10322 Lisp_Object waited
;
10324 /* If this command displayed something in the echo area;
10325 wait a few seconds, then display our suggestion message. */
10326 if (NILP (echo_area_buffer
[0]))
10327 waited
= sit_for (make_number (0), 0, 2);
10328 else if (NUMBERP (Vsuggest_key_bindings
))
10329 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10331 waited
= sit_for (make_number (2), 0, 2);
10333 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10335 Lisp_Object binding
;
10337 int message_p
= push_message ();
10338 int count
= SPECPDL_INDEX ();
10340 record_unwind_protect (pop_message_unwind
, Qnil
);
10341 binding
= Fkey_description (bindings
, Qnil
);
10344 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10347 sprintf (newmessage
, "You can run the command `%s' with %s",
10348 SDATA (SYMBOL_NAME (function
)),
10350 message2 (newmessage
,
10351 strlen (newmessage
),
10352 STRING_MULTIBYTE (binding
));
10353 if (NUMBERP (Vsuggest_key_bindings
))
10354 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10356 waited
= sit_for (make_number (2), 0, 2);
10358 if (!NILP (waited
) && message_p
)
10359 restore_message ();
10361 unbind_to (count
, Qnil
);
10365 RETURN_UNGCPRO (value
);
10369 /* Return nonzero if input events are pending. */
10372 detect_input_pending (void)
10374 if (!input_pending
)
10375 get_input_pending (&input_pending
, 0);
10377 return input_pending
;
10380 /* Return nonzero if input events other than mouse movements are
10384 detect_input_pending_ignore_squeezables (void)
10386 if (!input_pending
)
10387 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10389 return input_pending
;
10392 /* Return nonzero if input events are pending, and run any pending timers. */
10395 detect_input_pending_run_timers (int do_display
)
10397 int old_timers_run
= timers_run
;
10399 if (!input_pending
)
10400 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10402 if (old_timers_run
!= timers_run
&& do_display
)
10404 redisplay_preserve_echo_area (8);
10405 /* The following fixes a bug when using lazy-lock with
10406 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10407 from an idle timer function. The symptom of the bug is that
10408 the cursor sometimes doesn't become visible until the next X
10409 event is processed. --gerd. */
10411 Lisp_Object tail
, frame
;
10412 FOR_EACH_FRAME (tail
, frame
)
10413 if (FRAME_RIF (XFRAME (frame
)))
10414 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10418 return input_pending
;
10421 /* This is called in some cases before a possible quit.
10422 It cases the next call to detect_input_pending to recompute input_pending.
10423 So calling this function unnecessarily can't do any harm. */
10426 clear_input_pending (void)
10431 /* Return nonzero if there are pending requeued events.
10432 This isn't used yet. The hope is to make wait_reading_process_output
10433 call it, and return if it runs Lisp code that unreads something.
10434 The problem is, kbd_buffer_get_event needs to be fixed to know what
10435 to do in that case. It isn't trivial. */
10438 requeued_events_pending_p (void)
10440 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10444 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10445 doc
: /* Return t if command input is currently available with no wait.
10446 Actually, the value is nil only if we can be sure that no input is available;
10447 if there is a doubt, the value is t. */)
10450 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10451 || !NILP (Vunread_post_input_method_events
)
10452 || !NILP (Vunread_input_method_events
))
10455 get_input_pending (&input_pending
,
10456 READABLE_EVENTS_DO_TIMERS_NOW
10457 | READABLE_EVENTS_FILTER_EVENTS
);
10458 return input_pending
> 0 ? Qt
: Qnil
;
10461 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10462 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10465 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10468 if (total_keys
< NUM_RECENT_KEYS
)
10469 return Fvector (total_keys
, keys
);
10472 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10473 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10474 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10475 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10476 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10481 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10482 doc
: /* Return the key sequence that invoked this command.
10483 However, if the command has called `read-key-sequence', it returns
10484 the last key sequence that has been read.
10485 The value is a string or a vector.
10487 See also `this-command-keys-vector'. */)
10490 return make_event_array (this_command_key_count
,
10491 XVECTOR (this_command_keys
)->contents
);
10494 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10495 doc
: /* Return the key sequence that invoked this command, as a vector.
10496 However, if the command has called `read-key-sequence', it returns
10497 the last key sequence that has been read.
10499 See also `this-command-keys'. */)
10502 return Fvector (this_command_key_count
,
10503 XVECTOR (this_command_keys
)->contents
);
10506 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10507 Sthis_single_command_keys
, 0, 0, 0,
10508 doc
: /* Return the key sequence that invoked this command.
10509 More generally, it returns the last key sequence read, either by
10510 the command loop or by `read-key-sequence'.
10511 Unlike `this-command-keys', this function's value
10512 does not include prefix arguments.
10513 The value is always a vector. */)
10516 return Fvector (this_command_key_count
10517 - this_single_command_key_start
,
10518 (XVECTOR (this_command_keys
)->contents
10519 + this_single_command_key_start
));
10522 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10523 Sthis_single_command_raw_keys
, 0, 0, 0,
10524 doc
: /* Return the raw events that were read for this command.
10525 More generally, it returns the last key sequence read, either by
10526 the command loop or by `read-key-sequence'.
10527 Unlike `this-single-command-keys', this function's value
10528 shows the events before all translations (except for input methods).
10529 The value is always a vector. */)
10532 return Fvector (raw_keybuf_count
,
10533 (XVECTOR (raw_keybuf
)->contents
));
10536 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10537 Sreset_this_command_lengths
, 0, 0, 0,
10538 doc
: /* Make the unread events replace the last command and echo.
10539 Used in `universal-argument-other-key'.
10541 `universal-argument-other-key' rereads the event just typed.
10542 It then gets translated through `function-key-map'.
10543 The translated event has to replace the real events,
10544 both in the value of (this-command-keys) and in echoing.
10545 To achieve this, `universal-argument-other-key' calls
10546 `reset-this-command-lengths', which discards the record of reading
10547 these events the first time. */)
10550 this_command_key_count
= before_command_key_count
;
10551 if (this_command_key_count
< this_single_command_key_start
)
10552 this_single_command_key_start
= this_command_key_count
;
10554 echo_truncate (before_command_echo_length
);
10556 /* Cause whatever we put into unread-command-events
10557 to echo as if it were being freshly read from the keyboard. */
10558 this_command_key_count_reset
= 1;
10563 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10564 Sclear_this_command_keys
, 0, 1, 0,
10565 doc
: /* Clear out the vector that `this-command-keys' returns.
10566 Also clear the record of the last 100 events, unless optional arg
10567 KEEP-RECORD is non-nil. */)
10568 (Lisp_Object keep_record
)
10572 this_command_key_count
= 0;
10573 this_command_key_count_reset
= 0;
10575 if (NILP (keep_record
))
10577 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10578 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10580 recent_keys_index
= 0;
10585 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10586 doc
: /* Return the current depth in recursive edits. */)
10590 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10594 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10595 "FOpen dribble file: ",
10596 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10597 If FILE is nil, close any open dribble file. */)
10609 file
= Fexpand_file_name (file
, Qnil
);
10610 dribble
= fopen (SSDATA (file
), "w");
10612 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10617 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10618 doc
: /* Discard the contents of the terminal input buffer.
10619 Also end any kbd macro being defined. */)
10622 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10624 /* Discard the last command from the macro. */
10625 Fcancel_kbd_macro_events ();
10629 update_mode_lines
++;
10631 Vunread_command_events
= Qnil
;
10632 unread_command_char
= -1;
10634 discard_tty_input ();
10636 kbd_fetch_ptr
= kbd_store_ptr
;
10642 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10643 doc
: /* Stop Emacs and return to superior process. You can resume later.
10644 If `cannot-suspend' is non-nil, or if the system doesn't support job
10645 control, run a subshell instead.
10647 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10648 to be read as terminal input by Emacs's parent, after suspension.
10650 Before suspending, run the normal hook `suspend-hook'.
10651 After resumption run the normal hook `suspend-resume-hook'.
10653 Some operating systems cannot stop the Emacs process and resume it later.
10654 On such systems, Emacs starts a subshell instead of suspending. */)
10655 (Lisp_Object stuffstring
)
10657 int count
= SPECPDL_INDEX ();
10658 int old_height
, old_width
;
10660 struct gcpro gcpro1
;
10663 if (tty_list
&& tty_list
->next
)
10664 error ("There are other tty frames open; close them before suspending Emacs");
10666 if (!NILP (stuffstring
))
10667 CHECK_STRING (stuffstring
);
10669 /* Run the functions in suspend-hook. */
10670 hook
= intern ("suspend-hook");
10671 Frun_hooks (1, &hook
);
10673 GCPRO1 (stuffstring
);
10674 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10675 reset_all_sys_modes ();
10676 /* sys_suspend can get an error if it tries to fork a subshell
10677 and the system resources aren't available for that. */
10678 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10680 stuff_buffered_input (stuffstring
);
10681 if (cannot_suspend
)
10685 unbind_to (count
, Qnil
);
10687 /* Check if terminal/window size has changed.
10688 Note that this is not useful when we are running directly
10689 with a window system; but suspend should be disabled in that case. */
10690 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10691 if (width
!= old_width
|| height
!= old_height
)
10692 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10694 /* Run suspend-resume-hook. */
10695 hook
= intern ("suspend-resume-hook");
10696 Frun_hooks (1, &hook
);
10702 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10703 Then in any case stuff anything Emacs has read ahead and not used. */
10706 stuff_buffered_input (Lisp_Object stuffstring
)
10708 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10709 register unsigned char *p
;
10711 if (STRINGP (stuffstring
))
10713 register EMACS_INT count
;
10715 p
= SDATA (stuffstring
);
10716 count
= SBYTES (stuffstring
);
10717 while (count
-- > 0)
10722 /* Anything we have read ahead, put back for the shell to read. */
10723 /* ?? What should this do when we have multiple keyboards??
10724 Should we ignore anything that was typed in at the "wrong" kboard?
10726 rms: we should stuff everything back into the kboard
10728 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10731 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10732 kbd_fetch_ptr
= kbd_buffer
;
10733 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10734 stuff_char (kbd_fetch_ptr
->code
);
10736 clear_event (kbd_fetch_ptr
);
10740 #endif /* SIGTSTP */
10744 set_waiting_for_input (struct timeval
*time_to_clear
)
10746 input_available_clear_time
= time_to_clear
;
10748 /* Tell handle_interrupt to throw back to read_char, */
10749 waiting_for_input
= 1;
10751 /* If handle_interrupt was called before and buffered a C-g,
10752 make it run again now, to avoid timing error. */
10753 if (!NILP (Vquit_flag
))
10754 quit_throw_to_read_char ();
10758 clear_waiting_for_input (void)
10760 /* Tell handle_interrupt not to throw back to read_char, */
10761 waiting_for_input
= 0;
10762 input_available_clear_time
= 0;
10765 /* The SIGINT handler.
10767 If we have a frame on the controlling tty, we assume that the
10768 SIGINT was generated by C-g, so we call handle_interrupt.
10769 Otherwise, the handler kills Emacs. */
10772 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10773 /* compilers complain in signal calls. */
10775 /* Must preserve main program's value of errno. */
10776 int old_errno
= errno
;
10777 struct terminal
*terminal
;
10779 SIGNAL_THREAD_CHECK (signalnum
);
10781 /* See if we have an active terminal on our controlling tty. */
10782 terminal
= get_named_tty ("/dev/tty");
10785 /* If there are no frames there, let's pretend that we are a
10786 well-behaving UN*X program and quit. */
10787 Fkill_emacs (Qnil
);
10791 /* Otherwise, the SIGINT was probably generated by C-g. */
10793 /* Set internal_last_event_frame to the top frame of the
10794 controlling tty, if we have a frame there. We disable the
10795 interrupt key on secondary ttys, so the SIGINT must have come
10796 from the controlling tty. */
10797 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10799 handle_interrupt ();
10805 /* This routine is called at interrupt level in response to C-g.
10807 It is called from the SIGINT handler or kbd_buffer_store_event.
10809 If `waiting_for_input' is non zero, then unless `echoing' is
10810 nonzero, immediately throw back to read_char.
10812 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10813 eval to throw, when it gets a chance. If quit-flag is already
10814 non-nil, it stops the job right away. */
10817 handle_interrupt (void)
10823 /* XXX This code needs to be revised for multi-tty support. */
10824 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10826 /* If SIGINT isn't blocked, don't let us be interrupted by
10827 another SIGINT, it might be harmful due to non-reentrancy
10828 in I/O functions. */
10829 sigblock (sigmask (SIGINT
));
10832 reset_all_sys_modes ();
10834 #ifdef SIGTSTP /* Support possible in later USG versions */
10836 * On systems which can suspend the current process and return to the original
10837 * shell, this command causes the user to end up back at the shell.
10838 * The "Auto-save" and "Abort" questions are not asked until
10839 * the user elects to return to emacs, at which point he can save the current
10840 * job and either dump core or continue.
10844 /* Perhaps should really fork an inferior shell?
10845 But that would not provide any way to get back
10846 to the original shell, ever. */
10847 printf ("No support for stopping a process on this operating system;\n");
10848 printf ("you can continue or abort.\n");
10849 #endif /* not SIGTSTP */
10851 /* We must remain inside the screen area when the internal terminal
10852 is used. Note that [Enter] is not echoed by dos. */
10853 cursor_to (SELECTED_FRAME (), 0, 0);
10855 /* It doesn't work to autosave while GC is in progress;
10856 the code used for auto-saving doesn't cope with the mark bit. */
10857 if (!gc_in_progress
)
10859 printf ("Auto-save? (y or n) ");
10861 if (((c
= getchar ()) & ~040) == 'Y')
10863 Fdo_auto_save (Qt
, Qnil
);
10865 printf ("\r\nAuto-save done");
10866 #else /* not MSDOS */
10867 printf ("Auto-save done\n");
10868 #endif /* not MSDOS */
10870 while (c
!= '\n') c
= getchar ();
10874 /* During GC, it must be safe to reenable quitting again. */
10875 Vinhibit_quit
= Qnil
;
10878 #endif /* not MSDOS */
10879 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10880 printf ("but will instead do a real quit after garbage collection ends\r\n");
10885 printf ("\r\nAbort? (y or n) ");
10886 #else /* not MSDOS */
10887 printf ("Abort (and dump core)? (y or n) ");
10888 #endif /* not MSDOS */
10890 if (((c
= getchar ()) & ~040) == 'Y')
10892 while (c
!= '\n') c
= getchar ();
10894 printf ("\r\nContinuing...\r\n");
10895 #else /* not MSDOS */
10896 printf ("Continuing...\n");
10897 #endif /* not MSDOS */
10899 init_all_sys_modes ();
10904 /* If executing a function that wants to be interrupted out of
10905 and the user has not deferred quitting by binding `inhibit-quit'
10906 then quit right away. */
10907 if (immediate_quit
&& NILP (Vinhibit_quit
))
10909 struct gl_state_s saved
;
10910 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10912 immediate_quit
= 0;
10915 GCPRO4 (saved
.object
, saved
.global_code
,
10916 saved
.current_syntax_table
, saved
.old_prop
);
10917 Fsignal (Qquit
, Qnil
);
10918 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10923 /* Else request quit when it's safe */
10927 /* TODO: The longjmp in this call throws the NS event loop integration off,
10928 and it seems to do fine without this. Probably some attention
10929 needs to be paid to the setting of waiting_for_input in
10930 wait_reading_process_output() under HAVE_NS because of the call
10931 to ns_select there (needed because otherwise events aren't picked up
10932 outside of polling since we don't get SIGIO like X and we don't have a
10933 separate event loop thread like W32. */
10935 if (waiting_for_input
&& !echoing
)
10936 quit_throw_to_read_char ();
10940 /* Handle a C-g by making read_char return C-g. */
10943 quit_throw_to_read_char (void)
10946 /* Prevent another signal from doing this before we finish. */
10947 clear_waiting_for_input ();
10950 Vunread_command_events
= Qnil
;
10951 unread_command_char
= -1;
10953 #if 0 /* Currently, sit_for is called from read_char without turning
10954 off polling. And that can call set_waiting_for_input.
10955 It seems to be harmless. */
10956 #ifdef POLL_FOR_INPUT
10957 /* May be > 1 if in recursive minibuffer. */
10958 if (poll_suppress_count
== 0)
10962 if (FRAMEP (internal_last_event_frame
)
10963 && !EQ (internal_last_event_frame
, selected_frame
))
10964 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10967 _longjmp (getcjmp
, 1);
10970 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
10971 doc
: /* Set interrupt mode of reading keyboard input.
10972 If INTERRUPT is non-nil, Emacs will use input interrupts;
10973 otherwise Emacs uses CBREAK mode.
10975 See also `current-input-mode'. */)
10976 (Lisp_Object interrupt
)
10978 int new_interrupt_input
;
10980 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10981 #ifdef HAVE_X_WINDOWS
10982 if (x_display_list
!= NULL
)
10984 /* When using X, don't give the user a real choice,
10985 because we haven't implemented the mechanisms to support it. */
10986 new_interrupt_input
= 1;
10989 #endif /* HAVE_X_WINDOWS */
10990 new_interrupt_input
= !NILP (interrupt
);
10991 #else /* not SIGIO */
10992 new_interrupt_input
= 0;
10993 #endif /* not SIGIO */
10995 if (new_interrupt_input
!= interrupt_input
)
10997 #ifdef POLL_FOR_INPUT
11001 /* this causes startup screen to be restored and messes with the mouse */
11002 reset_all_sys_modes ();
11003 interrupt_input
= new_interrupt_input
;
11004 init_all_sys_modes ();
11006 interrupt_input
= new_interrupt_input
;
11009 #ifdef POLL_FOR_INPUT
11010 poll_suppress_count
= 1;
11017 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11018 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11019 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11020 C-q in key sequences.
11022 This setting only has an effect on tty terminals and only when
11023 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11025 See also `current-input-mode'. */)
11026 (Lisp_Object flow
, Lisp_Object terminal
)
11028 struct terminal
*t
= get_terminal (terminal
, 1);
11029 struct tty_display_info
*tty
;
11030 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11032 tty
= t
->display_info
.tty
;
11034 if (tty
->flow_control
!= !NILP (flow
))
11037 /* this causes startup screen to be restored and messes with the mouse */
11038 reset_sys_modes (tty
);
11041 tty
->flow_control
= !NILP (flow
);
11044 init_sys_modes (tty
);
11050 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11051 doc
: /* Enable or disable 8-bit input on TERMINAL.
11052 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11053 bit as the Meta modifier.
11055 If META is nil, Emacs will ignore the top bit, on the assumption it is
11058 Otherwise, Emacs will accept and pass through 8-bit input without
11059 specially interpreting the top bit.
11061 This setting only has an effect on tty terminal devices.
11063 Optional parameter TERMINAL specifies the tty terminal device to use.
11064 It may be a terminal object, a frame, or nil for the terminal used by
11065 the currently selected frame.
11067 See also `current-input-mode'. */)
11068 (Lisp_Object meta
, Lisp_Object terminal
)
11070 struct terminal
*t
= get_terminal (terminal
, 1);
11071 struct tty_display_info
*tty
;
11074 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11076 tty
= t
->display_info
.tty
;
11080 else if (EQ (meta
, Qt
))
11085 if (tty
->meta_key
!= new_meta
)
11088 /* this causes startup screen to be restored and messes with the mouse */
11089 reset_sys_modes (tty
);
11092 tty
->meta_key
= new_meta
;
11095 init_sys_modes (tty
);
11101 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11102 doc
: /* Specify character used for quitting.
11103 QUIT must be an ASCII character.
11105 This function only has an effect on the controlling tty of the Emacs
11108 See also `current-input-mode'. */)
11111 struct terminal
*t
= get_named_tty ("/dev/tty");
11112 struct tty_display_info
*tty
;
11113 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11115 tty
= t
->display_info
.tty
;
11117 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11118 error ("QUIT must be an ASCII character");
11121 /* this causes startup screen to be restored and messes with the mouse */
11122 reset_sys_modes (tty
);
11125 /* Don't let this value be out of range. */
11126 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11129 init_sys_modes (tty
);
11135 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11136 doc
: /* Set mode of reading keyboard input.
11137 First arg INTERRUPT non-nil means use input interrupts;
11138 nil means use CBREAK mode.
11139 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11140 (no effect except in CBREAK mode).
11141 Third arg META t means accept 8-bit input (for a Meta key).
11142 META nil means ignore the top bit, on the assumption it is parity.
11143 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11144 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11145 See also `current-input-mode'. */)
11146 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11148 Fset_input_interrupt_mode (interrupt
);
11149 Fset_output_flow_control (flow
, Qnil
);
11150 Fset_input_meta_mode (meta
, Qnil
);
11152 Fset_quit_char (quit
);
11156 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11157 doc
: /* Return information about the way Emacs currently reads keyboard input.
11158 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11159 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11160 nil, Emacs is using CBREAK mode.
11161 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11162 terminal; this does not apply if Emacs uses interrupt-driven input.
11163 META is t if accepting 8-bit input with 8th bit as Meta flag.
11164 META nil means ignoring the top bit, on the assumption it is parity.
11165 META is neither t nor nil if accepting 8-bit input and using
11166 all 8 bits as the character code.
11167 QUIT is the character Emacs currently uses to quit.
11168 The elements of this list correspond to the arguments of
11169 `set-input-mode'. */)
11172 Lisp_Object val
[4];
11173 struct frame
*sf
= XFRAME (selected_frame
);
11175 val
[0] = interrupt_input
? Qt
: Qnil
;
11176 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11178 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11179 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11181 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11188 XSETFASTINT (val
[3], quit_char
);
11190 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11193 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11194 doc
: /* Return position information for pixel coordinates X and Y.
11195 By default, X and Y are relative to text area of the selected window.
11196 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11197 If optional fourth arg WHOLE is non-nil, X is relative to the left
11198 edge of the window.
11200 The return value is similar to a mouse click position:
11201 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11202 IMAGE (DX . DY) (WIDTH . HEIGHT))
11203 The `posn-' functions access elements of such lists. */)
11204 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11209 if (NILP (frame_or_window
))
11210 frame_or_window
= selected_window
;
11212 if (WINDOWP (frame_or_window
))
11216 CHECK_LIVE_WINDOW (frame_or_window
);
11218 w
= XWINDOW (frame_or_window
);
11219 XSETINT (x
, (XINT (x
)
11220 + WINDOW_LEFT_EDGE_X (w
)
11222 ? window_box_left_offset (w
, TEXT_AREA
)
11224 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11225 frame_or_window
= w
->frame
;
11228 CHECK_LIVE_FRAME (frame_or_window
);
11230 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11233 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11234 doc
: /* Return position information for buffer POS in WINDOW.
11235 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11237 Return nil if position is not visible in window. Otherwise,
11238 the return value is similar to that returned by `event-start' for
11239 a mouse click at the upper left corner of the glyph corresponding
11240 to the given buffer position:
11241 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11242 IMAGE (DX . DY) (WIDTH . HEIGHT))
11243 The `posn-' functions access elements of such lists. */)
11244 (Lisp_Object pos
, Lisp_Object window
)
11249 window
= selected_window
;
11251 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11254 Lisp_Object x
= XCAR (tem
);
11255 Lisp_Object y
= XCAR (XCDR (tem
));
11257 /* Point invisible due to hscrolling? */
11260 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11268 * Set up a new kboard object with reasonable initial values.
11271 init_kboard (KBOARD
*kb
)
11273 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11274 KVAR (kb
, Vlast_command
) = Qnil
;
11275 KVAR (kb
, Vreal_last_command
) = Qnil
;
11276 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11277 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11278 KVAR (kb
, Vprefix_arg
) = Qnil
;
11279 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11280 KVAR (kb
, kbd_queue
) = Qnil
;
11281 kb
->kbd_queue_has_data
= 0;
11282 kb
->immediate_echo
= 0;
11283 KVAR (kb
, echo_string
) = Qnil
;
11284 kb
->echo_after_prompt
= -1;
11285 kb
->kbd_macro_buffer
= 0;
11286 kb
->kbd_macro_bufsize
= 0;
11287 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11288 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11289 kb
->reference_count
= 0;
11290 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11291 KVAR (kb
, system_key_syms
) = Qnil
;
11292 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11293 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11294 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11295 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11296 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11300 * Destroy the contents of a kboard object, but not the object itself.
11301 * We use this just before deleting it, or if we're going to initialize
11302 * it a second time.
11305 wipe_kboard (KBOARD
*kb
)
11307 xfree (kb
->kbd_macro_buffer
);
11310 /* Free KB and memory referenced from it. */
11313 delete_kboard (KBOARD
*kb
)
11317 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11320 *kbp
= kb
->next_kboard
;
11322 /* Prevent a dangling reference to KB. */
11323 if (kb
== current_kboard
11324 && FRAMEP (selected_frame
)
11325 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11327 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11329 if (current_kboard
== kb
)
11338 init_keyboard (void)
11340 /* This is correct before outermost invocation of the editor loop */
11341 command_loop_level
= -1;
11342 immediate_quit
= 0;
11343 quit_char
= Ctl ('g');
11344 Vunread_command_events
= Qnil
;
11345 unread_command_char
= -1;
11346 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11348 recent_keys_index
= 0;
11349 kbd_fetch_ptr
= kbd_buffer
;
11350 kbd_store_ptr
= kbd_buffer
;
11351 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11352 do_mouse_tracking
= Qnil
;
11355 interrupt_input_blocked
= 0;
11356 interrupt_input_pending
= 0;
11358 pending_signals
= 0;
11361 /* This means that command_loop_1 won't try to select anything the first
11363 internal_last_event_frame
= Qnil
;
11364 Vlast_event_frame
= internal_last_event_frame
;
11366 current_kboard
= initial_kboard
;
11367 /* Re-initialize the keyboard again. */
11368 wipe_kboard (current_kboard
);
11369 init_kboard (current_kboard
);
11370 /* A value of nil for Vwindow_system normally means a tty, but we also use
11371 it for the initial terminal since there is no window system there. */
11372 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11374 if (!noninteractive
)
11376 /* Before multi-tty support, these handlers used to be installed
11377 only if the current session was a tty session. Now an Emacs
11378 session may have multiple display types, so we always handle
11379 SIGINT. There is special code in interrupt_signal to exit
11380 Emacs on SIGINT when there are no termcap frames on the
11381 controlling terminal. */
11382 signal (SIGINT
, interrupt_signal
);
11384 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11385 SIGQUIT and we can't tell which one it will give us. */
11386 signal (SIGQUIT
, interrupt_signal
);
11387 #endif /* not DOS_NT */
11389 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11391 if (!noninteractive
)
11392 signal (SIGIO
, input_available_signal
);
11395 /* Use interrupt input by default, if it works and noninterrupt input
11396 has deficiencies. */
11398 #ifdef INTERRUPT_INPUT
11399 interrupt_input
= 1;
11401 interrupt_input
= 0;
11407 if (keyboard_init_hook
)
11408 (*keyboard_init_hook
) ();
11410 #ifdef POLL_FOR_INPUT
11412 poll_suppress_count
= 1;
11417 /* This type's only use is in syms_of_keyboard, to initialize the
11418 event header symbols and put properties on them. */
11419 struct event_head
{
11425 static const struct event_head head_table
[] = {
11426 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11427 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11428 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11429 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11430 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11431 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11432 /* `select-window' should be handled just like `switch-frame'
11433 in read_key_sequence. */
11434 {&Qselect_window
, "select-window", &Qswitch_frame
}
11438 syms_of_keyboard (void)
11440 pending_funcalls
= Qnil
;
11441 staticpro (&pending_funcalls
);
11443 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11444 staticpro (&Vlispy_mouse_stem
);
11447 QCimage
= intern_c_string (":image");
11448 staticpro (&QCimage
);
11450 staticpro (&Qhelp_echo
);
11451 Qhelp_echo
= intern_c_string ("help-echo");
11454 Qrtl
= intern_c_string (":rtl");
11456 staticpro (&item_properties
);
11457 item_properties
= Qnil
;
11459 staticpro (&tool_bar_item_properties
);
11460 tool_bar_item_properties
= Qnil
;
11461 staticpro (&tool_bar_items_vector
);
11462 tool_bar_items_vector
= Qnil
;
11464 staticpro (&real_this_command
);
11465 real_this_command
= Qnil
;
11467 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11468 staticpro (&Qtimer_event_handler
);
11470 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11471 staticpro (&Qdisabled_command_function
);
11473 Qself_insert_command
= intern_c_string ("self-insert-command");
11474 staticpro (&Qself_insert_command
);
11476 Qforward_char
= intern_c_string ("forward-char");
11477 staticpro (&Qforward_char
);
11479 Qbackward_char
= intern_c_string ("backward-char");
11480 staticpro (&Qbackward_char
);
11482 Qdisabled
= intern_c_string ("disabled");
11483 staticpro (&Qdisabled
);
11485 Qundefined
= intern_c_string ("undefined");
11486 staticpro (&Qundefined
);
11488 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11489 staticpro (&Qpre_command_hook
);
11491 Qpost_command_hook
= intern_c_string ("post-command-hook");
11492 staticpro (&Qpost_command_hook
);
11494 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11495 staticpro (&Qdeferred_action_function
);
11497 Qfunction_key
= intern_c_string ("function-key");
11498 staticpro (&Qfunction_key
);
11499 Qmouse_click
= intern_c_string ("mouse-click");
11500 staticpro (&Qmouse_click
);
11501 #if defined (WINDOWSNT)
11502 Qlanguage_change
= intern_c_string ("language-change");
11503 staticpro (&Qlanguage_change
);
11505 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11506 staticpro (&Qdrag_n_drop
);
11508 Qsave_session
= intern_c_string ("save-session");
11509 staticpro (&Qsave_session
);
11512 Qdbus_event
= intern_c_string ("dbus-event");
11513 staticpro (&Qdbus_event
);
11516 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11517 staticpro (&Qconfig_changed_event
);
11519 Qmenu_enable
= intern_c_string ("menu-enable");
11520 staticpro (&Qmenu_enable
);
11521 QCenable
= intern_c_string (":enable");
11522 staticpro (&QCenable
);
11523 QCvisible
= intern_c_string (":visible");
11524 staticpro (&QCvisible
);
11525 QChelp
= intern_c_string (":help");
11526 staticpro (&QChelp
);
11527 QCfilter
= intern_c_string (":filter");
11528 staticpro (&QCfilter
);
11529 QCbutton
= intern_c_string (":button");
11530 staticpro (&QCbutton
);
11531 QCkeys
= intern_c_string (":keys");
11532 staticpro (&QCkeys
);
11533 QCkey_sequence
= intern_c_string (":key-sequence");
11534 staticpro (&QCkey_sequence
);
11535 QCtoggle
= intern_c_string (":toggle");
11536 staticpro (&QCtoggle
);
11537 QCradio
= intern_c_string (":radio");
11538 staticpro (&QCradio
);
11539 QClabel
= intern_c_string (":label");
11540 staticpro (&QClabel
);
11541 QCvert_only
= intern_c_string (":vert-only");
11542 staticpro (&QCvert_only
);
11544 Qmode_line
= intern_c_string ("mode-line");
11545 staticpro (&Qmode_line
);
11546 Qvertical_line
= intern_c_string ("vertical-line");
11547 staticpro (&Qvertical_line
);
11548 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11549 staticpro (&Qvertical_scroll_bar
);
11550 Qmenu_bar
= intern_c_string ("menu-bar");
11551 staticpro (&Qmenu_bar
);
11553 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11554 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11555 staticpro (&Qmouse_fixup_help_message
);
11558 Qabove_handle
= intern_c_string ("above-handle");
11559 staticpro (&Qabove_handle
);
11560 Qhandle
= intern_c_string ("handle");
11561 staticpro (&Qhandle
);
11562 Qbelow_handle
= intern_c_string ("below-handle");
11563 staticpro (&Qbelow_handle
);
11564 Qup
= intern_c_string ("up");
11566 Qdown
= intern_c_string ("down");
11567 staticpro (&Qdown
);
11568 Qtop
= intern_c_string ("top");
11570 Qbottom
= intern_c_string ("bottom");
11571 staticpro (&Qbottom
);
11572 Qend_scroll
= intern_c_string ("end-scroll");
11573 staticpro (&Qend_scroll
);
11574 Qratio
= intern_c_string ("ratio");
11575 staticpro (&Qratio
);
11577 Qevent_kind
= intern_c_string ("event-kind");
11578 staticpro (&Qevent_kind
);
11579 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11580 staticpro (&Qevent_symbol_elements
);
11581 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11582 staticpro (&Qevent_symbol_element_mask
);
11583 Qmodifier_cache
= intern_c_string ("modifier-cache");
11584 staticpro (&Qmodifier_cache
);
11586 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11587 staticpro (&Qrecompute_lucid_menubar
);
11588 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11589 staticpro (&Qactivate_menubar_hook
);
11591 Qpolling_period
= intern_c_string ("polling-period");
11592 staticpro (&Qpolling_period
);
11594 Qinput_method_function
= intern_c_string ("input-method-function");
11595 staticpro (&Qinput_method_function
);
11597 Qx_set_selection
= intern_c_string ("x-set-selection");
11598 staticpro (&Qx_set_selection
);
11599 QPRIMARY
= intern_c_string ("PRIMARY");
11600 staticpro (&QPRIMARY
);
11601 Qhandle_switch_frame
= intern_c_string ("handle-switch-frame");
11602 staticpro (&Qhandle_switch_frame
);
11604 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11605 staticpro (&Qinput_method_exit_on_first_char
);
11606 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11607 staticpro (&Qinput_method_use_echo_area
);
11609 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11610 Fset (Qinput_method_use_echo_area
, Qnil
);
11612 last_point_position_buffer
= Qnil
;
11613 last_point_position_window
= Qnil
;
11617 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11619 for (i
= 0; i
< len
; i
++)
11621 const struct event_head
*p
= &head_table
[i
];
11622 *p
->var
= intern_c_string (p
->name
);
11623 staticpro (p
->var
);
11624 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11625 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11629 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11630 staticpro (&button_down_location
);
11631 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11632 staticpro (&mouse_syms
);
11633 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11634 / sizeof (lispy_wheel_names
[0])),
11636 staticpro (&wheel_syms
);
11640 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11642 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11643 for (i
= 0; i
< len
; i
++)
11644 if (modifier_names
[i
])
11645 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11646 staticpro (&modifier_symbols
);
11649 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11650 staticpro (&recent_keys
);
11652 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11653 staticpro (&this_command_keys
);
11655 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11656 staticpro (&raw_keybuf
);
11658 Qextended_command_history
= intern_c_string ("extended-command-history");
11659 Fset (Qextended_command_history
, Qnil
);
11660 staticpro (&Qextended_command_history
);
11662 accent_key_syms
= Qnil
;
11663 staticpro (&accent_key_syms
);
11665 func_key_syms
= Qnil
;
11666 staticpro (&func_key_syms
);
11668 drag_n_drop_syms
= Qnil
;
11669 staticpro (&drag_n_drop_syms
);
11671 unread_switch_frame
= Qnil
;
11672 staticpro (&unread_switch_frame
);
11674 internal_last_event_frame
= Qnil
;
11675 staticpro (&internal_last_event_frame
);
11677 read_key_sequence_cmd
= Qnil
;
11678 staticpro (&read_key_sequence_cmd
);
11680 menu_bar_one_keymap_changed_items
= Qnil
;
11681 staticpro (&menu_bar_one_keymap_changed_items
);
11683 menu_bar_items_vector
= Qnil
;
11684 staticpro (&menu_bar_items_vector
);
11686 help_form_saved_window_configs
= Qnil
;
11687 staticpro (&help_form_saved_window_configs
);
11689 defsubr (&Scurrent_idle_time
);
11690 defsubr (&Sevent_symbol_parse_modifiers
);
11691 defsubr (&Sevent_convert_list
);
11692 defsubr (&Sread_key_sequence
);
11693 defsubr (&Sread_key_sequence_vector
);
11694 defsubr (&Srecursive_edit
);
11695 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11696 defsubr (&Strack_mouse
);
11698 defsubr (&Sinput_pending_p
);
11699 defsubr (&Scommand_execute
);
11700 defsubr (&Srecent_keys
);
11701 defsubr (&Sthis_command_keys
);
11702 defsubr (&Sthis_command_keys_vector
);
11703 defsubr (&Sthis_single_command_keys
);
11704 defsubr (&Sthis_single_command_raw_keys
);
11705 defsubr (&Sreset_this_command_lengths
);
11706 defsubr (&Sclear_this_command_keys
);
11707 defsubr (&Ssuspend_emacs
);
11708 defsubr (&Sabort_recursive_edit
);
11709 defsubr (&Sexit_recursive_edit
);
11710 defsubr (&Srecursion_depth
);
11711 defsubr (&Stop_level
);
11712 defsubr (&Sdiscard_input
);
11713 defsubr (&Sopen_dribble_file
);
11714 defsubr (&Sset_input_interrupt_mode
);
11715 defsubr (&Sset_output_flow_control
);
11716 defsubr (&Sset_input_meta_mode
);
11717 defsubr (&Sset_quit_char
);
11718 defsubr (&Sset_input_mode
);
11719 defsubr (&Scurrent_input_mode
);
11720 defsubr (&Sexecute_extended_command
);
11721 defsubr (&Sposn_at_point
);
11722 defsubr (&Sposn_at_x_y
);
11724 DEFVAR_LISP ("last-command-event", last_command_event
,
11725 doc
: /* Last input event that was part of a command. */);
11727 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11728 doc
: /* Last input event in a command, except for mouse menu events.
11729 Mouse menus give back keys that don't look like mouse events;
11730 this variable holds the actual mouse event that led to the menu,
11731 so that you can determine whether the command was run by mouse or not. */);
11733 DEFVAR_LISP ("last-input-event", last_input_event
,
11734 doc
: /* Last input event. */);
11736 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11737 doc
: /* List of events to be read as the command input.
11738 These events are processed first, before actual keyboard input.
11739 Events read from this list are not normally added to `this-command-keys',
11740 as they will already have been added once as they were read for the first time.
11741 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11742 Vunread_command_events
= Qnil
;
11744 DEFVAR_INT ("unread-command-char", unread_command_char
,
11745 doc
: /* If not -1, an object to be read as next command input event. */);
11747 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11748 doc
: /* List of events to be processed as input by input methods.
11749 These events are processed before `unread-command-events'
11750 and actual keyboard input, but are not given to `input-method-function'. */);
11751 Vunread_post_input_method_events
= Qnil
;
11753 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11754 doc
: /* List of events to be processed as input by input methods.
11755 These events are processed after `unread-command-events', but
11756 before actual keyboard input.
11757 If there's an active input method, the events are given to
11758 `input-method-function'. */);
11759 Vunread_input_method_events
= Qnil
;
11761 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11762 doc
: /* Meta-prefix character code.
11763 Meta-foo as command input turns into this character followed by foo. */);
11764 XSETINT (meta_prefix_char
, 033);
11766 DEFVAR_KBOARD ("last-command", Vlast_command
,
11767 doc
: /* The last command executed.
11768 Normally a symbol with a function definition, but can be whatever was found
11769 in the keymap, or whatever the variable `this-command' was set to by that
11772 The value `mode-exit' is special; it means that the previous command
11773 read an event that told it to exit, and it did so and unread that event.
11774 In other words, the present command is the event that made the previous
11777 The value `kill-region' is special; it means that the previous command
11778 was a kill command.
11780 `last-command' has a separate binding for each terminal device.
11781 See Info node `(elisp)Multiple Terminals'. */);
11783 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11784 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11786 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11787 doc
: /* Last command that may be repeated.
11788 The last command executed that was not bound to an input event.
11789 This is the command `repeat' will try to repeat. */);
11791 DEFVAR_LISP ("this-command", Vthis_command
,
11792 doc
: /* The command now being executed.
11793 The command can set this variable; whatever is put here
11794 will be in `last-command' during the following command. */);
11795 Vthis_command
= Qnil
;
11797 DEFVAR_LISP ("this-command-keys-shift-translated",
11798 Vthis_command_keys_shift_translated
,
11799 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11800 Shift-translation occurs when there is no binding for the key sequence
11801 as entered, but a binding was found by changing an upper-case letter
11802 to lower-case, or a shifted function key to an unshifted one. */);
11803 Vthis_command_keys_shift_translated
= Qnil
;
11805 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11806 doc
: /* The command bound to the current key sequence before remapping.
11807 It equals `this-command' if the original command was not remapped through
11808 any of the active keymaps. Otherwise, the value of `this-command' is the
11809 result of looking up the original command in the active keymaps. */);
11810 Vthis_original_command
= Qnil
;
11812 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11813 doc
: /* *Number of input events between auto-saves.
11814 Zero means disable autosaving due to number of characters typed. */);
11815 auto_save_interval
= 300;
11817 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11818 doc
: /* *Number of seconds idle time before auto-save.
11819 Zero or nil means disable auto-saving due to idleness.
11820 After auto-saving due to this many seconds of idle time,
11821 Emacs also does a garbage collection if that seems to be warranted. */);
11822 XSETFASTINT (Vauto_save_timeout
, 30);
11824 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11825 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11826 The value may be integer or floating point. */);
11827 Vecho_keystrokes
= make_number (1);
11829 DEFVAR_INT ("polling-period", polling_period
,
11830 doc
: /* *Interval between polling for input during Lisp execution.
11831 The reason for polling is to make C-g work to stop a running program.
11832 Polling is needed only when using X windows and SIGIO does not work.
11833 Polling is automatically disabled in all other cases. */);
11834 polling_period
= 2;
11836 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11837 doc
: /* *Maximum time between mouse clicks to make a double-click.
11838 Measured in milliseconds. The value nil means disable double-click
11839 recognition; t means double-clicks have no time limit and are detected
11840 by position only. */);
11841 Vdouble_click_time
= make_number (500);
11843 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11844 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11845 On window-system frames, value is the number of pixels the mouse may have
11846 moved horizontally or vertically between two clicks to make a double-click.
11847 On non window-system frames, value is interpreted in units of 1/8 characters
11850 This variable is also the threshold for motion of the mouse
11851 to count as a drag. */);
11852 double_click_fuzz
= 3;
11854 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11855 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11856 inhibit_local_menu_bar_menus
= 0;
11858 DEFVAR_INT ("num-input-keys", num_input_keys
,
11859 doc
: /* Number of complete key sequences read as input so far.
11860 This includes key sequences read from keyboard macros.
11861 The number is effectively the number of interactive command invocations. */);
11862 num_input_keys
= 0;
11864 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11865 doc
: /* Number of input events read from the keyboard so far.
11866 This does not include events generated by keyboard macros. */);
11867 num_nonmacro_input_events
= 0;
11869 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11870 doc
: /* The frame in which the most recently read event occurred.
11871 If the last event came from a keyboard macro, this is set to `macro'. */);
11872 Vlast_event_frame
= Qnil
;
11874 /* This variable is set up in sysdep.c. */
11875 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11876 doc
: /* The ERASE character as set by the user with stty. */);
11878 DEFVAR_LISP ("help-char", Vhelp_char
,
11879 doc
: /* Character to recognize as meaning Help.
11880 When it is read, do `(eval help-form)', and display result if it's a string.
11881 If the value of `help-form' is nil, this char can be read normally. */);
11882 XSETINT (Vhelp_char
, Ctl ('H'));
11884 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11885 doc
: /* List of input events to recognize as meaning Help.
11886 These work just like the value of `help-char' (see that). */);
11887 Vhelp_event_list
= Qnil
;
11889 DEFVAR_LISP ("help-form", Vhelp_form
,
11890 doc
: /* Form to execute when character `help-char' is read.
11891 If the form returns a string, that string is displayed.
11892 If `help-form' is nil, the help char is not recognized. */);
11895 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11896 doc
: /* Command to run when `help-char' character follows a prefix key.
11897 This command is used only when there is no actual binding
11898 for that character after that prefix key. */);
11899 Vprefix_help_command
= Qnil
;
11901 DEFVAR_LISP ("top-level", Vtop_level
,
11902 doc
: /* Form to evaluate when Emacs starts up.
11903 Useful to set before you dump a modified Emacs. */);
11906 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11907 doc
: /* Translate table for local keyboard input, or nil.
11908 If non-nil, the value should be a char-table. Each character read
11909 from the keyboard is looked up in this char-table. If the value found
11910 there is non-nil, then it is used instead of the actual input character.
11912 The value can also be a string or vector, but this is considered obsolete.
11913 If it is a string or vector of length N, character codes N and up are left
11914 untranslated. In a vector, an element which is nil means "no translation".
11916 This is applied to the characters supplied to input methods, not their
11917 output. See also `translation-table-for-input'.
11919 This variable has a separate binding for each terminal.
11920 See Info node `(elisp)Multiple Terminals'. */);
11922 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11923 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11924 \(Even if the operating system has support for stopping a process.\) */);
11925 cannot_suspend
= 0;
11927 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11928 doc
: /* Non-nil means prompt with menus when appropriate.
11929 This is done when reading from a keymap that has a prompt string,
11930 for elements that have prompt strings.
11931 The menu is displayed on the screen
11932 if X menus were enabled at configuration
11933 time and the previous event was a mouse click prefix key.
11934 Otherwise, menu prompting uses the echo area. */);
11935 menu_prompting
= 1;
11937 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11938 doc
: /* Character to see next line of menu prompt.
11939 Type this character while in a menu prompt to rotate around the lines of it. */);
11940 XSETINT (menu_prompt_more_char
, ' ');
11942 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11943 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11944 Emacs applies the modifiers of the character stored here to each keyboard
11945 character it reads. For example, after evaluating the expression
11946 (setq extra-keyboard-modifiers ?\\C-x)
11947 all input characters will have the control modifier applied to them.
11949 Note that the character ?\\C-@, equivalent to the integer zero, does
11950 not count as a control character; rather, it counts as a character
11951 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11952 cancels any modification. */);
11953 extra_keyboard_modifiers
= 0;
11955 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11956 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11957 The command loop sets this to nil before each command,
11958 and tests the value when the command returns.
11959 Buffer modification stores t in this variable. */);
11960 Vdeactivate_mark
= Qnil
;
11961 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
11962 staticpro (&Qdeactivate_mark
);
11964 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11965 doc
: /* Normal hook run before each command is executed.
11966 If an unhandled error happens in running this hook,
11967 the function in which the error occurred is unconditionally removed, since
11968 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11969 Vpre_command_hook
= Qnil
;
11971 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11972 doc
: /* Normal hook run after each command is executed.
11973 If an unhandled error happens in running this hook,
11974 the function in which the error occurred is unconditionally removed, since
11975 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11976 Vpost_command_hook
= Qnil
;
11979 DEFVAR_LISP ("echo-area-clear-hook", ...,
11980 doc
: /* Normal hook run when clearing the echo area. */);
11982 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
11983 staticpro (&Qecho_area_clear_hook
);
11984 Fset (Qecho_area_clear_hook
, Qnil
);
11986 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11987 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11988 Vlucid_menu_bar_dirty_flag
= Qnil
;
11990 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11991 doc
: /* List of menu bar items to move to the end of the menu bar.
11992 The elements of the list are event types that may have menu bar bindings. */);
11993 Vmenu_bar_final_items
= Qnil
;
11995 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11996 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11997 This is used internally by graphical displays that do not render
11998 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11999 Vtool_bar_separator_image_expression
= Qnil
;
12001 DEFVAR_KBOARD ("overriding-terminal-local-map",
12002 Voverriding_terminal_local_map
,
12003 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12004 If this variable is non-nil, it is used as a keymap instead of the
12005 buffer's local map, and the minor mode keymaps and text property keymaps.
12006 It also replaces `overriding-local-map'.
12008 This variable is intended to let commands such as `universal-argument'
12009 set up a different keymap for reading the next command.
12011 `overriding-terminal-local-map' has a separate binding for each
12013 See Info node `(elisp)Multiple Terminals'. */);
12015 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
12016 doc
: /* Keymap that overrides all other local keymaps.
12017 If this variable is non-nil, it is used as a keymap--replacing the
12018 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12019 Voverriding_local_map
= Qnil
;
12021 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
12022 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12023 Otherwise, the menu bar continues to reflect the buffer's local map
12024 and the minor mode maps regardless of `overriding-local-map'. */);
12025 Voverriding_local_map_menu_flag
= Qnil
;
12027 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12028 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12029 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12031 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12032 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12034 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12035 doc
: /* Alist of system-specific X windows key symbols.
12036 Each element should have the form (N . SYMBOL) where N is the
12037 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12038 and SYMBOL is its name.
12040 `system-key-alist' has a separate binding for each terminal device.
12041 See Info node `(elisp)Multiple Terminals'. */);
12043 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12044 doc
: /* Keymap that translates key sequences to key sequences during input.
12045 This is used mainly for mapping key sequences into some preferred
12046 key events (symbols).
12048 The `read-key-sequence' function replaces any subsequence bound by
12049 `local-function-key-map' with its binding. More precisely, when the
12050 active keymaps have no binding for the current key sequence but
12051 `local-function-key-map' binds a suffix of the sequence to a vector or
12052 string, `read-key-sequence' replaces the matching suffix with its
12053 binding, and continues with the new sequence.
12055 If the binding is a function, it is called with one argument (the prompt)
12056 and its return value (a key sequence) is used.
12058 The events that come from bindings in `local-function-key-map' are not
12059 themselves looked up in `local-function-key-map'.
12061 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12062 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12063 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12064 typing `ESC O P x' would return [f1 x].
12066 `local-function-key-map' has a separate binding for each terminal
12067 device. See Info node `(elisp)Multiple Terminals'. If you need to
12068 define a binding on all terminals, change `function-key-map'
12069 instead. Initially, `local-function-key-map' is an empty keymap that
12070 has `function-key-map' as its parent on all terminal devices. */);
12072 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12073 doc
: /* Keymap that decodes input escape sequences.
12074 This is used mainly for mapping ASCII function key sequences into
12075 real Emacs function key events (symbols).
12077 The `read-key-sequence' function replaces any subsequence bound by
12078 `input-decode-map' with its binding. Contrary to `function-key-map',
12079 this map applies its rebinding regardless of the presence of an ordinary
12080 binding. So it is more like `key-translation-map' except that it applies
12081 before `function-key-map' rather than after.
12083 If the binding is a function, it is called with one argument (the prompt)
12084 and its return value (a key sequence) is used.
12086 The events that come from bindings in `input-decode-map' are not
12087 themselves looked up in `input-decode-map'.
12089 This variable is keyboard-local. */);
12091 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12092 doc
: /* The parent keymap of all `local-function-key-map' instances.
12093 Function key definitions that apply to all terminal devices should go
12094 here. If a mapping is defined in both the current
12095 `local-function-key-map' binding and this variable, then the local
12096 definition will take precendence. */);
12097 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12099 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12100 doc
: /* Keymap of key translations that can override keymaps.
12101 This keymap works like `function-key-map', but comes after that,
12102 and its non-prefix bindings override ordinary bindings.
12103 Another difference is that it is global rather than keyboard-local. */);
12104 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12106 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12107 doc
: /* List of deferred actions to be performed at a later time.
12108 The precise format isn't relevant here; we just check whether it is nil. */);
12109 Vdeferred_action_list
= Qnil
;
12111 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12112 doc
: /* Function to call to handle deferred actions, after each command.
12113 This function is called with no arguments after each command
12114 whenever `deferred-action-list' is non-nil. */);
12115 Vdeferred_action_function
= Qnil
;
12117 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12118 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12119 The value can be a length of time to show the message for.
12120 If the value is non-nil and not a number, we wait 2 seconds. */);
12121 Vsuggest_key_bindings
= Qt
;
12123 DEFVAR_LISP ("timer-list", Vtimer_list
,
12124 doc
: /* List of active absolute time timers in order of increasing time. */);
12125 Vtimer_list
= Qnil
;
12127 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12128 doc
: /* List of active idle-time timers in order of increasing time. */);
12129 Vtimer_idle_list
= Qnil
;
12131 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12132 doc
: /* If non-nil, the function that implements the current input method.
12133 It's called with one argument, a printing character that was just read.
12134 \(That means a character with code 040...0176.)
12135 Typically this function uses `read-event' to read additional events.
12136 When it does so, it should first bind `input-method-function' to nil
12137 so it will not be called recursively.
12139 The function should return a list of zero or more events
12140 to be used as input. If it wants to put back some events
12141 to be reconsidered, separately, by the input method,
12142 it can add them to the beginning of `unread-command-events'.
12144 The input method function can find in `input-method-previous-message'
12145 the previous echo area message.
12147 The input method function should refer to the variables
12148 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12149 for guidance on what to do. */);
12150 Vinput_method_function
= Qnil
;
12152 DEFVAR_LISP ("input-method-previous-message",
12153 Vinput_method_previous_message
,
12154 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12155 This variable exists because `read-event' clears the echo area
12156 before running the input method. It is nil if there was no message. */);
12157 Vinput_method_previous_message
= Qnil
;
12159 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12160 doc
: /* If non-nil, the function that implements the display of help.
12161 It's called with one argument, the help string to display. */);
12162 Vshow_help_function
= Qnil
;
12164 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12165 doc
: /* If non-nil, suppress point adjustment after executing a command.
12167 After a command is executed, if point is moved into a region that has
12168 special properties (e.g. composition, display), we adjust point to
12169 the boundary of the region. But, when a command sets this variable to
12170 non-nil, we suppress the point adjustment.
12172 This variable is set to nil before reading a command, and is checked
12173 just after executing the command. */);
12174 Vdisable_point_adjustment
= Qnil
;
12176 DEFVAR_LISP ("global-disable-point-adjustment",
12177 Vglobal_disable_point_adjustment
,
12178 doc
: /* *If non-nil, always suppress point adjustment.
12180 The default value is nil, in which case, point adjustment are
12181 suppressed only after special commands that set
12182 `disable-point-adjustment' (which see) to non-nil. */);
12183 Vglobal_disable_point_adjustment
= Qnil
;
12185 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12186 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12187 If the value is not a number, such messages don't time out. */);
12188 Vminibuffer_message_timeout
= make_number (2);
12190 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12191 doc
: /* If non-nil, any keyboard input throws to this symbol.
12192 The value of that variable is passed to `quit-flag' and later causes a
12193 peculiar kind of quitting. */);
12194 Vthrow_on_input
= Qnil
;
12196 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12197 doc
: /* If non-nil, function to output error messages.
12198 The arguments are the error data, a list of the form
12199 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12200 such as just as `condition-case' would bind its variable to,
12201 the context (a string which normally goes at the start of the message),
12202 and the Lisp function within which the error was signaled. */);
12203 Vcommand_error_function
= Qnil
;
12205 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12206 Venable_disabled_menus_and_buttons
,
12207 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12209 Help functions bind this to allow help on disabled menu items
12210 and tool-bar buttons. */);
12211 Venable_disabled_menus_and_buttons
= Qnil
;
12213 DEFVAR_LISP ("select-active-regions",
12214 Vselect_active_regions
,
12215 doc
: /* If non-nil, an active region automatically sets the primary selection.
12216 If the value is `only', only temporarily active regions (usually made
12217 by mouse-dragging or shift-selection) set the window selection.
12219 This takes effect only when Transient Mark mode is enabled. */);
12220 Vselect_active_regions
= Qt
;
12222 DEFVAR_LISP ("saved-region-selection",
12223 Vsaved_region_selection
,
12224 doc
: /* Contents of active region prior to buffer modification.
12225 If `select-active-regions' is non-nil, Emacs sets this to the
12226 text in the region before modifying the buffer. The next
12227 `deactivate-mark' call uses this to set the window selection. */);
12228 Vsaved_region_selection
= Qnil
;
12230 /* Create the initial keyboard. */
12231 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12232 init_kboard (initial_kboard
);
12233 /* Vwindow_system is left at t for now. */
12234 initial_kboard
->next_kboard
= all_kboards
;
12235 all_kboards
= initial_kboard
;
12239 keys_of_keyboard (void)
12241 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12242 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12243 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12244 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12245 initial_define_key (meta_map
, 'x', "execute-extended-command");
12247 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12248 "handle-delete-frame");
12249 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12250 "ns-put-working-text");
12251 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12252 "ns-unput-working-text");
12253 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12254 current-prefix-arg, as is done in `handle-switch-frame'.
12255 But `handle-switch-frame is not run from the special-map.
12256 Commands from that map are run in a special way that automatically
12257 preserves the prefix-arg. Restoring the prefix arg here is not just
12258 redundant but harmful:
12260 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12261 - after the first prompt, the exit-minibuffer-hook is run which may
12262 iconify a frame and thus push a `iconify-frame' event.
12263 - after running exit-minibuffer-hook, current-prefix-arg is
12264 restored to the non-nil value it had before the prompt.
12265 - we enter the second prompt.
12266 current-prefix-arg is non-nil, prefix-arg is nil.
12267 - before running the first real event, we run the special iconify-frame
12268 event, but we pass the `special' arg to execute-command so
12269 current-prefix-arg and prefix-arg are left untouched.
12270 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12271 - the next key event will have a spuriously non-nil current-prefix-arg. */
12272 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12274 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12276 /* Handling it at such a low-level causes read_key_sequence to get
12277 * confused because it doesn't realize that the current_buffer was
12278 * changed by read_char.
12280 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12281 * "handle-select-window"); */
12282 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12283 "handle-save-session");
12286 /* Define a special event which is raised for dbus callback
12288 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12289 "dbus-handle-event");
12292 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12296 /* Mark the pointers in the kboard objects.
12297 Called by the Fgarbage_collector. */
12299 mark_kboards (void)
12303 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12305 if (kb
->kbd_macro_buffer
)
12306 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12308 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12309 mark_object (KVAR (kb
, Vlast_command
));
12310 mark_object (KVAR (kb
, Vreal_last_command
));
12311 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12312 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12313 mark_object (KVAR (kb
, Vprefix_arg
));
12314 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12315 mark_object (KVAR (kb
, kbd_queue
));
12316 mark_object (KVAR (kb
, defining_kbd_macro
));
12317 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12318 mark_object (KVAR (kb
, Vsystem_key_alist
));
12319 mark_object (KVAR (kb
, system_key_syms
));
12320 mark_object (KVAR (kb
, Vwindow_system
));
12321 mark_object (KVAR (kb
, Vinput_decode_map
));
12322 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12323 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12324 mark_object (KVAR (kb
, echo_string
));
12327 struct input_event
*event
;
12328 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12330 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12331 event
= kbd_buffer
;
12332 if (event
->kind
!= SELECTION_REQUEST_EVENT
12333 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12335 mark_object (event
->x
);
12336 mark_object (event
->y
);
12338 mark_object (event
->frame_or_window
);
12339 mark_object (event
->arg
);