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 Lisp_Object Qpolling_period
;
487 /* List of absolute timers. Appears in order of next scheduled event. */
488 Lisp_Object Vtimer_list
;
490 /* List of idle time timers. Appears in order of next scheduled event. */
491 Lisp_Object Vtimer_idle_list
;
493 /* Incremented whenever a timer is run. */
496 extern Lisp_Object Vprint_level
, Vprint_length
;
498 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
500 EMACS_TIME
*input_available_clear_time
;
502 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
503 Default is 1 if INTERRUPT_INPUT is defined. */
506 /* Nonzero while interrupts are temporarily deferred during redisplay. */
507 int interrupts_deferred
;
509 /* Nonzero means use ^S/^Q for flow control. */
512 /* Allow m- file to inhibit use of FIONREAD. */
513 #ifdef BROKEN_FIONREAD
517 /* We are unable to use interrupts if FIONREAD is not available,
518 so flush SIGIO so we won't try. */
525 /* If we support a window system, turn on the code to poll periodically
526 to detect C-g. It isn't actually used when doing interrupt input. */
527 #ifdef HAVE_WINDOW_SYSTEM
528 #define POLL_FOR_INPUT
531 /* Global variable declarations. */
533 /* Function for init_keyboard to call with no args (if nonzero). */
534 void (*keyboard_init_hook
) ();
536 static int read_avail_input ();
537 static void get_input_pending ();
538 static int readable_events ();
539 static Lisp_Object
read_char_x_menu_prompt ();
540 static Lisp_Object
read_char_minibuf_menu_prompt ();
541 static Lisp_Object
make_lispy_event ();
543 static Lisp_Object
make_lispy_movement ();
545 static Lisp_Object
modify_event_symbol ();
546 static Lisp_Object
make_lispy_switch_frame ();
547 static int parse_solitary_modifier ();
549 /* > 0 if we are to echo keystrokes. */
550 static int echo_keystrokes
;
552 /* Nonzero means don't try to suspend even if the operating system seems
554 static int cannot_suspend
;
556 #define min(a,b) ((a)<(b)?(a):(b))
557 #define max(a,b) ((a)>(b)?(a):(b))
559 /* Install the string STR as the beginning of the string of echoing,
560 so that it serves as a prompt for the next character.
561 Also start echoing. */
566 int len
= strlen (str
);
568 if (len
> ECHOBUFSIZE
- 4)
569 len
= ECHOBUFSIZE
- 4;
570 bcopy (str
, current_kboard
->echobuf
, len
);
571 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
572 *current_kboard
->echoptr
= '\0';
574 current_kboard
->echo_after_prompt
= len
;
579 /* Add C to the echo string, if echoing is going on.
580 C can be a character, which is printed prettily ("M-C-x" and all that
581 jazz), or a symbol, whose name is printed. */
586 extern char *push_key_description ();
588 if (current_kboard
->immediate_echo
)
590 char *ptr
= current_kboard
->echoptr
;
592 if (ptr
!= current_kboard
->echobuf
)
595 /* If someone has passed us a composite event, use its head symbol. */
600 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
603 ptr
= push_key_description (XINT (c
), ptr
);
605 else if (SYMBOLP (c
))
607 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
608 if ((ptr
- current_kboard
->echobuf
) + name
->size
+ 4 > ECHOBUFSIZE
)
610 bcopy (name
->data
, ptr
, name
->size
);
614 if (current_kboard
->echoptr
== current_kboard
->echobuf
617 strcpy (ptr
, " (Type ? for further options)");
622 current_kboard
->echoptr
= ptr
;
628 /* Temporarily add a dash to the end of the echo string if it's not
629 empty, so that it serves as a mini-prompt for the very next character. */
633 if (!current_kboard
->immediate_echo
634 && current_kboard
->echoptr
== current_kboard
->echobuf
)
636 /* Do nothing if we just printed a prompt. */
637 if (current_kboard
->echo_after_prompt
638 == current_kboard
->echoptr
- current_kboard
->echobuf
)
640 /* Do nothing if not echoing at all. */
641 if (current_kboard
->echoptr
== 0)
644 /* Put a dash at the end of the buffer temporarily,
645 but make it go away when the next character is added. */
646 current_kboard
->echoptr
[0] = '-';
647 current_kboard
->echoptr
[1] = 0;
652 /* Display the current echo string, and begin echoing if not already
657 if (!current_kboard
->immediate_echo
)
660 current_kboard
->immediate_echo
= 1;
662 for (i
= 0; i
< this_command_key_count
; i
++)
665 c
= XVECTOR (this_command_keys
)->contents
[i
];
666 if (! (EVENT_HAS_PARAMETERS (c
)
667 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
674 message1_nolog (current_kboard
->echobuf
);
677 if (waiting_for_input
&& !NILP (Vquit_flag
))
678 quit_throw_to_read_char ();
681 /* Turn off echoing, for the start of a new command. */
685 current_kboard
->immediate_echo
= 0;
686 current_kboard
->echoptr
= current_kboard
->echobuf
;
687 current_kboard
->echo_after_prompt
= -1;
688 ok_to_echo_at_next_pause
= 0;
691 /* Return the length of the current echo string. */
696 return current_kboard
->echoptr
- current_kboard
->echobuf
;
699 /* Truncate the current echo message to its first LEN chars.
700 This and echo_char get used by read_key_sequence when the user
701 switches frames while entering a key sequence. */
707 current_kboard
->echobuf
[len
] = '\0';
708 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
709 truncate_echo_area (len
);
713 /* Functions for manipulating this_command_keys. */
715 add_command_key (key
)
718 int size
= XVECTOR (this_command_keys
)->size
;
720 /* If reset-this-command-length was called recently, obey it now.
721 See the doc string of that function for an explanation of why. */
722 if (before_command_restore_flag
)
724 this_command_key_count
= before_command_key_count_1
;
725 if (this_command_key_count
< this_single_command_key_start
)
726 this_single_command_key_start
= this_command_key_count
;
727 echo_truncate (before_command_echo_length_1
);
728 before_command_restore_flag
= 0;
731 if (this_command_key_count
>= size
)
733 Lisp_Object new_keys
;
735 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
736 bcopy (XVECTOR (this_command_keys
)->contents
,
737 XVECTOR (new_keys
)->contents
,
738 size
* sizeof (Lisp_Object
));
740 this_command_keys
= new_keys
;
743 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
749 int count
= specpdl_ptr
- specpdl
;
752 if (command_loop_level
> 0)
754 specbind (Qstandard_output
, Qt
);
755 specbind (Qstandard_input
, Qt
);
758 val
= command_loop ();
760 Fsignal (Qquit
, Qnil
);
761 /* Handle throw from read_minibuf when using minibuffer
762 while it's active but we're in another window. */
764 Fsignal (Qerror
, Fcons (val
, Qnil
));
766 return unbind_to (count
, Qnil
);
769 /* When an auto-save happens, record the "time", and don't do again soon. */
773 last_auto_save
= num_nonmacro_input_events
;
776 /* Make an auto save happen as soon as possible at command level. */
778 force_auto_save_soon ()
780 last_auto_save
= - auto_save_interval
- 1;
782 record_asynch_buffer_change ();
785 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
786 "Invoke the editor command loop recursively.\n\
787 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
788 that tells this function to return.\n\
789 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
790 This function is called by the editor initialization to begin editing.")
793 int count
= specpdl_ptr
- specpdl
;
796 command_loop_level
++;
797 update_mode_lines
= 1;
799 record_unwind_protect (recursive_edit_unwind
,
801 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
805 return unbind_to (count
, Qnil
);
809 recursive_edit_unwind (buffer
)
813 Fset_buffer (buffer
);
815 command_loop_level
--;
816 update_mode_lines
= 1;
824 #if 0 /* Theory: if there's anything in Vunread_command_events,
825 it will right away be read by read_key_sequence,
826 and then if we do switch KBOARDS, it will go into the side
827 queue then. So we don't need to do anything special here -- rms. */
828 if (CONSP (Vunread_command_events
))
830 current_kboard
->kbd_queue
831 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
832 current_kboard
->kbd_queue_has_data
= 1;
834 Vunread_command_events
= Qnil
;
840 /* Switch to the single-kboard state, making current_kboard
841 the only KBOARD from which further input is accepted. */
844 single_kboard_state ()
851 /* Maintain a stack of kboards, so other parts of Emacs
852 can switch temporarily to the kboard of a given frame
853 and then revert to the previous status. */
858 struct kboard_stack
*next
;
861 static struct kboard_stack
*kboard_stack
;
864 push_frame_kboard (f
)
868 struct kboard_stack
*p
869 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
871 p
->next
= kboard_stack
;
872 p
->kboard
= current_kboard
;
875 current_kboard
= FRAME_KBOARD (f
);
883 struct kboard_stack
*p
= kboard_stack
;
884 current_kboard
= p
->kboard
;
885 kboard_stack
= p
->next
;
890 /* Handle errors that are not handled at inner levels
891 by printing an error message and returning to the editor command loop. */
897 Lisp_Object old_level
, old_length
;
900 if (!NILP (executing_macro
))
902 if (executing_macro_iterations
== 1)
903 sprintf (macroerror
, "After 1 kbd macro iteration: ");
905 sprintf (macroerror
, "After %d kbd macro iterations: ",
906 executing_macro_iterations
);
911 Vstandard_output
= Qt
;
912 Vstandard_input
= Qt
;
913 Vexecuting_macro
= Qnil
;
914 executing_macro
= Qnil
;
915 current_kboard
->Vprefix_arg
= Qnil
;
918 /* Avoid unquittable loop if data contains a circular list. */
919 old_level
= Vprint_level
;
920 old_length
= Vprint_length
;
921 XSETFASTINT (Vprint_level
, 10);
922 XSETFASTINT (Vprint_length
, 10);
923 cmd_error_internal (data
, macroerror
);
924 Vprint_level
= old_level
;
925 Vprint_length
= old_length
;
929 Vinhibit_quit
= Qnil
;
934 return make_number (0);
937 cmd_error_internal (data
, context
)
945 echo_area_glyphs
= 0;
947 /* If the window system or terminal frame hasn't been initialized
948 yet, or we're not interactive, it's best to dump this message out
949 to stderr and exit. */
950 if (! FRAME_MESSAGE_BUF (selected_frame
)
952 stream
= Qexternal_debugging_output
;
961 write_string_1 (context
, -1, stream
);
963 print_error_message (data
, stream
);
965 /* If the window system or terminal frame hasn't been initialized
966 yet, or we're in -batch mode, this error should cause Emacs to exit. */
967 if (! FRAME_MESSAGE_BUF (selected_frame
)
971 Fkill_emacs (make_number (-1));
975 Lisp_Object
command_loop_1 ();
976 Lisp_Object
command_loop_2 ();
977 Lisp_Object
top_level_1 ();
979 /* Entry to editor-command-loop.
980 This level has the catches for exiting/returning to editor command loop.
981 It returns nil to exit recursive edit, t to abort it. */
986 if (command_loop_level
> 0 || minibuf_level
> 0)
988 return internal_catch (Qexit
, command_loop_2
, Qnil
);
993 internal_catch (Qtop_level
, top_level_1
, Qnil
);
994 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
996 /* End of file in -batch run causes exit here. */
1002 /* Here we catch errors in execution of commands within the
1003 editing loop, and reenter the editing loop.
1004 When there is an error, cmd_error runs and returns a non-nil
1005 value to us. A value of nil means that cmd_loop_1 itself
1006 returned due to end of file (or end of kbd macro). */
1011 register Lisp_Object val
;
1014 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1015 while (!NILP (val
));
1023 return Feval (Vtop_level
);
1029 /* On entry to the outer level, run the startup file */
1030 if (!NILP (Vtop_level
))
1031 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1032 else if (!NILP (Vpurify_flag
))
1033 message ("Bare impure Emacs (standard Lisp code not loaded)");
1035 message ("Bare Emacs (standard Lisp code not loaded)");
1039 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1040 "Exit all recursive editing levels.")
1043 Fthrow (Qtop_level
, Qnil
);
1046 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1047 "Exit from the innermost recursive edit or minibuffer.")
1050 if (command_loop_level
> 0 || minibuf_level
> 0)
1051 Fthrow (Qexit
, Qnil
);
1053 error ("No recursive edit is in progress");
1056 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1057 "Abort the command that requested this recursive edit or minibuffer input.")
1060 if (command_loop_level
> 0 || minibuf_level
> 0)
1063 error ("No recursive edit is in progress");
1066 /* This is the actual command reading loop,
1067 sans error-handling encapsulation. */
1069 Lisp_Object
Fcommand_execute ();
1070 static int read_key_sequence ();
1071 void safe_run_hooks ();
1076 Lisp_Object cmd
, tem
;
1079 Lisp_Object keybuf
[30];
1084 struct buffer
*prev_buffer
;
1086 int was_locked
= single_kboard
;
1089 current_kboard
->Vprefix_arg
= Qnil
;
1090 Vdeactivate_mark
= Qnil
;
1091 waiting_for_input
= 0;
1096 this_command_key_count
= 0;
1097 this_single_command_key_start
= 0;
1099 /* Make sure this hook runs after commands that get errors and
1100 throw to top level. */
1101 /* Note that the value cell will never directly contain nil
1102 if the symbol is a local variable. */
1103 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1104 safe_run_hooks (Qpost_command_hook
);
1106 if (!NILP (Vdeferred_action_list
))
1107 call0 (Vdeferred_action_function
);
1109 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1111 if (NILP (Vunread_command_events
)
1112 && NILP (Vexecuting_macro
)
1113 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1114 safe_run_hooks (Qpost_command_idle_hook
);
1117 /* Do this after running Vpost_command_hook, for consistency. */
1118 current_kboard
->Vlast_command
= this_command
;
1122 /* Make sure the current window's buffer is selected. */
1123 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1124 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1126 /* Display any malloc warning that just came out. Use while because
1127 displaying one warning can cause another. */
1129 while (pending_malloc_warning
)
1130 display_malloc_warning ();
1134 Vdeactivate_mark
= Qnil
;
1136 /* If minibuffer on and echo area in use,
1137 wait 2 sec and redraw minibuffer. */
1139 if (minibuf_level
&& echo_area_glyphs
1140 && EQ (minibuf_window
, echo_area_window
))
1142 /* Bind inhibit-quit to t so that C-g gets read in
1143 rather than quitting back to the minibuffer. */
1144 int count
= specpdl_ptr
- specpdl
;
1145 specbind (Qinhibit_quit
, Qt
);
1147 Fsit_for (make_number (2), Qnil
, Qnil
);
1148 /* Clear the echo area. */
1150 safe_run_hooks (Qecho_area_clear_hook
);
1152 unbind_to (count
, Qnil
);
1154 /* If a C-g came in before, treat it as input now. */
1155 if (!NILP (Vquit_flag
))
1158 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1163 alloca (0); /* Cause a garbage collection now */
1164 /* Since we can free the most stuff here. */
1165 #endif /* C_ALLOCA */
1168 /* Select the frame that the last event came from. Usually,
1169 switch-frame events will take care of this, but if some lisp
1170 code swallows a switch-frame event, we'll fix things up here.
1171 Is this a good idea? */
1172 if (FRAMEP (internal_last_event_frame
)
1173 && XFRAME (internal_last_event_frame
) != selected_frame
)
1174 Fselect_frame (internal_last_event_frame
, Qnil
);
1176 /* If it has changed current-menubar from previous value,
1177 really recompute the menubar from the value. */
1178 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1179 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1180 call0 (Qrecompute_lucid_menubar
);
1182 before_command_key_count
= this_command_key_count
;
1183 before_command_echo_length
= echo_length ();
1185 this_command
= Qnil
;
1187 /* Read next key sequence; i gets its length. */
1188 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1191 /* A filter may have run while we were reading the input. */
1192 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1193 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1197 /* Now we have read a key sequence of length I,
1198 or else I is 0 and we found end of file. */
1200 if (i
== 0) /* End of file -- happens only in */
1201 return Qnil
; /* a kbd macro, at the end. */
1202 /* -1 means read_key_sequence got a menu that was rejected.
1203 Just loop around and read another command. */
1207 this_command_key_count
= 0;
1208 this_single_command_key_start
= 0;
1212 last_command_char
= keybuf
[i
- 1];
1214 /* If the previous command tried to force a specific window-start,
1215 forget about that, in case this command moves point far away
1216 from that position. But also throw away beg_unchanged and
1217 end_unchanged information in that case, so that redisplay will
1218 update the whole window properly. */
1219 if (!NILP (XWINDOW (selected_window
)->force_start
))
1221 XWINDOW (selected_window
)->force_start
= Qnil
;
1222 beg_unchanged
= end_unchanged
= 0;
1225 cmd
= read_key_sequence_cmd
;
1226 if (!NILP (Vexecuting_macro
))
1228 if (!NILP (Vquit_flag
))
1230 Vexecuting_macro
= Qt
;
1231 QUIT
; /* Make some noise. */
1232 /* Will return since macro now empty. */
1236 /* Do redisplay processing after this command except in special
1237 cases identified below that set no_redisplay to 1.
1238 (actually, there's currently no way to prevent the redisplay,
1239 and no_redisplay is ignored.
1240 Perhaps someday we will really implement it.) */
1243 prev_buffer
= current_buffer
;
1244 prev_modiff
= MODIFF
;
1245 last_point_position
= PT
;
1246 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1248 /* Execute the command. */
1251 /* Note that the value cell will never directly contain nil
1252 if the symbol is a local variable. */
1253 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1254 safe_run_hooks (Qpre_command_hook
);
1256 if (NILP (this_command
))
1258 /* nil means key is undefined. */
1260 current_kboard
->defining_kbd_macro
= Qnil
;
1261 update_mode_lines
= 1;
1262 current_kboard
->Vprefix_arg
= Qnil
;
1266 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1268 /* Recognize some common commands in common situations and
1269 do them directly. */
1270 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1272 struct Lisp_Char_Table
*dp
1273 = window_display_table (XWINDOW (selected_window
));
1274 lose
= FETCH_BYTE (PT
);
1275 SET_PT (forward_point (1));
1277 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1278 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1279 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1280 && (lose
>= 0x20 && lose
< 0x7f)))
1281 : (lose
>= 0x20 && lose
< 0x7f))
1282 /* To extract the case of continuation on
1283 wide-column characters. */
1284 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT
)) == 1)
1285 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1287 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1289 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1291 && !windows_or_buffers_changed
1292 && EQ (current_buffer
->selective_display
, Qnil
)
1293 && !detect_input_pending ()
1294 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1295 && NILP (Vexecuting_macro
))
1296 no_redisplay
= direct_output_forward_char (1);
1299 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1301 struct Lisp_Char_Table
*dp
1302 = window_display_table (XWINDOW (selected_window
));
1303 SET_PT (forward_point (-1));
1304 lose
= FETCH_BYTE (PT
);
1306 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1307 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1308 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1309 && (lose
>= 0x20 && lose
< 0x7f)))
1310 : (lose
>= 0x20 && lose
< 0x7f))
1311 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1313 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1315 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1317 && !windows_or_buffers_changed
1318 && EQ (current_buffer
->selective_display
, Qnil
)
1319 && !detect_input_pending ()
1320 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1321 && NILP (Vexecuting_macro
))
1322 no_redisplay
= direct_output_forward_char (-1);
1325 else if (EQ (this_command
, Qself_insert_command
)
1326 /* Try this optimization only on ascii keystrokes. */
1327 && INTEGERP (last_command_char
))
1329 unsigned int c
= XINT (last_command_char
);
1332 if (NILP (Vexecuting_macro
)
1333 && !EQ (minibuf_window
, selected_window
))
1335 if (!nonundocount
|| nonundocount
>= 20)
1342 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1344 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1346 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1348 || MODIFF
<= SAVE_MODIFF
1349 || windows_or_buffers_changed
1350 || !EQ (current_buffer
->selective_display
, Qnil
)
1351 || detect_input_pending ()
1352 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1353 || !NILP (Vexecuting_macro
));
1354 value
= internal_self_insert (c
, 0);
1361 && (PT
== ZV
|| FETCH_BYTE (PT
) == '\n'))
1363 struct Lisp_Char_Table
*dp
1364 = window_display_table (XWINDOW (selected_window
));
1371 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1374 /* Do it only for char codes
1375 that by default display as themselves. */
1376 if (lose
>= 0x20 && lose
<= 0x7e)
1377 no_redisplay
= direct_output_for_insert (lose
);
1379 else if (VECTORP (obj
)
1380 && XVECTOR (obj
)->size
== 1
1381 && (obj
= XVECTOR (obj
)->contents
[0],
1383 /* Insist face not specified in glyph. */
1384 && (XINT (obj
) & ((-1) << 8)) == 0)
1386 = direct_output_for_insert (XINT (obj
));
1390 if (lose
>= 0x20 && lose
<= 0x7e)
1391 no_redisplay
= direct_output_for_insert (lose
);
1398 /* Here for a command that isn't executed directly */
1401 if (NILP (current_kboard
->Vprefix_arg
))
1403 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1408 /* If there is a prefix argument,
1409 1) We don't want Vlast_command to be ``universal-argument''
1410 (that would be dumb), so don't set Vlast_command,
1411 2) we want to leave echoing on so that the prefix will be
1412 echoed as part of this key sequence, so don't call
1414 3) we want to leave this_command_key_count non-zero, so that
1415 read_char will realize that it is re-reading a character, and
1416 not echo it a second time.
1418 If the command didn't actually create a prefix arg,
1419 but is merely a frame event that is transparent to prefix args,
1420 then the above doesn't apply. */
1421 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1423 current_kboard
->Vlast_command
= this_command
;
1425 this_command_key_count
= 0;
1426 this_single_command_key_start
= 0;
1429 /* Note that the value cell will never directly contain nil
1430 if the symbol is a local variable. */
1431 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1432 safe_run_hooks (Qpost_command_hook
);
1434 if (!NILP (Vdeferred_action_list
))
1435 safe_run_hooks (Qdeferred_action_function
);
1437 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1439 if (NILP (Vunread_command_events
)
1440 && NILP (Vexecuting_macro
)
1441 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1442 safe_run_hooks (Qpost_command_idle_hook
);
1445 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1447 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1449 current_buffer
->mark_active
= Qnil
;
1450 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1452 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1453 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1457 /* Install chars successfully executed in kbd macro. */
1459 if (!NILP (current_kboard
->defining_kbd_macro
)
1460 && NILP (current_kboard
->Vprefix_arg
))
1461 finalize_kbd_macro_chars ();
1465 any_kboard_state ();
1470 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1473 safe_run_hooks_1 (hook
)
1476 return call1 (Vrun_hooks
, Vinhibit_quit
);
1479 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1482 safe_run_hooks_error (data
)
1485 Fset (Vinhibit_quit
, Qnil
);
1488 /* If we get an error while running the hook, cause the hook variable
1489 to be nil. Also inhibit quits, so that C-g won't cause the hook
1490 to mysteriously evaporate. */
1493 safe_run_hooks (hook
)
1497 int count
= specpdl_ptr
- specpdl
;
1498 specbind (Qinhibit_quit
, hook
);
1500 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1502 unbind_to (count
, Qnil
);
1505 /* Number of seconds between polling for input. */
1508 /* Nonzero means polling for input is temporarily suppressed. */
1509 int poll_suppress_count
;
1511 /* Nonzero if polling_for_input is actually being used. */
1512 int polling_for_input
;
1514 #ifdef POLL_FOR_INPUT
1516 /* Handle an alarm once each second and read pending input
1517 so as to handle a C-g if it comces in. */
1520 input_poll_signal (signalnum
) /* If we don't have an argument, */
1521 int signalnum
; /* some compilers complain in signal calls. */
1523 /* This causes the call to start_polling at the end
1524 to do its job. It also arranges for a quit or error
1525 from within read_avail_input to resume polling. */
1526 poll_suppress_count
++;
1527 if (interrupt_input_blocked
== 0
1528 && !waiting_for_input
)
1529 read_avail_input (0);
1530 /* Turn on the SIGALRM handler and request another alarm. */
1536 /* Begin signals to poll for input, if they are appropriate.
1537 This function is called unconditionally from various places. */
1541 #ifdef POLL_FOR_INPUT
1542 if (read_socket_hook
&& !interrupt_input
)
1544 poll_suppress_count
--;
1545 if (poll_suppress_count
== 0)
1547 signal (SIGALRM
, input_poll_signal
);
1548 polling_for_input
= 1;
1549 alarm (polling_period
);
1555 /* Nonzero if we are using polling to handle input asynchronously. */
1558 input_polling_used ()
1560 #ifdef POLL_FOR_INPUT
1561 return read_socket_hook
&& !interrupt_input
;
1567 /* Turn off polling. */
1571 #ifdef POLL_FOR_INPUT
1572 if (read_socket_hook
&& !interrupt_input
)
1574 if (poll_suppress_count
== 0)
1576 polling_for_input
= 0;
1579 poll_suppress_count
++;
1584 /* Set the value of poll_suppress_count to COUNT
1585 and start or stop polling accordingly. */
1588 set_poll_suppress_count (count
)
1591 #ifdef POLL_FOR_INPUT
1592 if (count
== 0 && poll_suppress_count
!= 0)
1594 poll_suppress_count
= 1;
1597 else if (count
!= 0 && poll_suppress_count
== 0)
1601 poll_suppress_count
= count
;
1605 /* Bind polling_period to a value at least N.
1606 But don't decrease it. */
1608 bind_polling_period (n
)
1611 #ifdef POLL_FOR_INPUT
1612 int new = polling_period
;
1618 specbind (Qpolling_period
, make_number (new));
1619 /* Start a new alarm with the new period. */
1624 /* Apply the control modifier to CHARACTER. */
1630 /* Save the upper bits here. */
1631 int upper
= c
& ~0177;
1635 /* Everything in the columns containing the upper-case letters
1636 denotes a control character. */
1637 if (c
>= 0100 && c
< 0140)
1641 /* Set the shift modifier for a control char
1642 made from a shifted letter. But only for letters! */
1643 if (oc
>= 'A' && oc
<= 'Z')
1644 c
|= shift_modifier
;
1647 /* The lower-case letters denote control characters too. */
1648 else if (c
>= 'a' && c
<= 'z')
1651 /* Include the bits for control and shift
1652 only if the basic ASCII code can't indicate them. */
1656 /* Replace the high bits. */
1657 c
|= (upper
& ~ctrl_modifier
);
1664 /* Input of single characters from keyboard */
1666 Lisp_Object
print_help ();
1667 static Lisp_Object
kbd_buffer_get_event ();
1668 static void record_char ();
1671 static jmp_buf wrong_kboard_jmpbuf
;
1674 /* read a character from the keyboard; call the redisplay if needed */
1675 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1676 -1 means do not do redisplay, but do do autosaving.
1679 /* The arguments MAPS and NMAPS are for menu prompting.
1680 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1682 PREV_EVENT is the previous input event, or nil if we are reading
1683 the first event of a key sequence.
1685 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1686 if we used a mouse menu to read the input, or zero otherwise. If
1687 USED_MOUSE_MENU is null, we don't dereference it.
1689 Value is t if we showed a menu and the user rejected it. */
1692 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1696 Lisp_Object prev_event
;
1697 int *used_mouse_menu
;
1699 register Lisp_Object c
;
1701 jmp_buf local_getcjmp
;
1703 int key_already_recorded
= 0;
1704 Lisp_Object tem
, save
;
1705 Lisp_Object also_record
;
1708 before_command_key_count
= this_command_key_count
;
1709 before_command_echo_length
= echo_length ();
1713 if (CONSP (Vunread_command_events
))
1715 c
= XCONS (Vunread_command_events
)->car
;
1716 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1718 /* Undo what read_char_x_menu_prompt did when it unread
1719 additional keys returned by Fx_popup_menu. */
1721 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1722 && NILP (XCONS (c
)->cdr
))
1725 if (this_command_key_count
== 0)
1731 if (unread_command_char
!= -1)
1733 XSETINT (c
, unread_command_char
);
1734 unread_command_char
= -1;
1736 if (this_command_key_count
== 0)
1742 /* If there is no function key translated before
1743 reset-this-command-lengths takes effect, forget about it. */
1744 before_command_restore_flag
= 0;
1746 if (!NILP (Vexecuting_macro
))
1748 /* We set this to Qmacro; since that's not a frame, nobody will
1749 try to switch frames on us, and the selected window will
1752 Since this event came from a macro, it would be misleading to
1753 leave internal_last_event_frame set to wherever the last
1754 real event came from. Normally, a switch-frame event selects
1755 internal_last_event_frame after each command is read, but
1756 events read from a macro should never cause a new frame to be
1758 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1760 /* Exit the macro if we are at the end.
1761 Also, some things replace the macro with t
1762 to force an early exit. */
1763 if (EQ (Vexecuting_macro
, Qt
)
1764 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1770 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1771 if (STRINGP (Vexecuting_macro
)
1772 && (XINT (c
) & 0x80))
1773 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1775 executing_macro_index
++;
1780 if (!NILP (unread_switch_frame
))
1782 c
= unread_switch_frame
;
1783 unread_switch_frame
= Qnil
;
1785 /* This event should make it into this_command_keys, and get echoed
1786 again, so we go to reread_first, rather than reread. */
1790 if (commandflag
>= 0 && !input_pending
1791 && !detect_input_pending_run_timers (0))
1794 /* Message turns off echoing unless more keystrokes turn it on again. */
1795 if (echo_area_glyphs
&& *echo_area_glyphs
1796 && echo_area_glyphs
!= current_kboard
->echobuf
1797 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1800 /* If already echoing, continue. */
1803 /* Try reading a character via menu prompting in the minibuf.
1804 Try this before the sit-for, because the sit-for
1805 would do the wrong thing if we are supposed to do
1806 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1807 after a mouse event so don't try a minibuf menu. */
1809 if (nmaps
> 0 && INTERACTIVE
1810 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1811 /* Don't bring up a menu if we already have another event. */
1812 && NILP (Vunread_command_events
)
1813 && unread_command_char
< 0
1814 && !detect_input_pending_run_timers (0))
1816 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1819 key_already_recorded
= 1;
1824 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1825 We will do that below, temporarily for short sections of code,
1826 when appropriate. local_getcjmp must be in effect
1827 around any call to sit_for or kbd_buffer_get_event;
1828 it *must not* be in effect when we call redisplay. */
1830 if (_setjmp (local_getcjmp
))
1832 XSETINT (c
, quit_char
);
1833 XSETFRAME (internal_last_event_frame
, selected_frame
);
1834 Vlast_event_frame
= internal_last_event_frame
;
1835 /* If we report the quit char as an event,
1836 don't do so more than once. */
1837 if (!NILP (Vinhibit_quit
))
1842 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1843 if (kb
!= current_kboard
)
1845 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1846 /* We shouldn't get here if we were in single-kboard mode! */
1849 while (CONSP (*tailp
))
1850 tailp
= &XCONS (*tailp
)->cdr
;
1853 *tailp
= Fcons (c
, Qnil
);
1854 kb
->kbd_queue_has_data
= 1;
1855 current_kboard
= kb
;
1856 longjmp (wrong_kboard_jmpbuf
, 1);
1863 timer_start_idle ();
1865 /* If in middle of key sequence and minibuffer not active,
1866 start echoing if enough time elapses. */
1868 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1869 && this_command_key_count
> 0
1871 && echo_keystrokes
> 0
1872 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1873 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1877 /* After a mouse event, start echoing right away.
1878 This is because we are probably about to display a menu,
1879 and we don't want to delay before doing so. */
1880 if (EVENT_HAS_PARAMETERS (prev_event
))
1884 save_getcjmp (save_jump
);
1885 restore_getcjmp (local_getcjmp
);
1886 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
1887 restore_getcjmp (save_jump
);
1889 && ! CONSP (Vunread_command_events
))
1894 /* Maybe auto save due to number of keystrokes. */
1896 if (commandflag
!= 0
1897 && auto_save_interval
> 0
1898 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
1899 && !detect_input_pending_run_timers (0))
1901 Fdo_auto_save (Qnil
, Qnil
);
1902 /* Hooks can actually change some buffers in auto save. */
1906 /* Try reading using an X menu.
1907 This is never confused with reading using the minibuf
1908 because the recursive call of read_char in read_char_minibuf_menu_prompt
1909 does not pass on any keymaps. */
1911 if (nmaps
> 0 && INTERACTIVE
1912 && !NILP (prev_event
)
1913 && EVENT_HAS_PARAMETERS (prev_event
)
1914 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1915 /* Don't bring up a menu if we already have another event. */
1916 && NILP (Vunread_command_events
)
1917 && unread_command_char
< 0)
1919 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1921 /* Now that we have read an event, Emacs is not idle. */
1927 /* Maybe autosave and/or garbage collect due to idleness. */
1929 if (INTERACTIVE
&& NILP (c
))
1931 int delay_level
, buffer_size
;
1933 /* Slow down auto saves logarithmically in size of current buffer,
1934 and garbage collect while we're at it. */
1935 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1936 last_non_minibuf_size
= Z
- BEG
;
1937 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1939 while (buffer_size
> 64)
1940 delay_level
++, buffer_size
-= buffer_size
>> 2;
1941 if (delay_level
< 4) delay_level
= 4;
1942 /* delay_level is 4 for files under around 50k, 7 at 100k,
1943 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1945 /* Auto save if enough time goes by without input. */
1946 if (commandflag
!= 0
1947 && num_nonmacro_input_events
> last_auto_save
1948 && INTEGERP (Vauto_save_timeout
)
1949 && XINT (Vauto_save_timeout
) > 0)
1953 save_getcjmp (save_jump
);
1954 restore_getcjmp (local_getcjmp
);
1955 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
1957 restore_getcjmp (save_jump
);
1960 && ! CONSP (Vunread_command_events
))
1962 Fdo_auto_save (Qnil
, Qnil
);
1964 /* If we have auto-saved and there is still no input
1965 available, garbage collect if there has been enough
1966 consing going on to make it worthwhile. */
1967 if (!detect_input_pending_run_timers (0)
1968 && consing_since_gc
> gc_cons_threshold
/ 2)
1969 Fgarbage_collect ();
1976 /* If this has become non-nil here, it has been set by a timer
1977 or sentinel or filter. */
1978 if (CONSP (Vunread_command_events
))
1980 c
= XCONS (Vunread_command_events
)->car
;
1981 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1984 /* Read something from current KBOARD's side queue, if possible. */
1988 if (current_kboard
->kbd_queue_has_data
)
1990 if (!CONSP (current_kboard
->kbd_queue
))
1992 c
= XCONS (current_kboard
->kbd_queue
)->car
;
1993 current_kboard
->kbd_queue
1994 = XCONS (current_kboard
->kbd_queue
)->cdr
;
1995 if (NILP (current_kboard
->kbd_queue
))
1996 current_kboard
->kbd_queue_has_data
= 0;
1997 input_pending
= readable_events (0);
1998 if (EVENT_HAS_PARAMETERS (c
)
1999 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2000 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2001 Vlast_event_frame
= internal_last_event_frame
;
2006 /* If current_kboard's side queue is empty check the other kboards.
2007 If one of them has data that we have not yet seen here,
2008 switch to it and process the data waiting for it.
2010 Note: if the events queued up for another kboard
2011 have already been seen here, and therefore are not a complete command,
2012 the kbd_queue_has_data field is 0, so we skip that kboard here.
2013 That's to avoid an infinite loop switching between kboards here. */
2014 if (NILP (c
) && !single_kboard
)
2017 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2018 if (kb
->kbd_queue_has_data
)
2020 current_kboard
= kb
;
2021 longjmp (wrong_kboard_jmpbuf
, 1);
2030 /* Finally, we read from the main queue,
2031 and if that gives us something we can't use yet, we put it on the
2032 appropriate side queue and try again. */
2038 /* Actually read a character, waiting if necessary. */
2039 save_getcjmp (save_jump
);
2040 restore_getcjmp (local_getcjmp
);
2041 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2042 restore_getcjmp (save_jump
);
2045 if (! NILP (c
) && (kb
!= current_kboard
))
2047 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2048 while (CONSP (*tailp
))
2049 tailp
= &XCONS (*tailp
)->cdr
;
2052 *tailp
= Fcons (c
, Qnil
);
2053 kb
->kbd_queue_has_data
= 1;
2057 current_kboard
= kb
;
2058 longjmp (wrong_kboard_jmpbuf
, 1);
2063 /* Terminate Emacs in batch mode if at eof. */
2064 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2065 Fkill_emacs (make_number (1));
2069 /* Add in any extra modifiers, where appropriate. */
2070 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2071 || ((extra_keyboard_modifiers
& 0177) < ' '
2072 && (extra_keyboard_modifiers
& 0177) != 0))
2073 XSETINT (c
, make_ctrl_char (XINT (c
)));
2075 /* Transfer any other modifier bits directly from
2076 extra_keyboard_modifiers to c. Ignore the actual character code
2077 in the low 16 bits of extra_keyboard_modifiers. */
2078 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2083 /* Now that we have read an event, Emacs is not idle--
2084 unless the event was a timer event (not used now). */
2092 if (commandflag
>= 0
2093 && !input_pending
&& !detect_input_pending_run_timers (0))
2101 /* Buffer switch events are only for internal wakeups
2102 so don't show them to the user. */
2106 if (key_already_recorded
)
2109 /* Process special events within read_char
2110 and loop around to read another event. */
2113 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2119 int was_locked
= single_kboard
;
2121 last_input_char
= c
;
2122 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2124 /* Resume allowing input from any kboard, if that was true before. */
2126 any_kboard_state ();
2131 /* Wipe the echo area. */
2132 if (echo_area_glyphs
)
2133 safe_run_hooks (Qecho_area_clear_hook
);
2134 echo_area_glyphs
= 0;
2136 /* Handle things that only apply to characters. */
2139 /* If kbd_buffer_get_event gave us an EOF, return that. */
2143 if (STRINGP (Vkeyboard_translate_table
)
2144 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2145 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2146 else if ((VECTORP (Vkeyboard_translate_table
)
2147 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2148 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2149 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2152 d
= Faref (Vkeyboard_translate_table
, c
);
2153 /* nil in keyboard-translate-table means no translation. */
2159 /* If this event is a mouse click in the menu bar,
2160 return just menu-bar for now. Modify the mouse click event
2161 so we won't do this twice, then queue it up. */
2162 if (EVENT_HAS_PARAMETERS (c
)
2163 && CONSP (XCONS (c
)->cdr
)
2164 && CONSP (EVENT_START (c
))
2165 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2169 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2170 /* Handle menu-bar events:
2171 insert the dummy prefix event `menu-bar'. */
2172 if (EQ (posn
, Qmenu_bar
))
2174 /* Change menu-bar to (menu-bar) as the event "position". */
2175 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2178 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2184 if (! NILP (also_record
))
2185 record_char (also_record
);
2189 before_command_key_count
= this_command_key_count
;
2190 before_command_echo_length
= echo_length ();
2192 /* Don't echo mouse motion events. */
2194 && ! (EVENT_HAS_PARAMETERS (c
)
2195 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2198 if (! NILP (also_record
))
2199 echo_char (also_record
);
2200 /* Once we reread a character, echoing can happen
2201 the next time we pause to read a new one. */
2202 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2205 /* Record this character as part of the current key. */
2206 add_command_key (c
);
2207 if (! NILP (also_record
))
2208 add_command_key (also_record
);
2210 /* Re-reading in the middle of a command */
2212 last_input_char
= c
;
2215 /* Process the help character specially if enabled */
2216 if (!NILP (Vhelp_form
) && help_char_p (c
))
2219 count
= specpdl_ptr
- specpdl
;
2221 record_unwind_protect (Fset_window_configuration
,
2222 Fcurrent_window_configuration (Qnil
));
2224 tem0
= Feval (Vhelp_form
);
2226 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2230 c
= read_char (0, 0, 0, Qnil
, 0);
2231 while (BUFFERP (c
));
2232 /* Remove the help from the frame */
2233 unbind_to (count
, Qnil
);
2236 if (EQ (c
, make_number (040)))
2240 c
= read_char (0, 0, 0, Qnil
, 0);
2241 while (BUFFERP (c
));
2248 /* Record a key that came from a mouse menu.
2249 Record it for echoing, for this-command-keys, and so on. */
2255 /* Wipe the echo area. */
2256 echo_area_glyphs
= 0;
2260 before_command_key_count
= this_command_key_count
;
2261 before_command_echo_length
= echo_length ();
2263 /* Don't echo mouse motion events. */
2264 if (echo_keystrokes
)
2268 /* Once we reread a character, echoing can happen
2269 the next time we pause to read a new one. */
2270 ok_to_echo_at_next_pause
= 0;
2273 /* Record this character as part of the current key. */
2274 add_command_key (c
);
2276 /* Re-reading in the middle of a command */
2277 last_input_char
= c
;
2281 /* Return 1 if should recognize C as "the help character". */
2289 if (EQ (c
, Vhelp_char
))
2291 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2292 if (EQ (c
, XCONS (tail
)->car
))
2297 /* Record the input event C in various ways. */
2304 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2305 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2306 recent_keys_index
= 0;
2308 /* Write c to the dribble file. If c is a lispy event, write
2309 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2310 If you, dear reader, have a better idea, you've got the source. :-) */
2315 if (XUINT (c
) < 0x100)
2316 putc (XINT (c
), dribble
);
2318 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2322 Lisp_Object dribblee
;
2324 /* If it's a structured event, take the event header. */
2325 dribblee
= EVENT_HEAD (c
);
2327 if (SYMBOLP (dribblee
))
2329 putc ('<', dribble
);
2330 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2331 XSYMBOL (dribblee
)->name
->size
,
2333 putc ('>', dribble
);
2340 store_kbd_macro_char (c
);
2342 num_nonmacro_input_events
++;
2349 struct buffer
*old
= current_buffer
;
2350 Fprinc (object
, Qnil
);
2351 set_buffer_internal (XBUFFER (Vstandard_output
));
2352 call0 (intern ("help-mode"));
2353 set_buffer_internal (old
);
2357 /* Copy out or in the info on where C-g should throw to.
2358 This is used when running Lisp code from within get_char,
2359 in case get_char is called recursively.
2360 See read_process_output. */
2365 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2368 restore_getcjmp (temp
)
2371 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2376 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2377 of this function. */
2380 tracking_off (old_value
)
2381 Lisp_Object old_value
;
2383 do_mouse_tracking
= old_value
;
2384 if (NILP (old_value
))
2386 /* Redisplay may have been preempted because there was input
2387 available, and it assumes it will be called again after the
2388 input has been processed. If the only input available was
2389 the sort that we have just disabled, then we need to call
2391 if (!readable_events (1))
2393 redisplay_preserve_echo_area ();
2394 get_input_pending (&input_pending
, 1);
2399 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2400 "Evaluate BODY with mouse movement events enabled.\n\
2401 Within a `track-mouse' form, mouse motion generates input events that\n\
2402 you can read with `read-event'.\n\
2403 Normally, mouse motion is ignored.")
2407 int count
= specpdl_ptr
- specpdl
;
2410 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2412 do_mouse_tracking
= Qt
;
2414 val
= Fprogn (args
);
2415 return unbind_to (count
, val
);
2418 /* If mouse has moved on some frame, return one of those frames.
2419 Return 0 otherwise. */
2424 Lisp_Object tail
, frame
;
2426 FOR_EACH_FRAME (tail
, frame
)
2428 if (XFRAME (frame
)->mouse_moved
)
2429 return XFRAME (frame
);
2435 #endif /* HAVE_MOUSE */
2437 /* Low level keyboard/mouse input.
2438 kbd_buffer_store_event places events in kbd_buffer, and
2439 kbd_buffer_get_event retrieves them. */
2441 /* Return true iff there are any events in the queue that read-char
2442 would return. If this returns false, a read-char would block. */
2444 readable_events (do_timers_now
)
2448 timer_check (do_timers_now
);
2450 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2453 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2458 if (current_kboard
->kbd_queue_has_data
)
2464 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2465 if (kb
->kbd_queue_has_data
)
2471 /* Set this for debugging, to have a way to get out */
2476 event_to_kboard (event
)
2477 struct input_event
*event
;
2480 frame
= event
->frame_or_window
;
2482 frame
= XCONS (frame
)->car
;
2483 else if (WINDOWP (frame
))
2484 frame
= WINDOW_FRAME (XWINDOW (frame
));
2486 /* There are still some events that don't set this field.
2487 For now, just ignore the problem.
2488 Also ignore dead frames here. */
2489 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2492 return FRAME_KBOARD (XFRAME (frame
));
2496 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2499 kbd_buffer_store_event (event
)
2500 register struct input_event
*event
;
2502 if (event
->kind
== no_event
)
2505 if (event
->kind
== ascii_keystroke
)
2507 register int c
= event
->code
& 0377;
2509 if (event
->modifiers
& ctrl_modifier
)
2510 c
= make_ctrl_char (c
);
2512 c
|= (event
->modifiers
2513 & (meta_modifier
| alt_modifier
2514 | hyper_modifier
| super_modifier
));
2518 extern SIGTYPE
interrupt_signal ();
2521 struct input_event
*sp
;
2524 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2525 kb
!= current_kboard
))
2528 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2529 Fcons (make_number (c
), Qnil
));
2530 kb
->kbd_queue_has_data
= 1;
2531 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2533 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2536 if (event_to_kboard (sp
) == kb
)
2538 sp
->kind
= no_event
;
2539 sp
->frame_or_window
= Qnil
;
2546 /* If this results in a quit_char being returned to Emacs as
2547 input, set Vlast_event_frame properly. If this doesn't
2548 get returned to Emacs as an event, the next event read
2549 will set Vlast_event_frame again, so this is safe to do. */
2553 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2555 focus
= event
->frame_or_window
;
2556 internal_last_event_frame
= focus
;
2557 Vlast_event_frame
= focus
;
2560 last_event_timestamp
= event
->timestamp
;
2561 interrupt_signal ();
2565 if (c
&& c
== stop_character
)
2571 /* Don't insert two buffer_switch_event's in a row.
2572 Just ignore the second one. */
2573 else if (event
->kind
== buffer_switch_event
2574 && kbd_fetch_ptr
!= kbd_store_ptr
2575 && kbd_store_ptr
->kind
== buffer_switch_event
)
2578 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2579 kbd_store_ptr
= kbd_buffer
;
2581 /* Don't let the very last slot in the buffer become full,
2582 since that would make the two pointers equal,
2583 and that is indistinguishable from an empty buffer.
2584 Discard the event if it would fill the last slot. */
2585 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2587 volatile struct input_event
*sp
= kbd_store_ptr
;
2588 sp
->kind
= event
->kind
;
2589 if (event
->kind
== selection_request_event
)
2591 /* We must not use the ordinary copying code for this case,
2592 since `part' is an enum and copying it might not copy enough
2594 bcopy (event
, (char *) sp
, sizeof (*event
));
2598 sp
->code
= event
->code
;
2599 sp
->part
= event
->part
;
2600 sp
->frame_or_window
= event
->frame_or_window
;
2601 sp
->modifiers
= event
->modifiers
;
2604 sp
->timestamp
= event
->timestamp
;
2606 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2608 = event
->frame_or_window
);
2614 /* Read one event from the event buffer, waiting if necessary.
2615 The value is a Lisp object representing the event.
2616 The value is nil for an event that should be ignored,
2617 or that was handled here.
2618 We always read and discard one event. */
2621 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2623 int *used_mouse_menu
;
2627 EMACS_TIME next_timer_delay
;
2633 *kbp
= current_kboard
;
2637 /* Wait until there is input available. */
2640 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2643 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2647 /* If the quit flag is set, then read_char will return
2648 quit_char, so that counts as "available input." */
2649 if (!NILP (Vquit_flag
))
2650 quit_throw_to_read_char ();
2652 /* One way or another, wait until input is available; then, if
2653 interrupt handlers have not read it, read it now. */
2656 wait_for_kbd_input ();
2658 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2662 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2665 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2669 Lisp_Object minus_one
;
2671 XSETINT (minus_one
, -1);
2672 wait_reading_process_input (0, 0, minus_one
, 1);
2674 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2675 /* Pass 1 for EXPECT since we just waited to have input. */
2676 read_avail_input (1);
2678 #endif /* not VMS */
2681 if (CONSP (Vunread_command_events
))
2684 first
= XCONS (Vunread_command_events
)->car
;
2685 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2686 *kbp
= current_kboard
;
2690 /* At this point, we know that there is a readable event available
2691 somewhere. If the event queue is empty, then there must be a
2692 mouse movement enabled and available. */
2693 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2695 struct input_event
*event
;
2697 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2701 last_event_timestamp
= event
->timestamp
;
2704 *kbp
= event_to_kboard (event
);
2706 *kbp
= current_kboard
; /* Better than returning null ptr? */
2708 *kbp
= &the_only_kboard
;
2713 /* These two kinds of events get special handling
2714 and don't actually appear to the command loop.
2715 We return nil for them. */
2716 if (event
->kind
== selection_request_event
)
2719 struct input_event copy
;
2721 /* Remove it from the buffer before processing it,
2722 since otherwise swallow_events will see it
2723 and process it again. */
2725 kbd_fetch_ptr
= event
+ 1;
2726 input_pending
= readable_events (0);
2727 x_handle_selection_request (©
);
2729 /* We're getting selection request events, but we don't have
2735 else if (event
->kind
== selection_clear_event
)
2738 struct input_event copy
;
2740 /* Remove it from the buffer before processing it. */
2742 kbd_fetch_ptr
= event
+ 1;
2743 input_pending
= readable_events (0);
2744 x_handle_selection_clear (©
);
2746 /* We're getting selection request events, but we don't have
2751 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2752 else if (event
->kind
== delete_window_event
)
2754 /* Make an event (delete-frame (FRAME)). */
2755 obj
= Fcons (event
->frame_or_window
, Qnil
);
2756 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2757 kbd_fetch_ptr
= event
+ 1;
2759 else if (event
->kind
== iconify_event
)
2761 /* Make an event (iconify-frame (FRAME)). */
2762 obj
= Fcons (event
->frame_or_window
, Qnil
);
2763 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2764 kbd_fetch_ptr
= event
+ 1;
2766 else if (event
->kind
== deiconify_event
)
2768 /* Make an event (make-frame-visible (FRAME)). */
2769 obj
= Fcons (event
->frame_or_window
, Qnil
);
2770 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2771 kbd_fetch_ptr
= event
+ 1;
2774 else if (event
->kind
== buffer_switch_event
)
2776 /* The value doesn't matter here; only the type is tested. */
2777 XSETBUFFER (obj
, current_buffer
);
2778 kbd_fetch_ptr
= event
+ 1;
2780 #ifdef USE_X_TOOLKIT
2781 else if (event
->kind
== menu_bar_activate_event
)
2783 kbd_fetch_ptr
= event
+ 1;
2784 input_pending
= readable_events (0);
2785 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2786 x_activate_menubar (XFRAME (event
->frame_or_window
));
2789 /* Just discard these, by returning nil.
2790 With MULTI_KBOARD, these events are used as placeholders
2791 when we need to randomly delete events from the queue.
2792 (They shouldn't otherwise be found in the buffer,
2793 but on some machines it appears they do show up
2794 even without MULTI_KBOARD.) */
2795 else if (event
->kind
== no_event
)
2796 kbd_fetch_ptr
= event
+ 1;
2798 /* If this event is on a different frame, return a switch-frame this
2799 time, and leave the event in the queue for next time. */
2805 frame
= event
->frame_or_window
;
2807 frame
= XCONS (frame
)->car
;
2808 else if (WINDOWP (frame
))
2809 frame
= WINDOW_FRAME (XWINDOW (frame
));
2811 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2815 if (! EQ (frame
, internal_last_event_frame
)
2816 && XFRAME (frame
) != selected_frame
)
2817 obj
= make_lispy_switch_frame (frame
);
2818 internal_last_event_frame
= frame
;
2820 /* If we didn't decide to make a switch-frame event, go ahead
2821 and build a real event from the queue entry. */
2825 obj
= make_lispy_event (event
);
2826 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2827 /* If this was a menu selection, then set the flag to inhibit
2828 writing to last_nonmenu_event. Don't do this if the event
2829 we're returning is (menu-bar), though; that indicates the
2830 beginning of the menu sequence, and we might as well leave
2831 that as the `event with parameters' for this selection. */
2832 if (event
->kind
== menu_bar_event
2833 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2835 *used_mouse_menu
= 1;
2838 /* Wipe out this event, to catch bugs. */
2839 event
->kind
= no_event
;
2840 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2842 kbd_fetch_ptr
= event
+ 1;
2847 /* Try generating a mouse motion event. */
2848 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2850 FRAME_PTR f
= some_mouse_moved ();
2851 Lisp_Object bar_window
;
2852 enum scroll_bar_part part
;
2856 *kbp
= current_kboard
;
2857 /* Note that this uses F to determine which display to look at.
2858 If there is no valid info, it does not store anything
2859 so x remains nil. */
2861 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2865 /* Decide if we should generate a switch-frame event. Don't
2866 generate switch-frame events for motion outside of all Emacs
2872 frame
= FRAME_FOCUS_FRAME (f
);
2874 XSETFRAME (frame
, f
);
2876 if (! EQ (frame
, internal_last_event_frame
)
2877 && XFRAME (frame
) != selected_frame
)
2878 obj
= make_lispy_switch_frame (frame
);
2879 internal_last_event_frame
= frame
;
2882 /* If we didn't decide to make a switch-frame event, go ahead and
2883 return a mouse-motion event. */
2884 if (!NILP (x
) && NILP (obj
))
2885 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2887 #endif /* HAVE_MOUSE */
2889 /* We were promised by the above while loop that there was
2890 something for us to read! */
2893 input_pending
= readable_events (0);
2895 Vlast_event_frame
= internal_last_event_frame
;
2900 /* Process any events that are not user-visible,
2901 then return, without reading any user-visible events. */
2904 swallow_events (do_display
)
2909 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2911 struct input_event
*event
;
2913 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2917 last_event_timestamp
= event
->timestamp
;
2919 /* These two kinds of events get special handling
2920 and don't actually appear to the command loop. */
2921 if (event
->kind
== selection_request_event
)
2924 struct input_event copy
;
2926 /* Remove it from the buffer before processing it,
2927 since otherwise swallow_events called recursively could see it
2928 and process it again. */
2930 kbd_fetch_ptr
= event
+ 1;
2931 input_pending
= readable_events (0);
2932 x_handle_selection_request (©
);
2934 /* We're getting selection request events, but we don't have
2940 else if (event
->kind
== selection_clear_event
)
2943 struct input_event copy
;
2945 /* Remove it from the buffer before processing it, */
2948 kbd_fetch_ptr
= event
+ 1;
2949 input_pending
= readable_events (0);
2950 x_handle_selection_clear (©
);
2952 /* We're getting selection request events, but we don't have
2961 old_timers_run
= timers_run
;
2962 get_input_pending (&input_pending
, 1);
2964 if (timers_run
!= old_timers_run
&& do_display
)
2965 redisplay_preserve_echo_area ();
2968 static EMACS_TIME timer_idleness_start_time
;
2970 /* Record the start of when Emacs is idle,
2971 for the sake of running idle-time timers. */
2977 /* If we are already in the idle state, do nothing. */
2978 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2981 EMACS_GET_TIME (timer_idleness_start_time
);
2983 /* Mark all idle-time timers as once again candidates for running. */
2984 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
2988 timer
= XCONS (timers
)->car
;
2990 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
2992 XVECTOR (timer
)->contents
[0] = Qnil
;
2996 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3000 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3003 /* This is only for debugging. */
3004 struct input_event last_timer_event
;
3006 /* Check whether a timer has fired. To prevent larger problems we simply
3007 disregard elements that are not proper timers. Do not make a circular
3008 timer list for the time being.
3010 Returns the number of seconds to wait until the next timer fires. If a
3011 timer is triggering now, return zero seconds.
3012 If no timer is active, return -1 seconds.
3014 If a timer is ripe, we run it, with quitting turned off.
3016 DO_IT_NOW is now ignored. It used to mean that we should
3017 run the timer directly instead of queueing a timer-event.
3018 Now we always run timers directly. */
3021 timer_check (do_it_now
)
3024 EMACS_TIME nexttime
;
3025 EMACS_TIME now
, idleness_now
;
3026 Lisp_Object timers
, idle_timers
, chosen_timer
;
3027 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3029 EMACS_SET_SECS (nexttime
, -1);
3030 EMACS_SET_USECS (nexttime
, -1);
3032 /* Always consider the ordinary timers. */
3033 timers
= Vtimer_list
;
3034 /* Consider the idle timers only if Emacs is idle. */
3035 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3036 idle_timers
= Vtimer_idle_list
;
3039 chosen_timer
= Qnil
;
3040 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3042 if (CONSP (timers
) || CONSP (idle_timers
))
3044 EMACS_GET_TIME (now
);
3045 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3046 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3049 while (CONSP (timers
) || CONSP (idle_timers
))
3051 int triggertime
= EMACS_SECS (now
);
3052 Lisp_Object
*vector
;
3053 Lisp_Object timer
, idle_timer
;
3054 EMACS_TIME timer_time
, idle_timer_time
;
3055 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3057 /* Skip past invalid timers and timers already handled. */
3060 timer
= XCONS (timers
)->car
;
3061 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3063 timers
= XCONS (timers
)->cdr
;
3066 vector
= XVECTOR (timer
)->contents
;
3068 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3069 || !INTEGERP (vector
[3])
3070 || ! NILP (vector
[0]))
3072 timers
= XCONS (timers
)->cdr
;
3076 if (!NILP (idle_timers
))
3078 timer
= XCONS (idle_timers
)->car
;
3079 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3081 idle_timers
= XCONS (idle_timers
)->cdr
;
3084 vector
= XVECTOR (timer
)->contents
;
3086 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3087 || !INTEGERP (vector
[3])
3088 || ! NILP (vector
[0]))
3090 idle_timers
= XCONS (idle_timers
)->cdr
;
3095 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3096 based on the next ordinary timer.
3097 TIMER_DIFFERENCE is the distance in time from NOW to when
3098 this timer becomes ripe (negative if it's already ripe). */
3101 timer
= XCONS (timers
)->car
;
3102 vector
= XVECTOR (timer
)->contents
;
3103 EMACS_SET_SECS (timer_time
,
3104 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3105 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3106 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3109 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3110 based on the next idle timer. */
3111 if (!NILP (idle_timers
))
3113 idle_timer
= XCONS (idle_timers
)->car
;
3114 vector
= XVECTOR (idle_timer
)->contents
;
3115 EMACS_SET_SECS (idle_timer_time
,
3116 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3117 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3118 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3121 /* Decide which timer is the next timer,
3122 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3123 Also step down the list where we found that timer. */
3125 if (! NILP (timers
) && ! NILP (idle_timers
))
3128 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3129 if (EMACS_TIME_NEG_P (temp
))
3131 chosen_timer
= timer
;
3132 timers
= XCONS (timers
)->cdr
;
3133 difference
= timer_difference
;
3137 chosen_timer
= idle_timer
;
3138 idle_timers
= XCONS (idle_timers
)->cdr
;
3139 difference
= idle_timer_difference
;
3142 else if (! NILP (timers
))
3144 chosen_timer
= timer
;
3145 timers
= XCONS (timers
)->cdr
;
3146 difference
= timer_difference
;
3150 chosen_timer
= idle_timer
;
3151 idle_timers
= XCONS (idle_timers
)->cdr
;
3152 difference
= idle_timer_difference
;
3154 vector
= XVECTOR (chosen_timer
)->contents
;
3156 /* If timer is rupe, run it if it hasn't been run. */
3157 if (EMACS_TIME_NEG_P (difference
)
3158 || (EMACS_SECS (difference
) == 0
3159 && EMACS_USECS (difference
) == 0))
3161 if (NILP (vector
[0]))
3164 int was_locked
= single_kboard
;
3165 int count
= specpdl_ptr
- specpdl
;
3167 /* Mark the timer as triggered to prevent problems if the lisp
3168 code fails to reschedule it right. */
3171 specbind (Qinhibit_quit
, Qt
);
3173 call1 (Qtimer_event_handler
, chosen_timer
);
3176 unbind_to (count
, Qnil
);
3178 /* Resume allowing input from any kboard, if that was true before. */
3180 any_kboard_state ();
3182 /* Since we have handled the event,
3183 we don't need to tell the caller to wake up and do it. */
3187 /* When we encounter a timer that is still waiting,
3188 return the amount of time to wait before it is ripe. */
3195 /* No timers are pending in the future. */
3196 /* Return 0 if we generated an event, and -1 if not. */
3201 /* Caches for modify_event_symbol. */
3202 static Lisp_Object accent_key_syms
;
3203 static Lisp_Object func_key_syms
;
3204 static Lisp_Object mouse_syms
;
3206 /* This is a list of keysym codes for special "accent" characters.
3207 It parallels lispy_accent_keys. */
3209 static int lispy_accent_codes
[] =
3211 #ifdef XK_dead_circumflex
3216 #ifdef XK_dead_grave
3221 #ifdef XK_dead_tilde
3226 #ifdef XK_dead_diaeresis
3231 #ifdef XK_dead_macron
3236 #ifdef XK_dead_degree
3241 #ifdef XK_dead_acute
3246 #ifdef XK_dead_cedilla
3251 #ifdef XK_dead_breve
3256 #ifdef XK_dead_ogonek
3261 #ifdef XK_dead_caron
3266 #ifdef XK_dead_doubleacute
3267 XK_dead_doubleacute
,
3271 #ifdef XK_dead_abovedot
3278 /* This is a list of Lisp names for special "accent" characters.
3279 It parallels lispy_accent_codes. */
3281 static char *lispy_accent_keys
[] =
3299 #define FUNCTION_KEY_OFFSET 0x0
3301 char *lispy_function_keys
[] =
3305 0, /* VK_LBUTTON 0x01 */
3306 0, /* VK_RBUTTON 0x02 */
3307 "cancel", /* VK_CANCEL 0x03 */
3308 0, /* VK_MBUTTON 0x04 */
3310 0, 0, 0, /* 0x05 .. 0x07 */
3312 "backspace", /* VK_BACK 0x08 */
3313 "tab", /* VK_TAB 0x09 */
3315 0, 0, /* 0x0A .. 0x0B */
3317 "clear", /* VK_CLEAR 0x0C */
3318 "return", /* VK_RETURN 0x0D */
3320 0, 0, /* 0x0E .. 0x0F */
3322 "shift", /* VK_SHIFT 0x10 */
3323 "control", /* VK_CONTROL 0x11 */
3324 "menu", /* VK_MENU 0x12 */
3325 "pause", /* VK_PAUSE 0x13 */
3326 "capital", /* VK_CAPITAL 0x14 */
3328 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3330 0, /* VK_ESCAPE 0x1B */
3332 0, 0, 0, 0, /* 0x1C .. 0x1F */
3334 0, /* VK_SPACE 0x20 */
3335 "prior", /* VK_PRIOR 0x21 */
3336 "next", /* VK_NEXT 0x22 */
3337 "end", /* VK_END 0x23 */
3338 "home", /* VK_HOME 0x24 */
3339 "left", /* VK_LEFT 0x25 */
3340 "up", /* VK_UP 0x26 */
3341 "right", /* VK_RIGHT 0x27 */
3342 "down", /* VK_DOWN 0x28 */
3343 "select", /* VK_SELECT 0x29 */
3344 "print", /* VK_PRINT 0x2A */
3345 "execute", /* VK_EXECUTE 0x2B */
3346 "snapshot", /* VK_SNAPSHOT 0x2C */
3347 "insert", /* VK_INSERT 0x2D */
3348 "delete", /* VK_DELETE 0x2E */
3349 "help", /* VK_HELP 0x2F */
3351 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3353 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3355 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3357 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3359 0, 0, 0, 0, 0, 0, 0, 0, 0,
3360 0, 0, 0, 0, 0, 0, 0, 0, 0,
3361 0, 0, 0, 0, 0, 0, 0, 0,
3363 "lwindow", /* VK_LWIN 0x5B */
3364 "rwindow", /* VK_RWIN 0x5C */
3365 "apps", /* VK_APPS 0x5D */
3367 0, 0, /* 0x5E .. 0x5F */
3369 "kp-0", /* VK_NUMPAD0 0x60 */
3370 "kp-1", /* VK_NUMPAD1 0x61 */
3371 "kp-2", /* VK_NUMPAD2 0x62 */
3372 "kp-3", /* VK_NUMPAD3 0x63 */
3373 "kp-4", /* VK_NUMPAD4 0x64 */
3374 "kp-5", /* VK_NUMPAD5 0x65 */
3375 "kp-6", /* VK_NUMPAD6 0x66 */
3376 "kp-7", /* VK_NUMPAD7 0x67 */
3377 "kp-8", /* VK_NUMPAD8 0x68 */
3378 "kp-9", /* VK_NUMPAD9 0x69 */
3379 "kp-multiply", /* VK_MULTIPLY 0x6A */
3380 "kp-add", /* VK_ADD 0x6B */
3381 "kp-separator", /* VK_SEPARATOR 0x6C */
3382 "kp-subtract", /* VK_SUBTRACT 0x6D */
3383 "kp-decimal", /* VK_DECIMAL 0x6E */
3384 "kp-divide", /* VK_DIVIDE 0x6F */
3385 "f1", /* VK_F1 0x70 */
3386 "f2", /* VK_F2 0x71 */
3387 "f3", /* VK_F3 0x72 */
3388 "f4", /* VK_F4 0x73 */
3389 "f5", /* VK_F5 0x74 */
3390 "f6", /* VK_F6 0x75 */
3391 "f7", /* VK_F7 0x76 */
3392 "f8", /* VK_F8 0x77 */
3393 "f9", /* VK_F9 0x78 */
3394 "f10", /* VK_F10 0x79 */
3395 "f11", /* VK_F11 0x7A */
3396 "f12", /* VK_F12 0x7B */
3397 "f13", /* VK_F13 0x7C */
3398 "f14", /* VK_F14 0x7D */
3399 "f15", /* VK_F15 0x7E */
3400 "f16", /* VK_F16 0x7F */
3401 "f17", /* VK_F17 0x80 */
3402 "f18", /* VK_F18 0x81 */
3403 "f19", /* VK_F19 0x82 */
3404 "f20", /* VK_F20 0x83 */
3405 "f21", /* VK_F21 0x84 */
3406 "f22", /* VK_F22 0x85 */
3407 "f23", /* VK_F23 0x86 */
3408 "f24", /* VK_F24 0x87 */
3410 0, 0, 0, 0, /* 0x88 .. 0x8B */
3411 0, 0, 0, 0, /* 0x8C .. 0x8F */
3413 "kp-numlock", /* VK_NUMLOCK 0x90 */
3414 "scroll", /* VK_SCROLL 0x91 */
3416 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3417 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3418 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3419 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3420 "kp-end", /* VK_NUMPAD_END 0x96 */
3421 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3422 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3423 "kp-up", /* VK_NUMPAD_UP 0x99 */
3424 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3425 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3426 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3427 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3429 0, 0, /* 0x9E .. 0x9F */
3432 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3433 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3434 * No other API or message will distinguish left and right keys this way.
3438 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3439 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3440 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3441 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3442 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3448 "attn", /* VK_ATTN 0xF6 */
3449 "crsel", /* VK_CRSEL 0xF7 */
3450 "exsel", /* VK_EXSEL 0xF8 */
3451 "ereof", /* VK_EREOF 0xF9 */
3452 "play", /* VK_PLAY 0xFA */
3453 "zoom", /* VK_ZOOM 0xFB */
3454 "noname", /* VK_NONAME 0xFC */
3455 "pa1", /* VK_PA1 0xFD */
3456 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3459 #else /* not HAVE_NTGUI */
3462 static char *lispy_kana_keys
[] =
3464 /* X Keysym value */
3465 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3466 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3467 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3468 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3469 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3470 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3471 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3472 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3473 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3474 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3475 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3476 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3477 "kana-i", "kana-u", "kana-e", "kana-o",
3478 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3479 "prolongedsound", "kana-A", "kana-I", "kana-U",
3480 "kana-E", "kana-O", "kana-KA", "kana-KI",
3481 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3482 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3483 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3484 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3485 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3486 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3487 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3488 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3489 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3490 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3491 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3492 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3494 #endif /* XK_kana_A */
3496 #define FUNCTION_KEY_OFFSET 0xff00
3498 /* You'll notice that this table is arranged to be conveniently
3499 indexed by X Windows keysym values. */
3500 static char *lispy_function_keys
[] =
3502 /* X Keysym value */
3504 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3512 0, 0, 0, /* 0xff10 */
3514 0, 0, 0, 0, 0, 0, 0,
3517 0, "kanji", "muhenkan",
3518 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3519 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3520 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3522 "home", /* 0xff50 */ /* IsCursorKey */
3533 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3544 "break", /* 0xff6b */
3546 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3548 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3549 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3550 0, 0, 0, 0, 0, 0, 0, 0,
3551 "kp-tab", /* 0xff89 */
3553 "kp-enter", /* 0xff8d */
3555 "kp-f1", /* 0xff91 */
3559 "kp-home", /* 0xff95 */
3564 "kp-prior", /* kp-page-up */
3565 "kp-next", /* kp-page-down */
3571 0, 0, 0, 0, 0, 0, 0, 0, 0,
3572 "kp-multiply", /* 0xffaa */
3577 "kp-divide", /* 0xffaf */
3578 "kp-0", /* 0xffb0 */
3579 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3582 "kp-equal", /* 0xffbd */
3583 "f1", /* 0xffbe */ /* IsFunctionKey */
3585 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3586 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3587 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3588 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3589 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3590 0, 0, 0, 0, 0, 0, 0, 0,
3591 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3592 0, 0, 0, 0, 0, 0, 0, "delete"
3595 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3596 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3598 static char *iso_lispy_function_keys
[] =
3600 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3601 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3602 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3603 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3604 "iso-lefttab", /* 0xfe20 */
3605 "iso-move-line-up", "iso-move-line-down",
3606 "iso-partial-line-up", "iso-partial-line-down",
3607 "iso-partial-space-left", "iso-partial-space-right",
3608 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3609 "iso-release-margin-left", "iso-release-margin-right",
3610 "iso-release-both-margins",
3611 "iso-fast-cursor-left", "iso-fast-cursor-right",
3612 "iso-fast-cursor-up", "iso-fast-cursor-down",
3613 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3614 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3617 #endif /* not HAVE_NTGUI */
3619 static char *lispy_mouse_names
[] =
3621 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3624 /* Scroll bar parts. */
3625 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3626 Lisp_Object Qup
, Qdown
;
3628 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3629 Lisp_Object
*scroll_bar_parts
[] = {
3630 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3635 /* A vector, indexed by button number, giving the down-going location
3636 of currently depressed buttons, both scroll bar and non-scroll bar.
3638 The elements have the form
3639 (BUTTON-NUMBER MODIFIER-MASK . REST)
3640 where REST is the cdr of a position as it would be reported in the event.
3642 The make_lispy_event function stores positions here to tell the
3643 difference between click and drag events, and to store the starting
3644 location to be included in drag events. */
3646 static Lisp_Object button_down_location
;
3648 /* Information about the most recent up-going button event: Which
3649 button, what location, and what time. */
3651 static int last_mouse_button
;
3652 static int last_mouse_x
;
3653 static int last_mouse_y
;
3654 static unsigned long button_down_time
;
3656 /* The maximum time between clicks to make a double-click,
3657 or Qnil to disable double-click detection,
3658 or Qt for no time limit. */
3659 Lisp_Object Vdouble_click_time
;
3661 /* The number of clicks in this multiple-click. */
3663 int double_click_count
;
3665 /* Given a struct input_event, build the lisp event which represents
3666 it. If EVENT is 0, build a mouse movement event from the mouse
3667 movement buffer, which should have a movement event in it.
3669 Note that events must be passed to this function in the order they
3670 are received; this function stores the location of button presses
3671 in order to build drag events when the button is released. */
3674 make_lispy_event (event
)
3675 struct input_event
*event
;
3679 switch (SWITCH_ENUM_CAST (event
->kind
))
3681 /* A simple keystroke. */
3682 case ascii_keystroke
:
3684 Lisp_Object lispy_c
;
3685 int c
= event
->code
& 0377;
3686 /* Turn ASCII characters into control characters
3688 if (event
->modifiers
& ctrl_modifier
)
3689 c
= make_ctrl_char (c
);
3691 /* Add in the other modifier bits. We took care of ctrl_modifier
3692 just above, and the shift key was taken care of by the X code,
3693 and applied to control characters by make_ctrl_char. */
3694 c
|= (event
->modifiers
3695 & (meta_modifier
| alt_modifier
3696 | hyper_modifier
| super_modifier
));
3697 button_down_time
= 0;
3698 XSETFASTINT (lispy_c
, c
);
3702 /* A function key. The symbol may need to have modifier prefixes
3704 case non_ascii_keystroke
:
3705 button_down_time
= 0;
3707 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3708 if (event
->code
== lispy_accent_codes
[i
])
3709 return modify_event_symbol (i
,
3711 Qfunction_key
, Qnil
,
3712 lispy_accent_keys
, &accent_key_syms
,
3713 (sizeof (lispy_accent_keys
)
3714 / sizeof (lispy_accent_keys
[0])));
3716 /* Handle system-specific keysyms. */
3717 if (event
->code
& (1 << 28))
3719 /* We need to use an alist rather than a vector as the cache
3720 since we can't make a vector long enuf. */
3721 if (NILP (current_kboard
->system_key_syms
))
3722 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3723 return modify_event_symbol (event
->code
,
3726 current_kboard
->Vsystem_key_alist
,
3727 0, ¤t_kboard
->system_key_syms
,
3732 if (event
->code
>= 0x400 && event
->code
< 0x500)
3733 return modify_event_symbol (event
->code
- 0x400,
3734 event
->modifiers
& ~shift_modifier
,
3735 Qfunction_key
, Qnil
,
3736 lispy_kana_keys
, &func_key_syms
,
3737 (sizeof (lispy_kana_keys
)
3738 / sizeof (lispy_kana_keys
[0])));
3739 #endif /* XK_kana_A */
3741 if (event
->code
< FUNCTION_KEY_OFFSET
3742 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
3743 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
3745 Qfunction_key
, Qnil
,
3746 iso_lispy_function_keys
, &func_key_syms
,
3747 (sizeof (iso_lispy_function_keys
)
3748 / sizeof (iso_lispy_function_keys
[0])));
3750 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3752 Qfunction_key
, Qnil
,
3753 lispy_function_keys
, &func_key_syms
,
3754 (sizeof (lispy_function_keys
)
3755 / sizeof (lispy_function_keys
[0])));
3758 /* A mouse click. Figure out where it is, decide whether it's
3759 a press, click or drag, and build the appropriate structure. */
3761 case scroll_bar_click
:
3763 int button
= event
->code
;
3765 Lisp_Object position
;
3766 Lisp_Object
*start_pos_ptr
;
3767 Lisp_Object start_pos
;
3769 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3772 /* Build the position as appropriate for this mouse click. */
3773 if (event
->kind
== mouse_click
)
3776 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3781 /* Ignore mouse events that were made on frame that
3782 have been deleted. */
3783 if (! FRAME_LIVE_P (f
))
3786 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3787 &column
, &row
, NULL
, 1);
3789 #ifndef USE_X_TOOLKIT
3790 /* In the non-toolkit version, clicks on the menu bar
3791 are ordinary button events in the event buffer.
3792 Distinguish them, and invoke the menu.
3794 (In the toolkit version, the toolkit handles the menu bar
3795 and Emacs doesn't know about it until after the user
3796 makes a selection.) */
3797 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3798 && (event
->modifiers
& down_modifier
))
3800 Lisp_Object items
, item
;
3805 /* Activate the menu bar on the down event. If the
3806 up event comes in before the menu code can deal with it,
3808 if (! (event
->modifiers
& down_modifier
))
3813 items
= FRAME_MENU_BAR_ITEMS (f
);
3814 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3816 Lisp_Object pos
, string
;
3817 string
= XVECTOR (items
)->contents
[i
+ 1];
3818 pos
= XVECTOR (items
)->contents
[i
+ 3];
3821 if (column
>= XINT (pos
)
3822 && column
< XINT (pos
) + XSTRING (string
)->size
)
3824 item
= XVECTOR (items
)->contents
[i
];
3830 = Fcons (event
->frame_or_window
,
3832 Fcons (Fcons (event
->x
, event
->y
),
3833 Fcons (make_number (event
->timestamp
),
3836 return Fcons (item
, Fcons (position
, Qnil
));
3838 #endif /* not USE_X_TOOLKIT */
3840 window
= window_from_coordinates (f
, column
, row
, &part
);
3842 if (!WINDOWP (window
))
3844 window
= event
->frame_or_window
;
3849 int pixcolumn
, pixrow
;
3850 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3851 row
-= XINT (XWINDOW (window
)->top
);
3852 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3853 XSETINT (event
->x
, pixcolumn
);
3854 XSETINT (event
->y
, pixrow
);
3859 posn
= Qvertical_line
;
3862 buffer_posn_from_coords (XWINDOW (window
),
3869 Fcons (Fcons (event
->x
, event
->y
),
3870 Fcons (make_number (event
->timestamp
),
3876 Lisp_Object portion_whole
;
3879 window
= event
->frame_or_window
;
3880 portion_whole
= Fcons (event
->x
, event
->y
);
3881 part
= *scroll_bar_parts
[(int) event
->part
];
3885 Fcons (Qvertical_scroll_bar
,
3886 Fcons (portion_whole
,
3887 Fcons (make_number (event
->timestamp
),
3888 Fcons (part
, Qnil
)))));
3891 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3893 start_pos
= *start_pos_ptr
;
3894 *start_pos_ptr
= Qnil
;
3896 is_double
= (button
== last_mouse_button
3897 && XINT (event
->x
) == last_mouse_x
3898 && XINT (event
->y
) == last_mouse_y
3899 && button_down_time
!= 0
3900 && (EQ (Vdouble_click_time
, Qt
)
3901 || (INTEGERP (Vdouble_click_time
)
3902 && ((int)(event
->timestamp
- button_down_time
)
3903 < XINT (Vdouble_click_time
)))));
3904 last_mouse_button
= button
;
3905 last_mouse_x
= XINT (event
->x
);
3906 last_mouse_y
= XINT (event
->y
);
3908 /* If this is a button press, squirrel away the location, so
3909 we can decide later whether it was a click or a drag. */
3910 if (event
->modifiers
& down_modifier
)
3914 double_click_count
++;
3915 event
->modifiers
|= ((double_click_count
> 2)
3920 double_click_count
= 1;
3921 button_down_time
= event
->timestamp
;
3922 *start_pos_ptr
= Fcopy_alist (position
);
3925 /* Now we're releasing a button - check the co-ordinates to
3926 see if this was a click or a drag. */
3927 else if (event
->modifiers
& up_modifier
)
3929 /* If we did not see a down before this up,
3930 ignore the up. Probably this happened because
3931 the down event chose a menu item.
3932 It would be an annoyance to treat the release
3933 of the button that chose the menu item
3934 as a separate event. */
3936 if (!CONSP (start_pos
))
3939 event
->modifiers
&= ~up_modifier
;
3940 #if 0 /* Formerly we treated an up with no down as a click event. */
3941 if (!CONSP (start_pos
))
3942 event
->modifiers
|= click_modifier
;
3946 /* The third element of every position should be the (x,y)
3950 down
= Fnth (make_number (2), start_pos
);
3951 if (EQ (event
->x
, XCONS (down
)->car
)
3952 && EQ (event
->y
, XCONS (down
)->cdr
))
3954 event
->modifiers
|= click_modifier
;
3958 button_down_time
= 0;
3959 event
->modifiers
|= drag_modifier
;
3961 /* Don't check is_double; treat this as multiple
3962 if the down-event was multiple. */
3963 if (double_click_count
> 1)
3964 event
->modifiers
|= ((double_click_count
> 2)
3970 /* Every mouse event should either have the down_modifier or
3971 the up_modifier set. */
3975 /* Get the symbol we should use for the mouse click. */
3978 head
= modify_event_symbol (button
,
3981 lispy_mouse_names
, &mouse_syms
,
3982 (sizeof (lispy_mouse_names
)
3983 / sizeof (lispy_mouse_names
[0])));
3984 if (event
->modifiers
& drag_modifier
)
3989 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
3992 Fcons (make_number (double_click_count
),
4002 case w32_scroll_bar_click
:
4004 int button
= event
->code
;
4006 Lisp_Object position
;
4007 Lisp_Object
*start_pos_ptr
;
4008 Lisp_Object start_pos
;
4010 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4015 Lisp_Object portion_whole
;
4018 window
= event
->frame_or_window
;
4019 portion_whole
= Fcons (event
->x
, event
->y
);
4020 part
= *scroll_bar_parts
[(int) event
->part
];
4024 Fcons (Qvertical_scroll_bar
,
4025 Fcons (portion_whole
,
4026 Fcons (make_number (event
->timestamp
),
4027 Fcons (part
, Qnil
)))));
4030 /* Always treat W32 scroll bar events as clicks. */
4031 event
->modifiers
|= click_modifier
;
4034 /* Get the symbol we should use for the mouse click. */
4037 head
= modify_event_symbol (button
,
4040 lispy_mouse_names
, &mouse_syms
,
4041 (sizeof (lispy_mouse_names
)
4042 / sizeof (lispy_mouse_names
[0])));
4050 #endif /* HAVE_MOUSE */
4052 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4053 case menu_bar_event
:
4054 /* The event value is in the cdr of the frame_or_window slot. */
4055 if (!CONSP (event
->frame_or_window
))
4057 return XCONS (event
->frame_or_window
)->cdr
;
4060 /* The 'kind' field of the event is something we don't recognize. */
4069 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4071 Lisp_Object bar_window
;
4072 enum scroll_bar_part part
;
4076 /* Is it a scroll bar movement? */
4077 if (frame
&& ! NILP (bar_window
))
4079 Lisp_Object part_sym
;
4081 part_sym
= *scroll_bar_parts
[(int) part
];
4082 return Fcons (Qscroll_bar_movement
,
4083 (Fcons (Fcons (bar_window
,
4084 Fcons (Qvertical_scroll_bar
,
4085 Fcons (Fcons (x
, y
),
4086 Fcons (make_number (time
),
4092 /* Or is it an ordinary mouse movement? */
4102 /* It's in a frame; which window on that frame? */
4103 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4105 window
= window_from_coordinates (frame
, column
, row
, &area
);
4110 if (WINDOWP (window
))
4112 int pixcolumn
, pixrow
;
4113 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4114 row
-= XINT (XWINDOW (window
)->top
);
4115 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4116 XSETINT (x
, pixcolumn
);
4117 XSETINT (y
, pixrow
);
4122 posn
= Qvertical_line
;
4125 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4127 else if (frame
!= 0)
4129 XSETFRAME (window
, frame
);
4140 return Fcons (Qmouse_movement
,
4141 Fcons (Fcons (window
,
4143 Fcons (Fcons (x
, y
),
4144 Fcons (make_number (time
),
4150 #endif /* HAVE_MOUSE */
4152 /* Construct a switch frame event. */
4154 make_lispy_switch_frame (frame
)
4157 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4160 /* Manipulating modifiers. */
4162 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4164 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4165 SYMBOL's name of the end of the modifiers; the string from this
4166 position is the unmodified symbol name.
4168 This doesn't use any caches. */
4171 parse_modifiers_uncached (symbol
, modifier_end
)
4175 struct Lisp_String
*name
;
4179 CHECK_SYMBOL (symbol
, 1);
4182 name
= XSYMBOL (symbol
)->name
;
4184 for (i
= 0; i
+2 <= name
->size
; )
4186 int this_mod_end
= 0;
4189 /* See if the name continues with a modifier word.
4190 Check that the word appears, but don't check what follows it.
4191 Set this_mod and this_mod_end to record what we find. */
4193 switch (name
->data
[i
])
4195 #define SINGLE_LETTER_MOD(BIT) \
4196 (this_mod_end = i + 1, this_mod = BIT)
4199 SINGLE_LETTER_MOD (alt_modifier
);
4203 SINGLE_LETTER_MOD (ctrl_modifier
);
4207 SINGLE_LETTER_MOD (hyper_modifier
);
4211 SINGLE_LETTER_MOD (meta_modifier
);
4215 SINGLE_LETTER_MOD (shift_modifier
);
4219 SINGLE_LETTER_MOD (super_modifier
);
4222 #undef SINGLE_LETTER_MOD
4225 /* If we found no modifier, stop looking for them. */
4226 if (this_mod_end
== 0)
4229 /* Check there is a dash after the modifier, so that it
4230 really is a modifier. */
4231 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
4234 /* This modifier is real; look for another. */
4235 modifiers
|= this_mod
;
4236 i
= this_mod_end
+ 1;
4239 /* Should we include the `click' modifier? */
4240 if (! (modifiers
& (down_modifier
| drag_modifier
4241 | double_modifier
| triple_modifier
))
4242 && i
+ 7 == name
->size
4243 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4244 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4245 modifiers
|= click_modifier
;
4253 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4254 prepended to the string BASE[0..BASE_LEN-1].
4255 This doesn't use any caches. */
4257 apply_modifiers_uncached (modifiers
, base
, base_len
)
4262 /* Since BASE could contain nulls, we can't use intern here; we have
4263 to use Fintern, which expects a genuine Lisp_String, and keeps a
4266 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4272 /* Only the event queue may use the `up' modifier; it should always
4273 be turned into a click or drag event before presented to lisp code. */
4274 if (modifiers
& up_modifier
)
4277 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4278 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4279 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4280 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4281 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4282 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4283 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4284 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4285 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4286 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4287 /* The click modifier is denoted by the absence of other modifiers. */
4291 mod_len
= p
- new_mods
;
4295 Lisp_Object new_name
;
4297 new_name
= make_uninit_string (mod_len
+ base_len
);
4298 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4299 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
4301 return Fintern (new_name
, Qnil
);
4306 static char *modifier_names
[] =
4308 "up", "down", "drag", "click", "double", "triple", 0, 0,
4309 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4310 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4312 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4314 static Lisp_Object modifier_symbols
;
4316 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4318 lispy_modifier_list (modifiers
)
4321 Lisp_Object modifier_list
;
4324 modifier_list
= Qnil
;
4325 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4326 if (modifiers
& (1<<i
))
4327 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4330 return modifier_list
;
4334 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4335 where UNMODIFIED is the unmodified form of SYMBOL,
4336 MASK is the set of modifiers present in SYMBOL's name.
4337 This is similar to parse_modifiers_uncached, but uses the cache in
4338 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4339 Qevent_symbol_elements property. */
4342 parse_modifiers (symbol
)
4345 Lisp_Object elements
;
4347 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4348 if (CONSP (elements
))
4353 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4354 Lisp_Object unmodified
;
4357 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4358 XSYMBOL (symbol
)->name
->size
- end
),
4361 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4363 XSETFASTINT (mask
, modifiers
);
4364 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4366 /* Cache the parsing results on SYMBOL. */
4367 Fput (symbol
, Qevent_symbol_element_mask
,
4369 Fput (symbol
, Qevent_symbol_elements
,
4370 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4372 /* Since we know that SYMBOL is modifiers applied to unmodified,
4373 it would be nice to put that in unmodified's cache.
4374 But we can't, since we're not sure that parse_modifiers is
4381 /* Apply the modifiers MODIFIERS to the symbol BASE.
4382 BASE must be unmodified.
4384 This is like apply_modifiers_uncached, but uses BASE's
4385 Qmodifier_cache property, if present. It also builds
4386 Qevent_symbol_elements properties, since it has that info anyway.
4388 apply_modifiers copies the value of BASE's Qevent_kind property to
4389 the modified symbol. */
4391 apply_modifiers (modifiers
, base
)
4395 Lisp_Object cache
, index
, entry
, new_symbol
;
4397 /* Mask out upper bits. We don't know where this value's been. */
4398 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4400 /* The click modifier never figures into cache indices. */
4401 cache
= Fget (base
, Qmodifier_cache
);
4402 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4403 entry
= assq_no_quit (index
, cache
);
4406 new_symbol
= XCONS (entry
)->cdr
;
4409 /* We have to create the symbol ourselves. */
4410 new_symbol
= apply_modifiers_uncached (modifiers
,
4411 XSYMBOL (base
)->name
->data
,
4412 XSYMBOL (base
)->name
->size
);
4414 /* Add the new symbol to the base's cache. */
4415 entry
= Fcons (index
, new_symbol
);
4416 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4418 /* We have the parsing info now for free, so add it to the caches. */
4419 XSETFASTINT (index
, modifiers
);
4420 Fput (new_symbol
, Qevent_symbol_element_mask
,
4421 Fcons (base
, Fcons (index
, Qnil
)));
4422 Fput (new_symbol
, Qevent_symbol_elements
,
4423 Fcons (base
, lispy_modifier_list (modifiers
)));
4426 /* Make sure this symbol is of the same kind as BASE.
4428 You'd think we could just set this once and for all when we
4429 intern the symbol above, but reorder_modifiers may call us when
4430 BASE's property isn't set right; we can't assume that just
4431 because it has a Qmodifier_cache property it must have its
4432 Qevent_kind set right as well. */
4433 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4437 kind
= Fget (base
, Qevent_kind
);
4439 Fput (new_symbol
, Qevent_kind
, kind
);
4446 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4447 return a symbol with the modifiers placed in the canonical order.
4448 Canonical order is alphabetical, except for down and drag, which
4449 always come last. The 'click' modifier is never written out.
4451 Fdefine_key calls this to make sure that (for example) C-M-foo
4452 and M-C-foo end up being equivalent in the keymap. */
4455 reorder_modifiers (symbol
)
4458 /* It's hopefully okay to write the code this way, since everything
4459 will soon be in caches, and no consing will be done at all. */
4462 parsed
= parse_modifiers (symbol
);
4463 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4464 XCONS (parsed
)->car
);
4468 /* For handling events, we often want to produce a symbol whose name
4469 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4470 to some base, like the name of a function key or mouse button.
4471 modify_event_symbol produces symbols of this sort.
4473 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4474 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4477 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4478 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4480 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4481 persist between calls to modify_event_symbol that it can use to
4482 store a cache of the symbols it's generated for this NAME_TABLE
4483 before. The object stored there may be a vector or an alist.
4485 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4487 MODIFIERS is a set of modifier bits (as given in struct input_events)
4488 whose prefixes should be applied to the symbol name.
4490 SYMBOL_KIND is the value to be placed in the event_kind property of
4491 the returned symbol.
4493 The symbols we create are supposed to have an
4494 `event-symbol-elements' property, which lists the modifiers present
4495 in the symbol's name. */
4498 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4499 name_table
, symbol_table
, table_size
)
4502 Lisp_Object symbol_kind
;
4503 Lisp_Object name_alist
;
4505 Lisp_Object
*symbol_table
;
4506 unsigned int table_size
;
4509 Lisp_Object symbol_int
;
4511 /* Get rid of the "vendor-specific" bit here. */
4512 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4514 /* Is this a request for a valid symbol? */
4515 if (symbol_num
< 0 || symbol_num
>= table_size
)
4518 if (CONSP (*symbol_table
))
4519 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4521 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4522 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4523 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4524 we've never used that symbol before. */
4527 if (! VECTORP (*symbol_table
)
4528 || XVECTOR (*symbol_table
)->size
!= table_size
)
4532 XSETFASTINT (size
, table_size
);
4533 *symbol_table
= Fmake_vector (size
, Qnil
);
4536 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4539 /* Have we already used this symbol before? */
4542 /* No; let's create it. */
4543 if (!NILP (name_alist
))
4544 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4545 else if (name_table
!= 0 && name_table
[symbol_num
])
4546 value
= intern (name_table
[symbol_num
]);
4548 #ifdef HAVE_WINDOW_SYSTEM
4551 char *name
= x_get_keysym_name (symbol_num
);
4553 value
= intern (name
);
4560 sprintf (buf
, "key-%d", symbol_num
);
4561 value
= intern (buf
);
4564 if (CONSP (*symbol_table
))
4565 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4567 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4569 /* Fill in the cache entries for this symbol; this also
4570 builds the Qevent_symbol_elements property, which the user
4572 apply_modifiers (modifiers
& click_modifier
, value
);
4573 Fput (value
, Qevent_kind
, symbol_kind
);
4576 /* Apply modifiers to that symbol. */
4577 return apply_modifiers (modifiers
, value
);
4580 /* Convert a list that represents an event type,
4581 such as (ctrl meta backspace), into the usual representation of that
4582 event type as a number or a symbol. */
4584 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4585 "Convert the event description list EVENT-DESC to an event type.\n\
4586 EVENT-DESC should contain one base event type (a character or symbol)\n\
4587 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4588 drag, down, double or triple). The base must be last.\n\
4589 The return value is an event type (a character or symbol) which\n\
4590 has the same base event type and all the specified modifiers.")
4592 Lisp_Object event_desc
;
4600 while (CONSP (rest
))
4605 elt
= XCONS (rest
)->car
;
4606 rest
= XCONS (rest
)->cdr
;
4608 /* Given a symbol, see if it is a modifier name. */
4609 if (SYMBOLP (elt
) && CONSP (rest
))
4610 this = parse_solitary_modifier (elt
);
4614 else if (!NILP (base
))
4615 error ("Two bases given in one event");
4621 /* Let the symbol A refer to the character A. */
4622 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4623 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4625 if (INTEGERP (base
))
4627 /* Turn (shift a) into A. */
4628 if ((modifiers
& shift_modifier
) != 0
4629 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4631 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4632 modifiers
&= ~shift_modifier
;
4635 /* Turn (control a) into C-a. */
4636 if (modifiers
& ctrl_modifier
)
4637 return make_number ((modifiers
& ~ctrl_modifier
)
4638 | make_ctrl_char (XINT (base
)));
4640 return make_number (modifiers
| XINT (base
));
4642 else if (SYMBOLP (base
))
4643 return apply_modifiers (modifiers
, base
);
4645 error ("Invalid base event");
4648 /* Try to recognize SYMBOL as a modifier name.
4649 Return the modifier flag bit, or 0 if not recognized. */
4652 parse_solitary_modifier (symbol
)
4655 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4657 switch (name
->data
[0])
4659 #define SINGLE_LETTER_MOD(BIT) \
4660 if (name->size == 1) \
4663 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4664 if (LEN == name->size \
4665 && ! strncmp (name->data, NAME, LEN)) \
4669 SINGLE_LETTER_MOD (alt_modifier
);
4673 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4677 SINGLE_LETTER_MOD (ctrl_modifier
);
4681 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4682 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4686 SINGLE_LETTER_MOD (hyper_modifier
);
4690 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4694 SINGLE_LETTER_MOD (meta_modifier
);
4698 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4702 SINGLE_LETTER_MOD (shift_modifier
);
4706 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4707 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4708 SINGLE_LETTER_MOD (super_modifier
);
4712 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4713 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4714 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4718 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4721 #undef SINGLE_LETTER_MOD
4722 #undef MULTI_LETTER_MOD
4728 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4729 Such a list is not valid as an event,
4730 but it can be a Lucid-style event type list. */
4733 lucid_event_type_list_p (object
)
4738 if (! CONSP (object
))
4741 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4744 elt
= XCONS (tail
)->car
;
4745 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4752 /* Store into *addr a value nonzero if terminal input chars are available.
4753 Serves the purpose of ioctl (0, FIONREAD, addr)
4754 but works even if FIONREAD does not exist.
4755 (In fact, this may actually read some input.)
4757 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4760 get_input_pending (addr
, do_timers_now
)
4764 /* First of all, have we already counted some input? */
4765 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4767 /* If input is being read as it arrives, and we have none, there is none. */
4768 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4771 /* Try to read some input and see how much we get. */
4773 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4776 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4779 gobble_input (expected
)
4784 if (interrupt_input
)
4787 mask
= sigblock (sigmask (SIGIO
));
4788 read_avail_input (expected
);
4792 #ifdef POLL_FOR_INPUT
4793 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4796 mask
= sigblock (sigmask (SIGALRM
));
4797 read_avail_input (expected
);
4803 read_avail_input (expected
);
4807 /* Put a buffer_switch_event in the buffer
4808 so that read_key_sequence will notice the new current buffer. */
4810 record_asynch_buffer_change ()
4812 struct input_event event
;
4815 event
.kind
= buffer_switch_event
;
4816 event
.frame_or_window
= Qnil
;
4819 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4820 The purpose of the event is to make read_key_sequence look up the
4821 keymaps again. If we aren't in read_key_sequence, we don't need one,
4822 and the event could cause trouble by messing up (input-pending-p). */
4823 tem
= Fwaiting_for_user_input_p ();
4827 /* We never need these events if we have no asynchronous subprocesses. */
4831 /* Make sure no interrupt happens while storing the event. */
4833 if (interrupt_input
)
4836 mask
= sigblock (sigmask (SIGIO
));
4837 kbd_buffer_store_event (&event
);
4844 kbd_buffer_store_event (&event
);
4851 /* Read any terminal input already buffered up by the system
4852 into the kbd_buffer, but do not wait.
4854 EXPECTED should be nonzero if the caller knows there is some input.
4856 Except on VMS, all input is read by this function.
4857 If interrupt_input is nonzero, this function MUST be called
4858 only when SIGIO is blocked.
4860 Returns the number of keyboard chars read, or -1 meaning
4861 this is a bad time to try to read input. */
4864 read_avail_input (expected
)
4867 struct input_event buf
[KBD_BUFFER_SIZE
];
4871 if (read_socket_hook
)
4872 /* No need for FIONREAD or fcntl; just say don't wait. */
4873 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
4876 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
4877 the kbd_buffer can really hold. That may prevent loss
4878 of characters on some systems when input is stuffed at us. */
4879 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
4882 /* Determine how many characters we should *try* to read. */
4885 #else /* not WINDOWSNT */
4887 n_to_read
= dos_keysns ();
4890 #else /* not MSDOS */
4892 /* Find out how much input is available. */
4893 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
4894 /* Formerly simply reported no input, but that sometimes led to
4895 a failure of Emacs to terminate.
4896 SIGHUP seems appropriate if we can't reach the terminal. */
4897 /* ??? Is it really right to send the signal just to this process
4898 rather than to the whole process group?
4899 Perhaps on systems with FIONREAD Emacs is alone in its group. */
4900 kill (getpid (), SIGHUP
);
4903 if (n_to_read
> sizeof cbuf
)
4904 n_to_read
= sizeof cbuf
;
4905 #else /* no FIONREAD */
4906 #if defined (USG) || defined (DGUX)
4907 /* Read some input if available, but don't wait. */
4908 n_to_read
= sizeof cbuf
;
4909 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
4914 #endif /* not MSDOS */
4915 #endif /* not WINDOWSNT */
4917 /* Now read; for one reason or another, this will not block.
4918 NREAD is set to the number of chars read. */
4922 cbuf
[0] = dos_keyread ();
4925 nread
= read (input_fd
, cbuf
, n_to_read
);
4927 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
4928 /* The kernel sometimes fails to deliver SIGHUP for ptys.
4929 This looks incorrect, but it isn't, because _BSD causes
4930 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
4931 and that causes a value other than 0 when there is no input. */
4937 /* We used to retry the read if it was interrupted.
4938 But this does the wrong thing when O_NDELAY causes
4939 an EAGAIN error. Does anybody know of a situation
4940 where a retry is actually needed? */
4942 nread
< 0 && (errno
== EAGAIN
4956 #if defined (USG) || defined (DGUX)
4957 fcntl (input_fd
, F_SETFL
, 0);
4958 #endif /* USG or DGUX */
4959 #endif /* no FIONREAD */
4960 for (i
= 0; i
< nread
; i
++)
4962 buf
[i
].kind
= ascii_keystroke
;
4963 buf
[i
].modifiers
= 0;
4964 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
4965 buf
[i
].modifiers
= meta_modifier
;
4969 buf
[i
].code
= cbuf
[i
];
4970 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
4974 /* Scan the chars for C-g and store them in kbd_buffer. */
4975 for (i
= 0; i
< nread
; i
++)
4977 kbd_buffer_store_event (&buf
[i
]);
4978 /* Don't look at input that follows a C-g too closely.
4979 This reduces lossage due to autorepeat on C-g. */
4980 if (buf
[i
].kind
== ascii_keystroke
4981 && buf
[i
].code
== quit_char
)
4987 #endif /* not VMS */
4989 #ifdef SIGIO /* for entire page */
4990 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4993 input_available_signal (signo
)
4996 /* Must preserve main program's value of errno. */
4997 int old_errno
= errno
;
4999 extern int select_alarmed
;
5002 #if defined (USG) && !defined (POSIX_SIGNALS)
5003 /* USG systems forget handlers when they are used;
5004 must reestablish each time */
5005 signal (signo
, input_available_signal
);
5012 if (input_available_clear_time
)
5013 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5018 nread
= read_avail_input (1);
5019 /* -1 means it's not ok to read the input now.
5020 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5021 0 means there was no keyboard input available. */
5026 select_alarmed
= 1; /* Force the select emulator back to life */
5037 /* Send ourselves a SIGIO.
5039 This function exists so that the UNBLOCK_INPUT macro in
5040 blockinput.h can have some way to take care of input we put off
5041 dealing with, without assuming that every file which uses
5042 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5044 reinvoke_input_signal ()
5047 kill (getpid (), SIGIO
);
5053 /* Return the prompt-string of a sparse keymap.
5054 This is the first element which is a string.
5055 Return nil if there is none. */
5063 register Lisp_Object tem
;
5072 static void menu_bar_item ();
5073 static void menu_bar_one_keymap ();
5075 /* These variables hold the vector under construction within
5076 menu_bar_items and its subroutines, and the current index
5077 for storing into that vector. */
5078 static Lisp_Object menu_bar_items_vector
;
5079 static int menu_bar_items_index
;
5081 /* Return a vector of menu items for a menu bar, appropriate
5082 to the current buffer. Each item has three elements in the vector:
5085 OLD is an old vector we can optionally reuse, or nil. */
5088 menu_bar_items (old
)
5091 /* The number of keymaps we're scanning right now, and the number of
5092 keymaps we have allocated space for. */
5095 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5096 in the current keymaps, or nil where it is not a prefix. */
5099 Lisp_Object def
, tem
, tail
;
5108 struct gcpro gcpro1
;
5110 /* In order to build the menus, we need to call the keymap
5111 accessors. They all call QUIT. But this function is called
5112 during redisplay, during which a quit is fatal. So inhibit
5113 quitting while building the menus.
5114 We do this instead of specbind because (1) errors will clear it anyway
5115 and (2) this avoids risk of specpdl overflow. */
5116 oquit
= Vinhibit_quit
;
5120 menu_bar_items_vector
= old
;
5122 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5123 menu_bar_items_index
= 0;
5125 GCPRO1 (menu_bar_items_vector
);
5127 /* Build our list of keymaps.
5128 If we recognize a function key and replace its escape sequence in
5129 keybuf with its symbol, or if the sequence starts with a mouse
5130 click and we need to switch buffers, we jump back here to rebuild
5131 the initial keymaps from the current buffer. */
5135 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5136 if (!NILP (Voverriding_local_map_menu_flag
))
5138 /* Yes, use them (if non-nil) as well as the global map. */
5139 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5141 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5142 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5143 if (!NILP (Voverriding_local_map
))
5144 maps
[nmaps
++] = Voverriding_local_map
;
5148 /* No, so use major and minor mode keymaps. */
5149 nmaps
= current_minor_maps (NULL
, &tmaps
);
5150 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5151 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5152 #ifdef USE_TEXT_PROPERTIES
5153 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5155 maps
[nmaps
++] = current_buffer
->keymap
;
5158 maps
[nmaps
++] = current_global_map
;
5161 /* Look up in each map the dummy prefix key `menu-bar'. */
5165 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5167 if (! NILP (maps
[mapno
]))
5168 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
5172 tem
= Fkeymapp (def
);
5174 menu_bar_one_keymap (def
);
5177 /* Move to the end those items that should be at the end. */
5179 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5182 int end
= menu_bar_items_index
;
5184 for (i
= 0; i
< end
; i
+= 4)
5185 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5187 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5188 /* Move the item at index I to the end,
5189 shifting all the others forward. */
5190 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5191 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5192 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5193 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5195 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5196 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5197 (end
- i
- 4) * sizeof (Lisp_Object
));
5198 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5199 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5200 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5201 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5206 /* Add nil, nil, nil, nil at the end. */
5207 i
= menu_bar_items_index
;
5208 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5211 int newsize
= 2 * i
;
5212 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5213 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5214 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5215 menu_bar_items_vector
= tem
;
5217 /* Add this item. */
5218 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5219 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5220 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5221 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5222 menu_bar_items_index
= i
;
5224 Vinhibit_quit
= oquit
;
5226 return menu_bar_items_vector
;
5229 /* Scan one map KEYMAP, accumulating any menu items it defines
5230 in menu_bar_items_vector. */
5233 menu_bar_one_keymap (keymap
)
5236 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
5238 /* Loop over all keymap entries that have menu strings. */
5239 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5241 item
= XCONS (tail
)->car
;
5244 key
= XCONS (item
)->car
;
5245 binding
= XCONS (item
)->cdr
;
5246 if (CONSP (binding
))
5248 item_string
= XCONS (binding
)->car
;
5249 if (STRINGP (item_string
))
5250 menu_bar_item (key
, item_string
, Fcdr (binding
));
5252 else if (EQ (binding
, Qundefined
))
5253 menu_bar_item (key
, Qnil
, binding
);
5255 else if (VECTORP (item
))
5257 /* Loop over the char values represented in the vector. */
5258 int len
= XVECTOR (item
)->size
;
5260 for (c
= 0; c
< len
; c
++)
5262 Lisp_Object character
;
5263 XSETFASTINT (character
, c
);
5264 binding
= XVECTOR (item
)->contents
[c
];
5265 if (CONSP (binding
))
5267 item_string
= XCONS (binding
)->car
;
5268 if (STRINGP (item_string
))
5269 menu_bar_item (key
, item_string
, Fcdr (binding
));
5271 else if (EQ (binding
, Qundefined
))
5272 menu_bar_item (key
, Qnil
, binding
);
5278 /* This is used as the handler when calling internal_condition_case_1. */
5281 menu_bar_item_1 (arg
)
5287 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5288 If there's already an item for KEY, add this DEF to it. */
5291 menu_bar_item (key
, item_string
, def
)
5292 Lisp_Object key
, item_string
, def
;
5295 Lisp_Object enabled
;
5298 /* Skip menu-bar equiv keys data. */
5299 if (CONSP (def
) && CONSP (XCONS (def
)->car
))
5300 def
= XCONS (def
)->cdr
;
5302 if (EQ (def
, Qundefined
))
5304 /* If a map has an explicit `undefined' as definition,
5305 discard any previously made menu bar item. */
5307 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5308 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5310 if (menu_bar_items_index
> i
+ 4)
5311 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5312 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5313 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5314 menu_bar_items_index
-= 4;
5318 /* If there's no definition for this key yet,
5319 just ignore `undefined'. */
5323 /* See if this entry is enabled. */
5328 /* No property, or nil, means enable.
5329 Otherwise, enable if value is not nil. */
5330 tem
= Fget (def
, Qmenu_enable
);
5332 /* (condition-case nil (eval tem)
5334 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5338 /* Ignore this item if it's not enabled. */
5342 /* Find any existing item for this KEY. */
5343 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5344 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5347 /* If we did not find this KEY, add it at the end. */
5348 if (i
== menu_bar_items_index
)
5350 /* If vector is too small, get a bigger one. */
5351 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5354 int newsize
= 2 * i
;
5355 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5356 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5357 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5358 menu_bar_items_vector
= tem
;
5360 /* Add this item. */
5361 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5362 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5363 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5364 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5365 menu_bar_items_index
= i
;
5367 /* We did find an item for this KEY. Add DEF to its list of maps. */
5371 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5372 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5376 /* Read a character using menus based on maps in the array MAPS.
5377 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5378 Return t if we displayed a menu but the user rejected it.
5380 PREV_EVENT is the previous input event, or nil if we are reading
5381 the first event of a key sequence.
5383 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5384 if we used a mouse menu to read the input, or zero otherwise. If
5385 USED_MOUSE_MENU is null, we don't dereference it.
5387 The prompting is done based on the prompt-string of the map
5388 and the strings associated with various map elements.
5390 This can be done with X menus or with menus put in the minibuf.
5391 These are done in different ways, depending on how the input will be read.
5392 Menus using X are done after auto-saving in read-char, getting the input
5393 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5394 and do auto-saving in the inner call of read_char. */
5397 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5400 Lisp_Object prev_event
;
5401 int *used_mouse_menu
;
5404 register Lisp_Object name
;
5405 Lisp_Object rest
, vector
;
5407 if (used_mouse_menu
)
5408 *used_mouse_menu
= 0;
5410 /* Use local over global Menu maps */
5412 if (! menu_prompting
)
5415 /* Optionally disregard all but the global map. */
5416 if (inhibit_local_menu_bar_menus
)
5418 maps
+= (nmaps
- 1);
5422 /* Get the menu name from the first map that has one (a prompt string). */
5423 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5425 name
= map_prompt (maps
[mapno
]);
5430 /* If we don't have any menus, just read a character normally. */
5435 /* If we got to this point via a mouse click,
5436 use a real menu for mouse selection. */
5437 if (EVENT_HAS_PARAMETERS (prev_event
)
5438 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5440 /* Display the menu and get the selection. */
5441 Lisp_Object
*realmaps
5442 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5446 /* Use the maps that are not nil. */
5447 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5448 if (!NILP (maps
[mapno
]))
5449 realmaps
[nmaps1
++] = maps
[mapno
];
5451 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5456 record_menu_key (XCONS (value
)->car
);
5458 /* If we got multiple events, unread all but
5460 There is no way to prevent those unread events
5461 from showing up later in last_nonmenu_event.
5462 So turn symbol and integer events into lists,
5463 to indicate that they came from a mouse menu,
5464 so that when present in last_nonmenu_event
5465 they won't confuse things. */
5466 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5467 tem
= XCONS (tem
)->cdr
)
5469 record_menu_key (XCONS (tem
)->car
);
5470 if (SYMBOLP (XCONS (tem
)->car
)
5471 || INTEGERP (XCONS (tem
)->car
))
5473 = Fcons (XCONS (tem
)->car
, Qnil
);
5476 /* If we got more than one event, put all but the first
5477 onto this list to be read later.
5478 Return just the first event now. */
5479 Vunread_command_events
5480 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5481 value
= XCONS (value
)->car
;
5483 else if (NILP (value
))
5485 if (used_mouse_menu
)
5486 *used_mouse_menu
= 1;
5489 #endif /* HAVE_MENUS */
5493 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5494 We make this bigger when necessary, and never free it. */
5495 static char *read_char_minibuf_menu_text
;
5496 /* Size of that buffer. */
5497 static int read_char_minibuf_menu_width
;
5500 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5506 register Lisp_Object name
;
5508 int width
= FRAME_WIDTH (selected_frame
) - 4;
5511 Lisp_Object rest
, vector
;
5514 if (! menu_prompting
)
5517 /* Make sure we have a big enough buffer for the menu text. */
5518 if (read_char_minibuf_menu_text
== 0)
5520 read_char_minibuf_menu_width
= width
+ 4;
5521 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5523 else if (width
+ 4 > read_char_minibuf_menu_width
)
5525 read_char_minibuf_menu_width
= width
+ 4;
5526 read_char_minibuf_menu_text
5527 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5529 menu
= read_char_minibuf_menu_text
;
5531 /* Get the menu name from the first map that has one (a prompt string). */
5532 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5534 name
= map_prompt (maps
[mapno
]);
5539 /* If we don't have any menus, just read a character normally. */
5543 /* Prompt string always starts with map's prompt, and a space. */
5544 strcpy (menu
, XSTRING (name
)->data
);
5545 nlength
= XSTRING (name
)->size
;
5546 menu
[nlength
++] = ':';
5547 menu
[nlength
++] = ' ';
5550 /* Start prompting at start of first map. */
5554 /* Present the documented bindings, a line at a time. */
5561 Lisp_Object orig_defn_macro
;
5563 /* Loop over elements of map. */
5568 /* If reached end of map, start at beginning of next map. */
5572 /* At end of last map, wrap around to first map if just starting,
5573 or end this line if already have something on it. */
5577 if (notfirst
|| nobindings
) break;
5582 /* Look at the next element of the map. */
5584 elt
= XVECTOR (vector
)->contents
[idx
];
5586 elt
= Fcar_safe (rest
);
5588 if (idx
< 0 && VECTORP (elt
))
5590 /* If we found a dense table in the keymap,
5591 advanced past it, but start scanning its contents. */
5592 rest
= Fcdr_safe (rest
);
5598 /* An ordinary element. */
5603 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5604 event
= Fcar_safe (elt
);
5608 s
= Fcar_safe (elt
); /* vector */
5609 XSETINT (event
, idx
);
5612 /* Ignore the element if it has no prompt string. */
5613 if (STRINGP (s
) && INTEGERP (event
))
5615 /* 1 if the char to type matches the string. */
5617 Lisp_Object upcased_event
, downcased_event
;
5620 upcased_event
= Fupcase (event
);
5621 downcased_event
= Fdowncase (event
);
5622 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5623 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5625 desc
= Fsingle_key_description (event
);
5627 /* If we have room for the prompt string, add it to this line.
5628 If this is the first on the line, always add it. */
5629 if ((XSTRING (s
)->size
+ i
+ 2
5630 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5636 /* Punctuate between strings. */
5639 strcpy (menu
+ i
, ", ");
5645 /* If the char to type doesn't match the string's
5646 first char, explicitly show what char to type. */
5649 /* Add as much of string as fits. */
5650 thiswidth
= XSTRING (desc
)->size
;
5651 if (thiswidth
+ i
> width
)
5652 thiswidth
= width
- i
;
5653 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5655 strcpy (menu
+ i
, " = ");
5659 /* Add as much of string as fits. */
5660 thiswidth
= XSTRING (s
)->size
;
5661 if (thiswidth
+ i
> width
)
5662 thiswidth
= width
- i
;
5663 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5669 /* If this element does not fit, end the line now,
5670 and save the element for the next line. */
5671 strcpy (menu
+ i
, "...");
5676 /* Move past this element. */
5677 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5678 /* Handle reaching end of dense table. */
5683 rest
= Fcdr_safe (rest
);
5687 /* Prompt with that and read response. */
5690 /* Make believe its not a keyboard macro in case the help char
5691 is pressed. Help characters are not recorded because menu prompting
5692 is not used on replay.
5694 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5695 current_kboard
->defining_kbd_macro
= Qnil
;
5697 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5698 while (BUFFERP (obj
));
5699 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5701 if (!INTEGERP (obj
))
5706 if (! EQ (obj
, menu_prompt_more_char
)
5707 && (!INTEGERP (menu_prompt_more_char
)
5708 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5710 if (!NILP (current_kboard
->defining_kbd_macro
))
5711 store_kbd_macro_char (obj
);
5714 /* Help char - go round again */
5718 /* Reading key sequences. */
5720 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5721 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5722 keymap, or nil otherwise. Return the index of the first keymap in
5723 which KEY has any binding, or NMAPS if no map has a binding.
5725 If KEY is a meta ASCII character, treat it like meta-prefix-char
5726 followed by the corresponding non-meta character. Keymaps in
5727 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5730 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5733 NEXT may be the same array as CURRENT. */
5736 follow_key (key
, nmaps
, current
, defs
, next
)
5738 Lisp_Object
*current
, *defs
, *next
;
5741 int i
, first_binding
;
5744 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5745 followed by the corresponding non-meta character.
5746 Put the results into DEFS, since we are going to alter that anyway.
5747 Do not alter CURRENT or NEXT. */
5748 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5750 for (i
= 0; i
< nmaps
; i
++)
5751 if (! NILP (current
[i
]))
5754 def
= get_keyelt (access_keymap (current
[i
],
5755 meta_prefix_char
, 1, 0));
5757 /* Note that since we pass the resulting bindings through
5758 get_keymap_1, non-prefix bindings for meta-prefix-char
5760 defs
[i
] = get_keymap_1 (def
, 0, 1);
5766 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5769 first_binding
= nmaps
;
5770 for (i
= nmaps
- 1; i
>= 0; i
--)
5772 if (! NILP (current
[i
]))
5780 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0));
5781 if (! NILP (defs
[i
]))
5788 /* Given the set of bindings we've found, produce the next set of maps. */
5789 if (first_binding
< nmaps
)
5790 for (i
= 0; i
< nmaps
; i
++)
5791 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5793 return first_binding
;
5796 /* Read a sequence of keys that ends with a non prefix character,
5797 storing it in KEYBUF, a buffer of size BUFSIZE.
5799 Return the length of the key sequence stored.
5800 Return -1 if the user rejected a command menu.
5802 Echo starting immediately unless `prompt' is 0.
5804 Where a key sequence ends depends on the currently active keymaps.
5805 These include any minor mode keymaps active in the current buffer,
5806 the current buffer's local map, and the global map.
5808 If a key sequence has no other bindings, we check Vfunction_key_map
5809 to see if some trailing subsequence might be the beginning of a
5810 function key's sequence. If so, we try to read the whole function
5811 key, and substitute its symbolic name into the key sequence.
5813 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5814 `double-' events into similar click events, if that would make them
5815 bound. We try to turn `triple-' events first into `double-' events,
5818 If we get a mouse click in a mode line, vertical divider, or other
5819 non-text area, we treat the click as if it were prefixed by the
5820 symbol denoting that area - `mode-line', `vertical-line', or
5823 If the sequence starts with a mouse click, we read the key sequence
5824 with respect to the buffer clicked on, not the current buffer.
5826 If the user switches frames in the midst of a key sequence, we put
5827 off the switch-frame event until later; the next call to
5828 read_char will return it.
5830 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
5831 from the selected window's buffer. */
5834 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5835 can_return_switch_frame
, fix_current_buffer
)
5836 Lisp_Object
*keybuf
;
5839 int dont_downcase_last
;
5840 int can_return_switch_frame
;
5841 int fix_current_buffer
;
5843 int count
= specpdl_ptr
- specpdl
;
5845 /* How many keys there are in the current key sequence. */
5848 /* The length of the echo buffer when we started reading, and
5849 the length of this_command_keys when we started reading. */
5853 /* The number of keymaps we're scanning right now, and the number of
5854 keymaps we have allocated space for. */
5856 int nmaps_allocated
= 0;
5858 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5859 the current keymaps. */
5862 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5863 in the current keymaps, or nil where it is not a prefix. */
5864 Lisp_Object
*submaps
;
5866 /* The local map to start out with at start of key sequence. */
5867 Lisp_Object orig_local_map
;
5869 /* 1 if we have already considered switching to the local-map property
5870 of the place where a mouse click occurred. */
5871 int localized_local_map
= 0;
5873 /* The index in defs[] of the first keymap that has a binding for
5874 this key sequence. In other words, the lowest i such that
5875 defs[i] is non-nil. */
5878 /* If t < mock_input, then KEYBUF[t] should be read as the next
5881 We use this to recover after recognizing a function key. Once we
5882 realize that a suffix of the current key sequence is actually a
5883 function key's escape sequence, we replace the suffix with the
5884 function key's binding from Vfunction_key_map. Now keybuf
5885 contains a new and different key sequence, so the echo area,
5886 this_command_keys, and the submaps and defs arrays are wrong. In
5887 this situation, we set mock_input to t, set t to 0, and jump to
5888 restart_sequence; the loop will read keys from keybuf up until
5889 mock_input, thus rebuilding the state; and then it will resume
5890 reading characters from the keyboard. */
5893 /* If the sequence is unbound in submaps[], then
5894 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
5895 and fkey_map is its binding.
5897 These might be > t, indicating that all function key scanning
5898 should hold off until t reaches them. We do this when we've just
5899 recognized a function key, to avoid searching for the function
5900 key's again in Vfunction_key_map. */
5901 int fkey_start
= 0, fkey_end
= 0;
5902 Lisp_Object fkey_map
;
5904 /* Likewise, for key_translation_map. */
5905 int keytran_start
= 0, keytran_end
= 0;
5906 Lisp_Object keytran_map
;
5908 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
5909 we put it off for later. While we're reading, we keep the event here. */
5910 Lisp_Object delayed_switch_frame
;
5912 /* See the comment below... */
5913 #if defined (GOBBLE_FIRST_EVENT)
5914 Lisp_Object first_event
;
5917 Lisp_Object original_uppercase
;
5918 int original_uppercase_position
= -1;
5920 /* Gets around Microsoft compiler limitations. */
5923 struct buffer
*starting_buffer
;
5925 /* Nonzero if we seem to have got the beginning of a binding
5926 in function_key_map. */
5927 int function_key_possible
= 0;
5928 int key_translation_possible
= 0;
5930 /* Save the status of key translation before each step,
5931 so that we can restore this after downcasing. */
5932 Lisp_Object prev_fkey_map
;
5933 int prev_fkey_start
;
5936 Lisp_Object prev_keytran_map
;
5937 int prev_keytran_start
;
5938 int prev_keytran_end
;
5942 last_nonmenu_event
= Qnil
;
5944 delayed_switch_frame
= Qnil
;
5945 fkey_map
= Vfunction_key_map
;
5946 keytran_map
= Vkey_translation_map
;
5948 /* If there is no function-key-map, turn off function key scanning. */
5949 if (NILP (Fkeymapp (Vfunction_key_map
)))
5950 fkey_start
= fkey_end
= bufsize
+ 1;
5952 /* If there is no key-translation-map, turn off scanning. */
5953 if (NILP (Fkeymapp (Vkey_translation_map
)))
5954 keytran_start
= keytran_end
= bufsize
+ 1;
5959 echo_prompt (XSTRING (prompt
)->data
);
5960 else if (cursor_in_echo_area
&& echo_keystrokes
)
5961 /* This doesn't put in a dash if the echo buffer is empty, so
5962 you don't always see a dash hanging out in the minibuffer. */
5966 /* Record the initial state of the echo area and this_command_keys;
5967 we will need to restore them if we replay a key sequence. */
5969 echo_start
= echo_length ();
5970 keys_start
= this_command_key_count
;
5971 this_single_command_key_start
= keys_start
;
5973 #if defined (GOBBLE_FIRST_EVENT)
5974 /* This doesn't quite work, because some of the things that read_char
5975 does cannot safely be bypassed. It seems too risky to try to make
5978 /* Read the first char of the sequence specially, before setting
5979 up any keymaps, in case a filter runs and switches buffers on us. */
5980 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
5982 #endif /* GOBBLE_FIRST_EVENT */
5984 orig_local_map
= get_local_map (PT
, current_buffer
);
5986 /* We jump here when the key sequence has been thoroughly changed, and
5987 we need to rescan it starting from the beginning. When we jump here,
5988 keybuf[0..mock_input] holds the sequence we should reread. */
5991 starting_buffer
= current_buffer
;
5992 function_key_possible
= 0;
5993 key_translation_possible
= 0;
5995 /* Build our list of keymaps.
5996 If we recognize a function key and replace its escape sequence in
5997 keybuf with its symbol, or if the sequence starts with a mouse
5998 click and we need to switch buffers, we jump back here to rebuild
5999 the initial keymaps from the current buffer. */
6003 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6004 || !NILP (Voverriding_local_map
))
6006 if (3 > nmaps_allocated
)
6008 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6009 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6010 nmaps_allocated
= 3;
6013 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6014 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6015 if (!NILP (Voverriding_local_map
))
6016 submaps
[nmaps
++] = Voverriding_local_map
;
6020 nmaps
= current_minor_maps (0, &maps
);
6021 if (nmaps
+ 2 > nmaps_allocated
)
6023 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6024 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6025 nmaps_allocated
= nmaps
+ 2;
6027 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6028 #ifdef USE_TEXT_PROPERTIES
6029 submaps
[nmaps
++] = orig_local_map
;
6031 submaps
[nmaps
++] = current_buffer
->keymap
;
6034 submaps
[nmaps
++] = current_global_map
;
6037 /* Find an accurate initial value for first_binding. */
6038 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6039 if (! NILP (submaps
[first_binding
]))
6042 /* Start from the beginning in keybuf. */
6045 /* These are no-ops the first time through, but if we restart, they
6046 revert the echo area and this_command_keys to their original state. */
6047 this_command_key_count
= keys_start
;
6048 if (INTERACTIVE
&& t
< mock_input
)
6049 echo_truncate (echo_start
);
6051 /* If the best binding for the current key sequence is a keymap, or
6052 we may be looking at a function key's escape sequence, keep on
6054 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6055 || (first_binding
>= nmaps
6057 /* mock input is never part of a function key's sequence. */
6058 && mock_input
<= fkey_start
)
6059 || (first_binding
>= nmaps
6060 && keytran_start
< t
&& key_translation_possible
)
6061 /* Don't return in the middle of a possible function key sequence,
6062 if the only bindings we found were via case conversion.
6063 Thus, if ESC O a has a function-key-map translation
6064 and ESC o has a binding, don't return after ESC O,
6065 so that we can translate ESC O plus the next character. */
6069 int used_mouse_menu
= 0;
6071 /* Where the last real key started. If we need to throw away a
6072 key that has expanded into more than one element of keybuf
6073 (say, a mouse click on the mode line which is being treated
6074 as [mode-line (mouse-...)], then we backtrack to this point
6076 int last_real_key_start
;
6078 /* These variables are analogous to echo_start and keys_start;
6079 while those allow us to restart the entire key sequence,
6080 echo_local_start and keys_local_start allow us to throw away
6082 int echo_local_start
, keys_local_start
, local_first_binding
;
6085 error ("Key sequence too long");
6088 echo_local_start
= echo_length ();
6089 keys_local_start
= this_command_key_count
;
6090 local_first_binding
= first_binding
;
6093 /* These are no-ops, unless we throw away a keystroke below and
6094 jumped back up to replay_key; in that case, these restore the
6095 variables to their original state, allowing us to replay the
6097 if (INTERACTIVE
&& t
< mock_input
)
6098 echo_truncate (echo_local_start
);
6099 this_command_key_count
= keys_local_start
;
6100 first_binding
= local_first_binding
;
6102 /* By default, assume each event is "real". */
6103 last_real_key_start
= t
;
6105 /* Does mock_input indicate that we are re-reading a key sequence? */
6109 add_command_key (key
);
6110 if (echo_keystrokes
)
6114 /* If not, we should actually read a character. */
6117 struct buffer
*buf
= current_buffer
;
6121 KBOARD
*interrupted_kboard
= current_kboard
;
6122 struct frame
*interrupted_frame
= selected_frame
;
6123 if (setjmp (wrong_kboard_jmpbuf
))
6125 if (!NILP (delayed_switch_frame
))
6127 interrupted_kboard
->kbd_queue
6128 = Fcons (delayed_switch_frame
,
6129 interrupted_kboard
->kbd_queue
);
6130 delayed_switch_frame
= Qnil
;
6133 interrupted_kboard
->kbd_queue
6134 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6136 /* If the side queue is non-empty, ensure it begins with a
6137 switch-frame, so we'll replay it in the right context. */
6138 if (CONSP (interrupted_kboard
->kbd_queue
)
6139 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6140 !(EVENT_HAS_PARAMETERS (key
)
6141 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6145 XSETFRAME (frame
, interrupted_frame
);
6146 interrupted_kboard
->kbd_queue
6147 = Fcons (make_lispy_switch_frame (frame
),
6148 interrupted_kboard
->kbd_queue
);
6151 orig_local_map
= get_local_map (PT
, current_buffer
);
6152 goto replay_sequence
;
6155 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6159 /* read_char returns t when it shows a menu and the user rejects it.
6164 /* read_char returns -1 at the end of a macro.
6165 Emacs 18 handles this by returning immediately with a
6166 zero, so that's what we'll do. */
6167 if (INTEGERP (key
) && XINT (key
) == -1)
6170 /* The Microsoft C compiler can't handle the goto that
6176 /* If the current buffer has been changed from under us, the
6177 keymap may have changed, so replay the sequence. */
6181 /* Reset the current buffer from the selected window
6182 in case something changed the former and not the latter.
6183 This is to be more consistent with the behavior
6184 of the command_loop_1. */
6185 if (fix_current_buffer
)
6186 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
6187 Fset_buffer (XWINDOW (selected_window
)->buffer
);
6189 orig_local_map
= get_local_map (PT
, current_buffer
);
6190 goto replay_sequence
;
6193 /* If we have a quit that was typed in another frame, and
6194 quit_throw_to_read_char switched buffers,
6195 replay to get the right keymap. */
6196 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6201 orig_local_map
= get_local_map (PT
, current_buffer
);
6202 goto replay_sequence
;
6208 /* Clicks in non-text areas get prefixed by the symbol
6209 in their CHAR-ADDRESS field. For example, a click on
6210 the mode line is prefixed by the symbol `mode-line'.
6212 Furthermore, key sequences beginning with mouse clicks
6213 are read using the keymaps of the buffer clicked on, not
6214 the current buffer. So we may have to switch the buffer
6217 When we turn one event into two events, we must make sure
6218 that neither of the two looks like the original--so that,
6219 if we replay the events, they won't be expanded again.
6220 If not for this, such reexpansion could happen either here
6221 or when user programs play with this-command-keys. */
6222 if (EVENT_HAS_PARAMETERS (key
))
6226 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6227 if (EQ (kind
, Qmouse_click
))
6229 Lisp_Object window
, posn
;
6231 window
= POSN_WINDOW (EVENT_START (key
));
6232 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6235 /* We're looking at the second event of a
6236 sequence which we expanded before. Set
6237 last_real_key_start appropriately. */
6239 last_real_key_start
= t
- 1;
6242 /* Key sequences beginning with mouse clicks are
6243 read using the keymaps in the buffer clicked on,
6244 not the current buffer. If we're at the
6245 beginning of a key sequence, switch buffers. */
6246 if (last_real_key_start
== 0
6248 && BUFFERP (XWINDOW (window
)->buffer
)
6249 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6254 /* Arrange to go back to the original buffer once we're
6255 done reading the key sequence. Note that we can't
6256 use save_excursion_{save,restore} here, because they
6257 save point as well as the current buffer; we don't
6258 want to save point, because redisplay may change it,
6259 to accommodate a Fset_window_start or something. We
6260 don't want to do this at the top of the function,
6261 because we may get input from a subprocess which
6262 wants to change the selected window and stuff (say,
6264 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6266 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6267 orig_local_map
= get_local_map (PT
, current_buffer
);
6268 goto replay_sequence
;
6270 /* For a mouse click, get the local text-property keymap
6271 of the place clicked on, rather than point. */
6272 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6273 && ! localized_local_map
)
6275 Lisp_Object map_here
, start
, pos
;
6277 localized_local_map
= 1;
6278 start
= EVENT_START (key
);
6279 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6281 pos
= POSN_BUFFER_POSN (start
);
6283 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6285 map_here
= get_local_map (XINT (pos
), current_buffer
);
6286 if (!EQ (map_here
, orig_local_map
))
6288 orig_local_map
= map_here
;
6292 goto replay_sequence
;
6298 /* Expand mode-line and scroll-bar events into two events:
6299 use posn as a fake prefix key. */
6302 if (t
+ 1 >= bufsize
)
6303 error ("Key sequence too long");
6308 /* Zap the position in key, so we know that we've
6309 expanded it, and don't try to do so again. */
6310 POSN_BUFFER_POSN (EVENT_START (key
))
6311 = Fcons (posn
, Qnil
);
6315 else if (EQ (kind
, Qswitch_frame
))
6317 /* If we're at the beginning of a key sequence, and the caller
6318 says it's okay, go ahead and return this event. If we're
6319 in the midst of a key sequence, delay it until the end. */
6320 if (t
> 0 || !can_return_switch_frame
)
6322 delayed_switch_frame
= key
;
6326 else if (CONSP (XCONS (key
)->cdr
)
6327 && CONSP (EVENT_START (key
))
6328 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6332 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6333 /* Handle menu-bar events:
6334 insert the dummy prefix event `menu-bar'. */
6335 if (EQ (posn
, Qmenu_bar
))
6337 if (t
+ 1 >= bufsize
)
6338 error ("Key sequence too long");
6342 /* Zap the position in key, so we know that we've
6343 expanded it, and don't try to do so again. */
6344 POSN_BUFFER_POSN (EVENT_START (key
))
6345 = Fcons (posn
, Qnil
);
6348 goto replay_sequence
;
6350 else if (CONSP (posn
))
6352 /* We're looking at the second event of a
6353 sequence which we expanded before. Set
6354 last_real_key_start appropriately. */
6355 if (last_real_key_start
== t
&& t
> 0)
6356 last_real_key_start
= t
- 1;
6361 /* We have finally decided that KEY is something we might want
6363 first_binding
= (follow_key (key
,
6364 nmaps
- first_binding
,
6365 submaps
+ first_binding
,
6366 defs
+ first_binding
,
6367 submaps
+ first_binding
)
6370 /* If KEY wasn't bound, we'll try some fallbacks. */
6371 if (first_binding
>= nmaps
)
6375 head
= EVENT_HEAD (key
);
6376 if (help_char_p (head
) && t
> 0)
6378 read_key_sequence_cmd
= Vprefix_help_command
;
6380 last_nonmenu_event
= key
;
6381 /* The Microsoft C compiler can't handle the goto that
6389 Lisp_Object breakdown
;
6392 breakdown
= parse_modifiers (head
);
6393 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6394 /* Attempt to reduce an unbound mouse event to a simpler
6395 event that is bound:
6396 Drags reduce to clicks.
6397 Double-clicks reduce to clicks.
6398 Triple-clicks reduce to double-clicks, then to clicks.
6399 Down-clicks are eliminated.
6400 Double-downs reduce to downs, then are eliminated.
6401 Triple-downs reduce to double-downs, then to downs,
6402 then are eliminated. */
6403 if (modifiers
& (down_modifier
| drag_modifier
6404 | double_modifier
| triple_modifier
))
6406 while (modifiers
& (down_modifier
| drag_modifier
6407 | double_modifier
| triple_modifier
))
6409 Lisp_Object new_head
, new_click
;
6410 if (modifiers
& triple_modifier
)
6411 modifiers
^= (double_modifier
| triple_modifier
);
6412 else if (modifiers
& double_modifier
)
6413 modifiers
&= ~double_modifier
;
6414 else if (modifiers
& drag_modifier
)
6415 modifiers
&= ~drag_modifier
;
6418 /* Dispose of this `down' event by simply jumping
6419 back to replay_key, to get another event.
6421 Note that if this event came from mock input,
6422 then just jumping back to replay_key will just
6423 hand it to us again. So we have to wipe out any
6426 We could delete keybuf[t] and shift everything
6427 after that to the left by one spot, but we'd also
6428 have to fix up any variable that points into
6429 keybuf, and shifting isn't really necessary
6432 Adding prefixes for non-textual mouse clicks
6433 creates two characters of mock input, and both
6434 must be thrown away. If we're only looking at
6435 the prefix now, we can just jump back to
6436 replay_key. On the other hand, if we've already
6437 processed the prefix, and now the actual click
6438 itself is giving us trouble, then we've lost the
6439 state of the keymaps we want to backtrack to, and
6440 we need to replay the whole sequence to rebuild
6443 Beyond that, only function key expansion could
6444 create more than two keys, but that should never
6445 generate mouse events, so it's okay to zero
6446 mock_input in that case too.
6448 Isn't this just the most wonderful code ever? */
6449 if (t
== last_real_key_start
)
6456 mock_input
= last_real_key_start
;
6457 goto replay_sequence
;
6462 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6464 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6466 /* Look for a binding for this new key. follow_key
6467 promises that it didn't munge submaps the
6468 last time we called it, since key was unbound. */
6470 = (follow_key (new_click
,
6471 nmaps
- local_first_binding
,
6472 submaps
+ local_first_binding
,
6473 defs
+ local_first_binding
,
6474 submaps
+ local_first_binding
)
6475 + local_first_binding
);
6477 /* If that click is bound, go for it. */
6478 if (first_binding
< nmaps
)
6483 /* Otherwise, we'll leave key set to the drag event. */
6490 /* Normally, last_nonmenu_event gets the previous key we read.
6491 But when a mouse popup menu is being used,
6492 we don't update last_nonmenu_event; it continues to hold the mouse
6493 event that preceded the first level of menu. */
6494 if (!used_mouse_menu
)
6495 last_nonmenu_event
= key
;
6497 /* Record what part of this_command_keys is the current key sequence. */
6498 this_single_command_key_start
= this_command_key_count
- t
;
6500 prev_fkey_map
= fkey_map
;
6501 prev_fkey_start
= fkey_start
;
6502 prev_fkey_end
= fkey_end
;
6504 prev_keytran_map
= keytran_map
;
6505 prev_keytran_start
= keytran_start
;
6506 prev_keytran_end
= keytran_end
;
6508 /* If the sequence is unbound, see if we can hang a function key
6509 off the end of it. We only want to scan real keyboard input
6510 for function key sequences, so if mock_input says that we're
6511 re-reading old events, don't examine it. */
6512 if (first_binding
>= nmaps
6515 Lisp_Object fkey_next
;
6517 /* Continue scan from fkey_end until we find a bound suffix.
6518 If we fail, increment fkey_start
6519 and start fkey_end from there. */
6520 while (fkey_end
< t
)
6524 key
= keybuf
[fkey_end
++];
6525 /* Look up meta-characters by prefixing them
6526 with meta_prefix_char. I hate this. */
6527 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6532 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
6534 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6537 fkey_next
= fkey_map
;
6540 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
6542 #if 0 /* I didn't turn this on, because it might cause trouble
6543 for the mapping of return into C-m and tab into C-i. */
6544 /* Optionally don't map function keys into other things.
6545 This enables the user to redefine kp- keys easily. */
6546 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6550 /* If the function key map gives a function, not an
6551 array, then call the function with no args and use
6552 its value instead. */
6553 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6556 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6560 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6561 fkey_next
= call1 (fkey_next
, prompt
);
6563 /* If the function returned something invalid,
6564 barf--don't ignore it.
6565 (To ignore it safely, we would need to gcpro a bunch of
6566 other variables.) */
6567 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6568 error ("Function in key-translation-map returns invalid key sequence");
6571 function_key_possible
= ! NILP (fkey_next
);
6573 /* If keybuf[fkey_start..fkey_end] is bound in the
6574 function key map and it's a suffix of the current
6575 sequence (i.e. fkey_end == t), replace it with
6576 the binding and restart with fkey_start at the end. */
6577 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6580 int len
= XFASTINT (Flength (fkey_next
));
6582 t
= fkey_start
+ len
;
6584 error ("Key sequence too long");
6586 if (VECTORP (fkey_next
))
6587 bcopy (XVECTOR (fkey_next
)->contents
,
6588 keybuf
+ fkey_start
,
6589 (t
- fkey_start
) * sizeof (keybuf
[0]));
6590 else if (STRINGP (fkey_next
))
6594 for (i
= 0; i
< len
; i
++)
6595 XSETFASTINT (keybuf
[fkey_start
+ i
],
6596 XSTRING (fkey_next
)->data
[i
]);
6600 fkey_start
= fkey_end
= t
;
6601 fkey_map
= Vfunction_key_map
;
6603 /* Do pass the results through key-translation-map. */
6604 keytran_start
= keytran_end
= 0;
6605 keytran_map
= Vkey_translation_map
;
6607 goto replay_sequence
;
6610 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6612 /* If we no longer have a bound suffix, try a new positions for
6614 if (NILP (fkey_map
))
6616 fkey_end
= ++fkey_start
;
6617 fkey_map
= Vfunction_key_map
;
6618 function_key_possible
= 0;
6623 /* Look for this sequence in key-translation-map. */
6625 Lisp_Object keytran_next
;
6627 /* Scan from keytran_end until we find a bound suffix. */
6628 while (keytran_end
< t
)
6632 key
= keybuf
[keytran_end
++];
6633 /* Look up meta-characters by prefixing them
6634 with meta_prefix_char. I hate this. */
6635 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6640 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
6642 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6645 keytran_next
= keytran_map
;
6648 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
6650 /* If the key translation map gives a function, not an
6651 array, then call the function with no args and use
6652 its value instead. */
6653 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6654 && keytran_end
== t
)
6656 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6660 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6661 keytran_next
= call1 (keytran_next
, prompt
);
6663 /* If the function returned something invalid,
6664 barf--don't ignore it.
6665 (To ignore it safely, we would need to gcpro a bunch of
6666 other variables.) */
6667 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6668 error ("Function in key-translation-map returns invalid key sequence");
6671 key_translation_possible
= ! NILP (keytran_next
);
6673 /* If keybuf[keytran_start..keytran_end] is bound in the
6674 key translation map and it's a suffix of the current
6675 sequence (i.e. keytran_end == t), replace it with
6676 the binding and restart with keytran_start at the end. */
6677 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6678 && keytran_end
== t
)
6680 int len
= XFASTINT (Flength (keytran_next
));
6682 t
= keytran_start
+ len
;
6684 error ("Key sequence too long");
6686 if (VECTORP (keytran_next
))
6687 bcopy (XVECTOR (keytran_next
)->contents
,
6688 keybuf
+ keytran_start
,
6689 (t
- keytran_start
) * sizeof (keybuf
[0]));
6690 else if (STRINGP (keytran_next
))
6694 for (i
= 0; i
< len
; i
++)
6695 XSETFASTINT (keybuf
[keytran_start
+ i
],
6696 XSTRING (keytran_next
)->data
[i
]);
6700 keytran_start
= keytran_end
= t
;
6701 keytran_map
= Vkey_translation_map
;
6703 /* Don't pass the results of key-translation-map
6704 through function-key-map. */
6705 fkey_start
= fkey_end
= t
;
6706 fkey_map
= Vkey_translation_map
;
6708 goto replay_sequence
;
6711 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6713 /* If we no longer have a bound suffix, try a new positions for
6715 if (NILP (keytran_map
))
6717 keytran_end
= ++keytran_start
;
6718 keytran_map
= Vkey_translation_map
;
6719 key_translation_possible
= 0;
6724 /* If KEY is not defined in any of the keymaps,
6725 and cannot be part of a function key or translation,
6726 and is an upper case letter
6727 use the corresponding lower-case letter instead. */
6728 if (first_binding
== nmaps
&& ! function_key_possible
6729 && ! key_translation_possible
6731 && ((((XINT (key
) & 0x3ffff)
6732 < XSTRING (current_buffer
->downcase_table
)->size
)
6733 && UPPERCASEP (XINT (key
) & 0x3ffff))
6734 || (XINT (key
) & shift_modifier
)))
6736 Lisp_Object new_key
;
6738 original_uppercase
= key
;
6739 original_uppercase_position
= t
- 1;
6741 if (XINT (key
) & shift_modifier
)
6742 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6744 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6745 | (XINT (key
) & ~0x3ffff)));
6747 /* We have to do this unconditionally, regardless of whether
6748 the lower-case char is defined in the keymaps, because they
6749 might get translated through function-key-map. */
6750 keybuf
[t
- 1] = new_key
;
6753 fkey_map
= prev_fkey_map
;
6754 fkey_start
= prev_fkey_start
;
6755 fkey_end
= prev_fkey_end
;
6757 keytran_map
= prev_keytran_map
;
6758 keytran_start
= prev_keytran_start
;
6759 keytran_end
= prev_keytran_end
;
6761 goto replay_sequence
;
6763 /* If KEY is not defined in any of the keymaps,
6764 and cannot be part of a function key or translation,
6765 and is a shifted function key,
6766 use the corresponding unshifted function key instead. */
6767 if (first_binding
== nmaps
&& ! function_key_possible
6768 && ! key_translation_possible
6771 Lisp_Object breakdown
;
6774 breakdown
= parse_modifiers (key
);
6775 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6776 if (modifiers
& shift_modifier
)
6778 Lisp_Object new_key
;
6780 original_uppercase
= key
;
6781 original_uppercase_position
= t
- 1;
6783 modifiers
&= ~shift_modifier
;
6784 new_key
= apply_modifiers (modifiers
,
6785 XCONS (breakdown
)->car
);
6787 keybuf
[t
- 1] = new_key
;
6790 fkey_map
= prev_fkey_map
;
6791 fkey_start
= prev_fkey_start
;
6792 fkey_end
= prev_fkey_end
;
6794 keytran_map
= prev_keytran_map
;
6795 keytran_start
= prev_keytran_start
;
6796 keytran_end
= prev_keytran_end
;
6798 goto replay_sequence
;
6804 read_key_sequence_cmd
= (first_binding
< nmaps
6805 ? defs
[first_binding
]
6808 unread_switch_frame
= delayed_switch_frame
;
6809 unbind_to (count
, Qnil
);
6811 /* Don't downcase the last character if the caller says don't.
6812 Don't downcase it if the result is undefined, either. */
6813 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6814 && t
- 1 == original_uppercase_position
)
6815 keybuf
[t
- 1] = original_uppercase
;
6817 /* Occasionally we fabricate events, perhaps by expanding something
6818 according to function-key-map, or by adding a prefix symbol to a
6819 mouse click in the scroll bar or modeline. In this cases, return
6820 the entire generated key sequence, even if we hit an unbound
6821 prefix or a definition before the end. This means that you will
6822 be able to push back the event properly, and also means that
6823 read-key-sequence will always return a logical unit.
6826 for (; t
< mock_input
; t
++)
6828 if (echo_keystrokes
)
6829 echo_char (keybuf
[t
]);
6830 add_command_key (keybuf
[t
]);
6836 #if 0 /* This doc string is too long for some compilers.
6837 This commented-out definition serves for DOC. */
6838 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6839 "Read a sequence of keystrokes and return as a string or vector.\n\
6840 The sequence is sufficient to specify a non-prefix command in the\n\
6841 current local and global maps.\n\
6843 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6844 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6845 as a continuation of the previous key.\n\
6847 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6848 convert the last event to lower case. (Normally any upper case event\n\
6849 is converted to lower case if the original event is undefined and the lower\n\
6850 case equivalent is defined.) A non-nil value is appropriate for reading\n\
6851 a key sequence to be defined.\n\
6853 A C-g typed while in this function is treated like any other character,\n\
6854 and `quit-flag' is not set.\n\
6856 If the key sequence starts with a mouse click, then the sequence is read\n\
6857 using the keymaps of the buffer of the window clicked in, not the buffer\n\
6858 of the selected window as normal.\n\
6860 `read-key-sequence' drops unbound button-down events, since you normally\n\
6861 only care about the click or drag events which follow them. If a drag\n\
6862 or multi-click event is unbound, but the corresponding click event would\n\
6863 be bound, `read-key-sequence' turns the event into a click event at the\n\
6864 drag's starting position. This means that you don't have to distinguish\n\
6865 between click and drag, double, or triple events unless you want to.\n\
6867 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
6868 lines separating windows, and scroll bars with imaginary keys\n\
6869 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
6871 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
6872 function will process a switch-frame event if the user switches frames\n\
6873 before typing anything. If the user switches frames in the middle of a\n\
6874 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
6875 is nil, then the event will be put off until after the current key sequence.\n\
6877 `read-key-sequence' checks `function-key-map' for function key\n\
6878 sequences, where they wouldn't conflict with ordinary bindings. See\n\
6879 `function-key-map' for more details.")
6880 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6883 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6885 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6886 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
6887 Lisp_Object can_return_switch_frame
;
6889 Lisp_Object keybuf
[30];
6891 struct gcpro gcpro1
, gcpro2
;
6894 CHECK_STRING (prompt
, 0);
6897 bzero (keybuf
, sizeof keybuf
);
6899 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
6901 if (NILP (continue_echo
))
6903 this_command_key_count
= 0;
6904 this_single_command_key_start
= 0;
6907 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
6908 prompt
, ! NILP (dont_downcase_last
),
6909 ! NILP (can_return_switch_frame
), 0);
6917 return make_event_array (i
, keybuf
);
6920 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
6921 "Execute CMD as an editor command.\n\
6922 CMD must be a symbol that satisfies the `commandp' predicate.\n\
6923 Optional second arg RECORD-FLAG non-nil\n\
6924 means unconditionally put this command in `command-history'.\n\
6925 Otherwise, that is done only if an arg is read using the minibuffer.\n\
6926 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
6927 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
6928 The argument SPECIAL, if non-nil, means that this command is executing\n\
6929 a special event, so ignore the prefix argument and don't clear it.")
6930 (cmd
, record_flag
, keys
, special
)
6931 Lisp_Object cmd
, record_flag
, keys
, special
;
6933 register Lisp_Object final
;
6934 register Lisp_Object tem
;
6935 Lisp_Object prefixarg
;
6936 struct backtrace backtrace
;
6937 extern int debug_on_next_call
;
6939 debug_on_next_call
= 0;
6943 prefixarg
= current_kboard
->Vprefix_arg
;
6944 Vcurrent_prefix_arg
= prefixarg
;
6945 current_kboard
->Vprefix_arg
= Qnil
;
6952 tem
= Fget (cmd
, Qdisabled
);
6953 if (!NILP (tem
) && !NILP (Vrun_hooks
))
6955 tem
= Fsymbol_value (Qdisabled_command_hook
);
6957 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
6963 final
= Findirect_function (cmd
);
6965 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
6967 struct gcpro gcpro1
, gcpro2
;
6969 GCPRO2 (cmd
, prefixarg
);
6970 do_autoload (final
, cmd
);
6977 if (STRINGP (final
) || VECTORP (final
))
6979 /* If requested, place the macro in the command history. For
6980 other sorts of commands, call-interactively takes care of
6982 if (!NILP (record_flag
))
6984 = Fcons (Fcons (Qexecute_kbd_macro
,
6985 Fcons (final
, Fcons (prefixarg
, Qnil
))),
6988 return Fexecute_kbd_macro (final
, prefixarg
);
6990 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
6992 backtrace
.next
= backtrace_list
;
6993 backtrace_list
= &backtrace
;
6994 backtrace
.function
= &Qcall_interactively
;
6995 backtrace
.args
= &cmd
;
6996 backtrace
.nargs
= 1;
6997 backtrace
.evalargs
= 0;
6999 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7001 backtrace_list
= backtrace
.next
;
7007 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7009 "Read function name, then read its arguments and call it.")
7011 Lisp_Object prefixarg
;
7013 Lisp_Object function
;
7015 Lisp_Object saved_keys
;
7016 Lisp_Object bindings
, value
;
7017 struct gcpro gcpro1
, gcpro2
;
7019 saved_keys
= Fvector (this_command_key_count
,
7020 XVECTOR (this_command_keys
)->contents
);
7022 GCPRO2 (saved_keys
, prefixarg
);
7024 if (EQ (prefixarg
, Qminus
))
7026 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7027 strcpy (buf
, "C-u ");
7028 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7030 if (sizeof (int) == sizeof (EMACS_INT
))
7031 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7032 else if (sizeof (long) == sizeof (EMACS_INT
))
7033 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7037 else if (INTEGERP (prefixarg
))
7039 if (sizeof (int) == sizeof (EMACS_INT
))
7040 sprintf (buf
, "%d ", XINT (prefixarg
));
7041 else if (sizeof (long) == sizeof (EMACS_INT
))
7042 sprintf (buf
, "%ld ", XINT (prefixarg
));
7047 /* This isn't strictly correct if execute-extended-command
7048 is bound to anything else. Perhaps it should use
7049 this_command_keys? */
7050 strcat (buf
, "M-x ");
7052 /* Prompt with buf, and then read a string, completing from and
7053 restricting to the set of all defined commands. Don't provide
7054 any initial input. Save the command read on the extended-command
7056 function
= Fcompleting_read (build_string (buf
),
7057 Vobarray
, Qcommandp
,
7058 Qt
, Qnil
, Qextended_command_history
, Qnil
);
7060 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7061 error ("No command name given");
7063 /* Set this_command_keys to the concatenation of saved_keys and
7064 function, followed by a RET. */
7066 struct Lisp_String
*str
;
7071 this_command_key_count
= 0;
7072 this_single_command_key_start
= 0;
7074 keys
= XVECTOR (saved_keys
)->contents
;
7075 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7076 add_command_key (keys
[i
]);
7078 str
= XSTRING (function
);
7079 for (i
= 0; i
< str
->size
; i
++)
7081 XSETFASTINT (tem
, str
->data
[i
]);
7082 add_command_key (tem
);
7085 XSETFASTINT (tem
, '\015');
7086 add_command_key (tem
);
7091 function
= Fintern (function
, Qnil
);
7092 current_kboard
->Vprefix_arg
= prefixarg
;
7093 this_command
= function
;
7095 /* If enabled, show which key runs this command. */
7096 if (!NILP (Vsuggest_key_bindings
)
7097 && NILP (Vexecuting_macro
)
7098 && SYMBOLP (function
))
7099 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7105 GCPRO2 (bindings
, value
);
7106 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7108 /* If the command has a key binding, print it now. */
7109 if (!NILP (bindings
))
7111 /* But first wait, and skip the message if there is input. */
7112 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7113 ? Vsuggest_key_bindings
: make_number (2)),
7115 && ! CONSP (Vunread_command_events
))
7117 Lisp_Object binding
;
7119 char *oldmessage
= echo_area_glyphs
;
7120 int oldmessage_len
= echo_area_glyphs_length
;
7122 binding
= Fkey_description (bindings
);
7125 = (char *) alloca (XSYMBOL (function
)->name
->size
7126 + XSTRING (binding
)->size
7128 sprintf (newmessage
, "You can run the command `%s' by typing %s",
7129 XSYMBOL (function
)->name
->data
,
7130 XSTRING (binding
)->data
);
7131 message1_nolog (newmessage
);
7132 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7133 ? Vsuggest_key_bindings
: make_number (2)),
7135 message2_nolog (oldmessage
, oldmessage_len
);
7139 RETURN_UNGCPRO (value
);
7142 /* Find the set of keymaps now active.
7143 Store into *MAPS_P a vector holding the various maps
7144 and return the number of them. The vector was malloc'd
7145 and the caller should free it. */
7148 current_active_maps (maps_p
)
7149 Lisp_Object
**maps_p
;
7151 Lisp_Object
*tmaps
, *maps
;
7154 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7155 if (!NILP (Voverriding_local_map_menu_flag
))
7157 /* Yes, use them (if non-nil) as well as the global map. */
7158 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7160 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7161 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7162 if (!NILP (Voverriding_local_map
))
7163 maps
[nmaps
++] = Voverriding_local_map
;
7167 /* No, so use major and minor mode keymaps. */
7168 nmaps
= current_minor_maps (NULL
, &tmaps
);
7169 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7170 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7171 #ifdef USE_TEXT_PROPERTIES
7172 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7174 maps
[nmaps
++] = current_buffer
->keymap
;
7177 maps
[nmaps
++] = current_global_map
;
7183 /* Return nonzero if input events are pending. */
7185 detect_input_pending ()
7188 get_input_pending (&input_pending
, 0);
7190 return input_pending
;
7193 /* Return nonzero if input events are pending, and run any pending timers. */
7195 detect_input_pending_run_timers (do_display
)
7198 int old_timers_run
= timers_run
;
7201 get_input_pending (&input_pending
, 1);
7203 if (old_timers_run
!= timers_run
&& do_display
)
7204 redisplay_preserve_echo_area ();
7206 return input_pending
;
7209 /* This is called in some cases before a possible quit.
7210 It cases the next call to detect_input_pending to recompute input_pending.
7211 So calling this function unnecessarily can't do any harm. */
7212 clear_input_pending ()
7217 /* Return nonzero if there are pending requeued events.
7218 This isn't used yet. The hope is to make wait_reading_process_input
7219 call it, and return return if it runs Lisp code that unreads something.
7220 The problem is, kbd_buffer_get_event needs to be fixed to know what
7221 to do in that case. It isn't trivial. */
7223 requeued_events_pending_p ()
7225 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7229 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7230 "T if command input is currently available with no waiting.\n\
7231 Actually, the value is nil only if we can be sure that no input is available.")
7234 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7237 get_input_pending (&input_pending
, 1);
7238 return input_pending
> 0 ? Qt
: Qnil
;
7241 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7242 "Return vector of last 100 events, not counting those from keyboard macros.")
7245 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7248 if (total_keys
< NUM_RECENT_KEYS
)
7249 return Fvector (total_keys
, keys
);
7252 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7253 bcopy (keys
+ recent_keys_index
,
7254 XVECTOR (val
)->contents
,
7255 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7257 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7258 recent_keys_index
* sizeof (Lisp_Object
));
7263 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7264 "Return the key sequence that invoked this command.\n\
7265 The value is a string or a vector.")
7268 return make_event_array (this_command_key_count
,
7269 XVECTOR (this_command_keys
)->contents
);
7272 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7273 Sthis_single_command_keys
, 0, 0, 0,
7274 "Return the key sequence that invoked this command.\n\
7275 Unlike `this-command-keys', this function's value\n\
7276 does not include prefix arguments.\n\
7277 The value is a string or a vector.")
7280 return make_event_array (this_command_key_count
7281 - this_single_command_key_start
,
7282 (XVECTOR (this_command_keys
)->contents
7283 + this_single_command_key_start
));
7286 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7287 Sreset_this_command_lengths
, 0, 0, 0,
7288 "Used for complicated reasons in `universal-argument-other-key'.\n\
7290 `universal-argument-other-key' rereads the event just typed.\n\
7291 It then gets translated through `function-key-map'.\n\
7292 The translated event gets included in the echo area and in\n\
7293 the value of `this-command-keys' in addition to the raw original event.\n\
7294 That is not right.\n\
7296 Calling this function directs the translated event to replace\n\
7297 the original event, so that only one version of the event actually\n\
7298 appears in the echo area and in the value of `this-command-keys.'.")
7301 before_command_restore_flag
= 1;
7302 before_command_key_count_1
= before_command_key_count
;
7303 before_command_echo_length_1
= before_command_echo_length
;
7306 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7307 "Return the current depth in recursive edits.")
7311 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
7315 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
7316 "FOpen dribble file: ",
7317 "Start writing all keyboard characters to a dribble file called FILE.\n\
7318 If FILE is nil, close any open dribble file.")
7329 file
= Fexpand_file_name (file
, Qnil
);
7330 dribble
= fopen (XSTRING (file
)->data
, "w");
7332 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
7337 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
7338 "Discard the contents of the terminal input buffer.\n\
7339 Also cancel any kbd macro being defined.")
7342 current_kboard
->defining_kbd_macro
= Qnil
;
7343 update_mode_lines
++;
7345 Vunread_command_events
= Qnil
;
7346 unread_command_char
= -1;
7348 discard_tty_input ();
7350 /* Without the cast, GCC complains that this assignment loses the
7351 volatile qualifier of kbd_store_ptr. Is there anything wrong
7353 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7354 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7360 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7361 "Stop Emacs and return to superior process. You can resume later.\n\
7362 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7363 control, run a subshell instead.\n\n\
7364 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7365 to be read as terminal input by Emacs's parent, after suspension.\n\
7367 Before suspending, run the normal hook `suspend-hook'.\n\
7368 After resumption run the normal hook `suspend-resume-hook'.\n\
7370 Some operating systems cannot stop the Emacs process and resume it later.\n\
7371 On such systems, Emacs starts a subshell instead of suspending.")
7373 Lisp_Object stuffstring
;
7376 int count
= specpdl_ptr
- specpdl
;
7377 int old_height
, old_width
;
7379 struct gcpro gcpro1
, gcpro2
;
7380 extern init_sys_modes ();
7382 if (!NILP (stuffstring
))
7383 CHECK_STRING (stuffstring
, 0);
7385 /* Run the functions in suspend-hook. */
7386 if (!NILP (Vrun_hooks
))
7387 call1 (Vrun_hooks
, intern ("suspend-hook"));
7389 GCPRO1 (stuffstring
);
7390 get_frame_size (&old_width
, &old_height
);
7392 /* sys_suspend can get an error if it tries to fork a subshell
7393 and the system resources aren't available for that. */
7394 record_unwind_protect (init_sys_modes
, 0);
7395 stuff_buffered_input (stuffstring
);
7400 unbind_to (count
, Qnil
);
7402 /* Check if terminal/window size has changed.
7403 Note that this is not useful when we are running directly
7404 with a window system; but suspend should be disabled in that case. */
7405 get_frame_size (&width
, &height
);
7406 if (width
!= old_width
|| height
!= old_height
)
7407 change_frame_size (selected_frame
, height
, width
, 0, 0);
7409 /* Run suspend-resume-hook. */
7410 if (!NILP (Vrun_hooks
))
7411 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7417 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7418 Then in any case stuff anything Emacs has read ahead and not used. */
7420 stuff_buffered_input (stuffstring
)
7421 Lisp_Object stuffstring
;
7423 /* stuff_char works only in BSD, versions 4.2 and up. */
7426 register unsigned char *p
;
7428 if (STRINGP (stuffstring
))
7432 p
= XSTRING (stuffstring
)->data
;
7433 count
= XSTRING (stuffstring
)->size
;
7438 /* Anything we have read ahead, put back for the shell to read. */
7439 /* ?? What should this do when we have multiple keyboards??
7440 Should we ignore anything that was typed in at the "wrong" kboard? */
7441 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7443 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7444 kbd_fetch_ptr
= kbd_buffer
;
7445 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7446 stuff_char (kbd_fetch_ptr
->code
);
7447 kbd_fetch_ptr
->kind
= no_event
;
7448 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7454 #endif /* BSD_SYSTEM and not BSD4_1 */
7457 set_waiting_for_input (time_to_clear
)
7458 EMACS_TIME
*time_to_clear
;
7460 input_available_clear_time
= time_to_clear
;
7462 /* Tell interrupt_signal to throw back to read_char, */
7463 waiting_for_input
= 1;
7465 /* If interrupt_signal was called before and buffered a C-g,
7466 make it run again now, to avoid timing error. */
7467 if (!NILP (Vquit_flag
))
7468 quit_throw_to_read_char ();
7471 clear_waiting_for_input ()
7473 /* Tell interrupt_signal not to throw back to read_char, */
7474 waiting_for_input
= 0;
7475 input_available_clear_time
= 0;
7478 /* This routine is called at interrupt level in response to C-G.
7479 If interrupt_input, this is the handler for SIGINT.
7480 Otherwise, it is called from kbd_buffer_store_event,
7481 in handling SIGIO or SIGTINT.
7483 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7484 immediately throw back to read_char.
7486 Otherwise it sets the Lisp variable quit-flag not-nil.
7487 This causes eval to throw, when it gets a chance.
7488 If quit-flag is already non-nil, it stops the job right away. */
7491 interrupt_signal (signalnum
) /* If we don't have an argument, */
7492 int signalnum
; /* some compilers complain in signal calls. */
7495 /* Must preserve main program's value of errno. */
7496 int old_errno
= errno
;
7498 #if defined (USG) && !defined (POSIX_SIGNALS)
7499 if (!read_socket_hook
&& NILP (Vwindow_system
))
7501 /* USG systems forget handlers when they are used;
7502 must reestablish each time */
7503 signal (SIGINT
, interrupt_signal
);
7504 signal (SIGQUIT
, interrupt_signal
);
7510 if (!NILP (Vquit_flag
)
7511 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
7513 /* If SIGINT isn't blocked, don't let us be interrupted by
7514 another SIGINT, it might be harmful due to non-reentrancy
7515 in I/O functions. */
7516 sigblock (sigmask (SIGINT
));
7521 #ifdef SIGTSTP /* Support possible in later USG versions */
7523 * On systems which can suspend the current process and return to the original
7524 * shell, this command causes the user to end up back at the shell.
7525 * The "Auto-save" and "Abort" questions are not asked until
7526 * the user elects to return to emacs, at which point he can save the current
7527 * job and either dump core or continue.
7532 if (sys_suspend () == -1)
7534 printf ("Not running as a subprocess;\n");
7535 printf ("you can continue or abort.\n");
7538 /* Perhaps should really fork an inferior shell?
7539 But that would not provide any way to get back
7540 to the original shell, ever. */
7541 printf ("No support for stopping a process on this operating system;\n");
7542 printf ("you can continue or abort.\n");
7543 #endif /* not VMS */
7544 #endif /* not SIGTSTP */
7546 /* We must remain inside the screen area when the internal terminal
7547 is used. Note that [Enter] is not echoed by dos. */
7550 /* It doesn't work to autosave while GC is in progress;
7551 the code used for auto-saving doesn't cope with the mark bit. */
7552 if (!gc_in_progress
)
7554 printf ("Auto-save? (y or n) ");
7556 if (((c
= getchar ()) & ~040) == 'Y')
7558 Fdo_auto_save (Qt
, Qnil
);
7560 printf ("\r\nAuto-save done");
7561 #else /* not MSDOS */
7562 printf ("Auto-save done\n");
7563 #endif /* not MSDOS */
7565 while (c
!= '\n') c
= getchar ();
7569 /* During GC, it must be safe to reenable quitting again. */
7570 Vinhibit_quit
= Qnil
;
7573 #endif /* not MSDOS */
7574 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7575 printf ("but will instead do a real quit after garbage collection ends\r\n");
7580 printf ("\r\nAbort? (y or n) ");
7581 #else /* not MSDOS */
7583 printf ("Abort (and enter debugger)? (y or n) ");
7585 printf ("Abort (and dump core)? (y or n) ");
7586 #endif /* not VMS */
7587 #endif /* not MSDOS */
7589 if (((c
= getchar ()) & ~040) == 'Y')
7591 while (c
!= '\n') c
= getchar ();
7593 printf ("\r\nContinuing...\r\n");
7594 #else /* not MSDOS */
7595 printf ("Continuing...\n");
7596 #endif /* not MSDOS */
7603 /* If executing a function that wants to be interrupted out of
7604 and the user has not deferred quitting by binding `inhibit-quit'
7605 then quit right away. */
7606 if (immediate_quit
&& NILP (Vinhibit_quit
))
7610 Fsignal (Qquit
, Qnil
);
7613 /* Else request quit when it's safe */
7617 if (waiting_for_input
&& !echoing
)
7618 quit_throw_to_read_char ();
7623 /* Handle a C-g by making read_char return C-g. */
7625 quit_throw_to_read_char ()
7627 quit_error_check ();
7629 /* Prevent another signal from doing this before we finish. */
7630 clear_waiting_for_input ();
7633 Vunread_command_events
= Qnil
;
7634 unread_command_char
= -1;
7636 #if 0 /* Currently, sit_for is called from read_char without turning
7637 off polling. And that can call set_waiting_for_input.
7638 It seems to be harmless. */
7639 #ifdef POLL_FOR_INPUT
7640 /* May be > 1 if in recursive minibuffer. */
7641 if (poll_suppress_count
== 0)
7645 if (FRAMEP (internal_last_event_frame
)
7646 && XFRAME (internal_last_event_frame
) != selected_frame
)
7647 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7650 _longjmp (getcjmp
, 1);
7653 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7654 "Set mode of reading keyboard input.\n\
7655 First arg INTERRUPT non-nil means use input interrupts;\n\
7656 nil means use CBREAK mode.\n\
7657 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7658 (no effect except in CBREAK mode).\n\
7659 Third arg META t means accept 8-bit input (for a Meta key).\n\
7660 META nil means ignore the top bit, on the assumption it is parity.\n\
7661 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7662 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7663 See also `current-input-mode'.")
7664 (interrupt
, flow
, meta
, quit
)
7665 Lisp_Object interrupt
, flow
, meta
, quit
;
7668 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7669 error ("set-input-mode: QUIT must be an ASCII character");
7671 #ifdef POLL_FOR_INPUT
7676 /* this causes startup screen to be restored and messes with the mouse */
7681 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7682 if (read_socket_hook
)
7684 /* When using X, don't give the user a real choice,
7685 because we haven't implemented the mechanisms to support it. */
7686 #ifdef NO_SOCK_SIGIO
7687 interrupt_input
= 0;
7688 #else /* not NO_SOCK_SIGIO */
7689 interrupt_input
= 1;
7690 #endif /* NO_SOCK_SIGIO */
7693 interrupt_input
= !NILP (interrupt
);
7694 #else /* not SIGIO */
7695 interrupt_input
= 0;
7696 #endif /* not SIGIO */
7698 /* Our VMS input only works by interrupts, as of now. */
7700 interrupt_input
= 1;
7703 flow_control
= !NILP (flow
);
7706 else if (EQ (meta
, Qt
))
7711 /* Don't let this value be out of range. */
7712 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7718 #ifdef POLL_FOR_INPUT
7719 poll_suppress_count
= 1;
7725 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7726 "Return information about the way Emacs currently reads keyboard input.\n\
7727 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7728 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7729 nil, Emacs is using CBREAK mode.\n\
7730 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7731 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7732 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7733 META nil means ignoring the top bit, on the assumption it is parity.\n\
7734 META is neither t nor nil if accepting 8-bit input and using\n\
7735 all 8 bits as the character code.\n\
7736 QUIT is the character Emacs currently uses to quit.\n\
7737 The elements of this list correspond to the arguments of\n\
7743 val
[0] = interrupt_input
? Qt
: Qnil
;
7744 val
[1] = flow_control
? Qt
: Qnil
;
7745 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7746 XSETFASTINT (val
[3], quit_char
);
7748 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7753 * Set up a new kboard object with reasonable initial values.
7759 kb
->Voverriding_terminal_local_map
= Qnil
;
7760 kb
->Vlast_command
= Qnil
;
7761 kb
->Vprefix_arg
= Qnil
;
7762 kb
->kbd_queue
= Qnil
;
7763 kb
->kbd_queue_has_data
= 0;
7764 kb
->immediate_echo
= 0;
7765 kb
->echoptr
= kb
->echobuf
;
7766 kb
->echo_after_prompt
= -1;
7767 kb
->kbd_macro_buffer
= 0;
7768 kb
->kbd_macro_bufsize
= 0;
7769 kb
->defining_kbd_macro
= Qnil
;
7770 kb
->Vlast_kbd_macro
= Qnil
;
7771 kb
->reference_count
= 0;
7772 kb
->Vsystem_key_alist
= Qnil
;
7773 kb
->system_key_syms
= Qnil
;
7774 kb
->Vdefault_minibuffer_frame
= Qnil
;
7778 * Destroy the contents of a kboard object, but not the object itself.
7779 * We use this just before deleting it, or if we're going to initialize
7786 if (kb
->kbd_macro_buffer
)
7787 xfree (kb
->kbd_macro_buffer
);
7796 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7799 *kbp
= kb
->next_kboard
;
7807 /* This is correct before outermost invocation of the editor loop */
7808 command_loop_level
= -1;
7810 quit_char
= Ctl ('g');
7811 Vunread_command_events
= Qnil
;
7812 unread_command_char
= -1;
7813 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
7815 recent_keys_index
= 0;
7816 kbd_fetch_ptr
= kbd_buffer
;
7817 kbd_store_ptr
= kbd_buffer
;
7818 kbd_buffer_frame_or_window
7819 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7821 do_mouse_tracking
= Qnil
;
7825 /* This means that command_loop_1 won't try to select anything the first
7827 internal_last_event_frame
= Qnil
;
7828 Vlast_event_frame
= internal_last_event_frame
;
7831 current_kboard
= initial_kboard
;
7833 wipe_kboard (current_kboard
);
7834 init_kboard (current_kboard
);
7837 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7839 kbd_buffer_frame_or_window
7840 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7841 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
7843 signal (SIGINT
, interrupt_signal
);
7844 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
7845 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7846 SIGQUIT and we can't tell which one it will give us. */
7847 signal (SIGQUIT
, interrupt_signal
);
7848 #endif /* HAVE_TERMIO */
7850 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7852 if (!noninteractive
)
7853 signal (SIGIO
, input_available_signal
);
7856 /* Use interrupt input by default, if it works and noninterrupt input
7857 has deficiencies. */
7859 #ifdef INTERRUPT_INPUT
7860 interrupt_input
= 1;
7862 interrupt_input
= 0;
7865 /* Our VMS input only works by interrupts, as of now. */
7867 interrupt_input
= 1;
7873 if (keyboard_init_hook
)
7874 (*keyboard_init_hook
) ();
7876 #ifdef POLL_FOR_INPUT
7877 poll_suppress_count
= 1;
7882 /* This type's only use is in syms_of_keyboard, to initialize the
7883 event header symbols and put properties on them. */
7890 struct event_head head_table
[] = {
7891 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
7892 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
7893 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
7894 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
7895 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
7896 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
7901 Qtimer_event_handler
= intern ("timer-event-handler");
7902 staticpro (&Qtimer_event_handler
);
7904 Qdisabled_command_hook
= intern ("disabled-command-hook");
7905 staticpro (&Qdisabled_command_hook
);
7907 Qself_insert_command
= intern ("self-insert-command");
7908 staticpro (&Qself_insert_command
);
7910 Qforward_char
= intern ("forward-char");
7911 staticpro (&Qforward_char
);
7913 Qbackward_char
= intern ("backward-char");
7914 staticpro (&Qbackward_char
);
7916 Qdisabled
= intern ("disabled");
7917 staticpro (&Qdisabled
);
7919 Qundefined
= intern ("undefined");
7920 staticpro (&Qundefined
);
7922 Qpre_command_hook
= intern ("pre-command-hook");
7923 staticpro (&Qpre_command_hook
);
7925 Qpost_command_hook
= intern ("post-command-hook");
7926 staticpro (&Qpost_command_hook
);
7928 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
7929 staticpro (&Qpost_command_idle_hook
);
7931 Qdeferred_action_function
= intern ("deferred-action-function");
7932 staticpro (&Qdeferred_action_function
);
7934 Qcommand_hook_internal
= intern ("command-hook-internal");
7935 staticpro (&Qcommand_hook_internal
);
7937 Qfunction_key
= intern ("function-key");
7938 staticpro (&Qfunction_key
);
7939 Qmouse_click
= intern ("mouse-click");
7940 staticpro (&Qmouse_click
);
7942 Qmenu_enable
= intern ("menu-enable");
7943 staticpro (&Qmenu_enable
);
7945 Qmode_line
= intern ("mode-line");
7946 staticpro (&Qmode_line
);
7947 Qvertical_line
= intern ("vertical-line");
7948 staticpro (&Qvertical_line
);
7949 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
7950 staticpro (&Qvertical_scroll_bar
);
7951 Qmenu_bar
= intern ("menu-bar");
7952 staticpro (&Qmenu_bar
);
7954 Qabove_handle
= intern ("above-handle");
7955 staticpro (&Qabove_handle
);
7956 Qhandle
= intern ("handle");
7957 staticpro (&Qhandle
);
7958 Qbelow_handle
= intern ("below-handle");
7959 staticpro (&Qbelow_handle
);
7960 Qup
= intern ("up");
7962 Qdown
= intern ("down");
7965 Qevent_kind
= intern ("event-kind");
7966 staticpro (&Qevent_kind
);
7967 Qevent_symbol_elements
= intern ("event-symbol-elements");
7968 staticpro (&Qevent_symbol_elements
);
7969 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
7970 staticpro (&Qevent_symbol_element_mask
);
7971 Qmodifier_cache
= intern ("modifier-cache");
7972 staticpro (&Qmodifier_cache
);
7974 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
7975 staticpro (&Qrecompute_lucid_menubar
);
7976 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
7977 staticpro (&Qactivate_menubar_hook
);
7979 Qpolling_period
= intern ("polling-period");
7980 staticpro (&Qpolling_period
);
7983 struct event_head
*p
;
7985 for (p
= head_table
;
7986 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
7989 *p
->var
= intern (p
->name
);
7991 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
7992 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
7996 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
7997 staticpro (&button_down_location
);
8001 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
8003 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
8004 for (i
= 0; i
< len
; i
++)
8005 if (modifier_names
[i
])
8006 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
8007 staticpro (&modifier_symbols
);
8010 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
8011 staticpro (&recent_keys
);
8013 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
8014 staticpro (&this_command_keys
);
8016 Qextended_command_history
= intern ("extended-command-history");
8017 Fset (Qextended_command_history
, Qnil
);
8018 staticpro (&Qextended_command_history
);
8020 kbd_buffer_frame_or_window
8021 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8022 staticpro (&kbd_buffer_frame_or_window
);
8024 accent_key_syms
= Qnil
;
8025 staticpro (&accent_key_syms
);
8027 func_key_syms
= Qnil
;
8028 staticpro (&func_key_syms
);
8031 staticpro (&mouse_syms
);
8033 unread_switch_frame
= Qnil
;
8034 staticpro (&unread_switch_frame
);
8036 internal_last_event_frame
= Qnil
;
8037 staticpro (&internal_last_event_frame
);
8039 read_key_sequence_cmd
= Qnil
;
8040 staticpro (&read_key_sequence_cmd
);
8042 defsubr (&Sevent_convert_list
);
8043 defsubr (&Sread_key_sequence
);
8044 defsubr (&Srecursive_edit
);
8046 defsubr (&Strack_mouse
);
8048 defsubr (&Sinput_pending_p
);
8049 defsubr (&Scommand_execute
);
8050 defsubr (&Srecent_keys
);
8051 defsubr (&Sthis_command_keys
);
8052 defsubr (&Sthis_single_command_keys
);
8053 defsubr (&Sreset_this_command_lengths
);
8054 defsubr (&Ssuspend_emacs
);
8055 defsubr (&Sabort_recursive_edit
);
8056 defsubr (&Sexit_recursive_edit
);
8057 defsubr (&Srecursion_depth
);
8058 defsubr (&Stop_level
);
8059 defsubr (&Sdiscard_input
);
8060 defsubr (&Sopen_dribble_file
);
8061 defsubr (&Sset_input_mode
);
8062 defsubr (&Scurrent_input_mode
);
8063 defsubr (&Sexecute_extended_command
);
8065 DEFVAR_LISP ("last-command-char", &last_command_char
,
8066 "Last input event that was part of a command.");
8068 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
8069 "Last input event that was part of a command.");
8071 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
8072 "Last input event in a command, except for mouse menu events.\n\
8073 Mouse menus give back keys that don't look like mouse events;\n\
8074 this variable holds the actual mouse event that led to the menu,\n\
8075 so that you can determine whether the command was run by mouse or not.");
8077 DEFVAR_LISP ("last-input-char", &last_input_char
,
8078 "Last input event.");
8080 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
8081 "Last input event.");
8083 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
8084 "List of objects to be read as next command input events.");
8086 DEFVAR_INT ("unread-command-char", &unread_command_char
,
8087 "If not -1, an object to be read as next command input event.");
8089 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
8090 "Meta-prefix character code. Meta-foo as command input\n\
8091 turns into this character followed by foo.");
8092 XSETINT (meta_prefix_char
, 033);
8094 DEFVAR_KBOARD ("last-command", Vlast_command
,
8095 "The last command executed. Normally a symbol with a function definition,\n\
8096 but can be whatever was found in the keymap, or whatever the variable\n\
8097 `this-command' was set to by that command.\n\
8099 The value `mode-exit' is special; it means that the previous command\n\
8100 read an event that told it to exit, and it did so and unread that event.\n\
8101 In other words, the present command is the event that made the previous\n\
8104 The value `kill-region' is special; it means that the previous command\n\
8105 was a kill command.");
8107 DEFVAR_LISP ("this-command", &this_command
,
8108 "The command now being executed.\n\
8109 The command can set this variable; whatever is put here\n\
8110 will be in `last-command' during the following command.");
8111 this_command
= Qnil
;
8113 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8114 "*Number of keyboard input characters between auto-saves.\n\
8115 Zero means disable autosaving due to number of characters typed.");
8116 auto_save_interval
= 300;
8118 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8119 "*Number of seconds idle time before auto-save.\n\
8120 Zero or nil means disable auto-saving due to idleness.\n\
8121 After auto-saving due to this many seconds of idle time,\n\
8122 Emacs also does a garbage collection if that seems to be warranted.");
8123 XSETFASTINT (Vauto_save_timeout
, 30);
8125 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8126 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8127 echo_keystrokes
= 1;
8129 DEFVAR_INT ("polling-period", &polling_period
,
8130 "*Interval between polling for input during Lisp execution.\n\
8131 The reason for polling is to make C-g work to stop a running program.\n\
8132 Polling is needed only when using X windows and SIGIO does not work.\n\
8133 Polling is automatically disabled in all other cases.");
8136 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8137 "*Maximum time between mouse clicks to make a double-click.\n\
8138 Measured in milliseconds. nil means disable double-click recognition;\n\
8139 t means double-clicks have no time limit and are detected\n\
8140 by position only.");
8141 Vdouble_click_time
= make_number (500);
8143 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8144 "*Non-nil means inhibit local map menu bar menus.");
8145 inhibit_local_menu_bar_menus
= 0;
8147 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8148 "Number of complete key sequences read as input so far.\n\
8149 This includes key sequences read from keyboard macros.\n\
8150 The number is effectively the number of interactive command invocations.");
8153 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
8154 "Number of input events read from the keyboard so far.\n\
8155 This does not include events generated by keyboard macros.");
8156 num_nonmacro_input_events
= 0;
8158 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8159 "The frame in which the most recently read event occurred.\n\
8160 If the last event came from a keyboard macro, this is set to `macro'.");
8161 Vlast_event_frame
= Qnil
;
8163 /* This variable is set up in sysdep.c. */
8164 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
8165 "The ERASE character as set by the user with stty.");
8167 DEFVAR_LISP ("help-char", &Vhelp_char
,
8168 "Character to recognize as meaning Help.\n\
8169 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8170 If the value of `help-form' is nil, this char can be read normally.");
8171 XSETINT (Vhelp_char
, Ctl ('H'));
8173 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8174 "List of input events to recognize as meaning Help.\n\
8175 These work just like the value of `help-char' (see that).");
8176 Vhelp_event_list
= Qnil
;
8178 DEFVAR_LISP ("help-form", &Vhelp_form
,
8179 "Form to execute when character `help-char' is read.\n\
8180 If the form returns a string, that string is displayed.\n\
8181 If `help-form' is nil, the help char is not recognized.");
8184 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8185 "Command to run when `help-char' character follows a prefix key.\n\
8186 This command is used only when there is no actual binding\n\
8187 for that character after that prefix key.");
8188 Vprefix_help_command
= Qnil
;
8190 DEFVAR_LISP ("top-level", &Vtop_level
,
8191 "Form to evaluate when Emacs starts up.\n\
8192 Useful to set before you dump a modified Emacs.");
8195 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8196 "Translate table for keyboard input, or nil.\n\
8197 Each character is looked up in this string and the contents used instead.\n\
8198 The value may be a string, a vector, or a char-table.\n\
8199 If it is a string or vector of length N,\n\
8200 character codes N and up are untranslated.\n\
8201 In a vector or a char-table, an element which is nil means \"no translation\".");
8202 Vkeyboard_translate_table
= Qnil
;
8204 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8205 "Non-nil means to always spawn a subshell instead of suspending,\n\
8206 even if the operating system has support for stopping a process.");
8209 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8210 "Non-nil means prompt with menus when appropriate.\n\
8211 This is done when reading from a keymap that has a prompt string,\n\
8212 for elements that have prompt strings.\n\
8213 The menu is displayed on the screen\n\
8214 if X menus were enabled at configuration\n\
8215 time and the previous event was a mouse click prefix key.\n\
8216 Otherwise, menu prompting uses the echo area.");
8219 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8220 "Character to see next line of menu prompt.\n\
8221 Type this character while in a menu prompt to rotate around the lines of it.");
8222 XSETINT (menu_prompt_more_char
, ' ');
8224 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8225 "A mask of additional modifier keys to use with every keyboard character.\n\
8226 Emacs applies the modifiers of the character stored here to each keyboard\n\
8227 character it reads. For example, after evaluating the expression\n\
8228 (setq extra-keyboard-modifiers ?\\C-x)\n\
8229 all input characters will have the control modifier applied to them.\n\
8231 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8232 not count as a control character; rather, it counts as a character\n\
8233 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8234 cancels any modification.");
8235 extra_keyboard_modifiers
= 0;
8237 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8238 "If an editing command sets this to t, deactivate the mark afterward.\n\
8239 The command loop sets this to nil before each command,\n\
8240 and tests the value when the command returns.\n\
8241 Buffer modification stores t in this variable.");
8242 Vdeactivate_mark
= Qnil
;
8244 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8245 "Temporary storage of pre-command-hook or post-command-hook.");
8246 Vcommand_hook_internal
= Qnil
;
8248 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8249 "Normal hook run before each command is executed.\n\
8250 Errors running the hook are caught and ignored.");
8251 Vpre_command_hook
= Qnil
;
8253 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8254 "Normal hook run after each command is executed.\n\
8255 Errors running the hook are caught and ignored.");
8256 Vpost_command_hook
= Qnil
;
8258 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8259 "Normal hook run after each command is executed, if idle.\n\
8260 Errors running the hook are caught and ignored.\n\
8261 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
8262 Vpost_command_idle_hook
= Qnil
;
8264 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
8265 "Delay time before running `post-command-idle-hook'.\n\
8266 This is measured in microseconds.");
8267 post_command_idle_delay
= 100000;
8270 DEFVAR_LISP ("echo-area-clear-hook", ...,
8271 "Normal hook run when clearing the echo area.");
8273 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
8274 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
8276 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
8277 "t means menu bar, specified Lucid style, needs to be recomputed.");
8278 Vlucid_menu_bar_dirty_flag
= Qnil
;
8280 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
8281 "List of menu bar items to move to the end of the menu bar.\n\
8282 The elements of the list are event types that may have menu bar bindings.");
8283 Vmenu_bar_final_items
= Qnil
;
8285 DEFVAR_KBOARD ("overriding-terminal-local-map",
8286 Voverriding_terminal_local_map
,
8287 "Per-terminal keymap that overrides all other local keymaps.\n\
8288 If this variable is non-nil, it is used as a keymap instead of the\n\
8289 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
8290 This variable is intended to let commands such as `universal-argumemnt'\n\
8291 set up a different keymap for reading the next command.");
8293 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
8294 "Keymap that overrides all other local keymaps.\n\
8295 If this variable is non-nil, it is used as a keymap instead of the\n\
8296 buffer's local map, and the minor mode keymaps and text property keymaps.");
8297 Voverriding_local_map
= Qnil
;
8299 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
8300 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8301 Otherwise, the menu bar continues to reflect the buffer's local map\n\
8302 and the minor mode maps regardless of `overriding-local-map'.");
8303 Voverriding_local_map_menu_flag
= Qnil
;
8305 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
8306 "Keymap defining bindings for special events to execute at low level.");
8307 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
8309 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
8310 "*Non-nil means generate motion events for mouse motion.");
8312 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
8313 "Alist of system-specific X windows key symbols.\n\
8314 Each element should have the form (N . SYMBOL) where N is the\n\
8315 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
8316 and SYMBOL is its name.");
8318 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
8319 "List of deferred actions to be performed at a later time.\n\
8320 The precise format isn't relevant here; we just check whether it is nil.");
8321 Vdeferred_action_list
= Qnil
;
8323 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
8324 "Function to call to handle deferred actions, after each command.\n\
8325 This function is called with no arguments after each command\n\
8326 whenever `deferred-action-list' is non-nil.");
8327 Vdeferred_action_function
= Qnil
;
8329 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
8330 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8331 The value can be a length of time to show the message for.\n\
8332 If the value is non-nil and not a number, we wait 2 seconds.");
8333 Vsuggest_key_bindings
= Qt
;
8335 DEFVAR_LISP ("timer-list", &Vtimer_list
,
8336 "List of active absolute time timers in order of increasing time");
8339 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
8340 "List of active idle-time timers in order of increasing time");
8341 Vtimer_idle_list
= Qnil
;
8346 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
8347 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
8348 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
8349 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
8350 initial_define_key (meta_map
, 'x', "execute-extended-command");
8352 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
8353 "handle-delete-frame");
8354 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
8356 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",