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 last_input_char
= c
;
2061 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
));
2065 /* Wipe the echo area. */
2066 echo_area_glyphs
= 0;
2068 /* Handle things that only apply to characters. */
2071 /* If kbd_buffer_get_event gave us an EOF, return that. */
2075 if (STRINGP (Vkeyboard_translate_table
)
2076 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
2077 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2078 else if ((VECTORP (Vkeyboard_translate_table
)
2079 && XVECTOR (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
2080 || CHAR_TABLE_P (Vkeyboard_translate_table
))
2083 d
= Faref (Vkeyboard_translate_table
, c
);
2084 /* nil in keyboard-translate-table means no translation. */
2090 /* If this event is a mouse click in the menu bar,
2091 return just menu-bar for now. Modify the mouse click event
2092 so we won't do this twice, then queue it up. */
2093 if (EVENT_HAS_PARAMETERS (c
)
2094 && CONSP (XCONS (c
)->cdr
)
2095 && CONSP (EVENT_START (c
))
2096 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2100 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2101 /* Handle menu-bar events:
2102 insert the dummy prefix event `menu-bar'. */
2103 if (EQ (posn
, Qmenu_bar
))
2105 /* Change menu-bar to (menu-bar) as the event "position". */
2106 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2109 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2115 if (! NILP (also_record
))
2116 record_char (also_record
);
2120 before_command_key_count
= this_command_key_count
;
2121 before_command_echo_length
= echo_length ();
2123 /* Don't echo mouse motion events. */
2125 && ! (EVENT_HAS_PARAMETERS (c
)
2126 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2129 if (! NILP (also_record
))
2130 echo_char (also_record
);
2131 /* Once we reread a character, echoing can happen
2132 the next time we pause to read a new one. */
2133 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2136 /* Record this character as part of the current key. */
2137 add_command_key (c
);
2138 if (! NILP (also_record
))
2139 add_command_key (also_record
);
2141 /* Re-reading in the middle of a command */
2143 last_input_char
= c
;
2146 /* Process the help character specially if enabled */
2147 if (!NILP (Vhelp_form
) && help_char_p (c
))
2150 count
= specpdl_ptr
- specpdl
;
2152 record_unwind_protect (Fset_window_configuration
,
2153 Fcurrent_window_configuration (Qnil
));
2155 tem0
= Feval (Vhelp_form
);
2157 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2161 c
= read_char (0, 0, 0, Qnil
, 0);
2162 while (BUFFERP (c
));
2163 /* Remove the help from the frame */
2164 unbind_to (count
, Qnil
);
2167 if (EQ (c
, make_number (040)))
2171 c
= read_char (0, 0, 0, Qnil
, 0);
2172 while (BUFFERP (c
));
2179 /* Return 1 if should recognize C as "the help character". */
2187 if (EQ (c
, Vhelp_char
))
2189 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2190 if (EQ (c
, XCONS (tail
)->car
))
2195 /* Record the input event C in various ways. */
2202 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2203 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2204 recent_keys_index
= 0;
2206 /* Write c to the dribble file. If c is a lispy event, write
2207 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2208 If you, dear reader, have a better idea, you've got the source. :-) */
2213 if (XUINT (c
) < 0x100)
2214 putc (XINT (c
), dribble
);
2216 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2220 Lisp_Object dribblee
;
2222 /* If it's a structured event, take the event header. */
2223 dribblee
= EVENT_HEAD (c
);
2225 if (SYMBOLP (dribblee
))
2227 putc ('<', dribble
);
2228 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2229 XSYMBOL (dribblee
)->name
->size
,
2231 putc ('>', dribble
);
2238 store_kbd_macro_char (c
);
2240 num_nonmacro_input_chars
++;
2247 struct buffer
*old
= current_buffer
;
2248 Fprinc (object
, Qnil
);
2249 set_buffer_internal (XBUFFER (Vstandard_output
));
2250 call0 (intern ("help-mode"));
2251 set_buffer_internal (old
);
2255 /* Copy out or in the info on where C-g should throw to.
2256 This is used when running Lisp code from within get_char,
2257 in case get_char is called recursively.
2258 See read_process_output. */
2263 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2266 restore_getcjmp (temp
)
2269 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2274 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2275 of this function. */
2278 tracking_off (old_value
)
2279 Lisp_Object old_value
;
2281 do_mouse_tracking
= old_value
;
2282 if (NILP (old_value
))
2284 /* Redisplay may have been preempted because there was input
2285 available, and it assumes it will be called again after the
2286 input has been processed. If the only input available was
2287 the sort that we have just disabled, then we need to call
2289 if (!readable_events ())
2291 redisplay_preserve_echo_area ();
2292 get_input_pending (&input_pending
);
2297 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2298 "Evaluate BODY with mouse movement events enabled.\n\
2299 Within a `track-mouse' form, mouse motion generates input events that\n\
2300 you can read with `read-event'.\n\
2301 Normally, mouse motion is ignored.")
2305 int count
= specpdl_ptr
- specpdl
;
2308 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2310 do_mouse_tracking
= Qt
;
2312 val
= Fprogn (args
);
2313 return unbind_to (count
, val
);
2316 /* If mouse has moved on some frame, return one of those frames.
2317 Return 0 otherwise. */
2322 Lisp_Object tail
, frame
;
2324 FOR_EACH_FRAME (tail
, frame
)
2326 if (XFRAME (frame
)->mouse_moved
)
2327 return XFRAME (frame
);
2333 #endif /* HAVE_MOUSE */
2335 /* Low level keyboard/mouse input.
2336 kbd_buffer_store_event places events in kbd_buffer, and
2337 kbd_buffer_get_event retrieves them. */
2339 /* Return true iff there are any events in the queue that read-char
2340 would return. If this returns false, a read-char would block. */
2345 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2348 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2353 if (current_kboard
->kbd_queue_has_data
)
2359 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2360 if (kb
->kbd_queue_has_data
)
2366 /* Set this for debugging, to have a way to get out */
2371 event_to_kboard (event
)
2372 struct input_event
*event
;
2375 frame
= event
->frame_or_window
;
2377 frame
= XCONS (frame
)->car
;
2378 else if (WINDOWP (frame
))
2379 frame
= WINDOW_FRAME (XWINDOW (frame
));
2381 /* There are still some events that don't set this field.
2382 For now, just ignore the problem.
2383 Also ignore dead frames here. */
2384 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2387 return FRAME_KBOARD (XFRAME (frame
));
2391 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2394 kbd_buffer_store_event (event
)
2395 register struct input_event
*event
;
2397 if (event
->kind
== no_event
)
2400 if (event
->kind
== ascii_keystroke
)
2402 register int c
= event
->code
& 0377;
2404 if (event
->modifiers
& ctrl_modifier
)
2405 c
= make_ctrl_char (c
);
2407 c
|= (event
->modifiers
2408 & (meta_modifier
| alt_modifier
2409 | hyper_modifier
| super_modifier
));
2413 extern SIGTYPE
interrupt_signal ();
2416 struct input_event
*sp
;
2419 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2420 kb
!= current_kboard
))
2423 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2424 Fcons (make_number (c
), Qnil
));
2425 kb
->kbd_queue_has_data
= 1;
2426 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2428 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2431 if (event_to_kboard (sp
) == kb
)
2433 sp
->kind
= no_event
;
2434 sp
->frame_or_window
= Qnil
;
2442 /* If this results in a quit_char being returned to Emacs as
2443 input, set Vlast_event_frame properly. If this doesn't
2444 get returned to Emacs as an event, the next event read
2445 will set Vlast_event_frame again, so this is safe to do. */
2449 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2451 focus
= event
->frame_or_window
;
2452 internal_last_event_frame
= focus
;
2453 Vlast_event_frame
= focus
;
2457 last_event_timestamp
= event
->timestamp
;
2458 interrupt_signal ();
2462 if (c
&& c
== stop_character
)
2468 /* Don't insert two buffer_switch_event's in a row.
2469 Just ignore the second one. */
2470 else if (event
->kind
== buffer_switch_event
2471 && kbd_fetch_ptr
!= kbd_store_ptr
2472 && kbd_store_ptr
->kind
== buffer_switch_event
)
2475 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2476 kbd_store_ptr
= kbd_buffer
;
2478 /* Don't let the very last slot in the buffer become full,
2479 since that would make the two pointers equal,
2480 and that is indistinguishable from an empty buffer.
2481 Discard the event if it would fill the last slot. */
2482 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2484 volatile struct input_event
*sp
= kbd_store_ptr
;
2485 sp
->kind
= event
->kind
;
2486 if (event
->kind
== selection_request_event
)
2488 /* We must not use the ordinary copying code for this case,
2489 since `part' is an enum and copying it might not copy enough
2491 bcopy (event
, (char *) sp
, sizeof (*event
));
2495 sp
->code
= event
->code
;
2496 sp
->part
= event
->part
;
2497 sp
->frame_or_window
= event
->frame_or_window
;
2498 sp
->modifiers
= event
->modifiers
;
2501 sp
->timestamp
= event
->timestamp
;
2503 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2505 = event
->frame_or_window
);
2511 /* Read one event from the event buffer, waiting if necessary.
2512 The value is a Lisp object representing the event.
2513 The value is nil for an event that should be ignored,
2514 or that was handled here.
2515 We always read and discard one event. */
2518 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2520 int *used_mouse_menu
;
2524 EMACS_TIME next_timer_delay
;
2530 *kbp
= current_kboard
;
2534 /* Wait until there is input available. */
2537 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2540 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2544 /* Check when the next timer fires. */
2545 next_timer_delay
= timer_check (0);
2546 if (EMACS_SECS (next_timer_delay
) == 0
2547 && EMACS_USECS (next_timer_delay
) == 0)
2549 if (EMACS_TIME_NEG_P (next_timer_delay
))
2551 EMACS_SET_SECS (next_timer_delay
, 0);
2552 EMACS_SET_USECS (next_timer_delay
, 0);
2555 /* If the quit flag is set, then read_char will return
2556 quit_char, so that counts as "available input." */
2557 if (!NILP (Vquit_flag
))
2558 quit_throw_to_read_char ();
2560 /* One way or another, wait until input is available; then, if
2561 interrupt handlers have not read it, read it now. */
2564 wait_for_kbd_input ();
2566 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2570 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2573 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2577 Lisp_Object minus_one
;
2579 XSETINT (minus_one
, -1);
2580 wait_reading_process_input (EMACS_SECS (next_timer_delay
),
2581 EMACS_USECS (next_timer_delay
),
2584 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2585 /* Pass 1 for EXPECT since we just waited to have input. */
2586 read_avail_input (1);
2588 #endif /* not VMS */
2591 /* At this point, we know that there is a readable event available
2592 somewhere. If the event queue is empty, then there must be a
2593 mouse movement enabled and available. */
2594 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2596 struct input_event
*event
;
2598 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2602 last_event_timestamp
= event
->timestamp
;
2605 *kbp
= event_to_kboard (event
);
2607 *kbp
= current_kboard
; /* Better than returning null ptr? */
2609 *kbp
= &the_only_kboard
;
2614 /* These two kinds of events get special handling
2615 and don't actually appear to the command loop.
2616 We return nil for them. */
2617 if (event
->kind
== selection_request_event
)
2620 struct input_event copy
;
2622 /* Remove it from the buffer before processing it,
2623 since otherwise swallow_events will see it
2624 and process it again. */
2626 kbd_fetch_ptr
= event
+ 1;
2627 input_pending
= readable_events ();
2628 x_handle_selection_request (©
);
2630 /* We're getting selection request events, but we don't have
2636 else if (event
->kind
== selection_clear_event
)
2639 struct input_event copy
;
2641 /* Remove it from the buffer before processing it. */
2643 kbd_fetch_ptr
= event
+ 1;
2644 input_pending
= readable_events ();
2645 x_handle_selection_clear (©
);
2647 /* We're getting selection request events, but we don't have
2652 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2653 else if (event
->kind
== delete_window_event
)
2655 /* Make an event (delete-frame (FRAME)). */
2656 obj
= Fcons (event
->frame_or_window
, Qnil
);
2657 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2658 kbd_fetch_ptr
= event
+ 1;
2660 else if (event
->kind
== iconify_event
)
2662 /* Make an event (iconify-frame (FRAME)). */
2663 obj
= Fcons (event
->frame_or_window
, Qnil
);
2664 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2665 kbd_fetch_ptr
= event
+ 1;
2667 else if (event
->kind
== deiconify_event
)
2669 /* Make an event (make-frame-visible (FRAME)). */
2670 obj
= Fcons (event
->frame_or_window
, Qnil
);
2671 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2672 kbd_fetch_ptr
= event
+ 1;
2675 else if (event
->kind
== buffer_switch_event
)
2677 /* The value doesn't matter here; only the type is tested. */
2678 XSETBUFFER (obj
, current_buffer
);
2679 kbd_fetch_ptr
= event
+ 1;
2681 #ifdef USE_X_TOOLKIT
2682 else if (event
->kind
== menu_bar_activate_event
)
2684 kbd_fetch_ptr
= event
+ 1;
2685 input_pending
= readable_events ();
2686 x_activate_menubar (XFRAME (event
->frame_or_window
));
2689 /* Just discard these, by returning nil.
2690 With MULTI_KBOARD, these events are used as placeholders
2691 when we need to randomly delete events from the queue.
2692 (They shouldn't otherwise be found in the buffer,
2693 but on some machines it appears they do show up
2694 even without MULTI_KBOARD.) */
2695 else if (event
->kind
== no_event
)
2696 kbd_fetch_ptr
= event
+ 1;
2698 /* If this event is on a different frame, return a switch-frame this
2699 time, and leave the event in the queue for next time. */
2706 frame
= event
->frame_or_window
;
2708 frame
= XCONS (frame
)->car
;
2709 else if (WINDOWP (frame
))
2710 frame
= WINDOW_FRAME (XWINDOW (frame
));
2712 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2716 if (! EQ (frame
, internal_last_event_frame
)
2717 && XFRAME (frame
) != selected_frame
)
2718 obj
= make_lispy_switch_frame (frame
);
2719 internal_last_event_frame
= frame
;
2720 #endif /* MULTI_FRAME */
2722 /* If we didn't decide to make a switch-frame event, go ahead
2723 and build a real event from the queue entry. */
2727 obj
= make_lispy_event (event
);
2728 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2729 /* If this was a menu selection, then set the flag to inhibit
2730 writing to last_nonmenu_event. Don't do this if the event
2731 we're returning is (menu-bar), though; that indicates the
2732 beginning of the menu sequence, and we might as well leave
2733 that as the `event with parameters' for this selection. */
2734 if (event
->kind
== menu_bar_event
2735 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2737 *used_mouse_menu
= 1;
2740 /* Wipe out this event, to catch bugs. */
2741 event
->kind
= no_event
;
2742 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2744 kbd_fetch_ptr
= event
+ 1;
2749 /* Try generating a mouse motion event. */
2750 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2752 FRAME_PTR f
= some_mouse_moved ();
2753 Lisp_Object bar_window
;
2754 enum scroll_bar_part part
;
2758 *kbp
= current_kboard
;
2759 /* Note that this uses F to determine which display to look at.
2760 If there is no valid info, it does not store anything
2761 so x remains nil. */
2763 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2768 /* Decide if we should generate a switch-frame event. Don't
2769 generate switch-frame events for motion outside of all Emacs
2775 frame
= FRAME_FOCUS_FRAME (f
);
2777 XSETFRAME (frame
, f
);
2779 if (! EQ (frame
, internal_last_event_frame
)
2780 && XFRAME (frame
) != selected_frame
)
2781 obj
= make_lispy_switch_frame (frame
);
2782 internal_last_event_frame
= frame
;
2786 /* If we didn't decide to make a switch-frame event, go ahead and
2787 return a mouse-motion event. */
2788 if (!NILP (x
) && NILP (obj
))
2789 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2791 #endif /* HAVE_MOUSE */
2793 /* We were promised by the above while loop that there was
2794 something for us to read! */
2797 input_pending
= readable_events ();
2800 Vlast_event_frame
= internal_last_event_frame
;
2806 /* Process any events that are not user-visible,
2807 then return, without reading any user-visible events. */
2812 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2814 struct input_event
*event
;
2816 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2820 last_event_timestamp
= event
->timestamp
;
2822 /* These two kinds of events get special handling
2823 and don't actually appear to the command loop. */
2824 if (event
->kind
== selection_request_event
)
2827 struct input_event copy
;
2829 /* Remove it from the buffer before processing it,
2830 since otherwise swallow_events called recursively could see it
2831 and process it again. */
2833 kbd_fetch_ptr
= event
+ 1;
2834 input_pending
= readable_events ();
2835 x_handle_selection_request (©
);
2837 /* We're getting selection request events, but we don't have
2843 else if (event
->kind
== selection_clear_event
)
2846 struct input_event copy
;
2848 /* Remove it from the buffer before processing it, */
2851 kbd_fetch_ptr
= event
+ 1;
2852 input_pending
= readable_events ();
2853 x_handle_selection_clear (©
);
2855 /* We're getting selection request events, but we don't have
2864 get_input_pending (&input_pending
);
2867 /* Check whether a timer has fired. To prevent larger problems we simply
2868 disregard elements that are not proper timers. Do not make a circular
2869 timer list for the time being.
2871 Returns the number of seconds to wait until the next timer fires. If a
2872 timer is triggering now, return zero seconds.
2873 If no timer is active, return -1 seconds.
2875 If a timer is triggering now, either queue a timer-event
2876 or run the timer's handler function if DO_IT_NOW is nonzero. */
2879 timer_check (do_it_now
)
2882 EMACS_TIME nexttime
;
2884 Lisp_Object timers
, timer
;
2885 /* Nonzero if we generate some events. */
2886 int events_generated
= 0;
2887 struct gcpro gcpro1
, gcpro2
;
2889 EMACS_SET_SECS (nexttime
, -1);
2890 EMACS_SET_USECS (nexttime
, -1);
2892 timers
= Vtimer_list
;
2894 GCPRO2 (timers
, timer
);
2897 EMACS_GET_TIME (now
);
2899 while (CONSP (timers
))
2902 Lisp_Object
*vector
;
2903 EMACS_TIME timer_time
;
2904 EMACS_TIME difference
;
2906 timer
= XCONS (timers
)->car
;
2907 timers
= XCONS (timers
)->cdr
;
2909 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 7)
2911 vector
= XVECTOR (timer
)->contents
;
2913 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
2914 || !INTEGERP (vector
[3]))
2917 EMACS_SET_SECS (timer_time
,
2918 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
2919 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
2920 EMACS_SUB_TIME (difference
, timer_time
, now
);
2921 /* If event is past, run it if it hasn't been run. */
2922 if (EMACS_TIME_NEG_P (difference
))
2924 if (NILP (vector
[0]))
2926 /* Mark the timer as triggered to prevent problems if the lisp
2927 code fails to reschedule it right. */
2930 /* Run the timer or queue a timer event. */
2933 Lisp_Object tem
, event
;
2934 tem
= get_keymap_1 (Vspecial_event_map
, 0, 0);
2935 tem
= get_keyelt (access_keymap (tem
, Qtimer_event
, 0, 0),
2937 event
= Fcons (Qtimer_event
, Fcons (timer
, Qnil
));
2938 Fcommand_execute (tem
, Qnil
, Fvector (1, &event
));
2939 /* Since we have handled the event,
2940 we don't need to tell the caller to wake up and do it. */
2944 /* Generate a timer event so the caller will handle it. */
2945 struct input_event event
;
2947 event
.kind
= timer_event
;
2948 event
.modifiers
= 0;
2949 event
.x
= event
.y
= Qnil
;
2950 event
.timestamp
= triggertime
;
2951 /* Store the timer in the frame slot. */
2952 event
.frame_or_window
= Fcons (Fselected_frame (), timer
);
2953 kbd_buffer_store_event (&event
);
2955 /* Tell caller to handle this event right away. */
2956 events_generated
= 1;
2957 EMACS_SET_SECS (nexttime
, 0);
2958 EMACS_SET_USECS (nexttime
, 0);
2963 /* When we encounter a timer that is still waiting,
2964 return the amount of time to wait before it is ripe. */
2967 /* But if we generated an event,
2968 tell the caller to handle it now. */
2969 if (events_generated
)
2974 /* No timers are pending in the future. */
2975 /* Return 0 if we generated an event, and -1 if not. */
2980 /* Caches for modify_event_symbol. */
2981 static Lisp_Object accent_key_syms
;
2982 static Lisp_Object func_key_syms
;
2983 static Lisp_Object mouse_syms
;
2985 /* This is a list of keysym codes for special "accent" characters.
2986 It parallels lispy_accent_keys. */
2988 static int lispy_accent_codes
[] =
2990 #ifdef XK_dead_circumflex
2995 #ifdef XK_dead_grave
3000 #ifdef XK_dead_tilde
3005 #ifdef XK_dead_diaeresis
3010 #ifdef XK_dead_macron
3015 #ifdef XK_dead_degree
3020 #ifdef XK_dead_acute
3025 #ifdef XK_dead_cedilla
3030 #ifdef XK_dead_breve
3035 #ifdef XK_dead_ogonek
3040 #ifdef XK_dead_caron
3045 #ifdef XK_dead_doubleacute
3046 XK_dead_doubleacute
,
3050 #ifdef XK_dead_abovedot
3057 /* This is a list of Lisp names for special "accent" characters.
3058 It parallels lispy_accent_codes. */
3060 static char *lispy_accent_keys
[] =
3078 #define FUNCTION_KEY_OFFSET 0x0
3080 char *lispy_function_keys
[] =
3084 0, /* VK_LBUTTON 0x01 */
3085 0, /* VK_RBUTTON 0x02 */
3086 "cancel", /* VK_CANCEL 0x03 */
3087 0, /* VK_MBUTTON 0x04 */
3089 0, 0, 0, /* 0x05 .. 0x07 */
3091 "backspace", /* VK_BACK 0x08 */
3092 "tab", /* VK_TAB 0x09 */
3094 0, 0, /* 0x0A .. 0x0B */
3096 "clear", /* VK_CLEAR 0x0C */
3097 "return", /* VK_RETURN 0x0D */
3099 0, 0, /* 0x0E .. 0x0F */
3101 "shift", /* VK_SHIFT 0x10 */
3102 "control", /* VK_CONTROL 0x11 */
3103 "menu", /* VK_MENU 0x12 */
3104 "pause", /* VK_PAUSE 0x13 */
3105 "capital", /* VK_CAPITAL 0x14 */
3107 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3109 0, /* VK_ESCAPE 0x1B */
3111 0, 0, 0, 0, /* 0x1C .. 0x1F */
3113 0, /* VK_SPACE 0x20 */
3114 "prior", /* VK_PRIOR 0x21 */
3115 "next", /* VK_NEXT 0x22 */
3116 "end", /* VK_END 0x23 */
3117 "home", /* VK_HOME 0x24 */
3118 "left", /* VK_LEFT 0x25 */
3119 "up", /* VK_UP 0x26 */
3120 "right", /* VK_RIGHT 0x27 */
3121 "down", /* VK_DOWN 0x28 */
3122 "select", /* VK_SELECT 0x29 */
3123 "print", /* VK_PRINT 0x2A */
3124 "execute", /* VK_EXECUTE 0x2B */
3125 "snapshot", /* VK_SNAPSHOT 0x2C */
3126 "insert", /* VK_INSERT 0x2D */
3127 "delete", /* VK_DELETE 0x2E */
3128 "help", /* VK_HELP 0x2F */
3130 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3132 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3134 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3136 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3138 0, 0, 0, 0, 0, 0, 0, 0, 0,
3139 0, 0, 0, 0, 0, 0, 0, 0, 0,
3140 0, 0, 0, 0, 0, 0, 0, 0,
3142 0, /* VK_LWIN 0x5B */
3143 0, /* VK_RWIN 0x5C */
3144 0, /* VK_APPS 0x5D */
3146 0, 0, /* 0x5E .. 0x5F */
3148 "kp-0", /* VK_NUMPAD0 0x60 */
3149 "kp-1", /* VK_NUMPAD1 0x61 */
3150 "kp-2", /* VK_NUMPAD2 0x62 */
3151 "kp-3", /* VK_NUMPAD3 0x63 */
3152 "kp-4", /* VK_NUMPAD4 0x64 */
3153 "kp-5", /* VK_NUMPAD5 0x65 */
3154 "kp-6", /* VK_NUMPAD6 0x66 */
3155 "kp-7", /* VK_NUMPAD7 0x67 */
3156 "kp-8", /* VK_NUMPAD8 0x68 */
3157 "kp-9", /* VK_NUMPAD9 0x69 */
3158 "kp-multiply", /* VK_MULTIPLY 0x6A */
3159 "kp-add", /* VK_ADD 0x6B */
3160 "kp-separator", /* VK_SEPARATOR 0x6C */
3161 "kp-subtract", /* VK_SUBTRACT 0x6D */
3162 "kp-decimal", /* VK_DECIMAL 0x6E */
3163 "kp-divide", /* VK_DIVIDE 0x6F */
3164 "f1", /* VK_F1 0x70 */
3165 "f2", /* VK_F2 0x71 */
3166 "f3", /* VK_F3 0x72 */
3167 "f4", /* VK_F4 0x73 */
3168 "f5", /* VK_F5 0x74 */
3169 "f6", /* VK_F6 0x75 */
3170 "f7", /* VK_F7 0x76 */
3171 "f8", /* VK_F8 0x77 */
3172 "f9", /* VK_F9 0x78 */
3173 "f10", /* VK_F10 0x79 */
3174 "f11", /* VK_F11 0x7A */
3175 "f12", /* VK_F12 0x7B */
3176 "f13", /* VK_F13 0x7C */
3177 "f14", /* VK_F14 0x7D */
3178 "f15", /* VK_F15 0x7E */
3179 "f16", /* VK_F16 0x7F */
3180 "f17", /* VK_F17 0x80 */
3181 "f18", /* VK_F18 0x81 */
3182 "f19", /* VK_F19 0x82 */
3183 "f20", /* VK_F20 0x83 */
3184 "f21", /* VK_F21 0x84 */
3185 "f22", /* VK_F22 0x85 */
3186 "f23", /* VK_F23 0x86 */
3187 "f24", /* VK_F24 0x87 */
3189 0, 0, 0, 0, /* 0x88 .. 0x8B */
3190 0, 0, 0, 0, /* 0x8C .. 0x8F */
3192 "kp-numlock", /* VK_NUMLOCK 0x90 */
3193 "scroll", /* VK_SCROLL 0x91 */
3195 0, 0, 0, 0, 0, /* 0x92 .. 0x96 */
3196 0, 0, 0, 0, 0, /* 0x97 .. 0x9B */
3197 0, 0, 0, 0, /* 0x9C .. 0x9F */
3200 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3201 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3202 * No other API or message will distinguish left and right keys this way.
3206 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3207 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3208 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3209 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3210 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3216 "attn", /* VK_ATTN 0xF6 */
3217 "crsel", /* VK_CRSEL 0xF7 */
3218 "exsel", /* VK_EXSEL 0xF8 */
3219 "ereof", /* VK_EREOF 0xF9 */
3220 "play", /* VK_PLAY 0xFA */
3221 "zoom", /* VK_ZOOM 0xFB */
3222 "noname", /* VK_NONAME 0xFC */
3223 "pa1", /* VK_PA1 0xFD */
3224 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3229 #define FUNCTION_KEY_OFFSET 0xff00
3231 /* You'll notice that this table is arranged to be conveniently
3232 indexed by X Windows keysym values. */
3233 static char *lispy_function_keys
[] =
3235 /* X Keysym value */
3237 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3245 0, 0, 0, /* 0xff10 */
3247 0, 0, 0, 0, 0, 0, 0,
3250 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3251 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3252 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3254 "home", /* 0xff50 */ /* IsCursorKey */
3265 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3276 "break", /* 0xff6b */
3278 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3280 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3281 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3282 0, 0, 0, 0, 0, 0, 0, 0,
3283 "kp-tab", /* 0xff89 */
3285 "kp-enter", /* 0xff8d */
3287 "kp-f1", /* 0xff91 */
3291 "kp-home", /* 0xff95 */
3296 "kp-prior", /* kp-page-up */
3297 "kp-next", /* kp-page-down */
3303 0, 0, 0, 0, 0, 0, 0, 0, 0,
3304 "kp-multiply", /* 0xffaa */
3309 "kp-divide", /* 0xffaf */
3310 "kp-0", /* 0xffb0 */
3311 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3314 "kp-equal", /* 0xffbd */
3315 "f1", /* 0xffbe */ /* IsFunctionKey */
3317 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3318 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3319 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3320 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3321 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3322 0, 0, 0, 0, 0, 0, 0, 0,
3323 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3324 0, 0, 0, 0, 0, 0, 0, "delete"
3327 #endif /* HAVE_NTGUI */
3329 static char *lispy_mouse_names
[] =
3331 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3334 /* Scroll bar parts. */
3335 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3337 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3338 Lisp_Object
*scroll_bar_parts
[] = {
3339 &Qabove_handle
, &Qhandle
, &Qbelow_handle
3343 /* A vector, indexed by button number, giving the down-going location
3344 of currently depressed buttons, both scroll bar and non-scroll bar.
3346 The elements have the form
3347 (BUTTON-NUMBER MODIFIER-MASK . REST)
3348 where REST is the cdr of a position as it would be reported in the event.
3350 The make_lispy_event function stores positions here to tell the
3351 difference between click and drag events, and to store the starting
3352 location to be included in drag events. */
3354 static Lisp_Object button_down_location
;
3356 /* Information about the most recent up-going button event: Which
3357 button, what location, and what time. */
3359 static int last_mouse_button
;
3360 static int last_mouse_x
;
3361 static int last_mouse_y
;
3362 static unsigned long button_down_time
;
3364 /* The maximum time between clicks to make a double-click,
3365 or Qnil to disable double-click detection,
3366 or Qt for no time limit. */
3367 Lisp_Object Vdouble_click_time
;
3369 /* The number of clicks in this multiple-click. */
3371 int double_click_count
;
3373 /* Given a struct input_event, build the lisp event which represents
3374 it. If EVENT is 0, build a mouse movement event from the mouse
3375 movement buffer, which should have a movement event in it.
3377 Note that events must be passed to this function in the order they
3378 are received; this function stores the location of button presses
3379 in order to build drag events when the button is released. */
3382 make_lispy_event (event
)
3383 struct input_event
*event
;
3387 switch (SWITCH_ENUM_CAST (event
->kind
))
3389 /* A simple keystroke. */
3390 case ascii_keystroke
:
3392 Lisp_Object lispy_c
;
3393 int c
= event
->code
& 0377;
3394 /* Turn ASCII characters into control characters
3396 if (event
->modifiers
& ctrl_modifier
)
3397 c
= make_ctrl_char (c
);
3399 /* Add in the other modifier bits. We took care of ctrl_modifier
3400 just above, and the shift key was taken care of by the X code,
3401 and applied to control characters by make_ctrl_char. */
3402 c
|= (event
->modifiers
3403 & (meta_modifier
| alt_modifier
3404 | hyper_modifier
| super_modifier
));
3405 button_down_time
= 0;
3406 XSETFASTINT (lispy_c
, c
);
3410 /* A function key. The symbol may need to have modifier prefixes
3412 case non_ascii_keystroke
:
3413 button_down_time
= 0;
3415 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3416 if (event
->code
== lispy_accent_codes
[i
])
3417 return modify_event_symbol (i
,
3419 Qfunction_key
, Qnil
,
3420 lispy_accent_keys
, &accent_key_syms
,
3421 (sizeof (lispy_accent_keys
)
3422 / sizeof (lispy_accent_keys
[0])));
3424 /* Handle system-specific keysyms. */
3425 if (event
->code
& (1 << 28))
3427 /* We need to use an alist rather than a vector as the cache
3428 since we can't make a vector long enuf. */
3429 if (NILP (current_kboard
->system_key_syms
))
3430 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3431 return modify_event_symbol (event
->code
,
3434 current_kboard
->Vsystem_key_alist
,
3435 0, ¤t_kboard
->system_key_syms
,
3439 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3441 Qfunction_key
, Qnil
,
3442 lispy_function_keys
, &func_key_syms
,
3443 (sizeof (lispy_function_keys
)
3444 / sizeof (lispy_function_keys
[0])));
3448 return Fcons (Qtimer_event
, Fcons (Fcdr (event
->frame_or_window
), Qnil
));
3451 /* A mouse click. Figure out where it is, decide whether it's
3452 a press, click or drag, and build the appropriate structure. */
3454 case scroll_bar_click
:
3456 int button
= event
->code
;
3458 Lisp_Object position
;
3459 Lisp_Object
*start_pos_ptr
;
3460 Lisp_Object start_pos
;
3462 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3465 /* Build the position as appropriate for this mouse click. */
3466 if (event
->kind
== mouse_click
)
3469 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3474 /* Ignore mouse events that were made on frame that
3475 have been deleted. */
3476 if (! FRAME_LIVE_P (f
))
3479 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3480 &column
, &row
, NULL
, 1);
3482 #ifndef USE_X_TOOLKIT
3483 /* In the non-toolkit version, clicks on the menu bar
3484 are ordinary button events in the event buffer.
3485 Distinguish them, and invoke the menu.
3487 (In the toolkit version, the toolkit handles the menu bar
3488 and Emacs doesn't know about it until after the user
3489 makes a selection.) */
3490 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3491 && (event
->modifiers
& down_modifier
))
3493 Lisp_Object items
, item
;
3498 /* Activate the menu bar on the down event. If the
3499 up event comes in before the menu code can deal with it,
3501 if (! (event
->modifiers
& down_modifier
))
3506 items
= FRAME_MENU_BAR_ITEMS (f
);
3507 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
3509 Lisp_Object pos
, string
;
3510 string
= XVECTOR (items
)->contents
[i
+ 1];
3511 pos
= XVECTOR (items
)->contents
[i
+ 2];
3514 if (column
>= XINT (pos
)
3515 && column
< XINT (pos
) + XSTRING (string
)->size
)
3517 item
= XVECTOR (items
)->contents
[i
];
3523 = Fcons (event
->frame_or_window
,
3525 Fcons (Fcons (event
->x
, event
->y
),
3526 Fcons (make_number (event
->timestamp
),
3529 return Fcons (item
, Fcons (position
, Qnil
));
3531 #endif /* not USE_X_TOOLKIT */
3533 window
= window_from_coordinates (f
, column
, row
, &part
);
3535 if (!WINDOWP (window
))
3537 window
= event
->frame_or_window
;
3542 int pixcolumn
, pixrow
;
3543 column
-= XINT (XWINDOW (window
)->left
);
3544 row
-= XINT (XWINDOW (window
)->top
);
3545 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3546 XSETINT (event
->x
, pixcolumn
);
3547 XSETINT (event
->y
, pixrow
);
3552 posn
= Qvertical_line
;
3555 buffer_posn_from_coords (XWINDOW (window
),
3562 Fcons (Fcons (event
->x
, event
->y
),
3563 Fcons (make_number (event
->timestamp
),
3569 Lisp_Object portion_whole
;
3572 window
= event
->frame_or_window
;
3573 portion_whole
= Fcons (event
->x
, event
->y
);
3574 part
= *scroll_bar_parts
[(int) event
->part
];
3578 Fcons (Qvertical_scroll_bar
,
3579 Fcons (portion_whole
,
3580 Fcons (make_number (event
->timestamp
),
3581 Fcons (part
, Qnil
)))));
3584 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3586 start_pos
= *start_pos_ptr
;
3587 *start_pos_ptr
= Qnil
;
3589 is_double
= (button
== last_mouse_button
3590 && XINT (event
->x
) == last_mouse_x
3591 && XINT (event
->y
) == last_mouse_y
3592 && button_down_time
!= 0
3593 && (EQ (Vdouble_click_time
, Qt
)
3594 || (INTEGERP (Vdouble_click_time
)
3595 && ((int)(event
->timestamp
- button_down_time
)
3596 < XINT (Vdouble_click_time
)))));
3597 last_mouse_button
= button
;
3598 last_mouse_x
= XINT (event
->x
);
3599 last_mouse_y
= XINT (event
->y
);
3601 /* If this is a button press, squirrel away the location, so
3602 we can decide later whether it was a click or a drag. */
3603 if (event
->modifiers
& down_modifier
)
3607 double_click_count
++;
3608 event
->modifiers
|= ((double_click_count
> 2)
3613 double_click_count
= 1;
3614 button_down_time
= event
->timestamp
;
3615 *start_pos_ptr
= Fcopy_alist (position
);
3618 /* Now we're releasing a button - check the co-ordinates to
3619 see if this was a click or a drag. */
3620 else if (event
->modifiers
& up_modifier
)
3622 /* If we did not see a down before this up,
3623 ignore the up. Probably this happened because
3624 the down event chose a menu item.
3625 It would be an annoyance to treat the release
3626 of the button that chose the menu item
3627 as a separate event. */
3629 if (!CONSP (start_pos
))
3632 event
->modifiers
&= ~up_modifier
;
3633 #if 0 /* Formerly we treated an up with no down as a click event. */
3634 if (!CONSP (start_pos
))
3635 event
->modifiers
|= click_modifier
;
3639 /* The third element of every position should be the (x,y)
3643 down
= Fnth (make_number (2), start_pos
);
3644 if (EQ (event
->x
, XCONS (down
)->car
)
3645 && EQ (event
->y
, XCONS (down
)->cdr
))
3647 event
->modifiers
|= click_modifier
;
3651 button_down_time
= 0;
3652 event
->modifiers
|= drag_modifier
;
3654 /* Don't check is_double; treat this as multiple
3655 if the down-event was multiple. */
3656 if (double_click_count
> 1)
3657 event
->modifiers
|= ((double_click_count
> 2)
3663 /* Every mouse event should either have the down_modifier or
3664 the up_modifier set. */
3668 /* Get the symbol we should use for the mouse click. */
3671 head
= modify_event_symbol (button
,
3674 lispy_mouse_names
, &mouse_syms
,
3675 (sizeof (lispy_mouse_names
)
3676 / sizeof (lispy_mouse_names
[0])));
3677 if (event
->modifiers
& drag_modifier
)
3682 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
3685 Fcons (make_number (double_click_count
),
3693 #endif /* HAVE_MOUSE */
3695 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3696 case menu_bar_event
:
3697 /* The event value is in the cdr of the frame_or_window slot. */
3698 if (!CONSP (event
->frame_or_window
))
3700 return XCONS (event
->frame_or_window
)->cdr
;
3703 /* The 'kind' field of the event is something we don't recognize. */
3712 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
3714 Lisp_Object bar_window
;
3715 enum scroll_bar_part part
;
3720 /* Is it a scroll bar movement? */
3721 if (frame
&& ! NILP (bar_window
))
3723 Lisp_Object part_sym
;
3725 part_sym
= *scroll_bar_parts
[(int) part
];
3726 return Fcons (Qscroll_bar_movement
,
3727 (Fcons (Fcons (bar_window
,
3728 Fcons (Qvertical_scroll_bar
,
3729 Fcons (Fcons (x
, y
),
3730 Fcons (make_number (time
),
3736 /* Or is it an ordinary mouse movement? */
3738 #endif /* MULTI_FRAME */
3751 /* It's in a frame; which window on that frame? */
3752 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
3754 window
= window_from_coordinates (frame
, column
, row
, &area
);
3759 if (WINDOWP (window
))
3761 int pixcolumn
, pixrow
;
3762 column
-= XINT (XWINDOW (window
)->left
);
3763 row
-= XINT (XWINDOW (window
)->top
);
3764 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
3765 XSETINT (x
, pixcolumn
);
3766 XSETINT (y
, pixrow
);
3771 posn
= Qvertical_line
;
3774 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
3777 else if (frame
!= 0)
3779 XSETFRAME (window
, frame
);
3791 return Fcons (Qmouse_movement
,
3792 Fcons (Fcons (window
,
3794 Fcons (Fcons (x
, y
),
3795 Fcons (make_number (time
),
3801 #endif /* HAVE_MOUSE */
3803 /* Construct a switch frame event. */
3805 make_lispy_switch_frame (frame
)
3808 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
3811 /* Manipulating modifiers. */
3813 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
3815 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
3816 SYMBOL's name of the end of the modifiers; the string from this
3817 position is the unmodified symbol name.
3819 This doesn't use any caches. */
3822 parse_modifiers_uncached (symbol
, modifier_end
)
3826 struct Lisp_String
*name
;
3830 CHECK_SYMBOL (symbol
, 1);
3833 name
= XSYMBOL (symbol
)->name
;
3835 for (i
= 0; i
+2 <= name
->size
; )
3837 int this_mod_end
= 0;
3840 /* See if the name continues with a modifier word.
3841 Check that the word appears, but don't check what follows it.
3842 Set this_mod and this_mod_end to record what we find. */
3844 switch (name
->data
[i
])
3846 #define SINGLE_LETTER_MOD(BIT) \
3847 (this_mod_end = i + 1, this_mod = BIT)
3850 SINGLE_LETTER_MOD (alt_modifier
);
3854 SINGLE_LETTER_MOD (ctrl_modifier
);
3858 SINGLE_LETTER_MOD (hyper_modifier
);
3862 SINGLE_LETTER_MOD (meta_modifier
);
3866 SINGLE_LETTER_MOD (shift_modifier
);
3870 SINGLE_LETTER_MOD (super_modifier
);
3873 #undef SINGLE_LETTER_MOD
3876 /* If we found no modifier, stop looking for them. */
3877 if (this_mod_end
== 0)
3880 /* Check there is a dash after the modifier, so that it
3881 really is a modifier. */
3882 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
3885 /* This modifier is real; look for another. */
3886 modifiers
|= this_mod
;
3887 i
= this_mod_end
+ 1;
3890 /* Should we include the `click' modifier? */
3891 if (! (modifiers
& (down_modifier
| drag_modifier
3892 | double_modifier
| triple_modifier
))
3893 && i
+ 7 == name
->size
3894 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
3895 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
3896 modifiers
|= click_modifier
;
3904 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
3905 prepended to the string BASE[0..BASE_LEN-1].
3906 This doesn't use any caches. */
3908 apply_modifiers_uncached (modifiers
, base
, base_len
)
3913 /* Since BASE could contain nulls, we can't use intern here; we have
3914 to use Fintern, which expects a genuine Lisp_String, and keeps a
3917 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
3923 /* Only the event queue may use the `up' modifier; it should always
3924 be turned into a click or drag event before presented to lisp code. */
3925 if (modifiers
& up_modifier
)
3928 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
3929 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
3930 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
3931 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
3932 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
3933 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
3934 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
3935 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
3936 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
3937 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
3938 /* The click modifier is denoted by the absence of other modifiers. */
3942 mod_len
= p
- new_mods
;
3946 Lisp_Object new_name
;
3948 new_name
= make_uninit_string (mod_len
+ base_len
);
3949 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
3950 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
3952 return Fintern (new_name
, Qnil
);
3957 static char *modifier_names
[] =
3959 "up", "down", "drag", "click", "double", "triple", 0, 0,
3960 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3961 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
3963 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
3965 static Lisp_Object modifier_symbols
;
3967 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3969 lispy_modifier_list (modifiers
)
3972 Lisp_Object modifier_list
;
3975 modifier_list
= Qnil
;
3976 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
3977 if (modifiers
& (1<<i
))
3978 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
3981 return modifier_list
;
3985 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
3986 where UNMODIFIED is the unmodified form of SYMBOL,
3987 MASK is the set of modifiers present in SYMBOL's name.
3988 This is similar to parse_modifiers_uncached, but uses the cache in
3989 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3990 Qevent_symbol_elements property. */
3993 parse_modifiers (symbol
)
3996 Lisp_Object elements
;
3998 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3999 if (CONSP (elements
))
4004 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4005 Lisp_Object unmodified
;
4008 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4009 XSYMBOL (symbol
)->name
->size
- end
),
4012 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4014 XSETFASTINT (mask
, modifiers
);
4015 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4017 /* Cache the parsing results on SYMBOL. */
4018 Fput (symbol
, Qevent_symbol_element_mask
,
4020 Fput (symbol
, Qevent_symbol_elements
,
4021 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4023 /* Since we know that SYMBOL is modifiers applied to unmodified,
4024 it would be nice to put that in unmodified's cache.
4025 But we can't, since we're not sure that parse_modifiers is
4032 /* Apply the modifiers MODIFIERS to the symbol BASE.
4033 BASE must be unmodified.
4035 This is like apply_modifiers_uncached, but uses BASE's
4036 Qmodifier_cache property, if present. It also builds
4037 Qevent_symbol_elements properties, since it has that info anyway.
4039 apply_modifiers copies the value of BASE's Qevent_kind property to
4040 the modified symbol. */
4042 apply_modifiers (modifiers
, base
)
4046 Lisp_Object cache
, index
, entry
, new_symbol
;
4048 /* Mask out upper bits. We don't know where this value's been. */
4049 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4051 /* The click modifier never figures into cache indices. */
4052 cache
= Fget (base
, Qmodifier_cache
);
4053 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4054 entry
= assq_no_quit (index
, cache
);
4057 new_symbol
= XCONS (entry
)->cdr
;
4060 /* We have to create the symbol ourselves. */
4061 new_symbol
= apply_modifiers_uncached (modifiers
,
4062 XSYMBOL (base
)->name
->data
,
4063 XSYMBOL (base
)->name
->size
);
4065 /* Add the new symbol to the base's cache. */
4066 entry
= Fcons (index
, new_symbol
);
4067 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4069 /* We have the parsing info now for free, so add it to the caches. */
4070 XSETFASTINT (index
, modifiers
);
4071 Fput (new_symbol
, Qevent_symbol_element_mask
,
4072 Fcons (base
, Fcons (index
, Qnil
)));
4073 Fput (new_symbol
, Qevent_symbol_elements
,
4074 Fcons (base
, lispy_modifier_list (modifiers
)));
4077 /* Make sure this symbol is of the same kind as BASE.
4079 You'd think we could just set this once and for all when we
4080 intern the symbol above, but reorder_modifiers may call us when
4081 BASE's property isn't set right; we can't assume that just
4082 because it has a Qmodifier_cache property it must have its
4083 Qevent_kind set right as well. */
4084 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4088 kind
= Fget (base
, Qevent_kind
);
4090 Fput (new_symbol
, Qevent_kind
, kind
);
4097 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4098 return a symbol with the modifiers placed in the canonical order.
4099 Canonical order is alphabetical, except for down and drag, which
4100 always come last. The 'click' modifier is never written out.
4102 Fdefine_key calls this to make sure that (for example) C-M-foo
4103 and M-C-foo end up being equivalent in the keymap. */
4106 reorder_modifiers (symbol
)
4109 /* It's hopefully okay to write the code this way, since everything
4110 will soon be in caches, and no consing will be done at all. */
4113 parsed
= parse_modifiers (symbol
);
4114 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4115 XCONS (parsed
)->car
);
4119 /* For handling events, we often want to produce a symbol whose name
4120 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4121 to some base, like the name of a function key or mouse button.
4122 modify_event_symbol produces symbols of this sort.
4124 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4125 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4128 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4129 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4131 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4132 persist between calls to modify_event_symbol that it can use to
4133 store a cache of the symbols it's generated for this NAME_TABLE
4134 before. The object stored there may be a vector or an alist.
4136 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4138 MODIFIERS is a set of modifier bits (as given in struct input_events)
4139 whose prefixes should be applied to the symbol name.
4141 SYMBOL_KIND is the value to be placed in the event_kind property of
4142 the returned symbol.
4144 The symbols we create are supposed to have an
4145 `event-symbol-elements' property, which lists the modifiers present
4146 in the symbol's name. */
4149 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4150 name_table
, symbol_table
, table_size
)
4153 Lisp_Object symbol_kind
;
4154 Lisp_Object name_alist
;
4156 Lisp_Object
*symbol_table
;
4157 unsigned int table_size
;
4160 Lisp_Object symbol_int
;
4162 /* Get rid of the "vendor-specific" bit here. */
4163 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4165 /* Is this a request for a valid symbol? */
4166 if (symbol_num
< 0 || symbol_num
>= table_size
)
4169 if (CONSP (*symbol_table
))
4170 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4172 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4173 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4174 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4175 we've never used that symbol before. */
4178 if (! VECTORP (*symbol_table
)
4179 || XVECTOR (*symbol_table
)->size
!= table_size
)
4183 XSETFASTINT (size
, table_size
);
4184 *symbol_table
= Fmake_vector (size
, Qnil
);
4187 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4190 /* Have we already used this symbol before? */
4193 /* No; let's create it. */
4194 if (!NILP (name_alist
))
4195 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4196 else if (name_table
[symbol_num
])
4197 value
= intern (name_table
[symbol_num
]);
4199 #ifdef HAVE_WINDOW_SYSTEM
4202 char *name
= x_get_keysym_name (symbol_num
);
4204 value
= intern (name
);
4211 sprintf (buf
, "key-%d", symbol_num
);
4212 value
= intern (buf
);
4215 if (CONSP (*symbol_table
))
4216 *symbol_table
= Fcons (value
, *symbol_table
);
4218 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4220 /* Fill in the cache entries for this symbol; this also
4221 builds the Qevent_symbol_elements property, which the user
4223 apply_modifiers (modifiers
& click_modifier
, value
);
4224 Fput (value
, Qevent_kind
, symbol_kind
);
4227 /* Apply modifiers to that symbol. */
4228 return apply_modifiers (modifiers
, value
);
4231 /* Convert a list that represents an event type,
4232 such as (ctrl meta backspace), into the usual representation of that
4233 event type as a number or a symbol. */
4235 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4236 "Convert the event description list EVENT-DESC to an event type.\n\
4237 EVENT-DESC should contain one base event type (a character or symbol)\n\
4238 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4239 drag, down, double or triple).\n\
4240 The return value is an event type (a character or symbol) which\n\
4241 has the same base event type and all the specified modifiers.")
4243 Lisp_Object event_desc
;
4251 while (CONSP (rest
))
4256 elt
= XCONS (rest
)->car
;
4258 /* Given a symbol, see if it is a modifier name. */
4260 this = parse_solitary_modifier (elt
);
4264 else if (!NILP (base
))
4265 error ("Two bases given in one event");
4269 rest
= XCONS (rest
)->cdr
;
4272 /* Let the symbol A refer to the character A. */
4273 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4274 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4276 if (INTEGERP (base
))
4278 /* Turn (shift a) into A. */
4279 if ((modifiers
& shift_modifier
) != 0
4280 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4282 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4283 modifiers
&= ~shift_modifier
;
4286 /* Turn (control a) into C-a. */
4287 if (modifiers
& ctrl_modifier
)
4288 return make_number ((modifiers
& ~ctrl_modifier
)
4289 | make_ctrl_char (XINT (base
)));
4291 return make_number (modifiers
| XINT (base
));
4293 else if (SYMBOLP (base
))
4294 return apply_modifiers (modifiers
, base
);
4296 error ("Invalid base event");
4299 /* Try to recognize SYMBOL as a modifier name.
4300 Return the modifier flag bit, or 0 if not recognized. */
4303 parse_solitary_modifier (symbol
)
4306 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4308 switch (name
->data
[0])
4310 #define SINGLE_LETTER_MOD(BIT) \
4311 if (name->size == 1) \
4314 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4315 if (LEN == name->size \
4316 && ! strncmp (name->data, NAME, LEN)) \
4320 SINGLE_LETTER_MOD (alt_modifier
);
4324 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4328 SINGLE_LETTER_MOD (ctrl_modifier
);
4332 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4333 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4337 SINGLE_LETTER_MOD (hyper_modifier
);
4341 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4345 SINGLE_LETTER_MOD (meta_modifier
);
4349 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4353 SINGLE_LETTER_MOD (shift_modifier
);
4357 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4358 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4359 SINGLE_LETTER_MOD (super_modifier
);
4363 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4364 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4365 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4369 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4372 #undef SINGLE_LETTER_MOD
4373 #undef MULTI_LETTER_MOD
4379 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4380 Such a list is not valid as an event,
4381 but it can be a Lucid-style event type list. */
4384 lucid_event_type_list_p (object
)
4389 if (! CONSP (object
))
4392 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4395 elt
= XCONS (tail
)->car
;
4396 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4403 /* Store into *addr a value nonzero if terminal input chars are available.
4404 Serves the purpose of ioctl (0, FIONREAD, addr)
4405 but works even if FIONREAD does not exist.
4406 (In fact, this may actually read some input.) */
4409 get_input_pending (addr
)
4412 /* First of all, have we already counted some input? */
4413 *addr
= !NILP (Vquit_flag
) || readable_events ();
4415 /* If input is being read as it arrives, and we have none, there is none. */
4416 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4419 /* Try to read some input and see how much we get. */
4421 *addr
= !NILP (Vquit_flag
) || readable_events ();
4424 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4427 gobble_input (expected
)
4432 if (interrupt_input
)
4435 mask
= sigblockx (SIGIO
);
4436 read_avail_input (expected
);
4440 #ifdef POLL_FOR_INPUT
4441 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4444 mask
= sigblockx (SIGALRM
);
4445 read_avail_input (expected
);
4451 read_avail_input (expected
);
4455 /* Put a buffer_switch_event in the buffer
4456 so that read_key_sequence will notice the new current buffer. */
4458 record_asynch_buffer_change ()
4460 struct input_event event
;
4463 event
.kind
= buffer_switch_event
;
4464 event
.frame_or_window
= Qnil
;
4467 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4468 The purpose of the event is to make read_key_sequence look up the
4469 keymaps again. If we aren't in read_key_sequence, we don't need one,
4470 and the event could cause trouble by messing up (input-pending-p). */
4471 tem
= Fwaiting_for_user_input_p ();
4475 /* We never need these events if we have no asynchronous subprocesses. */
4479 /* Make sure no interrupt happens while storing the event. */
4481 if (interrupt_input
)
4484 mask
= sigblockx (SIGIO
);
4485 kbd_buffer_store_event (&event
);
4492 kbd_buffer_store_event (&event
);
4499 /* Read any terminal input already buffered up by the system
4500 into the kbd_buffer, but do not wait.
4502 EXPECTED should be nonzero if the caller knows there is some input.
4504 Except on VMS, all input is read by this function.
4505 If interrupt_input is nonzero, this function MUST be called
4506 only when SIGIO is blocked.
4508 Returns the number of keyboard chars read, or -1 meaning
4509 this is a bad time to try to read input. */
4512 read_avail_input (expected
)
4515 struct input_event buf
[KBD_BUFFER_SIZE
];
4519 if (read_socket_hook
)
4520 /* No need for FIONREAD or fcntl; just say don't wait. */
4521 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
,
4522 expected
, expected
);
4525 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
4526 the kbd_buffer can really hold. That may prevent loss
4527 of characters on some systems when input is stuffed at us. */
4528 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
4531 /* Determine how many characters we should *try* to read. */
4534 #else /* not WINDOWSNT */
4536 n_to_read
= dos_keysns ();
4539 #else /* not MSDOS */
4541 /* Find out how much input is available. */
4542 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
4543 /* Formerly simply reported no input, but that sometimes led to
4544 a failure of Emacs to terminate.
4545 SIGHUP seems appropriate if we can't reach the terminal. */
4546 /* ??? Is it really right to send the signal just to this process
4547 rather than to the whole process group?
4548 Perhaps on systems with FIONREAD Emacs is alone in its group. */
4549 kill (getpid (), SIGHUP
);
4552 if (n_to_read
> sizeof cbuf
)
4553 n_to_read
= sizeof cbuf
;
4554 #else /* no FIONREAD */
4555 #if defined (USG) || defined (DGUX)
4556 /* Read some input if available, but don't wait. */
4557 n_to_read
= sizeof cbuf
;
4558 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
4563 #endif /* not MSDOS */
4564 #endif /* not WINDOWSNT */
4566 /* Now read; for one reason or another, this will not block.
4567 NREAD is set to the number of chars read. */
4571 cbuf
[0] = dos_keyread ();
4574 nread
= read (input_fd
, cbuf
, n_to_read
);
4576 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
4577 /* The kernel sometimes fails to deliver SIGHUP for ptys.
4578 This looks incorrect, but it isn't, because _BSD causes
4579 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
4580 and that causes a value other than 0 when there is no input. */
4586 /* We used to retry the read if it was interrupted.
4587 But this does the wrong thing when O_NDELAY causes
4588 an EAGAIN error. Does anybody know of a situation
4589 where a retry is actually needed? */
4591 nread
< 0 && (errno
== EAGAIN
4605 #if defined (USG) || defined (DGUX)
4606 fcntl (input_fd
, F_SETFL
, 0);
4607 #endif /* USG or DGUX */
4608 #endif /* no FIONREAD */
4609 for (i
= 0; i
< nread
; i
++)
4611 buf
[i
].kind
= ascii_keystroke
;
4612 buf
[i
].modifiers
= 0;
4613 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
4614 buf
[i
].modifiers
= meta_modifier
;
4618 buf
[i
].code
= cbuf
[i
];
4620 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
4622 buf
[i
].frame_or_window
= Qnil
;
4627 /* Scan the chars for C-g and store them in kbd_buffer. */
4628 for (i
= 0; i
< nread
; i
++)
4630 kbd_buffer_store_event (&buf
[i
]);
4631 /* Don't look at input that follows a C-g too closely.
4632 This reduces lossage due to autorepeat on C-g. */
4633 if (buf
[i
].kind
== ascii_keystroke
4634 && buf
[i
].code
== quit_char
)
4640 #endif /* not VMS */
4642 #ifdef SIGIO /* for entire page */
4643 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4646 input_available_signal (signo
)
4649 /* Must preserve main program's value of errno. */
4650 int old_errno
= errno
;
4652 extern int select_alarmed
;
4656 /* USG systems forget handlers when they are used;
4657 must reestablish each time */
4658 signal (signo
, input_available_signal
);
4665 if (input_available_clear_time
)
4666 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
4671 nread
= read_avail_input (1);
4672 /* -1 means it's not ok to read the input now.
4673 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
4674 0 means there was no keyboard input available. */
4679 select_alarmed
= 1; /* Force the select emulator back to life */
4690 /* Send ourselves a SIGIO.
4692 This function exists so that the UNBLOCK_INPUT macro in
4693 blockinput.h can have some way to take care of input we put off
4694 dealing with, without assuming that every file which uses
4695 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
4697 reinvoke_input_signal ()
4706 /* Return the prompt-string of a sparse keymap.
4707 This is the first element which is a string.
4708 Return nil if there is none. */
4716 register Lisp_Object tem
;
4725 static void menu_bar_item ();
4726 static void menu_bar_one_keymap ();
4728 /* These variables hold the vector under construction within
4729 menu_bar_items and its subroutines, and the current index
4730 for storing into that vector. */
4731 static Lisp_Object menu_bar_items_vector
;
4732 static int menu_bar_items_index
;
4734 /* Return a vector of menu items for a menu bar, appropriate
4735 to the current buffer. Each item has three elements in the vector:
4738 OLD is an old vector we can optionally reuse, or nil. */
4741 menu_bar_items (old
)
4744 /* The number of keymaps we're scanning right now, and the number of
4745 keymaps we have allocated space for. */
4748 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4749 in the current keymaps, or nil where it is not a prefix. */
4752 Lisp_Object def
, tem
, tail
;
4761 struct gcpro gcpro1
;
4763 /* In order to build the menus, we need to call the keymap
4764 accessors. They all call QUIT. But this function is called
4765 during redisplay, during which a quit is fatal. So inhibit
4766 quitting while building the menus.
4767 We do this instead of specbind because (1) errors will clear it anyway
4768 and (2) this avoids risk of specpdl overflow. */
4769 oquit
= Vinhibit_quit
;
4773 menu_bar_items_vector
= old
;
4775 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
4776 menu_bar_items_index
= 0;
4778 GCPRO1 (menu_bar_items_vector
);
4780 /* Build our list of keymaps.
4781 If we recognize a function key and replace its escape sequence in
4782 keybuf with its symbol, or if the sequence starts with a mouse
4783 click and we need to switch buffers, we jump back here to rebuild
4784 the initial keymaps from the current buffer. */
4788 /* Should overriding-terminal-local-map and overriding-local-map apply? */
4789 if (!NILP (Voverriding_local_map_menu_flag
))
4791 /* Yes, use them (if non-nil) as well as the global map. */
4792 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
4794 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
4795 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
4796 if (!NILP (Voverriding_local_map
))
4797 maps
[nmaps
++] = Voverriding_local_map
;
4801 /* No, so use major and minor mode keymaps. */
4802 nmaps
= current_minor_maps (NULL
, &tmaps
);
4803 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
4804 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
4805 #ifdef USE_TEXT_PROPERTIES
4806 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
4808 maps
[nmaps
++] = current_buffer
->keymap
;
4811 maps
[nmaps
++] = current_global_map
;
4814 /* Look up in each map the dummy prefix key `menu-bar'. */
4818 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
4820 if (! NILP (maps
[mapno
]))
4821 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
4825 tem
= Fkeymapp (def
);
4827 menu_bar_one_keymap (def
);
4830 /* Move to the end those items that should be at the end. */
4832 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4835 int end
= menu_bar_items_index
;
4837 for (i
= 0; i
< end
; i
+= 3)
4838 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4840 Lisp_Object tem0
, tem1
, tem2
;
4841 /* Move the item at index I to the end,
4842 shifting all the others forward. */
4843 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
4844 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
4845 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
4847 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
4848 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
4849 (end
- i
- 3) * sizeof (Lisp_Object
));
4850 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
4851 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
4852 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
4857 /* Add nil, nil, nil at the end. */
4858 i
= menu_bar_items_index
;
4859 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
4862 int newsize
= 2 * i
;
4863 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
4864 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
4865 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
4866 menu_bar_items_vector
= tem
;
4868 /* Add this item. */
4869 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
4870 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
4871 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
4872 menu_bar_items_index
= i
;
4874 Vinhibit_quit
= oquit
;
4876 return menu_bar_items_vector
;
4879 /* Scan one map KEYMAP, accumulating any menu items it defines
4880 in menu_bar_items_vector. */
4883 menu_bar_one_keymap (keymap
)
4886 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
4888 /* Loop over all keymap entries that have menu strings. */
4889 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4891 item
= XCONS (tail
)->car
;
4894 key
= XCONS (item
)->car
;
4895 binding
= XCONS (item
)->cdr
;
4896 if (CONSP (binding
))
4898 item_string
= XCONS (binding
)->car
;
4899 if (STRINGP (item_string
))
4900 menu_bar_item (key
, item_string
, Fcdr (binding
));
4902 else if (EQ (binding
, Qundefined
))
4903 menu_bar_item (key
, Qnil
, binding
);
4905 else if (VECTORP (item
))
4907 /* Loop over the char values represented in the vector. */
4908 int len
= XVECTOR (item
)->size
;
4910 for (c
= 0; c
< len
; c
++)
4912 Lisp_Object character
;
4913 XSETFASTINT (character
, c
);
4914 binding
= XVECTOR (item
)->contents
[c
];
4915 if (CONSP (binding
))
4917 item_string
= XCONS (binding
)->car
;
4918 if (STRINGP (item_string
))
4919 menu_bar_item (key
, item_string
, Fcdr (binding
));
4921 else if (EQ (binding
, Qundefined
))
4922 menu_bar_item (key
, Qnil
, binding
);
4928 /* This is used as the handler when calling internal_condition_case_1. */
4931 menu_bar_item_1 (arg
)
4937 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
4938 If there's already an item for KEY, add this DEF to it. */
4941 menu_bar_item (key
, item_string
, def
)
4942 Lisp_Object key
, item_string
, def
;
4945 Lisp_Object enabled
;
4948 if (EQ (def
, Qundefined
))
4950 /* If a map has an explicit `undefined' as definition,
4951 discard any previously made menu bar item. */
4953 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
4954 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4956 if (menu_bar_items_index
> i
+ 3)
4957 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
4958 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
4959 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
4960 menu_bar_items_index
-= 3;
4964 /* If there's no definition for this key yet,
4965 just ignore `undefined'. */
4969 /* See if this entry is enabled. */
4974 /* No property, or nil, means enable.
4975 Otherwise, enable if value is not nil. */
4976 tem
= Fget (def
, Qmenu_enable
);
4978 /* (condition-case nil (eval tem)
4980 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
4984 /* Ignore this item if it's not enabled. */
4988 /* Find any existing item for this KEY. */
4989 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
4990 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4993 /* If we did not find this KEY, add it at the end. */
4994 if (i
== menu_bar_items_index
)
4996 /* If vector is too small, get a bigger one. */
4997 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
5000 int newsize
= 2 * i
;
5001 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5002 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5003 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5004 menu_bar_items_vector
= tem
;
5006 /* Add this item. */
5007 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5008 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5009 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5010 menu_bar_items_index
= i
;
5012 /* We did find an item for this KEY. Add DEF to its list of maps. */
5016 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5017 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5021 /* Read a character using menus based on maps in the array MAPS.
5022 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5023 Return t if we displayed a menu but the user rejected it.
5025 PREV_EVENT is the previous input event, or nil if we are reading
5026 the first event of a key sequence.
5028 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5029 if we used a mouse menu to read the input, or zero otherwise. If
5030 USED_MOUSE_MENU is null, we don't dereference it.
5032 The prompting is done based on the prompt-string of the map
5033 and the strings associated with various map elements.
5035 This can be done with X menus or with menus put in the minibuf.
5036 These are done in different ways, depending on how the input will be read.
5037 Menus using X are done after auto-saving in read-char, getting the input
5038 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5039 and do auto-saving in the inner call of read_char. */
5042 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5045 Lisp_Object prev_event
;
5046 int *used_mouse_menu
;
5049 register Lisp_Object name
;
5050 Lisp_Object rest
, vector
;
5052 if (used_mouse_menu
)
5053 *used_mouse_menu
= 0;
5055 /* Use local over global Menu maps */
5057 if (! menu_prompting
)
5060 /* Optionally disregard all but the global map. */
5061 if (inhibit_local_menu_bar_menus
)
5063 maps
+= (nmaps
- 1);
5067 /* Get the menu name from the first map that has one (a prompt string). */
5068 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5070 name
= map_prompt (maps
[mapno
]);
5075 /* If we don't have any menus, just read a character normally. */
5080 /* If we got to this point via a mouse click,
5081 use a real menu for mouse selection. */
5082 if (EVENT_HAS_PARAMETERS (prev_event
)
5083 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5085 /* Display the menu and get the selection. */
5086 Lisp_Object
*realmaps
5087 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5091 /* Use the maps that are not nil. */
5092 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5093 if (!NILP (maps
[mapno
]))
5094 realmaps
[nmaps1
++] = maps
[mapno
];
5096 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5101 /* If we got multiple events, unread all but
5103 There is no way to prevent those unread events
5104 from showing up later in last_nonmenu_event.
5105 So turn symbol and integer events into lists,
5106 to indicate that they came from a mouse menu,
5107 so that when present in last_nonmenu_event
5108 they won't confuse things. */
5109 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5110 tem
= XCONS (tem
)->cdr
)
5111 if (SYMBOLP (XCONS (tem
)->car
)
5112 || INTEGERP (XCONS (tem
)->car
))
5114 = Fcons (XCONS (tem
)->car
, Qnil
);
5116 /* If we got more than one event, put all but the first
5117 onto this list to be read later.
5118 Return just the first event now. */
5119 Vunread_command_events
5120 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5121 value
= XCONS (value
)->car
;
5123 else if (NILP (value
))
5125 if (used_mouse_menu
)
5126 *used_mouse_menu
= 1;
5129 #endif /* HAVE_MENUS */
5133 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5134 We make this bigger when necessary, and never free it. */
5135 static char *read_char_minibuf_menu_text
;
5136 /* Size of that buffer. */
5137 static int read_char_minibuf_menu_width
;
5140 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5146 register Lisp_Object name
;
5148 int width
= FRAME_WIDTH (selected_frame
) - 4;
5151 Lisp_Object rest
, vector
;
5154 if (! menu_prompting
)
5157 /* Make sure we have a big enough buffer for the menu text. */
5158 if (read_char_minibuf_menu_text
== 0)
5160 read_char_minibuf_menu_width
= width
+ 4;
5161 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5163 else if (width
+ 4 > read_char_minibuf_menu_width
)
5165 read_char_minibuf_menu_width
= width
+ 4;
5166 read_char_minibuf_menu_text
5167 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5169 menu
= read_char_minibuf_menu_text
;
5171 /* Get the menu name from the first map that has one (a prompt string). */
5172 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5174 name
= map_prompt (maps
[mapno
]);
5179 /* If we don't have any menus, just read a character normally. */
5183 /* Prompt string always starts with map's prompt, and a space. */
5184 strcpy (menu
, XSTRING (name
)->data
);
5185 nlength
= XSTRING (name
)->size
;
5186 menu
[nlength
++] = ':';
5187 menu
[nlength
++] = ' ';
5190 /* Start prompting at start of first map. */
5194 /* Present the documented bindings, a line at a time. */
5201 Lisp_Object orig_defn_macro
;
5203 /* Loop over elements of map. */
5208 /* If reached end of map, start at beginning of next map. */
5212 /* At end of last map, wrap around to first map if just starting,
5213 or end this line if already have something on it. */
5217 if (notfirst
|| nobindings
) break;
5222 /* Look at the next element of the map. */
5224 elt
= XVECTOR (vector
)->contents
[idx
];
5226 elt
= Fcar_safe (rest
);
5228 if (idx
< 0 && VECTORP (elt
))
5230 /* If we found a dense table in the keymap,
5231 advanced past it, but start scanning its contents. */
5232 rest
= Fcdr_safe (rest
);
5238 /* An ordinary element. */
5243 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5244 event
= Fcar_safe (elt
);
5248 s
= Fcar_safe (elt
); /* vector */
5249 XSETINT (event
, idx
);
5252 /* Ignore the element if it has no prompt string. */
5253 if (STRINGP (s
) && INTEGERP (event
))
5255 /* 1 if the char to type matches the string. */
5257 Lisp_Object upcased_event
, downcased_event
;
5260 upcased_event
= Fupcase (event
);
5261 downcased_event
= Fdowncase (event
);
5262 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5263 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5265 desc
= Fsingle_key_description (event
);
5267 /* If we have room for the prompt string, add it to this line.
5268 If this is the first on the line, always add it. */
5269 if ((XSTRING (s
)->size
+ i
+ 2
5270 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5276 /* Punctuate between strings. */
5279 strcpy (menu
+ i
, ", ");
5285 /* If the char to type doesn't match the string's
5286 first char, explicitly show what char to type. */
5289 /* Add as much of string as fits. */
5290 thiswidth
= XSTRING (desc
)->size
;
5291 if (thiswidth
+ i
> width
)
5292 thiswidth
= width
- i
;
5293 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5295 strcpy (menu
+ i
, " = ");
5299 /* Add as much of string as fits. */
5300 thiswidth
= XSTRING (s
)->size
;
5301 if (thiswidth
+ i
> width
)
5302 thiswidth
= width
- i
;
5303 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5309 /* If this element does not fit, end the line now,
5310 and save the element for the next line. */
5311 strcpy (menu
+ i
, "...");
5316 /* Move past this element. */
5317 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5318 /* Handle reaching end of dense table. */
5323 rest
= Fcdr_safe (rest
);
5327 /* Prompt with that and read response. */
5330 /* Make believe its not a keyboard macro in case the help char
5331 is pressed. Help characters are not recorded because menu prompting
5332 is not used on replay.
5334 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5335 current_kboard
->defining_kbd_macro
= Qnil
;
5337 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5338 while (BUFFERP (obj
));
5339 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5341 if (!INTEGERP (obj
))
5346 if (! EQ (obj
, menu_prompt_more_char
)
5347 && (!INTEGERP (menu_prompt_more_char
)
5348 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5350 if (!NILP (current_kboard
->defining_kbd_macro
))
5351 store_kbd_macro_char (obj
);
5354 /* Help char - go round again */
5358 /* Reading key sequences. */
5360 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5361 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5362 keymap, or nil otherwise. Return the index of the first keymap in
5363 which KEY has any binding, or NMAPS if no map has a binding.
5365 If KEY is a meta ASCII character, treat it like meta-prefix-char
5366 followed by the corresponding non-meta character. Keymaps in
5367 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5370 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5373 NEXT may be the same array as CURRENT. */
5376 follow_key (key
, nmaps
, current
, defs
, next
)
5378 Lisp_Object
*current
, *defs
, *next
;
5381 int i
, first_binding
;
5384 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5385 followed by the corresponding non-meta character.
5386 Put the results into DEFS, since we are going to alter that anyway.
5387 Do not alter CURRENT or NEXT. */
5388 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5390 for (i
= 0; i
< nmaps
; i
++)
5391 if (! NILP (current
[i
]))
5394 def
= get_keyelt (access_keymap (current
[i
],
5395 meta_prefix_char
, 1, 0));
5397 /* Note that since we pass the resulting bindings through
5398 get_keymap_1, non-prefix bindings for meta-prefix-char
5400 defs
[i
] = get_keymap_1 (def
, 0, 1);
5406 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5409 first_binding
= nmaps
;
5410 for (i
= nmaps
- 1; i
>= 0; i
--)
5412 if (! NILP (current
[i
]))
5420 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0));
5421 if (! NILP (defs
[i
]))
5428 /* Given the set of bindings we've found, produce the next set of maps. */
5429 if (first_binding
< nmaps
)
5430 for (i
= 0; i
< nmaps
; i
++)
5431 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5433 return first_binding
;
5436 /* Read a sequence of keys that ends with a non prefix character,
5437 storing it in KEYBUF, a buffer of size BUFSIZE.
5439 Return the length of the key sequence stored.
5440 Return -1 if the user rejected a command menu.
5442 Echo starting immediately unless `prompt' is 0.
5444 Where a key sequence ends depends on the currently active keymaps.
5445 These include any minor mode keymaps active in the current buffer,
5446 the current buffer's local map, and the global map.
5448 If a key sequence has no other bindings, we check Vfunction_key_map
5449 to see if some trailing subsequence might be the beginning of a
5450 function key's sequence. If so, we try to read the whole function
5451 key, and substitute its symbolic name into the key sequence.
5453 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5454 `double-' events into similar click events, if that would make them
5455 bound. We try to turn `triple-' events first into `double-' events,
5458 If we get a mouse click in a mode line, vertical divider, or other
5459 non-text area, we treat the click as if it were prefixed by the
5460 symbol denoting that area - `mode-line', `vertical-line', or
5463 If the sequence starts with a mouse click, we read the key sequence
5464 with respect to the buffer clicked on, not the current buffer.
5466 If the user switches frames in the midst of a key sequence, we put
5467 off the switch-frame event until later; the next call to
5468 read_char will return it. */
5471 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5472 can_return_switch_frame
)
5473 Lisp_Object
*keybuf
;
5476 int dont_downcase_last
;
5477 int can_return_switch_frame
;
5479 int count
= specpdl_ptr
- specpdl
;
5481 /* How many keys there are in the current key sequence. */
5484 /* The length of the echo buffer when we started reading, and
5485 the length of this_command_keys when we started reading. */
5489 /* The number of keymaps we're scanning right now, and the number of
5490 keymaps we have allocated space for. */
5492 int nmaps_allocated
= 0;
5494 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5495 the current keymaps. */
5498 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5499 in the current keymaps, or nil where it is not a prefix. */
5500 Lisp_Object
*submaps
;
5502 /* The local map to start out with at start of key sequence. */
5503 Lisp_Object orig_local_map
;
5505 /* 1 if we have already considered switching to the local-map property
5506 of the place where a mouse click occurred. */
5507 int localized_local_map
= 0;
5509 /* The index in defs[] of the first keymap that has a binding for
5510 this key sequence. In other words, the lowest i such that
5511 defs[i] is non-nil. */
5514 /* If t < mock_input, then KEYBUF[t] should be read as the next
5517 We use this to recover after recognizing a function key. Once we
5518 realize that a suffix of the current key sequence is actually a
5519 function key's escape sequence, we replace the suffix with the
5520 function key's binding from Vfunction_key_map. Now keybuf
5521 contains a new and different key sequence, so the echo area,
5522 this_command_keys, and the submaps and defs arrays are wrong. In
5523 this situation, we set mock_input to t, set t to 0, and jump to
5524 restart_sequence; the loop will read keys from keybuf up until
5525 mock_input, thus rebuilding the state; and then it will resume
5526 reading characters from the keyboard. */
5529 /* If the sequence is unbound in submaps[], then
5530 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
5531 and fkey_map is its binding.
5533 These might be > t, indicating that all function key scanning
5534 should hold off until t reaches them. We do this when we've just
5535 recognized a function key, to avoid searching for the function
5536 key's again in Vfunction_key_map. */
5537 int fkey_start
= 0, fkey_end
= 0;
5538 Lisp_Object fkey_map
;
5540 /* Likewise, for key_translation_map. */
5541 int keytran_start
= 0, keytran_end
= 0;
5542 Lisp_Object keytran_map
;
5544 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
5545 we put it off for later. While we're reading, we keep the event here. */
5546 Lisp_Object delayed_switch_frame
;
5548 /* See the comment below... */
5549 #if defined (GOBBLE_FIRST_EVENT)
5550 Lisp_Object first_event
;
5553 Lisp_Object original_uppercase
;
5554 int original_uppercase_position
= -1;
5556 /* Gets around Microsoft compiler limitations. */
5559 struct buffer
*starting_buffer
;
5561 /* Nonzero if we seem to have got the beginning of a binding
5562 in function_key_map. */
5563 int function_key_possible
= 0;
5564 int key_translation_possible
= 0;
5566 /* Save the status of key translation before each step,
5567 so that we can restore this after downcasing. */
5568 Lisp_Object prev_fkey_map
;
5569 Lisp_Object prev_fkey_start
;
5570 Lisp_Object prev_fkey_end
;
5572 Lisp_Object prev_keytran_map
;
5573 Lisp_Object prev_keytran_start
;
5574 Lisp_Object prev_keytran_end
;
5578 last_nonmenu_event
= Qnil
;
5580 delayed_switch_frame
= Qnil
;
5581 fkey_map
= Vfunction_key_map
;
5582 keytran_map
= Vkey_translation_map
;
5584 /* If there is no function-key-map, turn off function key scanning. */
5585 if (NILP (Fkeymapp (Vfunction_key_map
)))
5586 fkey_start
= fkey_end
= bufsize
+ 1;
5588 /* If there is no key-translation-map, turn off scanning. */
5589 if (NILP (Fkeymapp (Vkey_translation_map
)))
5590 keytran_start
= keytran_end
= bufsize
+ 1;
5595 echo_prompt (XSTRING (prompt
)->data
);
5596 else if (cursor_in_echo_area
&& echo_keystrokes
)
5597 /* This doesn't put in a dash if the echo buffer is empty, so
5598 you don't always see a dash hanging out in the minibuffer. */
5602 /* Record the initial state of the echo area and this_command_keys;
5603 we will need to restore them if we replay a key sequence. */
5605 echo_start
= echo_length ();
5606 keys_start
= this_command_key_count
;
5608 #if defined (GOBBLE_FIRST_EVENT)
5609 /* This doesn't quite work, because some of the things that read_char
5610 does cannot safely be bypassed. It seems too risky to try to make
5613 /* Read the first char of the sequence specially, before setting
5614 up any keymaps, in case a filter runs and switches buffers on us. */
5615 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
5617 #endif /* GOBBLE_FIRST_EVENT */
5619 orig_local_map
= get_local_map (PT
, current_buffer
);
5621 /* We jump here when the key sequence has been thoroughly changed, and
5622 we need to rescan it starting from the beginning. When we jump here,
5623 keybuf[0..mock_input] holds the sequence we should reread. */
5626 starting_buffer
= current_buffer
;
5627 function_key_possible
= 0;
5628 key_translation_possible
= 0;
5630 /* Build our list of keymaps.
5631 If we recognize a function key and replace its escape sequence in
5632 keybuf with its symbol, or if the sequence starts with a mouse
5633 click and we need to switch buffers, we jump back here to rebuild
5634 the initial keymaps from the current buffer. */
5638 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
5639 || !NILP (Voverriding_local_map
))
5641 if (3 > nmaps_allocated
)
5643 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
5644 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
5645 nmaps_allocated
= 3;
5648 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5649 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5650 if (!NILP (Voverriding_local_map
))
5651 submaps
[nmaps
++] = Voverriding_local_map
;
5655 nmaps
= current_minor_maps (0, &maps
);
5656 if (nmaps
+ 2 > nmaps_allocated
)
5658 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
5659 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
5660 nmaps_allocated
= nmaps
+ 2;
5662 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
5663 #ifdef USE_TEXT_PROPERTIES
5664 submaps
[nmaps
++] = orig_local_map
;
5666 submaps
[nmaps
++] = current_buffer
->keymap
;
5669 submaps
[nmaps
++] = current_global_map
;
5672 /* Find an accurate initial value for first_binding. */
5673 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
5674 if (! NILP (submaps
[first_binding
]))
5677 /* Start from the beginning in keybuf. */
5680 /* These are no-ops the first time through, but if we restart, they
5681 revert the echo area and this_command_keys to their original state. */
5682 this_command_key_count
= keys_start
;
5683 if (INTERACTIVE
&& t
< mock_input
)
5684 echo_truncate (echo_start
);
5686 /* If the best binding for the current key sequence is a keymap, or
5687 we may be looking at a function key's escape sequence, keep on
5689 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
5690 || (first_binding
>= nmaps
5692 /* mock input is never part of a function key's sequence. */
5693 && mock_input
<= fkey_start
)
5694 || (first_binding
>= nmaps
5695 && keytran_start
< t
&& key_translation_possible
)
5696 /* Don't return in the middle of a possible function key sequence,
5697 if the only bindings we found were via case conversion.
5698 Thus, if ESC O a has a function-key-map translation
5699 and ESC o has a binding, don't return after ESC O,
5700 so that we can translate ESC O plus the next character. */
5704 int used_mouse_menu
= 0;
5706 /* Where the last real key started. If we need to throw away a
5707 key that has expanded into more than one element of keybuf
5708 (say, a mouse click on the mode line which is being treated
5709 as [mode-line (mouse-...)], then we backtrack to this point
5711 int last_real_key_start
;
5713 /* These variables are analogous to echo_start and keys_start;
5714 while those allow us to restart the entire key sequence,
5715 echo_local_start and keys_local_start allow us to throw away
5717 int echo_local_start
, keys_local_start
, local_first_binding
;
5720 error ("Key sequence too long");
5723 echo_local_start
= echo_length ();
5724 keys_local_start
= this_command_key_count
;
5725 local_first_binding
= first_binding
;
5728 /* These are no-ops, unless we throw away a keystroke below and
5729 jumped back up to replay_key; in that case, these restore the
5730 variables to their original state, allowing us to replay the
5732 if (INTERACTIVE
&& t
< mock_input
)
5733 echo_truncate (echo_local_start
);
5734 this_command_key_count
= keys_local_start
;
5735 first_binding
= local_first_binding
;
5737 /* By default, assume each event is "real". */
5738 last_real_key_start
= t
;
5740 /* Does mock_input indicate that we are re-reading a key sequence? */
5744 add_command_key (key
);
5745 if (echo_keystrokes
)
5749 /* If not, we should actually read a character. */
5752 struct buffer
*buf
= current_buffer
;
5756 KBOARD
*interrupted_kboard
= current_kboard
;
5757 struct frame
*interrupted_frame
= selected_frame
;
5758 if (setjmp (wrong_kboard_jmpbuf
))
5760 if (!NILP (delayed_switch_frame
))
5762 interrupted_kboard
->kbd_queue
5763 = Fcons (delayed_switch_frame
,
5764 interrupted_kboard
->kbd_queue
);
5765 delayed_switch_frame
= Qnil
;
5768 interrupted_kboard
->kbd_queue
5769 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
5771 /* If the side queue is non-empty, ensure it begins with a
5772 switch-frame, so we'll replay it in the right context. */
5773 if (CONSP (interrupted_kboard
->kbd_queue
)
5774 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
5775 !(EVENT_HAS_PARAMETERS (key
)
5776 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
5780 XSETFRAME (frame
, interrupted_frame
);
5781 interrupted_kboard
->kbd_queue
5782 = Fcons (make_lispy_switch_frame (frame
),
5783 interrupted_kboard
->kbd_queue
);
5786 orig_local_map
= get_local_map (PT
, current_buffer
);
5787 goto replay_sequence
;
5790 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
5794 /* read_char returns t when it shows a menu and the user rejects it.
5799 /* read_char returns -1 at the end of a macro.
5800 Emacs 18 handles this by returning immediately with a
5801 zero, so that's what we'll do. */
5802 if (INTEGERP (key
) && XINT (key
) == -1)
5805 /* The Microsoft C compiler can't handle the goto that
5811 /* If the current buffer has been changed from under us, the
5812 keymap may have changed, so replay the sequence. */
5816 orig_local_map
= get_local_map (PT
, current_buffer
);
5817 goto replay_sequence
;
5820 /* If we have a quit that was typed in another frame, and
5821 quit_throw_to_read_char switched buffers,
5822 replay to get the right keymap. */
5823 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
5828 orig_local_map
= get_local_map (PT
, current_buffer
);
5829 goto replay_sequence
;
5835 /* Clicks in non-text areas get prefixed by the symbol
5836 in their CHAR-ADDRESS field. For example, a click on
5837 the mode line is prefixed by the symbol `mode-line'.
5839 Furthermore, key sequences beginning with mouse clicks
5840 are read using the keymaps of the buffer clicked on, not
5841 the current buffer. So we may have to switch the buffer
5844 When we turn one event into two events, we must make sure
5845 that neither of the two looks like the original--so that,
5846 if we replay the events, they won't be expanded again.
5847 If not for this, such reexpansion could happen either here
5848 or when user programs play with this-command-keys. */
5849 if (EVENT_HAS_PARAMETERS (key
))
5853 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
5854 if (EQ (kind
, Qmouse_click
))
5856 Lisp_Object window
, posn
;
5858 window
= POSN_WINDOW (EVENT_START (key
));
5859 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
5862 /* We're looking at the second event of a
5863 sequence which we expanded before. Set
5864 last_real_key_start appropriately. */
5866 last_real_key_start
= t
- 1;
5869 /* Key sequences beginning with mouse clicks are
5870 read using the keymaps in the buffer clicked on,
5871 not the current buffer. If we're at the
5872 beginning of a key sequence, switch buffers. */
5873 if (last_real_key_start
== 0
5875 && BUFFERP (XWINDOW (window
)->buffer
)
5876 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
5881 /* Arrange to go back to the original buffer once we're
5882 done reading the key sequence. Note that we can't
5883 use save_excursion_{save,restore} here, because they
5884 save point as well as the current buffer; we don't
5885 want to save point, because redisplay may change it,
5886 to accommodate a Fset_window_start or something. We
5887 don't want to do this at the top of the function,
5888 because we may get input from a subprocess which
5889 wants to change the selected window and stuff (say,
5891 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5893 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
5894 orig_local_map
= get_local_map (PT
, current_buffer
);
5895 goto replay_sequence
;
5897 /* For a mouse click, get the local text-property keymap
5898 of the place clicked on, rather than point. */
5899 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
5900 && ! localized_local_map
)
5902 Lisp_Object map_here
, start
, pos
;
5904 localized_local_map
= 1;
5905 start
= EVENT_START (key
);
5906 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
5908 pos
= POSN_BUFFER_POSN (start
);
5910 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
5912 map_here
= get_local_map (XINT (pos
), current_buffer
);
5913 if (!EQ (map_here
, orig_local_map
))
5915 orig_local_map
= map_here
;
5919 goto replay_sequence
;
5925 /* Expand mode-line and scroll-bar events into two events:
5926 use posn as a fake prefix key. */
5929 if (t
+ 1 >= bufsize
)
5930 error ("Key sequence too long");
5935 /* Zap the position in key, so we know that we've
5936 expanded it, and don't try to do so again. */
5937 POSN_BUFFER_POSN (EVENT_START (key
))
5938 = Fcons (posn
, Qnil
);
5942 else if (EQ (kind
, Qswitch_frame
))
5944 /* If we're at the beginning of a key sequence, and the caller
5945 says it's okay, go ahead and return this event. If we're
5946 in the midst of a key sequence, delay it until the end. */
5947 if (t
> 0 || !can_return_switch_frame
)
5949 delayed_switch_frame
= key
;
5953 else if (CONSP (XCONS (key
)->cdr
)
5954 && CONSP (EVENT_START (key
))
5955 && CONSP (XCONS (EVENT_START (key
))->cdr
))
5959 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
5960 /* Handle menu-bar events:
5961 insert the dummy prefix event `menu-bar'. */
5962 if (EQ (posn
, Qmenu_bar
))
5964 if (t
+ 1 >= bufsize
)
5965 error ("Key sequence too long");
5969 /* Zap the position in key, so we know that we've
5970 expanded it, and don't try to do so again. */
5971 POSN_BUFFER_POSN (EVENT_START (key
))
5972 = Fcons (posn
, Qnil
);
5975 goto replay_sequence
;
5977 else if (CONSP (posn
))
5979 /* We're looking at the second event of a
5980 sequence which we expanded before. Set
5981 last_real_key_start appropriately. */
5982 if (last_real_key_start
== t
&& t
> 0)
5983 last_real_key_start
= t
- 1;
5988 /* We have finally decided that KEY is something we might want
5990 first_binding
= (follow_key (key
,
5991 nmaps
- first_binding
,
5992 submaps
+ first_binding
,
5993 defs
+ first_binding
,
5994 submaps
+ first_binding
)
5997 /* If KEY wasn't bound, we'll try some fallbacks. */
5998 if (first_binding
>= nmaps
)
6002 head
= EVENT_HEAD (key
);
6003 if (help_char_p (head
) && t
> 0)
6005 read_key_sequence_cmd
= Vprefix_help_command
;
6007 last_nonmenu_event
= key
;
6008 /* The Microsoft C compiler can't handle the goto that
6016 Lisp_Object breakdown
;
6019 breakdown
= parse_modifiers (head
);
6020 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6021 /* Attempt to reduce an unbound mouse event to a simpler
6022 event that is bound:
6023 Drags reduce to clicks.
6024 Double-clicks reduce to clicks.
6025 Triple-clicks reduce to double-clicks, then to clicks.
6026 Down-clicks are eliminated.
6027 Double-downs reduce to downs, then are eliminated.
6028 Triple-downs reduce to double-downs, then to downs,
6029 then are eliminated. */
6030 if (modifiers
& (down_modifier
| drag_modifier
6031 | double_modifier
| triple_modifier
))
6033 while (modifiers
& (down_modifier
| drag_modifier
6034 | double_modifier
| triple_modifier
))
6036 Lisp_Object new_head
, new_click
;
6037 if (modifiers
& triple_modifier
)
6038 modifiers
^= (double_modifier
| triple_modifier
);
6039 else if (modifiers
& double_modifier
)
6040 modifiers
&= ~double_modifier
;
6041 else if (modifiers
& drag_modifier
)
6042 modifiers
&= ~drag_modifier
;
6045 /* Dispose of this `down' event by simply jumping
6046 back to replay_key, to get another event.
6048 Note that if this event came from mock input,
6049 then just jumping back to replay_key will just
6050 hand it to us again. So we have to wipe out any
6053 We could delete keybuf[t] and shift everything
6054 after that to the left by one spot, but we'd also
6055 have to fix up any variable that points into
6056 keybuf, and shifting isn't really necessary
6059 Adding prefixes for non-textual mouse clicks
6060 creates two characters of mock input, and both
6061 must be thrown away. If we're only looking at
6062 the prefix now, we can just jump back to
6063 replay_key. On the other hand, if we've already
6064 processed the prefix, and now the actual click
6065 itself is giving us trouble, then we've lost the
6066 state of the keymaps we want to backtrack to, and
6067 we need to replay the whole sequence to rebuild
6070 Beyond that, only function key expansion could
6071 create more than two keys, but that should never
6072 generate mouse events, so it's okay to zero
6073 mock_input in that case too.
6075 Isn't this just the most wonderful code ever? */
6076 if (t
== last_real_key_start
)
6083 mock_input
= last_real_key_start
;
6084 goto replay_sequence
;
6089 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6091 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6093 /* Look for a binding for this new key. follow_key
6094 promises that it didn't munge submaps the
6095 last time we called it, since key was unbound. */
6097 = (follow_key (new_click
,
6098 nmaps
- local_first_binding
,
6099 submaps
+ local_first_binding
,
6100 defs
+ local_first_binding
,
6101 submaps
+ local_first_binding
)
6102 + local_first_binding
);
6104 /* If that click is bound, go for it. */
6105 if (first_binding
< nmaps
)
6110 /* Otherwise, we'll leave key set to the drag event. */
6117 /* Normally, last_nonmenu_event gets the previous key we read.
6118 But when a mouse popup menu is being used,
6119 we don't update last_nonmenu_event; it continues to hold the mouse
6120 event that preceded the first level of menu. */
6121 if (!used_mouse_menu
)
6122 last_nonmenu_event
= key
;
6124 prev_fkey_map
= fkey_map
;
6125 prev_fkey_start
= fkey_start
;
6126 prev_fkey_end
= fkey_end
;
6128 prev_keytran_map
= keytran_map
;
6129 prev_keytran_start
= keytran_start
;
6130 prev_keytran_end
= keytran_end
;
6132 /* If the sequence is unbound, see if we can hang a function key
6133 off the end of it. We only want to scan real keyboard input
6134 for function key sequences, so if mock_input says that we're
6135 re-reading old events, don't examine it. */
6136 if (first_binding
>= nmaps
6139 Lisp_Object fkey_next
;
6141 /* Continue scan from fkey_end until we find a bound suffix.
6142 If we fail, increment fkey_start
6143 and start fkey_end from there. */
6144 while (fkey_end
< t
)
6148 key
= keybuf
[fkey_end
++];
6149 /* Look up meta-characters by prefixing them
6150 with meta_prefix_char. I hate this. */
6151 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6156 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
6158 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6161 fkey_next
= fkey_map
;
6164 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
6166 #if 0 /* I didn't turn this on, because it might cause trouble
6167 for the mapping of return into C-m and tab into C-i. */
6168 /* Optionally don't map function keys into other things.
6169 This enables the user to redefine kp- keys easily. */
6170 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6174 /* If the function key map gives a function, not an
6175 array, then call the function with no args and use
6176 its value instead. */
6177 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6180 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6184 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6185 fkey_next
= call1 (fkey_next
, prompt
);
6187 /* If the function returned something invalid,
6188 barf--don't ignore it.
6189 (To ignore it safely, we would need to gcpro a bunch of
6190 other variables.) */
6191 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6192 error ("Function in function-key-map returns invalid key sequence");
6195 function_key_possible
= ! NILP (fkey_next
);
6197 /* If keybuf[fkey_start..fkey_end] is bound in the
6198 function key map and it's a suffix of the current
6199 sequence (i.e. fkey_end == t), replace it with
6200 the binding and restart with fkey_start at the end. */
6201 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6204 int len
= XFASTINT (Flength (fkey_next
));
6206 t
= fkey_start
+ len
;
6208 error ("Key sequence too long");
6210 if (VECTORP (fkey_next
))
6211 bcopy (XVECTOR (fkey_next
)->contents
,
6212 keybuf
+ fkey_start
,
6213 (t
- fkey_start
) * sizeof (keybuf
[0]));
6214 else if (STRINGP (fkey_next
))
6218 for (i
= 0; i
< len
; i
++)
6219 XSETFASTINT (keybuf
[fkey_start
+ i
],
6220 XSTRING (fkey_next
)->data
[i
]);
6224 fkey_start
= fkey_end
= t
;
6225 fkey_map
= Vfunction_key_map
;
6227 /* Do pass the results through key-translation-map. */
6228 keytran_start
= keytran_end
= 0;
6229 keytran_map
= Vkey_translation_map
;
6231 goto replay_sequence
;
6234 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6236 /* If we no longer have a bound suffix, try a new positions for
6238 if (NILP (fkey_map
))
6240 fkey_end
= ++fkey_start
;
6241 fkey_map
= Vfunction_key_map
;
6242 function_key_possible
= 0;
6247 /* Look for this sequence in key-translation-map. */
6249 Lisp_Object keytran_next
;
6251 /* Scan from keytran_end until we find a bound suffix. */
6252 while (keytran_end
< t
)
6256 key
= keybuf
[keytran_end
++];
6257 /* Look up meta-characters by prefixing them
6258 with meta_prefix_char. I hate this. */
6259 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6264 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
6266 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6269 keytran_next
= keytran_map
;
6272 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
6274 /* If the key translation map gives a function, not an
6275 array, then call the function with no args and use
6276 its value instead. */
6277 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6278 && keytran_end
== t
)
6280 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6284 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6285 keytran_next
= call1 (keytran_next
, prompt
);
6287 /* If the function returned something invalid,
6288 barf--don't ignore it.
6289 (To ignore it safely, we would need to gcpro a bunch of
6290 other variables.) */
6291 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6292 error ("Function in key-translation-map returns invalid key sequence");
6295 key_translation_possible
= ! NILP (keytran_next
);
6297 /* If keybuf[keytran_start..keytran_end] is bound in the
6298 key translation map and it's a suffix of the current
6299 sequence (i.e. keytran_end == t), replace it with
6300 the binding and restart with keytran_start at the end. */
6301 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6302 && keytran_end
== t
)
6304 int len
= XFASTINT (Flength (keytran_next
));
6306 t
= keytran_start
+ len
;
6308 error ("Key sequence too long");
6310 if (VECTORP (keytran_next
))
6311 bcopy (XVECTOR (keytran_next
)->contents
,
6312 keybuf
+ keytran_start
,
6313 (t
- keytran_start
) * sizeof (keybuf
[0]));
6314 else if (STRINGP (keytran_next
))
6318 for (i
= 0; i
< len
; i
++)
6319 XSETFASTINT (keybuf
[keytran_start
+ i
],
6320 XSTRING (keytran_next
)->data
[i
]);
6324 keytran_start
= keytran_end
= t
;
6325 keytran_map
= Vkey_translation_map
;
6327 /* Don't pass the results of key-translation-map
6328 through function-key-map. */
6329 fkey_start
= fkey_end
= t
;
6330 fkey_map
= Vkey_translation_map
;
6332 goto replay_sequence
;
6335 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6337 /* If we no longer have a bound suffix, try a new positions for
6339 if (NILP (keytran_map
))
6341 keytran_end
= ++keytran_start
;
6342 keytran_map
= Vkey_translation_map
;
6343 key_translation_possible
= 0;
6348 /* If KEY is not defined in any of the keymaps,
6349 and cannot be part of a function key or translation,
6350 and is an upper case letter
6351 use the corresponding lower-case letter instead. */
6352 if (first_binding
== nmaps
&& ! function_key_possible
6353 && ! key_translation_possible
6355 && ((((XINT (key
) & 0x3ffff)
6356 < XSTRING (current_buffer
->downcase_table
)->size
)
6357 && UPPERCASEP (XINT (key
) & 0x3ffff))
6358 || (XINT (key
) & shift_modifier
)))
6360 Lisp_Object new_key
;
6362 original_uppercase
= key
;
6363 original_uppercase_position
= t
- 1;
6365 if (XINT (new_key
) & shift_modifier
)
6366 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6368 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6369 | (XINT (key
) & ~0x3ffff)));
6371 /* We have to do this unconditionally, regardless of whether
6372 the lower-case char is defined in the keymaps, because they
6373 might get translated through function-key-map. */
6374 keybuf
[t
- 1] = new_key
;
6377 fkey_map
= prev_fkey_map
;
6378 fkey_start
= prev_fkey_start
;
6379 fkey_end
= prev_fkey_end
;
6381 keytran_map
= prev_keytran_map
;
6382 keytran_start
= prev_keytran_start
;
6383 keytran_end
= prev_keytran_end
;
6385 goto replay_sequence
;
6387 /* If KEY is not defined in any of the keymaps,
6388 and cannot be part of a function key or translation,
6389 and is a shifted function key,
6390 use the corresponding unshifted function key instead. */
6391 if (first_binding
== nmaps
&& ! function_key_possible
6392 && ! key_translation_possible
6395 Lisp_Object breakdown
;
6398 breakdown
= parse_modifiers (key
);
6399 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6400 if (modifiers
& shift_modifier
)
6402 Lisp_Object new_key
;
6404 original_uppercase
= key
;
6405 original_uppercase_position
= t
- 1;
6407 modifiers
&= ~shift_modifier
;
6408 new_key
= apply_modifiers (modifiers
,
6409 XCONS (breakdown
)->car
);
6411 keybuf
[t
- 1] = new_key
;
6414 fkey_map
= prev_fkey_map
;
6415 fkey_start
= prev_fkey_start
;
6416 fkey_end
= prev_fkey_end
;
6418 keytran_map
= prev_keytran_map
;
6419 keytran_start
= prev_keytran_start
;
6420 keytran_end
= prev_keytran_end
;
6422 goto replay_sequence
;
6428 read_key_sequence_cmd
= (first_binding
< nmaps
6429 ? defs
[first_binding
]
6432 unread_switch_frame
= delayed_switch_frame
;
6433 unbind_to (count
, Qnil
);
6435 /* Don't downcase the last character if the caller says don't.
6436 Don't downcase it if the result is undefined, either. */
6437 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6438 && t
- 1 == original_uppercase_position
)
6439 keybuf
[t
- 1] = original_uppercase
;
6441 /* Occasionally we fabricate events, perhaps by expanding something
6442 according to function-key-map, or by adding a prefix symbol to a
6443 mouse click in the scroll bar or modeline. In this cases, return
6444 the entire generated key sequence, even if we hit an unbound
6445 prefix or a definition before the end. This means that you will
6446 be able to push back the event properly, and also means that
6447 read-key-sequence will always return a logical unit.
6450 for (; t
< mock_input
; t
++)
6452 if (echo_keystrokes
)
6453 echo_char (keybuf
[t
]);
6454 add_command_key (keybuf
[t
]);
6460 #if 0 /* This doc string is too long for some compilers.
6461 This commented-out definition serves for DOC. */
6462 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6463 "Read a sequence of keystrokes and return as a string or vector.\n\
6464 The sequence is sufficient to specify a non-prefix command in the\n\
6465 current local and global maps.\n\
6467 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6468 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6469 as a continuation of the previous key.\n\
6471 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6472 convert the last event to lower case. (Normally any upper case event\n\
6473 is converted to lower case if the original event is undefined and the lower\n\
6474 case equivalent is defined.) A non-nil value is appropriate for reading\n\
6475 a key sequence to be defined.\n\
6477 A C-g typed while in this function is treated like any other character,\n\
6478 and `quit-flag' is not set.\n\
6480 If the key sequence starts with a mouse click, then the sequence is read\n\
6481 using the keymaps of the buffer of the window clicked in, not the buffer\n\
6482 of the selected window as normal.\n\
6484 `read-key-sequence' drops unbound button-down events, since you normally\n\
6485 only care about the click or drag events which follow them. If a drag\n\
6486 or multi-click event is unbound, but the corresponding click event would\n\
6487 be bound, `read-key-sequence' turns the event into a click event at the\n\
6488 drag's starting position. This means that you don't have to distinguish\n\
6489 between click and drag, double, or triple events unless you want to.\n\
6491 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
6492 lines separating windows, and scroll bars with imaginary keys\n\
6493 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
6495 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
6496 function will process a switch-frame event if the user switches frames\n\
6497 before typing anything. If the user switches frames in the middle of a\n\
6498 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
6499 is nil, then the event will be put off until after the current key sequence.\n\
6501 `read-key-sequence' checks `function-key-map' for function key\n\
6502 sequences, where they wouldn't conflict with ordinary bindings. See\n\
6503 `function-key-map' for more details.")
6504 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6507 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6509 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6510 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
6511 Lisp_Object can_return_switch_frame
;
6513 Lisp_Object keybuf
[30];
6515 struct gcpro gcpro1
, gcpro2
;
6518 CHECK_STRING (prompt
, 0);
6521 bzero (keybuf
, sizeof keybuf
);
6523 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
6525 if (NILP (continue_echo
))
6526 this_command_key_count
= 0;
6528 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
6529 prompt
, ! NILP (dont_downcase_last
),
6530 ! NILP (can_return_switch_frame
));
6538 return make_event_array (i
, keybuf
);
6541 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 3, 0,
6542 "Execute CMD as an editor command.\n\
6543 CMD must be a symbol that satisfies the `commandp' predicate.\n\
6544 Optional second arg RECORD-FLAG non-nil\n\
6545 means unconditionally put this command in `command-history'.\n\
6546 Otherwise, that is done only if an arg is read using the minibuffer.\n\
6547 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
6548 when reading the arguments; if it is nil, (this_command_key_count) is used.")
6549 (cmd
, record_flag
, keys
)
6550 Lisp_Object cmd
, record_flag
, keys
;
6552 register Lisp_Object final
;
6553 register Lisp_Object tem
;
6554 Lisp_Object prefixarg
;
6555 struct backtrace backtrace
;
6556 extern int debug_on_next_call
;
6558 prefixarg
= current_kboard
->Vprefix_arg
;
6559 current_kboard
->Vprefix_arg
= Qnil
;
6560 Vcurrent_prefix_arg
= prefixarg
;
6561 debug_on_next_call
= 0;
6565 tem
= Fget (cmd
, Qdisabled
);
6566 if (!NILP (tem
) && !NILP (Vrun_hooks
))
6568 tem
= Fsymbol_value (Qdisabled_command_hook
);
6570 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
6576 final
= Findirect_function (cmd
);
6578 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
6579 do_autoload (final
, cmd
);
6584 if (STRINGP (final
) || VECTORP (final
))
6586 /* If requested, place the macro in the command history. For
6587 other sorts of commands, call-interactively takes care of
6589 if (!NILP (record_flag
))
6591 = Fcons (Fcons (Qexecute_kbd_macro
,
6592 Fcons (final
, Fcons (prefixarg
, Qnil
))),
6595 return Fexecute_kbd_macro (final
, prefixarg
);
6597 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
6599 backtrace
.next
= backtrace_list
;
6600 backtrace_list
= &backtrace
;
6601 backtrace
.function
= &Qcall_interactively
;
6602 backtrace
.args
= &cmd
;
6603 backtrace
.nargs
= 1;
6604 backtrace
.evalargs
= 0;
6606 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
6608 backtrace_list
= backtrace
.next
;
6614 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
6616 "Read function name, then read its arguments and call it.")
6618 Lisp_Object prefixarg
;
6620 Lisp_Object function
;
6622 Lisp_Object saved_keys
;
6623 struct gcpro gcpro1
;
6625 saved_keys
= Fvector (this_command_key_count
,
6626 XVECTOR (this_command_keys
)->contents
);
6628 GCPRO1 (saved_keys
);
6630 if (EQ (prefixarg
, Qminus
))
6632 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
6633 strcpy (buf
, "C-u ");
6634 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
6636 if (sizeof (int) == sizeof (EMACS_INT
))
6637 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
6638 else if (sizeof (long) == sizeof (EMACS_INT
))
6639 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
6643 else if (INTEGERP (prefixarg
))
6645 if (sizeof (int) == sizeof (EMACS_INT
))
6646 sprintf (buf
, "%d ", XINT (prefixarg
));
6647 else if (sizeof (long) == sizeof (EMACS_INT
))
6648 sprintf (buf
, "%ld ", XINT (prefixarg
));
6653 /* This isn't strictly correct if execute-extended-command
6654 is bound to anything else. Perhaps it should use
6655 this_command_keys? */
6656 strcat (buf
, "M-x ");
6658 /* Prompt with buf, and then read a string, completing from and
6659 restricting to the set of all defined commands. Don't provide
6660 any initial input. Save the command read on the extended-command
6662 function
= Fcompleting_read (build_string (buf
),
6663 Vobarray
, Qcommandp
,
6664 Qt
, Qnil
, Qextended_command_history
);
6666 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
6667 error ("No command name given");
6669 /* Set this_command_keys to the concatenation of saved_keys and
6670 function, followed by a RET. */
6672 struct Lisp_String
*str
;
6677 this_command_key_count
= 0;
6679 keys
= XVECTOR (saved_keys
)->contents
;
6680 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
6681 add_command_key (keys
[i
]);
6683 str
= XSTRING (function
);
6684 for (i
= 0; i
< str
->size
; i
++)
6686 XSETFASTINT (tem
, str
->data
[i
]);
6687 add_command_key (tem
);
6690 XSETFASTINT (tem
, '\015');
6691 add_command_key (tem
);
6696 function
= Fintern (function
, Qnil
);
6697 current_kboard
->Vprefix_arg
= prefixarg
;
6698 this_command
= function
;
6700 /* If enabled, show which key runs this command. */
6701 if (!NILP (Vsuggest_key_bindings
)
6702 && SYMBOLP (function
))
6704 Lisp_Object bindings
;
6706 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
6709 if (!NILP (bindings
))
6711 message ("You can run the command `%s' by typing %s",
6712 XSYMBOL (function
)->name
->data
,
6713 XSTRING (Fkey_description (bindings
))->data
);
6714 Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
6715 ? Vsuggest_key_bindings
: make_number (2)),
6720 return Fcommand_execute (function
, Qt
, Qnil
);
6723 /* Find the set of keymaps now active.
6724 Store into *MAPS_P a vector holding the various maps
6725 and return the number of them. The vector was malloc'd
6726 and the caller should free it. */
6729 current_active_maps (maps_p
)
6730 Lisp_Object
**maps_p
;
6732 Lisp_Object
*tmaps
, *maps
;
6735 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6736 if (!NILP (Voverriding_local_map_menu_flag
))
6738 /* Yes, use them (if non-nil) as well as the global map. */
6739 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
6741 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6742 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6743 if (!NILP (Voverriding_local_map
))
6744 maps
[nmaps
++] = Voverriding_local_map
;
6748 /* No, so use major and minor mode keymaps. */
6749 nmaps
= current_minor_maps (NULL
, &tmaps
);
6750 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
6751 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
6752 #ifdef USE_TEXT_PROPERTIES
6753 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
6755 maps
[nmaps
++] = current_buffer
->keymap
;
6758 maps
[nmaps
++] = current_global_map
;
6765 detect_input_pending ()
6768 get_input_pending (&input_pending
);
6770 return input_pending
;
6773 /* This is called in some cases before a possible quit.
6774 It cases the next call to detect_input_pending to recompute input_pending.
6775 So calling this function unnecessarily can't do any harm. */
6776 clear_input_pending ()
6781 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
6782 "T if command input is currently available with no waiting.\n\
6783 Actually, the value is nil only if we can be sure that no input is available.")
6786 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
6789 return detect_input_pending () ? Qt
: Qnil
;
6792 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
6793 "Return vector of last 100 events, not counting those from keyboard macros.")
6796 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
6799 if (total_keys
< NUM_RECENT_KEYS
)
6800 return Fvector (total_keys
, keys
);
6803 val
= Fvector (NUM_RECENT_KEYS
, keys
);
6804 bcopy (keys
+ recent_keys_index
,
6805 XVECTOR (val
)->contents
,
6806 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
6808 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
6809 recent_keys_index
* sizeof (Lisp_Object
));
6814 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
6815 "Return the key sequence that invoked this command.\n\
6816 The value is a string or a vector.")
6819 return make_event_array (this_command_key_count
,
6820 XVECTOR (this_command_keys
)->contents
);
6823 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
6824 Sreset_this_command_lengths
, 0, 0, 0,
6825 "Used for complicated reasons in `universal-argument-other-key'.\n\
6827 `universal-argument-other-key' rereads the event just typed.\n\
6828 It then gets translated through `function-key-map'.\n\
6829 The translated event gets included in the echo area and in\n\
6830 the value of `this-command-keys' in addition to the raw original event.\n\
6831 That is not right.\n\
6833 Calling this function directs the translated event to replace\n\
6834 the original event, so that only one version of the event actually\n\
6835 appears in the echo area and in the value of `this-command-keys.'.")
6838 before_command_restore_flag
= 1;
6839 before_command_key_count_1
= before_command_key_count
;
6840 before_command_echo_length_1
= before_command_echo_length
;
6843 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
6844 "Return the current depth in recursive edits.")
6848 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
6852 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
6853 "FOpen dribble file: ",
6854 "Start writing all keyboard characters to a dribble file called FILE.\n\
6855 If FILE is nil, close any open dribble file.")
6869 file
= Fexpand_file_name (file
, Qnil
);
6870 dribble
= fopen (XSTRING (file
)->data
, "w");
6875 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
6876 "Discard the contents of the terminal input buffer.\n\
6877 Also cancel any kbd macro being defined.")
6880 current_kboard
->defining_kbd_macro
= Qnil
;
6881 update_mode_lines
++;
6883 Vunread_command_events
= Qnil
;
6884 unread_command_char
= -1;
6886 discard_tty_input ();
6888 /* Without the cast, GCC complains that this assignment loses the
6889 volatile qualifier of kbd_store_ptr. Is there anything wrong
6891 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
6892 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
6898 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
6899 "Stop Emacs and return to superior process. You can resume later.\n\
6900 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
6901 control, run a subshell instead.\n\n\
6902 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
6903 to be read as terminal input by Emacs's parent, after suspension.\n\
6905 Before suspending, run the normal hook `suspend-hook'.\n\
6906 After resumption run the normal hook `suspend-resume-hook'.\n\
6908 Some operating systems cannot stop the Emacs process and resume it later.\n\
6909 On such systems, Emacs starts a subshell instead of suspending.")
6911 Lisp_Object stuffstring
;
6914 int count
= specpdl_ptr
- specpdl
;
6915 int old_height
, old_width
;
6917 struct gcpro gcpro1
, gcpro2
;
6918 extern init_sys_modes ();
6920 if (!NILP (stuffstring
))
6921 CHECK_STRING (stuffstring
, 0);
6923 /* Run the functions in suspend-hook. */
6924 if (!NILP (Vrun_hooks
))
6925 call1 (Vrun_hooks
, intern ("suspend-hook"));
6927 GCPRO1 (stuffstring
);
6928 get_frame_size (&old_width
, &old_height
);
6930 /* sys_suspend can get an error if it tries to fork a subshell
6931 and the system resources aren't available for that. */
6932 record_unwind_protect (init_sys_modes
, 0);
6933 stuff_buffered_input (stuffstring
);
6938 unbind_to (count
, Qnil
);
6940 /* Check if terminal/window size has changed.
6941 Note that this is not useful when we are running directly
6942 with a window system; but suspend should be disabled in that case. */
6943 get_frame_size (&width
, &height
);
6944 if (width
!= old_width
|| height
!= old_height
)
6945 change_frame_size (selected_frame
, height
, width
, 0, 0);
6947 /* Run suspend-resume-hook. */
6948 if (!NILP (Vrun_hooks
))
6949 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
6955 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
6956 Then in any case stuff anything Emacs has read ahead and not used. */
6958 stuff_buffered_input (stuffstring
)
6959 Lisp_Object stuffstring
;
6961 /* stuff_char works only in BSD, versions 4.2 and up. */
6964 register unsigned char *p
;
6966 if (STRINGP (stuffstring
))
6970 p
= XSTRING (stuffstring
)->data
;
6971 count
= XSTRING (stuffstring
)->size
;
6976 /* Anything we have read ahead, put back for the shell to read. */
6977 /* ?? What should this do when we have multiple keyboards??
6978 Should we ignore anything that was typed in at the "wrong" kboard? */
6979 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
6981 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
6982 kbd_fetch_ptr
= kbd_buffer
;
6983 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
6984 stuff_char (kbd_fetch_ptr
->code
);
6985 kbd_fetch_ptr
->kind
= no_event
;
6986 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
6992 #endif /* BSD and not BSD4_1 */
6995 set_waiting_for_input (time_to_clear
)
6996 EMACS_TIME
*time_to_clear
;
6998 input_available_clear_time
= time_to_clear
;
7000 /* Tell interrupt_signal to throw back to read_char, */
7001 waiting_for_input
= 1;
7003 /* If interrupt_signal was called before and buffered a C-g,
7004 make it run again now, to avoid timing error. */
7005 if (!NILP (Vquit_flag
))
7006 quit_throw_to_read_char ();
7009 clear_waiting_for_input ()
7011 /* Tell interrupt_signal not to throw back to read_char, */
7012 waiting_for_input
= 0;
7013 input_available_clear_time
= 0;
7016 /* This routine is called at interrupt level in response to C-G.
7017 If interrupt_input, this is the handler for SIGINT.
7018 Otherwise, it is called from kbd_buffer_store_event,
7019 in handling SIGIO or SIGTINT.
7021 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7022 immediately throw back to read_char.
7024 Otherwise it sets the Lisp variable quit-flag not-nil.
7025 This causes eval to throw, when it gets a chance.
7026 If quit-flag is already non-nil, it stops the job right away. */
7029 interrupt_signal (signalnum
) /* If we don't have an argument, */
7030 int signalnum
; /* some compilers complain in signal calls. */
7033 /* Must preserve main program's value of errno. */
7034 int old_errno
= errno
;
7037 if (!read_socket_hook
&& NILP (Vwindow_system
))
7039 /* USG systems forget handlers when they are used;
7040 must reestablish each time */
7041 signal (SIGINT
, interrupt_signal
);
7042 signal (SIGQUIT
, interrupt_signal
);
7048 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
7053 #ifdef SIGTSTP /* Support possible in later USG versions */
7055 * On systems which can suspend the current process and return to the original
7056 * shell, this command causes the user to end up back at the shell.
7057 * The "Auto-save" and "Abort" questions are not asked until
7058 * the user elects to return to emacs, at which point he can save the current
7059 * job and either dump core or continue.
7064 if (sys_suspend () == -1)
7066 printf ("Not running as a subprocess;\n");
7067 printf ("you can continue or abort.\n");
7070 /* Perhaps should really fork an inferior shell?
7071 But that would not provide any way to get back
7072 to the original shell, ever. */
7073 printf ("No support for stopping a process on this operating system;\n");
7074 printf ("you can continue or abort.\n");
7075 #endif /* not VMS */
7076 #endif /* not SIGTSTP */
7078 /* We must remain inside the screen area when the internal terminal
7079 is used. Note that [Enter] is not echoed by dos. */
7082 /* It doesn't work to autosave while GC is in progress;
7083 the code used for auto-saving doesn't cope with the mark bit. */
7084 if (!gc_in_progress
)
7086 printf ("Auto-save? (y or n) ");
7088 if (((c
= getchar ()) & ~040) == 'Y')
7090 Fdo_auto_save (Qt
, Qnil
);
7092 printf ("\r\nAuto-save done");
7093 #else /* not MSDOS */
7094 printf ("Auto-save done\n");
7095 #endif /* not MSDOS */
7097 while (c
!= '\n') c
= getchar ();
7101 /* During GC, it must be safe to reenable quitting again. */
7102 Vinhibit_quit
= Qnil
;
7105 #endif /* not MSDOS */
7106 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7107 printf ("but will instead do a real quit after garbage collection ends\r\n");
7112 printf ("\r\nAbort? (y or n) ");
7113 #else /* not MSDOS */
7115 printf ("Abort (and enter debugger)? (y or n) ");
7117 printf ("Abort (and dump core)? (y or n) ");
7118 #endif /* not VMS */
7119 #endif /* not MSDOS */
7121 if (((c
= getchar ()) & ~040) == 'Y')
7123 while (c
!= '\n') c
= getchar ();
7125 printf ("\r\nContinuing...\r\n");
7126 #else /* not MSDOS */
7127 printf ("Continuing...\n");
7128 #endif /* not MSDOS */
7134 /* If executing a function that wants to be interrupted out of
7135 and the user has not deferred quitting by binding `inhibit-quit'
7136 then quit right away. */
7137 if (immediate_quit
&& NILP (Vinhibit_quit
))
7141 Fsignal (Qquit
, Qnil
);
7144 /* Else request quit when it's safe */
7148 if (waiting_for_input
&& !echoing
)
7149 quit_throw_to_read_char ();
7154 /* Handle a C-g by making read_char return C-g. */
7156 quit_throw_to_read_char ()
7158 quit_error_check ();
7160 /* Prevent another signal from doing this before we finish. */
7161 clear_waiting_for_input ();
7164 Vunread_command_events
= Qnil
;
7165 unread_command_char
= -1;
7167 #if 0 /* Currently, sit_for is called from read_char without turning
7168 off polling. And that can call set_waiting_for_input.
7169 It seems to be harmless. */
7170 #ifdef POLL_FOR_INPUT
7171 /* May be > 1 if in recursive minibuffer. */
7172 if (poll_suppress_count
== 0)
7177 if (FRAMEP (internal_last_event_frame
)
7178 && XFRAME (internal_last_event_frame
) != selected_frame
)
7179 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7183 _longjmp (getcjmp
, 1);
7186 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7187 "Set mode of reading keyboard input.\n\
7188 First arg INTERRUPT non-nil means use input interrupts;\n\
7189 nil means use CBREAK mode.\n\
7190 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7191 (no effect except in CBREAK mode).\n\
7192 Third arg META t means accept 8-bit input (for a Meta key).\n\
7193 META nil means ignore the top bit, on the assumption it is parity.\n\
7194 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7195 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7196 See also `current-input-mode'.")
7197 (interrupt
, flow
, meta
, quit
)
7198 Lisp_Object interrupt
, flow
, meta
, quit
;
7201 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7202 error ("set-input-mode: QUIT must be an ASCII character");
7204 #ifdef POLL_FOR_INPUT
7209 /* this causes startup screen to be restored and messes with the mouse */
7214 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7215 if (read_socket_hook
)
7217 /* When using X, don't give the user a real choice,
7218 because we haven't implemented the mechanisms to support it. */
7219 #ifdef NO_SOCK_SIGIO
7220 interrupt_input
= 0;
7221 #else /* not NO_SOCK_SIGIO */
7222 interrupt_input
= 1;
7223 #endif /* NO_SOCK_SIGIO */
7226 interrupt_input
= !NILP (interrupt
);
7227 #else /* not SIGIO */
7228 interrupt_input
= 0;
7229 #endif /* not SIGIO */
7231 /* Our VMS input only works by interrupts, as of now. */
7233 interrupt_input
= 1;
7236 flow_control
= !NILP (flow
);
7239 else if (EQ (meta
, Qt
))
7244 /* Don't let this value be out of range. */
7245 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7251 #ifdef POLL_FOR_INPUT
7252 poll_suppress_count
= 1;
7258 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7259 "Return information about the way Emacs currently reads keyboard input.\n\
7260 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7261 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7262 nil, Emacs is using CBREAK mode.\n\
7263 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7264 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7265 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7266 META nil means ignoring the top bit, on the assumption it is parity.\n\
7267 META is neither t nor nil if accepting 8-bit input and using\n\
7268 all 8 bits as the character code.\n\
7269 QUIT is the character Emacs currently uses to quit.\n\
7270 The elements of this list correspond to the arguments of\n\
7276 val
[0] = interrupt_input
? Qt
: Qnil
;
7277 val
[1] = flow_control
? Qt
: Qnil
;
7278 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7279 XSETFASTINT (val
[3], quit_char
);
7281 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7286 * Set up a new kboard object with reasonable initial values.
7292 kb
->Voverriding_terminal_local_map
= Qnil
;
7293 kb
->Vlast_command
= Qnil
;
7294 kb
->Vprefix_arg
= Qnil
;
7295 kb
->kbd_queue
= Qnil
;
7296 kb
->kbd_queue_has_data
= 0;
7297 kb
->immediate_echo
= 0;
7298 kb
->echoptr
= kb
->echobuf
;
7299 kb
->echo_after_prompt
= -1;
7300 kb
->kbd_macro_buffer
= 0;
7301 kb
->kbd_macro_bufsize
= 0;
7302 kb
->defining_kbd_macro
= Qnil
;
7303 kb
->Vlast_kbd_macro
= Qnil
;
7304 kb
->reference_count
= 0;
7305 kb
->Vsystem_key_alist
= Qnil
;
7306 kb
->system_key_syms
= Qnil
;
7307 kb
->Vdefault_minibuffer_frame
= Qnil
;
7311 * Destroy the contents of a kboard object, but not the object itself.
7312 * We use this just before deleting it, or if we're going to initialize
7319 if (kb
->kbd_macro_buffer
)
7320 xfree (kb
->kbd_macro_buffer
);
7329 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7332 *kbp
= kb
->next_kboard
;
7340 /* This is correct before outermost invocation of the editor loop */
7341 command_loop_level
= -1;
7343 quit_char
= Ctl ('g');
7344 Vunread_command_events
= Qnil
;
7345 unread_command_char
= -1;
7347 recent_keys_index
= 0;
7348 kbd_fetch_ptr
= kbd_buffer
;
7349 kbd_store_ptr
= kbd_buffer
;
7350 kbd_buffer_frame_or_window
7351 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7353 do_mouse_tracking
= Qnil
;
7358 /* This means that command_loop_1 won't try to select anything the first
7360 internal_last_event_frame
= Qnil
;
7361 Vlast_event_frame
= internal_last_event_frame
;
7365 current_kboard
= initial_kboard
;
7367 wipe_kboard (current_kboard
);
7368 init_kboard (current_kboard
);
7371 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7373 kbd_buffer_frame_or_window
7374 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7375 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
7377 signal (SIGINT
, interrupt_signal
);
7378 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
7379 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7380 SIGQUIT and we can't tell which one it will give us. */
7381 signal (SIGQUIT
, interrupt_signal
);
7382 #endif /* HAVE_TERMIO */
7384 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7386 if (!noninteractive
)
7387 signal (SIGIO
, input_available_signal
);
7390 /* Use interrupt input by default, if it works and noninterrupt input
7391 has deficiencies. */
7393 #ifdef INTERRUPT_INPUT
7394 interrupt_input
= 1;
7396 interrupt_input
= 0;
7399 /* Our VMS input only works by interrupts, as of now. */
7401 interrupt_input
= 1;
7407 if (keyboard_init_hook
)
7408 (*keyboard_init_hook
) ();
7410 #ifdef POLL_FOR_INPUT
7411 poll_suppress_count
= 1;
7416 /* This type's only use is in syms_of_keyboard, to initialize the
7417 event header symbols and put properties on them. */
7424 struct event_head head_table
[] = {
7425 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
7426 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
7427 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
7428 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
7429 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
7430 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
7435 Qdisabled_command_hook
= intern ("disabled-command-hook");
7436 staticpro (&Qdisabled_command_hook
);
7438 Qself_insert_command
= intern ("self-insert-command");
7439 staticpro (&Qself_insert_command
);
7441 Qforward_char
= intern ("forward-char");
7442 staticpro (&Qforward_char
);
7444 Qbackward_char
= intern ("backward-char");
7445 staticpro (&Qbackward_char
);
7447 Qdisabled
= intern ("disabled");
7448 staticpro (&Qdisabled
);
7450 Qundefined
= intern ("undefined");
7451 staticpro (&Qundefined
);
7453 Qpre_command_hook
= intern ("pre-command-hook");
7454 staticpro (&Qpre_command_hook
);
7456 Qpost_command_hook
= intern ("post-command-hook");
7457 staticpro (&Qpost_command_hook
);
7459 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
7460 staticpro (&Qpost_command_idle_hook
);
7462 Qdeferred_action_function
= intern ("deferred-action-function");
7463 staticpro (&Qdeferred_action_function
);
7465 Qcommand_hook_internal
= intern ("command-hook-internal");
7466 staticpro (&Qcommand_hook_internal
);
7468 Qfunction_key
= intern ("function-key");
7469 staticpro (&Qfunction_key
);
7470 Qmouse_click
= intern ("mouse-click");
7471 staticpro (&Qmouse_click
);
7472 Qtimer_event
= intern ("timer-event");
7473 staticpro (&Qtimer_event
);
7475 Qmenu_enable
= intern ("menu-enable");
7476 staticpro (&Qmenu_enable
);
7478 Qmode_line
= intern ("mode-line");
7479 staticpro (&Qmode_line
);
7480 Qvertical_line
= intern ("vertical-line");
7481 staticpro (&Qvertical_line
);
7482 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
7483 staticpro (&Qvertical_scroll_bar
);
7484 Qmenu_bar
= intern ("menu-bar");
7485 staticpro (&Qmenu_bar
);
7487 Qabove_handle
= intern ("above-handle");
7488 staticpro (&Qabove_handle
);
7489 Qhandle
= intern ("handle");
7490 staticpro (&Qhandle
);
7491 Qbelow_handle
= intern ("below-handle");
7492 staticpro (&Qbelow_handle
);
7494 Qevent_kind
= intern ("event-kind");
7495 staticpro (&Qevent_kind
);
7496 Qevent_symbol_elements
= intern ("event-symbol-elements");
7497 staticpro (&Qevent_symbol_elements
);
7498 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
7499 staticpro (&Qevent_symbol_element_mask
);
7500 Qmodifier_cache
= intern ("modifier-cache");
7501 staticpro (&Qmodifier_cache
);
7503 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
7504 staticpro (&Qrecompute_lucid_menubar
);
7505 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
7506 staticpro (&Qactivate_menubar_hook
);
7508 Qpolling_period
= intern ("polling-period");
7509 staticpro (&Qpolling_period
);
7512 struct event_head
*p
;
7514 for (p
= head_table
;
7515 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
7518 *p
->var
= intern (p
->name
);
7520 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
7521 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
7525 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
7526 staticpro (&button_down_location
);
7530 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
7532 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
7533 for (i
= 0; i
< len
; i
++)
7534 if (modifier_names
[i
])
7535 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
7536 staticpro (&modifier_symbols
);
7539 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
7540 staticpro (&recent_keys
);
7542 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
7543 staticpro (&this_command_keys
);
7545 Qextended_command_history
= intern ("extended-command-history");
7546 Fset (Qextended_command_history
, Qnil
);
7547 staticpro (&Qextended_command_history
);
7549 kbd_buffer_frame_or_window
7550 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7551 staticpro (&kbd_buffer_frame_or_window
);
7553 accent_key_syms
= Qnil
;
7554 staticpro (&accent_key_syms
);
7556 func_key_syms
= Qnil
;
7557 staticpro (&func_key_syms
);
7560 staticpro (&mouse_syms
);
7562 unread_switch_frame
= Qnil
;
7563 staticpro (&unread_switch_frame
);
7565 defsubr (&Sevent_convert_list
);
7566 defsubr (&Sread_key_sequence
);
7567 defsubr (&Srecursive_edit
);
7569 defsubr (&Strack_mouse
);
7571 defsubr (&Sinput_pending_p
);
7572 defsubr (&Scommand_execute
);
7573 defsubr (&Srecent_keys
);
7574 defsubr (&Sthis_command_keys
);
7575 defsubr (&Sreset_this_command_lengths
);
7576 defsubr (&Ssuspend_emacs
);
7577 defsubr (&Sabort_recursive_edit
);
7578 defsubr (&Sexit_recursive_edit
);
7579 defsubr (&Srecursion_depth
);
7580 defsubr (&Stop_level
);
7581 defsubr (&Sdiscard_input
);
7582 defsubr (&Sopen_dribble_file
);
7583 defsubr (&Sset_input_mode
);
7584 defsubr (&Scurrent_input_mode
);
7585 defsubr (&Sexecute_extended_command
);
7587 DEFVAR_LISP ("last-command-char", &last_command_char
,
7588 "Last input event that was part of a command.");
7590 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
7591 "Last input event that was part of a command.");
7593 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
7594 "Last input event in a command, except for mouse menu events.\n\
7595 Mouse menus give back keys that don't look like mouse events;\n\
7596 this variable holds the actual mouse event that led to the menu,\n\
7597 so that you can determine whether the command was run by mouse or not.");
7599 DEFVAR_LISP ("last-input-char", &last_input_char
,
7600 "Last input event.");
7602 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
7603 "Last input event.");
7605 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
7606 "List of objects to be read as next command input events.");
7608 DEFVAR_INT ("unread-command-char", &unread_command_char
,
7609 "If not -1, an object to be read as next command input event.");
7611 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
7612 "Meta-prefix character code. Meta-foo as command input\n\
7613 turns into this character followed by foo.");
7614 XSETINT (meta_prefix_char
, 033);
7616 DEFVAR_KBOARD ("last-command", Vlast_command
,
7617 "The last command executed. Normally a symbol with a function definition,\n\
7618 but can be whatever was found in the keymap, or whatever the variable\n\
7619 `this-command' was set to by that command.\n\
7621 The value `mode-exit' is special; it means that the previous command\n\
7622 read an event that told it to exit, and it did so and unread that event.\n\
7623 In other words, the present command is the event that made the previous\n\
7626 The value `kill-region' is special; it means that the previous command\n\
7627 was a kill command.");
7629 DEFVAR_LISP ("this-command", &this_command
,
7630 "The command now being executed.\n\
7631 The command can set this variable; whatever is put here\n\
7632 will be in `last-command' during the following command.");
7633 this_command
= Qnil
;
7635 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
7636 "*Number of keyboard input characters between auto-saves.\n\
7637 Zero means disable autosaving due to number of characters typed.");
7638 auto_save_interval
= 300;
7640 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
7641 "*Number of seconds idle time before auto-save.\n\
7642 Zero or nil means disable auto-saving due to idleness.\n\
7643 After auto-saving due to this many seconds of idle time,\n\
7644 Emacs also does a garbage collection if that seems to be warranted.");
7645 XSETFASTINT (Vauto_save_timeout
, 30);
7647 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
7648 "*Nonzero means echo unfinished commands after this many seconds of pause.");
7649 echo_keystrokes
= 1;
7651 DEFVAR_INT ("polling-period", &polling_period
,
7652 "*Interval between polling for input during Lisp execution.\n\
7653 The reason for polling is to make C-g work to stop a running program.\n\
7654 Polling is needed only when using X windows and SIGIO does not work.\n\
7655 Polling is automatically disabled in all other cases.");
7658 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
7659 "*Maximum time between mouse clicks to make a double-click.\n\
7660 Measured in milliseconds. nil means disable double-click recognition;\n\
7661 t means double-clicks have no time limit and are detected\n\
7662 by position only.");
7663 Vdouble_click_time
= make_number (500);
7665 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
7666 "*Non-nil means inhibit local map menu bar menus.");
7667 inhibit_local_menu_bar_menus
= 0;
7669 DEFVAR_INT ("num-input-keys", &num_input_keys
,
7670 "Number of complete keys read from the keyboard so far.");
7673 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
7674 "The frame in which the most recently read event occurred.\n\
7675 If the last event came from a keyboard macro, this is set to `macro'.");
7676 Vlast_event_frame
= Qnil
;
7678 DEFVAR_LISP ("help-char", &Vhelp_char
,
7679 "Character to recognize as meaning Help.\n\
7680 When it is read, do `(eval help-form)', and display result if it's a string.\n\
7681 If the value of `help-form' is nil, this char can be read normally.");
7682 XSETINT (Vhelp_char
, Ctl ('H'));
7684 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
7685 "List of input events to recognize as meaning Help.\n\
7686 These work just like the value of `help-char' (see that).");
7687 Vhelp_event_list
= Qnil
;
7689 DEFVAR_LISP ("help-form", &Vhelp_form
,
7690 "Form to execute when character `help-char' is read.\n\
7691 If the form returns a string, that string is displayed.\n\
7692 If `help-form' is nil, the help char is not recognized.");
7695 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
7696 "Command to run when `help-char' character follows a prefix key.\n\
7697 This command is used only when there is no actual binding\n\
7698 for that character after that prefix key.");
7699 Vprefix_help_command
= Qnil
;
7701 DEFVAR_LISP ("top-level", &Vtop_level
,
7702 "Form to evaluate when Emacs starts up.\n\
7703 Useful to set before you dump a modified Emacs.");
7706 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
7707 "Translate table for keyboard input, or nil.\n\
7708 Each character is looked up in this string and the contents used instead.\n\
7709 The value may be a string, a vector, or a char-table.\n\
7710 If it is a string or vector of length N,\n\
7711 character codes N and up are untranslated.\n\
7712 In a vector or a char-table, an element which is nil means \"no translation\".");
7713 Vkeyboard_translate_table
= Qnil
;
7715 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
7716 "Non-nil means to always spawn a subshell instead of suspending,\n\
7717 even if the operating system has support for stopping a process.");
7720 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
7721 "Non-nil means prompt with menus when appropriate.\n\
7722 This is done when reading from a keymap that has a prompt string,\n\
7723 for elements that have prompt strings.\n\
7724 The menu is displayed on the screen\n\
7725 if X menus were enabled at configuration\n\
7726 time and the previous event was a mouse click prefix key.\n\
7727 Otherwise, menu prompting uses the echo area.");
7730 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
7731 "Character to see next line of menu prompt.\n\
7732 Type this character while in a menu prompt to rotate around the lines of it.");
7733 XSETINT (menu_prompt_more_char
, ' ');
7735 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
7736 "A mask of additional modifier keys to use with every keyboard character.\n\
7737 Emacs applies the modifiers of the character stored here to each keyboard\n\
7738 character it reads. For example, after evaluating the expression\n\
7739 (setq extra-keyboard-modifiers ?\\C-x)\n\
7740 all input characters will have the control modifier applied to them.\n\
7742 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
7743 not count as a control character; rather, it counts as a character\n\
7744 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
7745 cancels any modification.");
7746 extra_keyboard_modifiers
= 0;
7748 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
7749 "If an editing command sets this to t, deactivate the mark afterward.\n\
7750 The command loop sets this to nil before each command,\n\
7751 and tests the value when the command returns.\n\
7752 Buffer modification stores t in this variable.");
7753 Vdeactivate_mark
= Qnil
;
7755 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
7756 "Temporary storage of pre-command-hook or post-command-hook.");
7757 Vcommand_hook_internal
= Qnil
;
7759 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
7760 "Normal hook run before each command is executed.\n\
7761 Errors running the hook are caught and ignored.");
7762 Vpre_command_hook
= Qnil
;
7764 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
7765 "Normal hook run after each command is executed.\n\
7766 Errors running the hook are caught and ignored.");
7767 Vpost_command_hook
= Qnil
;
7769 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
7770 "Normal hook run after each command is executed, if idle.\n\
7771 Errors running the hook are caught and ignored.");
7772 Vpost_command_idle_hook
= Qnil
;
7774 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
7775 "Delay time before running `post-command-idle-delay'.\n\
7776 This is measured in microseconds.");
7777 post_command_idle_delay
= 100000;
7779 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
7780 "t means menu bar, specified Lucid style, needs to be recomputed.");
7781 Vlucid_menu_bar_dirty_flag
= Qnil
;
7783 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
7784 "List of menu bar items to move to the end of the menu bar.\n\
7785 The elements of the list are event types that may have menu bar bindings.");
7786 Vmenu_bar_final_items
= Qnil
;
7788 DEFVAR_KBOARD ("overriding-terminal-local-map",
7789 Voverriding_terminal_local_map
,
7790 "Keymap that overrides all other local keymaps.\n\
7791 If this variable is non-nil, it is used as a keymap instead of the\n\
7792 buffer's local map, and the minor mode keymaps and text property keymaps.");
7794 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
7795 "Keymap that overrides all other local keymaps.\n\
7796 If this variable is non-nil, it is used as a keymap instead of the\n\
7797 buffer's local map, and the minor mode keymaps and text property keymaps.");
7798 Voverriding_local_map
= Qnil
;
7800 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
7801 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
7802 Otherwise, the menu bar continues to reflect the buffer's local map\n\
7803 and the minor mode maps regardless of `overriding-local-map'.");
7804 Voverriding_local_map_menu_flag
= Qnil
;
7806 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
7807 "Keymap defining bindings for special events to execute at low level.");
7808 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
7810 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
7811 "*Non-nil means generate motion events for mouse motion.");
7813 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
7814 "Alist of system-specific X windows key symbols.\n\
7815 Each element should have the form (N . SYMBOL) where N is the\n\
7816 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
7817 and SYMBOL is its name.");
7819 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
7820 "List of deferred actions to be performed at a later time.\n\
7821 The precise format isn't relevant here; we just check whether it is nil.");
7822 Vdeferred_action_list
= Qnil
;
7824 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
7825 "Function to call to handle deferred actions, after each command.\n\
7826 This function is called with no arguments after each command\n\
7827 whenever `deferred-action-list' is non-nil.");
7828 Vdeferred_action_function
= Qnil
;
7830 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
7831 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
7832 The value can be a length of time to show the message for.\n\
7833 If the value is non-nil and not a number, we wait 2 seconds.");
7834 Vsuggest_key_bindings
= Qt
;
7836 DEFVAR_LISP ("column-number-mode", &Vcolumn_number_mode
,
7837 "Non-nil enables display of the current column number in the mode line.");
7838 Vcolumn_number_mode
= Qnil
;
7840 DEFVAR_LISP ("timer-list", &Vtimer_list
,
7841 "List of active timers in order of increasing time");
7847 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
7848 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
7849 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
7850 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
7851 initial_define_key (meta_map
, 'x', "execute-extended-command");
7853 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
7854 "handle-delete-frame");
7855 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
7857 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",