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
;
104 static Lisp_Object Qdisabled_command_function
;
106 #define NUM_RECENT_KEYS (300)
107 int recent_keys_index
; /* Index for storing next element into recent_keys */
108 int total_keys
; /* Total number of elements stored into recent_keys */
109 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
111 /* Vector holding the key sequence that invoked the current command.
112 It is reused for each command, and it may be longer than the current
113 sequence; this_command_key_count indicates how many elements
114 actually mean something.
115 It's easier to staticpro a single Lisp_Object than an array. */
116 Lisp_Object this_command_keys
;
117 int this_command_key_count
;
119 /* 1 after calling Freset_this_command_lengths.
121 int this_command_key_count_reset
;
123 /* This vector is used as a buffer to record the events that were actually read
124 by read_key_sequence. */
125 Lisp_Object raw_keybuf
;
126 int raw_keybuf_count
;
128 #define GROW_RAW_KEYBUF \
129 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
130 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
132 /* Number of elements of this_command_keys
133 that precede this key sequence. */
134 int this_single_command_key_start
;
136 /* Record values of this_command_key_count and echo_length ()
137 before this command was read. */
138 static int before_command_key_count
;
139 static int before_command_echo_length
;
141 /* For longjmp to where kbd input is being done. */
143 static jmp_buf getcjmp
;
145 /* True while doing kbd input. */
146 int waiting_for_input
;
148 /* True while displaying for echoing. Delays C-g throwing. */
152 /* Non-null means we can start echoing at the next input pause even
153 though there is something in the echo area. */
155 static struct kboard
*ok_to_echo_at_next_pause
;
157 /* The kboard last echoing, or null for none. Reset to 0 in
158 cancel_echoing. If non-null, and a current echo area message
159 exists, and echo_message_buffer is eq to the current message
160 buffer, we know that the message comes from echo_kboard. */
162 struct kboard
*echo_kboard
;
164 /* The buffer used for echoing. Set in echo_now, reset in
167 Lisp_Object echo_message_buffer
;
169 /* Nonzero means C-g should cause immediate error-signal. */
172 /* Character that causes a quit. Normally C-g.
174 If we are running on an ordinary terminal, this must be an ordinary
175 ASCII char, since we want to make it our interrupt character.
177 If we are not running on an ordinary terminal, it still needs to be
178 an ordinary ASCII char. This character needs to be recognized in
179 the input interrupt handler. At this point, the keystroke is
180 represented as a struct input_event, while the desired quit
181 character is specified as a lispy event. The mapping from struct
182 input_events to lispy events cannot run in an interrupt handler,
183 and the reverse mapping is difficult for anything but ASCII
186 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
190 /* Current depth in recursive edits. */
191 int command_loop_level
;
193 /* If not Qnil, this is a switch-frame event which we decided to put
194 off until the end of a key sequence. This should be read as the
195 next command input, after any unread_command_events.
197 read_key_sequence uses this to delay switch-frame events until the
198 end of the key sequence; Fread_char uses it to put off switch-frame
199 events until a non-ASCII event is acceptable as input. */
200 Lisp_Object unread_switch_frame
;
202 /* Last size recorded for a current buffer which is not a minibuffer. */
203 static EMACS_INT last_non_minibuf_size
;
205 /* Total number of times read_char has returned, modulo SIZE_MAX + 1. */
206 size_t num_input_events
;
208 /* Value of num_nonmacro_input_events as of last auto save. */
212 /* This is like Vthis_command, except that commands never set it. */
213 Lisp_Object real_this_command
;
215 /* The value of point when the last command was started. */
216 static EMACS_INT last_point_position
;
218 /* The buffer that was current when the last command was started. */
219 static Lisp_Object last_point_position_buffer
;
221 /* The window that was selected when the last command was started. */
222 static Lisp_Object last_point_position_window
;
224 /* The frame in which the last input event occurred, or Qmacro if the
225 last event came from a macro. We use this to determine when to
226 generate switch-frame events. This may be cleared by functions
227 like Fselect_frame, to make sure that a switch-frame event is
228 generated by the next character. */
229 Lisp_Object internal_last_event_frame
;
231 /* The timestamp of the last input event we received from the X server.
232 X Windows wants this for selection ownership. */
233 unsigned long last_event_timestamp
;
235 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
236 Lisp_Object QPRIMARY
;
238 static Lisp_Object Qself_insert_command
;
239 static Lisp_Object Qforward_char
;
240 static Lisp_Object Qbackward_char
;
241 static Lisp_Object Qundefined
;
242 static Lisp_Object Qtimer_event_handler
;
244 /* read_key_sequence stores here the command definition of the
245 key sequence that it reads. */
246 Lisp_Object read_key_sequence_cmd
;
248 static Lisp_Object Qinput_method_function
;
250 static Lisp_Object Qdeactivate_mark
;
252 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
254 static Lisp_Object Qecho_area_clear_hook
;
256 /* Hooks to run before and after each command. */
257 static Lisp_Object Qpre_command_hook
;
258 static Lisp_Object Qpost_command_hook
;
260 static Lisp_Object Qdeferred_action_function
;
262 static Lisp_Object Qinput_method_exit_on_first_char
;
263 static Lisp_Object Qinput_method_use_echo_area
;
265 static Lisp_Object Qhelp_form_show
;
267 /* File in which we write all commands we read. */
270 /* Nonzero if input is available. */
273 /* Circular buffer for pre-read keyboard input. */
275 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
277 /* Pointer to next available character in kbd_buffer.
278 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
279 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
280 next available char is in kbd_buffer[0]. */
281 static struct input_event
*kbd_fetch_ptr
;
283 /* Pointer to next place to store character in kbd_buffer. This
284 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
285 character should go in kbd_buffer[0]. */
286 static struct input_event
* volatile kbd_store_ptr
;
288 /* The above pair of variables forms a "queue empty" flag. When we
289 enqueue a non-hook event, we increment kbd_store_ptr. When we
290 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
291 there is input available if the two pointers are not equal.
293 Why not just have a flag set and cleared by the enqueuing and
294 dequeuing functions? Such a flag could be screwed up by interrupts
295 at inopportune times. */
297 /* Symbols to head events. */
298 static Lisp_Object Qmouse_movement
;
299 static Lisp_Object Qscroll_bar_movement
;
300 Lisp_Object Qswitch_frame
;
301 static Lisp_Object Qdelete_frame
;
302 static Lisp_Object Qiconify_frame
;
303 static Lisp_Object Qmake_frame_visible
;
304 static Lisp_Object Qselect_window
;
305 Lisp_Object Qhelp_echo
;
307 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
308 static Lisp_Object Qmouse_fixup_help_message
;
311 /* Symbols to denote kinds of events. */
312 static Lisp_Object Qfunction_key
;
313 Lisp_Object Qmouse_click
;
314 #if defined (WINDOWSNT)
315 Lisp_Object Qlanguage_change
;
317 static Lisp_Object Qdrag_n_drop
;
318 static Lisp_Object Qsave_session
;
320 static Lisp_Object Qdbus_event
;
322 static Lisp_Object Qconfig_changed_event
;
324 /* Lisp_Object Qmouse_movement; - also an event header */
326 /* Properties of event headers. */
327 Lisp_Object Qevent_kind
;
328 static Lisp_Object Qevent_symbol_elements
;
330 /* menu and tool bar item parts */
331 static Lisp_Object Qmenu_enable
;
332 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
333 Lisp_Object QCfilter
;
335 /* Non-nil disable property on a command means
336 do not execute it; call disabled-command-function's value instead. */
337 Lisp_Object QCtoggle
, QCradio
;
338 static Lisp_Object QCbutton
, QClabel
;
340 static Lisp_Object QCvert_only
;
342 /* An event header symbol HEAD may have a property named
343 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
344 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
345 mask of modifiers applied to it. If present, this is used to help
346 speed up parse_modifiers. */
347 Lisp_Object Qevent_symbol_element_mask
;
349 /* An unmodified event header BASE may have a property named
350 Qmodifier_cache, which is an alist mapping modifier masks onto
351 modified versions of BASE. If present, this helps speed up
353 static Lisp_Object Qmodifier_cache
;
355 /* Symbols to use for parts of windows. */
356 Lisp_Object Qmode_line
;
357 Lisp_Object Qvertical_line
;
358 static Lisp_Object Qvertical_scroll_bar
;
359 Lisp_Object Qmenu_bar
;
361 Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
), command_loop (void);
362 static Lisp_Object Qextended_command_history
;
363 EMACS_TIME
timer_check (void);
365 static void record_menu_key (Lisp_Object c
);
366 static int echo_length (void);
368 static Lisp_Object Qpolling_period
;
370 /* Incremented whenever a timer is run. */
373 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
375 EMACS_TIME
*input_available_clear_time
;
377 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
378 Default is 1 if INTERRUPT_INPUT is defined. */
381 /* Nonzero while interrupts are temporarily deferred during redisplay. */
382 int interrupts_deferred
;
384 /* Allow m- file to inhibit use of FIONREAD. */
385 #ifdef BROKEN_FIONREAD
389 /* We are unable to use interrupts if FIONREAD is not available,
390 so flush SIGIO so we won't try. */
391 #if !defined (FIONREAD)
397 /* If we support a window system, turn on the code to poll periodically
398 to detect C-g. It isn't actually used when doing interrupt input. */
399 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
400 #define POLL_FOR_INPUT
403 /* The time when Emacs started being idle. */
405 static EMACS_TIME timer_idleness_start_time
;
407 /* After Emacs stops being idle, this saves the last value
408 of timer_idleness_start_time from when it was idle. */
410 static EMACS_TIME timer_last_idleness_start_time
;
413 /* Global variable declarations. */
415 /* Flags for readable_events. */
416 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
417 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
418 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
420 /* Function for init_keyboard to call with no args (if nonzero). */
421 void (*keyboard_init_hook
) (void);
423 static int read_avail_input (int);
424 static void get_input_pending (int *, int);
425 static int readable_events (int);
426 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
428 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
430 static Lisp_Object
make_lispy_event (struct input_event
*);
431 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
432 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
433 enum scroll_bar_part
,
434 Lisp_Object
, Lisp_Object
,
437 static Lisp_Object
modify_event_symbol (EMACS_INT
, unsigned, Lisp_Object
,
438 Lisp_Object
, const char *const *,
439 Lisp_Object
*, unsigned);
440 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
441 static void save_getcjmp (jmp_buf);
442 static void restore_getcjmp (jmp_buf);
443 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
444 static void clear_event (struct input_event
*);
445 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
446 static void interrupt_signal (int signalnum
);
448 static void input_available_signal (int signo
);
450 INFUN (Fcommand_execute
, 4);
451 static void handle_interrupt (void);
452 static void timer_start_idle (void);
453 static void timer_stop_idle (void);
454 static void timer_resume_idle (void);
455 static void handle_user_signal (int);
456 static char *find_user_signal_name (int);
457 static int store_user_signal_events (void);
460 /* Add C to the echo string, if echoing is going on.
461 C can be a character, which is printed prettily ("M-C-x" and all that
462 jazz), or a symbol, whose name is printed. */
465 echo_char (Lisp_Object c
)
467 if (current_kboard
->immediate_echo
)
469 int size
= KEY_DESCRIPTION_SIZE
+ 100;
470 char *buffer
= (char *) alloca (size
);
472 Lisp_Object echo_string
;
474 echo_string
= KVAR (current_kboard
, echo_string
);
476 /* If someone has passed us a composite event, use its head symbol. */
481 ptr
= push_key_description (XINT (c
), ptr
, 1);
483 else if (SYMBOLP (c
))
485 Lisp_Object name
= SYMBOL_NAME (c
);
486 int nbytes
= SBYTES (name
);
488 if (size
- (ptr
- buffer
) < nbytes
)
490 int offset
= ptr
- buffer
;
491 size
= max (2 * size
, size
+ nbytes
);
492 buffer
= (char *) alloca (size
);
493 ptr
= buffer
+ offset
;
496 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
497 STRING_MULTIBYTE (name
), 1);
500 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
503 const char *text
= " (Type ? for further options)";
504 int len
= strlen (text
);
506 if (size
- (ptr
- buffer
) < len
)
508 int offset
= ptr
- buffer
;
510 buffer
= (char *) alloca (size
);
511 ptr
= buffer
+ offset
;
514 memcpy (ptr
, text
, len
);
518 /* Replace a dash from echo_dash with a space, otherwise
519 add a space at the end as a separator between keys. */
520 if (STRINGP (echo_string
)
521 && SCHARS (echo_string
) > 1)
523 Lisp_Object last_char
, prev_char
, idx
;
525 idx
= make_number (SCHARS (echo_string
) - 2);
526 prev_char
= Faref (echo_string
, idx
);
528 idx
= make_number (SCHARS (echo_string
) - 1);
529 last_char
= Faref (echo_string
, idx
);
531 /* We test PREV_CHAR to make sure this isn't the echoing
533 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
534 Faset (echo_string
, idx
, make_number (' '));
536 echo_string
= concat2 (echo_string
, build_string (" "));
538 else if (STRINGP (echo_string
))
539 echo_string
= concat2 (echo_string
, build_string (" "));
541 KVAR (current_kboard
, echo_string
)
542 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
548 /* Temporarily add a dash to the end of the echo string if it's not
549 empty, so that it serves as a mini-prompt for the very next character. */
554 /* Do nothing if not echoing at all. */
555 if (NILP (KVAR (current_kboard
, echo_string
)))
558 if (this_command_key_count
== 0)
561 if (!current_kboard
->immediate_echo
562 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
565 /* Do nothing if we just printed a prompt. */
566 if (current_kboard
->echo_after_prompt
567 == SCHARS (KVAR (current_kboard
, echo_string
)))
570 /* Do nothing if we have already put a dash at the end. */
571 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
573 Lisp_Object last_char
, prev_char
, idx
;
575 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
576 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
578 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
579 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
581 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
585 /* Put a dash at the end of the buffer temporarily,
586 but make it go away when the next character is added. */
587 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
592 /* Display the current echo string, and begin echoing if not already
598 if (!current_kboard
->immediate_echo
)
601 current_kboard
->immediate_echo
= 1;
603 for (i
= 0; i
< this_command_key_count
; i
++)
607 /* Set before_command_echo_length to the value that would
608 have been saved before the start of this subcommand in
609 command_loop_1, if we had already been echoing then. */
610 if (i
== this_single_command_key_start
)
611 before_command_echo_length
= echo_length ();
613 c
= XVECTOR (this_command_keys
)->contents
[i
];
614 if (! (EVENT_HAS_PARAMETERS (c
)
615 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
619 /* Set before_command_echo_length to the value that would
620 have been saved before the start of this subcommand in
621 command_loop_1, if we had already been echoing then. */
622 if (this_command_key_count
== this_single_command_key_start
)
623 before_command_echo_length
= echo_length ();
625 /* Put a dash at the end to invite the user to type more. */
630 message3_nolog (KVAR (current_kboard
, echo_string
),
631 SBYTES (KVAR (current_kboard
, echo_string
)),
632 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
635 /* Record in what buffer we echoed, and from which kboard. */
636 echo_message_buffer
= echo_area_buffer
[0];
637 echo_kboard
= current_kboard
;
639 if (waiting_for_input
&& !NILP (Vquit_flag
))
640 quit_throw_to_read_char ();
643 /* Turn off echoing, for the start of a new command. */
646 cancel_echoing (void)
648 current_kboard
->immediate_echo
= 0;
649 current_kboard
->echo_after_prompt
= -1;
650 KVAR (current_kboard
, echo_string
) = Qnil
;
651 ok_to_echo_at_next_pause
= NULL
;
653 echo_message_buffer
= Qnil
;
656 /* Return the length of the current echo string. */
661 return (STRINGP (KVAR (current_kboard
, echo_string
))
662 ? SCHARS (KVAR (current_kboard
, echo_string
))
666 /* Truncate the current echo message to its first LEN chars.
667 This and echo_char get used by read_key_sequence when the user
668 switches frames while entering a key sequence. */
671 echo_truncate (EMACS_INT nchars
)
673 if (STRINGP (KVAR (current_kboard
, echo_string
)))
674 KVAR (current_kboard
, echo_string
)
675 = Fsubstring (KVAR (current_kboard
, echo_string
),
676 make_number (0), make_number (nchars
));
677 truncate_echo_area (nchars
);
681 /* Functions for manipulating this_command_keys. */
683 add_command_key (Lisp_Object key
)
685 #if 0 /* Not needed after we made Freset_this_command_lengths
686 do the job immediately. */
687 /* If reset-this-command-length was called recently, obey it now.
688 See the doc string of that function for an explanation of why. */
689 if (before_command_restore_flag
)
691 this_command_key_count
= before_command_key_count_1
;
692 if (this_command_key_count
< this_single_command_key_start
)
693 this_single_command_key_start
= this_command_key_count
;
694 echo_truncate (before_command_echo_length_1
);
695 before_command_restore_flag
= 0;
699 if (this_command_key_count
>= ASIZE (this_command_keys
))
700 this_command_keys
= larger_vector (this_command_keys
,
701 2 * ASIZE (this_command_keys
),
704 ASET (this_command_keys
, this_command_key_count
, key
);
705 ++this_command_key_count
;
710 recursive_edit_1 (void)
712 int count
= SPECPDL_INDEX ();
715 if (command_loop_level
> 0)
717 specbind (Qstandard_output
, Qt
);
718 specbind (Qstandard_input
, Qt
);
721 #ifdef HAVE_WINDOW_SYSTEM
722 /* The command loop has started an hourglass timer, so we have to
723 cancel it here, otherwise it will fire because the recursive edit
724 can take some time. Do not check for display_hourglass_p here,
725 because it could already be nil. */
729 /* This function may have been called from a debugger called from
730 within redisplay, for instance by Edebugging a function called
731 from fontification-functions. We want to allow redisplay in
732 the debugging session.
734 The recursive edit is left with a `(throw exit ...)'. The `exit'
735 tag is not caught anywhere in redisplay, i.e. when we leave the
736 recursive edit, the original redisplay leading to the recursive
737 edit will be unwound. The outcome should therefore be safe. */
738 specbind (Qinhibit_redisplay
, Qnil
);
741 val
= command_loop ();
743 Fsignal (Qquit
, Qnil
);
744 /* Handle throw from read_minibuf when using minibuffer
745 while it's active but we're in another window. */
747 xsignal1 (Qerror
, val
);
749 return unbind_to (count
, Qnil
);
752 /* When an auto-save happens, record the "time", and don't do again soon. */
755 record_auto_save (void)
757 last_auto_save
= num_nonmacro_input_events
;
760 /* Make an auto save happen as soon as possible at command level. */
763 force_auto_save_soon (void)
765 last_auto_save
= - auto_save_interval
- 1;
767 record_asynch_buffer_change ();
770 DEFUE ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
771 doc
: /* Invoke the editor command loop recursively.
772 To get out of the recursive edit, a command can do `(throw 'exit nil)';
773 that tells this function to return.
774 Alternatively, `(throw 'exit t)' makes this function signal an error.
775 This function is called by the editor initialization to begin editing. */)
778 int count
= SPECPDL_INDEX ();
781 /* If we enter while input is blocked, don't lock up here.
782 This may happen through the debugger during redisplay. */
786 command_loop_level
++;
787 update_mode_lines
= 1;
789 if (command_loop_level
790 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
791 buffer
= Fcurrent_buffer ();
795 /* If we leave recursive_edit_1 below with a `throw' for instance,
796 like it is done in the splash screen display, we have to
797 make sure that we restore single_kboard as command_loop_1
798 would have done if it were left normally. */
799 if (command_loop_level
> 0)
800 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
801 record_unwind_protect (recursive_edit_unwind
, buffer
);
804 return unbind_to (count
, Qnil
);
808 recursive_edit_unwind (Lisp_Object buffer
)
810 if (BUFFERP (buffer
))
811 Fset_buffer (buffer
);
813 command_loop_level
--;
814 update_mode_lines
= 1;
819 #if 0 /* These two functions are now replaced with
820 temporarily_switch_to_single_kboard. */
824 #if 0 /* Theory: if there's anything in Vunread_command_events,
825 it will right away be read by read_key_sequence,
826 and then if we do switch KBOARDS, it will go into the side
827 queue then. So we don't need to do anything special here -- rms. */
828 if (CONSP (Vunread_command_events
))
830 current_kboard
->kbd_queue
831 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
832 current_kboard
->kbd_queue_has_data
= 1;
834 Vunread_command_events
= Qnil
;
839 /* Switch to the single-kboard state, making current_kboard
840 the only KBOARD from which further input is accepted. */
843 single_kboard_state ()
849 /* If we're in single_kboard state for kboard KBOARD,
853 not_single_kboard_state (KBOARD
*kboard
)
855 if (kboard
== current_kboard
)
859 /* Maintain a stack of kboards, so other parts of Emacs
860 can switch temporarily to the kboard of a given frame
861 and then revert to the previous status. */
866 struct kboard_stack
*next
;
869 static struct kboard_stack
*kboard_stack
;
872 push_kboard (struct kboard
*k
)
874 struct kboard_stack
*p
875 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
877 p
->next
= kboard_stack
;
878 p
->kboard
= current_kboard
;
888 struct kboard_stack
*p
= kboard_stack
;
890 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
892 if (t
->kboard
== p
->kboard
)
894 current_kboard
= p
->kboard
;
901 /* The terminal we remembered has been deleted. */
902 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
905 kboard_stack
= p
->next
;
909 /* Switch to single_kboard mode, making current_kboard the only KBOARD
910 from which further input is accepted. If F is non-nil, set its
911 KBOARD as the current keyboard.
913 This function uses record_unwind_protect to return to the previous
916 If Emacs is already in single_kboard mode, and F's keyboard is
917 locked, then this function will throw an errow. */
920 temporarily_switch_to_single_kboard (struct frame
*f
)
922 int was_locked
= single_kboard
;
925 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
926 /* We can not switch keyboards while in single_kboard mode.
927 In rare cases, Lisp code may call `recursive-edit' (or
928 `read-minibuffer' or `y-or-n-p') after it switched to a
929 locked frame. For example, this is likely to happen
930 when server.el connects to a new terminal while Emacs is in
931 single_kboard mode. It is best to throw an error instead
932 of presenting the user with a frozen screen. */
933 error ("Terminal %d is locked, cannot read from it",
934 FRAME_TERMINAL (f
)->id
);
936 /* This call is unnecessary, but helps
937 `restore_kboard_configuration' discover if somebody changed
938 `current_kboard' behind our back. */
939 push_kboard (current_kboard
);
942 current_kboard
= FRAME_KBOARD (f
);
944 record_unwind_protect (restore_kboard_configuration
,
945 (was_locked
? Qt
: Qnil
));
948 #if 0 /* This function is not needed anymore. */
950 record_single_kboard_state ()
953 push_kboard (current_kboard
);
954 record_unwind_protect (restore_kboard_configuration
,
955 (single_kboard
? Qt
: Qnil
));
960 restore_kboard_configuration (Lisp_Object was_locked
)
962 if (NILP (was_locked
))
966 struct kboard
*prev
= current_kboard
;
969 /* The pop should not change the kboard. */
970 if (single_kboard
&& current_kboard
!= prev
)
977 /* Handle errors that are not handled at inner levels
978 by printing an error message and returning to the editor command loop. */
981 cmd_error (Lisp_Object data
)
983 Lisp_Object old_level
, old_length
;
986 #ifdef HAVE_WINDOW_SYSTEM
987 if (display_hourglass_p
)
991 if (!NILP (executing_kbd_macro
))
993 if (executing_kbd_macro_iterations
== 1)
994 sprintf (macroerror
, "After 1 kbd macro iteration: ");
996 sprintf (macroerror
, "After %d kbd macro iterations: ",
997 executing_kbd_macro_iterations
);
1002 Vstandard_output
= Qt
;
1003 Vstandard_input
= Qt
;
1004 Vexecuting_kbd_macro
= Qnil
;
1005 executing_kbd_macro
= Qnil
;
1006 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1007 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1010 /* Avoid unquittable loop if data contains a circular list. */
1011 old_level
= Vprint_level
;
1012 old_length
= Vprint_length
;
1013 XSETFASTINT (Vprint_level
, 10);
1014 XSETFASTINT (Vprint_length
, 10);
1015 cmd_error_internal (data
, macroerror
);
1016 Vprint_level
= old_level
;
1017 Vprint_length
= old_length
;
1021 Vinhibit_quit
= Qnil
;
1022 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1023 if (command_loop_level
== 0 && minibuf_level
== 0)
1024 any_kboard_state ();
1027 return make_number (0);
1030 /* Take actions on handling an error. DATA is the data that describes
1033 CONTEXT is a C-string containing ASCII characters only which
1034 describes the context in which the error happened. If we need to
1035 generalize CONTEXT to allow multibyte characters, make it a Lisp
1039 cmd_error_internal (Lisp_Object data
, const char *context
)
1041 struct frame
*sf
= SELECTED_FRAME ();
1043 /* The immediate context is not interesting for Quits,
1044 since they are asyncronous. */
1045 if (EQ (XCAR (data
), Qquit
))
1046 Vsignaling_function
= Qnil
;
1051 /* Use user's specified output function if any. */
1052 if (!NILP (Vcommand_error_function
))
1053 call3 (Vcommand_error_function
, data
,
1054 context
? build_string (context
) : empty_unibyte_string
,
1055 Vsignaling_function
);
1056 /* If the window system or terminal frame hasn't been initialized
1057 yet, or we're not interactive, write the message to stderr and exit. */
1058 else if (!sf
->glyphs_initialized_p
1059 /* The initial frame is a special non-displaying frame. It
1060 will be current in daemon mode when there are no frames
1061 to display, and in non-daemon mode before the real frame
1062 has finished initializing. If an error is thrown in the
1063 latter case while creating the frame, then the frame
1064 will never be displayed, so the safest thing to do is
1065 write to stderr and quit. In daemon mode, there are
1066 many other potential errors that do not prevent frames
1067 from being created, so continuing as normal is better in
1069 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1072 print_error_message (data
, Qexternal_debugging_output
,
1073 context
, Vsignaling_function
);
1074 Fterpri (Qexternal_debugging_output
);
1075 Fkill_emacs (make_number (-1));
1079 clear_message (1, 0);
1081 message_log_maybe_newline ();
1084 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1087 Vsignaling_function
= Qnil
;
1090 Lisp_Object
command_loop_1 (void);
1091 Lisp_Object
command_loop_2 (Lisp_Object
);
1092 Lisp_Object
top_level_1 (Lisp_Object
);
1094 /* Entry to editor-command-loop.
1095 This level has the catches for exiting/returning to editor command loop.
1096 It returns nil to exit recursive edit, t to abort it. */
1101 if (command_loop_level
> 0 || minibuf_level
> 0)
1104 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1105 executing_kbd_macro
= Qnil
;
1111 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1112 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1113 /* Reset single_kboard in case top-level set it while
1114 evaluating an -f option, or we are stuck there for some
1116 any_kboard_state ();
1118 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1119 executing_kbd_macro
= Qnil
;
1121 /* End of file in -batch run causes exit here. */
1127 /* Here we catch errors in execution of commands within the
1128 editing loop, and reenter the editing loop.
1129 When there is an error, cmd_error runs and returns a non-nil
1130 value to us. A value of nil means that command_loop_1 itself
1131 returned due to end of file (or end of kbd macro). */
1134 command_loop_2 (Lisp_Object ignore
)
1136 register Lisp_Object val
;
1139 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1140 while (!NILP (val
));
1148 return Feval (Vtop_level
, Qnil
);
1152 top_level_1 (Lisp_Object ignore
)
1154 /* On entry to the outer level, run the startup file */
1155 if (!NILP (Vtop_level
))
1156 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1157 else if (!NILP (Vpurify_flag
))
1158 message ("Bare impure Emacs (standard Lisp code not loaded)");
1160 message ("Bare Emacs (standard Lisp code not loaded)");
1164 DEFUE ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1165 doc
: /* Exit all recursive editing levels.
1166 This also exits all active minibuffers. */)
1169 #ifdef HAVE_WINDOW_SYSTEM
1170 if (display_hourglass_p
)
1171 cancel_hourglass ();
1174 /* Unblock input if we enter with input blocked. This may happen if
1175 redisplay traps e.g. during tool-bar update with input blocked. */
1176 while (INPUT_BLOCKED_P
)
1179 Fthrow (Qtop_level
, Qnil
);
1182 INFUN (Fexit_recursive_edit
, 0) NO_RETURN
;
1183 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1184 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1187 if (command_loop_level
> 0 || minibuf_level
> 0)
1188 Fthrow (Qexit
, Qnil
);
1190 error ("No recursive edit is in progress");
1193 INFUN (Fabort_recursive_edit
, 0) NO_RETURN
;
1194 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1195 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1198 if (command_loop_level
> 0 || minibuf_level
> 0)
1201 error ("No recursive edit is in progress");
1204 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1206 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1207 of this function. */
1210 tracking_off (Lisp_Object old_value
)
1212 do_mouse_tracking
= old_value
;
1213 if (NILP (old_value
))
1215 /* Redisplay may have been preempted because there was input
1216 available, and it assumes it will be called again after the
1217 input has been processed. If the only input available was
1218 the sort that we have just disabled, then we need to call
1220 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1222 redisplay_preserve_echo_area (6);
1223 get_input_pending (&input_pending
,
1224 READABLE_EVENTS_DO_TIMERS_NOW
);
1230 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1231 doc
: /* Evaluate BODY with mouse movement events enabled.
1232 Within a `track-mouse' form, mouse motion generates input events that
1233 you can read with `read-event'.
1234 Normally, mouse motion is ignored.
1235 usage: (track-mouse BODY...) */)
1238 int count
= SPECPDL_INDEX ();
1241 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1243 do_mouse_tracking
= Qt
;
1245 val
= Fprogn (args
);
1246 return unbind_to (count
, val
);
1249 /* If mouse has moved on some frame, return one of those frames.
1253 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1254 after resizing the tool-bar window. */
1256 int ignore_mouse_drag_p
;
1259 some_mouse_moved (void)
1261 Lisp_Object tail
, frame
;
1263 if (ignore_mouse_drag_p
)
1265 /* ignore_mouse_drag_p = 0; */
1269 FOR_EACH_FRAME (tail
, frame
)
1271 if (XFRAME (frame
)->mouse_moved
)
1272 return XFRAME (frame
);
1278 #endif /* HAVE_MOUSE || HAVE_GPM */
1280 /* This is the actual command reading loop,
1281 sans error-handling encapsulation. */
1283 static int read_key_sequence (Lisp_Object
*, size_t, Lisp_Object
,
1285 void safe_run_hooks (Lisp_Object
);
1286 static void adjust_point_for_property (EMACS_INT
, int);
1288 /* Cancel hourglass from protect_unwind.
1290 #ifdef HAVE_WINDOW_SYSTEM
1292 cancel_hourglass_unwind (Lisp_Object arg
)
1294 cancel_hourglass ();
1299 /* FIXME: This is wrong rather than test window-system, we should call
1300 a new set-selection, which will then dispatch to x-set-selection, or
1301 tty-set-selection, or w32-set-selection, ... */
1302 EXFUN (Fwindow_system
, 1);
1305 command_loop_1 (void)
1308 Lisp_Object keybuf
[30];
1310 int prev_modiff
= 0;
1311 struct buffer
*prev_buffer
= NULL
;
1312 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1313 int was_locked
= single_kboard
;
1315 int already_adjusted
= 0;
1317 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1318 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1319 Vdeactivate_mark
= Qnil
;
1320 waiting_for_input
= 0;
1323 this_command_key_count
= 0;
1324 this_command_key_count_reset
= 0;
1325 this_single_command_key_start
= 0;
1327 if (NILP (Vmemory_full
))
1329 /* Make sure this hook runs after commands that get errors and
1330 throw to top level. */
1331 /* Note that the value cell will never directly contain nil
1332 if the symbol is a local variable. */
1333 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1334 safe_run_hooks (Qpost_command_hook
);
1336 /* If displaying a message, resize the echo area window to fit
1337 that message's size exactly. */
1338 if (!NILP (echo_area_buffer
[0]))
1339 resize_echo_area_exactly ();
1341 if (!NILP (Vdeferred_action_list
))
1342 safe_run_hooks (Qdeferred_action_function
);
1345 /* Do this after running Vpost_command_hook, for consistency. */
1346 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1347 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1348 if (!CONSP (last_command_event
))
1349 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1353 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1356 /* Make sure the current window's buffer is selected. */
1357 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1358 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1360 /* Display any malloc warning that just came out. Use while because
1361 displaying one warning can cause another. */
1363 while (pending_malloc_warning
)
1364 display_malloc_warning ();
1366 Vdeactivate_mark
= Qnil
;
1368 /* If minibuffer on and echo area in use,
1369 wait a short time and redraw minibuffer. */
1372 && !NILP (echo_area_buffer
[0])
1373 && EQ (minibuf_window
, echo_area_window
)
1374 && NUMBERP (Vminibuffer_message_timeout
))
1376 /* Bind inhibit-quit to t so that C-g gets read in
1377 rather than quitting back to the minibuffer. */
1378 int count
= SPECPDL_INDEX ();
1379 specbind (Qinhibit_quit
, Qt
);
1381 sit_for (Vminibuffer_message_timeout
, 0, 2);
1383 /* Clear the echo area. */
1385 safe_run_hooks (Qecho_area_clear_hook
);
1387 unbind_to (count
, Qnil
);
1389 /* If a C-g came in before, treat it as input now. */
1390 if (!NILP (Vquit_flag
))
1393 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1398 /* Select the frame that the last event came from. Usually,
1399 switch-frame events will take care of this, but if some lisp
1400 code swallows a switch-frame event, we'll fix things up here.
1401 Is this a good idea? */
1402 if (FRAMEP (internal_last_event_frame
)
1403 && !EQ (internal_last_event_frame
, selected_frame
))
1404 Fselect_frame (internal_last_event_frame
, Qnil
);
1406 /* If it has changed current-menubar from previous value,
1407 really recompute the menubar from the value. */
1408 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1409 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1410 call0 (Qrecompute_lucid_menubar
);
1412 before_command_key_count
= this_command_key_count
;
1413 before_command_echo_length
= echo_length ();
1415 Vthis_command
= Qnil
;
1416 real_this_command
= Qnil
;
1417 Vthis_original_command
= Qnil
;
1418 Vthis_command_keys_shift_translated
= Qnil
;
1420 /* Read next key sequence; i gets its length. */
1421 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1424 /* A filter may have run while we were reading the input. */
1425 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1427 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1428 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1432 /* Now we have read a key sequence of length I,
1433 or else I is 0 and we found end of file. */
1435 if (i
== 0) /* End of file -- happens only in */
1436 return Qnil
; /* a kbd macro, at the end. */
1437 /* -1 means read_key_sequence got a menu that was rejected.
1438 Just loop around and read another command. */
1442 this_command_key_count
= 0;
1443 this_command_key_count_reset
= 0;
1444 this_single_command_key_start
= 0;
1448 last_command_event
= keybuf
[i
- 1];
1450 /* If the previous command tried to force a specific window-start,
1451 forget about that, in case this command moves point far away
1452 from that position. But also throw away beg_unchanged and
1453 end_unchanged information in that case, so that redisplay will
1454 update the whole window properly. */
1455 if (!NILP (XWINDOW (selected_window
)->force_start
))
1458 XWINDOW (selected_window
)->force_start
= Qnil
;
1459 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1460 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1463 cmd
= read_key_sequence_cmd
;
1464 if (!NILP (Vexecuting_kbd_macro
))
1466 if (!NILP (Vquit_flag
))
1468 Vexecuting_kbd_macro
= Qt
;
1469 QUIT
; /* Make some noise. */
1470 /* Will return since macro now empty. */
1474 /* Do redisplay processing after this command except in special
1475 cases identified below. */
1476 prev_buffer
= current_buffer
;
1477 prev_modiff
= MODIFF
;
1478 last_point_position
= PT
;
1479 last_point_position_window
= selected_window
;
1480 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1482 /* By default, we adjust point to a boundary of a region that
1483 has such a property that should be treated intangible
1484 (e.g. composition, display). But, some commands will set
1485 this variable differently. */
1486 Vdisable_point_adjustment
= Qnil
;
1488 /* Process filters and timers may have messed with deactivate-mark.
1489 reset it before we execute the command. */
1490 Vdeactivate_mark
= Qnil
;
1492 /* Remap command through active keymaps */
1493 Vthis_original_command
= cmd
;
1497 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1501 /* Execute the command. */
1503 Vthis_command
= cmd
;
1504 real_this_command
= cmd
;
1505 safe_run_hooks (Qpre_command_hook
);
1507 already_adjusted
= 0;
1509 if (NILP (Vthis_command
))
1511 /* nil means key is undefined. */
1512 Lisp_Object keys
= Fvector (i
, keybuf
);
1513 keys
= Fkey_description (keys
, Qnil
);
1515 message_with_string ("%s is undefined", keys
, 0);
1516 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1517 update_mode_lines
= 1;
1518 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1522 /* Here for a command that isn't executed directly */
1524 #ifdef HAVE_WINDOW_SYSTEM
1525 int scount
= SPECPDL_INDEX ();
1527 if (display_hourglass_p
1528 && NILP (Vexecuting_kbd_macro
))
1530 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1535 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1537 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1539 #ifdef HAVE_WINDOW_SYSTEM
1540 /* Do not check display_hourglass_p here, because
1541 Fcommand_execute could change it, but we should cancel
1542 hourglass cursor anyway.
1543 But don't cancel the hourglass within a macro
1544 just because a command in the macro finishes. */
1545 if (NILP (Vexecuting_kbd_macro
))
1546 unbind_to (scount
, Qnil
);
1549 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1551 safe_run_hooks (Qpost_command_hook
);
1553 /* If displaying a message, resize the echo area window to fit
1554 that message's size exactly. */
1555 if (!NILP (echo_area_buffer
[0]))
1556 resize_echo_area_exactly ();
1558 safe_run_hooks (Qdeferred_action_function
);
1560 /* If there is a prefix argument,
1561 1) We don't want Vlast_command to be ``universal-argument''
1562 (that would be dumb), so don't set Vlast_command,
1563 2) we want to leave echoing on so that the prefix will be
1564 echoed as part of this key sequence, so don't call
1566 3) we want to leave this_command_key_count non-zero, so that
1567 read_char will realize that it is re-reading a character, and
1568 not echo it a second time.
1570 If the command didn't actually create a prefix arg,
1571 but is merely a frame event that is transparent to prefix args,
1572 then the above doesn't apply. */
1573 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1575 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1576 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1577 if (!CONSP (last_command_event
))
1578 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1580 this_command_key_count
= 0;
1581 this_command_key_count_reset
= 0;
1582 this_single_command_key_start
= 0;
1585 if (!NILP (BVAR (current_buffer
, mark_active
))
1586 && !NILP (Vrun_hooks
))
1588 /* In Emacs 22, setting transient-mark-mode to `only' was a
1589 way of turning it on for just one command. This usage is
1590 obsolete, but support it anyway. */
1591 if (EQ (Vtransient_mark_mode
, Qidentity
))
1592 Vtransient_mark_mode
= Qnil
;
1593 else if (EQ (Vtransient_mark_mode
, Qonly
))
1594 Vtransient_mark_mode
= Qidentity
;
1596 if (!NILP (Vdeactivate_mark
))
1597 /* If `select-active-regions' is non-nil, this call to
1598 `deactivate-mark' also sets the PRIMARY selection. */
1599 call0 (Qdeactivate_mark
);
1602 /* Even if not deactivating the mark, set PRIMARY if
1603 `select-active-regions' is non-nil. */
1604 if (!NILP (Fwindow_system (Qnil
))
1605 /* Even if mark_active is non-nil, the actual buffer
1606 marker may not have been set yet (Bug#7044). */
1607 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1608 && (EQ (Vselect_active_regions
, Qonly
)
1609 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1610 : (!NILP (Vselect_active_regions
)
1611 && !NILP (Vtransient_mark_mode
)))
1612 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1615 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1618 call2 (Qx_set_selection
, QPRIMARY
,
1619 make_buffer_string (beg
, end
, 0));
1621 call2 (Qx_set_selection
, QPRIMARY
,
1622 make_buffer_string (end
, beg
, 0));
1623 /* Don't set empty selections. */
1626 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1628 Lisp_Object hook
= intern ("activate-mark-hook");
1629 Frun_hooks (1, &hook
);
1633 Vsaved_region_selection
= Qnil
;
1638 if (current_buffer
== prev_buffer
1639 && last_point_position
!= PT
1640 && NILP (Vdisable_point_adjustment
)
1641 && NILP (Vglobal_disable_point_adjustment
))
1643 if (last_point_position
> BEGV
1644 && last_point_position
< ZV
1645 && (composition_adjust_point (last_point_position
,
1646 last_point_position
)
1647 != last_point_position
))
1648 /* The last point was temporarily set within a grapheme
1649 cluster to prevent automatic composition. To recover
1650 the automatic composition, we must update the
1652 windows_or_buffers_changed
++;
1653 if (!already_adjusted
)
1654 adjust_point_for_property (last_point_position
,
1655 MODIFF
!= prev_modiff
);
1658 /* Install chars successfully executed in kbd macro. */
1660 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1661 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1662 finalize_kbd_macro_chars ();
1663 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1665 any_kboard_state ();
1670 /* Adjust point to a boundary of a region that has such a property
1671 that should be treated intangible. For the moment, we check
1672 `composition', `display' and `invisible' properties.
1673 LAST_PT is the last position of point. */
1676 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1679 Lisp_Object val
, overlay
, tmp
;
1680 /* When called after buffer modification, we should temporarily
1681 suppress the point adjustment for automatic composition so that a
1682 user can keep inserting another character at point or keep
1683 deleting characters around point. */
1684 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1685 EMACS_INT orig_pt
= PT
;
1687 /* FIXME: cycling is probably not necessary because these properties
1688 can't be usefully combined anyway. */
1689 while (check_composition
|| check_display
|| check_invisible
)
1691 /* FIXME: check `intangible'. */
1692 if (check_composition
1693 && PT
> BEGV
&& PT
< ZV
1694 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1697 check_display
= check_invisible
= 1;
1699 check_composition
= 0;
1701 && PT
> BEGV
&& PT
< ZV
1702 && !NILP (val
= get_char_property_and_overlay
1703 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1704 && display_prop_intangible_p (val
)
1705 && (!OVERLAYP (overlay
)
1706 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1707 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1708 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1709 && (beg
< PT
/* && end > PT <- It's always the case. */
1710 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1713 SET_PT (PT
< last_pt
1714 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1716 check_composition
= check_invisible
= 1;
1719 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1721 int inv
, ellipsis
= 0;
1724 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1727 /* FIXME: We should stop if we find a spot between
1728 two runs of `invisible' where inserted text would
1729 be visible. This is important when we have two
1730 invisible boundaries that enclose an area: if the
1731 area is empty, we need this test in order to make
1732 it possible to place point in the middle rather
1733 than skip both boundaries. However, this code
1734 also stops anywhere in a non-sticky text-property,
1735 which breaks (e.g.) Org mode. */
1736 && (val
= get_pos_property (make_number (end
),
1738 TEXT_PROP_MEANS_INVISIBLE (val
))
1740 && !NILP (val
= get_char_property_and_overlay
1741 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1742 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1744 ellipsis
= ellipsis
|| inv
> 1
1745 || (OVERLAYP (overlay
)
1746 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1747 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1748 tmp
= Fnext_single_char_property_change
1749 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1750 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1754 && (val
= get_pos_property (make_number (beg
),
1756 TEXT_PROP_MEANS_INVISIBLE (val
))
1758 && !NILP (val
= get_char_property_and_overlay
1759 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1760 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1762 ellipsis
= ellipsis
|| inv
> 1
1763 || (OVERLAYP (overlay
)
1764 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1765 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1766 tmp
= Fprevious_single_char_property_change
1767 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1768 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1771 /* Move away from the inside area. */
1772 if (beg
< PT
&& end
> PT
)
1774 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1775 /* We haven't moved yet (so we don't need to fear
1776 infinite-looping) and we were outside the range
1777 before (so either end of the range still corresponds
1778 to a move in the right direction): pretend we moved
1779 less than we actually did, so that we still have
1780 more freedom below in choosing which end of the range
1782 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1783 /* We either have moved already or the last point
1784 was already in the range: we don't get to choose
1785 which end of the range we have to go to. */
1786 : (PT
< last_pt
? beg
: end
));
1787 check_composition
= check_display
= 1;
1789 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1790 the point to something other than its argument, due to
1791 point-motion hooks, intangibility, etc. */
1792 xassert (PT
== beg
|| PT
== end
);
1795 /* Pretend the area doesn't exist if the buffer is not
1797 if (!modified
&& !ellipsis
&& beg
< end
)
1799 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1800 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1801 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1802 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1803 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1804 /* We've already moved as far as we can. Trying to go
1805 to the other end would mean moving backwards and thus
1806 could lead to an infinite loop. */
1808 else if (val
= get_pos_property (make_number (PT
),
1810 TEXT_PROP_MEANS_INVISIBLE (val
)
1811 && (val
= get_pos_property
1812 (make_number (PT
== beg
? end
: beg
),
1814 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1815 (check_composition
= check_display
= 1,
1816 SET_PT (PT
== beg
? end
: beg
));
1819 check_invisible
= 0;
1823 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1826 safe_run_hooks_1 (void)
1828 eassert (CONSP (Vinhibit_quit
));
1829 return call0 (XCDR (Vinhibit_quit
));
1832 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1836 safe_run_hooks_error (Lisp_Object error_data
)
1839 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1840 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1841 Lisp_Object args
[4];
1842 args
[0] = build_string ("Error in %s (%s): %s");
1845 args
[3] = error_data
;
1851 Lisp_Object newval
= Qnil
;
1852 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1853 if (EQ (fun
, XCAR (val
)))
1856 newval
= Fcons (XCAR (val
), newval
);
1858 return Fset (hook
, Fnreverse (newval
));
1859 /* Not found in the local part of the hook. Let's look at the global
1862 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1863 : Fdefault_value (hook
));
1864 CONSP (val
); val
= XCDR (val
))
1865 if (EQ (fun
, XCAR (val
)))
1868 newval
= Fcons (XCAR (val
), newval
);
1870 return Fset_default (hook
, Fnreverse (newval
));
1876 safe_run_hook_funcall (size_t nargs
, Lisp_Object
*args
)
1878 eassert (nargs
== 1);
1879 if (CONSP (Vinhibit_quit
))
1880 XSETCDR (Vinhibit_quit
, args
[0]);
1882 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1884 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1888 /* If we get an error while running the hook, cause the hook variable
1889 to be nil. Also inhibit quits, so that C-g won't cause the hook
1890 to mysteriously evaporate. */
1893 safe_run_hooks (Lisp_Object hook
)
1895 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1896 to its body or to its handlers other than via globals such as
1897 dynamically-bound variables ;-) */
1898 int count
= SPECPDL_INDEX ();
1899 specbind (Qinhibit_quit
, hook
);
1901 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1903 unbind_to (count
, Qnil
);
1907 /* Nonzero means polling for input is temporarily suppressed. */
1909 int poll_suppress_count
;
1911 /* Asynchronous timer for polling. */
1913 struct atimer
*poll_timer
;
1916 #ifdef POLL_FOR_INPUT
1918 /* Poll for input, so that we catch a C-g if it comes in. This
1919 function is called from x_make_frame_visible, see comment
1923 poll_for_input_1 (void)
1925 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1926 doing anything dangerous. */
1930 if (interrupt_input_blocked
== 0
1931 && !waiting_for_input
)
1932 read_avail_input (0);
1938 /* Timer callback function for poll_timer. TIMER is equal to
1942 poll_for_input (struct atimer
*timer
)
1944 if (poll_suppress_count
== 0)
1947 interrupt_input_pending
= 1;
1948 pending_signals
= 1;
1950 poll_for_input_1 ();
1955 #endif /* POLL_FOR_INPUT */
1957 /* Begin signals to poll for input, if they are appropriate.
1958 This function is called unconditionally from various places. */
1961 start_polling (void)
1963 #ifdef POLL_FOR_INPUT
1964 /* XXX This condition was (read_socket_hook && !interrupt_input),
1965 but read_socket_hook is not global anymore. Let's pretend that
1967 if (!interrupt_input
)
1969 /* Turn alarm handling on unconditionally. It might have
1970 been turned off in process.c. */
1971 turn_on_atimers (1);
1973 /* If poll timer doesn't exist, are we need one with
1974 a different interval, start a new one. */
1975 if (poll_timer
== NULL
1976 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1978 EMACS_TIME interval
;
1981 cancel_atimer (poll_timer
);
1983 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1984 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1985 poll_for_input
, NULL
);
1988 /* Let the timer's callback function poll for input
1989 if this becomes zero. */
1990 --poll_suppress_count
;
1995 /* Nonzero if we are using polling to handle input asynchronously. */
1998 input_polling_used (void)
2000 #ifdef POLL_FOR_INPUT
2001 /* XXX This condition was (read_socket_hook && !interrupt_input),
2002 but read_socket_hook is not global anymore. Let's pretend that
2004 return !interrupt_input
;
2010 /* Turn off polling. */
2015 #ifdef POLL_FOR_INPUT
2016 /* XXX This condition was (read_socket_hook && !interrupt_input),
2017 but read_socket_hook is not global anymore. Let's pretend that
2019 if (!interrupt_input
)
2020 ++poll_suppress_count
;
2024 /* Set the value of poll_suppress_count to COUNT
2025 and start or stop polling accordingly. */
2028 set_poll_suppress_count (int count
)
2030 #ifdef POLL_FOR_INPUT
2031 if (count
== 0 && poll_suppress_count
!= 0)
2033 poll_suppress_count
= 1;
2036 else if (count
!= 0 && poll_suppress_count
== 0)
2040 poll_suppress_count
= count
;
2044 /* Bind polling_period to a value at least N.
2045 But don't decrease it. */
2048 bind_polling_period (int n
)
2050 #ifdef POLL_FOR_INPUT
2051 int new = polling_period
;
2056 stop_other_atimers (poll_timer
);
2058 specbind (Qpolling_period
, make_number (new));
2059 /* Start a new alarm with the new period. */
2064 /* Apply the control modifier to CHARACTER. */
2067 make_ctrl_char (int c
)
2069 /* Save the upper bits here. */
2070 int upper
= c
& ~0177;
2072 if (! ASCII_BYTE_P (c
))
2073 return c
|= ctrl_modifier
;
2077 /* Everything in the columns containing the upper-case letters
2078 denotes a control character. */
2079 if (c
>= 0100 && c
< 0140)
2083 /* Set the shift modifier for a control char
2084 made from a shifted letter. But only for letters! */
2085 if (oc
>= 'A' && oc
<= 'Z')
2086 c
|= shift_modifier
;
2089 /* The lower-case letters denote control characters too. */
2090 else if (c
>= 'a' && c
<= 'z')
2093 /* Include the bits for control and shift
2094 only if the basic ASCII code can't indicate them. */
2098 /* Replace the high bits. */
2099 c
|= (upper
& ~ctrl_modifier
);
2104 /* Display the help-echo property of the character after the mouse pointer.
2105 Either show it in the echo area, or call show-help-function to display
2106 it by other means (maybe in a tooltip).
2108 If HELP is nil, that means clear the previous help echo.
2110 If HELP is a string, display that string. If HELP is a function,
2111 call it with OBJECT and POS as arguments; the function should
2112 return a help string or nil for none. For all other types of HELP,
2113 evaluate it to obtain a string.
2115 WINDOW is the window in which the help was generated, if any.
2116 It is nil if not in a window.
2118 If OBJECT is a buffer, POS is the position in the buffer where the
2119 `help-echo' text property was found.
2121 If OBJECT is an overlay, that overlay has a `help-echo' property,
2122 and POS is the position in the overlay's buffer under the mouse.
2124 If OBJECT is a string (an overlay string or a string displayed with
2125 the `display' property). POS is the position in that string under
2128 Note: this function may only be called with HELP nil or a string
2129 from X code running asynchronously. */
2132 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2135 if (!NILP (help
) && !STRINGP (help
))
2137 if (FUNCTIONP (help
))
2139 Lisp_Object args
[4];
2144 help
= safe_call (4, args
);
2147 help
= safe_eval (help
);
2149 if (!STRINGP (help
))
2153 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2154 if (!noninteractive
&& STRINGP (help
))
2156 /* The mouse-fixup-help-message Lisp function can call
2157 mouse_position_hook, which resets the mouse_moved flags.
2158 This causes trouble if we are trying to read a mouse motion
2159 event (i.e., if we are inside a `track-mouse' form), so we
2160 restore the mouse_moved flag. */
2161 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2162 help
= call1 (Qmouse_fixup_help_message
, help
);
2168 if (STRINGP (help
) || NILP (help
))
2170 if (!NILP (Vshow_help_function
))
2171 call1 (Vshow_help_function
, help
);
2172 help_echo_showing_p
= STRINGP (help
);
2178 /* Input of single characters from keyboard */
2180 Lisp_Object
print_help (Lisp_Object object
);
2181 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2182 struct timeval
*end_time
);
2183 static void record_char (Lisp_Object c
);
2185 static Lisp_Object help_form_saved_window_configs
;
2187 read_char_help_form_unwind (Lisp_Object arg
)
2189 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2190 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2191 if (!NILP (window_config
))
2192 Fset_window_configuration (window_config
);
2196 #define STOP_POLLING \
2197 do { if (! polling_stopped_here) stop_polling (); \
2198 polling_stopped_here = 1; } while (0)
2200 #define RESUME_POLLING \
2201 do { if (polling_stopped_here) start_polling (); \
2202 polling_stopped_here = 0; } while (0)
2204 /* read a character from the keyboard; call the redisplay if needed */
2205 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2206 -1 means do not do redisplay, but do do autosaving.
2209 /* The arguments MAPS and NMAPS are for menu prompting.
2210 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2212 PREV_EVENT is the previous input event, or nil if we are reading
2213 the first event of a key sequence (or not reading a key sequence).
2214 If PREV_EVENT is t, that is a "magic" value that says
2215 not to run input methods, but in other respects to act as if
2216 not reading a key sequence.
2218 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2219 if we used a mouse menu to read the input, or zero otherwise. If
2220 USED_MOUSE_MENU is null, we don't dereference it.
2222 Value is -2 when we find input on another keyboard. A second call
2223 to read_char will read it.
2225 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2226 specifying the maximum time to wait until. If no input arrives by
2227 that time, stop waiting and return nil.
2229 Value is t if we showed a menu and the user rejected it. */
2232 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2233 int *used_mouse_menu
, struct timeval
*end_time
)
2235 volatile Lisp_Object c
;
2237 jmp_buf local_getcjmp
;
2239 volatile int key_already_recorded
= 0;
2240 Lisp_Object tem
, save
;
2241 volatile Lisp_Object previous_echo_area_message
;
2242 volatile Lisp_Object also_record
;
2243 volatile int reread
;
2244 struct gcpro gcpro1
, gcpro2
;
2245 int polling_stopped_here
= 0;
2246 struct kboard
*orig_kboard
= current_kboard
;
2250 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2251 before_command_key_count
= this_command_key_count
;
2252 before_command_echo_length
= echo_length ();
2255 previous_echo_area_message
= Qnil
;
2257 GCPRO2 (c
, previous_echo_area_message
);
2262 if (CONSP (Vunread_post_input_method_events
))
2264 c
= XCAR (Vunread_post_input_method_events
);
2265 Vunread_post_input_method_events
2266 = XCDR (Vunread_post_input_method_events
);
2268 /* Undo what read_char_x_menu_prompt did when it unread
2269 additional keys returned by Fx_popup_menu. */
2271 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2279 if (unread_command_char
!= -1)
2281 XSETINT (c
, unread_command_char
);
2282 unread_command_char
= -1;
2288 if (CONSP (Vunread_command_events
))
2290 int was_disabled
= 0;
2292 c
= XCAR (Vunread_command_events
);
2293 Vunread_command_events
= XCDR (Vunread_command_events
);
2297 /* Undo what sit-for did when it unread additional keys
2298 inside universal-argument. */
2301 && EQ (XCAR (c
), Qt
))
2307 /* Undo what read_char_x_menu_prompt did when it unread
2308 additional keys returned by Fx_popup_menu. */
2310 && EQ (XCDR (c
), Qdisabled
)
2311 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2317 /* If the queued event is something that used the mouse,
2318 set used_mouse_menu accordingly. */
2320 /* Also check was_disabled so last-nonmenu-event won't return
2321 a bad value when submenus are involved. (Bug#447) */
2322 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2323 *used_mouse_menu
= 1;
2325 goto reread_for_input_method
;
2328 if (CONSP (Vunread_input_method_events
))
2330 c
= XCAR (Vunread_input_method_events
);
2331 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2333 /* Undo what read_char_x_menu_prompt did when it unread
2334 additional keys returned by Fx_popup_menu. */
2336 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2340 goto reread_for_input_method
;
2343 this_command_key_count_reset
= 0;
2345 if (!NILP (Vexecuting_kbd_macro
))
2347 /* We set this to Qmacro; since that's not a frame, nobody will
2348 try to switch frames on us, and the selected window will
2351 Since this event came from a macro, it would be misleading to
2352 leave internal_last_event_frame set to wherever the last
2353 real event came from. Normally, a switch-frame event selects
2354 internal_last_event_frame after each command is read, but
2355 events read from a macro should never cause a new frame to be
2357 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2359 /* Exit the macro if we are at the end.
2360 Also, some things replace the macro with t
2361 to force an early exit. */
2362 if (EQ (Vexecuting_kbd_macro
, Qt
)
2363 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2369 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2370 if (STRINGP (Vexecuting_kbd_macro
)
2371 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2372 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2374 executing_kbd_macro_index
++;
2379 if (!NILP (unread_switch_frame
))
2381 c
= unread_switch_frame
;
2382 unread_switch_frame
= Qnil
;
2384 /* This event should make it into this_command_keys, and get echoed
2385 again, so we do not set `reread'. */
2389 /* if redisplay was requested */
2390 if (commandflag
>= 0)
2392 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2394 /* If there is pending input, process any events which are not
2395 user-visible, such as X selection_request events. */
2397 || detect_input_pending_run_timers (0))
2398 swallow_events (0); /* may clear input_pending */
2400 /* Redisplay if no pending input. */
2401 while (!input_pending
)
2403 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2404 redisplay_preserve_echo_area (5);
2409 /* Normal case: no input arrived during redisplay. */
2412 /* Input arrived and pre-empted redisplay.
2413 Process any events which are not user-visible. */
2415 /* If that cleared input_pending, try again to redisplay. */
2418 /* Prevent the redisplay we just did
2419 from messing up echoing of the input after the prompt. */
2420 if (commandflag
== 0 && echo_current
)
2421 echo_message_buffer
= echo_area_buffer
[0];
2425 /* Message turns off echoing unless more keystrokes turn it on again.
2427 The code in 20.x for the condition was
2429 1. echo_area_glyphs && *echo_area_glyphs
2430 2. && echo_area_glyphs != current_kboard->echobuf
2431 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2433 (1) means there's a current message displayed
2435 (2) means it's not the message from echoing from the current
2438 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2439 is set to a non-null value. This is done in read_char and it is
2440 set to echo_area_glyphs after a call to echo_char. That means
2441 ok_to_echo_at_next_pause is either null or
2442 current_kboard->echobuf with the appropriate current_kboard at
2445 So, condition (3) means in clear text ok_to_echo_at_next_pause
2446 must be either null, or the current message isn't from echoing at
2447 all, or it's from echoing from a different kboard than the
2450 if (/* There currently is something in the echo area. */
2451 !NILP (echo_area_buffer
[0])
2452 && (/* And it's either not from echoing. */
2453 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2454 /* Or it's an echo from a different kboard. */
2455 || echo_kboard
!= current_kboard
2456 /* Or we explicitly allow overwriting whatever there is. */
2457 || ok_to_echo_at_next_pause
== NULL
))
2462 /* Try reading a character via menu prompting in the minibuf.
2463 Try this before the sit-for, because the sit-for
2464 would do the wrong thing if we are supposed to do
2465 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2466 after a mouse event so don't try a minibuf menu. */
2468 if (nmaps
> 0 && INTERACTIVE
2469 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2470 /* Don't bring up a menu if we already have another event. */
2471 && NILP (Vunread_command_events
)
2472 && unread_command_char
< 0
2473 && !detect_input_pending_run_timers (0))
2475 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2477 if (INTEGERP (c
) && XINT (c
) == -2)
2478 return c
; /* wrong_kboard_jmpbuf */
2482 key_already_recorded
= 1;
2487 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2488 We will do that below, temporarily for short sections of code,
2489 when appropriate. local_getcjmp must be in effect
2490 around any call to sit_for or kbd_buffer_get_event;
2491 it *must not* be in effect when we call redisplay. */
2493 jmpcount
= SPECPDL_INDEX ();
2494 if (_setjmp (local_getcjmp
))
2496 /* Handle quits while reading the keyboard. */
2497 /* We must have saved the outer value of getcjmp here,
2498 so restore it now. */
2499 restore_getcjmp (save_jump
);
2500 unbind_to (jmpcount
, Qnil
);
2501 XSETINT (c
, quit_char
);
2502 internal_last_event_frame
= selected_frame
;
2503 Vlast_event_frame
= internal_last_event_frame
;
2504 /* If we report the quit char as an event,
2505 don't do so more than once. */
2506 if (!NILP (Vinhibit_quit
))
2510 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2511 if (kb
!= current_kboard
)
2513 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2514 /* We shouldn't get here if we were in single-kboard mode! */
2519 while (CONSP (XCDR (last
)))
2521 if (!NILP (XCDR (last
)))
2525 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2527 XSETCDR (last
, Fcons (c
, Qnil
));
2528 kb
->kbd_queue_has_data
= 1;
2529 current_kboard
= kb
;
2530 /* This is going to exit from read_char
2531 so we had better get rid of this frame's stuff. */
2533 return make_number (-2); /* wrong_kboard_jmpbuf */
2539 /* Start idle timers if no time limit is supplied. We don't do it
2540 if a time limit is supplied to avoid an infinite recursion in the
2541 situation where an idle timer calls `sit-for'. */
2544 timer_start_idle ();
2546 /* If in middle of key sequence and minibuffer not active,
2547 start echoing if enough time elapses. */
2549 if (minibuf_level
== 0
2551 && !current_kboard
->immediate_echo
2552 && this_command_key_count
> 0
2554 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2555 && NILP (Fzerop (Vecho_keystrokes
))
2556 && (/* No message. */
2557 NILP (echo_area_buffer
[0])
2558 /* Or empty message. */
2559 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2560 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2561 /* Or already echoing from same kboard. */
2562 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2563 /* Or not echoing before and echoing allowed. */
2564 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2566 /* After a mouse event, start echoing right away.
2567 This is because we are probably about to display a menu,
2568 and we don't want to delay before doing so. */
2569 if (EVENT_HAS_PARAMETERS (prev_event
))
2575 save_getcjmp (save_jump
);
2576 restore_getcjmp (local_getcjmp
);
2577 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2578 restore_getcjmp (save_jump
);
2580 && ! CONSP (Vunread_command_events
))
2585 /* Maybe auto save due to number of keystrokes. */
2587 if (commandflag
!= 0
2588 && auto_save_interval
> 0
2589 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2590 && !detect_input_pending_run_timers (0))
2592 Fdo_auto_save (Qnil
, Qnil
);
2593 /* Hooks can actually change some buffers in auto save. */
2597 /* Try reading using an X menu.
2598 This is never confused with reading using the minibuf
2599 because the recursive call of read_char in read_char_minibuf_menu_prompt
2600 does not pass on any keymaps. */
2602 if (nmaps
> 0 && INTERACTIVE
2603 && !NILP (prev_event
)
2604 && EVENT_HAS_PARAMETERS (prev_event
)
2605 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2606 && !EQ (XCAR (prev_event
), Qtool_bar
)
2607 /* Don't bring up a menu if we already have another event. */
2608 && NILP (Vunread_command_events
)
2609 && unread_command_char
< 0)
2611 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2613 /* Now that we have read an event, Emacs is not idle. */
2620 /* Maybe autosave and/or garbage collect due to idleness. */
2622 if (INTERACTIVE
&& NILP (c
))
2625 EMACS_INT buffer_size
;
2627 /* Slow down auto saves logarithmically in size of current buffer,
2628 and garbage collect while we're at it. */
2629 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2630 last_non_minibuf_size
= Z
- BEG
;
2631 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2633 while (buffer_size
> 64)
2634 delay_level
++, buffer_size
-= buffer_size
>> 2;
2635 if (delay_level
< 4) delay_level
= 4;
2636 /* delay_level is 4 for files under around 50k, 7 at 100k,
2637 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2639 /* Auto save if enough time goes by without input. */
2640 if (commandflag
!= 0
2641 && num_nonmacro_input_events
> last_auto_save
2642 && INTEGERP (Vauto_save_timeout
)
2643 && XINT (Vauto_save_timeout
) > 0)
2646 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2648 save_getcjmp (save_jump
);
2649 restore_getcjmp (local_getcjmp
);
2650 tem0
= sit_for (make_number (timeout
), 1, 1);
2651 restore_getcjmp (save_jump
);
2654 && ! CONSP (Vunread_command_events
))
2656 Fdo_auto_save (Qnil
, Qnil
);
2658 /* If we have auto-saved and there is still no input
2659 available, garbage collect if there has been enough
2660 consing going on to make it worthwhile. */
2661 if (!detect_input_pending_run_timers (0)
2662 && consing_since_gc
> gc_cons_threshold
/ 2)
2663 Fgarbage_collect ();
2670 /* Notify the caller if an autosave hook, or a timer, sentinel or
2671 filter in the sit_for calls above have changed the current
2672 kboard. This could happen if they use the minibuffer or start a
2673 recursive edit, like the fancy splash screen in server.el's
2674 filter. If this longjmp wasn't here, read_key_sequence would
2675 interpret the next key sequence using the wrong translation
2676 tables and function keymaps. */
2677 if (NILP (c
) && current_kboard
!= orig_kboard
)
2680 return make_number (-2); /* wrong_kboard_jmpbuf */
2683 /* If this has become non-nil here, it has been set by a timer
2684 or sentinel or filter. */
2685 if (CONSP (Vunread_command_events
))
2687 c
= XCAR (Vunread_command_events
);
2688 Vunread_command_events
= XCDR (Vunread_command_events
);
2691 /* Read something from current KBOARD's side queue, if possible. */
2695 if (current_kboard
->kbd_queue_has_data
)
2697 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2699 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2700 KVAR (current_kboard
, kbd_queue
)
2701 = XCDR (KVAR (current_kboard
, kbd_queue
));
2702 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2703 current_kboard
->kbd_queue_has_data
= 0;
2704 input_pending
= readable_events (0);
2705 if (EVENT_HAS_PARAMETERS (c
)
2706 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2707 internal_last_event_frame
= XCAR (XCDR (c
));
2708 Vlast_event_frame
= internal_last_event_frame
;
2712 /* If current_kboard's side queue is empty check the other kboards.
2713 If one of them has data that we have not yet seen here,
2714 switch to it and process the data waiting for it.
2716 Note: if the events queued up for another kboard
2717 have already been seen here, and therefore are not a complete command,
2718 the kbd_queue_has_data field is 0, so we skip that kboard here.
2719 That's to avoid an infinite loop switching between kboards here. */
2720 if (NILP (c
) && !single_kboard
)
2723 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2724 if (kb
->kbd_queue_has_data
)
2726 current_kboard
= kb
;
2727 /* This is going to exit from read_char
2728 so we had better get rid of this frame's stuff. */
2730 return make_number (-2); /* wrong_kboard_jmpbuf */
2738 /* Finally, we read from the main queue,
2739 and if that gives us something we can't use yet, we put it on the
2740 appropriate side queue and try again. */
2744 KBOARD
*kb
IF_LINT (= NULL
);
2749 EMACS_GET_TIME (now
);
2750 if (EMACS_TIME_GE (now
, *end_time
))
2754 /* Actually read a character, waiting if necessary. */
2755 save_getcjmp (save_jump
);
2756 restore_getcjmp (local_getcjmp
);
2758 timer_start_idle ();
2759 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2760 restore_getcjmp (save_jump
);
2762 if (! NILP (c
) && (kb
!= current_kboard
))
2764 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2767 while (CONSP (XCDR (last
)))
2769 if (!NILP (XCDR (last
)))
2773 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2775 XSETCDR (last
, Fcons (c
, Qnil
));
2776 kb
->kbd_queue_has_data
= 1;
2780 current_kboard
= kb
;
2781 /* This is going to exit from read_char
2782 so we had better get rid of this frame's stuff. */
2784 return make_number (-2);
2788 /* Terminate Emacs in batch mode if at eof. */
2789 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2790 Fkill_emacs (make_number (1));
2794 /* Add in any extra modifiers, where appropriate. */
2795 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2796 || ((extra_keyboard_modifiers
& 0177) < ' '
2797 && (extra_keyboard_modifiers
& 0177) != 0))
2798 XSETINT (c
, make_ctrl_char (XINT (c
)));
2800 /* Transfer any other modifier bits directly from
2801 extra_keyboard_modifiers to c. Ignore the actual character code
2802 in the low 16 bits of extra_keyboard_modifiers. */
2803 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2814 if (commandflag
>= 0
2815 && !input_pending
&& !detect_input_pending_run_timers (0))
2823 /* Buffer switch events are only for internal wakeups
2824 so don't show them to the user.
2825 Also, don't record a key if we already did. */
2826 if (BUFFERP (c
) || key_already_recorded
)
2829 /* Process special events within read_char
2830 and loop around to read another event. */
2833 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2838 struct buffer
*prev_buffer
= current_buffer
;
2839 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2840 int was_locked
= single_kboard
;
2841 int count
= SPECPDL_INDEX ();
2842 record_single_kboard_state ();
2845 last_input_event
= c
;
2846 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2848 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2849 /* We stopped being idle for this event; undo that. This
2850 prevents automatic window selection (under
2851 mouse_autoselect_window from acting as a real input event, for
2852 example banishing the mouse under mouse-avoidance-mode. */
2853 timer_resume_idle ();
2855 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2856 /* Resume allowing input from any kboard, if that was true before. */
2858 any_kboard_state ();
2859 unbind_to (count
, Qnil
);
2862 if (current_buffer
!= prev_buffer
)
2864 /* The command may have changed the keymaps. Pretend there
2865 is input in another keyboard and return. This will
2866 recalculate keymaps. */
2867 c
= make_number (-2);
2874 /* Handle things that only apply to characters. */
2877 /* If kbd_buffer_get_event gave us an EOF, return that. */
2881 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2882 && SCHARS (KVAR (current_kboard
, Vkeyboard_translate_table
)) > (unsigned) XFASTINT (c
))
2883 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2884 && XVECTOR (KVAR (current_kboard
, Vkeyboard_translate_table
))->size
> (unsigned) XFASTINT (c
))
2885 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2889 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2890 /* nil in keyboard-translate-table means no translation. */
2896 /* If this event is a mouse click in the menu bar,
2897 return just menu-bar for now. Modify the mouse click event
2898 so we won't do this twice, then queue it up. */
2899 if (EVENT_HAS_PARAMETERS (c
)
2901 && CONSP (EVENT_START (c
))
2902 && CONSP (XCDR (EVENT_START (c
))))
2906 posn
= POSN_POSN (EVENT_START (c
));
2907 /* Handle menu-bar events:
2908 insert the dummy prefix event `menu-bar'. */
2909 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2911 /* Change menu-bar to (menu-bar) as the event "position". */
2912 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2915 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2920 /* Store these characters into recent_keys, the dribble file if any,
2921 and the keyboard macro being defined, if any. */
2923 if (! NILP (also_record
))
2924 record_char (also_record
);
2926 /* Wipe the echo area.
2927 But first, if we are about to use an input method,
2928 save the echo area contents for it to refer to. */
2930 && ! NILP (Vinput_method_function
)
2931 && (unsigned) XINT (c
) >= ' '
2932 && (unsigned) XINT (c
) != 127
2933 && (unsigned) XINT (c
) < 256)
2935 previous_echo_area_message
= Fcurrent_message ();
2936 Vinput_method_previous_message
= previous_echo_area_message
;
2939 /* Now wipe the echo area, except for help events which do their
2940 own stuff with the echo area. */
2942 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2943 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2945 if (!NILP (echo_area_buffer
[0]))
2946 safe_run_hooks (Qecho_area_clear_hook
);
2947 clear_message (1, 0);
2950 reread_for_input_method
:
2952 /* Pass this to the input method, if appropriate. */
2954 && ! NILP (Vinput_method_function
)
2955 /* Don't run the input method within a key sequence,
2956 after the first event of the key sequence. */
2957 && NILP (prev_event
)
2958 && (unsigned) XINT (c
) >= ' '
2959 && (unsigned) XINT (c
) != 127
2960 && (unsigned) XINT (c
) < 256)
2963 int key_count
, key_count_reset
;
2964 struct gcpro inner_gcpro1
;
2965 int count
= SPECPDL_INDEX ();
2967 /* Save the echo status. */
2968 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2969 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2970 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2971 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2974 if (before_command_restore_flag
)
2976 this_command_key_count
= before_command_key_count_1
;
2977 if (this_command_key_count
< this_single_command_key_start
)
2978 this_single_command_key_start
= this_command_key_count
;
2979 echo_truncate (before_command_echo_length_1
);
2980 before_command_restore_flag
= 0;
2984 /* Save the this_command_keys status. */
2985 key_count
= this_command_key_count
;
2986 key_count_reset
= this_command_key_count_reset
;
2989 keys
= Fcopy_sequence (this_command_keys
);
2992 GCPRO1_VAR (keys
, inner_gcpro
);
2994 /* Clear out this_command_keys. */
2995 this_command_key_count
= 0;
2996 this_command_key_count_reset
= 0;
2998 /* Now wipe the echo area. */
2999 if (!NILP (echo_area_buffer
[0]))
3000 safe_run_hooks (Qecho_area_clear_hook
);
3001 clear_message (1, 0);
3004 /* If we are not reading a key sequence,
3005 never use the echo area. */
3008 specbind (Qinput_method_use_echo_area
, Qt
);
3011 /* Call the input method. */
3012 tem
= call1 (Vinput_method_function
, c
);
3014 tem
= unbind_to (count
, tem
);
3016 /* Restore the saved echoing state
3017 and this_command_keys state. */
3018 this_command_key_count
= key_count
;
3019 this_command_key_count_reset
= key_count_reset
;
3021 this_command_keys
= keys
;
3024 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3025 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3026 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3027 if (saved_immediate_echo
)
3030 UNGCPRO_VAR (inner_gcpro
);
3032 /* The input method can return no events. */
3035 /* Bring back the previous message, if any. */
3036 if (! NILP (previous_echo_area_message
))
3037 message_with_string ("%s", previous_echo_area_message
, 0);
3040 /* It returned one event or more. */
3042 Vunread_post_input_method_events
3043 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3048 /* Display help if not echoing. */
3049 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3051 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3052 Lisp_Object help
, object
, position
, window
, htem
;
3054 htem
= Fcdr (XCDR (c
));
3057 window
= Fcar (htem
);
3059 object
= Fcar (htem
);
3061 position
= Fcar (htem
);
3063 show_help_echo (help
, window
, object
, position
);
3065 /* We stopped being idle for this event; undo that. */
3067 timer_resume_idle ();
3071 if ((! reread
|| this_command_key_count
== 0
3072 || this_command_key_count_reset
)
3076 /* Don't echo mouse motion events. */
3077 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3078 && NILP (Fzerop (Vecho_keystrokes
))
3079 && ! (EVENT_HAS_PARAMETERS (c
)
3080 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3083 if (! NILP (also_record
))
3084 echo_char (also_record
);
3085 /* Once we reread a character, echoing can happen
3086 the next time we pause to read a new one. */
3087 ok_to_echo_at_next_pause
= current_kboard
;
3090 /* Record this character as part of the current key. */
3091 add_command_key (c
);
3092 if (! NILP (also_record
))
3093 add_command_key (also_record
);
3096 last_input_event
= c
;
3099 /* Process the help character specially if enabled */
3100 if (!NILP (Vhelp_form
) && help_char_p (c
))
3102 int count
= SPECPDL_INDEX ();
3104 help_form_saved_window_configs
3105 = Fcons (Fcurrent_window_configuration (Qnil
),
3106 help_form_saved_window_configs
);
3107 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3108 call0 (Qhelp_form_show
);
3113 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3114 if (EVENT_HAS_PARAMETERS (c
)
3115 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3116 XSETCAR (help_form_saved_window_configs
, Qnil
);
3118 while (BUFFERP (c
));
3119 /* Remove the help from the frame */
3120 unbind_to (count
, Qnil
);
3123 if (EQ (c
, make_number (040)))
3127 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3128 while (BUFFERP (c
));
3137 /* Record a key that came from a mouse menu.
3138 Record it for echoing, for this-command-keys, and so on. */
3141 record_menu_key (Lisp_Object c
)
3143 /* Wipe the echo area. */
3144 clear_message (1, 0);
3149 before_command_key_count
= this_command_key_count
;
3150 before_command_echo_length
= echo_length ();
3153 /* Don't echo mouse motion events. */
3154 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3155 && NILP (Fzerop (Vecho_keystrokes
)))
3159 /* Once we reread a character, echoing can happen
3160 the next time we pause to read a new one. */
3161 ok_to_echo_at_next_pause
= 0;
3164 /* Record this character as part of the current key. */
3165 add_command_key (c
);
3167 /* Re-reading in the middle of a command */
3168 last_input_event
= c
;
3172 /* Return 1 if should recognize C as "the help character". */
3175 help_char_p (Lisp_Object c
)
3179 if (EQ (c
, Vhelp_char
))
3181 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3182 if (EQ (c
, XCAR (tail
)))
3187 /* Record the input event C in various ways. */
3190 record_char (Lisp_Object c
)
3194 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3196 /* To avoid filling recent_keys with help-echo and mouse-movement
3197 events, we filter out repeated help-echo events, only store the
3198 first and last in a series of mouse-movement events, and don't
3199 store repeated help-echo events which are only separated by
3200 mouse-movement events. */
3202 Lisp_Object ev1
, ev2
, ev3
;
3205 if ((ix1
= recent_keys_index
- 1) < 0)
3206 ix1
= NUM_RECENT_KEYS
- 1;
3207 ev1
= AREF (recent_keys
, ix1
);
3209 if ((ix2
= ix1
- 1) < 0)
3210 ix2
= NUM_RECENT_KEYS
- 1;
3211 ev2
= AREF (recent_keys
, ix2
);
3213 if ((ix3
= ix2
- 1) < 0)
3214 ix3
= NUM_RECENT_KEYS
- 1;
3215 ev3
= AREF (recent_keys
, ix3
);
3217 if (EQ (XCAR (c
), Qhelp_echo
))
3219 /* Don't record `help-echo' in recent_keys unless it shows some help
3220 message, and a different help than the previously recorded
3222 Lisp_Object help
, last_help
;
3224 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3225 if (!STRINGP (help
))
3227 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3228 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3230 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3231 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3232 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3234 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3235 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3236 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3237 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3240 else if (EQ (XCAR (c
), Qmouse_movement
))
3242 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3243 So additional mouse movement events replace the last element. */
3244 Lisp_Object last_window
, window
;
3246 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3247 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3248 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3249 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3250 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3252 ASET (recent_keys
, ix1
, c
);
3258 store_kbd_macro_char (c
);
3263 ASET (recent_keys
, recent_keys_index
, c
);
3264 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3265 recent_keys_index
= 0;
3267 else if (recorded
< 0)
3269 /* We need to remove one or two events from recent_keys.
3270 To do this, we simply put nil at those events and move the
3271 recent_keys_index backwards over those events. Usually,
3272 users will never see those nil events, as they will be
3273 overwritten by the command keys entered to see recent_keys
3276 while (recorded
++ < 0 && total_keys
> 0)
3278 if (total_keys
< NUM_RECENT_KEYS
)
3280 if (--recent_keys_index
< 0)
3281 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3282 ASET (recent_keys
, recent_keys_index
, Qnil
);
3286 num_nonmacro_input_events
++;
3288 /* Write c to the dribble file. If c is a lispy event, write
3289 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3290 If you, dear reader, have a better idea, you've got the source. :-) */
3296 if (XUINT (c
) < 0x100)
3297 putc (XINT (c
), dribble
);
3299 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3303 Lisp_Object dribblee
;
3305 /* If it's a structured event, take the event header. */
3306 dribblee
= EVENT_HEAD (c
);
3308 if (SYMBOLP (dribblee
))
3310 putc ('<', dribble
);
3311 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3312 SBYTES (SYMBOL_NAME (dribblee
)),
3314 putc ('>', dribble
);
3324 print_help (Lisp_Object object
)
3326 struct buffer
*old
= current_buffer
;
3327 Fprinc (object
, Qnil
);
3328 set_buffer_internal (XBUFFER (Vstandard_output
));
3329 call0 (intern ("help-mode"));
3330 set_buffer_internal (old
);
3334 /* Copy out or in the info on where C-g should throw to.
3335 This is used when running Lisp code from within get_char,
3336 in case get_char is called recursively.
3337 See read_process_output. */
3340 save_getcjmp (jmp_buf temp
)
3342 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3346 restore_getcjmp (jmp_buf temp
)
3348 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3351 /* Low level keyboard/mouse input.
3352 kbd_buffer_store_event places events in kbd_buffer, and
3353 kbd_buffer_get_event retrieves them. */
3355 /* Return true if there are any events in the queue that read-char
3356 would return. If this returns false, a read-char would block. */
3358 readable_events (int flags
)
3360 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3363 /* If the buffer contains only FOCUS_IN_EVENT events, and
3364 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3365 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3367 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3368 #ifdef USE_TOOLKIT_SCROLL_BARS
3369 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3373 struct input_event
*event
;
3375 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3382 #ifdef USE_TOOLKIT_SCROLL_BARS
3383 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3385 event
->kind
== FOCUS_IN_EVENT
)
3386 #ifdef USE_TOOLKIT_SCROLL_BARS
3387 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3388 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3389 && event
->part
== scroll_bar_handle
3390 && event
->modifiers
== 0)
3395 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3398 while (event
!= kbd_store_ptr
);
3404 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3405 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3406 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3411 if (current_kboard
->kbd_queue_has_data
)
3417 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3418 if (kb
->kbd_queue_has_data
)
3424 /* Set this for debugging, to have a way to get out */
3428 event_to_kboard (struct input_event
*event
)
3431 frame
= event
->frame_or_window
;
3433 frame
= XCAR (frame
);
3434 else if (WINDOWP (frame
))
3435 frame
= WINDOW_FRAME (XWINDOW (frame
));
3437 /* There are still some events that don't set this field.
3438 For now, just ignore the problem.
3439 Also ignore dead frames here. */
3440 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3443 return FRAME_KBOARD (XFRAME (frame
));
3447 /* Return the number of slots occupied in kbd_buffer. */
3450 kbd_buffer_nr_stored (void)
3452 return kbd_fetch_ptr
== kbd_store_ptr
3454 : (kbd_fetch_ptr
< kbd_store_ptr
3455 ? kbd_store_ptr
- kbd_fetch_ptr
3456 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3457 + (kbd_store_ptr
- kbd_buffer
)));
3459 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3462 kbd_buffer_store_event (register struct input_event
*event
)
3464 kbd_buffer_store_event_hold (event
, 0);
3467 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3469 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3470 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3471 Else, if EVENT is a quit event, store the quit event
3472 in HOLD_QUIT, and return (thus ignoring further events).
3474 This is used in read_avail_input to postpone the processing
3475 of the quit event until all subsequent input events have been
3476 parsed (and discarded).
3480 kbd_buffer_store_event_hold (register struct input_event
*event
,
3481 struct input_event
*hold_quit
)
3483 if (event
->kind
== NO_EVENT
)
3486 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3489 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3491 register int c
= event
->code
& 0377;
3493 if (event
->modifiers
& ctrl_modifier
)
3494 c
= make_ctrl_char (c
);
3496 c
|= (event
->modifiers
3497 & (meta_modifier
| alt_modifier
3498 | hyper_modifier
| super_modifier
));
3502 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3503 struct input_event
*sp
;
3505 if (single_kboard
&& kb
!= current_kboard
)
3507 KVAR (kb
, kbd_queue
)
3508 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3509 Fcons (make_number (c
), Qnil
));
3510 kb
->kbd_queue_has_data
= 1;
3511 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3513 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3516 if (event_to_kboard (sp
) == kb
)
3518 sp
->kind
= NO_EVENT
;
3519 sp
->frame_or_window
= Qnil
;
3528 memcpy (hold_quit
, event
, sizeof (*event
));
3532 /* If this results in a quit_char being returned to Emacs as
3533 input, set Vlast_event_frame properly. If this doesn't
3534 get returned to Emacs as an event, the next event read
3535 will set Vlast_event_frame again, so this is safe to do. */
3539 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3541 focus
= event
->frame_or_window
;
3542 internal_last_event_frame
= focus
;
3543 Vlast_event_frame
= focus
;
3546 last_event_timestamp
= event
->timestamp
;
3547 handle_interrupt ();
3551 if (c
&& c
== stop_character
)
3557 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3558 Just ignore the second one. */
3559 else if (event
->kind
== BUFFER_SWITCH_EVENT
3560 && kbd_fetch_ptr
!= kbd_store_ptr
3561 && ((kbd_store_ptr
== kbd_buffer
3562 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3563 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3566 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3567 kbd_store_ptr
= kbd_buffer
;
3569 /* Don't let the very last slot in the buffer become full,
3570 since that would make the two pointers equal,
3571 and that is indistinguishable from an empty buffer.
3572 Discard the event if it would fill the last slot. */
3573 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3575 *kbd_store_ptr
= *event
;
3578 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3580 /* Don't read keyboard input until we have processed kbd_buffer.
3581 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3582 hold_keyboard_input ();
3584 if (!noninteractive
)
3585 signal (SIGIO
, SIG_IGN
);
3589 #endif /* subprocesses */
3592 /* If we're inside while-no-input, and this event qualifies
3593 as input, set quit-flag to cause an interrupt. */
3594 if (!NILP (Vthrow_on_input
)
3595 && event
->kind
!= FOCUS_IN_EVENT
3596 && event
->kind
!= HELP_EVENT
3597 && event
->kind
!= DEICONIFY_EVENT
)
3599 Vquit_flag
= Vthrow_on_input
;
3600 /* If we're inside a function that wants immediate quits,
3602 if (immediate_quit
&& NILP (Vinhibit_quit
))
3612 /* Put an input event back in the head of the event queue. */
3615 kbd_buffer_unget_event (register struct input_event
*event
)
3617 if (kbd_fetch_ptr
== kbd_buffer
)
3618 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3620 /* Don't let the very last slot in the buffer become full, */
3621 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3624 *kbd_fetch_ptr
= *event
;
3629 /* Generate a HELP_EVENT input_event and store it in the keyboard
3632 HELP is the help form.
3634 FRAME and WINDOW are the frame and window where the help is
3635 generated. OBJECT is the Lisp object where the help was found (a
3636 buffer, a string, an overlay, or nil if neither from a string nor
3637 from a buffer). POS is the position within OBJECT where the help
3641 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3642 Lisp_Object object
, EMACS_INT pos
)
3644 struct input_event event
;
3648 event
.kind
= HELP_EVENT
;
3649 event
.frame_or_window
= frame
;
3651 event
.x
= WINDOWP (window
) ? window
: frame
;
3654 kbd_buffer_store_event (&event
);
3658 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3661 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3663 struct input_event event
;
3665 event
.kind
= HELP_EVENT
;
3666 event
.frame_or_window
= frame
;
3671 kbd_buffer_store_event (&event
);
3675 /* Discard any mouse events in the event buffer by setting them to
3678 discard_mouse_events (void)
3680 struct input_event
*sp
;
3681 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3683 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3686 if (sp
->kind
== MOUSE_CLICK_EVENT
3687 || sp
->kind
== WHEEL_EVENT
3688 || sp
->kind
== HORIZ_WHEEL_EVENT
3690 || sp
->kind
== GPM_CLICK_EVENT
3692 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3694 sp
->kind
= NO_EVENT
;
3700 /* Return non-zero if there are any real events waiting in the event
3701 buffer, not counting `NO_EVENT's.
3703 If DISCARD is non-zero, discard NO_EVENT events at the front of
3704 the input queue, possibly leaving the input queue empty if there
3705 are no real input events. */
3708 kbd_buffer_events_waiting (int discard
)
3710 struct input_event
*sp
;
3712 for (sp
= kbd_fetch_ptr
;
3713 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3716 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3723 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3727 /* Clear input event EVENT. */
3730 clear_event (struct input_event
*event
)
3732 event
->kind
= NO_EVENT
;
3736 /* Read one event from the event buffer, waiting if necessary.
3737 The value is a Lisp object representing the event.
3738 The value is nil for an event that should be ignored,
3739 or that was handled here.
3740 We always read and discard one event. */
3743 kbd_buffer_get_event (KBOARD
**kbp
,
3744 int *used_mouse_menu
,
3745 struct timeval
*end_time
)
3751 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3753 /* Start reading input again, we have processed enough so we can
3754 accept new events again. */
3755 unhold_keyboard_input ();
3757 if (!noninteractive
)
3758 signal (SIGIO
, input_available_signal
);
3762 #endif /* subprocesses */
3765 /* In case we are running as a daemon, only do this before
3766 detaching from the terminal. */
3767 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3771 *kbp
= current_kboard
;
3775 /* Wait until there is input available. */
3778 /* Break loop if there's an unread command event. Needed in
3779 moused window autoselection which uses a timer to insert such
3781 if (CONSP (Vunread_command_events
))
3784 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3786 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3787 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3791 /* If the quit flag is set, then read_char will return
3792 quit_char, so that counts as "available input." */
3793 if (!NILP (Vquit_flag
))
3794 quit_throw_to_read_char ();
3796 /* One way or another, wait until input is available; then, if
3797 interrupt handlers have not read it, read it now. */
3799 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3803 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3805 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3806 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3811 EMACS_TIME duration
;
3812 EMACS_GET_TIME (duration
);
3813 if (EMACS_TIME_GE (duration
, *end_time
))
3814 return Qnil
; /* finished waiting */
3817 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3818 wait_reading_process_output (EMACS_SECS (duration
),
3819 EMACS_USECS (duration
),
3820 -1, 1, Qnil
, NULL
, 0);
3824 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3826 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3827 /* Pass 1 for EXPECT since we just waited to have input. */
3828 read_avail_input (1);
3831 if (CONSP (Vunread_command_events
))
3834 first
= XCAR (Vunread_command_events
);
3835 Vunread_command_events
= XCDR (Vunread_command_events
);
3836 *kbp
= current_kboard
;
3840 /* At this point, we know that there is a readable event available
3841 somewhere. If the event queue is empty, then there must be a
3842 mouse movement enabled and available. */
3843 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3845 struct input_event
*event
;
3847 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3851 last_event_timestamp
= event
->timestamp
;
3853 *kbp
= event_to_kboard (event
);
3855 *kbp
= current_kboard
; /* Better than returning null ptr? */
3859 /* These two kinds of events get special handling
3860 and don't actually appear to the command loop.
3861 We return nil for them. */
3862 if (event
->kind
== SELECTION_REQUEST_EVENT
3863 || event
->kind
== SELECTION_CLEAR_EVENT
)
3866 struct input_event copy
;
3868 /* Remove it from the buffer before processing it,
3869 since otherwise swallow_events will see it
3870 and process it again. */
3872 kbd_fetch_ptr
= event
+ 1;
3873 input_pending
= readable_events (0);
3874 x_handle_selection_event (©
);
3876 /* We're getting selection request events, but we don't have
3882 #if defined (HAVE_NS)
3883 else if (event
->kind
== NS_TEXT_EVENT
)
3885 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3886 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3888 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3889 kbd_fetch_ptr
= event
+ 1;
3890 if (used_mouse_menu
)
3891 *used_mouse_menu
= 1;
3895 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3896 || defined (HAVE_NS)
3897 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3899 /* Make an event (delete-frame (FRAME)). */
3900 obj
= Fcons (event
->frame_or_window
, Qnil
);
3901 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3902 kbd_fetch_ptr
= event
+ 1;
3905 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3906 || defined (HAVE_NS)
3907 else if (event
->kind
== ICONIFY_EVENT
)
3909 /* Make an event (iconify-frame (FRAME)). */
3910 obj
= Fcons (event
->frame_or_window
, Qnil
);
3911 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3912 kbd_fetch_ptr
= event
+ 1;
3914 else if (event
->kind
== DEICONIFY_EVENT
)
3916 /* Make an event (make-frame-visible (FRAME)). */
3917 obj
= Fcons (event
->frame_or_window
, Qnil
);
3918 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3919 kbd_fetch_ptr
= event
+ 1;
3922 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3924 /* The value doesn't matter here; only the type is tested. */
3925 XSETBUFFER (obj
, current_buffer
);
3926 kbd_fetch_ptr
= event
+ 1;
3928 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3929 || defined(HAVE_NS) || defined (USE_GTK)
3930 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3932 kbd_fetch_ptr
= event
+ 1;
3933 input_pending
= readable_events (0);
3934 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3935 x_activate_menubar (XFRAME (event
->frame_or_window
));
3938 #if defined (WINDOWSNT)
3939 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3941 /* Make an event (language-change (FRAME CHARSET LCID)). */
3942 obj
= Fcons (event
->frame_or_window
, Qnil
);
3943 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3944 kbd_fetch_ptr
= event
+ 1;
3947 else if (event
->kind
== SAVE_SESSION_EVENT
)
3949 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3950 kbd_fetch_ptr
= event
+ 1;
3952 /* Just discard these, by returning nil.
3953 With MULTI_KBOARD, these events are used as placeholders
3954 when we need to randomly delete events from the queue.
3955 (They shouldn't otherwise be found in the buffer,
3956 but on some machines it appears they do show up
3957 even without MULTI_KBOARD.) */
3958 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3959 mouse events during a popup-menu call. */
3960 else if (event
->kind
== NO_EVENT
)
3961 kbd_fetch_ptr
= event
+ 1;
3962 else if (event
->kind
== HELP_EVENT
)
3964 Lisp_Object object
, position
, help
, frame
, window
;
3966 frame
= event
->frame_or_window
;
3967 object
= event
->arg
;
3968 position
= make_number (event
->code
);
3971 clear_event (event
);
3973 kbd_fetch_ptr
= event
+ 1;
3974 if (!WINDOWP (window
))
3976 obj
= Fcons (Qhelp_echo
,
3977 list5 (frame
, help
, window
, object
, position
));
3979 else if (event
->kind
== FOCUS_IN_EVENT
)
3981 /* Notification of a FocusIn event. The frame receiving the
3982 focus is in event->frame_or_window. Generate a
3983 switch-frame event if necessary. */
3984 Lisp_Object frame
, focus
;
3986 frame
= event
->frame_or_window
;
3987 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3991 if (!EQ (frame
, internal_last_event_frame
)
3992 && !EQ (frame
, selected_frame
))
3993 obj
= make_lispy_switch_frame (frame
);
3994 internal_last_event_frame
= frame
;
3995 kbd_fetch_ptr
= event
+ 1;
3998 else if (event
->kind
== DBUS_EVENT
)
4000 obj
= make_lispy_event (event
);
4001 kbd_fetch_ptr
= event
+ 1;
4004 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4006 obj
= make_lispy_event (event
);
4007 kbd_fetch_ptr
= event
+ 1;
4011 /* If this event is on a different frame, return a switch-frame this
4012 time, and leave the event in the queue for next time. */
4016 frame
= event
->frame_or_window
;
4018 frame
= XCAR (frame
);
4019 else if (WINDOWP (frame
))
4020 frame
= WINDOW_FRAME (XWINDOW (frame
));
4022 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4026 if (! EQ (frame
, internal_last_event_frame
)
4027 && !EQ (frame
, selected_frame
))
4028 obj
= make_lispy_switch_frame (frame
);
4029 internal_last_event_frame
= frame
;
4031 /* If we didn't decide to make a switch-frame event, go ahead
4032 and build a real event from the queue entry. */
4036 obj
= make_lispy_event (event
);
4038 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4039 || defined(HAVE_NS) || defined (USE_GTK)
4040 /* If this was a menu selection, then set the flag to inhibit
4041 writing to last_nonmenu_event. Don't do this if the event
4042 we're returning is (menu-bar), though; that indicates the
4043 beginning of the menu sequence, and we might as well leave
4044 that as the `event with parameters' for this selection. */
4046 && !EQ (event
->frame_or_window
, event
->arg
)
4047 && (event
->kind
== MENU_BAR_EVENT
4048 || event
->kind
== TOOL_BAR_EVENT
))
4049 *used_mouse_menu
= 1;
4052 /* certain system events are non-key events */
4054 && event
->kind
== NS_NONKEY_EVENT
)
4055 *used_mouse_menu
= 1;
4058 /* Wipe out this event, to catch bugs. */
4059 clear_event (event
);
4060 kbd_fetch_ptr
= event
+ 1;
4064 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4065 /* Try generating a mouse motion event. */
4066 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4068 FRAME_PTR f
= some_mouse_moved ();
4069 Lisp_Object bar_window
;
4070 enum scroll_bar_part part
;
4074 *kbp
= current_kboard
;
4075 /* Note that this uses F to determine which terminal to look at.
4076 If there is no valid info, it does not store anything
4077 so x remains nil. */
4080 /* XXX Can f or mouse_position_hook be NULL here? */
4081 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4082 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4087 /* Decide if we should generate a switch-frame event. Don't
4088 generate switch-frame events for motion outside of all Emacs
4094 frame
= FRAME_FOCUS_FRAME (f
);
4096 XSETFRAME (frame
, f
);
4098 if (! EQ (frame
, internal_last_event_frame
)
4099 && !EQ (frame
, selected_frame
))
4100 obj
= make_lispy_switch_frame (frame
);
4101 internal_last_event_frame
= frame
;
4104 /* If we didn't decide to make a switch-frame event, go ahead and
4105 return a mouse-motion event. */
4106 if (!NILP (x
) && NILP (obj
))
4107 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4109 #endif /* HAVE_MOUSE || HAVE GPM */
4111 /* We were promised by the above while loop that there was
4112 something for us to read! */
4115 input_pending
= readable_events (0);
4117 Vlast_event_frame
= internal_last_event_frame
;
4122 /* Process any events that are not user-visible,
4123 then return, without reading any user-visible events. */
4126 swallow_events (int do_display
)
4130 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4132 struct input_event
*event
;
4134 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4138 last_event_timestamp
= event
->timestamp
;
4140 /* These two kinds of events get special handling
4141 and don't actually appear to the command loop. */
4142 if (event
->kind
== SELECTION_REQUEST_EVENT
4143 || event
->kind
== SELECTION_CLEAR_EVENT
)
4146 struct input_event copy
;
4148 /* Remove it from the buffer before processing it,
4149 since otherwise swallow_events called recursively could see it
4150 and process it again. */
4152 kbd_fetch_ptr
= event
+ 1;
4153 input_pending
= readable_events (0);
4154 x_handle_selection_event (©
);
4156 /* We're getting selection request events, but we don't have
4165 old_timers_run
= timers_run
;
4166 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4168 if (timers_run
!= old_timers_run
&& do_display
)
4169 redisplay_preserve_echo_area (7);
4172 /* Record the start of when Emacs is idle,
4173 for the sake of running idle-time timers. */
4176 timer_start_idle (void)
4180 /* If we are already in the idle state, do nothing. */
4181 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4184 EMACS_GET_TIME (timer_idleness_start_time
);
4186 timer_last_idleness_start_time
= timer_idleness_start_time
;
4188 /* Mark all idle-time timers as once again candidates for running. */
4189 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4193 timer
= XCAR (timers
);
4195 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4197 XVECTOR (timer
)->contents
[0] = Qnil
;
4201 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4204 timer_stop_idle (void)
4206 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4209 /* Resume idle timer from last idle start time. */
4212 timer_resume_idle (void)
4214 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4217 timer_idleness_start_time
= timer_last_idleness_start_time
;
4220 /* This is only for debugging. */
4221 struct input_event last_timer_event
;
4223 /* List of elisp functions to call, delayed because they were generated in
4224 a context where Elisp could not be safely run (e.g. redisplay, signal,
4225 ...). Each element has the form (FUN . ARGS). */
4226 Lisp_Object pending_funcalls
;
4228 /* Check whether a timer has fired. To prevent larger problems we simply
4229 disregard elements that are not proper timers. Do not make a circular
4230 timer list for the time being.
4232 Returns the time to wait until the next timer fires. If a
4233 timer is triggering now, return zero.
4234 If no timer is active, return -1.
4236 If a timer is ripe, we run it, with quitting turned off.
4237 In that case we return 0 to indicate that a new timer_check_2 call
4241 timer_check_2 (void)
4243 EMACS_TIME nexttime
;
4245 EMACS_TIME idleness_now
IF_LINT (= {0});
4246 Lisp_Object timers
, idle_timers
, chosen_timer
;
4247 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4249 EMACS_SET_SECS (nexttime
, -1);
4250 EMACS_SET_USECS (nexttime
, -1);
4252 /* Always consider the ordinary timers. */
4253 timers
= Vtimer_list
;
4254 /* Consider the idle timers only if Emacs is idle. */
4255 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4256 idle_timers
= Vtimer_idle_list
;
4259 chosen_timer
= Qnil
;
4260 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4262 /* First run the code that was delayed. */
4263 while (CONSP (pending_funcalls
))
4265 Lisp_Object funcall
= XCAR (pending_funcalls
);
4266 pending_funcalls
= XCDR (pending_funcalls
);
4267 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4270 if (CONSP (timers
) || CONSP (idle_timers
))
4272 EMACS_GET_TIME (now
);
4273 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4274 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4277 while (CONSP (timers
) || CONSP (idle_timers
))
4279 Lisp_Object
*vector
;
4280 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4281 EMACS_TIME timer_time
, idle_timer_time
;
4282 EMACS_TIME difference
;
4283 EMACS_TIME timer_difference
IF_LINT (= {0});
4284 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4286 /* Skip past invalid timers and timers already handled. */
4289 timer
= XCAR (timers
);
4290 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4292 timers
= XCDR (timers
);
4295 vector
= XVECTOR (timer
)->contents
;
4297 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4298 || !INTEGERP (vector
[3])
4299 || ! NILP (vector
[0]))
4301 timers
= XCDR (timers
);
4305 if (CONSP (idle_timers
))
4307 timer
= XCAR (idle_timers
);
4308 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4310 idle_timers
= XCDR (idle_timers
);
4313 vector
= XVECTOR (timer
)->contents
;
4315 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4316 || !INTEGERP (vector
[3])
4317 || ! NILP (vector
[0]))
4319 idle_timers
= XCDR (idle_timers
);
4324 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4325 based on the next ordinary timer.
4326 TIMER_DIFFERENCE is the distance in time from NOW to when
4327 this timer becomes ripe (negative if it's already ripe). */
4330 timer
= XCAR (timers
);
4331 vector
= XVECTOR (timer
)->contents
;
4332 EMACS_SET_SECS (timer_time
,
4333 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4334 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4335 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4338 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4339 based on the next idle timer. */
4340 if (CONSP (idle_timers
))
4342 idle_timer
= XCAR (idle_timers
);
4343 vector
= XVECTOR (idle_timer
)->contents
;
4344 EMACS_SET_SECS (idle_timer_time
,
4345 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4346 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4347 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4350 /* Decide which timer is the next timer,
4351 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4352 Also step down the list where we found that timer. */
4354 if (CONSP (timers
) && CONSP (idle_timers
))
4357 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4358 if (EMACS_TIME_NEG_P (temp
))
4360 chosen_timer
= timer
;
4361 timers
= XCDR (timers
);
4362 difference
= timer_difference
;
4366 chosen_timer
= idle_timer
;
4367 idle_timers
= XCDR (idle_timers
);
4368 difference
= idle_timer_difference
;
4371 else if (CONSP (timers
))
4373 chosen_timer
= timer
;
4374 timers
= XCDR (timers
);
4375 difference
= timer_difference
;
4379 chosen_timer
= idle_timer
;
4380 idle_timers
= XCDR (idle_timers
);
4381 difference
= idle_timer_difference
;
4383 vector
= XVECTOR (chosen_timer
)->contents
;
4385 /* If timer is ripe, run it if it hasn't been run. */
4386 if (EMACS_TIME_NEG_P (difference
)
4387 || (EMACS_SECS (difference
) == 0
4388 && EMACS_USECS (difference
) == 0))
4390 if (NILP (vector
[0]))
4392 int count
= SPECPDL_INDEX ();
4393 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4395 /* Mark the timer as triggered to prevent problems if the lisp
4396 code fails to reschedule it right. */
4399 specbind (Qinhibit_quit
, Qt
);
4401 call1 (Qtimer_event_handler
, chosen_timer
);
4402 Vdeactivate_mark
= old_deactivate_mark
;
4404 unbind_to (count
, Qnil
);
4406 /* Since we have handled the event,
4407 we don't need to tell the caller to wake up and do it. */
4408 /* But the caller must still wait for the next timer, so
4409 return 0 to indicate that. */
4412 EMACS_SET_SECS (nexttime
, 0);
4413 EMACS_SET_USECS (nexttime
, 0);
4416 /* When we encounter a timer that is still waiting,
4417 return the amount of time to wait before it is ripe. */
4424 /* No timers are pending in the future. */
4425 /* Return 0 if we generated an event, and -1 if not. */
4431 /* Check whether a timer has fired. To prevent larger problems we simply
4432 disregard elements that are not proper timers. Do not make a circular
4433 timer list for the time being.
4435 Returns the time to wait until the next timer fires.
4436 If no timer is active, return -1.
4438 As long as any timer is ripe, we run it. */
4443 EMACS_TIME nexttime
;
4447 nexttime
= timer_check_2 ();
4449 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4454 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4455 doc
: /* Return the current length of Emacs idleness, or nil.
4456 The value when Emacs is idle is a list of three integers. The first has
4457 the most significant 16 bits of the seconds, while the second has the least
4458 significant 16 bits. The third integer gives the microsecond count.
4460 The value when Emacs is not idle is nil.
4462 The microsecond count is zero on systems that do not provide
4463 resolution finer than a second. */)
4466 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4468 EMACS_TIME now
, idleness_now
;
4470 EMACS_GET_TIME (now
);
4471 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4473 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4474 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4475 make_number (EMACS_USECS (idleness_now
)));
4481 /* Caches for modify_event_symbol. */
4482 static Lisp_Object accent_key_syms
;
4483 static Lisp_Object func_key_syms
;
4484 static Lisp_Object mouse_syms
;
4485 static Lisp_Object wheel_syms
;
4486 static Lisp_Object drag_n_drop_syms
;
4488 /* This is a list of keysym codes for special "accent" characters.
4489 It parallels lispy_accent_keys. */
4491 static const int lispy_accent_codes
[] =
4493 #ifdef XK_dead_circumflex
4498 #ifdef XK_dead_grave
4503 #ifdef XK_dead_tilde
4508 #ifdef XK_dead_diaeresis
4513 #ifdef XK_dead_macron
4518 #ifdef XK_dead_degree
4523 #ifdef XK_dead_acute
4528 #ifdef XK_dead_cedilla
4533 #ifdef XK_dead_breve
4538 #ifdef XK_dead_ogonek
4543 #ifdef XK_dead_caron
4548 #ifdef XK_dead_doubleacute
4549 XK_dead_doubleacute
,
4553 #ifdef XK_dead_abovedot
4558 #ifdef XK_dead_abovering
4568 #ifdef XK_dead_belowdot
4573 #ifdef XK_dead_voiced_sound
4574 XK_dead_voiced_sound
,
4578 #ifdef XK_dead_semivoiced_sound
4579 XK_dead_semivoiced_sound
,
4595 /* This is a list of Lisp names for special "accent" characters.
4596 It parallels lispy_accent_codes. */
4598 static const char *const lispy_accent_keys
[] =
4616 "dead-voiced-sound",
4617 "dead-semivoiced-sound",
4623 #define FUNCTION_KEY_OFFSET 0x0
4625 const char *const lispy_function_keys
[] =
4629 0, /* VK_LBUTTON 0x01 */
4630 0, /* VK_RBUTTON 0x02 */
4631 "cancel", /* VK_CANCEL 0x03 */
4632 0, /* VK_MBUTTON 0x04 */
4634 0, 0, 0, /* 0x05 .. 0x07 */
4636 "backspace", /* VK_BACK 0x08 */
4637 "tab", /* VK_TAB 0x09 */
4639 0, 0, /* 0x0A .. 0x0B */
4641 "clear", /* VK_CLEAR 0x0C */
4642 "return", /* VK_RETURN 0x0D */
4644 0, 0, /* 0x0E .. 0x0F */
4646 0, /* VK_SHIFT 0x10 */
4647 0, /* VK_CONTROL 0x11 */
4648 0, /* VK_MENU 0x12 */
4649 "pause", /* VK_PAUSE 0x13 */
4650 "capslock", /* VK_CAPITAL 0x14 */
4651 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4653 "junja", /* VK_JUNJA 0x17 */
4654 "final", /* VK_FINAL 0x18 */
4655 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4657 "escape", /* VK_ESCAPE 0x1B */
4658 "convert", /* VK_CONVERT 0x1C */
4659 "non-convert", /* VK_NONCONVERT 0x1D */
4660 "accept", /* VK_ACCEPT 0x1E */
4661 "mode-change", /* VK_MODECHANGE 0x1F */
4662 0, /* VK_SPACE 0x20 */
4663 "prior", /* VK_PRIOR 0x21 */
4664 "next", /* VK_NEXT 0x22 */
4665 "end", /* VK_END 0x23 */
4666 "home", /* VK_HOME 0x24 */
4667 "left", /* VK_LEFT 0x25 */
4668 "up", /* VK_UP 0x26 */
4669 "right", /* VK_RIGHT 0x27 */
4670 "down", /* VK_DOWN 0x28 */
4671 "select", /* VK_SELECT 0x29 */
4672 "print", /* VK_PRINT 0x2A */
4673 "execute", /* VK_EXECUTE 0x2B */
4674 "snapshot", /* VK_SNAPSHOT 0x2C */
4675 "insert", /* VK_INSERT 0x2D */
4676 "delete", /* VK_DELETE 0x2E */
4677 "help", /* VK_HELP 0x2F */
4679 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4681 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4683 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4685 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4687 0, 0, 0, 0, 0, 0, 0, 0, 0,
4688 0, 0, 0, 0, 0, 0, 0, 0, 0,
4689 0, 0, 0, 0, 0, 0, 0, 0,
4691 "lwindow", /* VK_LWIN 0x5B */
4692 "rwindow", /* VK_RWIN 0x5C */
4693 "apps", /* VK_APPS 0x5D */
4696 "kp-0", /* VK_NUMPAD0 0x60 */
4697 "kp-1", /* VK_NUMPAD1 0x61 */
4698 "kp-2", /* VK_NUMPAD2 0x62 */
4699 "kp-3", /* VK_NUMPAD3 0x63 */
4700 "kp-4", /* VK_NUMPAD4 0x64 */
4701 "kp-5", /* VK_NUMPAD5 0x65 */
4702 "kp-6", /* VK_NUMPAD6 0x66 */
4703 "kp-7", /* VK_NUMPAD7 0x67 */
4704 "kp-8", /* VK_NUMPAD8 0x68 */
4705 "kp-9", /* VK_NUMPAD9 0x69 */
4706 "kp-multiply", /* VK_MULTIPLY 0x6A */
4707 "kp-add", /* VK_ADD 0x6B */
4708 "kp-separator", /* VK_SEPARATOR 0x6C */
4709 "kp-subtract", /* VK_SUBTRACT 0x6D */
4710 "kp-decimal", /* VK_DECIMAL 0x6E */
4711 "kp-divide", /* VK_DIVIDE 0x6F */
4712 "f1", /* VK_F1 0x70 */
4713 "f2", /* VK_F2 0x71 */
4714 "f3", /* VK_F3 0x72 */
4715 "f4", /* VK_F4 0x73 */
4716 "f5", /* VK_F5 0x74 */
4717 "f6", /* VK_F6 0x75 */
4718 "f7", /* VK_F7 0x76 */
4719 "f8", /* VK_F8 0x77 */
4720 "f9", /* VK_F9 0x78 */
4721 "f10", /* VK_F10 0x79 */
4722 "f11", /* VK_F11 0x7A */
4723 "f12", /* VK_F12 0x7B */
4724 "f13", /* VK_F13 0x7C */
4725 "f14", /* VK_F14 0x7D */
4726 "f15", /* VK_F15 0x7E */
4727 "f16", /* VK_F16 0x7F */
4728 "f17", /* VK_F17 0x80 */
4729 "f18", /* VK_F18 0x81 */
4730 "f19", /* VK_F19 0x82 */
4731 "f20", /* VK_F20 0x83 */
4732 "f21", /* VK_F21 0x84 */
4733 "f22", /* VK_F22 0x85 */
4734 "f23", /* VK_F23 0x86 */
4735 "f24", /* VK_F24 0x87 */
4737 0, 0, 0, 0, /* 0x88 .. 0x8B */
4738 0, 0, 0, 0, /* 0x8C .. 0x8F */
4740 "kp-numlock", /* VK_NUMLOCK 0x90 */
4741 "scroll", /* VK_SCROLL 0x91 */
4742 /* Not sure where the following block comes from.
4743 Windows headers have NEC and Fujitsu specific keys in
4744 this block, but nothing generic. */
4745 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4746 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4747 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4748 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4749 "kp-end", /* VK_NUMPAD_END 0x96 */
4750 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4751 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4752 "kp-up", /* VK_NUMPAD_UP 0x99 */
4753 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4754 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4755 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4756 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4758 0, 0, /* 0x9E .. 0x9F */
4761 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4762 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4763 * No other API or message will distinguish left and right keys this way.
4768 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4769 to enable them selectively, and gives access to a few more functions.
4770 See lispy_multimedia_keys below. */
4771 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4772 0, 0, 0, /* 0xAD .. 0xAF Volume */
4773 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4774 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4776 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4777 0, 0, 0, 0, 0, 0, 0, 0, 0,
4779 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4780 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4781 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4784 "ax", /* VK_OEM_AX 0xE1 */
4785 0, /* VK_OEM_102 0xE2 */
4786 "ico-help", /* VK_ICO_HELP 0xE3 */
4787 "ico-00", /* VK_ICO_00 0xE4 */
4788 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4789 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4790 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4792 "reset", /* VK_OEM_RESET 0xE9 */
4793 "jump", /* VK_OEM_JUMP 0xEA */
4794 "oem-pa1", /* VK_OEM_PA1 0xEB */
4795 "oem-pa2", /* VK_OEM_PA2 0xEC */
4796 "oem-pa3", /* VK_OEM_PA3 0xED */
4797 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4798 "cusel", /* VK_OEM_CUSEL 0xEF */
4799 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4800 "finish", /* VK_OEM_FINISH 0xF1 */
4801 "copy", /* VK_OEM_COPY 0xF2 */
4802 "auto", /* VK_OEM_AUTO 0xF3 */
4803 "enlw", /* VK_OEM_ENLW 0xF4 */
4804 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4805 "attn", /* VK_ATTN 0xF6 */
4806 "crsel", /* VK_CRSEL 0xF7 */
4807 "exsel", /* VK_EXSEL 0xF8 */
4808 "ereof", /* VK_EREOF 0xF9 */
4809 "play", /* VK_PLAY 0xFA */
4810 "zoom", /* VK_ZOOM 0xFB */
4811 "noname", /* VK_NONAME 0xFC */
4812 "pa1", /* VK_PA1 0xFD */
4813 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4817 /* Some of these duplicate the "Media keys" on newer keyboards,
4818 but they are delivered to the application in a different way. */
4819 static const char *const lispy_multimedia_keys
[] =
4827 "browser-favorites",
4864 "toggle-dictate-command",
4870 "media-fast-forward",
4873 "media-channel-down"
4876 #else /* not HAVE_NTGUI */
4878 /* This should be dealt with in XTread_socket now, and that doesn't
4879 depend on the client system having the Kana syms defined. See also
4880 the XK_kana_A case below. */
4883 static const char *const lispy_kana_keys
[] =
4885 /* X Keysym value */
4886 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4887 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4888 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4889 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4890 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4891 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4892 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4893 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4894 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4895 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4896 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4897 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4898 "kana-i", "kana-u", "kana-e", "kana-o",
4899 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4900 "prolongedsound", "kana-A", "kana-I", "kana-U",
4901 "kana-E", "kana-O", "kana-KA", "kana-KI",
4902 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4903 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4904 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4905 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4906 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4907 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4908 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4909 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4910 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4911 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4912 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4913 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4915 #endif /* XK_kana_A */
4918 #define FUNCTION_KEY_OFFSET 0xff00
4920 /* You'll notice that this table is arranged to be conveniently
4921 indexed by X Windows keysym values. */
4922 static const char *const lispy_function_keys
[] =
4924 /* X Keysym value */
4926 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4927 "backspace", "tab", "linefeed", "clear",
4929 0, 0, 0, "pause", /* 0xff10...1f */
4930 0, 0, 0, 0, 0, 0, 0, "escape",
4932 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4933 "romaji", "hiragana", "katakana", "hiragana-katakana",
4934 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4935 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4936 "eisu-toggle", /* 0xff30...3f */
4937 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4938 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4940 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4941 "down", "prior", "next", "end",
4942 "begin", 0, 0, 0, 0, 0, 0, 0,
4943 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4954 "break", /* 0xff6b */
4957 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4958 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4959 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4960 0, 0, 0, 0, 0, 0, 0, 0,
4961 "kp-tab", /* 0xff89 */
4963 "kp-enter", /* 0xff8d */
4965 "kp-f1", /* 0xff91 */
4969 "kp-home", /* 0xff95 */
4974 "kp-prior", /* kp-page-up */
4975 "kp-next", /* kp-page-down */
4981 0, 0, 0, 0, 0, 0, 0, 0, 0,
4982 "kp-multiply", /* 0xffaa */
4987 "kp-divide", /* 0xffaf */
4988 "kp-0", /* 0xffb0 */
4989 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4992 "kp-equal", /* 0xffbd */
4993 "f1", /* 0xffbe */ /* IsFunctionKey */
4995 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4996 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4997 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4998 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4999 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5000 0, 0, 0, 0, 0, 0, 0, 0,
5001 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5002 0, 0, 0, 0, 0, 0, 0, "delete"
5005 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5006 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5008 static const char *const iso_lispy_function_keys
[] =
5010 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5011 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5012 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5013 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5014 "iso-lefttab", /* 0xfe20 */
5015 "iso-move-line-up", "iso-move-line-down",
5016 "iso-partial-line-up", "iso-partial-line-down",
5017 "iso-partial-space-left", "iso-partial-space-right",
5018 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5019 "iso-release-margin-left", "iso-release-margin-right",
5020 "iso-release-both-margins",
5021 "iso-fast-cursor-left", "iso-fast-cursor-right",
5022 "iso-fast-cursor-up", "iso-fast-cursor-down",
5023 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5024 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5027 #endif /* not HAVE_NTGUI */
5029 Lisp_Object Vlispy_mouse_stem
;
5031 static const char *const lispy_wheel_names
[] =
5033 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5036 /* drag-n-drop events are generated when a set of selected files are
5037 dragged from another application and dropped onto an Emacs window. */
5038 static const char *const lispy_drag_n_drop_names
[] =
5043 /* Scroll bar parts. */
5044 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5045 Lisp_Object Qup
, Qdown
, Qbottom
;
5046 static Lisp_Object Qend_scroll
;
5048 static Lisp_Object Qratio
;
5050 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5051 static Lisp_Object
*const scroll_bar_parts
[] = {
5052 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5053 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5056 /* A vector, indexed by button number, giving the down-going location
5057 of currently depressed buttons, both scroll bar and non-scroll bar.
5059 The elements have the form
5060 (BUTTON-NUMBER MODIFIER-MASK . REST)
5061 where REST is the cdr of a position as it would be reported in the event.
5063 The make_lispy_event function stores positions here to tell the
5064 difference between click and drag events, and to store the starting
5065 location to be included in drag events. */
5067 static Lisp_Object button_down_location
;
5069 /* Information about the most recent up-going button event: Which
5070 button, what location, and what time. */
5072 static int last_mouse_button
;
5073 static int last_mouse_x
;
5074 static int last_mouse_y
;
5075 static unsigned long button_down_time
;
5077 /* The number of clicks in this multiple-click. */
5079 int double_click_count
;
5081 /* X and Y are frame-relative coordinates for a click or wheel event.
5082 Return a Lisp-style event list. */
5085 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5088 enum window_part part
;
5089 Lisp_Object posn
= Qnil
;
5090 Lisp_Object extra_info
= Qnil
;
5091 /* Coordinate pixel positions to return. */
5092 int xret
= 0, yret
= 0;
5093 /* The window under frame pixel coordinates (x,y) */
5094 Lisp_Object window
= f
5095 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5098 if (WINDOWP (window
))
5100 /* It's a click in window window at frame coordinates (x,y) */
5101 struct window
*w
= XWINDOW (window
);
5102 Lisp_Object string_info
= Qnil
;
5103 EMACS_INT textpos
= -1;
5104 int col
= -1, row
= -1;
5105 int dx
= -1, dy
= -1;
5106 int width
= -1, height
= -1;
5107 Lisp_Object object
= Qnil
;
5109 /* Pixel coordinates relative to the window corner. */
5110 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5111 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5113 /* For text area clicks, return X, Y relative to the corner of
5114 this text area. Note that dX, dY etc are set below, by
5115 buffer_posn_from_coords. */
5116 if (part
== ON_TEXT
)
5118 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5119 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5121 /* For mode line and header line clicks, return X, Y relative to
5122 the left window edge. Use mode_line_string to look for a
5123 string on the click position. */
5124 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5129 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5130 /* Note that mode_line_string takes COL, ROW as pixels and
5131 converts them to characters. */
5134 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5135 &object
, &dx
, &dy
, &width
, &height
);
5136 if (STRINGP (string
))
5137 string_info
= Fcons (string
, make_number (charpos
));
5138 textpos
= (w
== XWINDOW (selected_window
)
5139 && current_buffer
== XBUFFER (w
->buffer
))
5140 ? PT
: XMARKER (w
->pointm
)->charpos
;
5145 /* For fringes and margins, Y is relative to the area's (and the
5146 window's) top edge, while X is meaningless. */
5147 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5152 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5155 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5156 &object
, &dx
, &dy
, &width
, &height
);
5157 if (STRINGP (string
))
5158 string_info
= Fcons (string
, make_number (charpos
));
5159 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5161 else if (part
== ON_LEFT_FRINGE
)
5163 posn
= Qleft_fringe
;
5166 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5167 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5168 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5170 else if (part
== ON_RIGHT_FRINGE
)
5172 posn
= Qright_fringe
;
5175 - window_box_width (w
, LEFT_MARGIN_AREA
)
5176 - window_box_width (w
, TEXT_AREA
)
5177 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5178 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5180 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5182 else if (part
== ON_VERTICAL_BORDER
)
5184 posn
= Qvertical_line
;
5189 /* Nothing special for part == ON_SCROLL_BAR. */
5191 /* For clicks in the text area, fringes, or margins, call
5192 buffer_posn_from_coords to extract TEXTPOS, the buffer
5193 position nearest to the click. */
5196 Lisp_Object string2
, object2
= Qnil
;
5197 struct display_pos p
;
5199 int width2
, height2
;
5200 /* The pixel X coordinate passed to buffer_posn_from_coords
5201 is the X coordinate relative to the text area for
5202 text-area and right-margin clicks, zero otherwise. */
5204 = (part
== ON_TEXT
) ? xret
5205 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5206 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5210 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5211 &object2
, &dx2
, &dy2
,
5213 textpos
= CHARPOS (p
.pos
);
5214 if (col
< 0) col
= x2
;
5215 if (row
< 0) row
= y2
;
5216 if (dx
< 0) dx
= dx2
;
5217 if (dy
< 0) dy
= dy2
;
5218 if (width
< 0) width
= width2
;
5219 if (height
< 0) height
= height2
;
5223 posn
= make_number (textpos
);
5224 if (STRINGP (string2
))
5225 string_info
= Fcons (string2
,
5226 make_number (CHARPOS (p
.string_pos
)));
5232 #ifdef HAVE_WINDOW_SYSTEM
5233 if (IMAGEP (object
))
5235 Lisp_Object image_map
, hotspot
;
5236 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5238 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5240 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5241 posn
= XCAR (hotspot
);
5248 Fcons (make_number (dx
), make_number (dy
)),
5249 Fcons (make_number (width
), make_number (height
)));
5252 extra_info
= Fcons (string_info
,
5253 Fcons (make_number (textpos
),
5254 Fcons (Fcons (make_number (col
),
5259 XSETFRAME (window
, f
);
5263 return Fcons (window
,
5265 Fcons (Fcons (make_number (xret
),
5266 make_number (yret
)),
5267 Fcons (make_number (t
),
5271 /* Given a struct input_event, build the lisp event which represents
5272 it. If EVENT is 0, build a mouse movement event from the mouse
5273 movement buffer, which should have a movement event in it.
5275 Note that events must be passed to this function in the order they
5276 are received; this function stores the location of button presses
5277 in order to build drag events when the button is released. */
5280 make_lispy_event (struct input_event
*event
)
5284 switch (SWITCH_ENUM_CAST (event
->kind
))
5286 /* A simple keystroke. */
5287 case ASCII_KEYSTROKE_EVENT
:
5288 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5290 Lisp_Object lispy_c
;
5291 EMACS_INT c
= event
->code
;
5292 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5295 eassert (c
== event
->code
);
5296 /* Turn ASCII characters into control characters
5298 if (event
->modifiers
& ctrl_modifier
)
5300 c
= make_ctrl_char (c
);
5301 event
->modifiers
&= ~ctrl_modifier
;
5305 /* Add in the other modifier bits. The shift key was taken care
5306 of by the X code. */
5307 c
|= (event
->modifiers
5308 & (meta_modifier
| alt_modifier
5309 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5310 /* Distinguish Shift-SPC from SPC. */
5311 if ((event
->code
) == 040
5312 && event
->modifiers
& shift_modifier
)
5313 c
|= shift_modifier
;
5314 button_down_time
= 0;
5315 XSETFASTINT (lispy_c
, c
);
5320 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5321 except that they are non-key events (last-nonmenu-event is nil). */
5322 case NS_NONKEY_EVENT
:
5325 /* A function key. The symbol may need to have modifier prefixes
5327 case NON_ASCII_KEYSTROKE_EVENT
:
5328 button_down_time
= 0;
5330 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5331 if (event
->code
== lispy_accent_codes
[i
])
5332 return modify_event_symbol (i
,
5334 Qfunction_key
, Qnil
,
5335 lispy_accent_keys
, &accent_key_syms
,
5336 (sizeof (lispy_accent_keys
)
5337 / sizeof (lispy_accent_keys
[0])));
5341 if (event
->code
>= 0x400 && event
->code
< 0x500)
5342 return modify_event_symbol (event
->code
- 0x400,
5343 event
->modifiers
& ~shift_modifier
,
5344 Qfunction_key
, Qnil
,
5345 lispy_kana_keys
, &func_key_syms
,
5346 (sizeof (lispy_kana_keys
)
5347 / sizeof (lispy_kana_keys
[0])));
5348 #endif /* XK_kana_A */
5351 #ifdef ISO_FUNCTION_KEY_OFFSET
5352 if (event
->code
< FUNCTION_KEY_OFFSET
5353 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5354 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5356 Qfunction_key
, Qnil
,
5357 iso_lispy_function_keys
, &func_key_syms
,
5358 (sizeof (iso_lispy_function_keys
)
5359 / sizeof (iso_lispy_function_keys
[0])));
5362 /* Handle system-specific or unknown keysyms. */
5363 if (event
->code
& (1 << 28)
5364 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5365 || (event
->code
- FUNCTION_KEY_OFFSET
5366 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5367 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5369 /* We need to use an alist rather than a vector as the cache
5370 since we can't make a vector long enuf. */
5371 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5372 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5373 return modify_event_symbol (event
->code
,
5376 KVAR (current_kboard
, Vsystem_key_alist
),
5377 0, &KVAR (current_kboard
, system_key_syms
),
5381 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5383 Qfunction_key
, Qnil
,
5384 lispy_function_keys
, &func_key_syms
,
5385 (sizeof (lispy_function_keys
)
5386 / sizeof (lispy_function_keys
[0])));
5389 case MULTIMEDIA_KEY_EVENT
:
5390 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5391 / sizeof (lispy_multimedia_keys
[0]))
5392 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5394 return modify_event_symbol (event
->code
, event
->modifiers
,
5395 Qfunction_key
, Qnil
,
5396 lispy_multimedia_keys
, &func_key_syms
,
5397 (sizeof (lispy_multimedia_keys
)
5398 / sizeof (lispy_multimedia_keys
[0])));
5404 /* A mouse click. Figure out where it is, decide whether it's
5405 a press, click or drag, and build the appropriate structure. */
5406 case MOUSE_CLICK_EVENT
:
5407 #ifndef USE_TOOLKIT_SCROLL_BARS
5408 case SCROLL_BAR_CLICK_EVENT
:
5411 int button
= event
->code
;
5413 Lisp_Object position
;
5414 Lisp_Object
*start_pos_ptr
;
5415 Lisp_Object start_pos
;
5419 /* Build the position as appropriate for this mouse click. */
5420 if (event
->kind
== MOUSE_CLICK_EVENT
)
5422 struct frame
*f
= XFRAME (event
->frame_or_window
);
5423 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5427 /* Ignore mouse events that were made on frame that
5428 have been deleted. */
5429 if (! FRAME_LIVE_P (f
))
5432 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5433 /* EVENT->x and EVENT->y are frame-relative pixel
5434 coordinates at this place. Under old redisplay, COLUMN
5435 and ROW are set to frame relative glyph coordinates
5436 which are then used to determine whether this click is
5437 in a menu (non-toolkit version). */
5438 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5439 &column
, &row
, NULL
, 1);
5441 /* In the non-toolkit version, clicks on the menu bar
5442 are ordinary button events in the event buffer.
5443 Distinguish them, and invoke the menu.
5445 (In the toolkit version, the toolkit handles the menu bar
5446 and Emacs doesn't know about it until after the user
5447 makes a selection.) */
5448 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5449 && (event
->modifiers
& down_modifier
))
5451 Lisp_Object items
, item
;
5454 /* Find the menu bar item under `column'. */
5456 items
= FRAME_MENU_BAR_ITEMS (f
);
5457 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5459 Lisp_Object pos
, string
;
5460 string
= AREF (items
, i
+ 1);
5461 pos
= AREF (items
, i
+ 3);
5464 if (column
>= XINT (pos
)
5465 && column
< XINT (pos
) + SCHARS (string
))
5467 item
= AREF (items
, i
);
5472 /* ELisp manual 2.4b says (x y) are window relative but
5473 code says they are frame-relative. */
5475 = Fcons (event
->frame_or_window
,
5477 Fcons (Fcons (event
->x
, event
->y
),
5478 Fcons (make_number (event
->timestamp
),
5481 return Fcons (item
, Fcons (position
, Qnil
));
5483 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5485 position
= make_lispy_position (f
, event
->x
, event
->y
,
5488 #ifndef USE_TOOLKIT_SCROLL_BARS
5491 /* It's a scrollbar click. */
5493 Lisp_Object portion_whole
;
5496 window
= event
->frame_or_window
;
5497 portion_whole
= Fcons (event
->x
, event
->y
);
5498 part
= *scroll_bar_parts
[(int) event
->part
];
5502 Fcons (Qvertical_scroll_bar
,
5503 Fcons (portion_whole
,
5504 Fcons (make_number (event
->timestamp
),
5505 Fcons (part
, Qnil
)))));
5507 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5509 if (button
>= ASIZE (button_down_location
))
5511 button_down_location
= larger_vector (button_down_location
,
5513 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5516 start_pos_ptr
= &AREF (button_down_location
, button
);
5517 start_pos
= *start_pos_ptr
;
5518 *start_pos_ptr
= Qnil
;
5521 /* On window-system frames, use the value of
5522 double-click-fuzz as is. On other frames, interpret it
5523 as a multiple of 1/8 characters. */
5527 if (WINDOWP (event
->frame_or_window
))
5528 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5529 else if (FRAMEP (event
->frame_or_window
))
5530 f
= XFRAME (event
->frame_or_window
);
5534 if (FRAME_WINDOW_P (f
))
5535 fuzz
= double_click_fuzz
;
5537 fuzz
= double_click_fuzz
/ 8;
5539 is_double
= (button
== last_mouse_button
5540 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5541 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5542 && button_down_time
!= 0
5543 && (EQ (Vdouble_click_time
, Qt
)
5544 || (INTEGERP (Vdouble_click_time
)
5545 && ((int)(event
->timestamp
- button_down_time
)
5546 < XINT (Vdouble_click_time
)))));
5549 last_mouse_button
= button
;
5550 last_mouse_x
= XINT (event
->x
);
5551 last_mouse_y
= XINT (event
->y
);
5553 /* If this is a button press, squirrel away the location, so
5554 we can decide later whether it was a click or a drag. */
5555 if (event
->modifiers
& down_modifier
)
5559 double_click_count
++;
5560 event
->modifiers
|= ((double_click_count
> 2)
5565 double_click_count
= 1;
5566 button_down_time
= event
->timestamp
;
5567 *start_pos_ptr
= Fcopy_alist (position
);
5568 ignore_mouse_drag_p
= 0;
5571 /* Now we're releasing a button - check the co-ordinates to
5572 see if this was a click or a drag. */
5573 else if (event
->modifiers
& up_modifier
)
5575 /* If we did not see a down before this up, ignore the up.
5576 Probably this happened because the down event chose a
5577 menu item. It would be an annoyance to treat the
5578 release of the button that chose the menu item as a
5581 if (!CONSP (start_pos
))
5584 event
->modifiers
&= ~up_modifier
;
5587 Lisp_Object new_down
, down
;
5588 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5590 /* The third element of every position
5591 should be the (x,y) pair. */
5592 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5593 new_down
= Fcar (Fcdr (Fcdr (position
)));
5596 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5598 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5599 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5602 if (ignore_mouse_drag_p
)
5604 event
->modifiers
|= click_modifier
;
5605 ignore_mouse_drag_p
= 0;
5607 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5608 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5609 /* Maybe the mouse has moved a lot, caused scrolling, and
5610 eventually ended up at the same screen position (but
5611 not buffer position) in which case it is a drag, not
5613 /* FIXME: OTOH if the buffer position has changed
5614 because of a timer or process filter rather than
5615 because of mouse movement, it should be considered as
5616 a click. But mouse-drag-region completely ignores
5617 this case and it hasn't caused any real problem, so
5618 it's probably OK to ignore it as well. */
5619 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5620 /* Mouse hasn't moved (much). */
5621 event
->modifiers
|= click_modifier
;
5624 button_down_time
= 0;
5625 event
->modifiers
|= drag_modifier
;
5628 /* Don't check is_double; treat this as multiple
5629 if the down-event was multiple. */
5630 if (double_click_count
> 1)
5631 event
->modifiers
|= ((double_click_count
> 2)
5637 /* Every mouse event should either have the down_modifier or
5638 the up_modifier set. */
5642 /* Get the symbol we should use for the mouse click. */
5645 head
= modify_event_symbol (button
,
5647 Qmouse_click
, Vlispy_mouse_stem
,
5650 XVECTOR (mouse_syms
)->size
);
5651 if (event
->modifiers
& drag_modifier
)
5656 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5659 Fcons (make_number (double_click_count
),
5669 case HORIZ_WHEEL_EVENT
:
5671 Lisp_Object position
;
5674 /* Build the position as appropriate for this mouse click. */
5675 struct frame
*f
= XFRAME (event
->frame_or_window
);
5677 /* Ignore wheel events that were made on frame that have been
5679 if (! FRAME_LIVE_P (f
))
5682 position
= make_lispy_position (f
, event
->x
, event
->y
,
5685 /* Set double or triple modifiers to indicate the wheel speed. */
5687 /* On window-system frames, use the value of
5688 double-click-fuzz as is. On other frames, interpret it
5689 as a multiple of 1/8 characters. */
5695 if (WINDOWP (event
->frame_or_window
))
5696 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5697 else if (FRAMEP (event
->frame_or_window
))
5698 fr
= XFRAME (event
->frame_or_window
);
5702 fuzz
= FRAME_WINDOW_P (fr
)
5703 ? double_click_fuzz
: double_click_fuzz
/ 8;
5705 if (event
->modifiers
& up_modifier
)
5707 /* Emit a wheel-up event. */
5708 event
->modifiers
&= ~up_modifier
;
5711 else if (event
->modifiers
& down_modifier
)
5713 /* Emit a wheel-down event. */
5714 event
->modifiers
&= ~down_modifier
;
5718 /* Every wheel event should either have the down_modifier or
5719 the up_modifier set. */
5722 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5725 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5726 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5727 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5728 && button_down_time
!= 0
5729 && (EQ (Vdouble_click_time
, Qt
)
5730 || (INTEGERP (Vdouble_click_time
)
5731 && ((int)(event
->timestamp
- button_down_time
)
5732 < XINT (Vdouble_click_time
)))));
5735 double_click_count
++;
5736 event
->modifiers
|= ((double_click_count
> 2)
5742 double_click_count
= 1;
5743 event
->modifiers
|= click_modifier
;
5746 button_down_time
= event
->timestamp
;
5747 /* Use a negative value to distinguish wheel from mouse button. */
5748 last_mouse_button
= - (1 + symbol_num
);
5749 last_mouse_x
= XINT (event
->x
);
5750 last_mouse_y
= XINT (event
->y
);
5752 /* Get the symbol we should use for the wheel event. */
5753 head
= modify_event_symbol (symbol_num
,
5759 ASIZE (wheel_syms
));
5762 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5765 Fcons (make_number (double_click_count
),
5774 #ifdef USE_TOOLKIT_SCROLL_BARS
5776 /* We don't have down and up events if using toolkit scroll bars,
5777 so make this always a click event. Store in the `part' of
5778 the Lisp event a symbol which maps to the following actions:
5780 `above_handle' page up
5781 `below_handle' page down
5785 `bottom' bottom of buffer
5786 `handle' thumb has been dragged.
5787 `end-scroll' end of interaction with scroll bar
5789 The incoming input_event contains in its `part' member an
5790 index of type `enum scroll_bar_part' which we can use as an
5791 index in scroll_bar_parts to get the appropriate symbol. */
5793 case SCROLL_BAR_CLICK_EVENT
:
5795 Lisp_Object position
, head
, window
, portion_whole
, part
;
5797 window
= event
->frame_or_window
;
5798 portion_whole
= Fcons (event
->x
, event
->y
);
5799 part
= *scroll_bar_parts
[(int) event
->part
];
5803 Fcons (Qvertical_scroll_bar
,
5804 Fcons (portion_whole
,
5805 Fcons (make_number (event
->timestamp
),
5806 Fcons (part
, Qnil
)))));
5808 /* Always treat scroll bar events as clicks. */
5809 event
->modifiers
|= click_modifier
;
5810 event
->modifiers
&= ~up_modifier
;
5812 if (event
->code
>= ASIZE (mouse_syms
))
5813 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5815 /* Get the symbol we should use for the mouse click. */
5816 head
= modify_event_symbol (event
->code
,
5821 XVECTOR (mouse_syms
)->size
);
5822 return Fcons (head
, Fcons (position
, Qnil
));
5825 #endif /* USE_TOOLKIT_SCROLL_BARS */
5827 case DRAG_N_DROP_EVENT
:
5830 Lisp_Object head
, position
;
5833 f
= XFRAME (event
->frame_or_window
);
5836 /* Ignore mouse events that were made on frames that
5837 have been deleted. */
5838 if (! FRAME_LIVE_P (f
))
5841 position
= make_lispy_position (f
, event
->x
, event
->y
,
5844 head
= modify_event_symbol (0, event
->modifiers
,
5846 lispy_drag_n_drop_names
,
5847 &drag_n_drop_syms
, 1);
5853 #endif /* HAVE_MOUSE */
5855 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5856 || defined(HAVE_NS) || defined (USE_GTK)
5857 case MENU_BAR_EVENT
:
5858 if (EQ (event
->arg
, event
->frame_or_window
))
5859 /* This is the prefix key. We translate this to
5860 `(menu_bar)' because the code in keyboard.c for menu
5861 events, which we use, relies on this. */
5862 return Fcons (Qmenu_bar
, Qnil
);
5866 case SELECT_WINDOW_EVENT
:
5867 /* Make an event (select-window (WINDOW)). */
5868 return Fcons (Qselect_window
,
5869 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5872 case TOOL_BAR_EVENT
:
5873 if (EQ (event
->arg
, event
->frame_or_window
))
5874 /* This is the prefix key. We translate this to
5875 `(tool_bar)' because the code in keyboard.c for tool bar
5876 events, which we use, relies on this. */
5877 return Fcons (Qtool_bar
, Qnil
);
5878 else if (SYMBOLP (event
->arg
))
5879 return apply_modifiers (event
->modifiers
, event
->arg
);
5882 case USER_SIGNAL_EVENT
:
5883 /* A user signal. */
5885 char *name
= find_user_signal_name (event
->code
);
5888 return intern (name
);
5891 case SAVE_SESSION_EVENT
:
5892 return Qsave_session
;
5897 return Fcons (Qdbus_event
, event
->arg
);
5899 #endif /* HAVE_DBUS */
5901 case CONFIG_CHANGED_EVENT
:
5902 return Fcons (Qconfig_changed_event
,
5904 Fcons (event
->frame_or_window
, Qnil
)));
5906 case GPM_CLICK_EVENT
:
5908 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5909 Lisp_Object head
, position
;
5910 Lisp_Object
*start_pos_ptr
;
5911 Lisp_Object start_pos
;
5912 int button
= event
->code
;
5914 if (button
>= ASIZE (button_down_location
))
5916 button_down_location
= larger_vector (button_down_location
,
5918 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5921 start_pos_ptr
= &AREF (button_down_location
, button
);
5922 start_pos
= *start_pos_ptr
;
5924 position
= make_lispy_position (f
, event
->x
, event
->y
,
5927 if (event
->modifiers
& down_modifier
)
5928 *start_pos_ptr
= Fcopy_alist (position
);
5929 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5931 if (!CONSP (start_pos
))
5933 event
->modifiers
&= ~up_modifier
;
5936 head
= modify_event_symbol (button
,
5938 Qmouse_click
, Vlispy_mouse_stem
,
5941 XVECTOR (mouse_syms
)->size
);
5943 if (event
->modifiers
& drag_modifier
)
5948 else if (event
->modifiers
& double_modifier
)
5951 Fcons (make_number (2),
5953 else if (event
->modifiers
& triple_modifier
)
5956 Fcons (make_number (3),
5963 #endif /* HAVE_GPM */
5965 /* The 'kind' field of the event is something we don't recognize. */
5971 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
5974 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5975 Lisp_Object x
, Lisp_Object y
, unsigned long t
)
5977 /* Is it a scroll bar movement? */
5978 if (frame
&& ! NILP (bar_window
))
5980 Lisp_Object part_sym
;
5982 part_sym
= *scroll_bar_parts
[(int) part
];
5983 return Fcons (Qscroll_bar_movement
,
5984 Fcons (list5 (bar_window
,
5985 Qvertical_scroll_bar
,
5991 /* Or is it an ordinary mouse movement? */
5994 Lisp_Object position
;
5995 position
= make_lispy_position (frame
, x
, y
, t
);
5996 return list2 (Qmouse_movement
, position
);
6000 #endif /* HAVE_MOUSE || HAVE GPM */
6002 /* Construct a switch frame event. */
6004 make_lispy_switch_frame (Lisp_Object frame
)
6006 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6009 /* Manipulating modifiers. */
6011 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6013 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6014 SYMBOL's name of the end of the modifiers; the string from this
6015 position is the unmodified symbol name.
6017 This doesn't use any caches. */
6020 parse_modifiers_uncached (Lisp_Object symbol
, EMACS_INT
*modifier_end
)
6026 CHECK_SYMBOL (symbol
);
6029 name
= SYMBOL_NAME (symbol
);
6031 for (i
= 0; i
+2 <= SBYTES (name
); )
6033 EMACS_INT this_mod_end
= 0;
6036 /* See if the name continues with a modifier word.
6037 Check that the word appears, but don't check what follows it.
6038 Set this_mod and this_mod_end to record what we find. */
6040 switch (SREF (name
, i
))
6042 #define SINGLE_LETTER_MOD(BIT) \
6043 (this_mod_end = i + 1, this_mod = BIT)
6046 SINGLE_LETTER_MOD (alt_modifier
);
6050 SINGLE_LETTER_MOD (ctrl_modifier
);
6054 SINGLE_LETTER_MOD (hyper_modifier
);
6058 SINGLE_LETTER_MOD (meta_modifier
);
6062 SINGLE_LETTER_MOD (shift_modifier
);
6066 SINGLE_LETTER_MOD (super_modifier
);
6069 #undef SINGLE_LETTER_MOD
6071 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6072 if (i + LEN + 1 <= SBYTES (name) \
6073 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6075 this_mod_end = i + LEN; \
6080 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6081 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6082 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6086 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6088 #undef MULTI_LETTER_MOD
6092 /* If we found no modifier, stop looking for them. */
6093 if (this_mod_end
== 0)
6096 /* Check there is a dash after the modifier, so that it
6097 really is a modifier. */
6098 if (this_mod_end
>= SBYTES (name
)
6099 || SREF (name
, this_mod_end
) != '-')
6102 /* This modifier is real; look for another. */
6103 modifiers
|= this_mod
;
6104 i
= this_mod_end
+ 1;
6107 /* Should we include the `click' modifier? */
6108 if (! (modifiers
& (down_modifier
| drag_modifier
6109 | double_modifier
| triple_modifier
))
6110 && i
+ 7 == SBYTES (name
)
6111 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6112 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6113 modifiers
|= click_modifier
;
6115 if (! (modifiers
& (double_modifier
| triple_modifier
))
6116 && i
+ 6 < SBYTES (name
)
6117 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6118 modifiers
|= click_modifier
;
6126 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6127 prepended to the string BASE[0..BASE_LEN-1].
6128 This doesn't use any caches. */
6130 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6132 /* Since BASE could contain nulls, we can't use intern here; we have
6133 to use Fintern, which expects a genuine Lisp_String, and keeps a
6136 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6142 /* Only the event queue may use the `up' modifier; it should always
6143 be turned into a click or drag event before presented to lisp code. */
6144 if (modifiers
& up_modifier
)
6147 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6148 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6149 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6150 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6151 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6152 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6153 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6154 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6155 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6156 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6157 /* The click modifier is denoted by the absence of other modifiers. */
6161 mod_len
= p
- new_mods
;
6165 Lisp_Object new_name
;
6167 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6168 mod_len
+ base_len_byte
);
6169 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6170 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6172 return Fintern (new_name
, Qnil
);
6177 static const char *const modifier_names
[] =
6179 "up", "down", "drag", "click", "double", "triple", 0, 0,
6180 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6181 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6183 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6185 static Lisp_Object modifier_symbols
;
6187 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6189 lispy_modifier_list (int modifiers
)
6191 Lisp_Object modifier_list
;
6194 modifier_list
= Qnil
;
6195 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6196 if (modifiers
& (1<<i
))
6197 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6200 return modifier_list
;
6204 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6205 where UNMODIFIED is the unmodified form of SYMBOL,
6206 MASK is the set of modifiers present in SYMBOL's name.
6207 This is similar to parse_modifiers_uncached, but uses the cache in
6208 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6209 Qevent_symbol_elements property. */
6211 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6214 parse_modifiers (Lisp_Object symbol
)
6216 Lisp_Object elements
;
6218 if (INTEGERP (symbol
))
6219 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6220 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6222 else if (!SYMBOLP (symbol
))
6225 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6226 if (CONSP (elements
))
6231 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6232 Lisp_Object unmodified
;
6235 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6236 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6239 if (modifiers
& ~INTMASK
)
6241 XSETFASTINT (mask
, modifiers
);
6242 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6244 /* Cache the parsing results on SYMBOL. */
6245 Fput (symbol
, Qevent_symbol_element_mask
,
6247 Fput (symbol
, Qevent_symbol_elements
,
6248 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6250 /* Since we know that SYMBOL is modifiers applied to unmodified,
6251 it would be nice to put that in unmodified's cache.
6252 But we can't, since we're not sure that parse_modifiers is
6259 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6260 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6261 doc
: /* Parse the event symbol. For internal use. */)
6262 (Lisp_Object symbol
)
6264 /* Fill the cache if needed. */
6265 parse_modifiers (symbol
);
6266 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6267 and use the Lispier representation stored on Qevent_symbol_elements
6269 return Fget (symbol
, Qevent_symbol_elements
);
6272 /* Apply the modifiers MODIFIERS to the symbol BASE.
6273 BASE must be unmodified.
6275 This is like apply_modifiers_uncached, but uses BASE's
6276 Qmodifier_cache property, if present. It also builds
6277 Qevent_symbol_elements properties, since it has that info anyway.
6279 apply_modifiers copies the value of BASE's Qevent_kind property to
6280 the modified symbol. */
6282 apply_modifiers (int modifiers
, Lisp_Object base
)
6284 Lisp_Object cache
, idx
, entry
, new_symbol
;
6286 /* Mask out upper bits. We don't know where this value's been. */
6287 modifiers
&= INTMASK
;
6289 if (INTEGERP (base
))
6290 return make_number (XINT (base
) | modifiers
);
6292 /* The click modifier never figures into cache indices. */
6293 cache
= Fget (base
, Qmodifier_cache
);
6294 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6295 entry
= assq_no_quit (idx
, cache
);
6298 new_symbol
= XCDR (entry
);
6301 /* We have to create the symbol ourselves. */
6302 new_symbol
= apply_modifiers_uncached (modifiers
,
6303 SSDATA (SYMBOL_NAME (base
)),
6304 SCHARS (SYMBOL_NAME (base
)),
6305 SBYTES (SYMBOL_NAME (base
)));
6307 /* Add the new symbol to the base's cache. */
6308 entry
= Fcons (idx
, new_symbol
);
6309 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6311 /* We have the parsing info now for free, so we could add it to
6313 XSETFASTINT (idx, modifiers);
6314 Fput (new_symbol, Qevent_symbol_element_mask,
6315 Fcons (base, Fcons (idx, Qnil)));
6316 Fput (new_symbol, Qevent_symbol_elements,
6317 Fcons (base, lispy_modifier_list (modifiers)));
6318 Sadly, this is only correct if `base' is indeed a base event,
6319 which is not necessarily the case. -stef */
6322 /* Make sure this symbol is of the same kind as BASE.
6324 You'd think we could just set this once and for all when we
6325 intern the symbol above, but reorder_modifiers may call us when
6326 BASE's property isn't set right; we can't assume that just
6327 because it has a Qmodifier_cache property it must have its
6328 Qevent_kind set right as well. */
6329 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6333 kind
= Fget (base
, Qevent_kind
);
6335 Fput (new_symbol
, Qevent_kind
, kind
);
6342 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6343 return a symbol with the modifiers placed in the canonical order.
6344 Canonical order is alphabetical, except for down and drag, which
6345 always come last. The 'click' modifier is never written out.
6347 Fdefine_key calls this to make sure that (for example) C-M-foo
6348 and M-C-foo end up being equivalent in the keymap. */
6351 reorder_modifiers (Lisp_Object symbol
)
6353 /* It's hopefully okay to write the code this way, since everything
6354 will soon be in caches, and no consing will be done at all. */
6357 parsed
= parse_modifiers (symbol
);
6358 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6363 /* For handling events, we often want to produce a symbol whose name
6364 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6365 to some base, like the name of a function key or mouse button.
6366 modify_event_symbol produces symbols of this sort.
6368 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6369 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6372 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6373 into symbol names, or a string specifying a name stem used to
6374 construct a symbol name or the form `STEM-N', where N is the decimal
6375 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6376 non-nil; otherwise NAME_TABLE is used.
6378 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6379 persist between calls to modify_event_symbol that it can use to
6380 store a cache of the symbols it's generated for this NAME_TABLE
6381 before. The object stored there may be a vector or an alist.
6383 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6385 MODIFIERS is a set of modifier bits (as given in struct input_events)
6386 whose prefixes should be applied to the symbol name.
6388 SYMBOL_KIND is the value to be placed in the event_kind property of
6389 the returned symbol.
6391 The symbols we create are supposed to have an
6392 `event-symbol-elements' property, which lists the modifiers present
6393 in the symbol's name. */
6396 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6397 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6398 Lisp_Object
*symbol_table
, unsigned int table_size
)
6401 Lisp_Object symbol_int
;
6403 /* Get rid of the "vendor-specific" bit here. */
6404 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6406 /* Is this a request for a valid symbol? */
6407 if (symbol_num
< 0 || symbol_num
>= table_size
)
6410 if (CONSP (*symbol_table
))
6411 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6413 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6414 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6415 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6416 we've never used that symbol before. */
6419 if (! VECTORP (*symbol_table
)
6420 || XVECTOR (*symbol_table
)->size
!= table_size
)
6424 XSETFASTINT (size
, table_size
);
6425 *symbol_table
= Fmake_vector (size
, Qnil
);
6428 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6431 /* Have we already used this symbol before? */
6434 /* No; let's create it. */
6435 if (CONSP (name_alist_or_stem
))
6436 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6437 else if (STRINGP (name_alist_or_stem
))
6439 int len
= SBYTES (name_alist_or_stem
);
6440 char *buf
= (char *) alloca (len
+ 50);
6441 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6442 (long) XINT (symbol_int
) + 1);
6443 value
= intern (buf
);
6445 else if (name_table
!= 0 && name_table
[symbol_num
])
6446 value
= intern (name_table
[symbol_num
]);
6448 #ifdef HAVE_WINDOW_SYSTEM
6451 char *name
= x_get_keysym_name (symbol_num
);
6453 value
= intern (name
);
6460 sprintf (buf
, "key-%ld", (long)symbol_num
);
6461 value
= intern (buf
);
6464 if (CONSP (*symbol_table
))
6465 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6467 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6469 /* Fill in the cache entries for this symbol; this also
6470 builds the Qevent_symbol_elements property, which the user
6472 apply_modifiers (modifiers
& click_modifier
, value
);
6473 Fput (value
, Qevent_kind
, symbol_kind
);
6476 /* Apply modifiers to that symbol. */
6477 return apply_modifiers (modifiers
, value
);
6480 /* Convert a list that represents an event type,
6481 such as (ctrl meta backspace), into the usual representation of that
6482 event type as a number or a symbol. */
6484 DEFUE ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6485 doc
: /* Convert the event description list EVENT-DESC to an event type.
6486 EVENT-DESC should contain one base event type (a character or symbol)
6487 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6488 drag, down, double or triple). The base must be last.
6489 The return value is an event type (a character or symbol) which
6490 has the same base event type and all the specified modifiers. */)
6491 (Lisp_Object event_desc
)
6499 while (CONSP (rest
))
6507 /* Given a symbol, see if it is a modifier name. */
6508 if (SYMBOLP (elt
) && CONSP (rest
))
6509 this = parse_solitary_modifier (elt
);
6513 else if (!NILP (base
))
6514 error ("Two bases given in one event");
6520 /* Let the symbol A refer to the character A. */
6521 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6522 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6524 if (INTEGERP (base
))
6526 /* Turn (shift a) into A. */
6527 if ((modifiers
& shift_modifier
) != 0
6528 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6530 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6531 modifiers
&= ~shift_modifier
;
6534 /* Turn (control a) into C-a. */
6535 if (modifiers
& ctrl_modifier
)
6536 return make_number ((modifiers
& ~ctrl_modifier
)
6537 | make_ctrl_char (XINT (base
)));
6539 return make_number (modifiers
| XINT (base
));
6541 else if (SYMBOLP (base
))
6542 return apply_modifiers (modifiers
, base
);
6545 error ("Invalid base event");
6550 /* Try to recognize SYMBOL as a modifier name.
6551 Return the modifier flag bit, or 0 if not recognized. */
6554 parse_solitary_modifier (Lisp_Object symbol
)
6556 Lisp_Object name
= SYMBOL_NAME (symbol
);
6558 switch (SREF (name
, 0))
6560 #define SINGLE_LETTER_MOD(BIT) \
6561 if (SBYTES (name) == 1) \
6564 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6565 if (LEN == SBYTES (name) \
6566 && ! strncmp (SSDATA (name), NAME, LEN)) \
6570 SINGLE_LETTER_MOD (alt_modifier
);
6574 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6578 SINGLE_LETTER_MOD (ctrl_modifier
);
6582 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6583 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6587 SINGLE_LETTER_MOD (hyper_modifier
);
6591 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6595 SINGLE_LETTER_MOD (meta_modifier
);
6599 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6603 SINGLE_LETTER_MOD (shift_modifier
);
6607 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6608 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6609 SINGLE_LETTER_MOD (super_modifier
);
6613 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6614 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6615 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6619 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6622 #undef SINGLE_LETTER_MOD
6623 #undef MULTI_LETTER_MOD
6629 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6630 Such a list is not valid as an event,
6631 but it can be a Lucid-style event type list. */
6634 lucid_event_type_list_p (Lisp_Object object
)
6638 if (! CONSP (object
))
6641 if (EQ (XCAR (object
), Qhelp_echo
)
6642 || EQ (XCAR (object
), Qvertical_line
)
6643 || EQ (XCAR (object
), Qmode_line
)
6644 || EQ (XCAR (object
), Qheader_line
))
6647 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6651 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6658 /* Store into *addr a value nonzero if terminal input chars are available.
6659 Serves the purpose of ioctl (0, FIONREAD, addr)
6660 but works even if FIONREAD does not exist.
6661 (In fact, this may actually read some input.)
6663 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6664 timer events that are ripe.
6665 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6666 events (FOCUS_IN_EVENT).
6667 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6668 movements and toolkit scroll bar thumb drags. */
6671 get_input_pending (int *addr
, int flags
)
6673 /* First of all, have we already counted some input? */
6674 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6676 /* If input is being read as it arrives, and we have none, there is none. */
6677 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6680 /* Try to read some input and see how much we get. */
6682 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6685 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6688 gobble_input (int expected
)
6691 if (interrupt_input
)
6694 mask
= sigblock (sigmask (SIGIO
));
6695 read_avail_input (expected
);
6699 #ifdef POLL_FOR_INPUT
6700 /* XXX This condition was (read_socket_hook && !interrupt_input),
6701 but read_socket_hook is not global anymore. Let's pretend that
6703 if (!interrupt_input
&& poll_suppress_count
== 0)
6706 mask
= sigblock (sigmask (SIGALRM
));
6707 read_avail_input (expected
);
6713 read_avail_input (expected
);
6716 /* Put a BUFFER_SWITCH_EVENT in the buffer
6717 so that read_key_sequence will notice the new current buffer. */
6720 record_asynch_buffer_change (void)
6722 struct input_event event
;
6726 event
.kind
= BUFFER_SWITCH_EVENT
;
6727 event
.frame_or_window
= Qnil
;
6730 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6731 The purpose of the event is to make read_key_sequence look up the
6732 keymaps again. If we aren't in read_key_sequence, we don't need one,
6733 and the event could cause trouble by messing up (input-pending-p).
6734 Note: Fwaiting_for_user_input_p always returns nil when async
6735 subprocesses aren't supported. */
6736 tem
= Fwaiting_for_user_input_p ();
6740 /* Make sure no interrupt happens while storing the event. */
6742 if (interrupt_input
)
6745 mask
= sigblock (sigmask (SIGIO
));
6746 kbd_buffer_store_event (&event
);
6753 kbd_buffer_store_event (&event
);
6758 /* Read any terminal input already buffered up by the system
6759 into the kbd_buffer, but do not wait.
6761 EXPECTED should be nonzero if the caller knows there is some input.
6763 Returns the number of keyboard chars read, or -1 meaning
6764 this is a bad time to try to read input. */
6767 read_avail_input (int expected
)
6773 /* Store pending user signal events, if any. */
6774 if (store_user_signal_events ())
6777 /* Loop through the available terminals, and call their input hooks. */
6781 struct terminal
*next
= t
->next_terminal
;
6783 if (t
->read_socket_hook
)
6786 struct input_event hold_quit
;
6788 EVENT_INIT (hold_quit
);
6789 hold_quit
.kind
= NO_EVENT
;
6791 /* No need for FIONREAD or fcntl; just say don't wait. */
6792 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6798 if (nr
== -1) /* Not OK to read input now. */
6802 else if (nr
== -2) /* Non-transient error. */
6804 /* The terminal device terminated; it should be closed. */
6806 /* Kill Emacs if this was our last terminal. */
6807 if (!terminal_list
->next_terminal
)
6808 /* Formerly simply reported no input, but that
6809 sometimes led to a failure of Emacs to terminate.
6810 SIGHUP seems appropriate if we can't reach the
6812 /* ??? Is it really right to send the signal just to
6813 this process rather than to the whole process
6814 group? Perhaps on systems with FIONREAD Emacs is
6815 alone in its group. */
6816 kill (getpid (), SIGHUP
);
6818 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6821 XSETTERMINAL (tmp
, t
);
6822 Fdelete_terminal (tmp
, Qnoelisp
);
6826 if (hold_quit
.kind
!= NO_EVENT
)
6827 kbd_buffer_store_event (&hold_quit
);
6836 frame_make_pointer_visible ();
6842 decode_keyboard_code (struct tty_display_info
*tty
,
6843 struct coding_system
*coding
,
6844 unsigned char *buf
, int nbytes
)
6846 unsigned char *src
= buf
;
6847 const unsigned char *p
;
6852 if (tty
->meta_key
!= 2)
6853 for (i
= 0; i
< nbytes
; i
++)
6855 if (coding
->carryover_bytes
> 0)
6857 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6858 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6859 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6860 nbytes
+= coding
->carryover_bytes
;
6862 coding
->destination
= alloca (nbytes
* 4);
6863 coding
->dst_bytes
= nbytes
* 4;
6864 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6865 if (coding
->produced_char
== 0)
6867 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6869 struct input_event event_buf
;
6871 EVENT_INIT (event_buf
);
6872 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6874 (ASCII_CHAR_P (event_buf
.code
)
6875 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6876 /* See the comment in tty_read_avail_input. */
6877 event_buf
.frame_or_window
= tty
->top_frame
;
6878 event_buf
.arg
= Qnil
;
6879 kbd_buffer_store_event (&event_buf
);
6883 /* This is the tty way of reading available input.
6885 Note that each terminal device has its own `struct terminal' object,
6886 and so this function is called once for each individual termcap
6887 terminal. The first parameter indicates which terminal to read from. */
6890 tty_read_avail_input (struct terminal
*terminal
,
6892 struct input_event
*hold_quit
)
6894 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6895 the kbd_buffer can really hold. That may prevent loss
6896 of characters on some systems when input is stuffed at us. */
6897 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6899 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6902 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6904 if (kbd_on_hold_p () || buffer_free
<= 0)
6906 #endif /* subprocesses */
6908 if (!terminal
->name
) /* Don't read from a dead terminal. */
6911 if (terminal
->type
!= output_termcap
6912 && terminal
->type
!= output_msdos_raw
)
6915 /* XXX I think the following code should be moved to separate hook
6916 functions in system-dependent files. */
6919 #else /* not WINDOWSNT */
6920 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6924 return 0; /* The terminal is suspended. */
6927 n_to_read
= dos_keysns ();
6931 cbuf
[0] = dos_keyread ();
6934 #else /* not MSDOS */
6939 struct input_event gpm_hold_quit
;
6940 int gpm
, fd
= gpm_fd
;
6942 EVENT_INIT (gpm_hold_quit
);
6943 gpm_hold_quit
.kind
= NO_EVENT
;
6945 /* gpm==1 if event received.
6946 gpm==0 if the GPM daemon has closed the connection, in which case
6947 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6948 we save it in `fd' so close_gpm can remove it from the
6950 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6951 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6952 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6955 /* Presumably the GPM daemon has closed the connection. */
6957 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6958 kbd_buffer_store_event (&gpm_hold_quit
);
6962 #endif /* HAVE_GPM */
6964 /* Determine how many characters we should *try* to read. */
6966 /* Find out how much input is available. */
6967 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6969 if (! noninteractive
)
6970 return -2; /* Close this terminal. */
6976 if (n_to_read
> sizeof cbuf
)
6977 n_to_read
= sizeof cbuf
;
6978 #else /* no FIONREAD */
6979 #if defined (USG) || defined(CYGWIN)
6980 /* Read some input if available, but don't wait. */
6981 n_to_read
= sizeof cbuf
;
6982 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6989 /* Don't read more than we can store. */
6990 if (n_to_read
> buffer_free
)
6991 n_to_read
= buffer_free
;
6992 #endif /* subprocesses */
6994 /* Now read; for one reason or another, this will not block.
6995 NREAD is set to the number of chars read. */
6998 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6999 /* POSIX infers that processes which are not in the session leader's
7000 process group won't get SIGHUP's at logout time. BSDI adheres to
7001 this part standard and returns -1 from read (0) with errno==EIO
7002 when the control tty is taken away.
7003 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7004 if (nread
== -1 && errno
== EIO
)
7005 return -2; /* Close this terminal. */
7006 #if defined (AIX) && defined (_BSD)
7007 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7008 This looks incorrect, but it isn't, because _BSD causes
7009 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7010 and that causes a value other than 0 when there is no input. */
7012 return -2; /* Close this terminal. */
7016 /* We used to retry the read if it was interrupted.
7017 But this does the wrong thing when O_NDELAY causes
7018 an EAGAIN error. Does anybody know of a situation
7019 where a retry is actually needed? */
7021 nread
< 0 && (errno
== EAGAIN
7035 #if defined (USG) || defined (CYGWIN)
7036 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7037 #endif /* USG or CYGWIN */
7038 #endif /* no FIONREAD */
7043 #endif /* not MSDOS */
7044 #endif /* not WINDOWSNT */
7046 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7047 & CODING_REQUIRE_DECODING_MASK
)
7049 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7052 /* Decode the key sequence except for those with meta
7054 for (i
= from
= 0; ; i
++)
7055 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7057 struct input_event buf
;
7059 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7064 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7065 buf
.modifiers
= meta_modifier
;
7066 buf
.code
= cbuf
[i
] & ~0x80;
7067 /* See the comment below. */
7068 buf
.frame_or_window
= tty
->top_frame
;
7070 kbd_buffer_store_event (&buf
);
7076 for (i
= 0; i
< nread
; i
++)
7078 struct input_event buf
;
7080 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7082 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7083 buf
.modifiers
= meta_modifier
;
7084 if (tty
->meta_key
!= 2)
7088 /* Set the frame corresponding to the active tty. Note that the
7089 value of selected_frame is not reliable here, redisplay tends
7090 to temporarily change it. */
7091 buf
.frame_or_window
= tty
->top_frame
;
7094 kbd_buffer_store_event (&buf
);
7095 /* Don't look at input that follows a C-g too closely.
7096 This reduces lossage due to autorepeat on C-g. */
7097 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7098 && buf
.code
== quit_char
)
7106 handle_async_input (void)
7108 interrupt_input_pending
= 0;
7110 pending_signals
= pending_atimers
;
7112 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7113 doing anything dangerous. */
7120 nread
= read_avail_input (1);
7121 /* -1 means it's not ok to read the input now.
7122 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7123 0 means there was no keyboard input available. */
7133 process_pending_signals (void)
7135 if (interrupt_input_pending
)
7136 handle_async_input ();
7137 do_pending_atimers ();
7140 #ifdef SIGIO /* for entire page */
7141 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7144 input_available_signal (int signo
)
7146 /* Must preserve main program's value of errno. */
7147 int old_errno
= errno
;
7148 SIGNAL_THREAD_CHECK (signo
);
7151 interrupt_input_pending
= 1;
7152 pending_signals
= 1;
7155 if (input_available_clear_time
)
7156 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7159 handle_async_input ();
7166 /* Send ourselves a SIGIO.
7168 This function exists so that the UNBLOCK_INPUT macro in
7169 blockinput.h can have some way to take care of input we put off
7170 dealing with, without assuming that every file which uses
7171 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7173 reinvoke_input_signal (void)
7176 handle_async_input ();
7182 /* User signal events. */
7184 struct user_signal_info
7186 /* Signal number. */
7189 /* Name of the signal. */
7192 /* Number of pending signals. */
7195 struct user_signal_info
*next
;
7198 /* List of user signals. */
7199 static struct user_signal_info
*user_signals
= NULL
;
7202 add_user_signal (int sig
, const char *name
)
7204 struct user_signal_info
*p
;
7206 for (p
= user_signals
; p
; p
= p
->next
)
7208 /* Already added. */
7211 p
= xmalloc (sizeof (struct user_signal_info
));
7213 p
->name
= xstrdup (name
);
7215 p
->next
= user_signals
;
7218 signal (sig
, handle_user_signal
);
7222 handle_user_signal (int sig
)
7224 int old_errno
= errno
;
7225 struct user_signal_info
*p
;
7227 SIGNAL_THREAD_CHECK (sig
);
7229 for (p
= user_signals
; p
; p
= p
->next
)
7234 if (interrupt_input
)
7235 kill (getpid (), SIGIO
);
7239 /* Tell wait_reading_process_output that it needs to wake
7240 up and look around. */
7241 if (input_available_clear_time
)
7242 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7251 find_user_signal_name (int sig
)
7253 struct user_signal_info
*p
;
7255 for (p
= user_signals
; p
; p
= p
->next
)
7263 store_user_signal_events (void)
7265 struct user_signal_info
*p
;
7266 struct input_event buf
;
7269 for (p
= user_signals
; p
; p
= p
->next
)
7270 if (p
->npending
> 0)
7276 memset (&buf
, 0, sizeof buf
);
7277 buf
.kind
= USER_SIGNAL_EVENT
;
7278 buf
.frame_or_window
= selected_frame
;
7280 nstored
+= p
->npending
;
7282 mask
= sigblock (sigmask (p
->sig
));
7286 kbd_buffer_store_event (&buf
);
7289 while (p
->npending
> 0);
7297 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7298 static Lisp_Object menu_bar_one_keymap_changed_items
;
7300 /* These variables hold the vector under construction within
7301 menu_bar_items and its subroutines, and the current index
7302 for storing into that vector. */
7303 static Lisp_Object menu_bar_items_vector
;
7304 static int menu_bar_items_index
;
7307 static const char* separator_names
[] = {
7312 "single-dashed-line",
7313 "double-dashed-line",
7315 "shadow-etched-out",
7316 "shadow-etched-in-dash",
7317 "shadow-etched-out-dash",
7318 "shadow-double-etched-in",
7319 "shadow-double-etched-out",
7320 "shadow-double-etched-in-dash",
7321 "shadow-double-etched-out-dash",
7325 /* Return non-zero if LABEL specifies a separator. */
7328 menu_separator_name_p (const char *label
)
7332 else if (strlen (label
) > 3
7333 && strncmp (label
, "--", 2) == 0
7338 for (i
= 0; separator_names
[i
]; ++i
)
7339 if (strcmp (label
, separator_names
[i
]) == 0)
7344 /* It's a separator if it contains only dashes. */
7345 while (*label
== '-')
7347 return (*label
== 0);
7354 /* Return a vector of menu items for a menu bar, appropriate
7355 to the current buffer. Each item has three elements in the vector:
7358 OLD is an old vector we can optionally reuse, or nil. */
7361 menu_bar_items (Lisp_Object old
)
7363 /* The number of keymaps we're scanning right now, and the number of
7364 keymaps we have allocated space for. */
7367 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7368 in the current keymaps, or nil where it is not a prefix. */
7371 Lisp_Object def
, tail
;
7376 /* In order to build the menus, we need to call the keymap
7377 accessors. They all call QUIT. But this function is called
7378 during redisplay, during which a quit is fatal. So inhibit
7379 quitting while building the menus.
7380 We do this instead of specbind because (1) errors will clear it anyway
7381 and (2) this avoids risk of specpdl overflow. */
7382 oquit
= Vinhibit_quit
;
7386 menu_bar_items_vector
= old
;
7388 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7389 menu_bar_items_index
= 0;
7391 /* Build our list of keymaps.
7392 If we recognize a function key and replace its escape sequence in
7393 keybuf with its symbol, or if the sequence starts with a mouse
7394 click and we need to switch buffers, we jump back here to rebuild
7395 the initial keymaps from the current buffer. */
7399 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7400 if (!NILP (Voverriding_local_map_menu_flag
))
7402 /* Yes, use them (if non-nil) as well as the global map. */
7403 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7405 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7406 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7407 if (!NILP (Voverriding_local_map
))
7408 maps
[nmaps
++] = Voverriding_local_map
;
7412 /* No, so use major and minor mode keymaps and keymap property.
7413 Note that menu-bar bindings in the local-map and keymap
7414 properties may not work reliable, as they are only
7415 recognized when the menu-bar (or mode-line) is updated,
7416 which does not normally happen after every command. */
7419 nminor
= current_minor_maps (NULL
, &tmaps
);
7420 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7422 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7423 maps
[nmaps
++] = tem
;
7424 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7426 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7428 maps
[nmaps
++] = current_global_map
;
7431 /* Look up in each map the dummy prefix key `menu-bar'. */
7433 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7434 if (!NILP (maps
[mapno
]))
7436 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7440 menu_bar_one_keymap_changed_items
= Qnil
;
7441 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7445 /* Move to the end those items that should be at the end. */
7447 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7450 int end
= menu_bar_items_index
;
7452 for (i
= 0; i
< end
; i
+= 4)
7453 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7455 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7456 /* Move the item at index I to the end,
7457 shifting all the others forward. */
7458 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7459 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7460 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7461 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7463 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7464 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7465 (end
- i
- 4) * sizeof (Lisp_Object
));
7466 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7467 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7468 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7469 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7474 /* Add nil, nil, nil, nil at the end. */
7476 int i
= menu_bar_items_index
;
7477 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7478 menu_bar_items_vector
=
7479 larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7480 /* Add this item. */
7481 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7482 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7483 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7484 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7485 menu_bar_items_index
= i
;
7488 Vinhibit_quit
= oquit
;
7489 return menu_bar_items_vector
;
7492 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7493 If there's already an item for KEY, add this DEF to it. */
7495 Lisp_Object item_properties
;
7498 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7500 struct gcpro gcpro1
;
7504 if (EQ (item
, Qundefined
))
7506 /* If a map has an explicit `undefined' as definition,
7507 discard any previously made menu bar item. */
7509 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7510 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7512 if (menu_bar_items_index
> i
+ 4)
7513 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7514 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7515 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7516 menu_bar_items_index
-= 4;
7520 /* If this keymap has already contributed to this KEY,
7521 don't contribute to it a second time. */
7522 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7523 if (!NILP (tem
) || NILP (item
))
7526 menu_bar_one_keymap_changed_items
7527 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7529 /* We add to menu_bar_one_keymap_changed_items before doing the
7530 parse_menu_item, so that if it turns out it wasn't a menu item,
7531 it still correctly hides any further menu item. */
7533 i
= parse_menu_item (item
, 1);
7538 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7540 /* Find any existing item for this KEY. */
7541 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7542 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7545 /* If we did not find this KEY, add it at the end. */
7546 if (i
== menu_bar_items_index
)
7548 /* If vector is too small, get a bigger one. */
7549 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7550 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7551 /* Add this item. */
7552 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7553 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7554 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7555 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7556 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7557 menu_bar_items_index
= i
;
7559 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7563 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7564 /* If the new and the old items are not both keymaps,
7565 the lookup will only find `item'. */
7566 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7567 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7571 /* This is used as the handler when calling menu_item_eval_property. */
7573 menu_item_eval_property_1 (Lisp_Object arg
)
7575 /* If we got a quit from within the menu computation,
7576 quit all the way out of it. This takes care of C-] in the debugger. */
7577 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7578 Fsignal (Qquit
, Qnil
);
7584 eval_dyn (Lisp_Object form
)
7586 return Feval (form
, Qnil
);
7589 /* Evaluate an expression and return the result (or nil if something
7590 went wrong). Used to evaluate dynamic parts of menu items. */
7592 menu_item_eval_property (Lisp_Object sexpr
)
7594 int count
= SPECPDL_INDEX ();
7596 specbind (Qinhibit_redisplay
, Qt
);
7597 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7598 menu_item_eval_property_1
);
7599 return unbind_to (count
, val
);
7602 /* This function parses a menu item and leaves the result in the
7603 vector item_properties.
7604 ITEM is a key binding, a possible menu item.
7605 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7607 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7608 parse_menu_item returns true if the item is a menu item and false
7612 parse_menu_item (Lisp_Object item
, int inmenubar
)
7614 Lisp_Object def
, tem
, item_string
, start
;
7616 Lisp_Object keyhint
;
7625 /* Create item_properties vector if necessary. */
7626 if (NILP (item_properties
))
7628 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7630 /* Initialize optional entries. */
7631 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7632 ASET (item_properties
, i
, Qnil
);
7633 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7635 /* Save the item here to protect it from GC. */
7636 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7638 item_string
= XCAR (item
);
7642 if (STRINGP (item_string
))
7644 /* Old format menu item. */
7645 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7647 /* Maybe help string. */
7648 if (CONSP (item
) && STRINGP (XCAR (item
)))
7650 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7655 /* Maybe an obsolete key binding cache. */
7656 if (CONSP (item
) && CONSP (XCAR (item
))
7657 && (NILP (XCAR (XCAR (item
)))
7658 || VECTORP (XCAR (XCAR (item
)))))
7661 /* This is the real definition--the function to run. */
7662 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7664 /* Get enable property, if any. */
7667 tem
= Fget (item
, Qmenu_enable
);
7668 if (!NILP (Venable_disabled_menus_and_buttons
))
7669 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7670 else if (!NILP (tem
))
7671 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7674 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7676 /* New format menu item. */
7677 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7678 start
= XCDR (item
);
7681 /* We have a real binding. */
7682 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7684 item
= XCDR (start
);
7685 /* Is there an obsolete cache list with key equivalences. */
7686 if (CONSP (item
) && CONSP (XCAR (item
)))
7689 /* Parse properties. */
7690 while (CONSP (item
) && CONSP (XCDR (item
)))
7695 if (EQ (tem
, QCenable
))
7697 if (!NILP (Venable_disabled_menus_and_buttons
))
7698 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7700 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7702 else if (EQ (tem
, QCvisible
))
7704 /* If got a visible property and that evaluates to nil
7705 then ignore this item. */
7706 tem
= menu_item_eval_property (XCAR (item
));
7710 else if (EQ (tem
, QChelp
))
7711 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7712 else if (EQ (tem
, QCfilter
))
7714 else if (EQ (tem
, QCkey_sequence
))
7717 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7718 /* Be GC protected. Set keyhint to item instead of tem. */
7721 else if (EQ (tem
, QCkeys
))
7724 if (CONSP (tem
) || STRINGP (tem
))
7725 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7727 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7732 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7734 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7736 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7742 else if (inmenubar
|| !NILP (start
))
7746 return 0; /* not a menu item */
7748 /* If item string is not a string, evaluate it to get string.
7749 If we don't get a string, skip this item. */
7750 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7751 if (!(STRINGP (item_string
)))
7753 item_string
= menu_item_eval_property (item_string
);
7754 if (!STRINGP (item_string
))
7756 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7759 /* If got a filter apply it on definition. */
7760 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7763 def
= menu_item_eval_property (list2 (XCAR (filter
),
7764 list2 (Qquote
, def
)));
7766 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7769 /* Enable or disable selection of item. */
7770 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7773 tem
= menu_item_eval_property (tem
);
7774 if (inmenubar
&& NILP (tem
))
7775 return 0; /* Ignore disabled items in menu bar. */
7776 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7779 /* If we got no definition, this item is just unselectable text which
7780 is OK in a submenu but not in the menubar. */
7782 return (inmenubar
? 0 : 1);
7784 /* See if this is a separate pane or a submenu. */
7785 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7786 tem
= get_keymap (def
, 0, 1);
7787 /* For a subkeymap, just record its details and exit. */
7790 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7791 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7795 /* At the top level in the menu bar, do likewise for commands also.
7796 The menu bar does not display equivalent key bindings anyway.
7797 ITEM_PROPERTY_DEF is already set up properly. */
7801 { /* This is a command. See if there is an equivalent key binding. */
7802 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7804 /* The previous code preferred :key-sequence to :keys, so we
7805 preserve this behavior. */
7806 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7807 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7810 Lisp_Object prefix
= keyeq
;
7811 Lisp_Object keys
= Qnil
;
7815 def
= XCAR (prefix
);
7816 prefix
= XCDR (prefix
);
7819 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7821 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7823 keys
= XCAR (keyhint
);
7824 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7826 /* We have a suggested key. Is it bound to the command? */
7829 /* If the command is an alias for another
7830 (such as lmenu.el set it up), check if the
7831 original command matches the cached command. */
7832 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7837 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7841 tem
= Fkey_description (keys
, Qnil
);
7844 if (STRINGP (XCAR (prefix
)))
7845 tem
= concat2 (XCAR (prefix
), tem
);
7846 if (STRINGP (XCDR (prefix
)))
7847 tem
= concat2 (tem
, XCDR (prefix
));
7849 keyeq
= concat2 (build_string (" "), tem
);
7850 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7856 /* If we have an equivalent key binding, use that. */
7857 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7860 /* Include this when menu help is implemented.
7861 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7862 if (!(NILP (tem) || STRINGP (tem)))
7864 tem = menu_item_eval_property (tem);
7867 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7871 /* Handle radio buttons or toggle boxes. */
7872 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7874 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7875 menu_item_eval_property (tem
));
7882 /***********************************************************************
7884 ***********************************************************************/
7886 /* A vector holding tool bar items while they are parsed in function
7887 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7890 static Lisp_Object tool_bar_items_vector
;
7892 /* A vector holding the result of parse_tool_bar_item. Layout is like
7893 the one for a single item in tool_bar_items_vector. */
7895 static Lisp_Object tool_bar_item_properties
;
7897 /* Next free index in tool_bar_items_vector. */
7899 static int ntool_bar_items
;
7901 /* The symbols `:image' and `:rtl'. */
7903 static Lisp_Object QCimage
;
7904 static Lisp_Object Qrtl
;
7906 /* Function prototypes. */
7908 static void init_tool_bar_items (Lisp_Object
);
7909 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7910 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7911 static void append_tool_bar_item (void);
7914 /* Return a vector of tool bar items for keymaps currently in effect.
7915 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7916 tool bar items found. */
7919 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7928 /* In order to build the menus, we need to call the keymap
7929 accessors. They all call QUIT. But this function is called
7930 during redisplay, during which a quit is fatal. So inhibit
7931 quitting while building the menus. We do this instead of
7932 specbind because (1) errors will clear it anyway and (2) this
7933 avoids risk of specpdl overflow. */
7934 oquit
= Vinhibit_quit
;
7937 /* Initialize tool_bar_items_vector and protect it from GC. */
7938 init_tool_bar_items (reuse
);
7940 /* Build list of keymaps in maps. Set nmaps to the number of maps
7943 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7944 if (!NILP (Voverriding_local_map_menu_flag
))
7946 /* Yes, use them (if non-nil) as well as the global map. */
7947 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7949 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7950 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7951 if (!NILP (Voverriding_local_map
))
7952 maps
[nmaps
++] = Voverriding_local_map
;
7956 /* No, so use major and minor mode keymaps and keymap property.
7957 Note that tool-bar bindings in the local-map and keymap
7958 properties may not work reliable, as they are only
7959 recognized when the tool-bar (or mode-line) is updated,
7960 which does not normally happen after every command. */
7963 nminor
= current_minor_maps (NULL
, &tmaps
);
7964 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7966 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7967 maps
[nmaps
++] = tem
;
7968 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7970 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7973 /* Add global keymap at the end. */
7974 maps
[nmaps
++] = current_global_map
;
7976 /* Process maps in reverse order and look up in each map the prefix
7978 for (i
= nmaps
- 1; i
>= 0; --i
)
7979 if (!NILP (maps
[i
]))
7983 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7985 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7988 Vinhibit_quit
= oquit
;
7989 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7990 return tool_bar_items_vector
;
7994 /* Process the definition of KEY which is DEF. */
7997 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8000 struct gcpro gcpro1
, gcpro2
;
8002 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8006 if (EQ (def
, Qundefined
))
8008 /* If a map has an explicit `undefined' as definition,
8009 discard any previously made item. */
8010 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8012 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8014 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8016 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8017 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8018 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8019 * sizeof (Lisp_Object
)));
8020 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8025 else if (parse_tool_bar_item (key
, def
))
8026 /* Append a new tool bar item to tool_bar_items_vector. Accept
8027 more than one definition for the same key. */
8028 append_tool_bar_item ();
8034 /* Parse a tool bar item specification ITEM for key KEY and return the
8035 result in tool_bar_item_properties. Value is zero if ITEM is
8038 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8040 CAPTION is the caption of the item, If it's not a string, it is
8041 evaluated to get a string.
8043 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8044 as binding are currently ignored.
8046 The following properties are recognized:
8050 FORM is evaluated and specifies whether the tool bar item is
8051 enabled or disabled.
8055 FORM is evaluated and specifies whether the tool bar item is visible.
8057 - `:filter FUNCTION'
8059 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8060 result is stored as the new binding.
8062 - `:button (TYPE SELECTED)'
8064 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8065 and specifies whether the button is selected (pressed) or not.
8069 IMAGES is either a single image specification or a vector of four
8070 image specifications. See enum tool_bar_item_images.
8072 - `:help HELP-STRING'.
8074 Gives a help string to display for the tool bar item.
8076 - `:label LABEL-STRING'.
8078 A text label to show with the tool bar button if labels are enabled. */
8081 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8083 /* Access slot with index IDX of vector tool_bar_item_properties. */
8084 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8086 Lisp_Object filter
= Qnil
;
8087 Lisp_Object caption
;
8088 int i
, have_label
= 0;
8090 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8091 Rule out items that aren't lists, don't start with
8092 `menu-item' or whose rest following `tool-bar-item' is not a
8097 /* As an exception, allow old-style menu separators. */
8098 if (STRINGP (XCAR (item
)))
8099 item
= Fcons (XCAR (item
), Qnil
);
8100 else if (!EQ (XCAR (item
), Qmenu_item
)
8101 || (item
= XCDR (item
), !CONSP (item
)))
8104 /* Create tool_bar_item_properties vector if necessary. Reset it to
8106 if (VECTORP (tool_bar_item_properties
))
8108 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8112 tool_bar_item_properties
8113 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8116 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8117 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8119 /* Get the caption of the item. If the caption is not a string,
8120 evaluate it to get a string. If we don't get a string, skip this
8122 caption
= XCAR (item
);
8123 if (!STRINGP (caption
))
8125 caption
= menu_item_eval_property (caption
);
8126 if (!STRINGP (caption
))
8129 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8131 /* If the rest following the caption is not a list, the menu item is
8132 either a separator, or invalid. */
8136 if (menu_separator_name_p (SSDATA (caption
)))
8138 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8139 #if !defined (USE_GTK) && !defined (HAVE_NS)
8140 /* If we use build_desired_tool_bar_string to render the
8141 tool bar, the separator is rendered as an image. */
8142 PROP (TOOL_BAR_ITEM_IMAGES
)
8143 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8144 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8145 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8146 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8153 /* Store the binding. */
8154 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8157 /* Ignore cached key binding, if any. */
8158 if (CONSP (item
) && CONSP (XCAR (item
)))
8161 /* Process the rest of the properties. */
8162 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8164 Lisp_Object ikey
, value
;
8167 value
= XCAR (XCDR (item
));
8169 if (EQ (ikey
, QCenable
))
8171 /* `:enable FORM'. */
8172 if (!NILP (Venable_disabled_menus_and_buttons
))
8173 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8175 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8177 else if (EQ (ikey
, QCvisible
))
8179 /* `:visible FORM'. If got a visible property and that
8180 evaluates to nil then ignore this item. */
8181 if (NILP (menu_item_eval_property (value
)))
8184 else if (EQ (ikey
, QChelp
))
8185 /* `:help HELP-STRING'. */
8186 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8187 else if (EQ (ikey
, QCvert_only
))
8188 /* `:vert-only t/nil'. */
8189 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8190 else if (EQ (ikey
, QClabel
))
8192 const char *bad_label
= "!!?GARBLED ITEM?!!";
8193 /* `:label LABEL-STRING'. */
8194 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8196 : make_string (bad_label
, strlen (bad_label
));
8199 else if (EQ (ikey
, QCfilter
))
8200 /* ':filter FORM'. */
8202 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8204 /* `:button (TYPE . SELECTED)'. */
8205 Lisp_Object type
, selected
;
8207 type
= XCAR (value
);
8208 selected
= XCDR (value
);
8209 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8211 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8212 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8215 else if (EQ (ikey
, QCimage
)
8217 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8218 /* Value is either a single image specification or a vector
8219 of 4 such specifications for the different button states. */
8220 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8221 else if (EQ (ikey
, Qrtl
))
8223 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8229 /* Try to make one from caption and key. */
8230 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8231 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8232 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8233 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8234 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8235 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8236 Lisp_Object new_lbl
;
8237 size_t caption_len
= strlen (capt
);
8239 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8242 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8244 buf
[caption_len
] = '\0';
8248 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8252 strcpy (buf
, label
);
8254 for (j
= 0; buf
[j
] != '\0'; ++j
)
8262 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8263 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8264 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8266 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8270 /* If got a filter apply it on binding. */
8272 PROP (TOOL_BAR_ITEM_BINDING
)
8273 = menu_item_eval_property (list2 (filter
,
8275 PROP (TOOL_BAR_ITEM_BINDING
))));
8277 /* See if the binding is a keymap. Give up if it is. */
8278 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8281 /* Enable or disable selection of item. */
8282 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8283 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8284 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8286 /* Handle radio buttons or toggle boxes. */
8287 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8288 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8289 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8297 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8298 that can be reused. */
8301 init_tool_bar_items (Lisp_Object reuse
)
8303 if (VECTORP (reuse
))
8304 tool_bar_items_vector
= reuse
;
8306 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8307 ntool_bar_items
= 0;
8311 /* Append parsed tool bar item properties from
8312 tool_bar_item_properties */
8315 append_tool_bar_item (void)
8317 Lisp_Object
*to
, *from
;
8319 /* Enlarge tool_bar_items_vector if necessary. */
8320 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8321 >= XVECTOR (tool_bar_items_vector
)->size
)
8322 tool_bar_items_vector
8323 = larger_vector (tool_bar_items_vector
,
8324 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8326 /* Append entries from tool_bar_item_properties to the end of
8327 tool_bar_items_vector. */
8328 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8329 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8330 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8331 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8338 /* Read a character using menus based on maps in the array MAPS.
8339 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8340 Return t if we displayed a menu but the user rejected it.
8342 PREV_EVENT is the previous input event, or nil if we are reading
8343 the first event of a key sequence.
8345 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8346 if we used a mouse menu to read the input, or zero otherwise. If
8347 USED_MOUSE_MENU is null, we don't dereference it.
8349 The prompting is done based on the prompt-string of the map
8350 and the strings associated with various map elements.
8352 This can be done with X menus or with menus put in the minibuf.
8353 These are done in different ways, depending on how the input will be read.
8354 Menus using X are done after auto-saving in read-char, getting the input
8355 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8356 and do auto-saving in the inner call of read_char. */
8359 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8360 int *used_mouse_menu
)
8364 if (used_mouse_menu
)
8365 *used_mouse_menu
= 0;
8367 /* Use local over global Menu maps */
8369 if (! menu_prompting
)
8372 /* Optionally disregard all but the global map. */
8373 if (inhibit_local_menu_bar_menus
)
8375 maps
+= (nmaps
- 1);
8380 /* If we got to this point via a mouse click,
8381 use a real menu for mouse selection. */
8382 if (EVENT_HAS_PARAMETERS (prev_event
)
8383 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8384 && !EQ (XCAR (prev_event
), Qtool_bar
))
8386 /* Display the menu and get the selection. */
8387 Lisp_Object
*realmaps
8388 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8392 /* Use the maps that are not nil. */
8393 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8394 if (!NILP (maps
[mapno
]))
8395 realmaps
[nmaps1
++] = maps
[mapno
];
8397 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8402 record_menu_key (XCAR (value
));
8404 /* If we got multiple events, unread all but
8406 There is no way to prevent those unread events
8407 from showing up later in last_nonmenu_event.
8408 So turn symbol and integer events into lists,
8409 to indicate that they came from a mouse menu,
8410 so that when present in last_nonmenu_event
8411 they won't confuse things. */
8412 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8414 record_menu_key (XCAR (tem
));
8415 if (SYMBOLP (XCAR (tem
))
8416 || INTEGERP (XCAR (tem
)))
8417 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8420 /* If we got more than one event, put all but the first
8421 onto this list to be read later.
8422 Return just the first event now. */
8423 Vunread_command_events
8424 = nconc2 (XCDR (value
), Vunread_command_events
);
8425 value
= XCAR (value
);
8427 else if (NILP (value
))
8429 if (used_mouse_menu
)
8430 *used_mouse_menu
= 1;
8433 #endif /* HAVE_MENUS */
8437 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8438 We make this bigger when necessary, and never free it. */
8439 static char *read_char_minibuf_menu_text
;
8440 /* Size of that buffer. */
8441 static int read_char_minibuf_menu_width
;
8444 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8447 register Lisp_Object name
;
8449 /* FIXME: Use the minibuffer's frame width. */
8450 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8453 Lisp_Object rest
, vector
;
8459 if (! menu_prompting
)
8462 /* Get the menu name from the first map that has one (a prompt string). */
8463 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8465 name
= Fkeymap_prompt (maps
[mapno
]);
8470 /* If we don't have any menus, just read a character normally. */
8471 if (!STRINGP (name
))
8474 /* Make sure we have a big enough buffer for the menu text. */
8475 width
= max (width
, SBYTES (name
));
8476 if (read_char_minibuf_menu_text
== 0)
8478 read_char_minibuf_menu_width
= width
+ 4;
8479 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8481 else if (width
+ 4 > read_char_minibuf_menu_width
)
8483 read_char_minibuf_menu_width
= width
+ 4;
8484 read_char_minibuf_menu_text
8485 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8487 menu
= read_char_minibuf_menu_text
;
8489 /* Prompt string always starts with map's prompt, and a space. */
8490 strcpy (menu
, SSDATA (name
));
8491 nlength
= SBYTES (name
);
8492 menu
[nlength
++] = ':';
8493 menu
[nlength
++] = ' ';
8496 /* Start prompting at start of first map. */
8500 /* Present the documented bindings, a line at a time. */
8506 Lisp_Object orig_defn_macro
;
8508 /* Loop over elements of map. */
8513 /* If reached end of map, start at beginning of next map. */
8517 /* At end of last map, wrap around to first map if just starting,
8518 or end this line if already have something on it. */
8522 if (notfirst
|| nobindings
) break;
8527 /* Look at the next element of the map. */
8529 elt
= XVECTOR (vector
)->contents
[idx
];
8531 elt
= Fcar_safe (rest
);
8533 if (idx
< 0 && VECTORP (elt
))
8535 /* If we found a dense table in the keymap,
8536 advanced past it, but start scanning its contents. */
8537 rest
= Fcdr_safe (rest
);
8543 /* An ordinary element. */
8544 Lisp_Object event
, tem
;
8548 event
= Fcar_safe (elt
); /* alist */
8549 elt
= Fcdr_safe (elt
);
8553 XSETINT (event
, idx
); /* vector */
8556 /* Ignore the element if it has no prompt string. */
8557 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8559 /* 1 if the char to type matches the string. */
8561 Lisp_Object upcased_event
, downcased_event
;
8562 Lisp_Object desc
= Qnil
;
8564 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8566 upcased_event
= Fupcase (event
);
8567 downcased_event
= Fdowncase (event
);
8568 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8569 || XINT (downcased_event
) == SREF (s
, 0));
8571 desc
= Fsingle_key_description (event
, Qnil
);
8573 #if 0 /* It is redundant to list the equivalent key bindings because
8574 the prefix is what the user has already typed. */
8576 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8578 /* Insert equivalent keybinding. */
8579 s
= concat2 (s
, tem
);
8582 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8583 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8585 /* Insert button prefix. */
8586 Lisp_Object selected
8587 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8588 if (EQ (tem
, QCradio
))
8589 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8591 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8592 s
= concat2 (tem
, s
);
8596 /* If we have room for the prompt string, add it to this line.
8597 If this is the first on the line, always add it. */
8598 if ((SCHARS (s
) + i
+ 2
8599 + (char_matches
? 0 : SCHARS (desc
) + 3))
8605 /* Punctuate between strings. */
8608 strcpy (menu
+ i
, ", ");
8614 /* If the char to type doesn't match the string's
8615 first char, explicitly show what char to type. */
8618 /* Add as much of string as fits. */
8619 thiswidth
= SCHARS (desc
);
8620 if (thiswidth
+ i
> width
)
8621 thiswidth
= width
- i
;
8622 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8624 strcpy (menu
+ i
, " = ");
8628 /* Add as much of string as fits. */
8629 thiswidth
= SCHARS (s
);
8630 if (thiswidth
+ i
> width
)
8631 thiswidth
= width
- i
;
8632 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8638 /* If this element does not fit, end the line now,
8639 and save the element for the next line. */
8640 strcpy (menu
+ i
, "...");
8645 /* Move past this element. */
8646 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8647 /* Handle reaching end of dense table. */
8652 rest
= Fcdr_safe (rest
);
8656 /* Prompt with that and read response. */
8657 message2_nolog (menu
, strlen (menu
),
8658 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8660 /* Make believe its not a keyboard macro in case the help char
8661 is pressed. Help characters are not recorded because menu prompting
8662 is not used on replay.
8664 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8665 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8667 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8668 while (BUFFERP (obj
));
8669 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8671 if (!INTEGERP (obj
))
8673 else if (XINT (obj
) == -2)
8676 if (! EQ (obj
, menu_prompt_more_char
)
8677 && (!INTEGERP (menu_prompt_more_char
)
8678 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8680 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8681 store_kbd_macro_char (obj
);
8684 /* Help char - go round again */
8688 /* Reading key sequences. */
8690 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8691 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8692 keymap, or nil otherwise. Return the index of the first keymap in
8693 which KEY has any binding, or NMAPS if no map has a binding.
8695 If KEY is a meta ASCII character, treat it like meta-prefix-char
8696 followed by the corresponding non-meta character. Keymaps in
8697 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8700 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8703 NEXT may be the same array as CURRENT. */
8706 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8709 int i
, first_binding
;
8711 first_binding
= nmaps
;
8712 for (i
= nmaps
- 1; i
>= 0; i
--)
8714 if (! NILP (current
[i
]))
8716 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8717 if (! NILP (defs
[i
]))
8724 /* Given the set of bindings we've found, produce the next set of maps. */
8725 if (first_binding
< nmaps
)
8726 for (i
= 0; i
< nmaps
; i
++)
8727 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8729 return first_binding
;
8732 /* Structure used to keep track of partial application of key remapping
8733 such as Vfunction_key_map and Vkey_translation_map. */
8734 typedef struct keyremap
8736 /* This is the map originally specified for this use. */
8738 /* This is a submap reached by looking up, in PARENT,
8739 the events from START to END. */
8741 /* Positions [START, END) in the key sequence buffer
8742 are the key that we have scanned so far.
8743 Those events are the ones that we will replace
8744 if PAREHT maps them into a key sequence. */
8748 /* Lookup KEY in MAP.
8749 MAP is a keymap mapping keys to key vectors or functions.
8750 If the mapping is a function and DO_FUNCTION is non-zero, then
8751 the function is called with PROMPT as parameter and its return
8752 value is used as the return value of this function (after checking
8753 that it is indeed a vector). */
8756 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8761 next
= access_keymap (map
, key
, 1, 0, 1);
8763 /* Handle symbol with autoload definition. */
8764 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8765 && CONSP (XSYMBOL (next
)->function
)
8766 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8767 do_autoload (XSYMBOL (next
)->function
, next
);
8769 /* Handle a symbol whose function definition is a keymap
8771 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8772 && (ARRAYP (XSYMBOL (next
)->function
)
8773 || KEYMAPP (XSYMBOL (next
)->function
)))
8774 next
= XSYMBOL (next
)->function
;
8776 /* If the keymap gives a function, not an
8777 array, then call the function with one arg and use
8778 its value instead. */
8779 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8784 next
= call1 (next
, prompt
);
8785 /* If the function returned something invalid,
8786 barf--don't ignore it.
8787 (To ignore it safely, we would need to gcpro a bunch of
8788 other variables.) */
8789 if (! (VECTORP (next
) || STRINGP (next
)))
8790 error ("Function %s returns invalid key sequence",
8791 SSDATA (SYMBOL_NAME (tem
)));
8796 /* Do one step of the key remapping used for function-key-map and
8797 key-translation-map:
8798 KEYBUF is the buffer holding the input events.
8799 BUFSIZE is its maximum size.
8800 FKEY is a pointer to the keyremap structure to use.
8801 INPUT is the index of the last element in KEYBUF.
8802 DOIT if non-zero says that the remapping can actually take place.
8803 DIFF is used to return the number of keys added/removed by the remapping.
8804 PARENT is the root of the keymap.
8805 PROMPT is the prompt to use if the remapping happens through a function.
8806 The return value is non-zero if the remapping actually took place. */
8809 keyremap_step (Lisp_Object
*keybuf
, size_t bufsize
, volatile keyremap
*fkey
,
8810 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8812 Lisp_Object next
, key
;
8814 key
= keybuf
[fkey
->end
++];
8816 if (KEYMAPP (fkey
->parent
))
8817 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8821 /* If keybuf[fkey->start..fkey->end] is bound in the
8822 map and we're in a position to do the key remapping, replace it with
8823 the binding and restart with fkey->start at the end. */
8824 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8826 int len
= XFASTINT (Flength (next
));
8829 *diff
= len
- (fkey
->end
- fkey
->start
);
8831 if (input
+ *diff
>= bufsize
)
8832 error ("Key sequence too long");
8834 /* Shift the keys that follow fkey->end. */
8836 for (i
= fkey
->end
; i
< input
; i
++)
8837 keybuf
[i
+ *diff
] = keybuf
[i
];
8839 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8840 keybuf
[i
+ *diff
] = keybuf
[i
];
8841 /* Overwrite the old keys with the new ones. */
8842 for (i
= 0; i
< len
; i
++)
8843 keybuf
[fkey
->start
+ i
]
8844 = Faref (next
, make_number (i
));
8846 fkey
->start
= fkey
->end
+= *diff
;
8847 fkey
->map
= fkey
->parent
;
8852 fkey
->map
= get_keymap (next
, 0, 1);
8854 /* If we no longer have a bound suffix, try a new position for
8856 if (!CONSP (fkey
->map
))
8858 fkey
->end
= ++fkey
->start
;
8859 fkey
->map
= fkey
->parent
;
8864 /* Read a sequence of keys that ends with a non prefix character,
8865 storing it in KEYBUF, a buffer of size BUFSIZE.
8867 Return the length of the key sequence stored.
8868 Return -1 if the user rejected a command menu.
8870 Echo starting immediately unless `prompt' is 0.
8872 Where a key sequence ends depends on the currently active keymaps.
8873 These include any minor mode keymaps active in the current buffer,
8874 the current buffer's local map, and the global map.
8876 If a key sequence has no other bindings, we check Vfunction_key_map
8877 to see if some trailing subsequence might be the beginning of a
8878 function key's sequence. If so, we try to read the whole function
8879 key, and substitute its symbolic name into the key sequence.
8881 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8882 `double-' events into similar click events, if that would make them
8883 bound. We try to turn `triple-' events first into `double-' events,
8886 If we get a mouse click in a mode line, vertical divider, or other
8887 non-text area, we treat the click as if it were prefixed by the
8888 symbol denoting that area - `mode-line', `vertical-line', or
8891 If the sequence starts with a mouse click, we read the key sequence
8892 with respect to the buffer clicked on, not the current buffer.
8894 If the user switches frames in the midst of a key sequence, we put
8895 off the switch-frame event until later; the next call to
8896 read_char will return it.
8898 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8899 from the selected window's buffer. */
8902 read_key_sequence (Lisp_Object
*keybuf
, size_t bufsize
, Lisp_Object prompt
,
8903 int dont_downcase_last
, int can_return_switch_frame
,
8904 int fix_current_buffer
)
8906 Lisp_Object from_string
;
8907 int count
= SPECPDL_INDEX ();
8909 /* How many keys there are in the current key sequence. */
8912 /* The length of the echo buffer when we started reading, and
8913 the length of this_command_keys when we started reading. */
8914 int echo_start
IF_LINT (= 0);
8917 /* The number of keymaps we're scanning right now, and the number of
8918 keymaps we have allocated space for. */
8920 int nmaps_allocated
= 0;
8922 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8923 the current keymaps. */
8924 Lisp_Object
*defs
= NULL
;
8926 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8927 in the current keymaps, or nil where it is not a prefix. */
8928 Lisp_Object
*submaps
= NULL
;
8930 /* The local map to start out with at start of key sequence. */
8931 Lisp_Object orig_local_map
;
8933 /* The map from the `keymap' property to start out with at start of
8935 Lisp_Object orig_keymap
;
8937 /* 1 if we have already considered switching to the local-map property
8938 of the place where a mouse click occurred. */
8939 int localized_local_map
= 0;
8941 /* The index in submaps[] of the first keymap that has a binding for
8942 this key sequence. In other words, the lowest i such that
8943 submaps[i] is non-nil. */
8945 /* Index of the first key that has no binding.
8946 It is useless to try fkey.start larger than that. */
8949 /* If t < mock_input, then KEYBUF[t] should be read as the next
8952 We use this to recover after recognizing a function key. Once we
8953 realize that a suffix of the current key sequence is actually a
8954 function key's escape sequence, we replace the suffix with the
8955 function key's binding from Vfunction_key_map. Now keybuf
8956 contains a new and different key sequence, so the echo area,
8957 this_command_keys, and the submaps and defs arrays are wrong. In
8958 this situation, we set mock_input to t, set t to 0, and jump to
8959 restart_sequence; the loop will read keys from keybuf up until
8960 mock_input, thus rebuilding the state; and then it will resume
8961 reading characters from the keyboard. */
8964 /* If the sequence is unbound in submaps[], then
8965 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8966 and fkey.map is its binding.
8968 These might be > t, indicating that all function key scanning
8969 should hold off until t reaches them. We do this when we've just
8970 recognized a function key, to avoid searching for the function
8971 key's again in Vfunction_key_map. */
8974 /* Likewise, for key_translation_map and input-decode-map. */
8975 keyremap keytran
, indec
;
8977 /* Non-zero if we are trying to map a key by changing an upper-case
8978 letter to lower case, or a shifted function key to an unshifted
8980 int shift_translated
= 0;
8982 /* If we receive a `switch-frame' or `select-window' event in the middle of
8983 a key sequence, we put it off for later.
8984 While we're reading, we keep the event here. */
8985 Lisp_Object delayed_switch_frame
;
8987 /* See the comment below... */
8988 #if defined (GOBBLE_FIRST_EVENT)
8989 Lisp_Object first_event
;
8992 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8993 int original_uppercase_position
= -1;
8995 /* Gets around Microsoft compiler limitations. */
8998 struct buffer
*starting_buffer
;
9000 /* List of events for which a fake prefix key has been generated. */
9001 Lisp_Object fake_prefixed_keys
= Qnil
;
9003 #if defined (GOBBLE_FIRST_EVENT)
9007 struct gcpro outer_gcpro1
;
9009 GCPRO1_VAR (fake_prefixed_keys
, outer_gcpro
);
9010 raw_keybuf_count
= 0;
9012 last_nonmenu_event
= Qnil
;
9014 delayed_switch_frame
= Qnil
;
9020 /* Install the string STR as the beginning of the string of
9021 echoing, so that it serves as a prompt for the next
9023 KVAR (current_kboard
, echo_string
) = prompt
;
9024 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9027 else if (cursor_in_echo_area
9028 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9029 && NILP (Fzerop (Vecho_keystrokes
)))
9030 /* This doesn't put in a dash if the echo buffer is empty, so
9031 you don't always see a dash hanging out in the minibuffer. */
9035 /* Record the initial state of the echo area and this_command_keys;
9036 we will need to restore them if we replay a key sequence. */
9038 echo_start
= echo_length ();
9039 keys_start
= this_command_key_count
;
9040 this_single_command_key_start
= keys_start
;
9042 #if defined (GOBBLE_FIRST_EVENT)
9043 /* This doesn't quite work, because some of the things that read_char
9044 does cannot safely be bypassed. It seems too risky to try to make
9047 /* Read the first char of the sequence specially, before setting
9048 up any keymaps, in case a filter runs and switches buffers on us. */
9049 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9051 #endif /* GOBBLE_FIRST_EVENT */
9053 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9054 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9057 /* We jump here when we need to reinitialize fkey and keytran; this
9058 happens if we switch keyboards between rescans. */
9059 replay_entire_sequence
:
9061 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9062 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9063 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9064 indec
.start
= indec
.end
= 0;
9065 fkey
.start
= fkey
.end
= 0;
9066 keytran
.start
= keytran
.end
= 0;
9068 /* We jump here when the key sequence has been thoroughly changed, and
9069 we need to rescan it starting from the beginning. When we jump here,
9070 keybuf[0..mock_input] holds the sequence we should reread. */
9073 starting_buffer
= current_buffer
;
9074 first_unbound
= bufsize
+ 1;
9076 /* Build our list of keymaps.
9077 If we recognize a function key and replace its escape sequence in
9078 keybuf with its symbol, or if the sequence starts with a mouse
9079 click and we need to switch buffers, we jump back here to rebuild
9080 the initial keymaps from the current buffer. */
9083 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9085 if (2 > nmaps_allocated
)
9087 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9088 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9089 nmaps_allocated
= 2;
9091 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9093 else if (!NILP (Voverriding_local_map
))
9095 if (2 > nmaps_allocated
)
9097 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9098 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9099 nmaps_allocated
= 2;
9101 submaps
[nmaps
++] = Voverriding_local_map
;
9109 nminor
= current_minor_maps (0, &maps
);
9110 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9112 if (total
> nmaps_allocated
)
9114 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9115 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9116 nmaps_allocated
= total
;
9119 if (!NILP (orig_keymap
))
9120 submaps
[nmaps
++] = orig_keymap
;
9122 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9126 submaps
[nmaps
++] = orig_local_map
;
9128 submaps
[nmaps
++] = current_global_map
;
9130 /* Find an accurate initial value for first_binding. */
9131 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9132 if (! NILP (submaps
[first_binding
]))
9135 /* Start from the beginning in keybuf. */
9138 /* These are no-ops the first time through, but if we restart, they
9139 revert the echo area and this_command_keys to their original state. */
9140 this_command_key_count
= keys_start
;
9141 if (INTERACTIVE
&& t
< mock_input
)
9142 echo_truncate (echo_start
);
9144 /* If the best binding for the current key sequence is a keymap, or
9145 we may be looking at a function key's escape sequence, keep on
9147 while (first_binding
< nmaps
9148 /* Keep reading as long as there's a prefix binding. */
9149 ? !NILP (submaps
[first_binding
])
9150 /* Don't return in the middle of a possible function key sequence,
9151 if the only bindings we found were via case conversion.
9152 Thus, if ESC O a has a function-key-map translation
9153 and ESC o has a binding, don't return after ESC O,
9154 so that we can translate ESC O plus the next character. */
9155 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9158 int used_mouse_menu
= 0;
9160 /* Where the last real key started. If we need to throw away a
9161 key that has expanded into more than one element of keybuf
9162 (say, a mouse click on the mode line which is being treated
9163 as [mode-line (mouse-...)], then we backtrack to this point
9165 int last_real_key_start
;
9167 /* These variables are analogous to echo_start and keys_start;
9168 while those allow us to restart the entire key sequence,
9169 echo_local_start and keys_local_start allow us to throw away
9171 int echo_local_start
IF_LINT (= 0);
9172 int keys_local_start
, local_first_binding
;
9174 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9175 eassert (indec
.start
<= indec
.end
);
9176 eassert (fkey
.start
<= fkey
.end
);
9177 eassert (keytran
.start
<= keytran
.end
);
9178 /* key-translation-map is applied *after* function-key-map
9179 which is itself applied *after* input-decode-map. */
9180 eassert (fkey
.end
<= indec
.start
);
9181 eassert (keytran
.end
<= fkey
.start
);
9183 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9184 first_unbound
< keytran
.start
)
9185 { /* The prefix upto first_unbound has no binding and has
9186 no translation left to do either, so we know it's unbound.
9187 If we don't stop now, we risk staying here indefinitely
9188 (if the user keeps entering fkey or keytran prefixes
9189 like C-c ESC ESC ESC ESC ...) */
9191 for (i
= first_unbound
+ 1; i
< t
; i
++)
9192 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9193 mock_input
= t
- first_unbound
- 1;
9194 indec
.end
= indec
.start
-= first_unbound
+ 1;
9195 indec
.map
= indec
.parent
;
9196 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9197 fkey
.map
= fkey
.parent
;
9198 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9199 keytran
.map
= keytran
.parent
;
9200 goto replay_sequence
;
9204 error ("Key sequence too long");
9207 echo_local_start
= echo_length ();
9208 keys_local_start
= this_command_key_count
;
9209 local_first_binding
= first_binding
;
9212 /* These are no-ops, unless we throw away a keystroke below and
9213 jumped back up to replay_key; in that case, these restore the
9214 variables to their original state, allowing us to replay the
9216 if (INTERACTIVE
&& t
< mock_input
)
9217 echo_truncate (echo_local_start
);
9218 this_command_key_count
= keys_local_start
;
9219 first_binding
= local_first_binding
;
9221 /* By default, assume each event is "real". */
9222 last_real_key_start
= t
;
9224 /* Does mock_input indicate that we are re-reading a key sequence? */
9228 add_command_key (key
);
9229 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9230 && NILP (Fzerop (Vecho_keystrokes
)))
9234 /* If not, we should actually read a character. */
9238 KBOARD
*interrupted_kboard
= current_kboard
;
9239 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9240 key
= read_char (NILP (prompt
), nmaps
,
9241 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9242 &used_mouse_menu
, NULL
);
9243 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9244 /* When switching to a new tty (with a new keyboard),
9245 read_char returns the new buffer, rather than -2
9246 (Bug#5095). This is because `terminal-init-xterm'
9247 calls read-char, which eats the wrong_kboard_jmpbuf
9248 return. Any better way to fix this? -- cyd */
9249 || (interrupted_kboard
!= current_kboard
))
9254 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9255 if (k
== interrupted_kboard
)
9260 /* Don't touch interrupted_kboard when it's been
9262 delayed_switch_frame
= Qnil
;
9263 goto replay_entire_sequence
;
9266 if (!NILP (delayed_switch_frame
))
9268 KVAR (interrupted_kboard
, kbd_queue
)
9269 = Fcons (delayed_switch_frame
,
9270 KVAR (interrupted_kboard
, kbd_queue
));
9271 delayed_switch_frame
= Qnil
;
9275 KVAR (interrupted_kboard
, kbd_queue
)
9276 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9278 /* If the side queue is non-empty, ensure it begins with a
9279 switch-frame, so we'll replay it in the right context. */
9280 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9281 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9282 !(EVENT_HAS_PARAMETERS (key
)
9283 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9287 XSETFRAME (frame
, interrupted_frame
);
9288 KVAR (interrupted_kboard
, kbd_queue
)
9289 = Fcons (make_lispy_switch_frame (frame
),
9290 KVAR (interrupted_kboard
, kbd_queue
));
9293 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9294 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9295 goto replay_entire_sequence
;
9299 /* read_char returns t when it shows a menu and the user rejects it.
9303 unbind_to (count
, Qnil
);
9304 UNGCPRO_VAR (outer_gcpro
);
9308 /* read_char returns -1 at the end of a macro.
9309 Emacs 18 handles this by returning immediately with a
9310 zero, so that's what we'll do. */
9311 if (INTEGERP (key
) && XINT (key
) == -1)
9314 /* The Microsoft C compiler can't handle the goto that
9320 /* If the current buffer has been changed from under us, the
9321 keymap may have changed, so replay the sequence. */
9324 timer_resume_idle ();
9327 /* Reset the current buffer from the selected window
9328 in case something changed the former and not the latter.
9329 This is to be more consistent with the behavior
9330 of the command_loop_1. */
9331 if (fix_current_buffer
)
9333 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9335 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9336 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9339 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9340 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9341 goto replay_sequence
;
9344 /* If we have a quit that was typed in another frame, and
9345 quit_throw_to_read_char switched buffers,
9346 replay to get the right keymap. */
9348 && XINT (key
) == quit_char
9349 && current_buffer
!= starting_buffer
)
9352 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9356 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9357 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9358 goto replay_sequence
;
9363 if (EVENT_HAS_PARAMETERS (key
)
9364 /* Either a `switch-frame' or a `select-window' event. */
9365 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9367 /* If we're at the beginning of a key sequence, and the caller
9368 says it's okay, go ahead and return this event. If we're
9369 in the midst of a key sequence, delay it until the end. */
9370 if (t
> 0 || !can_return_switch_frame
)
9372 delayed_switch_frame
= key
;
9378 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9382 /* Clicks in non-text areas get prefixed by the symbol
9383 in their CHAR-ADDRESS field. For example, a click on
9384 the mode line is prefixed by the symbol `mode-line'.
9386 Furthermore, key sequences beginning with mouse clicks
9387 are read using the keymaps of the buffer clicked on, not
9388 the current buffer. So we may have to switch the buffer
9391 When we turn one event into two events, we must make sure
9392 that neither of the two looks like the original--so that,
9393 if we replay the events, they won't be expanded again.
9394 If not for this, such reexpansion could happen either here
9395 or when user programs play with this-command-keys. */
9396 if (EVENT_HAS_PARAMETERS (key
))
9401 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9402 if (EQ (kind
, Qmouse_click
))
9404 Lisp_Object window
, posn
;
9406 window
= POSN_WINDOW (EVENT_START (key
));
9407 posn
= POSN_POSN (EVENT_START (key
));
9410 || (!NILP (fake_prefixed_keys
)
9411 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9413 /* We're looking a second time at an event for which
9414 we generated a fake prefix key. Set
9415 last_real_key_start appropriately. */
9417 last_real_key_start
= t
- 1;
9420 if (last_real_key_start
== 0)
9422 /* Key sequences beginning with mouse clicks are
9423 read using the keymaps in the buffer clicked on,
9424 not the current buffer. If we're at the
9425 beginning of a key sequence, switch buffers. */
9426 if (WINDOWP (window
)
9427 && BUFFERP (XWINDOW (window
)->buffer
)
9428 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9430 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9434 /* Arrange to go back to the original buffer once we're
9435 done reading the key sequence. Note that we can't
9436 use save_excursion_{save,restore} here, because they
9437 save point as well as the current buffer; we don't
9438 want to save point, because redisplay may change it,
9439 to accommodate a Fset_window_start or something. We
9440 don't want to do this at the top of the function,
9441 because we may get input from a subprocess which
9442 wants to change the selected window and stuff (say,
9444 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9446 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9448 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9449 orig_local_map
= get_local_map (PT
, current_buffer
,
9451 orig_keymap
= get_local_map (PT
, current_buffer
,
9453 goto replay_sequence
;
9456 /* For a mouse click, get the local text-property keymap
9457 of the place clicked on, rather than point. */
9458 if (CONSP (XCDR (key
))
9459 && ! localized_local_map
)
9461 Lisp_Object map_here
, start
, pos
;
9463 localized_local_map
= 1;
9464 start
= EVENT_START (key
);
9466 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9468 pos
= POSN_BUFFER_POSN (start
);
9470 && XINT (pos
) >= BEGV
9471 && XINT (pos
) <= ZV
)
9473 map_here
= get_local_map (XINT (pos
),
9476 if (!EQ (map_here
, orig_local_map
))
9478 orig_local_map
= map_here
;
9479 ++localized_local_map
;
9482 map_here
= get_local_map (XINT (pos
),
9485 if (!EQ (map_here
, orig_keymap
))
9487 orig_keymap
= map_here
;
9488 ++localized_local_map
;
9491 if (localized_local_map
> 1)
9496 goto replay_sequence
;
9503 /* Expand mode-line and scroll-bar events into two events:
9504 use posn as a fake prefix key. */
9506 && (NILP (fake_prefixed_keys
)
9507 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9509 if (t
+ 1 >= bufsize
)
9510 error ("Key sequence too long");
9513 keybuf
[t
+ 1] = key
;
9516 /* Record that a fake prefix key has been generated
9517 for KEY. Don't modify the event; this would
9518 prevent proper action when the event is pushed
9519 back into unread-command-events. */
9520 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9522 /* If on a mode line string with a local keymap,
9523 reconsider the key sequence with that keymap. */
9524 if (string
= POSN_STRING (EVENT_START (key
)),
9525 (CONSP (string
) && STRINGP (XCAR (string
))))
9527 Lisp_Object pos
, map
, map2
;
9529 pos
= XCDR (string
);
9530 string
= XCAR (string
);
9532 && XINT (pos
) < SCHARS (string
))
9534 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9536 orig_local_map
= map
;
9537 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9540 if (!NILP (map
) || !NILP (map2
))
9541 goto replay_sequence
;
9547 else if (NILP (from_string
)
9548 && (string
= POSN_STRING (EVENT_START (key
)),
9549 (CONSP (string
) && STRINGP (XCAR (string
)))))
9551 /* For a click on a string, i.e. overlay string or a
9552 string displayed via the `display' property,
9553 consider `local-map' and `keymap' properties of
9555 Lisp_Object pos
, map
, map2
;
9557 pos
= XCDR (string
);
9558 string
= XCAR (string
);
9560 && XINT (pos
) < SCHARS (string
))
9562 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9564 orig_local_map
= map
;
9565 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9569 if (!NILP (map
) || !NILP (map2
))
9571 from_string
= string
;
9574 goto replay_sequence
;
9579 else if (CONSP (XCDR (key
))
9580 && CONSP (EVENT_START (key
))
9581 && CONSP (XCDR (EVENT_START (key
))))
9585 posn
= POSN_POSN (EVENT_START (key
));
9586 /* Handle menu-bar events:
9587 insert the dummy prefix event `menu-bar'. */
9588 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9590 if (t
+ 1 >= bufsize
)
9591 error ("Key sequence too long");
9595 /* Zap the position in key, so we know that we've
9596 expanded it, and don't try to do so again. */
9597 POSN_SET_POSN (EVENT_START (key
),
9598 Fcons (posn
, Qnil
));
9601 goto replay_sequence
;
9603 else if (CONSP (posn
))
9605 /* We're looking at the second event of a
9606 sequence which we expanded before. Set
9607 last_real_key_start appropriately. */
9608 if (last_real_key_start
== t
&& t
> 0)
9609 last_real_key_start
= t
- 1;
9614 /* We have finally decided that KEY is something we might want
9616 first_binding
= (follow_key (key
,
9617 nmaps
- first_binding
,
9618 submaps
+ first_binding
,
9619 defs
+ first_binding
,
9620 submaps
+ first_binding
)
9623 /* If KEY wasn't bound, we'll try some fallbacks. */
9624 if (first_binding
< nmaps
)
9625 /* This is needed for the following scenario:
9626 event 0: a down-event that gets dropped by calling replay_key.
9627 event 1: some normal prefix like C-h.
9628 After event 0, first_unbound is 0, after event 1 indec.start,
9629 fkey.start, and keytran.start are all 1, so when we see that
9630 C-h is bound, we need to update first_unbound. */
9631 first_unbound
= max (t
+ 1, first_unbound
);
9636 /* Remember the position to put an upper bound on indec.start. */
9637 first_unbound
= min (t
, first_unbound
);
9639 head
= EVENT_HEAD (key
);
9640 if (help_char_p (head
) && t
> 0)
9642 read_key_sequence_cmd
= Vprefix_help_command
;
9644 last_nonmenu_event
= key
;
9645 /* The Microsoft C compiler can't handle the goto that
9653 Lisp_Object breakdown
;
9656 breakdown
= parse_modifiers (head
);
9657 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9658 /* Attempt to reduce an unbound mouse event to a simpler
9659 event that is bound:
9660 Drags reduce to clicks.
9661 Double-clicks reduce to clicks.
9662 Triple-clicks reduce to double-clicks, then to clicks.
9663 Down-clicks are eliminated.
9664 Double-downs reduce to downs, then are eliminated.
9665 Triple-downs reduce to double-downs, then to downs,
9666 then are eliminated. */
9667 if (modifiers
& (down_modifier
| drag_modifier
9668 | double_modifier
| triple_modifier
))
9670 while (modifiers
& (down_modifier
| drag_modifier
9671 | double_modifier
| triple_modifier
))
9673 Lisp_Object new_head
, new_click
;
9674 if (modifiers
& triple_modifier
)
9675 modifiers
^= (double_modifier
| triple_modifier
);
9676 else if (modifiers
& double_modifier
)
9677 modifiers
&= ~double_modifier
;
9678 else if (modifiers
& drag_modifier
)
9679 modifiers
&= ~drag_modifier
;
9682 /* Dispose of this `down' event by simply jumping
9683 back to replay_key, to get another event.
9685 Note that if this event came from mock input,
9686 then just jumping back to replay_key will just
9687 hand it to us again. So we have to wipe out any
9690 We could delete keybuf[t] and shift everything
9691 after that to the left by one spot, but we'd also
9692 have to fix up any variable that points into
9693 keybuf, and shifting isn't really necessary
9696 Adding prefixes for non-textual mouse clicks
9697 creates two characters of mock input, and both
9698 must be thrown away. If we're only looking at
9699 the prefix now, we can just jump back to
9700 replay_key. On the other hand, if we've already
9701 processed the prefix, and now the actual click
9702 itself is giving us trouble, then we've lost the
9703 state of the keymaps we want to backtrack to, and
9704 we need to replay the whole sequence to rebuild
9707 Beyond that, only function key expansion could
9708 create more than two keys, but that should never
9709 generate mouse events, so it's okay to zero
9710 mock_input in that case too.
9712 FIXME: The above paragraph seems just plain
9713 wrong, if you consider things like
9714 xterm-mouse-mode. -stef
9716 Isn't this just the most wonderful code ever? */
9718 /* If mock_input > t + 1, the above simplification
9719 will actually end up dropping keys on the floor.
9720 This is probably OK for now, but even
9721 if mock_input <= t + 1, we need to adjust indec,
9723 Typical case [header-line down-mouse-N]:
9724 mock_input = 2, t = 1, fkey.end = 1,
9725 last_real_key_start = 0. */
9726 if (indec
.end
> last_real_key_start
)
9728 indec
.end
= indec
.start
9729 = min (last_real_key_start
, indec
.start
);
9730 indec
.map
= indec
.parent
;
9731 if (fkey
.end
> last_real_key_start
)
9733 fkey
.end
= fkey
.start
9734 = min (last_real_key_start
, fkey
.start
);
9735 fkey
.map
= fkey
.parent
;
9736 if (keytran
.end
> last_real_key_start
)
9738 keytran
.end
= keytran
.start
9739 = min (last_real_key_start
, keytran
.start
);
9740 keytran
.map
= keytran
.parent
;
9744 if (t
== last_real_key_start
)
9751 mock_input
= last_real_key_start
;
9752 goto replay_sequence
;
9757 = apply_modifiers (modifiers
, XCAR (breakdown
));
9759 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9761 /* Look for a binding for this new key. follow_key
9762 promises that it didn't munge submaps the
9763 last time we called it, since key was unbound. */
9765 = (follow_key (new_click
,
9766 nmaps
- local_first_binding
,
9767 submaps
+ local_first_binding
,
9768 defs
+ local_first_binding
,
9769 submaps
+ local_first_binding
)
9770 + local_first_binding
);
9772 /* If that click is bound, go for it. */
9773 if (first_binding
< nmaps
)
9778 /* Otherwise, we'll leave key set to the drag event. */
9785 /* Normally, last_nonmenu_event gets the previous key we read.
9786 But when a mouse popup menu is being used,
9787 we don't update last_nonmenu_event; it continues to hold the mouse
9788 event that preceded the first level of menu. */
9789 if (!used_mouse_menu
)
9790 last_nonmenu_event
= key
;
9792 /* Record what part of this_command_keys is the current key sequence. */
9793 this_single_command_key_start
= this_command_key_count
- t
;
9795 /* Look for this sequence in input-decode-map.
9796 Scan from indec.end until we find a bound suffix. */
9797 while (indec
.end
< t
)
9799 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9802 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9803 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9808 mock_input
= diff
+ max (t
, mock_input
);
9809 goto replay_sequence
;
9813 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9814 && indec
.start
>= t
)
9815 /* There is a binding and it's not a prefix.
9816 (and it doesn't have any input-decode-map translation pending).
9817 There is thus no function-key in this sequence.
9818 Moving fkey.start is important in this case to allow keytran.start
9819 to go over the sequence before we return (since we keep the
9820 invariant that keytran.end <= fkey.start). */
9823 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9826 /* If the sequence is unbound, see if we can hang a function key
9827 off the end of it. */
9828 /* Continue scan from fkey.end until we find a bound suffix. */
9829 while (fkey
.end
< indec
.start
)
9831 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9834 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9835 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9836 max (t
, mock_input
),
9837 /* If there's a binding (i.e.
9838 first_binding >= nmaps) we don't want
9839 to apply this function-key-mapping. */
9840 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9845 mock_input
= diff
+ max (t
, mock_input
);
9846 /* Adjust the input-decode-map counters. */
9848 indec
.start
+= diff
;
9850 goto replay_sequence
;
9854 /* Look for this sequence in key-translation-map.
9855 Scan from keytran.end until we find a bound suffix. */
9856 while (keytran
.end
< fkey
.start
)
9858 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9861 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9862 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9867 mock_input
= diff
+ max (t
, mock_input
);
9868 /* Adjust the function-key-map and input-decode-map counters. */
9870 indec
.start
+= diff
;
9874 goto replay_sequence
;
9878 /* If KEY is not defined in any of the keymaps,
9879 and cannot be part of a function key or translation,
9880 and is an upper case letter
9881 use the corresponding lower-case letter instead. */
9882 if (first_binding
>= nmaps
9883 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9885 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9886 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9887 || (XINT (key
) & shift_modifier
)))
9889 Lisp_Object new_key
;
9891 original_uppercase
= key
;
9892 original_uppercase_position
= t
- 1;
9894 if (XINT (key
) & shift_modifier
)
9895 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9897 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9898 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9900 /* We have to do this unconditionally, regardless of whether
9901 the lower-case char is defined in the keymaps, because they
9902 might get translated through function-key-map. */
9903 keybuf
[t
- 1] = new_key
;
9904 mock_input
= max (t
, mock_input
);
9905 shift_translated
= 1;
9907 goto replay_sequence
;
9909 /* If KEY is not defined in any of the keymaps,
9910 and cannot be part of a function key or translation,
9911 and is a shifted function key,
9912 use the corresponding unshifted function key instead. */
9913 if (first_binding
>= nmaps
9914 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9916 Lisp_Object breakdown
= parse_modifiers (key
);
9918 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9920 if (modifiers
& shift_modifier
9921 /* Treat uppercase keys as shifted. */
9923 && (KEY_TO_CHAR (key
)
9924 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->size
)
9925 && uppercasep (KEY_TO_CHAR (key
))))
9928 = (modifiers
& shift_modifier
9929 ? apply_modifiers (modifiers
& ~shift_modifier
,
9931 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9933 original_uppercase
= key
;
9934 original_uppercase_position
= t
- 1;
9936 /* We have to do this unconditionally, regardless of whether
9937 the lower-case char is defined in the keymaps, because they
9938 might get translated through function-key-map. */
9939 keybuf
[t
- 1] = new_key
;
9940 mock_input
= max (t
, mock_input
);
9941 /* Reset fkey (and consequently keytran) to apply
9942 function-key-map on the result, so that S-backspace is
9943 correctly mapped to DEL (via backspace). OTOH,
9944 input-decode-map doesn't need to go through it again. */
9945 fkey
.start
= fkey
.end
= 0;
9946 keytran
.start
= keytran
.end
= 0;
9947 shift_translated
= 1;
9949 goto replay_sequence
;
9954 read_key_sequence_cmd
= (first_binding
< nmaps
9955 ? defs
[first_binding
]
9958 unread_switch_frame
= delayed_switch_frame
;
9959 unbind_to (count
, Qnil
);
9961 /* Don't downcase the last character if the caller says don't.
9962 Don't downcase it if the result is undefined, either. */
9963 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9965 && t
- 1 == original_uppercase_position
)
9967 keybuf
[t
- 1] = original_uppercase
;
9968 shift_translated
= 0;
9971 if (shift_translated
)
9972 Vthis_command_keys_shift_translated
= Qt
;
9974 /* Occasionally we fabricate events, perhaps by expanding something
9975 according to function-key-map, or by adding a prefix symbol to a
9976 mouse click in the scroll bar or modeline. In this cases, return
9977 the entire generated key sequence, even if we hit an unbound
9978 prefix or a definition before the end. This means that you will
9979 be able to push back the event properly, and also means that
9980 read-key-sequence will always return a logical unit.
9983 for (; t
< mock_input
; t
++)
9985 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9986 && NILP (Fzerop (Vecho_keystrokes
)))
9987 echo_char (keybuf
[t
]);
9988 add_command_key (keybuf
[t
]);
9991 UNGCPRO_VAR (outer_gcpro
);
9995 DEFUE ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9996 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9997 The sequence is sufficient to specify a non-prefix command in the
9998 current local and global maps.
10000 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10001 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10002 as a continuation of the previous key.
10004 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10005 convert the last event to lower case. (Normally any upper case event
10006 is converted to lower case if the original event is undefined and the lower
10007 case equivalent is defined.) A non-nil value is appropriate for reading
10008 a key sequence to be defined.
10010 A C-g typed while in this function is treated like any other character,
10011 and `quit-flag' is not set.
10013 If the key sequence starts with a mouse click, then the sequence is read
10014 using the keymaps of the buffer of the window clicked in, not the buffer
10015 of the selected window as normal.
10017 `read-key-sequence' drops unbound button-down events, since you normally
10018 only care about the click or drag events which follow them. If a drag
10019 or multi-click event is unbound, but the corresponding click event would
10020 be bound, `read-key-sequence' turns the event into a click event at the
10021 drag's starting position. This means that you don't have to distinguish
10022 between click and drag, double, or triple events unless you want to.
10024 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10025 lines separating windows, and scroll bars with imaginary keys
10026 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10028 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10029 function will process a switch-frame event if the user switches frames
10030 before typing anything. If the user switches frames in the middle of a
10031 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10032 is nil, then the event will be put off until after the current key sequence.
10034 `read-key-sequence' checks `function-key-map' for function key
10035 sequences, where they wouldn't conflict with ordinary bindings. See
10036 `function-key-map' for more details.
10038 The optional fifth argument CMD-LOOP, if non-nil, means
10039 that this key sequence is being read by something that will
10040 read commands one after another. It should be nil if the caller
10041 will read just one key sequence. */)
10042 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10044 Lisp_Object keybuf
[30];
10046 struct gcpro gcpro1
;
10047 int count
= SPECPDL_INDEX ();
10049 if (!NILP (prompt
))
10050 CHECK_STRING (prompt
);
10053 specbind (Qinput_method_exit_on_first_char
,
10054 (NILP (cmd_loop
) ? Qt
: Qnil
));
10055 specbind (Qinput_method_use_echo_area
,
10056 (NILP (cmd_loop
) ? Qt
: Qnil
));
10058 memset (keybuf
, 0, sizeof keybuf
);
10059 GCPRO1 (keybuf
[0]);
10060 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10062 if (NILP (continue_echo
))
10064 this_command_key_count
= 0;
10065 this_command_key_count_reset
= 0;
10066 this_single_command_key_start
= 0;
10069 #ifdef HAVE_WINDOW_SYSTEM
10070 if (display_hourglass_p
)
10071 cancel_hourglass ();
10074 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10075 prompt
, ! NILP (dont_downcase_last
),
10076 ! NILP (can_return_switch_frame
), 0);
10078 #if 0 /* The following is fine for code reading a key sequence and
10079 then proceeding with a lenghty computation, but it's not good
10080 for code reading keys in a loop, like an input method. */
10081 #ifdef HAVE_WINDOW_SYSTEM
10082 if (display_hourglass_p
)
10083 start_hourglass ();
10093 return unbind_to (count
, make_event_array (i
, keybuf
));
10096 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10097 Sread_key_sequence_vector
, 1, 5, 0,
10098 doc
: /* Like `read-key-sequence' but always return a vector. */)
10099 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10101 Lisp_Object keybuf
[30];
10103 struct gcpro gcpro1
;
10104 int count
= SPECPDL_INDEX ();
10106 if (!NILP (prompt
))
10107 CHECK_STRING (prompt
);
10110 specbind (Qinput_method_exit_on_first_char
,
10111 (NILP (cmd_loop
) ? Qt
: Qnil
));
10112 specbind (Qinput_method_use_echo_area
,
10113 (NILP (cmd_loop
) ? Qt
: Qnil
));
10115 memset (keybuf
, 0, sizeof keybuf
);
10116 GCPRO1 (keybuf
[0]);
10117 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10119 if (NILP (continue_echo
))
10121 this_command_key_count
= 0;
10122 this_command_key_count_reset
= 0;
10123 this_single_command_key_start
= 0;
10126 #ifdef HAVE_WINDOW_SYSTEM
10127 if (display_hourglass_p
)
10128 cancel_hourglass ();
10131 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10132 prompt
, ! NILP (dont_downcase_last
),
10133 ! NILP (can_return_switch_frame
), 0);
10135 #ifdef HAVE_WINDOW_SYSTEM
10136 if (display_hourglass_p
)
10137 start_hourglass ();
10146 return unbind_to (count
, Fvector (i
, keybuf
));
10149 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10150 doc
: /* Execute CMD as an editor command.
10151 CMD must be a symbol that satisfies the `commandp' predicate.
10152 Optional second arg RECORD-FLAG non-nil
10153 means unconditionally put this command in `command-history'.
10154 Otherwise, that is done only if an arg is read using the minibuffer.
10155 The argument KEYS specifies the value to use instead of (this-command-keys)
10156 when reading the arguments; if it is nil, (this-command-keys) is used.
10157 The argument SPECIAL, if non-nil, means that this command is executing
10158 a special event, so ignore the prefix argument and don't clear it. */)
10159 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10161 register Lisp_Object final
;
10162 register Lisp_Object tem
;
10163 Lisp_Object prefixarg
;
10165 debug_on_next_call
= 0;
10167 if (NILP (special
))
10169 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10170 Vcurrent_prefix_arg
= prefixarg
;
10171 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10178 tem
= Fget (cmd
, Qdisabled
);
10181 tem
= Fsymbol_value (Qdisabled_command_function
);
10183 return Frun_hooks (1, &Qdisabled_command_function
);
10189 final
= Findirect_function (cmd
, Qnil
);
10191 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10193 struct gcpro gcpro1
, gcpro2
;
10195 GCPRO2 (cmd
, prefixarg
);
10196 do_autoload (final
, cmd
);
10203 if (STRINGP (final
) || VECTORP (final
))
10205 /* If requested, place the macro in the command history. For
10206 other sorts of commands, call-interactively takes care of
10208 if (!NILP (record_flag
))
10211 = Fcons (Fcons (Qexecute_kbd_macro
,
10212 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10215 /* Don't keep command history around forever. */
10216 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10218 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10220 XSETCDR (tem
, Qnil
);
10224 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10227 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10228 /* Don't call Fcall_interactively directly because we want to make
10229 sure the backtrace has an entry for `call-interactively'.
10230 For the same reason, pass `cmd' rather than `final'. */
10231 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10238 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10240 doc
: /* Read function name, then read its arguments and call it.
10242 To pass a numeric argument to the command you are invoking with, specify
10243 the numeric argument to this command.
10245 Noninteractively, the argument PREFIXARG is the prefix argument to
10246 give to the command you invoke, if it asks for an argument. */)
10247 (Lisp_Object prefixarg
)
10249 Lisp_Object function
;
10250 EMACS_INT saved_last_point_position
;
10251 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10252 Lisp_Object bindings
, value
;
10253 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10254 #ifdef HAVE_WINDOW_SYSTEM
10255 /* The call to Fcompleting_read will start and cancel the hourglass,
10256 but if the hourglass was already scheduled, this means that no
10257 hourglass will be shown for the actual M-x command itself.
10258 So we restart it if it is already scheduled. Note that checking
10259 hourglass_shown_p is not enough, normally the hourglass is not shown,
10260 just scheduled to be shown. */
10261 int hstarted
= hourglass_started ();
10264 saved_keys
= Fvector (this_command_key_count
,
10265 XVECTOR (this_command_keys
)->contents
);
10266 saved_last_point_position_buffer
= last_point_position_buffer
;
10267 saved_last_point_position
= last_point_position
;
10268 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10270 function
= call0 (intern ("read-extended-command"));
10272 #ifdef HAVE_WINDOW_SYSTEM
10273 if (hstarted
) start_hourglass ();
10276 if (STRINGP (function
) && SCHARS (function
) == 0)
10277 error ("No command name given");
10279 /* Set this_command_keys to the concatenation of saved_keys and
10280 function, followed by a RET. */
10285 this_command_key_count
= 0;
10286 this_command_key_count_reset
= 0;
10287 this_single_command_key_start
= 0;
10289 keys
= XVECTOR (saved_keys
)->contents
;
10290 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10291 add_command_key (keys
[i
]);
10293 for (i
= 0; i
< SCHARS (function
); i
++)
10294 add_command_key (Faref (function
, make_number (i
)));
10296 add_command_key (make_number ('\015'));
10299 last_point_position
= saved_last_point_position
;
10300 last_point_position_buffer
= saved_last_point_position_buffer
;
10304 function
= Fintern (function
, Qnil
);
10305 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10306 Vthis_command
= function
;
10307 real_this_command
= function
;
10309 /* If enabled, show which key runs this command. */
10310 if (!NILP (Vsuggest_key_bindings
)
10311 && NILP (Vexecuting_kbd_macro
)
10312 && SYMBOLP (function
))
10313 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10319 GCPRO3 (bindings
, value
, function
);
10320 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10322 /* If the command has a key binding, print it now. */
10323 if (!NILP (bindings
)
10324 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10327 /* But first wait, and skip the message if there is input. */
10328 Lisp_Object waited
;
10330 /* If this command displayed something in the echo area;
10331 wait a few seconds, then display our suggestion message. */
10332 if (NILP (echo_area_buffer
[0]))
10333 waited
= sit_for (make_number (0), 0, 2);
10334 else if (NUMBERP (Vsuggest_key_bindings
))
10335 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10337 waited
= sit_for (make_number (2), 0, 2);
10339 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10341 Lisp_Object binding
;
10343 int message_p
= push_message ();
10344 int count
= SPECPDL_INDEX ();
10346 record_unwind_protect (pop_message_unwind
, Qnil
);
10347 binding
= Fkey_description (bindings
, Qnil
);
10350 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10353 sprintf (newmessage
, "You can run the command `%s' with %s",
10354 SDATA (SYMBOL_NAME (function
)),
10356 message2 (newmessage
,
10357 strlen (newmessage
),
10358 STRING_MULTIBYTE (binding
));
10359 if (NUMBERP (Vsuggest_key_bindings
))
10360 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10362 waited
= sit_for (make_number (2), 0, 2);
10364 if (!NILP (waited
) && message_p
)
10365 restore_message ();
10367 unbind_to (count
, Qnil
);
10371 RETURN_UNGCPRO (value
);
10375 /* Return nonzero if input events are pending. */
10378 detect_input_pending (void)
10380 if (!input_pending
)
10381 get_input_pending (&input_pending
, 0);
10383 return input_pending
;
10386 /* Return nonzero if input events other than mouse movements are
10390 detect_input_pending_ignore_squeezables (void)
10392 if (!input_pending
)
10393 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10395 return input_pending
;
10398 /* Return nonzero if input events are pending, and run any pending timers. */
10401 detect_input_pending_run_timers (int do_display
)
10403 int old_timers_run
= timers_run
;
10405 if (!input_pending
)
10406 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10408 if (old_timers_run
!= timers_run
&& do_display
)
10410 redisplay_preserve_echo_area (8);
10411 /* The following fixes a bug when using lazy-lock with
10412 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10413 from an idle timer function. The symptom of the bug is that
10414 the cursor sometimes doesn't become visible until the next X
10415 event is processed. --gerd. */
10417 Lisp_Object tail
, frame
;
10418 FOR_EACH_FRAME (tail
, frame
)
10419 if (FRAME_RIF (XFRAME (frame
)))
10420 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10424 return input_pending
;
10427 /* This is called in some cases before a possible quit.
10428 It cases the next call to detect_input_pending to recompute input_pending.
10429 So calling this function unnecessarily can't do any harm. */
10432 clear_input_pending (void)
10437 /* Return nonzero if there are pending requeued events.
10438 This isn't used yet. The hope is to make wait_reading_process_output
10439 call it, and return if it runs Lisp code that unreads something.
10440 The problem is, kbd_buffer_get_event needs to be fixed to know what
10441 to do in that case. It isn't trivial. */
10444 requeued_events_pending_p (void)
10446 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10450 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10451 doc
: /* Return t if command input is currently available with no wait.
10452 Actually, the value is nil only if we can be sure that no input is available;
10453 if there is a doubt, the value is t. */)
10456 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10457 || !NILP (Vunread_post_input_method_events
)
10458 || !NILP (Vunread_input_method_events
))
10461 get_input_pending (&input_pending
,
10462 READABLE_EVENTS_DO_TIMERS_NOW
10463 | READABLE_EVENTS_FILTER_EVENTS
);
10464 return input_pending
> 0 ? Qt
: Qnil
;
10467 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10468 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10471 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10474 if (total_keys
< NUM_RECENT_KEYS
)
10475 return Fvector (total_keys
, keys
);
10478 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10479 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10480 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10481 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10482 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10487 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10488 doc
: /* Return the key sequence that invoked this command.
10489 However, if the command has called `read-key-sequence', it returns
10490 the last key sequence that has been read.
10491 The value is a string or a vector.
10493 See also `this-command-keys-vector'. */)
10496 return make_event_array (this_command_key_count
,
10497 XVECTOR (this_command_keys
)->contents
);
10500 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10501 doc
: /* Return the key sequence that invoked this command, as a vector.
10502 However, if the command has called `read-key-sequence', it returns
10503 the last key sequence that has been read.
10505 See also `this-command-keys'. */)
10508 return Fvector (this_command_key_count
,
10509 XVECTOR (this_command_keys
)->contents
);
10512 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10513 Sthis_single_command_keys
, 0, 0, 0,
10514 doc
: /* Return the key sequence that invoked this command.
10515 More generally, it returns the last key sequence read, either by
10516 the command loop or by `read-key-sequence'.
10517 Unlike `this-command-keys', this function's value
10518 does not include prefix arguments.
10519 The value is always a vector. */)
10522 return Fvector (this_command_key_count
10523 - this_single_command_key_start
,
10524 (XVECTOR (this_command_keys
)->contents
10525 + this_single_command_key_start
));
10528 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10529 Sthis_single_command_raw_keys
, 0, 0, 0,
10530 doc
: /* Return the raw events that were read for this command.
10531 More generally, it returns the last key sequence read, either by
10532 the command loop or by `read-key-sequence'.
10533 Unlike `this-single-command-keys', this function's value
10534 shows the events before all translations (except for input methods).
10535 The value is always a vector. */)
10538 return Fvector (raw_keybuf_count
,
10539 (XVECTOR (raw_keybuf
)->contents
));
10542 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10543 Sreset_this_command_lengths
, 0, 0, 0,
10544 doc
: /* Make the unread events replace the last command and echo.
10545 Used in `universal-argument-other-key'.
10547 `universal-argument-other-key' rereads the event just typed.
10548 It then gets translated through `function-key-map'.
10549 The translated event has to replace the real events,
10550 both in the value of (this-command-keys) and in echoing.
10551 To achieve this, `universal-argument-other-key' calls
10552 `reset-this-command-lengths', which discards the record of reading
10553 these events the first time. */)
10556 this_command_key_count
= before_command_key_count
;
10557 if (this_command_key_count
< this_single_command_key_start
)
10558 this_single_command_key_start
= this_command_key_count
;
10560 echo_truncate (before_command_echo_length
);
10562 /* Cause whatever we put into unread-command-events
10563 to echo as if it were being freshly read from the keyboard. */
10564 this_command_key_count_reset
= 1;
10569 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10570 Sclear_this_command_keys
, 0, 1, 0,
10571 doc
: /* Clear out the vector that `this-command-keys' returns.
10572 Also clear the record of the last 100 events, unless optional arg
10573 KEEP-RECORD is non-nil. */)
10574 (Lisp_Object keep_record
)
10578 this_command_key_count
= 0;
10579 this_command_key_count_reset
= 0;
10581 if (NILP (keep_record
))
10583 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10584 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10586 recent_keys_index
= 0;
10591 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10592 doc
: /* Return the current depth in recursive edits. */)
10596 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10600 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10601 "FOpen dribble file: ",
10602 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10603 If FILE is nil, close any open dribble file. */)
10615 file
= Fexpand_file_name (file
, Qnil
);
10616 dribble
= fopen (SSDATA (file
), "w");
10618 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10623 DEFUE ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10624 doc
: /* Discard the contents of the terminal input buffer.
10625 Also end any kbd macro being defined. */)
10628 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10630 /* Discard the last command from the macro. */
10631 Fcancel_kbd_macro_events ();
10635 update_mode_lines
++;
10637 Vunread_command_events
= Qnil
;
10638 unread_command_char
= -1;
10640 discard_tty_input ();
10642 kbd_fetch_ptr
= kbd_store_ptr
;
10648 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10649 doc
: /* Stop Emacs and return to superior process. You can resume later.
10650 If `cannot-suspend' is non-nil, or if the system doesn't support job
10651 control, run a subshell instead.
10653 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10654 to be read as terminal input by Emacs's parent, after suspension.
10656 Before suspending, run the normal hook `suspend-hook'.
10657 After resumption run the normal hook `suspend-resume-hook'.
10659 Some operating systems cannot stop the Emacs process and resume it later.
10660 On such systems, Emacs starts a subshell instead of suspending. */)
10661 (Lisp_Object stuffstring
)
10663 int count
= SPECPDL_INDEX ();
10664 int old_height
, old_width
;
10666 struct gcpro gcpro1
;
10669 if (tty_list
&& tty_list
->next
)
10670 error ("There are other tty frames open; close them before suspending Emacs");
10672 if (!NILP (stuffstring
))
10673 CHECK_STRING (stuffstring
);
10675 /* Run the functions in suspend-hook. */
10676 hook
= intern ("suspend-hook");
10677 Frun_hooks (1, &hook
);
10679 GCPRO1 (stuffstring
);
10680 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10681 reset_all_sys_modes ();
10682 /* sys_suspend can get an error if it tries to fork a subshell
10683 and the system resources aren't available for that. */
10684 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10686 stuff_buffered_input (stuffstring
);
10687 if (cannot_suspend
)
10691 unbind_to (count
, Qnil
);
10693 /* Check if terminal/window size has changed.
10694 Note that this is not useful when we are running directly
10695 with a window system; but suspend should be disabled in that case. */
10696 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10697 if (width
!= old_width
|| height
!= old_height
)
10698 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10700 /* Run suspend-resume-hook. */
10701 hook
= intern ("suspend-resume-hook");
10702 Frun_hooks (1, &hook
);
10708 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10709 Then in any case stuff anything Emacs has read ahead and not used. */
10712 stuff_buffered_input (Lisp_Object stuffstring
)
10714 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10715 register unsigned char *p
;
10717 if (STRINGP (stuffstring
))
10719 register EMACS_INT count
;
10721 p
= SDATA (stuffstring
);
10722 count
= SBYTES (stuffstring
);
10723 while (count
-- > 0)
10728 /* Anything we have read ahead, put back for the shell to read. */
10729 /* ?? What should this do when we have multiple keyboards??
10730 Should we ignore anything that was typed in at the "wrong" kboard?
10732 rms: we should stuff everything back into the kboard
10734 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10737 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10738 kbd_fetch_ptr
= kbd_buffer
;
10739 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10740 stuff_char (kbd_fetch_ptr
->code
);
10742 clear_event (kbd_fetch_ptr
);
10746 #endif /* SIGTSTP */
10750 set_waiting_for_input (struct timeval
*time_to_clear
)
10752 input_available_clear_time
= time_to_clear
;
10754 /* Tell handle_interrupt to throw back to read_char, */
10755 waiting_for_input
= 1;
10757 /* If handle_interrupt was called before and buffered a C-g,
10758 make it run again now, to avoid timing error. */
10759 if (!NILP (Vquit_flag
))
10760 quit_throw_to_read_char ();
10764 clear_waiting_for_input (void)
10766 /* Tell handle_interrupt not to throw back to read_char, */
10767 waiting_for_input
= 0;
10768 input_available_clear_time
= 0;
10771 /* The SIGINT handler.
10773 If we have a frame on the controlling tty, we assume that the
10774 SIGINT was generated by C-g, so we call handle_interrupt.
10775 Otherwise, the handler kills Emacs. */
10778 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10779 /* compilers complain in signal calls. */
10781 /* Must preserve main program's value of errno. */
10782 int old_errno
= errno
;
10783 struct terminal
*terminal
;
10785 SIGNAL_THREAD_CHECK (signalnum
);
10787 /* See if we have an active terminal on our controlling tty. */
10788 terminal
= get_named_tty ("/dev/tty");
10791 /* If there are no frames there, let's pretend that we are a
10792 well-behaving UN*X program and quit. */
10793 Fkill_emacs (Qnil
);
10797 /* Otherwise, the SIGINT was probably generated by C-g. */
10799 /* Set internal_last_event_frame to the top frame of the
10800 controlling tty, if we have a frame there. We disable the
10801 interrupt key on secondary ttys, so the SIGINT must have come
10802 from the controlling tty. */
10803 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10805 handle_interrupt ();
10811 /* This routine is called at interrupt level in response to C-g.
10813 It is called from the SIGINT handler or kbd_buffer_store_event.
10815 If `waiting_for_input' is non zero, then unless `echoing' is
10816 nonzero, immediately throw back to read_char.
10818 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10819 eval to throw, when it gets a chance. If quit-flag is already
10820 non-nil, it stops the job right away. */
10823 handle_interrupt (void)
10829 /* XXX This code needs to be revised for multi-tty support. */
10830 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10832 /* If SIGINT isn't blocked, don't let us be interrupted by
10833 another SIGINT, it might be harmful due to non-reentrancy
10834 in I/O functions. */
10835 sigblock (sigmask (SIGINT
));
10838 reset_all_sys_modes ();
10840 #ifdef SIGTSTP /* Support possible in later USG versions */
10842 * On systems which can suspend the current process and return to the original
10843 * shell, this command causes the user to end up back at the shell.
10844 * The "Auto-save" and "Abort" questions are not asked until
10845 * the user elects to return to emacs, at which point he can save the current
10846 * job and either dump core or continue.
10850 /* Perhaps should really fork an inferior shell?
10851 But that would not provide any way to get back
10852 to the original shell, ever. */
10853 printf ("No support for stopping a process on this operating system;\n");
10854 printf ("you can continue or abort.\n");
10855 #endif /* not SIGTSTP */
10857 /* We must remain inside the screen area when the internal terminal
10858 is used. Note that [Enter] is not echoed by dos. */
10859 cursor_to (SELECTED_FRAME (), 0, 0);
10861 /* It doesn't work to autosave while GC is in progress;
10862 the code used for auto-saving doesn't cope with the mark bit. */
10863 if (!gc_in_progress
)
10865 printf ("Auto-save? (y or n) ");
10867 if (((c
= getchar ()) & ~040) == 'Y')
10869 Fdo_auto_save (Qt
, Qnil
);
10871 printf ("\r\nAuto-save done");
10872 #else /* not MSDOS */
10873 printf ("Auto-save done\n");
10874 #endif /* not MSDOS */
10876 while (c
!= '\n') c
= getchar ();
10880 /* During GC, it must be safe to reenable quitting again. */
10881 Vinhibit_quit
= Qnil
;
10884 #endif /* not MSDOS */
10885 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10886 printf ("but will instead do a real quit after garbage collection ends\r\n");
10891 printf ("\r\nAbort? (y or n) ");
10892 #else /* not MSDOS */
10893 printf ("Abort (and dump core)? (y or n) ");
10894 #endif /* not MSDOS */
10896 if (((c
= getchar ()) & ~040) == 'Y')
10898 while (c
!= '\n') c
= getchar ();
10900 printf ("\r\nContinuing...\r\n");
10901 #else /* not MSDOS */
10902 printf ("Continuing...\n");
10903 #endif /* not MSDOS */
10905 init_all_sys_modes ();
10910 /* If executing a function that wants to be interrupted out of
10911 and the user has not deferred quitting by binding `inhibit-quit'
10912 then quit right away. */
10913 if (immediate_quit
&& NILP (Vinhibit_quit
))
10915 struct gl_state_s saved
;
10916 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10918 immediate_quit
= 0;
10921 GCPRO4 (saved
.object
, saved
.global_code
,
10922 saved
.current_syntax_table
, saved
.old_prop
);
10923 Fsignal (Qquit
, Qnil
);
10924 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10929 /* Else request quit when it's safe */
10933 /* TODO: The longjmp in this call throws the NS event loop integration off,
10934 and it seems to do fine without this. Probably some attention
10935 needs to be paid to the setting of waiting_for_input in
10936 wait_reading_process_output() under HAVE_NS because of the call
10937 to ns_select there (needed because otherwise events aren't picked up
10938 outside of polling since we don't get SIGIO like X and we don't have a
10939 separate event loop thread like W32. */
10941 if (waiting_for_input
&& !echoing
)
10942 quit_throw_to_read_char ();
10946 /* Handle a C-g by making read_char return C-g. */
10949 quit_throw_to_read_char (void)
10952 /* Prevent another signal from doing this before we finish. */
10953 clear_waiting_for_input ();
10956 Vunread_command_events
= Qnil
;
10957 unread_command_char
= -1;
10959 #if 0 /* Currently, sit_for is called from read_char without turning
10960 off polling. And that can call set_waiting_for_input.
10961 It seems to be harmless. */
10962 #ifdef POLL_FOR_INPUT
10963 /* May be > 1 if in recursive minibuffer. */
10964 if (poll_suppress_count
== 0)
10968 if (FRAMEP (internal_last_event_frame
)
10969 && !EQ (internal_last_event_frame
, selected_frame
))
10970 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10973 _longjmp (getcjmp
, 1);
10976 DEFUE ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10977 Sset_input_interrupt_mode
, 1, 1, 0,
10978 doc
: /* Set interrupt mode of reading keyboard input.
10979 If INTERRUPT is non-nil, Emacs will use input interrupts;
10980 otherwise Emacs uses CBREAK mode.
10982 See also `current-input-mode'. */)
10983 (Lisp_Object interrupt
)
10985 int new_interrupt_input
;
10987 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10988 #ifdef HAVE_X_WINDOWS
10989 if (x_display_list
!= NULL
)
10991 /* When using X, don't give the user a real choice,
10992 because we haven't implemented the mechanisms to support it. */
10993 new_interrupt_input
= 1;
10996 #endif /* HAVE_X_WINDOWS */
10997 new_interrupt_input
= !NILP (interrupt
);
10998 #else /* not SIGIO */
10999 new_interrupt_input
= 0;
11000 #endif /* not SIGIO */
11002 if (new_interrupt_input
!= interrupt_input
)
11004 #ifdef POLL_FOR_INPUT
11008 /* this causes startup screen to be restored and messes with the mouse */
11009 reset_all_sys_modes ();
11010 interrupt_input
= new_interrupt_input
;
11011 init_all_sys_modes ();
11013 interrupt_input
= new_interrupt_input
;
11016 #ifdef POLL_FOR_INPUT
11017 poll_suppress_count
= 1;
11024 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11025 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11026 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11027 C-q in key sequences.
11029 This setting only has an effect on tty terminals and only when
11030 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11032 See also `current-input-mode'. */)
11033 (Lisp_Object flow
, Lisp_Object terminal
)
11035 struct terminal
*t
= get_terminal (terminal
, 1);
11036 struct tty_display_info
*tty
;
11037 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11039 tty
= t
->display_info
.tty
;
11041 if (tty
->flow_control
!= !NILP (flow
))
11044 /* this causes startup screen to be restored and messes with the mouse */
11045 reset_sys_modes (tty
);
11048 tty
->flow_control
= !NILP (flow
);
11051 init_sys_modes (tty
);
11057 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11058 doc
: /* Enable or disable 8-bit input on TERMINAL.
11059 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11060 bit as the Meta modifier.
11062 If META is nil, Emacs will ignore the top bit, on the assumption it is
11065 Otherwise, Emacs will accept and pass through 8-bit input without
11066 specially interpreting the top bit.
11068 This setting only has an effect on tty terminal devices.
11070 Optional parameter TERMINAL specifies the tty terminal device to use.
11071 It may be a terminal object, a frame, or nil for the terminal used by
11072 the currently selected frame.
11074 See also `current-input-mode'. */)
11075 (Lisp_Object meta
, Lisp_Object terminal
)
11077 struct terminal
*t
= get_terminal (terminal
, 1);
11078 struct tty_display_info
*tty
;
11081 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11083 tty
= t
->display_info
.tty
;
11087 else if (EQ (meta
, Qt
))
11092 if (tty
->meta_key
!= new_meta
)
11095 /* this causes startup screen to be restored and messes with the mouse */
11096 reset_sys_modes (tty
);
11099 tty
->meta_key
= new_meta
;
11102 init_sys_modes (tty
);
11108 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11109 doc
: /* Specify character used for quitting.
11110 QUIT must be an ASCII character.
11112 This function only has an effect on the controlling tty of the Emacs
11115 See also `current-input-mode'. */)
11118 struct terminal
*t
= get_named_tty ("/dev/tty");
11119 struct tty_display_info
*tty
;
11120 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11122 tty
= t
->display_info
.tty
;
11124 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11125 error ("QUIT must be an ASCII character");
11128 /* this causes startup screen to be restored and messes with the mouse */
11129 reset_sys_modes (tty
);
11132 /* Don't let this value be out of range. */
11133 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11136 init_sys_modes (tty
);
11142 DEFUE ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11143 doc
: /* Set mode of reading keyboard input.
11144 First arg INTERRUPT non-nil means use input interrupts;
11145 nil means use CBREAK mode.
11146 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11147 (no effect except in CBREAK mode).
11148 Third arg META t means accept 8-bit input (for a Meta key).
11149 META nil means ignore the top bit, on the assumption it is parity.
11150 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11151 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11152 See also `current-input-mode'. */)
11153 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11155 Fset_input_interrupt_mode (interrupt
);
11156 Fset_output_flow_control (flow
, Qnil
);
11157 Fset_input_meta_mode (meta
, Qnil
);
11159 Fset_quit_char (quit
);
11163 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11164 doc
: /* Return information about the way Emacs currently reads keyboard input.
11165 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11166 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11167 nil, Emacs is using CBREAK mode.
11168 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11169 terminal; this does not apply if Emacs uses interrupt-driven input.
11170 META is t if accepting 8-bit input with 8th bit as Meta flag.
11171 META nil means ignoring the top bit, on the assumption it is parity.
11172 META is neither t nor nil if accepting 8-bit input and using
11173 all 8 bits as the character code.
11174 QUIT is the character Emacs currently uses to quit.
11175 The elements of this list correspond to the arguments of
11176 `set-input-mode'. */)
11179 Lisp_Object val
[4];
11180 struct frame
*sf
= XFRAME (selected_frame
);
11182 val
[0] = interrupt_input
? Qt
: Qnil
;
11183 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11185 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11186 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11188 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11195 XSETFASTINT (val
[3], quit_char
);
11197 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11200 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11201 doc
: /* Return position information for pixel coordinates X and Y.
11202 By default, X and Y are relative to text area of the selected window.
11203 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11204 If optional fourth arg WHOLE is non-nil, X is relative to the left
11205 edge of the window.
11207 The return value is similar to a mouse click position:
11208 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11209 IMAGE (DX . DY) (WIDTH . HEIGHT))
11210 The `posn-' functions access elements of such lists. */)
11211 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11216 if (NILP (frame_or_window
))
11217 frame_or_window
= selected_window
;
11219 if (WINDOWP (frame_or_window
))
11223 CHECK_LIVE_WINDOW (frame_or_window
);
11225 w
= XWINDOW (frame_or_window
);
11226 XSETINT (x
, (XINT (x
)
11227 + WINDOW_LEFT_EDGE_X (w
)
11229 ? window_box_left_offset (w
, TEXT_AREA
)
11231 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11232 frame_or_window
= w
->frame
;
11235 CHECK_LIVE_FRAME (frame_or_window
);
11237 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11240 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11241 doc
: /* Return position information for buffer POS in WINDOW.
11242 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11244 Return nil if position is not visible in window. Otherwise,
11245 the return value is similar to that returned by `event-start' for
11246 a mouse click at the upper left corner of the glyph corresponding
11247 to the given buffer position:
11248 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11249 IMAGE (DX . DY) (WIDTH . HEIGHT))
11250 The `posn-' functions access elements of such lists. */)
11251 (Lisp_Object pos
, Lisp_Object window
)
11256 window
= selected_window
;
11258 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11261 Lisp_Object x
= XCAR (tem
);
11262 Lisp_Object y
= XCAR (XCDR (tem
));
11264 /* Point invisible due to hscrolling? */
11267 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11275 * Set up a new kboard object with reasonable initial values.
11278 init_kboard (KBOARD
*kb
)
11280 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11281 KVAR (kb
, Vlast_command
) = Qnil
;
11282 KVAR (kb
, Vreal_last_command
) = Qnil
;
11283 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11284 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11285 KVAR (kb
, Vprefix_arg
) = Qnil
;
11286 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11287 KVAR (kb
, kbd_queue
) = Qnil
;
11288 kb
->kbd_queue_has_data
= 0;
11289 kb
->immediate_echo
= 0;
11290 KVAR (kb
, echo_string
) = Qnil
;
11291 kb
->echo_after_prompt
= -1;
11292 kb
->kbd_macro_buffer
= 0;
11293 kb
->kbd_macro_bufsize
= 0;
11294 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11295 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11296 kb
->reference_count
= 0;
11297 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11298 KVAR (kb
, system_key_syms
) = Qnil
;
11299 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11300 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11301 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11302 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11303 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11307 * Destroy the contents of a kboard object, but not the object itself.
11308 * We use this just before deleting it, or if we're going to initialize
11309 * it a second time.
11312 wipe_kboard (KBOARD
*kb
)
11314 xfree (kb
->kbd_macro_buffer
);
11317 /* Free KB and memory referenced from it. */
11320 delete_kboard (KBOARD
*kb
)
11324 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11327 *kbp
= kb
->next_kboard
;
11329 /* Prevent a dangling reference to KB. */
11330 if (kb
== current_kboard
11331 && FRAMEP (selected_frame
)
11332 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11334 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11336 if (current_kboard
== kb
)
11345 init_keyboard (void)
11347 /* This is correct before outermost invocation of the editor loop */
11348 command_loop_level
= -1;
11349 immediate_quit
= 0;
11350 quit_char
= Ctl ('g');
11351 Vunread_command_events
= Qnil
;
11352 unread_command_char
= -1;
11353 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11355 recent_keys_index
= 0;
11356 kbd_fetch_ptr
= kbd_buffer
;
11357 kbd_store_ptr
= kbd_buffer
;
11358 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11359 do_mouse_tracking
= Qnil
;
11362 interrupt_input_blocked
= 0;
11363 interrupt_input_pending
= 0;
11365 pending_signals
= 0;
11368 /* This means that command_loop_1 won't try to select anything the first
11370 internal_last_event_frame
= Qnil
;
11371 Vlast_event_frame
= internal_last_event_frame
;
11373 current_kboard
= initial_kboard
;
11374 /* Re-initialize the keyboard again. */
11375 wipe_kboard (current_kboard
);
11376 init_kboard (current_kboard
);
11377 /* A value of nil for Vwindow_system normally means a tty, but we also use
11378 it for the initial terminal since there is no window system there. */
11379 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11381 if (!noninteractive
)
11383 /* Before multi-tty support, these handlers used to be installed
11384 only if the current session was a tty session. Now an Emacs
11385 session may have multiple display types, so we always handle
11386 SIGINT. There is special code in interrupt_signal to exit
11387 Emacs on SIGINT when there are no termcap frames on the
11388 controlling terminal. */
11389 signal (SIGINT
, interrupt_signal
);
11391 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11392 SIGQUIT and we can't tell which one it will give us. */
11393 signal (SIGQUIT
, interrupt_signal
);
11394 #endif /* not DOS_NT */
11396 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11398 if (!noninteractive
)
11399 signal (SIGIO
, input_available_signal
);
11402 /* Use interrupt input by default, if it works and noninterrupt input
11403 has deficiencies. */
11405 #ifdef INTERRUPT_INPUT
11406 interrupt_input
= 1;
11408 interrupt_input
= 0;
11414 if (keyboard_init_hook
)
11415 (*keyboard_init_hook
) ();
11417 #ifdef POLL_FOR_INPUT
11419 poll_suppress_count
= 1;
11424 /* This type's only use is in syms_of_keyboard, to initialize the
11425 event header symbols and put properties on them. */
11426 struct event_head
{
11432 static const struct event_head head_table
[] = {
11433 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11434 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11435 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11436 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11437 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11438 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11439 /* `select-window' should be handled just like `switch-frame'
11440 in read_key_sequence. */
11441 {&Qselect_window
, "select-window", &Qswitch_frame
}
11445 syms_of_keyboard (void)
11447 pending_funcalls
= Qnil
;
11448 staticpro (&pending_funcalls
);
11450 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11451 staticpro (&Vlispy_mouse_stem
);
11454 DEFSYM (QCimage
, ":image");
11455 DEFSYM (Qhelp_echo
, "help-echo");
11456 DEFSYM (Qrtl
, ":rtl");
11458 staticpro (&item_properties
);
11459 item_properties
= Qnil
;
11461 staticpro (&tool_bar_item_properties
);
11462 tool_bar_item_properties
= Qnil
;
11463 staticpro (&tool_bar_items_vector
);
11464 tool_bar_items_vector
= Qnil
;
11466 staticpro (&real_this_command
);
11467 real_this_command
= Qnil
;
11469 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11470 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11471 DEFSYM (Qself_insert_command
, "self-insert-command");
11472 DEFSYM (Qforward_char
, "forward-char");
11473 DEFSYM (Qbackward_char
, "backward-char");
11474 DEFSYM (Qdisabled
, "disabled");
11475 DEFSYM (Qundefined
, "undefined");
11476 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11477 DEFSYM (Qpost_command_hook
, "post-command-hook");
11478 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11479 DEFSYM (Qfunction_key
, "function-key");
11480 DEFSYM (Qmouse_click
, "mouse-click");
11481 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11482 DEFSYM (Qsave_session
, "save-session");
11483 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11484 DEFSYM (Qmenu_enable
, "menu-enable");
11486 #if defined (WINDOWSNT)
11487 DEFSYM (Qlanguage_change
, "language-change");
11491 DEFSYM (Qdbus_event
, "dbus-event");
11494 DEFSYM (QCenable
, ":enable");
11495 DEFSYM (QCvisible
, ":visible");
11496 DEFSYM (QChelp
, ":help");
11497 DEFSYM (QCfilter
, ":filter");
11498 DEFSYM (QCbutton
, ":button");
11499 DEFSYM (QCkeys
, ":keys");
11500 DEFSYM (QCkey_sequence
, ":key-sequence");
11501 DEFSYM (QCtoggle
, ":toggle");
11502 DEFSYM (QCradio
, ":radio");
11503 DEFSYM (QClabel
, ":label");
11504 DEFSYM (QCvert_only
, ":vert-only");
11506 DEFSYM (Qmode_line
, "mode-line");
11507 DEFSYM (Qvertical_line
, "vertical-line");
11508 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11509 DEFSYM (Qmenu_bar
, "menu-bar");
11511 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11512 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11515 DEFSYM (Qabove_handle
, "above-handle");
11516 DEFSYM (Qhandle
, "handle");
11517 DEFSYM (Qbelow_handle
, "below-handle");
11518 DEFSYM (Qup
, "up");
11519 DEFSYM (Qdown
, "down");
11520 DEFSYM (Qtop
, "top");
11521 DEFSYM (Qbottom
, "bottom");
11522 DEFSYM (Qend_scroll
, "end-scroll");
11523 DEFSYM (Qratio
, "ratio");
11525 DEFSYM (Qevent_kind
, "event-kind");
11526 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11527 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11528 DEFSYM (Qmodifier_cache
, "modifier-cache");
11530 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11531 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11533 DEFSYM (Qpolling_period
, "polling-period");
11535 DEFSYM (Qx_set_selection
, "x-set-selection");
11536 DEFSYM (QPRIMARY
, "PRIMARY");
11537 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11539 DEFSYM (Qinput_method_function
, "input-method-function");
11540 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11541 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11543 DEFSYM (Qhelp_form_show
, "help-form-show");
11545 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11546 Fset (Qinput_method_use_echo_area
, Qnil
);
11548 last_point_position_buffer
= Qnil
;
11549 last_point_position_window
= Qnil
;
11553 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11555 for (i
= 0; i
< len
; i
++)
11557 const struct event_head
*p
= &head_table
[i
];
11558 *p
->var
= intern_c_string (p
->name
);
11559 staticpro (p
->var
);
11560 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11561 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11565 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11566 staticpro (&button_down_location
);
11567 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11568 staticpro (&mouse_syms
);
11569 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11570 / sizeof (lispy_wheel_names
[0])),
11572 staticpro (&wheel_syms
);
11576 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11578 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11579 for (i
= 0; i
< len
; i
++)
11580 if (modifier_names
[i
])
11581 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11582 staticpro (&modifier_symbols
);
11585 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11586 staticpro (&recent_keys
);
11588 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11589 staticpro (&this_command_keys
);
11591 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11592 staticpro (&raw_keybuf
);
11594 DEFSYM (Qextended_command_history
, "extended-command-history");
11595 Fset (Qextended_command_history
, Qnil
);
11597 accent_key_syms
= Qnil
;
11598 staticpro (&accent_key_syms
);
11600 func_key_syms
= Qnil
;
11601 staticpro (&func_key_syms
);
11603 drag_n_drop_syms
= Qnil
;
11604 staticpro (&drag_n_drop_syms
);
11606 unread_switch_frame
= Qnil
;
11607 staticpro (&unread_switch_frame
);
11609 internal_last_event_frame
= Qnil
;
11610 staticpro (&internal_last_event_frame
);
11612 read_key_sequence_cmd
= Qnil
;
11613 staticpro (&read_key_sequence_cmd
);
11615 menu_bar_one_keymap_changed_items
= Qnil
;
11616 staticpro (&menu_bar_one_keymap_changed_items
);
11618 menu_bar_items_vector
= Qnil
;
11619 staticpro (&menu_bar_items_vector
);
11621 help_form_saved_window_configs
= Qnil
;
11622 staticpro (&help_form_saved_window_configs
);
11624 defsubr (&Scurrent_idle_time
);
11625 defsubr (&Sevent_symbol_parse_modifiers
);
11626 defsubr (&Sevent_convert_list
);
11627 defsubr (&Sread_key_sequence
);
11628 defsubr (&Sread_key_sequence_vector
);
11629 defsubr (&Srecursive_edit
);
11630 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11631 defsubr (&Strack_mouse
);
11633 defsubr (&Sinput_pending_p
);
11634 defsubr (&Scommand_execute
);
11635 defsubr (&Srecent_keys
);
11636 defsubr (&Sthis_command_keys
);
11637 defsubr (&Sthis_command_keys_vector
);
11638 defsubr (&Sthis_single_command_keys
);
11639 defsubr (&Sthis_single_command_raw_keys
);
11640 defsubr (&Sreset_this_command_lengths
);
11641 defsubr (&Sclear_this_command_keys
);
11642 defsubr (&Ssuspend_emacs
);
11643 defsubr (&Sabort_recursive_edit
);
11644 defsubr (&Sexit_recursive_edit
);
11645 defsubr (&Srecursion_depth
);
11646 defsubr (&Stop_level
);
11647 defsubr (&Sdiscard_input
);
11648 defsubr (&Sopen_dribble_file
);
11649 defsubr (&Sset_input_interrupt_mode
);
11650 defsubr (&Sset_output_flow_control
);
11651 defsubr (&Sset_input_meta_mode
);
11652 defsubr (&Sset_quit_char
);
11653 defsubr (&Sset_input_mode
);
11654 defsubr (&Scurrent_input_mode
);
11655 defsubr (&Sexecute_extended_command
);
11656 defsubr (&Sposn_at_point
);
11657 defsubr (&Sposn_at_x_y
);
11659 DEFVAR_LISP ("last-command-event", last_command_event
,
11660 doc
: /* Last input event that was part of a command. */);
11662 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11663 doc
: /* Last input event in a command, except for mouse menu events.
11664 Mouse menus give back keys that don't look like mouse events;
11665 this variable holds the actual mouse event that led to the menu,
11666 so that you can determine whether the command was run by mouse or not. */);
11668 DEFVAR_LISP ("last-input-event", last_input_event
,
11669 doc
: /* Last input event. */);
11671 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11672 doc
: /* List of events to be read as the command input.
11673 These events are processed first, before actual keyboard input.
11674 Events read from this list are not normally added to `this-command-keys',
11675 as they will already have been added once as they were read for the first time.
11676 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11677 Vunread_command_events
= Qnil
;
11679 DEFVAR_INT ("unread-command-char", unread_command_char
,
11680 doc
: /* If not -1, an object to be read as next command input event. */);
11682 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11683 doc
: /* List of events to be processed as input by input methods.
11684 These events are processed before `unread-command-events'
11685 and actual keyboard input, but are not given to `input-method-function'. */);
11686 Vunread_post_input_method_events
= Qnil
;
11688 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11689 doc
: /* List of events to be processed as input by input methods.
11690 These events are processed after `unread-command-events', but
11691 before actual keyboard input.
11692 If there's an active input method, the events are given to
11693 `input-method-function'. */);
11694 Vunread_input_method_events
= Qnil
;
11696 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11697 doc
: /* Meta-prefix character code.
11698 Meta-foo as command input turns into this character followed by foo. */);
11699 XSETINT (meta_prefix_char
, 033);
11701 DEFVAR_KBOARD ("last-command", Vlast_command
,
11702 doc
: /* The last command executed.
11703 Normally a symbol with a function definition, but can be whatever was found
11704 in the keymap, or whatever the variable `this-command' was set to by that
11707 The value `mode-exit' is special; it means that the previous command
11708 read an event that told it to exit, and it did so and unread that event.
11709 In other words, the present command is the event that made the previous
11712 The value `kill-region' is special; it means that the previous command
11713 was a kill command.
11715 `last-command' has a separate binding for each terminal device.
11716 See Info node `(elisp)Multiple Terminals'. */);
11718 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11719 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11721 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11722 doc
: /* Last command that may be repeated.
11723 The last command executed that was not bound to an input event.
11724 This is the command `repeat' will try to repeat. */);
11726 DEFVAR_LISP ("this-command", Vthis_command
,
11727 doc
: /* The command now being executed.
11728 The command can set this variable; whatever is put here
11729 will be in `last-command' during the following command. */);
11730 Vthis_command
= Qnil
;
11732 DEFVAR_LISP ("this-command-keys-shift-translated",
11733 Vthis_command_keys_shift_translated
,
11734 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11735 Shift-translation occurs when there is no binding for the key sequence
11736 as entered, but a binding was found by changing an upper-case letter
11737 to lower-case, or a shifted function key to an unshifted one. */);
11738 Vthis_command_keys_shift_translated
= Qnil
;
11740 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11741 doc
: /* The command bound to the current key sequence before remapping.
11742 It equals `this-command' if the original command was not remapped through
11743 any of the active keymaps. Otherwise, the value of `this-command' is the
11744 result of looking up the original command in the active keymaps. */);
11745 Vthis_original_command
= Qnil
;
11747 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11748 doc
: /* *Number of input events between auto-saves.
11749 Zero means disable autosaving due to number of characters typed. */);
11750 auto_save_interval
= 300;
11752 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11753 doc
: /* *Number of seconds idle time before auto-save.
11754 Zero or nil means disable auto-saving due to idleness.
11755 After auto-saving due to this many seconds of idle time,
11756 Emacs also does a garbage collection if that seems to be warranted. */);
11757 XSETFASTINT (Vauto_save_timeout
, 30);
11759 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11760 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11761 The value may be integer or floating point. */);
11762 Vecho_keystrokes
= make_number (1);
11764 DEFVAR_INT ("polling-period", polling_period
,
11765 doc
: /* *Interval between polling for input during Lisp execution.
11766 The reason for polling is to make C-g work to stop a running program.
11767 Polling is needed only when using X windows and SIGIO does not work.
11768 Polling is automatically disabled in all other cases. */);
11769 polling_period
= 2;
11771 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11772 doc
: /* *Maximum time between mouse clicks to make a double-click.
11773 Measured in milliseconds. The value nil means disable double-click
11774 recognition; t means double-clicks have no time limit and are detected
11775 by position only. */);
11776 Vdouble_click_time
= make_number (500);
11778 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11779 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11780 On window-system frames, value is the number of pixels the mouse may have
11781 moved horizontally or vertically between two clicks to make a double-click.
11782 On non window-system frames, value is interpreted in units of 1/8 characters
11785 This variable is also the threshold for motion of the mouse
11786 to count as a drag. */);
11787 double_click_fuzz
= 3;
11789 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11790 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11791 inhibit_local_menu_bar_menus
= 0;
11793 DEFVAR_INT ("num-input-keys", num_input_keys
,
11794 doc
: /* Number of complete key sequences read as input so far.
11795 This includes key sequences read from keyboard macros.
11796 The number is effectively the number of interactive command invocations. */);
11797 num_input_keys
= 0;
11799 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11800 doc
: /* Number of input events read from the keyboard so far.
11801 This does not include events generated by keyboard macros. */);
11802 num_nonmacro_input_events
= 0;
11804 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11805 doc
: /* The frame in which the most recently read event occurred.
11806 If the last event came from a keyboard macro, this is set to `macro'. */);
11807 Vlast_event_frame
= Qnil
;
11809 /* This variable is set up in sysdep.c. */
11810 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11811 doc
: /* The ERASE character as set by the user with stty. */);
11813 DEFVAR_LISP ("help-char", Vhelp_char
,
11814 doc
: /* Character to recognize as meaning Help.
11815 When it is read, do `(eval help-form)', and display result if it's a string.
11816 If the value of `help-form' is nil, this char can be read normally. */);
11817 XSETINT (Vhelp_char
, Ctl ('H'));
11819 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11820 doc
: /* List of input events to recognize as meaning Help.
11821 These work just like the value of `help-char' (see that). */);
11822 Vhelp_event_list
= Qnil
;
11824 DEFVAR_LISP ("help-form", Vhelp_form
,
11825 doc
: /* Form to execute when character `help-char' is read.
11826 If the form returns a string, that string is displayed.
11827 If `help-form' is nil, the help char is not recognized. */);
11830 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11831 doc
: /* Command to run when `help-char' character follows a prefix key.
11832 This command is used only when there is no actual binding
11833 for that character after that prefix key. */);
11834 Vprefix_help_command
= Qnil
;
11836 DEFVAR_LISP ("top-level", Vtop_level
,
11837 doc
: /* Form to evaluate when Emacs starts up.
11838 Useful to set before you dump a modified Emacs. */);
11841 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11842 doc
: /* Translate table for local keyboard input, or nil.
11843 If non-nil, the value should be a char-table. Each character read
11844 from the keyboard is looked up in this char-table. If the value found
11845 there is non-nil, then it is used instead of the actual input character.
11847 The value can also be a string or vector, but this is considered obsolete.
11848 If it is a string or vector of length N, character codes N and up are left
11849 untranslated. In a vector, an element which is nil means "no translation".
11851 This is applied to the characters supplied to input methods, not their
11852 output. See also `translation-table-for-input'.
11854 This variable has a separate binding for each terminal.
11855 See Info node `(elisp)Multiple Terminals'. */);
11857 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11858 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11859 \(Even if the operating system has support for stopping a process.\) */);
11860 cannot_suspend
= 0;
11862 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11863 doc
: /* Non-nil means prompt with menus when appropriate.
11864 This is done when reading from a keymap that has a prompt string,
11865 for elements that have prompt strings.
11866 The menu is displayed on the screen
11867 if X menus were enabled at configuration
11868 time and the previous event was a mouse click prefix key.
11869 Otherwise, menu prompting uses the echo area. */);
11870 menu_prompting
= 1;
11872 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11873 doc
: /* Character to see next line of menu prompt.
11874 Type this character while in a menu prompt to rotate around the lines of it. */);
11875 XSETINT (menu_prompt_more_char
, ' ');
11877 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11878 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11879 Emacs applies the modifiers of the character stored here to each keyboard
11880 character it reads. For example, after evaluating the expression
11881 (setq extra-keyboard-modifiers ?\\C-x)
11882 all input characters will have the control modifier applied to them.
11884 Note that the character ?\\C-@, equivalent to the integer zero, does
11885 not count as a control character; rather, it counts as a character
11886 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11887 cancels any modification. */);
11888 extra_keyboard_modifiers
= 0;
11890 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11891 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11892 The command loop sets this to nil before each command,
11893 and tests the value when the command returns.
11894 Buffer modification stores t in this variable. */);
11895 Vdeactivate_mark
= Qnil
;
11896 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11898 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11899 doc
: /* Normal hook run before each command is executed.
11900 If an unhandled error happens in running this hook,
11901 the function in which the error occurred is unconditionally removed, since
11902 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11903 Vpre_command_hook
= Qnil
;
11905 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11906 doc
: /* Normal hook run after each command is executed.
11907 If an unhandled error happens in running this hook,
11908 the function in which the error occurred is unconditionally removed, since
11909 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11910 Vpost_command_hook
= Qnil
;
11913 DEFVAR_LISP ("echo-area-clear-hook", ...,
11914 doc
: /* Normal hook run when clearing the echo area. */);
11916 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11917 Fset (Qecho_area_clear_hook
, Qnil
);
11919 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11920 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11921 Vlucid_menu_bar_dirty_flag
= Qnil
;
11923 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11924 doc
: /* List of menu bar items to move to the end of the menu bar.
11925 The elements of the list are event types that may have menu bar bindings. */);
11926 Vmenu_bar_final_items
= Qnil
;
11928 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11929 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11930 This is used internally by graphical displays that do not render
11931 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11932 Vtool_bar_separator_image_expression
= Qnil
;
11934 DEFVAR_KBOARD ("overriding-terminal-local-map",
11935 Voverriding_terminal_local_map
,
11936 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11937 If this variable is non-nil, it is used as a keymap instead of the
11938 buffer's local map, and the minor mode keymaps and text property keymaps.
11939 It also replaces `overriding-local-map'.
11941 This variable is intended to let commands such as `universal-argument'
11942 set up a different keymap for reading the next command.
11944 `overriding-terminal-local-map' has a separate binding for each
11946 See Info node `(elisp)Multiple Terminals'. */);
11948 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11949 doc
: /* Keymap that overrides all other local keymaps.
11950 If this variable is non-nil, it is used as a keymap--replacing the
11951 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11952 Voverriding_local_map
= Qnil
;
11954 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11955 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11956 Otherwise, the menu bar continues to reflect the buffer's local map
11957 and the minor mode maps regardless of `overriding-local-map'. */);
11958 Voverriding_local_map_menu_flag
= Qnil
;
11960 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11961 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11962 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11964 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11965 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11967 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11968 doc
: /* Alist of system-specific X windows key symbols.
11969 Each element should have the form (N . SYMBOL) where N is the
11970 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11971 and SYMBOL is its name.
11973 `system-key-alist' has a separate binding for each terminal device.
11974 See Info node `(elisp)Multiple Terminals'. */);
11976 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11977 doc
: /* Keymap that translates key sequences to key sequences during input.
11978 This is used mainly for mapping key sequences into some preferred
11979 key events (symbols).
11981 The `read-key-sequence' function replaces any subsequence bound by
11982 `local-function-key-map' with its binding. More precisely, when the
11983 active keymaps have no binding for the current key sequence but
11984 `local-function-key-map' binds a suffix of the sequence to a vector or
11985 string, `read-key-sequence' replaces the matching suffix with its
11986 binding, and continues with the new sequence.
11988 If the binding is a function, it is called with one argument (the prompt)
11989 and its return value (a key sequence) is used.
11991 The events that come from bindings in `local-function-key-map' are not
11992 themselves looked up in `local-function-key-map'.
11994 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11995 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11996 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11997 typing `ESC O P x' would return [f1 x].
11999 `local-function-key-map' has a separate binding for each terminal
12000 device. See Info node `(elisp)Multiple Terminals'. If you need to
12001 define a binding on all terminals, change `function-key-map'
12002 instead. Initially, `local-function-key-map' is an empty keymap that
12003 has `function-key-map' as its parent on all terminal devices. */);
12005 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12006 doc
: /* Keymap that decodes input escape sequences.
12007 This is used mainly for mapping ASCII function key sequences into
12008 real Emacs function key events (symbols).
12010 The `read-key-sequence' function replaces any subsequence bound by
12011 `input-decode-map' with its binding. Contrary to `function-key-map',
12012 this map applies its rebinding regardless of the presence of an ordinary
12013 binding. So it is more like `key-translation-map' except that it applies
12014 before `function-key-map' rather than after.
12016 If the binding is a function, it is called with one argument (the prompt)
12017 and its return value (a key sequence) is used.
12019 The events that come from bindings in `input-decode-map' are not
12020 themselves looked up in `input-decode-map'.
12022 This variable is keyboard-local. */);
12024 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12025 doc
: /* The parent keymap of all `local-function-key-map' instances.
12026 Function key definitions that apply to all terminal devices should go
12027 here. If a mapping is defined in both the current
12028 `local-function-key-map' binding and this variable, then the local
12029 definition will take precendence. */);
12030 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12032 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12033 doc
: /* Keymap of key translations that can override keymaps.
12034 This keymap works like `function-key-map', but comes after that,
12035 and its non-prefix bindings override ordinary bindings.
12036 Another difference is that it is global rather than keyboard-local. */);
12037 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12039 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12040 doc
: /* List of deferred actions to be performed at a later time.
12041 The precise format isn't relevant here; we just check whether it is nil. */);
12042 Vdeferred_action_list
= Qnil
;
12044 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12045 doc
: /* Function to call to handle deferred actions, after each command.
12046 This function is called with no arguments after each command
12047 whenever `deferred-action-list' is non-nil. */);
12048 Vdeferred_action_function
= Qnil
;
12050 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12051 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12052 The value can be a length of time to show the message for.
12053 If the value is non-nil and not a number, we wait 2 seconds. */);
12054 Vsuggest_key_bindings
= Qt
;
12056 DEFVAR_LISP ("timer-list", Vtimer_list
,
12057 doc
: /* List of active absolute time timers in order of increasing time. */);
12058 Vtimer_list
= Qnil
;
12060 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12061 doc
: /* List of active idle-time timers in order of increasing time. */);
12062 Vtimer_idle_list
= Qnil
;
12064 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12065 doc
: /* If non-nil, the function that implements the current input method.
12066 It's called with one argument, a printing character that was just read.
12067 \(That means a character with code 040...0176.)
12068 Typically this function uses `read-event' to read additional events.
12069 When it does so, it should first bind `input-method-function' to nil
12070 so it will not be called recursively.
12072 The function should return a list of zero or more events
12073 to be used as input. If it wants to put back some events
12074 to be reconsidered, separately, by the input method,
12075 it can add them to the beginning of `unread-command-events'.
12077 The input method function can find in `input-method-previous-message'
12078 the previous echo area message.
12080 The input method function should refer to the variables
12081 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12082 for guidance on what to do. */);
12083 Vinput_method_function
= Qnil
;
12085 DEFVAR_LISP ("input-method-previous-message",
12086 Vinput_method_previous_message
,
12087 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12088 This variable exists because `read-event' clears the echo area
12089 before running the input method. It is nil if there was no message. */);
12090 Vinput_method_previous_message
= Qnil
;
12092 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12093 doc
: /* If non-nil, the function that implements the display of help.
12094 It's called with one argument, the help string to display. */);
12095 Vshow_help_function
= Qnil
;
12097 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12098 doc
: /* If non-nil, suppress point adjustment after executing a command.
12100 After a command is executed, if point is moved into a region that has
12101 special properties (e.g. composition, display), we adjust point to
12102 the boundary of the region. But, when a command sets this variable to
12103 non-nil, we suppress the point adjustment.
12105 This variable is set to nil before reading a command, and is checked
12106 just after executing the command. */);
12107 Vdisable_point_adjustment
= Qnil
;
12109 DEFVAR_LISP ("global-disable-point-adjustment",
12110 Vglobal_disable_point_adjustment
,
12111 doc
: /* *If non-nil, always suppress point adjustment.
12113 The default value is nil, in which case, point adjustment are
12114 suppressed only after special commands that set
12115 `disable-point-adjustment' (which see) to non-nil. */);
12116 Vglobal_disable_point_adjustment
= Qnil
;
12118 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12119 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12120 If the value is not a number, such messages don't time out. */);
12121 Vminibuffer_message_timeout
= make_number (2);
12123 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12124 doc
: /* If non-nil, any keyboard input throws to this symbol.
12125 The value of that variable is passed to `quit-flag' and later causes a
12126 peculiar kind of quitting. */);
12127 Vthrow_on_input
= Qnil
;
12129 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12130 doc
: /* If non-nil, function to output error messages.
12131 The arguments are the error data, a list of the form
12132 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12133 such as just as `condition-case' would bind its variable to,
12134 the context (a string which normally goes at the start of the message),
12135 and the Lisp function within which the error was signaled. */);
12136 Vcommand_error_function
= Qnil
;
12138 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12139 Venable_disabled_menus_and_buttons
,
12140 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12142 Help functions bind this to allow help on disabled menu items
12143 and tool-bar buttons. */);
12144 Venable_disabled_menus_and_buttons
= Qnil
;
12146 DEFVAR_LISP ("select-active-regions",
12147 Vselect_active_regions
,
12148 doc
: /* If non-nil, an active region automatically sets the primary selection.
12149 If the value is `only', only temporarily active regions (usually made
12150 by mouse-dragging or shift-selection) set the window selection.
12152 This takes effect only when Transient Mark mode is enabled. */);
12153 Vselect_active_regions
= Qt
;
12155 DEFVAR_LISP ("saved-region-selection",
12156 Vsaved_region_selection
,
12157 doc
: /* Contents of active region prior to buffer modification.
12158 If `select-active-regions' is non-nil, Emacs sets this to the
12159 text in the region before modifying the buffer. The next
12160 `deactivate-mark' call uses this to set the window selection. */);
12161 Vsaved_region_selection
= Qnil
;
12163 /* Create the initial keyboard. */
12164 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12165 init_kboard (initial_kboard
);
12166 /* Vwindow_system is left at t for now. */
12167 initial_kboard
->next_kboard
= all_kboards
;
12168 all_kboards
= initial_kboard
;
12172 keys_of_keyboard (void)
12174 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12175 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12176 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12177 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12178 initial_define_key (meta_map
, 'x', "execute-extended-command");
12180 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12181 "handle-delete-frame");
12182 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12183 "ns-put-working-text");
12184 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12185 "ns-unput-working-text");
12186 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12187 current-prefix-arg, as is done in `handle-switch-frame'.
12188 But `handle-switch-frame is not run from the special-map.
12189 Commands from that map are run in a special way that automatically
12190 preserves the prefix-arg. Restoring the prefix arg here is not just
12191 redundant but harmful:
12193 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12194 - after the first prompt, the exit-minibuffer-hook is run which may
12195 iconify a frame and thus push a `iconify-frame' event.
12196 - after running exit-minibuffer-hook, current-prefix-arg is
12197 restored to the non-nil value it had before the prompt.
12198 - we enter the second prompt.
12199 current-prefix-arg is non-nil, prefix-arg is nil.
12200 - before running the first real event, we run the special iconify-frame
12201 event, but we pass the `special' arg to execute-command so
12202 current-prefix-arg and prefix-arg are left untouched.
12203 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12204 - the next key event will have a spuriously non-nil current-prefix-arg. */
12205 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12207 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12209 /* Handling it at such a low-level causes read_key_sequence to get
12210 * confused because it doesn't realize that the current_buffer was
12211 * changed by read_char.
12213 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12214 * "handle-select-window"); */
12215 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12216 "handle-save-session");
12219 /* Define a special event which is raised for dbus callback
12221 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12222 "dbus-handle-event");
12225 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12229 /* Mark the pointers in the kboard objects.
12230 Called by the Fgarbage_collector. */
12232 mark_kboards (void)
12236 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12238 if (kb
->kbd_macro_buffer
)
12239 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12241 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12242 mark_object (KVAR (kb
, Vlast_command
));
12243 mark_object (KVAR (kb
, Vreal_last_command
));
12244 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12245 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12246 mark_object (KVAR (kb
, Vprefix_arg
));
12247 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12248 mark_object (KVAR (kb
, kbd_queue
));
12249 mark_object (KVAR (kb
, defining_kbd_macro
));
12250 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12251 mark_object (KVAR (kb
, Vsystem_key_alist
));
12252 mark_object (KVAR (kb
, system_key_syms
));
12253 mark_object (KVAR (kb
, Vwindow_system
));
12254 mark_object (KVAR (kb
, Vinput_decode_map
));
12255 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12256 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12257 mark_object (KVAR (kb
, echo_string
));
12260 struct input_event
*event
;
12261 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12263 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12264 event
= kbd_buffer
;
12265 if (event
->kind
!= SELECTION_REQUEST_EVENT
12266 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12268 mark_object (event
->x
);
12269 mark_object (event
->y
);
12271 mark_object (event
->frame_or_window
);
12272 mark_object (event
->arg
);