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 return internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1876 /* If we get an error while running the hook, cause the hook variable
1877 to be nil. Also inhibit quits, so that C-g won't cause the hook
1878 to mysteriously evaporate. */
1881 safe_run_hooks (Lisp_Object hook
)
1883 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1884 to its body or to its handlers other than via globals such as
1885 dynamically-bound variables ;-) */
1886 int count
= SPECPDL_INDEX ();
1887 specbind (Qinhibit_quit
, hook
);
1889 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1891 unbind_to (count
, Qnil
);
1895 /* Nonzero means polling for input is temporarily suppressed. */
1897 int poll_suppress_count
;
1899 /* Asynchronous timer for polling. */
1901 struct atimer
*poll_timer
;
1904 #ifdef POLL_FOR_INPUT
1906 /* Poll for input, so that we catch a C-g if it comes in. This
1907 function is called from x_make_frame_visible, see comment
1911 poll_for_input_1 (void)
1913 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1914 doing anything dangerous. */
1918 if (interrupt_input_blocked
== 0
1919 && !waiting_for_input
)
1920 read_avail_input (0);
1926 /* Timer callback function for poll_timer. TIMER is equal to
1930 poll_for_input (struct atimer
*timer
)
1932 if (poll_suppress_count
== 0)
1935 interrupt_input_pending
= 1;
1936 pending_signals
= 1;
1938 poll_for_input_1 ();
1943 #endif /* POLL_FOR_INPUT */
1945 /* Begin signals to poll for input, if they are appropriate.
1946 This function is called unconditionally from various places. */
1949 start_polling (void)
1951 #ifdef POLL_FOR_INPUT
1952 /* XXX This condition was (read_socket_hook && !interrupt_input),
1953 but read_socket_hook is not global anymore. Let's pretend that
1955 if (!interrupt_input
)
1957 /* Turn alarm handling on unconditionally. It might have
1958 been turned off in process.c. */
1959 turn_on_atimers (1);
1961 /* If poll timer doesn't exist, are we need one with
1962 a different interval, start a new one. */
1963 if (poll_timer
== NULL
1964 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1966 EMACS_TIME interval
;
1969 cancel_atimer (poll_timer
);
1971 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1972 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1973 poll_for_input
, NULL
);
1976 /* Let the timer's callback function poll for input
1977 if this becomes zero. */
1978 --poll_suppress_count
;
1983 /* Nonzero if we are using polling to handle input asynchronously. */
1986 input_polling_used (void)
1988 #ifdef POLL_FOR_INPUT
1989 /* XXX This condition was (read_socket_hook && !interrupt_input),
1990 but read_socket_hook is not global anymore. Let's pretend that
1992 return !interrupt_input
;
1998 /* Turn off polling. */
2003 #ifdef POLL_FOR_INPUT
2004 /* XXX This condition was (read_socket_hook && !interrupt_input),
2005 but read_socket_hook is not global anymore. Let's pretend that
2007 if (!interrupt_input
)
2008 ++poll_suppress_count
;
2012 /* Set the value of poll_suppress_count to COUNT
2013 and start or stop polling accordingly. */
2016 set_poll_suppress_count (int count
)
2018 #ifdef POLL_FOR_INPUT
2019 if (count
== 0 && poll_suppress_count
!= 0)
2021 poll_suppress_count
= 1;
2024 else if (count
!= 0 && poll_suppress_count
== 0)
2028 poll_suppress_count
= count
;
2032 /* Bind polling_period to a value at least N.
2033 But don't decrease it. */
2036 bind_polling_period (int n
)
2038 #ifdef POLL_FOR_INPUT
2039 int new = polling_period
;
2044 stop_other_atimers (poll_timer
);
2046 specbind (Qpolling_period
, make_number (new));
2047 /* Start a new alarm with the new period. */
2052 /* Apply the control modifier to CHARACTER. */
2055 make_ctrl_char (int c
)
2057 /* Save the upper bits here. */
2058 int upper
= c
& ~0177;
2060 if (! ASCII_BYTE_P (c
))
2061 return c
|= ctrl_modifier
;
2065 /* Everything in the columns containing the upper-case letters
2066 denotes a control character. */
2067 if (c
>= 0100 && c
< 0140)
2071 /* Set the shift modifier for a control char
2072 made from a shifted letter. But only for letters! */
2073 if (oc
>= 'A' && oc
<= 'Z')
2074 c
|= shift_modifier
;
2077 /* The lower-case letters denote control characters too. */
2078 else if (c
>= 'a' && c
<= 'z')
2081 /* Include the bits for control and shift
2082 only if the basic ASCII code can't indicate them. */
2086 /* Replace the high bits. */
2087 c
|= (upper
& ~ctrl_modifier
);
2092 /* Display the help-echo property of the character after the mouse pointer.
2093 Either show it in the echo area, or call show-help-function to display
2094 it by other means (maybe in a tooltip).
2096 If HELP is nil, that means clear the previous help echo.
2098 If HELP is a string, display that string. If HELP is a function,
2099 call it with OBJECT and POS as arguments; the function should
2100 return a help string or nil for none. For all other types of HELP,
2101 evaluate it to obtain a string.
2103 WINDOW is the window in which the help was generated, if any.
2104 It is nil if not in a window.
2106 If OBJECT is a buffer, POS is the position in the buffer where the
2107 `help-echo' text property was found.
2109 If OBJECT is an overlay, that overlay has a `help-echo' property,
2110 and POS is the position in the overlay's buffer under the mouse.
2112 If OBJECT is a string (an overlay string or a string displayed with
2113 the `display' property). POS is the position in that string under
2116 Note: this function may only be called with HELP nil or a string
2117 from X code running asynchronously. */
2120 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2123 if (!NILP (help
) && !STRINGP (help
))
2125 if (FUNCTIONP (help
))
2127 Lisp_Object args
[4];
2132 help
= safe_call (4, args
);
2135 help
= safe_eval (help
);
2137 if (!STRINGP (help
))
2141 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2142 if (!noninteractive
&& STRINGP (help
))
2144 /* The mouse-fixup-help-message Lisp function can call
2145 mouse_position_hook, which resets the mouse_moved flags.
2146 This causes trouble if we are trying to read a mouse motion
2147 event (i.e., if we are inside a `track-mouse' form), so we
2148 restore the mouse_moved flag. */
2149 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2150 help
= call1 (Qmouse_fixup_help_message
, help
);
2156 if (STRINGP (help
) || NILP (help
))
2158 if (!NILP (Vshow_help_function
))
2159 call1 (Vshow_help_function
, help
);
2160 help_echo_showing_p
= STRINGP (help
);
2166 /* Input of single characters from keyboard */
2168 Lisp_Object
print_help (Lisp_Object object
);
2169 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2170 struct timeval
*end_time
);
2171 static void record_char (Lisp_Object c
);
2173 static Lisp_Object help_form_saved_window_configs
;
2175 read_char_help_form_unwind (Lisp_Object arg
)
2177 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2178 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2179 if (!NILP (window_config
))
2180 Fset_window_configuration (window_config
);
2184 #define STOP_POLLING \
2185 do { if (! polling_stopped_here) stop_polling (); \
2186 polling_stopped_here = 1; } while (0)
2188 #define RESUME_POLLING \
2189 do { if (polling_stopped_here) start_polling (); \
2190 polling_stopped_here = 0; } while (0)
2192 /* read a character from the keyboard; call the redisplay if needed */
2193 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2194 -1 means do not do redisplay, but do do autosaving.
2197 /* The arguments MAPS and NMAPS are for menu prompting.
2198 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2200 PREV_EVENT is the previous input event, or nil if we are reading
2201 the first event of a key sequence (or not reading a key sequence).
2202 If PREV_EVENT is t, that is a "magic" value that says
2203 not to run input methods, but in other respects to act as if
2204 not reading a key sequence.
2206 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2207 if we used a mouse menu to read the input, or zero otherwise. If
2208 USED_MOUSE_MENU is null, we don't dereference it.
2210 Value is -2 when we find input on another keyboard. A second call
2211 to read_char will read it.
2213 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2214 specifying the maximum time to wait until. If no input arrives by
2215 that time, stop waiting and return nil.
2217 Value is t if we showed a menu and the user rejected it. */
2220 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2221 int *used_mouse_menu
, struct timeval
*end_time
)
2223 volatile Lisp_Object c
;
2225 jmp_buf local_getcjmp
;
2227 volatile int key_already_recorded
= 0;
2228 Lisp_Object tem
, save
;
2229 volatile Lisp_Object previous_echo_area_message
;
2230 volatile Lisp_Object also_record
;
2231 volatile int reread
;
2232 struct gcpro gcpro1
, gcpro2
;
2233 int polling_stopped_here
= 0;
2234 struct kboard
*orig_kboard
= current_kboard
;
2238 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2239 before_command_key_count
= this_command_key_count
;
2240 before_command_echo_length
= echo_length ();
2243 previous_echo_area_message
= Qnil
;
2245 GCPRO2 (c
, previous_echo_area_message
);
2250 if (CONSP (Vunread_post_input_method_events
))
2252 c
= XCAR (Vunread_post_input_method_events
);
2253 Vunread_post_input_method_events
2254 = XCDR (Vunread_post_input_method_events
);
2256 /* Undo what read_char_x_menu_prompt did when it unread
2257 additional keys returned by Fx_popup_menu. */
2259 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2267 if (unread_command_char
!= -1)
2269 XSETINT (c
, unread_command_char
);
2270 unread_command_char
= -1;
2276 if (CONSP (Vunread_command_events
))
2278 int was_disabled
= 0;
2280 c
= XCAR (Vunread_command_events
);
2281 Vunread_command_events
= XCDR (Vunread_command_events
);
2285 /* Undo what sit-for did when it unread additional keys
2286 inside universal-argument. */
2289 && EQ (XCAR (c
), Qt
))
2295 /* Undo what read_char_x_menu_prompt did when it unread
2296 additional keys returned by Fx_popup_menu. */
2298 && EQ (XCDR (c
), Qdisabled
)
2299 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2305 /* If the queued event is something that used the mouse,
2306 set used_mouse_menu accordingly. */
2308 /* Also check was_disabled so last-nonmenu-event won't return
2309 a bad value when submenus are involved. (Bug#447) */
2310 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2311 *used_mouse_menu
= 1;
2313 goto reread_for_input_method
;
2316 if (CONSP (Vunread_input_method_events
))
2318 c
= XCAR (Vunread_input_method_events
);
2319 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2321 /* Undo what read_char_x_menu_prompt did when it unread
2322 additional keys returned by Fx_popup_menu. */
2324 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2328 goto reread_for_input_method
;
2331 this_command_key_count_reset
= 0;
2333 if (!NILP (Vexecuting_kbd_macro
))
2335 /* We set this to Qmacro; since that's not a frame, nobody will
2336 try to switch frames on us, and the selected window will
2339 Since this event came from a macro, it would be misleading to
2340 leave internal_last_event_frame set to wherever the last
2341 real event came from. Normally, a switch-frame event selects
2342 internal_last_event_frame after each command is read, but
2343 events read from a macro should never cause a new frame to be
2345 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2347 /* Exit the macro if we are at the end.
2348 Also, some things replace the macro with t
2349 to force an early exit. */
2350 if (EQ (Vexecuting_kbd_macro
, Qt
)
2351 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2357 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2358 if (STRINGP (Vexecuting_kbd_macro
)
2359 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2360 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2362 executing_kbd_macro_index
++;
2367 if (!NILP (unread_switch_frame
))
2369 c
= unread_switch_frame
;
2370 unread_switch_frame
= Qnil
;
2372 /* This event should make it into this_command_keys, and get echoed
2373 again, so we do not set `reread'. */
2377 /* if redisplay was requested */
2378 if (commandflag
>= 0)
2380 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2382 /* If there is pending input, process any events which are not
2383 user-visible, such as X selection_request events. */
2385 || detect_input_pending_run_timers (0))
2386 swallow_events (0); /* may clear input_pending */
2388 /* Redisplay if no pending input. */
2389 while (!input_pending
)
2391 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2392 redisplay_preserve_echo_area (5);
2397 /* Normal case: no input arrived during redisplay. */
2400 /* Input arrived and pre-empted redisplay.
2401 Process any events which are not user-visible. */
2403 /* If that cleared input_pending, try again to redisplay. */
2406 /* Prevent the redisplay we just did
2407 from messing up echoing of the input after the prompt. */
2408 if (commandflag
== 0 && echo_current
)
2409 echo_message_buffer
= echo_area_buffer
[0];
2413 /* Message turns off echoing unless more keystrokes turn it on again.
2415 The code in 20.x for the condition was
2417 1. echo_area_glyphs && *echo_area_glyphs
2418 2. && echo_area_glyphs != current_kboard->echobuf
2419 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2421 (1) means there's a current message displayed
2423 (2) means it's not the message from echoing from the current
2426 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2427 is set to a non-null value. This is done in read_char and it is
2428 set to echo_area_glyphs after a call to echo_char. That means
2429 ok_to_echo_at_next_pause is either null or
2430 current_kboard->echobuf with the appropriate current_kboard at
2433 So, condition (3) means in clear text ok_to_echo_at_next_pause
2434 must be either null, or the current message isn't from echoing at
2435 all, or it's from echoing from a different kboard than the
2438 if (/* There currently is something in the echo area. */
2439 !NILP (echo_area_buffer
[0])
2440 && (/* And it's either not from echoing. */
2441 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2442 /* Or it's an echo from a different kboard. */
2443 || echo_kboard
!= current_kboard
2444 /* Or we explicitly allow overwriting whatever there is. */
2445 || ok_to_echo_at_next_pause
== NULL
))
2450 /* Try reading a character via menu prompting in the minibuf.
2451 Try this before the sit-for, because the sit-for
2452 would do the wrong thing if we are supposed to do
2453 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2454 after a mouse event so don't try a minibuf menu. */
2456 if (nmaps
> 0 && INTERACTIVE
2457 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2458 /* Don't bring up a menu if we already have another event. */
2459 && NILP (Vunread_command_events
)
2460 && unread_command_char
< 0
2461 && !detect_input_pending_run_timers (0))
2463 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2465 if (INTEGERP (c
) && XINT (c
) == -2)
2466 return c
; /* wrong_kboard_jmpbuf */
2470 key_already_recorded
= 1;
2475 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2476 We will do that below, temporarily for short sections of code,
2477 when appropriate. local_getcjmp must be in effect
2478 around any call to sit_for or kbd_buffer_get_event;
2479 it *must not* be in effect when we call redisplay. */
2481 jmpcount
= SPECPDL_INDEX ();
2482 if (_setjmp (local_getcjmp
))
2484 /* Handle quits while reading the keyboard. */
2485 /* We must have saved the outer value of getcjmp here,
2486 so restore it now. */
2487 restore_getcjmp (save_jump
);
2488 unbind_to (jmpcount
, Qnil
);
2489 XSETINT (c
, quit_char
);
2490 internal_last_event_frame
= selected_frame
;
2491 Vlast_event_frame
= internal_last_event_frame
;
2492 /* If we report the quit char as an event,
2493 don't do so more than once. */
2494 if (!NILP (Vinhibit_quit
))
2498 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2499 if (kb
!= current_kboard
)
2501 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2502 /* We shouldn't get here if we were in single-kboard mode! */
2507 while (CONSP (XCDR (last
)))
2509 if (!NILP (XCDR (last
)))
2513 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2515 XSETCDR (last
, Fcons (c
, Qnil
));
2516 kb
->kbd_queue_has_data
= 1;
2517 current_kboard
= kb
;
2518 /* This is going to exit from read_char
2519 so we had better get rid of this frame's stuff. */
2521 return make_number (-2); /* wrong_kboard_jmpbuf */
2527 /* Start idle timers if no time limit is supplied. We don't do it
2528 if a time limit is supplied to avoid an infinite recursion in the
2529 situation where an idle timer calls `sit-for'. */
2532 timer_start_idle ();
2534 /* If in middle of key sequence and minibuffer not active,
2535 start echoing if enough time elapses. */
2537 if (minibuf_level
== 0
2539 && !current_kboard
->immediate_echo
2540 && this_command_key_count
> 0
2542 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2543 && NILP (Fzerop (Vecho_keystrokes
))
2544 && (/* No message. */
2545 NILP (echo_area_buffer
[0])
2546 /* Or empty message. */
2547 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2548 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2549 /* Or already echoing from same kboard. */
2550 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2551 /* Or not echoing before and echoing allowed. */
2552 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2554 /* After a mouse event, start echoing right away.
2555 This is because we are probably about to display a menu,
2556 and we don't want to delay before doing so. */
2557 if (EVENT_HAS_PARAMETERS (prev_event
))
2563 save_getcjmp (save_jump
);
2564 restore_getcjmp (local_getcjmp
);
2565 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2566 restore_getcjmp (save_jump
);
2568 && ! CONSP (Vunread_command_events
))
2573 /* Maybe auto save due to number of keystrokes. */
2575 if (commandflag
!= 0
2576 && auto_save_interval
> 0
2577 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2578 && !detect_input_pending_run_timers (0))
2580 Fdo_auto_save (Qnil
, Qnil
);
2581 /* Hooks can actually change some buffers in auto save. */
2585 /* Try reading using an X menu.
2586 This is never confused with reading using the minibuf
2587 because the recursive call of read_char in read_char_minibuf_menu_prompt
2588 does not pass on any keymaps. */
2590 if (nmaps
> 0 && INTERACTIVE
2591 && !NILP (prev_event
)
2592 && EVENT_HAS_PARAMETERS (prev_event
)
2593 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2594 && !EQ (XCAR (prev_event
), Qtool_bar
)
2595 /* Don't bring up a menu if we already have another event. */
2596 && NILP (Vunread_command_events
)
2597 && unread_command_char
< 0)
2599 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2601 /* Now that we have read an event, Emacs is not idle. */
2608 /* Maybe autosave and/or garbage collect due to idleness. */
2610 if (INTERACTIVE
&& NILP (c
))
2613 EMACS_INT buffer_size
;
2615 /* Slow down auto saves logarithmically in size of current buffer,
2616 and garbage collect while we're at it. */
2617 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2618 last_non_minibuf_size
= Z
- BEG
;
2619 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2621 while (buffer_size
> 64)
2622 delay_level
++, buffer_size
-= buffer_size
>> 2;
2623 if (delay_level
< 4) delay_level
= 4;
2624 /* delay_level is 4 for files under around 50k, 7 at 100k,
2625 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2627 /* Auto save if enough time goes by without input. */
2628 if (commandflag
!= 0
2629 && num_nonmacro_input_events
> last_auto_save
2630 && INTEGERP (Vauto_save_timeout
)
2631 && XINT (Vauto_save_timeout
) > 0)
2634 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2636 save_getcjmp (save_jump
);
2637 restore_getcjmp (local_getcjmp
);
2638 tem0
= sit_for (make_number (timeout
), 1, 1);
2639 restore_getcjmp (save_jump
);
2642 && ! CONSP (Vunread_command_events
))
2644 Fdo_auto_save (Qnil
, Qnil
);
2646 /* If we have auto-saved and there is still no input
2647 available, garbage collect if there has been enough
2648 consing going on to make it worthwhile. */
2649 if (!detect_input_pending_run_timers (0)
2650 && consing_since_gc
> gc_cons_threshold
/ 2)
2651 Fgarbage_collect ();
2658 /* Notify the caller if an autosave hook, or a timer, sentinel or
2659 filter in the sit_for calls above have changed the current
2660 kboard. This could happen if they use the minibuffer or start a
2661 recursive edit, like the fancy splash screen in server.el's
2662 filter. If this longjmp wasn't here, read_key_sequence would
2663 interpret the next key sequence using the wrong translation
2664 tables and function keymaps. */
2665 if (NILP (c
) && current_kboard
!= orig_kboard
)
2668 return make_number (-2); /* wrong_kboard_jmpbuf */
2671 /* If this has become non-nil here, it has been set by a timer
2672 or sentinel or filter. */
2673 if (CONSP (Vunread_command_events
))
2675 c
= XCAR (Vunread_command_events
);
2676 Vunread_command_events
= XCDR (Vunread_command_events
);
2679 /* Read something from current KBOARD's side queue, if possible. */
2683 if (current_kboard
->kbd_queue_has_data
)
2685 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2687 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2688 KVAR (current_kboard
, kbd_queue
)
2689 = XCDR (KVAR (current_kboard
, kbd_queue
));
2690 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2691 current_kboard
->kbd_queue_has_data
= 0;
2692 input_pending
= readable_events (0);
2693 if (EVENT_HAS_PARAMETERS (c
)
2694 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2695 internal_last_event_frame
= XCAR (XCDR (c
));
2696 Vlast_event_frame
= internal_last_event_frame
;
2700 /* If current_kboard's side queue is empty check the other kboards.
2701 If one of them has data that we have not yet seen here,
2702 switch to it and process the data waiting for it.
2704 Note: if the events queued up for another kboard
2705 have already been seen here, and therefore are not a complete command,
2706 the kbd_queue_has_data field is 0, so we skip that kboard here.
2707 That's to avoid an infinite loop switching between kboards here. */
2708 if (NILP (c
) && !single_kboard
)
2711 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2712 if (kb
->kbd_queue_has_data
)
2714 current_kboard
= kb
;
2715 /* This is going to exit from read_char
2716 so we had better get rid of this frame's stuff. */
2718 return make_number (-2); /* wrong_kboard_jmpbuf */
2726 /* Finally, we read from the main queue,
2727 and if that gives us something we can't use yet, we put it on the
2728 appropriate side queue and try again. */
2732 KBOARD
*kb
IF_LINT (= NULL
);
2737 EMACS_GET_TIME (now
);
2738 if (EMACS_TIME_GE (now
, *end_time
))
2742 /* Actually read a character, waiting if necessary. */
2743 save_getcjmp (save_jump
);
2744 restore_getcjmp (local_getcjmp
);
2746 timer_start_idle ();
2747 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2748 restore_getcjmp (save_jump
);
2750 if (! NILP (c
) && (kb
!= current_kboard
))
2752 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2755 while (CONSP (XCDR (last
)))
2757 if (!NILP (XCDR (last
)))
2761 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2763 XSETCDR (last
, Fcons (c
, Qnil
));
2764 kb
->kbd_queue_has_data
= 1;
2768 current_kboard
= kb
;
2769 /* This is going to exit from read_char
2770 so we had better get rid of this frame's stuff. */
2772 return make_number (-2);
2776 /* Terminate Emacs in batch mode if at eof. */
2777 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2778 Fkill_emacs (make_number (1));
2782 /* Add in any extra modifiers, where appropriate. */
2783 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2784 || ((extra_keyboard_modifiers
& 0177) < ' '
2785 && (extra_keyboard_modifiers
& 0177) != 0))
2786 XSETINT (c
, make_ctrl_char (XINT (c
)));
2788 /* Transfer any other modifier bits directly from
2789 extra_keyboard_modifiers to c. Ignore the actual character code
2790 in the low 16 bits of extra_keyboard_modifiers. */
2791 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2802 if (commandflag
>= 0
2803 && !input_pending
&& !detect_input_pending_run_timers (0))
2811 /* Buffer switch events are only for internal wakeups
2812 so don't show them to the user.
2813 Also, don't record a key if we already did. */
2814 if (BUFFERP (c
) || key_already_recorded
)
2817 /* Process special events within read_char
2818 and loop around to read another event. */
2821 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2826 struct buffer
*prev_buffer
= current_buffer
;
2827 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2828 int was_locked
= single_kboard
;
2829 int count
= SPECPDL_INDEX ();
2830 record_single_kboard_state ();
2833 last_input_event
= c
;
2834 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2836 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2837 /* We stopped being idle for this event; undo that. This
2838 prevents automatic window selection (under
2839 mouse_autoselect_window from acting as a real input event, for
2840 example banishing the mouse under mouse-avoidance-mode. */
2841 timer_resume_idle ();
2843 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2844 /* Resume allowing input from any kboard, if that was true before. */
2846 any_kboard_state ();
2847 unbind_to (count
, Qnil
);
2850 if (current_buffer
!= prev_buffer
)
2852 /* The command may have changed the keymaps. Pretend there
2853 is input in another keyboard and return. This will
2854 recalculate keymaps. */
2855 c
= make_number (-2);
2862 /* Handle things that only apply to characters. */
2865 /* If kbd_buffer_get_event gave us an EOF, return that. */
2869 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2870 && SCHARS (KVAR (current_kboard
, Vkeyboard_translate_table
)) > (unsigned) XFASTINT (c
))
2871 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2872 && XVECTOR (KVAR (current_kboard
, Vkeyboard_translate_table
))->size
> (unsigned) XFASTINT (c
))
2873 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2877 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2878 /* nil in keyboard-translate-table means no translation. */
2884 /* If this event is a mouse click in the menu bar,
2885 return just menu-bar for now. Modify the mouse click event
2886 so we won't do this twice, then queue it up. */
2887 if (EVENT_HAS_PARAMETERS (c
)
2889 && CONSP (EVENT_START (c
))
2890 && CONSP (XCDR (EVENT_START (c
))))
2894 posn
= POSN_POSN (EVENT_START (c
));
2895 /* Handle menu-bar events:
2896 insert the dummy prefix event `menu-bar'. */
2897 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2899 /* Change menu-bar to (menu-bar) as the event "position". */
2900 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2903 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2908 /* Store these characters into recent_keys, the dribble file if any,
2909 and the keyboard macro being defined, if any. */
2911 if (! NILP (also_record
))
2912 record_char (also_record
);
2914 /* Wipe the echo area.
2915 But first, if we are about to use an input method,
2916 save the echo area contents for it to refer to. */
2918 && ! NILP (Vinput_method_function
)
2919 && (unsigned) XINT (c
) >= ' '
2920 && (unsigned) XINT (c
) != 127
2921 && (unsigned) XINT (c
) < 256)
2923 previous_echo_area_message
= Fcurrent_message ();
2924 Vinput_method_previous_message
= previous_echo_area_message
;
2927 /* Now wipe the echo area, except for help events which do their
2928 own stuff with the echo area. */
2930 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2931 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2933 if (!NILP (echo_area_buffer
[0]))
2934 safe_run_hooks (Qecho_area_clear_hook
);
2935 clear_message (1, 0);
2938 reread_for_input_method
:
2940 /* Pass this to the input method, if appropriate. */
2942 && ! NILP (Vinput_method_function
)
2943 /* Don't run the input method within a key sequence,
2944 after the first event of the key sequence. */
2945 && NILP (prev_event
)
2946 && (unsigned) XINT (c
) >= ' '
2947 && (unsigned) XINT (c
) != 127
2948 && (unsigned) XINT (c
) < 256)
2951 int key_count
, key_count_reset
;
2952 struct gcpro inner_gcpro1
;
2953 int count
= SPECPDL_INDEX ();
2955 /* Save the echo status. */
2956 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2957 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2958 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2959 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2962 if (before_command_restore_flag
)
2964 this_command_key_count
= before_command_key_count_1
;
2965 if (this_command_key_count
< this_single_command_key_start
)
2966 this_single_command_key_start
= this_command_key_count
;
2967 echo_truncate (before_command_echo_length_1
);
2968 before_command_restore_flag
= 0;
2972 /* Save the this_command_keys status. */
2973 key_count
= this_command_key_count
;
2974 key_count_reset
= this_command_key_count_reset
;
2977 keys
= Fcopy_sequence (this_command_keys
);
2980 GCPRO1_VAR (keys
, inner_gcpro
);
2982 /* Clear out this_command_keys. */
2983 this_command_key_count
= 0;
2984 this_command_key_count_reset
= 0;
2986 /* Now wipe the echo area. */
2987 if (!NILP (echo_area_buffer
[0]))
2988 safe_run_hooks (Qecho_area_clear_hook
);
2989 clear_message (1, 0);
2992 /* If we are not reading a key sequence,
2993 never use the echo area. */
2996 specbind (Qinput_method_use_echo_area
, Qt
);
2999 /* Call the input method. */
3000 tem
= call1 (Vinput_method_function
, c
);
3002 tem
= unbind_to (count
, tem
);
3004 /* Restore the saved echoing state
3005 and this_command_keys state. */
3006 this_command_key_count
= key_count
;
3007 this_command_key_count_reset
= key_count_reset
;
3009 this_command_keys
= keys
;
3012 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3013 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3014 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3015 if (saved_immediate_echo
)
3018 UNGCPRO_VAR (inner_gcpro
);
3020 /* The input method can return no events. */
3023 /* Bring back the previous message, if any. */
3024 if (! NILP (previous_echo_area_message
))
3025 message_with_string ("%s", previous_echo_area_message
, 0);
3028 /* It returned one event or more. */
3030 Vunread_post_input_method_events
3031 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3036 /* Display help if not echoing. */
3037 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3039 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3040 Lisp_Object help
, object
, position
, window
, htem
;
3042 htem
= Fcdr (XCDR (c
));
3045 window
= Fcar (htem
);
3047 object
= Fcar (htem
);
3049 position
= Fcar (htem
);
3051 show_help_echo (help
, window
, object
, position
);
3053 /* We stopped being idle for this event; undo that. */
3055 timer_resume_idle ();
3059 if ((! reread
|| this_command_key_count
== 0
3060 || this_command_key_count_reset
)
3064 /* Don't echo mouse motion events. */
3065 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3066 && NILP (Fzerop (Vecho_keystrokes
))
3067 && ! (EVENT_HAS_PARAMETERS (c
)
3068 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3071 if (! NILP (also_record
))
3072 echo_char (also_record
);
3073 /* Once we reread a character, echoing can happen
3074 the next time we pause to read a new one. */
3075 ok_to_echo_at_next_pause
= current_kboard
;
3078 /* Record this character as part of the current key. */
3079 add_command_key (c
);
3080 if (! NILP (also_record
))
3081 add_command_key (also_record
);
3084 last_input_event
= c
;
3087 /* Process the help character specially if enabled */
3088 if (!NILP (Vhelp_form
) && help_char_p (c
))
3091 int count
= SPECPDL_INDEX ();
3093 help_form_saved_window_configs
3094 = Fcons (Fcurrent_window_configuration (Qnil
),
3095 help_form_saved_window_configs
);
3096 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3098 tem0
= Feval (Vhelp_form
, Qnil
);
3100 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3105 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3106 if (EVENT_HAS_PARAMETERS (c
)
3107 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3108 XSETCAR (help_form_saved_window_configs
, Qnil
);
3110 while (BUFFERP (c
));
3111 /* Remove the help from the frame */
3112 unbind_to (count
, Qnil
);
3115 if (EQ (c
, make_number (040)))
3119 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3120 while (BUFFERP (c
));
3129 /* Record a key that came from a mouse menu.
3130 Record it for echoing, for this-command-keys, and so on. */
3133 record_menu_key (Lisp_Object c
)
3135 /* Wipe the echo area. */
3136 clear_message (1, 0);
3141 before_command_key_count
= this_command_key_count
;
3142 before_command_echo_length
= echo_length ();
3145 /* Don't echo mouse motion events. */
3146 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3147 && NILP (Fzerop (Vecho_keystrokes
)))
3151 /* Once we reread a character, echoing can happen
3152 the next time we pause to read a new one. */
3153 ok_to_echo_at_next_pause
= 0;
3156 /* Record this character as part of the current key. */
3157 add_command_key (c
);
3159 /* Re-reading in the middle of a command */
3160 last_input_event
= c
;
3164 /* Return 1 if should recognize C as "the help character". */
3167 help_char_p (Lisp_Object c
)
3171 if (EQ (c
, Vhelp_char
))
3173 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3174 if (EQ (c
, XCAR (tail
)))
3179 /* Record the input event C in various ways. */
3182 record_char (Lisp_Object c
)
3186 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3188 /* To avoid filling recent_keys with help-echo and mouse-movement
3189 events, we filter out repeated help-echo events, only store the
3190 first and last in a series of mouse-movement events, and don't
3191 store repeated help-echo events which are only separated by
3192 mouse-movement events. */
3194 Lisp_Object ev1
, ev2
, ev3
;
3197 if ((ix1
= recent_keys_index
- 1) < 0)
3198 ix1
= NUM_RECENT_KEYS
- 1;
3199 ev1
= AREF (recent_keys
, ix1
);
3201 if ((ix2
= ix1
- 1) < 0)
3202 ix2
= NUM_RECENT_KEYS
- 1;
3203 ev2
= AREF (recent_keys
, ix2
);
3205 if ((ix3
= ix2
- 1) < 0)
3206 ix3
= NUM_RECENT_KEYS
- 1;
3207 ev3
= AREF (recent_keys
, ix3
);
3209 if (EQ (XCAR (c
), Qhelp_echo
))
3211 /* Don't record `help-echo' in recent_keys unless it shows some help
3212 message, and a different help than the previously recorded
3214 Lisp_Object help
, last_help
;
3216 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3217 if (!STRINGP (help
))
3219 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3220 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3222 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3223 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3224 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3226 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3227 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3228 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3229 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3232 else if (EQ (XCAR (c
), Qmouse_movement
))
3234 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3235 So additional mouse movement events replace the last element. */
3236 Lisp_Object last_window
, window
;
3238 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3239 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3240 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3241 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3242 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3244 ASET (recent_keys
, ix1
, c
);
3250 store_kbd_macro_char (c
);
3255 ASET (recent_keys
, recent_keys_index
, c
);
3256 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3257 recent_keys_index
= 0;
3259 else if (recorded
< 0)
3261 /* We need to remove one or two events from recent_keys.
3262 To do this, we simply put nil at those events and move the
3263 recent_keys_index backwards over those events. Usually,
3264 users will never see those nil events, as they will be
3265 overwritten by the command keys entered to see recent_keys
3268 while (recorded
++ < 0 && total_keys
> 0)
3270 if (total_keys
< NUM_RECENT_KEYS
)
3272 if (--recent_keys_index
< 0)
3273 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3274 ASET (recent_keys
, recent_keys_index
, Qnil
);
3278 num_nonmacro_input_events
++;
3280 /* Write c to the dribble file. If c is a lispy event, write
3281 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3282 If you, dear reader, have a better idea, you've got the source. :-) */
3288 if (XUINT (c
) < 0x100)
3289 putc (XINT (c
), dribble
);
3291 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3295 Lisp_Object dribblee
;
3297 /* If it's a structured event, take the event header. */
3298 dribblee
= EVENT_HEAD (c
);
3300 if (SYMBOLP (dribblee
))
3302 putc ('<', dribble
);
3303 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3304 SBYTES (SYMBOL_NAME (dribblee
)),
3306 putc ('>', dribble
);
3316 print_help (Lisp_Object object
)
3318 struct buffer
*old
= current_buffer
;
3319 Fprinc (object
, Qnil
);
3320 set_buffer_internal (XBUFFER (Vstandard_output
));
3321 call0 (intern ("help-mode"));
3322 set_buffer_internal (old
);
3326 /* Copy out or in the info on where C-g should throw to.
3327 This is used when running Lisp code from within get_char,
3328 in case get_char is called recursively.
3329 See read_process_output. */
3332 save_getcjmp (jmp_buf temp
)
3334 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3338 restore_getcjmp (jmp_buf temp
)
3340 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3343 /* Low level keyboard/mouse input.
3344 kbd_buffer_store_event places events in kbd_buffer, and
3345 kbd_buffer_get_event retrieves them. */
3347 /* Return true if there are any events in the queue that read-char
3348 would return. If this returns false, a read-char would block. */
3350 readable_events (int flags
)
3352 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3355 /* If the buffer contains only FOCUS_IN_EVENT events, and
3356 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3357 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3359 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3360 #ifdef USE_TOOLKIT_SCROLL_BARS
3361 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3365 struct input_event
*event
;
3367 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3374 #ifdef USE_TOOLKIT_SCROLL_BARS
3375 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3377 event
->kind
== FOCUS_IN_EVENT
)
3378 #ifdef USE_TOOLKIT_SCROLL_BARS
3379 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3380 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3381 && event
->part
== scroll_bar_handle
3382 && event
->modifiers
== 0)
3387 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3390 while (event
!= kbd_store_ptr
);
3396 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3397 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3398 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3403 if (current_kboard
->kbd_queue_has_data
)
3409 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3410 if (kb
->kbd_queue_has_data
)
3416 /* Set this for debugging, to have a way to get out */
3420 event_to_kboard (struct input_event
*event
)
3423 frame
= event
->frame_or_window
;
3425 frame
= XCAR (frame
);
3426 else if (WINDOWP (frame
))
3427 frame
= WINDOW_FRAME (XWINDOW (frame
));
3429 /* There are still some events that don't set this field.
3430 For now, just ignore the problem.
3431 Also ignore dead frames here. */
3432 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3435 return FRAME_KBOARD (XFRAME (frame
));
3439 /* Return the number of slots occupied in kbd_buffer. */
3442 kbd_buffer_nr_stored (void)
3444 return kbd_fetch_ptr
== kbd_store_ptr
3446 : (kbd_fetch_ptr
< kbd_store_ptr
3447 ? kbd_store_ptr
- kbd_fetch_ptr
3448 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3449 + (kbd_store_ptr
- kbd_buffer
)));
3451 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3454 kbd_buffer_store_event (register struct input_event
*event
)
3456 kbd_buffer_store_event_hold (event
, 0);
3459 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3461 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3462 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3463 Else, if EVENT is a quit event, store the quit event
3464 in HOLD_QUIT, and return (thus ignoring further events).
3466 This is used in read_avail_input to postpone the processing
3467 of the quit event until all subsequent input events have been
3468 parsed (and discarded).
3472 kbd_buffer_store_event_hold (register struct input_event
*event
,
3473 struct input_event
*hold_quit
)
3475 if (event
->kind
== NO_EVENT
)
3478 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3481 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3483 register int c
= event
->code
& 0377;
3485 if (event
->modifiers
& ctrl_modifier
)
3486 c
= make_ctrl_char (c
);
3488 c
|= (event
->modifiers
3489 & (meta_modifier
| alt_modifier
3490 | hyper_modifier
| super_modifier
));
3494 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3495 struct input_event
*sp
;
3497 if (single_kboard
&& kb
!= current_kboard
)
3499 KVAR (kb
, kbd_queue
)
3500 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3501 Fcons (make_number (c
), Qnil
));
3502 kb
->kbd_queue_has_data
= 1;
3503 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3505 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3508 if (event_to_kboard (sp
) == kb
)
3510 sp
->kind
= NO_EVENT
;
3511 sp
->frame_or_window
= Qnil
;
3520 memcpy (hold_quit
, event
, sizeof (*event
));
3524 /* If this results in a quit_char being returned to Emacs as
3525 input, set Vlast_event_frame properly. If this doesn't
3526 get returned to Emacs as an event, the next event read
3527 will set Vlast_event_frame again, so this is safe to do. */
3531 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3533 focus
= event
->frame_or_window
;
3534 internal_last_event_frame
= focus
;
3535 Vlast_event_frame
= focus
;
3538 last_event_timestamp
= event
->timestamp
;
3539 handle_interrupt ();
3543 if (c
&& c
== stop_character
)
3549 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3550 Just ignore the second one. */
3551 else if (event
->kind
== BUFFER_SWITCH_EVENT
3552 && kbd_fetch_ptr
!= kbd_store_ptr
3553 && ((kbd_store_ptr
== kbd_buffer
3554 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3555 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3558 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3559 kbd_store_ptr
= kbd_buffer
;
3561 /* Don't let the very last slot in the buffer become full,
3562 since that would make the two pointers equal,
3563 and that is indistinguishable from an empty buffer.
3564 Discard the event if it would fill the last slot. */
3565 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3567 *kbd_store_ptr
= *event
;
3570 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3572 /* Don't read keyboard input until we have processed kbd_buffer.
3573 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3574 hold_keyboard_input ();
3576 if (!noninteractive
)
3577 signal (SIGIO
, SIG_IGN
);
3581 #endif /* subprocesses */
3584 /* If we're inside while-no-input, and this event qualifies
3585 as input, set quit-flag to cause an interrupt. */
3586 if (!NILP (Vthrow_on_input
)
3587 && event
->kind
!= FOCUS_IN_EVENT
3588 && event
->kind
!= HELP_EVENT
3589 && event
->kind
!= DEICONIFY_EVENT
)
3591 Vquit_flag
= Vthrow_on_input
;
3592 /* If we're inside a function that wants immediate quits,
3594 if (immediate_quit
&& NILP (Vinhibit_quit
))
3604 /* Put an input event back in the head of the event queue. */
3607 kbd_buffer_unget_event (register struct input_event
*event
)
3609 if (kbd_fetch_ptr
== kbd_buffer
)
3610 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3612 /* Don't let the very last slot in the buffer become full, */
3613 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3616 *kbd_fetch_ptr
= *event
;
3621 /* Generate a HELP_EVENT input_event and store it in the keyboard
3624 HELP is the help form.
3626 FRAME and WINDOW are the frame and window where the help is
3627 generated. OBJECT is the Lisp object where the help was found (a
3628 buffer, a string, an overlay, or nil if neither from a string nor
3629 from a buffer). POS is the position within OBJECT where the help
3633 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3634 Lisp_Object object
, EMACS_INT pos
)
3636 struct input_event event
;
3640 event
.kind
= HELP_EVENT
;
3641 event
.frame_or_window
= frame
;
3643 event
.x
= WINDOWP (window
) ? window
: frame
;
3646 kbd_buffer_store_event (&event
);
3650 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3653 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3655 struct input_event event
;
3657 event
.kind
= HELP_EVENT
;
3658 event
.frame_or_window
= frame
;
3663 kbd_buffer_store_event (&event
);
3667 /* Discard any mouse events in the event buffer by setting them to
3670 discard_mouse_events (void)
3672 struct input_event
*sp
;
3673 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3675 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3678 if (sp
->kind
== MOUSE_CLICK_EVENT
3679 || sp
->kind
== WHEEL_EVENT
3680 || sp
->kind
== HORIZ_WHEEL_EVENT
3682 || sp
->kind
== GPM_CLICK_EVENT
3684 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3686 sp
->kind
= NO_EVENT
;
3692 /* Return non-zero if there are any real events waiting in the event
3693 buffer, not counting `NO_EVENT's.
3695 If DISCARD is non-zero, discard NO_EVENT events at the front of
3696 the input queue, possibly leaving the input queue empty if there
3697 are no real input events. */
3700 kbd_buffer_events_waiting (int discard
)
3702 struct input_event
*sp
;
3704 for (sp
= kbd_fetch_ptr
;
3705 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3708 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3715 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3719 /* Clear input event EVENT. */
3722 clear_event (struct input_event
*event
)
3724 event
->kind
= NO_EVENT
;
3728 /* Read one event from the event buffer, waiting if necessary.
3729 The value is a Lisp object representing the event.
3730 The value is nil for an event that should be ignored,
3731 or that was handled here.
3732 We always read and discard one event. */
3735 kbd_buffer_get_event (KBOARD
**kbp
,
3736 int *used_mouse_menu
,
3737 struct timeval
*end_time
)
3743 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3745 /* Start reading input again, we have processed enough so we can
3746 accept new events again. */
3747 unhold_keyboard_input ();
3749 if (!noninteractive
)
3750 signal (SIGIO
, input_available_signal
);
3754 #endif /* subprocesses */
3757 /* In case we are running as a daemon, only do this before
3758 detaching from the terminal. */
3759 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3763 *kbp
= current_kboard
;
3767 /* Wait until there is input available. */
3770 /* Break loop if there's an unread command event. Needed in
3771 moused window autoselection which uses a timer to insert such
3773 if (CONSP (Vunread_command_events
))
3776 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3778 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3779 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3783 /* If the quit flag is set, then read_char will return
3784 quit_char, so that counts as "available input." */
3785 if (!NILP (Vquit_flag
))
3786 quit_throw_to_read_char ();
3788 /* One way or another, wait until input is available; then, if
3789 interrupt handlers have not read it, read it now. */
3791 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3795 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3797 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3798 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3803 EMACS_TIME duration
;
3804 EMACS_GET_TIME (duration
);
3805 if (EMACS_TIME_GE (duration
, *end_time
))
3806 return Qnil
; /* finished waiting */
3809 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3810 wait_reading_process_output (EMACS_SECS (duration
),
3811 EMACS_USECS (duration
),
3812 -1, 1, Qnil
, NULL
, 0);
3816 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3818 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3819 /* Pass 1 for EXPECT since we just waited to have input. */
3820 read_avail_input (1);
3823 if (CONSP (Vunread_command_events
))
3826 first
= XCAR (Vunread_command_events
);
3827 Vunread_command_events
= XCDR (Vunread_command_events
);
3828 *kbp
= current_kboard
;
3832 /* At this point, we know that there is a readable event available
3833 somewhere. If the event queue is empty, then there must be a
3834 mouse movement enabled and available. */
3835 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3837 struct input_event
*event
;
3839 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3843 last_event_timestamp
= event
->timestamp
;
3845 *kbp
= event_to_kboard (event
);
3847 *kbp
= current_kboard
; /* Better than returning null ptr? */
3851 /* These two kinds of events get special handling
3852 and don't actually appear to the command loop.
3853 We return nil for them. */
3854 if (event
->kind
== SELECTION_REQUEST_EVENT
3855 || event
->kind
== SELECTION_CLEAR_EVENT
)
3858 struct input_event copy
;
3860 /* Remove it from the buffer before processing it,
3861 since otherwise swallow_events will see it
3862 and process it again. */
3864 kbd_fetch_ptr
= event
+ 1;
3865 input_pending
= readable_events (0);
3866 x_handle_selection_event (©
);
3868 /* We're getting selection request events, but we don't have
3874 #if defined (HAVE_NS)
3875 else if (event
->kind
== NS_TEXT_EVENT
)
3877 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3878 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3880 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3881 kbd_fetch_ptr
= event
+ 1;
3882 if (used_mouse_menu
)
3883 *used_mouse_menu
= 1;
3887 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3888 || defined (HAVE_NS)
3889 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3891 /* Make an event (delete-frame (FRAME)). */
3892 obj
= Fcons (event
->frame_or_window
, Qnil
);
3893 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3894 kbd_fetch_ptr
= event
+ 1;
3897 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3898 || defined (HAVE_NS)
3899 else if (event
->kind
== ICONIFY_EVENT
)
3901 /* Make an event (iconify-frame (FRAME)). */
3902 obj
= Fcons (event
->frame_or_window
, Qnil
);
3903 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3904 kbd_fetch_ptr
= event
+ 1;
3906 else if (event
->kind
== DEICONIFY_EVENT
)
3908 /* Make an event (make-frame-visible (FRAME)). */
3909 obj
= Fcons (event
->frame_or_window
, Qnil
);
3910 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3911 kbd_fetch_ptr
= event
+ 1;
3914 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3916 /* The value doesn't matter here; only the type is tested. */
3917 XSETBUFFER (obj
, current_buffer
);
3918 kbd_fetch_ptr
= event
+ 1;
3920 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3921 || defined(HAVE_NS) || defined (USE_GTK)
3922 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3924 kbd_fetch_ptr
= event
+ 1;
3925 input_pending
= readable_events (0);
3926 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3927 x_activate_menubar (XFRAME (event
->frame_or_window
));
3930 #if defined (WINDOWSNT)
3931 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3933 /* Make an event (language-change (FRAME CHARSET LCID)). */
3934 obj
= Fcons (event
->frame_or_window
, Qnil
);
3935 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3936 kbd_fetch_ptr
= event
+ 1;
3939 else if (event
->kind
== SAVE_SESSION_EVENT
)
3941 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3942 kbd_fetch_ptr
= event
+ 1;
3944 /* Just discard these, by returning nil.
3945 With MULTI_KBOARD, these events are used as placeholders
3946 when we need to randomly delete events from the queue.
3947 (They shouldn't otherwise be found in the buffer,
3948 but on some machines it appears they do show up
3949 even without MULTI_KBOARD.) */
3950 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3951 mouse events during a popup-menu call. */
3952 else if (event
->kind
== NO_EVENT
)
3953 kbd_fetch_ptr
= event
+ 1;
3954 else if (event
->kind
== HELP_EVENT
)
3956 Lisp_Object object
, position
, help
, frame
, window
;
3958 frame
= event
->frame_or_window
;
3959 object
= event
->arg
;
3960 position
= make_number (event
->code
);
3963 clear_event (event
);
3965 kbd_fetch_ptr
= event
+ 1;
3966 if (!WINDOWP (window
))
3968 obj
= Fcons (Qhelp_echo
,
3969 list5 (frame
, help
, window
, object
, position
));
3971 else if (event
->kind
== FOCUS_IN_EVENT
)
3973 /* Notification of a FocusIn event. The frame receiving the
3974 focus is in event->frame_or_window. Generate a
3975 switch-frame event if necessary. */
3976 Lisp_Object frame
, focus
;
3978 frame
= event
->frame_or_window
;
3979 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3983 if (!EQ (frame
, internal_last_event_frame
)
3984 && !EQ (frame
, selected_frame
))
3985 obj
= make_lispy_switch_frame (frame
);
3986 internal_last_event_frame
= frame
;
3987 kbd_fetch_ptr
= event
+ 1;
3990 else if (event
->kind
== DBUS_EVENT
)
3992 obj
= make_lispy_event (event
);
3993 kbd_fetch_ptr
= event
+ 1;
3996 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3998 obj
= make_lispy_event (event
);
3999 kbd_fetch_ptr
= event
+ 1;
4003 /* If this event is on a different frame, return a switch-frame this
4004 time, and leave the event in the queue for next time. */
4008 frame
= event
->frame_or_window
;
4010 frame
= XCAR (frame
);
4011 else if (WINDOWP (frame
))
4012 frame
= WINDOW_FRAME (XWINDOW (frame
));
4014 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4018 if (! EQ (frame
, internal_last_event_frame
)
4019 && !EQ (frame
, selected_frame
))
4020 obj
= make_lispy_switch_frame (frame
);
4021 internal_last_event_frame
= frame
;
4023 /* If we didn't decide to make a switch-frame event, go ahead
4024 and build a real event from the queue entry. */
4028 obj
= make_lispy_event (event
);
4030 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4031 || defined(HAVE_NS) || defined (USE_GTK)
4032 /* If this was a menu selection, then set the flag to inhibit
4033 writing to last_nonmenu_event. Don't do this if the event
4034 we're returning is (menu-bar), though; that indicates the
4035 beginning of the menu sequence, and we might as well leave
4036 that as the `event with parameters' for this selection. */
4038 && !EQ (event
->frame_or_window
, event
->arg
)
4039 && (event
->kind
== MENU_BAR_EVENT
4040 || event
->kind
== TOOL_BAR_EVENT
))
4041 *used_mouse_menu
= 1;
4044 /* certain system events are non-key events */
4046 && event
->kind
== NS_NONKEY_EVENT
)
4047 *used_mouse_menu
= 1;
4050 /* Wipe out this event, to catch bugs. */
4051 clear_event (event
);
4052 kbd_fetch_ptr
= event
+ 1;
4056 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4057 /* Try generating a mouse motion event. */
4058 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4060 FRAME_PTR f
= some_mouse_moved ();
4061 Lisp_Object bar_window
;
4062 enum scroll_bar_part part
;
4066 *kbp
= current_kboard
;
4067 /* Note that this uses F to determine which terminal to look at.
4068 If there is no valid info, it does not store anything
4069 so x remains nil. */
4072 /* XXX Can f or mouse_position_hook be NULL here? */
4073 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4074 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4079 /* Decide if we should generate a switch-frame event. Don't
4080 generate switch-frame events for motion outside of all Emacs
4086 frame
= FRAME_FOCUS_FRAME (f
);
4088 XSETFRAME (frame
, f
);
4090 if (! EQ (frame
, internal_last_event_frame
)
4091 && !EQ (frame
, selected_frame
))
4092 obj
= make_lispy_switch_frame (frame
);
4093 internal_last_event_frame
= frame
;
4096 /* If we didn't decide to make a switch-frame event, go ahead and
4097 return a mouse-motion event. */
4098 if (!NILP (x
) && NILP (obj
))
4099 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4101 #endif /* HAVE_MOUSE || HAVE GPM */
4103 /* We were promised by the above while loop that there was
4104 something for us to read! */
4107 input_pending
= readable_events (0);
4109 Vlast_event_frame
= internal_last_event_frame
;
4114 /* Process any events that are not user-visible,
4115 then return, without reading any user-visible events. */
4118 swallow_events (int do_display
)
4122 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4124 struct input_event
*event
;
4126 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4130 last_event_timestamp
= event
->timestamp
;
4132 /* These two kinds of events get special handling
4133 and don't actually appear to the command loop. */
4134 if (event
->kind
== SELECTION_REQUEST_EVENT
4135 || event
->kind
== SELECTION_CLEAR_EVENT
)
4138 struct input_event copy
;
4140 /* Remove it from the buffer before processing it,
4141 since otherwise swallow_events called recursively could see it
4142 and process it again. */
4144 kbd_fetch_ptr
= event
+ 1;
4145 input_pending
= readable_events (0);
4146 x_handle_selection_event (©
);
4148 /* We're getting selection request events, but we don't have
4157 old_timers_run
= timers_run
;
4158 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4160 if (timers_run
!= old_timers_run
&& do_display
)
4161 redisplay_preserve_echo_area (7);
4164 /* Record the start of when Emacs is idle,
4165 for the sake of running idle-time timers. */
4168 timer_start_idle (void)
4172 /* If we are already in the idle state, do nothing. */
4173 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4176 EMACS_GET_TIME (timer_idleness_start_time
);
4178 timer_last_idleness_start_time
= timer_idleness_start_time
;
4180 /* Mark all idle-time timers as once again candidates for running. */
4181 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4185 timer
= XCAR (timers
);
4187 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4189 XVECTOR (timer
)->contents
[0] = Qnil
;
4193 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4196 timer_stop_idle (void)
4198 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4201 /* Resume idle timer from last idle start time. */
4204 timer_resume_idle (void)
4206 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4209 timer_idleness_start_time
= timer_last_idleness_start_time
;
4212 /* This is only for debugging. */
4213 struct input_event last_timer_event
;
4215 /* List of elisp functions to call, delayed because they were generated in
4216 a context where Elisp could not be safely run (e.g. redisplay, signal,
4217 ...). Each element has the form (FUN . ARGS). */
4218 Lisp_Object pending_funcalls
;
4220 /* Check whether a timer has fired. To prevent larger problems we simply
4221 disregard elements that are not proper timers. Do not make a circular
4222 timer list for the time being.
4224 Returns the time to wait until the next timer fires. If a
4225 timer is triggering now, return zero.
4226 If no timer is active, return -1.
4228 If a timer is ripe, we run it, with quitting turned off.
4229 In that case we return 0 to indicate that a new timer_check_2 call
4233 timer_check_2 (void)
4235 EMACS_TIME nexttime
;
4237 EMACS_TIME idleness_now
IF_LINT (= {0});
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
;
4275 EMACS_TIME timer_difference
IF_LINT (= {0});
4276 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4278 /* Skip past invalid timers and timers already handled. */
4281 timer
= XCAR (timers
);
4282 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4284 timers
= XCDR (timers
);
4287 vector
= XVECTOR (timer
)->contents
;
4289 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4290 || !INTEGERP (vector
[3])
4291 || ! NILP (vector
[0]))
4293 timers
= XCDR (timers
);
4297 if (CONSP (idle_timers
))
4299 timer
= XCAR (idle_timers
);
4300 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4302 idle_timers
= XCDR (idle_timers
);
4305 vector
= XVECTOR (timer
)->contents
;
4307 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4308 || !INTEGERP (vector
[3])
4309 || ! NILP (vector
[0]))
4311 idle_timers
= XCDR (idle_timers
);
4316 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4317 based on the next ordinary timer.
4318 TIMER_DIFFERENCE is the distance in time from NOW to when
4319 this timer becomes ripe (negative if it's already ripe). */
4322 timer
= XCAR (timers
);
4323 vector
= XVECTOR (timer
)->contents
;
4324 EMACS_SET_SECS (timer_time
,
4325 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4326 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4327 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4330 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4331 based on the next idle timer. */
4332 if (CONSP (idle_timers
))
4334 idle_timer
= XCAR (idle_timers
);
4335 vector
= XVECTOR (idle_timer
)->contents
;
4336 EMACS_SET_SECS (idle_timer_time
,
4337 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4338 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4339 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4342 /* Decide which timer is the next timer,
4343 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4344 Also step down the list where we found that timer. */
4346 if (CONSP (timers
) && CONSP (idle_timers
))
4349 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4350 if (EMACS_TIME_NEG_P (temp
))
4352 chosen_timer
= timer
;
4353 timers
= XCDR (timers
);
4354 difference
= timer_difference
;
4358 chosen_timer
= idle_timer
;
4359 idle_timers
= XCDR (idle_timers
);
4360 difference
= idle_timer_difference
;
4363 else if (CONSP (timers
))
4365 chosen_timer
= timer
;
4366 timers
= XCDR (timers
);
4367 difference
= timer_difference
;
4371 chosen_timer
= idle_timer
;
4372 idle_timers
= XCDR (idle_timers
);
4373 difference
= idle_timer_difference
;
4375 vector
= XVECTOR (chosen_timer
)->contents
;
4377 /* If timer is ripe, run it if it hasn't been run. */
4378 if (EMACS_TIME_NEG_P (difference
)
4379 || (EMACS_SECS (difference
) == 0
4380 && EMACS_USECS (difference
) == 0))
4382 if (NILP (vector
[0]))
4384 int count
= SPECPDL_INDEX ();
4385 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4387 /* Mark the timer as triggered to prevent problems if the lisp
4388 code fails to reschedule it right. */
4391 specbind (Qinhibit_quit
, Qt
);
4393 call1 (Qtimer_event_handler
, chosen_timer
);
4394 Vdeactivate_mark
= old_deactivate_mark
;
4396 unbind_to (count
, Qnil
);
4398 /* Since we have handled the event,
4399 we don't need to tell the caller to wake up and do it. */
4400 /* But the caller must still wait for the next timer, so
4401 return 0 to indicate that. */
4404 EMACS_SET_SECS (nexttime
, 0);
4405 EMACS_SET_USECS (nexttime
, 0);
4408 /* When we encounter a timer that is still waiting,
4409 return the amount of time to wait before it is ripe. */
4416 /* No timers are pending in the future. */
4417 /* Return 0 if we generated an event, and -1 if not. */
4423 /* Check whether a timer has fired. To prevent larger problems we simply
4424 disregard elements that are not proper timers. Do not make a circular
4425 timer list for the time being.
4427 Returns the time to wait until the next timer fires.
4428 If no timer is active, return -1.
4430 As long as any timer is ripe, we run it. */
4435 EMACS_TIME nexttime
;
4439 nexttime
= timer_check_2 ();
4441 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4446 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4447 doc
: /* Return the current length of Emacs idleness, or nil.
4448 The value when Emacs is idle is a list of three integers. The first has
4449 the most significant 16 bits of the seconds, while the second has the least
4450 significant 16 bits. The third integer gives the microsecond count.
4452 The value when Emacs is not idle is nil.
4454 The microsecond count is zero on systems that do not provide
4455 resolution finer than a second. */)
4458 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4460 EMACS_TIME now
, idleness_now
;
4462 EMACS_GET_TIME (now
);
4463 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4465 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4466 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4467 make_number (EMACS_USECS (idleness_now
)));
4473 /* Caches for modify_event_symbol. */
4474 static Lisp_Object accent_key_syms
;
4475 static Lisp_Object func_key_syms
;
4476 static Lisp_Object mouse_syms
;
4477 static Lisp_Object wheel_syms
;
4478 static Lisp_Object drag_n_drop_syms
;
4480 /* This is a list of keysym codes for special "accent" characters.
4481 It parallels lispy_accent_keys. */
4483 static const int lispy_accent_codes
[] =
4485 #ifdef XK_dead_circumflex
4490 #ifdef XK_dead_grave
4495 #ifdef XK_dead_tilde
4500 #ifdef XK_dead_diaeresis
4505 #ifdef XK_dead_macron
4510 #ifdef XK_dead_degree
4515 #ifdef XK_dead_acute
4520 #ifdef XK_dead_cedilla
4525 #ifdef XK_dead_breve
4530 #ifdef XK_dead_ogonek
4535 #ifdef XK_dead_caron
4540 #ifdef XK_dead_doubleacute
4541 XK_dead_doubleacute
,
4545 #ifdef XK_dead_abovedot
4550 #ifdef XK_dead_abovering
4560 #ifdef XK_dead_belowdot
4565 #ifdef XK_dead_voiced_sound
4566 XK_dead_voiced_sound
,
4570 #ifdef XK_dead_semivoiced_sound
4571 XK_dead_semivoiced_sound
,
4587 /* This is a list of Lisp names for special "accent" characters.
4588 It parallels lispy_accent_codes. */
4590 static const char *const lispy_accent_keys
[] =
4608 "dead-voiced-sound",
4609 "dead-semivoiced-sound",
4615 #define FUNCTION_KEY_OFFSET 0x0
4617 const char *const lispy_function_keys
[] =
4621 0, /* VK_LBUTTON 0x01 */
4622 0, /* VK_RBUTTON 0x02 */
4623 "cancel", /* VK_CANCEL 0x03 */
4624 0, /* VK_MBUTTON 0x04 */
4626 0, 0, 0, /* 0x05 .. 0x07 */
4628 "backspace", /* VK_BACK 0x08 */
4629 "tab", /* VK_TAB 0x09 */
4631 0, 0, /* 0x0A .. 0x0B */
4633 "clear", /* VK_CLEAR 0x0C */
4634 "return", /* VK_RETURN 0x0D */
4636 0, 0, /* 0x0E .. 0x0F */
4638 0, /* VK_SHIFT 0x10 */
4639 0, /* VK_CONTROL 0x11 */
4640 0, /* VK_MENU 0x12 */
4641 "pause", /* VK_PAUSE 0x13 */
4642 "capslock", /* VK_CAPITAL 0x14 */
4643 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4645 "junja", /* VK_JUNJA 0x17 */
4646 "final", /* VK_FINAL 0x18 */
4647 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4649 "escape", /* VK_ESCAPE 0x1B */
4650 "convert", /* VK_CONVERT 0x1C */
4651 "non-convert", /* VK_NONCONVERT 0x1D */
4652 "accept", /* VK_ACCEPT 0x1E */
4653 "mode-change", /* VK_MODECHANGE 0x1F */
4654 0, /* VK_SPACE 0x20 */
4655 "prior", /* VK_PRIOR 0x21 */
4656 "next", /* VK_NEXT 0x22 */
4657 "end", /* VK_END 0x23 */
4658 "home", /* VK_HOME 0x24 */
4659 "left", /* VK_LEFT 0x25 */
4660 "up", /* VK_UP 0x26 */
4661 "right", /* VK_RIGHT 0x27 */
4662 "down", /* VK_DOWN 0x28 */
4663 "select", /* VK_SELECT 0x29 */
4664 "print", /* VK_PRINT 0x2A */
4665 "execute", /* VK_EXECUTE 0x2B */
4666 "snapshot", /* VK_SNAPSHOT 0x2C */
4667 "insert", /* VK_INSERT 0x2D */
4668 "delete", /* VK_DELETE 0x2E */
4669 "help", /* VK_HELP 0x2F */
4671 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4673 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4675 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4677 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4679 0, 0, 0, 0, 0, 0, 0, 0, 0,
4680 0, 0, 0, 0, 0, 0, 0, 0, 0,
4681 0, 0, 0, 0, 0, 0, 0, 0,
4683 "lwindow", /* VK_LWIN 0x5B */
4684 "rwindow", /* VK_RWIN 0x5C */
4685 "apps", /* VK_APPS 0x5D */
4688 "kp-0", /* VK_NUMPAD0 0x60 */
4689 "kp-1", /* VK_NUMPAD1 0x61 */
4690 "kp-2", /* VK_NUMPAD2 0x62 */
4691 "kp-3", /* VK_NUMPAD3 0x63 */
4692 "kp-4", /* VK_NUMPAD4 0x64 */
4693 "kp-5", /* VK_NUMPAD5 0x65 */
4694 "kp-6", /* VK_NUMPAD6 0x66 */
4695 "kp-7", /* VK_NUMPAD7 0x67 */
4696 "kp-8", /* VK_NUMPAD8 0x68 */
4697 "kp-9", /* VK_NUMPAD9 0x69 */
4698 "kp-multiply", /* VK_MULTIPLY 0x6A */
4699 "kp-add", /* VK_ADD 0x6B */
4700 "kp-separator", /* VK_SEPARATOR 0x6C */
4701 "kp-subtract", /* VK_SUBTRACT 0x6D */
4702 "kp-decimal", /* VK_DECIMAL 0x6E */
4703 "kp-divide", /* VK_DIVIDE 0x6F */
4704 "f1", /* VK_F1 0x70 */
4705 "f2", /* VK_F2 0x71 */
4706 "f3", /* VK_F3 0x72 */
4707 "f4", /* VK_F4 0x73 */
4708 "f5", /* VK_F5 0x74 */
4709 "f6", /* VK_F6 0x75 */
4710 "f7", /* VK_F7 0x76 */
4711 "f8", /* VK_F8 0x77 */
4712 "f9", /* VK_F9 0x78 */
4713 "f10", /* VK_F10 0x79 */
4714 "f11", /* VK_F11 0x7A */
4715 "f12", /* VK_F12 0x7B */
4716 "f13", /* VK_F13 0x7C */
4717 "f14", /* VK_F14 0x7D */
4718 "f15", /* VK_F15 0x7E */
4719 "f16", /* VK_F16 0x7F */
4720 "f17", /* VK_F17 0x80 */
4721 "f18", /* VK_F18 0x81 */
4722 "f19", /* VK_F19 0x82 */
4723 "f20", /* VK_F20 0x83 */
4724 "f21", /* VK_F21 0x84 */
4725 "f22", /* VK_F22 0x85 */
4726 "f23", /* VK_F23 0x86 */
4727 "f24", /* VK_F24 0x87 */
4729 0, 0, 0, 0, /* 0x88 .. 0x8B */
4730 0, 0, 0, 0, /* 0x8C .. 0x8F */
4732 "kp-numlock", /* VK_NUMLOCK 0x90 */
4733 "scroll", /* VK_SCROLL 0x91 */
4734 /* Not sure where the following block comes from.
4735 Windows headers have NEC and Fujitsu specific keys in
4736 this block, but nothing generic. */
4737 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4738 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4739 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4740 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4741 "kp-end", /* VK_NUMPAD_END 0x96 */
4742 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4743 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4744 "kp-up", /* VK_NUMPAD_UP 0x99 */
4745 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4746 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4747 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4748 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4750 0, 0, /* 0x9E .. 0x9F */
4753 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4754 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4755 * No other API or message will distinguish left and right keys this way.
4760 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4761 to enable them selectively, and gives access to a few more functions.
4762 See lispy_multimedia_keys below. */
4763 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4764 0, 0, 0, /* 0xAD .. 0xAF Volume */
4765 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4766 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4768 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4769 0, 0, 0, 0, 0, 0, 0, 0, 0,
4771 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4772 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4773 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4776 "ax", /* VK_OEM_AX 0xE1 */
4777 0, /* VK_OEM_102 0xE2 */
4778 "ico-help", /* VK_ICO_HELP 0xE3 */
4779 "ico-00", /* VK_ICO_00 0xE4 */
4780 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4781 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4782 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4784 "reset", /* VK_OEM_RESET 0xE9 */
4785 "jump", /* VK_OEM_JUMP 0xEA */
4786 "oem-pa1", /* VK_OEM_PA1 0xEB */
4787 "oem-pa2", /* VK_OEM_PA2 0xEC */
4788 "oem-pa3", /* VK_OEM_PA3 0xED */
4789 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4790 "cusel", /* VK_OEM_CUSEL 0xEF */
4791 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4792 "finish", /* VK_OEM_FINISH 0xF1 */
4793 "copy", /* VK_OEM_COPY 0xF2 */
4794 "auto", /* VK_OEM_AUTO 0xF3 */
4795 "enlw", /* VK_OEM_ENLW 0xF4 */
4796 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4797 "attn", /* VK_ATTN 0xF6 */
4798 "crsel", /* VK_CRSEL 0xF7 */
4799 "exsel", /* VK_EXSEL 0xF8 */
4800 "ereof", /* VK_EREOF 0xF9 */
4801 "play", /* VK_PLAY 0xFA */
4802 "zoom", /* VK_ZOOM 0xFB */
4803 "noname", /* VK_NONAME 0xFC */
4804 "pa1", /* VK_PA1 0xFD */
4805 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4809 /* Some of these duplicate the "Media keys" on newer keyboards,
4810 but they are delivered to the application in a different way. */
4811 static const char *const lispy_multimedia_keys
[] =
4819 "browser-favorites",
4856 "toggle-dictate-command",
4862 "media-fast-forward",
4865 "media-channel-down"
4868 #else /* not HAVE_NTGUI */
4870 /* This should be dealt with in XTread_socket now, and that doesn't
4871 depend on the client system having the Kana syms defined. See also
4872 the XK_kana_A case below. */
4875 static const char *const lispy_kana_keys
[] =
4877 /* X Keysym value */
4878 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4879 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4880 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4881 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4882 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4883 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4884 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4885 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4886 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4887 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4888 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4889 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4890 "kana-i", "kana-u", "kana-e", "kana-o",
4891 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4892 "prolongedsound", "kana-A", "kana-I", "kana-U",
4893 "kana-E", "kana-O", "kana-KA", "kana-KI",
4894 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4895 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4896 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4897 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4898 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4899 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4900 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4901 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4902 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4903 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4904 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4905 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4907 #endif /* XK_kana_A */
4910 #define FUNCTION_KEY_OFFSET 0xff00
4912 /* You'll notice that this table is arranged to be conveniently
4913 indexed by X Windows keysym values. */
4914 static const char *const lispy_function_keys
[] =
4916 /* X Keysym value */
4918 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4919 "backspace", "tab", "linefeed", "clear",
4921 0, 0, 0, "pause", /* 0xff10...1f */
4922 0, 0, 0, 0, 0, 0, 0, "escape",
4924 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4925 "romaji", "hiragana", "katakana", "hiragana-katakana",
4926 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4927 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4928 "eisu-toggle", /* 0xff30...3f */
4929 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4930 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4932 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4933 "down", "prior", "next", "end",
4934 "begin", 0, 0, 0, 0, 0, 0, 0,
4935 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4946 "break", /* 0xff6b */
4949 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4950 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4951 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4952 0, 0, 0, 0, 0, 0, 0, 0,
4953 "kp-tab", /* 0xff89 */
4955 "kp-enter", /* 0xff8d */
4957 "kp-f1", /* 0xff91 */
4961 "kp-home", /* 0xff95 */
4966 "kp-prior", /* kp-page-up */
4967 "kp-next", /* kp-page-down */
4973 0, 0, 0, 0, 0, 0, 0, 0, 0,
4974 "kp-multiply", /* 0xffaa */
4979 "kp-divide", /* 0xffaf */
4980 "kp-0", /* 0xffb0 */
4981 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4984 "kp-equal", /* 0xffbd */
4985 "f1", /* 0xffbe */ /* IsFunctionKey */
4987 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4988 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4989 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4990 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4991 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4992 0, 0, 0, 0, 0, 0, 0, 0,
4993 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4994 0, 0, 0, 0, 0, 0, 0, "delete"
4997 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4998 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5000 static const char *const iso_lispy_function_keys
[] =
5002 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5003 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5004 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5005 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5006 "iso-lefttab", /* 0xfe20 */
5007 "iso-move-line-up", "iso-move-line-down",
5008 "iso-partial-line-up", "iso-partial-line-down",
5009 "iso-partial-space-left", "iso-partial-space-right",
5010 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5011 "iso-release-margin-left", "iso-release-margin-right",
5012 "iso-release-both-margins",
5013 "iso-fast-cursor-left", "iso-fast-cursor-right",
5014 "iso-fast-cursor-up", "iso-fast-cursor-down",
5015 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5016 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5019 #endif /* not HAVE_NTGUI */
5021 Lisp_Object Vlispy_mouse_stem
;
5023 static const char *const lispy_wheel_names
[] =
5025 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5028 /* drag-n-drop events are generated when a set of selected files are
5029 dragged from another application and dropped onto an Emacs window. */
5030 static const char *const lispy_drag_n_drop_names
[] =
5035 /* Scroll bar parts. */
5036 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5037 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5038 Lisp_Object Qtop
, Qratio
;
5040 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5041 static Lisp_Object
*const scroll_bar_parts
[] = {
5042 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5043 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5046 /* A vector, indexed by button number, giving the down-going location
5047 of currently depressed buttons, both scroll bar and non-scroll bar.
5049 The elements have the form
5050 (BUTTON-NUMBER MODIFIER-MASK . REST)
5051 where REST is the cdr of a position as it would be reported in the event.
5053 The make_lispy_event function stores positions here to tell the
5054 difference between click and drag events, and to store the starting
5055 location to be included in drag events. */
5057 static Lisp_Object button_down_location
;
5059 /* Information about the most recent up-going button event: Which
5060 button, what location, and what time. */
5062 static int last_mouse_button
;
5063 static int last_mouse_x
;
5064 static int last_mouse_y
;
5065 static unsigned long button_down_time
;
5067 /* The number of clicks in this multiple-click. */
5069 int double_click_count
;
5071 /* X and Y are frame-relative coordinates for a click or wheel event.
5072 Return a Lisp-style event list. */
5075 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5078 enum window_part part
;
5079 Lisp_Object posn
= Qnil
;
5080 Lisp_Object extra_info
= Qnil
;
5081 /* Coordinate pixel positions to return. */
5082 int xret
= 0, yret
= 0;
5083 /* The window under frame pixel coordinates (x,y) */
5084 Lisp_Object window
= f
5085 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5088 if (WINDOWP (window
))
5090 /* It's a click in window window at frame coordinates (x,y) */
5091 struct window
*w
= XWINDOW (window
);
5092 Lisp_Object string_info
= Qnil
;
5093 EMACS_INT textpos
= -1;
5094 int col
= -1, row
= -1;
5095 int dx
= -1, dy
= -1;
5096 int width
= -1, height
= -1;
5097 Lisp_Object object
= Qnil
;
5099 /* Pixel coordinates relative to the window corner. */
5100 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5101 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5103 /* For text area clicks, return X, Y relative to the corner of
5104 this text area. Note that dX, dY etc are set below, by
5105 buffer_posn_from_coords. */
5106 if (part
== ON_TEXT
)
5108 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5109 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5111 /* For mode line and header line clicks, return X, Y relative to
5112 the left window edge. Use mode_line_string to look for a
5113 string on the click position. */
5114 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5119 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5120 /* Note that mode_line_string takes COL, ROW as pixels and
5121 converts them to characters. */
5124 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5125 &object
, &dx
, &dy
, &width
, &height
);
5126 if (STRINGP (string
))
5127 string_info
= Fcons (string
, make_number (charpos
));
5128 textpos
= (w
== XWINDOW (selected_window
)
5129 && current_buffer
== XBUFFER (w
->buffer
))
5130 ? PT
: XMARKER (w
->pointm
)->charpos
;
5135 /* For fringes and margins, Y is relative to the area's (and the
5136 window's) top edge, while X is meaningless. */
5137 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5142 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5145 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5146 &object
, &dx
, &dy
, &width
, &height
);
5147 if (STRINGP (string
))
5148 string_info
= Fcons (string
, make_number (charpos
));
5149 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5151 else if (part
== ON_LEFT_FRINGE
)
5153 posn
= Qleft_fringe
;
5156 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5157 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5158 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5160 else if (part
== ON_RIGHT_FRINGE
)
5162 posn
= Qright_fringe
;
5165 - window_box_width (w
, LEFT_MARGIN_AREA
)
5166 - window_box_width (w
, TEXT_AREA
)
5167 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5168 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5170 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5172 else if (part
== ON_VERTICAL_BORDER
)
5174 posn
= Qvertical_line
;
5179 /* Nothing special for part == ON_SCROLL_BAR. */
5181 /* For clicks in the text area, fringes, or margins, call
5182 buffer_posn_from_coords to extract TEXTPOS, the buffer
5183 position nearest to the click. */
5186 Lisp_Object string2
, object2
= Qnil
;
5187 struct display_pos p
;
5189 int width2
, height2
;
5190 /* The pixel X coordinate passed to buffer_posn_from_coords
5191 is the X coordinate relative to the text area for
5192 text-area and right-margin clicks, zero otherwise. */
5194 = (part
== ON_TEXT
) ? xret
5195 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5196 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5200 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5201 &object2
, &dx2
, &dy2
,
5203 textpos
= CHARPOS (p
.pos
);
5204 if (col
< 0) col
= x2
;
5205 if (row
< 0) row
= y2
;
5206 if (dx
< 0) dx
= dx2
;
5207 if (dy
< 0) dy
= dy2
;
5208 if (width
< 0) width
= width2
;
5209 if (height
< 0) height
= height2
;
5213 posn
= make_number (textpos
);
5214 if (STRINGP (string2
))
5215 string_info
= Fcons (string2
,
5216 make_number (CHARPOS (p
.string_pos
)));
5222 #ifdef HAVE_WINDOW_SYSTEM
5223 if (IMAGEP (object
))
5225 Lisp_Object image_map
, hotspot
;
5226 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5228 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5230 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5231 posn
= XCAR (hotspot
);
5238 Fcons (make_number (dx
), make_number (dy
)),
5239 Fcons (make_number (width
), make_number (height
)));
5242 extra_info
= Fcons (string_info
,
5243 Fcons (make_number (textpos
),
5244 Fcons (Fcons (make_number (col
),
5249 XSETFRAME (window
, f
);
5253 return Fcons (window
,
5255 Fcons (Fcons (make_number (xret
),
5256 make_number (yret
)),
5257 Fcons (make_number (t
),
5261 /* Given a struct input_event, build the lisp event which represents
5262 it. If EVENT is 0, build a mouse movement event from the mouse
5263 movement buffer, which should have a movement event in it.
5265 Note that events must be passed to this function in the order they
5266 are received; this function stores the location of button presses
5267 in order to build drag events when the button is released. */
5270 make_lispy_event (struct input_event
*event
)
5274 switch (SWITCH_ENUM_CAST (event
->kind
))
5276 /* A simple keystroke. */
5277 case ASCII_KEYSTROKE_EVENT
:
5278 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5280 Lisp_Object lispy_c
;
5281 EMACS_INT c
= event
->code
;
5282 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5285 eassert (c
== event
->code
);
5286 /* Turn ASCII characters into control characters
5288 if (event
->modifiers
& ctrl_modifier
)
5290 c
= make_ctrl_char (c
);
5291 event
->modifiers
&= ~ctrl_modifier
;
5295 /* Add in the other modifier bits. The shift key was taken care
5296 of by the X code. */
5297 c
|= (event
->modifiers
5298 & (meta_modifier
| alt_modifier
5299 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5300 /* Distinguish Shift-SPC from SPC. */
5301 if ((event
->code
) == 040
5302 && event
->modifiers
& shift_modifier
)
5303 c
|= shift_modifier
;
5304 button_down_time
= 0;
5305 XSETFASTINT (lispy_c
, c
);
5310 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5311 except that they are non-key events (last-nonmenu-event is nil). */
5312 case NS_NONKEY_EVENT
:
5315 /* A function key. The symbol may need to have modifier prefixes
5317 case NON_ASCII_KEYSTROKE_EVENT
:
5318 button_down_time
= 0;
5320 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5321 if (event
->code
== lispy_accent_codes
[i
])
5322 return modify_event_symbol (i
,
5324 Qfunction_key
, Qnil
,
5325 lispy_accent_keys
, &accent_key_syms
,
5326 (sizeof (lispy_accent_keys
)
5327 / sizeof (lispy_accent_keys
[0])));
5331 if (event
->code
>= 0x400 && event
->code
< 0x500)
5332 return modify_event_symbol (event
->code
- 0x400,
5333 event
->modifiers
& ~shift_modifier
,
5334 Qfunction_key
, Qnil
,
5335 lispy_kana_keys
, &func_key_syms
,
5336 (sizeof (lispy_kana_keys
)
5337 / sizeof (lispy_kana_keys
[0])));
5338 #endif /* XK_kana_A */
5341 #ifdef ISO_FUNCTION_KEY_OFFSET
5342 if (event
->code
< FUNCTION_KEY_OFFSET
5343 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5344 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5346 Qfunction_key
, Qnil
,
5347 iso_lispy_function_keys
, &func_key_syms
,
5348 (sizeof (iso_lispy_function_keys
)
5349 / sizeof (iso_lispy_function_keys
[0])));
5352 /* Handle system-specific or unknown keysyms. */
5353 if (event
->code
& (1 << 28)
5354 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5355 || (event
->code
- FUNCTION_KEY_OFFSET
5356 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5357 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5359 /* We need to use an alist rather than a vector as the cache
5360 since we can't make a vector long enuf. */
5361 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5362 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5363 return modify_event_symbol (event
->code
,
5366 KVAR (current_kboard
, Vsystem_key_alist
),
5367 0, &KVAR (current_kboard
, system_key_syms
),
5371 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5373 Qfunction_key
, Qnil
,
5374 lispy_function_keys
, &func_key_syms
,
5375 (sizeof (lispy_function_keys
)
5376 / sizeof (lispy_function_keys
[0])));
5379 case MULTIMEDIA_KEY_EVENT
:
5380 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5381 / sizeof (lispy_multimedia_keys
[0]))
5382 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5384 return modify_event_symbol (event
->code
, event
->modifiers
,
5385 Qfunction_key
, Qnil
,
5386 lispy_multimedia_keys
, &func_key_syms
,
5387 (sizeof (lispy_multimedia_keys
)
5388 / sizeof (lispy_multimedia_keys
[0])));
5394 /* A mouse click. Figure out where it is, decide whether it's
5395 a press, click or drag, and build the appropriate structure. */
5396 case MOUSE_CLICK_EVENT
:
5397 #ifndef USE_TOOLKIT_SCROLL_BARS
5398 case SCROLL_BAR_CLICK_EVENT
:
5401 int button
= event
->code
;
5403 Lisp_Object position
;
5404 Lisp_Object
*start_pos_ptr
;
5405 Lisp_Object start_pos
;
5409 /* Build the position as appropriate for this mouse click. */
5410 if (event
->kind
== MOUSE_CLICK_EVENT
)
5412 struct frame
*f
= XFRAME (event
->frame_or_window
);
5413 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5417 /* Ignore mouse events that were made on frame that
5418 have been deleted. */
5419 if (! FRAME_LIVE_P (f
))
5422 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5423 /* EVENT->x and EVENT->y are frame-relative pixel
5424 coordinates at this place. Under old redisplay, COLUMN
5425 and ROW are set to frame relative glyph coordinates
5426 which are then used to determine whether this click is
5427 in a menu (non-toolkit version). */
5428 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5429 &column
, &row
, NULL
, 1);
5431 /* In the non-toolkit version, clicks on the menu bar
5432 are ordinary button events in the event buffer.
5433 Distinguish them, and invoke the menu.
5435 (In the toolkit version, the toolkit handles the menu bar
5436 and Emacs doesn't know about it until after the user
5437 makes a selection.) */
5438 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5439 && (event
->modifiers
& down_modifier
))
5441 Lisp_Object items
, item
;
5444 /* Find the menu bar item under `column'. */
5446 items
= FRAME_MENU_BAR_ITEMS (f
);
5447 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5449 Lisp_Object pos
, string
;
5450 string
= AREF (items
, i
+ 1);
5451 pos
= AREF (items
, i
+ 3);
5454 if (column
>= XINT (pos
)
5455 && column
< XINT (pos
) + SCHARS (string
))
5457 item
= AREF (items
, i
);
5462 /* ELisp manual 2.4b says (x y) are window relative but
5463 code says they are frame-relative. */
5465 = Fcons (event
->frame_or_window
,
5467 Fcons (Fcons (event
->x
, event
->y
),
5468 Fcons (make_number (event
->timestamp
),
5471 return Fcons (item
, Fcons (position
, Qnil
));
5473 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5475 position
= make_lispy_position (f
, event
->x
, event
->y
,
5478 #ifndef USE_TOOLKIT_SCROLL_BARS
5481 /* It's a scrollbar click. */
5483 Lisp_Object portion_whole
;
5486 window
= event
->frame_or_window
;
5487 portion_whole
= Fcons (event
->x
, event
->y
);
5488 part
= *scroll_bar_parts
[(int) event
->part
];
5492 Fcons (Qvertical_scroll_bar
,
5493 Fcons (portion_whole
,
5494 Fcons (make_number (event
->timestamp
),
5495 Fcons (part
, Qnil
)))));
5497 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5499 if (button
>= ASIZE (button_down_location
))
5501 button_down_location
= larger_vector (button_down_location
,
5503 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5506 start_pos_ptr
= &AREF (button_down_location
, button
);
5507 start_pos
= *start_pos_ptr
;
5508 *start_pos_ptr
= Qnil
;
5511 /* On window-system frames, use the value of
5512 double-click-fuzz as is. On other frames, interpret it
5513 as a multiple of 1/8 characters. */
5517 if (WINDOWP (event
->frame_or_window
))
5518 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5519 else if (FRAMEP (event
->frame_or_window
))
5520 f
= XFRAME (event
->frame_or_window
);
5524 if (FRAME_WINDOW_P (f
))
5525 fuzz
= double_click_fuzz
;
5527 fuzz
= double_click_fuzz
/ 8;
5529 is_double
= (button
== last_mouse_button
5530 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5531 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5532 && button_down_time
!= 0
5533 && (EQ (Vdouble_click_time
, Qt
)
5534 || (INTEGERP (Vdouble_click_time
)
5535 && ((int)(event
->timestamp
- button_down_time
)
5536 < XINT (Vdouble_click_time
)))));
5539 last_mouse_button
= button
;
5540 last_mouse_x
= XINT (event
->x
);
5541 last_mouse_y
= XINT (event
->y
);
5543 /* If this is a button press, squirrel away the location, so
5544 we can decide later whether it was a click or a drag. */
5545 if (event
->modifiers
& down_modifier
)
5549 double_click_count
++;
5550 event
->modifiers
|= ((double_click_count
> 2)
5555 double_click_count
= 1;
5556 button_down_time
= event
->timestamp
;
5557 *start_pos_ptr
= Fcopy_alist (position
);
5558 ignore_mouse_drag_p
= 0;
5561 /* Now we're releasing a button - check the co-ordinates to
5562 see if this was a click or a drag. */
5563 else if (event
->modifiers
& up_modifier
)
5565 /* If we did not see a down before this up, ignore the up.
5566 Probably this happened because the down event chose a
5567 menu item. It would be an annoyance to treat the
5568 release of the button that chose the menu item as a
5571 if (!CONSP (start_pos
))
5574 event
->modifiers
&= ~up_modifier
;
5577 Lisp_Object new_down
, down
;
5578 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5580 /* The third element of every position
5581 should be the (x,y) pair. */
5582 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5583 new_down
= Fcar (Fcdr (Fcdr (position
)));
5586 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5588 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5589 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5592 if (ignore_mouse_drag_p
)
5594 event
->modifiers
|= click_modifier
;
5595 ignore_mouse_drag_p
= 0;
5597 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5598 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5599 /* Maybe the mouse has moved a lot, caused scrolling, and
5600 eventually ended up at the same screen position (but
5601 not buffer position) in which case it is a drag, not
5603 /* FIXME: OTOH if the buffer position has changed
5604 because of a timer or process filter rather than
5605 because of mouse movement, it should be considered as
5606 a click. But mouse-drag-region completely ignores
5607 this case and it hasn't caused any real problem, so
5608 it's probably OK to ignore it as well. */
5609 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5610 /* Mouse hasn't moved (much). */
5611 event
->modifiers
|= click_modifier
;
5614 button_down_time
= 0;
5615 event
->modifiers
|= drag_modifier
;
5618 /* Don't check is_double; treat this as multiple
5619 if the down-event was multiple. */
5620 if (double_click_count
> 1)
5621 event
->modifiers
|= ((double_click_count
> 2)
5627 /* Every mouse event should either have the down_modifier or
5628 the up_modifier set. */
5632 /* Get the symbol we should use for the mouse click. */
5635 head
= modify_event_symbol (button
,
5637 Qmouse_click
, Vlispy_mouse_stem
,
5640 XVECTOR (mouse_syms
)->size
);
5641 if (event
->modifiers
& drag_modifier
)
5646 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5649 Fcons (make_number (double_click_count
),
5659 case HORIZ_WHEEL_EVENT
:
5661 Lisp_Object position
;
5664 /* Build the position as appropriate for this mouse click. */
5665 struct frame
*f
= XFRAME (event
->frame_or_window
);
5667 /* Ignore wheel events that were made on frame that have been
5669 if (! FRAME_LIVE_P (f
))
5672 position
= make_lispy_position (f
, event
->x
, event
->y
,
5675 /* Set double or triple modifiers to indicate the wheel speed. */
5677 /* On window-system frames, use the value of
5678 double-click-fuzz as is. On other frames, interpret it
5679 as a multiple of 1/8 characters. */
5685 if (WINDOWP (event
->frame_or_window
))
5686 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5687 else if (FRAMEP (event
->frame_or_window
))
5688 fr
= XFRAME (event
->frame_or_window
);
5692 fuzz
= FRAME_WINDOW_P (fr
)
5693 ? double_click_fuzz
: double_click_fuzz
/ 8;
5695 if (event
->modifiers
& up_modifier
)
5697 /* Emit a wheel-up event. */
5698 event
->modifiers
&= ~up_modifier
;
5701 else if (event
->modifiers
& down_modifier
)
5703 /* Emit a wheel-down event. */
5704 event
->modifiers
&= ~down_modifier
;
5708 /* Every wheel event should either have the down_modifier or
5709 the up_modifier set. */
5712 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5715 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5716 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5717 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5718 && button_down_time
!= 0
5719 && (EQ (Vdouble_click_time
, Qt
)
5720 || (INTEGERP (Vdouble_click_time
)
5721 && ((int)(event
->timestamp
- button_down_time
)
5722 < XINT (Vdouble_click_time
)))));
5725 double_click_count
++;
5726 event
->modifiers
|= ((double_click_count
> 2)
5732 double_click_count
= 1;
5733 event
->modifiers
|= click_modifier
;
5736 button_down_time
= event
->timestamp
;
5737 /* Use a negative value to distinguish wheel from mouse button. */
5738 last_mouse_button
= - (1 + symbol_num
);
5739 last_mouse_x
= XINT (event
->x
);
5740 last_mouse_y
= XINT (event
->y
);
5742 /* Get the symbol we should use for the wheel event. */
5743 head
= modify_event_symbol (symbol_num
,
5749 ASIZE (wheel_syms
));
5752 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5755 Fcons (make_number (double_click_count
),
5764 #ifdef USE_TOOLKIT_SCROLL_BARS
5766 /* We don't have down and up events if using toolkit scroll bars,
5767 so make this always a click event. Store in the `part' of
5768 the Lisp event a symbol which maps to the following actions:
5770 `above_handle' page up
5771 `below_handle' page down
5775 `bottom' bottom of buffer
5776 `handle' thumb has been dragged.
5777 `end-scroll' end of interaction with scroll bar
5779 The incoming input_event contains in its `part' member an
5780 index of type `enum scroll_bar_part' which we can use as an
5781 index in scroll_bar_parts to get the appropriate symbol. */
5783 case SCROLL_BAR_CLICK_EVENT
:
5785 Lisp_Object position
, head
, window
, portion_whole
, part
;
5787 window
= event
->frame_or_window
;
5788 portion_whole
= Fcons (event
->x
, event
->y
);
5789 part
= *scroll_bar_parts
[(int) event
->part
];
5793 Fcons (Qvertical_scroll_bar
,
5794 Fcons (portion_whole
,
5795 Fcons (make_number (event
->timestamp
),
5796 Fcons (part
, Qnil
)))));
5798 /* Always treat scroll bar events as clicks. */
5799 event
->modifiers
|= click_modifier
;
5800 event
->modifiers
&= ~up_modifier
;
5802 if (event
->code
>= ASIZE (mouse_syms
))
5803 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5805 /* Get the symbol we should use for the mouse click. */
5806 head
= modify_event_symbol (event
->code
,
5811 XVECTOR (mouse_syms
)->size
);
5812 return Fcons (head
, Fcons (position
, Qnil
));
5815 #endif /* USE_TOOLKIT_SCROLL_BARS */
5817 case DRAG_N_DROP_EVENT
:
5820 Lisp_Object head
, position
;
5823 f
= XFRAME (event
->frame_or_window
);
5826 /* Ignore mouse events that were made on frames that
5827 have been deleted. */
5828 if (! FRAME_LIVE_P (f
))
5831 position
= make_lispy_position (f
, event
->x
, event
->y
,
5834 head
= modify_event_symbol (0, event
->modifiers
,
5836 lispy_drag_n_drop_names
,
5837 &drag_n_drop_syms
, 1);
5843 #endif /* HAVE_MOUSE */
5845 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5846 || defined(HAVE_NS) || defined (USE_GTK)
5847 case MENU_BAR_EVENT
:
5848 if (EQ (event
->arg
, event
->frame_or_window
))
5849 /* This is the prefix key. We translate this to
5850 `(menu_bar)' because the code in keyboard.c for menu
5851 events, which we use, relies on this. */
5852 return Fcons (Qmenu_bar
, Qnil
);
5856 case SELECT_WINDOW_EVENT
:
5857 /* Make an event (select-window (WINDOW)). */
5858 return Fcons (Qselect_window
,
5859 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5862 case TOOL_BAR_EVENT
:
5863 if (EQ (event
->arg
, event
->frame_or_window
))
5864 /* This is the prefix key. We translate this to
5865 `(tool_bar)' because the code in keyboard.c for tool bar
5866 events, which we use, relies on this. */
5867 return Fcons (Qtool_bar
, Qnil
);
5868 else if (SYMBOLP (event
->arg
))
5869 return apply_modifiers (event
->modifiers
, event
->arg
);
5872 case USER_SIGNAL_EVENT
:
5873 /* A user signal. */
5875 char *name
= find_user_signal_name (event
->code
);
5878 return intern (name
);
5881 case SAVE_SESSION_EVENT
:
5882 return Qsave_session
;
5887 return Fcons (Qdbus_event
, event
->arg
);
5889 #endif /* HAVE_DBUS */
5891 case CONFIG_CHANGED_EVENT
:
5892 return Fcons (Qconfig_changed_event
,
5894 Fcons (event
->frame_or_window
, Qnil
)));
5896 case GPM_CLICK_EVENT
:
5898 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5899 Lisp_Object head
, position
;
5900 Lisp_Object
*start_pos_ptr
;
5901 Lisp_Object start_pos
;
5902 int button
= event
->code
;
5904 if (button
>= ASIZE (button_down_location
))
5906 button_down_location
= larger_vector (button_down_location
,
5908 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5911 start_pos_ptr
= &AREF (button_down_location
, button
);
5912 start_pos
= *start_pos_ptr
;
5914 position
= make_lispy_position (f
, event
->x
, event
->y
,
5917 if (event
->modifiers
& down_modifier
)
5918 *start_pos_ptr
= Fcopy_alist (position
);
5919 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5921 if (!CONSP (start_pos
))
5923 event
->modifiers
&= ~up_modifier
;
5926 head
= modify_event_symbol (button
,
5928 Qmouse_click
, Vlispy_mouse_stem
,
5931 XVECTOR (mouse_syms
)->size
);
5933 if (event
->modifiers
& drag_modifier
)
5938 else if (event
->modifiers
& double_modifier
)
5941 Fcons (make_number (2),
5943 else if (event
->modifiers
& triple_modifier
)
5946 Fcons (make_number (3),
5953 #endif /* HAVE_GPM */
5955 /* The 'kind' field of the event is something we don't recognize. */
5961 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
5964 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5965 Lisp_Object x
, Lisp_Object y
, unsigned long t
)
5967 /* Is it a scroll bar movement? */
5968 if (frame
&& ! NILP (bar_window
))
5970 Lisp_Object part_sym
;
5972 part_sym
= *scroll_bar_parts
[(int) part
];
5973 return Fcons (Qscroll_bar_movement
,
5974 Fcons (list5 (bar_window
,
5975 Qvertical_scroll_bar
,
5981 /* Or is it an ordinary mouse movement? */
5984 Lisp_Object position
;
5985 position
= make_lispy_position (frame
, x
, y
, t
);
5986 return list2 (Qmouse_movement
, position
);
5990 #endif /* HAVE_MOUSE || HAVE GPM */
5992 /* Construct a switch frame event. */
5994 make_lispy_switch_frame (Lisp_Object frame
)
5996 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5999 /* Manipulating modifiers. */
6001 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6003 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6004 SYMBOL's name of the end of the modifiers; the string from this
6005 position is the unmodified symbol name.
6007 This doesn't use any caches. */
6010 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6016 CHECK_SYMBOL (symbol
);
6019 name
= SYMBOL_NAME (symbol
);
6021 for (i
= 0; i
+2 <= SBYTES (name
); )
6023 EMACS_INT this_mod_end
= 0;
6026 /* See if the name continues with a modifier word.
6027 Check that the word appears, but don't check what follows it.
6028 Set this_mod and this_mod_end to record what we find. */
6030 switch (SREF (name
, i
))
6032 #define SINGLE_LETTER_MOD(BIT) \
6033 (this_mod_end = i + 1, this_mod = BIT)
6036 SINGLE_LETTER_MOD (alt_modifier
);
6040 SINGLE_LETTER_MOD (ctrl_modifier
);
6044 SINGLE_LETTER_MOD (hyper_modifier
);
6048 SINGLE_LETTER_MOD (meta_modifier
);
6052 SINGLE_LETTER_MOD (shift_modifier
);
6056 SINGLE_LETTER_MOD (super_modifier
);
6059 #undef SINGLE_LETTER_MOD
6061 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6062 if (i + LEN + 1 <= SBYTES (name) \
6063 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6065 this_mod_end = i + LEN; \
6070 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6071 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6072 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6076 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6078 #undef MULTI_LETTER_MOD
6082 /* If we found no modifier, stop looking for them. */
6083 if (this_mod_end
== 0)
6086 /* Check there is a dash after the modifier, so that it
6087 really is a modifier. */
6088 if (this_mod_end
>= SBYTES (name
)
6089 || SREF (name
, this_mod_end
) != '-')
6092 /* This modifier is real; look for another. */
6093 modifiers
|= this_mod
;
6094 i
= this_mod_end
+ 1;
6097 /* Should we include the `click' modifier? */
6098 if (! (modifiers
& (down_modifier
| drag_modifier
6099 | double_modifier
| triple_modifier
))
6100 && i
+ 7 == SBYTES (name
)
6101 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6102 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6103 modifiers
|= click_modifier
;
6105 if (! (modifiers
& (double_modifier
| triple_modifier
))
6106 && i
+ 6 < SBYTES (name
)
6107 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6108 modifiers
|= click_modifier
;
6116 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6117 prepended to the string BASE[0..BASE_LEN-1].
6118 This doesn't use any caches. */
6120 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6122 /* Since BASE could contain nulls, we can't use intern here; we have
6123 to use Fintern, which expects a genuine Lisp_String, and keeps a
6126 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6132 /* Only the event queue may use the `up' modifier; it should always
6133 be turned into a click or drag event before presented to lisp code. */
6134 if (modifiers
& up_modifier
)
6137 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6138 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6139 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6140 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6141 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6142 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6143 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6144 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6145 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6146 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6147 /* The click modifier is denoted by the absence of other modifiers. */
6151 mod_len
= p
- new_mods
;
6155 Lisp_Object new_name
;
6157 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6158 mod_len
+ base_len_byte
);
6159 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6160 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6162 return Fintern (new_name
, Qnil
);
6167 static const char *const modifier_names
[] =
6169 "up", "down", "drag", "click", "double", "triple", 0, 0,
6170 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6171 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6173 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6175 static Lisp_Object modifier_symbols
;
6177 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6179 lispy_modifier_list (int modifiers
)
6181 Lisp_Object modifier_list
;
6184 modifier_list
= Qnil
;
6185 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6186 if (modifiers
& (1<<i
))
6187 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6190 return modifier_list
;
6194 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6195 where UNMODIFIED is the unmodified form of SYMBOL,
6196 MASK is the set of modifiers present in SYMBOL's name.
6197 This is similar to parse_modifiers_uncached, but uses the cache in
6198 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6199 Qevent_symbol_elements property. */
6201 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6204 parse_modifiers (Lisp_Object symbol
)
6206 Lisp_Object elements
;
6208 if (INTEGERP (symbol
))
6209 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6210 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6212 else if (!SYMBOLP (symbol
))
6215 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6216 if (CONSP (elements
))
6221 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6222 Lisp_Object unmodified
;
6225 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6226 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6229 if (modifiers
& ~INTMASK
)
6231 XSETFASTINT (mask
, modifiers
);
6232 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6234 /* Cache the parsing results on SYMBOL. */
6235 Fput (symbol
, Qevent_symbol_element_mask
,
6237 Fput (symbol
, Qevent_symbol_elements
,
6238 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6240 /* Since we know that SYMBOL is modifiers applied to unmodified,
6241 it would be nice to put that in unmodified's cache.
6242 But we can't, since we're not sure that parse_modifiers is
6249 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6250 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6251 doc
: /* Parse the event symbol. For internal use. */)
6252 (Lisp_Object symbol
)
6254 /* Fill the cache if needed. */
6255 parse_modifiers (symbol
);
6256 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6257 and use the Lispier representation stored on Qevent_symbol_elements
6259 return Fget (symbol
, Qevent_symbol_elements
);
6262 /* Apply the modifiers MODIFIERS to the symbol BASE.
6263 BASE must be unmodified.
6265 This is like apply_modifiers_uncached, but uses BASE's
6266 Qmodifier_cache property, if present. It also builds
6267 Qevent_symbol_elements properties, since it has that info anyway.
6269 apply_modifiers copies the value of BASE's Qevent_kind property to
6270 the modified symbol. */
6272 apply_modifiers (int modifiers
, Lisp_Object base
)
6274 Lisp_Object cache
, idx
, entry
, new_symbol
;
6276 /* Mask out upper bits. We don't know where this value's been. */
6277 modifiers
&= INTMASK
;
6279 if (INTEGERP (base
))
6280 return make_number (XINT (base
) | modifiers
);
6282 /* The click modifier never figures into cache indices. */
6283 cache
= Fget (base
, Qmodifier_cache
);
6284 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6285 entry
= assq_no_quit (idx
, cache
);
6288 new_symbol
= XCDR (entry
);
6291 /* We have to create the symbol ourselves. */
6292 new_symbol
= apply_modifiers_uncached (modifiers
,
6293 SSDATA (SYMBOL_NAME (base
)),
6294 SCHARS (SYMBOL_NAME (base
)),
6295 SBYTES (SYMBOL_NAME (base
)));
6297 /* Add the new symbol to the base's cache. */
6298 entry
= Fcons (idx
, new_symbol
);
6299 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6301 /* We have the parsing info now for free, so we could add it to
6303 XSETFASTINT (idx, modifiers);
6304 Fput (new_symbol, Qevent_symbol_element_mask,
6305 Fcons (base, Fcons (idx, Qnil)));
6306 Fput (new_symbol, Qevent_symbol_elements,
6307 Fcons (base, lispy_modifier_list (modifiers)));
6308 Sadly, this is only correct if `base' is indeed a base event,
6309 which is not necessarily the case. -stef */
6312 /* Make sure this symbol is of the same kind as BASE.
6314 You'd think we could just set this once and for all when we
6315 intern the symbol above, but reorder_modifiers may call us when
6316 BASE's property isn't set right; we can't assume that just
6317 because it has a Qmodifier_cache property it must have its
6318 Qevent_kind set right as well. */
6319 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6323 kind
= Fget (base
, Qevent_kind
);
6325 Fput (new_symbol
, Qevent_kind
, kind
);
6332 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6333 return a symbol with the modifiers placed in the canonical order.
6334 Canonical order is alphabetical, except for down and drag, which
6335 always come last. The 'click' modifier is never written out.
6337 Fdefine_key calls this to make sure that (for example) C-M-foo
6338 and M-C-foo end up being equivalent in the keymap. */
6341 reorder_modifiers (Lisp_Object symbol
)
6343 /* It's hopefully okay to write the code this way, since everything
6344 will soon be in caches, and no consing will be done at all. */
6347 parsed
= parse_modifiers (symbol
);
6348 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6353 /* For handling events, we often want to produce a symbol whose name
6354 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6355 to some base, like the name of a function key or mouse button.
6356 modify_event_symbol produces symbols of this sort.
6358 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6359 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6362 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6363 into symbol names, or a string specifying a name stem used to
6364 construct a symbol name or the form `STEM-N', where N is the decimal
6365 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6366 non-nil; otherwise NAME_TABLE is used.
6368 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6369 persist between calls to modify_event_symbol that it can use to
6370 store a cache of the symbols it's generated for this NAME_TABLE
6371 before. The object stored there may be a vector or an alist.
6373 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6375 MODIFIERS is a set of modifier bits (as given in struct input_events)
6376 whose prefixes should be applied to the symbol name.
6378 SYMBOL_KIND is the value to be placed in the event_kind property of
6379 the returned symbol.
6381 The symbols we create are supposed to have an
6382 `event-symbol-elements' property, which lists the modifiers present
6383 in the symbol's name. */
6386 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6387 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6388 Lisp_Object
*symbol_table
, unsigned int table_size
)
6391 Lisp_Object symbol_int
;
6393 /* Get rid of the "vendor-specific" bit here. */
6394 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6396 /* Is this a request for a valid symbol? */
6397 if (symbol_num
< 0 || symbol_num
>= table_size
)
6400 if (CONSP (*symbol_table
))
6401 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6403 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6404 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6405 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6406 we've never used that symbol before. */
6409 if (! VECTORP (*symbol_table
)
6410 || XVECTOR (*symbol_table
)->size
!= table_size
)
6414 XSETFASTINT (size
, table_size
);
6415 *symbol_table
= Fmake_vector (size
, Qnil
);
6418 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6421 /* Have we already used this symbol before? */
6424 /* No; let's create it. */
6425 if (CONSP (name_alist_or_stem
))
6426 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6427 else if (STRINGP (name_alist_or_stem
))
6429 int len
= SBYTES (name_alist_or_stem
);
6430 char *buf
= (char *) alloca (len
+ 50);
6431 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6432 (long) XINT (symbol_int
) + 1);
6433 value
= intern (buf
);
6435 else if (name_table
!= 0 && name_table
[symbol_num
])
6436 value
= intern (name_table
[symbol_num
]);
6438 #ifdef HAVE_WINDOW_SYSTEM
6441 char *name
= x_get_keysym_name (symbol_num
);
6443 value
= intern (name
);
6450 sprintf (buf
, "key-%ld", (long)symbol_num
);
6451 value
= intern (buf
);
6454 if (CONSP (*symbol_table
))
6455 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6457 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6459 /* Fill in the cache entries for this symbol; this also
6460 builds the Qevent_symbol_elements property, which the user
6462 apply_modifiers (modifiers
& click_modifier
, value
);
6463 Fput (value
, Qevent_kind
, symbol_kind
);
6466 /* Apply modifiers to that symbol. */
6467 return apply_modifiers (modifiers
, value
);
6470 /* Convert a list that represents an event type,
6471 such as (ctrl meta backspace), into the usual representation of that
6472 event type as a number or a symbol. */
6474 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6475 doc
: /* Convert the event description list EVENT-DESC to an event type.
6476 EVENT-DESC should contain one base event type (a character or symbol)
6477 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6478 drag, down, double or triple). The base must be last.
6479 The return value is an event type (a character or symbol) which
6480 has the same base event type and all the specified modifiers. */)
6481 (Lisp_Object event_desc
)
6489 while (CONSP (rest
))
6497 /* Given a symbol, see if it is a modifier name. */
6498 if (SYMBOLP (elt
) && CONSP (rest
))
6499 this = parse_solitary_modifier (elt
);
6503 else if (!NILP (base
))
6504 error ("Two bases given in one event");
6510 /* Let the symbol A refer to the character A. */
6511 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6512 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6514 if (INTEGERP (base
))
6516 /* Turn (shift a) into A. */
6517 if ((modifiers
& shift_modifier
) != 0
6518 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6520 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6521 modifiers
&= ~shift_modifier
;
6524 /* Turn (control a) into C-a. */
6525 if (modifiers
& ctrl_modifier
)
6526 return make_number ((modifiers
& ~ctrl_modifier
)
6527 | make_ctrl_char (XINT (base
)));
6529 return make_number (modifiers
| XINT (base
));
6531 else if (SYMBOLP (base
))
6532 return apply_modifiers (modifiers
, base
);
6535 error ("Invalid base event");
6540 /* Try to recognize SYMBOL as a modifier name.
6541 Return the modifier flag bit, or 0 if not recognized. */
6544 parse_solitary_modifier (Lisp_Object symbol
)
6546 Lisp_Object name
= SYMBOL_NAME (symbol
);
6548 switch (SREF (name
, 0))
6550 #define SINGLE_LETTER_MOD(BIT) \
6551 if (SBYTES (name) == 1) \
6554 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6555 if (LEN == SBYTES (name) \
6556 && ! strncmp (SSDATA (name), NAME, LEN)) \
6560 SINGLE_LETTER_MOD (alt_modifier
);
6564 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6568 SINGLE_LETTER_MOD (ctrl_modifier
);
6572 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6573 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6577 SINGLE_LETTER_MOD (hyper_modifier
);
6581 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6585 SINGLE_LETTER_MOD (meta_modifier
);
6589 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6593 SINGLE_LETTER_MOD (shift_modifier
);
6597 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6598 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6599 SINGLE_LETTER_MOD (super_modifier
);
6603 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6604 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6605 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6609 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6612 #undef SINGLE_LETTER_MOD
6613 #undef MULTI_LETTER_MOD
6619 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6620 Such a list is not valid as an event,
6621 but it can be a Lucid-style event type list. */
6624 lucid_event_type_list_p (Lisp_Object object
)
6628 if (! CONSP (object
))
6631 if (EQ (XCAR (object
), Qhelp_echo
)
6632 || EQ (XCAR (object
), Qvertical_line
)
6633 || EQ (XCAR (object
), Qmode_line
)
6634 || EQ (XCAR (object
), Qheader_line
))
6637 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6641 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6648 /* Store into *addr a value nonzero if terminal input chars are available.
6649 Serves the purpose of ioctl (0, FIONREAD, addr)
6650 but works even if FIONREAD does not exist.
6651 (In fact, this may actually read some input.)
6653 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6654 timer events that are ripe.
6655 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6656 events (FOCUS_IN_EVENT).
6657 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6658 movements and toolkit scroll bar thumb drags. */
6661 get_input_pending (int *addr
, int flags
)
6663 /* First of all, have we already counted some input? */
6664 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6666 /* If input is being read as it arrives, and we have none, there is none. */
6667 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6670 /* Try to read some input and see how much we get. */
6672 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6675 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6678 gobble_input (int expected
)
6681 if (interrupt_input
)
6684 mask
= sigblock (sigmask (SIGIO
));
6685 read_avail_input (expected
);
6689 #ifdef POLL_FOR_INPUT
6690 /* XXX This condition was (read_socket_hook && !interrupt_input),
6691 but read_socket_hook is not global anymore. Let's pretend that
6693 if (!interrupt_input
&& poll_suppress_count
== 0)
6696 mask
= sigblock (sigmask (SIGALRM
));
6697 read_avail_input (expected
);
6703 read_avail_input (expected
);
6706 /* Put a BUFFER_SWITCH_EVENT in the buffer
6707 so that read_key_sequence will notice the new current buffer. */
6710 record_asynch_buffer_change (void)
6712 struct input_event event
;
6716 event
.kind
= BUFFER_SWITCH_EVENT
;
6717 event
.frame_or_window
= Qnil
;
6720 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6721 The purpose of the event is to make read_key_sequence look up the
6722 keymaps again. If we aren't in read_key_sequence, we don't need one,
6723 and the event could cause trouble by messing up (input-pending-p).
6724 Note: Fwaiting_for_user_input_p always returns nil when async
6725 subprocesses aren't supported. */
6726 tem
= Fwaiting_for_user_input_p ();
6730 /* Make sure no interrupt happens while storing the event. */
6732 if (interrupt_input
)
6735 mask
= sigblock (sigmask (SIGIO
));
6736 kbd_buffer_store_event (&event
);
6743 kbd_buffer_store_event (&event
);
6748 /* Read any terminal input already buffered up by the system
6749 into the kbd_buffer, but do not wait.
6751 EXPECTED should be nonzero if the caller knows there is some input.
6753 Returns the number of keyboard chars read, or -1 meaning
6754 this is a bad time to try to read input. */
6757 read_avail_input (int expected
)
6763 /* Store pending user signal events, if any. */
6764 if (store_user_signal_events ())
6767 /* Loop through the available terminals, and call their input hooks. */
6771 struct terminal
*next
= t
->next_terminal
;
6773 if (t
->read_socket_hook
)
6776 struct input_event hold_quit
;
6778 EVENT_INIT (hold_quit
);
6779 hold_quit
.kind
= NO_EVENT
;
6781 /* No need for FIONREAD or fcntl; just say don't wait. */
6782 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6788 if (nr
== -1) /* Not OK to read input now. */
6792 else if (nr
== -2) /* Non-transient error. */
6794 /* The terminal device terminated; it should be closed. */
6796 /* Kill Emacs if this was our last terminal. */
6797 if (!terminal_list
->next_terminal
)
6798 /* Formerly simply reported no input, but that
6799 sometimes led to a failure of Emacs to terminate.
6800 SIGHUP seems appropriate if we can't reach the
6802 /* ??? Is it really right to send the signal just to
6803 this process rather than to the whole process
6804 group? Perhaps on systems with FIONREAD Emacs is
6805 alone in its group. */
6806 kill (getpid (), SIGHUP
);
6808 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6811 XSETTERMINAL (tmp
, t
);
6812 Fdelete_terminal (tmp
, Qnoelisp
);
6816 if (hold_quit
.kind
!= NO_EVENT
)
6817 kbd_buffer_store_event (&hold_quit
);
6826 frame_make_pointer_visible ();
6832 decode_keyboard_code (struct tty_display_info
*tty
,
6833 struct coding_system
*coding
,
6834 unsigned char *buf
, int nbytes
)
6836 unsigned char *src
= buf
;
6837 const unsigned char *p
;
6842 if (tty
->meta_key
!= 2)
6843 for (i
= 0; i
< nbytes
; i
++)
6845 if (coding
->carryover_bytes
> 0)
6847 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6848 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6849 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6850 nbytes
+= coding
->carryover_bytes
;
6852 coding
->destination
= alloca (nbytes
* 4);
6853 coding
->dst_bytes
= nbytes
* 4;
6854 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6855 if (coding
->produced_char
== 0)
6857 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6859 struct input_event event_buf
;
6861 EVENT_INIT (event_buf
);
6862 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6864 (ASCII_CHAR_P (event_buf
.code
)
6865 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6866 /* See the comment in tty_read_avail_input. */
6867 event_buf
.frame_or_window
= tty
->top_frame
;
6868 event_buf
.arg
= Qnil
;
6869 kbd_buffer_store_event (&event_buf
);
6873 /* This is the tty way of reading available input.
6875 Note that each terminal device has its own `struct terminal' object,
6876 and so this function is called once for each individual termcap
6877 terminal. The first parameter indicates which terminal to read from. */
6880 tty_read_avail_input (struct terminal
*terminal
,
6882 struct input_event
*hold_quit
)
6884 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6885 the kbd_buffer can really hold. That may prevent loss
6886 of characters on some systems when input is stuffed at us. */
6887 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6889 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6892 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6894 if (kbd_on_hold_p () || buffer_free
<= 0)
6896 #endif /* subprocesses */
6898 if (!terminal
->name
) /* Don't read from a dead terminal. */
6901 if (terminal
->type
!= output_termcap
6902 && terminal
->type
!= output_msdos_raw
)
6905 /* XXX I think the following code should be moved to separate hook
6906 functions in system-dependent files. */
6909 #else /* not WINDOWSNT */
6910 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6914 return 0; /* The terminal is suspended. */
6917 n_to_read
= dos_keysns ();
6921 cbuf
[0] = dos_keyread ();
6924 #else /* not MSDOS */
6929 struct input_event gpm_hold_quit
;
6930 int gpm
, fd
= gpm_fd
;
6932 EVENT_INIT (gpm_hold_quit
);
6933 gpm_hold_quit
.kind
= NO_EVENT
;
6935 /* gpm==1 if event received.
6936 gpm==0 if the GPM daemon has closed the connection, in which case
6937 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6938 we save it in `fd' so close_gpm can remove it from the
6940 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6941 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6942 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6945 /* Presumably the GPM daemon has closed the connection. */
6947 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6948 kbd_buffer_store_event (&gpm_hold_quit
);
6952 #endif /* HAVE_GPM */
6954 /* Determine how many characters we should *try* to read. */
6956 /* Find out how much input is available. */
6957 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6959 if (! noninteractive
)
6960 return -2; /* Close this terminal. */
6966 if (n_to_read
> sizeof cbuf
)
6967 n_to_read
= sizeof cbuf
;
6968 #else /* no FIONREAD */
6969 #if defined (USG) || defined(CYGWIN)
6970 /* Read some input if available, but don't wait. */
6971 n_to_read
= sizeof cbuf
;
6972 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6979 /* Don't read more than we can store. */
6980 if (n_to_read
> buffer_free
)
6981 n_to_read
= buffer_free
;
6982 #endif /* subprocesses */
6984 /* Now read; for one reason or another, this will not block.
6985 NREAD is set to the number of chars read. */
6988 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6989 /* POSIX infers that processes which are not in the session leader's
6990 process group won't get SIGHUP's at logout time. BSDI adheres to
6991 this part standard and returns -1 from read (0) with errno==EIO
6992 when the control tty is taken away.
6993 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6994 if (nread
== -1 && errno
== EIO
)
6995 return -2; /* Close this terminal. */
6996 #if defined (AIX) && defined (_BSD)
6997 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6998 This looks incorrect, but it isn't, because _BSD causes
6999 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7000 and that causes a value other than 0 when there is no input. */
7002 return -2; /* Close this terminal. */
7006 /* We used to retry the read if it was interrupted.
7007 But this does the wrong thing when O_NDELAY causes
7008 an EAGAIN error. Does anybody know of a situation
7009 where a retry is actually needed? */
7011 nread
< 0 && (errno
== EAGAIN
7025 #if defined (USG) || defined (CYGWIN)
7026 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7027 #endif /* USG or CYGWIN */
7028 #endif /* no FIONREAD */
7033 #endif /* not MSDOS */
7034 #endif /* not WINDOWSNT */
7036 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7037 & CODING_REQUIRE_DECODING_MASK
)
7039 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7042 /* Decode the key sequence except for those with meta
7044 for (i
= from
= 0; ; i
++)
7045 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7047 struct input_event buf
;
7049 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7054 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7055 buf
.modifiers
= meta_modifier
;
7056 buf
.code
= cbuf
[i
] & ~0x80;
7057 /* See the comment below. */
7058 buf
.frame_or_window
= tty
->top_frame
;
7060 kbd_buffer_store_event (&buf
);
7066 for (i
= 0; i
< nread
; i
++)
7068 struct input_event buf
;
7070 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7072 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7073 buf
.modifiers
= meta_modifier
;
7074 if (tty
->meta_key
!= 2)
7078 /* Set the frame corresponding to the active tty. Note that the
7079 value of selected_frame is not reliable here, redisplay tends
7080 to temporarily change it. */
7081 buf
.frame_or_window
= tty
->top_frame
;
7084 kbd_buffer_store_event (&buf
);
7085 /* Don't look at input that follows a C-g too closely.
7086 This reduces lossage due to autorepeat on C-g. */
7087 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7088 && buf
.code
== quit_char
)
7096 handle_async_input (void)
7098 interrupt_input_pending
= 0;
7100 pending_signals
= pending_atimers
;
7102 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7103 doing anything dangerous. */
7110 nread
= read_avail_input (1);
7111 /* -1 means it's not ok to read the input now.
7112 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7113 0 means there was no keyboard input available. */
7123 process_pending_signals (void)
7125 if (interrupt_input_pending
)
7126 handle_async_input ();
7127 do_pending_atimers ();
7130 #ifdef SIGIO /* for entire page */
7131 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7134 input_available_signal (int signo
)
7136 /* Must preserve main program's value of errno. */
7137 int old_errno
= errno
;
7138 SIGNAL_THREAD_CHECK (signo
);
7141 interrupt_input_pending
= 1;
7142 pending_signals
= 1;
7145 if (input_available_clear_time
)
7146 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7149 handle_async_input ();
7156 /* Send ourselves a SIGIO.
7158 This function exists so that the UNBLOCK_INPUT macro in
7159 blockinput.h can have some way to take care of input we put off
7160 dealing with, without assuming that every file which uses
7161 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7163 reinvoke_input_signal (void)
7166 handle_async_input ();
7172 /* User signal events. */
7174 struct user_signal_info
7176 /* Signal number. */
7179 /* Name of the signal. */
7182 /* Number of pending signals. */
7185 struct user_signal_info
*next
;
7188 /* List of user signals. */
7189 static struct user_signal_info
*user_signals
= NULL
;
7192 add_user_signal (int sig
, const char *name
)
7194 struct user_signal_info
*p
;
7196 for (p
= user_signals
; p
; p
= p
->next
)
7198 /* Already added. */
7201 p
= xmalloc (sizeof (struct user_signal_info
));
7203 p
->name
= xstrdup (name
);
7205 p
->next
= user_signals
;
7208 signal (sig
, handle_user_signal
);
7212 handle_user_signal (int sig
)
7214 int old_errno
= errno
;
7215 struct user_signal_info
*p
;
7217 SIGNAL_THREAD_CHECK (sig
);
7219 for (p
= user_signals
; p
; p
= p
->next
)
7224 if (interrupt_input
)
7225 kill (getpid (), SIGIO
);
7229 /* Tell wait_reading_process_output that it needs to wake
7230 up and look around. */
7231 if (input_available_clear_time
)
7232 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7241 find_user_signal_name (int sig
)
7243 struct user_signal_info
*p
;
7245 for (p
= user_signals
; p
; p
= p
->next
)
7253 store_user_signal_events (void)
7255 struct user_signal_info
*p
;
7256 struct input_event buf
;
7259 for (p
= user_signals
; p
; p
= p
->next
)
7260 if (p
->npending
> 0)
7266 memset (&buf
, 0, sizeof buf
);
7267 buf
.kind
= USER_SIGNAL_EVENT
;
7268 buf
.frame_or_window
= selected_frame
;
7270 nstored
+= p
->npending
;
7272 mask
= sigblock (sigmask (p
->sig
));
7276 kbd_buffer_store_event (&buf
);
7279 while (p
->npending
> 0);
7287 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7288 static Lisp_Object menu_bar_one_keymap_changed_items
;
7290 /* These variables hold the vector under construction within
7291 menu_bar_items and its subroutines, and the current index
7292 for storing into that vector. */
7293 static Lisp_Object menu_bar_items_vector
;
7294 static int menu_bar_items_index
;
7297 static const char* separator_names
[] = {
7302 "single-dashed-line",
7303 "double-dashed-line",
7305 "shadow-etched-out",
7306 "shadow-etched-in-dash",
7307 "shadow-etched-out-dash",
7308 "shadow-double-etched-in",
7309 "shadow-double-etched-out",
7310 "shadow-double-etched-in-dash",
7311 "shadow-double-etched-out-dash",
7315 /* Return non-zero if LABEL specifies a separator. */
7318 menu_separator_name_p (const char *label
)
7322 else if (strlen (label
) > 3
7323 && strncmp (label
, "--", 2) == 0
7328 for (i
= 0; separator_names
[i
]; ++i
)
7329 if (strcmp (label
, separator_names
[i
]) == 0)
7334 /* It's a separator if it contains only dashes. */
7335 while (*label
== '-')
7337 return (*label
== 0);
7344 /* Return a vector of menu items for a menu bar, appropriate
7345 to the current buffer. Each item has three elements in the vector:
7348 OLD is an old vector we can optionally reuse, or nil. */
7351 menu_bar_items (Lisp_Object old
)
7353 /* The number of keymaps we're scanning right now, and the number of
7354 keymaps we have allocated space for. */
7357 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7358 in the current keymaps, or nil where it is not a prefix. */
7361 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'. */
7423 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7424 if (!NILP (maps
[mapno
]))
7426 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7430 menu_bar_one_keymap_changed_items
= Qnil
;
7431 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7435 /* Move to the end those items that should be at the end. */
7437 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7440 int end
= menu_bar_items_index
;
7442 for (i
= 0; i
< end
; i
+= 4)
7443 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7445 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7446 /* Move the item at index I to the end,
7447 shifting all the others forward. */
7448 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7449 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7450 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7451 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7453 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7454 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7455 (end
- i
- 4) * sizeof (Lisp_Object
));
7456 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7457 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7458 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7459 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7464 /* Add nil, nil, nil, nil at the end. */
7466 int i
= menu_bar_items_index
;
7467 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7468 menu_bar_items_vector
=
7469 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7470 /* Add this item. */
7471 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7472 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7473 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7474 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7475 menu_bar_items_index
= i
;
7478 Vinhibit_quit
= oquit
;
7479 return menu_bar_items_vector
;
7482 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7483 If there's already an item for KEY, add this DEF to it. */
7485 Lisp_Object item_properties
;
7488 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7490 struct gcpro gcpro1
;
7494 if (EQ (item
, Qundefined
))
7496 /* If a map has an explicit `undefined' as definition,
7497 discard any previously made menu bar item. */
7499 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7500 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7502 if (menu_bar_items_index
> i
+ 4)
7503 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7504 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7505 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7506 menu_bar_items_index
-= 4;
7510 /* If this keymap has already contributed to this KEY,
7511 don't contribute to it a second time. */
7512 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7513 if (!NILP (tem
) || NILP (item
))
7516 menu_bar_one_keymap_changed_items
7517 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7519 /* We add to menu_bar_one_keymap_changed_items before doing the
7520 parse_menu_item, so that if it turns out it wasn't a menu item,
7521 it still correctly hides any further menu item. */
7523 i
= parse_menu_item (item
, 1);
7528 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7530 /* Find any existing item for this KEY. */
7531 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7532 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7535 /* If we did not find this KEY, add it at the end. */
7536 if (i
== menu_bar_items_index
)
7538 /* If vector is too small, get a bigger one. */
7539 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7540 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7541 /* Add this item. */
7542 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7543 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7544 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7545 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7546 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7547 menu_bar_items_index
= i
;
7549 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7553 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7554 /* If the new and the old items are not both keymaps,
7555 the lookup will only find `item'. */
7556 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7557 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7561 /* This is used as the handler when calling menu_item_eval_property. */
7563 menu_item_eval_property_1 (Lisp_Object arg
)
7565 /* If we got a quit from within the menu computation,
7566 quit all the way out of it. This takes care of C-] in the debugger. */
7567 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7568 Fsignal (Qquit
, Qnil
);
7574 eval_dyn (Lisp_Object form
)
7576 return Feval (form
, Qnil
);
7579 /* Evaluate an expression and return the result (or nil if something
7580 went wrong). Used to evaluate dynamic parts of menu items. */
7582 menu_item_eval_property (Lisp_Object sexpr
)
7584 int count
= SPECPDL_INDEX ();
7586 specbind (Qinhibit_redisplay
, Qt
);
7587 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7588 menu_item_eval_property_1
);
7589 return unbind_to (count
, val
);
7592 /* This function parses a menu item and leaves the result in the
7593 vector item_properties.
7594 ITEM is a key binding, a possible menu item.
7595 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7597 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7598 parse_menu_item returns true if the item is a menu item and false
7602 parse_menu_item (Lisp_Object item
, int inmenubar
)
7604 Lisp_Object def
, tem
, item_string
, start
;
7606 Lisp_Object keyhint
;
7615 /* Create item_properties vector if necessary. */
7616 if (NILP (item_properties
))
7618 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7620 /* Initialize optional entries. */
7621 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7622 ASET (item_properties
, i
, Qnil
);
7623 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7625 /* Save the item here to protect it from GC. */
7626 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7628 item_string
= XCAR (item
);
7632 if (STRINGP (item_string
))
7634 /* Old format menu item. */
7635 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7637 /* Maybe help string. */
7638 if (CONSP (item
) && STRINGP (XCAR (item
)))
7640 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7645 /* Maybe an obsolete key binding cache. */
7646 if (CONSP (item
) && CONSP (XCAR (item
))
7647 && (NILP (XCAR (XCAR (item
)))
7648 || VECTORP (XCAR (XCAR (item
)))))
7651 /* This is the real definition--the function to run. */
7652 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7654 /* Get enable property, if any. */
7657 tem
= Fget (item
, Qmenu_enable
);
7658 if (!NILP (Venable_disabled_menus_and_buttons
))
7659 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7660 else if (!NILP (tem
))
7661 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7664 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7666 /* New format menu item. */
7667 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7668 start
= XCDR (item
);
7671 /* We have a real binding. */
7672 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7674 item
= XCDR (start
);
7675 /* Is there an obsolete cache list with key equivalences. */
7676 if (CONSP (item
) && CONSP (XCAR (item
)))
7679 /* Parse properties. */
7680 while (CONSP (item
) && CONSP (XCDR (item
)))
7685 if (EQ (tem
, QCenable
))
7687 if (!NILP (Venable_disabled_menus_and_buttons
))
7688 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7690 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7692 else if (EQ (tem
, QCvisible
))
7694 /* If got a visible property and that evaluates to nil
7695 then ignore this item. */
7696 tem
= menu_item_eval_property (XCAR (item
));
7700 else if (EQ (tem
, QChelp
))
7701 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7702 else if (EQ (tem
, QCfilter
))
7704 else if (EQ (tem
, QCkey_sequence
))
7707 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7708 /* Be GC protected. Set keyhint to item instead of tem. */
7711 else if (EQ (tem
, QCkeys
))
7714 if (CONSP (tem
) || STRINGP (tem
))
7715 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7717 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7722 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7724 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7726 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7732 else if (inmenubar
|| !NILP (start
))
7736 return 0; /* not a menu item */
7738 /* If item string is not a string, evaluate it to get string.
7739 If we don't get a string, skip this item. */
7740 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7741 if (!(STRINGP (item_string
)))
7743 item_string
= menu_item_eval_property (item_string
);
7744 if (!STRINGP (item_string
))
7746 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7749 /* If got a filter apply it on definition. */
7750 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7753 def
= menu_item_eval_property (list2 (XCAR (filter
),
7754 list2 (Qquote
, def
)));
7756 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7759 /* Enable or disable selection of item. */
7760 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7763 tem
= menu_item_eval_property (tem
);
7764 if (inmenubar
&& NILP (tem
))
7765 return 0; /* Ignore disabled items in menu bar. */
7766 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7769 /* If we got no definition, this item is just unselectable text which
7770 is OK in a submenu but not in the menubar. */
7772 return (inmenubar
? 0 : 1);
7774 /* See if this is a separate pane or a submenu. */
7775 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7776 tem
= get_keymap (def
, 0, 1);
7777 /* For a subkeymap, just record its details and exit. */
7780 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7781 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7785 /* At the top level in the menu bar, do likewise for commands also.
7786 The menu bar does not display equivalent key bindings anyway.
7787 ITEM_PROPERTY_DEF is already set up properly. */
7791 { /* This is a command. See if there is an equivalent key binding. */
7792 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7794 /* The previous code preferred :key-sequence to :keys, so we
7795 preserve this behavior. */
7796 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7797 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7800 Lisp_Object prefix
= keyeq
;
7801 Lisp_Object keys
= Qnil
;
7805 def
= XCAR (prefix
);
7806 prefix
= XCDR (prefix
);
7809 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7811 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7813 keys
= XCAR (keyhint
);
7814 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7816 /* We have a suggested key. Is it bound to the command? */
7819 /* If the command is an alias for another
7820 (such as lmenu.el set it up), check if the
7821 original command matches the cached command. */
7822 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7827 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7831 tem
= Fkey_description (keys
, Qnil
);
7834 if (STRINGP (XCAR (prefix
)))
7835 tem
= concat2 (XCAR (prefix
), tem
);
7836 if (STRINGP (XCDR (prefix
)))
7837 tem
= concat2 (tem
, XCDR (prefix
));
7839 keyeq
= concat2 (build_string (" "), tem
);
7840 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7846 /* If we have an equivalent key binding, use that. */
7847 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7850 /* Include this when menu help is implemented.
7851 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7852 if (!(NILP (tem) || STRINGP (tem)))
7854 tem = menu_item_eval_property (tem);
7857 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7861 /* Handle radio buttons or toggle boxes. */
7862 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7864 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7865 menu_item_eval_property (tem
));
7872 /***********************************************************************
7874 ***********************************************************************/
7876 /* A vector holding tool bar items while they are parsed in function
7877 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7880 static Lisp_Object tool_bar_items_vector
;
7882 /* A vector holding the result of parse_tool_bar_item. Layout is like
7883 the one for a single item in tool_bar_items_vector. */
7885 static Lisp_Object tool_bar_item_properties
;
7887 /* Next free index in tool_bar_items_vector. */
7889 static int ntool_bar_items
;
7891 /* The symbols `:image' and `:rtl'. */
7893 Lisp_Object QCimage
;
7896 /* Function prototypes. */
7898 static void init_tool_bar_items (Lisp_Object
);
7899 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7900 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7901 static void append_tool_bar_item (void);
7904 /* Return a vector of tool bar items for keymaps currently in effect.
7905 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7906 tool bar items found. */
7909 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7918 /* In order to build the menus, we need to call the keymap
7919 accessors. They all call QUIT. But this function is called
7920 during redisplay, during which a quit is fatal. So inhibit
7921 quitting while building the menus. We do this instead of
7922 specbind because (1) errors will clear it anyway and (2) this
7923 avoids risk of specpdl overflow. */
7924 oquit
= Vinhibit_quit
;
7927 /* Initialize tool_bar_items_vector and protect it from GC. */
7928 init_tool_bar_items (reuse
);
7930 /* Build list of keymaps in maps. Set nmaps to the number of maps
7933 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7934 if (!NILP (Voverriding_local_map_menu_flag
))
7936 /* Yes, use them (if non-nil) as well as the global map. */
7937 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7939 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7940 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7941 if (!NILP (Voverriding_local_map
))
7942 maps
[nmaps
++] = Voverriding_local_map
;
7946 /* No, so use major and minor mode keymaps and keymap property.
7947 Note that tool-bar bindings in the local-map and keymap
7948 properties may not work reliable, as they are only
7949 recognized when the tool-bar (or mode-line) is updated,
7950 which does not normally happen after every command. */
7953 nminor
= current_minor_maps (NULL
, &tmaps
);
7954 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7956 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7957 maps
[nmaps
++] = tem
;
7958 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7960 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7963 /* Add global keymap at the end. */
7964 maps
[nmaps
++] = current_global_map
;
7966 /* Process maps in reverse order and look up in each map the prefix
7968 for (i
= nmaps
- 1; i
>= 0; --i
)
7969 if (!NILP (maps
[i
]))
7973 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7975 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7978 Vinhibit_quit
= oquit
;
7979 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7980 return tool_bar_items_vector
;
7984 /* Process the definition of KEY which is DEF. */
7987 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7990 struct gcpro gcpro1
, gcpro2
;
7992 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7996 if (EQ (def
, Qundefined
))
7998 /* If a map has an explicit `undefined' as definition,
7999 discard any previously made item. */
8000 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8002 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8004 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8006 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8007 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8008 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8009 * sizeof (Lisp_Object
)));
8010 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8015 else if (parse_tool_bar_item (key
, def
))
8016 /* Append a new tool bar item to tool_bar_items_vector. Accept
8017 more than one definition for the same key. */
8018 append_tool_bar_item ();
8024 /* Parse a tool bar item specification ITEM for key KEY and return the
8025 result in tool_bar_item_properties. Value is zero if ITEM is
8028 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8030 CAPTION is the caption of the item, If it's not a string, it is
8031 evaluated to get a string.
8033 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8034 as binding are currently ignored.
8036 The following properties are recognized:
8040 FORM is evaluated and specifies whether the tool bar item is
8041 enabled or disabled.
8045 FORM is evaluated and specifies whether the tool bar item is visible.
8047 - `:filter FUNCTION'
8049 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8050 result is stored as the new binding.
8052 - `:button (TYPE SELECTED)'
8054 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8055 and specifies whether the button is selected (pressed) or not.
8059 IMAGES is either a single image specification or a vector of four
8060 image specifications. See enum tool_bar_item_images.
8062 - `:help HELP-STRING'.
8064 Gives a help string to display for the tool bar item.
8066 - `:label LABEL-STRING'.
8068 A text label to show with the tool bar button if labels are enabled. */
8071 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8073 /* Access slot with index IDX of vector tool_bar_item_properties. */
8074 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8076 Lisp_Object filter
= Qnil
;
8077 Lisp_Object caption
;
8078 int i
, have_label
= 0;
8080 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8081 Rule out items that aren't lists, don't start with
8082 `menu-item' or whose rest following `tool-bar-item' is not a
8087 /* As an exception, allow old-style menu separators. */
8088 if (STRINGP (XCAR (item
)))
8089 item
= Fcons (XCAR (item
), Qnil
);
8090 else if (!EQ (XCAR (item
), Qmenu_item
)
8091 || (item
= XCDR (item
), !CONSP (item
)))
8094 /* Create tool_bar_item_properties vector if necessary. Reset it to
8096 if (VECTORP (tool_bar_item_properties
))
8098 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8102 tool_bar_item_properties
8103 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8106 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8107 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8109 /* Get the caption of the item. If the caption is not a string,
8110 evaluate it to get a string. If we don't get a string, skip this
8112 caption
= XCAR (item
);
8113 if (!STRINGP (caption
))
8115 caption
= menu_item_eval_property (caption
);
8116 if (!STRINGP (caption
))
8119 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8121 /* If the rest following the caption is not a list, the menu item is
8122 either a separator, or invalid. */
8126 if (menu_separator_name_p (SSDATA (caption
)))
8128 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8129 #if !defined (USE_GTK) && !defined (HAVE_NS)
8130 /* If we use build_desired_tool_bar_string to render the
8131 tool bar, the separator is rendered as an image. */
8132 PROP (TOOL_BAR_ITEM_IMAGES
)
8133 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8134 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8135 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8136 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8143 /* Store the binding. */
8144 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8147 /* Ignore cached key binding, if any. */
8148 if (CONSP (item
) && CONSP (XCAR (item
)))
8151 /* Process the rest of the properties. */
8152 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8154 Lisp_Object ikey
, value
;
8157 value
= XCAR (XCDR (item
));
8159 if (EQ (ikey
, QCenable
))
8161 /* `:enable FORM'. */
8162 if (!NILP (Venable_disabled_menus_and_buttons
))
8163 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8165 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8167 else if (EQ (ikey
, QCvisible
))
8169 /* `:visible FORM'. If got a visible property and that
8170 evaluates to nil then ignore this item. */
8171 if (NILP (menu_item_eval_property (value
)))
8174 else if (EQ (ikey
, QChelp
))
8175 /* `:help HELP-STRING'. */
8176 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8177 else if (EQ (ikey
, QCvert_only
))
8178 /* `:vert-only t/nil'. */
8179 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8180 else if (EQ (ikey
, QClabel
))
8182 const char *bad_label
= "!!?GARBLED ITEM?!!";
8183 /* `:label LABEL-STRING'. */
8184 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8186 : make_string (bad_label
, strlen (bad_label
));
8189 else if (EQ (ikey
, QCfilter
))
8190 /* ':filter FORM'. */
8192 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8194 /* `:button (TYPE . SELECTED)'. */
8195 Lisp_Object type
, selected
;
8197 type
= XCAR (value
);
8198 selected
= XCDR (value
);
8199 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8201 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8202 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8205 else if (EQ (ikey
, QCimage
)
8207 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8208 /* Value is either a single image specification or a vector
8209 of 4 such specifications for the different button states. */
8210 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8211 else if (EQ (ikey
, Qrtl
))
8213 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8219 /* Try to make one from caption and key. */
8220 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8221 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8222 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8223 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8224 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8225 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8226 Lisp_Object new_lbl
;
8227 size_t caption_len
= strlen (capt
);
8229 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8232 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8234 buf
[caption_len
] = '\0';
8238 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8242 strcpy (buf
, label
);
8244 for (j
= 0; buf
[j
] != '\0'; ++j
)
8252 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8253 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8254 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8256 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8260 /* If got a filter apply it on binding. */
8262 PROP (TOOL_BAR_ITEM_BINDING
)
8263 = menu_item_eval_property (list2 (filter
,
8265 PROP (TOOL_BAR_ITEM_BINDING
))));
8267 /* See if the binding is a keymap. Give up if it is. */
8268 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8271 /* Enable or disable selection of item. */
8272 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8273 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8274 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8276 /* Handle radio buttons or toggle boxes. */
8277 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8278 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8279 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8287 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8288 that can be reused. */
8291 init_tool_bar_items (Lisp_Object reuse
)
8293 if (VECTORP (reuse
))
8294 tool_bar_items_vector
= reuse
;
8296 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8297 ntool_bar_items
= 0;
8301 /* Append parsed tool bar item properties from
8302 tool_bar_item_properties */
8305 append_tool_bar_item (void)
8307 Lisp_Object
*to
, *from
;
8309 /* Enlarge tool_bar_items_vector if necessary. */
8310 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8311 >= XVECTOR (tool_bar_items_vector
)->size
)
8312 tool_bar_items_vector
8313 = larger_vector (tool_bar_items_vector
,
8314 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8316 /* Append entries from tool_bar_item_properties to the end of
8317 tool_bar_items_vector. */
8318 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8319 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8320 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8321 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8328 /* Read a character using menus based on maps in the array MAPS.
8329 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8330 Return t if we displayed a menu but the user rejected it.
8332 PREV_EVENT is the previous input event, or nil if we are reading
8333 the first event of a key sequence.
8335 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8336 if we used a mouse menu to read the input, or zero otherwise. If
8337 USED_MOUSE_MENU is null, we don't dereference it.
8339 The prompting is done based on the prompt-string of the map
8340 and the strings associated with various map elements.
8342 This can be done with X menus or with menus put in the minibuf.
8343 These are done in different ways, depending on how the input will be read.
8344 Menus using X are done after auto-saving in read-char, getting the input
8345 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8346 and do auto-saving in the inner call of read_char. */
8349 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8350 int *used_mouse_menu
)
8354 if (used_mouse_menu
)
8355 *used_mouse_menu
= 0;
8357 /* Use local over global Menu maps */
8359 if (! menu_prompting
)
8362 /* Optionally disregard all but the global map. */
8363 if (inhibit_local_menu_bar_menus
)
8365 maps
+= (nmaps
- 1);
8370 /* If we got to this point via a mouse click,
8371 use a real menu for mouse selection. */
8372 if (EVENT_HAS_PARAMETERS (prev_event
)
8373 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8374 && !EQ (XCAR (prev_event
), Qtool_bar
))
8376 /* Display the menu and get the selection. */
8377 Lisp_Object
*realmaps
8378 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8382 /* Use the maps that are not nil. */
8383 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8384 if (!NILP (maps
[mapno
]))
8385 realmaps
[nmaps1
++] = maps
[mapno
];
8387 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8392 record_menu_key (XCAR (value
));
8394 /* If we got multiple events, unread all but
8396 There is no way to prevent those unread events
8397 from showing up later in last_nonmenu_event.
8398 So turn symbol and integer events into lists,
8399 to indicate that they came from a mouse menu,
8400 so that when present in last_nonmenu_event
8401 they won't confuse things. */
8402 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8404 record_menu_key (XCAR (tem
));
8405 if (SYMBOLP (XCAR (tem
))
8406 || INTEGERP (XCAR (tem
)))
8407 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8410 /* If we got more than one event, put all but the first
8411 onto this list to be read later.
8412 Return just the first event now. */
8413 Vunread_command_events
8414 = nconc2 (XCDR (value
), Vunread_command_events
);
8415 value
= XCAR (value
);
8417 else if (NILP (value
))
8419 if (used_mouse_menu
)
8420 *used_mouse_menu
= 1;
8423 #endif /* HAVE_MENUS */
8427 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8428 We make this bigger when necessary, and never free it. */
8429 static char *read_char_minibuf_menu_text
;
8430 /* Size of that buffer. */
8431 static int read_char_minibuf_menu_width
;
8434 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8437 register Lisp_Object name
;
8439 /* FIXME: Use the minibuffer's frame width. */
8440 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8443 Lisp_Object rest
, vector
;
8449 if (! menu_prompting
)
8452 /* Get the menu name from the first map that has one (a prompt string). */
8453 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8455 name
= Fkeymap_prompt (maps
[mapno
]);
8460 /* If we don't have any menus, just read a character normally. */
8461 if (!STRINGP (name
))
8464 /* Make sure we have a big enough buffer for the menu text. */
8465 width
= max (width
, SBYTES (name
));
8466 if (read_char_minibuf_menu_text
== 0)
8468 read_char_minibuf_menu_width
= width
+ 4;
8469 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8471 else if (width
+ 4 > read_char_minibuf_menu_width
)
8473 read_char_minibuf_menu_width
= width
+ 4;
8474 read_char_minibuf_menu_text
8475 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8477 menu
= read_char_minibuf_menu_text
;
8479 /* Prompt string always starts with map's prompt, and a space. */
8480 strcpy (menu
, SSDATA (name
));
8481 nlength
= SBYTES (name
);
8482 menu
[nlength
++] = ':';
8483 menu
[nlength
++] = ' ';
8486 /* Start prompting at start of first map. */
8490 /* Present the documented bindings, a line at a time. */
8496 Lisp_Object orig_defn_macro
;
8498 /* Loop over elements of map. */
8503 /* If reached end of map, start at beginning of next map. */
8507 /* At end of last map, wrap around to first map if just starting,
8508 or end this line if already have something on it. */
8512 if (notfirst
|| nobindings
) break;
8517 /* Look at the next element of the map. */
8519 elt
= XVECTOR (vector
)->contents
[idx
];
8521 elt
= Fcar_safe (rest
);
8523 if (idx
< 0 && VECTORP (elt
))
8525 /* If we found a dense table in the keymap,
8526 advanced past it, but start scanning its contents. */
8527 rest
= Fcdr_safe (rest
);
8533 /* An ordinary element. */
8534 Lisp_Object event
, tem
;
8538 event
= Fcar_safe (elt
); /* alist */
8539 elt
= Fcdr_safe (elt
);
8543 XSETINT (event
, idx
); /* vector */
8546 /* Ignore the element if it has no prompt string. */
8547 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8549 /* 1 if the char to type matches the string. */
8551 Lisp_Object upcased_event
, downcased_event
;
8552 Lisp_Object desc
= Qnil
;
8554 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8556 upcased_event
= Fupcase (event
);
8557 downcased_event
= Fdowncase (event
);
8558 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8559 || XINT (downcased_event
) == SREF (s
, 0));
8561 desc
= Fsingle_key_description (event
, Qnil
);
8563 #if 0 /* It is redundant to list the equivalent key bindings because
8564 the prefix is what the user has already typed. */
8566 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8568 /* Insert equivalent keybinding. */
8569 s
= concat2 (s
, tem
);
8572 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8573 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8575 /* Insert button prefix. */
8576 Lisp_Object selected
8577 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8578 if (EQ (tem
, QCradio
))
8579 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8581 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8582 s
= concat2 (tem
, s
);
8586 /* If we have room for the prompt string, add it to this line.
8587 If this is the first on the line, always add it. */
8588 if ((SCHARS (s
) + i
+ 2
8589 + (char_matches
? 0 : SCHARS (desc
) + 3))
8595 /* Punctuate between strings. */
8598 strcpy (menu
+ i
, ", ");
8604 /* If the char to type doesn't match the string's
8605 first char, explicitly show what char to type. */
8608 /* Add as much of string as fits. */
8609 thiswidth
= SCHARS (desc
);
8610 if (thiswidth
+ i
> width
)
8611 thiswidth
= width
- i
;
8612 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8614 strcpy (menu
+ i
, " = ");
8618 /* Add as much of string as fits. */
8619 thiswidth
= SCHARS (s
);
8620 if (thiswidth
+ i
> width
)
8621 thiswidth
= width
- i
;
8622 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8628 /* If this element does not fit, end the line now,
8629 and save the element for the next line. */
8630 strcpy (menu
+ i
, "...");
8635 /* Move past this element. */
8636 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8637 /* Handle reaching end of dense table. */
8642 rest
= Fcdr_safe (rest
);
8646 /* Prompt with that and read response. */
8647 message2_nolog (menu
, strlen (menu
),
8648 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8650 /* Make believe its not a keyboard macro in case the help char
8651 is pressed. Help characters are not recorded because menu prompting
8652 is not used on replay.
8654 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8655 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8657 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8658 while (BUFFERP (obj
));
8659 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8661 if (!INTEGERP (obj
))
8663 else if (XINT (obj
) == -2)
8666 if (! EQ (obj
, menu_prompt_more_char
)
8667 && (!INTEGERP (menu_prompt_more_char
)
8668 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8670 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8671 store_kbd_macro_char (obj
);
8674 /* Help char - go round again */
8678 /* Reading key sequences. */
8680 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8681 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8682 keymap, or nil otherwise. Return the index of the first keymap in
8683 which KEY has any binding, or NMAPS if no map has a binding.
8685 If KEY is a meta ASCII character, treat it like meta-prefix-char
8686 followed by the corresponding non-meta character. Keymaps in
8687 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8690 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8693 NEXT may be the same array as CURRENT. */
8696 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8699 int i
, first_binding
;
8701 first_binding
= nmaps
;
8702 for (i
= nmaps
- 1; i
>= 0; i
--)
8704 if (! NILP (current
[i
]))
8706 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8707 if (! NILP (defs
[i
]))
8714 /* Given the set of bindings we've found, produce the next set of maps. */
8715 if (first_binding
< nmaps
)
8716 for (i
= 0; i
< nmaps
; i
++)
8717 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8719 return first_binding
;
8722 /* Structure used to keep track of partial application of key remapping
8723 such as Vfunction_key_map and Vkey_translation_map. */
8724 typedef struct keyremap
8726 /* This is the map originally specified for this use. */
8728 /* This is a submap reached by looking up, in PARENT,
8729 the events from START to END. */
8731 /* Positions [START, END) in the key sequence buffer
8732 are the key that we have scanned so far.
8733 Those events are the ones that we will replace
8734 if PAREHT maps them into a key sequence. */
8738 /* Lookup KEY in MAP.
8739 MAP is a keymap mapping keys to key vectors or functions.
8740 If the mapping is a function and DO_FUNCTION is non-zero, then
8741 the function is called with PROMPT as parameter and its return
8742 value is used as the return value of this function (after checking
8743 that it is indeed a vector). */
8746 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8751 next
= access_keymap (map
, key
, 1, 0, 1);
8753 /* Handle symbol with autoload definition. */
8754 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8755 && CONSP (XSYMBOL (next
)->function
)
8756 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8757 do_autoload (XSYMBOL (next
)->function
, next
);
8759 /* Handle a symbol whose function definition is a keymap
8761 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8762 && (ARRAYP (XSYMBOL (next
)->function
)
8763 || KEYMAPP (XSYMBOL (next
)->function
)))
8764 next
= XSYMBOL (next
)->function
;
8766 /* If the keymap gives a function, not an
8767 array, then call the function with one arg and use
8768 its value instead. */
8769 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8774 next
= call1 (next
, prompt
);
8775 /* If the function returned something invalid,
8776 barf--don't ignore it.
8777 (To ignore it safely, we would need to gcpro a bunch of
8778 other variables.) */
8779 if (! (VECTORP (next
) || STRINGP (next
)))
8780 error ("Function %s returns invalid key sequence", tem
);
8785 /* Do one step of the key remapping used for function-key-map and
8786 key-translation-map:
8787 KEYBUF is the buffer holding the input events.
8788 BUFSIZE is its maximum size.
8789 FKEY is a pointer to the keyremap structure to use.
8790 INPUT is the index of the last element in KEYBUF.
8791 DOIT if non-zero says that the remapping can actually take place.
8792 DIFF is used to return the number of keys added/removed by the remapping.
8793 PARENT is the root of the keymap.
8794 PROMPT is the prompt to use if the remapping happens through a function.
8795 The return value is non-zero if the remapping actually took place. */
8798 keyremap_step (Lisp_Object
*keybuf
, size_t bufsize
, volatile keyremap
*fkey
,
8799 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8801 Lisp_Object next
, key
;
8803 key
= keybuf
[fkey
->end
++];
8805 if (KEYMAPP (fkey
->parent
))
8806 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8810 /* If keybuf[fkey->start..fkey->end] is bound in the
8811 map and we're in a position to do the key remapping, replace it with
8812 the binding and restart with fkey->start at the end. */
8813 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8815 int len
= XFASTINT (Flength (next
));
8818 *diff
= len
- (fkey
->end
- fkey
->start
);
8820 if (input
+ *diff
>= bufsize
)
8821 error ("Key sequence too long");
8823 /* Shift the keys that follow fkey->end. */
8825 for (i
= fkey
->end
; i
< input
; i
++)
8826 keybuf
[i
+ *diff
] = keybuf
[i
];
8828 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8829 keybuf
[i
+ *diff
] = keybuf
[i
];
8830 /* Overwrite the old keys with the new ones. */
8831 for (i
= 0; i
< len
; i
++)
8832 keybuf
[fkey
->start
+ i
]
8833 = Faref (next
, make_number (i
));
8835 fkey
->start
= fkey
->end
+= *diff
;
8836 fkey
->map
= fkey
->parent
;
8841 fkey
->map
= get_keymap (next
, 0, 1);
8843 /* If we no longer have a bound suffix, try a new position for
8845 if (!CONSP (fkey
->map
))
8847 fkey
->end
= ++fkey
->start
;
8848 fkey
->map
= fkey
->parent
;
8853 /* Read a sequence of keys that ends with a non prefix character,
8854 storing it in KEYBUF, a buffer of size BUFSIZE.
8856 Return the length of the key sequence stored.
8857 Return -1 if the user rejected a command menu.
8859 Echo starting immediately unless `prompt' is 0.
8861 Where a key sequence ends depends on the currently active keymaps.
8862 These include any minor mode keymaps active in the current buffer,
8863 the current buffer's local map, and the global map.
8865 If a key sequence has no other bindings, we check Vfunction_key_map
8866 to see if some trailing subsequence might be the beginning of a
8867 function key's sequence. If so, we try to read the whole function
8868 key, and substitute its symbolic name into the key sequence.
8870 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8871 `double-' events into similar click events, if that would make them
8872 bound. We try to turn `triple-' events first into `double-' events,
8875 If we get a mouse click in a mode line, vertical divider, or other
8876 non-text area, we treat the click as if it were prefixed by the
8877 symbol denoting that area - `mode-line', `vertical-line', or
8880 If the sequence starts with a mouse click, we read the key sequence
8881 with respect to the buffer clicked on, not the current buffer.
8883 If the user switches frames in the midst of a key sequence, we put
8884 off the switch-frame event until later; the next call to
8885 read_char will return it.
8887 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8888 from the selected window's buffer. */
8891 read_key_sequence (Lisp_Object
*keybuf
, size_t bufsize
, Lisp_Object prompt
,
8892 int dont_downcase_last
, int can_return_switch_frame
,
8893 int fix_current_buffer
)
8895 Lisp_Object from_string
;
8896 int count
= SPECPDL_INDEX ();
8898 /* How many keys there are in the current key sequence. */
8901 /* The length of the echo buffer when we started reading, and
8902 the length of this_command_keys when we started reading. */
8903 int echo_start
IF_LINT (= 0);
8906 /* The number of keymaps we're scanning right now, and the number of
8907 keymaps we have allocated space for. */
8909 int nmaps_allocated
= 0;
8911 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8912 the current keymaps. */
8913 Lisp_Object
*defs
= NULL
;
8915 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8916 in the current keymaps, or nil where it is not a prefix. */
8917 Lisp_Object
*submaps
= NULL
;
8919 /* The local map to start out with at start of key sequence. */
8920 Lisp_Object orig_local_map
;
8922 /* The map from the `keymap' property to start out with at start of
8924 Lisp_Object orig_keymap
;
8926 /* 1 if we have already considered switching to the local-map property
8927 of the place where a mouse click occurred. */
8928 int localized_local_map
= 0;
8930 /* The index in submaps[] of the first keymap that has a binding for
8931 this key sequence. In other words, the lowest i such that
8932 submaps[i] is non-nil. */
8934 /* Index of the first key that has no binding.
8935 It is useless to try fkey.start larger than that. */
8938 /* If t < mock_input, then KEYBUF[t] should be read as the next
8941 We use this to recover after recognizing a function key. Once we
8942 realize that a suffix of the current key sequence is actually a
8943 function key's escape sequence, we replace the suffix with the
8944 function key's binding from Vfunction_key_map. Now keybuf
8945 contains a new and different key sequence, so the echo area,
8946 this_command_keys, and the submaps and defs arrays are wrong. In
8947 this situation, we set mock_input to t, set t to 0, and jump to
8948 restart_sequence; the loop will read keys from keybuf up until
8949 mock_input, thus rebuilding the state; and then it will resume
8950 reading characters from the keyboard. */
8953 /* If the sequence is unbound in submaps[], then
8954 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8955 and fkey.map is its binding.
8957 These might be > t, indicating that all function key scanning
8958 should hold off until t reaches them. We do this when we've just
8959 recognized a function key, to avoid searching for the function
8960 key's again in Vfunction_key_map. */
8963 /* Likewise, for key_translation_map and input-decode-map. */
8964 keyremap keytran
, indec
;
8966 /* Non-zero if we are trying to map a key by changing an upper-case
8967 letter to lower case, or a shifted function key to an unshifted
8969 int shift_translated
= 0;
8971 /* If we receive a `switch-frame' or `select-window' event in the middle of
8972 a key sequence, we put it off for later.
8973 While we're reading, we keep the event here. */
8974 Lisp_Object delayed_switch_frame
;
8976 /* See the comment below... */
8977 #if defined (GOBBLE_FIRST_EVENT)
8978 Lisp_Object first_event
;
8981 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8982 int original_uppercase_position
= -1;
8984 /* Gets around Microsoft compiler limitations. */
8987 struct buffer
*starting_buffer
;
8989 /* List of events for which a fake prefix key has been generated. */
8990 Lisp_Object fake_prefixed_keys
= Qnil
;
8992 #if defined (GOBBLE_FIRST_EVENT)
8996 struct gcpro outer_gcpro1
;
8998 GCPRO1_VAR (fake_prefixed_keys
, outer_gcpro
);
8999 raw_keybuf_count
= 0;
9001 last_nonmenu_event
= Qnil
;
9003 delayed_switch_frame
= Qnil
;
9009 /* Install the string STR as the beginning of the string of
9010 echoing, so that it serves as a prompt for the next
9012 KVAR (current_kboard
, echo_string
) = prompt
;
9013 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9016 else if (cursor_in_echo_area
9017 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9018 && NILP (Fzerop (Vecho_keystrokes
)))
9019 /* This doesn't put in a dash if the echo buffer is empty, so
9020 you don't always see a dash hanging out in the minibuffer. */
9024 /* Record the initial state of the echo area and this_command_keys;
9025 we will need to restore them if we replay a key sequence. */
9027 echo_start
= echo_length ();
9028 keys_start
= this_command_key_count
;
9029 this_single_command_key_start
= keys_start
;
9031 #if defined (GOBBLE_FIRST_EVENT)
9032 /* This doesn't quite work, because some of the things that read_char
9033 does cannot safely be bypassed. It seems too risky to try to make
9036 /* Read the first char of the sequence specially, before setting
9037 up any keymaps, in case a filter runs and switches buffers on us. */
9038 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9040 #endif /* GOBBLE_FIRST_EVENT */
9042 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9043 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9046 /* We jump here when we need to reinitialize fkey and keytran; this
9047 happens if we switch keyboards between rescans. */
9048 replay_entire_sequence
:
9050 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9051 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9052 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9053 indec
.start
= indec
.end
= 0;
9054 fkey
.start
= fkey
.end
= 0;
9055 keytran
.start
= keytran
.end
= 0;
9057 /* We jump here when the key sequence has been thoroughly changed, and
9058 we need to rescan it starting from the beginning. When we jump here,
9059 keybuf[0..mock_input] holds the sequence we should reread. */
9062 starting_buffer
= current_buffer
;
9063 first_unbound
= bufsize
+ 1;
9065 /* Build our list of keymaps.
9066 If we recognize a function key and replace its escape sequence in
9067 keybuf with its symbol, or if the sequence starts with a mouse
9068 click and we need to switch buffers, we jump back here to rebuild
9069 the initial keymaps from the current buffer. */
9072 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9074 if (2 > nmaps_allocated
)
9076 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9077 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9078 nmaps_allocated
= 2;
9080 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9082 else if (!NILP (Voverriding_local_map
))
9084 if (2 > nmaps_allocated
)
9086 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9087 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9088 nmaps_allocated
= 2;
9090 submaps
[nmaps
++] = Voverriding_local_map
;
9098 nminor
= current_minor_maps (0, &maps
);
9099 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9101 if (total
> nmaps_allocated
)
9103 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9104 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9105 nmaps_allocated
= total
;
9108 if (!NILP (orig_keymap
))
9109 submaps
[nmaps
++] = orig_keymap
;
9111 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9115 submaps
[nmaps
++] = orig_local_map
;
9117 submaps
[nmaps
++] = current_global_map
;
9119 /* Find an accurate initial value for first_binding. */
9120 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9121 if (! NILP (submaps
[first_binding
]))
9124 /* Start from the beginning in keybuf. */
9127 /* These are no-ops the first time through, but if we restart, they
9128 revert the echo area and this_command_keys to their original state. */
9129 this_command_key_count
= keys_start
;
9130 if (INTERACTIVE
&& t
< mock_input
)
9131 echo_truncate (echo_start
);
9133 /* If the best binding for the current key sequence is a keymap, or
9134 we may be looking at a function key's escape sequence, keep on
9136 while (first_binding
< nmaps
9137 /* Keep reading as long as there's a prefix binding. */
9138 ? !NILP (submaps
[first_binding
])
9139 /* Don't return in the middle of a possible function key sequence,
9140 if the only bindings we found were via case conversion.
9141 Thus, if ESC O a has a function-key-map translation
9142 and ESC o has a binding, don't return after ESC O,
9143 so that we can translate ESC O plus the next character. */
9144 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9147 int used_mouse_menu
= 0;
9149 /* Where the last real key started. If we need to throw away a
9150 key that has expanded into more than one element of keybuf
9151 (say, a mouse click on the mode line which is being treated
9152 as [mode-line (mouse-...)], then we backtrack to this point
9154 int last_real_key_start
;
9156 /* These variables are analogous to echo_start and keys_start;
9157 while those allow us to restart the entire key sequence,
9158 echo_local_start and keys_local_start allow us to throw away
9160 int echo_local_start
IF_LINT (= 0);
9161 int keys_local_start
, local_first_binding
;
9163 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9164 eassert (indec
.start
<= indec
.end
);
9165 eassert (fkey
.start
<= fkey
.end
);
9166 eassert (keytran
.start
<= keytran
.end
);
9167 /* key-translation-map is applied *after* function-key-map
9168 which is itself applied *after* input-decode-map. */
9169 eassert (fkey
.end
<= indec
.start
);
9170 eassert (keytran
.end
<= fkey
.start
);
9172 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9173 first_unbound
< keytran
.start
)
9174 { /* The prefix upto first_unbound has no binding and has
9175 no translation left to do either, so we know it's unbound.
9176 If we don't stop now, we risk staying here indefinitely
9177 (if the user keeps entering fkey or keytran prefixes
9178 like C-c ESC ESC ESC ESC ...) */
9180 for (i
= first_unbound
+ 1; i
< t
; i
++)
9181 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9182 mock_input
= t
- first_unbound
- 1;
9183 indec
.end
= indec
.start
-= first_unbound
+ 1;
9184 indec
.map
= indec
.parent
;
9185 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9186 fkey
.map
= fkey
.parent
;
9187 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9188 keytran
.map
= keytran
.parent
;
9189 goto replay_sequence
;
9193 error ("Key sequence too long");
9196 echo_local_start
= echo_length ();
9197 keys_local_start
= this_command_key_count
;
9198 local_first_binding
= first_binding
;
9201 /* These are no-ops, unless we throw away a keystroke below and
9202 jumped back up to replay_key; in that case, these restore the
9203 variables to their original state, allowing us to replay the
9205 if (INTERACTIVE
&& t
< mock_input
)
9206 echo_truncate (echo_local_start
);
9207 this_command_key_count
= keys_local_start
;
9208 first_binding
= local_first_binding
;
9210 /* By default, assume each event is "real". */
9211 last_real_key_start
= t
;
9213 /* Does mock_input indicate that we are re-reading a key sequence? */
9217 add_command_key (key
);
9218 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9219 && NILP (Fzerop (Vecho_keystrokes
)))
9223 /* If not, we should actually read a character. */
9227 KBOARD
*interrupted_kboard
= current_kboard
;
9228 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9229 key
= read_char (NILP (prompt
), nmaps
,
9230 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9231 &used_mouse_menu
, NULL
);
9232 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9233 /* When switching to a new tty (with a new keyboard),
9234 read_char returns the new buffer, rather than -2
9235 (Bug#5095). This is because `terminal-init-xterm'
9236 calls read-char, which eats the wrong_kboard_jmpbuf
9237 return. Any better way to fix this? -- cyd */
9238 || (interrupted_kboard
!= current_kboard
))
9243 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9244 if (k
== interrupted_kboard
)
9249 /* Don't touch interrupted_kboard when it's been
9251 delayed_switch_frame
= Qnil
;
9252 goto replay_entire_sequence
;
9255 if (!NILP (delayed_switch_frame
))
9257 KVAR (interrupted_kboard
, kbd_queue
)
9258 = Fcons (delayed_switch_frame
,
9259 KVAR (interrupted_kboard
, kbd_queue
));
9260 delayed_switch_frame
= Qnil
;
9264 KVAR (interrupted_kboard
, kbd_queue
)
9265 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9267 /* If the side queue is non-empty, ensure it begins with a
9268 switch-frame, so we'll replay it in the right context. */
9269 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9270 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9271 !(EVENT_HAS_PARAMETERS (key
)
9272 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9276 XSETFRAME (frame
, interrupted_frame
);
9277 KVAR (interrupted_kboard
, kbd_queue
)
9278 = Fcons (make_lispy_switch_frame (frame
),
9279 KVAR (interrupted_kboard
, kbd_queue
));
9282 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9283 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9284 goto replay_entire_sequence
;
9288 /* read_char returns t when it shows a menu and the user rejects it.
9292 unbind_to (count
, Qnil
);
9293 UNGCPRO_VAR (outer_gcpro
);
9297 /* read_char returns -1 at the end of a macro.
9298 Emacs 18 handles this by returning immediately with a
9299 zero, so that's what we'll do. */
9300 if (INTEGERP (key
) && XINT (key
) == -1)
9303 /* The Microsoft C compiler can't handle the goto that
9309 /* If the current buffer has been changed from under us, the
9310 keymap may have changed, so replay the sequence. */
9313 timer_resume_idle ();
9316 /* Reset the current buffer from the selected window
9317 in case something changed the former and not the latter.
9318 This is to be more consistent with the behavior
9319 of the command_loop_1. */
9320 if (fix_current_buffer
)
9322 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9324 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9325 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9328 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9329 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9330 goto replay_sequence
;
9333 /* If we have a quit that was typed in another frame, and
9334 quit_throw_to_read_char switched buffers,
9335 replay to get the right keymap. */
9337 && XINT (key
) == quit_char
9338 && current_buffer
!= starting_buffer
)
9341 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9345 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9346 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9347 goto replay_sequence
;
9352 if (EVENT_HAS_PARAMETERS (key
)
9353 /* Either a `switch-frame' or a `select-window' event. */
9354 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9356 /* If we're at the beginning of a key sequence, and the caller
9357 says it's okay, go ahead and return this event. If we're
9358 in the midst of a key sequence, delay it until the end. */
9359 if (t
> 0 || !can_return_switch_frame
)
9361 delayed_switch_frame
= key
;
9367 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9371 /* Clicks in non-text areas get prefixed by the symbol
9372 in their CHAR-ADDRESS field. For example, a click on
9373 the mode line is prefixed by the symbol `mode-line'.
9375 Furthermore, key sequences beginning with mouse clicks
9376 are read using the keymaps of the buffer clicked on, not
9377 the current buffer. So we may have to switch the buffer
9380 When we turn one event into two events, we must make sure
9381 that neither of the two looks like the original--so that,
9382 if we replay the events, they won't be expanded again.
9383 If not for this, such reexpansion could happen either here
9384 or when user programs play with this-command-keys. */
9385 if (EVENT_HAS_PARAMETERS (key
))
9390 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9391 if (EQ (kind
, Qmouse_click
))
9393 Lisp_Object window
, posn
;
9395 window
= POSN_WINDOW (EVENT_START (key
));
9396 posn
= POSN_POSN (EVENT_START (key
));
9399 || (!NILP (fake_prefixed_keys
)
9400 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9402 /* We're looking a second time at an event for which
9403 we generated a fake prefix key. Set
9404 last_real_key_start appropriately. */
9406 last_real_key_start
= t
- 1;
9409 if (last_real_key_start
== 0)
9411 /* Key sequences beginning with mouse clicks are
9412 read using the keymaps in the buffer clicked on,
9413 not the current buffer. If we're at the
9414 beginning of a key sequence, switch buffers. */
9415 if (WINDOWP (window
)
9416 && BUFFERP (XWINDOW (window
)->buffer
)
9417 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9419 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9423 /* Arrange to go back to the original buffer once we're
9424 done reading the key sequence. Note that we can't
9425 use save_excursion_{save,restore} here, because they
9426 save point as well as the current buffer; we don't
9427 want to save point, because redisplay may change it,
9428 to accommodate a Fset_window_start or something. We
9429 don't want to do this at the top of the function,
9430 because we may get input from a subprocess which
9431 wants to change the selected window and stuff (say,
9433 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9435 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9437 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9438 orig_local_map
= get_local_map (PT
, current_buffer
,
9440 orig_keymap
= get_local_map (PT
, current_buffer
,
9442 goto replay_sequence
;
9445 /* For a mouse click, get the local text-property keymap
9446 of the place clicked on, rather than point. */
9447 if (CONSP (XCDR (key
))
9448 && ! localized_local_map
)
9450 Lisp_Object map_here
, start
, pos
;
9452 localized_local_map
= 1;
9453 start
= EVENT_START (key
);
9455 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9457 pos
= POSN_BUFFER_POSN (start
);
9459 && XINT (pos
) >= BEGV
9460 && XINT (pos
) <= ZV
)
9462 map_here
= get_local_map (XINT (pos
),
9465 if (!EQ (map_here
, orig_local_map
))
9467 orig_local_map
= map_here
;
9468 ++localized_local_map
;
9471 map_here
= get_local_map (XINT (pos
),
9474 if (!EQ (map_here
, orig_keymap
))
9476 orig_keymap
= map_here
;
9477 ++localized_local_map
;
9480 if (localized_local_map
> 1)
9485 goto replay_sequence
;
9492 /* Expand mode-line and scroll-bar events into two events:
9493 use posn as a fake prefix key. */
9495 && (NILP (fake_prefixed_keys
)
9496 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9498 if (t
+ 1 >= bufsize
)
9499 error ("Key sequence too long");
9502 keybuf
[t
+ 1] = key
;
9505 /* Record that a fake prefix key has been generated
9506 for KEY. Don't modify the event; this would
9507 prevent proper action when the event is pushed
9508 back into unread-command-events. */
9509 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9511 /* If on a mode line string with a local keymap,
9512 reconsider the key sequence with that keymap. */
9513 if (string
= POSN_STRING (EVENT_START (key
)),
9514 (CONSP (string
) && STRINGP (XCAR (string
))))
9516 Lisp_Object pos
, map
, map2
;
9518 pos
= XCDR (string
);
9519 string
= XCAR (string
);
9521 && XINT (pos
) < SCHARS (string
))
9523 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9525 orig_local_map
= map
;
9526 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9529 if (!NILP (map
) || !NILP (map2
))
9530 goto replay_sequence
;
9536 else if (NILP (from_string
)
9537 && (string
= POSN_STRING (EVENT_START (key
)),
9538 (CONSP (string
) && STRINGP (XCAR (string
)))))
9540 /* For a click on a string, i.e. overlay string or a
9541 string displayed via the `display' property,
9542 consider `local-map' and `keymap' properties of
9544 Lisp_Object pos
, map
, map2
;
9546 pos
= XCDR (string
);
9547 string
= XCAR (string
);
9549 && XINT (pos
) < SCHARS (string
))
9551 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9553 orig_local_map
= map
;
9554 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9558 if (!NILP (map
) || !NILP (map2
))
9560 from_string
= string
;
9563 goto replay_sequence
;
9568 else if (CONSP (XCDR (key
))
9569 && CONSP (EVENT_START (key
))
9570 && CONSP (XCDR (EVENT_START (key
))))
9574 posn
= POSN_POSN (EVENT_START (key
));
9575 /* Handle menu-bar events:
9576 insert the dummy prefix event `menu-bar'. */
9577 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9579 if (t
+ 1 >= bufsize
)
9580 error ("Key sequence too long");
9584 /* Zap the position in key, so we know that we've
9585 expanded it, and don't try to do so again. */
9586 POSN_SET_POSN (EVENT_START (key
),
9587 Fcons (posn
, Qnil
));
9590 goto replay_sequence
;
9592 else if (CONSP (posn
))
9594 /* We're looking at the second event of a
9595 sequence which we expanded before. Set
9596 last_real_key_start appropriately. */
9597 if (last_real_key_start
== t
&& t
> 0)
9598 last_real_key_start
= t
- 1;
9603 /* We have finally decided that KEY is something we might want
9605 first_binding
= (follow_key (key
,
9606 nmaps
- first_binding
,
9607 submaps
+ first_binding
,
9608 defs
+ first_binding
,
9609 submaps
+ first_binding
)
9612 /* If KEY wasn't bound, we'll try some fallbacks. */
9613 if (first_binding
< nmaps
)
9614 /* This is needed for the following scenario:
9615 event 0: a down-event that gets dropped by calling replay_key.
9616 event 1: some normal prefix like C-h.
9617 After event 0, first_unbound is 0, after event 1 indec.start,
9618 fkey.start, and keytran.start are all 1, so when we see that
9619 C-h is bound, we need to update first_unbound. */
9620 first_unbound
= max (t
+ 1, first_unbound
);
9625 /* Remember the position to put an upper bound on indec.start. */
9626 first_unbound
= min (t
, first_unbound
);
9628 head
= EVENT_HEAD (key
);
9629 if (help_char_p (head
) && t
> 0)
9631 read_key_sequence_cmd
= Vprefix_help_command
;
9633 last_nonmenu_event
= key
;
9634 /* The Microsoft C compiler can't handle the goto that
9642 Lisp_Object breakdown
;
9645 breakdown
= parse_modifiers (head
);
9646 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9647 /* Attempt to reduce an unbound mouse event to a simpler
9648 event that is bound:
9649 Drags reduce to clicks.
9650 Double-clicks reduce to clicks.
9651 Triple-clicks reduce to double-clicks, then to clicks.
9652 Down-clicks are eliminated.
9653 Double-downs reduce to downs, then are eliminated.
9654 Triple-downs reduce to double-downs, then to downs,
9655 then are eliminated. */
9656 if (modifiers
& (down_modifier
| drag_modifier
9657 | double_modifier
| triple_modifier
))
9659 while (modifiers
& (down_modifier
| drag_modifier
9660 | double_modifier
| triple_modifier
))
9662 Lisp_Object new_head
, new_click
;
9663 if (modifiers
& triple_modifier
)
9664 modifiers
^= (double_modifier
| triple_modifier
);
9665 else if (modifiers
& double_modifier
)
9666 modifiers
&= ~double_modifier
;
9667 else if (modifiers
& drag_modifier
)
9668 modifiers
&= ~drag_modifier
;
9671 /* Dispose of this `down' event by simply jumping
9672 back to replay_key, to get another event.
9674 Note that if this event came from mock input,
9675 then just jumping back to replay_key will just
9676 hand it to us again. So we have to wipe out any
9679 We could delete keybuf[t] and shift everything
9680 after that to the left by one spot, but we'd also
9681 have to fix up any variable that points into
9682 keybuf, and shifting isn't really necessary
9685 Adding prefixes for non-textual mouse clicks
9686 creates two characters of mock input, and both
9687 must be thrown away. If we're only looking at
9688 the prefix now, we can just jump back to
9689 replay_key. On the other hand, if we've already
9690 processed the prefix, and now the actual click
9691 itself is giving us trouble, then we've lost the
9692 state of the keymaps we want to backtrack to, and
9693 we need to replay the whole sequence to rebuild
9696 Beyond that, only function key expansion could
9697 create more than two keys, but that should never
9698 generate mouse events, so it's okay to zero
9699 mock_input in that case too.
9701 FIXME: The above paragraph seems just plain
9702 wrong, if you consider things like
9703 xterm-mouse-mode. -stef
9705 Isn't this just the most wonderful code ever? */
9707 /* If mock_input > t + 1, the above simplification
9708 will actually end up dropping keys on the floor.
9709 This is probably OK for now, but even
9710 if mock_input <= t + 1, we need to adjust indec,
9712 Typical case [header-line down-mouse-N]:
9713 mock_input = 2, t = 1, fkey.end = 1,
9714 last_real_key_start = 0. */
9715 if (indec
.end
> last_real_key_start
)
9717 indec
.end
= indec
.start
9718 = min (last_real_key_start
, indec
.start
);
9719 indec
.map
= indec
.parent
;
9720 if (fkey
.end
> last_real_key_start
)
9722 fkey
.end
= fkey
.start
9723 = min (last_real_key_start
, fkey
.start
);
9724 fkey
.map
= fkey
.parent
;
9725 if (keytran
.end
> last_real_key_start
)
9727 keytran
.end
= keytran
.start
9728 = min (last_real_key_start
, keytran
.start
);
9729 keytran
.map
= keytran
.parent
;
9733 if (t
== last_real_key_start
)
9740 mock_input
= last_real_key_start
;
9741 goto replay_sequence
;
9746 = apply_modifiers (modifiers
, XCAR (breakdown
));
9748 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9750 /* Look for a binding for this new key. follow_key
9751 promises that it didn't munge submaps the
9752 last time we called it, since key was unbound. */
9754 = (follow_key (new_click
,
9755 nmaps
- local_first_binding
,
9756 submaps
+ local_first_binding
,
9757 defs
+ local_first_binding
,
9758 submaps
+ local_first_binding
)
9759 + local_first_binding
);
9761 /* If that click is bound, go for it. */
9762 if (first_binding
< nmaps
)
9767 /* Otherwise, we'll leave key set to the drag event. */
9774 /* Normally, last_nonmenu_event gets the previous key we read.
9775 But when a mouse popup menu is being used,
9776 we don't update last_nonmenu_event; it continues to hold the mouse
9777 event that preceded the first level of menu. */
9778 if (!used_mouse_menu
)
9779 last_nonmenu_event
= key
;
9781 /* Record what part of this_command_keys is the current key sequence. */
9782 this_single_command_key_start
= this_command_key_count
- t
;
9784 /* Look for this sequence in input-decode-map.
9785 Scan from indec.end until we find a bound suffix. */
9786 while (indec
.end
< t
)
9788 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9791 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9792 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9797 mock_input
= diff
+ max (t
, mock_input
);
9798 goto replay_sequence
;
9802 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9803 && indec
.start
>= t
)
9804 /* There is a binding and it's not a prefix.
9805 (and it doesn't have any input-decode-map translation pending).
9806 There is thus no function-key in this sequence.
9807 Moving fkey.start is important in this case to allow keytran.start
9808 to go over the sequence before we return (since we keep the
9809 invariant that keytran.end <= fkey.start). */
9812 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9815 /* If the sequence is unbound, see if we can hang a function key
9816 off the end of it. */
9817 /* Continue scan from fkey.end until we find a bound suffix. */
9818 while (fkey
.end
< indec
.start
)
9820 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9823 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9824 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9825 max (t
, mock_input
),
9826 /* If there's a binding (i.e.
9827 first_binding >= nmaps) we don't want
9828 to apply this function-key-mapping. */
9829 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9834 mock_input
= diff
+ max (t
, mock_input
);
9835 /* Adjust the input-decode-map counters. */
9837 indec
.start
+= diff
;
9839 goto replay_sequence
;
9843 /* Look for this sequence in key-translation-map.
9844 Scan from keytran.end until we find a bound suffix. */
9845 while (keytran
.end
< fkey
.start
)
9847 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9850 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9851 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9856 mock_input
= diff
+ max (t
, mock_input
);
9857 /* Adjust the function-key-map and input-decode-map counters. */
9859 indec
.start
+= diff
;
9863 goto replay_sequence
;
9867 /* If KEY is not defined in any of the keymaps,
9868 and cannot be part of a function key or translation,
9869 and is an upper case letter
9870 use the corresponding lower-case letter instead. */
9871 if (first_binding
>= nmaps
9872 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9874 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9875 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9876 || (XINT (key
) & shift_modifier
)))
9878 Lisp_Object new_key
;
9880 original_uppercase
= key
;
9881 original_uppercase_position
= t
- 1;
9883 if (XINT (key
) & shift_modifier
)
9884 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9886 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9887 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9889 /* We have to do this unconditionally, regardless of whether
9890 the lower-case char is defined in the keymaps, because they
9891 might get translated through function-key-map. */
9892 keybuf
[t
- 1] = new_key
;
9893 mock_input
= max (t
, mock_input
);
9894 shift_translated
= 1;
9896 goto replay_sequence
;
9898 /* If KEY is not defined in any of the keymaps,
9899 and cannot be part of a function key or translation,
9900 and is a shifted function key,
9901 use the corresponding unshifted function key instead. */
9902 if (first_binding
>= nmaps
9903 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9905 Lisp_Object breakdown
= parse_modifiers (key
);
9907 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9909 if (modifiers
& shift_modifier
9910 /* Treat uppercase keys as shifted. */
9912 && (KEY_TO_CHAR (key
)
9913 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->size
)
9914 && uppercasep (KEY_TO_CHAR (key
))))
9917 = (modifiers
& shift_modifier
9918 ? apply_modifiers (modifiers
& ~shift_modifier
,
9920 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9922 original_uppercase
= key
;
9923 original_uppercase_position
= t
- 1;
9925 /* We have to do this unconditionally, regardless of whether
9926 the lower-case char is defined in the keymaps, because they
9927 might get translated through function-key-map. */
9928 keybuf
[t
- 1] = new_key
;
9929 mock_input
= max (t
, mock_input
);
9930 /* Reset fkey (and consequently keytran) to apply
9931 function-key-map on the result, so that S-backspace is
9932 correctly mapped to DEL (via backspace). OTOH,
9933 input-decode-map doesn't need to go through it again. */
9934 fkey
.start
= fkey
.end
= 0;
9935 keytran
.start
= keytran
.end
= 0;
9936 shift_translated
= 1;
9938 goto replay_sequence
;
9943 read_key_sequence_cmd
= (first_binding
< nmaps
9944 ? defs
[first_binding
]
9947 unread_switch_frame
= delayed_switch_frame
;
9948 unbind_to (count
, Qnil
);
9950 /* Don't downcase the last character if the caller says don't.
9951 Don't downcase it if the result is undefined, either. */
9952 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9954 && t
- 1 == original_uppercase_position
)
9956 keybuf
[t
- 1] = original_uppercase
;
9957 shift_translated
= 0;
9960 if (shift_translated
)
9961 Vthis_command_keys_shift_translated
= Qt
;
9963 /* Occasionally we fabricate events, perhaps by expanding something
9964 according to function-key-map, or by adding a prefix symbol to a
9965 mouse click in the scroll bar or modeline. In this cases, return
9966 the entire generated key sequence, even if we hit an unbound
9967 prefix or a definition before the end. This means that you will
9968 be able to push back the event properly, and also means that
9969 read-key-sequence will always return a logical unit.
9972 for (; t
< mock_input
; t
++)
9974 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9975 && NILP (Fzerop (Vecho_keystrokes
)))
9976 echo_char (keybuf
[t
]);
9977 add_command_key (keybuf
[t
]);
9980 UNGCPRO_VAR (outer_gcpro
);
9984 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9985 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9986 The sequence is sufficient to specify a non-prefix command in the
9987 current local and global maps.
9989 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9990 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9991 as a continuation of the previous key.
9993 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9994 convert the last event to lower case. (Normally any upper case event
9995 is converted to lower case if the original event is undefined and the lower
9996 case equivalent is defined.) A non-nil value is appropriate for reading
9997 a key sequence to be defined.
9999 A C-g typed while in this function is treated like any other character,
10000 and `quit-flag' is not set.
10002 If the key sequence starts with a mouse click, then the sequence is read
10003 using the keymaps of the buffer of the window clicked in, not the buffer
10004 of the selected window as normal.
10006 `read-key-sequence' drops unbound button-down events, since you normally
10007 only care about the click or drag events which follow them. If a drag
10008 or multi-click event is unbound, but the corresponding click event would
10009 be bound, `read-key-sequence' turns the event into a click event at the
10010 drag's starting position. This means that you don't have to distinguish
10011 between click and drag, double, or triple events unless you want to.
10013 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10014 lines separating windows, and scroll bars with imaginary keys
10015 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10017 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10018 function will process a switch-frame event if the user switches frames
10019 before typing anything. If the user switches frames in the middle of a
10020 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10021 is nil, then the event will be put off until after the current key sequence.
10023 `read-key-sequence' checks `function-key-map' for function key
10024 sequences, where they wouldn't conflict with ordinary bindings. See
10025 `function-key-map' for more details.
10027 The optional fifth argument CMD-LOOP, if non-nil, means
10028 that this key sequence is being read by something that will
10029 read commands one after another. It should be nil if the caller
10030 will read just one key sequence. */)
10031 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10033 Lisp_Object keybuf
[30];
10035 struct gcpro gcpro1
;
10036 int count
= SPECPDL_INDEX ();
10038 if (!NILP (prompt
))
10039 CHECK_STRING (prompt
);
10042 specbind (Qinput_method_exit_on_first_char
,
10043 (NILP (cmd_loop
) ? Qt
: Qnil
));
10044 specbind (Qinput_method_use_echo_area
,
10045 (NILP (cmd_loop
) ? Qt
: Qnil
));
10047 memset (keybuf
, 0, sizeof keybuf
);
10048 GCPRO1 (keybuf
[0]);
10049 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10051 if (NILP (continue_echo
))
10053 this_command_key_count
= 0;
10054 this_command_key_count_reset
= 0;
10055 this_single_command_key_start
= 0;
10058 #ifdef HAVE_WINDOW_SYSTEM
10059 if (display_hourglass_p
)
10060 cancel_hourglass ();
10063 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10064 prompt
, ! NILP (dont_downcase_last
),
10065 ! NILP (can_return_switch_frame
), 0);
10067 #if 0 /* The following is fine for code reading a key sequence and
10068 then proceeding with a lenghty computation, but it's not good
10069 for code reading keys in a loop, like an input method. */
10070 #ifdef HAVE_WINDOW_SYSTEM
10071 if (display_hourglass_p
)
10072 start_hourglass ();
10082 return unbind_to (count
, make_event_array (i
, keybuf
));
10085 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10086 Sread_key_sequence_vector
, 1, 5, 0,
10087 doc
: /* Like `read-key-sequence' but always return a vector. */)
10088 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10090 Lisp_Object keybuf
[30];
10092 struct gcpro gcpro1
;
10093 int count
= SPECPDL_INDEX ();
10095 if (!NILP (prompt
))
10096 CHECK_STRING (prompt
);
10099 specbind (Qinput_method_exit_on_first_char
,
10100 (NILP (cmd_loop
) ? Qt
: Qnil
));
10101 specbind (Qinput_method_use_echo_area
,
10102 (NILP (cmd_loop
) ? Qt
: Qnil
));
10104 memset (keybuf
, 0, sizeof keybuf
);
10105 GCPRO1 (keybuf
[0]);
10106 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10108 if (NILP (continue_echo
))
10110 this_command_key_count
= 0;
10111 this_command_key_count_reset
= 0;
10112 this_single_command_key_start
= 0;
10115 #ifdef HAVE_WINDOW_SYSTEM
10116 if (display_hourglass_p
)
10117 cancel_hourglass ();
10120 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10121 prompt
, ! NILP (dont_downcase_last
),
10122 ! NILP (can_return_switch_frame
), 0);
10124 #ifdef HAVE_WINDOW_SYSTEM
10125 if (display_hourglass_p
)
10126 start_hourglass ();
10135 return unbind_to (count
, Fvector (i
, keybuf
));
10138 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10139 doc
: /* Execute CMD as an editor command.
10140 CMD must be a symbol that satisfies the `commandp' predicate.
10141 Optional second arg RECORD-FLAG non-nil
10142 means unconditionally put this command in `command-history'.
10143 Otherwise, that is done only if an arg is read using the minibuffer.
10144 The argument KEYS specifies the value to use instead of (this-command-keys)
10145 when reading the arguments; if it is nil, (this-command-keys) is used.
10146 The argument SPECIAL, if non-nil, means that this command is executing
10147 a special event, so ignore the prefix argument and don't clear it. */)
10148 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10150 register Lisp_Object final
;
10151 register Lisp_Object tem
;
10152 Lisp_Object prefixarg
;
10154 debug_on_next_call
= 0;
10156 if (NILP (special
))
10158 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10159 Vcurrent_prefix_arg
= prefixarg
;
10160 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10167 tem
= Fget (cmd
, Qdisabled
);
10170 tem
= Fsymbol_value (Qdisabled_command_function
);
10172 return Frun_hooks (1, &Qdisabled_command_function
);
10178 final
= Findirect_function (cmd
, Qnil
);
10180 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10182 struct gcpro gcpro1
, gcpro2
;
10184 GCPRO2 (cmd
, prefixarg
);
10185 do_autoload (final
, cmd
);
10192 if (STRINGP (final
) || VECTORP (final
))
10194 /* If requested, place the macro in the command history. For
10195 other sorts of commands, call-interactively takes care of
10197 if (!NILP (record_flag
))
10200 = Fcons (Fcons (Qexecute_kbd_macro
,
10201 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10204 /* Don't keep command history around forever. */
10205 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10207 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10209 XSETCDR (tem
, Qnil
);
10213 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10216 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10217 /* Don't call Fcall_interactively directly because we want to make
10218 sure the backtrace has an entry for `call-interactively'.
10219 For the same reason, pass `cmd' rather than `final'. */
10220 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10227 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10229 doc
: /* Read function name, then read its arguments and call it.
10231 To pass a numeric argument to the command you are invoking with, specify
10232 the numeric argument to this command.
10234 Noninteractively, the argument PREFIXARG is the prefix argument to
10235 give to the command you invoke, if it asks for an argument. */)
10236 (Lisp_Object prefixarg
)
10238 Lisp_Object function
;
10239 EMACS_INT saved_last_point_position
;
10240 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10241 Lisp_Object bindings
, value
;
10242 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10243 #ifdef HAVE_WINDOW_SYSTEM
10244 /* The call to Fcompleting_read will start and cancel the hourglass,
10245 but if the hourglass was already scheduled, this means that no
10246 hourglass will be shown for the actual M-x command itself.
10247 So we restart it if it is already scheduled. Note that checking
10248 hourglass_shown_p is not enough, normally the hourglass is not shown,
10249 just scheduled to be shown. */
10250 int hstarted
= hourglass_started ();
10253 saved_keys
= Fvector (this_command_key_count
,
10254 XVECTOR (this_command_keys
)->contents
);
10255 saved_last_point_position_buffer
= last_point_position_buffer
;
10256 saved_last_point_position
= last_point_position
;
10257 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10259 function
= call0 (intern ("read-extended-command"));
10261 #ifdef HAVE_WINDOW_SYSTEM
10262 if (hstarted
) start_hourglass ();
10265 if (STRINGP (function
) && SCHARS (function
) == 0)
10266 error ("No command name given");
10268 /* Set this_command_keys to the concatenation of saved_keys and
10269 function, followed by a RET. */
10274 this_command_key_count
= 0;
10275 this_command_key_count_reset
= 0;
10276 this_single_command_key_start
= 0;
10278 keys
= XVECTOR (saved_keys
)->contents
;
10279 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10280 add_command_key (keys
[i
]);
10282 for (i
= 0; i
< SCHARS (function
); i
++)
10283 add_command_key (Faref (function
, make_number (i
)));
10285 add_command_key (make_number ('\015'));
10288 last_point_position
= saved_last_point_position
;
10289 last_point_position_buffer
= saved_last_point_position_buffer
;
10293 function
= Fintern (function
, Qnil
);
10294 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10295 Vthis_command
= function
;
10296 real_this_command
= function
;
10298 /* If enabled, show which key runs this command. */
10299 if (!NILP (Vsuggest_key_bindings
)
10300 && NILP (Vexecuting_kbd_macro
)
10301 && SYMBOLP (function
))
10302 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10308 GCPRO3 (bindings
, value
, function
);
10309 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10311 /* If the command has a key binding, print it now. */
10312 if (!NILP (bindings
)
10313 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10316 /* But first wait, and skip the message if there is input. */
10317 Lisp_Object waited
;
10319 /* If this command displayed something in the echo area;
10320 wait a few seconds, then display our suggestion message. */
10321 if (NILP (echo_area_buffer
[0]))
10322 waited
= sit_for (make_number (0), 0, 2);
10323 else if (NUMBERP (Vsuggest_key_bindings
))
10324 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10326 waited
= sit_for (make_number (2), 0, 2);
10328 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10330 Lisp_Object binding
;
10332 int message_p
= push_message ();
10333 int count
= SPECPDL_INDEX ();
10335 record_unwind_protect (pop_message_unwind
, Qnil
);
10336 binding
= Fkey_description (bindings
, Qnil
);
10339 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10342 sprintf (newmessage
, "You can run the command `%s' with %s",
10343 SDATA (SYMBOL_NAME (function
)),
10345 message2 (newmessage
,
10346 strlen (newmessage
),
10347 STRING_MULTIBYTE (binding
));
10348 if (NUMBERP (Vsuggest_key_bindings
))
10349 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10351 waited
= sit_for (make_number (2), 0, 2);
10353 if (!NILP (waited
) && message_p
)
10354 restore_message ();
10356 unbind_to (count
, Qnil
);
10360 RETURN_UNGCPRO (value
);
10364 /* Return nonzero if input events are pending. */
10367 detect_input_pending (void)
10369 if (!input_pending
)
10370 get_input_pending (&input_pending
, 0);
10372 return input_pending
;
10375 /* Return nonzero if input events other than mouse movements are
10379 detect_input_pending_ignore_squeezables (void)
10381 if (!input_pending
)
10382 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10384 return input_pending
;
10387 /* Return nonzero if input events are pending, and run any pending timers. */
10390 detect_input_pending_run_timers (int do_display
)
10392 int old_timers_run
= timers_run
;
10394 if (!input_pending
)
10395 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10397 if (old_timers_run
!= timers_run
&& do_display
)
10399 redisplay_preserve_echo_area (8);
10400 /* The following fixes a bug when using lazy-lock with
10401 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10402 from an idle timer function. The symptom of the bug is that
10403 the cursor sometimes doesn't become visible until the next X
10404 event is processed. --gerd. */
10406 Lisp_Object tail
, frame
;
10407 FOR_EACH_FRAME (tail
, frame
)
10408 if (FRAME_RIF (XFRAME (frame
)))
10409 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10413 return input_pending
;
10416 /* This is called in some cases before a possible quit.
10417 It cases the next call to detect_input_pending to recompute input_pending.
10418 So calling this function unnecessarily can't do any harm. */
10421 clear_input_pending (void)
10426 /* Return nonzero if there are pending requeued events.
10427 This isn't used yet. The hope is to make wait_reading_process_output
10428 call it, and return if it runs Lisp code that unreads something.
10429 The problem is, kbd_buffer_get_event needs to be fixed to know what
10430 to do in that case. It isn't trivial. */
10433 requeued_events_pending_p (void)
10435 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10439 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10440 doc
: /* Return t if command input is currently available with no wait.
10441 Actually, the value is nil only if we can be sure that no input is available;
10442 if there is a doubt, the value is t. */)
10445 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10446 || !NILP (Vunread_post_input_method_events
)
10447 || !NILP (Vunread_input_method_events
))
10450 get_input_pending (&input_pending
,
10451 READABLE_EVENTS_DO_TIMERS_NOW
10452 | READABLE_EVENTS_FILTER_EVENTS
);
10453 return input_pending
> 0 ? Qt
: Qnil
;
10456 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10457 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10460 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10463 if (total_keys
< NUM_RECENT_KEYS
)
10464 return Fvector (total_keys
, keys
);
10467 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10468 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10469 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10470 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10471 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10476 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10477 doc
: /* Return the key sequence that invoked this command.
10478 However, if the command has called `read-key-sequence', it returns
10479 the last key sequence that has been read.
10480 The value is a string or a vector.
10482 See also `this-command-keys-vector'. */)
10485 return make_event_array (this_command_key_count
,
10486 XVECTOR (this_command_keys
)->contents
);
10489 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10490 doc
: /* Return the key sequence that invoked this command, as a vector.
10491 However, if the command has called `read-key-sequence', it returns
10492 the last key sequence that has been read.
10494 See also `this-command-keys'. */)
10497 return Fvector (this_command_key_count
,
10498 XVECTOR (this_command_keys
)->contents
);
10501 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10502 Sthis_single_command_keys
, 0, 0, 0,
10503 doc
: /* Return the key sequence that invoked this command.
10504 More generally, it returns the last key sequence read, either by
10505 the command loop or by `read-key-sequence'.
10506 Unlike `this-command-keys', this function's value
10507 does not include prefix arguments.
10508 The value is always a vector. */)
10511 return Fvector (this_command_key_count
10512 - this_single_command_key_start
,
10513 (XVECTOR (this_command_keys
)->contents
10514 + this_single_command_key_start
));
10517 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10518 Sthis_single_command_raw_keys
, 0, 0, 0,
10519 doc
: /* Return the raw events that were read for this command.
10520 More generally, it returns the last key sequence read, either by
10521 the command loop or by `read-key-sequence'.
10522 Unlike `this-single-command-keys', this function's value
10523 shows the events before all translations (except for input methods).
10524 The value is always a vector. */)
10527 return Fvector (raw_keybuf_count
,
10528 (XVECTOR (raw_keybuf
)->contents
));
10531 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10532 Sreset_this_command_lengths
, 0, 0, 0,
10533 doc
: /* Make the unread events replace the last command and echo.
10534 Used in `universal-argument-other-key'.
10536 `universal-argument-other-key' rereads the event just typed.
10537 It then gets translated through `function-key-map'.
10538 The translated event has to replace the real events,
10539 both in the value of (this-command-keys) and in echoing.
10540 To achieve this, `universal-argument-other-key' calls
10541 `reset-this-command-lengths', which discards the record of reading
10542 these events the first time. */)
10545 this_command_key_count
= before_command_key_count
;
10546 if (this_command_key_count
< this_single_command_key_start
)
10547 this_single_command_key_start
= this_command_key_count
;
10549 echo_truncate (before_command_echo_length
);
10551 /* Cause whatever we put into unread-command-events
10552 to echo as if it were being freshly read from the keyboard. */
10553 this_command_key_count_reset
= 1;
10558 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10559 Sclear_this_command_keys
, 0, 1, 0,
10560 doc
: /* Clear out the vector that `this-command-keys' returns.
10561 Also clear the record of the last 100 events, unless optional arg
10562 KEEP-RECORD is non-nil. */)
10563 (Lisp_Object keep_record
)
10567 this_command_key_count
= 0;
10568 this_command_key_count_reset
= 0;
10570 if (NILP (keep_record
))
10572 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10573 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10575 recent_keys_index
= 0;
10580 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10581 doc
: /* Return the current depth in recursive edits. */)
10585 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10589 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10590 "FOpen dribble file: ",
10591 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10592 If FILE is nil, close any open dribble file. */)
10604 file
= Fexpand_file_name (file
, Qnil
);
10605 dribble
= fopen (SSDATA (file
), "w");
10607 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10612 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10613 doc
: /* Discard the contents of the terminal input buffer.
10614 Also end any kbd macro being defined. */)
10617 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10619 /* Discard the last command from the macro. */
10620 Fcancel_kbd_macro_events ();
10624 update_mode_lines
++;
10626 Vunread_command_events
= Qnil
;
10627 unread_command_char
= -1;
10629 discard_tty_input ();
10631 kbd_fetch_ptr
= kbd_store_ptr
;
10637 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10638 doc
: /* Stop Emacs and return to superior process. You can resume later.
10639 If `cannot-suspend' is non-nil, or if the system doesn't support job
10640 control, run a subshell instead.
10642 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10643 to be read as terminal input by Emacs's parent, after suspension.
10645 Before suspending, run the normal hook `suspend-hook'.
10646 After resumption run the normal hook `suspend-resume-hook'.
10648 Some operating systems cannot stop the Emacs process and resume it later.
10649 On such systems, Emacs starts a subshell instead of suspending. */)
10650 (Lisp_Object stuffstring
)
10652 int count
= SPECPDL_INDEX ();
10653 int old_height
, old_width
;
10655 struct gcpro gcpro1
;
10658 if (tty_list
&& tty_list
->next
)
10659 error ("There are other tty frames open; close them before suspending Emacs");
10661 if (!NILP (stuffstring
))
10662 CHECK_STRING (stuffstring
);
10664 /* Run the functions in suspend-hook. */
10665 hook
= intern ("suspend-hook");
10666 Frun_hooks (1, &hook
);
10668 GCPRO1 (stuffstring
);
10669 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10670 reset_all_sys_modes ();
10671 /* sys_suspend can get an error if it tries to fork a subshell
10672 and the system resources aren't available for that. */
10673 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10675 stuff_buffered_input (stuffstring
);
10676 if (cannot_suspend
)
10680 unbind_to (count
, Qnil
);
10682 /* Check if terminal/window size has changed.
10683 Note that this is not useful when we are running directly
10684 with a window system; but suspend should be disabled in that case. */
10685 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10686 if (width
!= old_width
|| height
!= old_height
)
10687 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10689 /* Run suspend-resume-hook. */
10690 hook
= intern ("suspend-resume-hook");
10691 Frun_hooks (1, &hook
);
10697 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10698 Then in any case stuff anything Emacs has read ahead and not used. */
10701 stuff_buffered_input (Lisp_Object stuffstring
)
10703 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10704 register unsigned char *p
;
10706 if (STRINGP (stuffstring
))
10708 register EMACS_INT count
;
10710 p
= SDATA (stuffstring
);
10711 count
= SBYTES (stuffstring
);
10712 while (count
-- > 0)
10717 /* Anything we have read ahead, put back for the shell to read. */
10718 /* ?? What should this do when we have multiple keyboards??
10719 Should we ignore anything that was typed in at the "wrong" kboard?
10721 rms: we should stuff everything back into the kboard
10723 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10726 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10727 kbd_fetch_ptr
= kbd_buffer
;
10728 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10729 stuff_char (kbd_fetch_ptr
->code
);
10731 clear_event (kbd_fetch_ptr
);
10735 #endif /* SIGTSTP */
10739 set_waiting_for_input (struct timeval
*time_to_clear
)
10741 input_available_clear_time
= time_to_clear
;
10743 /* Tell handle_interrupt to throw back to read_char, */
10744 waiting_for_input
= 1;
10746 /* If handle_interrupt was called before and buffered a C-g,
10747 make it run again now, to avoid timing error. */
10748 if (!NILP (Vquit_flag
))
10749 quit_throw_to_read_char ();
10753 clear_waiting_for_input (void)
10755 /* Tell handle_interrupt not to throw back to read_char, */
10756 waiting_for_input
= 0;
10757 input_available_clear_time
= 0;
10760 /* The SIGINT handler.
10762 If we have a frame on the controlling tty, we assume that the
10763 SIGINT was generated by C-g, so we call handle_interrupt.
10764 Otherwise, the handler kills Emacs. */
10767 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10768 /* compilers complain in signal calls. */
10770 /* Must preserve main program's value of errno. */
10771 int old_errno
= errno
;
10772 struct terminal
*terminal
;
10774 SIGNAL_THREAD_CHECK (signalnum
);
10776 /* See if we have an active terminal on our controlling tty. */
10777 terminal
= get_named_tty ("/dev/tty");
10780 /* If there are no frames there, let's pretend that we are a
10781 well-behaving UN*X program and quit. */
10782 Fkill_emacs (Qnil
);
10786 /* Otherwise, the SIGINT was probably generated by C-g. */
10788 /* Set internal_last_event_frame to the top frame of the
10789 controlling tty, if we have a frame there. We disable the
10790 interrupt key on secondary ttys, so the SIGINT must have come
10791 from the controlling tty. */
10792 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10794 handle_interrupt ();
10800 /* This routine is called at interrupt level in response to C-g.
10802 It is called from the SIGINT handler or kbd_buffer_store_event.
10804 If `waiting_for_input' is non zero, then unless `echoing' is
10805 nonzero, immediately throw back to read_char.
10807 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10808 eval to throw, when it gets a chance. If quit-flag is already
10809 non-nil, it stops the job right away. */
10812 handle_interrupt (void)
10818 /* XXX This code needs to be revised for multi-tty support. */
10819 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10821 /* If SIGINT isn't blocked, don't let us be interrupted by
10822 another SIGINT, it might be harmful due to non-reentrancy
10823 in I/O functions. */
10824 sigblock (sigmask (SIGINT
));
10827 reset_all_sys_modes ();
10829 #ifdef SIGTSTP /* Support possible in later USG versions */
10831 * On systems which can suspend the current process and return to the original
10832 * shell, this command causes the user to end up back at the shell.
10833 * The "Auto-save" and "Abort" questions are not asked until
10834 * the user elects to return to emacs, at which point he can save the current
10835 * job and either dump core or continue.
10839 /* Perhaps should really fork an inferior shell?
10840 But that would not provide any way to get back
10841 to the original shell, ever. */
10842 printf ("No support for stopping a process on this operating system;\n");
10843 printf ("you can continue or abort.\n");
10844 #endif /* not SIGTSTP */
10846 /* We must remain inside the screen area when the internal terminal
10847 is used. Note that [Enter] is not echoed by dos. */
10848 cursor_to (SELECTED_FRAME (), 0, 0);
10850 /* It doesn't work to autosave while GC is in progress;
10851 the code used for auto-saving doesn't cope with the mark bit. */
10852 if (!gc_in_progress
)
10854 printf ("Auto-save? (y or n) ");
10856 if (((c
= getchar ()) & ~040) == 'Y')
10858 Fdo_auto_save (Qt
, Qnil
);
10860 printf ("\r\nAuto-save done");
10861 #else /* not MSDOS */
10862 printf ("Auto-save done\n");
10863 #endif /* not MSDOS */
10865 while (c
!= '\n') c
= getchar ();
10869 /* During GC, it must be safe to reenable quitting again. */
10870 Vinhibit_quit
= Qnil
;
10873 #endif /* not MSDOS */
10874 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10875 printf ("but will instead do a real quit after garbage collection ends\r\n");
10880 printf ("\r\nAbort? (y or n) ");
10881 #else /* not MSDOS */
10882 printf ("Abort (and dump core)? (y or n) ");
10883 #endif /* not MSDOS */
10885 if (((c
= getchar ()) & ~040) == 'Y')
10887 while (c
!= '\n') c
= getchar ();
10889 printf ("\r\nContinuing...\r\n");
10890 #else /* not MSDOS */
10891 printf ("Continuing...\n");
10892 #endif /* not MSDOS */
10894 init_all_sys_modes ();
10899 /* If executing a function that wants to be interrupted out of
10900 and the user has not deferred quitting by binding `inhibit-quit'
10901 then quit right away. */
10902 if (immediate_quit
&& NILP (Vinhibit_quit
))
10904 struct gl_state_s saved
;
10905 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10907 immediate_quit
= 0;
10910 GCPRO4 (saved
.object
, saved
.global_code
,
10911 saved
.current_syntax_table
, saved
.old_prop
);
10912 Fsignal (Qquit
, Qnil
);
10913 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10918 /* Else request quit when it's safe */
10922 /* TODO: The longjmp in this call throws the NS event loop integration off,
10923 and it seems to do fine without this. Probably some attention
10924 needs to be paid to the setting of waiting_for_input in
10925 wait_reading_process_output() under HAVE_NS because of the call
10926 to ns_select there (needed because otherwise events aren't picked up
10927 outside of polling since we don't get SIGIO like X and we don't have a
10928 separate event loop thread like W32. */
10930 if (waiting_for_input
&& !echoing
)
10931 quit_throw_to_read_char ();
10935 /* Handle a C-g by making read_char return C-g. */
10938 quit_throw_to_read_char (void)
10941 /* Prevent another signal from doing this before we finish. */
10942 clear_waiting_for_input ();
10945 Vunread_command_events
= Qnil
;
10946 unread_command_char
= -1;
10948 #if 0 /* Currently, sit_for is called from read_char without turning
10949 off polling. And that can call set_waiting_for_input.
10950 It seems to be harmless. */
10951 #ifdef POLL_FOR_INPUT
10952 /* May be > 1 if in recursive minibuffer. */
10953 if (poll_suppress_count
== 0)
10957 if (FRAMEP (internal_last_event_frame
)
10958 && !EQ (internal_last_event_frame
, selected_frame
))
10959 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10962 _longjmp (getcjmp
, 1);
10965 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
10966 doc
: /* Set interrupt mode of reading keyboard input.
10967 If INTERRUPT is non-nil, Emacs will use input interrupts;
10968 otherwise Emacs uses CBREAK mode.
10970 See also `current-input-mode'. */)
10971 (Lisp_Object interrupt
)
10973 int new_interrupt_input
;
10975 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10976 #ifdef HAVE_X_WINDOWS
10977 if (x_display_list
!= NULL
)
10979 /* When using X, don't give the user a real choice,
10980 because we haven't implemented the mechanisms to support it. */
10981 new_interrupt_input
= 1;
10984 #endif /* HAVE_X_WINDOWS */
10985 new_interrupt_input
= !NILP (interrupt
);
10986 #else /* not SIGIO */
10987 new_interrupt_input
= 0;
10988 #endif /* not SIGIO */
10990 if (new_interrupt_input
!= interrupt_input
)
10992 #ifdef POLL_FOR_INPUT
10996 /* this causes startup screen to be restored and messes with the mouse */
10997 reset_all_sys_modes ();
10998 interrupt_input
= new_interrupt_input
;
10999 init_all_sys_modes ();
11001 interrupt_input
= new_interrupt_input
;
11004 #ifdef POLL_FOR_INPUT
11005 poll_suppress_count
= 1;
11012 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11013 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11014 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11015 C-q in key sequences.
11017 This setting only has an effect on tty terminals and only when
11018 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11020 See also `current-input-mode'. */)
11021 (Lisp_Object flow
, Lisp_Object terminal
)
11023 struct terminal
*t
= get_terminal (terminal
, 1);
11024 struct tty_display_info
*tty
;
11025 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11027 tty
= t
->display_info
.tty
;
11029 if (tty
->flow_control
!= !NILP (flow
))
11032 /* this causes startup screen to be restored and messes with the mouse */
11033 reset_sys_modes (tty
);
11036 tty
->flow_control
= !NILP (flow
);
11039 init_sys_modes (tty
);
11045 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11046 doc
: /* Enable or disable 8-bit input on TERMINAL.
11047 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11048 bit as the Meta modifier.
11050 If META is nil, Emacs will ignore the top bit, on the assumption it is
11053 Otherwise, Emacs will accept and pass through 8-bit input without
11054 specially interpreting the top bit.
11056 This setting only has an effect on tty terminal devices.
11058 Optional parameter TERMINAL specifies the tty terminal device to use.
11059 It may be a terminal object, a frame, or nil for the terminal used by
11060 the currently selected frame.
11062 See also `current-input-mode'. */)
11063 (Lisp_Object meta
, Lisp_Object terminal
)
11065 struct terminal
*t
= get_terminal (terminal
, 1);
11066 struct tty_display_info
*tty
;
11069 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11071 tty
= t
->display_info
.tty
;
11075 else if (EQ (meta
, Qt
))
11080 if (tty
->meta_key
!= new_meta
)
11083 /* this causes startup screen to be restored and messes with the mouse */
11084 reset_sys_modes (tty
);
11087 tty
->meta_key
= new_meta
;
11090 init_sys_modes (tty
);
11096 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11097 doc
: /* Specify character used for quitting.
11098 QUIT must be an ASCII character.
11100 This function only has an effect on the controlling tty of the Emacs
11103 See also `current-input-mode'. */)
11106 struct terminal
*t
= get_named_tty ("/dev/tty");
11107 struct tty_display_info
*tty
;
11108 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11110 tty
= t
->display_info
.tty
;
11112 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11113 error ("QUIT must be an ASCII character");
11116 /* this causes startup screen to be restored and messes with the mouse */
11117 reset_sys_modes (tty
);
11120 /* Don't let this value be out of range. */
11121 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11124 init_sys_modes (tty
);
11130 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11131 doc
: /* Set mode of reading keyboard input.
11132 First arg INTERRUPT non-nil means use input interrupts;
11133 nil means use CBREAK mode.
11134 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11135 (no effect except in CBREAK mode).
11136 Third arg META t means accept 8-bit input (for a Meta key).
11137 META nil means ignore the top bit, on the assumption it is parity.
11138 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11139 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11140 See also `current-input-mode'. */)
11141 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11143 Fset_input_interrupt_mode (interrupt
);
11144 Fset_output_flow_control (flow
, Qnil
);
11145 Fset_input_meta_mode (meta
, Qnil
);
11147 Fset_quit_char (quit
);
11151 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11152 doc
: /* Return information about the way Emacs currently reads keyboard input.
11153 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11154 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11155 nil, Emacs is using CBREAK mode.
11156 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11157 terminal; this does not apply if Emacs uses interrupt-driven input.
11158 META is t if accepting 8-bit input with 8th bit as Meta flag.
11159 META nil means ignoring the top bit, on the assumption it is parity.
11160 META is neither t nor nil if accepting 8-bit input and using
11161 all 8 bits as the character code.
11162 QUIT is the character Emacs currently uses to quit.
11163 The elements of this list correspond to the arguments of
11164 `set-input-mode'. */)
11167 Lisp_Object val
[4];
11168 struct frame
*sf
= XFRAME (selected_frame
);
11170 val
[0] = interrupt_input
? Qt
: Qnil
;
11171 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11173 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11174 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11176 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11183 XSETFASTINT (val
[3], quit_char
);
11185 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11188 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11189 doc
: /* Return position information for pixel coordinates X and Y.
11190 By default, X and Y are relative to text area of the selected window.
11191 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11192 If optional fourth arg WHOLE is non-nil, X is relative to the left
11193 edge of the window.
11195 The return value is similar to a mouse click position:
11196 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11197 IMAGE (DX . DY) (WIDTH . HEIGHT))
11198 The `posn-' functions access elements of such lists. */)
11199 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11204 if (NILP (frame_or_window
))
11205 frame_or_window
= selected_window
;
11207 if (WINDOWP (frame_or_window
))
11211 CHECK_LIVE_WINDOW (frame_or_window
);
11213 w
= XWINDOW (frame_or_window
);
11214 XSETINT (x
, (XINT (x
)
11215 + WINDOW_LEFT_EDGE_X (w
)
11217 ? window_box_left_offset (w
, TEXT_AREA
)
11219 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11220 frame_or_window
= w
->frame
;
11223 CHECK_LIVE_FRAME (frame_or_window
);
11225 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11228 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11229 doc
: /* Return position information for buffer POS in WINDOW.
11230 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11232 Return nil if position is not visible in window. Otherwise,
11233 the return value is similar to that returned by `event-start' for
11234 a mouse click at the upper left corner of the glyph corresponding
11235 to the given buffer position:
11236 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11237 IMAGE (DX . DY) (WIDTH . HEIGHT))
11238 The `posn-' functions access elements of such lists. */)
11239 (Lisp_Object pos
, Lisp_Object window
)
11244 window
= selected_window
;
11246 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11249 Lisp_Object x
= XCAR (tem
);
11250 Lisp_Object y
= XCAR (XCDR (tem
));
11252 /* Point invisible due to hscrolling? */
11255 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11263 * Set up a new kboard object with reasonable initial values.
11266 init_kboard (KBOARD
*kb
)
11268 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11269 KVAR (kb
, Vlast_command
) = Qnil
;
11270 KVAR (kb
, Vreal_last_command
) = Qnil
;
11271 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11272 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11273 KVAR (kb
, Vprefix_arg
) = Qnil
;
11274 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11275 KVAR (kb
, kbd_queue
) = Qnil
;
11276 kb
->kbd_queue_has_data
= 0;
11277 kb
->immediate_echo
= 0;
11278 KVAR (kb
, echo_string
) = Qnil
;
11279 kb
->echo_after_prompt
= -1;
11280 kb
->kbd_macro_buffer
= 0;
11281 kb
->kbd_macro_bufsize
= 0;
11282 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11283 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11284 kb
->reference_count
= 0;
11285 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11286 KVAR (kb
, system_key_syms
) = Qnil
;
11287 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11288 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11289 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11290 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11291 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11295 * Destroy the contents of a kboard object, but not the object itself.
11296 * We use this just before deleting it, or if we're going to initialize
11297 * it a second time.
11300 wipe_kboard (KBOARD
*kb
)
11302 xfree (kb
->kbd_macro_buffer
);
11305 /* Free KB and memory referenced from it. */
11308 delete_kboard (KBOARD
*kb
)
11312 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11315 *kbp
= kb
->next_kboard
;
11317 /* Prevent a dangling reference to KB. */
11318 if (kb
== current_kboard
11319 && FRAMEP (selected_frame
)
11320 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11322 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11324 if (current_kboard
== kb
)
11333 init_keyboard (void)
11335 /* This is correct before outermost invocation of the editor loop */
11336 command_loop_level
= -1;
11337 immediate_quit
= 0;
11338 quit_char
= Ctl ('g');
11339 Vunread_command_events
= Qnil
;
11340 unread_command_char
= -1;
11341 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11343 recent_keys_index
= 0;
11344 kbd_fetch_ptr
= kbd_buffer
;
11345 kbd_store_ptr
= kbd_buffer
;
11346 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11347 do_mouse_tracking
= Qnil
;
11350 interrupt_input_blocked
= 0;
11351 interrupt_input_pending
= 0;
11353 pending_signals
= 0;
11356 /* This means that command_loop_1 won't try to select anything the first
11358 internal_last_event_frame
= Qnil
;
11359 Vlast_event_frame
= internal_last_event_frame
;
11361 current_kboard
= initial_kboard
;
11362 /* Re-initialize the keyboard again. */
11363 wipe_kboard (current_kboard
);
11364 init_kboard (current_kboard
);
11365 /* A value of nil for Vwindow_system normally means a tty, but we also use
11366 it for the initial terminal since there is no window system there. */
11367 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11369 if (!noninteractive
)
11371 /* Before multi-tty support, these handlers used to be installed
11372 only if the current session was a tty session. Now an Emacs
11373 session may have multiple display types, so we always handle
11374 SIGINT. There is special code in interrupt_signal to exit
11375 Emacs on SIGINT when there are no termcap frames on the
11376 controlling terminal. */
11377 signal (SIGINT
, interrupt_signal
);
11379 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11380 SIGQUIT and we can't tell which one it will give us. */
11381 signal (SIGQUIT
, interrupt_signal
);
11382 #endif /* not DOS_NT */
11384 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11386 if (!noninteractive
)
11387 signal (SIGIO
, input_available_signal
);
11390 /* Use interrupt input by default, if it works and noninterrupt input
11391 has deficiencies. */
11393 #ifdef INTERRUPT_INPUT
11394 interrupt_input
= 1;
11396 interrupt_input
= 0;
11402 if (keyboard_init_hook
)
11403 (*keyboard_init_hook
) ();
11405 #ifdef POLL_FOR_INPUT
11407 poll_suppress_count
= 1;
11412 /* This type's only use is in syms_of_keyboard, to initialize the
11413 event header symbols and put properties on them. */
11414 struct event_head
{
11420 static const struct event_head head_table
[] = {
11421 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11422 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11423 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11424 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11425 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11426 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11427 /* `select-window' should be handled just like `switch-frame'
11428 in read_key_sequence. */
11429 {&Qselect_window
, "select-window", &Qswitch_frame
}
11433 syms_of_keyboard (void)
11435 pending_funcalls
= Qnil
;
11436 staticpro (&pending_funcalls
);
11438 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11439 staticpro (&Vlispy_mouse_stem
);
11442 QCimage
= intern_c_string (":image");
11443 staticpro (&QCimage
);
11445 staticpro (&Qhelp_echo
);
11446 Qhelp_echo
= intern_c_string ("help-echo");
11449 Qrtl
= intern_c_string (":rtl");
11451 staticpro (&item_properties
);
11452 item_properties
= Qnil
;
11454 staticpro (&tool_bar_item_properties
);
11455 tool_bar_item_properties
= Qnil
;
11456 staticpro (&tool_bar_items_vector
);
11457 tool_bar_items_vector
= Qnil
;
11459 staticpro (&real_this_command
);
11460 real_this_command
= Qnil
;
11462 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11463 staticpro (&Qtimer_event_handler
);
11465 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11466 staticpro (&Qdisabled_command_function
);
11468 Qself_insert_command
= intern_c_string ("self-insert-command");
11469 staticpro (&Qself_insert_command
);
11471 Qforward_char
= intern_c_string ("forward-char");
11472 staticpro (&Qforward_char
);
11474 Qbackward_char
= intern_c_string ("backward-char");
11475 staticpro (&Qbackward_char
);
11477 Qdisabled
= intern_c_string ("disabled");
11478 staticpro (&Qdisabled
);
11480 Qundefined
= intern_c_string ("undefined");
11481 staticpro (&Qundefined
);
11483 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11484 staticpro (&Qpre_command_hook
);
11486 Qpost_command_hook
= intern_c_string ("post-command-hook");
11487 staticpro (&Qpost_command_hook
);
11489 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11490 staticpro (&Qdeferred_action_function
);
11492 Qfunction_key
= intern_c_string ("function-key");
11493 staticpro (&Qfunction_key
);
11494 Qmouse_click
= intern_c_string ("mouse-click");
11495 staticpro (&Qmouse_click
);
11496 #if defined (WINDOWSNT)
11497 Qlanguage_change
= intern_c_string ("language-change");
11498 staticpro (&Qlanguage_change
);
11500 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11501 staticpro (&Qdrag_n_drop
);
11503 Qsave_session
= intern_c_string ("save-session");
11504 staticpro (&Qsave_session
);
11507 Qdbus_event
= intern_c_string ("dbus-event");
11508 staticpro (&Qdbus_event
);
11511 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11512 staticpro (&Qconfig_changed_event
);
11514 Qmenu_enable
= intern_c_string ("menu-enable");
11515 staticpro (&Qmenu_enable
);
11516 QCenable
= intern_c_string (":enable");
11517 staticpro (&QCenable
);
11518 QCvisible
= intern_c_string (":visible");
11519 staticpro (&QCvisible
);
11520 QChelp
= intern_c_string (":help");
11521 staticpro (&QChelp
);
11522 QCfilter
= intern_c_string (":filter");
11523 staticpro (&QCfilter
);
11524 QCbutton
= intern_c_string (":button");
11525 staticpro (&QCbutton
);
11526 QCkeys
= intern_c_string (":keys");
11527 staticpro (&QCkeys
);
11528 QCkey_sequence
= intern_c_string (":key-sequence");
11529 staticpro (&QCkey_sequence
);
11530 QCtoggle
= intern_c_string (":toggle");
11531 staticpro (&QCtoggle
);
11532 QCradio
= intern_c_string (":radio");
11533 staticpro (&QCradio
);
11534 QClabel
= intern_c_string (":label");
11535 staticpro (&QClabel
);
11536 QCvert_only
= intern_c_string (":vert-only");
11537 staticpro (&QCvert_only
);
11539 Qmode_line
= intern_c_string ("mode-line");
11540 staticpro (&Qmode_line
);
11541 Qvertical_line
= intern_c_string ("vertical-line");
11542 staticpro (&Qvertical_line
);
11543 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11544 staticpro (&Qvertical_scroll_bar
);
11545 Qmenu_bar
= intern_c_string ("menu-bar");
11546 staticpro (&Qmenu_bar
);
11548 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11549 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11550 staticpro (&Qmouse_fixup_help_message
);
11553 Qabove_handle
= intern_c_string ("above-handle");
11554 staticpro (&Qabove_handle
);
11555 Qhandle
= intern_c_string ("handle");
11556 staticpro (&Qhandle
);
11557 Qbelow_handle
= intern_c_string ("below-handle");
11558 staticpro (&Qbelow_handle
);
11559 Qup
= intern_c_string ("up");
11561 Qdown
= intern_c_string ("down");
11562 staticpro (&Qdown
);
11563 Qtop
= intern_c_string ("top");
11565 Qbottom
= intern_c_string ("bottom");
11566 staticpro (&Qbottom
);
11567 Qend_scroll
= intern_c_string ("end-scroll");
11568 staticpro (&Qend_scroll
);
11569 Qratio
= intern_c_string ("ratio");
11570 staticpro (&Qratio
);
11572 Qevent_kind
= intern_c_string ("event-kind");
11573 staticpro (&Qevent_kind
);
11574 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11575 staticpro (&Qevent_symbol_elements
);
11576 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11577 staticpro (&Qevent_symbol_element_mask
);
11578 Qmodifier_cache
= intern_c_string ("modifier-cache");
11579 staticpro (&Qmodifier_cache
);
11581 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11582 staticpro (&Qrecompute_lucid_menubar
);
11583 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11584 staticpro (&Qactivate_menubar_hook
);
11586 Qpolling_period
= intern_c_string ("polling-period");
11587 staticpro (&Qpolling_period
);
11589 Qinput_method_function
= intern_c_string ("input-method-function");
11590 staticpro (&Qinput_method_function
);
11592 Qx_set_selection
= intern_c_string ("x-set-selection");
11593 staticpro (&Qx_set_selection
);
11594 QPRIMARY
= intern_c_string ("PRIMARY");
11595 staticpro (&QPRIMARY
);
11596 Qhandle_switch_frame
= intern_c_string ("handle-switch-frame");
11597 staticpro (&Qhandle_switch_frame
);
11599 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11600 staticpro (&Qinput_method_exit_on_first_char
);
11601 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11602 staticpro (&Qinput_method_use_echo_area
);
11604 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11605 Fset (Qinput_method_use_echo_area
, Qnil
);
11607 last_point_position_buffer
= Qnil
;
11608 last_point_position_window
= Qnil
;
11612 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11614 for (i
= 0; i
< len
; i
++)
11616 const struct event_head
*p
= &head_table
[i
];
11617 *p
->var
= intern_c_string (p
->name
);
11618 staticpro (p
->var
);
11619 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11620 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11624 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11625 staticpro (&button_down_location
);
11626 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11627 staticpro (&mouse_syms
);
11628 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11629 / sizeof (lispy_wheel_names
[0])),
11631 staticpro (&wheel_syms
);
11635 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11637 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11638 for (i
= 0; i
< len
; i
++)
11639 if (modifier_names
[i
])
11640 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11641 staticpro (&modifier_symbols
);
11644 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11645 staticpro (&recent_keys
);
11647 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11648 staticpro (&this_command_keys
);
11650 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11651 staticpro (&raw_keybuf
);
11653 Qextended_command_history
= intern_c_string ("extended-command-history");
11654 Fset (Qextended_command_history
, Qnil
);
11655 staticpro (&Qextended_command_history
);
11657 accent_key_syms
= Qnil
;
11658 staticpro (&accent_key_syms
);
11660 func_key_syms
= Qnil
;
11661 staticpro (&func_key_syms
);
11663 drag_n_drop_syms
= Qnil
;
11664 staticpro (&drag_n_drop_syms
);
11666 unread_switch_frame
= Qnil
;
11667 staticpro (&unread_switch_frame
);
11669 internal_last_event_frame
= Qnil
;
11670 staticpro (&internal_last_event_frame
);
11672 read_key_sequence_cmd
= Qnil
;
11673 staticpro (&read_key_sequence_cmd
);
11675 menu_bar_one_keymap_changed_items
= Qnil
;
11676 staticpro (&menu_bar_one_keymap_changed_items
);
11678 menu_bar_items_vector
= Qnil
;
11679 staticpro (&menu_bar_items_vector
);
11681 help_form_saved_window_configs
= Qnil
;
11682 staticpro (&help_form_saved_window_configs
);
11684 defsubr (&Scurrent_idle_time
);
11685 defsubr (&Sevent_symbol_parse_modifiers
);
11686 defsubr (&Sevent_convert_list
);
11687 defsubr (&Sread_key_sequence
);
11688 defsubr (&Sread_key_sequence_vector
);
11689 defsubr (&Srecursive_edit
);
11690 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11691 defsubr (&Strack_mouse
);
11693 defsubr (&Sinput_pending_p
);
11694 defsubr (&Scommand_execute
);
11695 defsubr (&Srecent_keys
);
11696 defsubr (&Sthis_command_keys
);
11697 defsubr (&Sthis_command_keys_vector
);
11698 defsubr (&Sthis_single_command_keys
);
11699 defsubr (&Sthis_single_command_raw_keys
);
11700 defsubr (&Sreset_this_command_lengths
);
11701 defsubr (&Sclear_this_command_keys
);
11702 defsubr (&Ssuspend_emacs
);
11703 defsubr (&Sabort_recursive_edit
);
11704 defsubr (&Sexit_recursive_edit
);
11705 defsubr (&Srecursion_depth
);
11706 defsubr (&Stop_level
);
11707 defsubr (&Sdiscard_input
);
11708 defsubr (&Sopen_dribble_file
);
11709 defsubr (&Sset_input_interrupt_mode
);
11710 defsubr (&Sset_output_flow_control
);
11711 defsubr (&Sset_input_meta_mode
);
11712 defsubr (&Sset_quit_char
);
11713 defsubr (&Sset_input_mode
);
11714 defsubr (&Scurrent_input_mode
);
11715 defsubr (&Sexecute_extended_command
);
11716 defsubr (&Sposn_at_point
);
11717 defsubr (&Sposn_at_x_y
);
11719 DEFVAR_LISP ("last-command-event", last_command_event
,
11720 doc
: /* Last input event that was part of a command. */);
11722 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11723 doc
: /* Last input event in a command, except for mouse menu events.
11724 Mouse menus give back keys that don't look like mouse events;
11725 this variable holds the actual mouse event that led to the menu,
11726 so that you can determine whether the command was run by mouse or not. */);
11728 DEFVAR_LISP ("last-input-event", last_input_event
,
11729 doc
: /* Last input event. */);
11731 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11732 doc
: /* List of events to be read as the command input.
11733 These events are processed first, before actual keyboard input.
11734 Events read from this list are not normally added to `this-command-keys',
11735 as they will already have been added once as they were read for the first time.
11736 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11737 Vunread_command_events
= Qnil
;
11739 DEFVAR_INT ("unread-command-char", unread_command_char
,
11740 doc
: /* If not -1, an object to be read as next command input event. */);
11742 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11743 doc
: /* List of events to be processed as input by input methods.
11744 These events are processed before `unread-command-events'
11745 and actual keyboard input, but are not given to `input-method-function'. */);
11746 Vunread_post_input_method_events
= Qnil
;
11748 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11749 doc
: /* List of events to be processed as input by input methods.
11750 These events are processed after `unread-command-events', but
11751 before actual keyboard input.
11752 If there's an active input method, the events are given to
11753 `input-method-function'. */);
11754 Vunread_input_method_events
= Qnil
;
11756 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11757 doc
: /* Meta-prefix character code.
11758 Meta-foo as command input turns into this character followed by foo. */);
11759 XSETINT (meta_prefix_char
, 033);
11761 DEFVAR_KBOARD ("last-command", Vlast_command
,
11762 doc
: /* The last command executed.
11763 Normally a symbol with a function definition, but can be whatever was found
11764 in the keymap, or whatever the variable `this-command' was set to by that
11767 The value `mode-exit' is special; it means that the previous command
11768 read an event that told it to exit, and it did so and unread that event.
11769 In other words, the present command is the event that made the previous
11772 The value `kill-region' is special; it means that the previous command
11773 was a kill command.
11775 `last-command' has a separate binding for each terminal device.
11776 See Info node `(elisp)Multiple Terminals'. */);
11778 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11779 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11781 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11782 doc
: /* Last command that may be repeated.
11783 The last command executed that was not bound to an input event.
11784 This is the command `repeat' will try to repeat. */);
11786 DEFVAR_LISP ("this-command", Vthis_command
,
11787 doc
: /* The command now being executed.
11788 The command can set this variable; whatever is put here
11789 will be in `last-command' during the following command. */);
11790 Vthis_command
= Qnil
;
11792 DEFVAR_LISP ("this-command-keys-shift-translated",
11793 Vthis_command_keys_shift_translated
,
11794 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11795 Shift-translation occurs when there is no binding for the key sequence
11796 as entered, but a binding was found by changing an upper-case letter
11797 to lower-case, or a shifted function key to an unshifted one. */);
11798 Vthis_command_keys_shift_translated
= Qnil
;
11800 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11801 doc
: /* The command bound to the current key sequence before remapping.
11802 It equals `this-command' if the original command was not remapped through
11803 any of the active keymaps. Otherwise, the value of `this-command' is the
11804 result of looking up the original command in the active keymaps. */);
11805 Vthis_original_command
= Qnil
;
11807 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11808 doc
: /* *Number of input events between auto-saves.
11809 Zero means disable autosaving due to number of characters typed. */);
11810 auto_save_interval
= 300;
11812 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11813 doc
: /* *Number of seconds idle time before auto-save.
11814 Zero or nil means disable auto-saving due to idleness.
11815 After auto-saving due to this many seconds of idle time,
11816 Emacs also does a garbage collection if that seems to be warranted. */);
11817 XSETFASTINT (Vauto_save_timeout
, 30);
11819 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11820 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11821 The value may be integer or floating point. */);
11822 Vecho_keystrokes
= make_number (1);
11824 DEFVAR_INT ("polling-period", polling_period
,
11825 doc
: /* *Interval between polling for input during Lisp execution.
11826 The reason for polling is to make C-g work to stop a running program.
11827 Polling is needed only when using X windows and SIGIO does not work.
11828 Polling is automatically disabled in all other cases. */);
11829 polling_period
= 2;
11831 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11832 doc
: /* *Maximum time between mouse clicks to make a double-click.
11833 Measured in milliseconds. The value nil means disable double-click
11834 recognition; t means double-clicks have no time limit and are detected
11835 by position only. */);
11836 Vdouble_click_time
= make_number (500);
11838 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11839 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11840 On window-system frames, value is the number of pixels the mouse may have
11841 moved horizontally or vertically between two clicks to make a double-click.
11842 On non window-system frames, value is interpreted in units of 1/8 characters
11845 This variable is also the threshold for motion of the mouse
11846 to count as a drag. */);
11847 double_click_fuzz
= 3;
11849 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11850 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11851 inhibit_local_menu_bar_menus
= 0;
11853 DEFVAR_INT ("num-input-keys", num_input_keys
,
11854 doc
: /* Number of complete key sequences read as input so far.
11855 This includes key sequences read from keyboard macros.
11856 The number is effectively the number of interactive command invocations. */);
11857 num_input_keys
= 0;
11859 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11860 doc
: /* Number of input events read from the keyboard so far.
11861 This does not include events generated by keyboard macros. */);
11862 num_nonmacro_input_events
= 0;
11864 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11865 doc
: /* The frame in which the most recently read event occurred.
11866 If the last event came from a keyboard macro, this is set to `macro'. */);
11867 Vlast_event_frame
= Qnil
;
11869 /* This variable is set up in sysdep.c. */
11870 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11871 doc
: /* The ERASE character as set by the user with stty. */);
11873 DEFVAR_LISP ("help-char", Vhelp_char
,
11874 doc
: /* Character to recognize as meaning Help.
11875 When it is read, do `(eval help-form)', and display result if it's a string.
11876 If the value of `help-form' is nil, this char can be read normally. */);
11877 XSETINT (Vhelp_char
, Ctl ('H'));
11879 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11880 doc
: /* List of input events to recognize as meaning Help.
11881 These work just like the value of `help-char' (see that). */);
11882 Vhelp_event_list
= Qnil
;
11884 DEFVAR_LISP ("help-form", Vhelp_form
,
11885 doc
: /* Form to execute when character `help-char' is read.
11886 If the form returns a string, that string is displayed.
11887 If `help-form' is nil, the help char is not recognized. */);
11890 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11891 doc
: /* Command to run when `help-char' character follows a prefix key.
11892 This command is used only when there is no actual binding
11893 for that character after that prefix key. */);
11894 Vprefix_help_command
= Qnil
;
11896 DEFVAR_LISP ("top-level", Vtop_level
,
11897 doc
: /* Form to evaluate when Emacs starts up.
11898 Useful to set before you dump a modified Emacs. */);
11901 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11902 doc
: /* Translate table for local keyboard input, or nil.
11903 If non-nil, the value should be a char-table. Each character read
11904 from the keyboard is looked up in this char-table. If the value found
11905 there is non-nil, then it is used instead of the actual input character.
11907 The value can also be a string or vector, but this is considered obsolete.
11908 If it is a string or vector of length N, character codes N and up are left
11909 untranslated. In a vector, an element which is nil means "no translation".
11911 This is applied to the characters supplied to input methods, not their
11912 output. See also `translation-table-for-input'.
11914 This variable has a separate binding for each terminal.
11915 See Info node `(elisp)Multiple Terminals'. */);
11917 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11918 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11919 \(Even if the operating system has support for stopping a process.\) */);
11920 cannot_suspend
= 0;
11922 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11923 doc
: /* Non-nil means prompt with menus when appropriate.
11924 This is done when reading from a keymap that has a prompt string,
11925 for elements that have prompt strings.
11926 The menu is displayed on the screen
11927 if X menus were enabled at configuration
11928 time and the previous event was a mouse click prefix key.
11929 Otherwise, menu prompting uses the echo area. */);
11930 menu_prompting
= 1;
11932 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11933 doc
: /* Character to see next line of menu prompt.
11934 Type this character while in a menu prompt to rotate around the lines of it. */);
11935 XSETINT (menu_prompt_more_char
, ' ');
11937 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11938 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11939 Emacs applies the modifiers of the character stored here to each keyboard
11940 character it reads. For example, after evaluating the expression
11941 (setq extra-keyboard-modifiers ?\\C-x)
11942 all input characters will have the control modifier applied to them.
11944 Note that the character ?\\C-@, equivalent to the integer zero, does
11945 not count as a control character; rather, it counts as a character
11946 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11947 cancels any modification. */);
11948 extra_keyboard_modifiers
= 0;
11950 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11951 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11952 The command loop sets this to nil before each command,
11953 and tests the value when the command returns.
11954 Buffer modification stores t in this variable. */);
11955 Vdeactivate_mark
= Qnil
;
11956 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
11957 staticpro (&Qdeactivate_mark
);
11959 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11960 doc
: /* Normal hook run before each command is executed.
11961 If an unhandled error happens in running this hook,
11962 the function in which the error occurred is unconditionally removed, since
11963 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11964 Vpre_command_hook
= Qnil
;
11966 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11967 doc
: /* Normal hook run after each command is executed.
11968 If an unhandled error happens in running this hook,
11969 the function in which the error occurred is unconditionally removed, since
11970 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11971 Vpost_command_hook
= Qnil
;
11974 DEFVAR_LISP ("echo-area-clear-hook", ...,
11975 doc
: /* Normal hook run when clearing the echo area. */);
11977 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
11978 staticpro (&Qecho_area_clear_hook
);
11979 Fset (Qecho_area_clear_hook
, Qnil
);
11981 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11982 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11983 Vlucid_menu_bar_dirty_flag
= Qnil
;
11985 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11986 doc
: /* List of menu bar items to move to the end of the menu bar.
11987 The elements of the list are event types that may have menu bar bindings. */);
11988 Vmenu_bar_final_items
= Qnil
;
11990 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11991 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11992 This is used internally by graphical displays that do not render
11993 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11994 Vtool_bar_separator_image_expression
= Qnil
;
11996 DEFVAR_KBOARD ("overriding-terminal-local-map",
11997 Voverriding_terminal_local_map
,
11998 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11999 If this variable is non-nil, it is used as a keymap instead of the
12000 buffer's local map, and the minor mode keymaps and text property keymaps.
12001 It also replaces `overriding-local-map'.
12003 This variable is intended to let commands such as `universal-argument'
12004 set up a different keymap for reading the next command.
12006 `overriding-terminal-local-map' has a separate binding for each
12008 See Info node `(elisp)Multiple Terminals'. */);
12010 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
12011 doc
: /* Keymap that overrides all other local keymaps.
12012 If this variable is non-nil, it is used as a keymap--replacing the
12013 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12014 Voverriding_local_map
= Qnil
;
12016 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
12017 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12018 Otherwise, the menu bar continues to reflect the buffer's local map
12019 and the minor mode maps regardless of `overriding-local-map'. */);
12020 Voverriding_local_map_menu_flag
= Qnil
;
12022 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12023 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12024 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12026 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12027 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12029 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12030 doc
: /* Alist of system-specific X windows key symbols.
12031 Each element should have the form (N . SYMBOL) where N is the
12032 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12033 and SYMBOL is its name.
12035 `system-key-alist' has a separate binding for each terminal device.
12036 See Info node `(elisp)Multiple Terminals'. */);
12038 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12039 doc
: /* Keymap that translates key sequences to key sequences during input.
12040 This is used mainly for mapping key sequences into some preferred
12041 key events (symbols).
12043 The `read-key-sequence' function replaces any subsequence bound by
12044 `local-function-key-map' with its binding. More precisely, when the
12045 active keymaps have no binding for the current key sequence but
12046 `local-function-key-map' binds a suffix of the sequence to a vector or
12047 string, `read-key-sequence' replaces the matching suffix with its
12048 binding, and continues with the new sequence.
12050 If the binding is a function, it is called with one argument (the prompt)
12051 and its return value (a key sequence) is used.
12053 The events that come from bindings in `local-function-key-map' are not
12054 themselves looked up in `local-function-key-map'.
12056 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12057 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12058 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12059 typing `ESC O P x' would return [f1 x].
12061 `local-function-key-map' has a separate binding for each terminal
12062 device. See Info node `(elisp)Multiple Terminals'. If you need to
12063 define a binding on all terminals, change `function-key-map'
12064 instead. Initially, `local-function-key-map' is an empty keymap that
12065 has `function-key-map' as its parent on all terminal devices. */);
12067 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12068 doc
: /* Keymap that decodes input escape sequences.
12069 This is used mainly for mapping ASCII function key sequences into
12070 real Emacs function key events (symbols).
12072 The `read-key-sequence' function replaces any subsequence bound by
12073 `input-decode-map' with its binding. Contrary to `function-key-map',
12074 this map applies its rebinding regardless of the presence of an ordinary
12075 binding. So it is more like `key-translation-map' except that it applies
12076 before `function-key-map' rather than after.
12078 If the binding is a function, it is called with one argument (the prompt)
12079 and its return value (a key sequence) is used.
12081 The events that come from bindings in `input-decode-map' are not
12082 themselves looked up in `input-decode-map'.
12084 This variable is keyboard-local. */);
12086 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12087 doc
: /* The parent keymap of all `local-function-key-map' instances.
12088 Function key definitions that apply to all terminal devices should go
12089 here. If a mapping is defined in both the current
12090 `local-function-key-map' binding and this variable, then the local
12091 definition will take precendence. */);
12092 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12094 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12095 doc
: /* Keymap of key translations that can override keymaps.
12096 This keymap works like `function-key-map', but comes after that,
12097 and its non-prefix bindings override ordinary bindings.
12098 Another difference is that it is global rather than keyboard-local. */);
12099 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12101 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12102 doc
: /* List of deferred actions to be performed at a later time.
12103 The precise format isn't relevant here; we just check whether it is nil. */);
12104 Vdeferred_action_list
= Qnil
;
12106 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12107 doc
: /* Function to call to handle deferred actions, after each command.
12108 This function is called with no arguments after each command
12109 whenever `deferred-action-list' is non-nil. */);
12110 Vdeferred_action_function
= Qnil
;
12112 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12113 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12114 The value can be a length of time to show the message for.
12115 If the value is non-nil and not a number, we wait 2 seconds. */);
12116 Vsuggest_key_bindings
= Qt
;
12118 DEFVAR_LISP ("timer-list", Vtimer_list
,
12119 doc
: /* List of active absolute time timers in order of increasing time. */);
12120 Vtimer_list
= Qnil
;
12122 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12123 doc
: /* List of active idle-time timers in order of increasing time. */);
12124 Vtimer_idle_list
= Qnil
;
12126 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12127 doc
: /* If non-nil, the function that implements the current input method.
12128 It's called with one argument, a printing character that was just read.
12129 \(That means a character with code 040...0176.)
12130 Typically this function uses `read-event' to read additional events.
12131 When it does so, it should first bind `input-method-function' to nil
12132 so it will not be called recursively.
12134 The function should return a list of zero or more events
12135 to be used as input. If it wants to put back some events
12136 to be reconsidered, separately, by the input method,
12137 it can add them to the beginning of `unread-command-events'.
12139 The input method function can find in `input-method-previous-message'
12140 the previous echo area message.
12142 The input method function should refer to the variables
12143 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12144 for guidance on what to do. */);
12145 Vinput_method_function
= Qnil
;
12147 DEFVAR_LISP ("input-method-previous-message",
12148 Vinput_method_previous_message
,
12149 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12150 This variable exists because `read-event' clears the echo area
12151 before running the input method. It is nil if there was no message. */);
12152 Vinput_method_previous_message
= Qnil
;
12154 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12155 doc
: /* If non-nil, the function that implements the display of help.
12156 It's called with one argument, the help string to display. */);
12157 Vshow_help_function
= Qnil
;
12159 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12160 doc
: /* If non-nil, suppress point adjustment after executing a command.
12162 After a command is executed, if point is moved into a region that has
12163 special properties (e.g. composition, display), we adjust point to
12164 the boundary of the region. But, when a command sets this variable to
12165 non-nil, we suppress the point adjustment.
12167 This variable is set to nil before reading a command, and is checked
12168 just after executing the command. */);
12169 Vdisable_point_adjustment
= Qnil
;
12171 DEFVAR_LISP ("global-disable-point-adjustment",
12172 Vglobal_disable_point_adjustment
,
12173 doc
: /* *If non-nil, always suppress point adjustment.
12175 The default value is nil, in which case, point adjustment are
12176 suppressed only after special commands that set
12177 `disable-point-adjustment' (which see) to non-nil. */);
12178 Vglobal_disable_point_adjustment
= Qnil
;
12180 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12181 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12182 If the value is not a number, such messages don't time out. */);
12183 Vminibuffer_message_timeout
= make_number (2);
12185 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12186 doc
: /* If non-nil, any keyboard input throws to this symbol.
12187 The value of that variable is passed to `quit-flag' and later causes a
12188 peculiar kind of quitting. */);
12189 Vthrow_on_input
= Qnil
;
12191 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12192 doc
: /* If non-nil, function to output error messages.
12193 The arguments are the error data, a list of the form
12194 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12195 such as just as `condition-case' would bind its variable to,
12196 the context (a string which normally goes at the start of the message),
12197 and the Lisp function within which the error was signaled. */);
12198 Vcommand_error_function
= Qnil
;
12200 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12201 Venable_disabled_menus_and_buttons
,
12202 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12204 Help functions bind this to allow help on disabled menu items
12205 and tool-bar buttons. */);
12206 Venable_disabled_menus_and_buttons
= Qnil
;
12208 DEFVAR_LISP ("select-active-regions",
12209 Vselect_active_regions
,
12210 doc
: /* If non-nil, an active region automatically sets the primary selection.
12211 If the value is `only', only temporarily active regions (usually made
12212 by mouse-dragging or shift-selection) set the window selection.
12214 This takes effect only when Transient Mark mode is enabled. */);
12215 Vselect_active_regions
= Qt
;
12217 DEFVAR_LISP ("saved-region-selection",
12218 Vsaved_region_selection
,
12219 doc
: /* Contents of active region prior to buffer modification.
12220 If `select-active-regions' is non-nil, Emacs sets this to the
12221 text in the region before modifying the buffer. The next
12222 `deactivate-mark' call uses this to set the window selection. */);
12223 Vsaved_region_selection
= Qnil
;
12225 /* Create the initial keyboard. */
12226 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12227 init_kboard (initial_kboard
);
12228 /* Vwindow_system is left at t for now. */
12229 initial_kboard
->next_kboard
= all_kboards
;
12230 all_kboards
= initial_kboard
;
12234 keys_of_keyboard (void)
12236 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12237 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12238 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12239 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12240 initial_define_key (meta_map
, 'x', "execute-extended-command");
12242 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12243 "handle-delete-frame");
12244 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12245 "ns-put-working-text");
12246 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12247 "ns-unput-working-text");
12248 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12249 current-prefix-arg, as is done in `handle-switch-frame'.
12250 But `handle-switch-frame is not run from the special-map.
12251 Commands from that map are run in a special way that automatically
12252 preserves the prefix-arg. Restoring the prefix arg here is not just
12253 redundant but harmful:
12255 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12256 - after the first prompt, the exit-minibuffer-hook is run which may
12257 iconify a frame and thus push a `iconify-frame' event.
12258 - after running exit-minibuffer-hook, current-prefix-arg is
12259 restored to the non-nil value it had before the prompt.
12260 - we enter the second prompt.
12261 current-prefix-arg is non-nil, prefix-arg is nil.
12262 - before running the first real event, we run the special iconify-frame
12263 event, but we pass the `special' arg to execute-command so
12264 current-prefix-arg and prefix-arg are left untouched.
12265 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12266 - the next key event will have a spuriously non-nil current-prefix-arg. */
12267 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12269 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12271 /* Handling it at such a low-level causes read_key_sequence to get
12272 * confused because it doesn't realize that the current_buffer was
12273 * changed by read_char.
12275 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12276 * "handle-select-window"); */
12277 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12278 "handle-save-session");
12281 /* Define a special event which is raised for dbus callback
12283 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12284 "dbus-handle-event");
12287 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12291 /* Mark the pointers in the kboard objects.
12292 Called by the Fgarbage_collector. */
12294 mark_kboards (void)
12298 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12300 if (kb
->kbd_macro_buffer
)
12301 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12303 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12304 mark_object (KVAR (kb
, Vlast_command
));
12305 mark_object (KVAR (kb
, Vreal_last_command
));
12306 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12307 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12308 mark_object (KVAR (kb
, Vprefix_arg
));
12309 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12310 mark_object (KVAR (kb
, kbd_queue
));
12311 mark_object (KVAR (kb
, defining_kbd_macro
));
12312 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12313 mark_object (KVAR (kb
, Vsystem_key_alist
));
12314 mark_object (KVAR (kb
, system_key_syms
));
12315 mark_object (KVAR (kb
, Vwindow_system
));
12316 mark_object (KVAR (kb
, Vinput_decode_map
));
12317 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12318 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12319 mark_object (KVAR (kb
, echo_string
));
12322 struct input_event
*event
;
12323 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12325 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12326 event
= kbd_buffer
;
12327 if (event
->kind
!= SELECTION_REQUEST_EVENT
12328 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12330 mark_object (event
->x
);
12331 mark_object (event
->y
);
12333 mark_object (event
->frame_or_window
);
12334 mark_object (event
->arg
);