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 /* Number of elements of this_command_keys
129 that precede this key sequence. */
130 int this_single_command_key_start
;
132 /* Record values of this_command_key_count and echo_length ()
133 before this command was read. */
134 static int before_command_key_count
;
135 static int before_command_echo_length
;
136 /* Values of before_command_key_count and before_command_echo_length
137 saved by reset-this-command-lengths. */
138 static int before_command_key_count_1
;
139 static int before_command_echo_length_1
;
140 /* Flag set by reset-this-command-lengths,
141 saying to reset the lengths when add_command_key is called. */
142 static int before_command_restore_flag
;
144 extern int minbuf_level
;
146 extern struct backtrace
*backtrace_list
;
148 /* Nonzero means do menu prompting. */
149 static int menu_prompting
;
151 /* Character to see next line of menu prompt. */
152 static Lisp_Object menu_prompt_more_char
;
154 /* For longjmp to where kbd input is being done. */
155 static jmp_buf getcjmp
;
157 /* True while doing kbd input. */
158 int waiting_for_input
;
160 /* True while displaying for echoing. Delays C-g throwing. */
163 /* True means we can start echoing at the next input pause
164 even though there is something in the echo area. */
165 static char *ok_to_echo_at_next_pause
;
167 /* Nonzero means disregard local maps for the menu bar. */
168 static int inhibit_local_menu_bar_menus
;
170 /* Nonzero means C-g should cause immediate error-signal. */
173 /* Character to recognize as the help char. */
174 Lisp_Object Vhelp_char
;
176 /* List of other event types to recognize as meaning "help". */
177 Lisp_Object Vhelp_event_list
;
179 /* Form to execute when help char is typed. */
180 Lisp_Object Vhelp_form
;
182 /* Command to run when the help character follows a prefix key. */
183 Lisp_Object Vprefix_help_command
;
185 /* List of items that should move to the end of the menu bar. */
186 Lisp_Object Vmenu_bar_final_items
;
188 /* Non-nil means show the equivalent key-binding for
189 any M-x command that has one.
190 The value can be a length of time to show the message for.
191 If the value is non-nil and not a number, we wait 2 seconds. */
192 Lisp_Object Vsuggest_key_bindings
;
194 /* Character that causes a quit. Normally C-g.
196 If we are running on an ordinary terminal, this must be an ordinary
197 ASCII char, since we want to make it our interrupt character.
199 If we are not running on an ordinary terminal, it still needs to be
200 an ordinary ASCII char. This character needs to be recognized in
201 the input interrupt handler. At this point, the keystroke is
202 represented as a struct input_event, while the desired quit
203 character is specified as a lispy event. The mapping from struct
204 input_events to lispy events cannot run in an interrupt handler,
205 and the reverse mapping is difficult for anything but ASCII
208 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
212 extern Lisp_Object current_global_map
;
213 extern int minibuf_level
;
215 /* If non-nil, this is a map that overrides all other local maps. */
216 Lisp_Object Voverriding_local_map
;
218 /* If non-nil, Voverriding_local_map applies to the menu bar. */
219 Lisp_Object Voverriding_local_map_menu_flag
;
221 /* Keymap that defines special misc events that should
222 be processed immediately at a low level. */
223 Lisp_Object Vspecial_event_map
;
225 /* Current depth in recursive edits. */
226 int command_loop_level
;
228 /* Total number of times command_loop has read a key sequence. */
231 /* Last input character read as a command. */
232 Lisp_Object last_command_char
;
234 /* Last input character read as a command, not counting menus
235 reached by the mouse. */
236 Lisp_Object last_nonmenu_event
;
238 /* Last input character read for any purpose. */
239 Lisp_Object last_input_char
;
241 /* If not Qnil, a list of objects to be read as subsequent command input. */
242 Lisp_Object Vunread_command_events
;
244 /* If not -1, an event to be read as subsequent command input. */
245 int unread_command_char
;
247 /* If not Qnil, this is a switch-frame event which we decided to put
248 off until the end of a key sequence. This should be read as the
249 next command input, after any unread_command_events.
251 read_key_sequence uses this to delay switch-frame events until the
252 end of the key sequence; Fread_char uses it to put off switch-frame
253 events until a non-ASCII event is acceptable as input. */
254 Lisp_Object unread_switch_frame
;
256 /* A mask of extra modifier bits to put into every keyboard char. */
257 int extra_keyboard_modifiers
;
259 /* Char to use as prefix when a meta character is typed in.
260 This is bound on entry to minibuffer in case ESC is changed there. */
262 Lisp_Object meta_prefix_char
;
264 /* Last size recorded for a current buffer which is not a minibuffer. */
265 static int last_non_minibuf_size
;
267 /* Number of idle seconds before an auto-save and garbage collection. */
268 static Lisp_Object Vauto_save_timeout
;
270 /* Total number of times read_char has returned. */
273 /* Total number of times read_char has returned, outside of macros. */
274 int num_nonmacro_input_chars
;
276 /* Auto-save automatically when this many characters have been typed
277 since the last time. */
279 static int auto_save_interval
;
281 /* Value of num_nonmacro_input_chars as of last auto save. */
285 /* The command being executed by the command loop.
286 Commands may set this, and the value set will be copied into
287 current_kboard->Vlast_command instead of the actual command. */
288 Lisp_Object this_command
;
290 /* The value of point when the last command was executed. */
291 int last_point_position
;
293 /* The buffer that was current when the last command was started. */
294 Lisp_Object last_point_position_buffer
;
296 /* The frame in which the last input event occurred, or Qmacro if the
297 last event came from a macro. We use this to determine when to
298 generate switch-frame events. This may be cleared by functions
299 like Fselect_frame, to make sure that a switch-frame event is
300 generated by the next character. */
301 Lisp_Object internal_last_event_frame
;
303 /* A user-visible version of the above, intended to allow users to
304 figure out where the last event came from, if the event doesn't
305 carry that information itself (i.e. if it was a character). */
306 Lisp_Object Vlast_event_frame
;
308 /* The timestamp of the last input event we received from the X server.
309 X Windows wants this for selection ownership. */
310 unsigned long last_event_timestamp
;
312 Lisp_Object Qself_insert_command
;
313 Lisp_Object Qforward_char
;
314 Lisp_Object Qbackward_char
;
315 Lisp_Object Qundefined
;
317 /* read_key_sequence stores here the command definition of the
318 key sequence that it reads. */
319 Lisp_Object read_key_sequence_cmd
;
321 /* Form to evaluate (if non-nil) when Emacs is started. */
322 Lisp_Object Vtop_level
;
324 /* User-supplied string to translate input characters through. */
325 Lisp_Object Vkeyboard_translate_table
;
327 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
328 extern Lisp_Object Vfunction_key_map
;
330 /* Another keymap that maps key sequences into key sequences.
331 This one takes precedence over ordinary definitions. */
332 extern Lisp_Object Vkey_translation_map
;
334 /* Non-nil means deactivate the mark at end of this command. */
335 Lisp_Object Vdeactivate_mark
;
337 /* Menu bar specified in Lucid Emacs fashion. */
339 Lisp_Object Vlucid_menu_bar_dirty_flag
;
340 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
342 /* Hooks to run before and after each command. */
343 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
344 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
345 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
346 /* Hook run after a command if there's no more input soon. */
347 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
349 /* Delay time in microseconds before running post-command-idle-hook. */
350 int post_command_idle_delay
;
352 /* List of deferred actions to be performed at a later time.
353 The precise format isn't relevant here; we just check whether it is nil. */
354 Lisp_Object Vdeferred_action_list
;
356 /* Function to call to handle deferred actions, when there are any. */
357 Lisp_Object Vdeferred_action_function
;
358 Lisp_Object Qdeferred_action_function
;
360 /* File in which we write all commands we read. */
363 /* Nonzero if input is available. */
366 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
367 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
371 extern char *pending_malloc_warning
;
373 /* Circular buffer for pre-read keyboard input. */
374 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
376 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
378 The interrupt-level event handlers will never enqueue an event on a
379 frame which is not in Vframe_list, and once an event is dequeued,
380 internal_last_event_frame or the event itself points to the frame.
383 But while the event is sitting in the queue, it's completely
384 unprotected. Suppose the user types one command which will run for
385 a while and then delete a frame, and then types another event at
386 the frame that will be deleted, before the command gets around to
387 it. Suppose there are no references to this frame elsewhere in
388 Emacs, and a GC occurs before the second event is dequeued. Now we
389 have an event referring to a freed frame, which will crash Emacs
392 Similar things happen when an event on a scroll bar is enqueued; the
393 window may be deleted while the event is in the queue.
395 So, we use this vector to protect the frame_or_window field in the
396 event queue. That way, they'll be dequeued as dead frames or
397 windows, but still valid lisp objects.
399 If kbd_buffer[i].kind != no_event, then
400 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
401 == kbd_buffer[i].frame_or_window. */
402 static Lisp_Object kbd_buffer_frame_or_window
;
404 /* Pointer to next available character in kbd_buffer.
405 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
406 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
407 next available char is in kbd_buffer[0]. */
408 static struct input_event
*kbd_fetch_ptr
;
410 /* Pointer to next place to store character in kbd_buffer. This
411 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
412 character should go in kbd_buffer[0]. */
413 static volatile struct input_event
*kbd_store_ptr
;
415 /* The above pair of variables forms a "queue empty" flag. When we
416 enqueue a non-hook event, we increment kbd_store_ptr. When we
417 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
418 there is input available iff the two pointers are not equal.
420 Why not just have a flag set and cleared by the enqueuing and
421 dequeuing functions? Such a flag could be screwed up by interrupts
422 at inopportune times. */
424 /* If this flag is non-nil, we check mouse_moved to see when the
425 mouse moves, and motion events will appear in the input stream.
426 Otherwise, mouse motion is ignored. */
427 static Lisp_Object do_mouse_tracking
;
429 /* Symbols to head events. */
430 Lisp_Object Qmouse_movement
;
431 Lisp_Object Qscroll_bar_movement
;
432 Lisp_Object Qswitch_frame
;
433 Lisp_Object Qdelete_frame
;
434 Lisp_Object Qiconify_frame
;
435 Lisp_Object Qmake_frame_visible
;
437 /* Symbols to denote kinds of events. */
438 Lisp_Object Qfunction_key
;
439 Lisp_Object Qmouse_click
;
440 Lisp_Object Qtimer_event
;
441 /* Lisp_Object Qmouse_movement; - also an event header */
443 /* Properties of event headers. */
444 Lisp_Object Qevent_kind
;
445 Lisp_Object Qevent_symbol_elements
;
447 Lisp_Object Qmenu_enable
;
449 /* An event header symbol HEAD may have a property named
450 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
451 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
452 mask of modifiers applied to it. If present, this is used to help
453 speed up parse_modifiers. */
454 Lisp_Object Qevent_symbol_element_mask
;
456 /* An unmodified event header BASE may have a property named
457 Qmodifier_cache, which is an alist mapping modifier masks onto
458 modified versions of BASE. If present, this helps speed up
460 Lisp_Object Qmodifier_cache
;
462 /* Symbols to use for parts of windows. */
463 Lisp_Object Qmode_line
;
464 Lisp_Object Qvertical_line
;
465 Lisp_Object Qvertical_scroll_bar
;
466 Lisp_Object Qmenu_bar
;
468 extern Lisp_Object Qmenu_enable
;
470 Lisp_Object
recursive_edit_unwind (), command_loop ();
471 Lisp_Object
Fthis_command_keys ();
472 Lisp_Object Qextended_command_history
;
473 EMACS_TIME
timer_check ();
475 extern char *x_get_keysym_name ();
477 Lisp_Object Qpolling_period
;
479 /* List of absolute timers. Appears in order of next scheduled event. */
480 Lisp_Object Vtimer_list
;
482 /* List of idle time timers. Appears in order of next scheduled event. */
483 Lisp_Object Vtimer_idle_list
;
485 /* Incremented whenever a timer is run. */
488 extern Lisp_Object Vprint_level
, Vprint_length
;
490 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
492 EMACS_TIME
*input_available_clear_time
;
494 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
495 Default is 1 if INTERRUPT_INPUT is defined. */
498 /* Nonzero while interrupts are temporarily deferred during redisplay. */
499 int interrupts_deferred
;
501 /* Nonzero means use ^S/^Q for flow control. */
504 /* Allow m- file to inhibit use of FIONREAD. */
505 #ifdef BROKEN_FIONREAD
509 /* We are unable to use interrupts if FIONREAD is not available,
510 so flush SIGIO so we won't try. */
517 /* If we support a window system, turn on the code to poll periodically
518 to detect C-g. It isn't actually used when doing interrupt input. */
519 #ifdef HAVE_WINDOW_SYSTEM
520 #define POLL_FOR_INPUT
523 /* Global variable declarations. */
525 /* Function for init_keyboard to call with no args (if nonzero). */
526 void (*keyboard_init_hook
) ();
528 static int read_avail_input ();
529 static void get_input_pending ();
530 static int readable_events ();
531 static Lisp_Object
read_char_x_menu_prompt ();
532 static Lisp_Object
read_char_minibuf_menu_prompt ();
533 static Lisp_Object
make_lispy_event ();
535 static Lisp_Object
make_lispy_movement ();
537 static Lisp_Object
modify_event_symbol ();
538 static Lisp_Object
make_lispy_switch_frame ();
539 static int parse_solitary_modifier ();
541 /* > 0 if we are to echo keystrokes. */
542 static int echo_keystrokes
;
544 /* Nonzero means don't try to suspend even if the operating system seems
546 static int cannot_suspend
;
548 #define min(a,b) ((a)<(b)?(a):(b))
549 #define max(a,b) ((a)>(b)?(a):(b))
551 /* Install the string STR as the beginning of the string of echoing,
552 so that it serves as a prompt for the next character.
553 Also start echoing. */
558 int len
= strlen (str
);
560 if (len
> ECHOBUFSIZE
- 4)
561 len
= ECHOBUFSIZE
- 4;
562 bcopy (str
, current_kboard
->echobuf
, len
);
563 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
564 *current_kboard
->echoptr
= '\0';
566 current_kboard
->echo_after_prompt
= len
;
571 /* Add C to the echo string, if echoing is going on.
572 C can be a character, which is printed prettily ("M-C-x" and all that
573 jazz), or a symbol, whose name is printed. */
578 extern char *push_key_description ();
580 if (current_kboard
->immediate_echo
)
582 char *ptr
= current_kboard
->echoptr
;
584 if (ptr
!= current_kboard
->echobuf
)
587 /* If someone has passed us a composite event, use its head symbol. */
592 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
595 ptr
= push_key_description (XINT (c
), ptr
);
597 else if (SYMBOLP (c
))
599 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
600 if ((ptr
- current_kboard
->echobuf
) + name
->size
+ 4 > ECHOBUFSIZE
)
602 bcopy (name
->data
, ptr
, name
->size
);
606 if (current_kboard
->echoptr
== current_kboard
->echobuf
609 strcpy (ptr
, " (Type ? for further options)");
614 current_kboard
->echoptr
= ptr
;
620 /* Temporarily add a dash to the end of the echo string if it's not
621 empty, so that it serves as a mini-prompt for the very next character. */
625 if (!current_kboard
->immediate_echo
626 && current_kboard
->echoptr
== current_kboard
->echobuf
)
628 /* Do nothing if we just printed a prompt. */
629 if (current_kboard
->echo_after_prompt
630 == current_kboard
->echoptr
- current_kboard
->echobuf
)
632 /* Do nothing if not echoing at all. */
633 if (current_kboard
->echoptr
== 0)
636 /* Put a dash at the end of the buffer temporarily,
637 but make it go away when the next character is added. */
638 current_kboard
->echoptr
[0] = '-';
639 current_kboard
->echoptr
[1] = 0;
644 /* Display the current echo string, and begin echoing if not already
649 if (!current_kboard
->immediate_echo
)
652 current_kboard
->immediate_echo
= 1;
654 for (i
= 0; i
< this_command_key_count
; i
++)
657 c
= XVECTOR (this_command_keys
)->contents
[i
];
658 if (! (EVENT_HAS_PARAMETERS (c
)
659 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
666 message1_nolog (current_kboard
->echobuf
);
669 if (waiting_for_input
&& !NILP (Vquit_flag
))
670 quit_throw_to_read_char ();
673 /* Turn off echoing, for the start of a new command. */
677 current_kboard
->immediate_echo
= 0;
678 current_kboard
->echoptr
= current_kboard
->echobuf
;
679 current_kboard
->echo_after_prompt
= -1;
680 ok_to_echo_at_next_pause
= 0;
683 /* Return the length of the current echo string. */
688 return current_kboard
->echoptr
- current_kboard
->echobuf
;
691 /* Truncate the current echo message to its first LEN chars.
692 This and echo_char get used by read_key_sequence when the user
693 switches frames while entering a key sequence. */
699 current_kboard
->echobuf
[len
] = '\0';
700 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
701 truncate_echo_area (len
);
705 /* Functions for manipulating this_command_keys. */
707 add_command_key (key
)
710 int size
= XVECTOR (this_command_keys
)->size
;
712 /* If reset-this-command-length was called recently, obey it now.
713 See the doc string of that function for an explanation of why. */
714 if (before_command_restore_flag
)
716 this_command_key_count
= before_command_key_count_1
;
717 if (this_command_key_count
< this_single_command_key_start
)
718 this_single_command_key_start
= this_command_key_count
;
719 echo_truncate (before_command_echo_length_1
);
720 before_command_restore_flag
= 0;
723 if (this_command_key_count
>= size
)
725 Lisp_Object new_keys
;
727 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
728 bcopy (XVECTOR (this_command_keys
)->contents
,
729 XVECTOR (new_keys
)->contents
,
730 size
* sizeof (Lisp_Object
));
732 this_command_keys
= new_keys
;
735 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
741 int count
= specpdl_ptr
- specpdl
;
744 if (command_loop_level
> 0)
746 specbind (Qstandard_output
, Qt
);
747 specbind (Qstandard_input
, Qt
);
750 val
= command_loop ();
752 Fsignal (Qquit
, Qnil
);
753 /* Handle throw from read_minibuf when using minibuffer
754 while it's active but we're in another window. */
756 Fsignal (Qerror
, Fcons (val
, Qnil
));
758 return unbind_to (count
, Qnil
);
761 /* When an auto-save happens, record the "time", and don't do again soon. */
765 last_auto_save
= num_nonmacro_input_chars
;
768 /* Make an auto save happen as soon as possible at command level. */
770 force_auto_save_soon ()
772 last_auto_save
= - auto_save_interval
- 1;
774 record_asynch_buffer_change ();
777 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
778 "Invoke the editor command loop recursively.\n\
779 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
780 that tells this function to return.\n\
781 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
782 This function is called by the editor initialization to begin editing.")
785 int count
= specpdl_ptr
- specpdl
;
788 command_loop_level
++;
789 update_mode_lines
= 1;
791 record_unwind_protect (recursive_edit_unwind
,
793 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
797 return unbind_to (count
, Qnil
);
801 recursive_edit_unwind (buffer
)
805 Fset_buffer (buffer
);
807 command_loop_level
--;
808 update_mode_lines
= 1;
816 #if 0 /* Theory: if there's anything in Vunread_command_events,
817 it will right away be read by read_key_sequence,
818 and then if we do switch KBOARDS, it will go into the side
819 queue then. So we don't need to do anything special here -- rms. */
820 if (CONSP (Vunread_command_events
))
822 current_kboard
->kbd_queue
823 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
824 current_kboard
->kbd_queue_has_data
= 1;
826 Vunread_command_events
= Qnil
;
832 /* Switch to the single-kboard state, making current_kboard
833 the only KBOARD from which further input is accepted. */
836 single_kboard_state ()
843 /* Maintain a stack of kboards, so other parts of Emacs
844 can switch temporarily to the kboard of a given frame
845 and then revert to the previous status. */
850 struct kboard_stack
*next
;
853 static struct kboard_stack
*kboard_stack
;
856 push_frame_kboard (f
)
860 struct kboard_stack
*p
861 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
863 p
->next
= kboard_stack
;
864 p
->kboard
= current_kboard
;
867 current_kboard
= FRAME_KBOARD (f
);
875 struct kboard_stack
*p
= kboard_stack
;
876 current_kboard
= p
->kboard
;
877 kboard_stack
= p
->next
;
882 /* Handle errors that are not handled at inner levels
883 by printing an error message and returning to the editor command loop. */
889 Lisp_Object old_level
, old_length
;
892 if (!NILP (executing_macro
))
894 if (executing_macro_iterations
== 1)
895 sprintf (macroerror
, "After 1 kbd macro iteration: ");
897 sprintf (macroerror
, "After %d kbd macro iterations: ",
898 executing_macro_iterations
);
903 Vstandard_output
= Qt
;
904 Vstandard_input
= Qt
;
905 Vexecuting_macro
= Qnil
;
906 executing_macro
= Qnil
;
907 current_kboard
->Vprefix_arg
= Qnil
;
910 /* Avoid unquittable loop if data contains a circular list. */
911 old_level
= Vprint_level
;
912 old_length
= Vprint_length
;
913 XSETFASTINT (Vprint_level
, 10);
914 XSETFASTINT (Vprint_length
, 10);
915 cmd_error_internal (data
, macroerror
);
916 Vprint_level
= old_level
;
917 Vprint_length
= old_length
;
921 Vinhibit_quit
= Qnil
;
926 return make_number (0);
929 cmd_error_internal (data
, context
)
937 echo_area_glyphs
= 0;
939 /* If the window system or terminal frame hasn't been initialized
940 yet, or we're not interactive, it's best to dump this message out
941 to stderr and exit. */
942 if (! FRAME_MESSAGE_BUF (selected_frame
)
944 stream
= Qexternal_debugging_output
;
953 write_string_1 (context
, -1, stream
);
955 print_error_message (data
, stream
);
957 /* If the window system or terminal frame hasn't been initialized
958 yet, or we're in -batch mode, this error should cause Emacs to exit. */
959 if (! FRAME_MESSAGE_BUF (selected_frame
)
963 Fkill_emacs (make_number (-1));
967 Lisp_Object
command_loop_1 ();
968 Lisp_Object
command_loop_2 ();
969 Lisp_Object
top_level_1 ();
971 /* Entry to editor-command-loop.
972 This level has the catches for exiting/returning to editor command loop.
973 It returns nil to exit recursive edit, t to abort it. */
978 if (command_loop_level
> 0 || minibuf_level
> 0)
980 return internal_catch (Qexit
, command_loop_2
, Qnil
);
985 internal_catch (Qtop_level
, top_level_1
, Qnil
);
986 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
988 /* End of file in -batch run causes exit here. */
994 /* Here we catch errors in execution of commands within the
995 editing loop, and reenter the editing loop.
996 When there is an error, cmd_error runs and returns a non-nil
997 value to us. A value of nil means that cmd_loop_1 itself
998 returned due to end of file (or end of kbd macro). */
1003 register Lisp_Object val
;
1006 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1007 while (!NILP (val
));
1015 return Feval (Vtop_level
);
1021 /* On entry to the outer level, run the startup file */
1022 if (!NILP (Vtop_level
))
1023 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1024 else if (!NILP (Vpurify_flag
))
1025 message ("Bare impure Emacs (standard Lisp code not loaded)");
1027 message ("Bare Emacs (standard Lisp code not loaded)");
1031 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1032 "Exit all recursive editing levels.")
1035 Fthrow (Qtop_level
, Qnil
);
1038 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1039 "Exit from the innermost recursive edit or minibuffer.")
1042 if (command_loop_level
> 0 || minibuf_level
> 0)
1043 Fthrow (Qexit
, Qnil
);
1045 error ("No recursive edit is in progress");
1048 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1049 "Abort the command that requested this recursive edit or minibuffer input.")
1052 if (command_loop_level
> 0 || minibuf_level
> 0)
1055 error ("No recursive edit is in progress");
1058 /* This is the actual command reading loop,
1059 sans error-handling encapsulation. */
1061 Lisp_Object
Fcommand_execute ();
1062 static int read_key_sequence ();
1063 void safe_run_hooks ();
1068 Lisp_Object cmd
, tem
;
1071 Lisp_Object keybuf
[30];
1076 struct buffer
*prev_buffer
;
1078 int was_locked
= single_kboard
;
1081 current_kboard
->Vprefix_arg
= Qnil
;
1082 Vdeactivate_mark
= Qnil
;
1083 waiting_for_input
= 0;
1088 this_command_key_count
= 0;
1089 this_single_command_key_start
= 0;
1091 /* Make sure this hook runs after commands that get errors and
1092 throw to top level. */
1093 /* Note that the value cell will never directly contain nil
1094 if the symbol is a local variable. */
1095 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1096 safe_run_hooks (Qpost_command_hook
);
1098 if (!NILP (Vdeferred_action_list
))
1099 call0 (Vdeferred_action_function
);
1101 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1103 if (NILP (Vunread_command_events
)
1104 && NILP (Vexecuting_macro
)
1105 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1)))
1106 safe_run_hooks (Qpost_command_idle_hook
);
1109 /* Do this after running Vpost_command_hook, for consistency. */
1110 current_kboard
->Vlast_command
= this_command
;
1114 /* Make sure the current window's buffer is selected. */
1115 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1116 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1118 /* Display any malloc warning that just came out. Use while because
1119 displaying one warning can cause another. */
1121 while (pending_malloc_warning
)
1122 display_malloc_warning ();
1126 Vdeactivate_mark
= Qnil
;
1128 /* If minibuffer on and echo area in use,
1129 wait 2 sec and redraw minibuffer. */
1131 if (minibuf_level
&& echo_area_glyphs
1132 && EQ (minibuf_window
, echo_area_window
))
1134 /* Bind inhibit-quit to t so that C-g gets read in
1135 rather than quitting back to the minibuffer. */
1136 int count
= specpdl_ptr
- specpdl
;
1137 specbind (Qinhibit_quit
, Qt
);
1139 Fsit_for (make_number (2), Qnil
, Qnil
);
1140 /* Clear the echo area. */
1143 unbind_to (count
, Qnil
);
1145 /* If a C-g came in before, treat it as input now. */
1146 if (!NILP (Vquit_flag
))
1149 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1154 alloca (0); /* Cause a garbage collection now */
1155 /* Since we can free the most stuff here. */
1156 #endif /* C_ALLOCA */
1159 /* Select the frame that the last event came from. Usually,
1160 switch-frame events will take care of this, but if some lisp
1161 code swallows a switch-frame event, we'll fix things up here.
1162 Is this a good idea? */
1163 if (FRAMEP (internal_last_event_frame
)
1164 && XFRAME (internal_last_event_frame
) != selected_frame
)
1165 Fselect_frame (internal_last_event_frame
, Qnil
);
1167 /* If it has changed current-menubar from previous value,
1168 really recompute the menubar from the value. */
1169 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1170 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1171 call0 (Qrecompute_lucid_menubar
);
1173 before_command_key_count
= this_command_key_count
;
1174 before_command_echo_length
= echo_length ();
1176 this_command
= Qnil
;
1178 /* Read next key sequence; i gets its length. */
1179 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1184 /* Now we have read a key sequence of length I,
1185 or else I is 0 and we found end of file. */
1187 if (i
== 0) /* End of file -- happens only in */
1188 return Qnil
; /* a kbd macro, at the end. */
1189 /* -1 means read_key_sequence got a menu that was rejected.
1190 Just loop around and read another command. */
1194 this_command_key_count
= 0;
1195 this_single_command_key_start
= 0;
1199 last_command_char
= keybuf
[i
- 1];
1201 /* If the previous command tried to force a specific window-start,
1202 forget about that, in case this command moves point far away
1203 from that position. But also throw away beg_unchanged and
1204 end_unchanged information in that case, so that redisplay will
1205 update the whole window properly. */
1206 if (!NILP (XWINDOW (selected_window
)->force_start
))
1208 XWINDOW (selected_window
)->force_start
= Qnil
;
1209 beg_unchanged
= end_unchanged
= 0;
1212 cmd
= read_key_sequence_cmd
;
1213 if (!NILP (Vexecuting_macro
))
1215 if (!NILP (Vquit_flag
))
1217 Vexecuting_macro
= Qt
;
1218 QUIT
; /* Make some noise. */
1219 /* Will return since macro now empty. */
1223 /* Do redisplay processing after this command except in special
1224 cases identified below that set no_redisplay to 1.
1225 (actually, there's currently no way to prevent the redisplay,
1226 and no_redisplay is ignored.
1227 Perhaps someday we will really implement it.) */
1230 prev_buffer
= current_buffer
;
1231 prev_modiff
= MODIFF
;
1232 last_point_position
= PT
;
1233 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1235 /* Execute the command. */
1238 /* Note that the value cell will never directly contain nil
1239 if the symbol is a local variable. */
1240 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1241 safe_run_hooks (Qpre_command_hook
);
1243 if (NILP (this_command
))
1245 /* nil means key is undefined. */
1247 current_kboard
->defining_kbd_macro
= Qnil
;
1248 update_mode_lines
= 1;
1249 current_kboard
->Vprefix_arg
= Qnil
;
1253 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1255 /* Recognize some common commands in common situations and
1256 do them directly. */
1257 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1259 struct Lisp_Char_Table
*dp
1260 = window_display_table (XWINDOW (selected_window
));
1261 lose
= FETCH_CHAR (PT
);
1264 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1265 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1266 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1267 && (lose
>= 0x20 && lose
< 0x7f)))
1268 : (lose
>= 0x20 && lose
< 0x7f))
1269 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1271 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1273 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1275 && !windows_or_buffers_changed
1276 && EQ (current_buffer
->selective_display
, Qnil
)
1277 && !detect_input_pending ()
1278 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1279 && NILP (Vexecuting_macro
))
1280 no_redisplay
= direct_output_forward_char (1);
1283 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1285 struct Lisp_Char_Table
*dp
1286 = window_display_table (XWINDOW (selected_window
));
1288 lose
= FETCH_CHAR (PT
);
1290 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1291 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1292 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1293 && (lose
>= 0x20 && lose
< 0x7f)))
1294 : (lose
>= 0x20 && lose
< 0x7f))
1295 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1297 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1299 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1301 && !windows_or_buffers_changed
1302 && EQ (current_buffer
->selective_display
, Qnil
)
1303 && !detect_input_pending ()
1304 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1305 && NILP (Vexecuting_macro
))
1306 no_redisplay
= direct_output_forward_char (-1);
1309 else if (EQ (this_command
, Qself_insert_command
)
1310 /* Try this optimization only on ascii keystrokes. */
1311 && INTEGERP (last_command_char
))
1313 unsigned char c
= XINT (last_command_char
);
1316 if (NILP (Vexecuting_macro
)
1317 && !EQ (minibuf_window
, selected_window
))
1319 if (!nonundocount
|| nonundocount
>= 20)
1326 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1328 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1330 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1332 || MODIFF
<= SAVE_MODIFF
1333 || windows_or_buffers_changed
1334 || !EQ (current_buffer
->selective_display
, Qnil
)
1335 || detect_input_pending ()
1336 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1337 || !NILP (Vexecuting_macro
));
1338 value
= internal_self_insert (c
, 0);
1345 && (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1347 struct Lisp_Char_Table
*dp
1348 = window_display_table (XWINDOW (selected_window
));
1355 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1358 /* Do it only for char codes
1359 that by default display as themselves. */
1360 if (lose
>= 0x20 && lose
<= 0x7e)
1361 no_redisplay
= direct_output_for_insert (lose
);
1363 else if (VECTORP (obj
)
1364 && XVECTOR (obj
)->size
== 1
1365 && (obj
= XVECTOR (obj
)->contents
[0],
1367 /* Insist face not specified in glyph. */
1368 && (XINT (obj
) & ((-1) << 8)) == 0)
1370 = direct_output_for_insert (XINT (obj
));
1374 if (lose
>= 0x20 && lose
<= 0x7e)
1375 no_redisplay
= direct_output_for_insert (lose
);
1382 /* Here for a command that isn't executed directly */
1385 if (NILP (current_kboard
->Vprefix_arg
))
1387 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1392 /* If there is a prefix argument,
1393 1) We don't want Vlast_command to be ``universal-argument''
1394 (that would be dumb), so don't set Vlast_command,
1395 2) we want to leave echoing on so that the prefix will be
1396 echoed as part of this key sequence, so don't call
1398 3) we want to leave this_command_key_count non-zero, so that
1399 read_char will realize that it is re-reading a character, and
1400 not echo it a second time.
1402 If the command didn't actually create a prefix arg,
1403 but is merely a frame event that is transparent to prefix args,
1404 then the above doesn't apply. */
1405 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1407 current_kboard
->Vlast_command
= this_command
;
1409 this_command_key_count
= 0;
1410 this_single_command_key_start
= 0;
1413 /* Note that the value cell will never directly contain nil
1414 if the symbol is a local variable. */
1415 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1416 safe_run_hooks (Qpost_command_hook
);
1418 if (!NILP (Vdeferred_action_list
))
1419 safe_run_hooks (Qdeferred_action_function
);
1421 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1423 if (NILP (Vunread_command_events
)
1424 && NILP (Vexecuting_macro
)
1425 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1)))
1426 safe_run_hooks (Qpost_command_idle_hook
);
1429 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1431 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1433 current_buffer
->mark_active
= Qnil
;
1434 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1436 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1437 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1441 /* Install chars successfully executed in kbd macro. */
1443 if (!NILP (current_kboard
->defining_kbd_macro
)
1444 && NILP (current_kboard
->Vprefix_arg
))
1445 finalize_kbd_macro_chars ();
1449 any_kboard_state ();
1454 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1457 safe_run_hooks_1 (hook
)
1460 return call1 (Vrun_hooks
, Vinhibit_quit
);
1463 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1466 safe_run_hooks_error (data
)
1469 Fset (Vinhibit_quit
, Qnil
);
1472 /* If we get an error while running the hook, cause the hook variable
1473 to be nil. Also inhibit quits, so that C-g won't cause the hook
1474 to mysteriously evaporate. */
1477 safe_run_hooks (hook
)
1481 int count
= specpdl_ptr
- specpdl
;
1482 specbind (Qinhibit_quit
, hook
);
1484 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1486 unbind_to (count
, Qnil
);
1489 /* Number of seconds between polling for input. */
1492 /* Nonzero means polling for input is temporarily suppressed. */
1493 int poll_suppress_count
;
1495 /* Nonzero if polling_for_input is actually being used. */
1496 int polling_for_input
;
1498 #ifdef POLL_FOR_INPUT
1500 /* Handle an alarm once each second and read pending input
1501 so as to handle a C-g if it comces in. */
1504 input_poll_signal (signalnum
) /* If we don't have an argument, */
1505 int signalnum
; /* some compilers complain in signal calls. */
1507 /* This causes the call to start_polling at the end
1508 to do its job. It also arranges for a quit or error
1509 from within read_avail_input to resume polling. */
1510 poll_suppress_count
++;
1511 if (interrupt_input_blocked
== 0
1512 && !waiting_for_input
)
1513 read_avail_input (0);
1514 /* Turn on the SIGALRM handler and request another alarm. */
1520 /* Begin signals to poll for input, if they are appropriate.
1521 This function is called unconditionally from various places. */
1525 #ifdef POLL_FOR_INPUT
1526 if (read_socket_hook
&& !interrupt_input
)
1528 poll_suppress_count
--;
1529 if (poll_suppress_count
== 0)
1531 signal (SIGALRM
, input_poll_signal
);
1532 polling_for_input
= 1;
1533 alarm (polling_period
);
1539 /* Nonzero if we are using polling to handle input asynchronously. */
1542 input_polling_used ()
1544 #ifdef POLL_FOR_INPUT
1545 return read_socket_hook
&& !interrupt_input
;
1551 /* Turn off polling. */
1555 #ifdef POLL_FOR_INPUT
1556 if (read_socket_hook
&& !interrupt_input
)
1558 if (poll_suppress_count
== 0)
1560 polling_for_input
= 0;
1563 poll_suppress_count
++;
1568 /* Set the value of poll_suppress_count to COUNT
1569 and start or stop polling accordingly. */
1572 set_poll_suppress_count (count
)
1575 #ifdef POLL_FOR_INPUT
1576 if (count
== 0 && poll_suppress_count
!= 0)
1578 poll_suppress_count
= 1;
1581 else if (count
!= 0 && poll_suppress_count
== 0)
1585 poll_suppress_count
= count
;
1589 /* Bind polling_period to a value at least N.
1590 But don't decrease it. */
1592 bind_polling_period (n
)
1595 #ifdef POLL_FOR_INPUT
1596 int new = polling_period
;
1602 specbind (Qpolling_period
, make_number (new));
1603 /* Start a new alarm with the new period. */
1608 /* Apply the control modifier to CHARACTER. */
1614 /* Save the upper bits here. */
1615 int upper
= c
& ~0177;
1619 /* Everything in the columns containing the upper-case letters
1620 denotes a control character. */
1621 if (c
>= 0100 && c
< 0140)
1625 /* Set the shift modifier for a control char
1626 made from a shifted letter. But only for letters! */
1627 if (oc
>= 'A' && oc
<= 'Z')
1628 c
|= shift_modifier
;
1631 /* The lower-case letters denote control characters too. */
1632 else if (c
>= 'a' && c
<= 'z')
1635 /* Include the bits for control and shift
1636 only if the basic ASCII code can't indicate them. */
1640 /* Replace the high bits. */
1641 c
|= (upper
& ~ctrl_modifier
);
1648 /* Input of single characters from keyboard */
1650 Lisp_Object
print_help ();
1651 static Lisp_Object
kbd_buffer_get_event ();
1652 static void record_char ();
1655 static jmp_buf wrong_kboard_jmpbuf
;
1658 /* read a character from the keyboard; call the redisplay if needed */
1659 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1660 -1 means do not do redisplay, but do do autosaving.
1663 /* The arguments MAPS and NMAPS are for menu prompting.
1664 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1666 PREV_EVENT is the previous input event, or nil if we are reading
1667 the first event of a key sequence.
1669 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1670 if we used a mouse menu to read the input, or zero otherwise. If
1671 USED_MOUSE_MENU is null, we don't dereference it.
1673 Value is t if we showed a menu and the user rejected it. */
1676 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1680 Lisp_Object prev_event
;
1681 int *used_mouse_menu
;
1683 register Lisp_Object c
;
1685 jmp_buf local_getcjmp
;
1687 int key_already_recorded
= 0;
1688 Lisp_Object tem
, save
;
1689 Lisp_Object also_record
;
1692 before_command_key_count
= this_command_key_count
;
1693 before_command_echo_length
= echo_length ();
1697 if (CONSP (Vunread_command_events
))
1699 c
= XCONS (Vunread_command_events
)->car
;
1700 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1702 /* Undo what read_char_x_menu_prompt did when it unread
1703 additional keys returned by Fx_popup_menu. */
1705 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1706 && NILP (XCONS (c
)->cdr
))
1709 if (this_command_key_count
== 0)
1715 if (unread_command_char
!= -1)
1717 XSETINT (c
, unread_command_char
);
1718 unread_command_char
= -1;
1720 if (this_command_key_count
== 0)
1726 /* If there is no function key translated before
1727 reset-this-command-lengths takes effect, forget about it. */
1728 before_command_restore_flag
= 0;
1730 if (!NILP (Vexecuting_macro
))
1732 /* We set this to Qmacro; since that's not a frame, nobody will
1733 try to switch frames on us, and the selected window will
1736 Since this event came from a macro, it would be misleading to
1737 leave internal_last_event_frame set to wherever the last
1738 real event came from. Normally, a switch-frame event selects
1739 internal_last_event_frame after each command is read, but
1740 events read from a macro should never cause a new frame to be
1742 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1744 /* Exit the macro if we are at the end.
1745 Also, some things replace the macro with t
1746 to force an early exit. */
1747 if (EQ (Vexecuting_macro
, Qt
)
1748 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1754 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1755 if (STRINGP (Vexecuting_macro
)
1756 && (XINT (c
) & 0x80))
1757 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1759 executing_macro_index
++;
1764 if (!NILP (unread_switch_frame
))
1766 c
= unread_switch_frame
;
1767 unread_switch_frame
= Qnil
;
1769 /* This event should make it into this_command_keys, and get echoed
1770 again, so we go to reread_first, rather than reread. */
1774 if (commandflag
>= 0 && !input_pending
1775 && !detect_input_pending_run_timers (0))
1778 /* Message turns off echoing unless more keystrokes turn it on again. */
1779 if (echo_area_glyphs
&& *echo_area_glyphs
1780 && echo_area_glyphs
!= current_kboard
->echobuf
1781 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1784 /* If already echoing, continue. */
1787 /* Try reading a character via menu prompting in the minibuf.
1788 Try this before the sit-for, because the sit-for
1789 would do the wrong thing if we are supposed to do
1790 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1791 after a mouse event so don't try a minibuf menu. */
1793 if (nmaps
> 0 && INTERACTIVE
1794 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1795 /* Don't bring up a menu if we already have another event. */
1796 && NILP (Vunread_command_events
)
1797 && unread_command_char
< 0
1798 && !detect_input_pending_run_timers (0))
1800 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1803 key_already_recorded
= 1;
1808 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1809 We will do that below, temporarily for short sections of code,
1810 when appropriate. local_getcjmp must be in effect
1811 around any call to sit_for or kbd_buffer_get_event;
1812 it *must not* be in effect when we call redisplay. */
1814 if (_setjmp (local_getcjmp
))
1816 XSETINT (c
, quit_char
);
1817 XSETFRAME (internal_last_event_frame
, selected_frame
);
1818 Vlast_event_frame
= internal_last_event_frame
;
1819 /* If we report the quit char as an event,
1820 don't do so more than once. */
1821 if (!NILP (Vinhibit_quit
))
1826 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1827 if (kb
!= current_kboard
)
1829 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1830 /* We shouldn't get here if we were in single-kboard mode! */
1833 while (CONSP (*tailp
))
1834 tailp
= &XCONS (*tailp
)->cdr
;
1837 *tailp
= Fcons (c
, Qnil
);
1838 kb
->kbd_queue_has_data
= 1;
1839 current_kboard
= kb
;
1840 longjmp (wrong_kboard_jmpbuf
, 1);
1847 timer_start_idle ();
1849 /* If in middle of key sequence and minibuffer not active,
1850 start echoing if enough time elapses. */
1852 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1853 && this_command_key_count
> 0
1855 && echo_keystrokes
> 0
1856 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1857 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1861 /* After a mouse event, start echoing right away.
1862 This is because we are probably about to display a menu,
1863 and we don't want to delay before doing so. */
1864 if (EVENT_HAS_PARAMETERS (prev_event
))
1868 save_getcjmp (save_jump
);
1869 restore_getcjmp (local_getcjmp
);
1870 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1871 restore_getcjmp (save_jump
);
1877 /* Maybe auto save due to number of keystrokes. */
1879 if (commandflag
!= 0
1880 && auto_save_interval
> 0
1881 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1882 && !detect_input_pending_run_timers (0))
1884 Fdo_auto_save (Qnil
, Qnil
);
1885 /* Hooks can actually change some buffers in auto save. */
1889 /* Try reading using an X menu.
1890 This is never confused with reading using the minibuf
1891 because the recursive call of read_char in read_char_minibuf_menu_prompt
1892 does not pass on any keymaps. */
1894 if (nmaps
> 0 && INTERACTIVE
1895 && !NILP (prev_event
)
1896 && EVENT_HAS_PARAMETERS (prev_event
)
1897 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1898 /* Don't bring up a menu if we already have another event. */
1899 && NILP (Vunread_command_events
)
1900 && unread_command_char
< 0)
1901 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1903 /* Maybe autosave and/or garbage collect due to idleness. */
1905 if (INTERACTIVE
&& NILP (c
))
1907 int delay_level
, buffer_size
;
1909 /* Slow down auto saves logarithmically in size of current buffer,
1910 and garbage collect while we're at it. */
1911 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1912 last_non_minibuf_size
= Z
- BEG
;
1913 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1915 while (buffer_size
> 64)
1916 delay_level
++, buffer_size
-= buffer_size
>> 2;
1917 if (delay_level
< 4) delay_level
= 4;
1918 /* delay_level is 4 for files under around 50k, 7 at 100k,
1919 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1921 /* Auto save if enough time goes by without input. */
1922 if (commandflag
!= 0
1923 && num_nonmacro_input_chars
> last_auto_save
1924 && INTEGERP (Vauto_save_timeout
)
1925 && XINT (Vauto_save_timeout
) > 0)
1929 save_getcjmp (save_jump
);
1930 restore_getcjmp (local_getcjmp
);
1931 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
1933 restore_getcjmp (save_jump
);
1937 Fdo_auto_save (Qnil
, Qnil
);
1939 /* If we have auto-saved and there is still no input
1940 available, garbage collect if there has been enough
1941 consing going on to make it worthwhile. */
1942 if (!detect_input_pending_run_timers (0)
1943 && consing_since_gc
> gc_cons_threshold
/ 2)
1944 Fgarbage_collect ();
1951 /* Read something from current KBOARD's side queue, if possible. */
1955 if (current_kboard
->kbd_queue_has_data
)
1957 if (!CONSP (current_kboard
->kbd_queue
))
1959 c
= XCONS (current_kboard
->kbd_queue
)->car
;
1960 current_kboard
->kbd_queue
1961 = XCONS (current_kboard
->kbd_queue
)->cdr
;
1962 if (NILP (current_kboard
->kbd_queue
))
1963 current_kboard
->kbd_queue_has_data
= 0;
1964 input_pending
= readable_events (0);
1965 if (EVENT_HAS_PARAMETERS (c
)
1966 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
1967 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
1968 Vlast_event_frame
= internal_last_event_frame
;
1973 /* If current_kboard's side queue is empty check the other kboards.
1974 If one of them has data that we have not yet seen here,
1975 switch to it and process the data waiting for it.
1977 Note: if the events queued up for another kboard
1978 have already been seen here, and therefore are not a complete command,
1979 the kbd_queue_has_data field is 0, so we skip that kboard here.
1980 That's to avoid an infinite loop switching between kboards here. */
1981 if (NILP (c
) && !single_kboard
)
1984 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
1985 if (kb
->kbd_queue_has_data
)
1987 current_kboard
= kb
;
1988 longjmp (wrong_kboard_jmpbuf
, 1);
1997 /* Finally, we read from the main queue,
1998 and if that gives us something we can't use yet, we put it on the
1999 appropriate side queue and try again. */
2005 /* Actually read a character, waiting if necessary. */
2006 save_getcjmp (save_jump
);
2007 restore_getcjmp (local_getcjmp
);
2008 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2009 restore_getcjmp (save_jump
);
2012 if (! NILP (c
) && (kb
!= current_kboard
))
2014 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2015 while (CONSP (*tailp
))
2016 tailp
= &XCONS (*tailp
)->cdr
;
2019 *tailp
= Fcons (c
, Qnil
);
2020 kb
->kbd_queue_has_data
= 1;
2024 current_kboard
= kb
;
2025 longjmp (wrong_kboard_jmpbuf
, 1);
2030 /* Terminate Emacs in batch mode if at eof. */
2031 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2032 Fkill_emacs (make_number (1));
2036 /* Add in any extra modifiers, where appropriate. */
2037 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2038 || ((extra_keyboard_modifiers
& 0177) < ' '
2039 && (extra_keyboard_modifiers
& 0177) != 0))
2040 XSETINT (c
, make_ctrl_char (XINT (c
)));
2042 /* Transfer any other modifier bits directly from
2043 extra_keyboard_modifiers to c. Ignore the actual character code
2044 in the low 16 bits of extra_keyboard_modifiers. */
2045 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2050 /* Now that we have read an event, Emacs is not idle--
2051 unless the event was a timer event (not used now). */
2052 if (! (CONSP (c
) && EQ (XCONS (c
)->car
, Qtimer_event
)))
2059 if (commandflag
>= 0
2060 && !input_pending
&& !detect_input_pending_run_timers (0))
2068 /* Buffer switch events are only for internal wakeups
2069 so don't show them to the user. */
2073 if (key_already_recorded
)
2076 /* Process special events within read_char
2077 and loop around to read another event. */
2080 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2086 int was_locked
= single_kboard
;
2088 last_input_char
= c
;
2089 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2091 /* Resume allowing input from any kboard, if that was true before. */
2093 any_kboard_state ();
2098 /* Wipe the echo area. */
2099 echo_area_glyphs
= 0;
2101 /* Handle things that only apply to characters. */
2104 /* If kbd_buffer_get_event gave us an EOF, return that. */
2108 if (STRINGP (Vkeyboard_translate_table
)
2109 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2110 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2111 else if ((VECTORP (Vkeyboard_translate_table
)
2112 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2113 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2114 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2117 d
= Faref (Vkeyboard_translate_table
, c
);
2118 /* nil in keyboard-translate-table means no translation. */
2124 /* If this event is a mouse click in the menu bar,
2125 return just menu-bar for now. Modify the mouse click event
2126 so we won't do this twice, then queue it up. */
2127 if (EVENT_HAS_PARAMETERS (c
)
2128 && CONSP (XCONS (c
)->cdr
)
2129 && CONSP (EVENT_START (c
))
2130 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2134 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2135 /* Handle menu-bar events:
2136 insert the dummy prefix event `menu-bar'. */
2137 if (EQ (posn
, Qmenu_bar
))
2139 /* Change menu-bar to (menu-bar) as the event "position". */
2140 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2143 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2149 if (! NILP (also_record
))
2150 record_char (also_record
);
2154 before_command_key_count
= this_command_key_count
;
2155 before_command_echo_length
= echo_length ();
2157 /* Don't echo mouse motion events. */
2159 && ! (EVENT_HAS_PARAMETERS (c
)
2160 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2163 if (! NILP (also_record
))
2164 echo_char (also_record
);
2165 /* Once we reread a character, echoing can happen
2166 the next time we pause to read a new one. */
2167 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2170 /* Record this character as part of the current key. */
2171 add_command_key (c
);
2172 if (! NILP (also_record
))
2173 add_command_key (also_record
);
2175 /* Re-reading in the middle of a command */
2177 last_input_char
= c
;
2180 /* Process the help character specially if enabled */
2181 if (!NILP (Vhelp_form
) && help_char_p (c
))
2184 count
= specpdl_ptr
- specpdl
;
2186 record_unwind_protect (Fset_window_configuration
,
2187 Fcurrent_window_configuration (Qnil
));
2189 tem0
= Feval (Vhelp_form
);
2191 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2195 c
= read_char (0, 0, 0, Qnil
, 0);
2196 while (BUFFERP (c
));
2197 /* Remove the help from the frame */
2198 unbind_to (count
, Qnil
);
2201 if (EQ (c
, make_number (040)))
2205 c
= read_char (0, 0, 0, Qnil
, 0);
2206 while (BUFFERP (c
));
2213 /* Return 1 if should recognize C as "the help character". */
2221 if (EQ (c
, Vhelp_char
))
2223 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2224 if (EQ (c
, XCONS (tail
)->car
))
2229 /* Record the input event C in various ways. */
2236 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2237 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2238 recent_keys_index
= 0;
2240 /* Write c to the dribble file. If c is a lispy event, write
2241 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2242 If you, dear reader, have a better idea, you've got the source. :-) */
2247 if (XUINT (c
) < 0x100)
2248 putc (XINT (c
), dribble
);
2250 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2254 Lisp_Object dribblee
;
2256 /* If it's a structured event, take the event header. */
2257 dribblee
= EVENT_HEAD (c
);
2259 if (SYMBOLP (dribblee
))
2261 putc ('<', dribble
);
2262 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2263 XSYMBOL (dribblee
)->name
->size
,
2265 putc ('>', dribble
);
2272 store_kbd_macro_char (c
);
2274 num_nonmacro_input_chars
++;
2281 struct buffer
*old
= current_buffer
;
2282 Fprinc (object
, Qnil
);
2283 set_buffer_internal (XBUFFER (Vstandard_output
));
2284 call0 (intern ("help-mode"));
2285 set_buffer_internal (old
);
2289 /* Copy out or in the info on where C-g should throw to.
2290 This is used when running Lisp code from within get_char,
2291 in case get_char is called recursively.
2292 See read_process_output. */
2297 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2300 restore_getcjmp (temp
)
2303 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2308 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2309 of this function. */
2312 tracking_off (old_value
)
2313 Lisp_Object old_value
;
2315 do_mouse_tracking
= old_value
;
2316 if (NILP (old_value
))
2318 /* Redisplay may have been preempted because there was input
2319 available, and it assumes it will be called again after the
2320 input has been processed. If the only input available was
2321 the sort that we have just disabled, then we need to call
2323 if (!readable_events (1))
2325 redisplay_preserve_echo_area ();
2326 get_input_pending (&input_pending
, 1);
2331 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2332 "Evaluate BODY with mouse movement events enabled.\n\
2333 Within a `track-mouse' form, mouse motion generates input events that\n\
2334 you can read with `read-event'.\n\
2335 Normally, mouse motion is ignored.")
2339 int count
= specpdl_ptr
- specpdl
;
2342 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2344 do_mouse_tracking
= Qt
;
2346 val
= Fprogn (args
);
2347 return unbind_to (count
, val
);
2350 /* If mouse has moved on some frame, return one of those frames.
2351 Return 0 otherwise. */
2356 Lisp_Object tail
, frame
;
2358 FOR_EACH_FRAME (tail
, frame
)
2360 if (XFRAME (frame
)->mouse_moved
)
2361 return XFRAME (frame
);
2367 #endif /* HAVE_MOUSE */
2369 /* Low level keyboard/mouse input.
2370 kbd_buffer_store_event places events in kbd_buffer, and
2371 kbd_buffer_get_event retrieves them. */
2373 /* Return true iff there are any events in the queue that read-char
2374 would return. If this returns false, a read-char would block. */
2376 readable_events (do_timers_now
)
2380 timer_check (do_timers_now
);
2382 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2385 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2390 if (current_kboard
->kbd_queue_has_data
)
2396 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2397 if (kb
->kbd_queue_has_data
)
2403 /* Set this for debugging, to have a way to get out */
2408 event_to_kboard (event
)
2409 struct input_event
*event
;
2412 frame
= event
->frame_or_window
;
2414 frame
= XCONS (frame
)->car
;
2415 else if (WINDOWP (frame
))
2416 frame
= WINDOW_FRAME (XWINDOW (frame
));
2418 /* There are still some events that don't set this field.
2419 For now, just ignore the problem.
2420 Also ignore dead frames here. */
2421 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2424 return FRAME_KBOARD (XFRAME (frame
));
2428 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2431 kbd_buffer_store_event (event
)
2432 register struct input_event
*event
;
2434 if (event
->kind
== no_event
)
2437 if (event
->kind
== ascii_keystroke
)
2439 register int c
= event
->code
& 0377;
2441 if (event
->modifiers
& ctrl_modifier
)
2442 c
= make_ctrl_char (c
);
2444 c
|= (event
->modifiers
2445 & (meta_modifier
| alt_modifier
2446 | hyper_modifier
| super_modifier
));
2450 extern SIGTYPE
interrupt_signal ();
2453 struct input_event
*sp
;
2456 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2457 kb
!= current_kboard
))
2460 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2461 Fcons (make_number (c
), Qnil
));
2462 kb
->kbd_queue_has_data
= 1;
2463 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2465 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2468 if (event_to_kboard (sp
) == kb
)
2470 sp
->kind
= no_event
;
2471 sp
->frame_or_window
= Qnil
;
2478 /* If this results in a quit_char being returned to Emacs as
2479 input, set Vlast_event_frame properly. If this doesn't
2480 get returned to Emacs as an event, the next event read
2481 will set Vlast_event_frame again, so this is safe to do. */
2485 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2487 focus
= event
->frame_or_window
;
2488 internal_last_event_frame
= focus
;
2489 Vlast_event_frame
= focus
;
2492 last_event_timestamp
= event
->timestamp
;
2493 interrupt_signal ();
2497 if (c
&& c
== stop_character
)
2503 /* Don't insert two buffer_switch_event's in a row.
2504 Just ignore the second one. */
2505 else if (event
->kind
== buffer_switch_event
2506 && kbd_fetch_ptr
!= kbd_store_ptr
2507 && kbd_store_ptr
->kind
== buffer_switch_event
)
2510 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2511 kbd_store_ptr
= kbd_buffer
;
2513 /* Don't let the very last slot in the buffer become full,
2514 since that would make the two pointers equal,
2515 and that is indistinguishable from an empty buffer.
2516 Discard the event if it would fill the last slot. */
2517 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2519 volatile struct input_event
*sp
= kbd_store_ptr
;
2520 sp
->kind
= event
->kind
;
2521 if (event
->kind
== selection_request_event
)
2523 /* We must not use the ordinary copying code for this case,
2524 since `part' is an enum and copying it might not copy enough
2526 bcopy (event
, (char *) sp
, sizeof (*event
));
2530 sp
->code
= event
->code
;
2531 sp
->part
= event
->part
;
2532 sp
->frame_or_window
= event
->frame_or_window
;
2533 sp
->modifiers
= event
->modifiers
;
2536 sp
->timestamp
= event
->timestamp
;
2538 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2540 = event
->frame_or_window
);
2546 /* Read one event from the event buffer, waiting if necessary.
2547 The value is a Lisp object representing the event.
2548 The value is nil for an event that should be ignored,
2549 or that was handled here.
2550 We always read and discard one event. */
2553 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2555 int *used_mouse_menu
;
2559 EMACS_TIME next_timer_delay
;
2565 *kbp
= current_kboard
;
2569 /* Wait until there is input available. */
2572 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2575 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2579 /* If the quit flag is set, then read_char will return
2580 quit_char, so that counts as "available input." */
2581 if (!NILP (Vquit_flag
))
2582 quit_throw_to_read_char ();
2584 /* One way or another, wait until input is available; then, if
2585 interrupt handlers have not read it, read it now. */
2588 wait_for_kbd_input ();
2590 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2594 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2597 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2601 Lisp_Object minus_one
;
2603 XSETINT (minus_one
, -1);
2604 wait_reading_process_input (0, 0, minus_one
, 1);
2606 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2607 /* Pass 1 for EXPECT since we just waited to have input. */
2608 read_avail_input (1);
2610 #endif /* not VMS */
2613 /* At this point, we know that there is a readable event available
2614 somewhere. If the event queue is empty, then there must be a
2615 mouse movement enabled and available. */
2616 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2618 struct input_event
*event
;
2620 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2624 last_event_timestamp
= event
->timestamp
;
2627 *kbp
= event_to_kboard (event
);
2629 *kbp
= current_kboard
; /* Better than returning null ptr? */
2631 *kbp
= &the_only_kboard
;
2636 /* These two kinds of events get special handling
2637 and don't actually appear to the command loop.
2638 We return nil for them. */
2639 if (event
->kind
== selection_request_event
)
2642 struct input_event copy
;
2644 /* Remove it from the buffer before processing it,
2645 since otherwise swallow_events will see it
2646 and process it again. */
2648 kbd_fetch_ptr
= event
+ 1;
2649 input_pending
= readable_events (0);
2650 x_handle_selection_request (©
);
2652 /* We're getting selection request events, but we don't have
2658 else if (event
->kind
== selection_clear_event
)
2661 struct input_event copy
;
2663 /* Remove it from the buffer before processing it. */
2665 kbd_fetch_ptr
= event
+ 1;
2666 input_pending
= readable_events (0);
2667 x_handle_selection_clear (©
);
2669 /* We're getting selection request events, but we don't have
2674 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2675 else if (event
->kind
== delete_window_event
)
2677 /* Make an event (delete-frame (FRAME)). */
2678 obj
= Fcons (event
->frame_or_window
, Qnil
);
2679 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2680 kbd_fetch_ptr
= event
+ 1;
2682 else if (event
->kind
== iconify_event
)
2684 /* Make an event (iconify-frame (FRAME)). */
2685 obj
= Fcons (event
->frame_or_window
, Qnil
);
2686 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2687 kbd_fetch_ptr
= event
+ 1;
2689 else if (event
->kind
== deiconify_event
)
2691 /* Make an event (make-frame-visible (FRAME)). */
2692 obj
= Fcons (event
->frame_or_window
, Qnil
);
2693 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2694 kbd_fetch_ptr
= event
+ 1;
2697 else if (event
->kind
== buffer_switch_event
)
2699 /* The value doesn't matter here; only the type is tested. */
2700 XSETBUFFER (obj
, current_buffer
);
2701 kbd_fetch_ptr
= event
+ 1;
2703 #ifdef USE_X_TOOLKIT
2704 else if (event
->kind
== menu_bar_activate_event
)
2706 kbd_fetch_ptr
= event
+ 1;
2707 input_pending
= readable_events (0);
2708 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2709 x_activate_menubar (XFRAME (event
->frame_or_window
));
2712 /* Just discard these, by returning nil.
2713 With MULTI_KBOARD, these events are used as placeholders
2714 when we need to randomly delete events from the queue.
2715 (They shouldn't otherwise be found in the buffer,
2716 but on some machines it appears they do show up
2717 even without MULTI_KBOARD.) */
2718 else if (event
->kind
== no_event
)
2719 kbd_fetch_ptr
= event
+ 1;
2721 /* If this event is on a different frame, return a switch-frame this
2722 time, and leave the event in the queue for next time. */
2728 frame
= event
->frame_or_window
;
2730 frame
= XCONS (frame
)->car
;
2731 else if (WINDOWP (frame
))
2732 frame
= WINDOW_FRAME (XWINDOW (frame
));
2734 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2738 if (! EQ (frame
, internal_last_event_frame
)
2739 && XFRAME (frame
) != selected_frame
)
2740 obj
= make_lispy_switch_frame (frame
);
2741 internal_last_event_frame
= frame
;
2743 /* If we didn't decide to make a switch-frame event, go ahead
2744 and build a real event from the queue entry. */
2748 obj
= make_lispy_event (event
);
2749 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2750 /* If this was a menu selection, then set the flag to inhibit
2751 writing to last_nonmenu_event. Don't do this if the event
2752 we're returning is (menu-bar), though; that indicates the
2753 beginning of the menu sequence, and we might as well leave
2754 that as the `event with parameters' for this selection. */
2755 if (event
->kind
== menu_bar_event
2756 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2758 *used_mouse_menu
= 1;
2761 /* Wipe out this event, to catch bugs. */
2762 event
->kind
= no_event
;
2763 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2765 kbd_fetch_ptr
= event
+ 1;
2770 /* Try generating a mouse motion event. */
2771 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2773 FRAME_PTR f
= some_mouse_moved ();
2774 Lisp_Object bar_window
;
2775 enum scroll_bar_part part
;
2779 *kbp
= current_kboard
;
2780 /* Note that this uses F to determine which display to look at.
2781 If there is no valid info, it does not store anything
2782 so x remains nil. */
2784 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2788 /* Decide if we should generate a switch-frame event. Don't
2789 generate switch-frame events for motion outside of all Emacs
2795 frame
= FRAME_FOCUS_FRAME (f
);
2797 XSETFRAME (frame
, f
);
2799 if (! EQ (frame
, internal_last_event_frame
)
2800 && XFRAME (frame
) != selected_frame
)
2801 obj
= make_lispy_switch_frame (frame
);
2802 internal_last_event_frame
= frame
;
2805 /* If we didn't decide to make a switch-frame event, go ahead and
2806 return a mouse-motion event. */
2807 if (!NILP (x
) && NILP (obj
))
2808 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2810 #endif /* HAVE_MOUSE */
2812 /* We were promised by the above while loop that there was
2813 something for us to read! */
2816 input_pending
= readable_events (0);
2818 Vlast_event_frame
= internal_last_event_frame
;
2823 /* Process any events that are not user-visible,
2824 then return, without reading any user-visible events. */
2827 swallow_events (do_display
)
2832 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2834 struct input_event
*event
;
2836 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2840 last_event_timestamp
= event
->timestamp
;
2842 /* These two kinds of events get special handling
2843 and don't actually appear to the command loop. */
2844 if (event
->kind
== selection_request_event
)
2847 struct input_event copy
;
2849 /* Remove it from the buffer before processing it,
2850 since otherwise swallow_events called recursively could see it
2851 and process it again. */
2853 kbd_fetch_ptr
= event
+ 1;
2854 input_pending
= readable_events (0);
2855 x_handle_selection_request (©
);
2857 /* We're getting selection request events, but we don't have
2863 else if (event
->kind
== selection_clear_event
)
2866 struct input_event copy
;
2868 /* Remove it from the buffer before processing it, */
2871 kbd_fetch_ptr
= event
+ 1;
2872 input_pending
= readable_events (0);
2873 x_handle_selection_clear (©
);
2875 /* We're getting selection request events, but we don't have
2880 /* Note that timer_event is currently never used. */
2881 else if (event
->kind
== timer_event
)
2883 Lisp_Object tem
, lisp_event
;
2884 int was_locked
= single_kboard
;
2886 tem
= get_keymap_1 (Vspecial_event_map
, 0, 0);
2887 tem
= get_keyelt (access_keymap (tem
, Qtimer_event
, 0, 0),
2889 lisp_event
= Fcons (Qtimer_event
,
2890 Fcons (Fcdr (event
->frame_or_window
), Qnil
));
2891 kbd_fetch_ptr
= event
+ 1;
2892 if (kbd_fetch_ptr
== kbd_store_ptr
)
2894 Fcommand_execute (tem
, Qnil
, Fvector (1, &lisp_event
), Qt
);
2897 redisplay_preserve_echo_area ();
2899 /* Resume allowing input from any kboard, if that was true before. */
2901 any_kboard_state ();
2907 old_timers_run
= timers_run
;
2908 get_input_pending (&input_pending
, 1);
2910 if (timers_run
!= old_timers_run
&& do_display
)
2911 redisplay_preserve_echo_area ();
2914 static EMACS_TIME timer_idleness_start_time
;
2916 /* Record the start of when Emacs is idle,
2917 for the sake of running idle-time timers. */
2923 /* If we are already in the idle state, do nothing. */
2924 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2927 EMACS_GET_TIME (timer_idleness_start_time
);
2929 /* Mark all idle-time timers as once again candidates for running. */
2930 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
2934 timer
= XCONS (timers
)->car
;
2936 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
2938 XVECTOR (timer
)->contents
[0] = Qnil
;
2942 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
2946 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
2949 /* This is only for debugging. */
2950 struct input_event last_timer_event
;
2952 /* Check whether a timer has fired. To prevent larger problems we simply
2953 disregard elements that are not proper timers. Do not make a circular
2954 timer list for the time being.
2956 Returns the number of seconds to wait until the next timer fires. If a
2957 timer is triggering now, return zero seconds.
2958 If no timer is active, return -1 seconds.
2960 If a timer is ripe, we run it, with quitting turned off.
2962 DO_IT_NOW is now ignored. It used to mean that we should
2963 run the timer directly instead of queueing a timer-event.
2964 Now we always run timers directly. */
2967 timer_check (do_it_now
)
2970 EMACS_TIME nexttime
;
2971 EMACS_TIME now
, idleness_now
;
2972 Lisp_Object timers
, idle_timers
, chosen_timer
;
2973 /* Nonzero if we generate some events. */
2974 int events_generated
= 0;
2975 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2977 EMACS_SET_SECS (nexttime
, -1);
2978 EMACS_SET_USECS (nexttime
, -1);
2980 /* Always consider the ordinary timers. */
2981 timers
= Vtimer_list
;
2982 /* Consider the idle timers only if Emacs is idle. */
2983 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2984 idle_timers
= Vtimer_idle_list
;
2987 chosen_timer
= Qnil
;
2988 GCPRO3 (timers
, idle_timers
, chosen_timer
);
2990 if (CONSP (timers
) || CONSP (idle_timers
))
2992 EMACS_GET_TIME (now
);
2993 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2994 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
2997 while (CONSP (timers
) || CONSP (idle_timers
))
2999 int triggertime
= EMACS_SECS (now
);
3000 Lisp_Object
*vector
;
3001 Lisp_Object timer
, idle_timer
;
3002 EMACS_TIME timer_time
, idle_timer_time
;
3003 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3005 /* Skip past invalid timers and timers already handled. */
3008 timer
= XCONS (timers
)->car
;
3009 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3011 timers
= XCONS (timers
)->cdr
;
3014 vector
= XVECTOR (timer
)->contents
;
3016 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3017 || !INTEGERP (vector
[3])
3018 || ! NILP (vector
[0]))
3020 timers
= XCONS (timers
)->cdr
;
3024 if (!NILP (idle_timers
))
3026 timer
= XCONS (idle_timers
)->car
;
3027 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3029 idle_timers
= XCONS (idle_timers
)->cdr
;
3032 vector
= XVECTOR (timer
)->contents
;
3034 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3035 || !INTEGERP (vector
[3])
3036 || ! NILP (vector
[0]))
3038 idle_timers
= XCONS (idle_timers
)->cdr
;
3043 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3044 based on the next ordinary timer.
3045 TIMER_DIFFERENCE is the distance in time from NOW to when
3046 this timer becomes ripe (negative if it's already ripe). */
3049 timer
= XCONS (timers
)->car
;
3050 vector
= XVECTOR (timer
)->contents
;
3051 EMACS_SET_SECS (timer_time
,
3052 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3053 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3054 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3057 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3058 based on the next idle timer. */
3059 if (!NILP (idle_timers
))
3061 idle_timer
= XCONS (idle_timers
)->car
;
3062 vector
= XVECTOR (idle_timer
)->contents
;
3063 EMACS_SET_SECS (idle_timer_time
,
3064 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3065 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3066 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3069 /* Decide which timer is the next timer,
3070 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3071 Also step down the list where we found that timer. */
3073 if (! NILP (timers
) && ! NILP (idle_timers
))
3076 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3077 if (EMACS_TIME_NEG_P (temp
))
3079 chosen_timer
= timer
;
3080 timers
= XCONS (timers
)->cdr
;
3081 difference
= timer_difference
;
3085 chosen_timer
= idle_timer
;
3086 idle_timers
= XCONS (idle_timers
)->cdr
;
3087 difference
= idle_timer_difference
;
3090 else if (! NILP (timers
))
3092 chosen_timer
= timer
;
3093 timers
= XCONS (timers
)->cdr
;
3094 difference
= timer_difference
;
3098 chosen_timer
= idle_timer
;
3099 idle_timers
= XCONS (idle_timers
)->cdr
;
3100 difference
= idle_timer_difference
;
3102 vector
= XVECTOR (chosen_timer
)->contents
;
3104 /* If timer is rupe, run it if it hasn't been run. */
3105 if (EMACS_TIME_NEG_P (difference
)
3106 || (EMACS_SECS (difference
) == 0
3107 && EMACS_USECS (difference
) == 0))
3109 if (NILP (vector
[0]))
3111 /* Mark the timer as triggered to prevent problems if the lisp
3112 code fails to reschedule it right. */
3115 /* Run the timer or queue a timer event. */
3118 Lisp_Object tem
, event
;
3119 int was_locked
= single_kboard
;
3120 int count
= specpdl_ptr
- specpdl
;
3122 specbind (Qinhibit_quit
, Qt
);
3124 tem
= get_keymap_1 (Vspecial_event_map
, 0, 0);
3125 tem
= get_keyelt (access_keymap (tem
, Qtimer_event
, 0, 0),
3127 event
= Fcons (Qtimer_event
, Fcons (chosen_timer
, Qnil
));
3128 Fcommand_execute (tem
, Qnil
, Fvector (1, &event
), Qt
);
3131 unbind_to (count
, Qnil
);
3133 /* Resume allowing input from any kboard, if that was true before. */
3135 any_kboard_state ();
3137 /* Since we have handled the event,
3138 we don't need to tell the caller to wake up and do it. */
3143 /* Generate a timer event so the caller will handle it. */
3144 struct input_event event
;
3146 event
.kind
= timer_event
;
3147 event
.modifiers
= 0;
3148 event
.x
= event
.y
= Qnil
;
3149 event
.timestamp
= triggertime
;
3150 /* Store the timer in the frame slot. */
3151 event
.frame_or_window
3152 = Fcons (Fselected_frame (), chosen_timer
);
3153 kbd_buffer_store_event (&event
);
3155 last_timer_event
= event
;
3157 /* Tell caller to handle this event right away. */
3158 events_generated
= 1;
3159 EMACS_SET_SECS (nexttime
, 0);
3160 EMACS_SET_USECS (nexttime
, 0);
3162 /* Don't queue more than one event at once.
3163 When Emacs is ready for another, it will
3164 queue the next one. */
3172 /* When we encounter a timer that is still waiting,
3173 return the amount of time to wait before it is ripe. */
3176 /* But if we generated an event,
3177 tell the caller to handle it now. */
3178 if (events_generated
)
3184 /* No timers are pending in the future. */
3185 /* Return 0 if we generated an event, and -1 if not. */
3190 /* Caches for modify_event_symbol. */
3191 static Lisp_Object accent_key_syms
;
3192 static Lisp_Object func_key_syms
;
3193 static Lisp_Object mouse_syms
;
3195 /* This is a list of keysym codes for special "accent" characters.
3196 It parallels lispy_accent_keys. */
3198 static int lispy_accent_codes
[] =
3200 #ifdef XK_dead_circumflex
3205 #ifdef XK_dead_grave
3210 #ifdef XK_dead_tilde
3215 #ifdef XK_dead_diaeresis
3220 #ifdef XK_dead_macron
3225 #ifdef XK_dead_degree
3230 #ifdef XK_dead_acute
3235 #ifdef XK_dead_cedilla
3240 #ifdef XK_dead_breve
3245 #ifdef XK_dead_ogonek
3250 #ifdef XK_dead_caron
3255 #ifdef XK_dead_doubleacute
3256 XK_dead_doubleacute
,
3260 #ifdef XK_dead_abovedot
3267 /* This is a list of Lisp names for special "accent" characters.
3268 It parallels lispy_accent_codes. */
3270 static char *lispy_accent_keys
[] =
3288 #define FUNCTION_KEY_OFFSET 0x0
3290 char *lispy_function_keys
[] =
3294 0, /* VK_LBUTTON 0x01 */
3295 0, /* VK_RBUTTON 0x02 */
3296 "cancel", /* VK_CANCEL 0x03 */
3297 0, /* VK_MBUTTON 0x04 */
3299 0, 0, 0, /* 0x05 .. 0x07 */
3301 "backspace", /* VK_BACK 0x08 */
3302 "tab", /* VK_TAB 0x09 */
3304 0, 0, /* 0x0A .. 0x0B */
3306 "clear", /* VK_CLEAR 0x0C */
3307 "return", /* VK_RETURN 0x0D */
3309 0, 0, /* 0x0E .. 0x0F */
3311 "shift", /* VK_SHIFT 0x10 */
3312 "control", /* VK_CONTROL 0x11 */
3313 "menu", /* VK_MENU 0x12 */
3314 "pause", /* VK_PAUSE 0x13 */
3315 "capital", /* VK_CAPITAL 0x14 */
3317 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3319 0, /* VK_ESCAPE 0x1B */
3321 0, 0, 0, 0, /* 0x1C .. 0x1F */
3323 0, /* VK_SPACE 0x20 */
3324 "prior", /* VK_PRIOR 0x21 */
3325 "next", /* VK_NEXT 0x22 */
3326 "end", /* VK_END 0x23 */
3327 "home", /* VK_HOME 0x24 */
3328 "left", /* VK_LEFT 0x25 */
3329 "up", /* VK_UP 0x26 */
3330 "right", /* VK_RIGHT 0x27 */
3331 "down", /* VK_DOWN 0x28 */
3332 "select", /* VK_SELECT 0x29 */
3333 "print", /* VK_PRINT 0x2A */
3334 "execute", /* VK_EXECUTE 0x2B */
3335 "snapshot", /* VK_SNAPSHOT 0x2C */
3336 "insert", /* VK_INSERT 0x2D */
3337 "delete", /* VK_DELETE 0x2E */
3338 "help", /* VK_HELP 0x2F */
3340 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3342 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3344 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3346 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3348 0, 0, 0, 0, 0, 0, 0, 0, 0,
3349 0, 0, 0, 0, 0, 0, 0, 0, 0,
3350 0, 0, 0, 0, 0, 0, 0, 0,
3352 "lwindow", /* VK_LWIN 0x5B */
3353 "rwindow", /* VK_RWIN 0x5C */
3354 "apps", /* VK_APPS 0x5D */
3356 0, 0, /* 0x5E .. 0x5F */
3358 "kp-0", /* VK_NUMPAD0 0x60 */
3359 "kp-1", /* VK_NUMPAD1 0x61 */
3360 "kp-2", /* VK_NUMPAD2 0x62 */
3361 "kp-3", /* VK_NUMPAD3 0x63 */
3362 "kp-4", /* VK_NUMPAD4 0x64 */
3363 "kp-5", /* VK_NUMPAD5 0x65 */
3364 "kp-6", /* VK_NUMPAD6 0x66 */
3365 "kp-7", /* VK_NUMPAD7 0x67 */
3366 "kp-8", /* VK_NUMPAD8 0x68 */
3367 "kp-9", /* VK_NUMPAD9 0x69 */
3368 "kp-multiply", /* VK_MULTIPLY 0x6A */
3369 "kp-add", /* VK_ADD 0x6B */
3370 "kp-separator", /* VK_SEPARATOR 0x6C */
3371 "kp-subtract", /* VK_SUBTRACT 0x6D */
3372 "kp-decimal", /* VK_DECIMAL 0x6E */
3373 "kp-divide", /* VK_DIVIDE 0x6F */
3374 "f1", /* VK_F1 0x70 */
3375 "f2", /* VK_F2 0x71 */
3376 "f3", /* VK_F3 0x72 */
3377 "f4", /* VK_F4 0x73 */
3378 "f5", /* VK_F5 0x74 */
3379 "f6", /* VK_F6 0x75 */
3380 "f7", /* VK_F7 0x76 */
3381 "f8", /* VK_F8 0x77 */
3382 "f9", /* VK_F9 0x78 */
3383 "f10", /* VK_F10 0x79 */
3384 "f11", /* VK_F11 0x7A */
3385 "f12", /* VK_F12 0x7B */
3386 "f13", /* VK_F13 0x7C */
3387 "f14", /* VK_F14 0x7D */
3388 "f15", /* VK_F15 0x7E */
3389 "f16", /* VK_F16 0x7F */
3390 "f17", /* VK_F17 0x80 */
3391 "f18", /* VK_F18 0x81 */
3392 "f19", /* VK_F19 0x82 */
3393 "f20", /* VK_F20 0x83 */
3394 "f21", /* VK_F21 0x84 */
3395 "f22", /* VK_F22 0x85 */
3396 "f23", /* VK_F23 0x86 */
3397 "f24", /* VK_F24 0x87 */
3399 0, 0, 0, 0, /* 0x88 .. 0x8B */
3400 0, 0, 0, 0, /* 0x8C .. 0x8F */
3402 "kp-numlock", /* VK_NUMLOCK 0x90 */
3403 "scroll", /* VK_SCROLL 0x91 */
3405 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3406 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3407 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3408 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3409 "kp-end", /* VK_NUMPAD_END 0x96 */
3410 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3411 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3412 "kp-up", /* VK_NUMPAD_UP 0x99 */
3413 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3414 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3415 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3416 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3418 0, 0, /* 0x9E .. 0x9F */
3421 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3422 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3423 * No other API or message will distinguish left and right keys this way.
3427 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3428 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3429 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3430 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3431 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3437 "attn", /* VK_ATTN 0xF6 */
3438 "crsel", /* VK_CRSEL 0xF7 */
3439 "exsel", /* VK_EXSEL 0xF8 */
3440 "ereof", /* VK_EREOF 0xF9 */
3441 "play", /* VK_PLAY 0xFA */
3442 "zoom", /* VK_ZOOM 0xFB */
3443 "noname", /* VK_NONAME 0xFC */
3444 "pa1", /* VK_PA1 0xFD */
3445 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3450 #define FUNCTION_KEY_OFFSET 0xff00
3452 /* You'll notice that this table is arranged to be conveniently
3453 indexed by X Windows keysym values. */
3454 static char *lispy_function_keys
[] =
3456 /* X Keysym value */
3458 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3466 0, 0, 0, /* 0xff10 */
3468 0, 0, 0, 0, 0, 0, 0,
3471 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3472 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3473 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3475 "home", /* 0xff50 */ /* IsCursorKey */
3486 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3497 "break", /* 0xff6b */
3499 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3501 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3502 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3503 0, 0, 0, 0, 0, 0, 0, 0,
3504 "kp-tab", /* 0xff89 */
3506 "kp-enter", /* 0xff8d */
3508 "kp-f1", /* 0xff91 */
3512 "kp-home", /* 0xff95 */
3517 "kp-prior", /* kp-page-up */
3518 "kp-next", /* kp-page-down */
3524 0, 0, 0, 0, 0, 0, 0, 0, 0,
3525 "kp-multiply", /* 0xffaa */
3530 "kp-divide", /* 0xffaf */
3531 "kp-0", /* 0xffb0 */
3532 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3535 "kp-equal", /* 0xffbd */
3536 "f1", /* 0xffbe */ /* IsFunctionKey */
3538 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3539 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3540 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3541 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3542 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3543 0, 0, 0, 0, 0, 0, 0, 0,
3544 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3545 0, 0, 0, 0, 0, 0, 0, "delete"
3548 #endif /* HAVE_NTGUI */
3550 static char *lispy_mouse_names
[] =
3552 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3555 /* Scroll bar parts. */
3556 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3557 Lisp_Object Qup
, Qdown
;
3559 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3560 Lisp_Object
*scroll_bar_parts
[] = {
3561 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3566 /* A vector, indexed by button number, giving the down-going location
3567 of currently depressed buttons, both scroll bar and non-scroll bar.
3569 The elements have the form
3570 (BUTTON-NUMBER MODIFIER-MASK . REST)
3571 where REST is the cdr of a position as it would be reported in the event.
3573 The make_lispy_event function stores positions here to tell the
3574 difference between click and drag events, and to store the starting
3575 location to be included in drag events. */
3577 static Lisp_Object button_down_location
;
3579 /* Information about the most recent up-going button event: Which
3580 button, what location, and what time. */
3582 static int last_mouse_button
;
3583 static int last_mouse_x
;
3584 static int last_mouse_y
;
3585 static unsigned long button_down_time
;
3587 /* The maximum time between clicks to make a double-click,
3588 or Qnil to disable double-click detection,
3589 or Qt for no time limit. */
3590 Lisp_Object Vdouble_click_time
;
3592 /* The number of clicks in this multiple-click. */
3594 int double_click_count
;
3596 /* Given a struct input_event, build the lisp event which represents
3597 it. If EVENT is 0, build a mouse movement event from the mouse
3598 movement buffer, which should have a movement event in it.
3600 Note that events must be passed to this function in the order they
3601 are received; this function stores the location of button presses
3602 in order to build drag events when the button is released. */
3605 make_lispy_event (event
)
3606 struct input_event
*event
;
3610 switch (SWITCH_ENUM_CAST (event
->kind
))
3612 /* A simple keystroke. */
3613 case ascii_keystroke
:
3615 Lisp_Object lispy_c
;
3616 int c
= event
->code
& 0377;
3617 /* Turn ASCII characters into control characters
3619 if (event
->modifiers
& ctrl_modifier
)
3620 c
= make_ctrl_char (c
);
3622 /* Add in the other modifier bits. We took care of ctrl_modifier
3623 just above, and the shift key was taken care of by the X code,
3624 and applied to control characters by make_ctrl_char. */
3625 c
|= (event
->modifiers
3626 & (meta_modifier
| alt_modifier
3627 | hyper_modifier
| super_modifier
));
3628 button_down_time
= 0;
3629 XSETFASTINT (lispy_c
, c
);
3633 /* A function key. The symbol may need to have modifier prefixes
3635 case non_ascii_keystroke
:
3636 button_down_time
= 0;
3638 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3639 if (event
->code
== lispy_accent_codes
[i
])
3640 return modify_event_symbol (i
,
3642 Qfunction_key
, Qnil
,
3643 lispy_accent_keys
, &accent_key_syms
,
3644 (sizeof (lispy_accent_keys
)
3645 / sizeof (lispy_accent_keys
[0])));
3647 /* Handle system-specific keysyms. */
3648 if (event
->code
& (1 << 28))
3650 /* We need to use an alist rather than a vector as the cache
3651 since we can't make a vector long enuf. */
3652 if (NILP (current_kboard
->system_key_syms
))
3653 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3654 return modify_event_symbol (event
->code
,
3657 current_kboard
->Vsystem_key_alist
,
3658 0, ¤t_kboard
->system_key_syms
,
3662 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3664 Qfunction_key
, Qnil
,
3665 lispy_function_keys
, &func_key_syms
,
3666 (sizeof (lispy_function_keys
)
3667 / sizeof (lispy_function_keys
[0])));
3670 /* Note that timer_event is currently never used. */
3672 return Fcons (Qtimer_event
, Fcons (Fcdr (event
->frame_or_window
), Qnil
));
3675 /* A mouse click. Figure out where it is, decide whether it's
3676 a press, click or drag, and build the appropriate structure. */
3678 case scroll_bar_click
:
3680 int button
= event
->code
;
3682 Lisp_Object position
;
3683 Lisp_Object
*start_pos_ptr
;
3684 Lisp_Object start_pos
;
3686 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3689 /* Build the position as appropriate for this mouse click. */
3690 if (event
->kind
== mouse_click
)
3693 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3698 /* Ignore mouse events that were made on frame that
3699 have been deleted. */
3700 if (! FRAME_LIVE_P (f
))
3703 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3704 &column
, &row
, NULL
, 1);
3706 #ifndef USE_X_TOOLKIT
3707 /* In the non-toolkit version, clicks on the menu bar
3708 are ordinary button events in the event buffer.
3709 Distinguish them, and invoke the menu.
3711 (In the toolkit version, the toolkit handles the menu bar
3712 and Emacs doesn't know about it until after the user
3713 makes a selection.) */
3714 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3715 && (event
->modifiers
& down_modifier
))
3717 Lisp_Object items
, item
;
3722 /* Activate the menu bar on the down event. If the
3723 up event comes in before the menu code can deal with it,
3725 if (! (event
->modifiers
& down_modifier
))
3730 items
= FRAME_MENU_BAR_ITEMS (f
);
3731 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3733 Lisp_Object pos
, string
;
3734 string
= XVECTOR (items
)->contents
[i
+ 1];
3735 pos
= XVECTOR (items
)->contents
[i
+ 3];
3738 if (column
>= XINT (pos
)
3739 && column
< XINT (pos
) + XSTRING (string
)->size
)
3741 item
= XVECTOR (items
)->contents
[i
];
3747 = Fcons (event
->frame_or_window
,
3749 Fcons (Fcons (event
->x
, event
->y
),
3750 Fcons (make_number (event
->timestamp
),
3753 return Fcons (item
, Fcons (position
, Qnil
));
3755 #endif /* not USE_X_TOOLKIT */
3757 window
= window_from_coordinates (f
, column
, row
, &part
);
3759 if (!WINDOWP (window
))
3761 window
= event
->frame_or_window
;
3766 int pixcolumn
, pixrow
;
3767 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3768 row
-= XINT (XWINDOW (window
)->top
);
3769 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3770 XSETINT (event
->x
, pixcolumn
);
3771 XSETINT (event
->y
, pixrow
);
3776 posn
= Qvertical_line
;
3779 buffer_posn_from_coords (XWINDOW (window
),
3786 Fcons (Fcons (event
->x
, event
->y
),
3787 Fcons (make_number (event
->timestamp
),
3793 Lisp_Object portion_whole
;
3796 window
= event
->frame_or_window
;
3797 portion_whole
= Fcons (event
->x
, event
->y
);
3798 part
= *scroll_bar_parts
[(int) event
->part
];
3802 Fcons (Qvertical_scroll_bar
,
3803 Fcons (portion_whole
,
3804 Fcons (make_number (event
->timestamp
),
3805 Fcons (part
, Qnil
)))));
3808 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3810 start_pos
= *start_pos_ptr
;
3811 *start_pos_ptr
= Qnil
;
3813 is_double
= (button
== last_mouse_button
3814 && XINT (event
->x
) == last_mouse_x
3815 && XINT (event
->y
) == last_mouse_y
3816 && button_down_time
!= 0
3817 && (EQ (Vdouble_click_time
, Qt
)
3818 || (INTEGERP (Vdouble_click_time
)
3819 && ((int)(event
->timestamp
- button_down_time
)
3820 < XINT (Vdouble_click_time
)))));
3821 last_mouse_button
= button
;
3822 last_mouse_x
= XINT (event
->x
);
3823 last_mouse_y
= XINT (event
->y
);
3825 /* If this is a button press, squirrel away the location, so
3826 we can decide later whether it was a click or a drag. */
3827 if (event
->modifiers
& down_modifier
)
3831 double_click_count
++;
3832 event
->modifiers
|= ((double_click_count
> 2)
3837 double_click_count
= 1;
3838 button_down_time
= event
->timestamp
;
3839 *start_pos_ptr
= Fcopy_alist (position
);
3842 /* Now we're releasing a button - check the co-ordinates to
3843 see if this was a click or a drag. */
3844 else if (event
->modifiers
& up_modifier
)
3846 /* If we did not see a down before this up,
3847 ignore the up. Probably this happened because
3848 the down event chose a menu item.
3849 It would be an annoyance to treat the release
3850 of the button that chose the menu item
3851 as a separate event. */
3853 if (!CONSP (start_pos
))
3856 event
->modifiers
&= ~up_modifier
;
3857 #if 0 /* Formerly we treated an up with no down as a click event. */
3858 if (!CONSP (start_pos
))
3859 event
->modifiers
|= click_modifier
;
3863 /* The third element of every position should be the (x,y)
3867 down
= Fnth (make_number (2), start_pos
);
3868 if (EQ (event
->x
, XCONS (down
)->car
)
3869 && EQ (event
->y
, XCONS (down
)->cdr
))
3871 event
->modifiers
|= click_modifier
;
3875 button_down_time
= 0;
3876 event
->modifiers
|= drag_modifier
;
3878 /* Don't check is_double; treat this as multiple
3879 if the down-event was multiple. */
3880 if (double_click_count
> 1)
3881 event
->modifiers
|= ((double_click_count
> 2)
3887 /* Every mouse event should either have the down_modifier or
3888 the up_modifier set. */
3892 /* Get the symbol we should use for the mouse click. */
3895 head
= modify_event_symbol (button
,
3898 lispy_mouse_names
, &mouse_syms
,
3899 (sizeof (lispy_mouse_names
)
3900 / sizeof (lispy_mouse_names
[0])));
3901 if (event
->modifiers
& drag_modifier
)
3906 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
3909 Fcons (make_number (double_click_count
),
3919 case win32_scroll_bar_click
:
3921 int button
= event
->code
;
3923 Lisp_Object position
;
3924 Lisp_Object
*start_pos_ptr
;
3925 Lisp_Object start_pos
;
3927 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3932 Lisp_Object portion_whole
;
3935 window
= event
->frame_or_window
;
3936 portion_whole
= Fcons (event
->x
, event
->y
);
3937 part
= *scroll_bar_parts
[(int) event
->part
];
3941 Fcons (Qvertical_scroll_bar
,
3942 Fcons (portion_whole
,
3943 Fcons (make_number (event
->timestamp
),
3944 Fcons (part
, Qnil
)))));
3947 /* Always treat Win32 scroll bar events as clicks. */
3948 event
->modifiers
|= click_modifier
;
3951 /* Get the symbol we should use for the mouse click. */
3954 head
= modify_event_symbol (button
,
3957 lispy_mouse_names
, &mouse_syms
,
3958 (sizeof (lispy_mouse_names
)
3959 / sizeof (lispy_mouse_names
[0])));
3967 #endif /* HAVE_MOUSE */
3969 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3970 case menu_bar_event
:
3971 /* The event value is in the cdr of the frame_or_window slot. */
3972 if (!CONSP (event
->frame_or_window
))
3974 return XCONS (event
->frame_or_window
)->cdr
;
3977 /* The 'kind' field of the event is something we don't recognize. */
3986 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
3988 Lisp_Object bar_window
;
3989 enum scroll_bar_part part
;
3993 /* Is it a scroll bar movement? */
3994 if (frame
&& ! NILP (bar_window
))
3996 Lisp_Object part_sym
;
3998 part_sym
= *scroll_bar_parts
[(int) part
];
3999 return Fcons (Qscroll_bar_movement
,
4000 (Fcons (Fcons (bar_window
,
4001 Fcons (Qvertical_scroll_bar
,
4002 Fcons (Fcons (x
, y
),
4003 Fcons (make_number (time
),
4009 /* Or is it an ordinary mouse movement? */
4019 /* It's in a frame; which window on that frame? */
4020 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4022 window
= window_from_coordinates (frame
, column
, row
, &area
);
4027 if (WINDOWP (window
))
4029 int pixcolumn
, pixrow
;
4030 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4031 row
-= XINT (XWINDOW (window
)->top
);
4032 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4033 XSETINT (x
, pixcolumn
);
4034 XSETINT (y
, pixrow
);
4039 posn
= Qvertical_line
;
4042 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4044 else if (frame
!= 0)
4046 XSETFRAME (window
, frame
);
4057 return Fcons (Qmouse_movement
,
4058 Fcons (Fcons (window
,
4060 Fcons (Fcons (x
, y
),
4061 Fcons (make_number (time
),
4067 #endif /* HAVE_MOUSE */
4069 /* Construct a switch frame event. */
4071 make_lispy_switch_frame (frame
)
4074 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4077 /* Manipulating modifiers. */
4079 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4081 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4082 SYMBOL's name of the end of the modifiers; the string from this
4083 position is the unmodified symbol name.
4085 This doesn't use any caches. */
4088 parse_modifiers_uncached (symbol
, modifier_end
)
4092 struct Lisp_String
*name
;
4096 CHECK_SYMBOL (symbol
, 1);
4099 name
= XSYMBOL (symbol
)->name
;
4101 for (i
= 0; i
+2 <= name
->size
; )
4103 int this_mod_end
= 0;
4106 /* See if the name continues with a modifier word.
4107 Check that the word appears, but don't check what follows it.
4108 Set this_mod and this_mod_end to record what we find. */
4110 switch (name
->data
[i
])
4112 #define SINGLE_LETTER_MOD(BIT) \
4113 (this_mod_end = i + 1, this_mod = BIT)
4116 SINGLE_LETTER_MOD (alt_modifier
);
4120 SINGLE_LETTER_MOD (ctrl_modifier
);
4124 SINGLE_LETTER_MOD (hyper_modifier
);
4128 SINGLE_LETTER_MOD (meta_modifier
);
4132 SINGLE_LETTER_MOD (shift_modifier
);
4136 SINGLE_LETTER_MOD (super_modifier
);
4139 #undef SINGLE_LETTER_MOD
4142 /* If we found no modifier, stop looking for them. */
4143 if (this_mod_end
== 0)
4146 /* Check there is a dash after the modifier, so that it
4147 really is a modifier. */
4148 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
4151 /* This modifier is real; look for another. */
4152 modifiers
|= this_mod
;
4153 i
= this_mod_end
+ 1;
4156 /* Should we include the `click' modifier? */
4157 if (! (modifiers
& (down_modifier
| drag_modifier
4158 | double_modifier
| triple_modifier
))
4159 && i
+ 7 == name
->size
4160 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4161 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4162 modifiers
|= click_modifier
;
4170 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4171 prepended to the string BASE[0..BASE_LEN-1].
4172 This doesn't use any caches. */
4174 apply_modifiers_uncached (modifiers
, base
, base_len
)
4179 /* Since BASE could contain nulls, we can't use intern here; we have
4180 to use Fintern, which expects a genuine Lisp_String, and keeps a
4183 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4189 /* Only the event queue may use the `up' modifier; it should always
4190 be turned into a click or drag event before presented to lisp code. */
4191 if (modifiers
& up_modifier
)
4194 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4195 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4196 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4197 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4198 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4199 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4200 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4201 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4202 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4203 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4204 /* The click modifier is denoted by the absence of other modifiers. */
4208 mod_len
= p
- new_mods
;
4212 Lisp_Object new_name
;
4214 new_name
= make_uninit_string (mod_len
+ base_len
);
4215 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4216 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
4218 return Fintern (new_name
, Qnil
);
4223 static char *modifier_names
[] =
4225 "up", "down", "drag", "click", "double", "triple", 0, 0,
4226 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4227 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4229 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4231 static Lisp_Object modifier_symbols
;
4233 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4235 lispy_modifier_list (modifiers
)
4238 Lisp_Object modifier_list
;
4241 modifier_list
= Qnil
;
4242 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4243 if (modifiers
& (1<<i
))
4244 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4247 return modifier_list
;
4251 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4252 where UNMODIFIED is the unmodified form of SYMBOL,
4253 MASK is the set of modifiers present in SYMBOL's name.
4254 This is similar to parse_modifiers_uncached, but uses the cache in
4255 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4256 Qevent_symbol_elements property. */
4259 parse_modifiers (symbol
)
4262 Lisp_Object elements
;
4264 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4265 if (CONSP (elements
))
4270 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4271 Lisp_Object unmodified
;
4274 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4275 XSYMBOL (symbol
)->name
->size
- end
),
4278 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4280 XSETFASTINT (mask
, modifiers
);
4281 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4283 /* Cache the parsing results on SYMBOL. */
4284 Fput (symbol
, Qevent_symbol_element_mask
,
4286 Fput (symbol
, Qevent_symbol_elements
,
4287 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4289 /* Since we know that SYMBOL is modifiers applied to unmodified,
4290 it would be nice to put that in unmodified's cache.
4291 But we can't, since we're not sure that parse_modifiers is
4298 /* Apply the modifiers MODIFIERS to the symbol BASE.
4299 BASE must be unmodified.
4301 This is like apply_modifiers_uncached, but uses BASE's
4302 Qmodifier_cache property, if present. It also builds
4303 Qevent_symbol_elements properties, since it has that info anyway.
4305 apply_modifiers copies the value of BASE's Qevent_kind property to
4306 the modified symbol. */
4308 apply_modifiers (modifiers
, base
)
4312 Lisp_Object cache
, index
, entry
, new_symbol
;
4314 /* Mask out upper bits. We don't know where this value's been. */
4315 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4317 /* The click modifier never figures into cache indices. */
4318 cache
= Fget (base
, Qmodifier_cache
);
4319 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4320 entry
= assq_no_quit (index
, cache
);
4323 new_symbol
= XCONS (entry
)->cdr
;
4326 /* We have to create the symbol ourselves. */
4327 new_symbol
= apply_modifiers_uncached (modifiers
,
4328 XSYMBOL (base
)->name
->data
,
4329 XSYMBOL (base
)->name
->size
);
4331 /* Add the new symbol to the base's cache. */
4332 entry
= Fcons (index
, new_symbol
);
4333 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4335 /* We have the parsing info now for free, so add it to the caches. */
4336 XSETFASTINT (index
, modifiers
);
4337 Fput (new_symbol
, Qevent_symbol_element_mask
,
4338 Fcons (base
, Fcons (index
, Qnil
)));
4339 Fput (new_symbol
, Qevent_symbol_elements
,
4340 Fcons (base
, lispy_modifier_list (modifiers
)));
4343 /* Make sure this symbol is of the same kind as BASE.
4345 You'd think we could just set this once and for all when we
4346 intern the symbol above, but reorder_modifiers may call us when
4347 BASE's property isn't set right; we can't assume that just
4348 because it has a Qmodifier_cache property it must have its
4349 Qevent_kind set right as well. */
4350 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4354 kind
= Fget (base
, Qevent_kind
);
4356 Fput (new_symbol
, Qevent_kind
, kind
);
4363 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4364 return a symbol with the modifiers placed in the canonical order.
4365 Canonical order is alphabetical, except for down and drag, which
4366 always come last. The 'click' modifier is never written out.
4368 Fdefine_key calls this to make sure that (for example) C-M-foo
4369 and M-C-foo end up being equivalent in the keymap. */
4372 reorder_modifiers (symbol
)
4375 /* It's hopefully okay to write the code this way, since everything
4376 will soon be in caches, and no consing will be done at all. */
4379 parsed
= parse_modifiers (symbol
);
4380 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4381 XCONS (parsed
)->car
);
4385 /* For handling events, we often want to produce a symbol whose name
4386 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4387 to some base, like the name of a function key or mouse button.
4388 modify_event_symbol produces symbols of this sort.
4390 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4391 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4394 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4395 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4397 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4398 persist between calls to modify_event_symbol that it can use to
4399 store a cache of the symbols it's generated for this NAME_TABLE
4400 before. The object stored there may be a vector or an alist.
4402 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4404 MODIFIERS is a set of modifier bits (as given in struct input_events)
4405 whose prefixes should be applied to the symbol name.
4407 SYMBOL_KIND is the value to be placed in the event_kind property of
4408 the returned symbol.
4410 The symbols we create are supposed to have an
4411 `event-symbol-elements' property, which lists the modifiers present
4412 in the symbol's name. */
4415 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4416 name_table
, symbol_table
, table_size
)
4419 Lisp_Object symbol_kind
;
4420 Lisp_Object name_alist
;
4422 Lisp_Object
*symbol_table
;
4423 unsigned int table_size
;
4426 Lisp_Object symbol_int
;
4428 /* Get rid of the "vendor-specific" bit here. */
4429 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4431 /* Is this a request for a valid symbol? */
4432 if (symbol_num
< 0 || symbol_num
>= table_size
)
4435 if (CONSP (*symbol_table
))
4436 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4438 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4439 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4440 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4441 we've never used that symbol before. */
4444 if (! VECTORP (*symbol_table
)
4445 || XVECTOR (*symbol_table
)->size
!= table_size
)
4449 XSETFASTINT (size
, table_size
);
4450 *symbol_table
= Fmake_vector (size
, Qnil
);
4453 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4456 /* Have we already used this symbol before? */
4459 /* No; let's create it. */
4460 if (!NILP (name_alist
))
4461 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4462 else if (name_table
[symbol_num
])
4463 value
= intern (name_table
[symbol_num
]);
4465 #ifdef HAVE_WINDOW_SYSTEM
4468 char *name
= x_get_keysym_name (symbol_num
);
4470 value
= intern (name
);
4477 sprintf (buf
, "key-%d", symbol_num
);
4478 value
= intern (buf
);
4481 if (CONSP (*symbol_table
))
4482 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4484 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4486 /* Fill in the cache entries for this symbol; this also
4487 builds the Qevent_symbol_elements property, which the user
4489 apply_modifiers (modifiers
& click_modifier
, value
);
4490 Fput (value
, Qevent_kind
, symbol_kind
);
4493 /* Apply modifiers to that symbol. */
4494 return apply_modifiers (modifiers
, value
);
4497 /* Convert a list that represents an event type,
4498 such as (ctrl meta backspace), into the usual representation of that
4499 event type as a number or a symbol. */
4501 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4502 "Convert the event description list EVENT-DESC to an event type.\n\
4503 EVENT-DESC should contain one base event type (a character or symbol)\n\
4504 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4505 drag, down, double or triple). The base must be last.\n\
4506 The return value is an event type (a character or symbol) which\n\
4507 has the same base event type and all the specified modifiers.")
4509 Lisp_Object event_desc
;
4517 while (CONSP (rest
))
4522 elt
= XCONS (rest
)->car
;
4523 rest
= XCONS (rest
)->cdr
;
4525 /* Given a symbol, see if it is a modifier name. */
4526 if (SYMBOLP (elt
) && CONSP (rest
))
4527 this = parse_solitary_modifier (elt
);
4531 else if (!NILP (base
))
4532 error ("Two bases given in one event");
4538 /* Let the symbol A refer to the character A. */
4539 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4540 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4542 if (INTEGERP (base
))
4544 /* Turn (shift a) into A. */
4545 if ((modifiers
& shift_modifier
) != 0
4546 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4548 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4549 modifiers
&= ~shift_modifier
;
4552 /* Turn (control a) into C-a. */
4553 if (modifiers
& ctrl_modifier
)
4554 return make_number ((modifiers
& ~ctrl_modifier
)
4555 | make_ctrl_char (XINT (base
)));
4557 return make_number (modifiers
| XINT (base
));
4559 else if (SYMBOLP (base
))
4560 return apply_modifiers (modifiers
, base
);
4562 error ("Invalid base event");
4565 /* Try to recognize SYMBOL as a modifier name.
4566 Return the modifier flag bit, or 0 if not recognized. */
4569 parse_solitary_modifier (symbol
)
4572 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4574 switch (name
->data
[0])
4576 #define SINGLE_LETTER_MOD(BIT) \
4577 if (name->size == 1) \
4580 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4581 if (LEN == name->size \
4582 && ! strncmp (name->data, NAME, LEN)) \
4586 SINGLE_LETTER_MOD (alt_modifier
);
4590 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4594 SINGLE_LETTER_MOD (ctrl_modifier
);
4598 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4599 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4603 SINGLE_LETTER_MOD (hyper_modifier
);
4607 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4611 SINGLE_LETTER_MOD (meta_modifier
);
4615 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4619 SINGLE_LETTER_MOD (shift_modifier
);
4623 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4624 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4625 SINGLE_LETTER_MOD (super_modifier
);
4629 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4630 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4631 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4635 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4638 #undef SINGLE_LETTER_MOD
4639 #undef MULTI_LETTER_MOD
4645 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4646 Such a list is not valid as an event,
4647 but it can be a Lucid-style event type list. */
4650 lucid_event_type_list_p (object
)
4655 if (! CONSP (object
))
4658 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4661 elt
= XCONS (tail
)->car
;
4662 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4669 /* Store into *addr a value nonzero if terminal input chars are available.
4670 Serves the purpose of ioctl (0, FIONREAD, addr)
4671 but works even if FIONREAD does not exist.
4672 (In fact, this may actually read some input.)
4674 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4677 get_input_pending (addr
, do_timers_now
)
4681 /* First of all, have we already counted some input? */
4682 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4684 /* If input is being read as it arrives, and we have none, there is none. */
4685 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4688 /* Try to read some input and see how much we get. */
4690 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4693 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4696 gobble_input (expected
)
4701 if (interrupt_input
)
4704 mask
= sigblock (sigmask (SIGIO
));
4705 read_avail_input (expected
);
4709 #ifdef POLL_FOR_INPUT
4710 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4713 mask
= sigblock (sigmask (SIGALRM
));
4714 read_avail_input (expected
);
4720 read_avail_input (expected
);
4724 /* Put a buffer_switch_event in the buffer
4725 so that read_key_sequence will notice the new current buffer. */
4727 record_asynch_buffer_change ()
4729 struct input_event event
;
4732 event
.kind
= buffer_switch_event
;
4733 event
.frame_or_window
= Qnil
;
4736 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4737 The purpose of the event is to make read_key_sequence look up the
4738 keymaps again. If we aren't in read_key_sequence, we don't need one,
4739 and the event could cause trouble by messing up (input-pending-p). */
4740 tem
= Fwaiting_for_user_input_p ();
4744 /* We never need these events if we have no asynchronous subprocesses. */
4748 /* Make sure no interrupt happens while storing the event. */
4750 if (interrupt_input
)
4753 mask
= sigblock (sigmask (SIGIO
));
4754 kbd_buffer_store_event (&event
);
4761 kbd_buffer_store_event (&event
);
4768 /* Read any terminal input already buffered up by the system
4769 into the kbd_buffer, but do not wait.
4771 EXPECTED should be nonzero if the caller knows there is some input.
4773 Except on VMS, all input is read by this function.
4774 If interrupt_input is nonzero, this function MUST be called
4775 only when SIGIO is blocked.
4777 Returns the number of keyboard chars read, or -1 meaning
4778 this is a bad time to try to read input. */
4781 read_avail_input (expected
)
4784 struct input_event buf
[KBD_BUFFER_SIZE
];
4788 if (read_socket_hook
)
4789 /* No need for FIONREAD or fcntl; just say don't wait. */
4790 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
,
4791 expected
, expected
);
4794 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
4795 the kbd_buffer can really hold. That may prevent loss
4796 of characters on some systems when input is stuffed at us. */
4797 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
4800 /* Determine how many characters we should *try* to read. */
4803 #else /* not WINDOWSNT */
4805 n_to_read
= dos_keysns ();
4808 #else /* not MSDOS */
4810 /* Find out how much input is available. */
4811 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
4812 /* Formerly simply reported no input, but that sometimes led to
4813 a failure of Emacs to terminate.
4814 SIGHUP seems appropriate if we can't reach the terminal. */
4815 /* ??? Is it really right to send the signal just to this process
4816 rather than to the whole process group?
4817 Perhaps on systems with FIONREAD Emacs is alone in its group. */
4818 kill (getpid (), SIGHUP
);
4821 if (n_to_read
> sizeof cbuf
)
4822 n_to_read
= sizeof cbuf
;
4823 #else /* no FIONREAD */
4824 #if defined (USG) || defined (DGUX)
4825 /* Read some input if available, but don't wait. */
4826 n_to_read
= sizeof cbuf
;
4827 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
4832 #endif /* not MSDOS */
4833 #endif /* not WINDOWSNT */
4835 /* Now read; for one reason or another, this will not block.
4836 NREAD is set to the number of chars read. */
4840 cbuf
[0] = dos_keyread ();
4843 nread
= read (input_fd
, cbuf
, n_to_read
);
4845 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
4846 /* The kernel sometimes fails to deliver SIGHUP for ptys.
4847 This looks incorrect, but it isn't, because _BSD causes
4848 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
4849 and that causes a value other than 0 when there is no input. */
4855 /* We used to retry the read if it was interrupted.
4856 But this does the wrong thing when O_NDELAY causes
4857 an EAGAIN error. Does anybody know of a situation
4858 where a retry is actually needed? */
4860 nread
< 0 && (errno
== EAGAIN
4874 #if defined (USG) || defined (DGUX)
4875 fcntl (input_fd
, F_SETFL
, 0);
4876 #endif /* USG or DGUX */
4877 #endif /* no FIONREAD */
4878 for (i
= 0; i
< nread
; i
++)
4880 buf
[i
].kind
= ascii_keystroke
;
4881 buf
[i
].modifiers
= 0;
4882 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
4883 buf
[i
].modifiers
= meta_modifier
;
4887 buf
[i
].code
= cbuf
[i
];
4888 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
4892 /* Scan the chars for C-g and store them in kbd_buffer. */
4893 for (i
= 0; i
< nread
; i
++)
4895 kbd_buffer_store_event (&buf
[i
]);
4896 /* Don't look at input that follows a C-g too closely.
4897 This reduces lossage due to autorepeat on C-g. */
4898 if (buf
[i
].kind
== ascii_keystroke
4899 && buf
[i
].code
== quit_char
)
4905 #endif /* not VMS */
4907 #ifdef SIGIO /* for entire page */
4908 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4911 input_available_signal (signo
)
4914 /* Must preserve main program's value of errno. */
4915 int old_errno
= errno
;
4917 extern int select_alarmed
;
4920 #if defined (USG) && !defined (POSIX_SIGNALS)
4921 /* USG systems forget handlers when they are used;
4922 must reestablish each time */
4923 signal (signo
, input_available_signal
);
4930 if (input_available_clear_time
)
4931 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
4936 nread
= read_avail_input (1);
4937 /* -1 means it's not ok to read the input now.
4938 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
4939 0 means there was no keyboard input available. */
4944 select_alarmed
= 1; /* Force the select emulator back to life */
4955 /* Send ourselves a SIGIO.
4957 This function exists so that the UNBLOCK_INPUT macro in
4958 blockinput.h can have some way to take care of input we put off
4959 dealing with, without assuming that every file which uses
4960 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
4962 reinvoke_input_signal ()
4965 kill (getpid (), SIGIO
);
4971 /* Return the prompt-string of a sparse keymap.
4972 This is the first element which is a string.
4973 Return nil if there is none. */
4981 register Lisp_Object tem
;
4990 static void menu_bar_item ();
4991 static void menu_bar_one_keymap ();
4993 /* These variables hold the vector under construction within
4994 menu_bar_items and its subroutines, and the current index
4995 for storing into that vector. */
4996 static Lisp_Object menu_bar_items_vector
;
4997 static int menu_bar_items_index
;
4999 /* Return a vector of menu items for a menu bar, appropriate
5000 to the current buffer. Each item has three elements in the vector:
5003 OLD is an old vector we can optionally reuse, or nil. */
5006 menu_bar_items (old
)
5009 /* The number of keymaps we're scanning right now, and the number of
5010 keymaps we have allocated space for. */
5013 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5014 in the current keymaps, or nil where it is not a prefix. */
5017 Lisp_Object def
, tem
, tail
;
5026 struct gcpro gcpro1
;
5028 /* In order to build the menus, we need to call the keymap
5029 accessors. They all call QUIT. But this function is called
5030 during redisplay, during which a quit is fatal. So inhibit
5031 quitting while building the menus.
5032 We do this instead of specbind because (1) errors will clear it anyway
5033 and (2) this avoids risk of specpdl overflow. */
5034 oquit
= Vinhibit_quit
;
5038 menu_bar_items_vector
= old
;
5040 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5041 menu_bar_items_index
= 0;
5043 GCPRO1 (menu_bar_items_vector
);
5045 /* Build our list of keymaps.
5046 If we recognize a function key and replace its escape sequence in
5047 keybuf with its symbol, or if the sequence starts with a mouse
5048 click and we need to switch buffers, we jump back here to rebuild
5049 the initial keymaps from the current buffer. */
5053 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5054 if (!NILP (Voverriding_local_map_menu_flag
))
5056 /* Yes, use them (if non-nil) as well as the global map. */
5057 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5059 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5060 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5061 if (!NILP (Voverriding_local_map
))
5062 maps
[nmaps
++] = Voverriding_local_map
;
5066 /* No, so use major and minor mode keymaps. */
5067 nmaps
= current_minor_maps (NULL
, &tmaps
);
5068 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5069 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5070 #ifdef USE_TEXT_PROPERTIES
5071 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5073 maps
[nmaps
++] = current_buffer
->keymap
;
5076 maps
[nmaps
++] = current_global_map
;
5079 /* Look up in each map the dummy prefix key `menu-bar'. */
5083 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5085 if (! NILP (maps
[mapno
]))
5086 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
5090 tem
= Fkeymapp (def
);
5092 menu_bar_one_keymap (def
);
5095 /* Move to the end those items that should be at the end. */
5097 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5100 int end
= menu_bar_items_index
;
5102 for (i
= 0; i
< end
; i
+= 4)
5103 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5105 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5106 /* Move the item at index I to the end,
5107 shifting all the others forward. */
5108 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5109 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5110 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5111 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5113 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5114 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5115 (end
- i
- 4) * sizeof (Lisp_Object
));
5116 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5117 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5118 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5119 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5124 /* Add nil, nil, nil, nil at the end. */
5125 i
= menu_bar_items_index
;
5126 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5129 int newsize
= 2 * i
;
5130 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5131 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5132 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5133 menu_bar_items_vector
= tem
;
5135 /* Add this item. */
5136 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5137 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5138 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5139 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5140 menu_bar_items_index
= i
;
5142 Vinhibit_quit
= oquit
;
5144 return menu_bar_items_vector
;
5147 /* Scan one map KEYMAP, accumulating any menu items it defines
5148 in menu_bar_items_vector. */
5151 menu_bar_one_keymap (keymap
)
5154 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
5156 /* Loop over all keymap entries that have menu strings. */
5157 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5159 item
= XCONS (tail
)->car
;
5162 key
= XCONS (item
)->car
;
5163 binding
= XCONS (item
)->cdr
;
5164 if (CONSP (binding
))
5166 item_string
= XCONS (binding
)->car
;
5167 if (STRINGP (item_string
))
5168 menu_bar_item (key
, item_string
, Fcdr (binding
));
5170 else if (EQ (binding
, Qundefined
))
5171 menu_bar_item (key
, Qnil
, binding
);
5173 else if (VECTORP (item
))
5175 /* Loop over the char values represented in the vector. */
5176 int len
= XVECTOR (item
)->size
;
5178 for (c
= 0; c
< len
; c
++)
5180 Lisp_Object character
;
5181 XSETFASTINT (character
, c
);
5182 binding
= XVECTOR (item
)->contents
[c
];
5183 if (CONSP (binding
))
5185 item_string
= XCONS (binding
)->car
;
5186 if (STRINGP (item_string
))
5187 menu_bar_item (key
, item_string
, Fcdr (binding
));
5189 else if (EQ (binding
, Qundefined
))
5190 menu_bar_item (key
, Qnil
, binding
);
5196 /* This is used as the handler when calling internal_condition_case_1. */
5199 menu_bar_item_1 (arg
)
5205 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5206 If there's already an item for KEY, add this DEF to it. */
5209 menu_bar_item (key
, item_string
, def
)
5210 Lisp_Object key
, item_string
, def
;
5213 Lisp_Object enabled
;
5216 /* Skip menu-bar equiv keys data. */
5217 if (CONSP (def
) && CONSP (XCONS (def
)->car
))
5218 def
= XCONS (def
)->cdr
;
5220 if (EQ (def
, Qundefined
))
5222 /* If a map has an explicit `undefined' as definition,
5223 discard any previously made menu bar item. */
5225 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5226 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5228 if (menu_bar_items_index
> i
+ 4)
5229 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5230 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5231 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5232 menu_bar_items_index
-= 4;
5236 /* If there's no definition for this key yet,
5237 just ignore `undefined'. */
5241 /* See if this entry is enabled. */
5246 /* No property, or nil, means enable.
5247 Otherwise, enable if value is not nil. */
5248 tem
= Fget (def
, Qmenu_enable
);
5250 /* (condition-case nil (eval tem)
5252 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5256 /* Ignore this item if it's not enabled. */
5260 /* Find any existing item for this KEY. */
5261 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5262 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5265 /* If we did not find this KEY, add it at the end. */
5266 if (i
== menu_bar_items_index
)
5268 /* If vector is too small, get a bigger one. */
5269 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5272 int newsize
= 2 * i
;
5273 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5274 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5275 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5276 menu_bar_items_vector
= tem
;
5278 /* Add this item. */
5279 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5280 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5281 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5282 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5283 menu_bar_items_index
= i
;
5285 /* We did find an item for this KEY. Add DEF to its list of maps. */
5289 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5290 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5294 /* Read a character using menus based on maps in the array MAPS.
5295 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5296 Return t if we displayed a menu but the user rejected it.
5298 PREV_EVENT is the previous input event, or nil if we are reading
5299 the first event of a key sequence.
5301 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5302 if we used a mouse menu to read the input, or zero otherwise. If
5303 USED_MOUSE_MENU is null, we don't dereference it.
5305 The prompting is done based on the prompt-string of the map
5306 and the strings associated with various map elements.
5308 This can be done with X menus or with menus put in the minibuf.
5309 These are done in different ways, depending on how the input will be read.
5310 Menus using X are done after auto-saving in read-char, getting the input
5311 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5312 and do auto-saving in the inner call of read_char. */
5315 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5318 Lisp_Object prev_event
;
5319 int *used_mouse_menu
;
5322 register Lisp_Object name
;
5323 Lisp_Object rest
, vector
;
5325 if (used_mouse_menu
)
5326 *used_mouse_menu
= 0;
5328 /* Use local over global Menu maps */
5330 if (! menu_prompting
)
5333 /* Optionally disregard all but the global map. */
5334 if (inhibit_local_menu_bar_menus
)
5336 maps
+= (nmaps
- 1);
5340 /* Get the menu name from the first map that has one (a prompt string). */
5341 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5343 name
= map_prompt (maps
[mapno
]);
5348 /* If we don't have any menus, just read a character normally. */
5353 /* If we got to this point via a mouse click,
5354 use a real menu for mouse selection. */
5355 if (EVENT_HAS_PARAMETERS (prev_event
)
5356 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5358 /* Display the menu and get the selection. */
5359 Lisp_Object
*realmaps
5360 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5364 /* Use the maps that are not nil. */
5365 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5366 if (!NILP (maps
[mapno
]))
5367 realmaps
[nmaps1
++] = maps
[mapno
];
5369 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5374 /* If we got multiple events, unread all but
5376 There is no way to prevent those unread events
5377 from showing up later in last_nonmenu_event.
5378 So turn symbol and integer events into lists,
5379 to indicate that they came from a mouse menu,
5380 so that when present in last_nonmenu_event
5381 they won't confuse things. */
5382 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5383 tem
= XCONS (tem
)->cdr
)
5384 if (SYMBOLP (XCONS (tem
)->car
)
5385 || INTEGERP (XCONS (tem
)->car
))
5387 = Fcons (XCONS (tem
)->car
, Qnil
);
5389 /* If we got more than one event, put all but the first
5390 onto this list to be read later.
5391 Return just the first event now. */
5392 Vunread_command_events
5393 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5394 value
= XCONS (value
)->car
;
5396 else if (NILP (value
))
5398 if (used_mouse_menu
)
5399 *used_mouse_menu
= 1;
5402 #endif /* HAVE_MENUS */
5406 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5407 We make this bigger when necessary, and never free it. */
5408 static char *read_char_minibuf_menu_text
;
5409 /* Size of that buffer. */
5410 static int read_char_minibuf_menu_width
;
5413 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5419 register Lisp_Object name
;
5421 int width
= FRAME_WIDTH (selected_frame
) - 4;
5424 Lisp_Object rest
, vector
;
5427 if (! menu_prompting
)
5430 /* Make sure we have a big enough buffer for the menu text. */
5431 if (read_char_minibuf_menu_text
== 0)
5433 read_char_minibuf_menu_width
= width
+ 4;
5434 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5436 else if (width
+ 4 > read_char_minibuf_menu_width
)
5438 read_char_minibuf_menu_width
= width
+ 4;
5439 read_char_minibuf_menu_text
5440 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5442 menu
= read_char_minibuf_menu_text
;
5444 /* Get the menu name from the first map that has one (a prompt string). */
5445 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5447 name
= map_prompt (maps
[mapno
]);
5452 /* If we don't have any menus, just read a character normally. */
5456 /* Prompt string always starts with map's prompt, and a space. */
5457 strcpy (menu
, XSTRING (name
)->data
);
5458 nlength
= XSTRING (name
)->size
;
5459 menu
[nlength
++] = ':';
5460 menu
[nlength
++] = ' ';
5463 /* Start prompting at start of first map. */
5467 /* Present the documented bindings, a line at a time. */
5474 Lisp_Object orig_defn_macro
;
5476 /* Loop over elements of map. */
5481 /* If reached end of map, start at beginning of next map. */
5485 /* At end of last map, wrap around to first map if just starting,
5486 or end this line if already have something on it. */
5490 if (notfirst
|| nobindings
) break;
5495 /* Look at the next element of the map. */
5497 elt
= XVECTOR (vector
)->contents
[idx
];
5499 elt
= Fcar_safe (rest
);
5501 if (idx
< 0 && VECTORP (elt
))
5503 /* If we found a dense table in the keymap,
5504 advanced past it, but start scanning its contents. */
5505 rest
= Fcdr_safe (rest
);
5511 /* An ordinary element. */
5516 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5517 event
= Fcar_safe (elt
);
5521 s
= Fcar_safe (elt
); /* vector */
5522 XSETINT (event
, idx
);
5525 /* Ignore the element if it has no prompt string. */
5526 if (STRINGP (s
) && INTEGERP (event
))
5528 /* 1 if the char to type matches the string. */
5530 Lisp_Object upcased_event
, downcased_event
;
5533 upcased_event
= Fupcase (event
);
5534 downcased_event
= Fdowncase (event
);
5535 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5536 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5538 desc
= Fsingle_key_description (event
);
5540 /* If we have room for the prompt string, add it to this line.
5541 If this is the first on the line, always add it. */
5542 if ((XSTRING (s
)->size
+ i
+ 2
5543 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5549 /* Punctuate between strings. */
5552 strcpy (menu
+ i
, ", ");
5558 /* If the char to type doesn't match the string's
5559 first char, explicitly show what char to type. */
5562 /* Add as much of string as fits. */
5563 thiswidth
= XSTRING (desc
)->size
;
5564 if (thiswidth
+ i
> width
)
5565 thiswidth
= width
- i
;
5566 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5568 strcpy (menu
+ i
, " = ");
5572 /* Add as much of string as fits. */
5573 thiswidth
= XSTRING (s
)->size
;
5574 if (thiswidth
+ i
> width
)
5575 thiswidth
= width
- i
;
5576 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5582 /* If this element does not fit, end the line now,
5583 and save the element for the next line. */
5584 strcpy (menu
+ i
, "...");
5589 /* Move past this element. */
5590 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5591 /* Handle reaching end of dense table. */
5596 rest
= Fcdr_safe (rest
);
5600 /* Prompt with that and read response. */
5603 /* Make believe its not a keyboard macro in case the help char
5604 is pressed. Help characters are not recorded because menu prompting
5605 is not used on replay.
5607 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5608 current_kboard
->defining_kbd_macro
= Qnil
;
5610 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5611 while (BUFFERP (obj
));
5612 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5614 if (!INTEGERP (obj
))
5619 if (! EQ (obj
, menu_prompt_more_char
)
5620 && (!INTEGERP (menu_prompt_more_char
)
5621 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5623 if (!NILP (current_kboard
->defining_kbd_macro
))
5624 store_kbd_macro_char (obj
);
5627 /* Help char - go round again */
5631 /* Reading key sequences. */
5633 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5634 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5635 keymap, or nil otherwise. Return the index of the first keymap in
5636 which KEY has any binding, or NMAPS if no map has a binding.
5638 If KEY is a meta ASCII character, treat it like meta-prefix-char
5639 followed by the corresponding non-meta character. Keymaps in
5640 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5643 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5646 NEXT may be the same array as CURRENT. */
5649 follow_key (key
, nmaps
, current
, defs
, next
)
5651 Lisp_Object
*current
, *defs
, *next
;
5654 int i
, first_binding
;
5657 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5658 followed by the corresponding non-meta character.
5659 Put the results into DEFS, since we are going to alter that anyway.
5660 Do not alter CURRENT or NEXT. */
5661 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5663 for (i
= 0; i
< nmaps
; i
++)
5664 if (! NILP (current
[i
]))
5667 def
= get_keyelt (access_keymap (current
[i
],
5668 meta_prefix_char
, 1, 0));
5670 /* Note that since we pass the resulting bindings through
5671 get_keymap_1, non-prefix bindings for meta-prefix-char
5673 defs
[i
] = get_keymap_1 (def
, 0, 1);
5679 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5682 first_binding
= nmaps
;
5683 for (i
= nmaps
- 1; i
>= 0; i
--)
5685 if (! NILP (current
[i
]))
5693 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0));
5694 if (! NILP (defs
[i
]))
5701 /* Given the set of bindings we've found, produce the next set of maps. */
5702 if (first_binding
< nmaps
)
5703 for (i
= 0; i
< nmaps
; i
++)
5704 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5706 return first_binding
;
5709 /* Read a sequence of keys that ends with a non prefix character,
5710 storing it in KEYBUF, a buffer of size BUFSIZE.
5712 Return the length of the key sequence stored.
5713 Return -1 if the user rejected a command menu.
5715 Echo starting immediately unless `prompt' is 0.
5717 Where a key sequence ends depends on the currently active keymaps.
5718 These include any minor mode keymaps active in the current buffer,
5719 the current buffer's local map, and the global map.
5721 If a key sequence has no other bindings, we check Vfunction_key_map
5722 to see if some trailing subsequence might be the beginning of a
5723 function key's sequence. If so, we try to read the whole function
5724 key, and substitute its symbolic name into the key sequence.
5726 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5727 `double-' events into similar click events, if that would make them
5728 bound. We try to turn `triple-' events first into `double-' events,
5731 If we get a mouse click in a mode line, vertical divider, or other
5732 non-text area, we treat the click as if it were prefixed by the
5733 symbol denoting that area - `mode-line', `vertical-line', or
5736 If the sequence starts with a mouse click, we read the key sequence
5737 with respect to the buffer clicked on, not the current buffer.
5739 If the user switches frames in the midst of a key sequence, we put
5740 off the switch-frame event until later; the next call to
5741 read_char will return it. */
5744 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5745 can_return_switch_frame
)
5746 Lisp_Object
*keybuf
;
5749 int dont_downcase_last
;
5750 int can_return_switch_frame
;
5752 int count
= specpdl_ptr
- specpdl
;
5754 /* How many keys there are in the current key sequence. */
5757 /* The length of the echo buffer when we started reading, and
5758 the length of this_command_keys when we started reading. */
5762 /* The number of keymaps we're scanning right now, and the number of
5763 keymaps we have allocated space for. */
5765 int nmaps_allocated
= 0;
5767 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5768 the current keymaps. */
5771 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5772 in the current keymaps, or nil where it is not a prefix. */
5773 Lisp_Object
*submaps
;
5775 /* The local map to start out with at start of key sequence. */
5776 Lisp_Object orig_local_map
;
5778 /* 1 if we have already considered switching to the local-map property
5779 of the place where a mouse click occurred. */
5780 int localized_local_map
= 0;
5782 /* The index in defs[] of the first keymap that has a binding for
5783 this key sequence. In other words, the lowest i such that
5784 defs[i] is non-nil. */
5787 /* If t < mock_input, then KEYBUF[t] should be read as the next
5790 We use this to recover after recognizing a function key. Once we
5791 realize that a suffix of the current key sequence is actually a
5792 function key's escape sequence, we replace the suffix with the
5793 function key's binding from Vfunction_key_map. Now keybuf
5794 contains a new and different key sequence, so the echo area,
5795 this_command_keys, and the submaps and defs arrays are wrong. In
5796 this situation, we set mock_input to t, set t to 0, and jump to
5797 restart_sequence; the loop will read keys from keybuf up until
5798 mock_input, thus rebuilding the state; and then it will resume
5799 reading characters from the keyboard. */
5802 /* If the sequence is unbound in submaps[], then
5803 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
5804 and fkey_map is its binding.
5806 These might be > t, indicating that all function key scanning
5807 should hold off until t reaches them. We do this when we've just
5808 recognized a function key, to avoid searching for the function
5809 key's again in Vfunction_key_map. */
5810 int fkey_start
= 0, fkey_end
= 0;
5811 Lisp_Object fkey_map
;
5813 /* Likewise, for key_translation_map. */
5814 int keytran_start
= 0, keytran_end
= 0;
5815 Lisp_Object keytran_map
;
5817 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
5818 we put it off for later. While we're reading, we keep the event here. */
5819 Lisp_Object delayed_switch_frame
;
5821 /* See the comment below... */
5822 #if defined (GOBBLE_FIRST_EVENT)
5823 Lisp_Object first_event
;
5826 Lisp_Object original_uppercase
;
5827 int original_uppercase_position
= -1;
5829 /* Gets around Microsoft compiler limitations. */
5832 struct buffer
*starting_buffer
;
5834 /* Nonzero if we seem to have got the beginning of a binding
5835 in function_key_map. */
5836 int function_key_possible
= 0;
5837 int key_translation_possible
= 0;
5839 /* Save the status of key translation before each step,
5840 so that we can restore this after downcasing. */
5841 Lisp_Object prev_fkey_map
;
5842 Lisp_Object prev_fkey_start
;
5843 Lisp_Object prev_fkey_end
;
5845 Lisp_Object prev_keytran_map
;
5846 Lisp_Object prev_keytran_start
;
5847 Lisp_Object prev_keytran_end
;
5851 last_nonmenu_event
= Qnil
;
5853 delayed_switch_frame
= Qnil
;
5854 fkey_map
= Vfunction_key_map
;
5855 keytran_map
= Vkey_translation_map
;
5857 /* If there is no function-key-map, turn off function key scanning. */
5858 if (NILP (Fkeymapp (Vfunction_key_map
)))
5859 fkey_start
= fkey_end
= bufsize
+ 1;
5861 /* If there is no key-translation-map, turn off scanning. */
5862 if (NILP (Fkeymapp (Vkey_translation_map
)))
5863 keytran_start
= keytran_end
= bufsize
+ 1;
5868 echo_prompt (XSTRING (prompt
)->data
);
5869 else if (cursor_in_echo_area
&& echo_keystrokes
)
5870 /* This doesn't put in a dash if the echo buffer is empty, so
5871 you don't always see a dash hanging out in the minibuffer. */
5875 /* Record the initial state of the echo area and this_command_keys;
5876 we will need to restore them if we replay a key sequence. */
5878 echo_start
= echo_length ();
5879 keys_start
= this_command_key_count
;
5880 this_single_command_key_start
= keys_start
;
5882 #if defined (GOBBLE_FIRST_EVENT)
5883 /* This doesn't quite work, because some of the things that read_char
5884 does cannot safely be bypassed. It seems too risky to try to make
5887 /* Read the first char of the sequence specially, before setting
5888 up any keymaps, in case a filter runs and switches buffers on us. */
5889 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
5891 #endif /* GOBBLE_FIRST_EVENT */
5893 orig_local_map
= get_local_map (PT
, current_buffer
);
5895 /* We jump here when the key sequence has been thoroughly changed, and
5896 we need to rescan it starting from the beginning. When we jump here,
5897 keybuf[0..mock_input] holds the sequence we should reread. */
5900 starting_buffer
= current_buffer
;
5901 function_key_possible
= 0;
5902 key_translation_possible
= 0;
5904 /* Build our list of keymaps.
5905 If we recognize a function key and replace its escape sequence in
5906 keybuf with its symbol, or if the sequence starts with a mouse
5907 click and we need to switch buffers, we jump back here to rebuild
5908 the initial keymaps from the current buffer. */
5912 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
5913 || !NILP (Voverriding_local_map
))
5915 if (3 > nmaps_allocated
)
5917 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
5918 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
5919 nmaps_allocated
= 3;
5922 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5923 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5924 if (!NILP (Voverriding_local_map
))
5925 submaps
[nmaps
++] = Voverriding_local_map
;
5929 nmaps
= current_minor_maps (0, &maps
);
5930 if (nmaps
+ 2 > nmaps_allocated
)
5932 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
5933 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
5934 nmaps_allocated
= nmaps
+ 2;
5936 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
5937 #ifdef USE_TEXT_PROPERTIES
5938 submaps
[nmaps
++] = orig_local_map
;
5940 submaps
[nmaps
++] = current_buffer
->keymap
;
5943 submaps
[nmaps
++] = current_global_map
;
5946 /* Find an accurate initial value for first_binding. */
5947 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
5948 if (! NILP (submaps
[first_binding
]))
5951 /* Start from the beginning in keybuf. */
5954 /* These are no-ops the first time through, but if we restart, they
5955 revert the echo area and this_command_keys to their original state. */
5956 this_command_key_count
= keys_start
;
5957 if (INTERACTIVE
&& t
< mock_input
)
5958 echo_truncate (echo_start
);
5960 /* If the best binding for the current key sequence is a keymap, or
5961 we may be looking at a function key's escape sequence, keep on
5963 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
5964 || (first_binding
>= nmaps
5966 /* mock input is never part of a function key's sequence. */
5967 && mock_input
<= fkey_start
)
5968 || (first_binding
>= nmaps
5969 && keytran_start
< t
&& key_translation_possible
)
5970 /* Don't return in the middle of a possible function key sequence,
5971 if the only bindings we found were via case conversion.
5972 Thus, if ESC O a has a function-key-map translation
5973 and ESC o has a binding, don't return after ESC O,
5974 so that we can translate ESC O plus the next character. */
5978 int used_mouse_menu
= 0;
5980 /* Where the last real key started. If we need to throw away a
5981 key that has expanded into more than one element of keybuf
5982 (say, a mouse click on the mode line which is being treated
5983 as [mode-line (mouse-...)], then we backtrack to this point
5985 int last_real_key_start
;
5987 /* These variables are analogous to echo_start and keys_start;
5988 while those allow us to restart the entire key sequence,
5989 echo_local_start and keys_local_start allow us to throw away
5991 int echo_local_start
, keys_local_start
, local_first_binding
;
5994 error ("Key sequence too long");
5997 echo_local_start
= echo_length ();
5998 keys_local_start
= this_command_key_count
;
5999 local_first_binding
= first_binding
;
6002 /* These are no-ops, unless we throw away a keystroke below and
6003 jumped back up to replay_key; in that case, these restore the
6004 variables to their original state, allowing us to replay the
6006 if (INTERACTIVE
&& t
< mock_input
)
6007 echo_truncate (echo_local_start
);
6008 this_command_key_count
= keys_local_start
;
6009 first_binding
= local_first_binding
;
6011 /* By default, assume each event is "real". */
6012 last_real_key_start
= t
;
6014 /* Does mock_input indicate that we are re-reading a key sequence? */
6018 add_command_key (key
);
6019 if (echo_keystrokes
)
6023 /* If not, we should actually read a character. */
6026 struct buffer
*buf
= current_buffer
;
6030 KBOARD
*interrupted_kboard
= current_kboard
;
6031 struct frame
*interrupted_frame
= selected_frame
;
6032 if (setjmp (wrong_kboard_jmpbuf
))
6034 if (!NILP (delayed_switch_frame
))
6036 interrupted_kboard
->kbd_queue
6037 = Fcons (delayed_switch_frame
,
6038 interrupted_kboard
->kbd_queue
);
6039 delayed_switch_frame
= Qnil
;
6042 interrupted_kboard
->kbd_queue
6043 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6045 /* If the side queue is non-empty, ensure it begins with a
6046 switch-frame, so we'll replay it in the right context. */
6047 if (CONSP (interrupted_kboard
->kbd_queue
)
6048 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6049 !(EVENT_HAS_PARAMETERS (key
)
6050 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6054 XSETFRAME (frame
, interrupted_frame
);
6055 interrupted_kboard
->kbd_queue
6056 = Fcons (make_lispy_switch_frame (frame
),
6057 interrupted_kboard
->kbd_queue
);
6060 orig_local_map
= get_local_map (PT
, current_buffer
);
6061 goto replay_sequence
;
6064 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6068 /* read_char returns t when it shows a menu and the user rejects it.
6073 /* read_char returns -1 at the end of a macro.
6074 Emacs 18 handles this by returning immediately with a
6075 zero, so that's what we'll do. */
6076 if (INTEGERP (key
) && XINT (key
) == -1)
6079 /* The Microsoft C compiler can't handle the goto that
6085 /* If the current buffer has been changed from under us, the
6086 keymap may have changed, so replay the sequence. */
6090 orig_local_map
= get_local_map (PT
, current_buffer
);
6091 goto replay_sequence
;
6094 /* If we have a quit that was typed in another frame, and
6095 quit_throw_to_read_char switched buffers,
6096 replay to get the right keymap. */
6097 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6102 orig_local_map
= get_local_map (PT
, current_buffer
);
6103 goto replay_sequence
;
6109 /* Clicks in non-text areas get prefixed by the symbol
6110 in their CHAR-ADDRESS field. For example, a click on
6111 the mode line is prefixed by the symbol `mode-line'.
6113 Furthermore, key sequences beginning with mouse clicks
6114 are read using the keymaps of the buffer clicked on, not
6115 the current buffer. So we may have to switch the buffer
6118 When we turn one event into two events, we must make sure
6119 that neither of the two looks like the original--so that,
6120 if we replay the events, they won't be expanded again.
6121 If not for this, such reexpansion could happen either here
6122 or when user programs play with this-command-keys. */
6123 if (EVENT_HAS_PARAMETERS (key
))
6127 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6128 if (EQ (kind
, Qmouse_click
))
6130 Lisp_Object window
, posn
;
6132 window
= POSN_WINDOW (EVENT_START (key
));
6133 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6136 /* We're looking at the second event of a
6137 sequence which we expanded before. Set
6138 last_real_key_start appropriately. */
6140 last_real_key_start
= t
- 1;
6143 /* Key sequences beginning with mouse clicks are
6144 read using the keymaps in the buffer clicked on,
6145 not the current buffer. If we're at the
6146 beginning of a key sequence, switch buffers. */
6147 if (last_real_key_start
== 0
6149 && BUFFERP (XWINDOW (window
)->buffer
)
6150 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6155 /* Arrange to go back to the original buffer once we're
6156 done reading the key sequence. Note that we can't
6157 use save_excursion_{save,restore} here, because they
6158 save point as well as the current buffer; we don't
6159 want to save point, because redisplay may change it,
6160 to accommodate a Fset_window_start or something. We
6161 don't want to do this at the top of the function,
6162 because we may get input from a subprocess which
6163 wants to change the selected window and stuff (say,
6165 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6167 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6168 orig_local_map
= get_local_map (PT
, current_buffer
);
6169 goto replay_sequence
;
6171 /* For a mouse click, get the local text-property keymap
6172 of the place clicked on, rather than point. */
6173 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6174 && ! localized_local_map
)
6176 Lisp_Object map_here
, start
, pos
;
6178 localized_local_map
= 1;
6179 start
= EVENT_START (key
);
6180 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6182 pos
= POSN_BUFFER_POSN (start
);
6184 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6186 map_here
= get_local_map (XINT (pos
), current_buffer
);
6187 if (!EQ (map_here
, orig_local_map
))
6189 orig_local_map
= map_here
;
6193 goto replay_sequence
;
6199 /* Expand mode-line and scroll-bar events into two events:
6200 use posn as a fake prefix key. */
6203 if (t
+ 1 >= bufsize
)
6204 error ("Key sequence too long");
6209 /* Zap the position in key, so we know that we've
6210 expanded it, and don't try to do so again. */
6211 POSN_BUFFER_POSN (EVENT_START (key
))
6212 = Fcons (posn
, Qnil
);
6216 else if (EQ (kind
, Qswitch_frame
))
6218 /* If we're at the beginning of a key sequence, and the caller
6219 says it's okay, go ahead and return this event. If we're
6220 in the midst of a key sequence, delay it until the end. */
6221 if (t
> 0 || !can_return_switch_frame
)
6223 delayed_switch_frame
= key
;
6227 else if (CONSP (XCONS (key
)->cdr
)
6228 && CONSP (EVENT_START (key
))
6229 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6233 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6234 /* Handle menu-bar events:
6235 insert the dummy prefix event `menu-bar'. */
6236 if (EQ (posn
, Qmenu_bar
))
6238 if (t
+ 1 >= bufsize
)
6239 error ("Key sequence too long");
6243 /* Zap the position in key, so we know that we've
6244 expanded it, and don't try to do so again. */
6245 POSN_BUFFER_POSN (EVENT_START (key
))
6246 = Fcons (posn
, Qnil
);
6249 goto replay_sequence
;
6251 else if (CONSP (posn
))
6253 /* We're looking at the second event of a
6254 sequence which we expanded before. Set
6255 last_real_key_start appropriately. */
6256 if (last_real_key_start
== t
&& t
> 0)
6257 last_real_key_start
= t
- 1;
6262 /* We have finally decided that KEY is something we might want
6264 first_binding
= (follow_key (key
,
6265 nmaps
- first_binding
,
6266 submaps
+ first_binding
,
6267 defs
+ first_binding
,
6268 submaps
+ first_binding
)
6271 /* If KEY wasn't bound, we'll try some fallbacks. */
6272 if (first_binding
>= nmaps
)
6276 head
= EVENT_HEAD (key
);
6277 if (help_char_p (head
) && t
> 0)
6279 read_key_sequence_cmd
= Vprefix_help_command
;
6281 last_nonmenu_event
= key
;
6282 /* The Microsoft C compiler can't handle the goto that
6290 Lisp_Object breakdown
;
6293 breakdown
= parse_modifiers (head
);
6294 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6295 /* Attempt to reduce an unbound mouse event to a simpler
6296 event that is bound:
6297 Drags reduce to clicks.
6298 Double-clicks reduce to clicks.
6299 Triple-clicks reduce to double-clicks, then to clicks.
6300 Down-clicks are eliminated.
6301 Double-downs reduce to downs, then are eliminated.
6302 Triple-downs reduce to double-downs, then to downs,
6303 then are eliminated. */
6304 if (modifiers
& (down_modifier
| drag_modifier
6305 | double_modifier
| triple_modifier
))
6307 while (modifiers
& (down_modifier
| drag_modifier
6308 | double_modifier
| triple_modifier
))
6310 Lisp_Object new_head
, new_click
;
6311 if (modifiers
& triple_modifier
)
6312 modifiers
^= (double_modifier
| triple_modifier
);
6313 else if (modifiers
& double_modifier
)
6314 modifiers
&= ~double_modifier
;
6315 else if (modifiers
& drag_modifier
)
6316 modifiers
&= ~drag_modifier
;
6319 /* Dispose of this `down' event by simply jumping
6320 back to replay_key, to get another event.
6322 Note that if this event came from mock input,
6323 then just jumping back to replay_key will just
6324 hand it to us again. So we have to wipe out any
6327 We could delete keybuf[t] and shift everything
6328 after that to the left by one spot, but we'd also
6329 have to fix up any variable that points into
6330 keybuf, and shifting isn't really necessary
6333 Adding prefixes for non-textual mouse clicks
6334 creates two characters of mock input, and both
6335 must be thrown away. If we're only looking at
6336 the prefix now, we can just jump back to
6337 replay_key. On the other hand, if we've already
6338 processed the prefix, and now the actual click
6339 itself is giving us trouble, then we've lost the
6340 state of the keymaps we want to backtrack to, and
6341 we need to replay the whole sequence to rebuild
6344 Beyond that, only function key expansion could
6345 create more than two keys, but that should never
6346 generate mouse events, so it's okay to zero
6347 mock_input in that case too.
6349 Isn't this just the most wonderful code ever? */
6350 if (t
== last_real_key_start
)
6357 mock_input
= last_real_key_start
;
6358 goto replay_sequence
;
6363 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6365 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6367 /* Look for a binding for this new key. follow_key
6368 promises that it didn't munge submaps the
6369 last time we called it, since key was unbound. */
6371 = (follow_key (new_click
,
6372 nmaps
- local_first_binding
,
6373 submaps
+ local_first_binding
,
6374 defs
+ local_first_binding
,
6375 submaps
+ local_first_binding
)
6376 + local_first_binding
);
6378 /* If that click is bound, go for it. */
6379 if (first_binding
< nmaps
)
6384 /* Otherwise, we'll leave key set to the drag event. */
6391 /* Normally, last_nonmenu_event gets the previous key we read.
6392 But when a mouse popup menu is being used,
6393 we don't update last_nonmenu_event; it continues to hold the mouse
6394 event that preceded the first level of menu. */
6395 if (!used_mouse_menu
)
6396 last_nonmenu_event
= key
;
6398 /* Record what part of this_command_keys is the current key sequence. */
6399 this_single_command_key_start
= this_command_key_count
- t
;
6401 prev_fkey_map
= fkey_map
;
6402 prev_fkey_start
= fkey_start
;
6403 prev_fkey_end
= fkey_end
;
6405 prev_keytran_map
= keytran_map
;
6406 prev_keytran_start
= keytran_start
;
6407 prev_keytran_end
= keytran_end
;
6409 /* If the sequence is unbound, see if we can hang a function key
6410 off the end of it. We only want to scan real keyboard input
6411 for function key sequences, so if mock_input says that we're
6412 re-reading old events, don't examine it. */
6413 if (first_binding
>= nmaps
6416 Lisp_Object fkey_next
;
6418 /* Continue scan from fkey_end until we find a bound suffix.
6419 If we fail, increment fkey_start
6420 and start fkey_end from there. */
6421 while (fkey_end
< t
)
6425 key
= keybuf
[fkey_end
++];
6426 /* Look up meta-characters by prefixing them
6427 with meta_prefix_char. I hate this. */
6428 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6433 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
6435 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6438 fkey_next
= fkey_map
;
6441 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
6443 #if 0 /* I didn't turn this on, because it might cause trouble
6444 for the mapping of return into C-m and tab into C-i. */
6445 /* Optionally don't map function keys into other things.
6446 This enables the user to redefine kp- keys easily. */
6447 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6451 /* If the function key map gives a function, not an
6452 array, then call the function with no args and use
6453 its value instead. */
6454 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6457 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6461 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6462 fkey_next
= call1 (fkey_next
, prompt
);
6464 /* If the function returned something invalid,
6465 barf--don't ignore it.
6466 (To ignore it safely, we would need to gcpro a bunch of
6467 other variables.) */
6468 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6469 error ("Function in key-translation-map returns invalid key sequence");
6472 function_key_possible
= ! NILP (fkey_next
);
6474 /* If keybuf[fkey_start..fkey_end] is bound in the
6475 function key map and it's a suffix of the current
6476 sequence (i.e. fkey_end == t), replace it with
6477 the binding and restart with fkey_start at the end. */
6478 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6481 int len
= XFASTINT (Flength (fkey_next
));
6483 t
= fkey_start
+ len
;
6485 error ("Key sequence too long");
6487 if (VECTORP (fkey_next
))
6488 bcopy (XVECTOR (fkey_next
)->contents
,
6489 keybuf
+ fkey_start
,
6490 (t
- fkey_start
) * sizeof (keybuf
[0]));
6491 else if (STRINGP (fkey_next
))
6495 for (i
= 0; i
< len
; i
++)
6496 XSETFASTINT (keybuf
[fkey_start
+ i
],
6497 XSTRING (fkey_next
)->data
[i
]);
6501 fkey_start
= fkey_end
= t
;
6502 fkey_map
= Vfunction_key_map
;
6504 /* Do pass the results through key-translation-map. */
6505 keytran_start
= keytran_end
= 0;
6506 keytran_map
= Vkey_translation_map
;
6508 goto replay_sequence
;
6511 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6513 /* If we no longer have a bound suffix, try a new positions for
6515 if (NILP (fkey_map
))
6517 fkey_end
= ++fkey_start
;
6518 fkey_map
= Vfunction_key_map
;
6519 function_key_possible
= 0;
6524 /* Look for this sequence in key-translation-map. */
6526 Lisp_Object keytran_next
;
6528 /* Scan from keytran_end until we find a bound suffix. */
6529 while (keytran_end
< t
)
6533 key
= keybuf
[keytran_end
++];
6534 /* Look up meta-characters by prefixing them
6535 with meta_prefix_char. I hate this. */
6536 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6541 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
6543 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6546 keytran_next
= keytran_map
;
6549 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
6551 /* If the key translation map gives a function, not an
6552 array, then call the function with no args and use
6553 its value instead. */
6554 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6555 && keytran_end
== t
)
6557 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6561 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6562 keytran_next
= call1 (keytran_next
, prompt
);
6564 /* If the function returned something invalid,
6565 barf--don't ignore it.
6566 (To ignore it safely, we would need to gcpro a bunch of
6567 other variables.) */
6568 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6569 error ("Function in key-translation-map returns invalid key sequence");
6572 key_translation_possible
= ! NILP (keytran_next
);
6574 /* If keybuf[keytran_start..keytran_end] is bound in the
6575 key translation map and it's a suffix of the current
6576 sequence (i.e. keytran_end == t), replace it with
6577 the binding and restart with keytran_start at the end. */
6578 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6579 && keytran_end
== t
)
6581 int len
= XFASTINT (Flength (keytran_next
));
6583 t
= keytran_start
+ len
;
6585 error ("Key sequence too long");
6587 if (VECTORP (keytran_next
))
6588 bcopy (XVECTOR (keytran_next
)->contents
,
6589 keybuf
+ keytran_start
,
6590 (t
- keytran_start
) * sizeof (keybuf
[0]));
6591 else if (STRINGP (keytran_next
))
6595 for (i
= 0; i
< len
; i
++)
6596 XSETFASTINT (keybuf
[keytran_start
+ i
],
6597 XSTRING (keytran_next
)->data
[i
]);
6601 keytran_start
= keytran_end
= t
;
6602 keytran_map
= Vkey_translation_map
;
6604 /* Don't pass the results of key-translation-map
6605 through function-key-map. */
6606 fkey_start
= fkey_end
= t
;
6607 fkey_map
= Vkey_translation_map
;
6609 goto replay_sequence
;
6612 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6614 /* If we no longer have a bound suffix, try a new positions for
6616 if (NILP (keytran_map
))
6618 keytran_end
= ++keytran_start
;
6619 keytran_map
= Vkey_translation_map
;
6620 key_translation_possible
= 0;
6625 /* If KEY is not defined in any of the keymaps,
6626 and cannot be part of a function key or translation,
6627 and is an upper case letter
6628 use the corresponding lower-case letter instead. */
6629 if (first_binding
== nmaps
&& ! function_key_possible
6630 && ! key_translation_possible
6632 && ((((XINT (key
) & 0x3ffff)
6633 < XSTRING (current_buffer
->downcase_table
)->size
)
6634 && UPPERCASEP (XINT (key
) & 0x3ffff))
6635 || (XINT (key
) & shift_modifier
)))
6637 Lisp_Object new_key
;
6639 original_uppercase
= key
;
6640 original_uppercase_position
= t
- 1;
6642 if (XINT (key
) & shift_modifier
)
6643 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6645 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6646 | (XINT (key
) & ~0x3ffff)));
6648 /* We have to do this unconditionally, regardless of whether
6649 the lower-case char is defined in the keymaps, because they
6650 might get translated through function-key-map. */
6651 keybuf
[t
- 1] = new_key
;
6654 fkey_map
= prev_fkey_map
;
6655 fkey_start
= prev_fkey_start
;
6656 fkey_end
= prev_fkey_end
;
6658 keytran_map
= prev_keytran_map
;
6659 keytran_start
= prev_keytran_start
;
6660 keytran_end
= prev_keytran_end
;
6662 goto replay_sequence
;
6664 /* If KEY is not defined in any of the keymaps,
6665 and cannot be part of a function key or translation,
6666 and is a shifted function key,
6667 use the corresponding unshifted function key instead. */
6668 if (first_binding
== nmaps
&& ! function_key_possible
6669 && ! key_translation_possible
6672 Lisp_Object breakdown
;
6675 breakdown
= parse_modifiers (key
);
6676 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6677 if (modifiers
& shift_modifier
)
6679 Lisp_Object new_key
;
6681 original_uppercase
= key
;
6682 original_uppercase_position
= t
- 1;
6684 modifiers
&= ~shift_modifier
;
6685 new_key
= apply_modifiers (modifiers
,
6686 XCONS (breakdown
)->car
);
6688 keybuf
[t
- 1] = new_key
;
6691 fkey_map
= prev_fkey_map
;
6692 fkey_start
= prev_fkey_start
;
6693 fkey_end
= prev_fkey_end
;
6695 keytran_map
= prev_keytran_map
;
6696 keytran_start
= prev_keytran_start
;
6697 keytran_end
= prev_keytran_end
;
6699 goto replay_sequence
;
6705 read_key_sequence_cmd
= (first_binding
< nmaps
6706 ? defs
[first_binding
]
6709 unread_switch_frame
= delayed_switch_frame
;
6710 unbind_to (count
, Qnil
);
6712 /* Don't downcase the last character if the caller says don't.
6713 Don't downcase it if the result is undefined, either. */
6714 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6715 && t
- 1 == original_uppercase_position
)
6716 keybuf
[t
- 1] = original_uppercase
;
6718 /* Occasionally we fabricate events, perhaps by expanding something
6719 according to function-key-map, or by adding a prefix symbol to a
6720 mouse click in the scroll bar or modeline. In this cases, return
6721 the entire generated key sequence, even if we hit an unbound
6722 prefix or a definition before the end. This means that you will
6723 be able to push back the event properly, and also means that
6724 read-key-sequence will always return a logical unit.
6727 for (; t
< mock_input
; t
++)
6729 if (echo_keystrokes
)
6730 echo_char (keybuf
[t
]);
6731 add_command_key (keybuf
[t
]);
6737 #if 0 /* This doc string is too long for some compilers.
6738 This commented-out definition serves for DOC. */
6739 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6740 "Read a sequence of keystrokes and return as a string or vector.\n\
6741 The sequence is sufficient to specify a non-prefix command in the\n\
6742 current local and global maps.\n\
6744 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6745 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6746 as a continuation of the previous key.\n\
6748 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6749 convert the last event to lower case. (Normally any upper case event\n\
6750 is converted to lower case if the original event is undefined and the lower\n\
6751 case equivalent is defined.) A non-nil value is appropriate for reading\n\
6752 a key sequence to be defined.\n\
6754 A C-g typed while in this function is treated like any other character,\n\
6755 and `quit-flag' is not set.\n\
6757 If the key sequence starts with a mouse click, then the sequence is read\n\
6758 using the keymaps of the buffer of the window clicked in, not the buffer\n\
6759 of the selected window as normal.\n\
6761 `read-key-sequence' drops unbound button-down events, since you normally\n\
6762 only care about the click or drag events which follow them. If a drag\n\
6763 or multi-click event is unbound, but the corresponding click event would\n\
6764 be bound, `read-key-sequence' turns the event into a click event at the\n\
6765 drag's starting position. This means that you don't have to distinguish\n\
6766 between click and drag, double, or triple events unless you want to.\n\
6768 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
6769 lines separating windows, and scroll bars with imaginary keys\n\
6770 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
6772 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
6773 function will process a switch-frame event if the user switches frames\n\
6774 before typing anything. If the user switches frames in the middle of a\n\
6775 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
6776 is nil, then the event will be put off until after the current key sequence.\n\
6778 `read-key-sequence' checks `function-key-map' for function key\n\
6779 sequences, where they wouldn't conflict with ordinary bindings. See\n\
6780 `function-key-map' for more details.")
6781 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6784 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6786 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6787 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
6788 Lisp_Object can_return_switch_frame
;
6790 Lisp_Object keybuf
[30];
6792 struct gcpro gcpro1
, gcpro2
;
6795 CHECK_STRING (prompt
, 0);
6798 bzero (keybuf
, sizeof keybuf
);
6800 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
6802 if (NILP (continue_echo
))
6804 this_command_key_count
= 0;
6805 this_single_command_key_start
= 0;
6808 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
6809 prompt
, ! NILP (dont_downcase_last
),
6810 ! NILP (can_return_switch_frame
));
6818 return make_event_array (i
, keybuf
);
6821 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
6822 "Execute CMD as an editor command.\n\
6823 CMD must be a symbol that satisfies the `commandp' predicate.\n\
6824 Optional second arg RECORD-FLAG non-nil\n\
6825 means unconditionally put this command in `command-history'.\n\
6826 Otherwise, that is done only if an arg is read using the minibuffer.\n\
6827 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
6828 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
6829 The argument SPECIAL, if non-nil, means that this command is executing\n\
6830 a special event, so ignore the prefix argument and don't clear it.")
6831 (cmd
, record_flag
, keys
, special
)
6832 Lisp_Object cmd
, record_flag
, keys
, special
;
6834 register Lisp_Object final
;
6835 register Lisp_Object tem
;
6836 Lisp_Object prefixarg
;
6837 struct backtrace backtrace
;
6838 extern int debug_on_next_call
;
6840 debug_on_next_call
= 0;
6844 prefixarg
= current_kboard
->Vprefix_arg
;
6845 Vcurrent_prefix_arg
= prefixarg
;
6846 current_kboard
->Vprefix_arg
= Qnil
;
6853 tem
= Fget (cmd
, Qdisabled
);
6854 if (!NILP (tem
) && !NILP (Vrun_hooks
))
6856 tem
= Fsymbol_value (Qdisabled_command_hook
);
6858 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
6864 final
= Findirect_function (cmd
);
6866 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
6868 struct gcpro gcpro1
, gcpro2
;
6870 GCPRO2 (cmd
, prefixarg
);
6871 do_autoload (final
, cmd
);
6878 if (STRINGP (final
) || VECTORP (final
))
6880 /* If requested, place the macro in the command history. For
6881 other sorts of commands, call-interactively takes care of
6883 if (!NILP (record_flag
))
6885 = Fcons (Fcons (Qexecute_kbd_macro
,
6886 Fcons (final
, Fcons (prefixarg
, Qnil
))),
6889 return Fexecute_kbd_macro (final
, prefixarg
);
6891 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
6893 backtrace
.next
= backtrace_list
;
6894 backtrace_list
= &backtrace
;
6895 backtrace
.function
= &Qcall_interactively
;
6896 backtrace
.args
= &cmd
;
6897 backtrace
.nargs
= 1;
6898 backtrace
.evalargs
= 0;
6900 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
6902 backtrace_list
= backtrace
.next
;
6908 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
6910 "Read function name, then read its arguments and call it.")
6912 Lisp_Object prefixarg
;
6914 Lisp_Object function
;
6916 Lisp_Object saved_keys
;
6917 Lisp_Object bindings
, value
;
6918 struct gcpro gcpro1
, gcpro2
;
6920 saved_keys
= Fvector (this_command_key_count
,
6921 XVECTOR (this_command_keys
)->contents
);
6923 GCPRO2 (saved_keys
, prefixarg
);
6925 if (EQ (prefixarg
, Qminus
))
6927 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
6928 strcpy (buf
, "C-u ");
6929 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
6931 if (sizeof (int) == sizeof (EMACS_INT
))
6932 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
6933 else if (sizeof (long) == sizeof (EMACS_INT
))
6934 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
6938 else if (INTEGERP (prefixarg
))
6940 if (sizeof (int) == sizeof (EMACS_INT
))
6941 sprintf (buf
, "%d ", XINT (prefixarg
));
6942 else if (sizeof (long) == sizeof (EMACS_INT
))
6943 sprintf (buf
, "%ld ", XINT (prefixarg
));
6948 /* This isn't strictly correct if execute-extended-command
6949 is bound to anything else. Perhaps it should use
6950 this_command_keys? */
6951 strcat (buf
, "M-x ");
6953 /* Prompt with buf, and then read a string, completing from and
6954 restricting to the set of all defined commands. Don't provide
6955 any initial input. Save the command read on the extended-command
6957 function
= Fcompleting_read (build_string (buf
),
6958 Vobarray
, Qcommandp
,
6959 Qt
, Qnil
, Qextended_command_history
);
6961 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
6962 error ("No command name given");
6964 /* Set this_command_keys to the concatenation of saved_keys and
6965 function, followed by a RET. */
6967 struct Lisp_String
*str
;
6972 this_command_key_count
= 0;
6973 this_single_command_key_start
= 0;
6975 keys
= XVECTOR (saved_keys
)->contents
;
6976 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
6977 add_command_key (keys
[i
]);
6979 str
= XSTRING (function
);
6980 for (i
= 0; i
< str
->size
; i
++)
6982 XSETFASTINT (tem
, str
->data
[i
]);
6983 add_command_key (tem
);
6986 XSETFASTINT (tem
, '\015');
6987 add_command_key (tem
);
6992 function
= Fintern (function
, Qnil
);
6993 current_kboard
->Vprefix_arg
= prefixarg
;
6994 this_command
= function
;
6996 /* If enabled, show which key runs this command. */
6997 if (!NILP (Vsuggest_key_bindings
)
6998 && NILP (Vexecuting_macro
)
6999 && SYMBOLP (function
))
7000 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7006 GCPRO2 (bindings
, value
);
7007 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7009 /* If the command has a key binding, print it now. */
7010 if (!NILP (bindings
))
7012 /* But first wait, and skip the message if there is input. */
7013 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7014 ? Vsuggest_key_bindings
: make_number (2)),
7017 Lisp_Object binding
;
7019 char *oldmessage
= echo_area_glyphs
;
7020 int oldmessage_len
= echo_area_glyphs_length
;
7022 binding
= Fkey_description (bindings
);
7025 = (char *) alloca (XSYMBOL (function
)->name
->size
7026 + XSTRING (binding
)->size
7028 sprintf (newmessage
, "You can run the command `%s' by typing %s",
7029 XSYMBOL (function
)->name
->data
,
7030 XSTRING (binding
)->data
);
7031 message1_nolog (newmessage
);
7032 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7033 ? Vsuggest_key_bindings
: make_number (2)),
7035 message2_nolog (oldmessage
, oldmessage_len
);
7039 RETURN_UNGCPRO (value
);
7042 /* Find the set of keymaps now active.
7043 Store into *MAPS_P a vector holding the various maps
7044 and return the number of them. The vector was malloc'd
7045 and the caller should free it. */
7048 current_active_maps (maps_p
)
7049 Lisp_Object
**maps_p
;
7051 Lisp_Object
*tmaps
, *maps
;
7054 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7055 if (!NILP (Voverriding_local_map_menu_flag
))
7057 /* Yes, use them (if non-nil) as well as the global map. */
7058 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7060 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7061 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7062 if (!NILP (Voverriding_local_map
))
7063 maps
[nmaps
++] = Voverriding_local_map
;
7067 /* No, so use major and minor mode keymaps. */
7068 nmaps
= current_minor_maps (NULL
, &tmaps
);
7069 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7070 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7071 #ifdef USE_TEXT_PROPERTIES
7072 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7074 maps
[nmaps
++] = current_buffer
->keymap
;
7077 maps
[nmaps
++] = current_global_map
;
7083 /* Return nonzero if input events are pending. */
7085 detect_input_pending ()
7088 get_input_pending (&input_pending
, 0);
7090 return input_pending
;
7093 /* Return nonzero if input events are pending, and run any pending timers. */
7095 detect_input_pending_run_timers (do_display
)
7098 int old_timers_run
= timers_run
;
7101 get_input_pending (&input_pending
, 1);
7103 if (old_timers_run
!= timers_run
&& do_display
)
7104 redisplay_preserve_echo_area ();
7106 return input_pending
;
7109 /* This is called in some cases before a possible quit.
7110 It cases the next call to detect_input_pending to recompute input_pending.
7111 So calling this function unnecessarily can't do any harm. */
7112 clear_input_pending ()
7117 /* Return nonzero if there are pending requeued events.
7118 This isn't used yet. The hope is to make wait_reading_process_input
7119 call it, and return return if it runs Lisp code that unreads something.
7120 The problem is, kbd_buffer_get_event needs to be fixed to know what
7121 to do in that case. It isn't trivial. */
7123 requeued_events_pending_p ()
7125 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7129 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7130 "T if command input is currently available with no waiting.\n\
7131 Actually, the value is nil only if we can be sure that no input is available.")
7134 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7137 get_input_pending (&input_pending
, 1);
7138 return input_pending
> 0 ? Qt
: Qnil
;
7141 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7142 "Return vector of last 100 events, not counting those from keyboard macros.")
7145 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7148 if (total_keys
< NUM_RECENT_KEYS
)
7149 return Fvector (total_keys
, keys
);
7152 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7153 bcopy (keys
+ recent_keys_index
,
7154 XVECTOR (val
)->contents
,
7155 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7157 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7158 recent_keys_index
* sizeof (Lisp_Object
));
7163 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7164 "Return the key sequence that invoked this command.\n\
7165 The value is a string or a vector.")
7168 return make_event_array (this_command_key_count
,
7169 XVECTOR (this_command_keys
)->contents
);
7172 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7173 Sthis_single_command_keys
, 0, 0, 0,
7174 "Return the key sequence that invoked this command.\n\
7175 Unlike `this-command-keys', this function's value\n\
7176 does not include prefix arguments.\n\
7177 The value is a string or a vector.")
7180 return make_event_array (this_command_key_count
7181 - this_single_command_key_start
,
7182 (XVECTOR (this_command_keys
)->contents
7183 + this_single_command_key_start
));
7186 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7187 Sreset_this_command_lengths
, 0, 0, 0,
7188 "Used for complicated reasons in `universal-argument-other-key'.\n\
7190 `universal-argument-other-key' rereads the event just typed.\n\
7191 It then gets translated through `function-key-map'.\n\
7192 The translated event gets included in the echo area and in\n\
7193 the value of `this-command-keys' in addition to the raw original event.\n\
7194 That is not right.\n\
7196 Calling this function directs the translated event to replace\n\
7197 the original event, so that only one version of the event actually\n\
7198 appears in the echo area and in the value of `this-command-keys.'.")
7201 before_command_restore_flag
= 1;
7202 before_command_key_count_1
= before_command_key_count
;
7203 before_command_echo_length_1
= before_command_echo_length
;
7206 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7207 "Return the current depth in recursive edits.")
7211 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
7215 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
7216 "FOpen dribble file: ",
7217 "Start writing all keyboard characters to a dribble file called FILE.\n\
7218 If FILE is nil, close any open dribble file.")
7229 file
= Fexpand_file_name (file
, Qnil
);
7230 dribble
= fopen (XSTRING (file
)->data
, "w");
7232 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
7237 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
7238 "Discard the contents of the terminal input buffer.\n\
7239 Also cancel any kbd macro being defined.")
7242 current_kboard
->defining_kbd_macro
= Qnil
;
7243 update_mode_lines
++;
7245 Vunread_command_events
= Qnil
;
7246 unread_command_char
= -1;
7248 discard_tty_input ();
7250 /* Without the cast, GCC complains that this assignment loses the
7251 volatile qualifier of kbd_store_ptr. Is there anything wrong
7253 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7254 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7260 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7261 "Stop Emacs and return to superior process. You can resume later.\n\
7262 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7263 control, run a subshell instead.\n\n\
7264 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7265 to be read as terminal input by Emacs's parent, after suspension.\n\
7267 Before suspending, run the normal hook `suspend-hook'.\n\
7268 After resumption run the normal hook `suspend-resume-hook'.\n\
7270 Some operating systems cannot stop the Emacs process and resume it later.\n\
7271 On such systems, Emacs starts a subshell instead of suspending.")
7273 Lisp_Object stuffstring
;
7276 int count
= specpdl_ptr
- specpdl
;
7277 int old_height
, old_width
;
7279 struct gcpro gcpro1
, gcpro2
;
7280 extern init_sys_modes ();
7282 if (!NILP (stuffstring
))
7283 CHECK_STRING (stuffstring
, 0);
7285 /* Run the functions in suspend-hook. */
7286 if (!NILP (Vrun_hooks
))
7287 call1 (Vrun_hooks
, intern ("suspend-hook"));
7289 GCPRO1 (stuffstring
);
7290 get_frame_size (&old_width
, &old_height
);
7292 /* sys_suspend can get an error if it tries to fork a subshell
7293 and the system resources aren't available for that. */
7294 record_unwind_protect (init_sys_modes
, 0);
7295 stuff_buffered_input (stuffstring
);
7300 unbind_to (count
, Qnil
);
7302 /* Check if terminal/window size has changed.
7303 Note that this is not useful when we are running directly
7304 with a window system; but suspend should be disabled in that case. */
7305 get_frame_size (&width
, &height
);
7306 if (width
!= old_width
|| height
!= old_height
)
7307 change_frame_size (selected_frame
, height
, width
, 0, 0);
7309 /* Run suspend-resume-hook. */
7310 if (!NILP (Vrun_hooks
))
7311 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7317 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7318 Then in any case stuff anything Emacs has read ahead and not used. */
7320 stuff_buffered_input (stuffstring
)
7321 Lisp_Object stuffstring
;
7323 /* stuff_char works only in BSD, versions 4.2 and up. */
7326 register unsigned char *p
;
7328 if (STRINGP (stuffstring
))
7332 p
= XSTRING (stuffstring
)->data
;
7333 count
= XSTRING (stuffstring
)->size
;
7338 /* Anything we have read ahead, put back for the shell to read. */
7339 /* ?? What should this do when we have multiple keyboards??
7340 Should we ignore anything that was typed in at the "wrong" kboard? */
7341 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7343 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7344 kbd_fetch_ptr
= kbd_buffer
;
7345 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7346 stuff_char (kbd_fetch_ptr
->code
);
7347 kbd_fetch_ptr
->kind
= no_event
;
7348 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7354 #endif /* BSD_SYSTEM and not BSD4_1 */
7357 set_waiting_for_input (time_to_clear
)
7358 EMACS_TIME
*time_to_clear
;
7360 input_available_clear_time
= time_to_clear
;
7362 /* Tell interrupt_signal to throw back to read_char, */
7363 waiting_for_input
= 1;
7365 /* If interrupt_signal was called before and buffered a C-g,
7366 make it run again now, to avoid timing error. */
7367 if (!NILP (Vquit_flag
))
7368 quit_throw_to_read_char ();
7371 clear_waiting_for_input ()
7373 /* Tell interrupt_signal not to throw back to read_char, */
7374 waiting_for_input
= 0;
7375 input_available_clear_time
= 0;
7378 /* This routine is called at interrupt level in response to C-G.
7379 If interrupt_input, this is the handler for SIGINT.
7380 Otherwise, it is called from kbd_buffer_store_event,
7381 in handling SIGIO or SIGTINT.
7383 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7384 immediately throw back to read_char.
7386 Otherwise it sets the Lisp variable quit-flag not-nil.
7387 This causes eval to throw, when it gets a chance.
7388 If quit-flag is already non-nil, it stops the job right away. */
7391 interrupt_signal (signalnum
) /* If we don't have an argument, */
7392 int signalnum
; /* some compilers complain in signal calls. */
7395 /* Must preserve main program's value of errno. */
7396 int old_errno
= errno
;
7398 #if defined (USG) && !defined (POSIX_SIGNALS)
7399 if (!read_socket_hook
&& NILP (Vwindow_system
))
7401 /* USG systems forget handlers when they are used;
7402 must reestablish each time */
7403 signal (SIGINT
, interrupt_signal
);
7404 signal (SIGQUIT
, interrupt_signal
);
7410 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
7415 #ifdef SIGTSTP /* Support possible in later USG versions */
7417 * On systems which can suspend the current process and return to the original
7418 * shell, this command causes the user to end up back at the shell.
7419 * The "Auto-save" and "Abort" questions are not asked until
7420 * the user elects to return to emacs, at which point he can save the current
7421 * job and either dump core or continue.
7426 if (sys_suspend () == -1)
7428 printf ("Not running as a subprocess;\n");
7429 printf ("you can continue or abort.\n");
7432 /* Perhaps should really fork an inferior shell?
7433 But that would not provide any way to get back
7434 to the original shell, ever. */
7435 printf ("No support for stopping a process on this operating system;\n");
7436 printf ("you can continue or abort.\n");
7437 #endif /* not VMS */
7438 #endif /* not SIGTSTP */
7440 /* We must remain inside the screen area when the internal terminal
7441 is used. Note that [Enter] is not echoed by dos. */
7444 /* It doesn't work to autosave while GC is in progress;
7445 the code used for auto-saving doesn't cope with the mark bit. */
7446 if (!gc_in_progress
)
7448 printf ("Auto-save? (y or n) ");
7450 if (((c
= getchar ()) & ~040) == 'Y')
7452 Fdo_auto_save (Qt
, Qnil
);
7454 printf ("\r\nAuto-save done");
7455 #else /* not MSDOS */
7456 printf ("Auto-save done\n");
7457 #endif /* not MSDOS */
7459 while (c
!= '\n') c
= getchar ();
7463 /* During GC, it must be safe to reenable quitting again. */
7464 Vinhibit_quit
= Qnil
;
7467 #endif /* not MSDOS */
7468 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7469 printf ("but will instead do a real quit after garbage collection ends\r\n");
7474 printf ("\r\nAbort? (y or n) ");
7475 #else /* not MSDOS */
7477 printf ("Abort (and enter debugger)? (y or n) ");
7479 printf ("Abort (and dump core)? (y or n) ");
7480 #endif /* not VMS */
7481 #endif /* not MSDOS */
7483 if (((c
= getchar ()) & ~040) == 'Y')
7485 while (c
!= '\n') c
= getchar ();
7487 printf ("\r\nContinuing...\r\n");
7488 #else /* not MSDOS */
7489 printf ("Continuing...\n");
7490 #endif /* not MSDOS */
7496 /* If executing a function that wants to be interrupted out of
7497 and the user has not deferred quitting by binding `inhibit-quit'
7498 then quit right away. */
7499 if (immediate_quit
&& NILP (Vinhibit_quit
))
7503 Fsignal (Qquit
, Qnil
);
7506 /* Else request quit when it's safe */
7510 if (waiting_for_input
&& !echoing
)
7511 quit_throw_to_read_char ();
7516 /* Handle a C-g by making read_char return C-g. */
7518 quit_throw_to_read_char ()
7520 quit_error_check ();
7522 /* Prevent another signal from doing this before we finish. */
7523 clear_waiting_for_input ();
7526 Vunread_command_events
= Qnil
;
7527 unread_command_char
= -1;
7529 #if 0 /* Currently, sit_for is called from read_char without turning
7530 off polling. And that can call set_waiting_for_input.
7531 It seems to be harmless. */
7532 #ifdef POLL_FOR_INPUT
7533 /* May be > 1 if in recursive minibuffer. */
7534 if (poll_suppress_count
== 0)
7538 if (FRAMEP (internal_last_event_frame
)
7539 && XFRAME (internal_last_event_frame
) != selected_frame
)
7540 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7543 _longjmp (getcjmp
, 1);
7546 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7547 "Set mode of reading keyboard input.\n\
7548 First arg INTERRUPT non-nil means use input interrupts;\n\
7549 nil means use CBREAK mode.\n\
7550 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7551 (no effect except in CBREAK mode).\n\
7552 Third arg META t means accept 8-bit input (for a Meta key).\n\
7553 META nil means ignore the top bit, on the assumption it is parity.\n\
7554 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7555 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7556 See also `current-input-mode'.")
7557 (interrupt
, flow
, meta
, quit
)
7558 Lisp_Object interrupt
, flow
, meta
, quit
;
7561 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7562 error ("set-input-mode: QUIT must be an ASCII character");
7564 #ifdef POLL_FOR_INPUT
7569 /* this causes startup screen to be restored and messes with the mouse */
7574 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7575 if (read_socket_hook
)
7577 /* When using X, don't give the user a real choice,
7578 because we haven't implemented the mechanisms to support it. */
7579 #ifdef NO_SOCK_SIGIO
7580 interrupt_input
= 0;
7581 #else /* not NO_SOCK_SIGIO */
7582 interrupt_input
= 1;
7583 #endif /* NO_SOCK_SIGIO */
7586 interrupt_input
= !NILP (interrupt
);
7587 #else /* not SIGIO */
7588 interrupt_input
= 0;
7589 #endif /* not SIGIO */
7591 /* Our VMS input only works by interrupts, as of now. */
7593 interrupt_input
= 1;
7596 flow_control
= !NILP (flow
);
7599 else if (EQ (meta
, Qt
))
7604 /* Don't let this value be out of range. */
7605 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7611 #ifdef POLL_FOR_INPUT
7612 poll_suppress_count
= 1;
7618 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7619 "Return information about the way Emacs currently reads keyboard input.\n\
7620 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7621 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7622 nil, Emacs is using CBREAK mode.\n\
7623 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7624 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7625 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7626 META nil means ignoring the top bit, on the assumption it is parity.\n\
7627 META is neither t nor nil if accepting 8-bit input and using\n\
7628 all 8 bits as the character code.\n\
7629 QUIT is the character Emacs currently uses to quit.\n\
7630 The elements of this list correspond to the arguments of\n\
7636 val
[0] = interrupt_input
? Qt
: Qnil
;
7637 val
[1] = flow_control
? Qt
: Qnil
;
7638 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7639 XSETFASTINT (val
[3], quit_char
);
7641 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7646 * Set up a new kboard object with reasonable initial values.
7652 kb
->Voverriding_terminal_local_map
= Qnil
;
7653 kb
->Vlast_command
= Qnil
;
7654 kb
->Vprefix_arg
= Qnil
;
7655 kb
->kbd_queue
= Qnil
;
7656 kb
->kbd_queue_has_data
= 0;
7657 kb
->immediate_echo
= 0;
7658 kb
->echoptr
= kb
->echobuf
;
7659 kb
->echo_after_prompt
= -1;
7660 kb
->kbd_macro_buffer
= 0;
7661 kb
->kbd_macro_bufsize
= 0;
7662 kb
->defining_kbd_macro
= Qnil
;
7663 kb
->Vlast_kbd_macro
= Qnil
;
7664 kb
->reference_count
= 0;
7665 kb
->Vsystem_key_alist
= Qnil
;
7666 kb
->system_key_syms
= Qnil
;
7667 kb
->Vdefault_minibuffer_frame
= Qnil
;
7671 * Destroy the contents of a kboard object, but not the object itself.
7672 * We use this just before deleting it, or if we're going to initialize
7679 if (kb
->kbd_macro_buffer
)
7680 xfree (kb
->kbd_macro_buffer
);
7689 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7692 *kbp
= kb
->next_kboard
;
7700 /* This is correct before outermost invocation of the editor loop */
7701 command_loop_level
= -1;
7703 quit_char
= Ctl ('g');
7704 Vunread_command_events
= Qnil
;
7705 unread_command_char
= -1;
7706 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
7708 recent_keys_index
= 0;
7709 kbd_fetch_ptr
= kbd_buffer
;
7710 kbd_store_ptr
= kbd_buffer
;
7711 kbd_buffer_frame_or_window
7712 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7714 do_mouse_tracking
= Qnil
;
7718 /* This means that command_loop_1 won't try to select anything the first
7720 internal_last_event_frame
= Qnil
;
7721 Vlast_event_frame
= internal_last_event_frame
;
7724 current_kboard
= initial_kboard
;
7726 wipe_kboard (current_kboard
);
7727 init_kboard (current_kboard
);
7730 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7732 kbd_buffer_frame_or_window
7733 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7734 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
7736 signal (SIGINT
, interrupt_signal
);
7737 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
7738 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7739 SIGQUIT and we can't tell which one it will give us. */
7740 signal (SIGQUIT
, interrupt_signal
);
7741 #endif /* HAVE_TERMIO */
7743 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7745 if (!noninteractive
)
7746 signal (SIGIO
, input_available_signal
);
7749 /* Use interrupt input by default, if it works and noninterrupt input
7750 has deficiencies. */
7752 #ifdef INTERRUPT_INPUT
7753 interrupt_input
= 1;
7755 interrupt_input
= 0;
7758 /* Our VMS input only works by interrupts, as of now. */
7760 interrupt_input
= 1;
7766 if (keyboard_init_hook
)
7767 (*keyboard_init_hook
) ();
7769 #ifdef POLL_FOR_INPUT
7770 poll_suppress_count
= 1;
7775 /* This type's only use is in syms_of_keyboard, to initialize the
7776 event header symbols and put properties on them. */
7783 struct event_head head_table
[] = {
7784 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
7785 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
7786 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
7787 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
7788 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
7789 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
7794 Qdisabled_command_hook
= intern ("disabled-command-hook");
7795 staticpro (&Qdisabled_command_hook
);
7797 Qself_insert_command
= intern ("self-insert-command");
7798 staticpro (&Qself_insert_command
);
7800 Qforward_char
= intern ("forward-char");
7801 staticpro (&Qforward_char
);
7803 Qbackward_char
= intern ("backward-char");
7804 staticpro (&Qbackward_char
);
7806 Qdisabled
= intern ("disabled");
7807 staticpro (&Qdisabled
);
7809 Qundefined
= intern ("undefined");
7810 staticpro (&Qundefined
);
7812 Qpre_command_hook
= intern ("pre-command-hook");
7813 staticpro (&Qpre_command_hook
);
7815 Qpost_command_hook
= intern ("post-command-hook");
7816 staticpro (&Qpost_command_hook
);
7818 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
7819 staticpro (&Qpost_command_idle_hook
);
7821 Qdeferred_action_function
= intern ("deferred-action-function");
7822 staticpro (&Qdeferred_action_function
);
7824 Qcommand_hook_internal
= intern ("command-hook-internal");
7825 staticpro (&Qcommand_hook_internal
);
7827 Qfunction_key
= intern ("function-key");
7828 staticpro (&Qfunction_key
);
7829 Qmouse_click
= intern ("mouse-click");
7830 staticpro (&Qmouse_click
);
7831 Qtimer_event
= intern ("timer-event");
7832 staticpro (&Qtimer_event
);
7834 Qmenu_enable
= intern ("menu-enable");
7835 staticpro (&Qmenu_enable
);
7837 Qmode_line
= intern ("mode-line");
7838 staticpro (&Qmode_line
);
7839 Qvertical_line
= intern ("vertical-line");
7840 staticpro (&Qvertical_line
);
7841 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
7842 staticpro (&Qvertical_scroll_bar
);
7843 Qmenu_bar
= intern ("menu-bar");
7844 staticpro (&Qmenu_bar
);
7846 Qabove_handle
= intern ("above-handle");
7847 staticpro (&Qabove_handle
);
7848 Qhandle
= intern ("handle");
7849 staticpro (&Qhandle
);
7850 Qbelow_handle
= intern ("below-handle");
7851 staticpro (&Qbelow_handle
);
7852 Qup
= intern ("up");
7854 Qdown
= intern ("down");
7857 Qevent_kind
= intern ("event-kind");
7858 staticpro (&Qevent_kind
);
7859 Qevent_symbol_elements
= intern ("event-symbol-elements");
7860 staticpro (&Qevent_symbol_elements
);
7861 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
7862 staticpro (&Qevent_symbol_element_mask
);
7863 Qmodifier_cache
= intern ("modifier-cache");
7864 staticpro (&Qmodifier_cache
);
7866 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
7867 staticpro (&Qrecompute_lucid_menubar
);
7868 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
7869 staticpro (&Qactivate_menubar_hook
);
7871 Qpolling_period
= intern ("polling-period");
7872 staticpro (&Qpolling_period
);
7875 struct event_head
*p
;
7877 for (p
= head_table
;
7878 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
7881 *p
->var
= intern (p
->name
);
7883 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
7884 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
7888 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
7889 staticpro (&button_down_location
);
7893 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
7895 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
7896 for (i
= 0; i
< len
; i
++)
7897 if (modifier_names
[i
])
7898 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
7899 staticpro (&modifier_symbols
);
7902 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
7903 staticpro (&recent_keys
);
7905 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
7906 staticpro (&this_command_keys
);
7908 Qextended_command_history
= intern ("extended-command-history");
7909 Fset (Qextended_command_history
, Qnil
);
7910 staticpro (&Qextended_command_history
);
7912 kbd_buffer_frame_or_window
7913 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7914 staticpro (&kbd_buffer_frame_or_window
);
7916 accent_key_syms
= Qnil
;
7917 staticpro (&accent_key_syms
);
7919 func_key_syms
= Qnil
;
7920 staticpro (&func_key_syms
);
7923 staticpro (&mouse_syms
);
7925 unread_switch_frame
= Qnil
;
7926 staticpro (&unread_switch_frame
);
7928 internal_last_event_frame
= Qnil
;
7929 staticpro (&internal_last_event_frame
);
7931 read_key_sequence_cmd
= Qnil
;
7932 staticpro (&read_key_sequence_cmd
);
7934 defsubr (&Sevent_convert_list
);
7935 defsubr (&Sread_key_sequence
);
7936 defsubr (&Srecursive_edit
);
7938 defsubr (&Strack_mouse
);
7940 defsubr (&Sinput_pending_p
);
7941 defsubr (&Scommand_execute
);
7942 defsubr (&Srecent_keys
);
7943 defsubr (&Sthis_command_keys
);
7944 defsubr (&Sthis_single_command_keys
);
7945 defsubr (&Sreset_this_command_lengths
);
7946 defsubr (&Ssuspend_emacs
);
7947 defsubr (&Sabort_recursive_edit
);
7948 defsubr (&Sexit_recursive_edit
);
7949 defsubr (&Srecursion_depth
);
7950 defsubr (&Stop_level
);
7951 defsubr (&Sdiscard_input
);
7952 defsubr (&Sopen_dribble_file
);
7953 defsubr (&Sset_input_mode
);
7954 defsubr (&Scurrent_input_mode
);
7955 defsubr (&Sexecute_extended_command
);
7957 DEFVAR_LISP ("last-command-char", &last_command_char
,
7958 "Last input event that was part of a command.");
7960 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
7961 "Last input event that was part of a command.");
7963 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
7964 "Last input event in a command, except for mouse menu events.\n\
7965 Mouse menus give back keys that don't look like mouse events;\n\
7966 this variable holds the actual mouse event that led to the menu,\n\
7967 so that you can determine whether the command was run by mouse or not.");
7969 DEFVAR_LISP ("last-input-char", &last_input_char
,
7970 "Last input event.");
7972 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
7973 "Last input event.");
7975 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
7976 "List of objects to be read as next command input events.");
7978 DEFVAR_INT ("unread-command-char", &unread_command_char
,
7979 "If not -1, an object to be read as next command input event.");
7981 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
7982 "Meta-prefix character code. Meta-foo as command input\n\
7983 turns into this character followed by foo.");
7984 XSETINT (meta_prefix_char
, 033);
7986 DEFVAR_KBOARD ("last-command", Vlast_command
,
7987 "The last command executed. Normally a symbol with a function definition,\n\
7988 but can be whatever was found in the keymap, or whatever the variable\n\
7989 `this-command' was set to by that command.\n\
7991 The value `mode-exit' is special; it means that the previous command\n\
7992 read an event that told it to exit, and it did so and unread that event.\n\
7993 In other words, the present command is the event that made the previous\n\
7996 The value `kill-region' is special; it means that the previous command\n\
7997 was a kill command.");
7999 DEFVAR_LISP ("this-command", &this_command
,
8000 "The command now being executed.\n\
8001 The command can set this variable; whatever is put here\n\
8002 will be in `last-command' during the following command.");
8003 this_command
= Qnil
;
8005 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8006 "*Number of keyboard input characters between auto-saves.\n\
8007 Zero means disable autosaving due to number of characters typed.");
8008 auto_save_interval
= 300;
8010 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8011 "*Number of seconds idle time before auto-save.\n\
8012 Zero or nil means disable auto-saving due to idleness.\n\
8013 After auto-saving due to this many seconds of idle time,\n\
8014 Emacs also does a garbage collection if that seems to be warranted.");
8015 XSETFASTINT (Vauto_save_timeout
, 30);
8017 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8018 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8019 echo_keystrokes
= 1;
8021 DEFVAR_INT ("polling-period", &polling_period
,
8022 "*Interval between polling for input during Lisp execution.\n\
8023 The reason for polling is to make C-g work to stop a running program.\n\
8024 Polling is needed only when using X windows and SIGIO does not work.\n\
8025 Polling is automatically disabled in all other cases.");
8028 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8029 "*Maximum time between mouse clicks to make a double-click.\n\
8030 Measured in milliseconds. nil means disable double-click recognition;\n\
8031 t means double-clicks have no time limit and are detected\n\
8032 by position only.");
8033 Vdouble_click_time
= make_number (500);
8035 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8036 "*Non-nil means inhibit local map menu bar menus.");
8037 inhibit_local_menu_bar_menus
= 0;
8039 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8040 "Number of complete keys read from the keyboard so far.");
8043 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8044 "The frame in which the most recently read event occurred.\n\
8045 If the last event came from a keyboard macro, this is set to `macro'.");
8046 Vlast_event_frame
= Qnil
;
8048 DEFVAR_LISP ("help-char", &Vhelp_char
,
8049 "Character to recognize as meaning Help.\n\
8050 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8051 If the value of `help-form' is nil, this char can be read normally.");
8052 XSETINT (Vhelp_char
, Ctl ('H'));
8054 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8055 "List of input events to recognize as meaning Help.\n\
8056 These work just like the value of `help-char' (see that).");
8057 Vhelp_event_list
= Qnil
;
8059 DEFVAR_LISP ("help-form", &Vhelp_form
,
8060 "Form to execute when character `help-char' is read.\n\
8061 If the form returns a string, that string is displayed.\n\
8062 If `help-form' is nil, the help char is not recognized.");
8065 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8066 "Command to run when `help-char' character follows a prefix key.\n\
8067 This command is used only when there is no actual binding\n\
8068 for that character after that prefix key.");
8069 Vprefix_help_command
= Qnil
;
8071 DEFVAR_LISP ("top-level", &Vtop_level
,
8072 "Form to evaluate when Emacs starts up.\n\
8073 Useful to set before you dump a modified Emacs.");
8076 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8077 "Translate table for keyboard input, or nil.\n\
8078 Each character is looked up in this string and the contents used instead.\n\
8079 The value may be a string, a vector, or a char-table.\n\
8080 If it is a string or vector of length N,\n\
8081 character codes N and up are untranslated.\n\
8082 In a vector or a char-table, an element which is nil means \"no translation\".");
8083 Vkeyboard_translate_table
= Qnil
;
8085 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8086 "Non-nil means to always spawn a subshell instead of suspending,\n\
8087 even if the operating system has support for stopping a process.");
8090 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8091 "Non-nil means prompt with menus when appropriate.\n\
8092 This is done when reading from a keymap that has a prompt string,\n\
8093 for elements that have prompt strings.\n\
8094 The menu is displayed on the screen\n\
8095 if X menus were enabled at configuration\n\
8096 time and the previous event was a mouse click prefix key.\n\
8097 Otherwise, menu prompting uses the echo area.");
8100 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8101 "Character to see next line of menu prompt.\n\
8102 Type this character while in a menu prompt to rotate around the lines of it.");
8103 XSETINT (menu_prompt_more_char
, ' ');
8105 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8106 "A mask of additional modifier keys to use with every keyboard character.\n\
8107 Emacs applies the modifiers of the character stored here to each keyboard\n\
8108 character it reads. For example, after evaluating the expression\n\
8109 (setq extra-keyboard-modifiers ?\\C-x)\n\
8110 all input characters will have the control modifier applied to them.\n\
8112 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8113 not count as a control character; rather, it counts as a character\n\
8114 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8115 cancels any modification.");
8116 extra_keyboard_modifiers
= 0;
8118 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8119 "If an editing command sets this to t, deactivate the mark afterward.\n\
8120 The command loop sets this to nil before each command,\n\
8121 and tests the value when the command returns.\n\
8122 Buffer modification stores t in this variable.");
8123 Vdeactivate_mark
= Qnil
;
8125 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8126 "Temporary storage of pre-command-hook or post-command-hook.");
8127 Vcommand_hook_internal
= Qnil
;
8129 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8130 "Normal hook run before each command is executed.\n\
8131 Errors running the hook are caught and ignored.");
8132 Vpre_command_hook
= Qnil
;
8134 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8135 "Normal hook run after each command is executed.\n\
8136 Errors running the hook are caught and ignored.");
8137 Vpost_command_hook
= Qnil
;
8139 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8140 "Normal hook run after each command is executed, if idle.\n\
8141 Errors running the hook are caught and ignored.\n\
8142 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
8143 Vpost_command_idle_hook
= Qnil
;
8145 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
8146 "Delay time before running `post-command-idle-hook'.\n\
8147 This is measured in microseconds.");
8148 post_command_idle_delay
= 100000;
8150 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
8151 "t means menu bar, specified Lucid style, needs to be recomputed.");
8152 Vlucid_menu_bar_dirty_flag
= Qnil
;
8154 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
8155 "List of menu bar items to move to the end of the menu bar.\n\
8156 The elements of the list are event types that may have menu bar bindings.");
8157 Vmenu_bar_final_items
= Qnil
;
8159 DEFVAR_KBOARD ("overriding-terminal-local-map",
8160 Voverriding_terminal_local_map
,
8161 "Keymap that overrides all other local keymaps.\n\
8162 If this variable is non-nil, it is used as a keymap instead of the\n\
8163 buffer's local map, and the minor mode keymaps and text property keymaps.");
8165 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
8166 "Keymap that overrides all other local keymaps.\n\
8167 If this variable is non-nil, it is used as a keymap instead of the\n\
8168 buffer's local map, and the minor mode keymaps and text property keymaps.");
8169 Voverriding_local_map
= Qnil
;
8171 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
8172 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8173 Otherwise, the menu bar continues to reflect the buffer's local map\n\
8174 and the minor mode maps regardless of `overriding-local-map'.");
8175 Voverriding_local_map_menu_flag
= Qnil
;
8177 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
8178 "Keymap defining bindings for special events to execute at low level.");
8179 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
8181 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
8182 "*Non-nil means generate motion events for mouse motion.");
8184 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
8185 "Alist of system-specific X windows key symbols.\n\
8186 Each element should have the form (N . SYMBOL) where N is the\n\
8187 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
8188 and SYMBOL is its name.");
8190 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
8191 "List of deferred actions to be performed at a later time.\n\
8192 The precise format isn't relevant here; we just check whether it is nil.");
8193 Vdeferred_action_list
= Qnil
;
8195 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
8196 "Function to call to handle deferred actions, after each command.\n\
8197 This function is called with no arguments after each command\n\
8198 whenever `deferred-action-list' is non-nil.");
8199 Vdeferred_action_function
= Qnil
;
8201 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
8202 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8203 The value can be a length of time to show the message for.\n\
8204 If the value is non-nil and not a number, we wait 2 seconds.");
8205 Vsuggest_key_bindings
= Qt
;
8207 DEFVAR_LISP ("timer-list", &Vtimer_list
,
8208 "List of active absolute time timers in order of increasing time");
8211 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
8212 "List of active idle-time timers in order of increasing time");
8213 Vtimer_idle_list
= Qnil
;
8218 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
8219 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
8220 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
8221 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
8222 initial_define_key (meta_map
, 'x', "execute-extended-command");
8224 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
8225 "handle-delete-frame");
8226 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
8228 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",