1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
36 #include "dispextern.h"
38 #include "intervals.h"
39 #include "blockinput.h"
48 #include <sys/ioctl.h>
50 #endif /* not MSDOS */
52 #include "syssignal.h"
55 /* This is to get the definitions of the XK_ symbols. */
62 #endif /* HAVE_NTGUI */
64 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
69 /* Variables for blockinput.h: */
71 /* Non-zero if interrupt input is blocked right now. */
72 int interrupt_input_blocked
;
74 /* Nonzero means an input interrupt has arrived
75 during the current critical section. */
76 int interrupt_input_pending
;
79 /* File descriptor to use for input. */
82 #ifdef HAVE_WINDOW_SYSTEM
83 /* Make all keyboard buffers much bigger when using X windows. */
84 #define KBD_BUFFER_SIZE 4096
85 #else /* No X-windows, character input */
86 #define KBD_BUFFER_SIZE 256
87 #endif /* No X-windows */
89 /* Following definition copied from eval.c */
93 struct backtrace
*next
;
94 Lisp_Object
*function
;
95 Lisp_Object
*args
; /* Points to vector of args. */
96 int nargs
; /* length of vector. If nargs is UNEVALLED,
97 args points to slot holding list of
103 KBOARD
*initial_kboard
;
104 KBOARD
*current_kboard
;
108 KBOARD the_only_kboard
;
111 /* Non-nil disable property on a command means
112 do not execute it; call disabled-command-hook's value instead. */
113 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
115 #define NUM_RECENT_KEYS (100)
116 int recent_keys_index
; /* Index for storing next element into recent_keys */
117 int total_keys
; /* Total number of elements stored into recent_keys */
118 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
120 /* Vector holding the key sequence that invoked the current command.
121 It is reused for each command, and it may be longer than the current
122 sequence; this_command_key_count indicates how many elements
123 actually mean something.
124 It's easier to staticpro a single Lisp_Object than an array. */
125 Lisp_Object this_command_keys
;
126 int this_command_key_count
;
128 /* Record values of this_command_key_count and echo_length ()
129 before this command was read. */
130 static int before_command_key_count
;
131 static int before_command_echo_length
;
132 /* Values of before_command_key_count and before_command_echo_length
133 saved by reset-this-command-lengths. */
134 static int before_command_key_count_1
;
135 static int before_command_echo_length_1
;
136 /* Flag set by reset-this-command-lengths,
137 saying to reset the lengths when add_command_key is called. */
138 static int before_command_restore_flag
;
140 extern int minbuf_level
;
142 extern struct backtrace
*backtrace_list
;
144 /* Nonzero means do menu prompting. */
145 static int menu_prompting
;
147 /* Character to see next line of menu prompt. */
148 static Lisp_Object menu_prompt_more_char
;
150 /* For longjmp to where kbd input is being done. */
151 static jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 int waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
159 /* True means we can start echoing at the next input pause
160 even though there is something in the echo area. */
161 static char *ok_to_echo_at_next_pause
;
163 /* Nonzero means disregard local maps for the menu bar. */
164 static int inhibit_local_menu_bar_menus
;
166 /* Nonzero means C-g should cause immediate error-signal. */
169 /* Character to recognize as the help char. */
170 Lisp_Object Vhelp_char
;
172 /* List of other event types to recognize as meaning "help". */
173 Lisp_Object Vhelp_event_list
;
175 /* Form to execute when help char is typed. */
176 Lisp_Object Vhelp_form
;
178 /* Command to run when the help character follows a prefix key. */
179 Lisp_Object Vprefix_help_command
;
181 /* List of items that should move to the end of the menu bar. */
182 Lisp_Object Vmenu_bar_final_items
;
184 /* Non-nil means show the equivalent key-binding for
185 any M-x command that has one.
186 The value can be a length of time to show the message for.
187 If the value is non-nil and not a number, we wait 2 seconds. */
188 Lisp_Object Vsuggest_key_bindings
;
190 /* Character that causes a quit. Normally C-g.
192 If we are running on an ordinary terminal, this must be an ordinary
193 ASCII char, since we want to make it our interrupt character.
195 If we are not running on an ordinary terminal, it still needs to be
196 an ordinary ASCII char. This character needs to be recognized in
197 the input interrupt handler. At this point, the keystroke is
198 represented as a struct input_event, while the desired quit
199 character is specified as a lispy event. The mapping from struct
200 input_events to lispy events cannot run in an interrupt handler,
201 and the reverse mapping is difficult for anything but ASCII
204 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
208 extern Lisp_Object current_global_map
;
209 extern int minibuf_level
;
211 /* If non-nil, this is a map that overrides all other local maps. */
212 Lisp_Object Voverriding_local_map
;
214 /* If non-nil, Voverriding_local_map applies to the menu bar. */
215 Lisp_Object Voverriding_local_map_menu_flag
;
217 /* Keymap that defines special misc events that should
218 be processed immediately at a low level. */
219 Lisp_Object Vspecial_event_map
;
221 /* Current depth in recursive edits. */
222 int command_loop_level
;
224 /* Total number of times command_loop has read a key sequence. */
227 /* Last input character read as a command. */
228 Lisp_Object last_command_char
;
230 /* Last input character read as a command, not counting menus
231 reached by the mouse. */
232 Lisp_Object last_nonmenu_event
;
234 /* Last input character read for any purpose. */
235 Lisp_Object last_input_char
;
237 /* If not Qnil, a list of objects to be read as subsequent command input. */
238 Lisp_Object Vunread_command_events
;
240 /* If not -1, an event to be read as subsequent command input. */
241 int unread_command_char
;
243 /* If not Qnil, this is a switch-frame event which we decided to put
244 off until the end of a key sequence. This should be read as the
245 next command input, after any unread_command_events.
247 read_key_sequence uses this to delay switch-frame events until the
248 end of the key sequence; Fread_char uses it to put off switch-frame
249 events until a non-ASCII event is acceptable as input. */
250 Lisp_Object unread_switch_frame
;
252 /* A mask of extra modifier bits to put into every keyboard char. */
253 int extra_keyboard_modifiers
;
255 /* Char to use as prefix when a meta character is typed in.
256 This is bound on entry to minibuffer in case ESC is changed there. */
258 Lisp_Object meta_prefix_char
;
260 /* Last size recorded for a current buffer which is not a minibuffer. */
261 static int last_non_minibuf_size
;
263 /* Number of idle seconds before an auto-save and garbage collection. */
264 static Lisp_Object Vauto_save_timeout
;
266 /* Total number of times read_char has returned. */
269 /* Total number of times read_char has returned, outside of macros. */
270 int num_nonmacro_input_chars
;
272 /* Auto-save automatically when this many characters have been typed
273 since the last time. */
275 static int auto_save_interval
;
277 /* Value of num_nonmacro_input_chars as of last auto save. */
281 /* The command being executed by the command loop.
282 Commands may set this, and the value set will be copied into
283 current_kboard->Vlast_command instead of the actual command. */
284 Lisp_Object this_command
;
286 /* The value of point when the last command was executed. */
287 int last_point_position
;
289 /* The buffer that was current when the last command was started. */
290 Lisp_Object last_point_position_buffer
;
293 /* The frame in which the last input event occurred, or Qmacro if the
294 last event came from a macro. We use this to determine when to
295 generate switch-frame events. This may be cleared by functions
296 like Fselect_frame, to make sure that a switch-frame event is
297 generated by the next character. */
298 Lisp_Object internal_last_event_frame
;
301 /* A user-visible version of the above, intended to allow users to
302 figure out where the last event came from, if the event doesn't
303 carry that information itself (i.e. if it was a character). */
304 Lisp_Object Vlast_event_frame
;
306 /* The timestamp of the last input event we received from the X server.
307 X Windows wants this for selection ownership. */
308 unsigned long last_event_timestamp
;
310 Lisp_Object Qself_insert_command
;
311 Lisp_Object Qforward_char
;
312 Lisp_Object Qbackward_char
;
313 Lisp_Object Qundefined
;
315 /* read_key_sequence stores here the command definition of the
316 key sequence that it reads. */
317 Lisp_Object read_key_sequence_cmd
;
319 /* Form to evaluate (if non-nil) when Emacs is started. */
320 Lisp_Object Vtop_level
;
322 /* User-supplied string to translate input characters through. */
323 Lisp_Object Vkeyboard_translate_table
;
325 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
326 extern Lisp_Object Vfunction_key_map
;
328 /* Another keymap that maps key sequences into key sequences.
329 This one takes precedence over ordinary definitions. */
330 extern Lisp_Object Vkey_translation_map
;
332 /* Non-nil means deactivate the mark at end of this command. */
333 Lisp_Object Vdeactivate_mark
;
335 /* Menu bar specified in Lucid Emacs fashion. */
337 Lisp_Object Vlucid_menu_bar_dirty_flag
;
338 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
340 /* Hooks to run before and after each command. */
341 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
342 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
343 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
344 /* Hook run after a command if there's no more input soon. */
345 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
347 /* Delay time in microseconds before running post-command-idle-hook. */
348 int post_command_idle_delay
;
350 /* List of deferred actions to be performed at a later time.
351 The precise format isn't relevant here; we just check whether it is nil. */
352 Lisp_Object Vdeferred_action_list
;
354 /* Function to call to handle deferred actions, when there are any. */
355 Lisp_Object Vdeferred_action_function
;
356 Lisp_Object Qdeferred_action_function
;
358 /* File in which we write all commands we read. */
361 /* Nonzero if input is available. */
364 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
365 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
369 extern char *pending_malloc_warning
;
371 /* Circular buffer for pre-read keyboard input. */
372 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
374 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
376 The interrupt-level event handlers will never enqueue an event on a
377 frame which is not in Vframe_list, and once an event is dequeued,
378 internal_last_event_frame or the event itself points to the frame.
381 But while the event is sitting in the queue, it's completely
382 unprotected. Suppose the user types one command which will run for
383 a while and then delete a frame, and then types another event at
384 the frame that will be deleted, before the command gets around to
385 it. Suppose there are no references to this frame elsewhere in
386 Emacs, and a GC occurs before the second event is dequeued. Now we
387 have an event referring to a freed frame, which will crash Emacs
390 Similar things happen when an event on a scroll bar is enqueued; the
391 window may be deleted while the event is in the queue.
393 So, we use this vector to protect the frame_or_window field in the
394 event queue. That way, they'll be dequeued as dead frames or
395 windows, but still valid lisp objects.
397 If kbd_buffer[i].kind != no_event, then
398 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
399 == kbd_buffer[i].frame_or_window. */
400 static Lisp_Object kbd_buffer_frame_or_window
;
402 /* Pointer to next available character in kbd_buffer.
403 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
404 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
405 next available char is in kbd_buffer[0]. */
406 static struct input_event
*kbd_fetch_ptr
;
408 /* Pointer to next place to store character in kbd_buffer. This
409 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
410 character should go in kbd_buffer[0]. */
411 static volatile struct input_event
*kbd_store_ptr
;
413 /* The above pair of variables forms a "queue empty" flag. When we
414 enqueue a non-hook event, we increment kbd_store_ptr. When we
415 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
416 there is input available iff the two pointers are not equal.
418 Why not just have a flag set and cleared by the enqueuing and
419 dequeuing functions? Such a flag could be screwed up by interrupts
420 at inopportune times. */
422 /* If this flag is non-nil, we check mouse_moved to see when the
423 mouse moves, and motion events will appear in the input stream.
424 Otherwise, mouse motion is ignored. */
425 static Lisp_Object do_mouse_tracking
;
427 /* Symbols to head events. */
428 Lisp_Object Qmouse_movement
;
429 Lisp_Object Qscroll_bar_movement
;
430 Lisp_Object Qswitch_frame
;
431 Lisp_Object Qdelete_frame
;
432 Lisp_Object Qiconify_frame
;
433 Lisp_Object Qmake_frame_visible
;
435 /* Symbols to denote kinds of events. */
436 Lisp_Object Qfunction_key
;
437 Lisp_Object Qmouse_click
;
438 Lisp_Object Qtimer_event
;
439 /* Lisp_Object Qmouse_movement; - also an event header */
441 /* Properties of event headers. */
442 Lisp_Object Qevent_kind
;
443 Lisp_Object Qevent_symbol_elements
;
445 Lisp_Object Qmenu_enable
;
447 /* An event header symbol HEAD may have a property named
448 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
449 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
450 mask of modifiers applied to it. If present, this is used to help
451 speed up parse_modifiers. */
452 Lisp_Object Qevent_symbol_element_mask
;
454 /* An unmodified event header BASE may have a property named
455 Qmodifier_cache, which is an alist mapping modifier masks onto
456 modified versions of BASE. If present, this helps speed up
458 Lisp_Object Qmodifier_cache
;
460 /* Symbols to use for parts of windows. */
461 Lisp_Object Qmode_line
;
462 Lisp_Object Qvertical_line
;
463 Lisp_Object Qvertical_scroll_bar
;
464 Lisp_Object Qmenu_bar
;
466 extern Lisp_Object Qmenu_enable
;
468 Lisp_Object
recursive_edit_unwind (), command_loop ();
469 Lisp_Object
Fthis_command_keys ();
470 Lisp_Object Qextended_command_history
;
471 EMACS_TIME
timer_check ();
473 extern char *x_get_keysym_name ();
475 Lisp_Object Qpolling_period
;
477 /* List of active timers. Appears in order of next scheduled event. */
478 Lisp_Object Vtimer_list
;
480 extern Lisp_Object Vprint_level
, Vprint_length
;
482 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
484 EMACS_TIME
*input_available_clear_time
;
486 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
487 Default is 1 if INTERRUPT_INPUT is defined. */
490 /* Nonzero while interrupts are temporarily deferred during redisplay. */
491 int interrupts_deferred
;
493 /* nonzero means use ^S/^Q for flow control. */
496 /* Allow m- file to inhibit use of FIONREAD. */
497 #ifdef BROKEN_FIONREAD
501 /* We are unable to use interrupts if FIONREAD is not available,
502 so flush SIGIO so we won't try. */
509 /* If we support a window system, turn on the code to poll periodically
510 to detect C-g. It isn't actually used when doing interrupt input. */
511 #ifdef HAVE_WINDOW_SYSTEM
512 #define POLL_FOR_INPUT
515 /* Non-nil enables Column Number mode. */
516 Lisp_Object Vcolumn_number_mode
;
518 /* Global variable declarations. */
520 /* Function for init_keyboard to call with no args (if nonzero). */
521 void (*keyboard_init_hook
) ();
523 static int read_avail_input ();
524 static void get_input_pending ();
525 static int readable_events ();
526 static Lisp_Object
read_char_x_menu_prompt ();
527 static Lisp_Object
read_char_minibuf_menu_prompt ();
528 static Lisp_Object
make_lispy_event ();
530 static Lisp_Object
make_lispy_movement ();
532 static Lisp_Object
modify_event_symbol ();
533 static Lisp_Object
make_lispy_switch_frame ();
534 static int parse_solitary_modifier ();
536 /* > 0 if we are to echo keystrokes. */
537 static int echo_keystrokes
;
539 /* Nonzero means don't try to suspend even if the operating system seems
541 static int cannot_suspend
;
543 #define min(a,b) ((a)<(b)?(a):(b))
544 #define max(a,b) ((a)>(b)?(a):(b))
546 /* Install the string STR as the beginning of the string of echoing,
547 so that it serves as a prompt for the next character.
548 Also start echoing. */
553 int len
= strlen (str
);
555 if (len
> ECHOBUFSIZE
- 4)
556 len
= ECHOBUFSIZE
- 4;
557 bcopy (str
, current_kboard
->echobuf
, len
);
558 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
559 *current_kboard
->echoptr
= '\0';
561 current_kboard
->echo_after_prompt
= len
;
566 /* Add C to the echo string, if echoing is going on.
567 C can be a character, which is printed prettily ("M-C-x" and all that
568 jazz), or a symbol, whose name is printed. */
573 extern char *push_key_description ();
575 if (current_kboard
->immediate_echo
)
577 char *ptr
= current_kboard
->echoptr
;
579 if (ptr
!= current_kboard
->echobuf
)
582 /* If someone has passed us a composite event, use its head symbol. */
587 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
590 ptr
= push_key_description (XINT (c
), ptr
);
592 else if (SYMBOLP (c
))
594 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
595 if ((ptr
- current_kboard
->echobuf
) + name
->size
+ 4 > ECHOBUFSIZE
)
597 bcopy (name
->data
, ptr
, name
->size
);
601 if (current_kboard
->echoptr
== current_kboard
->echobuf
604 strcpy (ptr
, " (Type ? for further options)");
609 current_kboard
->echoptr
= ptr
;
615 /* Temporarily add a dash to the end of the echo string if it's not
616 empty, so that it serves as a mini-prompt for the very next character. */
620 if (!current_kboard
->immediate_echo
621 && current_kboard
->echoptr
== current_kboard
->echobuf
)
623 /* Do nothing if we just printed a prompt. */
624 if (current_kboard
->echo_after_prompt
625 == current_kboard
->echoptr
- current_kboard
->echobuf
)
627 /* Do nothing if not echoing at all. */
628 if (current_kboard
->echoptr
== 0)
631 /* Put a dash at the end of the buffer temporarily,
632 but make it go away when the next character is added. */
633 current_kboard
->echoptr
[0] = '-';
634 current_kboard
->echoptr
[1] = 0;
639 /* Display the current echo string, and begin echoing if not already
644 if (!current_kboard
->immediate_echo
)
647 current_kboard
->immediate_echo
= 1;
649 for (i
= 0; i
< this_command_key_count
; i
++)
652 c
= XVECTOR (this_command_keys
)->contents
[i
];
653 if (! (EVENT_HAS_PARAMETERS (c
)
654 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
661 message1_nolog (current_kboard
->echobuf
);
664 if (waiting_for_input
&& !NILP (Vquit_flag
))
665 quit_throw_to_read_char ();
668 /* Turn off echoing, for the start of a new command. */
672 current_kboard
->immediate_echo
= 0;
673 current_kboard
->echoptr
= current_kboard
->echobuf
;
674 current_kboard
->echo_after_prompt
= -1;
675 ok_to_echo_at_next_pause
= 0;
678 /* Return the length of the current echo string. */
683 return current_kboard
->echoptr
- current_kboard
->echobuf
;
686 /* Truncate the current echo message to its first LEN chars.
687 This and echo_char get used by read_key_sequence when the user
688 switches frames while entering a key sequence. */
694 current_kboard
->echobuf
[len
] = '\0';
695 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
696 truncate_echo_area (len
);
700 /* Functions for manipulating this_command_keys. */
702 add_command_key (key
)
705 int size
= XVECTOR (this_command_keys
)->size
;
707 /* If reset-this-command-length was called recently, obey it now.
708 See the doc string of that function for an explanation of why. */
709 if (before_command_restore_flag
)
711 this_command_key_count
= before_command_key_count_1
;
712 echo_truncate (before_command_echo_length_1
);
713 before_command_restore_flag
= 0;
716 if (this_command_key_count
>= size
)
718 Lisp_Object new_keys
;
720 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
721 bcopy (XVECTOR (this_command_keys
)->contents
,
722 XVECTOR (new_keys
)->contents
,
723 size
* sizeof (Lisp_Object
));
725 this_command_keys
= new_keys
;
728 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
734 int count
= specpdl_ptr
- specpdl
;
737 if (command_loop_level
> 0)
739 specbind (Qstandard_output
, Qt
);
740 specbind (Qstandard_input
, Qt
);
743 val
= command_loop ();
745 Fsignal (Qquit
, Qnil
);
747 return unbind_to (count
, Qnil
);
750 /* When an auto-save happens, record the "time", and don't do again soon. */
754 last_auto_save
= num_nonmacro_input_chars
;
757 /* Make an auto save happen as soon as possible at command level. */
759 force_auto_save_soon ()
761 last_auto_save
= - auto_save_interval
- 1;
763 record_asynch_buffer_change ();
766 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
767 "Invoke the editor command loop recursively.\n\
768 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
769 that tells this function to return.\n\
770 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
771 This function is called by the editor initialization to begin editing.")
774 int count
= specpdl_ptr
- specpdl
;
777 command_loop_level
++;
778 update_mode_lines
= 1;
780 record_unwind_protect (recursive_edit_unwind
,
782 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
786 return unbind_to (count
, Qnil
);
790 recursive_edit_unwind (buffer
)
794 Fset_buffer (buffer
);
796 command_loop_level
--;
797 update_mode_lines
= 1;
805 #if 0 /* Theory: if there's anything in Vunread_command_events,
806 it will right away be read by read_key_sequence,
807 and then if we do switch KBOARDS, it will go into the side
808 queue then. So we don't need to do anything special here -- rms. */
809 if (CONSP (Vunread_command_events
))
811 current_kboard
->kbd_queue
812 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
813 current_kboard
->kbd_queue_has_data
= 1;
815 Vunread_command_events
= Qnil
;
821 /* Switch to the single-kboard state, making current_kboard
822 the only KBOARD from which further input is accepted. */
825 single_kboard_state ()
832 /* Maintain a stack of kboards, so other parts of Emacs
833 can switch temporarily to the kboard of a given frame
834 and then revert to the previous status. */
839 struct kboard_stack
*next
;
842 static struct kboard_stack
*kboard_stack
;
845 push_frame_kboard (f
)
849 struct kboard_stack
*p
850 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
852 p
->next
= kboard_stack
;
853 p
->kboard
= current_kboard
;
856 current_kboard
= FRAME_KBOARD (f
);
864 struct kboard_stack
*p
= kboard_stack
;
865 current_kboard
= p
->kboard
;
866 kboard_stack
= p
->next
;
871 /* Handle errors that are not handled at inner levels
872 by printing an error message and returning to the editor command loop. */
878 Lisp_Object old_level
, old_length
;
880 Vstandard_output
= Qt
;
881 Vstandard_input
= Qt
;
882 Vexecuting_macro
= Qnil
;
883 current_kboard
->Vprefix_arg
= Qnil
;
886 /* Avoid unquittable loop if data contains a circular list. */
887 old_level
= Vprint_level
;
888 old_length
= Vprint_length
;
889 XSETFASTINT (Vprint_level
, 10);
890 XSETFASTINT (Vprint_length
, 10);
891 cmd_error_internal (data
, NULL
);
892 Vprint_level
= old_level
;
893 Vprint_length
= old_length
;
897 Vinhibit_quit
= Qnil
;
902 return make_number (0);
905 cmd_error_internal (data
, context
)
913 echo_area_glyphs
= 0;
915 /* If the window system or terminal frame hasn't been initialized
916 yet, or we're not interactive, it's best to dump this message out
917 to stderr and exit. */
918 if (! FRAME_MESSAGE_BUF (selected_frame
)
920 stream
= Qexternal_debugging_output
;
929 write_string_1 (context
, -1, stream
);
931 print_error_message (data
, stream
);
933 /* If the window system or terminal frame hasn't been initialized
934 yet, or we're in -batch mode, this error should cause Emacs to exit. */
935 if (! FRAME_MESSAGE_BUF (selected_frame
)
939 Fkill_emacs (make_number (-1));
943 Lisp_Object
command_loop_1 ();
944 Lisp_Object
command_loop_2 ();
945 Lisp_Object
top_level_1 ();
947 /* Entry to editor-command-loop.
948 This level has the catches for exiting/returning to editor command loop.
949 It returns nil to exit recursive edit, t to abort it. */
954 if (command_loop_level
> 0 || minibuf_level
> 0)
956 return internal_catch (Qexit
, command_loop_2
, Qnil
);
961 internal_catch (Qtop_level
, top_level_1
, Qnil
);
962 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
964 /* End of file in -batch run causes exit here. */
970 /* Here we catch errors in execution of commands within the
971 editing loop, and reenter the editing loop.
972 When there is an error, cmd_error runs and returns a non-nil
973 value to us. A value of nil means that cmd_loop_1 itself
974 returned due to end of file (or end of kbd macro). */
979 register Lisp_Object val
;
982 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
991 return Feval (Vtop_level
);
997 /* On entry to the outer level, run the startup file */
998 if (!NILP (Vtop_level
))
999 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1000 else if (!NILP (Vpurify_flag
))
1001 message ("Bare impure Emacs (standard Lisp code not loaded)");
1003 message ("Bare Emacs (standard Lisp code not loaded)");
1007 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1008 "Exit all recursive editing levels.")
1011 Fthrow (Qtop_level
, Qnil
);
1014 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1015 "Exit from the innermost recursive edit or minibuffer.")
1018 if (command_loop_level
> 0 || minibuf_level
> 0)
1019 Fthrow (Qexit
, Qnil
);
1021 error ("No recursive edit is in progress");
1024 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1025 "Abort the command that requested this recursive edit or minibuffer input.")
1028 if (command_loop_level
> 0 || minibuf_level
> 0)
1031 error ("No recursive edit is in progress");
1034 /* This is the actual command reading loop,
1035 sans error-handling encapsulation. */
1037 Lisp_Object
Fcommand_execute ();
1038 static int read_key_sequence ();
1039 void safe_run_hooks ();
1044 Lisp_Object cmd
, tem
;
1047 Lisp_Object keybuf
[30];
1052 struct buffer
*prev_buffer
;
1054 int was_locked
= single_kboard
;
1057 current_kboard
->Vprefix_arg
= Qnil
;
1058 Vdeactivate_mark
= Qnil
;
1059 waiting_for_input
= 0;
1064 this_command_key_count
= 0;
1066 /* Make sure this hook runs after commands that get errors and
1067 throw to top level. */
1068 /* Note that the value cell will never directly contain nil
1069 if the symbol is a local variable. */
1070 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1071 safe_run_hooks (Qpost_command_hook
);
1073 if (!NILP (Vdeferred_action_list
))
1074 call0 (Vdeferred_action_function
);
1076 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1078 if (NILP (Vunread_command_events
)
1079 && NILP (Vexecuting_macro
)
1080 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1)))
1081 safe_run_hooks (Qpost_command_idle_hook
);
1084 /* Do this after running Vpost_command_hook, for consistency. */
1085 current_kboard
->Vlast_command
= this_command
;
1089 /* Make sure the current window's buffer is selected. */
1090 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1091 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1093 /* Display any malloc warning that just came out. Use while because
1094 displaying one warning can cause another. */
1096 while (pending_malloc_warning
)
1097 display_malloc_warning ();
1101 Vdeactivate_mark
= Qnil
;
1103 /* If minibuffer on and echo area in use,
1104 wait 2 sec and redraw minibuffer. */
1106 if (minibuf_level
&& echo_area_glyphs
1107 && EQ (minibuf_window
, echo_area_window
))
1109 /* Bind inhibit-quit to t so that C-g gets read in
1110 rather than quitting back to the minibuffer. */
1111 int count
= specpdl_ptr
- specpdl
;
1112 specbind (Qinhibit_quit
, Qt
);
1113 Fsit_for (make_number (2), Qnil
, Qnil
);
1114 unbind_to (count
, Qnil
);
1116 echo_area_glyphs
= 0;
1118 if (!NILP (Vquit_flag
))
1121 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1126 alloca (0); /* Cause a garbage collection now */
1127 /* Since we can free the most stuff here. */
1128 #endif /* C_ALLOCA */
1132 /* Select the frame that the last event came from. Usually,
1133 switch-frame events will take care of this, but if some lisp
1134 code swallows a switch-frame event, we'll fix things up here.
1135 Is this a good idea? */
1136 if (FRAMEP (internal_last_event_frame
)
1137 && XFRAME (internal_last_event_frame
) != selected_frame
)
1138 Fselect_frame (internal_last_event_frame
, Qnil
);
1141 /* If it has changed current-menubar from previous value,
1142 really recompute the menubar from the value. */
1143 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1144 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1145 call0 (Qrecompute_lucid_menubar
);
1147 before_command_key_count
= this_command_key_count
;
1148 before_command_echo_length
= echo_length ();
1150 this_command
= Qnil
;
1152 /* Read next key sequence; i gets its length. */
1153 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1158 /* Now we have read a key sequence of length I,
1159 or else I is 0 and we found end of file. */
1161 if (i
== 0) /* End of file -- happens only in */
1162 return Qnil
; /* a kbd macro, at the end. */
1163 /* -1 means read_key_sequence got a menu that was rejected.
1164 Just loop around and read another command. */
1168 this_command_key_count
= 0;
1172 last_command_char
= keybuf
[i
- 1];
1174 /* If the previous command tried to force a specific window-start,
1175 forget about that, in case this command moves point far away
1176 from that position. But also throw away beg_unchanged and
1177 end_unchanged information in that case, so that redisplay will
1178 update the whole window properly. */
1179 if (!NILP (XWINDOW (selected_window
)->force_start
))
1181 XWINDOW (selected_window
)->force_start
= Qnil
;
1182 beg_unchanged
= end_unchanged
= 0;
1185 cmd
= read_key_sequence_cmd
;
1186 if (!NILP (Vexecuting_macro
))
1188 if (!NILP (Vquit_flag
))
1190 Vexecuting_macro
= Qt
;
1191 QUIT
; /* Make some noise. */
1192 /* Will return since macro now empty. */
1196 /* Do redisplay processing after this command except in special
1197 cases identified below that set no_redisplay to 1.
1198 (actually, there's currently no way to prevent the redisplay,
1199 and no_redisplay is ignored.
1200 Perhaps someday we will really implement it.) */
1203 prev_buffer
= current_buffer
;
1204 prev_modiff
= MODIFF
;
1205 last_point_position
= PT
;
1206 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1208 /* Execute the command. */
1211 /* Note that the value cell will never directly contain nil
1212 if the symbol is a local variable. */
1213 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1214 safe_run_hooks (Qpre_command_hook
);
1216 if (NILP (this_command
))
1218 /* nil means key is undefined. */
1220 current_kboard
->defining_kbd_macro
= Qnil
;
1221 update_mode_lines
= 1;
1222 current_kboard
->Vprefix_arg
= Qnil
;
1226 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1228 /* Recognize some common commands in common situations and
1229 do them directly. */
1230 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1232 struct Lisp_Char_Table
*dp
1233 = window_display_table (XWINDOW (selected_window
));
1234 lose
= FETCH_CHAR (PT
);
1237 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1238 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1239 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1240 && (lose
>= 0x20 && lose
< 0x7f)))
1241 : (lose
>= 0x20 && lose
< 0x7f))
1242 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1244 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1246 && !windows_or_buffers_changed
1247 && EQ (current_buffer
->selective_display
, Qnil
)
1248 && !detect_input_pending ()
1249 && NILP (Vcolumn_number_mode
)
1250 && NILP (Vexecuting_macro
))
1251 no_redisplay
= direct_output_forward_char (1);
1254 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1256 struct Lisp_Char_Table
*dp
1257 = window_display_table (XWINDOW (selected_window
));
1259 lose
= FETCH_CHAR (PT
);
1261 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1262 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1263 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1264 && (lose
>= 0x20 && lose
< 0x7f)))
1265 : (lose
>= 0x20 && lose
< 0x7f))
1266 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1268 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1270 && !windows_or_buffers_changed
1271 && EQ (current_buffer
->selective_display
, Qnil
)
1272 && !detect_input_pending ()
1273 && NILP (Vcolumn_number_mode
)
1274 && NILP (Vexecuting_macro
))
1275 no_redisplay
= direct_output_forward_char (-1);
1278 else if (EQ (this_command
, Qself_insert_command
)
1279 /* Try this optimization only on ascii keystrokes. */
1280 && INTEGERP (last_command_char
))
1282 unsigned char c
= XINT (last_command_char
);
1285 if (NILP (Vexecuting_macro
)
1286 && !EQ (minibuf_window
, selected_window
))
1288 if (!nonundocount
|| nonundocount
>= 20)
1295 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1297 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1299 || MODIFF
<= SAVE_MODIFF
1300 || windows_or_buffers_changed
1301 || !EQ (current_buffer
->selective_display
, Qnil
)
1302 || detect_input_pending ()
1303 || !NILP (Vcolumn_number_mode
)
1304 || !NILP (Vexecuting_macro
));
1305 value
= internal_self_insert (c
, 0);
1312 && (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1314 struct Lisp_Char_Table
*dp
1315 = window_display_table (XWINDOW (selected_window
));
1322 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1325 /* Do it only for char codes
1326 that by default display as themselves. */
1327 if (lose
>= 0x20 && lose
<= 0x7e)
1328 no_redisplay
= direct_output_for_insert (lose
);
1330 else if (VECTORP (obj
)
1331 && XVECTOR (obj
)->size
== 1
1332 && (obj
= XVECTOR (obj
)->contents
[0],
1334 /* Insist face not specified in glyph. */
1335 && (XINT (obj
) & ((-1) << 8)) == 0)
1337 = direct_output_for_insert (XINT (obj
));
1341 if (lose
>= 0x20 && lose
<= 0x7e)
1342 no_redisplay
= direct_output_for_insert (lose
);
1349 /* Here for a command that isn't executed directly */
1352 if (NILP (current_kboard
->Vprefix_arg
))
1354 Fcommand_execute (this_command
, Qnil
, Qnil
);
1359 /* Note that the value cell will never directly contain nil
1360 if the symbol is a local variable. */
1361 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1362 safe_run_hooks (Qpost_command_hook
);
1364 if (!NILP (Vdeferred_action_list
))
1365 safe_run_hooks (Qdeferred_action_function
);
1367 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1369 if (NILP (Vunread_command_events
)
1370 && NILP (Vexecuting_macro
)
1371 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1)))
1372 safe_run_hooks (Qpost_command_idle_hook
);
1375 /* If there is a prefix argument,
1376 1) We don't want Vlast_command to be ``universal-argument''
1377 (that would be dumb), so don't set Vlast_command,
1378 2) we want to leave echoing on so that the prefix will be
1379 echoed as part of this key sequence, so don't call
1381 3) we want to leave this_command_key_count non-zero, so that
1382 read_char will realize that it is re-reading a character, and
1383 not echo it a second time.
1385 If the command didn't actually create a prefix arg,
1386 but is merely a frame event that is transparent to prefix args,
1387 then the above doesn't apply. */
1388 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1390 current_kboard
->Vlast_command
= this_command
;
1392 this_command_key_count
= 0;
1395 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1397 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1399 current_buffer
->mark_active
= Qnil
;
1400 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1402 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1403 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1407 /* Install chars successfully executed in kbd macro. */
1409 if (!NILP (current_kboard
->defining_kbd_macro
)
1410 && NILP (current_kboard
->Vprefix_arg
))
1411 finalize_kbd_macro_chars ();
1415 any_kboard_state ();
1420 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1423 safe_run_hooks_1 (hook
)
1426 return call1 (Vrun_hooks
, Vinhibit_quit
);
1429 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1432 safe_run_hooks_error (data
)
1435 Fset (Vinhibit_quit
, Qnil
);
1438 /* If we get an error while running the hook, cause the hook variable
1439 to be nil. Also inhibit quits, so that C-g won't cause the hook
1440 to mysteriously evaporate. */
1443 safe_run_hooks (hook
)
1447 int count
= specpdl_ptr
- specpdl
;
1448 specbind (Qinhibit_quit
, hook
);
1450 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1452 unbind_to (count
, Qnil
);
1455 /* Number of seconds between polling for input. */
1458 /* Nonzero means polling for input is temporarily suppressed. */
1459 int poll_suppress_count
;
1461 /* Nonzero if polling_for_input is actually being used. */
1462 int polling_for_input
;
1464 #ifdef POLL_FOR_INPUT
1466 /* Handle an alarm once each second and read pending input
1467 so as to handle a C-g if it comces in. */
1470 input_poll_signal (signalnum
) /* If we don't have an argument, */
1471 int signalnum
; /* some compilers complain in signal calls. */
1473 if (interrupt_input_blocked
== 0
1474 && !waiting_for_input
)
1475 read_avail_input (0);
1476 signal (SIGALRM
, input_poll_signal
);
1477 alarm (polling_period
);
1482 /* Begin signals to poll for input, if they are appropriate.
1483 This function is called unconditionally from various places. */
1487 #ifdef POLL_FOR_INPUT
1488 if (read_socket_hook
&& !interrupt_input
)
1490 poll_suppress_count
--;
1491 if (poll_suppress_count
== 0)
1493 signal (SIGALRM
, input_poll_signal
);
1494 polling_for_input
= 1;
1495 alarm (polling_period
);
1501 /* Nonzero if we are using polling to handle input asynchronously. */
1504 input_polling_used ()
1506 #ifdef POLL_FOR_INPUT
1507 return read_socket_hook
&& !interrupt_input
;
1513 /* Turn off polling. */
1517 #ifdef POLL_FOR_INPUT
1518 if (read_socket_hook
&& !interrupt_input
)
1520 if (poll_suppress_count
== 0)
1522 polling_for_input
= 0;
1525 poll_suppress_count
++;
1530 /* Set the value of poll_suppress_count to COUNT
1531 and start or stop polling accordingly. */
1534 set_poll_suppress_count (count
)
1537 #ifdef POLL_FOR_INPUT
1538 if (count
== 0 && poll_suppress_count
!= 0)
1540 poll_suppress_count
= 1;
1543 else if (count
!= 0 && poll_suppress_count
== 0)
1547 poll_suppress_count
= count
;
1551 /* Bind polling_period to a value at least N.
1552 But don't decrease it. */
1554 bind_polling_period (n
)
1557 #ifdef POLL_FOR_INPUT
1558 int new = polling_period
;
1564 specbind (Qpolling_period
, make_number (new));
1565 /* Start a new alarm with the new period. */
1570 /* Apply the control modifier to CHARACTER. */
1576 /* Save the upper bits here. */
1577 int upper
= c
& ~0177;
1581 /* Everything in the columns containing the upper-case letters
1582 denotes a control character. */
1583 if (c
>= 0100 && c
< 0140)
1587 /* Set the shift modifier for a control char
1588 made from a shifted letter. But only for letters! */
1589 if (oc
>= 'A' && oc
<= 'Z')
1590 c
|= shift_modifier
;
1593 /* The lower-case letters denote control characters too. */
1594 else if (c
>= 'a' && c
<= 'z')
1597 /* Include the bits for control and shift
1598 only if the basic ASCII code can't indicate them. */
1602 /* Replace the high bits. */
1603 c
|= (upper
& ~ctrl_modifier
);
1610 /* Input of single characters from keyboard */
1612 Lisp_Object
print_help ();
1613 static Lisp_Object
kbd_buffer_get_event ();
1614 static void record_char ();
1617 static jmp_buf wrong_kboard_jmpbuf
;
1620 /* read a character from the keyboard; call the redisplay if needed */
1621 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1622 -1 means do not do redisplay, but do do autosaving.
1625 /* The arguments MAPS and NMAPS are for menu prompting.
1626 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1628 PREV_EVENT is the previous input event, or nil if we are reading
1629 the first event of a key sequence.
1631 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1632 if we used a mouse menu to read the input, or zero otherwise. If
1633 USED_MOUSE_MENU is null, we don't dereference it.
1635 Value is t if we showed a menu and the user rejected it. */
1638 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1642 Lisp_Object prev_event
;
1643 int *used_mouse_menu
;
1645 register Lisp_Object c
;
1647 jmp_buf local_getcjmp
;
1649 int key_already_recorded
= 0;
1650 Lisp_Object tem
, save
;
1651 Lisp_Object also_record
;
1654 before_command_key_count
= this_command_key_count
;
1655 before_command_echo_length
= echo_length ();
1659 if (CONSP (Vunread_command_events
))
1661 c
= XCONS (Vunread_command_events
)->car
;
1662 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1664 /* Undo what read_char_x_menu_prompt did when it unread
1665 additional keys returned by Fx_popup_menu. */
1667 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1668 && NILP (XCONS (c
)->cdr
))
1671 if (this_command_key_count
== 0)
1677 if (unread_command_char
!= -1)
1679 XSETINT (c
, unread_command_char
);
1680 unread_command_char
= -1;
1682 if (this_command_key_count
== 0)
1688 /* If there is no function key translated before
1689 reset-this-command-lengths takes effect, forget about it. */
1690 before_command_restore_flag
= 0;
1692 if (!NILP (Vexecuting_macro
))
1695 /* We set this to Qmacro; since that's not a frame, nobody will
1696 try to switch frames on us, and the selected window will
1699 Since this event came from a macro, it would be misleading to
1700 leave internal_last_event_frame set to wherever the last
1701 real event came from. Normally, a switch-frame event selects
1702 internal_last_event_frame after each command is read, but
1703 events read from a macro should never cause a new frame to be
1705 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1708 /* Exit the macro if we are at the end.
1709 Also, some things replace the macro with t
1710 to force an early exit. */
1711 if (EQ (Vexecuting_macro
, Qt
)
1712 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1718 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1719 if (STRINGP (Vexecuting_macro
)
1720 && (XINT (c
) & 0x80))
1721 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1723 executing_macro_index
++;
1728 if (!NILP (unread_switch_frame
))
1730 c
= unread_switch_frame
;
1731 unread_switch_frame
= Qnil
;
1733 /* This event should make it into this_command_keys, and get echoed
1734 again, so we go to reread_first, rather than reread. */
1738 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1741 /* Message turns off echoing unless more keystrokes turn it on again. */
1742 if (echo_area_glyphs
&& *echo_area_glyphs
1743 && echo_area_glyphs
!= current_kboard
->echobuf
1744 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1747 /* If already echoing, continue. */
1750 /* Try reading a character via menu prompting in the minibuf.
1751 Try this before the sit-for, because the sit-for
1752 would do the wrong thing if we are supposed to do
1753 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1754 after a mouse event so don't try a minibuf menu. */
1756 if (nmaps
> 0 && INTERACTIVE
1757 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1758 /* Don't bring up a menu if we already have another event. */
1759 && NILP (Vunread_command_events
)
1760 && unread_command_char
< 0
1761 && !detect_input_pending ())
1763 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1766 key_already_recorded
= 1;
1771 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1772 We will do that below, temporarily for short sections of code,
1773 when appropriate. local_getcjmp must be in effect
1774 around any call to sit_for or kbd_buffer_get_event;
1775 it *must not* be in effect when we call redisplay. */
1777 if (_setjmp (local_getcjmp
))
1779 XSETINT (c
, quit_char
);
1781 XSETFRAME (internal_last_event_frame
, selected_frame
);
1782 Vlast_event_frame
= internal_last_event_frame
;
1784 /* If we report the quit char as an event,
1785 don't do so more than once. */
1786 if (!NILP (Vinhibit_quit
))
1791 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1792 if (kb
!= current_kboard
)
1794 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1795 /* We shouldn't get here if we were in single-kboard mode! */
1798 while (CONSP (*tailp
))
1799 tailp
= &XCONS (*tailp
)->cdr
;
1802 *tailp
= Fcons (c
, Qnil
);
1803 kb
->kbd_queue_has_data
= 1;
1804 current_kboard
= kb
;
1805 longjmp (wrong_kboard_jmpbuf
, 1);
1812 /* If in middle of key sequence and minibuffer not active,
1813 start echoing if enough time elapses. */
1815 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1816 && this_command_key_count
> 0
1818 && echo_keystrokes
> 0
1819 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1820 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1824 /* After a mouse event, start echoing right away.
1825 This is because we are probably about to display a menu,
1826 and we don't want to delay before doing so. */
1827 if (EVENT_HAS_PARAMETERS (prev_event
))
1831 save_getcjmp (save_jump
);
1832 restore_getcjmp (local_getcjmp
);
1833 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1834 restore_getcjmp (save_jump
);
1840 /* Maybe auto save due to number of keystrokes. */
1842 if (commandflag
!= 0
1843 && auto_save_interval
> 0
1844 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1845 && !detect_input_pending ())
1847 Fdo_auto_save (Qnil
, Qnil
);
1848 /* Hooks can actually change some buffers in auto save. */
1852 /* Try reading using an X menu.
1853 This is never confused with reading using the minibuf
1854 because the recursive call of read_char in read_char_minibuf_menu_prompt
1855 does not pass on any keymaps. */
1857 if (nmaps
> 0 && INTERACTIVE
1858 && !NILP (prev_event
)
1859 && EVENT_HAS_PARAMETERS (prev_event
)
1860 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1861 /* Don't bring up a menu if we already have another event. */
1862 && NILP (Vunread_command_events
)
1863 && unread_command_char
< 0)
1864 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1866 /* Maybe autosave and/or garbage collect due to idleness. */
1868 if (INTERACTIVE
&& NILP (c
))
1870 int delay_level
, buffer_size
;
1872 /* Slow down auto saves logarithmically in size of current buffer,
1873 and garbage collect while we're at it. */
1874 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1875 last_non_minibuf_size
= Z
- BEG
;
1876 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1878 while (buffer_size
> 64)
1879 delay_level
++, buffer_size
-= buffer_size
>> 2;
1880 if (delay_level
< 4) delay_level
= 4;
1881 /* delay_level is 4 for files under around 50k, 7 at 100k,
1882 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1884 /* Auto save if enough time goes by without input. */
1885 if (commandflag
!= 0
1886 && num_nonmacro_input_chars
> last_auto_save
1887 && INTEGERP (Vauto_save_timeout
)
1888 && XINT (Vauto_save_timeout
) > 0)
1891 EMACS_TIME timer_delay
;
1892 EMACS_TIME delay
, difference
;
1894 EMACS_SET_SECS (delay
,
1895 delay_level
* XFASTINT (Vauto_save_timeout
) / 4);
1896 EMACS_SET_USECS (delay
, 0);
1898 /* Don't wait longer than until the next timer will fire. */
1899 timer_delay
= timer_check (0);
1900 if (! EMACS_TIME_NEG_P (timer_delay
))
1902 EMACS_SUB_TIME (difference
, timer_delay
, delay
);
1903 if (EMACS_TIME_NEG_P (difference
))
1904 delay
= timer_delay
;
1907 save_getcjmp (save_jump
);
1908 restore_getcjmp (local_getcjmp
);
1909 tem0
= sit_for (EMACS_SECS (delay
), EMACS_USECS (delay
), 1, 1);
1910 restore_getcjmp (save_jump
);
1914 Fdo_auto_save (Qnil
, Qnil
);
1916 /* If we have auto-saved and there is still no input
1917 available, garbage collect if there has been enough
1918 consing going on to make it worthwhile. */
1919 if (!detect_input_pending ()
1920 && consing_since_gc
> gc_cons_threshold
/ 2)
1921 Fgarbage_collect ();
1928 /* Read something from current KBOARD's side queue, if possible. */
1932 if (current_kboard
->kbd_queue_has_data
)
1934 if (!CONSP (current_kboard
->kbd_queue
))
1936 c
= XCONS (current_kboard
->kbd_queue
)->car
;
1937 current_kboard
->kbd_queue
1938 = XCONS (current_kboard
->kbd_queue
)->cdr
;
1939 if (NILP (current_kboard
->kbd_queue
))
1940 current_kboard
->kbd_queue_has_data
= 0;
1941 input_pending
= readable_events ();
1943 if (EVENT_HAS_PARAMETERS (c
)
1944 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
1945 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
1946 Vlast_event_frame
= internal_last_event_frame
;
1952 /* If current_kboard's side queue is empty check the other kboards.
1953 If one of them has data that we have not yet seen here,
1954 switch to it and process the data waiting for it.
1956 Note: if the events queued up for another kboard
1957 have already been seen here, and therefore are not a complete command,
1958 the kbd_queue_has_data field is 0, so we skip that kboard here.
1959 That's to avoid an infinite loop switching between kboards here. */
1960 if (NILP (c
) && !single_kboard
)
1963 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
1964 if (kb
->kbd_queue_has_data
)
1966 current_kboard
= kb
;
1967 longjmp (wrong_kboard_jmpbuf
, 1);
1976 /* Finally, we read from the main queue,
1977 and if that gives us something we can't use yet, we put it on the
1978 appropriate side queue and try again. */
1984 /* Actually read a character, waiting if necessary. */
1985 save_getcjmp (save_jump
);
1986 restore_getcjmp (local_getcjmp
);
1987 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
1988 restore_getcjmp (save_jump
);
1991 if (! NILP (c
) && (kb
!= current_kboard
))
1993 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1994 while (CONSP (*tailp
))
1995 tailp
= &XCONS (*tailp
)->cdr
;
1998 *tailp
= Fcons (c
, Qnil
);
1999 kb
->kbd_queue_has_data
= 1;
2003 current_kboard
= kb
;
2004 longjmp (wrong_kboard_jmpbuf
, 1);
2009 /* Terminate Emacs in batch mode if at eof. */
2010 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2011 Fkill_emacs (make_number (1));
2015 /* Add in any extra modifiers, where appropriate. */
2016 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2017 || ((extra_keyboard_modifiers
& 0177) < ' '
2018 && (extra_keyboard_modifiers
& 0177) != 0))
2019 XSETINT (c
, make_ctrl_char (XINT (c
)));
2021 /* Transfer any other modifier bits directly from
2022 extra_keyboard_modifiers to c. Ignore the actual character code
2023 in the low 16 bits of extra_keyboard_modifiers. */
2024 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2033 if (commandflag
>= 0
2034 && !input_pending
&& !detect_input_pending ())
2042 /* Buffer switch events are only for internal wakeups
2043 so don't show them to the user. */
2047 if (key_already_recorded
)
2050 /* Process special events within read_char
2051 and loop around to read another event. */
2054 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2060 int was_locked
= single_kboard
;
2062 last_input_char
= c
;
2063 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
));
2065 /* Resume allowing input from any kboard, if that was true before. */
2067 any_kboard_state ();
2072 /* Wipe the echo area. */
2073 echo_area_glyphs
= 0;
2075 /* Handle things that only apply to characters. */
2078 /* If kbd_buffer_get_event gave us an EOF, return that. */
2082 if (STRINGP (Vkeyboard_translate_table
)
2083 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
2084 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2085 else if ((VECTORP (Vkeyboard_translate_table
)
2086 && XVECTOR (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
2087 || CHAR_TABLE_P (Vkeyboard_translate_table
))
2090 d
= Faref (Vkeyboard_translate_table
, c
);
2091 /* nil in keyboard-translate-table means no translation. */
2097 /* If this event is a mouse click in the menu bar,
2098 return just menu-bar for now. Modify the mouse click event
2099 so we won't do this twice, then queue it up. */
2100 if (EVENT_HAS_PARAMETERS (c
)
2101 && CONSP (XCONS (c
)->cdr
)
2102 && CONSP (EVENT_START (c
))
2103 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2107 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2108 /* Handle menu-bar events:
2109 insert the dummy prefix event `menu-bar'. */
2110 if (EQ (posn
, Qmenu_bar
))
2112 /* Change menu-bar to (menu-bar) as the event "position". */
2113 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2116 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2122 if (! NILP (also_record
))
2123 record_char (also_record
);
2127 before_command_key_count
= this_command_key_count
;
2128 before_command_echo_length
= echo_length ();
2130 /* Don't echo mouse motion events. */
2132 && ! (EVENT_HAS_PARAMETERS (c
)
2133 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2136 if (! NILP (also_record
))
2137 echo_char (also_record
);
2138 /* Once we reread a character, echoing can happen
2139 the next time we pause to read a new one. */
2140 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2143 /* Record this character as part of the current key. */
2144 add_command_key (c
);
2145 if (! NILP (also_record
))
2146 add_command_key (also_record
);
2148 /* Re-reading in the middle of a command */
2150 last_input_char
= c
;
2153 /* Process the help character specially if enabled */
2154 if (!NILP (Vhelp_form
) && help_char_p (c
))
2157 count
= specpdl_ptr
- specpdl
;
2159 record_unwind_protect (Fset_window_configuration
,
2160 Fcurrent_window_configuration (Qnil
));
2162 tem0
= Feval (Vhelp_form
);
2164 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2168 c
= read_char (0, 0, 0, Qnil
, 0);
2169 while (BUFFERP (c
));
2170 /* Remove the help from the frame */
2171 unbind_to (count
, Qnil
);
2174 if (EQ (c
, make_number (040)))
2178 c
= read_char (0, 0, 0, Qnil
, 0);
2179 while (BUFFERP (c
));
2186 /* Return 1 if should recognize C as "the help character". */
2194 if (EQ (c
, Vhelp_char
))
2196 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2197 if (EQ (c
, XCONS (tail
)->car
))
2202 /* Record the input event C in various ways. */
2209 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2210 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2211 recent_keys_index
= 0;
2213 /* Write c to the dribble file. If c is a lispy event, write
2214 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2215 If you, dear reader, have a better idea, you've got the source. :-) */
2220 if (XUINT (c
) < 0x100)
2221 putc (XINT (c
), dribble
);
2223 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2227 Lisp_Object dribblee
;
2229 /* If it's a structured event, take the event header. */
2230 dribblee
= EVENT_HEAD (c
);
2232 if (SYMBOLP (dribblee
))
2234 putc ('<', dribble
);
2235 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2236 XSYMBOL (dribblee
)->name
->size
,
2238 putc ('>', dribble
);
2245 store_kbd_macro_char (c
);
2247 num_nonmacro_input_chars
++;
2254 struct buffer
*old
= current_buffer
;
2255 Fprinc (object
, Qnil
);
2256 set_buffer_internal (XBUFFER (Vstandard_output
));
2257 call0 (intern ("help-mode"));
2258 set_buffer_internal (old
);
2262 /* Copy out or in the info on where C-g should throw to.
2263 This is used when running Lisp code from within get_char,
2264 in case get_char is called recursively.
2265 See read_process_output. */
2270 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2273 restore_getcjmp (temp
)
2276 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2281 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2282 of this function. */
2285 tracking_off (old_value
)
2286 Lisp_Object old_value
;
2288 do_mouse_tracking
= old_value
;
2289 if (NILP (old_value
))
2291 /* Redisplay may have been preempted because there was input
2292 available, and it assumes it will be called again after the
2293 input has been processed. If the only input available was
2294 the sort that we have just disabled, then we need to call
2296 if (!readable_events ())
2298 redisplay_preserve_echo_area ();
2299 get_input_pending (&input_pending
);
2304 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2305 "Evaluate BODY with mouse movement events enabled.\n\
2306 Within a `track-mouse' form, mouse motion generates input events that\n\
2307 you can read with `read-event'.\n\
2308 Normally, mouse motion is ignored.")
2312 int count
= specpdl_ptr
- specpdl
;
2315 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2317 do_mouse_tracking
= Qt
;
2319 val
= Fprogn (args
);
2320 return unbind_to (count
, val
);
2323 /* If mouse has moved on some frame, return one of those frames.
2324 Return 0 otherwise. */
2329 Lisp_Object tail
, frame
;
2331 FOR_EACH_FRAME (tail
, frame
)
2333 if (XFRAME (frame
)->mouse_moved
)
2334 return XFRAME (frame
);
2340 #endif /* HAVE_MOUSE */
2342 /* Low level keyboard/mouse input.
2343 kbd_buffer_store_event places events in kbd_buffer, and
2344 kbd_buffer_get_event retrieves them. */
2346 /* Return true iff there are any events in the queue that read-char
2347 would return. If this returns false, a read-char would block. */
2352 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2355 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2360 if (current_kboard
->kbd_queue_has_data
)
2366 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2367 if (kb
->kbd_queue_has_data
)
2373 /* Set this for debugging, to have a way to get out */
2378 event_to_kboard (event
)
2379 struct input_event
*event
;
2382 frame
= event
->frame_or_window
;
2384 frame
= XCONS (frame
)->car
;
2385 else if (WINDOWP (frame
))
2386 frame
= WINDOW_FRAME (XWINDOW (frame
));
2388 /* There are still some events that don't set this field.
2389 For now, just ignore the problem.
2390 Also ignore dead frames here. */
2391 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2394 return FRAME_KBOARD (XFRAME (frame
));
2398 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2401 kbd_buffer_store_event (event
)
2402 register struct input_event
*event
;
2404 if (event
->kind
== no_event
)
2407 if (event
->kind
== ascii_keystroke
)
2409 register int c
= event
->code
& 0377;
2411 if (event
->modifiers
& ctrl_modifier
)
2412 c
= make_ctrl_char (c
);
2414 c
|= (event
->modifiers
2415 & (meta_modifier
| alt_modifier
2416 | hyper_modifier
| super_modifier
));
2420 extern SIGTYPE
interrupt_signal ();
2423 struct input_event
*sp
;
2426 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2427 kb
!= current_kboard
))
2430 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2431 Fcons (make_number (c
), Qnil
));
2432 kb
->kbd_queue_has_data
= 1;
2433 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2435 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2438 if (event_to_kboard (sp
) == kb
)
2440 sp
->kind
= no_event
;
2441 sp
->frame_or_window
= Qnil
;
2449 /* If this results in a quit_char being returned to Emacs as
2450 input, set Vlast_event_frame properly. If this doesn't
2451 get returned to Emacs as an event, the next event read
2452 will set Vlast_event_frame again, so this is safe to do. */
2456 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2458 focus
= event
->frame_or_window
;
2459 internal_last_event_frame
= focus
;
2460 Vlast_event_frame
= focus
;
2464 last_event_timestamp
= event
->timestamp
;
2465 interrupt_signal ();
2469 if (c
&& c
== stop_character
)
2475 /* Don't insert two buffer_switch_event's in a row.
2476 Just ignore the second one. */
2477 else if (event
->kind
== buffer_switch_event
2478 && kbd_fetch_ptr
!= kbd_store_ptr
2479 && kbd_store_ptr
->kind
== buffer_switch_event
)
2482 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2483 kbd_store_ptr
= kbd_buffer
;
2485 /* Don't let the very last slot in the buffer become full,
2486 since that would make the two pointers equal,
2487 and that is indistinguishable from an empty buffer.
2488 Discard the event if it would fill the last slot. */
2489 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2491 volatile struct input_event
*sp
= kbd_store_ptr
;
2492 sp
->kind
= event
->kind
;
2493 if (event
->kind
== selection_request_event
)
2495 /* We must not use the ordinary copying code for this case,
2496 since `part' is an enum and copying it might not copy enough
2498 bcopy (event
, (char *) sp
, sizeof (*event
));
2502 sp
->code
= event
->code
;
2503 sp
->part
= event
->part
;
2504 sp
->frame_or_window
= event
->frame_or_window
;
2505 sp
->modifiers
= event
->modifiers
;
2508 sp
->timestamp
= event
->timestamp
;
2510 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2512 = event
->frame_or_window
);
2518 /* Read one event from the event buffer, waiting if necessary.
2519 The value is a Lisp object representing the event.
2520 The value is nil for an event that should be ignored,
2521 or that was handled here.
2522 We always read and discard one event. */
2525 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2527 int *used_mouse_menu
;
2531 EMACS_TIME next_timer_delay
;
2537 *kbp
= current_kboard
;
2541 /* Wait until there is input available. */
2544 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2547 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2551 /* Check when the next timer fires. */
2552 next_timer_delay
= timer_check (0);
2553 if (EMACS_SECS (next_timer_delay
) == 0
2554 && EMACS_USECS (next_timer_delay
) == 0)
2556 if (EMACS_TIME_NEG_P (next_timer_delay
))
2558 EMACS_SET_SECS (next_timer_delay
, 0);
2559 EMACS_SET_USECS (next_timer_delay
, 0);
2562 /* If the quit flag is set, then read_char will return
2563 quit_char, so that counts as "available input." */
2564 if (!NILP (Vquit_flag
))
2565 quit_throw_to_read_char ();
2567 /* One way or another, wait until input is available; then, if
2568 interrupt handlers have not read it, read it now. */
2571 wait_for_kbd_input ();
2573 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2577 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2580 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2584 Lisp_Object minus_one
;
2586 XSETINT (minus_one
, -1);
2587 wait_reading_process_input (EMACS_SECS (next_timer_delay
),
2588 EMACS_USECS (next_timer_delay
),
2591 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2592 /* Pass 1 for EXPECT since we just waited to have input. */
2593 read_avail_input (1);
2595 #endif /* not VMS */
2598 /* At this point, we know that there is a readable event available
2599 somewhere. If the event queue is empty, then there must be a
2600 mouse movement enabled and available. */
2601 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2603 struct input_event
*event
;
2605 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2609 last_event_timestamp
= event
->timestamp
;
2612 *kbp
= event_to_kboard (event
);
2614 *kbp
= current_kboard
; /* Better than returning null ptr? */
2616 *kbp
= &the_only_kboard
;
2621 /* These two kinds of events get special handling
2622 and don't actually appear to the command loop.
2623 We return nil for them. */
2624 if (event
->kind
== selection_request_event
)
2627 struct input_event copy
;
2629 /* Remove it from the buffer before processing it,
2630 since otherwise swallow_events will see it
2631 and process it again. */
2633 kbd_fetch_ptr
= event
+ 1;
2634 input_pending
= readable_events ();
2635 x_handle_selection_request (©
);
2637 /* We're getting selection request events, but we don't have
2643 else if (event
->kind
== selection_clear_event
)
2646 struct input_event copy
;
2648 /* Remove it from the buffer before processing it. */
2650 kbd_fetch_ptr
= event
+ 1;
2651 input_pending
= readable_events ();
2652 x_handle_selection_clear (©
);
2654 /* We're getting selection request events, but we don't have
2659 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2660 else if (event
->kind
== delete_window_event
)
2662 /* Make an event (delete-frame (FRAME)). */
2663 obj
= Fcons (event
->frame_or_window
, Qnil
);
2664 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2665 kbd_fetch_ptr
= event
+ 1;
2667 else if (event
->kind
== iconify_event
)
2669 /* Make an event (iconify-frame (FRAME)). */
2670 obj
= Fcons (event
->frame_or_window
, Qnil
);
2671 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2672 kbd_fetch_ptr
= event
+ 1;
2674 else if (event
->kind
== deiconify_event
)
2676 /* Make an event (make-frame-visible (FRAME)). */
2677 obj
= Fcons (event
->frame_or_window
, Qnil
);
2678 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2679 kbd_fetch_ptr
= event
+ 1;
2682 else if (event
->kind
== buffer_switch_event
)
2684 /* The value doesn't matter here; only the type is tested. */
2685 XSETBUFFER (obj
, current_buffer
);
2686 kbd_fetch_ptr
= event
+ 1;
2688 #ifdef USE_X_TOOLKIT
2689 else if (event
->kind
== menu_bar_activate_event
)
2691 kbd_fetch_ptr
= event
+ 1;
2692 input_pending
= readable_events ();
2693 x_activate_menubar (XFRAME (event
->frame_or_window
));
2696 /* Just discard these, by returning nil.
2697 With MULTI_KBOARD, these events are used as placeholders
2698 when we need to randomly delete events from the queue.
2699 (They shouldn't otherwise be found in the buffer,
2700 but on some machines it appears they do show up
2701 even without MULTI_KBOARD.) */
2702 else if (event
->kind
== no_event
)
2703 kbd_fetch_ptr
= event
+ 1;
2705 /* If this event is on a different frame, return a switch-frame this
2706 time, and leave the event in the queue for next time. */
2713 frame
= event
->frame_or_window
;
2715 frame
= XCONS (frame
)->car
;
2716 else if (WINDOWP (frame
))
2717 frame
= WINDOW_FRAME (XWINDOW (frame
));
2719 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2723 if (! EQ (frame
, internal_last_event_frame
)
2724 && XFRAME (frame
) != selected_frame
)
2725 obj
= make_lispy_switch_frame (frame
);
2726 internal_last_event_frame
= frame
;
2727 #endif /* MULTI_FRAME */
2729 /* If we didn't decide to make a switch-frame event, go ahead
2730 and build a real event from the queue entry. */
2734 obj
= make_lispy_event (event
);
2735 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2736 /* If this was a menu selection, then set the flag to inhibit
2737 writing to last_nonmenu_event. Don't do this if the event
2738 we're returning is (menu-bar), though; that indicates the
2739 beginning of the menu sequence, and we might as well leave
2740 that as the `event with parameters' for this selection. */
2741 if (event
->kind
== menu_bar_event
2742 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2744 *used_mouse_menu
= 1;
2747 /* Wipe out this event, to catch bugs. */
2748 event
->kind
= no_event
;
2749 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2751 kbd_fetch_ptr
= event
+ 1;
2756 /* Try generating a mouse motion event. */
2757 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2759 FRAME_PTR f
= some_mouse_moved ();
2760 Lisp_Object bar_window
;
2761 enum scroll_bar_part part
;
2765 *kbp
= current_kboard
;
2766 /* Note that this uses F to determine which display to look at.
2767 If there is no valid info, it does not store anything
2768 so x remains nil. */
2770 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2775 /* Decide if we should generate a switch-frame event. Don't
2776 generate switch-frame events for motion outside of all Emacs
2782 frame
= FRAME_FOCUS_FRAME (f
);
2784 XSETFRAME (frame
, f
);
2786 if (! EQ (frame
, internal_last_event_frame
)
2787 && XFRAME (frame
) != selected_frame
)
2788 obj
= make_lispy_switch_frame (frame
);
2789 internal_last_event_frame
= frame
;
2793 /* If we didn't decide to make a switch-frame event, go ahead and
2794 return a mouse-motion event. */
2795 if (!NILP (x
) && NILP (obj
))
2796 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2798 #endif /* HAVE_MOUSE */
2800 /* We were promised by the above while loop that there was
2801 something for us to read! */
2804 input_pending
= readable_events ();
2807 Vlast_event_frame
= internal_last_event_frame
;
2813 /* Process any events that are not user-visible,
2814 then return, without reading any user-visible events. */
2819 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2821 struct input_event
*event
;
2823 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2827 last_event_timestamp
= event
->timestamp
;
2829 /* These two kinds of events get special handling
2830 and don't actually appear to the command loop. */
2831 if (event
->kind
== selection_request_event
)
2834 struct input_event copy
;
2836 /* Remove it from the buffer before processing it,
2837 since otherwise swallow_events called recursively could see it
2838 and process it again. */
2840 kbd_fetch_ptr
= event
+ 1;
2841 input_pending
= readable_events ();
2842 x_handle_selection_request (©
);
2844 /* We're getting selection request events, but we don't have
2850 else if (event
->kind
== selection_clear_event
)
2853 struct input_event copy
;
2855 /* Remove it from the buffer before processing it, */
2858 kbd_fetch_ptr
= event
+ 1;
2859 input_pending
= readable_events ();
2860 x_handle_selection_clear (©
);
2862 /* We're getting selection request events, but we don't have
2871 get_input_pending (&input_pending
);
2874 /* Check whether a timer has fired. To prevent larger problems we simply
2875 disregard elements that are not proper timers. Do not make a circular
2876 timer list for the time being.
2878 Returns the number of seconds to wait until the next timer fires. If a
2879 timer is triggering now, return zero seconds.
2880 If no timer is active, return -1 seconds.
2882 If a timer is triggering now, either queue a timer-event
2883 or run the timer's handler function if DO_IT_NOW is nonzero. */
2886 timer_check (do_it_now
)
2889 EMACS_TIME nexttime
;
2891 Lisp_Object timers
, timer
;
2892 /* Nonzero if we generate some events. */
2893 int events_generated
= 0;
2894 struct gcpro gcpro1
, gcpro2
;
2896 EMACS_SET_SECS (nexttime
, -1);
2897 EMACS_SET_USECS (nexttime
, -1);
2899 timers
= Vtimer_list
;
2901 GCPRO2 (timers
, timer
);
2904 EMACS_GET_TIME (now
);
2906 while (CONSP (timers
))
2909 Lisp_Object
*vector
;
2910 EMACS_TIME timer_time
;
2911 EMACS_TIME difference
;
2913 timer
= XCONS (timers
)->car
;
2914 timers
= XCONS (timers
)->cdr
;
2916 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 7)
2918 vector
= XVECTOR (timer
)->contents
;
2920 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
2921 || !INTEGERP (vector
[3]))
2924 EMACS_SET_SECS (timer_time
,
2925 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
2926 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
2927 EMACS_SUB_TIME (difference
, timer_time
, now
);
2928 /* If event is past, run it if it hasn't been run. */
2929 if (EMACS_TIME_NEG_P (difference
))
2931 if (NILP (vector
[0]))
2933 /* Mark the timer as triggered to prevent problems if the lisp
2934 code fails to reschedule it right. */
2937 /* Run the timer or queue a timer event. */
2940 Lisp_Object tem
, event
;
2941 int was_locked
= single_kboard
;
2943 tem
= get_keymap_1 (Vspecial_event_map
, 0, 0);
2944 tem
= get_keyelt (access_keymap (tem
, Qtimer_event
, 0, 0),
2946 event
= Fcons (Qtimer_event
, Fcons (timer
, Qnil
));
2947 Fcommand_execute (tem
, Qnil
, Fvector (1, &event
));
2949 /* Resume allowing input from any kboard, if that was true before. */
2951 any_kboard_state ();
2953 /* Since we have handled the event,
2954 we don't need to tell the caller to wake up and do it. */
2958 /* Generate a timer event so the caller will handle it. */
2959 struct input_event event
;
2961 event
.kind
= timer_event
;
2962 event
.modifiers
= 0;
2963 event
.x
= event
.y
= Qnil
;
2964 event
.timestamp
= triggertime
;
2965 /* Store the timer in the frame slot. */
2966 event
.frame_or_window
= Fcons (Fselected_frame (), timer
);
2967 kbd_buffer_store_event (&event
);
2969 /* Tell caller to handle this event right away. */
2970 events_generated
= 1;
2971 EMACS_SET_SECS (nexttime
, 0);
2972 EMACS_SET_USECS (nexttime
, 0);
2977 /* When we encounter a timer that is still waiting,
2978 return the amount of time to wait before it is ripe. */
2981 /* But if we generated an event,
2982 tell the caller to handle it now. */
2983 if (events_generated
)
2988 /* No timers are pending in the future. */
2989 /* Return 0 if we generated an event, and -1 if not. */
2994 /* Caches for modify_event_symbol. */
2995 static Lisp_Object accent_key_syms
;
2996 static Lisp_Object func_key_syms
;
2997 static Lisp_Object mouse_syms
;
2999 /* This is a list of keysym codes for special "accent" characters.
3000 It parallels lispy_accent_keys. */
3002 static int lispy_accent_codes
[] =
3004 #ifdef XK_dead_circumflex
3009 #ifdef XK_dead_grave
3014 #ifdef XK_dead_tilde
3019 #ifdef XK_dead_diaeresis
3024 #ifdef XK_dead_macron
3029 #ifdef XK_dead_degree
3034 #ifdef XK_dead_acute
3039 #ifdef XK_dead_cedilla
3044 #ifdef XK_dead_breve
3049 #ifdef XK_dead_ogonek
3054 #ifdef XK_dead_caron
3059 #ifdef XK_dead_doubleacute
3060 XK_dead_doubleacute
,
3064 #ifdef XK_dead_abovedot
3071 /* This is a list of Lisp names for special "accent" characters.
3072 It parallels lispy_accent_codes. */
3074 static char *lispy_accent_keys
[] =
3092 #define FUNCTION_KEY_OFFSET 0x0
3094 char *lispy_function_keys
[] =
3098 0, /* VK_LBUTTON 0x01 */
3099 0, /* VK_RBUTTON 0x02 */
3100 "cancel", /* VK_CANCEL 0x03 */
3101 0, /* VK_MBUTTON 0x04 */
3103 0, 0, 0, /* 0x05 .. 0x07 */
3105 "backspace", /* VK_BACK 0x08 */
3106 "tab", /* VK_TAB 0x09 */
3108 0, 0, /* 0x0A .. 0x0B */
3110 "clear", /* VK_CLEAR 0x0C */
3111 "return", /* VK_RETURN 0x0D */
3113 0, 0, /* 0x0E .. 0x0F */
3115 "shift", /* VK_SHIFT 0x10 */
3116 "control", /* VK_CONTROL 0x11 */
3117 "menu", /* VK_MENU 0x12 */
3118 "pause", /* VK_PAUSE 0x13 */
3119 "capital", /* VK_CAPITAL 0x14 */
3121 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3123 0, /* VK_ESCAPE 0x1B */
3125 0, 0, 0, 0, /* 0x1C .. 0x1F */
3127 0, /* VK_SPACE 0x20 */
3128 "prior", /* VK_PRIOR 0x21 */
3129 "next", /* VK_NEXT 0x22 */
3130 "end", /* VK_END 0x23 */
3131 "home", /* VK_HOME 0x24 */
3132 "left", /* VK_LEFT 0x25 */
3133 "up", /* VK_UP 0x26 */
3134 "right", /* VK_RIGHT 0x27 */
3135 "down", /* VK_DOWN 0x28 */
3136 "select", /* VK_SELECT 0x29 */
3137 "print", /* VK_PRINT 0x2A */
3138 "execute", /* VK_EXECUTE 0x2B */
3139 "snapshot", /* VK_SNAPSHOT 0x2C */
3140 "insert", /* VK_INSERT 0x2D */
3141 "delete", /* VK_DELETE 0x2E */
3142 "help", /* VK_HELP 0x2F */
3144 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3146 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3148 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3150 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3152 0, 0, 0, 0, 0, 0, 0, 0, 0,
3153 0, 0, 0, 0, 0, 0, 0, 0, 0,
3154 0, 0, 0, 0, 0, 0, 0, 0,
3156 "lwindow", /* VK_LWIN 0x5B */
3157 "rwindow", /* VK_RWIN 0x5C */
3158 "apps", /* VK_APPS 0x5D */
3160 0, 0, /* 0x5E .. 0x5F */
3162 "kp-0", /* VK_NUMPAD0 0x60 */
3163 "kp-1", /* VK_NUMPAD1 0x61 */
3164 "kp-2", /* VK_NUMPAD2 0x62 */
3165 "kp-3", /* VK_NUMPAD3 0x63 */
3166 "kp-4", /* VK_NUMPAD4 0x64 */
3167 "kp-5", /* VK_NUMPAD5 0x65 */
3168 "kp-6", /* VK_NUMPAD6 0x66 */
3169 "kp-7", /* VK_NUMPAD7 0x67 */
3170 "kp-8", /* VK_NUMPAD8 0x68 */
3171 "kp-9", /* VK_NUMPAD9 0x69 */
3172 "kp-multiply", /* VK_MULTIPLY 0x6A */
3173 "kp-add", /* VK_ADD 0x6B */
3174 "kp-separator", /* VK_SEPARATOR 0x6C */
3175 "kp-subtract", /* VK_SUBTRACT 0x6D */
3176 "kp-decimal", /* VK_DECIMAL 0x6E */
3177 "kp-divide", /* VK_DIVIDE 0x6F */
3178 "f1", /* VK_F1 0x70 */
3179 "f2", /* VK_F2 0x71 */
3180 "f3", /* VK_F3 0x72 */
3181 "f4", /* VK_F4 0x73 */
3182 "f5", /* VK_F5 0x74 */
3183 "f6", /* VK_F6 0x75 */
3184 "f7", /* VK_F7 0x76 */
3185 "f8", /* VK_F8 0x77 */
3186 "f9", /* VK_F9 0x78 */
3187 "f10", /* VK_F10 0x79 */
3188 "f11", /* VK_F11 0x7A */
3189 "f12", /* VK_F12 0x7B */
3190 "f13", /* VK_F13 0x7C */
3191 "f14", /* VK_F14 0x7D */
3192 "f15", /* VK_F15 0x7E */
3193 "f16", /* VK_F16 0x7F */
3194 "f17", /* VK_F17 0x80 */
3195 "f18", /* VK_F18 0x81 */
3196 "f19", /* VK_F19 0x82 */
3197 "f20", /* VK_F20 0x83 */
3198 "f21", /* VK_F21 0x84 */
3199 "f22", /* VK_F22 0x85 */
3200 "f23", /* VK_F23 0x86 */
3201 "f24", /* VK_F24 0x87 */
3203 0, 0, 0, 0, /* 0x88 .. 0x8B */
3204 0, 0, 0, 0, /* 0x8C .. 0x8F */
3206 "kp-numlock", /* VK_NUMLOCK 0x90 */
3207 "scroll", /* VK_SCROLL 0x91 */
3209 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3210 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3211 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3212 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3213 "kp-end", /* VK_NUMPAD_END 0x96 */
3214 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3215 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3216 "kp-up", /* VK_NUMPAD_UP 0x99 */
3217 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3218 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3219 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3220 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3222 0, 0, /* 0x9E .. 0x9F */
3225 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3226 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3227 * No other API or message will distinguish left and right keys this way.
3231 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3232 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3233 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3234 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3235 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3241 "attn", /* VK_ATTN 0xF6 */
3242 "crsel", /* VK_CRSEL 0xF7 */
3243 "exsel", /* VK_EXSEL 0xF8 */
3244 "ereof", /* VK_EREOF 0xF9 */
3245 "play", /* VK_PLAY 0xFA */
3246 "zoom", /* VK_ZOOM 0xFB */
3247 "noname", /* VK_NONAME 0xFC */
3248 "pa1", /* VK_PA1 0xFD */
3249 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3254 #define FUNCTION_KEY_OFFSET 0xff00
3256 /* You'll notice that this table is arranged to be conveniently
3257 indexed by X Windows keysym values. */
3258 static char *lispy_function_keys
[] =
3260 /* X Keysym value */
3262 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3270 0, 0, 0, /* 0xff10 */
3272 0, 0, 0, 0, 0, 0, 0,
3275 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3276 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3277 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3279 "home", /* 0xff50 */ /* IsCursorKey */
3290 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3301 "break", /* 0xff6b */
3303 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3305 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3306 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3307 0, 0, 0, 0, 0, 0, 0, 0,
3308 "kp-tab", /* 0xff89 */
3310 "kp-enter", /* 0xff8d */
3312 "kp-f1", /* 0xff91 */
3316 "kp-home", /* 0xff95 */
3321 "kp-prior", /* kp-page-up */
3322 "kp-next", /* kp-page-down */
3328 0, 0, 0, 0, 0, 0, 0, 0, 0,
3329 "kp-multiply", /* 0xffaa */
3334 "kp-divide", /* 0xffaf */
3335 "kp-0", /* 0xffb0 */
3336 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3339 "kp-equal", /* 0xffbd */
3340 "f1", /* 0xffbe */ /* IsFunctionKey */
3342 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3343 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3344 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3345 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3346 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3347 0, 0, 0, 0, 0, 0, 0, 0,
3348 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3349 0, 0, 0, 0, 0, 0, 0, "delete"
3352 #endif /* HAVE_NTGUI */
3354 static char *lispy_mouse_names
[] =
3356 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3359 /* Scroll bar parts. */
3360 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3362 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3363 Lisp_Object
*scroll_bar_parts
[] = {
3364 &Qabove_handle
, &Qhandle
, &Qbelow_handle
3368 /* A vector, indexed by button number, giving the down-going location
3369 of currently depressed buttons, both scroll bar and non-scroll bar.
3371 The elements have the form
3372 (BUTTON-NUMBER MODIFIER-MASK . REST)
3373 where REST is the cdr of a position as it would be reported in the event.
3375 The make_lispy_event function stores positions here to tell the
3376 difference between click and drag events, and to store the starting
3377 location to be included in drag events. */
3379 static Lisp_Object button_down_location
;
3381 /* Information about the most recent up-going button event: Which
3382 button, what location, and what time. */
3384 static int last_mouse_button
;
3385 static int last_mouse_x
;
3386 static int last_mouse_y
;
3387 static unsigned long button_down_time
;
3389 /* The maximum time between clicks to make a double-click,
3390 or Qnil to disable double-click detection,
3391 or Qt for no time limit. */
3392 Lisp_Object Vdouble_click_time
;
3394 /* The number of clicks in this multiple-click. */
3396 int double_click_count
;
3398 /* Given a struct input_event, build the lisp event which represents
3399 it. If EVENT is 0, build a mouse movement event from the mouse
3400 movement buffer, which should have a movement event in it.
3402 Note that events must be passed to this function in the order they
3403 are received; this function stores the location of button presses
3404 in order to build drag events when the button is released. */
3407 make_lispy_event (event
)
3408 struct input_event
*event
;
3412 switch (SWITCH_ENUM_CAST (event
->kind
))
3414 /* A simple keystroke. */
3415 case ascii_keystroke
:
3417 Lisp_Object lispy_c
;
3418 int c
= event
->code
& 0377;
3419 /* Turn ASCII characters into control characters
3421 if (event
->modifiers
& ctrl_modifier
)
3422 c
= make_ctrl_char (c
);
3424 /* Add in the other modifier bits. We took care of ctrl_modifier
3425 just above, and the shift key was taken care of by the X code,
3426 and applied to control characters by make_ctrl_char. */
3427 c
|= (event
->modifiers
3428 & (meta_modifier
| alt_modifier
3429 | hyper_modifier
| super_modifier
));
3430 button_down_time
= 0;
3431 XSETFASTINT (lispy_c
, c
);
3435 /* A function key. The symbol may need to have modifier prefixes
3437 case non_ascii_keystroke
:
3438 button_down_time
= 0;
3440 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3441 if (event
->code
== lispy_accent_codes
[i
])
3442 return modify_event_symbol (i
,
3444 Qfunction_key
, Qnil
,
3445 lispy_accent_keys
, &accent_key_syms
,
3446 (sizeof (lispy_accent_keys
)
3447 / sizeof (lispy_accent_keys
[0])));
3449 /* Handle system-specific keysyms. */
3450 if (event
->code
& (1 << 28))
3452 /* We need to use an alist rather than a vector as the cache
3453 since we can't make a vector long enuf. */
3454 if (NILP (current_kboard
->system_key_syms
))
3455 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3456 return modify_event_symbol (event
->code
,
3459 current_kboard
->Vsystem_key_alist
,
3460 0, ¤t_kboard
->system_key_syms
,
3464 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3466 Qfunction_key
, Qnil
,
3467 lispy_function_keys
, &func_key_syms
,
3468 (sizeof (lispy_function_keys
)
3469 / sizeof (lispy_function_keys
[0])));
3473 return Fcons (Qtimer_event
, Fcons (Fcdr (event
->frame_or_window
), Qnil
));
3476 /* A mouse click. Figure out where it is, decide whether it's
3477 a press, click or drag, and build the appropriate structure. */
3479 case scroll_bar_click
:
3481 int button
= event
->code
;
3483 Lisp_Object position
;
3484 Lisp_Object
*start_pos_ptr
;
3485 Lisp_Object start_pos
;
3487 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3490 /* Build the position as appropriate for this mouse click. */
3491 if (event
->kind
== mouse_click
)
3494 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3499 /* Ignore mouse events that were made on frame that
3500 have been deleted. */
3501 if (! FRAME_LIVE_P (f
))
3504 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3505 &column
, &row
, NULL
, 1);
3507 #ifndef USE_X_TOOLKIT
3508 /* In the non-toolkit version, clicks on the menu bar
3509 are ordinary button events in the event buffer.
3510 Distinguish them, and invoke the menu.
3512 (In the toolkit version, the toolkit handles the menu bar
3513 and Emacs doesn't know about it until after the user
3514 makes a selection.) */
3515 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3516 && (event
->modifiers
& down_modifier
))
3518 Lisp_Object items
, item
;
3523 /* Activate the menu bar on the down event. If the
3524 up event comes in before the menu code can deal with it,
3526 if (! (event
->modifiers
& down_modifier
))
3531 items
= FRAME_MENU_BAR_ITEMS (f
);
3532 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
3534 Lisp_Object pos
, string
;
3535 string
= XVECTOR (items
)->contents
[i
+ 1];
3536 pos
= XVECTOR (items
)->contents
[i
+ 2];
3539 if (column
>= XINT (pos
)
3540 && column
< XINT (pos
) + XSTRING (string
)->size
)
3542 item
= XVECTOR (items
)->contents
[i
];
3548 = Fcons (event
->frame_or_window
,
3550 Fcons (Fcons (event
->x
, event
->y
),
3551 Fcons (make_number (event
->timestamp
),
3554 return Fcons (item
, Fcons (position
, Qnil
));
3556 #endif /* not USE_X_TOOLKIT */
3558 window
= window_from_coordinates (f
, column
, row
, &part
);
3560 if (!WINDOWP (window
))
3562 window
= event
->frame_or_window
;
3567 int pixcolumn
, pixrow
;
3568 column
-= XINT (XWINDOW (window
)->left
);
3569 row
-= XINT (XWINDOW (window
)->top
);
3570 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3571 XSETINT (event
->x
, pixcolumn
);
3572 XSETINT (event
->y
, pixrow
);
3577 posn
= Qvertical_line
;
3580 buffer_posn_from_coords (XWINDOW (window
),
3587 Fcons (Fcons (event
->x
, event
->y
),
3588 Fcons (make_number (event
->timestamp
),
3594 Lisp_Object portion_whole
;
3597 window
= event
->frame_or_window
;
3598 portion_whole
= Fcons (event
->x
, event
->y
);
3599 part
= *scroll_bar_parts
[(int) event
->part
];
3603 Fcons (Qvertical_scroll_bar
,
3604 Fcons (portion_whole
,
3605 Fcons (make_number (event
->timestamp
),
3606 Fcons (part
, Qnil
)))));
3609 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3611 start_pos
= *start_pos_ptr
;
3612 *start_pos_ptr
= Qnil
;
3614 is_double
= (button
== last_mouse_button
3615 && XINT (event
->x
) == last_mouse_x
3616 && XINT (event
->y
) == last_mouse_y
3617 && button_down_time
!= 0
3618 && (EQ (Vdouble_click_time
, Qt
)
3619 || (INTEGERP (Vdouble_click_time
)
3620 && ((int)(event
->timestamp
- button_down_time
)
3621 < XINT (Vdouble_click_time
)))));
3622 last_mouse_button
= button
;
3623 last_mouse_x
= XINT (event
->x
);
3624 last_mouse_y
= XINT (event
->y
);
3626 /* If this is a button press, squirrel away the location, so
3627 we can decide later whether it was a click or a drag. */
3628 if (event
->modifiers
& down_modifier
)
3632 double_click_count
++;
3633 event
->modifiers
|= ((double_click_count
> 2)
3638 double_click_count
= 1;
3639 button_down_time
= event
->timestamp
;
3640 *start_pos_ptr
= Fcopy_alist (position
);
3643 /* Now we're releasing a button - check the co-ordinates to
3644 see if this was a click or a drag. */
3645 else if (event
->modifiers
& up_modifier
)
3647 /* If we did not see a down before this up,
3648 ignore the up. Probably this happened because
3649 the down event chose a menu item.
3650 It would be an annoyance to treat the release
3651 of the button that chose the menu item
3652 as a separate event. */
3654 if (!CONSP (start_pos
))
3657 event
->modifiers
&= ~up_modifier
;
3658 #if 0 /* Formerly we treated an up with no down as a click event. */
3659 if (!CONSP (start_pos
))
3660 event
->modifiers
|= click_modifier
;
3664 /* The third element of every position should be the (x,y)
3668 down
= Fnth (make_number (2), start_pos
);
3669 if (EQ (event
->x
, XCONS (down
)->car
)
3670 && EQ (event
->y
, XCONS (down
)->cdr
))
3672 event
->modifiers
|= click_modifier
;
3676 button_down_time
= 0;
3677 event
->modifiers
|= drag_modifier
;
3679 /* Don't check is_double; treat this as multiple
3680 if the down-event was multiple. */
3681 if (double_click_count
> 1)
3682 event
->modifiers
|= ((double_click_count
> 2)
3688 /* Every mouse event should either have the down_modifier or
3689 the up_modifier set. */
3693 /* Get the symbol we should use for the mouse click. */
3696 head
= modify_event_symbol (button
,
3699 lispy_mouse_names
, &mouse_syms
,
3700 (sizeof (lispy_mouse_names
)
3701 / sizeof (lispy_mouse_names
[0])));
3702 if (event
->modifiers
& drag_modifier
)
3707 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
3710 Fcons (make_number (double_click_count
),
3718 #endif /* HAVE_MOUSE */
3720 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3721 case menu_bar_event
:
3722 /* The event value is in the cdr of the frame_or_window slot. */
3723 if (!CONSP (event
->frame_or_window
))
3725 return XCONS (event
->frame_or_window
)->cdr
;
3728 /* The 'kind' field of the event is something we don't recognize. */
3737 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
3739 Lisp_Object bar_window
;
3740 enum scroll_bar_part part
;
3745 /* Is it a scroll bar movement? */
3746 if (frame
&& ! NILP (bar_window
))
3748 Lisp_Object part_sym
;
3750 part_sym
= *scroll_bar_parts
[(int) part
];
3751 return Fcons (Qscroll_bar_movement
,
3752 (Fcons (Fcons (bar_window
,
3753 Fcons (Qvertical_scroll_bar
,
3754 Fcons (Fcons (x
, y
),
3755 Fcons (make_number (time
),
3761 /* Or is it an ordinary mouse movement? */
3763 #endif /* MULTI_FRAME */
3776 /* It's in a frame; which window on that frame? */
3777 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
3779 window
= window_from_coordinates (frame
, column
, row
, &area
);
3784 if (WINDOWP (window
))
3786 int pixcolumn
, pixrow
;
3787 column
-= XINT (XWINDOW (window
)->left
);
3788 row
-= XINT (XWINDOW (window
)->top
);
3789 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
3790 XSETINT (x
, pixcolumn
);
3791 XSETINT (y
, pixrow
);
3796 posn
= Qvertical_line
;
3799 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
3802 else if (frame
!= 0)
3804 XSETFRAME (window
, frame
);
3816 return Fcons (Qmouse_movement
,
3817 Fcons (Fcons (window
,
3819 Fcons (Fcons (x
, y
),
3820 Fcons (make_number (time
),
3826 #endif /* HAVE_MOUSE */
3828 /* Construct a switch frame event. */
3830 make_lispy_switch_frame (frame
)
3833 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
3836 /* Manipulating modifiers. */
3838 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
3840 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
3841 SYMBOL's name of the end of the modifiers; the string from this
3842 position is the unmodified symbol name.
3844 This doesn't use any caches. */
3847 parse_modifiers_uncached (symbol
, modifier_end
)
3851 struct Lisp_String
*name
;
3855 CHECK_SYMBOL (symbol
, 1);
3858 name
= XSYMBOL (symbol
)->name
;
3860 for (i
= 0; i
+2 <= name
->size
; )
3862 int this_mod_end
= 0;
3865 /* See if the name continues with a modifier word.
3866 Check that the word appears, but don't check what follows it.
3867 Set this_mod and this_mod_end to record what we find. */
3869 switch (name
->data
[i
])
3871 #define SINGLE_LETTER_MOD(BIT) \
3872 (this_mod_end = i + 1, this_mod = BIT)
3875 SINGLE_LETTER_MOD (alt_modifier
);
3879 SINGLE_LETTER_MOD (ctrl_modifier
);
3883 SINGLE_LETTER_MOD (hyper_modifier
);
3887 SINGLE_LETTER_MOD (meta_modifier
);
3891 SINGLE_LETTER_MOD (shift_modifier
);
3895 SINGLE_LETTER_MOD (super_modifier
);
3898 #undef SINGLE_LETTER_MOD
3901 /* If we found no modifier, stop looking for them. */
3902 if (this_mod_end
== 0)
3905 /* Check there is a dash after the modifier, so that it
3906 really is a modifier. */
3907 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
3910 /* This modifier is real; look for another. */
3911 modifiers
|= this_mod
;
3912 i
= this_mod_end
+ 1;
3915 /* Should we include the `click' modifier? */
3916 if (! (modifiers
& (down_modifier
| drag_modifier
3917 | double_modifier
| triple_modifier
))
3918 && i
+ 7 == name
->size
3919 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
3920 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
3921 modifiers
|= click_modifier
;
3929 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
3930 prepended to the string BASE[0..BASE_LEN-1].
3931 This doesn't use any caches. */
3933 apply_modifiers_uncached (modifiers
, base
, base_len
)
3938 /* Since BASE could contain nulls, we can't use intern here; we have
3939 to use Fintern, which expects a genuine Lisp_String, and keeps a
3942 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
3948 /* Only the event queue may use the `up' modifier; it should always
3949 be turned into a click or drag event before presented to lisp code. */
3950 if (modifiers
& up_modifier
)
3953 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
3954 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
3955 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
3956 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
3957 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
3958 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
3959 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
3960 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
3961 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
3962 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
3963 /* The click modifier is denoted by the absence of other modifiers. */
3967 mod_len
= p
- new_mods
;
3971 Lisp_Object new_name
;
3973 new_name
= make_uninit_string (mod_len
+ base_len
);
3974 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
3975 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
3977 return Fintern (new_name
, Qnil
);
3982 static char *modifier_names
[] =
3984 "up", "down", "drag", "click", "double", "triple", 0, 0,
3985 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3986 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
3988 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
3990 static Lisp_Object modifier_symbols
;
3992 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3994 lispy_modifier_list (modifiers
)
3997 Lisp_Object modifier_list
;
4000 modifier_list
= Qnil
;
4001 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4002 if (modifiers
& (1<<i
))
4003 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4006 return modifier_list
;
4010 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4011 where UNMODIFIED is the unmodified form of SYMBOL,
4012 MASK is the set of modifiers present in SYMBOL's name.
4013 This is similar to parse_modifiers_uncached, but uses the cache in
4014 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4015 Qevent_symbol_elements property. */
4018 parse_modifiers (symbol
)
4021 Lisp_Object elements
;
4023 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4024 if (CONSP (elements
))
4029 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4030 Lisp_Object unmodified
;
4033 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4034 XSYMBOL (symbol
)->name
->size
- end
),
4037 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4039 XSETFASTINT (mask
, modifiers
);
4040 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4042 /* Cache the parsing results on SYMBOL. */
4043 Fput (symbol
, Qevent_symbol_element_mask
,
4045 Fput (symbol
, Qevent_symbol_elements
,
4046 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4048 /* Since we know that SYMBOL is modifiers applied to unmodified,
4049 it would be nice to put that in unmodified's cache.
4050 But we can't, since we're not sure that parse_modifiers is
4057 /* Apply the modifiers MODIFIERS to the symbol BASE.
4058 BASE must be unmodified.
4060 This is like apply_modifiers_uncached, but uses BASE's
4061 Qmodifier_cache property, if present. It also builds
4062 Qevent_symbol_elements properties, since it has that info anyway.
4064 apply_modifiers copies the value of BASE's Qevent_kind property to
4065 the modified symbol. */
4067 apply_modifiers (modifiers
, base
)
4071 Lisp_Object cache
, index
, entry
, new_symbol
;
4073 /* Mask out upper bits. We don't know where this value's been. */
4074 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4076 /* The click modifier never figures into cache indices. */
4077 cache
= Fget (base
, Qmodifier_cache
);
4078 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4079 entry
= assq_no_quit (index
, cache
);
4082 new_symbol
= XCONS (entry
)->cdr
;
4085 /* We have to create the symbol ourselves. */
4086 new_symbol
= apply_modifiers_uncached (modifiers
,
4087 XSYMBOL (base
)->name
->data
,
4088 XSYMBOL (base
)->name
->size
);
4090 /* Add the new symbol to the base's cache. */
4091 entry
= Fcons (index
, new_symbol
);
4092 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4094 /* We have the parsing info now for free, so add it to the caches. */
4095 XSETFASTINT (index
, modifiers
);
4096 Fput (new_symbol
, Qevent_symbol_element_mask
,
4097 Fcons (base
, Fcons (index
, Qnil
)));
4098 Fput (new_symbol
, Qevent_symbol_elements
,
4099 Fcons (base
, lispy_modifier_list (modifiers
)));
4102 /* Make sure this symbol is of the same kind as BASE.
4104 You'd think we could just set this once and for all when we
4105 intern the symbol above, but reorder_modifiers may call us when
4106 BASE's property isn't set right; we can't assume that just
4107 because it has a Qmodifier_cache property it must have its
4108 Qevent_kind set right as well. */
4109 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4113 kind
= Fget (base
, Qevent_kind
);
4115 Fput (new_symbol
, Qevent_kind
, kind
);
4122 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4123 return a symbol with the modifiers placed in the canonical order.
4124 Canonical order is alphabetical, except for down and drag, which
4125 always come last. The 'click' modifier is never written out.
4127 Fdefine_key calls this to make sure that (for example) C-M-foo
4128 and M-C-foo end up being equivalent in the keymap. */
4131 reorder_modifiers (symbol
)
4134 /* It's hopefully okay to write the code this way, since everything
4135 will soon be in caches, and no consing will be done at all. */
4138 parsed
= parse_modifiers (symbol
);
4139 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4140 XCONS (parsed
)->car
);
4144 /* For handling events, we often want to produce a symbol whose name
4145 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4146 to some base, like the name of a function key or mouse button.
4147 modify_event_symbol produces symbols of this sort.
4149 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4150 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4153 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4154 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4156 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4157 persist between calls to modify_event_symbol that it can use to
4158 store a cache of the symbols it's generated for this NAME_TABLE
4159 before. The object stored there may be a vector or an alist.
4161 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4163 MODIFIERS is a set of modifier bits (as given in struct input_events)
4164 whose prefixes should be applied to the symbol name.
4166 SYMBOL_KIND is the value to be placed in the event_kind property of
4167 the returned symbol.
4169 The symbols we create are supposed to have an
4170 `event-symbol-elements' property, which lists the modifiers present
4171 in the symbol's name. */
4174 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4175 name_table
, symbol_table
, table_size
)
4178 Lisp_Object symbol_kind
;
4179 Lisp_Object name_alist
;
4181 Lisp_Object
*symbol_table
;
4182 unsigned int table_size
;
4185 Lisp_Object symbol_int
;
4187 /* Get rid of the "vendor-specific" bit here. */
4188 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4190 /* Is this a request for a valid symbol? */
4191 if (symbol_num
< 0 || symbol_num
>= table_size
)
4194 if (CONSP (*symbol_table
))
4195 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4197 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4198 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4199 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4200 we've never used that symbol before. */
4203 if (! VECTORP (*symbol_table
)
4204 || XVECTOR (*symbol_table
)->size
!= table_size
)
4208 XSETFASTINT (size
, table_size
);
4209 *symbol_table
= Fmake_vector (size
, Qnil
);
4212 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4215 /* Have we already used this symbol before? */
4218 /* No; let's create it. */
4219 if (!NILP (name_alist
))
4220 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4221 else if (name_table
[symbol_num
])
4222 value
= intern (name_table
[symbol_num
]);
4224 #ifdef HAVE_WINDOW_SYSTEM
4227 char *name
= x_get_keysym_name (symbol_num
);
4229 value
= intern (name
);
4236 sprintf (buf
, "key-%d", symbol_num
);
4237 value
= intern (buf
);
4240 if (CONSP (*symbol_table
))
4241 *symbol_table
= Fcons (value
, *symbol_table
);
4243 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4245 /* Fill in the cache entries for this symbol; this also
4246 builds the Qevent_symbol_elements property, which the user
4248 apply_modifiers (modifiers
& click_modifier
, value
);
4249 Fput (value
, Qevent_kind
, symbol_kind
);
4252 /* Apply modifiers to that symbol. */
4253 return apply_modifiers (modifiers
, value
);
4256 /* Convert a list that represents an event type,
4257 such as (ctrl meta backspace), into the usual representation of that
4258 event type as a number or a symbol. */
4260 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4261 "Convert the event description list EVENT-DESC to an event type.\n\
4262 EVENT-DESC should contain one base event type (a character or symbol)\n\
4263 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4264 drag, down, double or triple).\n\
4265 The return value is an event type (a character or symbol) which\n\
4266 has the same base event type and all the specified modifiers.")
4268 Lisp_Object event_desc
;
4276 while (CONSP (rest
))
4281 elt
= XCONS (rest
)->car
;
4283 /* Given a symbol, see if it is a modifier name. */
4285 this = parse_solitary_modifier (elt
);
4289 else if (!NILP (base
))
4290 error ("Two bases given in one event");
4294 rest
= XCONS (rest
)->cdr
;
4297 /* Let the symbol A refer to the character A. */
4298 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4299 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4301 if (INTEGERP (base
))
4303 /* Turn (shift a) into A. */
4304 if ((modifiers
& shift_modifier
) != 0
4305 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4307 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4308 modifiers
&= ~shift_modifier
;
4311 /* Turn (control a) into C-a. */
4312 if (modifiers
& ctrl_modifier
)
4313 return make_number ((modifiers
& ~ctrl_modifier
)
4314 | make_ctrl_char (XINT (base
)));
4316 return make_number (modifiers
| XINT (base
));
4318 else if (SYMBOLP (base
))
4319 return apply_modifiers (modifiers
, base
);
4321 error ("Invalid base event");
4324 /* Try to recognize SYMBOL as a modifier name.
4325 Return the modifier flag bit, or 0 if not recognized. */
4328 parse_solitary_modifier (symbol
)
4331 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4333 switch (name
->data
[0])
4335 #define SINGLE_LETTER_MOD(BIT) \
4336 if (name->size == 1) \
4339 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4340 if (LEN == name->size \
4341 && ! strncmp (name->data, NAME, LEN)) \
4345 SINGLE_LETTER_MOD (alt_modifier
);
4349 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4353 SINGLE_LETTER_MOD (ctrl_modifier
);
4357 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4358 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4362 SINGLE_LETTER_MOD (hyper_modifier
);
4366 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4370 SINGLE_LETTER_MOD (meta_modifier
);
4374 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4378 SINGLE_LETTER_MOD (shift_modifier
);
4382 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4383 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4384 SINGLE_LETTER_MOD (super_modifier
);
4388 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4389 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4390 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4394 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4397 #undef SINGLE_LETTER_MOD
4398 #undef MULTI_LETTER_MOD
4404 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4405 Such a list is not valid as an event,
4406 but it can be a Lucid-style event type list. */
4409 lucid_event_type_list_p (object
)
4414 if (! CONSP (object
))
4417 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4420 elt
= XCONS (tail
)->car
;
4421 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4428 /* Store into *addr a value nonzero if terminal input chars are available.
4429 Serves the purpose of ioctl (0, FIONREAD, addr)
4430 but works even if FIONREAD does not exist.
4431 (In fact, this may actually read some input.) */
4434 get_input_pending (addr
)
4437 /* First of all, have we already counted some input? */
4438 *addr
= !NILP (Vquit_flag
) || readable_events ();
4440 /* If input is being read as it arrives, and we have none, there is none. */
4441 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4444 /* Try to read some input and see how much we get. */
4446 *addr
= !NILP (Vquit_flag
) || readable_events ();
4449 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4452 gobble_input (expected
)
4457 if (interrupt_input
)
4460 mask
= sigblockx (SIGIO
);
4461 read_avail_input (expected
);
4465 #ifdef POLL_FOR_INPUT
4466 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4469 mask
= sigblockx (SIGALRM
);
4470 read_avail_input (expected
);
4476 read_avail_input (expected
);
4480 /* Put a buffer_switch_event in the buffer
4481 so that read_key_sequence will notice the new current buffer. */
4483 record_asynch_buffer_change ()
4485 struct input_event event
;
4488 event
.kind
= buffer_switch_event
;
4489 event
.frame_or_window
= Qnil
;
4492 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4493 The purpose of the event is to make read_key_sequence look up the
4494 keymaps again. If we aren't in read_key_sequence, we don't need one,
4495 and the event could cause trouble by messing up (input-pending-p). */
4496 tem
= Fwaiting_for_user_input_p ();
4500 /* We never need these events if we have no asynchronous subprocesses. */
4504 /* Make sure no interrupt happens while storing the event. */
4506 if (interrupt_input
)
4509 mask
= sigblockx (SIGIO
);
4510 kbd_buffer_store_event (&event
);
4517 kbd_buffer_store_event (&event
);
4524 /* Read any terminal input already buffered up by the system
4525 into the kbd_buffer, but do not wait.
4527 EXPECTED should be nonzero if the caller knows there is some input.
4529 Except on VMS, all input is read by this function.
4530 If interrupt_input is nonzero, this function MUST be called
4531 only when SIGIO is blocked.
4533 Returns the number of keyboard chars read, or -1 meaning
4534 this is a bad time to try to read input. */
4537 read_avail_input (expected
)
4540 struct input_event buf
[KBD_BUFFER_SIZE
];
4544 if (read_socket_hook
)
4545 /* No need for FIONREAD or fcntl; just say don't wait. */
4546 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
,
4547 expected
, expected
);
4550 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
4551 the kbd_buffer can really hold. That may prevent loss
4552 of characters on some systems when input is stuffed at us. */
4553 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
4556 /* Determine how many characters we should *try* to read. */
4559 #else /* not WINDOWSNT */
4561 n_to_read
= dos_keysns ();
4564 #else /* not MSDOS */
4566 /* Find out how much input is available. */
4567 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
4568 /* Formerly simply reported no input, but that sometimes led to
4569 a failure of Emacs to terminate.
4570 SIGHUP seems appropriate if we can't reach the terminal. */
4571 /* ??? Is it really right to send the signal just to this process
4572 rather than to the whole process group?
4573 Perhaps on systems with FIONREAD Emacs is alone in its group. */
4574 kill (getpid (), SIGHUP
);
4577 if (n_to_read
> sizeof cbuf
)
4578 n_to_read
= sizeof cbuf
;
4579 #else /* no FIONREAD */
4580 #if defined (USG) || defined (DGUX)
4581 /* Read some input if available, but don't wait. */
4582 n_to_read
= sizeof cbuf
;
4583 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
4588 #endif /* not MSDOS */
4589 #endif /* not WINDOWSNT */
4591 /* Now read; for one reason or another, this will not block.
4592 NREAD is set to the number of chars read. */
4596 cbuf
[0] = dos_keyread ();
4599 nread
= read (input_fd
, cbuf
, n_to_read
);
4601 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
4602 /* The kernel sometimes fails to deliver SIGHUP for ptys.
4603 This looks incorrect, but it isn't, because _BSD causes
4604 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
4605 and that causes a value other than 0 when there is no input. */
4611 /* We used to retry the read if it was interrupted.
4612 But this does the wrong thing when O_NDELAY causes
4613 an EAGAIN error. Does anybody know of a situation
4614 where a retry is actually needed? */
4616 nread
< 0 && (errno
== EAGAIN
4630 #if defined (USG) || defined (DGUX)
4631 fcntl (input_fd
, F_SETFL
, 0);
4632 #endif /* USG or DGUX */
4633 #endif /* no FIONREAD */
4634 for (i
= 0; i
< nread
; i
++)
4636 buf
[i
].kind
= ascii_keystroke
;
4637 buf
[i
].modifiers
= 0;
4638 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
4639 buf
[i
].modifiers
= meta_modifier
;
4643 buf
[i
].code
= cbuf
[i
];
4645 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
4647 buf
[i
].frame_or_window
= Qnil
;
4652 /* Scan the chars for C-g and store them in kbd_buffer. */
4653 for (i
= 0; i
< nread
; i
++)
4655 kbd_buffer_store_event (&buf
[i
]);
4656 /* Don't look at input that follows a C-g too closely.
4657 This reduces lossage due to autorepeat on C-g. */
4658 if (buf
[i
].kind
== ascii_keystroke
4659 && buf
[i
].code
== quit_char
)
4665 #endif /* not VMS */
4667 #ifdef SIGIO /* for entire page */
4668 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4671 input_available_signal (signo
)
4674 /* Must preserve main program's value of errno. */
4675 int old_errno
= errno
;
4677 extern int select_alarmed
;
4681 /* USG systems forget handlers when they are used;
4682 must reestablish each time */
4683 signal (signo
, input_available_signal
);
4690 if (input_available_clear_time
)
4691 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
4696 nread
= read_avail_input (1);
4697 /* -1 means it's not ok to read the input now.
4698 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
4699 0 means there was no keyboard input available. */
4704 select_alarmed
= 1; /* Force the select emulator back to life */
4715 /* Send ourselves a SIGIO.
4717 This function exists so that the UNBLOCK_INPUT macro in
4718 blockinput.h can have some way to take care of input we put off
4719 dealing with, without assuming that every file which uses
4720 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
4722 reinvoke_input_signal ()
4731 /* Return the prompt-string of a sparse keymap.
4732 This is the first element which is a string.
4733 Return nil if there is none. */
4741 register Lisp_Object tem
;
4750 static void menu_bar_item ();
4751 static void menu_bar_one_keymap ();
4753 /* These variables hold the vector under construction within
4754 menu_bar_items and its subroutines, and the current index
4755 for storing into that vector. */
4756 static Lisp_Object menu_bar_items_vector
;
4757 static int menu_bar_items_index
;
4759 /* Return a vector of menu items for a menu bar, appropriate
4760 to the current buffer. Each item has three elements in the vector:
4763 OLD is an old vector we can optionally reuse, or nil. */
4766 menu_bar_items (old
)
4769 /* The number of keymaps we're scanning right now, and the number of
4770 keymaps we have allocated space for. */
4773 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4774 in the current keymaps, or nil where it is not a prefix. */
4777 Lisp_Object def
, tem
, tail
;
4786 struct gcpro gcpro1
;
4788 /* In order to build the menus, we need to call the keymap
4789 accessors. They all call QUIT. But this function is called
4790 during redisplay, during which a quit is fatal. So inhibit
4791 quitting while building the menus.
4792 We do this instead of specbind because (1) errors will clear it anyway
4793 and (2) this avoids risk of specpdl overflow. */
4794 oquit
= Vinhibit_quit
;
4798 menu_bar_items_vector
= old
;
4800 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
4801 menu_bar_items_index
= 0;
4803 GCPRO1 (menu_bar_items_vector
);
4805 /* Build our list of keymaps.
4806 If we recognize a function key and replace its escape sequence in
4807 keybuf with its symbol, or if the sequence starts with a mouse
4808 click and we need to switch buffers, we jump back here to rebuild
4809 the initial keymaps from the current buffer. */
4813 /* Should overriding-terminal-local-map and overriding-local-map apply? */
4814 if (!NILP (Voverriding_local_map_menu_flag
))
4816 /* Yes, use them (if non-nil) as well as the global map. */
4817 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
4819 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
4820 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
4821 if (!NILP (Voverriding_local_map
))
4822 maps
[nmaps
++] = Voverriding_local_map
;
4826 /* No, so use major and minor mode keymaps. */
4827 nmaps
= current_minor_maps (NULL
, &tmaps
);
4828 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
4829 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
4830 #ifdef USE_TEXT_PROPERTIES
4831 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
4833 maps
[nmaps
++] = current_buffer
->keymap
;
4836 maps
[nmaps
++] = current_global_map
;
4839 /* Look up in each map the dummy prefix key `menu-bar'. */
4843 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
4845 if (! NILP (maps
[mapno
]))
4846 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
4850 tem
= Fkeymapp (def
);
4852 menu_bar_one_keymap (def
);
4855 /* Move to the end those items that should be at the end. */
4857 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4860 int end
= menu_bar_items_index
;
4862 for (i
= 0; i
< end
; i
+= 3)
4863 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4865 Lisp_Object tem0
, tem1
, tem2
;
4866 /* Move the item at index I to the end,
4867 shifting all the others forward. */
4868 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
4869 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
4870 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
4872 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
4873 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
4874 (end
- i
- 3) * sizeof (Lisp_Object
));
4875 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
4876 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
4877 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
4882 /* Add nil, nil, nil at the end. */
4883 i
= menu_bar_items_index
;
4884 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
4887 int newsize
= 2 * i
;
4888 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
4889 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
4890 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
4891 menu_bar_items_vector
= tem
;
4893 /* Add this item. */
4894 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
4895 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
4896 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
4897 menu_bar_items_index
= i
;
4899 Vinhibit_quit
= oquit
;
4901 return menu_bar_items_vector
;
4904 /* Scan one map KEYMAP, accumulating any menu items it defines
4905 in menu_bar_items_vector. */
4908 menu_bar_one_keymap (keymap
)
4911 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
4913 /* Loop over all keymap entries that have menu strings. */
4914 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4916 item
= XCONS (tail
)->car
;
4919 key
= XCONS (item
)->car
;
4920 binding
= XCONS (item
)->cdr
;
4921 if (CONSP (binding
))
4923 item_string
= XCONS (binding
)->car
;
4924 if (STRINGP (item_string
))
4925 menu_bar_item (key
, item_string
, Fcdr (binding
));
4927 else if (EQ (binding
, Qundefined
))
4928 menu_bar_item (key
, Qnil
, binding
);
4930 else if (VECTORP (item
))
4932 /* Loop over the char values represented in the vector. */
4933 int len
= XVECTOR (item
)->size
;
4935 for (c
= 0; c
< len
; c
++)
4937 Lisp_Object character
;
4938 XSETFASTINT (character
, c
);
4939 binding
= XVECTOR (item
)->contents
[c
];
4940 if (CONSP (binding
))
4942 item_string
= XCONS (binding
)->car
;
4943 if (STRINGP (item_string
))
4944 menu_bar_item (key
, item_string
, Fcdr (binding
));
4946 else if (EQ (binding
, Qundefined
))
4947 menu_bar_item (key
, Qnil
, binding
);
4953 /* This is used as the handler when calling internal_condition_case_1. */
4956 menu_bar_item_1 (arg
)
4962 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
4963 If there's already an item for KEY, add this DEF to it. */
4966 menu_bar_item (key
, item_string
, def
)
4967 Lisp_Object key
, item_string
, def
;
4970 Lisp_Object enabled
;
4973 if (EQ (def
, Qundefined
))
4975 /* If a map has an explicit `undefined' as definition,
4976 discard any previously made menu bar item. */
4978 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
4979 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4981 if (menu_bar_items_index
> i
+ 3)
4982 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
4983 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
4984 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
4985 menu_bar_items_index
-= 3;
4989 /* If there's no definition for this key yet,
4990 just ignore `undefined'. */
4994 /* See if this entry is enabled. */
4999 /* No property, or nil, means enable.
5000 Otherwise, enable if value is not nil. */
5001 tem
= Fget (def
, Qmenu_enable
);
5003 /* (condition-case nil (eval tem)
5005 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5009 /* Ignore this item if it's not enabled. */
5013 /* Find any existing item for this KEY. */
5014 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
5015 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5018 /* If we did not find this KEY, add it at the end. */
5019 if (i
== menu_bar_items_index
)
5021 /* If vector is too small, get a bigger one. */
5022 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
5025 int newsize
= 2 * i
;
5026 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5027 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5028 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5029 menu_bar_items_vector
= tem
;
5031 /* Add this item. */
5032 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5033 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5034 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5035 menu_bar_items_index
= i
;
5037 /* We did find an item for this KEY. Add DEF to its list of maps. */
5041 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5042 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5046 /* Read a character using menus based on maps in the array MAPS.
5047 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5048 Return t if we displayed a menu but the user rejected it.
5050 PREV_EVENT is the previous input event, or nil if we are reading
5051 the first event of a key sequence.
5053 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5054 if we used a mouse menu to read the input, or zero otherwise. If
5055 USED_MOUSE_MENU is null, we don't dereference it.
5057 The prompting is done based on the prompt-string of the map
5058 and the strings associated with various map elements.
5060 This can be done with X menus or with menus put in the minibuf.
5061 These are done in different ways, depending on how the input will be read.
5062 Menus using X are done after auto-saving in read-char, getting the input
5063 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5064 and do auto-saving in the inner call of read_char. */
5067 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5070 Lisp_Object prev_event
;
5071 int *used_mouse_menu
;
5074 register Lisp_Object name
;
5075 Lisp_Object rest
, vector
;
5077 if (used_mouse_menu
)
5078 *used_mouse_menu
= 0;
5080 /* Use local over global Menu maps */
5082 if (! menu_prompting
)
5085 /* Optionally disregard all but the global map. */
5086 if (inhibit_local_menu_bar_menus
)
5088 maps
+= (nmaps
- 1);
5092 /* Get the menu name from the first map that has one (a prompt string). */
5093 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5095 name
= map_prompt (maps
[mapno
]);
5100 /* If we don't have any menus, just read a character normally. */
5105 /* If we got to this point via a mouse click,
5106 use a real menu for mouse selection. */
5107 if (EVENT_HAS_PARAMETERS (prev_event
)
5108 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5110 /* Display the menu and get the selection. */
5111 Lisp_Object
*realmaps
5112 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5116 /* Use the maps that are not nil. */
5117 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5118 if (!NILP (maps
[mapno
]))
5119 realmaps
[nmaps1
++] = maps
[mapno
];
5121 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5126 /* If we got multiple events, unread all but
5128 There is no way to prevent those unread events
5129 from showing up later in last_nonmenu_event.
5130 So turn symbol and integer events into lists,
5131 to indicate that they came from a mouse menu,
5132 so that when present in last_nonmenu_event
5133 they won't confuse things. */
5134 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5135 tem
= XCONS (tem
)->cdr
)
5136 if (SYMBOLP (XCONS (tem
)->car
)
5137 || INTEGERP (XCONS (tem
)->car
))
5139 = Fcons (XCONS (tem
)->car
, Qnil
);
5141 /* If we got more than one event, put all but the first
5142 onto this list to be read later.
5143 Return just the first event now. */
5144 Vunread_command_events
5145 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5146 value
= XCONS (value
)->car
;
5148 else if (NILP (value
))
5150 if (used_mouse_menu
)
5151 *used_mouse_menu
= 1;
5154 #endif /* HAVE_MENUS */
5158 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5159 We make this bigger when necessary, and never free it. */
5160 static char *read_char_minibuf_menu_text
;
5161 /* Size of that buffer. */
5162 static int read_char_minibuf_menu_width
;
5165 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5171 register Lisp_Object name
;
5173 int width
= FRAME_WIDTH (selected_frame
) - 4;
5176 Lisp_Object rest
, vector
;
5179 if (! menu_prompting
)
5182 /* Make sure we have a big enough buffer for the menu text. */
5183 if (read_char_minibuf_menu_text
== 0)
5185 read_char_minibuf_menu_width
= width
+ 4;
5186 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5188 else if (width
+ 4 > read_char_minibuf_menu_width
)
5190 read_char_minibuf_menu_width
= width
+ 4;
5191 read_char_minibuf_menu_text
5192 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5194 menu
= read_char_minibuf_menu_text
;
5196 /* Get the menu name from the first map that has one (a prompt string). */
5197 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5199 name
= map_prompt (maps
[mapno
]);
5204 /* If we don't have any menus, just read a character normally. */
5208 /* Prompt string always starts with map's prompt, and a space. */
5209 strcpy (menu
, XSTRING (name
)->data
);
5210 nlength
= XSTRING (name
)->size
;
5211 menu
[nlength
++] = ':';
5212 menu
[nlength
++] = ' ';
5215 /* Start prompting at start of first map. */
5219 /* Present the documented bindings, a line at a time. */
5226 Lisp_Object orig_defn_macro
;
5228 /* Loop over elements of map. */
5233 /* If reached end of map, start at beginning of next map. */
5237 /* At end of last map, wrap around to first map if just starting,
5238 or end this line if already have something on it. */
5242 if (notfirst
|| nobindings
) break;
5247 /* Look at the next element of the map. */
5249 elt
= XVECTOR (vector
)->contents
[idx
];
5251 elt
= Fcar_safe (rest
);
5253 if (idx
< 0 && VECTORP (elt
))
5255 /* If we found a dense table in the keymap,
5256 advanced past it, but start scanning its contents. */
5257 rest
= Fcdr_safe (rest
);
5263 /* An ordinary element. */
5268 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5269 event
= Fcar_safe (elt
);
5273 s
= Fcar_safe (elt
); /* vector */
5274 XSETINT (event
, idx
);
5277 /* Ignore the element if it has no prompt string. */
5278 if (STRINGP (s
) && INTEGERP (event
))
5280 /* 1 if the char to type matches the string. */
5282 Lisp_Object upcased_event
, downcased_event
;
5285 upcased_event
= Fupcase (event
);
5286 downcased_event
= Fdowncase (event
);
5287 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5288 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5290 desc
= Fsingle_key_description (event
);
5292 /* If we have room for the prompt string, add it to this line.
5293 If this is the first on the line, always add it. */
5294 if ((XSTRING (s
)->size
+ i
+ 2
5295 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5301 /* Punctuate between strings. */
5304 strcpy (menu
+ i
, ", ");
5310 /* If the char to type doesn't match the string's
5311 first char, explicitly show what char to type. */
5314 /* Add as much of string as fits. */
5315 thiswidth
= XSTRING (desc
)->size
;
5316 if (thiswidth
+ i
> width
)
5317 thiswidth
= width
- i
;
5318 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5320 strcpy (menu
+ i
, " = ");
5324 /* Add as much of string as fits. */
5325 thiswidth
= XSTRING (s
)->size
;
5326 if (thiswidth
+ i
> width
)
5327 thiswidth
= width
- i
;
5328 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5334 /* If this element does not fit, end the line now,
5335 and save the element for the next line. */
5336 strcpy (menu
+ i
, "...");
5341 /* Move past this element. */
5342 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5343 /* Handle reaching end of dense table. */
5348 rest
= Fcdr_safe (rest
);
5352 /* Prompt with that and read response. */
5355 /* Make believe its not a keyboard macro in case the help char
5356 is pressed. Help characters are not recorded because menu prompting
5357 is not used on replay.
5359 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5360 current_kboard
->defining_kbd_macro
= Qnil
;
5362 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5363 while (BUFFERP (obj
));
5364 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5366 if (!INTEGERP (obj
))
5371 if (! EQ (obj
, menu_prompt_more_char
)
5372 && (!INTEGERP (menu_prompt_more_char
)
5373 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5375 if (!NILP (current_kboard
->defining_kbd_macro
))
5376 store_kbd_macro_char (obj
);
5379 /* Help char - go round again */
5383 /* Reading key sequences. */
5385 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5386 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5387 keymap, or nil otherwise. Return the index of the first keymap in
5388 which KEY has any binding, or NMAPS if no map has a binding.
5390 If KEY is a meta ASCII character, treat it like meta-prefix-char
5391 followed by the corresponding non-meta character. Keymaps in
5392 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5395 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5398 NEXT may be the same array as CURRENT. */
5401 follow_key (key
, nmaps
, current
, defs
, next
)
5403 Lisp_Object
*current
, *defs
, *next
;
5406 int i
, first_binding
;
5409 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5410 followed by the corresponding non-meta character.
5411 Put the results into DEFS, since we are going to alter that anyway.
5412 Do not alter CURRENT or NEXT. */
5413 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5415 for (i
= 0; i
< nmaps
; i
++)
5416 if (! NILP (current
[i
]))
5419 def
= get_keyelt (access_keymap (current
[i
],
5420 meta_prefix_char
, 1, 0));
5422 /* Note that since we pass the resulting bindings through
5423 get_keymap_1, non-prefix bindings for meta-prefix-char
5425 defs
[i
] = get_keymap_1 (def
, 0, 1);
5431 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5434 first_binding
= nmaps
;
5435 for (i
= nmaps
- 1; i
>= 0; i
--)
5437 if (! NILP (current
[i
]))
5445 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0));
5446 if (! NILP (defs
[i
]))
5453 /* Given the set of bindings we've found, produce the next set of maps. */
5454 if (first_binding
< nmaps
)
5455 for (i
= 0; i
< nmaps
; i
++)
5456 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5458 return first_binding
;
5461 /* Read a sequence of keys that ends with a non prefix character,
5462 storing it in KEYBUF, a buffer of size BUFSIZE.
5464 Return the length of the key sequence stored.
5465 Return -1 if the user rejected a command menu.
5467 Echo starting immediately unless `prompt' is 0.
5469 Where a key sequence ends depends on the currently active keymaps.
5470 These include any minor mode keymaps active in the current buffer,
5471 the current buffer's local map, and the global map.
5473 If a key sequence has no other bindings, we check Vfunction_key_map
5474 to see if some trailing subsequence might be the beginning of a
5475 function key's sequence. If so, we try to read the whole function
5476 key, and substitute its symbolic name into the key sequence.
5478 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5479 `double-' events into similar click events, if that would make them
5480 bound. We try to turn `triple-' events first into `double-' events,
5483 If we get a mouse click in a mode line, vertical divider, or other
5484 non-text area, we treat the click as if it were prefixed by the
5485 symbol denoting that area - `mode-line', `vertical-line', or
5488 If the sequence starts with a mouse click, we read the key sequence
5489 with respect to the buffer clicked on, not the current buffer.
5491 If the user switches frames in the midst of a key sequence, we put
5492 off the switch-frame event until later; the next call to
5493 read_char will return it. */
5496 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5497 can_return_switch_frame
)
5498 Lisp_Object
*keybuf
;
5501 int dont_downcase_last
;
5502 int can_return_switch_frame
;
5504 int count
= specpdl_ptr
- specpdl
;
5506 /* How many keys there are in the current key sequence. */
5509 /* The length of the echo buffer when we started reading, and
5510 the length of this_command_keys when we started reading. */
5514 /* The number of keymaps we're scanning right now, and the number of
5515 keymaps we have allocated space for. */
5517 int nmaps_allocated
= 0;
5519 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5520 the current keymaps. */
5523 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5524 in the current keymaps, or nil where it is not a prefix. */
5525 Lisp_Object
*submaps
;
5527 /* The local map to start out with at start of key sequence. */
5528 Lisp_Object orig_local_map
;
5530 /* 1 if we have already considered switching to the local-map property
5531 of the place where a mouse click occurred. */
5532 int localized_local_map
= 0;
5534 /* The index in defs[] of the first keymap that has a binding for
5535 this key sequence. In other words, the lowest i such that
5536 defs[i] is non-nil. */
5539 /* If t < mock_input, then KEYBUF[t] should be read as the next
5542 We use this to recover after recognizing a function key. Once we
5543 realize that a suffix of the current key sequence is actually a
5544 function key's escape sequence, we replace the suffix with the
5545 function key's binding from Vfunction_key_map. Now keybuf
5546 contains a new and different key sequence, so the echo area,
5547 this_command_keys, and the submaps and defs arrays are wrong. In
5548 this situation, we set mock_input to t, set t to 0, and jump to
5549 restart_sequence; the loop will read keys from keybuf up until
5550 mock_input, thus rebuilding the state; and then it will resume
5551 reading characters from the keyboard. */
5554 /* If the sequence is unbound in submaps[], then
5555 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
5556 and fkey_map is its binding.
5558 These might be > t, indicating that all function key scanning
5559 should hold off until t reaches them. We do this when we've just
5560 recognized a function key, to avoid searching for the function
5561 key's again in Vfunction_key_map. */
5562 int fkey_start
= 0, fkey_end
= 0;
5563 Lisp_Object fkey_map
;
5565 /* Likewise, for key_translation_map. */
5566 int keytran_start
= 0, keytran_end
= 0;
5567 Lisp_Object keytran_map
;
5569 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
5570 we put it off for later. While we're reading, we keep the event here. */
5571 Lisp_Object delayed_switch_frame
;
5573 /* See the comment below... */
5574 #if defined (GOBBLE_FIRST_EVENT)
5575 Lisp_Object first_event
;
5578 Lisp_Object original_uppercase
;
5579 int original_uppercase_position
= -1;
5581 /* Gets around Microsoft compiler limitations. */
5584 struct buffer
*starting_buffer
;
5586 /* Nonzero if we seem to have got the beginning of a binding
5587 in function_key_map. */
5588 int function_key_possible
= 0;
5589 int key_translation_possible
= 0;
5591 /* Save the status of key translation before each step,
5592 so that we can restore this after downcasing. */
5593 Lisp_Object prev_fkey_map
;
5594 Lisp_Object prev_fkey_start
;
5595 Lisp_Object prev_fkey_end
;
5597 Lisp_Object prev_keytran_map
;
5598 Lisp_Object prev_keytran_start
;
5599 Lisp_Object prev_keytran_end
;
5603 last_nonmenu_event
= Qnil
;
5605 delayed_switch_frame
= Qnil
;
5606 fkey_map
= Vfunction_key_map
;
5607 keytran_map
= Vkey_translation_map
;
5609 /* If there is no function-key-map, turn off function key scanning. */
5610 if (NILP (Fkeymapp (Vfunction_key_map
)))
5611 fkey_start
= fkey_end
= bufsize
+ 1;
5613 /* If there is no key-translation-map, turn off scanning. */
5614 if (NILP (Fkeymapp (Vkey_translation_map
)))
5615 keytran_start
= keytran_end
= bufsize
+ 1;
5620 echo_prompt (XSTRING (prompt
)->data
);
5621 else if (cursor_in_echo_area
&& echo_keystrokes
)
5622 /* This doesn't put in a dash if the echo buffer is empty, so
5623 you don't always see a dash hanging out in the minibuffer. */
5627 /* Record the initial state of the echo area and this_command_keys;
5628 we will need to restore them if we replay a key sequence. */
5630 echo_start
= echo_length ();
5631 keys_start
= this_command_key_count
;
5633 #if defined (GOBBLE_FIRST_EVENT)
5634 /* This doesn't quite work, because some of the things that read_char
5635 does cannot safely be bypassed. It seems too risky to try to make
5638 /* Read the first char of the sequence specially, before setting
5639 up any keymaps, in case a filter runs and switches buffers on us. */
5640 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
5642 #endif /* GOBBLE_FIRST_EVENT */
5644 orig_local_map
= get_local_map (PT
, current_buffer
);
5646 /* We jump here when the key sequence has been thoroughly changed, and
5647 we need to rescan it starting from the beginning. When we jump here,
5648 keybuf[0..mock_input] holds the sequence we should reread. */
5651 starting_buffer
= current_buffer
;
5652 function_key_possible
= 0;
5653 key_translation_possible
= 0;
5655 /* Build our list of keymaps.
5656 If we recognize a function key and replace its escape sequence in
5657 keybuf with its symbol, or if the sequence starts with a mouse
5658 click and we need to switch buffers, we jump back here to rebuild
5659 the initial keymaps from the current buffer. */
5663 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
5664 || !NILP (Voverriding_local_map
))
5666 if (3 > nmaps_allocated
)
5668 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
5669 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
5670 nmaps_allocated
= 3;
5673 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5674 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5675 if (!NILP (Voverriding_local_map
))
5676 submaps
[nmaps
++] = Voverriding_local_map
;
5680 nmaps
= current_minor_maps (0, &maps
);
5681 if (nmaps
+ 2 > nmaps_allocated
)
5683 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
5684 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
5685 nmaps_allocated
= nmaps
+ 2;
5687 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
5688 #ifdef USE_TEXT_PROPERTIES
5689 submaps
[nmaps
++] = orig_local_map
;
5691 submaps
[nmaps
++] = current_buffer
->keymap
;
5694 submaps
[nmaps
++] = current_global_map
;
5697 /* Find an accurate initial value for first_binding. */
5698 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
5699 if (! NILP (submaps
[first_binding
]))
5702 /* Start from the beginning in keybuf. */
5705 /* These are no-ops the first time through, but if we restart, they
5706 revert the echo area and this_command_keys to their original state. */
5707 this_command_key_count
= keys_start
;
5708 if (INTERACTIVE
&& t
< mock_input
)
5709 echo_truncate (echo_start
);
5711 /* If the best binding for the current key sequence is a keymap, or
5712 we may be looking at a function key's escape sequence, keep on
5714 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
5715 || (first_binding
>= nmaps
5717 /* mock input is never part of a function key's sequence. */
5718 && mock_input
<= fkey_start
)
5719 || (first_binding
>= nmaps
5720 && keytran_start
< t
&& key_translation_possible
)
5721 /* Don't return in the middle of a possible function key sequence,
5722 if the only bindings we found were via case conversion.
5723 Thus, if ESC O a has a function-key-map translation
5724 and ESC o has a binding, don't return after ESC O,
5725 so that we can translate ESC O plus the next character. */
5729 int used_mouse_menu
= 0;
5731 /* Where the last real key started. If we need to throw away a
5732 key that has expanded into more than one element of keybuf
5733 (say, a mouse click on the mode line which is being treated
5734 as [mode-line (mouse-...)], then we backtrack to this point
5736 int last_real_key_start
;
5738 /* These variables are analogous to echo_start and keys_start;
5739 while those allow us to restart the entire key sequence,
5740 echo_local_start and keys_local_start allow us to throw away
5742 int echo_local_start
, keys_local_start
, local_first_binding
;
5745 error ("Key sequence too long");
5748 echo_local_start
= echo_length ();
5749 keys_local_start
= this_command_key_count
;
5750 local_first_binding
= first_binding
;
5753 /* These are no-ops, unless we throw away a keystroke below and
5754 jumped back up to replay_key; in that case, these restore the
5755 variables to their original state, allowing us to replay the
5757 if (INTERACTIVE
&& t
< mock_input
)
5758 echo_truncate (echo_local_start
);
5759 this_command_key_count
= keys_local_start
;
5760 first_binding
= local_first_binding
;
5762 /* By default, assume each event is "real". */
5763 last_real_key_start
= t
;
5765 /* Does mock_input indicate that we are re-reading a key sequence? */
5769 add_command_key (key
);
5770 if (echo_keystrokes
)
5774 /* If not, we should actually read a character. */
5777 struct buffer
*buf
= current_buffer
;
5781 KBOARD
*interrupted_kboard
= current_kboard
;
5782 struct frame
*interrupted_frame
= selected_frame
;
5783 if (setjmp (wrong_kboard_jmpbuf
))
5785 if (!NILP (delayed_switch_frame
))
5787 interrupted_kboard
->kbd_queue
5788 = Fcons (delayed_switch_frame
,
5789 interrupted_kboard
->kbd_queue
);
5790 delayed_switch_frame
= Qnil
;
5793 interrupted_kboard
->kbd_queue
5794 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
5796 /* If the side queue is non-empty, ensure it begins with a
5797 switch-frame, so we'll replay it in the right context. */
5798 if (CONSP (interrupted_kboard
->kbd_queue
)
5799 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
5800 !(EVENT_HAS_PARAMETERS (key
)
5801 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
5805 XSETFRAME (frame
, interrupted_frame
);
5806 interrupted_kboard
->kbd_queue
5807 = Fcons (make_lispy_switch_frame (frame
),
5808 interrupted_kboard
->kbd_queue
);
5811 orig_local_map
= get_local_map (PT
, current_buffer
);
5812 goto replay_sequence
;
5815 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
5819 /* read_char returns t when it shows a menu and the user rejects it.
5824 /* read_char returns -1 at the end of a macro.
5825 Emacs 18 handles this by returning immediately with a
5826 zero, so that's what we'll do. */
5827 if (INTEGERP (key
) && XINT (key
) == -1)
5830 /* The Microsoft C compiler can't handle the goto that
5836 /* If the current buffer has been changed from under us, the
5837 keymap may have changed, so replay the sequence. */
5841 orig_local_map
= get_local_map (PT
, current_buffer
);
5842 goto replay_sequence
;
5845 /* If we have a quit that was typed in another frame, and
5846 quit_throw_to_read_char switched buffers,
5847 replay to get the right keymap. */
5848 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
5853 orig_local_map
= get_local_map (PT
, current_buffer
);
5854 goto replay_sequence
;
5860 /* Clicks in non-text areas get prefixed by the symbol
5861 in their CHAR-ADDRESS field. For example, a click on
5862 the mode line is prefixed by the symbol `mode-line'.
5864 Furthermore, key sequences beginning with mouse clicks
5865 are read using the keymaps of the buffer clicked on, not
5866 the current buffer. So we may have to switch the buffer
5869 When we turn one event into two events, we must make sure
5870 that neither of the two looks like the original--so that,
5871 if we replay the events, they won't be expanded again.
5872 If not for this, such reexpansion could happen either here
5873 or when user programs play with this-command-keys. */
5874 if (EVENT_HAS_PARAMETERS (key
))
5878 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
5879 if (EQ (kind
, Qmouse_click
))
5881 Lisp_Object window
, posn
;
5883 window
= POSN_WINDOW (EVENT_START (key
));
5884 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
5887 /* We're looking at the second event of a
5888 sequence which we expanded before. Set
5889 last_real_key_start appropriately. */
5891 last_real_key_start
= t
- 1;
5894 /* Key sequences beginning with mouse clicks are
5895 read using the keymaps in the buffer clicked on,
5896 not the current buffer. If we're at the
5897 beginning of a key sequence, switch buffers. */
5898 if (last_real_key_start
== 0
5900 && BUFFERP (XWINDOW (window
)->buffer
)
5901 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
5906 /* Arrange to go back to the original buffer once we're
5907 done reading the key sequence. Note that we can't
5908 use save_excursion_{save,restore} here, because they
5909 save point as well as the current buffer; we don't
5910 want to save point, because redisplay may change it,
5911 to accommodate a Fset_window_start or something. We
5912 don't want to do this at the top of the function,
5913 because we may get input from a subprocess which
5914 wants to change the selected window and stuff (say,
5916 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5918 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
5919 orig_local_map
= get_local_map (PT
, current_buffer
);
5920 goto replay_sequence
;
5922 /* For a mouse click, get the local text-property keymap
5923 of the place clicked on, rather than point. */
5924 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
5925 && ! localized_local_map
)
5927 Lisp_Object map_here
, start
, pos
;
5929 localized_local_map
= 1;
5930 start
= EVENT_START (key
);
5931 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
5933 pos
= POSN_BUFFER_POSN (start
);
5935 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
5937 map_here
= get_local_map (XINT (pos
), current_buffer
);
5938 if (!EQ (map_here
, orig_local_map
))
5940 orig_local_map
= map_here
;
5944 goto replay_sequence
;
5950 /* Expand mode-line and scroll-bar events into two events:
5951 use posn as a fake prefix key. */
5954 if (t
+ 1 >= bufsize
)
5955 error ("Key sequence too long");
5960 /* Zap the position in key, so we know that we've
5961 expanded it, and don't try to do so again. */
5962 POSN_BUFFER_POSN (EVENT_START (key
))
5963 = Fcons (posn
, Qnil
);
5967 else if (EQ (kind
, Qswitch_frame
))
5969 /* If we're at the beginning of a key sequence, and the caller
5970 says it's okay, go ahead and return this event. If we're
5971 in the midst of a key sequence, delay it until the end. */
5972 if (t
> 0 || !can_return_switch_frame
)
5974 delayed_switch_frame
= key
;
5978 else if (CONSP (XCONS (key
)->cdr
)
5979 && CONSP (EVENT_START (key
))
5980 && CONSP (XCONS (EVENT_START (key
))->cdr
))
5984 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
5985 /* Handle menu-bar events:
5986 insert the dummy prefix event `menu-bar'. */
5987 if (EQ (posn
, Qmenu_bar
))
5989 if (t
+ 1 >= bufsize
)
5990 error ("Key sequence too long");
5994 /* Zap the position in key, so we know that we've
5995 expanded it, and don't try to do so again. */
5996 POSN_BUFFER_POSN (EVENT_START (key
))
5997 = Fcons (posn
, Qnil
);
6000 goto replay_sequence
;
6002 else if (CONSP (posn
))
6004 /* We're looking at the second event of a
6005 sequence which we expanded before. Set
6006 last_real_key_start appropriately. */
6007 if (last_real_key_start
== t
&& t
> 0)
6008 last_real_key_start
= t
- 1;
6013 /* We have finally decided that KEY is something we might want
6015 first_binding
= (follow_key (key
,
6016 nmaps
- first_binding
,
6017 submaps
+ first_binding
,
6018 defs
+ first_binding
,
6019 submaps
+ first_binding
)
6022 /* If KEY wasn't bound, we'll try some fallbacks. */
6023 if (first_binding
>= nmaps
)
6027 head
= EVENT_HEAD (key
);
6028 if (help_char_p (head
) && t
> 0)
6030 read_key_sequence_cmd
= Vprefix_help_command
;
6032 last_nonmenu_event
= key
;
6033 /* The Microsoft C compiler can't handle the goto that
6041 Lisp_Object breakdown
;
6044 breakdown
= parse_modifiers (head
);
6045 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6046 /* Attempt to reduce an unbound mouse event to a simpler
6047 event that is bound:
6048 Drags reduce to clicks.
6049 Double-clicks reduce to clicks.
6050 Triple-clicks reduce to double-clicks, then to clicks.
6051 Down-clicks are eliminated.
6052 Double-downs reduce to downs, then are eliminated.
6053 Triple-downs reduce to double-downs, then to downs,
6054 then are eliminated. */
6055 if (modifiers
& (down_modifier
| drag_modifier
6056 | double_modifier
| triple_modifier
))
6058 while (modifiers
& (down_modifier
| drag_modifier
6059 | double_modifier
| triple_modifier
))
6061 Lisp_Object new_head
, new_click
;
6062 if (modifiers
& triple_modifier
)
6063 modifiers
^= (double_modifier
| triple_modifier
);
6064 else if (modifiers
& double_modifier
)
6065 modifiers
&= ~double_modifier
;
6066 else if (modifiers
& drag_modifier
)
6067 modifiers
&= ~drag_modifier
;
6070 /* Dispose of this `down' event by simply jumping
6071 back to replay_key, to get another event.
6073 Note that if this event came from mock input,
6074 then just jumping back to replay_key will just
6075 hand it to us again. So we have to wipe out any
6078 We could delete keybuf[t] and shift everything
6079 after that to the left by one spot, but we'd also
6080 have to fix up any variable that points into
6081 keybuf, and shifting isn't really necessary
6084 Adding prefixes for non-textual mouse clicks
6085 creates two characters of mock input, and both
6086 must be thrown away. If we're only looking at
6087 the prefix now, we can just jump back to
6088 replay_key. On the other hand, if we've already
6089 processed the prefix, and now the actual click
6090 itself is giving us trouble, then we've lost the
6091 state of the keymaps we want to backtrack to, and
6092 we need to replay the whole sequence to rebuild
6095 Beyond that, only function key expansion could
6096 create more than two keys, but that should never
6097 generate mouse events, so it's okay to zero
6098 mock_input in that case too.
6100 Isn't this just the most wonderful code ever? */
6101 if (t
== last_real_key_start
)
6108 mock_input
= last_real_key_start
;
6109 goto replay_sequence
;
6114 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6116 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6118 /* Look for a binding for this new key. follow_key
6119 promises that it didn't munge submaps the
6120 last time we called it, since key was unbound. */
6122 = (follow_key (new_click
,
6123 nmaps
- local_first_binding
,
6124 submaps
+ local_first_binding
,
6125 defs
+ local_first_binding
,
6126 submaps
+ local_first_binding
)
6127 + local_first_binding
);
6129 /* If that click is bound, go for it. */
6130 if (first_binding
< nmaps
)
6135 /* Otherwise, we'll leave key set to the drag event. */
6142 /* Normally, last_nonmenu_event gets the previous key we read.
6143 But when a mouse popup menu is being used,
6144 we don't update last_nonmenu_event; it continues to hold the mouse
6145 event that preceded the first level of menu. */
6146 if (!used_mouse_menu
)
6147 last_nonmenu_event
= key
;
6149 prev_fkey_map
= fkey_map
;
6150 prev_fkey_start
= fkey_start
;
6151 prev_fkey_end
= fkey_end
;
6153 prev_keytran_map
= keytran_map
;
6154 prev_keytran_start
= keytran_start
;
6155 prev_keytran_end
= keytran_end
;
6157 /* If the sequence is unbound, see if we can hang a function key
6158 off the end of it. We only want to scan real keyboard input
6159 for function key sequences, so if mock_input says that we're
6160 re-reading old events, don't examine it. */
6161 if (first_binding
>= nmaps
6164 Lisp_Object fkey_next
;
6166 /* Continue scan from fkey_end until we find a bound suffix.
6167 If we fail, increment fkey_start
6168 and start fkey_end from there. */
6169 while (fkey_end
< t
)
6173 key
= keybuf
[fkey_end
++];
6174 /* Look up meta-characters by prefixing them
6175 with meta_prefix_char. I hate this. */
6176 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6181 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
6183 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6186 fkey_next
= fkey_map
;
6189 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
6191 #if 0 /* I didn't turn this on, because it might cause trouble
6192 for the mapping of return into C-m and tab into C-i. */
6193 /* Optionally don't map function keys into other things.
6194 This enables the user to redefine kp- keys easily. */
6195 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6199 /* If the function key map gives a function, not an
6200 array, then call the function with no args and use
6201 its value instead. */
6202 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6205 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6209 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6210 fkey_next
= call1 (fkey_next
, prompt
);
6212 /* If the function returned something invalid,
6213 barf--don't ignore it.
6214 (To ignore it safely, we would need to gcpro a bunch of
6215 other variables.) */
6216 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6217 error ("Function in function-key-map returns invalid key sequence");
6220 function_key_possible
= ! NILP (fkey_next
);
6222 /* If keybuf[fkey_start..fkey_end] is bound in the
6223 function key map and it's a suffix of the current
6224 sequence (i.e. fkey_end == t), replace it with
6225 the binding and restart with fkey_start at the end. */
6226 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6229 int len
= XFASTINT (Flength (fkey_next
));
6231 t
= fkey_start
+ len
;
6233 error ("Key sequence too long");
6235 if (VECTORP (fkey_next
))
6236 bcopy (XVECTOR (fkey_next
)->contents
,
6237 keybuf
+ fkey_start
,
6238 (t
- fkey_start
) * sizeof (keybuf
[0]));
6239 else if (STRINGP (fkey_next
))
6243 for (i
= 0; i
< len
; i
++)
6244 XSETFASTINT (keybuf
[fkey_start
+ i
],
6245 XSTRING (fkey_next
)->data
[i
]);
6249 fkey_start
= fkey_end
= t
;
6250 fkey_map
= Vfunction_key_map
;
6252 /* Do pass the results through key-translation-map. */
6253 keytran_start
= keytran_end
= 0;
6254 keytran_map
= Vkey_translation_map
;
6256 goto replay_sequence
;
6259 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6261 /* If we no longer have a bound suffix, try a new positions for
6263 if (NILP (fkey_map
))
6265 fkey_end
= ++fkey_start
;
6266 fkey_map
= Vfunction_key_map
;
6267 function_key_possible
= 0;
6272 /* Look for this sequence in key-translation-map. */
6274 Lisp_Object keytran_next
;
6276 /* Scan from keytran_end until we find a bound suffix. */
6277 while (keytran_end
< t
)
6281 key
= keybuf
[keytran_end
++];
6282 /* Look up meta-characters by prefixing them
6283 with meta_prefix_char. I hate this. */
6284 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6289 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
6291 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6294 keytran_next
= keytran_map
;
6297 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
6299 /* If the key translation map gives a function, not an
6300 array, then call the function with no args and use
6301 its value instead. */
6302 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6303 && keytran_end
== t
)
6305 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6309 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6310 keytran_next
= call1 (keytran_next
, prompt
);
6312 /* If the function returned something invalid,
6313 barf--don't ignore it.
6314 (To ignore it safely, we would need to gcpro a bunch of
6315 other variables.) */
6316 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6317 error ("Function in key-translation-map returns invalid key sequence");
6320 key_translation_possible
= ! NILP (keytran_next
);
6322 /* If keybuf[keytran_start..keytran_end] is bound in the
6323 key translation map and it's a suffix of the current
6324 sequence (i.e. keytran_end == t), replace it with
6325 the binding and restart with keytran_start at the end. */
6326 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6327 && keytran_end
== t
)
6329 int len
= XFASTINT (Flength (keytran_next
));
6331 t
= keytran_start
+ len
;
6333 error ("Key sequence too long");
6335 if (VECTORP (keytran_next
))
6336 bcopy (XVECTOR (keytran_next
)->contents
,
6337 keybuf
+ keytran_start
,
6338 (t
- keytran_start
) * sizeof (keybuf
[0]));
6339 else if (STRINGP (keytran_next
))
6343 for (i
= 0; i
< len
; i
++)
6344 XSETFASTINT (keybuf
[keytran_start
+ i
],
6345 XSTRING (keytran_next
)->data
[i
]);
6349 keytran_start
= keytran_end
= t
;
6350 keytran_map
= Vkey_translation_map
;
6352 /* Don't pass the results of key-translation-map
6353 through function-key-map. */
6354 fkey_start
= fkey_end
= t
;
6355 fkey_map
= Vkey_translation_map
;
6357 goto replay_sequence
;
6360 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6362 /* If we no longer have a bound suffix, try a new positions for
6364 if (NILP (keytran_map
))
6366 keytran_end
= ++keytran_start
;
6367 keytran_map
= Vkey_translation_map
;
6368 key_translation_possible
= 0;
6373 /* If KEY is not defined in any of the keymaps,
6374 and cannot be part of a function key or translation,
6375 and is an upper case letter
6376 use the corresponding lower-case letter instead. */
6377 if (first_binding
== nmaps
&& ! function_key_possible
6378 && ! key_translation_possible
6380 && ((((XINT (key
) & 0x3ffff)
6381 < XSTRING (current_buffer
->downcase_table
)->size
)
6382 && UPPERCASEP (XINT (key
) & 0x3ffff))
6383 || (XINT (key
) & shift_modifier
)))
6385 Lisp_Object new_key
;
6387 original_uppercase
= key
;
6388 original_uppercase_position
= t
- 1;
6390 if (XINT (new_key
) & shift_modifier
)
6391 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6393 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6394 | (XINT (key
) & ~0x3ffff)));
6396 /* We have to do this unconditionally, regardless of whether
6397 the lower-case char is defined in the keymaps, because they
6398 might get translated through function-key-map. */
6399 keybuf
[t
- 1] = new_key
;
6402 fkey_map
= prev_fkey_map
;
6403 fkey_start
= prev_fkey_start
;
6404 fkey_end
= prev_fkey_end
;
6406 keytran_map
= prev_keytran_map
;
6407 keytran_start
= prev_keytran_start
;
6408 keytran_end
= prev_keytran_end
;
6410 goto replay_sequence
;
6412 /* If KEY is not defined in any of the keymaps,
6413 and cannot be part of a function key or translation,
6414 and is a shifted function key,
6415 use the corresponding unshifted function key instead. */
6416 if (first_binding
== nmaps
&& ! function_key_possible
6417 && ! key_translation_possible
6420 Lisp_Object breakdown
;
6423 breakdown
= parse_modifiers (key
);
6424 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6425 if (modifiers
& shift_modifier
)
6427 Lisp_Object new_key
;
6429 original_uppercase
= key
;
6430 original_uppercase_position
= t
- 1;
6432 modifiers
&= ~shift_modifier
;
6433 new_key
= apply_modifiers (modifiers
,
6434 XCONS (breakdown
)->car
);
6436 keybuf
[t
- 1] = new_key
;
6439 fkey_map
= prev_fkey_map
;
6440 fkey_start
= prev_fkey_start
;
6441 fkey_end
= prev_fkey_end
;
6443 keytran_map
= prev_keytran_map
;
6444 keytran_start
= prev_keytran_start
;
6445 keytran_end
= prev_keytran_end
;
6447 goto replay_sequence
;
6453 read_key_sequence_cmd
= (first_binding
< nmaps
6454 ? defs
[first_binding
]
6457 unread_switch_frame
= delayed_switch_frame
;
6458 unbind_to (count
, Qnil
);
6460 /* Don't downcase the last character if the caller says don't.
6461 Don't downcase it if the result is undefined, either. */
6462 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6463 && t
- 1 == original_uppercase_position
)
6464 keybuf
[t
- 1] = original_uppercase
;
6466 /* Occasionally we fabricate events, perhaps by expanding something
6467 according to function-key-map, or by adding a prefix symbol to a
6468 mouse click in the scroll bar or modeline. In this cases, return
6469 the entire generated key sequence, even if we hit an unbound
6470 prefix or a definition before the end. This means that you will
6471 be able to push back the event properly, and also means that
6472 read-key-sequence will always return a logical unit.
6475 for (; t
< mock_input
; t
++)
6477 if (echo_keystrokes
)
6478 echo_char (keybuf
[t
]);
6479 add_command_key (keybuf
[t
]);
6485 #if 0 /* This doc string is too long for some compilers.
6486 This commented-out definition serves for DOC. */
6487 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6488 "Read a sequence of keystrokes and return as a string or vector.\n\
6489 The sequence is sufficient to specify a non-prefix command in the\n\
6490 current local and global maps.\n\
6492 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6493 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6494 as a continuation of the previous key.\n\
6496 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6497 convert the last event to lower case. (Normally any upper case event\n\
6498 is converted to lower case if the original event is undefined and the lower\n\
6499 case equivalent is defined.) A non-nil value is appropriate for reading\n\
6500 a key sequence to be defined.\n\
6502 A C-g typed while in this function is treated like any other character,\n\
6503 and `quit-flag' is not set.\n\
6505 If the key sequence starts with a mouse click, then the sequence is read\n\
6506 using the keymaps of the buffer of the window clicked in, not the buffer\n\
6507 of the selected window as normal.\n\
6509 `read-key-sequence' drops unbound button-down events, since you normally\n\
6510 only care about the click or drag events which follow them. If a drag\n\
6511 or multi-click event is unbound, but the corresponding click event would\n\
6512 be bound, `read-key-sequence' turns the event into a click event at the\n\
6513 drag's starting position. This means that you don't have to distinguish\n\
6514 between click and drag, double, or triple events unless you want to.\n\
6516 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
6517 lines separating windows, and scroll bars with imaginary keys\n\
6518 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
6520 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
6521 function will process a switch-frame event if the user switches frames\n\
6522 before typing anything. If the user switches frames in the middle of a\n\
6523 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
6524 is nil, then the event will be put off until after the current key sequence.\n\
6526 `read-key-sequence' checks `function-key-map' for function key\n\
6527 sequences, where they wouldn't conflict with ordinary bindings. See\n\
6528 `function-key-map' for more details.")
6529 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6532 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6534 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6535 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
6536 Lisp_Object can_return_switch_frame
;
6538 Lisp_Object keybuf
[30];
6540 struct gcpro gcpro1
, gcpro2
;
6543 CHECK_STRING (prompt
, 0);
6546 bzero (keybuf
, sizeof keybuf
);
6548 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
6550 if (NILP (continue_echo
))
6551 this_command_key_count
= 0;
6553 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
6554 prompt
, ! NILP (dont_downcase_last
),
6555 ! NILP (can_return_switch_frame
));
6563 return make_event_array (i
, keybuf
);
6566 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 3, 0,
6567 "Execute CMD as an editor command.\n\
6568 CMD must be a symbol that satisfies the `commandp' predicate.\n\
6569 Optional second arg RECORD-FLAG non-nil\n\
6570 means unconditionally put this command in `command-history'.\n\
6571 Otherwise, that is done only if an arg is read using the minibuffer.\n\
6572 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
6573 when reading the arguments; if it is nil, (this_command_key_count) is used.")
6574 (cmd
, record_flag
, keys
)
6575 Lisp_Object cmd
, record_flag
, keys
;
6577 register Lisp_Object final
;
6578 register Lisp_Object tem
;
6579 Lisp_Object prefixarg
;
6580 struct backtrace backtrace
;
6581 extern int debug_on_next_call
;
6583 prefixarg
= current_kboard
->Vprefix_arg
;
6584 current_kboard
->Vprefix_arg
= Qnil
;
6585 Vcurrent_prefix_arg
= prefixarg
;
6586 debug_on_next_call
= 0;
6590 tem
= Fget (cmd
, Qdisabled
);
6591 if (!NILP (tem
) && !NILP (Vrun_hooks
))
6593 tem
= Fsymbol_value (Qdisabled_command_hook
);
6595 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
6601 final
= Findirect_function (cmd
);
6603 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
6604 do_autoload (final
, cmd
);
6609 if (STRINGP (final
) || VECTORP (final
))
6611 /* If requested, place the macro in the command history. For
6612 other sorts of commands, call-interactively takes care of
6614 if (!NILP (record_flag
))
6616 = Fcons (Fcons (Qexecute_kbd_macro
,
6617 Fcons (final
, Fcons (prefixarg
, Qnil
))),
6620 return Fexecute_kbd_macro (final
, prefixarg
);
6622 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
6624 backtrace
.next
= backtrace_list
;
6625 backtrace_list
= &backtrace
;
6626 backtrace
.function
= &Qcall_interactively
;
6627 backtrace
.args
= &cmd
;
6628 backtrace
.nargs
= 1;
6629 backtrace
.evalargs
= 0;
6631 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
6633 backtrace_list
= backtrace
.next
;
6639 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
6641 "Read function name, then read its arguments and call it.")
6643 Lisp_Object prefixarg
;
6645 Lisp_Object function
;
6647 Lisp_Object saved_keys
;
6648 struct gcpro gcpro1
;
6650 saved_keys
= Fvector (this_command_key_count
,
6651 XVECTOR (this_command_keys
)->contents
);
6653 GCPRO1 (saved_keys
);
6655 if (EQ (prefixarg
, Qminus
))
6657 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
6658 strcpy (buf
, "C-u ");
6659 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
6661 if (sizeof (int) == sizeof (EMACS_INT
))
6662 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
6663 else if (sizeof (long) == sizeof (EMACS_INT
))
6664 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
6668 else if (INTEGERP (prefixarg
))
6670 if (sizeof (int) == sizeof (EMACS_INT
))
6671 sprintf (buf
, "%d ", XINT (prefixarg
));
6672 else if (sizeof (long) == sizeof (EMACS_INT
))
6673 sprintf (buf
, "%ld ", XINT (prefixarg
));
6678 /* This isn't strictly correct if execute-extended-command
6679 is bound to anything else. Perhaps it should use
6680 this_command_keys? */
6681 strcat (buf
, "M-x ");
6683 /* Prompt with buf, and then read a string, completing from and
6684 restricting to the set of all defined commands. Don't provide
6685 any initial input. Save the command read on the extended-command
6687 function
= Fcompleting_read (build_string (buf
),
6688 Vobarray
, Qcommandp
,
6689 Qt
, Qnil
, Qextended_command_history
);
6691 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
6692 error ("No command name given");
6694 /* Set this_command_keys to the concatenation of saved_keys and
6695 function, followed by a RET. */
6697 struct Lisp_String
*str
;
6702 this_command_key_count
= 0;
6704 keys
= XVECTOR (saved_keys
)->contents
;
6705 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
6706 add_command_key (keys
[i
]);
6708 str
= XSTRING (function
);
6709 for (i
= 0; i
< str
->size
; i
++)
6711 XSETFASTINT (tem
, str
->data
[i
]);
6712 add_command_key (tem
);
6715 XSETFASTINT (tem
, '\015');
6716 add_command_key (tem
);
6721 function
= Fintern (function
, Qnil
);
6722 current_kboard
->Vprefix_arg
= prefixarg
;
6723 this_command
= function
;
6725 /* If enabled, show which key runs this command. */
6726 if (!NILP (Vsuggest_key_bindings
)
6727 && SYMBOLP (function
))
6729 Lisp_Object bindings
;
6731 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
6734 if (!NILP (bindings
))
6736 message ("You can run the command `%s' by typing %s",
6737 XSYMBOL (function
)->name
->data
,
6738 XSTRING (Fkey_description (bindings
))->data
);
6739 Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
6740 ? Vsuggest_key_bindings
: make_number (2)),
6745 return Fcommand_execute (function
, Qt
, Qnil
);
6748 /* Find the set of keymaps now active.
6749 Store into *MAPS_P a vector holding the various maps
6750 and return the number of them. The vector was malloc'd
6751 and the caller should free it. */
6754 current_active_maps (maps_p
)
6755 Lisp_Object
**maps_p
;
6757 Lisp_Object
*tmaps
, *maps
;
6760 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6761 if (!NILP (Voverriding_local_map_menu_flag
))
6763 /* Yes, use them (if non-nil) as well as the global map. */
6764 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
6766 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6767 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6768 if (!NILP (Voverriding_local_map
))
6769 maps
[nmaps
++] = Voverriding_local_map
;
6773 /* No, so use major and minor mode keymaps. */
6774 nmaps
= current_minor_maps (NULL
, &tmaps
);
6775 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
6776 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
6777 #ifdef USE_TEXT_PROPERTIES
6778 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
6780 maps
[nmaps
++] = current_buffer
->keymap
;
6783 maps
[nmaps
++] = current_global_map
;
6790 detect_input_pending ()
6793 get_input_pending (&input_pending
);
6795 return input_pending
;
6798 /* This is called in some cases before a possible quit.
6799 It cases the next call to detect_input_pending to recompute input_pending.
6800 So calling this function unnecessarily can't do any harm. */
6801 clear_input_pending ()
6806 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
6807 "T if command input is currently available with no waiting.\n\
6808 Actually, the value is nil only if we can be sure that no input is available.")
6811 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
6814 return detect_input_pending () ? Qt
: Qnil
;
6817 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
6818 "Return vector of last 100 events, not counting those from keyboard macros.")
6821 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
6824 if (total_keys
< NUM_RECENT_KEYS
)
6825 return Fvector (total_keys
, keys
);
6828 val
= Fvector (NUM_RECENT_KEYS
, keys
);
6829 bcopy (keys
+ recent_keys_index
,
6830 XVECTOR (val
)->contents
,
6831 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
6833 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
6834 recent_keys_index
* sizeof (Lisp_Object
));
6839 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
6840 "Return the key sequence that invoked this command.\n\
6841 The value is a string or a vector.")
6844 return make_event_array (this_command_key_count
,
6845 XVECTOR (this_command_keys
)->contents
);
6848 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
6849 Sreset_this_command_lengths
, 0, 0, 0,
6850 "Used for complicated reasons in `universal-argument-other-key'.\n\
6852 `universal-argument-other-key' rereads the event just typed.\n\
6853 It then gets translated through `function-key-map'.\n\
6854 The translated event gets included in the echo area and in\n\
6855 the value of `this-command-keys' in addition to the raw original event.\n\
6856 That is not right.\n\
6858 Calling this function directs the translated event to replace\n\
6859 the original event, so that only one version of the event actually\n\
6860 appears in the echo area and in the value of `this-command-keys.'.")
6863 before_command_restore_flag
= 1;
6864 before_command_key_count_1
= before_command_key_count
;
6865 before_command_echo_length_1
= before_command_echo_length
;
6868 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
6869 "Return the current depth in recursive edits.")
6873 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
6877 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
6878 "FOpen dribble file: ",
6879 "Start writing all keyboard characters to a dribble file called FILE.\n\
6880 If FILE is nil, close any open dribble file.")
6891 file
= Fexpand_file_name (file
, Qnil
);
6892 dribble
= fopen (XSTRING (file
)->data
, "w");
6894 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
6899 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
6900 "Discard the contents of the terminal input buffer.\n\
6901 Also cancel any kbd macro being defined.")
6904 current_kboard
->defining_kbd_macro
= Qnil
;
6905 update_mode_lines
++;
6907 Vunread_command_events
= Qnil
;
6908 unread_command_char
= -1;
6910 discard_tty_input ();
6912 /* Without the cast, GCC complains that this assignment loses the
6913 volatile qualifier of kbd_store_ptr. Is there anything wrong
6915 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
6916 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
6922 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
6923 "Stop Emacs and return to superior process. You can resume later.\n\
6924 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
6925 control, run a subshell instead.\n\n\
6926 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
6927 to be read as terminal input by Emacs's parent, after suspension.\n\
6929 Before suspending, run the normal hook `suspend-hook'.\n\
6930 After resumption run the normal hook `suspend-resume-hook'.\n\
6932 Some operating systems cannot stop the Emacs process and resume it later.\n\
6933 On such systems, Emacs starts a subshell instead of suspending.")
6935 Lisp_Object stuffstring
;
6938 int count
= specpdl_ptr
- specpdl
;
6939 int old_height
, old_width
;
6941 struct gcpro gcpro1
, gcpro2
;
6942 extern init_sys_modes ();
6944 if (!NILP (stuffstring
))
6945 CHECK_STRING (stuffstring
, 0);
6947 /* Run the functions in suspend-hook. */
6948 if (!NILP (Vrun_hooks
))
6949 call1 (Vrun_hooks
, intern ("suspend-hook"));
6951 GCPRO1 (stuffstring
);
6952 get_frame_size (&old_width
, &old_height
);
6954 /* sys_suspend can get an error if it tries to fork a subshell
6955 and the system resources aren't available for that. */
6956 record_unwind_protect (init_sys_modes
, 0);
6957 stuff_buffered_input (stuffstring
);
6962 unbind_to (count
, Qnil
);
6964 /* Check if terminal/window size has changed.
6965 Note that this is not useful when we are running directly
6966 with a window system; but suspend should be disabled in that case. */
6967 get_frame_size (&width
, &height
);
6968 if (width
!= old_width
|| height
!= old_height
)
6969 change_frame_size (selected_frame
, height
, width
, 0, 0);
6971 /* Run suspend-resume-hook. */
6972 if (!NILP (Vrun_hooks
))
6973 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
6979 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
6980 Then in any case stuff anything Emacs has read ahead and not used. */
6982 stuff_buffered_input (stuffstring
)
6983 Lisp_Object stuffstring
;
6985 /* stuff_char works only in BSD, versions 4.2 and up. */
6988 register unsigned char *p
;
6990 if (STRINGP (stuffstring
))
6994 p
= XSTRING (stuffstring
)->data
;
6995 count
= XSTRING (stuffstring
)->size
;
7000 /* Anything we have read ahead, put back for the shell to read. */
7001 /* ?? What should this do when we have multiple keyboards??
7002 Should we ignore anything that was typed in at the "wrong" kboard? */
7003 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7005 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7006 kbd_fetch_ptr
= kbd_buffer
;
7007 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7008 stuff_char (kbd_fetch_ptr
->code
);
7009 kbd_fetch_ptr
->kind
= no_event
;
7010 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7016 #endif /* BSD and not BSD4_1 */
7019 set_waiting_for_input (time_to_clear
)
7020 EMACS_TIME
*time_to_clear
;
7022 input_available_clear_time
= time_to_clear
;
7024 /* Tell interrupt_signal to throw back to read_char, */
7025 waiting_for_input
= 1;
7027 /* If interrupt_signal was called before and buffered a C-g,
7028 make it run again now, to avoid timing error. */
7029 if (!NILP (Vquit_flag
))
7030 quit_throw_to_read_char ();
7033 clear_waiting_for_input ()
7035 /* Tell interrupt_signal not to throw back to read_char, */
7036 waiting_for_input
= 0;
7037 input_available_clear_time
= 0;
7040 /* This routine is called at interrupt level in response to C-G.
7041 If interrupt_input, this is the handler for SIGINT.
7042 Otherwise, it is called from kbd_buffer_store_event,
7043 in handling SIGIO or SIGTINT.
7045 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7046 immediately throw back to read_char.
7048 Otherwise it sets the Lisp variable quit-flag not-nil.
7049 This causes eval to throw, when it gets a chance.
7050 If quit-flag is already non-nil, it stops the job right away. */
7053 interrupt_signal (signalnum
) /* If we don't have an argument, */
7054 int signalnum
; /* some compilers complain in signal calls. */
7057 /* Must preserve main program's value of errno. */
7058 int old_errno
= errno
;
7061 if (!read_socket_hook
&& NILP (Vwindow_system
))
7063 /* USG systems forget handlers when they are used;
7064 must reestablish each time */
7065 signal (SIGINT
, interrupt_signal
);
7066 signal (SIGQUIT
, interrupt_signal
);
7072 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
7077 #ifdef SIGTSTP /* Support possible in later USG versions */
7079 * On systems which can suspend the current process and return to the original
7080 * shell, this command causes the user to end up back at the shell.
7081 * The "Auto-save" and "Abort" questions are not asked until
7082 * the user elects to return to emacs, at which point he can save the current
7083 * job and either dump core or continue.
7088 if (sys_suspend () == -1)
7090 printf ("Not running as a subprocess;\n");
7091 printf ("you can continue or abort.\n");
7094 /* Perhaps should really fork an inferior shell?
7095 But that would not provide any way to get back
7096 to the original shell, ever. */
7097 printf ("No support for stopping a process on this operating system;\n");
7098 printf ("you can continue or abort.\n");
7099 #endif /* not VMS */
7100 #endif /* not SIGTSTP */
7102 /* We must remain inside the screen area when the internal terminal
7103 is used. Note that [Enter] is not echoed by dos. */
7106 /* It doesn't work to autosave while GC is in progress;
7107 the code used for auto-saving doesn't cope with the mark bit. */
7108 if (!gc_in_progress
)
7110 printf ("Auto-save? (y or n) ");
7112 if (((c
= getchar ()) & ~040) == 'Y')
7114 Fdo_auto_save (Qt
, Qnil
);
7116 printf ("\r\nAuto-save done");
7117 #else /* not MSDOS */
7118 printf ("Auto-save done\n");
7119 #endif /* not MSDOS */
7121 while (c
!= '\n') c
= getchar ();
7125 /* During GC, it must be safe to reenable quitting again. */
7126 Vinhibit_quit
= Qnil
;
7129 #endif /* not MSDOS */
7130 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7131 printf ("but will instead do a real quit after garbage collection ends\r\n");
7136 printf ("\r\nAbort? (y or n) ");
7137 #else /* not MSDOS */
7139 printf ("Abort (and enter debugger)? (y or n) ");
7141 printf ("Abort (and dump core)? (y or n) ");
7142 #endif /* not VMS */
7143 #endif /* not MSDOS */
7145 if (((c
= getchar ()) & ~040) == 'Y')
7147 while (c
!= '\n') c
= getchar ();
7149 printf ("\r\nContinuing...\r\n");
7150 #else /* not MSDOS */
7151 printf ("Continuing...\n");
7152 #endif /* not MSDOS */
7158 /* If executing a function that wants to be interrupted out of
7159 and the user has not deferred quitting by binding `inhibit-quit'
7160 then quit right away. */
7161 if (immediate_quit
&& NILP (Vinhibit_quit
))
7165 Fsignal (Qquit
, Qnil
);
7168 /* Else request quit when it's safe */
7172 if (waiting_for_input
&& !echoing
)
7173 quit_throw_to_read_char ();
7178 /* Handle a C-g by making read_char return C-g. */
7180 quit_throw_to_read_char ()
7182 quit_error_check ();
7184 /* Prevent another signal from doing this before we finish. */
7185 clear_waiting_for_input ();
7188 Vunread_command_events
= Qnil
;
7189 unread_command_char
= -1;
7191 #if 0 /* Currently, sit_for is called from read_char without turning
7192 off polling. And that can call set_waiting_for_input.
7193 It seems to be harmless. */
7194 #ifdef POLL_FOR_INPUT
7195 /* May be > 1 if in recursive minibuffer. */
7196 if (poll_suppress_count
== 0)
7201 if (FRAMEP (internal_last_event_frame
)
7202 && XFRAME (internal_last_event_frame
) != selected_frame
)
7203 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7207 _longjmp (getcjmp
, 1);
7210 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7211 "Set mode of reading keyboard input.\n\
7212 First arg INTERRUPT non-nil means use input interrupts;\n\
7213 nil means use CBREAK mode.\n\
7214 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7215 (no effect except in CBREAK mode).\n\
7216 Third arg META t means accept 8-bit input (for a Meta key).\n\
7217 META nil means ignore the top bit, on the assumption it is parity.\n\
7218 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7219 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7220 See also `current-input-mode'.")
7221 (interrupt
, flow
, meta
, quit
)
7222 Lisp_Object interrupt
, flow
, meta
, quit
;
7225 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7226 error ("set-input-mode: QUIT must be an ASCII character");
7228 #ifdef POLL_FOR_INPUT
7233 /* this causes startup screen to be restored and messes with the mouse */
7238 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7239 if (read_socket_hook
)
7241 /* When using X, don't give the user a real choice,
7242 because we haven't implemented the mechanisms to support it. */
7243 #ifdef NO_SOCK_SIGIO
7244 interrupt_input
= 0;
7245 #else /* not NO_SOCK_SIGIO */
7246 interrupt_input
= 1;
7247 #endif /* NO_SOCK_SIGIO */
7250 interrupt_input
= !NILP (interrupt
);
7251 #else /* not SIGIO */
7252 interrupt_input
= 0;
7253 #endif /* not SIGIO */
7255 /* Our VMS input only works by interrupts, as of now. */
7257 interrupt_input
= 1;
7260 flow_control
= !NILP (flow
);
7263 else if (EQ (meta
, Qt
))
7268 /* Don't let this value be out of range. */
7269 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7275 #ifdef POLL_FOR_INPUT
7276 poll_suppress_count
= 1;
7282 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7283 "Return information about the way Emacs currently reads keyboard input.\n\
7284 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7285 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7286 nil, Emacs is using CBREAK mode.\n\
7287 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7288 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7289 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7290 META nil means ignoring the top bit, on the assumption it is parity.\n\
7291 META is neither t nor nil if accepting 8-bit input and using\n\
7292 all 8 bits as the character code.\n\
7293 QUIT is the character Emacs currently uses to quit.\n\
7294 The elements of this list correspond to the arguments of\n\
7300 val
[0] = interrupt_input
? Qt
: Qnil
;
7301 val
[1] = flow_control
? Qt
: Qnil
;
7302 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7303 XSETFASTINT (val
[3], quit_char
);
7305 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7310 * Set up a new kboard object with reasonable initial values.
7316 kb
->Voverriding_terminal_local_map
= Qnil
;
7317 kb
->Vlast_command
= Qnil
;
7318 kb
->Vprefix_arg
= Qnil
;
7319 kb
->kbd_queue
= Qnil
;
7320 kb
->kbd_queue_has_data
= 0;
7321 kb
->immediate_echo
= 0;
7322 kb
->echoptr
= kb
->echobuf
;
7323 kb
->echo_after_prompt
= -1;
7324 kb
->kbd_macro_buffer
= 0;
7325 kb
->kbd_macro_bufsize
= 0;
7326 kb
->defining_kbd_macro
= Qnil
;
7327 kb
->Vlast_kbd_macro
= Qnil
;
7328 kb
->reference_count
= 0;
7329 kb
->Vsystem_key_alist
= Qnil
;
7330 kb
->system_key_syms
= Qnil
;
7331 kb
->Vdefault_minibuffer_frame
= Qnil
;
7335 * Destroy the contents of a kboard object, but not the object itself.
7336 * We use this just before deleting it, or if we're going to initialize
7343 if (kb
->kbd_macro_buffer
)
7344 xfree (kb
->kbd_macro_buffer
);
7353 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7356 *kbp
= kb
->next_kboard
;
7364 /* This is correct before outermost invocation of the editor loop */
7365 command_loop_level
= -1;
7367 quit_char
= Ctl ('g');
7368 Vunread_command_events
= Qnil
;
7369 unread_command_char
= -1;
7371 recent_keys_index
= 0;
7372 kbd_fetch_ptr
= kbd_buffer
;
7373 kbd_store_ptr
= kbd_buffer
;
7374 kbd_buffer_frame_or_window
7375 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7377 do_mouse_tracking
= Qnil
;
7382 /* This means that command_loop_1 won't try to select anything the first
7384 internal_last_event_frame
= Qnil
;
7385 Vlast_event_frame
= internal_last_event_frame
;
7389 current_kboard
= initial_kboard
;
7391 wipe_kboard (current_kboard
);
7392 init_kboard (current_kboard
);
7395 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7397 kbd_buffer_frame_or_window
7398 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7399 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
7401 signal (SIGINT
, interrupt_signal
);
7402 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
7403 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7404 SIGQUIT and we can't tell which one it will give us. */
7405 signal (SIGQUIT
, interrupt_signal
);
7406 #endif /* HAVE_TERMIO */
7408 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7410 if (!noninteractive
)
7411 signal (SIGIO
, input_available_signal
);
7414 /* Use interrupt input by default, if it works and noninterrupt input
7415 has deficiencies. */
7417 #ifdef INTERRUPT_INPUT
7418 interrupt_input
= 1;
7420 interrupt_input
= 0;
7423 /* Our VMS input only works by interrupts, as of now. */
7425 interrupt_input
= 1;
7431 if (keyboard_init_hook
)
7432 (*keyboard_init_hook
) ();
7434 #ifdef POLL_FOR_INPUT
7435 poll_suppress_count
= 1;
7440 /* This type's only use is in syms_of_keyboard, to initialize the
7441 event header symbols and put properties on them. */
7448 struct event_head head_table
[] = {
7449 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
7450 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
7451 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
7452 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
7453 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
7454 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
7459 Qdisabled_command_hook
= intern ("disabled-command-hook");
7460 staticpro (&Qdisabled_command_hook
);
7462 Qself_insert_command
= intern ("self-insert-command");
7463 staticpro (&Qself_insert_command
);
7465 Qforward_char
= intern ("forward-char");
7466 staticpro (&Qforward_char
);
7468 Qbackward_char
= intern ("backward-char");
7469 staticpro (&Qbackward_char
);
7471 Qdisabled
= intern ("disabled");
7472 staticpro (&Qdisabled
);
7474 Qundefined
= intern ("undefined");
7475 staticpro (&Qundefined
);
7477 Qpre_command_hook
= intern ("pre-command-hook");
7478 staticpro (&Qpre_command_hook
);
7480 Qpost_command_hook
= intern ("post-command-hook");
7481 staticpro (&Qpost_command_hook
);
7483 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
7484 staticpro (&Qpost_command_idle_hook
);
7486 Qdeferred_action_function
= intern ("deferred-action-function");
7487 staticpro (&Qdeferred_action_function
);
7489 Qcommand_hook_internal
= intern ("command-hook-internal");
7490 staticpro (&Qcommand_hook_internal
);
7492 Qfunction_key
= intern ("function-key");
7493 staticpro (&Qfunction_key
);
7494 Qmouse_click
= intern ("mouse-click");
7495 staticpro (&Qmouse_click
);
7496 Qtimer_event
= intern ("timer-event");
7497 staticpro (&Qtimer_event
);
7499 Qmenu_enable
= intern ("menu-enable");
7500 staticpro (&Qmenu_enable
);
7502 Qmode_line
= intern ("mode-line");
7503 staticpro (&Qmode_line
);
7504 Qvertical_line
= intern ("vertical-line");
7505 staticpro (&Qvertical_line
);
7506 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
7507 staticpro (&Qvertical_scroll_bar
);
7508 Qmenu_bar
= intern ("menu-bar");
7509 staticpro (&Qmenu_bar
);
7511 Qabove_handle
= intern ("above-handle");
7512 staticpro (&Qabove_handle
);
7513 Qhandle
= intern ("handle");
7514 staticpro (&Qhandle
);
7515 Qbelow_handle
= intern ("below-handle");
7516 staticpro (&Qbelow_handle
);
7518 Qevent_kind
= intern ("event-kind");
7519 staticpro (&Qevent_kind
);
7520 Qevent_symbol_elements
= intern ("event-symbol-elements");
7521 staticpro (&Qevent_symbol_elements
);
7522 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
7523 staticpro (&Qevent_symbol_element_mask
);
7524 Qmodifier_cache
= intern ("modifier-cache");
7525 staticpro (&Qmodifier_cache
);
7527 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
7528 staticpro (&Qrecompute_lucid_menubar
);
7529 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
7530 staticpro (&Qactivate_menubar_hook
);
7532 Qpolling_period
= intern ("polling-period");
7533 staticpro (&Qpolling_period
);
7536 struct event_head
*p
;
7538 for (p
= head_table
;
7539 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
7542 *p
->var
= intern (p
->name
);
7544 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
7545 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
7549 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
7550 staticpro (&button_down_location
);
7554 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
7556 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
7557 for (i
= 0; i
< len
; i
++)
7558 if (modifier_names
[i
])
7559 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
7560 staticpro (&modifier_symbols
);
7563 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
7564 staticpro (&recent_keys
);
7566 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
7567 staticpro (&this_command_keys
);
7569 Qextended_command_history
= intern ("extended-command-history");
7570 Fset (Qextended_command_history
, Qnil
);
7571 staticpro (&Qextended_command_history
);
7573 kbd_buffer_frame_or_window
7574 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7575 staticpro (&kbd_buffer_frame_or_window
);
7577 accent_key_syms
= Qnil
;
7578 staticpro (&accent_key_syms
);
7580 func_key_syms
= Qnil
;
7581 staticpro (&func_key_syms
);
7584 staticpro (&mouse_syms
);
7586 unread_switch_frame
= Qnil
;
7587 staticpro (&unread_switch_frame
);
7589 defsubr (&Sevent_convert_list
);
7590 defsubr (&Sread_key_sequence
);
7591 defsubr (&Srecursive_edit
);
7593 defsubr (&Strack_mouse
);
7595 defsubr (&Sinput_pending_p
);
7596 defsubr (&Scommand_execute
);
7597 defsubr (&Srecent_keys
);
7598 defsubr (&Sthis_command_keys
);
7599 defsubr (&Sreset_this_command_lengths
);
7600 defsubr (&Ssuspend_emacs
);
7601 defsubr (&Sabort_recursive_edit
);
7602 defsubr (&Sexit_recursive_edit
);
7603 defsubr (&Srecursion_depth
);
7604 defsubr (&Stop_level
);
7605 defsubr (&Sdiscard_input
);
7606 defsubr (&Sopen_dribble_file
);
7607 defsubr (&Sset_input_mode
);
7608 defsubr (&Scurrent_input_mode
);
7609 defsubr (&Sexecute_extended_command
);
7611 DEFVAR_LISP ("last-command-char", &last_command_char
,
7612 "Last input event that was part of a command.");
7614 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
7615 "Last input event that was part of a command.");
7617 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
7618 "Last input event in a command, except for mouse menu events.\n\
7619 Mouse menus give back keys that don't look like mouse events;\n\
7620 this variable holds the actual mouse event that led to the menu,\n\
7621 so that you can determine whether the command was run by mouse or not.");
7623 DEFVAR_LISP ("last-input-char", &last_input_char
,
7624 "Last input event.");
7626 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
7627 "Last input event.");
7629 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
7630 "List of objects to be read as next command input events.");
7632 DEFVAR_INT ("unread-command-char", &unread_command_char
,
7633 "If not -1, an object to be read as next command input event.");
7635 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
7636 "Meta-prefix character code. Meta-foo as command input\n\
7637 turns into this character followed by foo.");
7638 XSETINT (meta_prefix_char
, 033);
7640 DEFVAR_KBOARD ("last-command", Vlast_command
,
7641 "The last command executed. Normally a symbol with a function definition,\n\
7642 but can be whatever was found in the keymap, or whatever the variable\n\
7643 `this-command' was set to by that command.\n\
7645 The value `mode-exit' is special; it means that the previous command\n\
7646 read an event that told it to exit, and it did so and unread that event.\n\
7647 In other words, the present command is the event that made the previous\n\
7650 The value `kill-region' is special; it means that the previous command\n\
7651 was a kill command.");
7653 DEFVAR_LISP ("this-command", &this_command
,
7654 "The command now being executed.\n\
7655 The command can set this variable; whatever is put here\n\
7656 will be in `last-command' during the following command.");
7657 this_command
= Qnil
;
7659 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
7660 "*Number of keyboard input characters between auto-saves.\n\
7661 Zero means disable autosaving due to number of characters typed.");
7662 auto_save_interval
= 300;
7664 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
7665 "*Number of seconds idle time before auto-save.\n\
7666 Zero or nil means disable auto-saving due to idleness.\n\
7667 After auto-saving due to this many seconds of idle time,\n\
7668 Emacs also does a garbage collection if that seems to be warranted.");
7669 XSETFASTINT (Vauto_save_timeout
, 30);
7671 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
7672 "*Nonzero means echo unfinished commands after this many seconds of pause.");
7673 echo_keystrokes
= 1;
7675 DEFVAR_INT ("polling-period", &polling_period
,
7676 "*Interval between polling for input during Lisp execution.\n\
7677 The reason for polling is to make C-g work to stop a running program.\n\
7678 Polling is needed only when using X windows and SIGIO does not work.\n\
7679 Polling is automatically disabled in all other cases.");
7682 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
7683 "*Maximum time between mouse clicks to make a double-click.\n\
7684 Measured in milliseconds. nil means disable double-click recognition;\n\
7685 t means double-clicks have no time limit and are detected\n\
7686 by position only.");
7687 Vdouble_click_time
= make_number (500);
7689 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
7690 "*Non-nil means inhibit local map menu bar menus.");
7691 inhibit_local_menu_bar_menus
= 0;
7693 DEFVAR_INT ("num-input-keys", &num_input_keys
,
7694 "Number of complete keys read from the keyboard so far.");
7697 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
7698 "The frame in which the most recently read event occurred.\n\
7699 If the last event came from a keyboard macro, this is set to `macro'.");
7700 Vlast_event_frame
= Qnil
;
7702 DEFVAR_LISP ("help-char", &Vhelp_char
,
7703 "Character to recognize as meaning Help.\n\
7704 When it is read, do `(eval help-form)', and display result if it's a string.\n\
7705 If the value of `help-form' is nil, this char can be read normally.");
7706 XSETINT (Vhelp_char
, Ctl ('H'));
7708 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
7709 "List of input events to recognize as meaning Help.\n\
7710 These work just like the value of `help-char' (see that).");
7711 Vhelp_event_list
= Qnil
;
7713 DEFVAR_LISP ("help-form", &Vhelp_form
,
7714 "Form to execute when character `help-char' is read.\n\
7715 If the form returns a string, that string is displayed.\n\
7716 If `help-form' is nil, the help char is not recognized.");
7719 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
7720 "Command to run when `help-char' character follows a prefix key.\n\
7721 This command is used only when there is no actual binding\n\
7722 for that character after that prefix key.");
7723 Vprefix_help_command
= Qnil
;
7725 DEFVAR_LISP ("top-level", &Vtop_level
,
7726 "Form to evaluate when Emacs starts up.\n\
7727 Useful to set before you dump a modified Emacs.");
7730 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
7731 "Translate table for keyboard input, or nil.\n\
7732 Each character is looked up in this string and the contents used instead.\n\
7733 The value may be a string, a vector, or a char-table.\n\
7734 If it is a string or vector of length N,\n\
7735 character codes N and up are untranslated.\n\
7736 In a vector or a char-table, an element which is nil means \"no translation\".");
7737 Vkeyboard_translate_table
= Qnil
;
7739 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
7740 "Non-nil means to always spawn a subshell instead of suspending,\n\
7741 even if the operating system has support for stopping a process.");
7744 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
7745 "Non-nil means prompt with menus when appropriate.\n\
7746 This is done when reading from a keymap that has a prompt string,\n\
7747 for elements that have prompt strings.\n\
7748 The menu is displayed on the screen\n\
7749 if X menus were enabled at configuration\n\
7750 time and the previous event was a mouse click prefix key.\n\
7751 Otherwise, menu prompting uses the echo area.");
7754 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
7755 "Character to see next line of menu prompt.\n\
7756 Type this character while in a menu prompt to rotate around the lines of it.");
7757 XSETINT (menu_prompt_more_char
, ' ');
7759 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
7760 "A mask of additional modifier keys to use with every keyboard character.\n\
7761 Emacs applies the modifiers of the character stored here to each keyboard\n\
7762 character it reads. For example, after evaluating the expression\n\
7763 (setq extra-keyboard-modifiers ?\\C-x)\n\
7764 all input characters will have the control modifier applied to them.\n\
7766 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
7767 not count as a control character; rather, it counts as a character\n\
7768 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
7769 cancels any modification.");
7770 extra_keyboard_modifiers
= 0;
7772 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
7773 "If an editing command sets this to t, deactivate the mark afterward.\n\
7774 The command loop sets this to nil before each command,\n\
7775 and tests the value when the command returns.\n\
7776 Buffer modification stores t in this variable.");
7777 Vdeactivate_mark
= Qnil
;
7779 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
7780 "Temporary storage of pre-command-hook or post-command-hook.");
7781 Vcommand_hook_internal
= Qnil
;
7783 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
7784 "Normal hook run before each command is executed.\n\
7785 Errors running the hook are caught and ignored.");
7786 Vpre_command_hook
= Qnil
;
7788 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
7789 "Normal hook run after each command is executed.\n\
7790 Errors running the hook are caught and ignored.");
7791 Vpost_command_hook
= Qnil
;
7793 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
7794 "Normal hook run after each command is executed, if idle.\n\
7795 Errors running the hook are caught and ignored.");
7796 Vpost_command_idle_hook
= Qnil
;
7798 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
7799 "Delay time before running `post-command-idle-hook'.\n\
7800 This is measured in microseconds.");
7801 post_command_idle_delay
= 100000;
7803 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
7804 "t means menu bar, specified Lucid style, needs to be recomputed.");
7805 Vlucid_menu_bar_dirty_flag
= Qnil
;
7807 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
7808 "List of menu bar items to move to the end of the menu bar.\n\
7809 The elements of the list are event types that may have menu bar bindings.");
7810 Vmenu_bar_final_items
= Qnil
;
7812 DEFVAR_KBOARD ("overriding-terminal-local-map",
7813 Voverriding_terminal_local_map
,
7814 "Keymap that overrides all other local keymaps.\n\
7815 If this variable is non-nil, it is used as a keymap instead of the\n\
7816 buffer's local map, and the minor mode keymaps and text property keymaps.");
7818 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
7819 "Keymap that overrides all other local keymaps.\n\
7820 If this variable is non-nil, it is used as a keymap instead of the\n\
7821 buffer's local map, and the minor mode keymaps and text property keymaps.");
7822 Voverriding_local_map
= Qnil
;
7824 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
7825 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
7826 Otherwise, the menu bar continues to reflect the buffer's local map\n\
7827 and the minor mode maps regardless of `overriding-local-map'.");
7828 Voverriding_local_map_menu_flag
= Qnil
;
7830 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
7831 "Keymap defining bindings for special events to execute at low level.");
7832 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
7834 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
7835 "*Non-nil means generate motion events for mouse motion.");
7837 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
7838 "Alist of system-specific X windows key symbols.\n\
7839 Each element should have the form (N . SYMBOL) where N is the\n\
7840 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
7841 and SYMBOL is its name.");
7843 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
7844 "List of deferred actions to be performed at a later time.\n\
7845 The precise format isn't relevant here; we just check whether it is nil.");
7846 Vdeferred_action_list
= Qnil
;
7848 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
7849 "Function to call to handle deferred actions, after each command.\n\
7850 This function is called with no arguments after each command\n\
7851 whenever `deferred-action-list' is non-nil.");
7852 Vdeferred_action_function
= Qnil
;
7854 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
7855 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
7856 The value can be a length of time to show the message for.\n\
7857 If the value is non-nil and not a number, we wait 2 seconds.");
7858 Vsuggest_key_bindings
= Qt
;
7860 DEFVAR_LISP ("column-number-mode", &Vcolumn_number_mode
,
7861 "Non-nil enables display of the current column number in the mode line.");
7862 Vcolumn_number_mode
= Qnil
;
7864 DEFVAR_LISP ("timer-list", &Vtimer_list
,
7865 "List of active timers in order of increasing time");
7871 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
7872 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
7873 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
7874 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
7875 initial_define_key (meta_map
, 'x', "execute-extended-command");
7877 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
7878 "handle-delete-frame");
7879 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
7881 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",