1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97 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"
37 #include "dispextern.h"
39 #include "intervals.h"
40 #include "blockinput.h"
49 #include <sys/ioctl.h>
51 #endif /* not MSDOS */
53 #include "syssignal.h"
56 /* This is to get the definitions of the XK_ symbols. */
63 #endif /* HAVE_NTGUI */
65 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
70 /* Variables for blockinput.h: */
72 /* Non-zero if interrupt input is blocked right now. */
73 int interrupt_input_blocked
;
75 /* Nonzero means an input interrupt has arrived
76 during the current critical section. */
77 int interrupt_input_pending
;
80 /* File descriptor to use for input. */
83 #ifdef HAVE_WINDOW_SYSTEM
84 /* Make all keyboard buffers much bigger when using X windows. */
85 #define KBD_BUFFER_SIZE 4096
86 #else /* No X-windows, character input */
87 #define KBD_BUFFER_SIZE 256
88 #endif /* No X-windows */
90 /* Following definition copied from eval.c */
94 struct backtrace
*next
;
95 Lisp_Object
*function
;
96 Lisp_Object
*args
; /* Points to vector of args. */
97 int nargs
; /* length of vector. If nargs is UNEVALLED,
98 args points to slot holding list of
104 KBOARD
*initial_kboard
;
105 KBOARD
*current_kboard
;
109 KBOARD the_only_kboard
;
112 /* Non-nil disable property on a command means
113 do not execute it; call disabled-command-hook's value instead. */
114 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
116 #define NUM_RECENT_KEYS (100)
117 int recent_keys_index
; /* Index for storing next element into recent_keys */
118 int total_keys
; /* Total number of elements stored into recent_keys */
119 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
121 /* Vector holding the key sequence that invoked the current command.
122 It is reused for each command, and it may be longer than the current
123 sequence; this_command_key_count indicates how many elements
124 actually mean something.
125 It's easier to staticpro a single Lisp_Object than an array. */
126 Lisp_Object this_command_keys
;
127 int this_command_key_count
;
129 /* Number of elements of this_command_keys
130 that precede this key sequence. */
131 int this_single_command_key_start
;
133 /* Record values of this_command_key_count and echo_length ()
134 before this command was read. */
135 static int before_command_key_count
;
136 static int before_command_echo_length
;
137 /* Values of before_command_key_count and before_command_echo_length
138 saved by reset-this-command-lengths. */
139 static int before_command_key_count_1
;
140 static int before_command_echo_length_1
;
141 /* Flag set by reset-this-command-lengths,
142 saying to reset the lengths when add_command_key is called. */
143 static int before_command_restore_flag
;
145 extern int minbuf_level
;
147 extern struct backtrace
*backtrace_list
;
149 /* Nonzero means do menu prompting. */
150 static int menu_prompting
;
152 /* Character to see next line of menu prompt. */
153 static Lisp_Object menu_prompt_more_char
;
155 /* For longjmp to where kbd input is being done. */
156 static jmp_buf getcjmp
;
158 /* True while doing kbd input. */
159 int waiting_for_input
;
161 /* True while displaying for echoing. Delays C-g throwing. */
164 /* True means we can start echoing at the next input pause
165 even though there is something in the echo area. */
166 static char *ok_to_echo_at_next_pause
;
168 /* Nonzero means disregard local maps for the menu bar. */
169 static int inhibit_local_menu_bar_menus
;
171 /* Nonzero means C-g should cause immediate error-signal. */
174 /* The user's ERASE setting. */
175 Lisp_Object Vtty_erase_char
;
177 /* Character to recognize as the help char. */
178 Lisp_Object Vhelp_char
;
180 /* List of other event types to recognize as meaning "help". */
181 Lisp_Object Vhelp_event_list
;
183 /* Form to execute when help char is typed. */
184 Lisp_Object Vhelp_form
;
186 /* Command to run when the help character follows a prefix key. */
187 Lisp_Object Vprefix_help_command
;
189 /* List of items that should move to the end of the menu bar. */
190 Lisp_Object Vmenu_bar_final_items
;
192 /* Non-nil means show the equivalent key-binding for
193 any M-x command that has one.
194 The value can be a length of time to show the message for.
195 If the value is non-nil and not a number, we wait 2 seconds. */
196 Lisp_Object Vsuggest_key_bindings
;
198 /* Character that causes a quit. Normally C-g.
200 If we are running on an ordinary terminal, this must be an ordinary
201 ASCII char, since we want to make it our interrupt character.
203 If we are not running on an ordinary terminal, it still needs to be
204 an ordinary ASCII char. This character needs to be recognized in
205 the input interrupt handler. At this point, the keystroke is
206 represented as a struct input_event, while the desired quit
207 character is specified as a lispy event. The mapping from struct
208 input_events to lispy events cannot run in an interrupt handler,
209 and the reverse mapping is difficult for anything but ASCII
212 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
216 extern Lisp_Object current_global_map
;
217 extern int minibuf_level
;
219 /* If non-nil, this is a map that overrides all other local maps. */
220 Lisp_Object Voverriding_local_map
;
222 /* If non-nil, Voverriding_local_map applies to the menu bar. */
223 Lisp_Object Voverriding_local_map_menu_flag
;
225 /* Keymap that defines special misc events that should
226 be processed immediately at a low level. */
227 Lisp_Object Vspecial_event_map
;
229 /* Current depth in recursive edits. */
230 int command_loop_level
;
232 /* Total number of times command_loop has read a key sequence. */
235 /* Last input character read as a command. */
236 Lisp_Object last_command_char
;
238 /* Last input character read as a command, not counting menus
239 reached by the mouse. */
240 Lisp_Object last_nonmenu_event
;
242 /* Last input character read for any purpose. */
243 Lisp_Object last_input_char
;
245 /* If not Qnil, a list of objects to be read as subsequent command input. */
246 Lisp_Object Vunread_command_events
;
248 /* If not -1, an event to be read as subsequent command input. */
249 int unread_command_char
;
251 /* If not Qnil, this is a switch-frame event which we decided to put
252 off until the end of a key sequence. This should be read as the
253 next command input, after any unread_command_events.
255 read_key_sequence uses this to delay switch-frame events until the
256 end of the key sequence; Fread_char uses it to put off switch-frame
257 events until a non-ASCII event is acceptable as input. */
258 Lisp_Object unread_switch_frame
;
260 /* A mask of extra modifier bits to put into every keyboard char. */
261 int extra_keyboard_modifiers
;
263 /* Char to use as prefix when a meta character is typed in.
264 This is bound on entry to minibuffer in case ESC is changed there. */
266 Lisp_Object meta_prefix_char
;
268 /* Last size recorded for a current buffer which is not a minibuffer. */
269 static int last_non_minibuf_size
;
271 /* Number of idle seconds before an auto-save and garbage collection. */
272 static Lisp_Object Vauto_save_timeout
;
274 /* Total number of times read_char has returned. */
277 /* Total number of times read_char has returned, outside of macros. */
278 int num_nonmacro_input_chars
;
280 /* Auto-save automatically when this many characters have been typed
281 since the last time. */
283 static int auto_save_interval
;
285 /* Value of num_nonmacro_input_chars as of last auto save. */
289 /* The command being executed by the command loop.
290 Commands may set this, and the value set will be copied into
291 current_kboard->Vlast_command instead of the actual command. */
292 Lisp_Object this_command
;
294 /* The value of point when the last command was executed. */
295 int last_point_position
;
297 /* The buffer that was current when the last command was started. */
298 Lisp_Object last_point_position_buffer
;
300 /* The frame in which the last input event occurred, or Qmacro if the
301 last event came from a macro. We use this to determine when to
302 generate switch-frame events. This may be cleared by functions
303 like Fselect_frame, to make sure that a switch-frame event is
304 generated by the next character. */
305 Lisp_Object internal_last_event_frame
;
307 /* A user-visible version of the above, intended to allow users to
308 figure out where the last event came from, if the event doesn't
309 carry that information itself (i.e. if it was a character). */
310 Lisp_Object Vlast_event_frame
;
312 /* The timestamp of the last input event we received from the X server.
313 X Windows wants this for selection ownership. */
314 unsigned long last_event_timestamp
;
316 Lisp_Object Qself_insert_command
;
317 Lisp_Object Qforward_char
;
318 Lisp_Object Qbackward_char
;
319 Lisp_Object Qundefined
;
320 Lisp_Object Qtimer_event_handler
;
322 /* read_key_sequence stores here the command definition of the
323 key sequence that it reads. */
324 Lisp_Object read_key_sequence_cmd
;
326 /* Form to evaluate (if non-nil) when Emacs is started. */
327 Lisp_Object Vtop_level
;
329 /* User-supplied string to translate input characters through. */
330 Lisp_Object Vkeyboard_translate_table
;
332 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
333 extern Lisp_Object Vfunction_key_map
;
335 /* Another keymap that maps key sequences into key sequences.
336 This one takes precedence over ordinary definitions. */
337 extern Lisp_Object Vkey_translation_map
;
339 /* Non-nil means deactivate the mark at end of this command. */
340 Lisp_Object Vdeactivate_mark
;
342 /* Menu bar specified in Lucid Emacs fashion. */
344 Lisp_Object Vlucid_menu_bar_dirty_flag
;
345 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
347 Lisp_Object Qecho_area_clear_hook
;
349 /* Hooks to run before and after each command. */
350 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
351 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
352 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
353 /* Hook run after a command if there's no more input soon. */
354 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
356 /* Delay time in microseconds before running post-command-idle-hook. */
357 int post_command_idle_delay
;
359 /* List of deferred actions to be performed at a later time.
360 The precise format isn't relevant here; we just check whether it is nil. */
361 Lisp_Object Vdeferred_action_list
;
363 /* Function to call to handle deferred actions, when there are any. */
364 Lisp_Object Vdeferred_action_function
;
365 Lisp_Object Qdeferred_action_function
;
367 /* File in which we write all commands we read. */
370 /* Nonzero if input is available. */
373 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
374 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
378 extern char *pending_malloc_warning
;
380 /* Circular buffer for pre-read keyboard input. */
381 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
383 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
385 The interrupt-level event handlers will never enqueue an event on a
386 frame which is not in Vframe_list, and once an event is dequeued,
387 internal_last_event_frame or the event itself points to the frame.
390 But while the event is sitting in the queue, it's completely
391 unprotected. Suppose the user types one command which will run for
392 a while and then delete a frame, and then types another event at
393 the frame that will be deleted, before the command gets around to
394 it. Suppose there are no references to this frame elsewhere in
395 Emacs, and a GC occurs before the second event is dequeued. Now we
396 have an event referring to a freed frame, which will crash Emacs
399 Similar things happen when an event on a scroll bar is enqueued; the
400 window may be deleted while the event is in the queue.
402 So, we use this vector to protect the frame_or_window field in the
403 event queue. That way, they'll be dequeued as dead frames or
404 windows, but still valid lisp objects.
406 If kbd_buffer[i].kind != no_event, then
407 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
408 == kbd_buffer[i].frame_or_window. */
409 static Lisp_Object kbd_buffer_frame_or_window
;
411 /* Pointer to next available character in kbd_buffer.
412 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
413 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
414 next available char is in kbd_buffer[0]. */
415 static struct input_event
*kbd_fetch_ptr
;
417 /* Pointer to next place to store character in kbd_buffer. This
418 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
419 character should go in kbd_buffer[0]. */
420 static volatile struct input_event
*kbd_store_ptr
;
422 /* The above pair of variables forms a "queue empty" flag. When we
423 enqueue a non-hook event, we increment kbd_store_ptr. When we
424 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
425 there is input available iff the two pointers are not equal.
427 Why not just have a flag set and cleared by the enqueuing and
428 dequeuing functions? Such a flag could be screwed up by interrupts
429 at inopportune times. */
431 /* If this flag is non-nil, we check mouse_moved to see when the
432 mouse moves, and motion events will appear in the input stream.
433 Otherwise, mouse motion is ignored. */
434 static Lisp_Object do_mouse_tracking
;
436 /* Symbols to head events. */
437 Lisp_Object Qmouse_movement
;
438 Lisp_Object Qscroll_bar_movement
;
439 Lisp_Object Qswitch_frame
;
440 Lisp_Object Qdelete_frame
;
441 Lisp_Object Qiconify_frame
;
442 Lisp_Object Qmake_frame_visible
;
444 /* Symbols to denote kinds of events. */
445 Lisp_Object Qfunction_key
;
446 Lisp_Object Qmouse_click
;
447 /* Lisp_Object Qmouse_movement; - also an event header */
449 /* Properties of event headers. */
450 Lisp_Object Qevent_kind
;
451 Lisp_Object Qevent_symbol_elements
;
453 Lisp_Object Qmenu_enable
;
455 /* An event header symbol HEAD may have a property named
456 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
457 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
458 mask of modifiers applied to it. If present, this is used to help
459 speed up parse_modifiers. */
460 Lisp_Object Qevent_symbol_element_mask
;
462 /* An unmodified event header BASE may have a property named
463 Qmodifier_cache, which is an alist mapping modifier masks onto
464 modified versions of BASE. If present, this helps speed up
466 Lisp_Object Qmodifier_cache
;
468 /* Symbols to use for parts of windows. */
469 Lisp_Object Qmode_line
;
470 Lisp_Object Qvertical_line
;
471 Lisp_Object Qvertical_scroll_bar
;
472 Lisp_Object Qmenu_bar
;
474 extern Lisp_Object Qmenu_enable
;
476 Lisp_Object
recursive_edit_unwind (), command_loop ();
477 Lisp_Object
Fthis_command_keys ();
478 Lisp_Object Qextended_command_history
;
479 EMACS_TIME
timer_check ();
481 extern char *x_get_keysym_name ();
483 static void record_menu_key ();
485 Lisp_Object Qpolling_period
;
487 /* List of absolute timers. Appears in order of next scheduled event. */
488 Lisp_Object Vtimer_list
;
490 /* List of idle time timers. Appears in order of next scheduled event. */
491 Lisp_Object Vtimer_idle_list
;
493 /* Incremented whenever a timer is run. */
496 extern Lisp_Object Vprint_level
, Vprint_length
;
498 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
500 EMACS_TIME
*input_available_clear_time
;
502 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
503 Default is 1 if INTERRUPT_INPUT is defined. */
506 /* Nonzero while interrupts are temporarily deferred during redisplay. */
507 int interrupts_deferred
;
509 /* Nonzero means use ^S/^Q for flow control. */
512 /* Allow m- file to inhibit use of FIONREAD. */
513 #ifdef BROKEN_FIONREAD
517 /* We are unable to use interrupts if FIONREAD is not available,
518 so flush SIGIO so we won't try. */
525 /* If we support a window system, turn on the code to poll periodically
526 to detect C-g. It isn't actually used when doing interrupt input. */
527 #ifdef HAVE_WINDOW_SYSTEM
528 #define POLL_FOR_INPUT
531 /* Global variable declarations. */
533 /* Function for init_keyboard to call with no args (if nonzero). */
534 void (*keyboard_init_hook
) ();
536 static int read_avail_input ();
537 static void get_input_pending ();
538 static int readable_events ();
539 static Lisp_Object
read_char_x_menu_prompt ();
540 static Lisp_Object
read_char_minibuf_menu_prompt ();
541 static Lisp_Object
make_lispy_event ();
543 static Lisp_Object
make_lispy_movement ();
545 static Lisp_Object
modify_event_symbol ();
546 static Lisp_Object
make_lispy_switch_frame ();
547 static int parse_solitary_modifier ();
549 /* > 0 if we are to echo keystrokes. */
550 static int echo_keystrokes
;
552 /* Nonzero means don't try to suspend even if the operating system seems
554 static int cannot_suspend
;
556 #define min(a,b) ((a)<(b)?(a):(b))
557 #define max(a,b) ((a)>(b)?(a):(b))
559 /* Install the string STR as the beginning of the string of echoing,
560 so that it serves as a prompt for the next character.
561 Also start echoing. */
566 int len
= strlen (str
);
568 if (len
> ECHOBUFSIZE
- 4)
569 len
= ECHOBUFSIZE
- 4;
570 bcopy (str
, current_kboard
->echobuf
, len
);
571 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
572 *current_kboard
->echoptr
= '\0';
574 current_kboard
->echo_after_prompt
= len
;
579 /* Add C to the echo string, if echoing is going on.
580 C can be a character, which is printed prettily ("M-C-x" and all that
581 jazz), or a symbol, whose name is printed. */
586 extern char *push_key_description ();
588 if (current_kboard
->immediate_echo
)
590 char *ptr
= current_kboard
->echoptr
;
592 if (ptr
!= current_kboard
->echobuf
)
595 /* If someone has passed us a composite event, use its head symbol. */
600 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
603 ptr
= push_key_description (XINT (c
), ptr
);
605 else if (SYMBOLP (c
))
607 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
608 if ((ptr
- current_kboard
->echobuf
) + name
->size
+ 4 > ECHOBUFSIZE
)
610 bcopy (name
->data
, ptr
, name
->size
);
614 if (current_kboard
->echoptr
== current_kboard
->echobuf
617 strcpy (ptr
, " (Type ? for further options)");
622 current_kboard
->echoptr
= ptr
;
628 /* Temporarily add a dash to the end of the echo string if it's not
629 empty, so that it serves as a mini-prompt for the very next character. */
633 if (!current_kboard
->immediate_echo
634 && current_kboard
->echoptr
== current_kboard
->echobuf
)
636 /* Do nothing if we just printed a prompt. */
637 if (current_kboard
->echo_after_prompt
638 == current_kboard
->echoptr
- current_kboard
->echobuf
)
640 /* Do nothing if not echoing at all. */
641 if (current_kboard
->echoptr
== 0)
644 /* Put a dash at the end of the buffer temporarily,
645 but make it go away when the next character is added. */
646 current_kboard
->echoptr
[0] = '-';
647 current_kboard
->echoptr
[1] = 0;
652 /* Display the current echo string, and begin echoing if not already
657 if (!current_kboard
->immediate_echo
)
660 current_kboard
->immediate_echo
= 1;
662 for (i
= 0; i
< this_command_key_count
; i
++)
665 c
= XVECTOR (this_command_keys
)->contents
[i
];
666 if (! (EVENT_HAS_PARAMETERS (c
)
667 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
674 message1_nolog (current_kboard
->echobuf
);
677 if (waiting_for_input
&& !NILP (Vquit_flag
))
678 quit_throw_to_read_char ();
681 /* Turn off echoing, for the start of a new command. */
685 current_kboard
->immediate_echo
= 0;
686 current_kboard
->echoptr
= current_kboard
->echobuf
;
687 current_kboard
->echo_after_prompt
= -1;
688 ok_to_echo_at_next_pause
= 0;
691 /* Return the length of the current echo string. */
696 return current_kboard
->echoptr
- current_kboard
->echobuf
;
699 /* Truncate the current echo message to its first LEN chars.
700 This and echo_char get used by read_key_sequence when the user
701 switches frames while entering a key sequence. */
707 current_kboard
->echobuf
[len
] = '\0';
708 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
709 truncate_echo_area (len
);
713 /* Functions for manipulating this_command_keys. */
715 add_command_key (key
)
718 int size
= XVECTOR (this_command_keys
)->size
;
720 /* If reset-this-command-length was called recently, obey it now.
721 See the doc string of that function for an explanation of why. */
722 if (before_command_restore_flag
)
724 this_command_key_count
= before_command_key_count_1
;
725 if (this_command_key_count
< this_single_command_key_start
)
726 this_single_command_key_start
= this_command_key_count
;
727 echo_truncate (before_command_echo_length_1
);
728 before_command_restore_flag
= 0;
731 if (this_command_key_count
>= size
)
733 Lisp_Object new_keys
;
735 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
736 bcopy (XVECTOR (this_command_keys
)->contents
,
737 XVECTOR (new_keys
)->contents
,
738 size
* sizeof (Lisp_Object
));
740 this_command_keys
= new_keys
;
743 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
749 int count
= specpdl_ptr
- specpdl
;
752 if (command_loop_level
> 0)
754 specbind (Qstandard_output
, Qt
);
755 specbind (Qstandard_input
, Qt
);
758 val
= command_loop ();
760 Fsignal (Qquit
, Qnil
);
761 /* Handle throw from read_minibuf when using minibuffer
762 while it's active but we're in another window. */
764 Fsignal (Qerror
, Fcons (val
, Qnil
));
766 return unbind_to (count
, Qnil
);
769 /* When an auto-save happens, record the "time", and don't do again soon. */
773 last_auto_save
= num_nonmacro_input_chars
;
776 /* Make an auto save happen as soon as possible at command level. */
778 force_auto_save_soon ()
780 last_auto_save
= - auto_save_interval
- 1;
782 record_asynch_buffer_change ();
785 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
786 "Invoke the editor command loop recursively.\n\
787 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
788 that tells this function to return.\n\
789 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
790 This function is called by the editor initialization to begin editing.")
793 int count
= specpdl_ptr
- specpdl
;
796 command_loop_level
++;
797 update_mode_lines
= 1;
799 record_unwind_protect (recursive_edit_unwind
,
801 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
805 return unbind_to (count
, Qnil
);
809 recursive_edit_unwind (buffer
)
813 Fset_buffer (buffer
);
815 command_loop_level
--;
816 update_mode_lines
= 1;
824 #if 0 /* Theory: if there's anything in Vunread_command_events,
825 it will right away be read by read_key_sequence,
826 and then if we do switch KBOARDS, it will go into the side
827 queue then. So we don't need to do anything special here -- rms. */
828 if (CONSP (Vunread_command_events
))
830 current_kboard
->kbd_queue
831 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
832 current_kboard
->kbd_queue_has_data
= 1;
834 Vunread_command_events
= Qnil
;
840 /* Switch to the single-kboard state, making current_kboard
841 the only KBOARD from which further input is accepted. */
844 single_kboard_state ()
851 /* Maintain a stack of kboards, so other parts of Emacs
852 can switch temporarily to the kboard of a given frame
853 and then revert to the previous status. */
858 struct kboard_stack
*next
;
861 static struct kboard_stack
*kboard_stack
;
864 push_frame_kboard (f
)
868 struct kboard_stack
*p
869 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
871 p
->next
= kboard_stack
;
872 p
->kboard
= current_kboard
;
875 current_kboard
= FRAME_KBOARD (f
);
883 struct kboard_stack
*p
= kboard_stack
;
884 current_kboard
= p
->kboard
;
885 kboard_stack
= p
->next
;
890 /* Handle errors that are not handled at inner levels
891 by printing an error message and returning to the editor command loop. */
897 Lisp_Object old_level
, old_length
;
900 if (!NILP (executing_macro
))
902 if (executing_macro_iterations
== 1)
903 sprintf (macroerror
, "After 1 kbd macro iteration: ");
905 sprintf (macroerror
, "After %d kbd macro iterations: ",
906 executing_macro_iterations
);
911 Vstandard_output
= Qt
;
912 Vstandard_input
= Qt
;
913 Vexecuting_macro
= Qnil
;
914 executing_macro
= Qnil
;
915 current_kboard
->Vprefix_arg
= Qnil
;
918 /* Avoid unquittable loop if data contains a circular list. */
919 old_level
= Vprint_level
;
920 old_length
= Vprint_length
;
921 XSETFASTINT (Vprint_level
, 10);
922 XSETFASTINT (Vprint_length
, 10);
923 cmd_error_internal (data
, macroerror
);
924 Vprint_level
= old_level
;
925 Vprint_length
= old_length
;
929 Vinhibit_quit
= Qnil
;
934 return make_number (0);
937 cmd_error_internal (data
, context
)
945 echo_area_glyphs
= 0;
947 /* If the window system or terminal frame hasn't been initialized
948 yet, or we're not interactive, it's best to dump this message out
949 to stderr and exit. */
950 if (! FRAME_MESSAGE_BUF (selected_frame
)
952 stream
= Qexternal_debugging_output
;
961 write_string_1 (context
, -1, stream
);
963 print_error_message (data
, stream
);
965 /* If the window system or terminal frame hasn't been initialized
966 yet, or we're in -batch mode, this error should cause Emacs to exit. */
967 if (! FRAME_MESSAGE_BUF (selected_frame
)
971 Fkill_emacs (make_number (-1));
975 Lisp_Object
command_loop_1 ();
976 Lisp_Object
command_loop_2 ();
977 Lisp_Object
top_level_1 ();
979 /* Entry to editor-command-loop.
980 This level has the catches for exiting/returning to editor command loop.
981 It returns nil to exit recursive edit, t to abort it. */
986 if (command_loop_level
> 0 || minibuf_level
> 0)
988 return internal_catch (Qexit
, command_loop_2
, Qnil
);
993 internal_catch (Qtop_level
, top_level_1
, Qnil
);
994 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
996 /* End of file in -batch run causes exit here. */
1002 /* Here we catch errors in execution of commands within the
1003 editing loop, and reenter the editing loop.
1004 When there is an error, cmd_error runs and returns a non-nil
1005 value to us. A value of nil means that cmd_loop_1 itself
1006 returned due to end of file (or end of kbd macro). */
1011 register Lisp_Object val
;
1014 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1015 while (!NILP (val
));
1023 return Feval (Vtop_level
);
1029 /* On entry to the outer level, run the startup file */
1030 if (!NILP (Vtop_level
))
1031 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1032 else if (!NILP (Vpurify_flag
))
1033 message ("Bare impure Emacs (standard Lisp code not loaded)");
1035 message ("Bare Emacs (standard Lisp code not loaded)");
1039 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1040 "Exit all recursive editing levels.")
1043 Fthrow (Qtop_level
, Qnil
);
1046 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1047 "Exit from the innermost recursive edit or minibuffer.")
1050 if (command_loop_level
> 0 || minibuf_level
> 0)
1051 Fthrow (Qexit
, Qnil
);
1053 error ("No recursive edit is in progress");
1056 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1057 "Abort the command that requested this recursive edit or minibuffer input.")
1060 if (command_loop_level
> 0 || minibuf_level
> 0)
1063 error ("No recursive edit is in progress");
1066 /* This is the actual command reading loop,
1067 sans error-handling encapsulation. */
1069 Lisp_Object
Fcommand_execute ();
1070 static int read_key_sequence ();
1071 void safe_run_hooks ();
1076 Lisp_Object cmd
, tem
;
1079 Lisp_Object keybuf
[30];
1084 struct buffer
*prev_buffer
;
1086 int was_locked
= single_kboard
;
1089 current_kboard
->Vprefix_arg
= Qnil
;
1090 Vdeactivate_mark
= Qnil
;
1091 waiting_for_input
= 0;
1096 this_command_key_count
= 0;
1097 this_single_command_key_start
= 0;
1099 /* Make sure this hook runs after commands that get errors and
1100 throw to top level. */
1101 /* Note that the value cell will never directly contain nil
1102 if the symbol is a local variable. */
1103 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1104 safe_run_hooks (Qpost_command_hook
);
1106 if (!NILP (Vdeferred_action_list
))
1107 call0 (Vdeferred_action_function
);
1109 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1111 if (NILP (Vunread_command_events
)
1112 && NILP (Vexecuting_macro
)
1113 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1)))
1114 safe_run_hooks (Qpost_command_idle_hook
);
1117 /* Do this after running Vpost_command_hook, for consistency. */
1118 current_kboard
->Vlast_command
= this_command
;
1122 /* Make sure the current window's buffer is selected. */
1123 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1124 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1126 /* Display any malloc warning that just came out. Use while because
1127 displaying one warning can cause another. */
1129 while (pending_malloc_warning
)
1130 display_malloc_warning ();
1134 Vdeactivate_mark
= Qnil
;
1136 /* If minibuffer on and echo area in use,
1137 wait 2 sec and redraw minibuffer. */
1139 if (minibuf_level
&& echo_area_glyphs
1140 && EQ (minibuf_window
, echo_area_window
))
1142 /* Bind inhibit-quit to t so that C-g gets read in
1143 rather than quitting back to the minibuffer. */
1144 int count
= specpdl_ptr
- specpdl
;
1145 specbind (Qinhibit_quit
, Qt
);
1147 Fsit_for (make_number (2), Qnil
, Qnil
);
1148 /* Clear the echo area. */
1150 safe_run_hooks (Qecho_area_clear_hook
);
1152 unbind_to (count
, Qnil
);
1154 /* If a C-g came in before, treat it as input now. */
1155 if (!NILP (Vquit_flag
))
1158 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1163 alloca (0); /* Cause a garbage collection now */
1164 /* Since we can free the most stuff here. */
1165 #endif /* C_ALLOCA */
1168 /* Select the frame that the last event came from. Usually,
1169 switch-frame events will take care of this, but if some lisp
1170 code swallows a switch-frame event, we'll fix things up here.
1171 Is this a good idea? */
1172 if (FRAMEP (internal_last_event_frame
)
1173 && XFRAME (internal_last_event_frame
) != selected_frame
)
1174 Fselect_frame (internal_last_event_frame
, Qnil
);
1176 /* If it has changed current-menubar from previous value,
1177 really recompute the menubar from the value. */
1178 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1179 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1180 call0 (Qrecompute_lucid_menubar
);
1182 before_command_key_count
= this_command_key_count
;
1183 before_command_echo_length
= echo_length ();
1185 this_command
= Qnil
;
1187 /* Read next key sequence; i gets its length. */
1188 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1191 /* A filter may have run while we were reading the input. */
1192 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1193 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1197 /* Now we have read a key sequence of length I,
1198 or else I is 0 and we found end of file. */
1200 if (i
== 0) /* End of file -- happens only in */
1201 return Qnil
; /* a kbd macro, at the end. */
1202 /* -1 means read_key_sequence got a menu that was rejected.
1203 Just loop around and read another command. */
1207 this_command_key_count
= 0;
1208 this_single_command_key_start
= 0;
1212 last_command_char
= keybuf
[i
- 1];
1214 /* If the previous command tried to force a specific window-start,
1215 forget about that, in case this command moves point far away
1216 from that position. But also throw away beg_unchanged and
1217 end_unchanged information in that case, so that redisplay will
1218 update the whole window properly. */
1219 if (!NILP (XWINDOW (selected_window
)->force_start
))
1221 XWINDOW (selected_window
)->force_start
= Qnil
;
1222 beg_unchanged
= end_unchanged
= 0;
1225 cmd
= read_key_sequence_cmd
;
1226 if (!NILP (Vexecuting_macro
))
1228 if (!NILP (Vquit_flag
))
1230 Vexecuting_macro
= Qt
;
1231 QUIT
; /* Make some noise. */
1232 /* Will return since macro now empty. */
1236 /* Do redisplay processing after this command except in special
1237 cases identified below that set no_redisplay to 1.
1238 (actually, there's currently no way to prevent the redisplay,
1239 and no_redisplay is ignored.
1240 Perhaps someday we will really implement it.) */
1243 prev_buffer
= current_buffer
;
1244 prev_modiff
= MODIFF
;
1245 last_point_position
= PT
;
1246 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1248 /* Execute the command. */
1251 /* Note that the value cell will never directly contain nil
1252 if the symbol is a local variable. */
1253 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1254 safe_run_hooks (Qpre_command_hook
);
1256 if (NILP (this_command
))
1258 /* nil means key is undefined. */
1260 current_kboard
->defining_kbd_macro
= Qnil
;
1261 update_mode_lines
= 1;
1262 current_kboard
->Vprefix_arg
= Qnil
;
1266 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1268 /* Recognize some common commands in common situations and
1269 do them directly. */
1270 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1272 struct Lisp_Char_Table
*dp
1273 = window_display_table (XWINDOW (selected_window
));
1274 lose
= FETCH_BYTE (PT
);
1275 SET_PT (forward_point (1));
1277 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1278 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1279 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1280 && (lose
>= 0x20 && lose
< 0x7f)))
1281 : (lose
>= 0x20 && lose
< 0x7f))
1282 /* To extract the case of continuation on
1283 wide-column characters. */
1284 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT
)) == 1)
1285 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1287 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1289 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1291 && !windows_or_buffers_changed
1292 && EQ (current_buffer
->selective_display
, Qnil
)
1293 && !detect_input_pending ()
1294 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1295 && NILP (Vexecuting_macro
))
1296 no_redisplay
= direct_output_forward_char (1);
1299 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1301 struct Lisp_Char_Table
*dp
1302 = window_display_table (XWINDOW (selected_window
));
1303 SET_PT (forward_point (-1));
1304 lose
= FETCH_BYTE (PT
);
1306 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1307 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1308 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1309 && (lose
>= 0x20 && lose
< 0x7f)))
1310 : (lose
>= 0x20 && lose
< 0x7f))
1311 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1313 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1315 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1317 && !windows_or_buffers_changed
1318 && EQ (current_buffer
->selective_display
, Qnil
)
1319 && !detect_input_pending ()
1320 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1321 && NILP (Vexecuting_macro
))
1322 no_redisplay
= direct_output_forward_char (-1);
1325 else if (EQ (this_command
, Qself_insert_command
)
1326 /* Try this optimization only on ascii keystrokes. */
1327 && INTEGERP (last_command_char
))
1329 unsigned int c
= XINT (last_command_char
);
1332 if (NILP (Vexecuting_macro
)
1333 && !EQ (minibuf_window
, selected_window
))
1335 if (!nonundocount
|| nonundocount
>= 20)
1342 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1344 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1346 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1348 || MODIFF
<= SAVE_MODIFF
1349 || windows_or_buffers_changed
1350 || !EQ (current_buffer
->selective_display
, Qnil
)
1351 || detect_input_pending ()
1352 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1353 || !NILP (Vexecuting_macro
));
1354 value
= internal_self_insert (c
, 0);
1361 && (PT
== ZV
|| FETCH_BYTE (PT
) == '\n'))
1363 struct Lisp_Char_Table
*dp
1364 = window_display_table (XWINDOW (selected_window
));
1371 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1374 /* Do it only for char codes
1375 that by default display as themselves. */
1376 if (lose
>= 0x20 && lose
<= 0x7e)
1377 no_redisplay
= direct_output_for_insert (lose
);
1379 else if (VECTORP (obj
)
1380 && XVECTOR (obj
)->size
== 1
1381 && (obj
= XVECTOR (obj
)->contents
[0],
1383 /* Insist face not specified in glyph. */
1384 && (XINT (obj
) & ((-1) << 8)) == 0)
1386 = direct_output_for_insert (XINT (obj
));
1390 if (lose
>= 0x20 && lose
<= 0x7e)
1391 no_redisplay
= direct_output_for_insert (lose
);
1398 /* Here for a command that isn't executed directly */
1401 if (NILP (current_kboard
->Vprefix_arg
))
1403 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1408 /* If there is a prefix argument,
1409 1) We don't want Vlast_command to be ``universal-argument''
1410 (that would be dumb), so don't set Vlast_command,
1411 2) we want to leave echoing on so that the prefix will be
1412 echoed as part of this key sequence, so don't call
1414 3) we want to leave this_command_key_count non-zero, so that
1415 read_char will realize that it is re-reading a character, and
1416 not echo it a second time.
1418 If the command didn't actually create a prefix arg,
1419 but is merely a frame event that is transparent to prefix args,
1420 then the above doesn't apply. */
1421 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1423 current_kboard
->Vlast_command
= this_command
;
1425 this_command_key_count
= 0;
1426 this_single_command_key_start
= 0;
1429 /* Note that the value cell will never directly contain nil
1430 if the symbol is a local variable. */
1431 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1432 safe_run_hooks (Qpost_command_hook
);
1434 if (!NILP (Vdeferred_action_list
))
1435 safe_run_hooks (Qdeferred_action_function
);
1437 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1439 if (NILP (Vunread_command_events
)
1440 && NILP (Vexecuting_macro
)
1441 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1)))
1442 safe_run_hooks (Qpost_command_idle_hook
);
1445 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1447 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1449 current_buffer
->mark_active
= Qnil
;
1450 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1452 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1453 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1457 /* Install chars successfully executed in kbd macro. */
1459 if (!NILP (current_kboard
->defining_kbd_macro
)
1460 && NILP (current_kboard
->Vprefix_arg
))
1461 finalize_kbd_macro_chars ();
1465 any_kboard_state ();
1470 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1473 safe_run_hooks_1 (hook
)
1476 return call1 (Vrun_hooks
, Vinhibit_quit
);
1479 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1482 safe_run_hooks_error (data
)
1485 Fset (Vinhibit_quit
, Qnil
);
1488 /* If we get an error while running the hook, cause the hook variable
1489 to be nil. Also inhibit quits, so that C-g won't cause the hook
1490 to mysteriously evaporate. */
1493 safe_run_hooks (hook
)
1497 int count
= specpdl_ptr
- specpdl
;
1498 specbind (Qinhibit_quit
, hook
);
1500 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1502 unbind_to (count
, Qnil
);
1505 /* Number of seconds between polling for input. */
1508 /* Nonzero means polling for input is temporarily suppressed. */
1509 int poll_suppress_count
;
1511 /* Nonzero if polling_for_input is actually being used. */
1512 int polling_for_input
;
1514 #ifdef POLL_FOR_INPUT
1516 /* Handle an alarm once each second and read pending input
1517 so as to handle a C-g if it comces in. */
1520 input_poll_signal (signalnum
) /* If we don't have an argument, */
1521 int signalnum
; /* some compilers complain in signal calls. */
1523 /* This causes the call to start_polling at the end
1524 to do its job. It also arranges for a quit or error
1525 from within read_avail_input to resume polling. */
1526 poll_suppress_count
++;
1527 if (interrupt_input_blocked
== 0
1528 && !waiting_for_input
)
1529 read_avail_input (0);
1530 /* Turn on the SIGALRM handler and request another alarm. */
1536 /* Begin signals to poll for input, if they are appropriate.
1537 This function is called unconditionally from various places. */
1541 #ifdef POLL_FOR_INPUT
1542 if (read_socket_hook
&& !interrupt_input
)
1544 poll_suppress_count
--;
1545 if (poll_suppress_count
== 0)
1547 signal (SIGALRM
, input_poll_signal
);
1548 polling_for_input
= 1;
1549 alarm (polling_period
);
1555 /* Nonzero if we are using polling to handle input asynchronously. */
1558 input_polling_used ()
1560 #ifdef POLL_FOR_INPUT
1561 return read_socket_hook
&& !interrupt_input
;
1567 /* Turn off polling. */
1571 #ifdef POLL_FOR_INPUT
1572 if (read_socket_hook
&& !interrupt_input
)
1574 if (poll_suppress_count
== 0)
1576 polling_for_input
= 0;
1579 poll_suppress_count
++;
1584 /* Set the value of poll_suppress_count to COUNT
1585 and start or stop polling accordingly. */
1588 set_poll_suppress_count (count
)
1591 #ifdef POLL_FOR_INPUT
1592 if (count
== 0 && poll_suppress_count
!= 0)
1594 poll_suppress_count
= 1;
1597 else if (count
!= 0 && poll_suppress_count
== 0)
1601 poll_suppress_count
= count
;
1605 /* Bind polling_period to a value at least N.
1606 But don't decrease it. */
1608 bind_polling_period (n
)
1611 #ifdef POLL_FOR_INPUT
1612 int new = polling_period
;
1618 specbind (Qpolling_period
, make_number (new));
1619 /* Start a new alarm with the new period. */
1624 /* Apply the control modifier to CHARACTER. */
1630 /* Save the upper bits here. */
1631 int upper
= c
& ~0177;
1635 /* Everything in the columns containing the upper-case letters
1636 denotes a control character. */
1637 if (c
>= 0100 && c
< 0140)
1641 /* Set the shift modifier for a control char
1642 made from a shifted letter. But only for letters! */
1643 if (oc
>= 'A' && oc
<= 'Z')
1644 c
|= shift_modifier
;
1647 /* The lower-case letters denote control characters too. */
1648 else if (c
>= 'a' && c
<= 'z')
1651 /* Include the bits for control and shift
1652 only if the basic ASCII code can't indicate them. */
1656 /* Replace the high bits. */
1657 c
|= (upper
& ~ctrl_modifier
);
1664 /* Input of single characters from keyboard */
1666 Lisp_Object
print_help ();
1667 static Lisp_Object
kbd_buffer_get_event ();
1668 static void record_char ();
1671 static jmp_buf wrong_kboard_jmpbuf
;
1674 /* read a character from the keyboard; call the redisplay if needed */
1675 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1676 -1 means do not do redisplay, but do do autosaving.
1679 /* The arguments MAPS and NMAPS are for menu prompting.
1680 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1682 PREV_EVENT is the previous input event, or nil if we are reading
1683 the first event of a key sequence.
1685 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1686 if we used a mouse menu to read the input, or zero otherwise. If
1687 USED_MOUSE_MENU is null, we don't dereference it.
1689 Value is t if we showed a menu and the user rejected it. */
1692 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1696 Lisp_Object prev_event
;
1697 int *used_mouse_menu
;
1699 register Lisp_Object c
;
1701 jmp_buf local_getcjmp
;
1703 int key_already_recorded
= 0;
1704 Lisp_Object tem
, save
;
1705 Lisp_Object also_record
;
1708 before_command_key_count
= this_command_key_count
;
1709 before_command_echo_length
= echo_length ();
1713 if (CONSP (Vunread_command_events
))
1715 c
= XCONS (Vunread_command_events
)->car
;
1716 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1718 /* Undo what read_char_x_menu_prompt did when it unread
1719 additional keys returned by Fx_popup_menu. */
1721 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1722 && NILP (XCONS (c
)->cdr
))
1725 if (this_command_key_count
== 0)
1731 if (unread_command_char
!= -1)
1733 XSETINT (c
, unread_command_char
);
1734 unread_command_char
= -1;
1736 if (this_command_key_count
== 0)
1742 /* If there is no function key translated before
1743 reset-this-command-lengths takes effect, forget about it. */
1744 before_command_restore_flag
= 0;
1746 if (!NILP (Vexecuting_macro
))
1748 /* We set this to Qmacro; since that's not a frame, nobody will
1749 try to switch frames on us, and the selected window will
1752 Since this event came from a macro, it would be misleading to
1753 leave internal_last_event_frame set to wherever the last
1754 real event came from. Normally, a switch-frame event selects
1755 internal_last_event_frame after each command is read, but
1756 events read from a macro should never cause a new frame to be
1758 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1760 /* Exit the macro if we are at the end.
1761 Also, some things replace the macro with t
1762 to force an early exit. */
1763 if (EQ (Vexecuting_macro
, Qt
)
1764 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1770 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1771 if (STRINGP (Vexecuting_macro
)
1772 && (XINT (c
) & 0x80))
1773 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1775 executing_macro_index
++;
1780 if (!NILP (unread_switch_frame
))
1782 c
= unread_switch_frame
;
1783 unread_switch_frame
= Qnil
;
1785 /* This event should make it into this_command_keys, and get echoed
1786 again, so we go to reread_first, rather than reread. */
1790 if (commandflag
>= 0 && !input_pending
1791 && !detect_input_pending_run_timers (0))
1794 /* Message turns off echoing unless more keystrokes turn it on again. */
1795 if (echo_area_glyphs
&& *echo_area_glyphs
1796 && echo_area_glyphs
!= current_kboard
->echobuf
1797 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1800 /* If already echoing, continue. */
1803 /* Try reading a character via menu prompting in the minibuf.
1804 Try this before the sit-for, because the sit-for
1805 would do the wrong thing if we are supposed to do
1806 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1807 after a mouse event so don't try a minibuf menu. */
1809 if (nmaps
> 0 && INTERACTIVE
1810 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1811 /* Don't bring up a menu if we already have another event. */
1812 && NILP (Vunread_command_events
)
1813 && unread_command_char
< 0
1814 && !detect_input_pending_run_timers (0))
1816 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1819 key_already_recorded
= 1;
1824 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1825 We will do that below, temporarily for short sections of code,
1826 when appropriate. local_getcjmp must be in effect
1827 around any call to sit_for or kbd_buffer_get_event;
1828 it *must not* be in effect when we call redisplay. */
1830 if (_setjmp (local_getcjmp
))
1832 XSETINT (c
, quit_char
);
1833 XSETFRAME (internal_last_event_frame
, selected_frame
);
1834 Vlast_event_frame
= internal_last_event_frame
;
1835 /* If we report the quit char as an event,
1836 don't do so more than once. */
1837 if (!NILP (Vinhibit_quit
))
1842 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1843 if (kb
!= current_kboard
)
1845 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1846 /* We shouldn't get here if we were in single-kboard mode! */
1849 while (CONSP (*tailp
))
1850 tailp
= &XCONS (*tailp
)->cdr
;
1853 *tailp
= Fcons (c
, Qnil
);
1854 kb
->kbd_queue_has_data
= 1;
1855 current_kboard
= kb
;
1856 longjmp (wrong_kboard_jmpbuf
, 1);
1863 timer_start_idle ();
1865 /* If in middle of key sequence and minibuffer not active,
1866 start echoing if enough time elapses. */
1868 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1869 && this_command_key_count
> 0
1871 && echo_keystrokes
> 0
1872 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1873 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1877 /* After a mouse event, start echoing right away.
1878 This is because we are probably about to display a menu,
1879 and we don't want to delay before doing so. */
1880 if (EVENT_HAS_PARAMETERS (prev_event
))
1884 save_getcjmp (save_jump
);
1885 restore_getcjmp (local_getcjmp
);
1886 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1887 restore_getcjmp (save_jump
);
1893 /* Maybe auto save due to number of keystrokes. */
1895 if (commandflag
!= 0
1896 && auto_save_interval
> 0
1897 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1898 && !detect_input_pending_run_timers (0))
1900 Fdo_auto_save (Qnil
, Qnil
);
1901 /* Hooks can actually change some buffers in auto save. */
1905 /* Try reading using an X menu.
1906 This is never confused with reading using the minibuf
1907 because the recursive call of read_char in read_char_minibuf_menu_prompt
1908 does not pass on any keymaps. */
1910 if (nmaps
> 0 && INTERACTIVE
1911 && !NILP (prev_event
)
1912 && EVENT_HAS_PARAMETERS (prev_event
)
1913 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1914 /* Don't bring up a menu if we already have another event. */
1915 && NILP (Vunread_command_events
)
1916 && unread_command_char
< 0)
1918 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1920 /* Now that we have read an event, Emacs is not idle. */
1926 /* Maybe autosave and/or garbage collect due to idleness. */
1928 if (INTERACTIVE
&& NILP (c
))
1930 int delay_level
, buffer_size
;
1932 /* Slow down auto saves logarithmically in size of current buffer,
1933 and garbage collect while we're at it. */
1934 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1935 last_non_minibuf_size
= Z
- BEG
;
1936 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1938 while (buffer_size
> 64)
1939 delay_level
++, buffer_size
-= buffer_size
>> 2;
1940 if (delay_level
< 4) delay_level
= 4;
1941 /* delay_level is 4 for files under around 50k, 7 at 100k,
1942 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1944 /* Auto save if enough time goes by without input. */
1945 if (commandflag
!= 0
1946 && num_nonmacro_input_chars
> last_auto_save
1947 && INTEGERP (Vauto_save_timeout
)
1948 && XINT (Vauto_save_timeout
) > 0)
1952 save_getcjmp (save_jump
);
1953 restore_getcjmp (local_getcjmp
);
1954 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
1956 restore_getcjmp (save_jump
);
1960 Fdo_auto_save (Qnil
, Qnil
);
1962 /* If we have auto-saved and there is still no input
1963 available, garbage collect if there has been enough
1964 consing going on to make it worthwhile. */
1965 if (!detect_input_pending_run_timers (0)
1966 && consing_since_gc
> gc_cons_threshold
/ 2)
1967 Fgarbage_collect ();
1974 /* Read something from current KBOARD's side queue, if possible. */
1978 if (current_kboard
->kbd_queue_has_data
)
1980 if (!CONSP (current_kboard
->kbd_queue
))
1982 c
= XCONS (current_kboard
->kbd_queue
)->car
;
1983 current_kboard
->kbd_queue
1984 = XCONS (current_kboard
->kbd_queue
)->cdr
;
1985 if (NILP (current_kboard
->kbd_queue
))
1986 current_kboard
->kbd_queue_has_data
= 0;
1987 input_pending
= readable_events (0);
1988 if (EVENT_HAS_PARAMETERS (c
)
1989 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
1990 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
1991 Vlast_event_frame
= internal_last_event_frame
;
1996 /* If current_kboard's side queue is empty check the other kboards.
1997 If one of them has data that we have not yet seen here,
1998 switch to it and process the data waiting for it.
2000 Note: if the events queued up for another kboard
2001 have already been seen here, and therefore are not a complete command,
2002 the kbd_queue_has_data field is 0, so we skip that kboard here.
2003 That's to avoid an infinite loop switching between kboards here. */
2004 if (NILP (c
) && !single_kboard
)
2007 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2008 if (kb
->kbd_queue_has_data
)
2010 current_kboard
= kb
;
2011 longjmp (wrong_kboard_jmpbuf
, 1);
2020 /* Finally, we read from the main queue,
2021 and if that gives us something we can't use yet, we put it on the
2022 appropriate side queue and try again. */
2028 /* Actually read a character, waiting if necessary. */
2029 save_getcjmp (save_jump
);
2030 restore_getcjmp (local_getcjmp
);
2031 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2032 restore_getcjmp (save_jump
);
2035 if (! NILP (c
) && (kb
!= current_kboard
))
2037 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2038 while (CONSP (*tailp
))
2039 tailp
= &XCONS (*tailp
)->cdr
;
2042 *tailp
= Fcons (c
, Qnil
);
2043 kb
->kbd_queue_has_data
= 1;
2047 current_kboard
= kb
;
2048 longjmp (wrong_kboard_jmpbuf
, 1);
2053 /* Terminate Emacs in batch mode if at eof. */
2054 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2055 Fkill_emacs (make_number (1));
2059 /* Add in any extra modifiers, where appropriate. */
2060 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2061 || ((extra_keyboard_modifiers
& 0177) < ' '
2062 && (extra_keyboard_modifiers
& 0177) != 0))
2063 XSETINT (c
, make_ctrl_char (XINT (c
)));
2065 /* Transfer any other modifier bits directly from
2066 extra_keyboard_modifiers to c. Ignore the actual character code
2067 in the low 16 bits of extra_keyboard_modifiers. */
2068 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2073 /* Now that we have read an event, Emacs is not idle--
2074 unless the event was a timer event (not used now). */
2082 if (commandflag
>= 0
2083 && !input_pending
&& !detect_input_pending_run_timers (0))
2091 /* Buffer switch events are only for internal wakeups
2092 so don't show them to the user. */
2096 if (key_already_recorded
)
2099 /* Process special events within read_char
2100 and loop around to read another event. */
2103 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2109 int was_locked
= single_kboard
;
2111 last_input_char
= c
;
2112 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2114 /* Resume allowing input from any kboard, if that was true before. */
2116 any_kboard_state ();
2121 /* Wipe the echo area. */
2122 if (echo_area_glyphs
)
2123 safe_run_hooks (Qecho_area_clear_hook
);
2124 echo_area_glyphs
= 0;
2126 /* Handle things that only apply to characters. */
2129 /* If kbd_buffer_get_event gave us an EOF, return that. */
2133 if (STRINGP (Vkeyboard_translate_table
)
2134 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2135 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2136 else if ((VECTORP (Vkeyboard_translate_table
)
2137 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2138 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2139 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2142 d
= Faref (Vkeyboard_translate_table
, c
);
2143 /* nil in keyboard-translate-table means no translation. */
2149 /* If this event is a mouse click in the menu bar,
2150 return just menu-bar for now. Modify the mouse click event
2151 so we won't do this twice, then queue it up. */
2152 if (EVENT_HAS_PARAMETERS (c
)
2153 && CONSP (XCONS (c
)->cdr
)
2154 && CONSP (EVENT_START (c
))
2155 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2159 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2160 /* Handle menu-bar events:
2161 insert the dummy prefix event `menu-bar'. */
2162 if (EQ (posn
, Qmenu_bar
))
2164 /* Change menu-bar to (menu-bar) as the event "position". */
2165 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2168 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2174 if (! NILP (also_record
))
2175 record_char (also_record
);
2179 before_command_key_count
= this_command_key_count
;
2180 before_command_echo_length
= echo_length ();
2182 /* Don't echo mouse motion events. */
2184 && ! (EVENT_HAS_PARAMETERS (c
)
2185 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2188 if (! NILP (also_record
))
2189 echo_char (also_record
);
2190 /* Once we reread a character, echoing can happen
2191 the next time we pause to read a new one. */
2192 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2195 /* Record this character as part of the current key. */
2196 add_command_key (c
);
2197 if (! NILP (also_record
))
2198 add_command_key (also_record
);
2200 /* Re-reading in the middle of a command */
2202 last_input_char
= c
;
2205 /* Process the help character specially if enabled */
2206 if (!NILP (Vhelp_form
) && help_char_p (c
))
2209 count
= specpdl_ptr
- specpdl
;
2211 record_unwind_protect (Fset_window_configuration
,
2212 Fcurrent_window_configuration (Qnil
));
2214 tem0
= Feval (Vhelp_form
);
2216 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2220 c
= read_char (0, 0, 0, Qnil
, 0);
2221 while (BUFFERP (c
));
2222 /* Remove the help from the frame */
2223 unbind_to (count
, Qnil
);
2226 if (EQ (c
, make_number (040)))
2230 c
= read_char (0, 0, 0, Qnil
, 0);
2231 while (BUFFERP (c
));
2238 /* Record a key that came from a mouse menu.
2239 Record it for echoing, for this-command-keys, and so on. */
2245 /* Wipe the echo area. */
2246 echo_area_glyphs
= 0;
2250 before_command_key_count
= this_command_key_count
;
2251 before_command_echo_length
= echo_length ();
2253 /* Don't echo mouse motion events. */
2254 if (echo_keystrokes
)
2258 /* Once we reread a character, echoing can happen
2259 the next time we pause to read a new one. */
2260 ok_to_echo_at_next_pause
= 0;
2263 /* Record this character as part of the current key. */
2264 add_command_key (c
);
2266 /* Re-reading in the middle of a command */
2267 last_input_char
= c
;
2271 /* Return 1 if should recognize C as "the help character". */
2279 if (EQ (c
, Vhelp_char
))
2281 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2282 if (EQ (c
, XCONS (tail
)->car
))
2287 /* Record the input event C in various ways. */
2294 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2295 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2296 recent_keys_index
= 0;
2298 /* Write c to the dribble file. If c is a lispy event, write
2299 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2300 If you, dear reader, have a better idea, you've got the source. :-) */
2305 if (XUINT (c
) < 0x100)
2306 putc (XINT (c
), dribble
);
2308 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2312 Lisp_Object dribblee
;
2314 /* If it's a structured event, take the event header. */
2315 dribblee
= EVENT_HEAD (c
);
2317 if (SYMBOLP (dribblee
))
2319 putc ('<', dribble
);
2320 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2321 XSYMBOL (dribblee
)->name
->size
,
2323 putc ('>', dribble
);
2330 store_kbd_macro_char (c
);
2332 num_nonmacro_input_chars
++;
2339 struct buffer
*old
= current_buffer
;
2340 Fprinc (object
, Qnil
);
2341 set_buffer_internal (XBUFFER (Vstandard_output
));
2342 call0 (intern ("help-mode"));
2343 set_buffer_internal (old
);
2347 /* Copy out or in the info on where C-g should throw to.
2348 This is used when running Lisp code from within get_char,
2349 in case get_char is called recursively.
2350 See read_process_output. */
2355 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2358 restore_getcjmp (temp
)
2361 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2366 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2367 of this function. */
2370 tracking_off (old_value
)
2371 Lisp_Object old_value
;
2373 do_mouse_tracking
= old_value
;
2374 if (NILP (old_value
))
2376 /* Redisplay may have been preempted because there was input
2377 available, and it assumes it will be called again after the
2378 input has been processed. If the only input available was
2379 the sort that we have just disabled, then we need to call
2381 if (!readable_events (1))
2383 redisplay_preserve_echo_area ();
2384 get_input_pending (&input_pending
, 1);
2389 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2390 "Evaluate BODY with mouse movement events enabled.\n\
2391 Within a `track-mouse' form, mouse motion generates input events that\n\
2392 you can read with `read-event'.\n\
2393 Normally, mouse motion is ignored.")
2397 int count
= specpdl_ptr
- specpdl
;
2400 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2402 do_mouse_tracking
= Qt
;
2404 val
= Fprogn (args
);
2405 return unbind_to (count
, val
);
2408 /* If mouse has moved on some frame, return one of those frames.
2409 Return 0 otherwise. */
2414 Lisp_Object tail
, frame
;
2416 FOR_EACH_FRAME (tail
, frame
)
2418 if (XFRAME (frame
)->mouse_moved
)
2419 return XFRAME (frame
);
2425 #endif /* HAVE_MOUSE */
2427 /* Low level keyboard/mouse input.
2428 kbd_buffer_store_event places events in kbd_buffer, and
2429 kbd_buffer_get_event retrieves them. */
2431 /* Return true iff there are any events in the queue that read-char
2432 would return. If this returns false, a read-char would block. */
2434 readable_events (do_timers_now
)
2438 timer_check (do_timers_now
);
2440 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2443 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2448 if (current_kboard
->kbd_queue_has_data
)
2454 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2455 if (kb
->kbd_queue_has_data
)
2461 /* Set this for debugging, to have a way to get out */
2466 event_to_kboard (event
)
2467 struct input_event
*event
;
2470 frame
= event
->frame_or_window
;
2472 frame
= XCONS (frame
)->car
;
2473 else if (WINDOWP (frame
))
2474 frame
= WINDOW_FRAME (XWINDOW (frame
));
2476 /* There are still some events that don't set this field.
2477 For now, just ignore the problem.
2478 Also ignore dead frames here. */
2479 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2482 return FRAME_KBOARD (XFRAME (frame
));
2486 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2489 kbd_buffer_store_event (event
)
2490 register struct input_event
*event
;
2492 if (event
->kind
== no_event
)
2495 if (event
->kind
== ascii_keystroke
)
2497 register int c
= event
->code
& 0377;
2499 if (event
->modifiers
& ctrl_modifier
)
2500 c
= make_ctrl_char (c
);
2502 c
|= (event
->modifiers
2503 & (meta_modifier
| alt_modifier
2504 | hyper_modifier
| super_modifier
));
2508 extern SIGTYPE
interrupt_signal ();
2511 struct input_event
*sp
;
2514 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2515 kb
!= current_kboard
))
2518 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2519 Fcons (make_number (c
), Qnil
));
2520 kb
->kbd_queue_has_data
= 1;
2521 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2523 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2526 if (event_to_kboard (sp
) == kb
)
2528 sp
->kind
= no_event
;
2529 sp
->frame_or_window
= Qnil
;
2536 /* If this results in a quit_char being returned to Emacs as
2537 input, set Vlast_event_frame properly. If this doesn't
2538 get returned to Emacs as an event, the next event read
2539 will set Vlast_event_frame again, so this is safe to do. */
2543 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2545 focus
= event
->frame_or_window
;
2546 internal_last_event_frame
= focus
;
2547 Vlast_event_frame
= focus
;
2550 last_event_timestamp
= event
->timestamp
;
2551 interrupt_signal ();
2555 if (c
&& c
== stop_character
)
2561 /* Don't insert two buffer_switch_event's in a row.
2562 Just ignore the second one. */
2563 else if (event
->kind
== buffer_switch_event
2564 && kbd_fetch_ptr
!= kbd_store_ptr
2565 && kbd_store_ptr
->kind
== buffer_switch_event
)
2568 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2569 kbd_store_ptr
= kbd_buffer
;
2571 /* Don't let the very last slot in the buffer become full,
2572 since that would make the two pointers equal,
2573 and that is indistinguishable from an empty buffer.
2574 Discard the event if it would fill the last slot. */
2575 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2577 volatile struct input_event
*sp
= kbd_store_ptr
;
2578 sp
->kind
= event
->kind
;
2579 if (event
->kind
== selection_request_event
)
2581 /* We must not use the ordinary copying code for this case,
2582 since `part' is an enum and copying it might not copy enough
2584 bcopy (event
, (char *) sp
, sizeof (*event
));
2588 sp
->code
= event
->code
;
2589 sp
->part
= event
->part
;
2590 sp
->frame_or_window
= event
->frame_or_window
;
2591 sp
->modifiers
= event
->modifiers
;
2594 sp
->timestamp
= event
->timestamp
;
2596 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2598 = event
->frame_or_window
);
2604 /* Read one event from the event buffer, waiting if necessary.
2605 The value is a Lisp object representing the event.
2606 The value is nil for an event that should be ignored,
2607 or that was handled here.
2608 We always read and discard one event. */
2611 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2613 int *used_mouse_menu
;
2617 EMACS_TIME next_timer_delay
;
2623 *kbp
= current_kboard
;
2627 /* Wait until there is input available. */
2630 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2633 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2637 /* If the quit flag is set, then read_char will return
2638 quit_char, so that counts as "available input." */
2639 if (!NILP (Vquit_flag
))
2640 quit_throw_to_read_char ();
2642 /* One way or another, wait until input is available; then, if
2643 interrupt handlers have not read it, read it now. */
2646 wait_for_kbd_input ();
2648 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2652 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2655 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2659 Lisp_Object minus_one
;
2661 XSETINT (minus_one
, -1);
2662 wait_reading_process_input (0, 0, minus_one
, 1);
2664 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2665 /* Pass 1 for EXPECT since we just waited to have input. */
2666 read_avail_input (1);
2668 #endif /* not VMS */
2671 /* At this point, we know that there is a readable event available
2672 somewhere. If the event queue is empty, then there must be a
2673 mouse movement enabled and available. */
2674 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2676 struct input_event
*event
;
2678 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2682 last_event_timestamp
= event
->timestamp
;
2685 *kbp
= event_to_kboard (event
);
2687 *kbp
= current_kboard
; /* Better than returning null ptr? */
2689 *kbp
= &the_only_kboard
;
2694 /* These two kinds of events get special handling
2695 and don't actually appear to the command loop.
2696 We return nil for them. */
2697 if (event
->kind
== selection_request_event
)
2700 struct input_event copy
;
2702 /* Remove it from the buffer before processing it,
2703 since otherwise swallow_events will see it
2704 and process it again. */
2706 kbd_fetch_ptr
= event
+ 1;
2707 input_pending
= readable_events (0);
2708 x_handle_selection_request (©
);
2710 /* We're getting selection request events, but we don't have
2716 else if (event
->kind
== selection_clear_event
)
2719 struct input_event copy
;
2721 /* Remove it from the buffer before processing it. */
2723 kbd_fetch_ptr
= event
+ 1;
2724 input_pending
= readable_events (0);
2725 x_handle_selection_clear (©
);
2727 /* We're getting selection request events, but we don't have
2732 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2733 else if (event
->kind
== delete_window_event
)
2735 /* Make an event (delete-frame (FRAME)). */
2736 obj
= Fcons (event
->frame_or_window
, Qnil
);
2737 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2738 kbd_fetch_ptr
= event
+ 1;
2740 else if (event
->kind
== iconify_event
)
2742 /* Make an event (iconify-frame (FRAME)). */
2743 obj
= Fcons (event
->frame_or_window
, Qnil
);
2744 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2745 kbd_fetch_ptr
= event
+ 1;
2747 else if (event
->kind
== deiconify_event
)
2749 /* Make an event (make-frame-visible (FRAME)). */
2750 obj
= Fcons (event
->frame_or_window
, Qnil
);
2751 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2752 kbd_fetch_ptr
= event
+ 1;
2755 else if (event
->kind
== buffer_switch_event
)
2757 /* The value doesn't matter here; only the type is tested. */
2758 XSETBUFFER (obj
, current_buffer
);
2759 kbd_fetch_ptr
= event
+ 1;
2761 #ifdef USE_X_TOOLKIT
2762 else if (event
->kind
== menu_bar_activate_event
)
2764 kbd_fetch_ptr
= event
+ 1;
2765 input_pending
= readable_events (0);
2766 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2767 x_activate_menubar (XFRAME (event
->frame_or_window
));
2770 /* Just discard these, by returning nil.
2771 With MULTI_KBOARD, these events are used as placeholders
2772 when we need to randomly delete events from the queue.
2773 (They shouldn't otherwise be found in the buffer,
2774 but on some machines it appears they do show up
2775 even without MULTI_KBOARD.) */
2776 else if (event
->kind
== no_event
)
2777 kbd_fetch_ptr
= event
+ 1;
2779 /* If this event is on a different frame, return a switch-frame this
2780 time, and leave the event in the queue for next time. */
2786 frame
= event
->frame_or_window
;
2788 frame
= XCONS (frame
)->car
;
2789 else if (WINDOWP (frame
))
2790 frame
= WINDOW_FRAME (XWINDOW (frame
));
2792 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2796 if (! EQ (frame
, internal_last_event_frame
)
2797 && XFRAME (frame
) != selected_frame
)
2798 obj
= make_lispy_switch_frame (frame
);
2799 internal_last_event_frame
= frame
;
2801 /* If we didn't decide to make a switch-frame event, go ahead
2802 and build a real event from the queue entry. */
2806 obj
= make_lispy_event (event
);
2807 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2808 /* If this was a menu selection, then set the flag to inhibit
2809 writing to last_nonmenu_event. Don't do this if the event
2810 we're returning is (menu-bar), though; that indicates the
2811 beginning of the menu sequence, and we might as well leave
2812 that as the `event with parameters' for this selection. */
2813 if (event
->kind
== menu_bar_event
2814 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2816 *used_mouse_menu
= 1;
2819 /* Wipe out this event, to catch bugs. */
2820 event
->kind
= no_event
;
2821 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2823 kbd_fetch_ptr
= event
+ 1;
2828 /* Try generating a mouse motion event. */
2829 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2831 FRAME_PTR f
= some_mouse_moved ();
2832 Lisp_Object bar_window
;
2833 enum scroll_bar_part part
;
2837 *kbp
= current_kboard
;
2838 /* Note that this uses F to determine which display to look at.
2839 If there is no valid info, it does not store anything
2840 so x remains nil. */
2842 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2846 /* Decide if we should generate a switch-frame event. Don't
2847 generate switch-frame events for motion outside of all Emacs
2853 frame
= FRAME_FOCUS_FRAME (f
);
2855 XSETFRAME (frame
, f
);
2857 if (! EQ (frame
, internal_last_event_frame
)
2858 && XFRAME (frame
) != selected_frame
)
2859 obj
= make_lispy_switch_frame (frame
);
2860 internal_last_event_frame
= frame
;
2863 /* If we didn't decide to make a switch-frame event, go ahead and
2864 return a mouse-motion event. */
2865 if (!NILP (x
) && NILP (obj
))
2866 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2868 #endif /* HAVE_MOUSE */
2870 /* We were promised by the above while loop that there was
2871 something for us to read! */
2874 input_pending
= readable_events (0);
2876 Vlast_event_frame
= internal_last_event_frame
;
2881 /* Process any events that are not user-visible,
2882 then return, without reading any user-visible events. */
2885 swallow_events (do_display
)
2890 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2892 struct input_event
*event
;
2894 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2898 last_event_timestamp
= event
->timestamp
;
2900 /* These two kinds of events get special handling
2901 and don't actually appear to the command loop. */
2902 if (event
->kind
== selection_request_event
)
2905 struct input_event copy
;
2907 /* Remove it from the buffer before processing it,
2908 since otherwise swallow_events called recursively could see it
2909 and process it again. */
2911 kbd_fetch_ptr
= event
+ 1;
2912 input_pending
= readable_events (0);
2913 x_handle_selection_request (©
);
2915 /* We're getting selection request events, but we don't have
2921 else if (event
->kind
== selection_clear_event
)
2924 struct input_event copy
;
2926 /* Remove it from the buffer before processing it, */
2929 kbd_fetch_ptr
= event
+ 1;
2930 input_pending
= readable_events (0);
2931 x_handle_selection_clear (©
);
2933 /* We're getting selection request events, but we don't have
2942 old_timers_run
= timers_run
;
2943 get_input_pending (&input_pending
, 1);
2945 if (timers_run
!= old_timers_run
&& do_display
)
2946 redisplay_preserve_echo_area ();
2949 static EMACS_TIME timer_idleness_start_time
;
2951 /* Record the start of when Emacs is idle,
2952 for the sake of running idle-time timers. */
2958 /* If we are already in the idle state, do nothing. */
2959 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2962 EMACS_GET_TIME (timer_idleness_start_time
);
2964 /* Mark all idle-time timers as once again candidates for running. */
2965 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
2969 timer
= XCONS (timers
)->car
;
2971 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
2973 XVECTOR (timer
)->contents
[0] = Qnil
;
2977 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
2981 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
2984 /* This is only for debugging. */
2985 struct input_event last_timer_event
;
2987 /* Check whether a timer has fired. To prevent larger problems we simply
2988 disregard elements that are not proper timers. Do not make a circular
2989 timer list for the time being.
2991 Returns the number of seconds to wait until the next timer fires. If a
2992 timer is triggering now, return zero seconds.
2993 If no timer is active, return -1 seconds.
2995 If a timer is ripe, we run it, with quitting turned off.
2997 DO_IT_NOW is now ignored. It used to mean that we should
2998 run the timer directly instead of queueing a timer-event.
2999 Now we always run timers directly. */
3002 timer_check (do_it_now
)
3005 EMACS_TIME nexttime
;
3006 EMACS_TIME now
, idleness_now
;
3007 Lisp_Object timers
, idle_timers
, chosen_timer
;
3008 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3010 EMACS_SET_SECS (nexttime
, -1);
3011 EMACS_SET_USECS (nexttime
, -1);
3013 /* Always consider the ordinary timers. */
3014 timers
= Vtimer_list
;
3015 /* Consider the idle timers only if Emacs is idle. */
3016 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3017 idle_timers
= Vtimer_idle_list
;
3020 chosen_timer
= Qnil
;
3021 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3023 if (CONSP (timers
) || CONSP (idle_timers
))
3025 EMACS_GET_TIME (now
);
3026 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3027 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3030 while (CONSP (timers
) || CONSP (idle_timers
))
3032 int triggertime
= EMACS_SECS (now
);
3033 Lisp_Object
*vector
;
3034 Lisp_Object timer
, idle_timer
;
3035 EMACS_TIME timer_time
, idle_timer_time
;
3036 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3038 /* Skip past invalid timers and timers already handled. */
3041 timer
= XCONS (timers
)->car
;
3042 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3044 timers
= XCONS (timers
)->cdr
;
3047 vector
= XVECTOR (timer
)->contents
;
3049 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3050 || !INTEGERP (vector
[3])
3051 || ! NILP (vector
[0]))
3053 timers
= XCONS (timers
)->cdr
;
3057 if (!NILP (idle_timers
))
3059 timer
= XCONS (idle_timers
)->car
;
3060 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3062 idle_timers
= XCONS (idle_timers
)->cdr
;
3065 vector
= XVECTOR (timer
)->contents
;
3067 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3068 || !INTEGERP (vector
[3])
3069 || ! NILP (vector
[0]))
3071 idle_timers
= XCONS (idle_timers
)->cdr
;
3076 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3077 based on the next ordinary timer.
3078 TIMER_DIFFERENCE is the distance in time from NOW to when
3079 this timer becomes ripe (negative if it's already ripe). */
3082 timer
= XCONS (timers
)->car
;
3083 vector
= XVECTOR (timer
)->contents
;
3084 EMACS_SET_SECS (timer_time
,
3085 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3086 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3087 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3090 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3091 based on the next idle timer. */
3092 if (!NILP (idle_timers
))
3094 idle_timer
= XCONS (idle_timers
)->car
;
3095 vector
= XVECTOR (idle_timer
)->contents
;
3096 EMACS_SET_SECS (idle_timer_time
,
3097 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3098 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3099 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3102 /* Decide which timer is the next timer,
3103 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3104 Also step down the list where we found that timer. */
3106 if (! NILP (timers
) && ! NILP (idle_timers
))
3109 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3110 if (EMACS_TIME_NEG_P (temp
))
3112 chosen_timer
= timer
;
3113 timers
= XCONS (timers
)->cdr
;
3114 difference
= timer_difference
;
3118 chosen_timer
= idle_timer
;
3119 idle_timers
= XCONS (idle_timers
)->cdr
;
3120 difference
= idle_timer_difference
;
3123 else if (! NILP (timers
))
3125 chosen_timer
= timer
;
3126 timers
= XCONS (timers
)->cdr
;
3127 difference
= timer_difference
;
3131 chosen_timer
= idle_timer
;
3132 idle_timers
= XCONS (idle_timers
)->cdr
;
3133 difference
= idle_timer_difference
;
3135 vector
= XVECTOR (chosen_timer
)->contents
;
3137 /* If timer is rupe, run it if it hasn't been run. */
3138 if (EMACS_TIME_NEG_P (difference
)
3139 || (EMACS_SECS (difference
) == 0
3140 && EMACS_USECS (difference
) == 0))
3142 if (NILP (vector
[0]))
3145 int was_locked
= single_kboard
;
3146 int count
= specpdl_ptr
- specpdl
;
3148 /* Mark the timer as triggered to prevent problems if the lisp
3149 code fails to reschedule it right. */
3152 specbind (Qinhibit_quit
, Qt
);
3154 call1 (Qtimer_event_handler
, chosen_timer
);
3157 unbind_to (count
, Qnil
);
3159 /* Resume allowing input from any kboard, if that was true before. */
3161 any_kboard_state ();
3163 /* Since we have handled the event,
3164 we don't need to tell the caller to wake up and do it. */
3168 /* When we encounter a timer that is still waiting,
3169 return the amount of time to wait before it is ripe. */
3176 /* No timers are pending in the future. */
3177 /* Return 0 if we generated an event, and -1 if not. */
3182 /* Caches for modify_event_symbol. */
3183 static Lisp_Object accent_key_syms
;
3184 static Lisp_Object func_key_syms
;
3185 static Lisp_Object mouse_syms
;
3187 /* This is a list of keysym codes for special "accent" characters.
3188 It parallels lispy_accent_keys. */
3190 static int lispy_accent_codes
[] =
3192 #ifdef XK_dead_circumflex
3197 #ifdef XK_dead_grave
3202 #ifdef XK_dead_tilde
3207 #ifdef XK_dead_diaeresis
3212 #ifdef XK_dead_macron
3217 #ifdef XK_dead_degree
3222 #ifdef XK_dead_acute
3227 #ifdef XK_dead_cedilla
3232 #ifdef XK_dead_breve
3237 #ifdef XK_dead_ogonek
3242 #ifdef XK_dead_caron
3247 #ifdef XK_dead_doubleacute
3248 XK_dead_doubleacute
,
3252 #ifdef XK_dead_abovedot
3259 /* This is a list of Lisp names for special "accent" characters.
3260 It parallels lispy_accent_codes. */
3262 static char *lispy_accent_keys
[] =
3280 #define FUNCTION_KEY_OFFSET 0x0
3282 char *lispy_function_keys
[] =
3286 0, /* VK_LBUTTON 0x01 */
3287 0, /* VK_RBUTTON 0x02 */
3288 "cancel", /* VK_CANCEL 0x03 */
3289 0, /* VK_MBUTTON 0x04 */
3291 0, 0, 0, /* 0x05 .. 0x07 */
3293 "backspace", /* VK_BACK 0x08 */
3294 "tab", /* VK_TAB 0x09 */
3296 0, 0, /* 0x0A .. 0x0B */
3298 "clear", /* VK_CLEAR 0x0C */
3299 "return", /* VK_RETURN 0x0D */
3301 0, 0, /* 0x0E .. 0x0F */
3303 "shift", /* VK_SHIFT 0x10 */
3304 "control", /* VK_CONTROL 0x11 */
3305 "menu", /* VK_MENU 0x12 */
3306 "pause", /* VK_PAUSE 0x13 */
3307 "capital", /* VK_CAPITAL 0x14 */
3309 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3311 0, /* VK_ESCAPE 0x1B */
3313 0, 0, 0, 0, /* 0x1C .. 0x1F */
3315 0, /* VK_SPACE 0x20 */
3316 "prior", /* VK_PRIOR 0x21 */
3317 "next", /* VK_NEXT 0x22 */
3318 "end", /* VK_END 0x23 */
3319 "home", /* VK_HOME 0x24 */
3320 "left", /* VK_LEFT 0x25 */
3321 "up", /* VK_UP 0x26 */
3322 "right", /* VK_RIGHT 0x27 */
3323 "down", /* VK_DOWN 0x28 */
3324 "select", /* VK_SELECT 0x29 */
3325 "print", /* VK_PRINT 0x2A */
3326 "execute", /* VK_EXECUTE 0x2B */
3327 "snapshot", /* VK_SNAPSHOT 0x2C */
3328 "insert", /* VK_INSERT 0x2D */
3329 "delete", /* VK_DELETE 0x2E */
3330 "help", /* VK_HELP 0x2F */
3332 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3334 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3336 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3338 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3340 0, 0, 0, 0, 0, 0, 0, 0, 0,
3341 0, 0, 0, 0, 0, 0, 0, 0, 0,
3342 0, 0, 0, 0, 0, 0, 0, 0,
3344 "lwindow", /* VK_LWIN 0x5B */
3345 "rwindow", /* VK_RWIN 0x5C */
3346 "apps", /* VK_APPS 0x5D */
3348 0, 0, /* 0x5E .. 0x5F */
3350 "kp-0", /* VK_NUMPAD0 0x60 */
3351 "kp-1", /* VK_NUMPAD1 0x61 */
3352 "kp-2", /* VK_NUMPAD2 0x62 */
3353 "kp-3", /* VK_NUMPAD3 0x63 */
3354 "kp-4", /* VK_NUMPAD4 0x64 */
3355 "kp-5", /* VK_NUMPAD5 0x65 */
3356 "kp-6", /* VK_NUMPAD6 0x66 */
3357 "kp-7", /* VK_NUMPAD7 0x67 */
3358 "kp-8", /* VK_NUMPAD8 0x68 */
3359 "kp-9", /* VK_NUMPAD9 0x69 */
3360 "kp-multiply", /* VK_MULTIPLY 0x6A */
3361 "kp-add", /* VK_ADD 0x6B */
3362 "kp-separator", /* VK_SEPARATOR 0x6C */
3363 "kp-subtract", /* VK_SUBTRACT 0x6D */
3364 "kp-decimal", /* VK_DECIMAL 0x6E */
3365 "kp-divide", /* VK_DIVIDE 0x6F */
3366 "f1", /* VK_F1 0x70 */
3367 "f2", /* VK_F2 0x71 */
3368 "f3", /* VK_F3 0x72 */
3369 "f4", /* VK_F4 0x73 */
3370 "f5", /* VK_F5 0x74 */
3371 "f6", /* VK_F6 0x75 */
3372 "f7", /* VK_F7 0x76 */
3373 "f8", /* VK_F8 0x77 */
3374 "f9", /* VK_F9 0x78 */
3375 "f10", /* VK_F10 0x79 */
3376 "f11", /* VK_F11 0x7A */
3377 "f12", /* VK_F12 0x7B */
3378 "f13", /* VK_F13 0x7C */
3379 "f14", /* VK_F14 0x7D */
3380 "f15", /* VK_F15 0x7E */
3381 "f16", /* VK_F16 0x7F */
3382 "f17", /* VK_F17 0x80 */
3383 "f18", /* VK_F18 0x81 */
3384 "f19", /* VK_F19 0x82 */
3385 "f20", /* VK_F20 0x83 */
3386 "f21", /* VK_F21 0x84 */
3387 "f22", /* VK_F22 0x85 */
3388 "f23", /* VK_F23 0x86 */
3389 "f24", /* VK_F24 0x87 */
3391 0, 0, 0, 0, /* 0x88 .. 0x8B */
3392 0, 0, 0, 0, /* 0x8C .. 0x8F */
3394 "kp-numlock", /* VK_NUMLOCK 0x90 */
3395 "scroll", /* VK_SCROLL 0x91 */
3397 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3398 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3399 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3400 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3401 "kp-end", /* VK_NUMPAD_END 0x96 */
3402 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3403 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3404 "kp-up", /* VK_NUMPAD_UP 0x99 */
3405 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3406 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3407 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3408 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3410 0, 0, /* 0x9E .. 0x9F */
3413 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3414 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3415 * No other API or message will distinguish left and right keys this way.
3419 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3420 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3421 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3422 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3423 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3429 "attn", /* VK_ATTN 0xF6 */
3430 "crsel", /* VK_CRSEL 0xF7 */
3431 "exsel", /* VK_EXSEL 0xF8 */
3432 "ereof", /* VK_EREOF 0xF9 */
3433 "play", /* VK_PLAY 0xFA */
3434 "zoom", /* VK_ZOOM 0xFB */
3435 "noname", /* VK_NONAME 0xFC */
3436 "pa1", /* VK_PA1 0xFD */
3437 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3440 #else /* not HAVE_NTGUI */
3443 static char *lispy_kana_keys
[] =
3445 /* X Keysym value */
3446 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3447 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3448 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3449 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3450 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3451 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3452 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3453 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3454 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3455 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3456 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3457 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3458 "kana-i", "kana-u", "kana-e", "kana-o",
3459 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3460 "prolongedsound", "kana-A", "kana-I", "kana-U",
3461 "kana-E", "kana-O", "kana-KA", "kana-KI",
3462 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3463 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3464 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3465 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3466 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3467 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3468 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3469 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3470 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3471 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3472 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3473 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3475 #endif /* XK_kana_A */
3477 #define FUNCTION_KEY_OFFSET 0xff00
3479 /* You'll notice that this table is arranged to be conveniently
3480 indexed by X Windows keysym values. */
3481 static char *lispy_function_keys
[] =
3483 /* X Keysym value */
3485 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3493 0, 0, 0, /* 0xff10 */
3495 0, 0, 0, 0, 0, 0, 0,
3498 0, "kanji", "muhenkan",
3499 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3500 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3501 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3503 "home", /* 0xff50 */ /* IsCursorKey */
3514 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3525 "break", /* 0xff6b */
3527 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3529 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3530 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3531 0, 0, 0, 0, 0, 0, 0, 0,
3532 "kp-tab", /* 0xff89 */
3534 "kp-enter", /* 0xff8d */
3536 "kp-f1", /* 0xff91 */
3540 "kp-home", /* 0xff95 */
3545 "kp-prior", /* kp-page-up */
3546 "kp-next", /* kp-page-down */
3552 0, 0, 0, 0, 0, 0, 0, 0, 0,
3553 "kp-multiply", /* 0xffaa */
3558 "kp-divide", /* 0xffaf */
3559 "kp-0", /* 0xffb0 */
3560 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3563 "kp-equal", /* 0xffbd */
3564 "f1", /* 0xffbe */ /* IsFunctionKey */
3566 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3567 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3568 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3569 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3570 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3571 0, 0, 0, 0, 0, 0, 0, 0,
3572 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3573 0, 0, 0, 0, 0, 0, 0, "delete"
3576 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3577 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3579 static char *iso_lispy_function_keys
[] =
3581 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3582 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3583 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3584 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3585 "iso-lefttab", /* 0xfe20 */
3586 "iso-move-line-up", "iso-move-line-down",
3587 "iso-partial-line-up", "iso-partial-line-down",
3588 "iso-partial-space-left", "iso-partial-space-right",
3589 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3590 "iso-release-margin-left", "iso-release-margin-right",
3591 "iso-release-both-margins",
3592 "iso-fast-cursor-left", "iso-fast-cursor-right",
3593 "iso-fast-cursor-up", "iso-fast-cursor-down",
3594 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3595 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3598 #endif /* not HAVE_NTGUI */
3600 static char *lispy_mouse_names
[] =
3602 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3605 /* Scroll bar parts. */
3606 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3607 Lisp_Object Qup
, Qdown
;
3609 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3610 Lisp_Object
*scroll_bar_parts
[] = {
3611 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3616 /* A vector, indexed by button number, giving the down-going location
3617 of currently depressed buttons, both scroll bar and non-scroll bar.
3619 The elements have the form
3620 (BUTTON-NUMBER MODIFIER-MASK . REST)
3621 where REST is the cdr of a position as it would be reported in the event.
3623 The make_lispy_event function stores positions here to tell the
3624 difference between click and drag events, and to store the starting
3625 location to be included in drag events. */
3627 static Lisp_Object button_down_location
;
3629 /* Information about the most recent up-going button event: Which
3630 button, what location, and what time. */
3632 static int last_mouse_button
;
3633 static int last_mouse_x
;
3634 static int last_mouse_y
;
3635 static unsigned long button_down_time
;
3637 /* The maximum time between clicks to make a double-click,
3638 or Qnil to disable double-click detection,
3639 or Qt for no time limit. */
3640 Lisp_Object Vdouble_click_time
;
3642 /* The number of clicks in this multiple-click. */
3644 int double_click_count
;
3646 /* Given a struct input_event, build the lisp event which represents
3647 it. If EVENT is 0, build a mouse movement event from the mouse
3648 movement buffer, which should have a movement event in it.
3650 Note that events must be passed to this function in the order they
3651 are received; this function stores the location of button presses
3652 in order to build drag events when the button is released. */
3655 make_lispy_event (event
)
3656 struct input_event
*event
;
3660 switch (SWITCH_ENUM_CAST (event
->kind
))
3662 /* A simple keystroke. */
3663 case ascii_keystroke
:
3665 Lisp_Object lispy_c
;
3666 int c
= event
->code
& 0377;
3667 /* Turn ASCII characters into control characters
3669 if (event
->modifiers
& ctrl_modifier
)
3670 c
= make_ctrl_char (c
);
3672 /* Add in the other modifier bits. We took care of ctrl_modifier
3673 just above, and the shift key was taken care of by the X code,
3674 and applied to control characters by make_ctrl_char. */
3675 c
|= (event
->modifiers
3676 & (meta_modifier
| alt_modifier
3677 | hyper_modifier
| super_modifier
));
3678 button_down_time
= 0;
3679 XSETFASTINT (lispy_c
, c
);
3683 /* A function key. The symbol may need to have modifier prefixes
3685 case non_ascii_keystroke
:
3686 button_down_time
= 0;
3688 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3689 if (event
->code
== lispy_accent_codes
[i
])
3690 return modify_event_symbol (i
,
3692 Qfunction_key
, Qnil
,
3693 lispy_accent_keys
, &accent_key_syms
,
3694 (sizeof (lispy_accent_keys
)
3695 / sizeof (lispy_accent_keys
[0])));
3697 /* Handle system-specific keysyms. */
3698 if (event
->code
& (1 << 28))
3700 /* We need to use an alist rather than a vector as the cache
3701 since we can't make a vector long enuf. */
3702 if (NILP (current_kboard
->system_key_syms
))
3703 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3704 return modify_event_symbol (event
->code
,
3707 current_kboard
->Vsystem_key_alist
,
3708 0, ¤t_kboard
->system_key_syms
,
3713 if (event
->code
>= 0x400 && event
->code
< 0x500)
3714 return modify_event_symbol (event
->code
- 0x400,
3715 event
->modifiers
& ~shift_modifier
,
3716 Qfunction_key
, Qnil
,
3717 lispy_kana_keys
, &func_key_syms
,
3718 (sizeof (lispy_kana_keys
)
3719 / sizeof (lispy_kana_keys
[0])));
3720 #endif /* XK_kana_A */
3722 if (event
->code
< FUNCTION_KEY_OFFSET
3723 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
3724 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
3726 Qfunction_key
, Qnil
,
3727 iso_lispy_function_keys
, &func_key_syms
,
3728 (sizeof (iso_lispy_function_keys
)
3729 / sizeof (iso_lispy_function_keys
[0])));
3731 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3733 Qfunction_key
, Qnil
,
3734 lispy_function_keys
, &func_key_syms
,
3735 (sizeof (lispy_function_keys
)
3736 / sizeof (lispy_function_keys
[0])));
3739 /* A mouse click. Figure out where it is, decide whether it's
3740 a press, click or drag, and build the appropriate structure. */
3742 case scroll_bar_click
:
3744 int button
= event
->code
;
3746 Lisp_Object position
;
3747 Lisp_Object
*start_pos_ptr
;
3748 Lisp_Object start_pos
;
3750 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3753 /* Build the position as appropriate for this mouse click. */
3754 if (event
->kind
== mouse_click
)
3757 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3762 /* Ignore mouse events that were made on frame that
3763 have been deleted. */
3764 if (! FRAME_LIVE_P (f
))
3767 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3768 &column
, &row
, NULL
, 1);
3770 #ifndef USE_X_TOOLKIT
3771 /* In the non-toolkit version, clicks on the menu bar
3772 are ordinary button events in the event buffer.
3773 Distinguish them, and invoke the menu.
3775 (In the toolkit version, the toolkit handles the menu bar
3776 and Emacs doesn't know about it until after the user
3777 makes a selection.) */
3778 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3779 && (event
->modifiers
& down_modifier
))
3781 Lisp_Object items
, item
;
3786 /* Activate the menu bar on the down event. If the
3787 up event comes in before the menu code can deal with it,
3789 if (! (event
->modifiers
& down_modifier
))
3794 items
= FRAME_MENU_BAR_ITEMS (f
);
3795 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3797 Lisp_Object pos
, string
;
3798 string
= XVECTOR (items
)->contents
[i
+ 1];
3799 pos
= XVECTOR (items
)->contents
[i
+ 3];
3802 if (column
>= XINT (pos
)
3803 && column
< XINT (pos
) + XSTRING (string
)->size
)
3805 item
= XVECTOR (items
)->contents
[i
];
3811 = Fcons (event
->frame_or_window
,
3813 Fcons (Fcons (event
->x
, event
->y
),
3814 Fcons (make_number (event
->timestamp
),
3817 return Fcons (item
, Fcons (position
, Qnil
));
3819 #endif /* not USE_X_TOOLKIT */
3821 window
= window_from_coordinates (f
, column
, row
, &part
);
3823 if (!WINDOWP (window
))
3825 window
= event
->frame_or_window
;
3830 int pixcolumn
, pixrow
;
3831 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3832 row
-= XINT (XWINDOW (window
)->top
);
3833 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3834 XSETINT (event
->x
, pixcolumn
);
3835 XSETINT (event
->y
, pixrow
);
3840 posn
= Qvertical_line
;
3843 buffer_posn_from_coords (XWINDOW (window
),
3850 Fcons (Fcons (event
->x
, event
->y
),
3851 Fcons (make_number (event
->timestamp
),
3857 Lisp_Object portion_whole
;
3860 window
= event
->frame_or_window
;
3861 portion_whole
= Fcons (event
->x
, event
->y
);
3862 part
= *scroll_bar_parts
[(int) event
->part
];
3866 Fcons (Qvertical_scroll_bar
,
3867 Fcons (portion_whole
,
3868 Fcons (make_number (event
->timestamp
),
3869 Fcons (part
, Qnil
)))));
3872 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3874 start_pos
= *start_pos_ptr
;
3875 *start_pos_ptr
= Qnil
;
3877 is_double
= (button
== last_mouse_button
3878 && XINT (event
->x
) == last_mouse_x
3879 && XINT (event
->y
) == last_mouse_y
3880 && button_down_time
!= 0
3881 && (EQ (Vdouble_click_time
, Qt
)
3882 || (INTEGERP (Vdouble_click_time
)
3883 && ((int)(event
->timestamp
- button_down_time
)
3884 < XINT (Vdouble_click_time
)))));
3885 last_mouse_button
= button
;
3886 last_mouse_x
= XINT (event
->x
);
3887 last_mouse_y
= XINT (event
->y
);
3889 /* If this is a button press, squirrel away the location, so
3890 we can decide later whether it was a click or a drag. */
3891 if (event
->modifiers
& down_modifier
)
3895 double_click_count
++;
3896 event
->modifiers
|= ((double_click_count
> 2)
3901 double_click_count
= 1;
3902 button_down_time
= event
->timestamp
;
3903 *start_pos_ptr
= Fcopy_alist (position
);
3906 /* Now we're releasing a button - check the co-ordinates to
3907 see if this was a click or a drag. */
3908 else if (event
->modifiers
& up_modifier
)
3910 /* If we did not see a down before this up,
3911 ignore the up. Probably this happened because
3912 the down event chose a menu item.
3913 It would be an annoyance to treat the release
3914 of the button that chose the menu item
3915 as a separate event. */
3917 if (!CONSP (start_pos
))
3920 event
->modifiers
&= ~up_modifier
;
3921 #if 0 /* Formerly we treated an up with no down as a click event. */
3922 if (!CONSP (start_pos
))
3923 event
->modifiers
|= click_modifier
;
3927 /* The third element of every position should be the (x,y)
3931 down
= Fnth (make_number (2), start_pos
);
3932 if (EQ (event
->x
, XCONS (down
)->car
)
3933 && EQ (event
->y
, XCONS (down
)->cdr
))
3935 event
->modifiers
|= click_modifier
;
3939 button_down_time
= 0;
3940 event
->modifiers
|= drag_modifier
;
3942 /* Don't check is_double; treat this as multiple
3943 if the down-event was multiple. */
3944 if (double_click_count
> 1)
3945 event
->modifiers
|= ((double_click_count
> 2)
3951 /* Every mouse event should either have the down_modifier or
3952 the up_modifier set. */
3956 /* Get the symbol we should use for the mouse click. */
3959 head
= modify_event_symbol (button
,
3962 lispy_mouse_names
, &mouse_syms
,
3963 (sizeof (lispy_mouse_names
)
3964 / sizeof (lispy_mouse_names
[0])));
3965 if (event
->modifiers
& drag_modifier
)
3970 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
3973 Fcons (make_number (double_click_count
),
3983 case w32_scroll_bar_click
:
3985 int button
= event
->code
;
3987 Lisp_Object position
;
3988 Lisp_Object
*start_pos_ptr
;
3989 Lisp_Object start_pos
;
3991 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3996 Lisp_Object portion_whole
;
3999 window
= event
->frame_or_window
;
4000 portion_whole
= Fcons (event
->x
, event
->y
);
4001 part
= *scroll_bar_parts
[(int) event
->part
];
4005 Fcons (Qvertical_scroll_bar
,
4006 Fcons (portion_whole
,
4007 Fcons (make_number (event
->timestamp
),
4008 Fcons (part
, Qnil
)))));
4011 /* Always treat W32 scroll bar events as clicks. */
4012 event
->modifiers
|= click_modifier
;
4015 /* Get the symbol we should use for the mouse click. */
4018 head
= modify_event_symbol (button
,
4021 lispy_mouse_names
, &mouse_syms
,
4022 (sizeof (lispy_mouse_names
)
4023 / sizeof (lispy_mouse_names
[0])));
4031 #endif /* HAVE_MOUSE */
4033 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4034 case menu_bar_event
:
4035 /* The event value is in the cdr of the frame_or_window slot. */
4036 if (!CONSP (event
->frame_or_window
))
4038 return XCONS (event
->frame_or_window
)->cdr
;
4041 /* The 'kind' field of the event is something we don't recognize. */
4050 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4052 Lisp_Object bar_window
;
4053 enum scroll_bar_part part
;
4057 /* Is it a scroll bar movement? */
4058 if (frame
&& ! NILP (bar_window
))
4060 Lisp_Object part_sym
;
4062 part_sym
= *scroll_bar_parts
[(int) part
];
4063 return Fcons (Qscroll_bar_movement
,
4064 (Fcons (Fcons (bar_window
,
4065 Fcons (Qvertical_scroll_bar
,
4066 Fcons (Fcons (x
, y
),
4067 Fcons (make_number (time
),
4073 /* Or is it an ordinary mouse movement? */
4083 /* It's in a frame; which window on that frame? */
4084 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4086 window
= window_from_coordinates (frame
, column
, row
, &area
);
4091 if (WINDOWP (window
))
4093 int pixcolumn
, pixrow
;
4094 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4095 row
-= XINT (XWINDOW (window
)->top
);
4096 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4097 XSETINT (x
, pixcolumn
);
4098 XSETINT (y
, pixrow
);
4103 posn
= Qvertical_line
;
4106 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4108 else if (frame
!= 0)
4110 XSETFRAME (window
, frame
);
4121 return Fcons (Qmouse_movement
,
4122 Fcons (Fcons (window
,
4124 Fcons (Fcons (x
, y
),
4125 Fcons (make_number (time
),
4131 #endif /* HAVE_MOUSE */
4133 /* Construct a switch frame event. */
4135 make_lispy_switch_frame (frame
)
4138 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4141 /* Manipulating modifiers. */
4143 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4145 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4146 SYMBOL's name of the end of the modifiers; the string from this
4147 position is the unmodified symbol name.
4149 This doesn't use any caches. */
4152 parse_modifiers_uncached (symbol
, modifier_end
)
4156 struct Lisp_String
*name
;
4160 CHECK_SYMBOL (symbol
, 1);
4163 name
= XSYMBOL (symbol
)->name
;
4165 for (i
= 0; i
+2 <= name
->size
; )
4167 int this_mod_end
= 0;
4170 /* See if the name continues with a modifier word.
4171 Check that the word appears, but don't check what follows it.
4172 Set this_mod and this_mod_end to record what we find. */
4174 switch (name
->data
[i
])
4176 #define SINGLE_LETTER_MOD(BIT) \
4177 (this_mod_end = i + 1, this_mod = BIT)
4180 SINGLE_LETTER_MOD (alt_modifier
);
4184 SINGLE_LETTER_MOD (ctrl_modifier
);
4188 SINGLE_LETTER_MOD (hyper_modifier
);
4192 SINGLE_LETTER_MOD (meta_modifier
);
4196 SINGLE_LETTER_MOD (shift_modifier
);
4200 SINGLE_LETTER_MOD (super_modifier
);
4203 #undef SINGLE_LETTER_MOD
4206 /* If we found no modifier, stop looking for them. */
4207 if (this_mod_end
== 0)
4210 /* Check there is a dash after the modifier, so that it
4211 really is a modifier. */
4212 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
4215 /* This modifier is real; look for another. */
4216 modifiers
|= this_mod
;
4217 i
= this_mod_end
+ 1;
4220 /* Should we include the `click' modifier? */
4221 if (! (modifiers
& (down_modifier
| drag_modifier
4222 | double_modifier
| triple_modifier
))
4223 && i
+ 7 == name
->size
4224 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4225 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4226 modifiers
|= click_modifier
;
4234 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4235 prepended to the string BASE[0..BASE_LEN-1].
4236 This doesn't use any caches. */
4238 apply_modifiers_uncached (modifiers
, base
, base_len
)
4243 /* Since BASE could contain nulls, we can't use intern here; we have
4244 to use Fintern, which expects a genuine Lisp_String, and keeps a
4247 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4253 /* Only the event queue may use the `up' modifier; it should always
4254 be turned into a click or drag event before presented to lisp code. */
4255 if (modifiers
& up_modifier
)
4258 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4259 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4260 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4261 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4262 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4263 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4264 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4265 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4266 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4267 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4268 /* The click modifier is denoted by the absence of other modifiers. */
4272 mod_len
= p
- new_mods
;
4276 Lisp_Object new_name
;
4278 new_name
= make_uninit_string (mod_len
+ base_len
);
4279 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4280 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
4282 return Fintern (new_name
, Qnil
);
4287 static char *modifier_names
[] =
4289 "up", "down", "drag", "click", "double", "triple", 0, 0,
4290 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4291 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4293 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4295 static Lisp_Object modifier_symbols
;
4297 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4299 lispy_modifier_list (modifiers
)
4302 Lisp_Object modifier_list
;
4305 modifier_list
= Qnil
;
4306 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4307 if (modifiers
& (1<<i
))
4308 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4311 return modifier_list
;
4315 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4316 where UNMODIFIED is the unmodified form of SYMBOL,
4317 MASK is the set of modifiers present in SYMBOL's name.
4318 This is similar to parse_modifiers_uncached, but uses the cache in
4319 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4320 Qevent_symbol_elements property. */
4323 parse_modifiers (symbol
)
4326 Lisp_Object elements
;
4328 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4329 if (CONSP (elements
))
4334 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4335 Lisp_Object unmodified
;
4338 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4339 XSYMBOL (symbol
)->name
->size
- end
),
4342 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4344 XSETFASTINT (mask
, modifiers
);
4345 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4347 /* Cache the parsing results on SYMBOL. */
4348 Fput (symbol
, Qevent_symbol_element_mask
,
4350 Fput (symbol
, Qevent_symbol_elements
,
4351 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4353 /* Since we know that SYMBOL is modifiers applied to unmodified,
4354 it would be nice to put that in unmodified's cache.
4355 But we can't, since we're not sure that parse_modifiers is
4362 /* Apply the modifiers MODIFIERS to the symbol BASE.
4363 BASE must be unmodified.
4365 This is like apply_modifiers_uncached, but uses BASE's
4366 Qmodifier_cache property, if present. It also builds
4367 Qevent_symbol_elements properties, since it has that info anyway.
4369 apply_modifiers copies the value of BASE's Qevent_kind property to
4370 the modified symbol. */
4372 apply_modifiers (modifiers
, base
)
4376 Lisp_Object cache
, index
, entry
, new_symbol
;
4378 /* Mask out upper bits. We don't know where this value's been. */
4379 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4381 /* The click modifier never figures into cache indices. */
4382 cache
= Fget (base
, Qmodifier_cache
);
4383 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4384 entry
= assq_no_quit (index
, cache
);
4387 new_symbol
= XCONS (entry
)->cdr
;
4390 /* We have to create the symbol ourselves. */
4391 new_symbol
= apply_modifiers_uncached (modifiers
,
4392 XSYMBOL (base
)->name
->data
,
4393 XSYMBOL (base
)->name
->size
);
4395 /* Add the new symbol to the base's cache. */
4396 entry
= Fcons (index
, new_symbol
);
4397 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4399 /* We have the parsing info now for free, so add it to the caches. */
4400 XSETFASTINT (index
, modifiers
);
4401 Fput (new_symbol
, Qevent_symbol_element_mask
,
4402 Fcons (base
, Fcons (index
, Qnil
)));
4403 Fput (new_symbol
, Qevent_symbol_elements
,
4404 Fcons (base
, lispy_modifier_list (modifiers
)));
4407 /* Make sure this symbol is of the same kind as BASE.
4409 You'd think we could just set this once and for all when we
4410 intern the symbol above, but reorder_modifiers may call us when
4411 BASE's property isn't set right; we can't assume that just
4412 because it has a Qmodifier_cache property it must have its
4413 Qevent_kind set right as well. */
4414 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4418 kind
= Fget (base
, Qevent_kind
);
4420 Fput (new_symbol
, Qevent_kind
, kind
);
4427 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4428 return a symbol with the modifiers placed in the canonical order.
4429 Canonical order is alphabetical, except for down and drag, which
4430 always come last. The 'click' modifier is never written out.
4432 Fdefine_key calls this to make sure that (for example) C-M-foo
4433 and M-C-foo end up being equivalent in the keymap. */
4436 reorder_modifiers (symbol
)
4439 /* It's hopefully okay to write the code this way, since everything
4440 will soon be in caches, and no consing will be done at all. */
4443 parsed
= parse_modifiers (symbol
);
4444 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4445 XCONS (parsed
)->car
);
4449 /* For handling events, we often want to produce a symbol whose name
4450 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4451 to some base, like the name of a function key or mouse button.
4452 modify_event_symbol produces symbols of this sort.
4454 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4455 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4458 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4459 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4461 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4462 persist between calls to modify_event_symbol that it can use to
4463 store a cache of the symbols it's generated for this NAME_TABLE
4464 before. The object stored there may be a vector or an alist.
4466 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4468 MODIFIERS is a set of modifier bits (as given in struct input_events)
4469 whose prefixes should be applied to the symbol name.
4471 SYMBOL_KIND is the value to be placed in the event_kind property of
4472 the returned symbol.
4474 The symbols we create are supposed to have an
4475 `event-symbol-elements' property, which lists the modifiers present
4476 in the symbol's name. */
4479 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4480 name_table
, symbol_table
, table_size
)
4483 Lisp_Object symbol_kind
;
4484 Lisp_Object name_alist
;
4486 Lisp_Object
*symbol_table
;
4487 unsigned int table_size
;
4490 Lisp_Object symbol_int
;
4492 /* Get rid of the "vendor-specific" bit here. */
4493 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4495 /* Is this a request for a valid symbol? */
4496 if (symbol_num
< 0 || symbol_num
>= table_size
)
4499 if (CONSP (*symbol_table
))
4500 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4502 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4503 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4504 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4505 we've never used that symbol before. */
4508 if (! VECTORP (*symbol_table
)
4509 || XVECTOR (*symbol_table
)->size
!= table_size
)
4513 XSETFASTINT (size
, table_size
);
4514 *symbol_table
= Fmake_vector (size
, Qnil
);
4517 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4520 /* Have we already used this symbol before? */
4523 /* No; let's create it. */
4524 if (!NILP (name_alist
))
4525 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4526 else if (name_table
!= 0 && name_table
[symbol_num
])
4527 value
= intern (name_table
[symbol_num
]);
4529 #ifdef HAVE_WINDOW_SYSTEM
4532 char *name
= x_get_keysym_name (symbol_num
);
4534 value
= intern (name
);
4541 sprintf (buf
, "key-%d", symbol_num
);
4542 value
= intern (buf
);
4545 if (CONSP (*symbol_table
))
4546 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4548 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4550 /* Fill in the cache entries for this symbol; this also
4551 builds the Qevent_symbol_elements property, which the user
4553 apply_modifiers (modifiers
& click_modifier
, value
);
4554 Fput (value
, Qevent_kind
, symbol_kind
);
4557 /* Apply modifiers to that symbol. */
4558 return apply_modifiers (modifiers
, value
);
4561 /* Convert a list that represents an event type,
4562 such as (ctrl meta backspace), into the usual representation of that
4563 event type as a number or a symbol. */
4565 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4566 "Convert the event description list EVENT-DESC to an event type.\n\
4567 EVENT-DESC should contain one base event type (a character or symbol)\n\
4568 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4569 drag, down, double or triple). The base must be last.\n\
4570 The return value is an event type (a character or symbol) which\n\
4571 has the same base event type and all the specified modifiers.")
4573 Lisp_Object event_desc
;
4581 while (CONSP (rest
))
4586 elt
= XCONS (rest
)->car
;
4587 rest
= XCONS (rest
)->cdr
;
4589 /* Given a symbol, see if it is a modifier name. */
4590 if (SYMBOLP (elt
) && CONSP (rest
))
4591 this = parse_solitary_modifier (elt
);
4595 else if (!NILP (base
))
4596 error ("Two bases given in one event");
4602 /* Let the symbol A refer to the character A. */
4603 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4604 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4606 if (INTEGERP (base
))
4608 /* Turn (shift a) into A. */
4609 if ((modifiers
& shift_modifier
) != 0
4610 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4612 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4613 modifiers
&= ~shift_modifier
;
4616 /* Turn (control a) into C-a. */
4617 if (modifiers
& ctrl_modifier
)
4618 return make_number ((modifiers
& ~ctrl_modifier
)
4619 | make_ctrl_char (XINT (base
)));
4621 return make_number (modifiers
| XINT (base
));
4623 else if (SYMBOLP (base
))
4624 return apply_modifiers (modifiers
, base
);
4626 error ("Invalid base event");
4629 /* Try to recognize SYMBOL as a modifier name.
4630 Return the modifier flag bit, or 0 if not recognized. */
4633 parse_solitary_modifier (symbol
)
4636 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4638 switch (name
->data
[0])
4640 #define SINGLE_LETTER_MOD(BIT) \
4641 if (name->size == 1) \
4644 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4645 if (LEN == name->size \
4646 && ! strncmp (name->data, NAME, LEN)) \
4650 SINGLE_LETTER_MOD (alt_modifier
);
4654 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4658 SINGLE_LETTER_MOD (ctrl_modifier
);
4662 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4663 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4667 SINGLE_LETTER_MOD (hyper_modifier
);
4671 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4675 SINGLE_LETTER_MOD (meta_modifier
);
4679 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4683 SINGLE_LETTER_MOD (shift_modifier
);
4687 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4688 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4689 SINGLE_LETTER_MOD (super_modifier
);
4693 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4694 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4695 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4699 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4702 #undef SINGLE_LETTER_MOD
4703 #undef MULTI_LETTER_MOD
4709 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4710 Such a list is not valid as an event,
4711 but it can be a Lucid-style event type list. */
4714 lucid_event_type_list_p (object
)
4719 if (! CONSP (object
))
4722 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4725 elt
= XCONS (tail
)->car
;
4726 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4733 /* Store into *addr a value nonzero if terminal input chars are available.
4734 Serves the purpose of ioctl (0, FIONREAD, addr)
4735 but works even if FIONREAD does not exist.
4736 (In fact, this may actually read some input.)
4738 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4741 get_input_pending (addr
, do_timers_now
)
4745 /* First of all, have we already counted some input? */
4746 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4748 /* If input is being read as it arrives, and we have none, there is none. */
4749 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4752 /* Try to read some input and see how much we get. */
4754 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4757 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4760 gobble_input (expected
)
4765 if (interrupt_input
)
4768 mask
= sigblock (sigmask (SIGIO
));
4769 read_avail_input (expected
);
4773 #ifdef POLL_FOR_INPUT
4774 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4777 mask
= sigblock (sigmask (SIGALRM
));
4778 read_avail_input (expected
);
4784 read_avail_input (expected
);
4788 /* Put a buffer_switch_event in the buffer
4789 so that read_key_sequence will notice the new current buffer. */
4791 record_asynch_buffer_change ()
4793 struct input_event event
;
4796 event
.kind
= buffer_switch_event
;
4797 event
.frame_or_window
= Qnil
;
4800 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4801 The purpose of the event is to make read_key_sequence look up the
4802 keymaps again. If we aren't in read_key_sequence, we don't need one,
4803 and the event could cause trouble by messing up (input-pending-p). */
4804 tem
= Fwaiting_for_user_input_p ();
4808 /* We never need these events if we have no asynchronous subprocesses. */
4812 /* Make sure no interrupt happens while storing the event. */
4814 if (interrupt_input
)
4817 mask
= sigblock (sigmask (SIGIO
));
4818 kbd_buffer_store_event (&event
);
4825 kbd_buffer_store_event (&event
);
4832 /* Read any terminal input already buffered up by the system
4833 into the kbd_buffer, but do not wait.
4835 EXPECTED should be nonzero if the caller knows there is some input.
4837 Except on VMS, all input is read by this function.
4838 If interrupt_input is nonzero, this function MUST be called
4839 only when SIGIO is blocked.
4841 Returns the number of keyboard chars read, or -1 meaning
4842 this is a bad time to try to read input. */
4845 read_avail_input (expected
)
4848 struct input_event buf
[KBD_BUFFER_SIZE
];
4852 if (read_socket_hook
)
4853 /* No need for FIONREAD or fcntl; just say don't wait. */
4854 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
4857 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
4858 the kbd_buffer can really hold. That may prevent loss
4859 of characters on some systems when input is stuffed at us. */
4860 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
4863 /* Determine how many characters we should *try* to read. */
4866 #else /* not WINDOWSNT */
4868 n_to_read
= dos_keysns ();
4871 #else /* not MSDOS */
4873 /* Find out how much input is available. */
4874 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
4875 /* Formerly simply reported no input, but that sometimes led to
4876 a failure of Emacs to terminate.
4877 SIGHUP seems appropriate if we can't reach the terminal. */
4878 /* ??? Is it really right to send the signal just to this process
4879 rather than to the whole process group?
4880 Perhaps on systems with FIONREAD Emacs is alone in its group. */
4881 kill (getpid (), SIGHUP
);
4884 if (n_to_read
> sizeof cbuf
)
4885 n_to_read
= sizeof cbuf
;
4886 #else /* no FIONREAD */
4887 #if defined (USG) || defined (DGUX)
4888 /* Read some input if available, but don't wait. */
4889 n_to_read
= sizeof cbuf
;
4890 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
4895 #endif /* not MSDOS */
4896 #endif /* not WINDOWSNT */
4898 /* Now read; for one reason or another, this will not block.
4899 NREAD is set to the number of chars read. */
4903 cbuf
[0] = dos_keyread ();
4906 nread
= read (input_fd
, cbuf
, n_to_read
);
4908 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
4909 /* The kernel sometimes fails to deliver SIGHUP for ptys.
4910 This looks incorrect, but it isn't, because _BSD causes
4911 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
4912 and that causes a value other than 0 when there is no input. */
4918 /* We used to retry the read if it was interrupted.
4919 But this does the wrong thing when O_NDELAY causes
4920 an EAGAIN error. Does anybody know of a situation
4921 where a retry is actually needed? */
4923 nread
< 0 && (errno
== EAGAIN
4937 #if defined (USG) || defined (DGUX)
4938 fcntl (input_fd
, F_SETFL
, 0);
4939 #endif /* USG or DGUX */
4940 #endif /* no FIONREAD */
4941 for (i
= 0; i
< nread
; i
++)
4943 buf
[i
].kind
= ascii_keystroke
;
4944 buf
[i
].modifiers
= 0;
4945 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
4946 buf
[i
].modifiers
= meta_modifier
;
4950 buf
[i
].code
= cbuf
[i
];
4951 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
4955 /* Scan the chars for C-g and store them in kbd_buffer. */
4956 for (i
= 0; i
< nread
; i
++)
4958 kbd_buffer_store_event (&buf
[i
]);
4959 /* Don't look at input that follows a C-g too closely.
4960 This reduces lossage due to autorepeat on C-g. */
4961 if (buf
[i
].kind
== ascii_keystroke
4962 && buf
[i
].code
== quit_char
)
4968 #endif /* not VMS */
4970 #ifdef SIGIO /* for entire page */
4971 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4974 input_available_signal (signo
)
4977 /* Must preserve main program's value of errno. */
4978 int old_errno
= errno
;
4980 extern int select_alarmed
;
4983 #if defined (USG) && !defined (POSIX_SIGNALS)
4984 /* USG systems forget handlers when they are used;
4985 must reestablish each time */
4986 signal (signo
, input_available_signal
);
4993 if (input_available_clear_time
)
4994 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
4999 nread
= read_avail_input (1);
5000 /* -1 means it's not ok to read the input now.
5001 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5002 0 means there was no keyboard input available. */
5007 select_alarmed
= 1; /* Force the select emulator back to life */
5018 /* Send ourselves a SIGIO.
5020 This function exists so that the UNBLOCK_INPUT macro in
5021 blockinput.h can have some way to take care of input we put off
5022 dealing with, without assuming that every file which uses
5023 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5025 reinvoke_input_signal ()
5028 kill (getpid (), SIGIO
);
5034 /* Return the prompt-string of a sparse keymap.
5035 This is the first element which is a string.
5036 Return nil if there is none. */
5044 register Lisp_Object tem
;
5053 static void menu_bar_item ();
5054 static void menu_bar_one_keymap ();
5056 /* These variables hold the vector under construction within
5057 menu_bar_items and its subroutines, and the current index
5058 for storing into that vector. */
5059 static Lisp_Object menu_bar_items_vector
;
5060 static int menu_bar_items_index
;
5062 /* Return a vector of menu items for a menu bar, appropriate
5063 to the current buffer. Each item has three elements in the vector:
5066 OLD is an old vector we can optionally reuse, or nil. */
5069 menu_bar_items (old
)
5072 /* The number of keymaps we're scanning right now, and the number of
5073 keymaps we have allocated space for. */
5076 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5077 in the current keymaps, or nil where it is not a prefix. */
5080 Lisp_Object def
, tem
, tail
;
5089 struct gcpro gcpro1
;
5091 /* In order to build the menus, we need to call the keymap
5092 accessors. They all call QUIT. But this function is called
5093 during redisplay, during which a quit is fatal. So inhibit
5094 quitting while building the menus.
5095 We do this instead of specbind because (1) errors will clear it anyway
5096 and (2) this avoids risk of specpdl overflow. */
5097 oquit
= Vinhibit_quit
;
5101 menu_bar_items_vector
= old
;
5103 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5104 menu_bar_items_index
= 0;
5106 GCPRO1 (menu_bar_items_vector
);
5108 /* Build our list of keymaps.
5109 If we recognize a function key and replace its escape sequence in
5110 keybuf with its symbol, or if the sequence starts with a mouse
5111 click and we need to switch buffers, we jump back here to rebuild
5112 the initial keymaps from the current buffer. */
5116 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5117 if (!NILP (Voverriding_local_map_menu_flag
))
5119 /* Yes, use them (if non-nil) as well as the global map. */
5120 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5122 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5123 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5124 if (!NILP (Voverriding_local_map
))
5125 maps
[nmaps
++] = Voverriding_local_map
;
5129 /* No, so use major and minor mode keymaps. */
5130 nmaps
= current_minor_maps (NULL
, &tmaps
);
5131 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5132 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5133 #ifdef USE_TEXT_PROPERTIES
5134 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5136 maps
[nmaps
++] = current_buffer
->keymap
;
5139 maps
[nmaps
++] = current_global_map
;
5142 /* Look up in each map the dummy prefix key `menu-bar'. */
5146 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5148 if (! NILP (maps
[mapno
]))
5149 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
5153 tem
= Fkeymapp (def
);
5155 menu_bar_one_keymap (def
);
5158 /* Move to the end those items that should be at the end. */
5160 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5163 int end
= menu_bar_items_index
;
5165 for (i
= 0; i
< end
; i
+= 4)
5166 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5168 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5169 /* Move the item at index I to the end,
5170 shifting all the others forward. */
5171 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5172 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5173 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5174 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5176 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5177 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5178 (end
- i
- 4) * sizeof (Lisp_Object
));
5179 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5180 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5181 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5182 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5187 /* Add nil, nil, nil, nil at the end. */
5188 i
= menu_bar_items_index
;
5189 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5192 int newsize
= 2 * i
;
5193 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5194 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5195 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5196 menu_bar_items_vector
= tem
;
5198 /* Add this item. */
5199 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5200 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5201 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5202 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5203 menu_bar_items_index
= i
;
5205 Vinhibit_quit
= oquit
;
5207 return menu_bar_items_vector
;
5210 /* Scan one map KEYMAP, accumulating any menu items it defines
5211 in menu_bar_items_vector. */
5214 menu_bar_one_keymap (keymap
)
5217 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
5219 /* Loop over all keymap entries that have menu strings. */
5220 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5222 item
= XCONS (tail
)->car
;
5225 key
= XCONS (item
)->car
;
5226 binding
= XCONS (item
)->cdr
;
5227 if (CONSP (binding
))
5229 item_string
= XCONS (binding
)->car
;
5230 if (STRINGP (item_string
))
5231 menu_bar_item (key
, item_string
, Fcdr (binding
));
5233 else if (EQ (binding
, Qundefined
))
5234 menu_bar_item (key
, Qnil
, binding
);
5236 else if (VECTORP (item
))
5238 /* Loop over the char values represented in the vector. */
5239 int len
= XVECTOR (item
)->size
;
5241 for (c
= 0; c
< len
; c
++)
5243 Lisp_Object character
;
5244 XSETFASTINT (character
, c
);
5245 binding
= XVECTOR (item
)->contents
[c
];
5246 if (CONSP (binding
))
5248 item_string
= XCONS (binding
)->car
;
5249 if (STRINGP (item_string
))
5250 menu_bar_item (key
, item_string
, Fcdr (binding
));
5252 else if (EQ (binding
, Qundefined
))
5253 menu_bar_item (key
, Qnil
, binding
);
5259 /* This is used as the handler when calling internal_condition_case_1. */
5262 menu_bar_item_1 (arg
)
5268 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5269 If there's already an item for KEY, add this DEF to it. */
5272 menu_bar_item (key
, item_string
, def
)
5273 Lisp_Object key
, item_string
, def
;
5276 Lisp_Object enabled
;
5279 /* Skip menu-bar equiv keys data. */
5280 if (CONSP (def
) && CONSP (XCONS (def
)->car
))
5281 def
= XCONS (def
)->cdr
;
5283 if (EQ (def
, Qundefined
))
5285 /* If a map has an explicit `undefined' as definition,
5286 discard any previously made menu bar item. */
5288 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5289 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5291 if (menu_bar_items_index
> i
+ 4)
5292 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5293 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5294 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5295 menu_bar_items_index
-= 4;
5299 /* If there's no definition for this key yet,
5300 just ignore `undefined'. */
5304 /* See if this entry is enabled. */
5309 /* No property, or nil, means enable.
5310 Otherwise, enable if value is not nil. */
5311 tem
= Fget (def
, Qmenu_enable
);
5313 /* (condition-case nil (eval tem)
5315 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5319 /* Ignore this item if it's not enabled. */
5323 /* Find any existing item for this KEY. */
5324 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5325 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5328 /* If we did not find this KEY, add it at the end. */
5329 if (i
== menu_bar_items_index
)
5331 /* If vector is too small, get a bigger one. */
5332 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5335 int newsize
= 2 * i
;
5336 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5337 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5338 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5339 menu_bar_items_vector
= tem
;
5341 /* Add this item. */
5342 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5343 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5344 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5345 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5346 menu_bar_items_index
= i
;
5348 /* We did find an item for this KEY. Add DEF to its list of maps. */
5352 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5353 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5357 /* Read a character using menus based on maps in the array MAPS.
5358 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5359 Return t if we displayed a menu but the user rejected it.
5361 PREV_EVENT is the previous input event, or nil if we are reading
5362 the first event of a key sequence.
5364 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5365 if we used a mouse menu to read the input, or zero otherwise. If
5366 USED_MOUSE_MENU is null, we don't dereference it.
5368 The prompting is done based on the prompt-string of the map
5369 and the strings associated with various map elements.
5371 This can be done with X menus or with menus put in the minibuf.
5372 These are done in different ways, depending on how the input will be read.
5373 Menus using X are done after auto-saving in read-char, getting the input
5374 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5375 and do auto-saving in the inner call of read_char. */
5378 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5381 Lisp_Object prev_event
;
5382 int *used_mouse_menu
;
5385 register Lisp_Object name
;
5386 Lisp_Object rest
, vector
;
5388 if (used_mouse_menu
)
5389 *used_mouse_menu
= 0;
5391 /* Use local over global Menu maps */
5393 if (! menu_prompting
)
5396 /* Optionally disregard all but the global map. */
5397 if (inhibit_local_menu_bar_menus
)
5399 maps
+= (nmaps
- 1);
5403 /* Get the menu name from the first map that has one (a prompt string). */
5404 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5406 name
= map_prompt (maps
[mapno
]);
5411 /* If we don't have any menus, just read a character normally. */
5416 /* If we got to this point via a mouse click,
5417 use a real menu for mouse selection. */
5418 if (EVENT_HAS_PARAMETERS (prev_event
)
5419 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5421 /* Display the menu and get the selection. */
5422 Lisp_Object
*realmaps
5423 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5427 /* Use the maps that are not nil. */
5428 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5429 if (!NILP (maps
[mapno
]))
5430 realmaps
[nmaps1
++] = maps
[mapno
];
5432 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5437 record_menu_key (XCONS (value
)->car
);
5439 /* If we got multiple events, unread all but
5441 There is no way to prevent those unread events
5442 from showing up later in last_nonmenu_event.
5443 So turn symbol and integer events into lists,
5444 to indicate that they came from a mouse menu,
5445 so that when present in last_nonmenu_event
5446 they won't confuse things. */
5447 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5448 tem
= XCONS (tem
)->cdr
)
5450 record_menu_key (XCONS (tem
)->car
);
5451 if (SYMBOLP (XCONS (tem
)->car
)
5452 || INTEGERP (XCONS (tem
)->car
))
5454 = Fcons (XCONS (tem
)->car
, Qnil
);
5457 /* If we got more than one event, put all but the first
5458 onto this list to be read later.
5459 Return just the first event now. */
5460 Vunread_command_events
5461 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5462 value
= XCONS (value
)->car
;
5464 else if (NILP (value
))
5466 if (used_mouse_menu
)
5467 *used_mouse_menu
= 1;
5470 #endif /* HAVE_MENUS */
5474 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5475 We make this bigger when necessary, and never free it. */
5476 static char *read_char_minibuf_menu_text
;
5477 /* Size of that buffer. */
5478 static int read_char_minibuf_menu_width
;
5481 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5487 register Lisp_Object name
;
5489 int width
= FRAME_WIDTH (selected_frame
) - 4;
5492 Lisp_Object rest
, vector
;
5495 if (! menu_prompting
)
5498 /* Make sure we have a big enough buffer for the menu text. */
5499 if (read_char_minibuf_menu_text
== 0)
5501 read_char_minibuf_menu_width
= width
+ 4;
5502 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5504 else if (width
+ 4 > read_char_minibuf_menu_width
)
5506 read_char_minibuf_menu_width
= width
+ 4;
5507 read_char_minibuf_menu_text
5508 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5510 menu
= read_char_minibuf_menu_text
;
5512 /* Get the menu name from the first map that has one (a prompt string). */
5513 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5515 name
= map_prompt (maps
[mapno
]);
5520 /* If we don't have any menus, just read a character normally. */
5524 /* Prompt string always starts with map's prompt, and a space. */
5525 strcpy (menu
, XSTRING (name
)->data
);
5526 nlength
= XSTRING (name
)->size
;
5527 menu
[nlength
++] = ':';
5528 menu
[nlength
++] = ' ';
5531 /* Start prompting at start of first map. */
5535 /* Present the documented bindings, a line at a time. */
5542 Lisp_Object orig_defn_macro
;
5544 /* Loop over elements of map. */
5549 /* If reached end of map, start at beginning of next map. */
5553 /* At end of last map, wrap around to first map if just starting,
5554 or end this line if already have something on it. */
5558 if (notfirst
|| nobindings
) break;
5563 /* Look at the next element of the map. */
5565 elt
= XVECTOR (vector
)->contents
[idx
];
5567 elt
= Fcar_safe (rest
);
5569 if (idx
< 0 && VECTORP (elt
))
5571 /* If we found a dense table in the keymap,
5572 advanced past it, but start scanning its contents. */
5573 rest
= Fcdr_safe (rest
);
5579 /* An ordinary element. */
5584 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5585 event
= Fcar_safe (elt
);
5589 s
= Fcar_safe (elt
); /* vector */
5590 XSETINT (event
, idx
);
5593 /* Ignore the element if it has no prompt string. */
5594 if (STRINGP (s
) && INTEGERP (event
))
5596 /* 1 if the char to type matches the string. */
5598 Lisp_Object upcased_event
, downcased_event
;
5601 upcased_event
= Fupcase (event
);
5602 downcased_event
= Fdowncase (event
);
5603 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5604 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5606 desc
= Fsingle_key_description (event
);
5608 /* If we have room for the prompt string, add it to this line.
5609 If this is the first on the line, always add it. */
5610 if ((XSTRING (s
)->size
+ i
+ 2
5611 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5617 /* Punctuate between strings. */
5620 strcpy (menu
+ i
, ", ");
5626 /* If the char to type doesn't match the string's
5627 first char, explicitly show what char to type. */
5630 /* Add as much of string as fits. */
5631 thiswidth
= XSTRING (desc
)->size
;
5632 if (thiswidth
+ i
> width
)
5633 thiswidth
= width
- i
;
5634 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5636 strcpy (menu
+ i
, " = ");
5640 /* Add as much of string as fits. */
5641 thiswidth
= XSTRING (s
)->size
;
5642 if (thiswidth
+ i
> width
)
5643 thiswidth
= width
- i
;
5644 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5650 /* If this element does not fit, end the line now,
5651 and save the element for the next line. */
5652 strcpy (menu
+ i
, "...");
5657 /* Move past this element. */
5658 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5659 /* Handle reaching end of dense table. */
5664 rest
= Fcdr_safe (rest
);
5668 /* Prompt with that and read response. */
5671 /* Make believe its not a keyboard macro in case the help char
5672 is pressed. Help characters are not recorded because menu prompting
5673 is not used on replay.
5675 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5676 current_kboard
->defining_kbd_macro
= Qnil
;
5678 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5679 while (BUFFERP (obj
));
5680 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5682 if (!INTEGERP (obj
))
5687 if (! EQ (obj
, menu_prompt_more_char
)
5688 && (!INTEGERP (menu_prompt_more_char
)
5689 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5691 if (!NILP (current_kboard
->defining_kbd_macro
))
5692 store_kbd_macro_char (obj
);
5695 /* Help char - go round again */
5699 /* Reading key sequences. */
5701 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5702 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5703 keymap, or nil otherwise. Return the index of the first keymap in
5704 which KEY has any binding, or NMAPS if no map has a binding.
5706 If KEY is a meta ASCII character, treat it like meta-prefix-char
5707 followed by the corresponding non-meta character. Keymaps in
5708 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5711 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5714 NEXT may be the same array as CURRENT. */
5717 follow_key (key
, nmaps
, current
, defs
, next
)
5719 Lisp_Object
*current
, *defs
, *next
;
5722 int i
, first_binding
;
5725 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5726 followed by the corresponding non-meta character.
5727 Put the results into DEFS, since we are going to alter that anyway.
5728 Do not alter CURRENT or NEXT. */
5729 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5731 for (i
= 0; i
< nmaps
; i
++)
5732 if (! NILP (current
[i
]))
5735 def
= get_keyelt (access_keymap (current
[i
],
5736 meta_prefix_char
, 1, 0));
5738 /* Note that since we pass the resulting bindings through
5739 get_keymap_1, non-prefix bindings for meta-prefix-char
5741 defs
[i
] = get_keymap_1 (def
, 0, 1);
5747 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5750 first_binding
= nmaps
;
5751 for (i
= nmaps
- 1; i
>= 0; i
--)
5753 if (! NILP (current
[i
]))
5761 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0));
5762 if (! NILP (defs
[i
]))
5769 /* Given the set of bindings we've found, produce the next set of maps. */
5770 if (first_binding
< nmaps
)
5771 for (i
= 0; i
< nmaps
; i
++)
5772 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5774 return first_binding
;
5777 /* Read a sequence of keys that ends with a non prefix character,
5778 storing it in KEYBUF, a buffer of size BUFSIZE.
5780 Return the length of the key sequence stored.
5781 Return -1 if the user rejected a command menu.
5783 Echo starting immediately unless `prompt' is 0.
5785 Where a key sequence ends depends on the currently active keymaps.
5786 These include any minor mode keymaps active in the current buffer,
5787 the current buffer's local map, and the global map.
5789 If a key sequence has no other bindings, we check Vfunction_key_map
5790 to see if some trailing subsequence might be the beginning of a
5791 function key's sequence. If so, we try to read the whole function
5792 key, and substitute its symbolic name into the key sequence.
5794 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5795 `double-' events into similar click events, if that would make them
5796 bound. We try to turn `triple-' events first into `double-' events,
5799 If we get a mouse click in a mode line, vertical divider, or other
5800 non-text area, we treat the click as if it were prefixed by the
5801 symbol denoting that area - `mode-line', `vertical-line', or
5804 If the sequence starts with a mouse click, we read the key sequence
5805 with respect to the buffer clicked on, not the current buffer.
5807 If the user switches frames in the midst of a key sequence, we put
5808 off the switch-frame event until later; the next call to
5809 read_char will return it.
5811 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
5812 from the selected window's buffer. */
5815 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5816 can_return_switch_frame
, fix_current_buffer
)
5817 Lisp_Object
*keybuf
;
5820 int dont_downcase_last
;
5821 int can_return_switch_frame
;
5822 int fix_current_buffer
;
5824 int count
= specpdl_ptr
- specpdl
;
5826 /* How many keys there are in the current key sequence. */
5829 /* The length of the echo buffer when we started reading, and
5830 the length of this_command_keys when we started reading. */
5834 /* The number of keymaps we're scanning right now, and the number of
5835 keymaps we have allocated space for. */
5837 int nmaps_allocated
= 0;
5839 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5840 the current keymaps. */
5843 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5844 in the current keymaps, or nil where it is not a prefix. */
5845 Lisp_Object
*submaps
;
5847 /* The local map to start out with at start of key sequence. */
5848 Lisp_Object orig_local_map
;
5850 /* 1 if we have already considered switching to the local-map property
5851 of the place where a mouse click occurred. */
5852 int localized_local_map
= 0;
5854 /* The index in defs[] of the first keymap that has a binding for
5855 this key sequence. In other words, the lowest i such that
5856 defs[i] is non-nil. */
5859 /* If t < mock_input, then KEYBUF[t] should be read as the next
5862 We use this to recover after recognizing a function key. Once we
5863 realize that a suffix of the current key sequence is actually a
5864 function key's escape sequence, we replace the suffix with the
5865 function key's binding from Vfunction_key_map. Now keybuf
5866 contains a new and different key sequence, so the echo area,
5867 this_command_keys, and the submaps and defs arrays are wrong. In
5868 this situation, we set mock_input to t, set t to 0, and jump to
5869 restart_sequence; the loop will read keys from keybuf up until
5870 mock_input, thus rebuilding the state; and then it will resume
5871 reading characters from the keyboard. */
5874 /* If the sequence is unbound in submaps[], then
5875 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
5876 and fkey_map is its binding.
5878 These might be > t, indicating that all function key scanning
5879 should hold off until t reaches them. We do this when we've just
5880 recognized a function key, to avoid searching for the function
5881 key's again in Vfunction_key_map. */
5882 int fkey_start
= 0, fkey_end
= 0;
5883 Lisp_Object fkey_map
;
5885 /* Likewise, for key_translation_map. */
5886 int keytran_start
= 0, keytran_end
= 0;
5887 Lisp_Object keytran_map
;
5889 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
5890 we put it off for later. While we're reading, we keep the event here. */
5891 Lisp_Object delayed_switch_frame
;
5893 /* See the comment below... */
5894 #if defined (GOBBLE_FIRST_EVENT)
5895 Lisp_Object first_event
;
5898 Lisp_Object original_uppercase
;
5899 int original_uppercase_position
= -1;
5901 /* Gets around Microsoft compiler limitations. */
5904 struct buffer
*starting_buffer
;
5906 /* Nonzero if we seem to have got the beginning of a binding
5907 in function_key_map. */
5908 int function_key_possible
= 0;
5909 int key_translation_possible
= 0;
5911 /* Save the status of key translation before each step,
5912 so that we can restore this after downcasing. */
5913 Lisp_Object prev_fkey_map
;
5914 Lisp_Object prev_fkey_start
;
5915 Lisp_Object prev_fkey_end
;
5917 Lisp_Object prev_keytran_map
;
5918 Lisp_Object prev_keytran_start
;
5919 Lisp_Object prev_keytran_end
;
5923 last_nonmenu_event
= Qnil
;
5925 delayed_switch_frame
= Qnil
;
5926 fkey_map
= Vfunction_key_map
;
5927 keytran_map
= Vkey_translation_map
;
5929 /* If there is no function-key-map, turn off function key scanning. */
5930 if (NILP (Fkeymapp (Vfunction_key_map
)))
5931 fkey_start
= fkey_end
= bufsize
+ 1;
5933 /* If there is no key-translation-map, turn off scanning. */
5934 if (NILP (Fkeymapp (Vkey_translation_map
)))
5935 keytran_start
= keytran_end
= bufsize
+ 1;
5940 echo_prompt (XSTRING (prompt
)->data
);
5941 else if (cursor_in_echo_area
&& echo_keystrokes
)
5942 /* This doesn't put in a dash if the echo buffer is empty, so
5943 you don't always see a dash hanging out in the minibuffer. */
5947 /* Record the initial state of the echo area and this_command_keys;
5948 we will need to restore them if we replay a key sequence. */
5950 echo_start
= echo_length ();
5951 keys_start
= this_command_key_count
;
5952 this_single_command_key_start
= keys_start
;
5954 #if defined (GOBBLE_FIRST_EVENT)
5955 /* This doesn't quite work, because some of the things that read_char
5956 does cannot safely be bypassed. It seems too risky to try to make
5959 /* Read the first char of the sequence specially, before setting
5960 up any keymaps, in case a filter runs and switches buffers on us. */
5961 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
5963 #endif /* GOBBLE_FIRST_EVENT */
5965 orig_local_map
= get_local_map (PT
, current_buffer
);
5967 /* We jump here when the key sequence has been thoroughly changed, and
5968 we need to rescan it starting from the beginning. When we jump here,
5969 keybuf[0..mock_input] holds the sequence we should reread. */
5972 starting_buffer
= current_buffer
;
5973 function_key_possible
= 0;
5974 key_translation_possible
= 0;
5976 /* Build our list of keymaps.
5977 If we recognize a function key and replace its escape sequence in
5978 keybuf with its symbol, or if the sequence starts with a mouse
5979 click and we need to switch buffers, we jump back here to rebuild
5980 the initial keymaps from the current buffer. */
5984 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
5985 || !NILP (Voverriding_local_map
))
5987 if (3 > nmaps_allocated
)
5989 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
5990 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
5991 nmaps_allocated
= 3;
5994 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5995 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5996 if (!NILP (Voverriding_local_map
))
5997 submaps
[nmaps
++] = Voverriding_local_map
;
6001 nmaps
= current_minor_maps (0, &maps
);
6002 if (nmaps
+ 2 > nmaps_allocated
)
6004 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6005 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6006 nmaps_allocated
= nmaps
+ 2;
6008 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6009 #ifdef USE_TEXT_PROPERTIES
6010 submaps
[nmaps
++] = orig_local_map
;
6012 submaps
[nmaps
++] = current_buffer
->keymap
;
6015 submaps
[nmaps
++] = current_global_map
;
6018 /* Find an accurate initial value for first_binding. */
6019 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6020 if (! NILP (submaps
[first_binding
]))
6023 /* Start from the beginning in keybuf. */
6026 /* These are no-ops the first time through, but if we restart, they
6027 revert the echo area and this_command_keys to their original state. */
6028 this_command_key_count
= keys_start
;
6029 if (INTERACTIVE
&& t
< mock_input
)
6030 echo_truncate (echo_start
);
6032 /* If the best binding for the current key sequence is a keymap, or
6033 we may be looking at a function key's escape sequence, keep on
6035 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6036 || (first_binding
>= nmaps
6038 /* mock input is never part of a function key's sequence. */
6039 && mock_input
<= fkey_start
)
6040 || (first_binding
>= nmaps
6041 && keytran_start
< t
&& key_translation_possible
)
6042 /* Don't return in the middle of a possible function key sequence,
6043 if the only bindings we found were via case conversion.
6044 Thus, if ESC O a has a function-key-map translation
6045 and ESC o has a binding, don't return after ESC O,
6046 so that we can translate ESC O plus the next character. */
6050 int used_mouse_menu
= 0;
6052 /* Where the last real key started. If we need to throw away a
6053 key that has expanded into more than one element of keybuf
6054 (say, a mouse click on the mode line which is being treated
6055 as [mode-line (mouse-...)], then we backtrack to this point
6057 int last_real_key_start
;
6059 /* These variables are analogous to echo_start and keys_start;
6060 while those allow us to restart the entire key sequence,
6061 echo_local_start and keys_local_start allow us to throw away
6063 int echo_local_start
, keys_local_start
, local_first_binding
;
6066 error ("Key sequence too long");
6069 echo_local_start
= echo_length ();
6070 keys_local_start
= this_command_key_count
;
6071 local_first_binding
= first_binding
;
6074 /* These are no-ops, unless we throw away a keystroke below and
6075 jumped back up to replay_key; in that case, these restore the
6076 variables to their original state, allowing us to replay the
6078 if (INTERACTIVE
&& t
< mock_input
)
6079 echo_truncate (echo_local_start
);
6080 this_command_key_count
= keys_local_start
;
6081 first_binding
= local_first_binding
;
6083 /* By default, assume each event is "real". */
6084 last_real_key_start
= t
;
6086 /* Does mock_input indicate that we are re-reading a key sequence? */
6090 add_command_key (key
);
6091 if (echo_keystrokes
)
6095 /* If not, we should actually read a character. */
6098 struct buffer
*buf
= current_buffer
;
6102 KBOARD
*interrupted_kboard
= current_kboard
;
6103 struct frame
*interrupted_frame
= selected_frame
;
6104 if (setjmp (wrong_kboard_jmpbuf
))
6106 if (!NILP (delayed_switch_frame
))
6108 interrupted_kboard
->kbd_queue
6109 = Fcons (delayed_switch_frame
,
6110 interrupted_kboard
->kbd_queue
);
6111 delayed_switch_frame
= Qnil
;
6114 interrupted_kboard
->kbd_queue
6115 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6117 /* If the side queue is non-empty, ensure it begins with a
6118 switch-frame, so we'll replay it in the right context. */
6119 if (CONSP (interrupted_kboard
->kbd_queue
)
6120 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6121 !(EVENT_HAS_PARAMETERS (key
)
6122 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6126 XSETFRAME (frame
, interrupted_frame
);
6127 interrupted_kboard
->kbd_queue
6128 = Fcons (make_lispy_switch_frame (frame
),
6129 interrupted_kboard
->kbd_queue
);
6132 orig_local_map
= get_local_map (PT
, current_buffer
);
6133 goto replay_sequence
;
6136 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6140 /* read_char returns t when it shows a menu and the user rejects it.
6145 /* read_char returns -1 at the end of a macro.
6146 Emacs 18 handles this by returning immediately with a
6147 zero, so that's what we'll do. */
6148 if (INTEGERP (key
) && XINT (key
) == -1)
6151 /* The Microsoft C compiler can't handle the goto that
6157 /* If the current buffer has been changed from under us, the
6158 keymap may have changed, so replay the sequence. */
6162 /* Reset the current buffer from the selected window
6163 in case something changed the former and not the latter.
6164 This is to be more consistent with the behavior
6165 of the command_loop_1. */
6166 if (fix_current_buffer
)
6167 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
6168 Fset_buffer (XWINDOW (selected_window
)->buffer
);
6170 orig_local_map
= get_local_map (PT
, current_buffer
);
6171 goto replay_sequence
;
6174 /* If we have a quit that was typed in another frame, and
6175 quit_throw_to_read_char switched buffers,
6176 replay to get the right keymap. */
6177 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6182 orig_local_map
= get_local_map (PT
, current_buffer
);
6183 goto replay_sequence
;
6189 /* Clicks in non-text areas get prefixed by the symbol
6190 in their CHAR-ADDRESS field. For example, a click on
6191 the mode line is prefixed by the symbol `mode-line'.
6193 Furthermore, key sequences beginning with mouse clicks
6194 are read using the keymaps of the buffer clicked on, not
6195 the current buffer. So we may have to switch the buffer
6198 When we turn one event into two events, we must make sure
6199 that neither of the two looks like the original--so that,
6200 if we replay the events, they won't be expanded again.
6201 If not for this, such reexpansion could happen either here
6202 or when user programs play with this-command-keys. */
6203 if (EVENT_HAS_PARAMETERS (key
))
6207 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6208 if (EQ (kind
, Qmouse_click
))
6210 Lisp_Object window
, posn
;
6212 window
= POSN_WINDOW (EVENT_START (key
));
6213 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6216 /* We're looking at the second event of a
6217 sequence which we expanded before. Set
6218 last_real_key_start appropriately. */
6220 last_real_key_start
= t
- 1;
6223 /* Key sequences beginning with mouse clicks are
6224 read using the keymaps in the buffer clicked on,
6225 not the current buffer. If we're at the
6226 beginning of a key sequence, switch buffers. */
6227 if (last_real_key_start
== 0
6229 && BUFFERP (XWINDOW (window
)->buffer
)
6230 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6235 /* Arrange to go back to the original buffer once we're
6236 done reading the key sequence. Note that we can't
6237 use save_excursion_{save,restore} here, because they
6238 save point as well as the current buffer; we don't
6239 want to save point, because redisplay may change it,
6240 to accommodate a Fset_window_start or something. We
6241 don't want to do this at the top of the function,
6242 because we may get input from a subprocess which
6243 wants to change the selected window and stuff (say,
6245 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6247 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6248 orig_local_map
= get_local_map (PT
, current_buffer
);
6249 goto replay_sequence
;
6251 /* For a mouse click, get the local text-property keymap
6252 of the place clicked on, rather than point. */
6253 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6254 && ! localized_local_map
)
6256 Lisp_Object map_here
, start
, pos
;
6258 localized_local_map
= 1;
6259 start
= EVENT_START (key
);
6260 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6262 pos
= POSN_BUFFER_POSN (start
);
6264 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6266 map_here
= get_local_map (XINT (pos
), current_buffer
);
6267 if (!EQ (map_here
, orig_local_map
))
6269 orig_local_map
= map_here
;
6273 goto replay_sequence
;
6279 /* Expand mode-line and scroll-bar events into two events:
6280 use posn as a fake prefix key. */
6283 if (t
+ 1 >= bufsize
)
6284 error ("Key sequence too long");
6289 /* Zap the position in key, so we know that we've
6290 expanded it, and don't try to do so again. */
6291 POSN_BUFFER_POSN (EVENT_START (key
))
6292 = Fcons (posn
, Qnil
);
6296 else if (EQ (kind
, Qswitch_frame
))
6298 /* If we're at the beginning of a key sequence, and the caller
6299 says it's okay, go ahead and return this event. If we're
6300 in the midst of a key sequence, delay it until the end. */
6301 if (t
> 0 || !can_return_switch_frame
)
6303 delayed_switch_frame
= key
;
6307 else if (CONSP (XCONS (key
)->cdr
)
6308 && CONSP (EVENT_START (key
))
6309 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6313 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6314 /* Handle menu-bar events:
6315 insert the dummy prefix event `menu-bar'. */
6316 if (EQ (posn
, Qmenu_bar
))
6318 if (t
+ 1 >= bufsize
)
6319 error ("Key sequence too long");
6323 /* Zap the position in key, so we know that we've
6324 expanded it, and don't try to do so again. */
6325 POSN_BUFFER_POSN (EVENT_START (key
))
6326 = Fcons (posn
, Qnil
);
6329 goto replay_sequence
;
6331 else if (CONSP (posn
))
6333 /* We're looking at the second event of a
6334 sequence which we expanded before. Set
6335 last_real_key_start appropriately. */
6336 if (last_real_key_start
== t
&& t
> 0)
6337 last_real_key_start
= t
- 1;
6342 /* We have finally decided that KEY is something we might want
6344 first_binding
= (follow_key (key
,
6345 nmaps
- first_binding
,
6346 submaps
+ first_binding
,
6347 defs
+ first_binding
,
6348 submaps
+ first_binding
)
6351 /* If KEY wasn't bound, we'll try some fallbacks. */
6352 if (first_binding
>= nmaps
)
6356 head
= EVENT_HEAD (key
);
6357 if (help_char_p (head
) && t
> 0)
6359 read_key_sequence_cmd
= Vprefix_help_command
;
6361 last_nonmenu_event
= key
;
6362 /* The Microsoft C compiler can't handle the goto that
6370 Lisp_Object breakdown
;
6373 breakdown
= parse_modifiers (head
);
6374 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6375 /* Attempt to reduce an unbound mouse event to a simpler
6376 event that is bound:
6377 Drags reduce to clicks.
6378 Double-clicks reduce to clicks.
6379 Triple-clicks reduce to double-clicks, then to clicks.
6380 Down-clicks are eliminated.
6381 Double-downs reduce to downs, then are eliminated.
6382 Triple-downs reduce to double-downs, then to downs,
6383 then are eliminated. */
6384 if (modifiers
& (down_modifier
| drag_modifier
6385 | double_modifier
| triple_modifier
))
6387 while (modifiers
& (down_modifier
| drag_modifier
6388 | double_modifier
| triple_modifier
))
6390 Lisp_Object new_head
, new_click
;
6391 if (modifiers
& triple_modifier
)
6392 modifiers
^= (double_modifier
| triple_modifier
);
6393 else if (modifiers
& double_modifier
)
6394 modifiers
&= ~double_modifier
;
6395 else if (modifiers
& drag_modifier
)
6396 modifiers
&= ~drag_modifier
;
6399 /* Dispose of this `down' event by simply jumping
6400 back to replay_key, to get another event.
6402 Note that if this event came from mock input,
6403 then just jumping back to replay_key will just
6404 hand it to us again. So we have to wipe out any
6407 We could delete keybuf[t] and shift everything
6408 after that to the left by one spot, but we'd also
6409 have to fix up any variable that points into
6410 keybuf, and shifting isn't really necessary
6413 Adding prefixes for non-textual mouse clicks
6414 creates two characters of mock input, and both
6415 must be thrown away. If we're only looking at
6416 the prefix now, we can just jump back to
6417 replay_key. On the other hand, if we've already
6418 processed the prefix, and now the actual click
6419 itself is giving us trouble, then we've lost the
6420 state of the keymaps we want to backtrack to, and
6421 we need to replay the whole sequence to rebuild
6424 Beyond that, only function key expansion could
6425 create more than two keys, but that should never
6426 generate mouse events, so it's okay to zero
6427 mock_input in that case too.
6429 Isn't this just the most wonderful code ever? */
6430 if (t
== last_real_key_start
)
6437 mock_input
= last_real_key_start
;
6438 goto replay_sequence
;
6443 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6445 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6447 /* Look for a binding for this new key. follow_key
6448 promises that it didn't munge submaps the
6449 last time we called it, since key was unbound. */
6451 = (follow_key (new_click
,
6452 nmaps
- local_first_binding
,
6453 submaps
+ local_first_binding
,
6454 defs
+ local_first_binding
,
6455 submaps
+ local_first_binding
)
6456 + local_first_binding
);
6458 /* If that click is bound, go for it. */
6459 if (first_binding
< nmaps
)
6464 /* Otherwise, we'll leave key set to the drag event. */
6471 /* Normally, last_nonmenu_event gets the previous key we read.
6472 But when a mouse popup menu is being used,
6473 we don't update last_nonmenu_event; it continues to hold the mouse
6474 event that preceded the first level of menu. */
6475 if (!used_mouse_menu
)
6476 last_nonmenu_event
= key
;
6478 /* Record what part of this_command_keys is the current key sequence. */
6479 this_single_command_key_start
= this_command_key_count
- t
;
6481 prev_fkey_map
= fkey_map
;
6482 prev_fkey_start
= fkey_start
;
6483 prev_fkey_end
= fkey_end
;
6485 prev_keytran_map
= keytran_map
;
6486 prev_keytran_start
= keytran_start
;
6487 prev_keytran_end
= keytran_end
;
6489 /* If the sequence is unbound, see if we can hang a function key
6490 off the end of it. We only want to scan real keyboard input
6491 for function key sequences, so if mock_input says that we're
6492 re-reading old events, don't examine it. */
6493 if (first_binding
>= nmaps
6496 Lisp_Object fkey_next
;
6498 /* Continue scan from fkey_end until we find a bound suffix.
6499 If we fail, increment fkey_start
6500 and start fkey_end from there. */
6501 while (fkey_end
< t
)
6505 key
= keybuf
[fkey_end
++];
6506 /* Look up meta-characters by prefixing them
6507 with meta_prefix_char. I hate this. */
6508 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6513 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
6515 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6518 fkey_next
= fkey_map
;
6521 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
6523 #if 0 /* I didn't turn this on, because it might cause trouble
6524 for the mapping of return into C-m and tab into C-i. */
6525 /* Optionally don't map function keys into other things.
6526 This enables the user to redefine kp- keys easily. */
6527 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6531 /* If the function key map gives a function, not an
6532 array, then call the function with no args and use
6533 its value instead. */
6534 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6537 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6541 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6542 fkey_next
= call1 (fkey_next
, prompt
);
6544 /* If the function returned something invalid,
6545 barf--don't ignore it.
6546 (To ignore it safely, we would need to gcpro a bunch of
6547 other variables.) */
6548 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6549 error ("Function in key-translation-map returns invalid key sequence");
6552 function_key_possible
= ! NILP (fkey_next
);
6554 /* If keybuf[fkey_start..fkey_end] is bound in the
6555 function key map and it's a suffix of the current
6556 sequence (i.e. fkey_end == t), replace it with
6557 the binding and restart with fkey_start at the end. */
6558 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6561 int len
= XFASTINT (Flength (fkey_next
));
6563 t
= fkey_start
+ len
;
6565 error ("Key sequence too long");
6567 if (VECTORP (fkey_next
))
6568 bcopy (XVECTOR (fkey_next
)->contents
,
6569 keybuf
+ fkey_start
,
6570 (t
- fkey_start
) * sizeof (keybuf
[0]));
6571 else if (STRINGP (fkey_next
))
6575 for (i
= 0; i
< len
; i
++)
6576 XSETFASTINT (keybuf
[fkey_start
+ i
],
6577 XSTRING (fkey_next
)->data
[i
]);
6581 fkey_start
= fkey_end
= t
;
6582 fkey_map
= Vfunction_key_map
;
6584 /* Do pass the results through key-translation-map. */
6585 keytran_start
= keytran_end
= 0;
6586 keytran_map
= Vkey_translation_map
;
6588 goto replay_sequence
;
6591 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6593 /* If we no longer have a bound suffix, try a new positions for
6595 if (NILP (fkey_map
))
6597 fkey_end
= ++fkey_start
;
6598 fkey_map
= Vfunction_key_map
;
6599 function_key_possible
= 0;
6604 /* Look for this sequence in key-translation-map. */
6606 Lisp_Object keytran_next
;
6608 /* Scan from keytran_end until we find a bound suffix. */
6609 while (keytran_end
< t
)
6613 key
= keybuf
[keytran_end
++];
6614 /* Look up meta-characters by prefixing them
6615 with meta_prefix_char. I hate this. */
6616 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6621 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
6623 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6626 keytran_next
= keytran_map
;
6629 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
6631 /* If the key translation map gives a function, not an
6632 array, then call the function with no args and use
6633 its value instead. */
6634 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6635 && keytran_end
== t
)
6637 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6641 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6642 keytran_next
= call1 (keytran_next
, prompt
);
6644 /* If the function returned something invalid,
6645 barf--don't ignore it.
6646 (To ignore it safely, we would need to gcpro a bunch of
6647 other variables.) */
6648 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6649 error ("Function in key-translation-map returns invalid key sequence");
6652 key_translation_possible
= ! NILP (keytran_next
);
6654 /* If keybuf[keytran_start..keytran_end] is bound in the
6655 key translation map and it's a suffix of the current
6656 sequence (i.e. keytran_end == t), replace it with
6657 the binding and restart with keytran_start at the end. */
6658 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6659 && keytran_end
== t
)
6661 int len
= XFASTINT (Flength (keytran_next
));
6663 t
= keytran_start
+ len
;
6665 error ("Key sequence too long");
6667 if (VECTORP (keytran_next
))
6668 bcopy (XVECTOR (keytran_next
)->contents
,
6669 keybuf
+ keytran_start
,
6670 (t
- keytran_start
) * sizeof (keybuf
[0]));
6671 else if (STRINGP (keytran_next
))
6675 for (i
= 0; i
< len
; i
++)
6676 XSETFASTINT (keybuf
[keytran_start
+ i
],
6677 XSTRING (keytran_next
)->data
[i
]);
6681 keytran_start
= keytran_end
= t
;
6682 keytran_map
= Vkey_translation_map
;
6684 /* Don't pass the results of key-translation-map
6685 through function-key-map. */
6686 fkey_start
= fkey_end
= t
;
6687 fkey_map
= Vkey_translation_map
;
6689 goto replay_sequence
;
6692 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6694 /* If we no longer have a bound suffix, try a new positions for
6696 if (NILP (keytran_map
))
6698 keytran_end
= ++keytran_start
;
6699 keytran_map
= Vkey_translation_map
;
6700 key_translation_possible
= 0;
6705 /* If KEY is not defined in any of the keymaps,
6706 and cannot be part of a function key or translation,
6707 and is an upper case letter
6708 use the corresponding lower-case letter instead. */
6709 if (first_binding
== nmaps
&& ! function_key_possible
6710 && ! key_translation_possible
6712 && ((((XINT (key
) & 0x3ffff)
6713 < XSTRING (current_buffer
->downcase_table
)->size
)
6714 && UPPERCASEP (XINT (key
) & 0x3ffff))
6715 || (XINT (key
) & shift_modifier
)))
6717 Lisp_Object new_key
;
6719 original_uppercase
= key
;
6720 original_uppercase_position
= t
- 1;
6722 if (XINT (key
) & shift_modifier
)
6723 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6725 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6726 | (XINT (key
) & ~0x3ffff)));
6728 /* We have to do this unconditionally, regardless of whether
6729 the lower-case char is defined in the keymaps, because they
6730 might get translated through function-key-map. */
6731 keybuf
[t
- 1] = new_key
;
6734 fkey_map
= prev_fkey_map
;
6735 fkey_start
= prev_fkey_start
;
6736 fkey_end
= prev_fkey_end
;
6738 keytran_map
= prev_keytran_map
;
6739 keytran_start
= prev_keytran_start
;
6740 keytran_end
= prev_keytran_end
;
6742 goto replay_sequence
;
6744 /* If KEY is not defined in any of the keymaps,
6745 and cannot be part of a function key or translation,
6746 and is a shifted function key,
6747 use the corresponding unshifted function key instead. */
6748 if (first_binding
== nmaps
&& ! function_key_possible
6749 && ! key_translation_possible
6752 Lisp_Object breakdown
;
6755 breakdown
= parse_modifiers (key
);
6756 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6757 if (modifiers
& shift_modifier
)
6759 Lisp_Object new_key
;
6761 original_uppercase
= key
;
6762 original_uppercase_position
= t
- 1;
6764 modifiers
&= ~shift_modifier
;
6765 new_key
= apply_modifiers (modifiers
,
6766 XCONS (breakdown
)->car
);
6768 keybuf
[t
- 1] = new_key
;
6771 fkey_map
= prev_fkey_map
;
6772 fkey_start
= prev_fkey_start
;
6773 fkey_end
= prev_fkey_end
;
6775 keytran_map
= prev_keytran_map
;
6776 keytran_start
= prev_keytran_start
;
6777 keytran_end
= prev_keytran_end
;
6779 goto replay_sequence
;
6785 read_key_sequence_cmd
= (first_binding
< nmaps
6786 ? defs
[first_binding
]
6789 unread_switch_frame
= delayed_switch_frame
;
6790 unbind_to (count
, Qnil
);
6792 /* Don't downcase the last character if the caller says don't.
6793 Don't downcase it if the result is undefined, either. */
6794 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6795 && t
- 1 == original_uppercase_position
)
6796 keybuf
[t
- 1] = original_uppercase
;
6798 /* Occasionally we fabricate events, perhaps by expanding something
6799 according to function-key-map, or by adding a prefix symbol to a
6800 mouse click in the scroll bar or modeline. In this cases, return
6801 the entire generated key sequence, even if we hit an unbound
6802 prefix or a definition before the end. This means that you will
6803 be able to push back the event properly, and also means that
6804 read-key-sequence will always return a logical unit.
6807 for (; t
< mock_input
; t
++)
6809 if (echo_keystrokes
)
6810 echo_char (keybuf
[t
]);
6811 add_command_key (keybuf
[t
]);
6817 #if 0 /* This doc string is too long for some compilers.
6818 This commented-out definition serves for DOC. */
6819 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6820 "Read a sequence of keystrokes and return as a string or vector.\n\
6821 The sequence is sufficient to specify a non-prefix command in the\n\
6822 current local and global maps.\n\
6824 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6825 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6826 as a continuation of the previous key.\n\
6828 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6829 convert the last event to lower case. (Normally any upper case event\n\
6830 is converted to lower case if the original event is undefined and the lower\n\
6831 case equivalent is defined.) A non-nil value is appropriate for reading\n\
6832 a key sequence to be defined.\n\
6834 A C-g typed while in this function is treated like any other character,\n\
6835 and `quit-flag' is not set.\n\
6837 If the key sequence starts with a mouse click, then the sequence is read\n\
6838 using the keymaps of the buffer of the window clicked in, not the buffer\n\
6839 of the selected window as normal.\n\
6841 `read-key-sequence' drops unbound button-down events, since you normally\n\
6842 only care about the click or drag events which follow them. If a drag\n\
6843 or multi-click event is unbound, but the corresponding click event would\n\
6844 be bound, `read-key-sequence' turns the event into a click event at the\n\
6845 drag's starting position. This means that you don't have to distinguish\n\
6846 between click and drag, double, or triple events unless you want to.\n\
6848 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
6849 lines separating windows, and scroll bars with imaginary keys\n\
6850 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
6852 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
6853 function will process a switch-frame event if the user switches frames\n\
6854 before typing anything. If the user switches frames in the middle of a\n\
6855 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
6856 is nil, then the event will be put off until after the current key sequence.\n\
6858 `read-key-sequence' checks `function-key-map' for function key\n\
6859 sequences, where they wouldn't conflict with ordinary bindings. See\n\
6860 `function-key-map' for more details.")
6861 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6864 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6866 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6867 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
6868 Lisp_Object can_return_switch_frame
;
6870 Lisp_Object keybuf
[30];
6872 struct gcpro gcpro1
, gcpro2
;
6875 CHECK_STRING (prompt
, 0);
6878 bzero (keybuf
, sizeof keybuf
);
6880 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
6882 if (NILP (continue_echo
))
6884 this_command_key_count
= 0;
6885 this_single_command_key_start
= 0;
6888 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
6889 prompt
, ! NILP (dont_downcase_last
),
6890 ! NILP (can_return_switch_frame
), 0);
6898 return make_event_array (i
, keybuf
);
6901 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
6902 "Execute CMD as an editor command.\n\
6903 CMD must be a symbol that satisfies the `commandp' predicate.\n\
6904 Optional second arg RECORD-FLAG non-nil\n\
6905 means unconditionally put this command in `command-history'.\n\
6906 Otherwise, that is done only if an arg is read using the minibuffer.\n\
6907 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
6908 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
6909 The argument SPECIAL, if non-nil, means that this command is executing\n\
6910 a special event, so ignore the prefix argument and don't clear it.")
6911 (cmd
, record_flag
, keys
, special
)
6912 Lisp_Object cmd
, record_flag
, keys
, special
;
6914 register Lisp_Object final
;
6915 register Lisp_Object tem
;
6916 Lisp_Object prefixarg
;
6917 struct backtrace backtrace
;
6918 extern int debug_on_next_call
;
6920 debug_on_next_call
= 0;
6924 prefixarg
= current_kboard
->Vprefix_arg
;
6925 Vcurrent_prefix_arg
= prefixarg
;
6926 current_kboard
->Vprefix_arg
= Qnil
;
6933 tem
= Fget (cmd
, Qdisabled
);
6934 if (!NILP (tem
) && !NILP (Vrun_hooks
))
6936 tem
= Fsymbol_value (Qdisabled_command_hook
);
6938 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
6944 final
= Findirect_function (cmd
);
6946 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
6948 struct gcpro gcpro1
, gcpro2
;
6950 GCPRO2 (cmd
, prefixarg
);
6951 do_autoload (final
, cmd
);
6958 if (STRINGP (final
) || VECTORP (final
))
6960 /* If requested, place the macro in the command history. For
6961 other sorts of commands, call-interactively takes care of
6963 if (!NILP (record_flag
))
6965 = Fcons (Fcons (Qexecute_kbd_macro
,
6966 Fcons (final
, Fcons (prefixarg
, Qnil
))),
6969 return Fexecute_kbd_macro (final
, prefixarg
);
6971 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
6973 backtrace
.next
= backtrace_list
;
6974 backtrace_list
= &backtrace
;
6975 backtrace
.function
= &Qcall_interactively
;
6976 backtrace
.args
= &cmd
;
6977 backtrace
.nargs
= 1;
6978 backtrace
.evalargs
= 0;
6980 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
6982 backtrace_list
= backtrace
.next
;
6988 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
6990 "Read function name, then read its arguments and call it.")
6992 Lisp_Object prefixarg
;
6994 Lisp_Object function
;
6996 Lisp_Object saved_keys
;
6997 Lisp_Object bindings
, value
;
6998 struct gcpro gcpro1
, gcpro2
;
7000 saved_keys
= Fvector (this_command_key_count
,
7001 XVECTOR (this_command_keys
)->contents
);
7003 GCPRO2 (saved_keys
, prefixarg
);
7005 if (EQ (prefixarg
, Qminus
))
7007 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7008 strcpy (buf
, "C-u ");
7009 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7011 if (sizeof (int) == sizeof (EMACS_INT
))
7012 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7013 else if (sizeof (long) == sizeof (EMACS_INT
))
7014 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7018 else if (INTEGERP (prefixarg
))
7020 if (sizeof (int) == sizeof (EMACS_INT
))
7021 sprintf (buf
, "%d ", XINT (prefixarg
));
7022 else if (sizeof (long) == sizeof (EMACS_INT
))
7023 sprintf (buf
, "%ld ", XINT (prefixarg
));
7028 /* This isn't strictly correct if execute-extended-command
7029 is bound to anything else. Perhaps it should use
7030 this_command_keys? */
7031 strcat (buf
, "M-x ");
7033 /* Prompt with buf, and then read a string, completing from and
7034 restricting to the set of all defined commands. Don't provide
7035 any initial input. Save the command read on the extended-command
7037 function
= Fcompleting_read (build_string (buf
),
7038 Vobarray
, Qcommandp
,
7039 Qt
, Qnil
, Qextended_command_history
, Qnil
);
7041 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7042 error ("No command name given");
7044 /* Set this_command_keys to the concatenation of saved_keys and
7045 function, followed by a RET. */
7047 struct Lisp_String
*str
;
7052 this_command_key_count
= 0;
7053 this_single_command_key_start
= 0;
7055 keys
= XVECTOR (saved_keys
)->contents
;
7056 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7057 add_command_key (keys
[i
]);
7059 str
= XSTRING (function
);
7060 for (i
= 0; i
< str
->size
; i
++)
7062 XSETFASTINT (tem
, str
->data
[i
]);
7063 add_command_key (tem
);
7066 XSETFASTINT (tem
, '\015');
7067 add_command_key (tem
);
7072 function
= Fintern (function
, Qnil
);
7073 current_kboard
->Vprefix_arg
= prefixarg
;
7074 this_command
= function
;
7076 /* If enabled, show which key runs this command. */
7077 if (!NILP (Vsuggest_key_bindings
)
7078 && NILP (Vexecuting_macro
)
7079 && SYMBOLP (function
))
7080 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7086 GCPRO2 (bindings
, value
);
7087 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7089 /* If the command has a key binding, print it now. */
7090 if (!NILP (bindings
))
7092 /* But first wait, and skip the message if there is input. */
7093 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7094 ? Vsuggest_key_bindings
: make_number (2)),
7097 Lisp_Object binding
;
7099 char *oldmessage
= echo_area_glyphs
;
7100 int oldmessage_len
= echo_area_glyphs_length
;
7102 binding
= Fkey_description (bindings
);
7105 = (char *) alloca (XSYMBOL (function
)->name
->size
7106 + XSTRING (binding
)->size
7108 sprintf (newmessage
, "You can run the command `%s' by typing %s",
7109 XSYMBOL (function
)->name
->data
,
7110 XSTRING (binding
)->data
);
7111 message1_nolog (newmessage
);
7112 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7113 ? Vsuggest_key_bindings
: make_number (2)),
7115 message2_nolog (oldmessage
, oldmessage_len
);
7119 RETURN_UNGCPRO (value
);
7122 /* Find the set of keymaps now active.
7123 Store into *MAPS_P a vector holding the various maps
7124 and return the number of them. The vector was malloc'd
7125 and the caller should free it. */
7128 current_active_maps (maps_p
)
7129 Lisp_Object
**maps_p
;
7131 Lisp_Object
*tmaps
, *maps
;
7134 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7135 if (!NILP (Voverriding_local_map_menu_flag
))
7137 /* Yes, use them (if non-nil) as well as the global map. */
7138 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7140 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7141 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7142 if (!NILP (Voverriding_local_map
))
7143 maps
[nmaps
++] = Voverriding_local_map
;
7147 /* No, so use major and minor mode keymaps. */
7148 nmaps
= current_minor_maps (NULL
, &tmaps
);
7149 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7150 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7151 #ifdef USE_TEXT_PROPERTIES
7152 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7154 maps
[nmaps
++] = current_buffer
->keymap
;
7157 maps
[nmaps
++] = current_global_map
;
7163 /* Return nonzero if input events are pending. */
7165 detect_input_pending ()
7168 get_input_pending (&input_pending
, 0);
7170 return input_pending
;
7173 /* Return nonzero if input events are pending, and run any pending timers. */
7175 detect_input_pending_run_timers (do_display
)
7178 int old_timers_run
= timers_run
;
7181 get_input_pending (&input_pending
, 1);
7183 if (old_timers_run
!= timers_run
&& do_display
)
7184 redisplay_preserve_echo_area ();
7186 return input_pending
;
7189 /* This is called in some cases before a possible quit.
7190 It cases the next call to detect_input_pending to recompute input_pending.
7191 So calling this function unnecessarily can't do any harm. */
7192 clear_input_pending ()
7197 /* Return nonzero if there are pending requeued events.
7198 This isn't used yet. The hope is to make wait_reading_process_input
7199 call it, and return return if it runs Lisp code that unreads something.
7200 The problem is, kbd_buffer_get_event needs to be fixed to know what
7201 to do in that case. It isn't trivial. */
7203 requeued_events_pending_p ()
7205 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7209 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7210 "T if command input is currently available with no waiting.\n\
7211 Actually, the value is nil only if we can be sure that no input is available.")
7214 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7217 get_input_pending (&input_pending
, 1);
7218 return input_pending
> 0 ? Qt
: Qnil
;
7221 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7222 "Return vector of last 100 events, not counting those from keyboard macros.")
7225 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7228 if (total_keys
< NUM_RECENT_KEYS
)
7229 return Fvector (total_keys
, keys
);
7232 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7233 bcopy (keys
+ recent_keys_index
,
7234 XVECTOR (val
)->contents
,
7235 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7237 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7238 recent_keys_index
* sizeof (Lisp_Object
));
7243 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7244 "Return the key sequence that invoked this command.\n\
7245 The value is a string or a vector.")
7248 return make_event_array (this_command_key_count
,
7249 XVECTOR (this_command_keys
)->contents
);
7252 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7253 Sthis_single_command_keys
, 0, 0, 0,
7254 "Return the key sequence that invoked this command.\n\
7255 Unlike `this-command-keys', this function's value\n\
7256 does not include prefix arguments.\n\
7257 The value is a string or a vector.")
7260 return make_event_array (this_command_key_count
7261 - this_single_command_key_start
,
7262 (XVECTOR (this_command_keys
)->contents
7263 + this_single_command_key_start
));
7266 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7267 Sreset_this_command_lengths
, 0, 0, 0,
7268 "Used for complicated reasons in `universal-argument-other-key'.\n\
7270 `universal-argument-other-key' rereads the event just typed.\n\
7271 It then gets translated through `function-key-map'.\n\
7272 The translated event gets included in the echo area and in\n\
7273 the value of `this-command-keys' in addition to the raw original event.\n\
7274 That is not right.\n\
7276 Calling this function directs the translated event to replace\n\
7277 the original event, so that only one version of the event actually\n\
7278 appears in the echo area and in the value of `this-command-keys.'.")
7281 before_command_restore_flag
= 1;
7282 before_command_key_count_1
= before_command_key_count
;
7283 before_command_echo_length_1
= before_command_echo_length
;
7286 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7287 "Return the current depth in recursive edits.")
7291 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
7295 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
7296 "FOpen dribble file: ",
7297 "Start writing all keyboard characters to a dribble file called FILE.\n\
7298 If FILE is nil, close any open dribble file.")
7309 file
= Fexpand_file_name (file
, Qnil
);
7310 dribble
= fopen (XSTRING (file
)->data
, "w");
7312 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
7317 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
7318 "Discard the contents of the terminal input buffer.\n\
7319 Also cancel any kbd macro being defined.")
7322 current_kboard
->defining_kbd_macro
= Qnil
;
7323 update_mode_lines
++;
7325 Vunread_command_events
= Qnil
;
7326 unread_command_char
= -1;
7328 discard_tty_input ();
7330 /* Without the cast, GCC complains that this assignment loses the
7331 volatile qualifier of kbd_store_ptr. Is there anything wrong
7333 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7334 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7340 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7341 "Stop Emacs and return to superior process. You can resume later.\n\
7342 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7343 control, run a subshell instead.\n\n\
7344 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7345 to be read as terminal input by Emacs's parent, after suspension.\n\
7347 Before suspending, run the normal hook `suspend-hook'.\n\
7348 After resumption run the normal hook `suspend-resume-hook'.\n\
7350 Some operating systems cannot stop the Emacs process and resume it later.\n\
7351 On such systems, Emacs starts a subshell instead of suspending.")
7353 Lisp_Object stuffstring
;
7356 int count
= specpdl_ptr
- specpdl
;
7357 int old_height
, old_width
;
7359 struct gcpro gcpro1
, gcpro2
;
7360 extern init_sys_modes ();
7362 if (!NILP (stuffstring
))
7363 CHECK_STRING (stuffstring
, 0);
7365 /* Run the functions in suspend-hook. */
7366 if (!NILP (Vrun_hooks
))
7367 call1 (Vrun_hooks
, intern ("suspend-hook"));
7369 GCPRO1 (stuffstring
);
7370 get_frame_size (&old_width
, &old_height
);
7372 /* sys_suspend can get an error if it tries to fork a subshell
7373 and the system resources aren't available for that. */
7374 record_unwind_protect (init_sys_modes
, 0);
7375 stuff_buffered_input (stuffstring
);
7380 unbind_to (count
, Qnil
);
7382 /* Check if terminal/window size has changed.
7383 Note that this is not useful when we are running directly
7384 with a window system; but suspend should be disabled in that case. */
7385 get_frame_size (&width
, &height
);
7386 if (width
!= old_width
|| height
!= old_height
)
7387 change_frame_size (selected_frame
, height
, width
, 0, 0);
7389 /* Run suspend-resume-hook. */
7390 if (!NILP (Vrun_hooks
))
7391 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7397 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7398 Then in any case stuff anything Emacs has read ahead and not used. */
7400 stuff_buffered_input (stuffstring
)
7401 Lisp_Object stuffstring
;
7403 /* stuff_char works only in BSD, versions 4.2 and up. */
7406 register unsigned char *p
;
7408 if (STRINGP (stuffstring
))
7412 p
= XSTRING (stuffstring
)->data
;
7413 count
= XSTRING (stuffstring
)->size
;
7418 /* Anything we have read ahead, put back for the shell to read. */
7419 /* ?? What should this do when we have multiple keyboards??
7420 Should we ignore anything that was typed in at the "wrong" kboard? */
7421 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7423 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7424 kbd_fetch_ptr
= kbd_buffer
;
7425 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7426 stuff_char (kbd_fetch_ptr
->code
);
7427 kbd_fetch_ptr
->kind
= no_event
;
7428 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7434 #endif /* BSD_SYSTEM and not BSD4_1 */
7437 set_waiting_for_input (time_to_clear
)
7438 EMACS_TIME
*time_to_clear
;
7440 input_available_clear_time
= time_to_clear
;
7442 /* Tell interrupt_signal to throw back to read_char, */
7443 waiting_for_input
= 1;
7445 /* If interrupt_signal was called before and buffered a C-g,
7446 make it run again now, to avoid timing error. */
7447 if (!NILP (Vquit_flag
))
7448 quit_throw_to_read_char ();
7451 clear_waiting_for_input ()
7453 /* Tell interrupt_signal not to throw back to read_char, */
7454 waiting_for_input
= 0;
7455 input_available_clear_time
= 0;
7458 /* This routine is called at interrupt level in response to C-G.
7459 If interrupt_input, this is the handler for SIGINT.
7460 Otherwise, it is called from kbd_buffer_store_event,
7461 in handling SIGIO or SIGTINT.
7463 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7464 immediately throw back to read_char.
7466 Otherwise it sets the Lisp variable quit-flag not-nil.
7467 This causes eval to throw, when it gets a chance.
7468 If quit-flag is already non-nil, it stops the job right away. */
7471 interrupt_signal (signalnum
) /* If we don't have an argument, */
7472 int signalnum
; /* some compilers complain in signal calls. */
7475 /* Must preserve main program's value of errno. */
7476 int old_errno
= errno
;
7478 #if defined (USG) && !defined (POSIX_SIGNALS)
7479 if (!read_socket_hook
&& NILP (Vwindow_system
))
7481 /* USG systems forget handlers when they are used;
7482 must reestablish each time */
7483 signal (SIGINT
, interrupt_signal
);
7484 signal (SIGQUIT
, interrupt_signal
);
7490 if (!NILP (Vquit_flag
)
7491 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
7493 /* If SIGINT isn't blocked, don't let us be interrupted by
7494 another SIGINT, it might be harmful due to non-reentrancy
7495 in I/O functions. */
7496 sigblock (sigmask (SIGINT
));
7501 #ifdef SIGTSTP /* Support possible in later USG versions */
7503 * On systems which can suspend the current process and return to the original
7504 * shell, this command causes the user to end up back at the shell.
7505 * The "Auto-save" and "Abort" questions are not asked until
7506 * the user elects to return to emacs, at which point he can save the current
7507 * job and either dump core or continue.
7512 if (sys_suspend () == -1)
7514 printf ("Not running as a subprocess;\n");
7515 printf ("you can continue or abort.\n");
7518 /* Perhaps should really fork an inferior shell?
7519 But that would not provide any way to get back
7520 to the original shell, ever. */
7521 printf ("No support for stopping a process on this operating system;\n");
7522 printf ("you can continue or abort.\n");
7523 #endif /* not VMS */
7524 #endif /* not SIGTSTP */
7526 /* We must remain inside the screen area when the internal terminal
7527 is used. Note that [Enter] is not echoed by dos. */
7530 /* It doesn't work to autosave while GC is in progress;
7531 the code used for auto-saving doesn't cope with the mark bit. */
7532 if (!gc_in_progress
)
7534 printf ("Auto-save? (y or n) ");
7536 if (((c
= getchar ()) & ~040) == 'Y')
7538 Fdo_auto_save (Qt
, Qnil
);
7540 printf ("\r\nAuto-save done");
7541 #else /* not MSDOS */
7542 printf ("Auto-save done\n");
7543 #endif /* not MSDOS */
7545 while (c
!= '\n') c
= getchar ();
7549 /* During GC, it must be safe to reenable quitting again. */
7550 Vinhibit_quit
= Qnil
;
7553 #endif /* not MSDOS */
7554 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7555 printf ("but will instead do a real quit after garbage collection ends\r\n");
7560 printf ("\r\nAbort? (y or n) ");
7561 #else /* not MSDOS */
7563 printf ("Abort (and enter debugger)? (y or n) ");
7565 printf ("Abort (and dump core)? (y or n) ");
7566 #endif /* not VMS */
7567 #endif /* not MSDOS */
7569 if (((c
= getchar ()) & ~040) == 'Y')
7571 while (c
!= '\n') c
= getchar ();
7573 printf ("\r\nContinuing...\r\n");
7574 #else /* not MSDOS */
7575 printf ("Continuing...\n");
7576 #endif /* not MSDOS */
7583 /* If executing a function that wants to be interrupted out of
7584 and the user has not deferred quitting by binding `inhibit-quit'
7585 then quit right away. */
7586 if (immediate_quit
&& NILP (Vinhibit_quit
))
7590 Fsignal (Qquit
, Qnil
);
7593 /* Else request quit when it's safe */
7597 if (waiting_for_input
&& !echoing
)
7598 quit_throw_to_read_char ();
7603 /* Handle a C-g by making read_char return C-g. */
7605 quit_throw_to_read_char ()
7607 quit_error_check ();
7609 /* Prevent another signal from doing this before we finish. */
7610 clear_waiting_for_input ();
7613 Vunread_command_events
= Qnil
;
7614 unread_command_char
= -1;
7616 #if 0 /* Currently, sit_for is called from read_char without turning
7617 off polling. And that can call set_waiting_for_input.
7618 It seems to be harmless. */
7619 #ifdef POLL_FOR_INPUT
7620 /* May be > 1 if in recursive minibuffer. */
7621 if (poll_suppress_count
== 0)
7625 if (FRAMEP (internal_last_event_frame
)
7626 && XFRAME (internal_last_event_frame
) != selected_frame
)
7627 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7630 _longjmp (getcjmp
, 1);
7633 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7634 "Set mode of reading keyboard input.\n\
7635 First arg INTERRUPT non-nil means use input interrupts;\n\
7636 nil means use CBREAK mode.\n\
7637 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7638 (no effect except in CBREAK mode).\n\
7639 Third arg META t means accept 8-bit input (for a Meta key).\n\
7640 META nil means ignore the top bit, on the assumption it is parity.\n\
7641 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7642 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7643 See also `current-input-mode'.")
7644 (interrupt
, flow
, meta
, quit
)
7645 Lisp_Object interrupt
, flow
, meta
, quit
;
7648 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7649 error ("set-input-mode: QUIT must be an ASCII character");
7651 #ifdef POLL_FOR_INPUT
7656 /* this causes startup screen to be restored and messes with the mouse */
7661 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7662 if (read_socket_hook
)
7664 /* When using X, don't give the user a real choice,
7665 because we haven't implemented the mechanisms to support it. */
7666 #ifdef NO_SOCK_SIGIO
7667 interrupt_input
= 0;
7668 #else /* not NO_SOCK_SIGIO */
7669 interrupt_input
= 1;
7670 #endif /* NO_SOCK_SIGIO */
7673 interrupt_input
= !NILP (interrupt
);
7674 #else /* not SIGIO */
7675 interrupt_input
= 0;
7676 #endif /* not SIGIO */
7678 /* Our VMS input only works by interrupts, as of now. */
7680 interrupt_input
= 1;
7683 flow_control
= !NILP (flow
);
7686 else if (EQ (meta
, Qt
))
7691 /* Don't let this value be out of range. */
7692 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7698 #ifdef POLL_FOR_INPUT
7699 poll_suppress_count
= 1;
7705 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7706 "Return information about the way Emacs currently reads keyboard input.\n\
7707 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7708 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7709 nil, Emacs is using CBREAK mode.\n\
7710 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7711 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7712 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7713 META nil means ignoring the top bit, on the assumption it is parity.\n\
7714 META is neither t nor nil if accepting 8-bit input and using\n\
7715 all 8 bits as the character code.\n\
7716 QUIT is the character Emacs currently uses to quit.\n\
7717 The elements of this list correspond to the arguments of\n\
7723 val
[0] = interrupt_input
? Qt
: Qnil
;
7724 val
[1] = flow_control
? Qt
: Qnil
;
7725 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7726 XSETFASTINT (val
[3], quit_char
);
7728 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7733 * Set up a new kboard object with reasonable initial values.
7739 kb
->Voverriding_terminal_local_map
= Qnil
;
7740 kb
->Vlast_command
= Qnil
;
7741 kb
->Vprefix_arg
= Qnil
;
7742 kb
->kbd_queue
= Qnil
;
7743 kb
->kbd_queue_has_data
= 0;
7744 kb
->immediate_echo
= 0;
7745 kb
->echoptr
= kb
->echobuf
;
7746 kb
->echo_after_prompt
= -1;
7747 kb
->kbd_macro_buffer
= 0;
7748 kb
->kbd_macro_bufsize
= 0;
7749 kb
->defining_kbd_macro
= Qnil
;
7750 kb
->Vlast_kbd_macro
= Qnil
;
7751 kb
->reference_count
= 0;
7752 kb
->Vsystem_key_alist
= Qnil
;
7753 kb
->system_key_syms
= Qnil
;
7754 kb
->Vdefault_minibuffer_frame
= Qnil
;
7758 * Destroy the contents of a kboard object, but not the object itself.
7759 * We use this just before deleting it, or if we're going to initialize
7766 if (kb
->kbd_macro_buffer
)
7767 xfree (kb
->kbd_macro_buffer
);
7776 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7779 *kbp
= kb
->next_kboard
;
7787 /* This is correct before outermost invocation of the editor loop */
7788 command_loop_level
= -1;
7790 quit_char
= Ctl ('g');
7791 Vunread_command_events
= Qnil
;
7792 unread_command_char
= -1;
7793 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
7795 recent_keys_index
= 0;
7796 kbd_fetch_ptr
= kbd_buffer
;
7797 kbd_store_ptr
= kbd_buffer
;
7798 kbd_buffer_frame_or_window
7799 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7801 do_mouse_tracking
= Qnil
;
7805 /* This means that command_loop_1 won't try to select anything the first
7807 internal_last_event_frame
= Qnil
;
7808 Vlast_event_frame
= internal_last_event_frame
;
7811 current_kboard
= initial_kboard
;
7813 wipe_kboard (current_kboard
);
7814 init_kboard (current_kboard
);
7817 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7819 kbd_buffer_frame_or_window
7820 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7821 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
7823 signal (SIGINT
, interrupt_signal
);
7824 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
7825 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7826 SIGQUIT and we can't tell which one it will give us. */
7827 signal (SIGQUIT
, interrupt_signal
);
7828 #endif /* HAVE_TERMIO */
7830 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7832 if (!noninteractive
)
7833 signal (SIGIO
, input_available_signal
);
7836 /* Use interrupt input by default, if it works and noninterrupt input
7837 has deficiencies. */
7839 #ifdef INTERRUPT_INPUT
7840 interrupt_input
= 1;
7842 interrupt_input
= 0;
7845 /* Our VMS input only works by interrupts, as of now. */
7847 interrupt_input
= 1;
7853 if (keyboard_init_hook
)
7854 (*keyboard_init_hook
) ();
7856 #ifdef POLL_FOR_INPUT
7857 poll_suppress_count
= 1;
7862 /* This type's only use is in syms_of_keyboard, to initialize the
7863 event header symbols and put properties on them. */
7870 struct event_head head_table
[] = {
7871 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
7872 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
7873 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
7874 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
7875 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
7876 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
7881 Qtimer_event_handler
= intern ("timer-event-handler");
7882 staticpro (&Qtimer_event_handler
);
7884 Qdisabled_command_hook
= intern ("disabled-command-hook");
7885 staticpro (&Qdisabled_command_hook
);
7887 Qself_insert_command
= intern ("self-insert-command");
7888 staticpro (&Qself_insert_command
);
7890 Qforward_char
= intern ("forward-char");
7891 staticpro (&Qforward_char
);
7893 Qbackward_char
= intern ("backward-char");
7894 staticpro (&Qbackward_char
);
7896 Qdisabled
= intern ("disabled");
7897 staticpro (&Qdisabled
);
7899 Qundefined
= intern ("undefined");
7900 staticpro (&Qundefined
);
7902 Qpre_command_hook
= intern ("pre-command-hook");
7903 staticpro (&Qpre_command_hook
);
7905 Qpost_command_hook
= intern ("post-command-hook");
7906 staticpro (&Qpost_command_hook
);
7908 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
7909 staticpro (&Qpost_command_idle_hook
);
7911 Qdeferred_action_function
= intern ("deferred-action-function");
7912 staticpro (&Qdeferred_action_function
);
7914 Qcommand_hook_internal
= intern ("command-hook-internal");
7915 staticpro (&Qcommand_hook_internal
);
7917 Qfunction_key
= intern ("function-key");
7918 staticpro (&Qfunction_key
);
7919 Qmouse_click
= intern ("mouse-click");
7920 staticpro (&Qmouse_click
);
7922 Qmenu_enable
= intern ("menu-enable");
7923 staticpro (&Qmenu_enable
);
7925 Qmode_line
= intern ("mode-line");
7926 staticpro (&Qmode_line
);
7927 Qvertical_line
= intern ("vertical-line");
7928 staticpro (&Qvertical_line
);
7929 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
7930 staticpro (&Qvertical_scroll_bar
);
7931 Qmenu_bar
= intern ("menu-bar");
7932 staticpro (&Qmenu_bar
);
7934 Qabove_handle
= intern ("above-handle");
7935 staticpro (&Qabove_handle
);
7936 Qhandle
= intern ("handle");
7937 staticpro (&Qhandle
);
7938 Qbelow_handle
= intern ("below-handle");
7939 staticpro (&Qbelow_handle
);
7940 Qup
= intern ("up");
7942 Qdown
= intern ("down");
7945 Qevent_kind
= intern ("event-kind");
7946 staticpro (&Qevent_kind
);
7947 Qevent_symbol_elements
= intern ("event-symbol-elements");
7948 staticpro (&Qevent_symbol_elements
);
7949 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
7950 staticpro (&Qevent_symbol_element_mask
);
7951 Qmodifier_cache
= intern ("modifier-cache");
7952 staticpro (&Qmodifier_cache
);
7954 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
7955 staticpro (&Qrecompute_lucid_menubar
);
7956 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
7957 staticpro (&Qactivate_menubar_hook
);
7959 Qpolling_period
= intern ("polling-period");
7960 staticpro (&Qpolling_period
);
7963 struct event_head
*p
;
7965 for (p
= head_table
;
7966 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
7969 *p
->var
= intern (p
->name
);
7971 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
7972 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
7976 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
7977 staticpro (&button_down_location
);
7981 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
7983 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
7984 for (i
= 0; i
< len
; i
++)
7985 if (modifier_names
[i
])
7986 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
7987 staticpro (&modifier_symbols
);
7990 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
7991 staticpro (&recent_keys
);
7993 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
7994 staticpro (&this_command_keys
);
7996 Qextended_command_history
= intern ("extended-command-history");
7997 Fset (Qextended_command_history
, Qnil
);
7998 staticpro (&Qextended_command_history
);
8000 kbd_buffer_frame_or_window
8001 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8002 staticpro (&kbd_buffer_frame_or_window
);
8004 accent_key_syms
= Qnil
;
8005 staticpro (&accent_key_syms
);
8007 func_key_syms
= Qnil
;
8008 staticpro (&func_key_syms
);
8011 staticpro (&mouse_syms
);
8013 unread_switch_frame
= Qnil
;
8014 staticpro (&unread_switch_frame
);
8016 internal_last_event_frame
= Qnil
;
8017 staticpro (&internal_last_event_frame
);
8019 read_key_sequence_cmd
= Qnil
;
8020 staticpro (&read_key_sequence_cmd
);
8022 defsubr (&Sevent_convert_list
);
8023 defsubr (&Sread_key_sequence
);
8024 defsubr (&Srecursive_edit
);
8026 defsubr (&Strack_mouse
);
8028 defsubr (&Sinput_pending_p
);
8029 defsubr (&Scommand_execute
);
8030 defsubr (&Srecent_keys
);
8031 defsubr (&Sthis_command_keys
);
8032 defsubr (&Sthis_single_command_keys
);
8033 defsubr (&Sreset_this_command_lengths
);
8034 defsubr (&Ssuspend_emacs
);
8035 defsubr (&Sabort_recursive_edit
);
8036 defsubr (&Sexit_recursive_edit
);
8037 defsubr (&Srecursion_depth
);
8038 defsubr (&Stop_level
);
8039 defsubr (&Sdiscard_input
);
8040 defsubr (&Sopen_dribble_file
);
8041 defsubr (&Sset_input_mode
);
8042 defsubr (&Scurrent_input_mode
);
8043 defsubr (&Sexecute_extended_command
);
8045 DEFVAR_LISP ("last-command-char", &last_command_char
,
8046 "Last input event that was part of a command.");
8048 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
8049 "Last input event that was part of a command.");
8051 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
8052 "Last input event in a command, except for mouse menu events.\n\
8053 Mouse menus give back keys that don't look like mouse events;\n\
8054 this variable holds the actual mouse event that led to the menu,\n\
8055 so that you can determine whether the command was run by mouse or not.");
8057 DEFVAR_LISP ("last-input-char", &last_input_char
,
8058 "Last input event.");
8060 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
8061 "Last input event.");
8063 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
8064 "List of objects to be read as next command input events.");
8066 DEFVAR_INT ("unread-command-char", &unread_command_char
,
8067 "If not -1, an object to be read as next command input event.");
8069 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
8070 "Meta-prefix character code. Meta-foo as command input\n\
8071 turns into this character followed by foo.");
8072 XSETINT (meta_prefix_char
, 033);
8074 DEFVAR_KBOARD ("last-command", Vlast_command
,
8075 "The last command executed. Normally a symbol with a function definition,\n\
8076 but can be whatever was found in the keymap, or whatever the variable\n\
8077 `this-command' was set to by that command.\n\
8079 The value `mode-exit' is special; it means that the previous command\n\
8080 read an event that told it to exit, and it did so and unread that event.\n\
8081 In other words, the present command is the event that made the previous\n\
8084 The value `kill-region' is special; it means that the previous command\n\
8085 was a kill command.");
8087 DEFVAR_LISP ("this-command", &this_command
,
8088 "The command now being executed.\n\
8089 The command can set this variable; whatever is put here\n\
8090 will be in `last-command' during the following command.");
8091 this_command
= Qnil
;
8093 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8094 "*Number of keyboard input characters between auto-saves.\n\
8095 Zero means disable autosaving due to number of characters typed.");
8096 auto_save_interval
= 300;
8098 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8099 "*Number of seconds idle time before auto-save.\n\
8100 Zero or nil means disable auto-saving due to idleness.\n\
8101 After auto-saving due to this many seconds of idle time,\n\
8102 Emacs also does a garbage collection if that seems to be warranted.");
8103 XSETFASTINT (Vauto_save_timeout
, 30);
8105 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8106 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8107 echo_keystrokes
= 1;
8109 DEFVAR_INT ("polling-period", &polling_period
,
8110 "*Interval between polling for input during Lisp execution.\n\
8111 The reason for polling is to make C-g work to stop a running program.\n\
8112 Polling is needed only when using X windows and SIGIO does not work.\n\
8113 Polling is automatically disabled in all other cases.");
8116 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8117 "*Maximum time between mouse clicks to make a double-click.\n\
8118 Measured in milliseconds. nil means disable double-click recognition;\n\
8119 t means double-clicks have no time limit and are detected\n\
8120 by position only.");
8121 Vdouble_click_time
= make_number (500);
8123 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8124 "*Non-nil means inhibit local map menu bar menus.");
8125 inhibit_local_menu_bar_menus
= 0;
8127 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8128 "Number of complete key sequences read from the keyboard so far.\n\
8129 This includes key sequences read from keyboard macros.\n\
8130 The number is effectively the number of interactive command invocations.");
8133 DEFVAR_INT ("num-nonmacro-input-chars", &num_nonmacro_input_chars
,
8134 "Number of characters read from the keyboard so far.\n\
8135 Does not include characters read from keyboard macros.");
8136 num_nonmacro_input_chars
= 0;
8138 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8139 "The frame in which the most recently read event occurred.\n\
8140 If the last event came from a keyboard macro, this is set to `macro'.");
8141 Vlast_event_frame
= Qnil
;
8143 /* This variable is set up in sysdep.c. */
8144 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
8145 "The ERASE character as set by the user with stty.");
8147 DEFVAR_LISP ("help-char", &Vhelp_char
,
8148 "Character to recognize as meaning Help.\n\
8149 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8150 If the value of `help-form' is nil, this char can be read normally.");
8151 XSETINT (Vhelp_char
, Ctl ('H'));
8153 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8154 "List of input events to recognize as meaning Help.\n\
8155 These work just like the value of `help-char' (see that).");
8156 Vhelp_event_list
= Qnil
;
8158 DEFVAR_LISP ("help-form", &Vhelp_form
,
8159 "Form to execute when character `help-char' is read.\n\
8160 If the form returns a string, that string is displayed.\n\
8161 If `help-form' is nil, the help char is not recognized.");
8164 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8165 "Command to run when `help-char' character follows a prefix key.\n\
8166 This command is used only when there is no actual binding\n\
8167 for that character after that prefix key.");
8168 Vprefix_help_command
= Qnil
;
8170 DEFVAR_LISP ("top-level", &Vtop_level
,
8171 "Form to evaluate when Emacs starts up.\n\
8172 Useful to set before you dump a modified Emacs.");
8175 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8176 "Translate table for keyboard input, or nil.\n\
8177 Each character is looked up in this string and the contents used instead.\n\
8178 The value may be a string, a vector, or a char-table.\n\
8179 If it is a string or vector of length N,\n\
8180 character codes N and up are untranslated.\n\
8181 In a vector or a char-table, an element which is nil means \"no translation\".");
8182 Vkeyboard_translate_table
= Qnil
;
8184 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8185 "Non-nil means to always spawn a subshell instead of suspending,\n\
8186 even if the operating system has support for stopping a process.");
8189 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8190 "Non-nil means prompt with menus when appropriate.\n\
8191 This is done when reading from a keymap that has a prompt string,\n\
8192 for elements that have prompt strings.\n\
8193 The menu is displayed on the screen\n\
8194 if X menus were enabled at configuration\n\
8195 time and the previous event was a mouse click prefix key.\n\
8196 Otherwise, menu prompting uses the echo area.");
8199 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8200 "Character to see next line of menu prompt.\n\
8201 Type this character while in a menu prompt to rotate around the lines of it.");
8202 XSETINT (menu_prompt_more_char
, ' ');
8204 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8205 "A mask of additional modifier keys to use with every keyboard character.\n\
8206 Emacs applies the modifiers of the character stored here to each keyboard\n\
8207 character it reads. For example, after evaluating the expression\n\
8208 (setq extra-keyboard-modifiers ?\\C-x)\n\
8209 all input characters will have the control modifier applied to them.\n\
8211 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8212 not count as a control character; rather, it counts as a character\n\
8213 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8214 cancels any modification.");
8215 extra_keyboard_modifiers
= 0;
8217 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8218 "If an editing command sets this to t, deactivate the mark afterward.\n\
8219 The command loop sets this to nil before each command,\n\
8220 and tests the value when the command returns.\n\
8221 Buffer modification stores t in this variable.");
8222 Vdeactivate_mark
= Qnil
;
8224 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8225 "Temporary storage of pre-command-hook or post-command-hook.");
8226 Vcommand_hook_internal
= Qnil
;
8228 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8229 "Normal hook run before each command is executed.\n\
8230 Errors running the hook are caught and ignored.");
8231 Vpre_command_hook
= Qnil
;
8233 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8234 "Normal hook run after each command is executed.\n\
8235 Errors running the hook are caught and ignored.");
8236 Vpost_command_hook
= Qnil
;
8238 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8239 "Normal hook run after each command is executed, if idle.\n\
8240 Errors running the hook are caught and ignored.\n\
8241 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
8242 Vpost_command_idle_hook
= Qnil
;
8244 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
8245 "Delay time before running `post-command-idle-hook'.\n\
8246 This is measured in microseconds.");
8247 post_command_idle_delay
= 100000;
8250 DEFVAR_LISP ("echo-area-clear-hook", ...,
8251 "Normal hook run when clearing the echo area.");
8253 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
8254 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
8256 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
8257 "t means menu bar, specified Lucid style, needs to be recomputed.");
8258 Vlucid_menu_bar_dirty_flag
= Qnil
;
8260 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
8261 "List of menu bar items to move to the end of the menu bar.\n\
8262 The elements of the list are event types that may have menu bar bindings.");
8263 Vmenu_bar_final_items
= Qnil
;
8265 DEFVAR_KBOARD ("overriding-terminal-local-map",
8266 Voverriding_terminal_local_map
,
8267 "Keymap that overrides all other local keymaps.\n\
8268 If this variable is non-nil, it is used as a keymap instead of the\n\
8269 buffer's local map, and the minor mode keymaps and text property keymaps.");
8271 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
8272 "Keymap that overrides all other local keymaps.\n\
8273 If this variable is non-nil, it is used as a keymap instead of the\n\
8274 buffer's local map, and the minor mode keymaps and text property keymaps.");
8275 Voverriding_local_map
= Qnil
;
8277 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
8278 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8279 Otherwise, the menu bar continues to reflect the buffer's local map\n\
8280 and the minor mode maps regardless of `overriding-local-map'.");
8281 Voverriding_local_map_menu_flag
= Qnil
;
8283 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
8284 "Keymap defining bindings for special events to execute at low level.");
8285 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
8287 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
8288 "*Non-nil means generate motion events for mouse motion.");
8290 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
8291 "Alist of system-specific X windows key symbols.\n\
8292 Each element should have the form (N . SYMBOL) where N is the\n\
8293 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
8294 and SYMBOL is its name.");
8296 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
8297 "List of deferred actions to be performed at a later time.\n\
8298 The precise format isn't relevant here; we just check whether it is nil.");
8299 Vdeferred_action_list
= Qnil
;
8301 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
8302 "Function to call to handle deferred actions, after each command.\n\
8303 This function is called with no arguments after each command\n\
8304 whenever `deferred-action-list' is non-nil.");
8305 Vdeferred_action_function
= Qnil
;
8307 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
8308 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8309 The value can be a length of time to show the message for.\n\
8310 If the value is non-nil and not a number, we wait 2 seconds.");
8311 Vsuggest_key_bindings
= Qt
;
8313 DEFVAR_LISP ("timer-list", &Vtimer_list
,
8314 "List of active absolute time timers in order of increasing time");
8317 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
8318 "List of active idle-time timers in order of increasing time");
8319 Vtimer_idle_list
= Qnil
;
8324 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
8325 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
8326 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
8327 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
8328 initial_define_key (meta_map
, 'x', "execute-extended-command");
8330 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
8331 "handle-delete-frame");
8332 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
8334 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",