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. */
275 int num_input_events
;
277 /* Total number of times read_char has returned, outside of macros. */
278 int num_nonmacro_input_events
;
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_events 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 void swallow_events ();
487 Lisp_Object Qpolling_period
;
489 /* List of absolute timers. Appears in order of next scheduled event. */
490 Lisp_Object Vtimer_list
;
492 /* List of idle time timers. Appears in order of next scheduled event. */
493 Lisp_Object Vtimer_idle_list
;
495 /* Incremented whenever a timer is run. */
498 extern Lisp_Object Vprint_level
, Vprint_length
;
500 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
502 EMACS_TIME
*input_available_clear_time
;
504 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
505 Default is 1 if INTERRUPT_INPUT is defined. */
508 /* Nonzero while interrupts are temporarily deferred during redisplay. */
509 int interrupts_deferred
;
511 /* Nonzero means use ^S/^Q for flow control. */
514 /* Allow m- file to inhibit use of FIONREAD. */
515 #ifdef BROKEN_FIONREAD
519 /* We are unable to use interrupts if FIONREAD is not available,
520 so flush SIGIO so we won't try. */
527 /* If we support a window system, turn on the code to poll periodically
528 to detect C-g. It isn't actually used when doing interrupt input. */
529 #ifdef HAVE_WINDOW_SYSTEM
530 #define POLL_FOR_INPUT
533 /* Global variable declarations. */
535 /* Function for init_keyboard to call with no args (if nonzero). */
536 void (*keyboard_init_hook
) ();
538 static int read_avail_input ();
539 static void get_input_pending ();
540 static int readable_events ();
541 static Lisp_Object
read_char_x_menu_prompt ();
542 static Lisp_Object
read_char_minibuf_menu_prompt ();
543 static Lisp_Object
make_lispy_event ();
545 static Lisp_Object
make_lispy_movement ();
547 static Lisp_Object
modify_event_symbol ();
548 static Lisp_Object
make_lispy_switch_frame ();
549 static int parse_solitary_modifier ();
551 /* > 0 if we are to echo keystrokes. */
552 static int echo_keystrokes
;
554 /* Nonzero means don't try to suspend even if the operating system seems
556 static int cannot_suspend
;
558 #define min(a,b) ((a)<(b)?(a):(b))
559 #define max(a,b) ((a)>(b)?(a):(b))
561 /* Install the string STR as the beginning of the string of echoing,
562 so that it serves as a prompt for the next character.
563 Also start echoing. */
568 int len
= strlen (str
);
570 if (len
> ECHOBUFSIZE
- 4)
571 len
= ECHOBUFSIZE
- 4;
572 bcopy (str
, current_kboard
->echobuf
, len
);
573 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
574 *current_kboard
->echoptr
= '\0';
576 current_kboard
->echo_after_prompt
= len
;
581 /* Add C to the echo string, if echoing is going on.
582 C can be a character, which is printed prettily ("M-C-x" and all that
583 jazz), or a symbol, whose name is printed. */
588 extern char *push_key_description ();
590 if (current_kboard
->immediate_echo
)
592 char *ptr
= current_kboard
->echoptr
;
594 if (ptr
!= current_kboard
->echobuf
)
597 /* If someone has passed us a composite event, use its head symbol. */
602 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
605 ptr
= push_key_description (XINT (c
), ptr
);
607 else if (SYMBOLP (c
))
609 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
610 if ((ptr
- current_kboard
->echobuf
) + name
->size
+ 4 > ECHOBUFSIZE
)
612 bcopy (name
->data
, ptr
, name
->size
);
616 if (current_kboard
->echoptr
== current_kboard
->echobuf
619 strcpy (ptr
, " (Type ? for further options)");
624 current_kboard
->echoptr
= ptr
;
630 /* Temporarily add a dash to the end of the echo string if it's not
631 empty, so that it serves as a mini-prompt for the very next character. */
635 if (!current_kboard
->immediate_echo
636 && current_kboard
->echoptr
== current_kboard
->echobuf
)
638 /* Do nothing if we just printed a prompt. */
639 if (current_kboard
->echo_after_prompt
640 == current_kboard
->echoptr
- current_kboard
->echobuf
)
642 /* Do nothing if not echoing at all. */
643 if (current_kboard
->echoptr
== 0)
646 /* Put a dash at the end of the buffer temporarily,
647 but make it go away when the next character is added. */
648 current_kboard
->echoptr
[0] = '-';
649 current_kboard
->echoptr
[1] = 0;
654 /* Display the current echo string, and begin echoing if not already
659 if (!current_kboard
->immediate_echo
)
662 current_kboard
->immediate_echo
= 1;
664 for (i
= 0; i
< this_command_key_count
; i
++)
667 c
= XVECTOR (this_command_keys
)->contents
[i
];
668 if (! (EVENT_HAS_PARAMETERS (c
)
669 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
676 message1_nolog (current_kboard
->echobuf
);
679 if (waiting_for_input
&& !NILP (Vquit_flag
))
680 quit_throw_to_read_char ();
683 /* Turn off echoing, for the start of a new command. */
687 current_kboard
->immediate_echo
= 0;
688 current_kboard
->echoptr
= current_kboard
->echobuf
;
689 current_kboard
->echo_after_prompt
= -1;
690 ok_to_echo_at_next_pause
= 0;
693 /* Return the length of the current echo string. */
698 return current_kboard
->echoptr
- current_kboard
->echobuf
;
701 /* Truncate the current echo message to its first LEN chars.
702 This and echo_char get used by read_key_sequence when the user
703 switches frames while entering a key sequence. */
709 current_kboard
->echobuf
[len
] = '\0';
710 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
711 truncate_echo_area (len
);
715 /* Functions for manipulating this_command_keys. */
717 add_command_key (key
)
720 int size
= XVECTOR (this_command_keys
)->size
;
722 /* If reset-this-command-length was called recently, obey it now.
723 See the doc string of that function for an explanation of why. */
724 if (before_command_restore_flag
)
726 this_command_key_count
= before_command_key_count_1
;
727 if (this_command_key_count
< this_single_command_key_start
)
728 this_single_command_key_start
= this_command_key_count
;
729 echo_truncate (before_command_echo_length_1
);
730 before_command_restore_flag
= 0;
733 if (this_command_key_count
>= size
)
735 Lisp_Object new_keys
;
737 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
738 bcopy (XVECTOR (this_command_keys
)->contents
,
739 XVECTOR (new_keys
)->contents
,
740 size
* sizeof (Lisp_Object
));
742 this_command_keys
= new_keys
;
745 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
751 int count
= specpdl_ptr
- specpdl
;
754 if (command_loop_level
> 0)
756 specbind (Qstandard_output
, Qt
);
757 specbind (Qstandard_input
, Qt
);
760 val
= command_loop ();
762 Fsignal (Qquit
, Qnil
);
763 /* Handle throw from read_minibuf when using minibuffer
764 while it's active but we're in another window. */
766 Fsignal (Qerror
, Fcons (val
, Qnil
));
768 return unbind_to (count
, Qnil
);
771 /* When an auto-save happens, record the "time", and don't do again soon. */
775 last_auto_save
= num_nonmacro_input_events
;
778 /* Make an auto save happen as soon as possible at command level. */
780 force_auto_save_soon ()
782 last_auto_save
= - auto_save_interval
- 1;
784 record_asynch_buffer_change ();
787 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
788 "Invoke the editor command loop recursively.\n\
789 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
790 that tells this function to return.\n\
791 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
792 This function is called by the editor initialization to begin editing.")
795 int count
= specpdl_ptr
- specpdl
;
798 command_loop_level
++;
799 update_mode_lines
= 1;
801 record_unwind_protect (recursive_edit_unwind
,
803 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
807 return unbind_to (count
, Qnil
);
811 recursive_edit_unwind (buffer
)
815 Fset_buffer (buffer
);
817 command_loop_level
--;
818 update_mode_lines
= 1;
826 #if 0 /* Theory: if there's anything in Vunread_command_events,
827 it will right away be read by read_key_sequence,
828 and then if we do switch KBOARDS, it will go into the side
829 queue then. So we don't need to do anything special here -- rms. */
830 if (CONSP (Vunread_command_events
))
832 current_kboard
->kbd_queue
833 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
834 current_kboard
->kbd_queue_has_data
= 1;
836 Vunread_command_events
= Qnil
;
842 /* Switch to the single-kboard state, making current_kboard
843 the only KBOARD from which further input is accepted. */
846 single_kboard_state ()
853 /* Maintain a stack of kboards, so other parts of Emacs
854 can switch temporarily to the kboard of a given frame
855 and then revert to the previous status. */
860 struct kboard_stack
*next
;
863 static struct kboard_stack
*kboard_stack
;
866 push_frame_kboard (f
)
870 struct kboard_stack
*p
871 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
873 p
->next
= kboard_stack
;
874 p
->kboard
= current_kboard
;
877 current_kboard
= FRAME_KBOARD (f
);
885 struct kboard_stack
*p
= kboard_stack
;
886 current_kboard
= p
->kboard
;
887 kboard_stack
= p
->next
;
892 /* Handle errors that are not handled at inner levels
893 by printing an error message and returning to the editor command loop. */
899 Lisp_Object old_level
, old_length
;
902 if (!NILP (executing_macro
))
904 if (executing_macro_iterations
== 1)
905 sprintf (macroerror
, "After 1 kbd macro iteration: ");
907 sprintf (macroerror
, "After %d kbd macro iterations: ",
908 executing_macro_iterations
);
913 Vstandard_output
= Qt
;
914 Vstandard_input
= Qt
;
915 Vexecuting_macro
= Qnil
;
916 executing_macro
= Qnil
;
917 current_kboard
->Vprefix_arg
= Qnil
;
920 /* Avoid unquittable loop if data contains a circular list. */
921 old_level
= Vprint_level
;
922 old_length
= Vprint_length
;
923 XSETFASTINT (Vprint_level
, 10);
924 XSETFASTINT (Vprint_length
, 10);
925 cmd_error_internal (data
, macroerror
);
926 Vprint_level
= old_level
;
927 Vprint_length
= old_length
;
931 Vinhibit_quit
= Qnil
;
936 return make_number (0);
939 cmd_error_internal (data
, context
)
947 echo_area_glyphs
= 0;
949 /* If the window system or terminal frame hasn't been initialized
950 yet, or we're not interactive, it's best to dump this message out
951 to stderr and exit. */
952 if (! FRAME_MESSAGE_BUF (selected_frame
)
954 stream
= Qexternal_debugging_output
;
963 write_string_1 (context
, -1, stream
);
965 print_error_message (data
, stream
);
967 /* If the window system or terminal frame hasn't been initialized
968 yet, or we're in -batch mode, this error should cause Emacs to exit. */
969 if (! FRAME_MESSAGE_BUF (selected_frame
)
973 Fkill_emacs (make_number (-1));
977 Lisp_Object
command_loop_1 ();
978 Lisp_Object
command_loop_2 ();
979 Lisp_Object
top_level_1 ();
981 /* Entry to editor-command-loop.
982 This level has the catches for exiting/returning to editor command loop.
983 It returns nil to exit recursive edit, t to abort it. */
988 if (command_loop_level
> 0 || minibuf_level
> 0)
990 return internal_catch (Qexit
, command_loop_2
, Qnil
);
995 internal_catch (Qtop_level
, top_level_1
, Qnil
);
996 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
998 /* End of file in -batch run causes exit here. */
1004 /* Here we catch errors in execution of commands within the
1005 editing loop, and reenter the editing loop.
1006 When there is an error, cmd_error runs and returns a non-nil
1007 value to us. A value of nil means that cmd_loop_1 itself
1008 returned due to end of file (or end of kbd macro). */
1013 register Lisp_Object val
;
1016 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1017 while (!NILP (val
));
1025 return Feval (Vtop_level
);
1031 /* On entry to the outer level, run the startup file */
1032 if (!NILP (Vtop_level
))
1033 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1034 else if (!NILP (Vpurify_flag
))
1035 message ("Bare impure Emacs (standard Lisp code not loaded)");
1037 message ("Bare Emacs (standard Lisp code not loaded)");
1041 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1042 "Exit all recursive editing levels.")
1045 Fthrow (Qtop_level
, Qnil
);
1048 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1049 "Exit from the innermost recursive edit or minibuffer.")
1052 if (command_loop_level
> 0 || minibuf_level
> 0)
1053 Fthrow (Qexit
, Qnil
);
1055 error ("No recursive edit is in progress");
1058 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1059 "Abort the command that requested this recursive edit or minibuffer input.")
1062 if (command_loop_level
> 0 || minibuf_level
> 0)
1065 error ("No recursive edit is in progress");
1068 /* This is the actual command reading loop,
1069 sans error-handling encapsulation. */
1071 Lisp_Object
Fcommand_execute ();
1072 static int read_key_sequence ();
1073 void safe_run_hooks ();
1078 Lisp_Object cmd
, tem
;
1081 Lisp_Object keybuf
[30];
1086 struct buffer
*prev_buffer
;
1088 int was_locked
= single_kboard
;
1091 current_kboard
->Vprefix_arg
= Qnil
;
1092 Vdeactivate_mark
= Qnil
;
1093 waiting_for_input
= 0;
1098 this_command_key_count
= 0;
1099 this_single_command_key_start
= 0;
1101 /* Make sure this hook runs after commands that get errors and
1102 throw to top level. */
1103 /* Note that the value cell will never directly contain nil
1104 if the symbol is a local variable. */
1105 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1106 safe_run_hooks (Qpost_command_hook
);
1108 if (!NILP (Vdeferred_action_list
))
1109 call0 (Vdeferred_action_function
);
1111 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1113 if (NILP (Vunread_command_events
)
1114 && NILP (Vexecuting_macro
)
1115 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1116 safe_run_hooks (Qpost_command_idle_hook
);
1119 /* Do this after running Vpost_command_hook, for consistency. */
1120 current_kboard
->Vlast_command
= this_command
;
1124 /* Make sure the current window's buffer is selected. */
1125 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1126 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1128 /* Display any malloc warning that just came out. Use while because
1129 displaying one warning can cause another. */
1131 while (pending_malloc_warning
)
1132 display_malloc_warning ();
1136 Vdeactivate_mark
= Qnil
;
1138 /* If minibuffer on and echo area in use,
1139 wait 2 sec and redraw minibuffer. */
1141 if (minibuf_level
&& echo_area_glyphs
1142 && EQ (minibuf_window
, echo_area_window
))
1144 /* Bind inhibit-quit to t so that C-g gets read in
1145 rather than quitting back to the minibuffer. */
1146 int count
= specpdl_ptr
- specpdl
;
1147 specbind (Qinhibit_quit
, Qt
);
1149 Fsit_for (make_number (2), Qnil
, Qnil
);
1150 /* Clear the echo area. */
1152 safe_run_hooks (Qecho_area_clear_hook
);
1154 unbind_to (count
, Qnil
);
1156 /* If a C-g came in before, treat it as input now. */
1157 if (!NILP (Vquit_flag
))
1160 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1165 alloca (0); /* Cause a garbage collection now */
1166 /* Since we can free the most stuff here. */
1167 #endif /* C_ALLOCA */
1170 /* Select the frame that the last event came from. Usually,
1171 switch-frame events will take care of this, but if some lisp
1172 code swallows a switch-frame event, we'll fix things up here.
1173 Is this a good idea? */
1174 if (FRAMEP (internal_last_event_frame
)
1175 && XFRAME (internal_last_event_frame
) != selected_frame
)
1176 Fselect_frame (internal_last_event_frame
, Qnil
);
1178 /* If it has changed current-menubar from previous value,
1179 really recompute the menubar from the value. */
1180 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1181 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1182 call0 (Qrecompute_lucid_menubar
);
1184 before_command_key_count
= this_command_key_count
;
1185 before_command_echo_length
= echo_length ();
1187 this_command
= Qnil
;
1189 /* Read next key sequence; i gets its length. */
1190 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1193 /* A filter may have run while we were reading the input. */
1194 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1195 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1199 /* Now we have read a key sequence of length I,
1200 or else I is 0 and we found end of file. */
1202 if (i
== 0) /* End of file -- happens only in */
1203 return Qnil
; /* a kbd macro, at the end. */
1204 /* -1 means read_key_sequence got a menu that was rejected.
1205 Just loop around and read another command. */
1209 this_command_key_count
= 0;
1210 this_single_command_key_start
= 0;
1214 last_command_char
= keybuf
[i
- 1];
1216 /* If the previous command tried to force a specific window-start,
1217 forget about that, in case this command moves point far away
1218 from that position. But also throw away beg_unchanged and
1219 end_unchanged information in that case, so that redisplay will
1220 update the whole window properly. */
1221 if (!NILP (XWINDOW (selected_window
)->force_start
))
1223 XWINDOW (selected_window
)->force_start
= Qnil
;
1224 beg_unchanged
= end_unchanged
= 0;
1227 cmd
= read_key_sequence_cmd
;
1228 if (!NILP (Vexecuting_macro
))
1230 if (!NILP (Vquit_flag
))
1232 Vexecuting_macro
= Qt
;
1233 QUIT
; /* Make some noise. */
1234 /* Will return since macro now empty. */
1238 /* Do redisplay processing after this command except in special
1239 cases identified below that set no_redisplay to 1.
1240 (actually, there's currently no way to prevent the redisplay,
1241 and no_redisplay is ignored.
1242 Perhaps someday we will really implement it.) */
1245 prev_buffer
= current_buffer
;
1246 prev_modiff
= MODIFF
;
1247 last_point_position
= PT
;
1248 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1250 /* Execute the command. */
1253 /* Note that the value cell will never directly contain nil
1254 if the symbol is a local variable. */
1255 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1256 safe_run_hooks (Qpre_command_hook
);
1258 if (NILP (this_command
))
1260 /* nil means key is undefined. */
1262 current_kboard
->defining_kbd_macro
= Qnil
;
1263 update_mode_lines
= 1;
1264 current_kboard
->Vprefix_arg
= Qnil
;
1268 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1270 /* Recognize some common commands in common situations and
1271 do them directly. */
1272 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1274 struct Lisp_Char_Table
*dp
1275 = window_display_table (XWINDOW (selected_window
));
1276 lose
= FETCH_BYTE (PT
);
1277 SET_PT (forward_point (1));
1279 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1280 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1281 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1282 && (lose
>= 0x20 && lose
< 0x7f)))
1283 : (lose
>= 0x20 && lose
< 0x7f))
1284 /* To extract the case of continuation on
1285 wide-column characters. */
1286 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT
)) == 1)
1287 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1289 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1291 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1293 && !windows_or_buffers_changed
1294 && EQ (current_buffer
->selective_display
, Qnil
)
1295 && !detect_input_pending ()
1296 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1297 && NILP (Vexecuting_macro
))
1298 no_redisplay
= direct_output_forward_char (1);
1301 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1303 struct Lisp_Char_Table
*dp
1304 = window_display_table (XWINDOW (selected_window
));
1305 SET_PT (forward_point (-1));
1306 lose
= FETCH_BYTE (PT
);
1308 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1309 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1310 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1311 && (lose
>= 0x20 && lose
< 0x7f)))
1312 : (lose
>= 0x20 && lose
< 0x7f))
1313 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1315 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1317 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1319 && !windows_or_buffers_changed
1320 && EQ (current_buffer
->selective_display
, Qnil
)
1321 && !detect_input_pending ()
1322 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1323 && NILP (Vexecuting_macro
))
1324 no_redisplay
= direct_output_forward_char (-1);
1327 else if (EQ (this_command
, Qself_insert_command
)
1328 /* Try this optimization only on ascii keystrokes. */
1329 && INTEGERP (last_command_char
))
1331 unsigned int c
= XINT (last_command_char
);
1334 if (NILP (Vexecuting_macro
)
1335 && !EQ (minibuf_window
, selected_window
))
1337 if (!nonundocount
|| nonundocount
>= 20)
1344 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1346 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1348 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1350 || MODIFF
<= SAVE_MODIFF
1351 || windows_or_buffers_changed
1352 || !EQ (current_buffer
->selective_display
, Qnil
)
1353 || detect_input_pending ()
1354 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1355 || !NILP (Vexecuting_macro
));
1356 value
= internal_self_insert (c
, 0);
1363 && (PT
== ZV
|| FETCH_BYTE (PT
) == '\n'))
1365 struct Lisp_Char_Table
*dp
1366 = window_display_table (XWINDOW (selected_window
));
1373 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1376 /* Do it only for char codes
1377 that by default display as themselves. */
1378 if (lose
>= 0x20 && lose
<= 0x7e)
1379 no_redisplay
= direct_output_for_insert (lose
);
1381 else if (VECTORP (obj
)
1382 && XVECTOR (obj
)->size
== 1
1383 && (obj
= XVECTOR (obj
)->contents
[0],
1385 /* Insist face not specified in glyph. */
1386 && (XINT (obj
) & ((-1) << 8)) == 0)
1388 = direct_output_for_insert (XINT (obj
));
1392 if (lose
>= 0x20 && lose
<= 0x7e)
1393 no_redisplay
= direct_output_for_insert (lose
);
1400 /* Here for a command that isn't executed directly */
1403 if (NILP (current_kboard
->Vprefix_arg
))
1405 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1410 /* If there is a prefix argument,
1411 1) We don't want Vlast_command to be ``universal-argument''
1412 (that would be dumb), so don't set Vlast_command,
1413 2) we want to leave echoing on so that the prefix will be
1414 echoed as part of this key sequence, so don't call
1416 3) we want to leave this_command_key_count non-zero, so that
1417 read_char will realize that it is re-reading a character, and
1418 not echo it a second time.
1420 If the command didn't actually create a prefix arg,
1421 but is merely a frame event that is transparent to prefix args,
1422 then the above doesn't apply. */
1423 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1425 current_kboard
->Vlast_command
= this_command
;
1427 this_command_key_count
= 0;
1428 this_single_command_key_start
= 0;
1431 /* Note that the value cell will never directly contain nil
1432 if the symbol is a local variable. */
1433 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1434 safe_run_hooks (Qpost_command_hook
);
1436 if (!NILP (Vdeferred_action_list
))
1437 safe_run_hooks (Qdeferred_action_function
);
1439 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1441 if (NILP (Vunread_command_events
)
1442 && NILP (Vexecuting_macro
)
1443 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1444 safe_run_hooks (Qpost_command_idle_hook
);
1447 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1449 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1451 current_buffer
->mark_active
= Qnil
;
1452 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1454 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1455 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1459 /* Install chars successfully executed in kbd macro. */
1461 if (!NILP (current_kboard
->defining_kbd_macro
)
1462 && NILP (current_kboard
->Vprefix_arg
))
1463 finalize_kbd_macro_chars ();
1467 any_kboard_state ();
1472 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1475 safe_run_hooks_1 (hook
)
1478 return call1 (Vrun_hooks
, Vinhibit_quit
);
1481 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1484 safe_run_hooks_error (data
)
1487 Fset (Vinhibit_quit
, Qnil
);
1490 /* If we get an error while running the hook, cause the hook variable
1491 to be nil. Also inhibit quits, so that C-g won't cause the hook
1492 to mysteriously evaporate. */
1495 safe_run_hooks (hook
)
1499 int count
= specpdl_ptr
- specpdl
;
1500 specbind (Qinhibit_quit
, hook
);
1502 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1504 unbind_to (count
, Qnil
);
1507 /* Number of seconds between polling for input. */
1510 /* Nonzero means polling for input is temporarily suppressed. */
1511 int poll_suppress_count
;
1513 /* Nonzero if polling_for_input is actually being used. */
1514 int polling_for_input
;
1516 #ifdef POLL_FOR_INPUT
1518 /* Handle an alarm once each second and read pending input
1519 so as to handle a C-g if it comces in. */
1522 input_poll_signal (signalnum
) /* If we don't have an argument, */
1523 int signalnum
; /* some compilers complain in signal calls. */
1525 /* This causes the call to start_polling at the end
1526 to do its job. It also arranges for a quit or error
1527 from within read_avail_input to resume polling. */
1528 poll_suppress_count
++;
1529 if (interrupt_input_blocked
== 0
1530 && !waiting_for_input
)
1531 read_avail_input (0);
1532 /* Turn on the SIGALRM handler and request another alarm. */
1538 /* Begin signals to poll for input, if they are appropriate.
1539 This function is called unconditionally from various places. */
1543 #ifdef POLL_FOR_INPUT
1544 if (read_socket_hook
&& !interrupt_input
)
1546 poll_suppress_count
--;
1547 if (poll_suppress_count
== 0)
1549 signal (SIGALRM
, input_poll_signal
);
1550 polling_for_input
= 1;
1551 alarm (polling_period
);
1557 /* Nonzero if we are using polling to handle input asynchronously. */
1560 input_polling_used ()
1562 #ifdef POLL_FOR_INPUT
1563 return read_socket_hook
&& !interrupt_input
;
1569 /* Turn off polling. */
1573 #ifdef POLL_FOR_INPUT
1574 if (read_socket_hook
&& !interrupt_input
)
1576 if (poll_suppress_count
== 0)
1578 polling_for_input
= 0;
1581 poll_suppress_count
++;
1586 /* Set the value of poll_suppress_count to COUNT
1587 and start or stop polling accordingly. */
1590 set_poll_suppress_count (count
)
1593 #ifdef POLL_FOR_INPUT
1594 if (count
== 0 && poll_suppress_count
!= 0)
1596 poll_suppress_count
= 1;
1599 else if (count
!= 0 && poll_suppress_count
== 0)
1603 poll_suppress_count
= count
;
1607 /* Bind polling_period to a value at least N.
1608 But don't decrease it. */
1610 bind_polling_period (n
)
1613 #ifdef POLL_FOR_INPUT
1614 int new = polling_period
;
1620 specbind (Qpolling_period
, make_number (new));
1621 /* Start a new alarm with the new period. */
1626 /* Apply the control modifier to CHARACTER. */
1632 /* Save the upper bits here. */
1633 int upper
= c
& ~0177;
1637 /* Everything in the columns containing the upper-case letters
1638 denotes a control character. */
1639 if (c
>= 0100 && c
< 0140)
1643 /* Set the shift modifier for a control char
1644 made from a shifted letter. But only for letters! */
1645 if (oc
>= 'A' && oc
<= 'Z')
1646 c
|= shift_modifier
;
1649 /* The lower-case letters denote control characters too. */
1650 else if (c
>= 'a' && c
<= 'z')
1653 /* Include the bits for control and shift
1654 only if the basic ASCII code can't indicate them. */
1658 /* Replace the high bits. */
1659 c
|= (upper
& ~ctrl_modifier
);
1666 /* Input of single characters from keyboard */
1668 Lisp_Object
print_help ();
1669 static Lisp_Object
kbd_buffer_get_event ();
1670 static void record_char ();
1673 static jmp_buf wrong_kboard_jmpbuf
;
1676 /* read a character from the keyboard; call the redisplay if needed */
1677 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1678 -1 means do not do redisplay, but do do autosaving.
1681 /* The arguments MAPS and NMAPS are for menu prompting.
1682 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1684 PREV_EVENT is the previous input event, or nil if we are reading
1685 the first event of a key sequence.
1687 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1688 if we used a mouse menu to read the input, or zero otherwise. If
1689 USED_MOUSE_MENU is null, we don't dereference it.
1691 Value is t if we showed a menu and the user rejected it. */
1694 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1698 Lisp_Object prev_event
;
1699 int *used_mouse_menu
;
1703 jmp_buf local_getcjmp
;
1705 int key_already_recorded
= 0;
1706 Lisp_Object tem
, save
;
1707 Lisp_Object also_record
;
1708 struct gcpro gcpro1
;
1712 before_command_key_count
= this_command_key_count
;
1713 before_command_echo_length
= echo_length ();
1720 if (CONSP (Vunread_command_events
))
1722 c
= XCONS (Vunread_command_events
)->car
;
1723 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1725 /* Undo what read_char_x_menu_prompt did when it unread
1726 additional keys returned by Fx_popup_menu. */
1728 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1729 && NILP (XCONS (c
)->cdr
))
1732 if (this_command_key_count
== 0)
1738 if (unread_command_char
!= -1)
1740 XSETINT (c
, unread_command_char
);
1741 unread_command_char
= -1;
1743 if (this_command_key_count
== 0)
1749 /* If there is no function key translated before
1750 reset-this-command-lengths takes effect, forget about it. */
1751 before_command_restore_flag
= 0;
1753 if (!NILP (Vexecuting_macro
))
1755 /* We set this to Qmacro; since that's not a frame, nobody will
1756 try to switch frames on us, and the selected window will
1759 Since this event came from a macro, it would be misleading to
1760 leave internal_last_event_frame set to wherever the last
1761 real event came from. Normally, a switch-frame event selects
1762 internal_last_event_frame after each command is read, but
1763 events read from a macro should never cause a new frame to be
1765 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1767 /* Exit the macro if we are at the end.
1768 Also, some things replace the macro with t
1769 to force an early exit. */
1770 if (EQ (Vexecuting_macro
, Qt
)
1771 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1777 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1778 if (STRINGP (Vexecuting_macro
)
1779 && (XINT (c
) & 0x80))
1780 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1782 executing_macro_index
++;
1787 if (!NILP (unread_switch_frame
))
1789 c
= unread_switch_frame
;
1790 unread_switch_frame
= Qnil
;
1792 /* This event should make it into this_command_keys, and get echoed
1793 again, so we go to reread_first, rather than reread. */
1797 if (commandflag
>= 0)
1800 || detect_input_pending_run_timers (0))
1807 /* Message turns off echoing unless more keystrokes turn it on again. */
1808 if (echo_area_glyphs
&& *echo_area_glyphs
1809 && echo_area_glyphs
!= current_kboard
->echobuf
1810 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1813 /* If already echoing, continue. */
1816 /* Try reading a character via menu prompting in the minibuf.
1817 Try this before the sit-for, because the sit-for
1818 would do the wrong thing if we are supposed to do
1819 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1820 after a mouse event so don't try a minibuf menu. */
1822 if (nmaps
> 0 && INTERACTIVE
1823 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1824 /* Don't bring up a menu if we already have another event. */
1825 && NILP (Vunread_command_events
)
1826 && unread_command_char
< 0
1827 && !detect_input_pending_run_timers (0))
1829 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1832 key_already_recorded
= 1;
1837 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1838 We will do that below, temporarily for short sections of code,
1839 when appropriate. local_getcjmp must be in effect
1840 around any call to sit_for or kbd_buffer_get_event;
1841 it *must not* be in effect when we call redisplay. */
1843 if (_setjmp (local_getcjmp
))
1845 XSETINT (c
, quit_char
);
1846 XSETFRAME (internal_last_event_frame
, selected_frame
);
1847 Vlast_event_frame
= internal_last_event_frame
;
1848 /* If we report the quit char as an event,
1849 don't do so more than once. */
1850 if (!NILP (Vinhibit_quit
))
1855 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1856 if (kb
!= current_kboard
)
1858 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1859 /* We shouldn't get here if we were in single-kboard mode! */
1862 while (CONSP (*tailp
))
1863 tailp
= &XCONS (*tailp
)->cdr
;
1866 *tailp
= Fcons (c
, Qnil
);
1867 kb
->kbd_queue_has_data
= 1;
1868 current_kboard
= kb
;
1869 /* This is going to exit from read_char
1870 so we had better get rid of this frame's stuff. */
1872 longjmp (wrong_kboard_jmpbuf
, 1);
1879 timer_start_idle ();
1881 /* If in middle of key sequence and minibuffer not active,
1882 start echoing if enough time elapses. */
1884 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1885 && this_command_key_count
> 0
1887 && echo_keystrokes
> 0
1888 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1889 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1893 /* After a mouse event, start echoing right away.
1894 This is because we are probably about to display a menu,
1895 and we don't want to delay before doing so. */
1896 if (EVENT_HAS_PARAMETERS (prev_event
))
1900 save_getcjmp (save_jump
);
1901 restore_getcjmp (local_getcjmp
);
1902 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
1903 restore_getcjmp (save_jump
);
1905 && ! CONSP (Vunread_command_events
))
1910 /* Maybe auto save due to number of keystrokes. */
1912 if (commandflag
!= 0
1913 && auto_save_interval
> 0
1914 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
1915 && !detect_input_pending_run_timers (0))
1917 Fdo_auto_save (Qnil
, Qnil
);
1918 /* Hooks can actually change some buffers in auto save. */
1922 /* Try reading using an X menu.
1923 This is never confused with reading using the minibuf
1924 because the recursive call of read_char in read_char_minibuf_menu_prompt
1925 does not pass on any keymaps. */
1927 if (nmaps
> 0 && INTERACTIVE
1928 && !NILP (prev_event
)
1929 && EVENT_HAS_PARAMETERS (prev_event
)
1930 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1931 /* Don't bring up a menu if we already have another event. */
1932 && NILP (Vunread_command_events
)
1933 && unread_command_char
< 0)
1935 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1937 /* Now that we have read an event, Emacs is not idle. */
1943 /* Maybe autosave and/or garbage collect due to idleness. */
1945 if (INTERACTIVE
&& NILP (c
))
1947 int delay_level
, buffer_size
;
1949 /* Slow down auto saves logarithmically in size of current buffer,
1950 and garbage collect while we're at it. */
1951 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1952 last_non_minibuf_size
= Z
- BEG
;
1953 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1955 while (buffer_size
> 64)
1956 delay_level
++, buffer_size
-= buffer_size
>> 2;
1957 if (delay_level
< 4) delay_level
= 4;
1958 /* delay_level is 4 for files under around 50k, 7 at 100k,
1959 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1961 /* Auto save if enough time goes by without input. */
1962 if (commandflag
!= 0
1963 && num_nonmacro_input_events
> last_auto_save
1964 && INTEGERP (Vauto_save_timeout
)
1965 && XINT (Vauto_save_timeout
) > 0)
1969 save_getcjmp (save_jump
);
1970 restore_getcjmp (local_getcjmp
);
1971 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
1973 restore_getcjmp (save_jump
);
1976 && ! CONSP (Vunread_command_events
))
1978 Fdo_auto_save (Qnil
, Qnil
);
1980 /* If we have auto-saved and there is still no input
1981 available, garbage collect if there has been enough
1982 consing going on to make it worthwhile. */
1983 if (!detect_input_pending_run_timers (0)
1984 && consing_since_gc
> gc_cons_threshold
/ 2)
1985 Fgarbage_collect ();
1992 /* If this has become non-nil here, it has been set by a timer
1993 or sentinel or filter. */
1994 if (CONSP (Vunread_command_events
))
1996 c
= XCONS (Vunread_command_events
)->car
;
1997 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2000 /* Read something from current KBOARD's side queue, if possible. */
2004 if (current_kboard
->kbd_queue_has_data
)
2006 if (!CONSP (current_kboard
->kbd_queue
))
2008 c
= XCONS (current_kboard
->kbd_queue
)->car
;
2009 current_kboard
->kbd_queue
2010 = XCONS (current_kboard
->kbd_queue
)->cdr
;
2011 if (NILP (current_kboard
->kbd_queue
))
2012 current_kboard
->kbd_queue_has_data
= 0;
2013 input_pending
= readable_events (0);
2014 if (EVENT_HAS_PARAMETERS (c
)
2015 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2016 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2017 Vlast_event_frame
= internal_last_event_frame
;
2022 /* If current_kboard's side queue is empty check the other kboards.
2023 If one of them has data that we have not yet seen here,
2024 switch to it and process the data waiting for it.
2026 Note: if the events queued up for another kboard
2027 have already been seen here, and therefore are not a complete command,
2028 the kbd_queue_has_data field is 0, so we skip that kboard here.
2029 That's to avoid an infinite loop switching between kboards here. */
2030 if (NILP (c
) && !single_kboard
)
2033 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2034 if (kb
->kbd_queue_has_data
)
2036 current_kboard
= kb
;
2037 /* This is going to exit from read_char
2038 so we had better get rid of this frame's stuff. */
2040 longjmp (wrong_kboard_jmpbuf
, 1);
2049 /* Finally, we read from the main queue,
2050 and if that gives us something we can't use yet, we put it on the
2051 appropriate side queue and try again. */
2057 /* Actually read a character, waiting if necessary. */
2058 save_getcjmp (save_jump
);
2059 restore_getcjmp (local_getcjmp
);
2060 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2061 restore_getcjmp (save_jump
);
2064 if (! NILP (c
) && (kb
!= current_kboard
))
2066 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2067 while (CONSP (*tailp
))
2068 tailp
= &XCONS (*tailp
)->cdr
;
2071 *tailp
= Fcons (c
, Qnil
);
2072 kb
->kbd_queue_has_data
= 1;
2076 current_kboard
= kb
;
2077 /* This is going to exit from read_char
2078 so we had better get rid of this frame's stuff. */
2080 longjmp (wrong_kboard_jmpbuf
, 1);
2085 /* Terminate Emacs in batch mode if at eof. */
2086 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2087 Fkill_emacs (make_number (1));
2091 /* Add in any extra modifiers, where appropriate. */
2092 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2093 || ((extra_keyboard_modifiers
& 0177) < ' '
2094 && (extra_keyboard_modifiers
& 0177) != 0))
2095 XSETINT (c
, make_ctrl_char (XINT (c
)));
2097 /* Transfer any other modifier bits directly from
2098 extra_keyboard_modifiers to c. Ignore the actual character code
2099 in the low 16 bits of extra_keyboard_modifiers. */
2100 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2111 if (commandflag
>= 0
2112 && !input_pending
&& !detect_input_pending_run_timers (0))
2120 /* Buffer switch events are only for internal wakeups
2121 so don't show them to the user.
2122 Also, don't record a key if we already did. */
2123 if (BUFFERP (c
) || key_already_recorded
)
2126 /* Process special events within read_char
2127 and loop around to read another event. */
2130 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2136 int was_locked
= single_kboard
;
2138 last_input_char
= c
;
2139 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2141 /* Resume allowing input from any kboard, if that was true before. */
2143 any_kboard_state ();
2148 /* Wipe the echo area. */
2149 if (echo_area_glyphs
)
2150 safe_run_hooks (Qecho_area_clear_hook
);
2151 echo_area_glyphs
= 0;
2153 /* Handle things that only apply to characters. */
2156 /* If kbd_buffer_get_event gave us an EOF, return that. */
2160 if (STRINGP (Vkeyboard_translate_table
)
2161 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2162 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2163 else if ((VECTORP (Vkeyboard_translate_table
)
2164 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2165 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2166 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2169 d
= Faref (Vkeyboard_translate_table
, c
);
2170 /* nil in keyboard-translate-table means no translation. */
2176 /* If this event is a mouse click in the menu bar,
2177 return just menu-bar for now. Modify the mouse click event
2178 so we won't do this twice, then queue it up. */
2179 if (EVENT_HAS_PARAMETERS (c
)
2180 && CONSP (XCONS (c
)->cdr
)
2181 && CONSP (EVENT_START (c
))
2182 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2186 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2187 /* Handle menu-bar events:
2188 insert the dummy prefix event `menu-bar'. */
2189 if (EQ (posn
, Qmenu_bar
))
2191 /* Change menu-bar to (menu-bar) as the event "position". */
2192 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2195 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2201 if (! NILP (also_record
))
2202 record_char (also_record
);
2207 before_command_key_count
= this_command_key_count
;
2208 before_command_echo_length
= echo_length ();
2210 /* Don't echo mouse motion events. */
2212 && ! (EVENT_HAS_PARAMETERS (c
)
2213 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2216 if (! NILP (also_record
))
2217 echo_char (also_record
);
2218 /* Once we reread a character, echoing can happen
2219 the next time we pause to read a new one. */
2220 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2223 /* Record this character as part of the current key. */
2224 add_command_key (c
);
2225 if (! NILP (also_record
))
2226 add_command_key (also_record
);
2228 /* Re-reading in the middle of a command */
2230 last_input_char
= c
;
2233 /* Process the help character specially if enabled */
2234 if (!NILP (Vhelp_form
) && help_char_p (c
))
2237 count
= specpdl_ptr
- specpdl
;
2239 record_unwind_protect (Fset_window_configuration
,
2240 Fcurrent_window_configuration (Qnil
));
2242 tem0
= Feval (Vhelp_form
);
2244 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2248 c
= read_char (0, 0, 0, Qnil
, 0);
2249 while (BUFFERP (c
));
2250 /* Remove the help from the frame */
2251 unbind_to (count
, Qnil
);
2254 if (EQ (c
, make_number (040)))
2258 c
= read_char (0, 0, 0, Qnil
, 0);
2259 while (BUFFERP (c
));
2266 /* Record a key that came from a mouse menu.
2267 Record it for echoing, for this-command-keys, and so on. */
2273 /* Wipe the echo area. */
2274 echo_area_glyphs
= 0;
2278 before_command_key_count
= this_command_key_count
;
2279 before_command_echo_length
= echo_length ();
2281 /* Don't echo mouse motion events. */
2282 if (echo_keystrokes
)
2286 /* Once we reread a character, echoing can happen
2287 the next time we pause to read a new one. */
2288 ok_to_echo_at_next_pause
= 0;
2291 /* Record this character as part of the current key. */
2292 add_command_key (c
);
2294 /* Re-reading in the middle of a command */
2295 last_input_char
= c
;
2299 /* Return 1 if should recognize C as "the help character". */
2307 if (EQ (c
, Vhelp_char
))
2309 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2310 if (EQ (c
, XCONS (tail
)->car
))
2315 /* Record the input event C in various ways. */
2322 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2323 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2324 recent_keys_index
= 0;
2326 /* Write c to the dribble file. If c is a lispy event, write
2327 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2328 If you, dear reader, have a better idea, you've got the source. :-) */
2333 if (XUINT (c
) < 0x100)
2334 putc (XINT (c
), dribble
);
2336 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2340 Lisp_Object dribblee
;
2342 /* If it's a structured event, take the event header. */
2343 dribblee
= EVENT_HEAD (c
);
2345 if (SYMBOLP (dribblee
))
2347 putc ('<', dribble
);
2348 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2349 XSYMBOL (dribblee
)->name
->size
,
2351 putc ('>', dribble
);
2358 store_kbd_macro_char (c
);
2360 num_nonmacro_input_events
++;
2367 struct buffer
*old
= current_buffer
;
2368 Fprinc (object
, Qnil
);
2369 set_buffer_internal (XBUFFER (Vstandard_output
));
2370 call0 (intern ("help-mode"));
2371 set_buffer_internal (old
);
2375 /* Copy out or in the info on where C-g should throw to.
2376 This is used when running Lisp code from within get_char,
2377 in case get_char is called recursively.
2378 See read_process_output. */
2383 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2386 restore_getcjmp (temp
)
2389 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2394 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2395 of this function. */
2398 tracking_off (old_value
)
2399 Lisp_Object old_value
;
2401 do_mouse_tracking
= old_value
;
2402 if (NILP (old_value
))
2404 /* Redisplay may have been preempted because there was input
2405 available, and it assumes it will be called again after the
2406 input has been processed. If the only input available was
2407 the sort that we have just disabled, then we need to call
2409 if (!readable_events (1))
2411 redisplay_preserve_echo_area ();
2412 get_input_pending (&input_pending
, 1);
2417 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2418 "Evaluate BODY with mouse movement events enabled.\n\
2419 Within a `track-mouse' form, mouse motion generates input events that\n\
2420 you can read with `read-event'.\n\
2421 Normally, mouse motion is ignored.")
2425 int count
= specpdl_ptr
- specpdl
;
2428 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2430 do_mouse_tracking
= Qt
;
2432 val
= Fprogn (args
);
2433 return unbind_to (count
, val
);
2436 /* If mouse has moved on some frame, return one of those frames.
2437 Return 0 otherwise. */
2442 Lisp_Object tail
, frame
;
2444 FOR_EACH_FRAME (tail
, frame
)
2446 if (XFRAME (frame
)->mouse_moved
)
2447 return XFRAME (frame
);
2453 #endif /* HAVE_MOUSE */
2455 /* Low level keyboard/mouse input.
2456 kbd_buffer_store_event places events in kbd_buffer, and
2457 kbd_buffer_get_event retrieves them. */
2459 /* Return true iff there are any events in the queue that read-char
2460 would return. If this returns false, a read-char would block. */
2462 readable_events (do_timers_now
)
2466 timer_check (do_timers_now
);
2468 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2471 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2476 if (current_kboard
->kbd_queue_has_data
)
2482 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2483 if (kb
->kbd_queue_has_data
)
2489 /* Set this for debugging, to have a way to get out */
2494 event_to_kboard (event
)
2495 struct input_event
*event
;
2498 frame
= event
->frame_or_window
;
2500 frame
= XCONS (frame
)->car
;
2501 else if (WINDOWP (frame
))
2502 frame
= WINDOW_FRAME (XWINDOW (frame
));
2504 /* There are still some events that don't set this field.
2505 For now, just ignore the problem.
2506 Also ignore dead frames here. */
2507 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2510 return FRAME_KBOARD (XFRAME (frame
));
2514 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2517 kbd_buffer_store_event (event
)
2518 register struct input_event
*event
;
2520 if (event
->kind
== no_event
)
2523 if (event
->kind
== ascii_keystroke
)
2525 register int c
= event
->code
& 0377;
2527 if (event
->modifiers
& ctrl_modifier
)
2528 c
= make_ctrl_char (c
);
2530 c
|= (event
->modifiers
2531 & (meta_modifier
| alt_modifier
2532 | hyper_modifier
| super_modifier
));
2536 extern SIGTYPE
interrupt_signal ();
2539 struct input_event
*sp
;
2542 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2543 kb
!= current_kboard
))
2546 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2547 Fcons (make_number (c
), Qnil
));
2548 kb
->kbd_queue_has_data
= 1;
2549 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2551 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2554 if (event_to_kboard (sp
) == kb
)
2556 sp
->kind
= no_event
;
2557 sp
->frame_or_window
= Qnil
;
2564 /* If this results in a quit_char being returned to Emacs as
2565 input, set Vlast_event_frame properly. If this doesn't
2566 get returned to Emacs as an event, the next event read
2567 will set Vlast_event_frame again, so this is safe to do. */
2571 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2573 focus
= event
->frame_or_window
;
2574 internal_last_event_frame
= focus
;
2575 Vlast_event_frame
= focus
;
2578 last_event_timestamp
= event
->timestamp
;
2579 interrupt_signal ();
2583 if (c
&& c
== stop_character
)
2589 /* Don't insert two buffer_switch_event's in a row.
2590 Just ignore the second one. */
2591 else if (event
->kind
== buffer_switch_event
2592 && kbd_fetch_ptr
!= kbd_store_ptr
2593 && kbd_store_ptr
->kind
== buffer_switch_event
)
2596 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2597 kbd_store_ptr
= kbd_buffer
;
2599 /* Don't let the very last slot in the buffer become full,
2600 since that would make the two pointers equal,
2601 and that is indistinguishable from an empty buffer.
2602 Discard the event if it would fill the last slot. */
2603 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2605 volatile struct input_event
*sp
= kbd_store_ptr
;
2606 sp
->kind
= event
->kind
;
2607 if (event
->kind
== selection_request_event
)
2609 /* We must not use the ordinary copying code for this case,
2610 since `part' is an enum and copying it might not copy enough
2612 bcopy (event
, (char *) sp
, sizeof (*event
));
2616 sp
->code
= event
->code
;
2617 sp
->part
= event
->part
;
2618 sp
->frame_or_window
= event
->frame_or_window
;
2619 sp
->modifiers
= event
->modifiers
;
2622 sp
->timestamp
= event
->timestamp
;
2624 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2626 = event
->frame_or_window
);
2632 /* Read one event from the event buffer, waiting if necessary.
2633 The value is a Lisp object representing the event.
2634 The value is nil for an event that should be ignored,
2635 or that was handled here.
2636 We always read and discard one event. */
2639 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2641 int *used_mouse_menu
;
2645 EMACS_TIME next_timer_delay
;
2651 *kbp
= current_kboard
;
2655 /* Wait until there is input available. */
2658 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2661 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2665 /* If the quit flag is set, then read_char will return
2666 quit_char, so that counts as "available input." */
2667 if (!NILP (Vquit_flag
))
2668 quit_throw_to_read_char ();
2670 /* One way or another, wait until input is available; then, if
2671 interrupt handlers have not read it, read it now. */
2674 wait_for_kbd_input ();
2676 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2680 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2683 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2687 Lisp_Object minus_one
;
2689 XSETINT (minus_one
, -1);
2690 wait_reading_process_input (0, 0, minus_one
, 1);
2692 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2693 /* Pass 1 for EXPECT since we just waited to have input. */
2694 read_avail_input (1);
2696 #endif /* not VMS */
2699 if (CONSP (Vunread_command_events
))
2702 first
= XCONS (Vunread_command_events
)->car
;
2703 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2704 *kbp
= current_kboard
;
2708 /* At this point, we know that there is a readable event available
2709 somewhere. If the event queue is empty, then there must be a
2710 mouse movement enabled and available. */
2711 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2713 struct input_event
*event
;
2715 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2719 last_event_timestamp
= event
->timestamp
;
2722 *kbp
= event_to_kboard (event
);
2724 *kbp
= current_kboard
; /* Better than returning null ptr? */
2726 *kbp
= &the_only_kboard
;
2731 /* These two kinds of events get special handling
2732 and don't actually appear to the command loop.
2733 We return nil for them. */
2734 if (event
->kind
== selection_request_event
)
2737 struct input_event copy
;
2739 /* Remove it from the buffer before processing it,
2740 since otherwise swallow_events will see it
2741 and process it again. */
2743 kbd_fetch_ptr
= event
+ 1;
2744 input_pending
= readable_events (0);
2745 x_handle_selection_request (©
);
2747 /* We're getting selection request events, but we don't have
2753 else if (event
->kind
== selection_clear_event
)
2756 struct input_event copy
;
2758 /* Remove it from the buffer before processing it. */
2760 kbd_fetch_ptr
= event
+ 1;
2761 input_pending
= readable_events (0);
2762 x_handle_selection_clear (©
);
2764 /* We're getting selection request events, but we don't have
2769 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2770 else if (event
->kind
== delete_window_event
)
2772 /* Make an event (delete-frame (FRAME)). */
2773 obj
= Fcons (event
->frame_or_window
, Qnil
);
2774 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2775 kbd_fetch_ptr
= event
+ 1;
2777 else if (event
->kind
== iconify_event
)
2779 /* Make an event (iconify-frame (FRAME)). */
2780 obj
= Fcons (event
->frame_or_window
, Qnil
);
2781 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2782 kbd_fetch_ptr
= event
+ 1;
2784 else if (event
->kind
== deiconify_event
)
2786 /* Make an event (make-frame-visible (FRAME)). */
2787 obj
= Fcons (event
->frame_or_window
, Qnil
);
2788 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2789 kbd_fetch_ptr
= event
+ 1;
2792 else if (event
->kind
== buffer_switch_event
)
2794 /* The value doesn't matter here; only the type is tested. */
2795 XSETBUFFER (obj
, current_buffer
);
2796 kbd_fetch_ptr
= event
+ 1;
2798 #ifdef USE_X_TOOLKIT
2799 else if (event
->kind
== menu_bar_activate_event
)
2801 kbd_fetch_ptr
= event
+ 1;
2802 input_pending
= readable_events (0);
2803 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2804 x_activate_menubar (XFRAME (event
->frame_or_window
));
2807 /* Just discard these, by returning nil.
2808 With MULTI_KBOARD, these events are used as placeholders
2809 when we need to randomly delete events from the queue.
2810 (They shouldn't otherwise be found in the buffer,
2811 but on some machines it appears they do show up
2812 even without MULTI_KBOARD.) */
2813 else if (event
->kind
== no_event
)
2814 kbd_fetch_ptr
= event
+ 1;
2816 /* If this event is on a different frame, return a switch-frame this
2817 time, and leave the event in the queue for next time. */
2823 frame
= event
->frame_or_window
;
2825 frame
= XCONS (frame
)->car
;
2826 else if (WINDOWP (frame
))
2827 frame
= WINDOW_FRAME (XWINDOW (frame
));
2829 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2833 if (! EQ (frame
, internal_last_event_frame
)
2834 && XFRAME (frame
) != selected_frame
)
2835 obj
= make_lispy_switch_frame (frame
);
2836 internal_last_event_frame
= frame
;
2838 /* If we didn't decide to make a switch-frame event, go ahead
2839 and build a real event from the queue entry. */
2843 obj
= make_lispy_event (event
);
2844 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2845 /* If this was a menu selection, then set the flag to inhibit
2846 writing to last_nonmenu_event. Don't do this if the event
2847 we're returning is (menu-bar), though; that indicates the
2848 beginning of the menu sequence, and we might as well leave
2849 that as the `event with parameters' for this selection. */
2850 if (event
->kind
== menu_bar_event
2851 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2853 *used_mouse_menu
= 1;
2856 /* Wipe out this event, to catch bugs. */
2857 event
->kind
= no_event
;
2858 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2860 kbd_fetch_ptr
= event
+ 1;
2865 /* Try generating a mouse motion event. */
2866 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2868 FRAME_PTR f
= some_mouse_moved ();
2869 Lisp_Object bar_window
;
2870 enum scroll_bar_part part
;
2874 *kbp
= current_kboard
;
2875 /* Note that this uses F to determine which display to look at.
2876 If there is no valid info, it does not store anything
2877 so x remains nil. */
2879 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2883 /* Decide if we should generate a switch-frame event. Don't
2884 generate switch-frame events for motion outside of all Emacs
2890 frame
= FRAME_FOCUS_FRAME (f
);
2892 XSETFRAME (frame
, f
);
2894 if (! EQ (frame
, internal_last_event_frame
)
2895 && XFRAME (frame
) != selected_frame
)
2896 obj
= make_lispy_switch_frame (frame
);
2897 internal_last_event_frame
= frame
;
2900 /* If we didn't decide to make a switch-frame event, go ahead and
2901 return a mouse-motion event. */
2902 if (!NILP (x
) && NILP (obj
))
2903 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2905 #endif /* HAVE_MOUSE */
2907 /* We were promised by the above while loop that there was
2908 something for us to read! */
2911 input_pending
= readable_events (0);
2913 Vlast_event_frame
= internal_last_event_frame
;
2918 /* Process any events that are not user-visible,
2919 then return, without reading any user-visible events. */
2922 swallow_events (do_display
)
2927 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2929 struct input_event
*event
;
2931 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2935 last_event_timestamp
= event
->timestamp
;
2937 /* These two kinds of events get special handling
2938 and don't actually appear to the command loop. */
2939 if (event
->kind
== selection_request_event
)
2942 struct input_event copy
;
2944 /* Remove it from the buffer before processing it,
2945 since otherwise swallow_events called recursively could see it
2946 and process it again. */
2948 kbd_fetch_ptr
= event
+ 1;
2949 input_pending
= readable_events (0);
2950 x_handle_selection_request (©
);
2952 /* We're getting selection request events, but we don't have
2958 else if (event
->kind
== selection_clear_event
)
2961 struct input_event copy
;
2963 /* Remove it from the buffer before processing it, */
2966 kbd_fetch_ptr
= event
+ 1;
2967 input_pending
= readable_events (0);
2968 x_handle_selection_clear (©
);
2970 /* We're getting selection request events, but we don't have
2979 old_timers_run
= timers_run
;
2980 get_input_pending (&input_pending
, 1);
2982 if (timers_run
!= old_timers_run
&& do_display
)
2983 redisplay_preserve_echo_area ();
2986 static EMACS_TIME timer_idleness_start_time
;
2988 /* Record the start of when Emacs is idle,
2989 for the sake of running idle-time timers. */
2995 /* If we are already in the idle state, do nothing. */
2996 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2999 EMACS_GET_TIME (timer_idleness_start_time
);
3001 /* Mark all idle-time timers as once again candidates for running. */
3002 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
3006 timer
= XCONS (timers
)->car
;
3008 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3010 XVECTOR (timer
)->contents
[0] = Qnil
;
3014 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3018 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3021 /* This is only for debugging. */
3022 struct input_event last_timer_event
;
3024 /* Check whether a timer has fired. To prevent larger problems we simply
3025 disregard elements that are not proper timers. Do not make a circular
3026 timer list for the time being.
3028 Returns the number of seconds to wait until the next timer fires. If a
3029 timer is triggering now, return zero seconds.
3030 If no timer is active, return -1 seconds.
3032 If a timer is ripe, we run it, with quitting turned off.
3034 DO_IT_NOW is now ignored. It used to mean that we should
3035 run the timer directly instead of queueing a timer-event.
3036 Now we always run timers directly. */
3039 timer_check (do_it_now
)
3042 EMACS_TIME nexttime
;
3043 EMACS_TIME now
, idleness_now
;
3044 Lisp_Object timers
, idle_timers
, chosen_timer
;
3045 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3047 EMACS_SET_SECS (nexttime
, -1);
3048 EMACS_SET_USECS (nexttime
, -1);
3050 /* Always consider the ordinary timers. */
3051 timers
= Vtimer_list
;
3052 /* Consider the idle timers only if Emacs is idle. */
3053 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3054 idle_timers
= Vtimer_idle_list
;
3057 chosen_timer
= Qnil
;
3058 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3060 if (CONSP (timers
) || CONSP (idle_timers
))
3062 EMACS_GET_TIME (now
);
3063 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3064 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3067 while (CONSP (timers
) || CONSP (idle_timers
))
3069 int triggertime
= EMACS_SECS (now
);
3070 Lisp_Object
*vector
;
3071 Lisp_Object timer
, idle_timer
;
3072 EMACS_TIME timer_time
, idle_timer_time
;
3073 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3075 /* Skip past invalid timers and timers already handled. */
3078 timer
= XCONS (timers
)->car
;
3079 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3081 timers
= XCONS (timers
)->cdr
;
3084 vector
= XVECTOR (timer
)->contents
;
3086 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3087 || !INTEGERP (vector
[3])
3088 || ! NILP (vector
[0]))
3090 timers
= XCONS (timers
)->cdr
;
3094 if (!NILP (idle_timers
))
3096 timer
= XCONS (idle_timers
)->car
;
3097 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3099 idle_timers
= XCONS (idle_timers
)->cdr
;
3102 vector
= XVECTOR (timer
)->contents
;
3104 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3105 || !INTEGERP (vector
[3])
3106 || ! NILP (vector
[0]))
3108 idle_timers
= XCONS (idle_timers
)->cdr
;
3113 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3114 based on the next ordinary timer.
3115 TIMER_DIFFERENCE is the distance in time from NOW to when
3116 this timer becomes ripe (negative if it's already ripe). */
3119 timer
= XCONS (timers
)->car
;
3120 vector
= XVECTOR (timer
)->contents
;
3121 EMACS_SET_SECS (timer_time
,
3122 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3123 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3124 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3127 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3128 based on the next idle timer. */
3129 if (!NILP (idle_timers
))
3131 idle_timer
= XCONS (idle_timers
)->car
;
3132 vector
= XVECTOR (idle_timer
)->contents
;
3133 EMACS_SET_SECS (idle_timer_time
,
3134 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3135 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3136 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3139 /* Decide which timer is the next timer,
3140 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3141 Also step down the list where we found that timer. */
3143 if (! NILP (timers
) && ! NILP (idle_timers
))
3146 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3147 if (EMACS_TIME_NEG_P (temp
))
3149 chosen_timer
= timer
;
3150 timers
= XCONS (timers
)->cdr
;
3151 difference
= timer_difference
;
3155 chosen_timer
= idle_timer
;
3156 idle_timers
= XCONS (idle_timers
)->cdr
;
3157 difference
= idle_timer_difference
;
3160 else if (! NILP (timers
))
3162 chosen_timer
= timer
;
3163 timers
= XCONS (timers
)->cdr
;
3164 difference
= timer_difference
;
3168 chosen_timer
= idle_timer
;
3169 idle_timers
= XCONS (idle_timers
)->cdr
;
3170 difference
= idle_timer_difference
;
3172 vector
= XVECTOR (chosen_timer
)->contents
;
3174 /* If timer is rupe, run it if it hasn't been run. */
3175 if (EMACS_TIME_NEG_P (difference
)
3176 || (EMACS_SECS (difference
) == 0
3177 && EMACS_USECS (difference
) == 0))
3179 if (NILP (vector
[0]))
3182 int was_locked
= single_kboard
;
3183 int count
= specpdl_ptr
- specpdl
;
3185 /* Mark the timer as triggered to prevent problems if the lisp
3186 code fails to reschedule it right. */
3189 specbind (Qinhibit_quit
, Qt
);
3191 call1 (Qtimer_event_handler
, chosen_timer
);
3194 unbind_to (count
, Qnil
);
3196 /* Resume allowing input from any kboard, if that was true before. */
3198 any_kboard_state ();
3200 /* Since we have handled the event,
3201 we don't need to tell the caller to wake up and do it. */
3205 /* When we encounter a timer that is still waiting,
3206 return the amount of time to wait before it is ripe. */
3213 /* No timers are pending in the future. */
3214 /* Return 0 if we generated an event, and -1 if not. */
3219 /* Caches for modify_event_symbol. */
3220 static Lisp_Object accent_key_syms
;
3221 static Lisp_Object func_key_syms
;
3222 static Lisp_Object mouse_syms
;
3224 /* This is a list of keysym codes for special "accent" characters.
3225 It parallels lispy_accent_keys. */
3227 static int lispy_accent_codes
[] =
3229 #ifdef XK_dead_circumflex
3234 #ifdef XK_dead_grave
3239 #ifdef XK_dead_tilde
3244 #ifdef XK_dead_diaeresis
3249 #ifdef XK_dead_macron
3254 #ifdef XK_dead_degree
3259 #ifdef XK_dead_acute
3264 #ifdef XK_dead_cedilla
3269 #ifdef XK_dead_breve
3274 #ifdef XK_dead_ogonek
3279 #ifdef XK_dead_caron
3284 #ifdef XK_dead_doubleacute
3285 XK_dead_doubleacute
,
3289 #ifdef XK_dead_abovedot
3296 /* This is a list of Lisp names for special "accent" characters.
3297 It parallels lispy_accent_codes. */
3299 static char *lispy_accent_keys
[] =
3317 #define FUNCTION_KEY_OFFSET 0x0
3319 char *lispy_function_keys
[] =
3323 0, /* VK_LBUTTON 0x01 */
3324 0, /* VK_RBUTTON 0x02 */
3325 "cancel", /* VK_CANCEL 0x03 */
3326 0, /* VK_MBUTTON 0x04 */
3328 0, 0, 0, /* 0x05 .. 0x07 */
3330 "backspace", /* VK_BACK 0x08 */
3331 "tab", /* VK_TAB 0x09 */
3333 0, 0, /* 0x0A .. 0x0B */
3335 "clear", /* VK_CLEAR 0x0C */
3336 "return", /* VK_RETURN 0x0D */
3338 0, 0, /* 0x0E .. 0x0F */
3340 "shift", /* VK_SHIFT 0x10 */
3341 "control", /* VK_CONTROL 0x11 */
3342 "menu", /* VK_MENU 0x12 */
3343 "pause", /* VK_PAUSE 0x13 */
3344 "capital", /* VK_CAPITAL 0x14 */
3346 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3348 0, /* VK_ESCAPE 0x1B */
3350 0, 0, 0, 0, /* 0x1C .. 0x1F */
3352 0, /* VK_SPACE 0x20 */
3353 "prior", /* VK_PRIOR 0x21 */
3354 "next", /* VK_NEXT 0x22 */
3355 "end", /* VK_END 0x23 */
3356 "home", /* VK_HOME 0x24 */
3357 "left", /* VK_LEFT 0x25 */
3358 "up", /* VK_UP 0x26 */
3359 "right", /* VK_RIGHT 0x27 */
3360 "down", /* VK_DOWN 0x28 */
3361 "select", /* VK_SELECT 0x29 */
3362 "print", /* VK_PRINT 0x2A */
3363 "execute", /* VK_EXECUTE 0x2B */
3364 "snapshot", /* VK_SNAPSHOT 0x2C */
3365 "insert", /* VK_INSERT 0x2D */
3366 "delete", /* VK_DELETE 0x2E */
3367 "help", /* VK_HELP 0x2F */
3369 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3371 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3373 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3375 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3377 0, 0, 0, 0, 0, 0, 0, 0, 0,
3378 0, 0, 0, 0, 0, 0, 0, 0, 0,
3379 0, 0, 0, 0, 0, 0, 0, 0,
3381 "lwindow", /* VK_LWIN 0x5B */
3382 "rwindow", /* VK_RWIN 0x5C */
3383 "apps", /* VK_APPS 0x5D */
3385 0, 0, /* 0x5E .. 0x5F */
3387 "kp-0", /* VK_NUMPAD0 0x60 */
3388 "kp-1", /* VK_NUMPAD1 0x61 */
3389 "kp-2", /* VK_NUMPAD2 0x62 */
3390 "kp-3", /* VK_NUMPAD3 0x63 */
3391 "kp-4", /* VK_NUMPAD4 0x64 */
3392 "kp-5", /* VK_NUMPAD5 0x65 */
3393 "kp-6", /* VK_NUMPAD6 0x66 */
3394 "kp-7", /* VK_NUMPAD7 0x67 */
3395 "kp-8", /* VK_NUMPAD8 0x68 */
3396 "kp-9", /* VK_NUMPAD9 0x69 */
3397 "kp-multiply", /* VK_MULTIPLY 0x6A */
3398 "kp-add", /* VK_ADD 0x6B */
3399 "kp-separator", /* VK_SEPARATOR 0x6C */
3400 "kp-subtract", /* VK_SUBTRACT 0x6D */
3401 "kp-decimal", /* VK_DECIMAL 0x6E */
3402 "kp-divide", /* VK_DIVIDE 0x6F */
3403 "f1", /* VK_F1 0x70 */
3404 "f2", /* VK_F2 0x71 */
3405 "f3", /* VK_F3 0x72 */
3406 "f4", /* VK_F4 0x73 */
3407 "f5", /* VK_F5 0x74 */
3408 "f6", /* VK_F6 0x75 */
3409 "f7", /* VK_F7 0x76 */
3410 "f8", /* VK_F8 0x77 */
3411 "f9", /* VK_F9 0x78 */
3412 "f10", /* VK_F10 0x79 */
3413 "f11", /* VK_F11 0x7A */
3414 "f12", /* VK_F12 0x7B */
3415 "f13", /* VK_F13 0x7C */
3416 "f14", /* VK_F14 0x7D */
3417 "f15", /* VK_F15 0x7E */
3418 "f16", /* VK_F16 0x7F */
3419 "f17", /* VK_F17 0x80 */
3420 "f18", /* VK_F18 0x81 */
3421 "f19", /* VK_F19 0x82 */
3422 "f20", /* VK_F20 0x83 */
3423 "f21", /* VK_F21 0x84 */
3424 "f22", /* VK_F22 0x85 */
3425 "f23", /* VK_F23 0x86 */
3426 "f24", /* VK_F24 0x87 */
3428 0, 0, 0, 0, /* 0x88 .. 0x8B */
3429 0, 0, 0, 0, /* 0x8C .. 0x8F */
3431 "kp-numlock", /* VK_NUMLOCK 0x90 */
3432 "scroll", /* VK_SCROLL 0x91 */
3434 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3435 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3436 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3437 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3438 "kp-end", /* VK_NUMPAD_END 0x96 */
3439 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3440 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3441 "kp-up", /* VK_NUMPAD_UP 0x99 */
3442 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3443 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3444 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3445 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3447 0, 0, /* 0x9E .. 0x9F */
3450 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3451 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3452 * No other API or message will distinguish left and right keys this way.
3456 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3457 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3458 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3459 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3460 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3466 "attn", /* VK_ATTN 0xF6 */
3467 "crsel", /* VK_CRSEL 0xF7 */
3468 "exsel", /* VK_EXSEL 0xF8 */
3469 "ereof", /* VK_EREOF 0xF9 */
3470 "play", /* VK_PLAY 0xFA */
3471 "zoom", /* VK_ZOOM 0xFB */
3472 "noname", /* VK_NONAME 0xFC */
3473 "pa1", /* VK_PA1 0xFD */
3474 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3477 #else /* not HAVE_NTGUI */
3480 static char *lispy_kana_keys
[] =
3482 /* X Keysym value */
3483 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3484 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3485 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3486 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3487 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3488 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3489 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3490 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3491 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3492 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3493 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3494 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3495 "kana-i", "kana-u", "kana-e", "kana-o",
3496 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3497 "prolongedsound", "kana-A", "kana-I", "kana-U",
3498 "kana-E", "kana-O", "kana-KA", "kana-KI",
3499 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3500 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3501 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3502 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3503 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3504 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3505 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3506 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3507 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3508 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3509 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3510 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3512 #endif /* XK_kana_A */
3514 #define FUNCTION_KEY_OFFSET 0xff00
3516 /* You'll notice that this table is arranged to be conveniently
3517 indexed by X Windows keysym values. */
3518 static char *lispy_function_keys
[] =
3520 /* X Keysym value */
3522 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3530 0, 0, 0, /* 0xff10 */
3532 0, 0, 0, 0, 0, 0, 0,
3535 0, "kanji", "muhenkan",
3536 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3537 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3538 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3540 "home", /* 0xff50 */ /* IsCursorKey */
3551 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3562 "break", /* 0xff6b */
3564 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3566 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3567 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3568 0, 0, 0, 0, 0, 0, 0, 0,
3569 "kp-tab", /* 0xff89 */
3571 "kp-enter", /* 0xff8d */
3573 "kp-f1", /* 0xff91 */
3577 "kp-home", /* 0xff95 */
3582 "kp-prior", /* kp-page-up */
3583 "kp-next", /* kp-page-down */
3589 0, 0, 0, 0, 0, 0, 0, 0, 0,
3590 "kp-multiply", /* 0xffaa */
3595 "kp-divide", /* 0xffaf */
3596 "kp-0", /* 0xffb0 */
3597 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3600 "kp-equal", /* 0xffbd */
3601 "f1", /* 0xffbe */ /* IsFunctionKey */
3603 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3604 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3605 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3606 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3607 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3608 0, 0, 0, 0, 0, 0, 0, 0,
3609 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3610 0, 0, 0, 0, 0, 0, 0, "delete"
3613 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3614 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3616 static char *iso_lispy_function_keys
[] =
3618 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3619 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3620 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3621 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3622 "iso-lefttab", /* 0xfe20 */
3623 "iso-move-line-up", "iso-move-line-down",
3624 "iso-partial-line-up", "iso-partial-line-down",
3625 "iso-partial-space-left", "iso-partial-space-right",
3626 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3627 "iso-release-margin-left", "iso-release-margin-right",
3628 "iso-release-both-margins",
3629 "iso-fast-cursor-left", "iso-fast-cursor-right",
3630 "iso-fast-cursor-up", "iso-fast-cursor-down",
3631 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3632 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3635 #endif /* not HAVE_NTGUI */
3637 static char *lispy_mouse_names
[] =
3639 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3642 /* Scroll bar parts. */
3643 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3644 Lisp_Object Qup
, Qdown
;
3646 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3647 Lisp_Object
*scroll_bar_parts
[] = {
3648 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3653 /* A vector, indexed by button number, giving the down-going location
3654 of currently depressed buttons, both scroll bar and non-scroll bar.
3656 The elements have the form
3657 (BUTTON-NUMBER MODIFIER-MASK . REST)
3658 where REST is the cdr of a position as it would be reported in the event.
3660 The make_lispy_event function stores positions here to tell the
3661 difference between click and drag events, and to store the starting
3662 location to be included in drag events. */
3664 static Lisp_Object button_down_location
;
3666 /* Information about the most recent up-going button event: Which
3667 button, what location, and what time. */
3669 static int last_mouse_button
;
3670 static int last_mouse_x
;
3671 static int last_mouse_y
;
3672 static unsigned long button_down_time
;
3674 /* The maximum time between clicks to make a double-click,
3675 or Qnil to disable double-click detection,
3676 or Qt for no time limit. */
3677 Lisp_Object Vdouble_click_time
;
3679 /* The number of clicks in this multiple-click. */
3681 int double_click_count
;
3683 /* Given a struct input_event, build the lisp event which represents
3684 it. If EVENT is 0, build a mouse movement event from the mouse
3685 movement buffer, which should have a movement event in it.
3687 Note that events must be passed to this function in the order they
3688 are received; this function stores the location of button presses
3689 in order to build drag events when the button is released. */
3692 make_lispy_event (event
)
3693 struct input_event
*event
;
3697 switch (SWITCH_ENUM_CAST (event
->kind
))
3699 /* A simple keystroke. */
3700 case ascii_keystroke
:
3702 Lisp_Object lispy_c
;
3703 int c
= event
->code
& 0377;
3704 /* Turn ASCII characters into control characters
3706 if (event
->modifiers
& ctrl_modifier
)
3707 c
= make_ctrl_char (c
);
3709 /* Add in the other modifier bits. We took care of ctrl_modifier
3710 just above, and the shift key was taken care of by the X code,
3711 and applied to control characters by make_ctrl_char. */
3712 c
|= (event
->modifiers
3713 & (meta_modifier
| alt_modifier
3714 | hyper_modifier
| super_modifier
));
3715 /* Distinguish Shift-SPC from SPC. */
3716 if ((event
->code
& 0377) == 040
3717 && event
->modifiers
& shift_modifier
)
3718 c
|= shift_modifier
;
3719 button_down_time
= 0;
3720 XSETFASTINT (lispy_c
, c
);
3724 /* A function key. The symbol may need to have modifier prefixes
3726 case non_ascii_keystroke
:
3727 button_down_time
= 0;
3729 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3730 if (event
->code
== lispy_accent_codes
[i
])
3731 return modify_event_symbol (i
,
3733 Qfunction_key
, Qnil
,
3734 lispy_accent_keys
, &accent_key_syms
,
3735 (sizeof (lispy_accent_keys
)
3736 / sizeof (lispy_accent_keys
[0])));
3738 /* Handle system-specific keysyms. */
3739 if (event
->code
& (1 << 28))
3741 /* We need to use an alist rather than a vector as the cache
3742 since we can't make a vector long enuf. */
3743 if (NILP (current_kboard
->system_key_syms
))
3744 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3745 return modify_event_symbol (event
->code
,
3748 current_kboard
->Vsystem_key_alist
,
3749 0, ¤t_kboard
->system_key_syms
,
3754 if (event
->code
>= 0x400 && event
->code
< 0x500)
3755 return modify_event_symbol (event
->code
- 0x400,
3756 event
->modifiers
& ~shift_modifier
,
3757 Qfunction_key
, Qnil
,
3758 lispy_kana_keys
, &func_key_syms
,
3759 (sizeof (lispy_kana_keys
)
3760 / sizeof (lispy_kana_keys
[0])));
3761 #endif /* XK_kana_A */
3763 #ifdef ISO_FUNCTION_KEY_OFFSET
3764 if (event
->code
< FUNCTION_KEY_OFFSET
3765 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
3766 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
3768 Qfunction_key
, Qnil
,
3769 iso_lispy_function_keys
, &func_key_syms
,
3770 (sizeof (iso_lispy_function_keys
)
3771 / sizeof (iso_lispy_function_keys
[0])));
3774 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3776 Qfunction_key
, Qnil
,
3777 lispy_function_keys
, &func_key_syms
,
3778 (sizeof (lispy_function_keys
)
3779 / sizeof (lispy_function_keys
[0])));
3782 /* A mouse click. Figure out where it is, decide whether it's
3783 a press, click or drag, and build the appropriate structure. */
3785 case scroll_bar_click
:
3787 int button
= event
->code
;
3789 Lisp_Object position
;
3790 Lisp_Object
*start_pos_ptr
;
3791 Lisp_Object start_pos
;
3793 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3796 /* Build the position as appropriate for this mouse click. */
3797 if (event
->kind
== mouse_click
)
3800 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3805 /* Ignore mouse events that were made on frame that
3806 have been deleted. */
3807 if (! FRAME_LIVE_P (f
))
3810 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3811 &column
, &row
, NULL
, 1);
3813 #ifndef USE_X_TOOLKIT
3814 /* In the non-toolkit version, clicks on the menu bar
3815 are ordinary button events in the event buffer.
3816 Distinguish them, and invoke the menu.
3818 (In the toolkit version, the toolkit handles the menu bar
3819 and Emacs doesn't know about it until after the user
3820 makes a selection.) */
3821 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3822 && (event
->modifiers
& down_modifier
))
3824 Lisp_Object items
, item
;
3829 /* Activate the menu bar on the down event. If the
3830 up event comes in before the menu code can deal with it,
3832 if (! (event
->modifiers
& down_modifier
))
3837 items
= FRAME_MENU_BAR_ITEMS (f
);
3838 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3840 Lisp_Object pos
, string
;
3841 string
= XVECTOR (items
)->contents
[i
+ 1];
3842 pos
= XVECTOR (items
)->contents
[i
+ 3];
3845 if (column
>= XINT (pos
)
3846 && column
< XINT (pos
) + XSTRING (string
)->size
)
3848 item
= XVECTOR (items
)->contents
[i
];
3854 = Fcons (event
->frame_or_window
,
3856 Fcons (Fcons (event
->x
, event
->y
),
3857 Fcons (make_number (event
->timestamp
),
3860 return Fcons (item
, Fcons (position
, Qnil
));
3862 #endif /* not USE_X_TOOLKIT */
3864 window
= window_from_coordinates (f
, column
, row
, &part
);
3866 if (!WINDOWP (window
))
3868 window
= event
->frame_or_window
;
3873 int pixcolumn
, pixrow
;
3874 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3875 row
-= XINT (XWINDOW (window
)->top
);
3876 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3877 XSETINT (event
->x
, pixcolumn
);
3878 XSETINT (event
->y
, pixrow
);
3883 posn
= Qvertical_line
;
3886 buffer_posn_from_coords (XWINDOW (window
),
3893 Fcons (Fcons (event
->x
, event
->y
),
3894 Fcons (make_number (event
->timestamp
),
3900 Lisp_Object portion_whole
;
3903 window
= event
->frame_or_window
;
3904 portion_whole
= Fcons (event
->x
, event
->y
);
3905 part
= *scroll_bar_parts
[(int) event
->part
];
3909 Fcons (Qvertical_scroll_bar
,
3910 Fcons (portion_whole
,
3911 Fcons (make_number (event
->timestamp
),
3912 Fcons (part
, Qnil
)))));
3915 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3917 start_pos
= *start_pos_ptr
;
3918 *start_pos_ptr
= Qnil
;
3920 is_double
= (button
== last_mouse_button
3921 && XINT (event
->x
) == last_mouse_x
3922 && XINT (event
->y
) == last_mouse_y
3923 && button_down_time
!= 0
3924 && (EQ (Vdouble_click_time
, Qt
)
3925 || (INTEGERP (Vdouble_click_time
)
3926 && ((int)(event
->timestamp
- button_down_time
)
3927 < XINT (Vdouble_click_time
)))));
3928 last_mouse_button
= button
;
3929 last_mouse_x
= XINT (event
->x
);
3930 last_mouse_y
= XINT (event
->y
);
3932 /* If this is a button press, squirrel away the location, so
3933 we can decide later whether it was a click or a drag. */
3934 if (event
->modifiers
& down_modifier
)
3938 double_click_count
++;
3939 event
->modifiers
|= ((double_click_count
> 2)
3944 double_click_count
= 1;
3945 button_down_time
= event
->timestamp
;
3946 *start_pos_ptr
= Fcopy_alist (position
);
3949 /* Now we're releasing a button - check the co-ordinates to
3950 see if this was a click or a drag. */
3951 else if (event
->modifiers
& up_modifier
)
3953 /* If we did not see a down before this up,
3954 ignore the up. Probably this happened because
3955 the down event chose a menu item.
3956 It would be an annoyance to treat the release
3957 of the button that chose the menu item
3958 as a separate event. */
3960 if (!CONSP (start_pos
))
3963 event
->modifiers
&= ~up_modifier
;
3964 #if 0 /* Formerly we treated an up with no down as a click event. */
3965 if (!CONSP (start_pos
))
3966 event
->modifiers
|= click_modifier
;
3970 /* The third element of every position should be the (x,y)
3974 down
= Fnth (make_number (2), start_pos
);
3975 if (EQ (event
->x
, XCONS (down
)->car
)
3976 && EQ (event
->y
, XCONS (down
)->cdr
))
3978 event
->modifiers
|= click_modifier
;
3982 button_down_time
= 0;
3983 event
->modifiers
|= drag_modifier
;
3985 /* Don't check is_double; treat this as multiple
3986 if the down-event was multiple. */
3987 if (double_click_count
> 1)
3988 event
->modifiers
|= ((double_click_count
> 2)
3994 /* Every mouse event should either have the down_modifier or
3995 the up_modifier set. */
3999 /* Get the symbol we should use for the mouse click. */
4002 head
= modify_event_symbol (button
,
4005 lispy_mouse_names
, &mouse_syms
,
4006 (sizeof (lispy_mouse_names
)
4007 / sizeof (lispy_mouse_names
[0])));
4008 if (event
->modifiers
& drag_modifier
)
4013 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4016 Fcons (make_number (double_click_count
),
4026 case w32_scroll_bar_click
:
4028 int button
= event
->code
;
4030 Lisp_Object position
;
4031 Lisp_Object
*start_pos_ptr
;
4032 Lisp_Object start_pos
;
4034 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4039 Lisp_Object portion_whole
;
4042 window
= event
->frame_or_window
;
4043 portion_whole
= Fcons (event
->x
, event
->y
);
4044 part
= *scroll_bar_parts
[(int) event
->part
];
4048 Fcons (Qvertical_scroll_bar
,
4049 Fcons (portion_whole
,
4050 Fcons (make_number (event
->timestamp
),
4051 Fcons (part
, Qnil
)))));
4054 /* Always treat W32 scroll bar events as clicks. */
4055 event
->modifiers
|= click_modifier
;
4058 /* Get the symbol we should use for the mouse click. */
4061 head
= modify_event_symbol (button
,
4064 lispy_mouse_names
, &mouse_syms
,
4065 (sizeof (lispy_mouse_names
)
4066 / sizeof (lispy_mouse_names
[0])));
4074 #endif /* HAVE_MOUSE */
4076 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4077 case menu_bar_event
:
4078 /* The event value is in the cdr of the frame_or_window slot. */
4079 if (!CONSP (event
->frame_or_window
))
4081 return XCONS (event
->frame_or_window
)->cdr
;
4084 /* The 'kind' field of the event is something we don't recognize. */
4093 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4095 Lisp_Object bar_window
;
4096 enum scroll_bar_part part
;
4100 /* Is it a scroll bar movement? */
4101 if (frame
&& ! NILP (bar_window
))
4103 Lisp_Object part_sym
;
4105 part_sym
= *scroll_bar_parts
[(int) part
];
4106 return Fcons (Qscroll_bar_movement
,
4107 (Fcons (Fcons (bar_window
,
4108 Fcons (Qvertical_scroll_bar
,
4109 Fcons (Fcons (x
, y
),
4110 Fcons (make_number (time
),
4116 /* Or is it an ordinary mouse movement? */
4126 /* It's in a frame; which window on that frame? */
4127 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4129 window
= window_from_coordinates (frame
, column
, row
, &area
);
4134 if (WINDOWP (window
))
4136 int pixcolumn
, pixrow
;
4137 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4138 row
-= XINT (XWINDOW (window
)->top
);
4139 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4140 XSETINT (x
, pixcolumn
);
4141 XSETINT (y
, pixrow
);
4146 posn
= Qvertical_line
;
4149 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4151 else if (frame
!= 0)
4153 XSETFRAME (window
, frame
);
4164 return Fcons (Qmouse_movement
,
4165 Fcons (Fcons (window
,
4167 Fcons (Fcons (x
, y
),
4168 Fcons (make_number (time
),
4174 #endif /* HAVE_MOUSE */
4176 /* Construct a switch frame event. */
4178 make_lispy_switch_frame (frame
)
4181 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4184 /* Manipulating modifiers. */
4186 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4188 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4189 SYMBOL's name of the end of the modifiers; the string from this
4190 position is the unmodified symbol name.
4192 This doesn't use any caches. */
4195 parse_modifiers_uncached (symbol
, modifier_end
)
4199 struct Lisp_String
*name
;
4203 CHECK_SYMBOL (symbol
, 1);
4206 name
= XSYMBOL (symbol
)->name
;
4208 for (i
= 0; i
+2 <= name
->size
; )
4210 int this_mod_end
= 0;
4213 /* See if the name continues with a modifier word.
4214 Check that the word appears, but don't check what follows it.
4215 Set this_mod and this_mod_end to record what we find. */
4217 switch (name
->data
[i
])
4219 #define SINGLE_LETTER_MOD(BIT) \
4220 (this_mod_end = i + 1, this_mod = BIT)
4223 SINGLE_LETTER_MOD (alt_modifier
);
4227 SINGLE_LETTER_MOD (ctrl_modifier
);
4231 SINGLE_LETTER_MOD (hyper_modifier
);
4235 SINGLE_LETTER_MOD (meta_modifier
);
4239 SINGLE_LETTER_MOD (shift_modifier
);
4243 SINGLE_LETTER_MOD (super_modifier
);
4246 #undef SINGLE_LETTER_MOD
4249 /* If we found no modifier, stop looking for them. */
4250 if (this_mod_end
== 0)
4253 /* Check there is a dash after the modifier, so that it
4254 really is a modifier. */
4255 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
4258 /* This modifier is real; look for another. */
4259 modifiers
|= this_mod
;
4260 i
= this_mod_end
+ 1;
4263 /* Should we include the `click' modifier? */
4264 if (! (modifiers
& (down_modifier
| drag_modifier
4265 | double_modifier
| triple_modifier
))
4266 && i
+ 7 == name
->size
4267 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4268 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4269 modifiers
|= click_modifier
;
4277 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4278 prepended to the string BASE[0..BASE_LEN-1].
4279 This doesn't use any caches. */
4281 apply_modifiers_uncached (modifiers
, base
, base_len
)
4286 /* Since BASE could contain nulls, we can't use intern here; we have
4287 to use Fintern, which expects a genuine Lisp_String, and keeps a
4290 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4296 /* Only the event queue may use the `up' modifier; it should always
4297 be turned into a click or drag event before presented to lisp code. */
4298 if (modifiers
& up_modifier
)
4301 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4302 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4303 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4304 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4305 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4306 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4307 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4308 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4309 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4310 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4311 /* The click modifier is denoted by the absence of other modifiers. */
4315 mod_len
= p
- new_mods
;
4319 Lisp_Object new_name
;
4321 new_name
= make_uninit_string (mod_len
+ base_len
);
4322 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4323 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
4325 return Fintern (new_name
, Qnil
);
4330 static char *modifier_names
[] =
4332 "up", "down", "drag", "click", "double", "triple", 0, 0,
4333 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4334 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4336 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4338 static Lisp_Object modifier_symbols
;
4340 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4342 lispy_modifier_list (modifiers
)
4345 Lisp_Object modifier_list
;
4348 modifier_list
= Qnil
;
4349 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4350 if (modifiers
& (1<<i
))
4351 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4354 return modifier_list
;
4358 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4359 where UNMODIFIED is the unmodified form of SYMBOL,
4360 MASK is the set of modifiers present in SYMBOL's name.
4361 This is similar to parse_modifiers_uncached, but uses the cache in
4362 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4363 Qevent_symbol_elements property. */
4366 parse_modifiers (symbol
)
4369 Lisp_Object elements
;
4371 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4372 if (CONSP (elements
))
4377 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4378 Lisp_Object unmodified
;
4381 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4382 XSYMBOL (symbol
)->name
->size
- end
),
4385 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4387 XSETFASTINT (mask
, modifiers
);
4388 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4390 /* Cache the parsing results on SYMBOL. */
4391 Fput (symbol
, Qevent_symbol_element_mask
,
4393 Fput (symbol
, Qevent_symbol_elements
,
4394 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4396 /* Since we know that SYMBOL is modifiers applied to unmodified,
4397 it would be nice to put that in unmodified's cache.
4398 But we can't, since we're not sure that parse_modifiers is
4405 /* Apply the modifiers MODIFIERS to the symbol BASE.
4406 BASE must be unmodified.
4408 This is like apply_modifiers_uncached, but uses BASE's
4409 Qmodifier_cache property, if present. It also builds
4410 Qevent_symbol_elements properties, since it has that info anyway.
4412 apply_modifiers copies the value of BASE's Qevent_kind property to
4413 the modified symbol. */
4415 apply_modifiers (modifiers
, base
)
4419 Lisp_Object cache
, index
, entry
, new_symbol
;
4421 /* Mask out upper bits. We don't know where this value's been. */
4422 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4424 /* The click modifier never figures into cache indices. */
4425 cache
= Fget (base
, Qmodifier_cache
);
4426 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4427 entry
= assq_no_quit (index
, cache
);
4430 new_symbol
= XCONS (entry
)->cdr
;
4433 /* We have to create the symbol ourselves. */
4434 new_symbol
= apply_modifiers_uncached (modifiers
,
4435 XSYMBOL (base
)->name
->data
,
4436 XSYMBOL (base
)->name
->size
);
4438 /* Add the new symbol to the base's cache. */
4439 entry
= Fcons (index
, new_symbol
);
4440 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4442 /* We have the parsing info now for free, so add it to the caches. */
4443 XSETFASTINT (index
, modifiers
);
4444 Fput (new_symbol
, Qevent_symbol_element_mask
,
4445 Fcons (base
, Fcons (index
, Qnil
)));
4446 Fput (new_symbol
, Qevent_symbol_elements
,
4447 Fcons (base
, lispy_modifier_list (modifiers
)));
4450 /* Make sure this symbol is of the same kind as BASE.
4452 You'd think we could just set this once and for all when we
4453 intern the symbol above, but reorder_modifiers may call us when
4454 BASE's property isn't set right; we can't assume that just
4455 because it has a Qmodifier_cache property it must have its
4456 Qevent_kind set right as well. */
4457 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4461 kind
= Fget (base
, Qevent_kind
);
4463 Fput (new_symbol
, Qevent_kind
, kind
);
4470 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4471 return a symbol with the modifiers placed in the canonical order.
4472 Canonical order is alphabetical, except for down and drag, which
4473 always come last. The 'click' modifier is never written out.
4475 Fdefine_key calls this to make sure that (for example) C-M-foo
4476 and M-C-foo end up being equivalent in the keymap. */
4479 reorder_modifiers (symbol
)
4482 /* It's hopefully okay to write the code this way, since everything
4483 will soon be in caches, and no consing will be done at all. */
4486 parsed
= parse_modifiers (symbol
);
4487 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4488 XCONS (parsed
)->car
);
4492 /* For handling events, we often want to produce a symbol whose name
4493 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4494 to some base, like the name of a function key or mouse button.
4495 modify_event_symbol produces symbols of this sort.
4497 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4498 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4501 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4502 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4504 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4505 persist between calls to modify_event_symbol that it can use to
4506 store a cache of the symbols it's generated for this NAME_TABLE
4507 before. The object stored there may be a vector or an alist.
4509 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4511 MODIFIERS is a set of modifier bits (as given in struct input_events)
4512 whose prefixes should be applied to the symbol name.
4514 SYMBOL_KIND is the value to be placed in the event_kind property of
4515 the returned symbol.
4517 The symbols we create are supposed to have an
4518 `event-symbol-elements' property, which lists the modifiers present
4519 in the symbol's name. */
4522 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4523 name_table
, symbol_table
, table_size
)
4526 Lisp_Object symbol_kind
;
4527 Lisp_Object name_alist
;
4529 Lisp_Object
*symbol_table
;
4530 unsigned int table_size
;
4533 Lisp_Object symbol_int
;
4535 /* Get rid of the "vendor-specific" bit here. */
4536 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4538 /* Is this a request for a valid symbol? */
4539 if (symbol_num
< 0 || symbol_num
>= table_size
)
4542 if (CONSP (*symbol_table
))
4543 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4545 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4546 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4547 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4548 we've never used that symbol before. */
4551 if (! VECTORP (*symbol_table
)
4552 || XVECTOR (*symbol_table
)->size
!= table_size
)
4556 XSETFASTINT (size
, table_size
);
4557 *symbol_table
= Fmake_vector (size
, Qnil
);
4560 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4563 /* Have we already used this symbol before? */
4566 /* No; let's create it. */
4567 if (!NILP (name_alist
))
4568 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4569 else if (name_table
!= 0 && name_table
[symbol_num
])
4570 value
= intern (name_table
[symbol_num
]);
4572 #ifdef HAVE_WINDOW_SYSTEM
4575 char *name
= x_get_keysym_name (symbol_num
);
4577 value
= intern (name
);
4584 sprintf (buf
, "key-%d", symbol_num
);
4585 value
= intern (buf
);
4588 if (CONSP (*symbol_table
))
4589 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4591 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4593 /* Fill in the cache entries for this symbol; this also
4594 builds the Qevent_symbol_elements property, which the user
4596 apply_modifiers (modifiers
& click_modifier
, value
);
4597 Fput (value
, Qevent_kind
, symbol_kind
);
4600 /* Apply modifiers to that symbol. */
4601 return apply_modifiers (modifiers
, value
);
4604 /* Convert a list that represents an event type,
4605 such as (ctrl meta backspace), into the usual representation of that
4606 event type as a number or a symbol. */
4608 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4609 "Convert the event description list EVENT-DESC to an event type.\n\
4610 EVENT-DESC should contain one base event type (a character or symbol)\n\
4611 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4612 drag, down, double or triple). The base must be last.\n\
4613 The return value is an event type (a character or symbol) which\n\
4614 has the same base event type and all the specified modifiers.")
4616 Lisp_Object event_desc
;
4624 while (CONSP (rest
))
4629 elt
= XCONS (rest
)->car
;
4630 rest
= XCONS (rest
)->cdr
;
4632 /* Given a symbol, see if it is a modifier name. */
4633 if (SYMBOLP (elt
) && CONSP (rest
))
4634 this = parse_solitary_modifier (elt
);
4638 else if (!NILP (base
))
4639 error ("Two bases given in one event");
4645 /* Let the symbol A refer to the character A. */
4646 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4647 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4649 if (INTEGERP (base
))
4651 /* Turn (shift a) into A. */
4652 if ((modifiers
& shift_modifier
) != 0
4653 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4655 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4656 modifiers
&= ~shift_modifier
;
4659 /* Turn (control a) into C-a. */
4660 if (modifiers
& ctrl_modifier
)
4661 return make_number ((modifiers
& ~ctrl_modifier
)
4662 | make_ctrl_char (XINT (base
)));
4664 return make_number (modifiers
| XINT (base
));
4666 else if (SYMBOLP (base
))
4667 return apply_modifiers (modifiers
, base
);
4669 error ("Invalid base event");
4672 /* Try to recognize SYMBOL as a modifier name.
4673 Return the modifier flag bit, or 0 if not recognized. */
4676 parse_solitary_modifier (symbol
)
4679 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4681 switch (name
->data
[0])
4683 #define SINGLE_LETTER_MOD(BIT) \
4684 if (name->size == 1) \
4687 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4688 if (LEN == name->size \
4689 && ! strncmp (name->data, NAME, LEN)) \
4693 SINGLE_LETTER_MOD (alt_modifier
);
4697 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4701 SINGLE_LETTER_MOD (ctrl_modifier
);
4705 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4706 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4710 SINGLE_LETTER_MOD (hyper_modifier
);
4714 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4718 SINGLE_LETTER_MOD (meta_modifier
);
4722 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4726 SINGLE_LETTER_MOD (shift_modifier
);
4730 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4731 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4732 SINGLE_LETTER_MOD (super_modifier
);
4736 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4737 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4738 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4742 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4745 #undef SINGLE_LETTER_MOD
4746 #undef MULTI_LETTER_MOD
4752 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4753 Such a list is not valid as an event,
4754 but it can be a Lucid-style event type list. */
4757 lucid_event_type_list_p (object
)
4762 if (! CONSP (object
))
4765 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4768 elt
= XCONS (tail
)->car
;
4769 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4776 /* Store into *addr a value nonzero if terminal input chars are available.
4777 Serves the purpose of ioctl (0, FIONREAD, addr)
4778 but works even if FIONREAD does not exist.
4779 (In fact, this may actually read some input.)
4781 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4784 get_input_pending (addr
, do_timers_now
)
4788 /* First of all, have we already counted some input? */
4789 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4791 /* If input is being read as it arrives, and we have none, there is none. */
4792 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4795 /* Try to read some input and see how much we get. */
4797 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4800 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4803 gobble_input (expected
)
4808 if (interrupt_input
)
4811 mask
= sigblock (sigmask (SIGIO
));
4812 read_avail_input (expected
);
4816 #ifdef POLL_FOR_INPUT
4817 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4820 mask
= sigblock (sigmask (SIGALRM
));
4821 read_avail_input (expected
);
4827 read_avail_input (expected
);
4831 /* Put a buffer_switch_event in the buffer
4832 so that read_key_sequence will notice the new current buffer. */
4834 record_asynch_buffer_change ()
4836 struct input_event event
;
4839 event
.kind
= buffer_switch_event
;
4840 event
.frame_or_window
= Qnil
;
4843 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4844 The purpose of the event is to make read_key_sequence look up the
4845 keymaps again. If we aren't in read_key_sequence, we don't need one,
4846 and the event could cause trouble by messing up (input-pending-p). */
4847 tem
= Fwaiting_for_user_input_p ();
4851 /* We never need these events if we have no asynchronous subprocesses. */
4855 /* Make sure no interrupt happens while storing the event. */
4857 if (interrupt_input
)
4860 mask
= sigblock (sigmask (SIGIO
));
4861 kbd_buffer_store_event (&event
);
4868 kbd_buffer_store_event (&event
);
4875 /* Read any terminal input already buffered up by the system
4876 into the kbd_buffer, but do not wait.
4878 EXPECTED should be nonzero if the caller knows there is some input.
4880 Except on VMS, all input is read by this function.
4881 If interrupt_input is nonzero, this function MUST be called
4882 only when SIGIO is blocked.
4884 Returns the number of keyboard chars read, or -1 meaning
4885 this is a bad time to try to read input. */
4888 read_avail_input (expected
)
4891 struct input_event buf
[KBD_BUFFER_SIZE
];
4895 if (read_socket_hook
)
4896 /* No need for FIONREAD or fcntl; just say don't wait. */
4897 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
4900 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
4901 the kbd_buffer can really hold. That may prevent loss
4902 of characters on some systems when input is stuffed at us. */
4903 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
4906 /* Determine how many characters we should *try* to read. */
4909 #else /* not WINDOWSNT */
4911 n_to_read
= dos_keysns ();
4914 #else /* not MSDOS */
4916 /* Find out how much input is available. */
4917 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
4918 /* Formerly simply reported no input, but that sometimes led to
4919 a failure of Emacs to terminate.
4920 SIGHUP seems appropriate if we can't reach the terminal. */
4921 /* ??? Is it really right to send the signal just to this process
4922 rather than to the whole process group?
4923 Perhaps on systems with FIONREAD Emacs is alone in its group. */
4924 kill (getpid (), SIGHUP
);
4927 if (n_to_read
> sizeof cbuf
)
4928 n_to_read
= sizeof cbuf
;
4929 #else /* no FIONREAD */
4930 #if defined (USG) || defined (DGUX)
4931 /* Read some input if available, but don't wait. */
4932 n_to_read
= sizeof cbuf
;
4933 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
4938 #endif /* not MSDOS */
4939 #endif /* not WINDOWSNT */
4941 /* Now read; for one reason or another, this will not block.
4942 NREAD is set to the number of chars read. */
4946 cbuf
[0] = dos_keyread ();
4949 nread
= read (input_fd
, cbuf
, n_to_read
);
4951 /* POSIX infers that processes which are not in the session leader's
4952 process group won't get SIGHUP's at logout time. BSDI adheres to
4953 this part standard and returns -1 from read(0) with errno==EIO
4954 when the control tty is taken away.
4955 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
4956 if (nread
== -1 && errno
== EIO
)
4958 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
4959 /* The kernel sometimes fails to deliver SIGHUP for ptys.
4960 This looks incorrect, but it isn't, because _BSD causes
4961 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
4962 and that causes a value other than 0 when there is no input. */
4968 /* We used to retry the read if it was interrupted.
4969 But this does the wrong thing when O_NDELAY causes
4970 an EAGAIN error. Does anybody know of a situation
4971 where a retry is actually needed? */
4973 nread
< 0 && (errno
== EAGAIN
4987 #if defined (USG) || defined (DGUX)
4988 fcntl (input_fd
, F_SETFL
, 0);
4989 #endif /* USG or DGUX */
4990 #endif /* no FIONREAD */
4991 for (i
= 0; i
< nread
; i
++)
4993 buf
[i
].kind
= ascii_keystroke
;
4994 buf
[i
].modifiers
= 0;
4995 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
4996 buf
[i
].modifiers
= meta_modifier
;
5000 buf
[i
].code
= cbuf
[i
];
5001 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
5005 /* Scan the chars for C-g and store them in kbd_buffer. */
5006 for (i
= 0; i
< nread
; i
++)
5008 kbd_buffer_store_event (&buf
[i
]);
5009 /* Don't look at input that follows a C-g too closely.
5010 This reduces lossage due to autorepeat on C-g. */
5011 if (buf
[i
].kind
== ascii_keystroke
5012 && buf
[i
].code
== quit_char
)
5018 #endif /* not VMS */
5020 #ifdef SIGIO /* for entire page */
5021 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5024 input_available_signal (signo
)
5027 /* Must preserve main program's value of errno. */
5028 int old_errno
= errno
;
5030 extern int select_alarmed
;
5033 #if defined (USG) && !defined (POSIX_SIGNALS)
5034 /* USG systems forget handlers when they are used;
5035 must reestablish each time */
5036 signal (signo
, input_available_signal
);
5043 if (input_available_clear_time
)
5044 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5049 nread
= read_avail_input (1);
5050 /* -1 means it's not ok to read the input now.
5051 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5052 0 means there was no keyboard input available. */
5057 select_alarmed
= 1; /* Force the select emulator back to life */
5068 /* Send ourselves a SIGIO.
5070 This function exists so that the UNBLOCK_INPUT macro in
5071 blockinput.h can have some way to take care of input we put off
5072 dealing with, without assuming that every file which uses
5073 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5075 reinvoke_input_signal ()
5078 kill (getpid (), SIGIO
);
5084 /* Return the prompt-string of a sparse keymap.
5085 This is the first element which is a string.
5086 Return nil if there is none. */
5094 register Lisp_Object tem
;
5103 static void menu_bar_item ();
5104 static void menu_bar_one_keymap ();
5106 /* These variables hold the vector under construction within
5107 menu_bar_items and its subroutines, and the current index
5108 for storing into that vector. */
5109 static Lisp_Object menu_bar_items_vector
;
5110 static int menu_bar_items_index
;
5112 /* Return a vector of menu items for a menu bar, appropriate
5113 to the current buffer. Each item has three elements in the vector:
5116 OLD is an old vector we can optionally reuse, or nil. */
5119 menu_bar_items (old
)
5122 /* The number of keymaps we're scanning right now, and the number of
5123 keymaps we have allocated space for. */
5126 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5127 in the current keymaps, or nil where it is not a prefix. */
5130 Lisp_Object def
, tem
, tail
;
5139 struct gcpro gcpro1
;
5141 /* In order to build the menus, we need to call the keymap
5142 accessors. They all call QUIT. But this function is called
5143 during redisplay, during which a quit is fatal. So inhibit
5144 quitting while building the menus.
5145 We do this instead of specbind because (1) errors will clear it anyway
5146 and (2) this avoids risk of specpdl overflow. */
5147 oquit
= Vinhibit_quit
;
5151 menu_bar_items_vector
= old
;
5153 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5154 menu_bar_items_index
= 0;
5156 GCPRO1 (menu_bar_items_vector
);
5158 /* Build our list of keymaps.
5159 If we recognize a function key and replace its escape sequence in
5160 keybuf with its symbol, or if the sequence starts with a mouse
5161 click and we need to switch buffers, we jump back here to rebuild
5162 the initial keymaps from the current buffer. */
5166 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5167 if (!NILP (Voverriding_local_map_menu_flag
))
5169 /* Yes, use them (if non-nil) as well as the global map. */
5170 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5172 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5173 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5174 if (!NILP (Voverriding_local_map
))
5175 maps
[nmaps
++] = Voverriding_local_map
;
5179 /* No, so use major and minor mode keymaps. */
5180 nmaps
= current_minor_maps (NULL
, &tmaps
);
5181 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5182 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5183 #ifdef USE_TEXT_PROPERTIES
5184 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5186 maps
[nmaps
++] = current_buffer
->keymap
;
5189 maps
[nmaps
++] = current_global_map
;
5192 /* Look up in each map the dummy prefix key `menu-bar'. */
5196 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5198 if (! NILP (maps
[mapno
]))
5199 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
5203 tem
= Fkeymapp (def
);
5205 menu_bar_one_keymap (def
);
5208 /* Move to the end those items that should be at the end. */
5210 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5213 int end
= menu_bar_items_index
;
5215 for (i
= 0; i
< end
; i
+= 4)
5216 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5218 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5219 /* Move the item at index I to the end,
5220 shifting all the others forward. */
5221 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5222 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5223 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5224 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5226 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5227 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5228 (end
- i
- 4) * sizeof (Lisp_Object
));
5229 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5230 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5231 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5232 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5237 /* Add nil, nil, nil, nil at the end. */
5238 i
= menu_bar_items_index
;
5239 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5242 int newsize
= 2 * i
;
5243 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5244 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5245 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5246 menu_bar_items_vector
= tem
;
5248 /* Add this item. */
5249 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5250 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5251 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5252 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5253 menu_bar_items_index
= i
;
5255 Vinhibit_quit
= oquit
;
5257 return menu_bar_items_vector
;
5260 /* Scan one map KEYMAP, accumulating any menu items it defines
5261 in menu_bar_items_vector. */
5264 menu_bar_one_keymap (keymap
)
5267 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
5269 /* Loop over all keymap entries that have menu strings. */
5270 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5272 item
= XCONS (tail
)->car
;
5275 key
= XCONS (item
)->car
;
5276 binding
= XCONS (item
)->cdr
;
5277 if (CONSP (binding
))
5279 item_string
= XCONS (binding
)->car
;
5280 if (STRINGP (item_string
))
5281 menu_bar_item (key
, item_string
, Fcdr (binding
));
5283 else if (EQ (binding
, Qundefined
))
5284 menu_bar_item (key
, Qnil
, binding
);
5286 else if (VECTORP (item
))
5288 /* Loop over the char values represented in the vector. */
5289 int len
= XVECTOR (item
)->size
;
5291 for (c
= 0; c
< len
; c
++)
5293 Lisp_Object character
;
5294 XSETFASTINT (character
, c
);
5295 binding
= XVECTOR (item
)->contents
[c
];
5296 if (CONSP (binding
))
5298 item_string
= XCONS (binding
)->car
;
5299 if (STRINGP (item_string
))
5300 menu_bar_item (key
, item_string
, Fcdr (binding
));
5302 else if (EQ (binding
, Qundefined
))
5303 menu_bar_item (key
, Qnil
, binding
);
5309 /* This is used as the handler when calling internal_condition_case_1. */
5312 menu_bar_item_1 (arg
)
5318 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5319 If there's already an item for KEY, add this DEF to it. */
5322 menu_bar_item (key
, item_string
, def
)
5323 Lisp_Object key
, item_string
, def
;
5326 Lisp_Object enabled
;
5329 /* Skip menu-bar equiv keys data. */
5330 if (CONSP (def
) && CONSP (XCONS (def
)->car
))
5331 def
= XCONS (def
)->cdr
;
5333 if (EQ (def
, Qundefined
))
5335 /* If a map has an explicit `undefined' as definition,
5336 discard any previously made menu bar item. */
5338 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5339 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5341 if (menu_bar_items_index
> i
+ 4)
5342 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5343 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5344 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5345 menu_bar_items_index
-= 4;
5349 /* If there's no definition for this key yet,
5350 just ignore `undefined'. */
5354 /* See if this entry is enabled. */
5359 /* No property, or nil, means enable.
5360 Otherwise, enable if value is not nil. */
5361 tem
= Fget (def
, Qmenu_enable
);
5363 /* (condition-case nil (eval tem)
5365 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5369 /* Ignore this item if it's not enabled. */
5373 /* Find any existing item for this KEY. */
5374 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5375 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5378 /* If we did not find this KEY, add it at the end. */
5379 if (i
== menu_bar_items_index
)
5381 /* If vector is too small, get a bigger one. */
5382 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5385 int newsize
= 2 * i
;
5386 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5387 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5388 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5389 menu_bar_items_vector
= tem
;
5391 /* Add this item. */
5392 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5393 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5394 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5395 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5396 menu_bar_items_index
= i
;
5398 /* We did find an item for this KEY. Add DEF to its list of maps. */
5402 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5403 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5407 /* Read a character using menus based on maps in the array MAPS.
5408 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5409 Return t if we displayed a menu but the user rejected it.
5411 PREV_EVENT is the previous input event, or nil if we are reading
5412 the first event of a key sequence.
5414 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5415 if we used a mouse menu to read the input, or zero otherwise. If
5416 USED_MOUSE_MENU is null, we don't dereference it.
5418 The prompting is done based on the prompt-string of the map
5419 and the strings associated with various map elements.
5421 This can be done with X menus or with menus put in the minibuf.
5422 These are done in different ways, depending on how the input will be read.
5423 Menus using X are done after auto-saving in read-char, getting the input
5424 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5425 and do auto-saving in the inner call of read_char. */
5428 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5431 Lisp_Object prev_event
;
5432 int *used_mouse_menu
;
5435 register Lisp_Object name
;
5436 Lisp_Object rest
, vector
;
5438 if (used_mouse_menu
)
5439 *used_mouse_menu
= 0;
5441 /* Use local over global Menu maps */
5443 if (! menu_prompting
)
5446 /* Optionally disregard all but the global map. */
5447 if (inhibit_local_menu_bar_menus
)
5449 maps
+= (nmaps
- 1);
5453 /* Get the menu name from the first map that has one (a prompt string). */
5454 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5456 name
= map_prompt (maps
[mapno
]);
5461 /* If we don't have any menus, just read a character normally. */
5466 /* If we got to this point via a mouse click,
5467 use a real menu for mouse selection. */
5468 if (EVENT_HAS_PARAMETERS (prev_event
)
5469 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5471 /* Display the menu and get the selection. */
5472 Lisp_Object
*realmaps
5473 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5477 /* Use the maps that are not nil. */
5478 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5479 if (!NILP (maps
[mapno
]))
5480 realmaps
[nmaps1
++] = maps
[mapno
];
5482 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5487 record_menu_key (XCONS (value
)->car
);
5489 /* If we got multiple events, unread all but
5491 There is no way to prevent those unread events
5492 from showing up later in last_nonmenu_event.
5493 So turn symbol and integer events into lists,
5494 to indicate that they came from a mouse menu,
5495 so that when present in last_nonmenu_event
5496 they won't confuse things. */
5497 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5498 tem
= XCONS (tem
)->cdr
)
5500 record_menu_key (XCONS (tem
)->car
);
5501 if (SYMBOLP (XCONS (tem
)->car
)
5502 || INTEGERP (XCONS (tem
)->car
))
5504 = Fcons (XCONS (tem
)->car
, Qnil
);
5507 /* If we got more than one event, put all but the first
5508 onto this list to be read later.
5509 Return just the first event now. */
5510 Vunread_command_events
5511 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5512 value
= XCONS (value
)->car
;
5514 else if (NILP (value
))
5516 if (used_mouse_menu
)
5517 *used_mouse_menu
= 1;
5520 #endif /* HAVE_MENUS */
5524 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5525 We make this bigger when necessary, and never free it. */
5526 static char *read_char_minibuf_menu_text
;
5527 /* Size of that buffer. */
5528 static int read_char_minibuf_menu_width
;
5531 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5537 register Lisp_Object name
;
5539 int width
= FRAME_WIDTH (selected_frame
) - 4;
5542 Lisp_Object rest
, vector
;
5545 if (! menu_prompting
)
5548 /* Make sure we have a big enough buffer for the menu text. */
5549 if (read_char_minibuf_menu_text
== 0)
5551 read_char_minibuf_menu_width
= width
+ 4;
5552 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5554 else if (width
+ 4 > read_char_minibuf_menu_width
)
5556 read_char_minibuf_menu_width
= width
+ 4;
5557 read_char_minibuf_menu_text
5558 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5560 menu
= read_char_minibuf_menu_text
;
5562 /* Get the menu name from the first map that has one (a prompt string). */
5563 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5565 name
= map_prompt (maps
[mapno
]);
5570 /* If we don't have any menus, just read a character normally. */
5574 /* Prompt string always starts with map's prompt, and a space. */
5575 strcpy (menu
, XSTRING (name
)->data
);
5576 nlength
= XSTRING (name
)->size
;
5577 menu
[nlength
++] = ':';
5578 menu
[nlength
++] = ' ';
5581 /* Start prompting at start of first map. */
5585 /* Present the documented bindings, a line at a time. */
5592 Lisp_Object orig_defn_macro
;
5594 /* Loop over elements of map. */
5599 /* If reached end of map, start at beginning of next map. */
5603 /* At end of last map, wrap around to first map if just starting,
5604 or end this line if already have something on it. */
5608 if (notfirst
|| nobindings
) break;
5613 /* Look at the next element of the map. */
5615 elt
= XVECTOR (vector
)->contents
[idx
];
5617 elt
= Fcar_safe (rest
);
5619 if (idx
< 0 && VECTORP (elt
))
5621 /* If we found a dense table in the keymap,
5622 advanced past it, but start scanning its contents. */
5623 rest
= Fcdr_safe (rest
);
5629 /* An ordinary element. */
5634 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5635 event
= Fcar_safe (elt
);
5639 s
= Fcar_safe (elt
); /* vector */
5640 XSETINT (event
, idx
);
5643 /* Ignore the element if it has no prompt string. */
5644 if (STRINGP (s
) && INTEGERP (event
))
5646 /* 1 if the char to type matches the string. */
5648 Lisp_Object upcased_event
, downcased_event
;
5651 upcased_event
= Fupcase (event
);
5652 downcased_event
= Fdowncase (event
);
5653 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5654 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5656 desc
= Fsingle_key_description (event
);
5658 /* If we have room for the prompt string, add it to this line.
5659 If this is the first on the line, always add it. */
5660 if ((XSTRING (s
)->size
+ i
+ 2
5661 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5667 /* Punctuate between strings. */
5670 strcpy (menu
+ i
, ", ");
5676 /* If the char to type doesn't match the string's
5677 first char, explicitly show what char to type. */
5680 /* Add as much of string as fits. */
5681 thiswidth
= XSTRING (desc
)->size
;
5682 if (thiswidth
+ i
> width
)
5683 thiswidth
= width
- i
;
5684 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5686 strcpy (menu
+ i
, " = ");
5690 /* Add as much of string as fits. */
5691 thiswidth
= XSTRING (s
)->size
;
5692 if (thiswidth
+ i
> width
)
5693 thiswidth
= width
- i
;
5694 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5700 /* If this element does not fit, end the line now,
5701 and save the element for the next line. */
5702 strcpy (menu
+ i
, "...");
5707 /* Move past this element. */
5708 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5709 /* Handle reaching end of dense table. */
5714 rest
= Fcdr_safe (rest
);
5718 /* Prompt with that and read response. */
5721 /* Make believe its not a keyboard macro in case the help char
5722 is pressed. Help characters are not recorded because menu prompting
5723 is not used on replay.
5725 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5726 current_kboard
->defining_kbd_macro
= Qnil
;
5728 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5729 while (BUFFERP (obj
));
5730 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5732 if (!INTEGERP (obj
))
5737 if (! EQ (obj
, menu_prompt_more_char
)
5738 && (!INTEGERP (menu_prompt_more_char
)
5739 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5741 if (!NILP (current_kboard
->defining_kbd_macro
))
5742 store_kbd_macro_char (obj
);
5745 /* Help char - go round again */
5749 /* Reading key sequences. */
5751 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5752 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5753 keymap, or nil otherwise. Return the index of the first keymap in
5754 which KEY has any binding, or NMAPS if no map has a binding.
5756 If KEY is a meta ASCII character, treat it like meta-prefix-char
5757 followed by the corresponding non-meta character. Keymaps in
5758 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5761 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5764 NEXT may be the same array as CURRENT. */
5767 follow_key (key
, nmaps
, current
, defs
, next
)
5769 Lisp_Object
*current
, *defs
, *next
;
5772 int i
, first_binding
;
5775 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5776 followed by the corresponding non-meta character.
5777 Put the results into DEFS, since we are going to alter that anyway.
5778 Do not alter CURRENT or NEXT. */
5779 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5781 for (i
= 0; i
< nmaps
; i
++)
5782 if (! NILP (current
[i
]))
5785 def
= get_keyelt (access_keymap (current
[i
],
5786 meta_prefix_char
, 1, 0), 0);
5788 /* Note that since we pass the resulting bindings through
5789 get_keymap_1, non-prefix bindings for meta-prefix-char
5791 defs
[i
] = get_keymap_1 (def
, 0, 1);
5797 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5800 first_binding
= nmaps
;
5801 for (i
= nmaps
- 1; i
>= 0; i
--)
5803 if (! NILP (current
[i
]))
5811 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
5812 if (! NILP (defs
[i
]))
5819 /* Given the set of bindings we've found, produce the next set of maps. */
5820 if (first_binding
< nmaps
)
5821 for (i
= 0; i
< nmaps
; i
++)
5822 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5824 return first_binding
;
5827 /* Read a sequence of keys that ends with a non prefix character,
5828 storing it in KEYBUF, a buffer of size BUFSIZE.
5830 Return the length of the key sequence stored.
5831 Return -1 if the user rejected a command menu.
5833 Echo starting immediately unless `prompt' is 0.
5835 Where a key sequence ends depends on the currently active keymaps.
5836 These include any minor mode keymaps active in the current buffer,
5837 the current buffer's local map, and the global map.
5839 If a key sequence has no other bindings, we check Vfunction_key_map
5840 to see if some trailing subsequence might be the beginning of a
5841 function key's sequence. If so, we try to read the whole function
5842 key, and substitute its symbolic name into the key sequence.
5844 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5845 `double-' events into similar click events, if that would make them
5846 bound. We try to turn `triple-' events first into `double-' events,
5849 If we get a mouse click in a mode line, vertical divider, or other
5850 non-text area, we treat the click as if it were prefixed by the
5851 symbol denoting that area - `mode-line', `vertical-line', or
5854 If the sequence starts with a mouse click, we read the key sequence
5855 with respect to the buffer clicked on, not the current buffer.
5857 If the user switches frames in the midst of a key sequence, we put
5858 off the switch-frame event until later; the next call to
5859 read_char will return it.
5861 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
5862 from the selected window's buffer. */
5865 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5866 can_return_switch_frame
, fix_current_buffer
)
5867 Lisp_Object
*keybuf
;
5870 int dont_downcase_last
;
5871 int can_return_switch_frame
;
5872 int fix_current_buffer
;
5874 int count
= specpdl_ptr
- specpdl
;
5876 /* How many keys there are in the current key sequence. */
5879 /* The length of the echo buffer when we started reading, and
5880 the length of this_command_keys when we started reading. */
5884 /* The number of keymaps we're scanning right now, and the number of
5885 keymaps we have allocated space for. */
5887 int nmaps_allocated
= 0;
5889 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5890 the current keymaps. */
5893 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5894 in the current keymaps, or nil where it is not a prefix. */
5895 Lisp_Object
*submaps
;
5897 /* The local map to start out with at start of key sequence. */
5898 Lisp_Object orig_local_map
;
5900 /* 1 if we have already considered switching to the local-map property
5901 of the place where a mouse click occurred. */
5902 int localized_local_map
= 0;
5904 /* The index in defs[] of the first keymap that has a binding for
5905 this key sequence. In other words, the lowest i such that
5906 defs[i] is non-nil. */
5909 /* If t < mock_input, then KEYBUF[t] should be read as the next
5912 We use this to recover after recognizing a function key. Once we
5913 realize that a suffix of the current key sequence is actually a
5914 function key's escape sequence, we replace the suffix with the
5915 function key's binding from Vfunction_key_map. Now keybuf
5916 contains a new and different key sequence, so the echo area,
5917 this_command_keys, and the submaps and defs arrays are wrong. In
5918 this situation, we set mock_input to t, set t to 0, and jump to
5919 restart_sequence; the loop will read keys from keybuf up until
5920 mock_input, thus rebuilding the state; and then it will resume
5921 reading characters from the keyboard. */
5924 /* If the sequence is unbound in submaps[], then
5925 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
5926 and fkey_map is its binding.
5928 These might be > t, indicating that all function key scanning
5929 should hold off until t reaches them. We do this when we've just
5930 recognized a function key, to avoid searching for the function
5931 key's again in Vfunction_key_map. */
5932 int fkey_start
= 0, fkey_end
= 0;
5933 Lisp_Object fkey_map
;
5935 /* Likewise, for key_translation_map. */
5936 int keytran_start
= 0, keytran_end
= 0;
5937 Lisp_Object keytran_map
;
5939 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
5940 we put it off for later. While we're reading, we keep the event here. */
5941 Lisp_Object delayed_switch_frame
;
5943 /* See the comment below... */
5944 #if defined (GOBBLE_FIRST_EVENT)
5945 Lisp_Object first_event
;
5948 Lisp_Object original_uppercase
;
5949 int original_uppercase_position
= -1;
5951 /* Gets around Microsoft compiler limitations. */
5954 struct buffer
*starting_buffer
;
5956 /* Nonzero if we seem to have got the beginning of a binding
5957 in function_key_map. */
5958 int function_key_possible
= 0;
5959 int key_translation_possible
= 0;
5961 /* Save the status of key translation before each step,
5962 so that we can restore this after downcasing. */
5963 Lisp_Object prev_fkey_map
;
5964 int prev_fkey_start
;
5967 Lisp_Object prev_keytran_map
;
5968 int prev_keytran_start
;
5969 int prev_keytran_end
;
5973 last_nonmenu_event
= Qnil
;
5975 delayed_switch_frame
= Qnil
;
5976 fkey_map
= Vfunction_key_map
;
5977 keytran_map
= Vkey_translation_map
;
5979 /* If there is no function-key-map, turn off function key scanning. */
5980 if (NILP (Fkeymapp (Vfunction_key_map
)))
5981 fkey_start
= fkey_end
= bufsize
+ 1;
5983 /* If there is no key-translation-map, turn off scanning. */
5984 if (NILP (Fkeymapp (Vkey_translation_map
)))
5985 keytran_start
= keytran_end
= bufsize
+ 1;
5990 echo_prompt (XSTRING (prompt
)->data
);
5991 else if (cursor_in_echo_area
&& echo_keystrokes
)
5992 /* This doesn't put in a dash if the echo buffer is empty, so
5993 you don't always see a dash hanging out in the minibuffer. */
5997 /* Record the initial state of the echo area and this_command_keys;
5998 we will need to restore them if we replay a key sequence. */
6000 echo_start
= echo_length ();
6001 keys_start
= this_command_key_count
;
6002 this_single_command_key_start
= keys_start
;
6004 #if defined (GOBBLE_FIRST_EVENT)
6005 /* This doesn't quite work, because some of the things that read_char
6006 does cannot safely be bypassed. It seems too risky to try to make
6009 /* Read the first char of the sequence specially, before setting
6010 up any keymaps, in case a filter runs and switches buffers on us. */
6011 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
6013 #endif /* GOBBLE_FIRST_EVENT */
6015 orig_local_map
= get_local_map (PT
, current_buffer
);
6017 /* We jump here when the key sequence has been thoroughly changed, and
6018 we need to rescan it starting from the beginning. When we jump here,
6019 keybuf[0..mock_input] holds the sequence we should reread. */
6022 starting_buffer
= current_buffer
;
6023 function_key_possible
= 0;
6024 key_translation_possible
= 0;
6026 /* Build our list of keymaps.
6027 If we recognize a function key and replace its escape sequence in
6028 keybuf with its symbol, or if the sequence starts with a mouse
6029 click and we need to switch buffers, we jump back here to rebuild
6030 the initial keymaps from the current buffer. */
6034 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6035 || !NILP (Voverriding_local_map
))
6037 if (3 > nmaps_allocated
)
6039 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6040 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6041 nmaps_allocated
= 3;
6044 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6045 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6046 if (!NILP (Voverriding_local_map
))
6047 submaps
[nmaps
++] = Voverriding_local_map
;
6051 nmaps
= current_minor_maps (0, &maps
);
6052 if (nmaps
+ 2 > nmaps_allocated
)
6054 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6055 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6056 nmaps_allocated
= nmaps
+ 2;
6058 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6059 #ifdef USE_TEXT_PROPERTIES
6060 submaps
[nmaps
++] = orig_local_map
;
6062 submaps
[nmaps
++] = current_buffer
->keymap
;
6065 submaps
[nmaps
++] = current_global_map
;
6068 /* Find an accurate initial value for first_binding. */
6069 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6070 if (! NILP (submaps
[first_binding
]))
6073 /* Start from the beginning in keybuf. */
6076 /* These are no-ops the first time through, but if we restart, they
6077 revert the echo area and this_command_keys to their original state. */
6078 this_command_key_count
= keys_start
;
6079 if (INTERACTIVE
&& t
< mock_input
)
6080 echo_truncate (echo_start
);
6082 /* If the best binding for the current key sequence is a keymap, or
6083 we may be looking at a function key's escape sequence, keep on
6085 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6086 || (first_binding
>= nmaps
6088 /* mock input is never part of a function key's sequence. */
6089 && mock_input
<= fkey_start
)
6090 || (first_binding
>= nmaps
6091 && keytran_start
< t
&& key_translation_possible
)
6092 /* Don't return in the middle of a possible function key sequence,
6093 if the only bindings we found were via case conversion.
6094 Thus, if ESC O a has a function-key-map translation
6095 and ESC o has a binding, don't return after ESC O,
6096 so that we can translate ESC O plus the next character. */
6100 int used_mouse_menu
= 0;
6102 /* Where the last real key started. If we need to throw away a
6103 key that has expanded into more than one element of keybuf
6104 (say, a mouse click on the mode line which is being treated
6105 as [mode-line (mouse-...)], then we backtrack to this point
6107 int last_real_key_start
;
6109 /* These variables are analogous to echo_start and keys_start;
6110 while those allow us to restart the entire key sequence,
6111 echo_local_start and keys_local_start allow us to throw away
6113 int echo_local_start
, keys_local_start
, local_first_binding
;
6116 error ("Key sequence too long");
6119 echo_local_start
= echo_length ();
6120 keys_local_start
= this_command_key_count
;
6121 local_first_binding
= first_binding
;
6124 /* These are no-ops, unless we throw away a keystroke below and
6125 jumped back up to replay_key; in that case, these restore the
6126 variables to their original state, allowing us to replay the
6128 if (INTERACTIVE
&& t
< mock_input
)
6129 echo_truncate (echo_local_start
);
6130 this_command_key_count
= keys_local_start
;
6131 first_binding
= local_first_binding
;
6133 /* By default, assume each event is "real". */
6134 last_real_key_start
= t
;
6136 /* Does mock_input indicate that we are re-reading a key sequence? */
6140 add_command_key (key
);
6141 if (echo_keystrokes
)
6145 /* If not, we should actually read a character. */
6148 struct buffer
*buf
= current_buffer
;
6152 KBOARD
*interrupted_kboard
= current_kboard
;
6153 struct frame
*interrupted_frame
= selected_frame
;
6154 if (setjmp (wrong_kboard_jmpbuf
))
6156 if (!NILP (delayed_switch_frame
))
6158 interrupted_kboard
->kbd_queue
6159 = Fcons (delayed_switch_frame
,
6160 interrupted_kboard
->kbd_queue
);
6161 delayed_switch_frame
= Qnil
;
6164 interrupted_kboard
->kbd_queue
6165 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6167 /* If the side queue is non-empty, ensure it begins with a
6168 switch-frame, so we'll replay it in the right context. */
6169 if (CONSP (interrupted_kboard
->kbd_queue
)
6170 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6171 !(EVENT_HAS_PARAMETERS (key
)
6172 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6176 XSETFRAME (frame
, interrupted_frame
);
6177 interrupted_kboard
->kbd_queue
6178 = Fcons (make_lispy_switch_frame (frame
),
6179 interrupted_kboard
->kbd_queue
);
6182 orig_local_map
= get_local_map (PT
, current_buffer
);
6183 goto replay_sequence
;
6186 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6190 /* read_char returns t when it shows a menu and the user rejects it.
6195 /* read_char returns -1 at the end of a macro.
6196 Emacs 18 handles this by returning immediately with a
6197 zero, so that's what we'll do. */
6198 if (INTEGERP (key
) && XINT (key
) == -1)
6201 /* The Microsoft C compiler can't handle the goto that
6207 /* If the current buffer has been changed from under us, the
6208 keymap may have changed, so replay the sequence. */
6212 /* Reset the current buffer from the selected window
6213 in case something changed the former and not the latter.
6214 This is to be more consistent with the behavior
6215 of the command_loop_1. */
6216 if (fix_current_buffer
)
6217 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
6218 Fset_buffer (XWINDOW (selected_window
)->buffer
);
6220 orig_local_map
= get_local_map (PT
, current_buffer
);
6221 goto replay_sequence
;
6224 /* If we have a quit that was typed in another frame, and
6225 quit_throw_to_read_char switched buffers,
6226 replay to get the right keymap. */
6227 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6232 orig_local_map
= get_local_map (PT
, current_buffer
);
6233 goto replay_sequence
;
6239 /* Clicks in non-text areas get prefixed by the symbol
6240 in their CHAR-ADDRESS field. For example, a click on
6241 the mode line is prefixed by the symbol `mode-line'.
6243 Furthermore, key sequences beginning with mouse clicks
6244 are read using the keymaps of the buffer clicked on, not
6245 the current buffer. So we may have to switch the buffer
6248 When we turn one event into two events, we must make sure
6249 that neither of the two looks like the original--so that,
6250 if we replay the events, they won't be expanded again.
6251 If not for this, such reexpansion could happen either here
6252 or when user programs play with this-command-keys. */
6253 if (EVENT_HAS_PARAMETERS (key
))
6257 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6258 if (EQ (kind
, Qmouse_click
))
6260 Lisp_Object window
, posn
;
6262 window
= POSN_WINDOW (EVENT_START (key
));
6263 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6266 /* We're looking at the second event of a
6267 sequence which we expanded before. Set
6268 last_real_key_start appropriately. */
6270 last_real_key_start
= t
- 1;
6273 /* Key sequences beginning with mouse clicks are
6274 read using the keymaps in the buffer clicked on,
6275 not the current buffer. If we're at the
6276 beginning of a key sequence, switch buffers. */
6277 if (last_real_key_start
== 0
6279 && BUFFERP (XWINDOW (window
)->buffer
)
6280 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6285 /* Arrange to go back to the original buffer once we're
6286 done reading the key sequence. Note that we can't
6287 use save_excursion_{save,restore} here, because they
6288 save point as well as the current buffer; we don't
6289 want to save point, because redisplay may change it,
6290 to accommodate a Fset_window_start or something. We
6291 don't want to do this at the top of the function,
6292 because we may get input from a subprocess which
6293 wants to change the selected window and stuff (say,
6295 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6297 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6298 orig_local_map
= get_local_map (PT
, current_buffer
);
6299 goto replay_sequence
;
6301 /* For a mouse click, get the local text-property keymap
6302 of the place clicked on, rather than point. */
6303 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6304 && ! localized_local_map
)
6306 Lisp_Object map_here
, start
, pos
;
6308 localized_local_map
= 1;
6309 start
= EVENT_START (key
);
6310 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6312 pos
= POSN_BUFFER_POSN (start
);
6314 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6316 map_here
= get_local_map (XINT (pos
), current_buffer
);
6317 if (!EQ (map_here
, orig_local_map
))
6319 orig_local_map
= map_here
;
6323 goto replay_sequence
;
6329 /* Expand mode-line and scroll-bar events into two events:
6330 use posn as a fake prefix key. */
6333 if (t
+ 1 >= bufsize
)
6334 error ("Key sequence too long");
6339 /* Zap the position in key, so we know that we've
6340 expanded it, and don't try to do so again. */
6341 POSN_BUFFER_POSN (EVENT_START (key
))
6342 = Fcons (posn
, Qnil
);
6346 else if (EQ (kind
, Qswitch_frame
))
6348 /* If we're at the beginning of a key sequence, and the caller
6349 says it's okay, go ahead and return this event. If we're
6350 in the midst of a key sequence, delay it until the end. */
6351 if (t
> 0 || !can_return_switch_frame
)
6353 delayed_switch_frame
= key
;
6357 else if (CONSP (XCONS (key
)->cdr
)
6358 && CONSP (EVENT_START (key
))
6359 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6363 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6364 /* Handle menu-bar events:
6365 insert the dummy prefix event `menu-bar'. */
6366 if (EQ (posn
, Qmenu_bar
))
6368 if (t
+ 1 >= bufsize
)
6369 error ("Key sequence too long");
6373 /* Zap the position in key, so we know that we've
6374 expanded it, and don't try to do so again. */
6375 POSN_BUFFER_POSN (EVENT_START (key
))
6376 = Fcons (posn
, Qnil
);
6379 goto replay_sequence
;
6381 else if (CONSP (posn
))
6383 /* We're looking at the second event of a
6384 sequence which we expanded before. Set
6385 last_real_key_start appropriately. */
6386 if (last_real_key_start
== t
&& t
> 0)
6387 last_real_key_start
= t
- 1;
6392 /* We have finally decided that KEY is something we might want
6394 first_binding
= (follow_key (key
,
6395 nmaps
- first_binding
,
6396 submaps
+ first_binding
,
6397 defs
+ first_binding
,
6398 submaps
+ first_binding
)
6401 /* If KEY wasn't bound, we'll try some fallbacks. */
6402 if (first_binding
>= nmaps
)
6406 head
= EVENT_HEAD (key
);
6407 if (help_char_p (head
) && t
> 0)
6409 read_key_sequence_cmd
= Vprefix_help_command
;
6411 last_nonmenu_event
= key
;
6412 /* The Microsoft C compiler can't handle the goto that
6420 Lisp_Object breakdown
;
6423 breakdown
= parse_modifiers (head
);
6424 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6425 /* Attempt to reduce an unbound mouse event to a simpler
6426 event that is bound:
6427 Drags reduce to clicks.
6428 Double-clicks reduce to clicks.
6429 Triple-clicks reduce to double-clicks, then to clicks.
6430 Down-clicks are eliminated.
6431 Double-downs reduce to downs, then are eliminated.
6432 Triple-downs reduce to double-downs, then to downs,
6433 then are eliminated. */
6434 if (modifiers
& (down_modifier
| drag_modifier
6435 | double_modifier
| triple_modifier
))
6437 while (modifiers
& (down_modifier
| drag_modifier
6438 | double_modifier
| triple_modifier
))
6440 Lisp_Object new_head
, new_click
;
6441 if (modifiers
& triple_modifier
)
6442 modifiers
^= (double_modifier
| triple_modifier
);
6443 else if (modifiers
& double_modifier
)
6444 modifiers
&= ~double_modifier
;
6445 else if (modifiers
& drag_modifier
)
6446 modifiers
&= ~drag_modifier
;
6449 /* Dispose of this `down' event by simply jumping
6450 back to replay_key, to get another event.
6452 Note that if this event came from mock input,
6453 then just jumping back to replay_key will just
6454 hand it to us again. So we have to wipe out any
6457 We could delete keybuf[t] and shift everything
6458 after that to the left by one spot, but we'd also
6459 have to fix up any variable that points into
6460 keybuf, and shifting isn't really necessary
6463 Adding prefixes for non-textual mouse clicks
6464 creates two characters of mock input, and both
6465 must be thrown away. If we're only looking at
6466 the prefix now, we can just jump back to
6467 replay_key. On the other hand, if we've already
6468 processed the prefix, and now the actual click
6469 itself is giving us trouble, then we've lost the
6470 state of the keymaps we want to backtrack to, and
6471 we need to replay the whole sequence to rebuild
6474 Beyond that, only function key expansion could
6475 create more than two keys, but that should never
6476 generate mouse events, so it's okay to zero
6477 mock_input in that case too.
6479 Isn't this just the most wonderful code ever? */
6480 if (t
== last_real_key_start
)
6487 mock_input
= last_real_key_start
;
6488 goto replay_sequence
;
6493 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6495 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6497 /* Look for a binding for this new key. follow_key
6498 promises that it didn't munge submaps the
6499 last time we called it, since key was unbound. */
6501 = (follow_key (new_click
,
6502 nmaps
- local_first_binding
,
6503 submaps
+ local_first_binding
,
6504 defs
+ local_first_binding
,
6505 submaps
+ local_first_binding
)
6506 + local_first_binding
);
6508 /* If that click is bound, go for it. */
6509 if (first_binding
< nmaps
)
6514 /* Otherwise, we'll leave key set to the drag event. */
6521 /* Normally, last_nonmenu_event gets the previous key we read.
6522 But when a mouse popup menu is being used,
6523 we don't update last_nonmenu_event; it continues to hold the mouse
6524 event that preceded the first level of menu. */
6525 if (!used_mouse_menu
)
6526 last_nonmenu_event
= key
;
6528 /* Record what part of this_command_keys is the current key sequence. */
6529 this_single_command_key_start
= this_command_key_count
- t
;
6531 prev_fkey_map
= fkey_map
;
6532 prev_fkey_start
= fkey_start
;
6533 prev_fkey_end
= fkey_end
;
6535 prev_keytran_map
= keytran_map
;
6536 prev_keytran_start
= keytran_start
;
6537 prev_keytran_end
= keytran_end
;
6539 /* If the sequence is unbound, see if we can hang a function key
6540 off the end of it. We only want to scan real keyboard input
6541 for function key sequences, so if mock_input says that we're
6542 re-reading old events, don't examine it. */
6543 if (first_binding
>= nmaps
6546 Lisp_Object fkey_next
;
6548 /* Continue scan from fkey_end until we find a bound suffix.
6549 If we fail, increment fkey_start
6550 and start fkey_end from there. */
6551 while (fkey_end
< t
)
6555 key
= keybuf
[fkey_end
++];
6556 /* Look up meta-characters by prefixing them
6557 with meta_prefix_char. I hate this. */
6558 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6563 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
6565 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6568 fkey_next
= fkey_map
;
6571 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 0);
6573 #if 0 /* I didn't turn this on, because it might cause trouble
6574 for the mapping of return into C-m and tab into C-i. */
6575 /* Optionally don't map function keys into other things.
6576 This enables the user to redefine kp- keys easily. */
6577 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6581 /* If the function key map gives a function, not an
6582 array, then call the function with no args and use
6583 its value instead. */
6584 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6587 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6591 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6592 fkey_next
= call1 (fkey_next
, prompt
);
6594 /* If the function returned something invalid,
6595 barf--don't ignore it.
6596 (To ignore it safely, we would need to gcpro a bunch of
6597 other variables.) */
6598 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6599 error ("Function in key-translation-map returns invalid key sequence");
6602 function_key_possible
= ! NILP (fkey_next
);
6604 /* If keybuf[fkey_start..fkey_end] is bound in the
6605 function key map and it's a suffix of the current
6606 sequence (i.e. fkey_end == t), replace it with
6607 the binding and restart with fkey_start at the end. */
6608 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6611 int len
= XFASTINT (Flength (fkey_next
));
6613 t
= fkey_start
+ len
;
6615 error ("Key sequence too long");
6617 if (VECTORP (fkey_next
))
6618 bcopy (XVECTOR (fkey_next
)->contents
,
6619 keybuf
+ fkey_start
,
6620 (t
- fkey_start
) * sizeof (keybuf
[0]));
6621 else if (STRINGP (fkey_next
))
6625 for (i
= 0; i
< len
; i
++)
6626 XSETFASTINT (keybuf
[fkey_start
+ i
],
6627 XSTRING (fkey_next
)->data
[i
]);
6631 fkey_start
= fkey_end
= t
;
6632 fkey_map
= Vfunction_key_map
;
6634 /* Do pass the results through key-translation-map. */
6635 keytran_start
= keytran_end
= 0;
6636 keytran_map
= Vkey_translation_map
;
6638 goto replay_sequence
;
6641 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6643 /* If we no longer have a bound suffix, try a new positions for
6645 if (NILP (fkey_map
))
6647 fkey_end
= ++fkey_start
;
6648 fkey_map
= Vfunction_key_map
;
6649 function_key_possible
= 0;
6654 /* Look for this sequence in key-translation-map. */
6656 Lisp_Object keytran_next
;
6658 /* Scan from keytran_end until we find a bound suffix. */
6659 while (keytran_end
< t
)
6663 key
= keybuf
[keytran_end
++];
6664 /* Look up meta-characters by prefixing them
6665 with meta_prefix_char. I hate this. */
6666 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6671 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
6673 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6676 keytran_next
= keytran_map
;
6679 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 0);
6681 /* If the key translation map gives a function, not an
6682 array, then call the function with no args and use
6683 its value instead. */
6684 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6685 && keytran_end
== t
)
6687 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6691 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6692 keytran_next
= call1 (keytran_next
, prompt
);
6694 /* If the function returned something invalid,
6695 barf--don't ignore it.
6696 (To ignore it safely, we would need to gcpro a bunch of
6697 other variables.) */
6698 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6699 error ("Function in key-translation-map returns invalid key sequence");
6702 key_translation_possible
= ! NILP (keytran_next
);
6704 /* If keybuf[keytran_start..keytran_end] is bound in the
6705 key translation map and it's a suffix of the current
6706 sequence (i.e. keytran_end == t), replace it with
6707 the binding and restart with keytran_start at the end. */
6708 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6709 && keytran_end
== t
)
6711 int len
= XFASTINT (Flength (keytran_next
));
6713 t
= keytran_start
+ len
;
6715 error ("Key sequence too long");
6717 if (VECTORP (keytran_next
))
6718 bcopy (XVECTOR (keytran_next
)->contents
,
6719 keybuf
+ keytran_start
,
6720 (t
- keytran_start
) * sizeof (keybuf
[0]));
6721 else if (STRINGP (keytran_next
))
6725 for (i
= 0; i
< len
; i
++)
6726 XSETFASTINT (keybuf
[keytran_start
+ i
],
6727 XSTRING (keytran_next
)->data
[i
]);
6731 keytran_start
= keytran_end
= t
;
6732 keytran_map
= Vkey_translation_map
;
6734 /* Don't pass the results of key-translation-map
6735 through function-key-map. */
6736 fkey_start
= fkey_end
= t
;
6737 fkey_map
= Vkey_translation_map
;
6739 goto replay_sequence
;
6742 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6744 /* If we no longer have a bound suffix, try a new positions for
6746 if (NILP (keytran_map
))
6748 keytran_end
= ++keytran_start
;
6749 keytran_map
= Vkey_translation_map
;
6750 key_translation_possible
= 0;
6755 /* If KEY is not defined in any of the keymaps,
6756 and cannot be part of a function key or translation,
6757 and is an upper case letter
6758 use the corresponding lower-case letter instead. */
6759 if (first_binding
== nmaps
&& ! function_key_possible
6760 && ! key_translation_possible
6762 && ((((XINT (key
) & 0x3ffff)
6763 < XSTRING (current_buffer
->downcase_table
)->size
)
6764 && UPPERCASEP (XINT (key
) & 0x3ffff))
6765 || (XINT (key
) & shift_modifier
)))
6767 Lisp_Object new_key
;
6769 original_uppercase
= key
;
6770 original_uppercase_position
= t
- 1;
6772 if (XINT (key
) & shift_modifier
)
6773 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6775 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6776 | (XINT (key
) & ~0x3ffff)));
6778 /* We have to do this unconditionally, regardless of whether
6779 the lower-case char is defined in the keymaps, because they
6780 might get translated through function-key-map. */
6781 keybuf
[t
- 1] = new_key
;
6784 fkey_map
= prev_fkey_map
;
6785 fkey_start
= prev_fkey_start
;
6786 fkey_end
= prev_fkey_end
;
6788 keytran_map
= prev_keytran_map
;
6789 keytran_start
= prev_keytran_start
;
6790 keytran_end
= prev_keytran_end
;
6792 goto replay_sequence
;
6794 /* If KEY is not defined in any of the keymaps,
6795 and cannot be part of a function key or translation,
6796 and is a shifted function key,
6797 use the corresponding unshifted function key instead. */
6798 if (first_binding
== nmaps
&& ! function_key_possible
6799 && ! key_translation_possible
6802 Lisp_Object breakdown
;
6805 breakdown
= parse_modifiers (key
);
6806 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6807 if (modifiers
& shift_modifier
)
6809 Lisp_Object new_key
;
6811 original_uppercase
= key
;
6812 original_uppercase_position
= t
- 1;
6814 modifiers
&= ~shift_modifier
;
6815 new_key
= apply_modifiers (modifiers
,
6816 XCONS (breakdown
)->car
);
6818 keybuf
[t
- 1] = new_key
;
6821 fkey_map
= prev_fkey_map
;
6822 fkey_start
= prev_fkey_start
;
6823 fkey_end
= prev_fkey_end
;
6825 keytran_map
= prev_keytran_map
;
6826 keytran_start
= prev_keytran_start
;
6827 keytran_end
= prev_keytran_end
;
6829 goto replay_sequence
;
6835 read_key_sequence_cmd
= (first_binding
< nmaps
6836 ? defs
[first_binding
]
6839 unread_switch_frame
= delayed_switch_frame
;
6840 unbind_to (count
, Qnil
);
6842 /* Don't downcase the last character if the caller says don't.
6843 Don't downcase it if the result is undefined, either. */
6844 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6845 && t
- 1 == original_uppercase_position
)
6846 keybuf
[t
- 1] = original_uppercase
;
6848 /* Occasionally we fabricate events, perhaps by expanding something
6849 according to function-key-map, or by adding a prefix symbol to a
6850 mouse click in the scroll bar or modeline. In this cases, return
6851 the entire generated key sequence, even if we hit an unbound
6852 prefix or a definition before the end. This means that you will
6853 be able to push back the event properly, and also means that
6854 read-key-sequence will always return a logical unit.
6857 for (; t
< mock_input
; t
++)
6859 if (echo_keystrokes
)
6860 echo_char (keybuf
[t
]);
6861 add_command_key (keybuf
[t
]);
6867 #if 0 /* This doc string is too long for some compilers.
6868 This commented-out definition serves for DOC. */
6869 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6870 "Read a sequence of keystrokes and return as a string or vector.\n\
6871 The sequence is sufficient to specify a non-prefix command in the\n\
6872 current local and global maps.\n\
6874 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6875 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6876 as a continuation of the previous key.\n\
6878 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6879 convert the last event to lower case. (Normally any upper case event\n\
6880 is converted to lower case if the original event is undefined and the lower\n\
6881 case equivalent is defined.) A non-nil value is appropriate for reading\n\
6882 a key sequence to be defined.\n\
6884 A C-g typed while in this function is treated like any other character,\n\
6885 and `quit-flag' is not set.\n\
6887 If the key sequence starts with a mouse click, then the sequence is read\n\
6888 using the keymaps of the buffer of the window clicked in, not the buffer\n\
6889 of the selected window as normal.\n\
6891 `read-key-sequence' drops unbound button-down events, since you normally\n\
6892 only care about the click or drag events which follow them. If a drag\n\
6893 or multi-click event is unbound, but the corresponding click event would\n\
6894 be bound, `read-key-sequence' turns the event into a click event at the\n\
6895 drag's starting position. This means that you don't have to distinguish\n\
6896 between click and drag, double, or triple events unless you want to.\n\
6898 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
6899 lines separating windows, and scroll bars with imaginary keys\n\
6900 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
6902 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
6903 function will process a switch-frame event if the user switches frames\n\
6904 before typing anything. If the user switches frames in the middle of a\n\
6905 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
6906 is nil, then the event will be put off until after the current key sequence.\n\
6908 `read-key-sequence' checks `function-key-map' for function key\n\
6909 sequences, where they wouldn't conflict with ordinary bindings. See\n\
6910 `function-key-map' for more details.")
6911 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6914 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6916 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6917 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
6918 Lisp_Object can_return_switch_frame
;
6920 Lisp_Object keybuf
[30];
6922 struct gcpro gcpro1
, gcpro2
;
6925 CHECK_STRING (prompt
, 0);
6928 bzero (keybuf
, sizeof keybuf
);
6930 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
6932 if (NILP (continue_echo
))
6934 this_command_key_count
= 0;
6935 this_single_command_key_start
= 0;
6938 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
6939 prompt
, ! NILP (dont_downcase_last
),
6940 ! NILP (can_return_switch_frame
), 0);
6948 return make_event_array (i
, keybuf
);
6951 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
6952 "Execute CMD as an editor command.\n\
6953 CMD must be a symbol that satisfies the `commandp' predicate.\n\
6954 Optional second arg RECORD-FLAG non-nil\n\
6955 means unconditionally put this command in `command-history'.\n\
6956 Otherwise, that is done only if an arg is read using the minibuffer.\n\
6957 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
6958 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
6959 The argument SPECIAL, if non-nil, means that this command is executing\n\
6960 a special event, so ignore the prefix argument and don't clear it.")
6961 (cmd
, record_flag
, keys
, special
)
6962 Lisp_Object cmd
, record_flag
, keys
, special
;
6964 register Lisp_Object final
;
6965 register Lisp_Object tem
;
6966 Lisp_Object prefixarg
;
6967 struct backtrace backtrace
;
6968 extern int debug_on_next_call
;
6970 debug_on_next_call
= 0;
6974 prefixarg
= current_kboard
->Vprefix_arg
;
6975 Vcurrent_prefix_arg
= prefixarg
;
6976 current_kboard
->Vprefix_arg
= Qnil
;
6983 tem
= Fget (cmd
, Qdisabled
);
6984 if (!NILP (tem
) && !NILP (Vrun_hooks
))
6986 tem
= Fsymbol_value (Qdisabled_command_hook
);
6988 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
6994 final
= Findirect_function (cmd
);
6996 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
6998 struct gcpro gcpro1
, gcpro2
;
7000 GCPRO2 (cmd
, prefixarg
);
7001 do_autoload (final
, cmd
);
7008 if (STRINGP (final
) || VECTORP (final
))
7010 /* If requested, place the macro in the command history. For
7011 other sorts of commands, call-interactively takes care of
7013 if (!NILP (record_flag
))
7015 = Fcons (Fcons (Qexecute_kbd_macro
,
7016 Fcons (final
, Fcons (prefixarg
, Qnil
))),
7019 return Fexecute_kbd_macro (final
, prefixarg
);
7021 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
7023 backtrace
.next
= backtrace_list
;
7024 backtrace_list
= &backtrace
;
7025 backtrace
.function
= &Qcall_interactively
;
7026 backtrace
.args
= &cmd
;
7027 backtrace
.nargs
= 1;
7028 backtrace
.evalargs
= 0;
7030 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7032 backtrace_list
= backtrace
.next
;
7038 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7040 "Read function name, then read its arguments and call it.")
7042 Lisp_Object prefixarg
;
7044 Lisp_Object function
;
7046 Lisp_Object saved_keys
;
7047 Lisp_Object bindings
, value
;
7048 struct gcpro gcpro1
, gcpro2
;
7050 saved_keys
= Fvector (this_command_key_count
,
7051 XVECTOR (this_command_keys
)->contents
);
7053 GCPRO2 (saved_keys
, prefixarg
);
7055 if (EQ (prefixarg
, Qminus
))
7057 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7058 strcpy (buf
, "C-u ");
7059 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7061 if (sizeof (int) == sizeof (EMACS_INT
))
7062 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7063 else if (sizeof (long) == sizeof (EMACS_INT
))
7064 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7068 else if (INTEGERP (prefixarg
))
7070 if (sizeof (int) == sizeof (EMACS_INT
))
7071 sprintf (buf
, "%d ", XINT (prefixarg
));
7072 else if (sizeof (long) == sizeof (EMACS_INT
))
7073 sprintf (buf
, "%ld ", XINT (prefixarg
));
7078 /* This isn't strictly correct if execute-extended-command
7079 is bound to anything else. Perhaps it should use
7080 this_command_keys? */
7081 strcat (buf
, "M-x ");
7083 /* Prompt with buf, and then read a string, completing from and
7084 restricting to the set of all defined commands. Don't provide
7085 any initial input. Save the command read on the extended-command
7087 function
= Fcompleting_read (build_string (buf
),
7088 Vobarray
, Qcommandp
,
7089 Qt
, Qnil
, Qextended_command_history
, Qnil
);
7091 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7092 error ("No command name given");
7094 /* Set this_command_keys to the concatenation of saved_keys and
7095 function, followed by a RET. */
7097 struct Lisp_String
*str
;
7102 this_command_key_count
= 0;
7103 this_single_command_key_start
= 0;
7105 keys
= XVECTOR (saved_keys
)->contents
;
7106 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7107 add_command_key (keys
[i
]);
7109 str
= XSTRING (function
);
7110 for (i
= 0; i
< str
->size
; i
++)
7112 XSETFASTINT (tem
, str
->data
[i
]);
7113 add_command_key (tem
);
7116 XSETFASTINT (tem
, '\015');
7117 add_command_key (tem
);
7122 function
= Fintern (function
, Qnil
);
7123 current_kboard
->Vprefix_arg
= prefixarg
;
7124 this_command
= function
;
7126 /* If enabled, show which key runs this command. */
7127 if (!NILP (Vsuggest_key_bindings
)
7128 && NILP (Vexecuting_macro
)
7129 && SYMBOLP (function
))
7130 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7136 GCPRO2 (bindings
, value
);
7137 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7139 /* If the command has a key binding, print it now. */
7140 if (!NILP (bindings
))
7142 /* But first wait, and skip the message if there is input. */
7143 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7144 ? Vsuggest_key_bindings
: make_number (2)),
7146 && ! CONSP (Vunread_command_events
))
7148 Lisp_Object binding
;
7150 char *oldmessage
= echo_area_glyphs
;
7151 int oldmessage_len
= echo_area_glyphs_length
;
7153 binding
= Fkey_description (bindings
);
7156 = (char *) alloca (XSYMBOL (function
)->name
->size
7157 + XSTRING (binding
)->size
7159 sprintf (newmessage
, "You can run the command `%s' by typing %s",
7160 XSYMBOL (function
)->name
->data
,
7161 XSTRING (binding
)->data
);
7162 message1_nolog (newmessage
);
7163 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7164 ? Vsuggest_key_bindings
: make_number (2)),
7166 message2_nolog (oldmessage
, oldmessage_len
);
7170 RETURN_UNGCPRO (value
);
7173 /* Find the set of keymaps now active.
7174 Store into *MAPS_P a vector holding the various maps
7175 and return the number of them. The vector was malloc'd
7176 and the caller should free it. */
7179 current_active_maps (maps_p
)
7180 Lisp_Object
**maps_p
;
7182 Lisp_Object
*tmaps
, *maps
;
7185 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7186 if (!NILP (Voverriding_local_map_menu_flag
))
7188 /* Yes, use them (if non-nil) as well as the global map. */
7189 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7191 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7192 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7193 if (!NILP (Voverriding_local_map
))
7194 maps
[nmaps
++] = Voverriding_local_map
;
7198 /* No, so use major and minor mode keymaps. */
7199 nmaps
= current_minor_maps (NULL
, &tmaps
);
7200 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7201 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7202 #ifdef USE_TEXT_PROPERTIES
7203 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7205 maps
[nmaps
++] = current_buffer
->keymap
;
7208 maps
[nmaps
++] = current_global_map
;
7214 /* Return nonzero if input events are pending. */
7216 detect_input_pending ()
7219 get_input_pending (&input_pending
, 0);
7221 return input_pending
;
7224 /* Return nonzero if input events are pending, and run any pending timers. */
7226 detect_input_pending_run_timers (do_display
)
7229 int old_timers_run
= timers_run
;
7232 get_input_pending (&input_pending
, 1);
7234 if (old_timers_run
!= timers_run
&& do_display
)
7235 redisplay_preserve_echo_area ();
7237 return input_pending
;
7240 /* This is called in some cases before a possible quit.
7241 It cases the next call to detect_input_pending to recompute input_pending.
7242 So calling this function unnecessarily can't do any harm. */
7243 clear_input_pending ()
7248 /* Return nonzero if there are pending requeued events.
7249 This isn't used yet. The hope is to make wait_reading_process_input
7250 call it, and return return if it runs Lisp code that unreads something.
7251 The problem is, kbd_buffer_get_event needs to be fixed to know what
7252 to do in that case. It isn't trivial. */
7254 requeued_events_pending_p ()
7256 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7260 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7261 "T if command input is currently available with no waiting.\n\
7262 Actually, the value is nil only if we can be sure that no input is available.")
7265 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7268 get_input_pending (&input_pending
, 1);
7269 return input_pending
> 0 ? Qt
: Qnil
;
7272 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7273 "Return vector of last 100 events, not counting those from keyboard macros.")
7276 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7279 if (total_keys
< NUM_RECENT_KEYS
)
7280 return Fvector (total_keys
, keys
);
7283 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7284 bcopy (keys
+ recent_keys_index
,
7285 XVECTOR (val
)->contents
,
7286 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7288 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7289 recent_keys_index
* sizeof (Lisp_Object
));
7294 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7295 "Return the key sequence that invoked this command.\n\
7296 The value is a string or a vector.")
7299 return make_event_array (this_command_key_count
,
7300 XVECTOR (this_command_keys
)->contents
);
7303 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7304 Sthis_single_command_keys
, 0, 0, 0,
7305 "Return the key sequence that invoked this command.\n\
7306 Unlike `this-command-keys', this function's value\n\
7307 does not include prefix arguments.\n\
7308 The value is a string or a vector.")
7311 return make_event_array (this_command_key_count
7312 - this_single_command_key_start
,
7313 (XVECTOR (this_command_keys
)->contents
7314 + this_single_command_key_start
));
7317 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7318 Sreset_this_command_lengths
, 0, 0, 0,
7319 "Used for complicated reasons in `universal-argument-other-key'.\n\
7321 `universal-argument-other-key' rereads the event just typed.\n\
7322 It then gets translated through `function-key-map'.\n\
7323 The translated event gets included in the echo area and in\n\
7324 the value of `this-command-keys' in addition to the raw original event.\n\
7325 That is not right.\n\
7327 Calling this function directs the translated event to replace\n\
7328 the original event, so that only one version of the event actually\n\
7329 appears in the echo area and in the value of `this-command-keys.'.")
7332 before_command_restore_flag
= 1;
7333 before_command_key_count_1
= before_command_key_count
;
7334 before_command_echo_length_1
= before_command_echo_length
;
7337 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7338 "Return the current depth in recursive edits.")
7342 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
7346 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
7347 "FOpen dribble file: ",
7348 "Start writing all keyboard characters to a dribble file called FILE.\n\
7349 If FILE is nil, close any open dribble file.")
7360 file
= Fexpand_file_name (file
, Qnil
);
7361 dribble
= fopen (XSTRING (file
)->data
, "w");
7363 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
7368 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
7369 "Discard the contents of the terminal input buffer.\n\
7370 Also cancel any kbd macro being defined.")
7373 current_kboard
->defining_kbd_macro
= Qnil
;
7374 update_mode_lines
++;
7376 Vunread_command_events
= Qnil
;
7377 unread_command_char
= -1;
7379 discard_tty_input ();
7381 /* Without the cast, GCC complains that this assignment loses the
7382 volatile qualifier of kbd_store_ptr. Is there anything wrong
7384 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7385 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7391 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7392 "Stop Emacs and return to superior process. You can resume later.\n\
7393 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7394 control, run a subshell instead.\n\n\
7395 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7396 to be read as terminal input by Emacs's parent, after suspension.\n\
7398 Before suspending, run the normal hook `suspend-hook'.\n\
7399 After resumption run the normal hook `suspend-resume-hook'.\n\
7401 Some operating systems cannot stop the Emacs process and resume it later.\n\
7402 On such systems, Emacs starts a subshell instead of suspending.")
7404 Lisp_Object stuffstring
;
7407 int count
= specpdl_ptr
- specpdl
;
7408 int old_height
, old_width
;
7410 struct gcpro gcpro1
, gcpro2
;
7411 extern init_sys_modes ();
7413 if (!NILP (stuffstring
))
7414 CHECK_STRING (stuffstring
, 0);
7416 /* Run the functions in suspend-hook. */
7417 if (!NILP (Vrun_hooks
))
7418 call1 (Vrun_hooks
, intern ("suspend-hook"));
7420 GCPRO1 (stuffstring
);
7421 get_frame_size (&old_width
, &old_height
);
7423 /* sys_suspend can get an error if it tries to fork a subshell
7424 and the system resources aren't available for that. */
7425 record_unwind_protect (init_sys_modes
, 0);
7426 stuff_buffered_input (stuffstring
);
7431 unbind_to (count
, Qnil
);
7433 /* Check if terminal/window size has changed.
7434 Note that this is not useful when we are running directly
7435 with a window system; but suspend should be disabled in that case. */
7436 get_frame_size (&width
, &height
);
7437 if (width
!= old_width
|| height
!= old_height
)
7438 change_frame_size (selected_frame
, height
, width
, 0, 0);
7440 /* Run suspend-resume-hook. */
7441 if (!NILP (Vrun_hooks
))
7442 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7448 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7449 Then in any case stuff anything Emacs has read ahead and not used. */
7451 stuff_buffered_input (stuffstring
)
7452 Lisp_Object stuffstring
;
7454 /* stuff_char works only in BSD, versions 4.2 and up. */
7457 register unsigned char *p
;
7459 if (STRINGP (stuffstring
))
7463 p
= XSTRING (stuffstring
)->data
;
7464 count
= XSTRING (stuffstring
)->size
;
7469 /* Anything we have read ahead, put back for the shell to read. */
7470 /* ?? What should this do when we have multiple keyboards??
7471 Should we ignore anything that was typed in at the "wrong" kboard? */
7472 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7474 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7475 kbd_fetch_ptr
= kbd_buffer
;
7476 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7477 stuff_char (kbd_fetch_ptr
->code
);
7478 kbd_fetch_ptr
->kind
= no_event
;
7479 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7485 #endif /* BSD_SYSTEM and not BSD4_1 */
7488 set_waiting_for_input (time_to_clear
)
7489 EMACS_TIME
*time_to_clear
;
7491 input_available_clear_time
= time_to_clear
;
7493 /* Tell interrupt_signal to throw back to read_char, */
7494 waiting_for_input
= 1;
7496 /* If interrupt_signal was called before and buffered a C-g,
7497 make it run again now, to avoid timing error. */
7498 if (!NILP (Vquit_flag
))
7499 quit_throw_to_read_char ();
7502 clear_waiting_for_input ()
7504 /* Tell interrupt_signal not to throw back to read_char, */
7505 waiting_for_input
= 0;
7506 input_available_clear_time
= 0;
7509 /* This routine is called at interrupt level in response to C-G.
7510 If interrupt_input, this is the handler for SIGINT.
7511 Otherwise, it is called from kbd_buffer_store_event,
7512 in handling SIGIO or SIGTINT.
7514 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7515 immediately throw back to read_char.
7517 Otherwise it sets the Lisp variable quit-flag not-nil.
7518 This causes eval to throw, when it gets a chance.
7519 If quit-flag is already non-nil, it stops the job right away. */
7522 interrupt_signal (signalnum
) /* If we don't have an argument, */
7523 int signalnum
; /* some compilers complain in signal calls. */
7526 /* Must preserve main program's value of errno. */
7527 int old_errno
= errno
;
7529 #if defined (USG) && !defined (POSIX_SIGNALS)
7530 if (!read_socket_hook
&& NILP (Vwindow_system
))
7532 /* USG systems forget handlers when they are used;
7533 must reestablish each time */
7534 signal (SIGINT
, interrupt_signal
);
7535 signal (SIGQUIT
, interrupt_signal
);
7541 if (!NILP (Vquit_flag
)
7542 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
7544 /* If SIGINT isn't blocked, don't let us be interrupted by
7545 another SIGINT, it might be harmful due to non-reentrancy
7546 in I/O functions. */
7547 sigblock (sigmask (SIGINT
));
7552 #ifdef SIGTSTP /* Support possible in later USG versions */
7554 * On systems which can suspend the current process and return to the original
7555 * shell, this command causes the user to end up back at the shell.
7556 * The "Auto-save" and "Abort" questions are not asked until
7557 * the user elects to return to emacs, at which point he can save the current
7558 * job and either dump core or continue.
7563 if (sys_suspend () == -1)
7565 printf ("Not running as a subprocess;\n");
7566 printf ("you can continue or abort.\n");
7569 /* Perhaps should really fork an inferior shell?
7570 But that would not provide any way to get back
7571 to the original shell, ever. */
7572 printf ("No support for stopping a process on this operating system;\n");
7573 printf ("you can continue or abort.\n");
7574 #endif /* not VMS */
7575 #endif /* not SIGTSTP */
7577 /* We must remain inside the screen area when the internal terminal
7578 is used. Note that [Enter] is not echoed by dos. */
7581 /* It doesn't work to autosave while GC is in progress;
7582 the code used for auto-saving doesn't cope with the mark bit. */
7583 if (!gc_in_progress
)
7585 printf ("Auto-save? (y or n) ");
7587 if (((c
= getchar ()) & ~040) == 'Y')
7589 Fdo_auto_save (Qt
, Qnil
);
7591 printf ("\r\nAuto-save done");
7592 #else /* not MSDOS */
7593 printf ("Auto-save done\n");
7594 #endif /* not MSDOS */
7596 while (c
!= '\n') c
= getchar ();
7600 /* During GC, it must be safe to reenable quitting again. */
7601 Vinhibit_quit
= Qnil
;
7604 #endif /* not MSDOS */
7605 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7606 printf ("but will instead do a real quit after garbage collection ends\r\n");
7611 printf ("\r\nAbort? (y or n) ");
7612 #else /* not MSDOS */
7614 printf ("Abort (and enter debugger)? (y or n) ");
7616 printf ("Abort (and dump core)? (y or n) ");
7617 #endif /* not VMS */
7618 #endif /* not MSDOS */
7620 if (((c
= getchar ()) & ~040) == 'Y')
7622 while (c
!= '\n') c
= getchar ();
7624 printf ("\r\nContinuing...\r\n");
7625 #else /* not MSDOS */
7626 printf ("Continuing...\n");
7627 #endif /* not MSDOS */
7634 /* If executing a function that wants to be interrupted out of
7635 and the user has not deferred quitting by binding `inhibit-quit'
7636 then quit right away. */
7637 if (immediate_quit
&& NILP (Vinhibit_quit
))
7641 Fsignal (Qquit
, Qnil
);
7644 /* Else request quit when it's safe */
7648 if (waiting_for_input
&& !echoing
)
7649 quit_throw_to_read_char ();
7654 /* Handle a C-g by making read_char return C-g. */
7656 quit_throw_to_read_char ()
7658 quit_error_check ();
7660 /* Prevent another signal from doing this before we finish. */
7661 clear_waiting_for_input ();
7664 Vunread_command_events
= Qnil
;
7665 unread_command_char
= -1;
7667 #if 0 /* Currently, sit_for is called from read_char without turning
7668 off polling. And that can call set_waiting_for_input.
7669 It seems to be harmless. */
7670 #ifdef POLL_FOR_INPUT
7671 /* May be > 1 if in recursive minibuffer. */
7672 if (poll_suppress_count
== 0)
7676 if (FRAMEP (internal_last_event_frame
)
7677 && XFRAME (internal_last_event_frame
) != selected_frame
)
7678 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7681 _longjmp (getcjmp
, 1);
7684 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7685 "Set mode of reading keyboard input.\n\
7686 First arg INTERRUPT non-nil means use input interrupts;\n\
7687 nil means use CBREAK mode.\n\
7688 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7689 (no effect except in CBREAK mode).\n\
7690 Third arg META t means accept 8-bit input (for a Meta key).\n\
7691 META nil means ignore the top bit, on the assumption it is parity.\n\
7692 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7693 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7694 See also `current-input-mode'.")
7695 (interrupt
, flow
, meta
, quit
)
7696 Lisp_Object interrupt
, flow
, meta
, quit
;
7699 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7700 error ("set-input-mode: QUIT must be an ASCII character");
7702 #ifdef POLL_FOR_INPUT
7707 /* this causes startup screen to be restored and messes with the mouse */
7712 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7713 if (read_socket_hook
)
7715 /* When using X, don't give the user a real choice,
7716 because we haven't implemented the mechanisms to support it. */
7717 #ifdef NO_SOCK_SIGIO
7718 interrupt_input
= 0;
7719 #else /* not NO_SOCK_SIGIO */
7720 interrupt_input
= 1;
7721 #endif /* NO_SOCK_SIGIO */
7724 interrupt_input
= !NILP (interrupt
);
7725 #else /* not SIGIO */
7726 interrupt_input
= 0;
7727 #endif /* not SIGIO */
7729 /* Our VMS input only works by interrupts, as of now. */
7731 interrupt_input
= 1;
7734 flow_control
= !NILP (flow
);
7737 else if (EQ (meta
, Qt
))
7742 /* Don't let this value be out of range. */
7743 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7749 #ifdef POLL_FOR_INPUT
7750 poll_suppress_count
= 1;
7756 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7757 "Return information about the way Emacs currently reads keyboard input.\n\
7758 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7759 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7760 nil, Emacs is using CBREAK mode.\n\
7761 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7762 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7763 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7764 META nil means ignoring the top bit, on the assumption it is parity.\n\
7765 META is neither t nor nil if accepting 8-bit input and using\n\
7766 all 8 bits as the character code.\n\
7767 QUIT is the character Emacs currently uses to quit.\n\
7768 The elements of this list correspond to the arguments of\n\
7774 val
[0] = interrupt_input
? Qt
: Qnil
;
7775 val
[1] = flow_control
? Qt
: Qnil
;
7776 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7777 XSETFASTINT (val
[3], quit_char
);
7779 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7784 * Set up a new kboard object with reasonable initial values.
7790 kb
->Voverriding_terminal_local_map
= Qnil
;
7791 kb
->Vlast_command
= Qnil
;
7792 kb
->Vprefix_arg
= Qnil
;
7793 kb
->kbd_queue
= Qnil
;
7794 kb
->kbd_queue_has_data
= 0;
7795 kb
->immediate_echo
= 0;
7796 kb
->echoptr
= kb
->echobuf
;
7797 kb
->echo_after_prompt
= -1;
7798 kb
->kbd_macro_buffer
= 0;
7799 kb
->kbd_macro_bufsize
= 0;
7800 kb
->defining_kbd_macro
= Qnil
;
7801 kb
->Vlast_kbd_macro
= Qnil
;
7802 kb
->reference_count
= 0;
7803 kb
->Vsystem_key_alist
= Qnil
;
7804 kb
->system_key_syms
= Qnil
;
7805 kb
->Vdefault_minibuffer_frame
= Qnil
;
7809 * Destroy the contents of a kboard object, but not the object itself.
7810 * We use this just before deleting it, or if we're going to initialize
7817 if (kb
->kbd_macro_buffer
)
7818 xfree (kb
->kbd_macro_buffer
);
7827 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7830 *kbp
= kb
->next_kboard
;
7838 /* This is correct before outermost invocation of the editor loop */
7839 command_loop_level
= -1;
7841 quit_char
= Ctl ('g');
7842 Vunread_command_events
= Qnil
;
7843 unread_command_char
= -1;
7844 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
7846 recent_keys_index
= 0;
7847 kbd_fetch_ptr
= kbd_buffer
;
7848 kbd_store_ptr
= kbd_buffer
;
7849 kbd_buffer_frame_or_window
7850 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7852 do_mouse_tracking
= Qnil
;
7856 /* This means that command_loop_1 won't try to select anything the first
7858 internal_last_event_frame
= Qnil
;
7859 Vlast_event_frame
= internal_last_event_frame
;
7862 current_kboard
= initial_kboard
;
7864 wipe_kboard (current_kboard
);
7865 init_kboard (current_kboard
);
7868 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7870 kbd_buffer_frame_or_window
7871 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7872 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
7874 signal (SIGINT
, interrupt_signal
);
7875 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
7876 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7877 SIGQUIT and we can't tell which one it will give us. */
7878 signal (SIGQUIT
, interrupt_signal
);
7879 #endif /* HAVE_TERMIO */
7881 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7883 if (!noninteractive
)
7884 signal (SIGIO
, input_available_signal
);
7887 /* Use interrupt input by default, if it works and noninterrupt input
7888 has deficiencies. */
7890 #ifdef INTERRUPT_INPUT
7891 interrupt_input
= 1;
7893 interrupt_input
= 0;
7896 /* Our VMS input only works by interrupts, as of now. */
7898 interrupt_input
= 1;
7904 if (keyboard_init_hook
)
7905 (*keyboard_init_hook
) ();
7907 #ifdef POLL_FOR_INPUT
7908 poll_suppress_count
= 1;
7913 /* This type's only use is in syms_of_keyboard, to initialize the
7914 event header symbols and put properties on them. */
7921 struct event_head head_table
[] = {
7922 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
7923 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
7924 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
7925 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
7926 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
7927 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
7932 Qtimer_event_handler
= intern ("timer-event-handler");
7933 staticpro (&Qtimer_event_handler
);
7935 Qdisabled_command_hook
= intern ("disabled-command-hook");
7936 staticpro (&Qdisabled_command_hook
);
7938 Qself_insert_command
= intern ("self-insert-command");
7939 staticpro (&Qself_insert_command
);
7941 Qforward_char
= intern ("forward-char");
7942 staticpro (&Qforward_char
);
7944 Qbackward_char
= intern ("backward-char");
7945 staticpro (&Qbackward_char
);
7947 Qdisabled
= intern ("disabled");
7948 staticpro (&Qdisabled
);
7950 Qundefined
= intern ("undefined");
7951 staticpro (&Qundefined
);
7953 Qpre_command_hook
= intern ("pre-command-hook");
7954 staticpro (&Qpre_command_hook
);
7956 Qpost_command_hook
= intern ("post-command-hook");
7957 staticpro (&Qpost_command_hook
);
7959 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
7960 staticpro (&Qpost_command_idle_hook
);
7962 Qdeferred_action_function
= intern ("deferred-action-function");
7963 staticpro (&Qdeferred_action_function
);
7965 Qcommand_hook_internal
= intern ("command-hook-internal");
7966 staticpro (&Qcommand_hook_internal
);
7968 Qfunction_key
= intern ("function-key");
7969 staticpro (&Qfunction_key
);
7970 Qmouse_click
= intern ("mouse-click");
7971 staticpro (&Qmouse_click
);
7973 Qmenu_enable
= intern ("menu-enable");
7974 staticpro (&Qmenu_enable
);
7976 Qmode_line
= intern ("mode-line");
7977 staticpro (&Qmode_line
);
7978 Qvertical_line
= intern ("vertical-line");
7979 staticpro (&Qvertical_line
);
7980 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
7981 staticpro (&Qvertical_scroll_bar
);
7982 Qmenu_bar
= intern ("menu-bar");
7983 staticpro (&Qmenu_bar
);
7985 Qabove_handle
= intern ("above-handle");
7986 staticpro (&Qabove_handle
);
7987 Qhandle
= intern ("handle");
7988 staticpro (&Qhandle
);
7989 Qbelow_handle
= intern ("below-handle");
7990 staticpro (&Qbelow_handle
);
7991 Qup
= intern ("up");
7993 Qdown
= intern ("down");
7996 Qevent_kind
= intern ("event-kind");
7997 staticpro (&Qevent_kind
);
7998 Qevent_symbol_elements
= intern ("event-symbol-elements");
7999 staticpro (&Qevent_symbol_elements
);
8000 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
8001 staticpro (&Qevent_symbol_element_mask
);
8002 Qmodifier_cache
= intern ("modifier-cache");
8003 staticpro (&Qmodifier_cache
);
8005 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
8006 staticpro (&Qrecompute_lucid_menubar
);
8007 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
8008 staticpro (&Qactivate_menubar_hook
);
8010 Qpolling_period
= intern ("polling-period");
8011 staticpro (&Qpolling_period
);
8014 struct event_head
*p
;
8016 for (p
= head_table
;
8017 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
8020 *p
->var
= intern (p
->name
);
8022 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
8023 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
8027 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
8028 staticpro (&button_down_location
);
8032 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
8034 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
8035 for (i
= 0; i
< len
; i
++)
8036 if (modifier_names
[i
])
8037 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
8038 staticpro (&modifier_symbols
);
8041 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
8042 staticpro (&recent_keys
);
8044 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
8045 staticpro (&this_command_keys
);
8047 Qextended_command_history
= intern ("extended-command-history");
8048 Fset (Qextended_command_history
, Qnil
);
8049 staticpro (&Qextended_command_history
);
8051 kbd_buffer_frame_or_window
8052 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8053 staticpro (&kbd_buffer_frame_or_window
);
8055 accent_key_syms
= Qnil
;
8056 staticpro (&accent_key_syms
);
8058 func_key_syms
= Qnil
;
8059 staticpro (&func_key_syms
);
8062 staticpro (&mouse_syms
);
8064 unread_switch_frame
= Qnil
;
8065 staticpro (&unread_switch_frame
);
8067 internal_last_event_frame
= Qnil
;
8068 staticpro (&internal_last_event_frame
);
8070 read_key_sequence_cmd
= Qnil
;
8071 staticpro (&read_key_sequence_cmd
);
8073 defsubr (&Sevent_convert_list
);
8074 defsubr (&Sread_key_sequence
);
8075 defsubr (&Srecursive_edit
);
8077 defsubr (&Strack_mouse
);
8079 defsubr (&Sinput_pending_p
);
8080 defsubr (&Scommand_execute
);
8081 defsubr (&Srecent_keys
);
8082 defsubr (&Sthis_command_keys
);
8083 defsubr (&Sthis_single_command_keys
);
8084 defsubr (&Sreset_this_command_lengths
);
8085 defsubr (&Ssuspend_emacs
);
8086 defsubr (&Sabort_recursive_edit
);
8087 defsubr (&Sexit_recursive_edit
);
8088 defsubr (&Srecursion_depth
);
8089 defsubr (&Stop_level
);
8090 defsubr (&Sdiscard_input
);
8091 defsubr (&Sopen_dribble_file
);
8092 defsubr (&Sset_input_mode
);
8093 defsubr (&Scurrent_input_mode
);
8094 defsubr (&Sexecute_extended_command
);
8096 DEFVAR_LISP ("last-command-char", &last_command_char
,
8097 "Last input event that was part of a command.");
8099 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
8100 "Last input event that was part of a command.");
8102 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
8103 "Last input event in a command, except for mouse menu events.\n\
8104 Mouse menus give back keys that don't look like mouse events;\n\
8105 this variable holds the actual mouse event that led to the menu,\n\
8106 so that you can determine whether the command was run by mouse or not.");
8108 DEFVAR_LISP ("last-input-char", &last_input_char
,
8109 "Last input event.");
8111 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
8112 "Last input event.");
8114 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
8115 "List of objects to be read as next command input events.");
8117 DEFVAR_INT ("unread-command-char", &unread_command_char
,
8118 "If not -1, an object to be read as next command input event.");
8120 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
8121 "Meta-prefix character code. Meta-foo as command input\n\
8122 turns into this character followed by foo.");
8123 XSETINT (meta_prefix_char
, 033);
8125 DEFVAR_KBOARD ("last-command", Vlast_command
,
8126 "The last command executed. Normally a symbol with a function definition,\n\
8127 but can be whatever was found in the keymap, or whatever the variable\n\
8128 `this-command' was set to by that command.\n\
8130 The value `mode-exit' is special; it means that the previous command\n\
8131 read an event that told it to exit, and it did so and unread that event.\n\
8132 In other words, the present command is the event that made the previous\n\
8135 The value `kill-region' is special; it means that the previous command\n\
8136 was a kill command.");
8138 DEFVAR_LISP ("this-command", &this_command
,
8139 "The command now being executed.\n\
8140 The command can set this variable; whatever is put here\n\
8141 will be in `last-command' during the following command.");
8142 this_command
= Qnil
;
8144 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8145 "*Number of keyboard input characters between auto-saves.\n\
8146 Zero means disable autosaving due to number of characters typed.");
8147 auto_save_interval
= 300;
8149 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8150 "*Number of seconds idle time before auto-save.\n\
8151 Zero or nil means disable auto-saving due to idleness.\n\
8152 After auto-saving due to this many seconds of idle time,\n\
8153 Emacs also does a garbage collection if that seems to be warranted.");
8154 XSETFASTINT (Vauto_save_timeout
, 30);
8156 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8157 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8158 echo_keystrokes
= 1;
8160 DEFVAR_INT ("polling-period", &polling_period
,
8161 "*Interval between polling for input during Lisp execution.\n\
8162 The reason for polling is to make C-g work to stop a running program.\n\
8163 Polling is needed only when using X windows and SIGIO does not work.\n\
8164 Polling is automatically disabled in all other cases.");
8167 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8168 "*Maximum time between mouse clicks to make a double-click.\n\
8169 Measured in milliseconds. nil means disable double-click recognition;\n\
8170 t means double-clicks have no time limit and are detected\n\
8171 by position only.");
8172 Vdouble_click_time
= make_number (500);
8174 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8175 "*Non-nil means inhibit local map menu bar menus.");
8176 inhibit_local_menu_bar_menus
= 0;
8178 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8179 "Number of complete key sequences read as input so far.\n\
8180 This includes key sequences read from keyboard macros.\n\
8181 The number is effectively the number of interactive command invocations.");
8184 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
8185 "Number of input events read from the keyboard so far.\n\
8186 This does not include events generated by keyboard macros.");
8187 num_nonmacro_input_events
= 0;
8189 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8190 "The frame in which the most recently read event occurred.\n\
8191 If the last event came from a keyboard macro, this is set to `macro'.");
8192 Vlast_event_frame
= Qnil
;
8194 /* This variable is set up in sysdep.c. */
8195 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
8196 "The ERASE character as set by the user with stty.");
8198 DEFVAR_LISP ("help-char", &Vhelp_char
,
8199 "Character to recognize as meaning Help.\n\
8200 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8201 If the value of `help-form' is nil, this char can be read normally.");
8202 XSETINT (Vhelp_char
, Ctl ('H'));
8204 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8205 "List of input events to recognize as meaning Help.\n\
8206 These work just like the value of `help-char' (see that).");
8207 Vhelp_event_list
= Qnil
;
8209 DEFVAR_LISP ("help-form", &Vhelp_form
,
8210 "Form to execute when character `help-char' is read.\n\
8211 If the form returns a string, that string is displayed.\n\
8212 If `help-form' is nil, the help char is not recognized.");
8215 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8216 "Command to run when `help-char' character follows a prefix key.\n\
8217 This command is used only when there is no actual binding\n\
8218 for that character after that prefix key.");
8219 Vprefix_help_command
= Qnil
;
8221 DEFVAR_LISP ("top-level", &Vtop_level
,
8222 "Form to evaluate when Emacs starts up.\n\
8223 Useful to set before you dump a modified Emacs.");
8226 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8227 "Translate table for keyboard input, or nil.\n\
8228 Each character is looked up in this string and the contents used instead.\n\
8229 The value may be a string, a vector, or a char-table.\n\
8230 If it is a string or vector of length N,\n\
8231 character codes N and up are untranslated.\n\
8232 In a vector or a char-table, an element which is nil means \"no translation\".");
8233 Vkeyboard_translate_table
= Qnil
;
8235 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8236 "Non-nil means to always spawn a subshell instead of suspending,\n\
8237 even if the operating system has support for stopping a process.");
8240 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8241 "Non-nil means prompt with menus when appropriate.\n\
8242 This is done when reading from a keymap that has a prompt string,\n\
8243 for elements that have prompt strings.\n\
8244 The menu is displayed on the screen\n\
8245 if X menus were enabled at configuration\n\
8246 time and the previous event was a mouse click prefix key.\n\
8247 Otherwise, menu prompting uses the echo area.");
8250 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8251 "Character to see next line of menu prompt.\n\
8252 Type this character while in a menu prompt to rotate around the lines of it.");
8253 XSETINT (menu_prompt_more_char
, ' ');
8255 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8256 "A mask of additional modifier keys to use with every keyboard character.\n\
8257 Emacs applies the modifiers of the character stored here to each keyboard\n\
8258 character it reads. For example, after evaluating the expression\n\
8259 (setq extra-keyboard-modifiers ?\\C-x)\n\
8260 all input characters will have the control modifier applied to them.\n\
8262 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8263 not count as a control character; rather, it counts as a character\n\
8264 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8265 cancels any modification.");
8266 extra_keyboard_modifiers
= 0;
8268 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8269 "If an editing command sets this to t, deactivate the mark afterward.\n\
8270 The command loop sets this to nil before each command,\n\
8271 and tests the value when the command returns.\n\
8272 Buffer modification stores t in this variable.");
8273 Vdeactivate_mark
= Qnil
;
8275 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8276 "Temporary storage of pre-command-hook or post-command-hook.");
8277 Vcommand_hook_internal
= Qnil
;
8279 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8280 "Normal hook run before each command is executed.\n\
8281 Errors running the hook are caught and ignored.");
8282 Vpre_command_hook
= Qnil
;
8284 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8285 "Normal hook run after each command is executed.\n\
8286 Errors running the hook are caught and ignored.");
8287 Vpost_command_hook
= Qnil
;
8289 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8290 "Normal hook run after each command is executed, if idle.\n\
8291 Errors running the hook are caught and ignored.\n\
8292 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
8293 Vpost_command_idle_hook
= Qnil
;
8295 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
8296 "Delay time before running `post-command-idle-hook'.\n\
8297 This is measured in microseconds.");
8298 post_command_idle_delay
= 100000;
8301 DEFVAR_LISP ("echo-area-clear-hook", ...,
8302 "Normal hook run when clearing the echo area.");
8304 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
8305 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
8307 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
8308 "t means menu bar, specified Lucid style, needs to be recomputed.");
8309 Vlucid_menu_bar_dirty_flag
= Qnil
;
8311 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
8312 "List of menu bar items to move to the end of the menu bar.\n\
8313 The elements of the list are event types that may have menu bar bindings.");
8314 Vmenu_bar_final_items
= Qnil
;
8316 DEFVAR_KBOARD ("overriding-terminal-local-map",
8317 Voverriding_terminal_local_map
,
8318 "Per-terminal keymap that overrides all other local keymaps.\n\
8319 If this variable is non-nil, it is used as a keymap instead of the\n\
8320 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
8321 This variable is intended to let commands such as `universal-argumemnt'\n\
8322 set up a different keymap for reading the next command.");
8324 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
8325 "Keymap that overrides all other local keymaps.\n\
8326 If this variable is non-nil, it is used as a keymap instead of the\n\
8327 buffer's local map, and the minor mode keymaps and text property keymaps.");
8328 Voverriding_local_map
= Qnil
;
8330 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
8331 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8332 Otherwise, the menu bar continues to reflect the buffer's local map\n\
8333 and the minor mode maps regardless of `overriding-local-map'.");
8334 Voverriding_local_map_menu_flag
= Qnil
;
8336 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
8337 "Keymap defining bindings for special events to execute at low level.");
8338 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
8340 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
8341 "*Non-nil means generate motion events for mouse motion.");
8343 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
8344 "Alist of system-specific X windows key symbols.\n\
8345 Each element should have the form (N . SYMBOL) where N is the\n\
8346 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
8347 and SYMBOL is its name.");
8349 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
8350 "List of deferred actions to be performed at a later time.\n\
8351 The precise format isn't relevant here; we just check whether it is nil.");
8352 Vdeferred_action_list
= Qnil
;
8354 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
8355 "Function to call to handle deferred actions, after each command.\n\
8356 This function is called with no arguments after each command\n\
8357 whenever `deferred-action-list' is non-nil.");
8358 Vdeferred_action_function
= Qnil
;
8360 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
8361 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8362 The value can be a length of time to show the message for.\n\
8363 If the value is non-nil and not a number, we wait 2 seconds.");
8364 Vsuggest_key_bindings
= Qt
;
8366 DEFVAR_LISP ("timer-list", &Vtimer_list
,
8367 "List of active absolute time timers in order of increasing time");
8370 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
8371 "List of active idle-time timers in order of increasing time");
8372 Vtimer_idle_list
= Qnil
;
8377 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
8378 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
8379 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
8380 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
8381 initial_define_key (meta_map
, 'x', "execute-extended-command");
8383 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
8384 "handle-delete-frame");
8385 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
8387 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",