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
;
448 Lisp_Object Qmouse_wheel
;
450 /* Lisp_Object Qmouse_movement; - also an event header */
452 /* Properties of event headers. */
453 Lisp_Object Qevent_kind
;
454 Lisp_Object Qevent_symbol_elements
;
456 Lisp_Object Qmenu_enable
;
458 /* An event header symbol HEAD may have a property named
459 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
460 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
461 mask of modifiers applied to it. If present, this is used to help
462 speed up parse_modifiers. */
463 Lisp_Object Qevent_symbol_element_mask
;
465 /* An unmodified event header BASE may have a property named
466 Qmodifier_cache, which is an alist mapping modifier masks onto
467 modified versions of BASE. If present, this helps speed up
469 Lisp_Object Qmodifier_cache
;
471 /* Symbols to use for parts of windows. */
472 Lisp_Object Qmode_line
;
473 Lisp_Object Qvertical_line
;
474 Lisp_Object Qvertical_scroll_bar
;
475 Lisp_Object Qmenu_bar
;
477 extern Lisp_Object Qmenu_enable
;
479 Lisp_Object
recursive_edit_unwind (), command_loop ();
480 Lisp_Object
Fthis_command_keys ();
481 Lisp_Object Qextended_command_history
;
482 EMACS_TIME
timer_check ();
484 extern char *x_get_keysym_name ();
486 static void record_menu_key ();
488 void swallow_events ();
490 Lisp_Object Qpolling_period
;
492 /* List of absolute timers. Appears in order of next scheduled event. */
493 Lisp_Object Vtimer_list
;
495 /* List of idle time timers. Appears in order of next scheduled event. */
496 Lisp_Object Vtimer_idle_list
;
498 /* Incremented whenever a timer is run. */
501 extern Lisp_Object Vprint_level
, Vprint_length
;
503 extern nonascii_insert_offset
;
505 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
507 EMACS_TIME
*input_available_clear_time
;
509 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
510 Default is 1 if INTERRUPT_INPUT is defined. */
513 /* Nonzero while interrupts are temporarily deferred during redisplay. */
514 int interrupts_deferred
;
516 /* Nonzero means use ^S/^Q for flow control. */
519 /* Allow m- file to inhibit use of FIONREAD. */
520 #ifdef BROKEN_FIONREAD
524 /* We are unable to use interrupts if FIONREAD is not available,
525 so flush SIGIO so we won't try. */
532 /* If we support a window system, turn on the code to poll periodically
533 to detect C-g. It isn't actually used when doing interrupt input. */
534 #ifdef HAVE_WINDOW_SYSTEM
535 #define POLL_FOR_INPUT
538 /* Global variable declarations. */
540 /* Function for init_keyboard to call with no args (if nonzero). */
541 void (*keyboard_init_hook
) ();
543 static int read_avail_input ();
544 static void get_input_pending ();
545 static int readable_events ();
546 static Lisp_Object
read_char_x_menu_prompt ();
547 static Lisp_Object
read_char_minibuf_menu_prompt ();
548 static Lisp_Object
make_lispy_event ();
550 static Lisp_Object
make_lispy_movement ();
552 static Lisp_Object
modify_event_symbol ();
553 static Lisp_Object
make_lispy_switch_frame ();
554 static int parse_solitary_modifier ();
556 /* > 0 if we are to echo keystrokes. */
557 static int echo_keystrokes
;
559 /* Nonzero means don't try to suspend even if the operating system seems
561 static int cannot_suspend
;
563 #define min(a,b) ((a)<(b)?(a):(b))
564 #define max(a,b) ((a)>(b)?(a):(b))
566 /* Install the string STR as the beginning of the string of echoing,
567 so that it serves as a prompt for the next character.
568 Also start echoing. */
573 int len
= strlen (str
);
575 if (len
> ECHOBUFSIZE
- 4)
576 len
= ECHOBUFSIZE
- 4;
577 bcopy (str
, current_kboard
->echobuf
, len
);
578 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
579 *current_kboard
->echoptr
= '\0';
581 current_kboard
->echo_after_prompt
= len
;
586 /* Add C to the echo string, if echoing is going on.
587 C can be a character, which is printed prettily ("M-C-x" and all that
588 jazz), or a symbol, whose name is printed. */
593 extern char *push_key_description ();
595 if (current_kboard
->immediate_echo
)
597 char *ptr
= current_kboard
->echoptr
;
599 if (ptr
!= current_kboard
->echobuf
)
602 /* If someone has passed us a composite event, use its head symbol. */
607 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
610 ptr
= push_key_description (XINT (c
), ptr
);
612 else if (SYMBOLP (c
))
614 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
615 if ((ptr
- current_kboard
->echobuf
) + name
->size
+ 4 > ECHOBUFSIZE
)
617 bcopy (name
->data
, ptr
, name
->size
);
621 if (current_kboard
->echoptr
== current_kboard
->echobuf
624 strcpy (ptr
, " (Type ? for further options)");
629 current_kboard
->echoptr
= ptr
;
635 /* Temporarily add a dash to the end of the echo string if it's not
636 empty, so that it serves as a mini-prompt for the very next character. */
640 if (!current_kboard
->immediate_echo
641 && current_kboard
->echoptr
== current_kboard
->echobuf
)
643 /* Do nothing if we just printed a prompt. */
644 if (current_kboard
->echo_after_prompt
645 == current_kboard
->echoptr
- current_kboard
->echobuf
)
647 /* Do nothing if not echoing at all. */
648 if (current_kboard
->echoptr
== 0)
651 /* Put a dash at the end of the buffer temporarily,
652 but make it go away when the next character is added. */
653 current_kboard
->echoptr
[0] = '-';
654 current_kboard
->echoptr
[1] = 0;
659 /* Display the current echo string, and begin echoing if not already
665 if (!current_kboard
->immediate_echo
)
668 current_kboard
->immediate_echo
= 1;
670 for (i
= 0; i
< this_command_key_count
; i
++)
673 c
= XVECTOR (this_command_keys
)->contents
[i
];
674 if (! (EVENT_HAS_PARAMETERS (c
)
675 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
682 message1_nolog (current_kboard
->echobuf
);
685 if (waiting_for_input
&& !NILP (Vquit_flag
))
686 quit_throw_to_read_char ();
689 /* Turn off echoing, for the start of a new command. */
693 current_kboard
->immediate_echo
= 0;
694 current_kboard
->echoptr
= current_kboard
->echobuf
;
695 current_kboard
->echo_after_prompt
= -1;
696 ok_to_echo_at_next_pause
= 0;
699 /* Return the length of the current echo string. */
704 return current_kboard
->echoptr
- current_kboard
->echobuf
;
707 /* Truncate the current echo message to its first LEN chars.
708 This and echo_char get used by read_key_sequence when the user
709 switches frames while entering a key sequence. */
715 current_kboard
->echobuf
[len
] = '\0';
716 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
717 truncate_echo_area (len
);
721 /* Functions for manipulating this_command_keys. */
723 add_command_key (key
)
726 int size
= XVECTOR (this_command_keys
)->size
;
728 /* If reset-this-command-length was called recently, obey it now.
729 See the doc string of that function for an explanation of why. */
730 if (before_command_restore_flag
)
732 this_command_key_count
= before_command_key_count_1
;
733 if (this_command_key_count
< this_single_command_key_start
)
734 this_single_command_key_start
= this_command_key_count
;
735 echo_truncate (before_command_echo_length_1
);
736 before_command_restore_flag
= 0;
739 if (this_command_key_count
>= size
)
741 Lisp_Object new_keys
;
743 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
744 bcopy (XVECTOR (this_command_keys
)->contents
,
745 XVECTOR (new_keys
)->contents
,
746 size
* sizeof (Lisp_Object
));
748 this_command_keys
= new_keys
;
751 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
757 int count
= specpdl_ptr
- specpdl
;
760 if (command_loop_level
> 0)
762 specbind (Qstandard_output
, Qt
);
763 specbind (Qstandard_input
, Qt
);
766 val
= command_loop ();
768 Fsignal (Qquit
, Qnil
);
769 /* Handle throw from read_minibuf when using minibuffer
770 while it's active but we're in another window. */
772 Fsignal (Qerror
, Fcons (val
, Qnil
));
774 return unbind_to (count
, Qnil
);
777 /* When an auto-save happens, record the "time", and don't do again soon. */
782 last_auto_save
= num_nonmacro_input_events
;
785 /* Make an auto save happen as soon as possible at command level. */
787 force_auto_save_soon ()
789 last_auto_save
= - auto_save_interval
- 1;
791 record_asynch_buffer_change ();
794 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
795 "Invoke the editor command loop recursively.\n\
796 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
797 that tells this function to return.\n\
798 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
799 This function is called by the editor initialization to begin editing.")
802 int count
= specpdl_ptr
- specpdl
;
805 command_loop_level
++;
806 update_mode_lines
= 1;
808 record_unwind_protect (recursive_edit_unwind
,
810 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
814 return unbind_to (count
, Qnil
);
818 recursive_edit_unwind (buffer
)
822 Fset_buffer (buffer
);
824 command_loop_level
--;
825 update_mode_lines
= 1;
833 #if 0 /* Theory: if there's anything in Vunread_command_events,
834 it will right away be read by read_key_sequence,
835 and then if we do switch KBOARDS, it will go into the side
836 queue then. So we don't need to do anything special here -- rms. */
837 if (CONSP (Vunread_command_events
))
839 current_kboard
->kbd_queue
840 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
841 current_kboard
->kbd_queue_has_data
= 1;
843 Vunread_command_events
= Qnil
;
849 /* Switch to the single-kboard state, making current_kboard
850 the only KBOARD from which further input is accepted. */
853 single_kboard_state ()
860 /* Maintain a stack of kboards, so other parts of Emacs
861 can switch temporarily to the kboard of a given frame
862 and then revert to the previous status. */
867 struct kboard_stack
*next
;
870 static struct kboard_stack
*kboard_stack
;
873 push_frame_kboard (f
)
877 struct kboard_stack
*p
878 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
880 p
->next
= kboard_stack
;
881 p
->kboard
= current_kboard
;
884 current_kboard
= FRAME_KBOARD (f
);
892 struct kboard_stack
*p
= kboard_stack
;
893 current_kboard
= p
->kboard
;
894 kboard_stack
= p
->next
;
899 /* Handle errors that are not handled at inner levels
900 by printing an error message and returning to the editor command loop. */
906 Lisp_Object old_level
, old_length
;
909 if (!NILP (executing_macro
))
911 if (executing_macro_iterations
== 1)
912 sprintf (macroerror
, "After 1 kbd macro iteration: ");
914 sprintf (macroerror
, "After %d kbd macro iterations: ",
915 executing_macro_iterations
);
920 Vstandard_output
= Qt
;
921 Vstandard_input
= Qt
;
922 Vexecuting_macro
= Qnil
;
923 executing_macro
= Qnil
;
924 current_kboard
->Vprefix_arg
= Qnil
;
927 /* Avoid unquittable loop if data contains a circular list. */
928 old_level
= Vprint_level
;
929 old_length
= Vprint_length
;
930 XSETFASTINT (Vprint_level
, 10);
931 XSETFASTINT (Vprint_length
, 10);
932 cmd_error_internal (data
, macroerror
);
933 Vprint_level
= old_level
;
934 Vprint_length
= old_length
;
938 Vinhibit_quit
= Qnil
;
943 return make_number (0);
947 cmd_error_internal (data
, context
)
955 echo_area_glyphs
= 0;
957 /* If the window system or terminal frame hasn't been initialized
958 yet, or we're not interactive, it's best to dump this message out
959 to stderr and exit. */
960 if (! FRAME_MESSAGE_BUF (selected_frame
)
962 stream
= Qexternal_debugging_output
;
971 write_string_1 (context
, -1, stream
);
973 print_error_message (data
, stream
);
975 /* If the window system or terminal frame hasn't been initialized
976 yet, or we're in -batch mode, this error should cause Emacs to exit. */
977 if (! FRAME_MESSAGE_BUF (selected_frame
)
981 Fkill_emacs (make_number (-1));
985 Lisp_Object
command_loop_1 ();
986 Lisp_Object
command_loop_2 ();
987 Lisp_Object
top_level_1 ();
989 /* Entry to editor-command-loop.
990 This level has the catches for exiting/returning to editor command loop.
991 It returns nil to exit recursive edit, t to abort it. */
996 if (command_loop_level
> 0 || minibuf_level
> 0)
998 return internal_catch (Qexit
, command_loop_2
, Qnil
);
1003 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1004 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1006 /* End of file in -batch run causes exit here. */
1012 /* Here we catch errors in execution of commands within the
1013 editing loop, and reenter the editing loop.
1014 When there is an error, cmd_error runs and returns a non-nil
1015 value to us. A value of nil means that cmd_loop_1 itself
1016 returned due to end of file (or end of kbd macro). */
1021 register Lisp_Object val
;
1024 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1025 while (!NILP (val
));
1033 return Feval (Vtop_level
);
1039 /* On entry to the outer level, run the startup file */
1040 if (!NILP (Vtop_level
))
1041 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1042 else if (!NILP (Vpurify_flag
))
1043 message ("Bare impure Emacs (standard Lisp code not loaded)");
1045 message ("Bare Emacs (standard Lisp code not loaded)");
1049 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1050 "Exit all recursive editing levels.")
1053 Fthrow (Qtop_level
, Qnil
);
1056 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1057 "Exit from the innermost recursive edit or minibuffer.")
1060 if (command_loop_level
> 0 || minibuf_level
> 0)
1061 Fthrow (Qexit
, Qnil
);
1063 error ("No recursive edit is in progress");
1066 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1067 "Abort the command that requested this recursive edit or minibuffer input.")
1070 if (command_loop_level
> 0 || minibuf_level
> 0)
1073 error ("No recursive edit is in progress");
1076 /* This is the actual command reading loop,
1077 sans error-handling encapsulation. */
1079 Lisp_Object
Fcommand_execute ();
1080 static int read_key_sequence ();
1081 void safe_run_hooks ();
1086 Lisp_Object cmd
, tem
;
1089 Lisp_Object keybuf
[30];
1094 struct buffer
*prev_buffer
;
1096 int was_locked
= single_kboard
;
1099 current_kboard
->Vprefix_arg
= Qnil
;
1100 Vdeactivate_mark
= Qnil
;
1101 waiting_for_input
= 0;
1106 this_command_key_count
= 0;
1107 this_single_command_key_start
= 0;
1109 /* Make sure this hook runs after commands that get errors and
1110 throw to top level. */
1111 /* Note that the value cell will never directly contain nil
1112 if the symbol is a local variable. */
1113 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1114 safe_run_hooks (Qpost_command_hook
);
1116 if (!NILP (Vdeferred_action_list
))
1117 call0 (Vdeferred_action_function
);
1119 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1121 if (NILP (Vunread_command_events
)
1122 && NILP (Vexecuting_macro
)
1123 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1124 safe_run_hooks (Qpost_command_idle_hook
);
1127 /* Do this after running Vpost_command_hook, for consistency. */
1128 current_kboard
->Vlast_command
= this_command
;
1132 /* Make sure the current window's buffer is selected. */
1133 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1134 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1136 /* Display any malloc warning that just came out. Use while because
1137 displaying one warning can cause another. */
1139 while (pending_malloc_warning
)
1140 display_malloc_warning ();
1144 Vdeactivate_mark
= Qnil
;
1146 /* If minibuffer on and echo area in use,
1147 wait 2 sec and redraw minibuffer. */
1149 if (minibuf_level
&& echo_area_glyphs
1150 && EQ (minibuf_window
, echo_area_window
))
1152 /* Bind inhibit-quit to t so that C-g gets read in
1153 rather than quitting back to the minibuffer. */
1154 int count
= specpdl_ptr
- specpdl
;
1155 specbind (Qinhibit_quit
, Qt
);
1157 Fsit_for (make_number (2), Qnil
, Qnil
);
1158 /* Clear the echo area. */
1160 safe_run_hooks (Qecho_area_clear_hook
);
1162 unbind_to (count
, Qnil
);
1164 /* If a C-g came in before, treat it as input now. */
1165 if (!NILP (Vquit_flag
))
1168 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1173 alloca (0); /* Cause a garbage collection now */
1174 /* Since we can free the most stuff here. */
1175 #endif /* C_ALLOCA */
1178 /* Select the frame that the last event came from. Usually,
1179 switch-frame events will take care of this, but if some lisp
1180 code swallows a switch-frame event, we'll fix things up here.
1181 Is this a good idea? */
1182 if (FRAMEP (internal_last_event_frame
)
1183 && XFRAME (internal_last_event_frame
) != selected_frame
)
1184 Fselect_frame (internal_last_event_frame
, Qnil
);
1186 /* If it has changed current-menubar from previous value,
1187 really recompute the menubar from the value. */
1188 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1189 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1190 call0 (Qrecompute_lucid_menubar
);
1192 before_command_key_count
= this_command_key_count
;
1193 before_command_echo_length
= echo_length ();
1195 this_command
= Qnil
;
1197 /* Read next key sequence; i gets its length. */
1198 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1201 /* A filter may have run while we were reading the input. */
1202 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1203 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1207 /* Now we have read a key sequence of length I,
1208 or else I is 0 and we found end of file. */
1210 if (i
== 0) /* End of file -- happens only in */
1211 return Qnil
; /* a kbd macro, at the end. */
1212 /* -1 means read_key_sequence got a menu that was rejected.
1213 Just loop around and read another command. */
1217 this_command_key_count
= 0;
1218 this_single_command_key_start
= 0;
1222 last_command_char
= keybuf
[i
- 1];
1224 /* If the previous command tried to force a specific window-start,
1225 forget about that, in case this command moves point far away
1226 from that position. But also throw away beg_unchanged and
1227 end_unchanged information in that case, so that redisplay will
1228 update the whole window properly. */
1229 if (!NILP (XWINDOW (selected_window
)->force_start
))
1231 XWINDOW (selected_window
)->force_start
= Qnil
;
1232 beg_unchanged
= end_unchanged
= 0;
1235 cmd
= read_key_sequence_cmd
;
1236 if (!NILP (Vexecuting_macro
))
1238 if (!NILP (Vquit_flag
))
1240 Vexecuting_macro
= Qt
;
1241 QUIT
; /* Make some noise. */
1242 /* Will return since macro now empty. */
1246 /* Do redisplay processing after this command except in special
1247 cases identified below that set no_redisplay to 1.
1248 (actually, there's currently no way to prevent the redisplay,
1249 and no_redisplay is ignored.
1250 Perhaps someday we will really implement it.) */
1253 prev_buffer
= current_buffer
;
1254 prev_modiff
= MODIFF
;
1255 last_point_position
= PT
;
1256 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1258 /* Execute the command. */
1261 /* Note that the value cell will never directly contain nil
1262 if the symbol is a local variable. */
1263 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1264 safe_run_hooks (Qpre_command_hook
);
1266 if (NILP (this_command
))
1268 /* nil means key is undefined. */
1270 current_kboard
->defining_kbd_macro
= Qnil
;
1271 update_mode_lines
= 1;
1272 current_kboard
->Vprefix_arg
= Qnil
;
1276 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1278 /* Recognize some common commands in common situations and
1279 do them directly. */
1280 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1282 struct Lisp_Char_Table
*dp
1283 = window_display_table (XWINDOW (selected_window
));
1284 lose
= FETCH_BYTE (PT
);
1285 SET_PT (forward_point (1));
1287 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1288 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1289 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1290 && (lose
>= 0x20 && lose
< 0x7f)))
1291 : (lose
>= 0x20 && lose
< 0x7f))
1292 /* To extract the case of continuation on
1293 wide-column characters. */
1294 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT
)) == 1)
1295 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1297 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1299 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1301 && !windows_or_buffers_changed
1302 && EQ (current_buffer
->selective_display
, Qnil
)
1303 && !detect_input_pending ()
1304 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1305 && NILP (Vexecuting_macro
))
1306 no_redisplay
= direct_output_forward_char (1);
1309 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1311 struct Lisp_Char_Table
*dp
1312 = window_display_table (XWINDOW (selected_window
));
1313 SET_PT (forward_point (-1));
1314 lose
= FETCH_BYTE (PT
);
1316 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1317 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1318 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1319 && (lose
>= 0x20 && lose
< 0x7f)))
1320 : (lose
>= 0x20 && lose
< 0x7f))
1321 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1323 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1325 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1327 && !windows_or_buffers_changed
1328 && EQ (current_buffer
->selective_display
, Qnil
)
1329 && !detect_input_pending ()
1330 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1331 && NILP (Vexecuting_macro
))
1332 no_redisplay
= direct_output_forward_char (-1);
1335 else if (EQ (this_command
, Qself_insert_command
)
1336 /* Try this optimization only on ascii keystrokes. */
1337 && INTEGERP (last_command_char
))
1339 unsigned int c
= XINT (last_command_char
);
1342 if (NILP (Vexecuting_macro
)
1343 && !EQ (minibuf_window
, selected_window
))
1345 if (!nonundocount
|| nonundocount
>= 20)
1352 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1354 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1356 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1358 || MODIFF
<= SAVE_MODIFF
1359 || windows_or_buffers_changed
1360 || !EQ (current_buffer
->selective_display
, Qnil
)
1361 || detect_input_pending ()
1362 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1363 || !NILP (Vexecuting_macro
));
1364 value
= internal_self_insert (c
, 0);
1371 && (PT
== ZV
|| FETCH_BYTE (PT
) == '\n'))
1373 struct Lisp_Char_Table
*dp
1374 = window_display_table (XWINDOW (selected_window
));
1377 /* Add the offset to the character, for Finsert_char.
1378 We pass internal_self_insert the unmodified character
1379 because it itself does this offsetting. */
1380 if (lose
>= 0200 && lose
<= 0377
1381 && ! NILP (current_buffer
->enable_multibyte_characters
))
1382 lose
+= nonascii_insert_offset
;
1388 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1391 /* Do it only for char codes
1392 that by default display as themselves. */
1393 if (lose
>= 0x20 && lose
<= 0x7e)
1394 no_redisplay
= direct_output_for_insert (lose
);
1396 else if (VECTORP (obj
)
1397 && XVECTOR (obj
)->size
== 1
1398 && (obj
= XVECTOR (obj
)->contents
[0],
1400 /* Insist face not specified in glyph. */
1401 && (XINT (obj
) & ((-1) << 8)) == 0)
1403 = direct_output_for_insert (XINT (obj
));
1407 if (lose
>= 0x20 && lose
<= 0x7e)
1408 no_redisplay
= direct_output_for_insert (lose
);
1415 /* Here for a command that isn't executed directly */
1418 if (NILP (current_kboard
->Vprefix_arg
))
1420 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1425 /* If there is a prefix argument,
1426 1) We don't want Vlast_command to be ``universal-argument''
1427 (that would be dumb), so don't set Vlast_command,
1428 2) we want to leave echoing on so that the prefix will be
1429 echoed as part of this key sequence, so don't call
1431 3) we want to leave this_command_key_count non-zero, so that
1432 read_char will realize that it is re-reading a character, and
1433 not echo it a second time.
1435 If the command didn't actually create a prefix arg,
1436 but is merely a frame event that is transparent to prefix args,
1437 then the above doesn't apply. */
1438 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1440 current_kboard
->Vlast_command
= this_command
;
1442 this_command_key_count
= 0;
1443 this_single_command_key_start
= 0;
1446 /* Note that the value cell will never directly contain nil
1447 if the symbol is a local variable. */
1448 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1449 safe_run_hooks (Qpost_command_hook
);
1451 if (!NILP (Vdeferred_action_list
))
1452 safe_run_hooks (Qdeferred_action_function
);
1454 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1456 if (NILP (Vunread_command_events
)
1457 && NILP (Vexecuting_macro
)
1458 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1459 safe_run_hooks (Qpost_command_idle_hook
);
1462 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1464 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1466 current_buffer
->mark_active
= Qnil
;
1467 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1469 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1470 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1474 /* Install chars successfully executed in kbd macro. */
1476 if (!NILP (current_kboard
->defining_kbd_macro
)
1477 && NILP (current_kboard
->Vprefix_arg
))
1478 finalize_kbd_macro_chars ();
1482 any_kboard_state ();
1487 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1490 safe_run_hooks_1 (hook
)
1493 return call1 (Vrun_hooks
, Vinhibit_quit
);
1496 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1499 safe_run_hooks_error (data
)
1502 Fset (Vinhibit_quit
, Qnil
);
1505 /* If we get an error while running the hook, cause the hook variable
1506 to be nil. Also inhibit quits, so that C-g won't cause the hook
1507 to mysteriously evaporate. */
1510 safe_run_hooks (hook
)
1514 int count
= specpdl_ptr
- specpdl
;
1515 specbind (Qinhibit_quit
, hook
);
1517 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1519 unbind_to (count
, Qnil
);
1522 /* Number of seconds between polling for input. */
1525 /* Nonzero means polling for input is temporarily suppressed. */
1526 int poll_suppress_count
;
1528 /* Nonzero if polling_for_input is actually being used. */
1529 int polling_for_input
;
1531 #ifdef POLL_FOR_INPUT
1533 /* Handle an alarm once each second and read pending input
1534 so as to handle a C-g if it comces in. */
1537 input_poll_signal (signalnum
) /* If we don't have an argument, */
1538 int signalnum
; /* some compilers complain in signal calls. */
1540 /* This causes the call to start_polling at the end
1541 to do its job. It also arranges for a quit or error
1542 from within read_avail_input to resume polling. */
1543 poll_suppress_count
++;
1544 if (interrupt_input_blocked
== 0
1545 && !waiting_for_input
)
1546 read_avail_input (0);
1547 /* Turn on the SIGALRM handler and request another alarm. */
1553 /* Begin signals to poll for input, if they are appropriate.
1554 This function is called unconditionally from various places. */
1559 #ifdef POLL_FOR_INPUT
1560 if (read_socket_hook
&& !interrupt_input
)
1562 poll_suppress_count
--;
1563 if (poll_suppress_count
== 0)
1565 signal (SIGALRM
, input_poll_signal
);
1566 polling_for_input
= 1;
1567 alarm (polling_period
);
1573 /* Nonzero if we are using polling to handle input asynchronously. */
1576 input_polling_used ()
1578 #ifdef POLL_FOR_INPUT
1579 return read_socket_hook
&& !interrupt_input
;
1585 /* Turn off polling. */
1590 #ifdef POLL_FOR_INPUT
1591 if (read_socket_hook
&& !interrupt_input
)
1593 if (poll_suppress_count
== 0)
1595 polling_for_input
= 0;
1598 poll_suppress_count
++;
1603 /* Set the value of poll_suppress_count to COUNT
1604 and start or stop polling accordingly. */
1607 set_poll_suppress_count (count
)
1610 #ifdef POLL_FOR_INPUT
1611 if (count
== 0 && poll_suppress_count
!= 0)
1613 poll_suppress_count
= 1;
1616 else if (count
!= 0 && poll_suppress_count
== 0)
1620 poll_suppress_count
= count
;
1624 /* Bind polling_period to a value at least N.
1625 But don't decrease it. */
1628 bind_polling_period (n
)
1631 #ifdef POLL_FOR_INPUT
1632 int new = polling_period
;
1638 specbind (Qpolling_period
, make_number (new));
1639 /* Start a new alarm with the new period. */
1644 /* Apply the control modifier to CHARACTER. */
1650 /* Save the upper bits here. */
1651 int upper
= c
& ~0177;
1655 /* Everything in the columns containing the upper-case letters
1656 denotes a control character. */
1657 if (c
>= 0100 && c
< 0140)
1661 /* Set the shift modifier for a control char
1662 made from a shifted letter. But only for letters! */
1663 if (oc
>= 'A' && oc
<= 'Z')
1664 c
|= shift_modifier
;
1667 /* The lower-case letters denote control characters too. */
1668 else if (c
>= 'a' && c
<= 'z')
1671 /* Include the bits for control and shift
1672 only if the basic ASCII code can't indicate them. */
1676 /* Replace the high bits. */
1677 c
|= (upper
& ~ctrl_modifier
);
1684 /* Input of single characters from keyboard */
1686 Lisp_Object
print_help ();
1687 static Lisp_Object
kbd_buffer_get_event ();
1688 static void record_char ();
1691 static jmp_buf wrong_kboard_jmpbuf
;
1694 /* read a character from the keyboard; call the redisplay if needed */
1695 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1696 -1 means do not do redisplay, but do do autosaving.
1699 /* The arguments MAPS and NMAPS are for menu prompting.
1700 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1702 PREV_EVENT is the previous input event, or nil if we are reading
1703 the first event of a key sequence.
1705 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1706 if we used a mouse menu to read the input, or zero otherwise. If
1707 USED_MOUSE_MENU is null, we don't dereference it.
1709 Value is t if we showed a menu and the user rejected it. */
1712 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1716 Lisp_Object prev_event
;
1717 int *used_mouse_menu
;
1721 jmp_buf local_getcjmp
;
1723 int key_already_recorded
= 0;
1724 Lisp_Object tem
, save
;
1725 Lisp_Object also_record
;
1726 struct gcpro gcpro1
;
1730 before_command_key_count
= this_command_key_count
;
1731 before_command_echo_length
= echo_length ();
1738 if (CONSP (Vunread_command_events
))
1740 c
= XCONS (Vunread_command_events
)->car
;
1741 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1743 /* Undo what read_char_x_menu_prompt did when it unread
1744 additional keys returned by Fx_popup_menu. */
1746 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1747 && NILP (XCONS (c
)->cdr
))
1750 if (this_command_key_count
== 0)
1756 if (unread_command_char
!= -1)
1758 XSETINT (c
, unread_command_char
);
1759 unread_command_char
= -1;
1761 if (this_command_key_count
== 0)
1767 /* If there is no function key translated before
1768 reset-this-command-lengths takes effect, forget about it. */
1769 before_command_restore_flag
= 0;
1771 if (!NILP (Vexecuting_macro
))
1773 /* We set this to Qmacro; since that's not a frame, nobody will
1774 try to switch frames on us, and the selected window will
1777 Since this event came from a macro, it would be misleading to
1778 leave internal_last_event_frame set to wherever the last
1779 real event came from. Normally, a switch-frame event selects
1780 internal_last_event_frame after each command is read, but
1781 events read from a macro should never cause a new frame to be
1783 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1785 /* Exit the macro if we are at the end.
1786 Also, some things replace the macro with t
1787 to force an early exit. */
1788 if (EQ (Vexecuting_macro
, Qt
)
1789 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1795 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1796 if (STRINGP (Vexecuting_macro
)
1797 && (XINT (c
) & 0x80))
1798 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1800 executing_macro_index
++;
1805 if (!NILP (unread_switch_frame
))
1807 c
= unread_switch_frame
;
1808 unread_switch_frame
= Qnil
;
1810 /* This event should make it into this_command_keys, and get echoed
1811 again, so we go to reread_first, rather than reread. */
1815 if (commandflag
>= 0)
1818 || detect_input_pending_run_timers (0))
1825 /* Message turns off echoing unless more keystrokes turn it on again. */
1826 if (echo_area_glyphs
&& *echo_area_glyphs
1827 && echo_area_glyphs
!= current_kboard
->echobuf
1828 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1831 /* If already echoing, continue. */
1834 /* Try reading a character via menu prompting in the minibuf.
1835 Try this before the sit-for, because the sit-for
1836 would do the wrong thing if we are supposed to do
1837 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1838 after a mouse event so don't try a minibuf menu. */
1840 if (nmaps
> 0 && INTERACTIVE
1841 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1842 /* Don't bring up a menu if we already have another event. */
1843 && NILP (Vunread_command_events
)
1844 && unread_command_char
< 0
1845 && !detect_input_pending_run_timers (0))
1847 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1850 key_already_recorded
= 1;
1855 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1856 We will do that below, temporarily for short sections of code,
1857 when appropriate. local_getcjmp must be in effect
1858 around any call to sit_for or kbd_buffer_get_event;
1859 it *must not* be in effect when we call redisplay. */
1861 if (_setjmp (local_getcjmp
))
1863 XSETINT (c
, quit_char
);
1864 XSETFRAME (internal_last_event_frame
, selected_frame
);
1865 Vlast_event_frame
= internal_last_event_frame
;
1866 /* If we report the quit char as an event,
1867 don't do so more than once. */
1868 if (!NILP (Vinhibit_quit
))
1873 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1874 if (kb
!= current_kboard
)
1876 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1877 /* We shouldn't get here if we were in single-kboard mode! */
1880 while (CONSP (*tailp
))
1881 tailp
= &XCONS (*tailp
)->cdr
;
1884 *tailp
= Fcons (c
, Qnil
);
1885 kb
->kbd_queue_has_data
= 1;
1886 current_kboard
= kb
;
1887 /* This is going to exit from read_char
1888 so we had better get rid of this frame's stuff. */
1890 longjmp (wrong_kboard_jmpbuf
, 1);
1897 timer_start_idle ();
1899 /* If in middle of key sequence and minibuffer not active,
1900 start echoing if enough time elapses. */
1902 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1903 && this_command_key_count
> 0
1905 && echo_keystrokes
> 0
1906 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1907 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1911 /* After a mouse event, start echoing right away.
1912 This is because we are probably about to display a menu,
1913 and we don't want to delay before doing so. */
1914 if (EVENT_HAS_PARAMETERS (prev_event
))
1918 save_getcjmp (save_jump
);
1919 restore_getcjmp (local_getcjmp
);
1920 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
1921 restore_getcjmp (save_jump
);
1923 && ! CONSP (Vunread_command_events
))
1928 /* Maybe auto save due to number of keystrokes. */
1930 if (commandflag
!= 0
1931 && auto_save_interval
> 0
1932 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
1933 && !detect_input_pending_run_timers (0))
1935 Fdo_auto_save (Qnil
, Qnil
);
1936 /* Hooks can actually change some buffers in auto save. */
1940 /* Try reading using an X menu.
1941 This is never confused with reading using the minibuf
1942 because the recursive call of read_char in read_char_minibuf_menu_prompt
1943 does not pass on any keymaps. */
1945 if (nmaps
> 0 && INTERACTIVE
1946 && !NILP (prev_event
)
1947 && EVENT_HAS_PARAMETERS (prev_event
)
1948 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1949 /* Don't bring up a menu if we already have another event. */
1950 && NILP (Vunread_command_events
)
1951 && unread_command_char
< 0)
1953 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1955 /* Now that we have read an event, Emacs is not idle. */
1961 /* Maybe autosave and/or garbage collect due to idleness. */
1963 if (INTERACTIVE
&& NILP (c
))
1965 int delay_level
, buffer_size
;
1967 /* Slow down auto saves logarithmically in size of current buffer,
1968 and garbage collect while we're at it. */
1969 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1970 last_non_minibuf_size
= Z
- BEG
;
1971 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1973 while (buffer_size
> 64)
1974 delay_level
++, buffer_size
-= buffer_size
>> 2;
1975 if (delay_level
< 4) delay_level
= 4;
1976 /* delay_level is 4 for files under around 50k, 7 at 100k,
1977 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1979 /* Auto save if enough time goes by without input. */
1980 if (commandflag
!= 0
1981 && num_nonmacro_input_events
> last_auto_save
1982 && INTEGERP (Vauto_save_timeout
)
1983 && XINT (Vauto_save_timeout
) > 0)
1987 save_getcjmp (save_jump
);
1988 restore_getcjmp (local_getcjmp
);
1989 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
1991 restore_getcjmp (save_jump
);
1994 && ! CONSP (Vunread_command_events
))
1996 Fdo_auto_save (Qnil
, Qnil
);
1998 /* If we have auto-saved and there is still no input
1999 available, garbage collect if there has been enough
2000 consing going on to make it worthwhile. */
2001 if (!detect_input_pending_run_timers (0)
2002 && consing_since_gc
> gc_cons_threshold
/ 2)
2003 Fgarbage_collect ();
2010 /* If this has become non-nil here, it has been set by a timer
2011 or sentinel or filter. */
2012 if (CONSP (Vunread_command_events
))
2014 c
= XCONS (Vunread_command_events
)->car
;
2015 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2018 /* Read something from current KBOARD's side queue, if possible. */
2022 if (current_kboard
->kbd_queue_has_data
)
2024 if (!CONSP (current_kboard
->kbd_queue
))
2026 c
= XCONS (current_kboard
->kbd_queue
)->car
;
2027 current_kboard
->kbd_queue
2028 = XCONS (current_kboard
->kbd_queue
)->cdr
;
2029 if (NILP (current_kboard
->kbd_queue
))
2030 current_kboard
->kbd_queue_has_data
= 0;
2031 input_pending
= readable_events (0);
2032 if (EVENT_HAS_PARAMETERS (c
)
2033 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2034 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2035 Vlast_event_frame
= internal_last_event_frame
;
2040 /* If current_kboard's side queue is empty check the other kboards.
2041 If one of them has data that we have not yet seen here,
2042 switch to it and process the data waiting for it.
2044 Note: if the events queued up for another kboard
2045 have already been seen here, and therefore are not a complete command,
2046 the kbd_queue_has_data field is 0, so we skip that kboard here.
2047 That's to avoid an infinite loop switching between kboards here. */
2048 if (NILP (c
) && !single_kboard
)
2051 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2052 if (kb
->kbd_queue_has_data
)
2054 current_kboard
= kb
;
2055 /* This is going to exit from read_char
2056 so we had better get rid of this frame's stuff. */
2058 longjmp (wrong_kboard_jmpbuf
, 1);
2067 /* Finally, we read from the main queue,
2068 and if that gives us something we can't use yet, we put it on the
2069 appropriate side queue and try again. */
2075 /* Actually read a character, waiting if necessary. */
2076 save_getcjmp (save_jump
);
2077 restore_getcjmp (local_getcjmp
);
2078 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2079 restore_getcjmp (save_jump
);
2082 if (! NILP (c
) && (kb
!= current_kboard
))
2084 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2085 while (CONSP (*tailp
))
2086 tailp
= &XCONS (*tailp
)->cdr
;
2089 *tailp
= Fcons (c
, Qnil
);
2090 kb
->kbd_queue_has_data
= 1;
2094 current_kboard
= kb
;
2095 /* This is going to exit from read_char
2096 so we had better get rid of this frame's stuff. */
2098 longjmp (wrong_kboard_jmpbuf
, 1);
2103 /* Terminate Emacs in batch mode if at eof. */
2104 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2105 Fkill_emacs (make_number (1));
2109 /* Add in any extra modifiers, where appropriate. */
2110 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2111 || ((extra_keyboard_modifiers
& 0177) < ' '
2112 && (extra_keyboard_modifiers
& 0177) != 0))
2113 XSETINT (c
, make_ctrl_char (XINT (c
)));
2115 /* Transfer any other modifier bits directly from
2116 extra_keyboard_modifiers to c. Ignore the actual character code
2117 in the low 16 bits of extra_keyboard_modifiers. */
2118 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2129 if (commandflag
>= 0
2130 && !input_pending
&& !detect_input_pending_run_timers (0))
2138 /* Buffer switch events are only for internal wakeups
2139 so don't show them to the user.
2140 Also, don't record a key if we already did. */
2141 if (BUFFERP (c
) || key_already_recorded
)
2144 /* Process special events within read_char
2145 and loop around to read another event. */
2148 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2154 int was_locked
= single_kboard
;
2156 last_input_char
= c
;
2157 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2159 /* Resume allowing input from any kboard, if that was true before. */
2161 any_kboard_state ();
2166 /* Wipe the echo area. */
2167 if (echo_area_glyphs
)
2168 safe_run_hooks (Qecho_area_clear_hook
);
2169 echo_area_glyphs
= 0;
2171 /* Handle things that only apply to characters. */
2174 /* If kbd_buffer_get_event gave us an EOF, return that. */
2178 if (STRINGP (Vkeyboard_translate_table
)
2179 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2180 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2181 else if ((VECTORP (Vkeyboard_translate_table
)
2182 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2183 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2184 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2187 d
= Faref (Vkeyboard_translate_table
, c
);
2188 /* nil in keyboard-translate-table means no translation. */
2194 /* If this event is a mouse click in the menu bar,
2195 return just menu-bar for now. Modify the mouse click event
2196 so we won't do this twice, then queue it up. */
2197 if (EVENT_HAS_PARAMETERS (c
)
2198 && CONSP (XCONS (c
)->cdr
)
2199 && CONSP (EVENT_START (c
))
2200 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2204 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2205 /* Handle menu-bar events:
2206 insert the dummy prefix event `menu-bar'. */
2207 if (EQ (posn
, Qmenu_bar
))
2209 /* Change menu-bar to (menu-bar) as the event "position". */
2210 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2213 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2219 if (! NILP (also_record
))
2220 record_char (also_record
);
2225 before_command_key_count
= this_command_key_count
;
2226 before_command_echo_length
= echo_length ();
2228 /* Don't echo mouse motion events. */
2230 && ! (EVENT_HAS_PARAMETERS (c
)
2231 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2234 if (! NILP (also_record
))
2235 echo_char (also_record
);
2236 /* Once we reread a character, echoing can happen
2237 the next time we pause to read a new one. */
2238 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2241 /* Record this character as part of the current key. */
2242 add_command_key (c
);
2243 if (! NILP (also_record
))
2244 add_command_key (also_record
);
2246 /* Re-reading in the middle of a command */
2248 last_input_char
= c
;
2251 /* Process the help character specially if enabled */
2252 if (!NILP (Vhelp_form
) && help_char_p (c
))
2255 count
= specpdl_ptr
- specpdl
;
2257 record_unwind_protect (Fset_window_configuration
,
2258 Fcurrent_window_configuration (Qnil
));
2260 tem0
= Feval (Vhelp_form
);
2262 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2266 c
= read_char (0, 0, 0, Qnil
, 0);
2267 while (BUFFERP (c
));
2268 /* Remove the help from the frame */
2269 unbind_to (count
, Qnil
);
2272 if (EQ (c
, make_number (040)))
2276 c
= read_char (0, 0, 0, Qnil
, 0);
2277 while (BUFFERP (c
));
2284 /* Record a key that came from a mouse menu.
2285 Record it for echoing, for this-command-keys, and so on. */
2291 /* Wipe the echo area. */
2292 echo_area_glyphs
= 0;
2296 before_command_key_count
= this_command_key_count
;
2297 before_command_echo_length
= echo_length ();
2299 /* Don't echo mouse motion events. */
2300 if (echo_keystrokes
)
2304 /* Once we reread a character, echoing can happen
2305 the next time we pause to read a new one. */
2306 ok_to_echo_at_next_pause
= 0;
2309 /* Record this character as part of the current key. */
2310 add_command_key (c
);
2312 /* Re-reading in the middle of a command */
2313 last_input_char
= c
;
2317 /* Return 1 if should recognize C as "the help character". */
2325 if (EQ (c
, Vhelp_char
))
2327 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2328 if (EQ (c
, XCONS (tail
)->car
))
2333 /* Record the input event C in various ways. */
2340 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2341 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2342 recent_keys_index
= 0;
2344 /* Write c to the dribble file. If c is a lispy event, write
2345 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2346 If you, dear reader, have a better idea, you've got the source. :-) */
2351 if (XUINT (c
) < 0x100)
2352 putc (XINT (c
), dribble
);
2354 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2358 Lisp_Object dribblee
;
2360 /* If it's a structured event, take the event header. */
2361 dribblee
= EVENT_HEAD (c
);
2363 if (SYMBOLP (dribblee
))
2365 putc ('<', dribble
);
2366 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2367 XSYMBOL (dribblee
)->name
->size
,
2369 putc ('>', dribble
);
2376 store_kbd_macro_char (c
);
2378 num_nonmacro_input_events
++;
2385 struct buffer
*old
= current_buffer
;
2386 Fprinc (object
, Qnil
);
2387 set_buffer_internal (XBUFFER (Vstandard_output
));
2388 call0 (intern ("help-mode"));
2389 set_buffer_internal (old
);
2393 /* Copy out or in the info on where C-g should throw to.
2394 This is used when running Lisp code from within get_char,
2395 in case get_char is called recursively.
2396 See read_process_output. */
2401 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2404 restore_getcjmp (temp
)
2407 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2412 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2413 of this function. */
2416 tracking_off (old_value
)
2417 Lisp_Object old_value
;
2419 do_mouse_tracking
= old_value
;
2420 if (NILP (old_value
))
2422 /* Redisplay may have been preempted because there was input
2423 available, and it assumes it will be called again after the
2424 input has been processed. If the only input available was
2425 the sort that we have just disabled, then we need to call
2427 if (!readable_events (1))
2429 redisplay_preserve_echo_area ();
2430 get_input_pending (&input_pending
, 1);
2435 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2436 "Evaluate BODY with mouse movement events enabled.\n\
2437 Within a `track-mouse' form, mouse motion generates input events that\n\
2438 you can read with `read-event'.\n\
2439 Normally, mouse motion is ignored.")
2443 int count
= specpdl_ptr
- specpdl
;
2446 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2448 do_mouse_tracking
= Qt
;
2450 val
= Fprogn (args
);
2451 return unbind_to (count
, val
);
2454 /* If mouse has moved on some frame, return one of those frames.
2455 Return 0 otherwise. */
2460 Lisp_Object tail
, frame
;
2462 FOR_EACH_FRAME (tail
, frame
)
2464 if (XFRAME (frame
)->mouse_moved
)
2465 return XFRAME (frame
);
2471 #endif /* HAVE_MOUSE */
2473 /* Low level keyboard/mouse input.
2474 kbd_buffer_store_event places events in kbd_buffer, and
2475 kbd_buffer_get_event retrieves them. */
2477 /* Return true iff there are any events in the queue that read-char
2478 would return. If this returns false, a read-char would block. */
2480 readable_events (do_timers_now
)
2484 timer_check (do_timers_now
);
2486 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2489 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2494 if (current_kboard
->kbd_queue_has_data
)
2500 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2501 if (kb
->kbd_queue_has_data
)
2507 /* Set this for debugging, to have a way to get out */
2512 event_to_kboard (event
)
2513 struct input_event
*event
;
2516 frame
= event
->frame_or_window
;
2518 frame
= XCONS (frame
)->car
;
2519 else if (WINDOWP (frame
))
2520 frame
= WINDOW_FRAME (XWINDOW (frame
));
2522 /* There are still some events that don't set this field.
2523 For now, just ignore the problem.
2524 Also ignore dead frames here. */
2525 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2528 return FRAME_KBOARD (XFRAME (frame
));
2532 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2535 kbd_buffer_store_event (event
)
2536 register struct input_event
*event
;
2538 if (event
->kind
== no_event
)
2541 if (event
->kind
== ascii_keystroke
)
2543 register int c
= event
->code
& 0377;
2545 if (event
->modifiers
& ctrl_modifier
)
2546 c
= make_ctrl_char (c
);
2548 c
|= (event
->modifiers
2549 & (meta_modifier
| alt_modifier
2550 | hyper_modifier
| super_modifier
));
2554 extern SIGTYPE
interrupt_signal ();
2557 struct input_event
*sp
;
2560 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2561 kb
!= current_kboard
))
2564 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2565 Fcons (make_number (c
), Qnil
));
2566 kb
->kbd_queue_has_data
= 1;
2567 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2569 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2572 if (event_to_kboard (sp
) == kb
)
2574 sp
->kind
= no_event
;
2575 sp
->frame_or_window
= Qnil
;
2582 /* If this results in a quit_char being returned to Emacs as
2583 input, set Vlast_event_frame properly. If this doesn't
2584 get returned to Emacs as an event, the next event read
2585 will set Vlast_event_frame again, so this is safe to do. */
2589 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2591 focus
= event
->frame_or_window
;
2592 internal_last_event_frame
= focus
;
2593 Vlast_event_frame
= focus
;
2596 last_event_timestamp
= event
->timestamp
;
2597 interrupt_signal ();
2601 if (c
&& c
== stop_character
)
2607 /* Don't insert two buffer_switch_event's in a row.
2608 Just ignore the second one. */
2609 else if (event
->kind
== buffer_switch_event
2610 && kbd_fetch_ptr
!= kbd_store_ptr
2611 && kbd_store_ptr
->kind
== buffer_switch_event
)
2614 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2615 kbd_store_ptr
= kbd_buffer
;
2617 /* Don't let the very last slot in the buffer become full,
2618 since that would make the two pointers equal,
2619 and that is indistinguishable from an empty buffer.
2620 Discard the event if it would fill the last slot. */
2621 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2623 volatile struct input_event
*sp
= kbd_store_ptr
;
2624 sp
->kind
= event
->kind
;
2625 if (event
->kind
== selection_request_event
)
2627 /* We must not use the ordinary copying code for this case,
2628 since `part' is an enum and copying it might not copy enough
2630 bcopy (event
, (char *) sp
, sizeof (*event
));
2634 sp
->code
= event
->code
;
2635 sp
->part
= event
->part
;
2636 sp
->frame_or_window
= event
->frame_or_window
;
2637 sp
->modifiers
= event
->modifiers
;
2640 sp
->timestamp
= event
->timestamp
;
2642 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2644 = event
->frame_or_window
);
2650 /* Discard any mouse events in the event buffer by setting them to
2653 discard_mouse_events ()
2655 struct input_event
*sp
;
2656 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2658 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2661 if (sp
->kind
== mouse_click
2663 || sp
->kind
== w32_scroll_bar_click
2665 || sp
->kind
== scroll_bar_click
)
2667 sp
->kind
= no_event
;
2672 /* Read one event from the event buffer, waiting if necessary.
2673 The value is a Lisp object representing the event.
2674 The value is nil for an event that should be ignored,
2675 or that was handled here.
2676 We always read and discard one event. */
2679 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2681 int *used_mouse_menu
;
2685 EMACS_TIME next_timer_delay
;
2691 *kbp
= current_kboard
;
2695 /* Wait until there is input available. */
2698 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2701 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2705 /* If the quit flag is set, then read_char will return
2706 quit_char, so that counts as "available input." */
2707 if (!NILP (Vquit_flag
))
2708 quit_throw_to_read_char ();
2710 /* One way or another, wait until input is available; then, if
2711 interrupt handlers have not read it, read it now. */
2714 wait_for_kbd_input ();
2716 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2720 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2723 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2727 Lisp_Object minus_one
;
2729 XSETINT (minus_one
, -1);
2730 wait_reading_process_input (0, 0, minus_one
, 1);
2732 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2733 /* Pass 1 for EXPECT since we just waited to have input. */
2734 read_avail_input (1);
2736 #endif /* not VMS */
2739 if (CONSP (Vunread_command_events
))
2742 first
= XCONS (Vunread_command_events
)->car
;
2743 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2744 *kbp
= current_kboard
;
2748 /* At this point, we know that there is a readable event available
2749 somewhere. If the event queue is empty, then there must be a
2750 mouse movement enabled and available. */
2751 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2753 struct input_event
*event
;
2755 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2759 last_event_timestamp
= event
->timestamp
;
2762 *kbp
= event_to_kboard (event
);
2764 *kbp
= current_kboard
; /* Better than returning null ptr? */
2766 *kbp
= &the_only_kboard
;
2771 /* These two kinds of events get special handling
2772 and don't actually appear to the command loop.
2773 We return nil for them. */
2774 if (event
->kind
== selection_request_event
)
2777 struct input_event copy
;
2779 /* Remove it from the buffer before processing it,
2780 since otherwise swallow_events will see it
2781 and process it again. */
2783 kbd_fetch_ptr
= event
+ 1;
2784 input_pending
= readable_events (0);
2785 x_handle_selection_request (©
);
2787 /* We're getting selection request events, but we don't have
2793 else if (event
->kind
== selection_clear_event
)
2796 struct input_event copy
;
2798 /* Remove it from the buffer before processing it. */
2800 kbd_fetch_ptr
= event
+ 1;
2801 input_pending
= readable_events (0);
2802 x_handle_selection_clear (©
);
2804 /* We're getting selection request events, but we don't have
2809 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2810 else if (event
->kind
== delete_window_event
)
2812 /* Make an event (delete-frame (FRAME)). */
2813 obj
= Fcons (event
->frame_or_window
, Qnil
);
2814 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2815 kbd_fetch_ptr
= event
+ 1;
2817 else if (event
->kind
== iconify_event
)
2819 /* Make an event (iconify-frame (FRAME)). */
2820 obj
= Fcons (event
->frame_or_window
, Qnil
);
2821 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2822 kbd_fetch_ptr
= event
+ 1;
2824 else if (event
->kind
== deiconify_event
)
2826 /* Make an event (make-frame-visible (FRAME)). */
2827 obj
= Fcons (event
->frame_or_window
, Qnil
);
2828 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2829 kbd_fetch_ptr
= event
+ 1;
2832 else if (event
->kind
== buffer_switch_event
)
2834 /* The value doesn't matter here; only the type is tested. */
2835 XSETBUFFER (obj
, current_buffer
);
2836 kbd_fetch_ptr
= event
+ 1;
2838 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2839 else if (event
->kind
== menu_bar_activate_event
)
2841 kbd_fetch_ptr
= event
+ 1;
2842 input_pending
= readable_events (0);
2843 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2844 x_activate_menubar (XFRAME (event
->frame_or_window
));
2847 /* Just discard these, by returning nil.
2848 With MULTI_KBOARD, these events are used as placeholders
2849 when we need to randomly delete events from the queue.
2850 (They shouldn't otherwise be found in the buffer,
2851 but on some machines it appears they do show up
2852 even without MULTI_KBOARD.) */
2853 /* On Windows NT/9X, no_event is used to delete extraneous
2854 mouse events during a popup-menu call. */
2855 else if (event
->kind
== no_event
)
2856 kbd_fetch_ptr
= event
+ 1;
2858 /* If this event is on a different frame, return a switch-frame this
2859 time, and leave the event in the queue for next time. */
2865 frame
= event
->frame_or_window
;
2867 frame
= XCONS (frame
)->car
;
2868 else if (WINDOWP (frame
))
2869 frame
= WINDOW_FRAME (XWINDOW (frame
));
2871 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2875 if (! EQ (frame
, internal_last_event_frame
)
2876 && XFRAME (frame
) != selected_frame
)
2877 obj
= make_lispy_switch_frame (frame
);
2878 internal_last_event_frame
= frame
;
2880 /* If we didn't decide to make a switch-frame event, go ahead
2881 and build a real event from the queue entry. */
2885 obj
= make_lispy_event (event
);
2886 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2887 /* If this was a menu selection, then set the flag to inhibit
2888 writing to last_nonmenu_event. Don't do this if the event
2889 we're returning is (menu-bar), though; that indicates the
2890 beginning of the menu sequence, and we might as well leave
2891 that as the `event with parameters' for this selection. */
2892 if (event
->kind
== menu_bar_event
2893 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2895 *used_mouse_menu
= 1;
2898 /* Wipe out this event, to catch bugs. */
2899 event
->kind
= no_event
;
2900 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2902 kbd_fetch_ptr
= event
+ 1;
2907 /* Try generating a mouse motion event. */
2908 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2910 FRAME_PTR f
= some_mouse_moved ();
2911 Lisp_Object bar_window
;
2912 enum scroll_bar_part part
;
2916 *kbp
= current_kboard
;
2917 /* Note that this uses F to determine which display to look at.
2918 If there is no valid info, it does not store anything
2919 so x remains nil. */
2921 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2925 /* Decide if we should generate a switch-frame event. Don't
2926 generate switch-frame events for motion outside of all Emacs
2932 frame
= FRAME_FOCUS_FRAME (f
);
2934 XSETFRAME (frame
, f
);
2936 if (! EQ (frame
, internal_last_event_frame
)
2937 && XFRAME (frame
) != selected_frame
)
2938 obj
= make_lispy_switch_frame (frame
);
2939 internal_last_event_frame
= frame
;
2942 /* If we didn't decide to make a switch-frame event, go ahead and
2943 return a mouse-motion event. */
2944 if (!NILP (x
) && NILP (obj
))
2945 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2947 #endif /* HAVE_MOUSE */
2949 /* We were promised by the above while loop that there was
2950 something for us to read! */
2953 input_pending
= readable_events (0);
2955 Vlast_event_frame
= internal_last_event_frame
;
2960 /* Process any events that are not user-visible,
2961 then return, without reading any user-visible events. */
2964 swallow_events (do_display
)
2969 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2971 struct input_event
*event
;
2973 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2977 last_event_timestamp
= event
->timestamp
;
2979 /* These two kinds of events get special handling
2980 and don't actually appear to the command loop. */
2981 if (event
->kind
== selection_request_event
)
2984 struct input_event copy
;
2986 /* Remove it from the buffer before processing it,
2987 since otherwise swallow_events called recursively could see it
2988 and process it again. */
2990 kbd_fetch_ptr
= event
+ 1;
2991 input_pending
= readable_events (0);
2992 x_handle_selection_request (©
);
2994 /* We're getting selection request events, but we don't have
3000 else if (event
->kind
== selection_clear_event
)
3003 struct input_event copy
;
3005 /* Remove it from the buffer before processing it, */
3008 kbd_fetch_ptr
= event
+ 1;
3009 input_pending
= readable_events (0);
3010 x_handle_selection_clear (©
);
3012 /* We're getting selection request events, but we don't have
3021 old_timers_run
= timers_run
;
3022 get_input_pending (&input_pending
, 1);
3024 if (timers_run
!= old_timers_run
&& do_display
)
3025 redisplay_preserve_echo_area ();
3028 static EMACS_TIME timer_idleness_start_time
;
3030 /* Record the start of when Emacs is idle,
3031 for the sake of running idle-time timers. */
3038 /* If we are already in the idle state, do nothing. */
3039 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3042 EMACS_GET_TIME (timer_idleness_start_time
);
3044 /* Mark all idle-time timers as once again candidates for running. */
3045 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
3049 timer
= XCONS (timers
)->car
;
3051 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3053 XVECTOR (timer
)->contents
[0] = Qnil
;
3057 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3062 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3065 /* This is only for debugging. */
3066 struct input_event last_timer_event
;
3068 /* Check whether a timer has fired. To prevent larger problems we simply
3069 disregard elements that are not proper timers. Do not make a circular
3070 timer list for the time being.
3072 Returns the number of seconds to wait until the next timer fires. If a
3073 timer is triggering now, return zero seconds.
3074 If no timer is active, return -1 seconds.
3076 If a timer is ripe, we run it, with quitting turned off.
3078 DO_IT_NOW is now ignored. It used to mean that we should
3079 run the timer directly instead of queueing a timer-event.
3080 Now we always run timers directly. */
3083 timer_check (do_it_now
)
3086 EMACS_TIME nexttime
;
3087 EMACS_TIME now
, idleness_now
;
3088 Lisp_Object timers
, idle_timers
, chosen_timer
;
3089 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3091 EMACS_SET_SECS (nexttime
, -1);
3092 EMACS_SET_USECS (nexttime
, -1);
3094 /* Always consider the ordinary timers. */
3095 timers
= Vtimer_list
;
3096 /* Consider the idle timers only if Emacs is idle. */
3097 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3098 idle_timers
= Vtimer_idle_list
;
3101 chosen_timer
= Qnil
;
3102 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3104 if (CONSP (timers
) || CONSP (idle_timers
))
3106 EMACS_GET_TIME (now
);
3107 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3108 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3111 while (CONSP (timers
) || CONSP (idle_timers
))
3113 int triggertime
= EMACS_SECS (now
);
3114 Lisp_Object
*vector
;
3115 Lisp_Object timer
, idle_timer
;
3116 EMACS_TIME timer_time
, idle_timer_time
;
3117 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3119 /* Skip past invalid timers and timers already handled. */
3122 timer
= XCONS (timers
)->car
;
3123 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3125 timers
= XCONS (timers
)->cdr
;
3128 vector
= XVECTOR (timer
)->contents
;
3130 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3131 || !INTEGERP (vector
[3])
3132 || ! NILP (vector
[0]))
3134 timers
= XCONS (timers
)->cdr
;
3138 if (!NILP (idle_timers
))
3140 timer
= XCONS (idle_timers
)->car
;
3141 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3143 idle_timers
= XCONS (idle_timers
)->cdr
;
3146 vector
= XVECTOR (timer
)->contents
;
3148 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3149 || !INTEGERP (vector
[3])
3150 || ! NILP (vector
[0]))
3152 idle_timers
= XCONS (idle_timers
)->cdr
;
3157 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3158 based on the next ordinary timer.
3159 TIMER_DIFFERENCE is the distance in time from NOW to when
3160 this timer becomes ripe (negative if it's already ripe). */
3163 timer
= XCONS (timers
)->car
;
3164 vector
= XVECTOR (timer
)->contents
;
3165 EMACS_SET_SECS (timer_time
,
3166 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3167 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3168 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3171 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3172 based on the next idle timer. */
3173 if (!NILP (idle_timers
))
3175 idle_timer
= XCONS (idle_timers
)->car
;
3176 vector
= XVECTOR (idle_timer
)->contents
;
3177 EMACS_SET_SECS (idle_timer_time
,
3178 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3179 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3180 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3183 /* Decide which timer is the next timer,
3184 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3185 Also step down the list where we found that timer. */
3187 if (! NILP (timers
) && ! NILP (idle_timers
))
3190 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3191 if (EMACS_TIME_NEG_P (temp
))
3193 chosen_timer
= timer
;
3194 timers
= XCONS (timers
)->cdr
;
3195 difference
= timer_difference
;
3199 chosen_timer
= idle_timer
;
3200 idle_timers
= XCONS (idle_timers
)->cdr
;
3201 difference
= idle_timer_difference
;
3204 else if (! NILP (timers
))
3206 chosen_timer
= timer
;
3207 timers
= XCONS (timers
)->cdr
;
3208 difference
= timer_difference
;
3212 chosen_timer
= idle_timer
;
3213 idle_timers
= XCONS (idle_timers
)->cdr
;
3214 difference
= idle_timer_difference
;
3216 vector
= XVECTOR (chosen_timer
)->contents
;
3218 /* If timer is rupe, run it if it hasn't been run. */
3219 if (EMACS_TIME_NEG_P (difference
)
3220 || (EMACS_SECS (difference
) == 0
3221 && EMACS_USECS (difference
) == 0))
3223 if (NILP (vector
[0]))
3226 int was_locked
= single_kboard
;
3227 int count
= specpdl_ptr
- specpdl
;
3229 /* Mark the timer as triggered to prevent problems if the lisp
3230 code fails to reschedule it right. */
3233 specbind (Qinhibit_quit
, Qt
);
3235 call1 (Qtimer_event_handler
, chosen_timer
);
3238 unbind_to (count
, Qnil
);
3240 /* Resume allowing input from any kboard, if that was true before. */
3242 any_kboard_state ();
3244 /* Since we have handled the event,
3245 we don't need to tell the caller to wake up and do it. */
3249 /* When we encounter a timer that is still waiting,
3250 return the amount of time to wait before it is ripe. */
3257 /* No timers are pending in the future. */
3258 /* Return 0 if we generated an event, and -1 if not. */
3263 /* Caches for modify_event_symbol. */
3264 static Lisp_Object accent_key_syms
;
3265 static Lisp_Object func_key_syms
;
3266 static Lisp_Object mouse_syms
;
3268 static Lisp_Object mouse_wheel_syms
;
3271 /* This is a list of keysym codes for special "accent" characters.
3272 It parallels lispy_accent_keys. */
3274 static int lispy_accent_codes
[] =
3276 #ifdef XK_dead_circumflex
3281 #ifdef XK_dead_grave
3286 #ifdef XK_dead_tilde
3291 #ifdef XK_dead_diaeresis
3296 #ifdef XK_dead_macron
3301 #ifdef XK_dead_degree
3306 #ifdef XK_dead_acute
3311 #ifdef XK_dead_cedilla
3316 #ifdef XK_dead_breve
3321 #ifdef XK_dead_ogonek
3326 #ifdef XK_dead_caron
3331 #ifdef XK_dead_doubleacute
3332 XK_dead_doubleacute
,
3336 #ifdef XK_dead_abovedot
3343 /* This is a list of Lisp names for special "accent" characters.
3344 It parallels lispy_accent_codes. */
3346 static char *lispy_accent_keys
[] =
3364 #define FUNCTION_KEY_OFFSET 0x0
3366 char *lispy_function_keys
[] =
3370 0, /* VK_LBUTTON 0x01 */
3371 0, /* VK_RBUTTON 0x02 */
3372 "cancel", /* VK_CANCEL 0x03 */
3373 0, /* VK_MBUTTON 0x04 */
3375 0, 0, 0, /* 0x05 .. 0x07 */
3377 "backspace", /* VK_BACK 0x08 */
3378 "tab", /* VK_TAB 0x09 */
3380 0, 0, /* 0x0A .. 0x0B */
3382 "clear", /* VK_CLEAR 0x0C */
3383 "return", /* VK_RETURN 0x0D */
3385 0, 0, /* 0x0E .. 0x0F */
3387 "shift", /* VK_SHIFT 0x10 */
3388 "control", /* VK_CONTROL 0x11 */
3389 "menu", /* VK_MENU 0x12 */
3390 "pause", /* VK_PAUSE 0x13 */
3391 "capital", /* VK_CAPITAL 0x14 */
3393 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3395 0, /* VK_ESCAPE 0x1B */
3397 0, 0, 0, 0, /* 0x1C .. 0x1F */
3399 0, /* VK_SPACE 0x20 */
3400 "prior", /* VK_PRIOR 0x21 */
3401 "next", /* VK_NEXT 0x22 */
3402 "end", /* VK_END 0x23 */
3403 "home", /* VK_HOME 0x24 */
3404 "left", /* VK_LEFT 0x25 */
3405 "up", /* VK_UP 0x26 */
3406 "right", /* VK_RIGHT 0x27 */
3407 "down", /* VK_DOWN 0x28 */
3408 "select", /* VK_SELECT 0x29 */
3409 "print", /* VK_PRINT 0x2A */
3410 "execute", /* VK_EXECUTE 0x2B */
3411 "snapshot", /* VK_SNAPSHOT 0x2C */
3412 "insert", /* VK_INSERT 0x2D */
3413 "delete", /* VK_DELETE 0x2E */
3414 "help", /* VK_HELP 0x2F */
3416 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3418 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3420 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3422 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3424 0, 0, 0, 0, 0, 0, 0, 0, 0,
3425 0, 0, 0, 0, 0, 0, 0, 0, 0,
3426 0, 0, 0, 0, 0, 0, 0, 0,
3428 "lwindow", /* VK_LWIN 0x5B */
3429 "rwindow", /* VK_RWIN 0x5C */
3430 "apps", /* VK_APPS 0x5D */
3432 0, 0, /* 0x5E .. 0x5F */
3434 "kp-0", /* VK_NUMPAD0 0x60 */
3435 "kp-1", /* VK_NUMPAD1 0x61 */
3436 "kp-2", /* VK_NUMPAD2 0x62 */
3437 "kp-3", /* VK_NUMPAD3 0x63 */
3438 "kp-4", /* VK_NUMPAD4 0x64 */
3439 "kp-5", /* VK_NUMPAD5 0x65 */
3440 "kp-6", /* VK_NUMPAD6 0x66 */
3441 "kp-7", /* VK_NUMPAD7 0x67 */
3442 "kp-8", /* VK_NUMPAD8 0x68 */
3443 "kp-9", /* VK_NUMPAD9 0x69 */
3444 "kp-multiply", /* VK_MULTIPLY 0x6A */
3445 "kp-add", /* VK_ADD 0x6B */
3446 "kp-separator", /* VK_SEPARATOR 0x6C */
3447 "kp-subtract", /* VK_SUBTRACT 0x6D */
3448 "kp-decimal", /* VK_DECIMAL 0x6E */
3449 "kp-divide", /* VK_DIVIDE 0x6F */
3450 "f1", /* VK_F1 0x70 */
3451 "f2", /* VK_F2 0x71 */
3452 "f3", /* VK_F3 0x72 */
3453 "f4", /* VK_F4 0x73 */
3454 "f5", /* VK_F5 0x74 */
3455 "f6", /* VK_F6 0x75 */
3456 "f7", /* VK_F7 0x76 */
3457 "f8", /* VK_F8 0x77 */
3458 "f9", /* VK_F9 0x78 */
3459 "f10", /* VK_F10 0x79 */
3460 "f11", /* VK_F11 0x7A */
3461 "f12", /* VK_F12 0x7B */
3462 "f13", /* VK_F13 0x7C */
3463 "f14", /* VK_F14 0x7D */
3464 "f15", /* VK_F15 0x7E */
3465 "f16", /* VK_F16 0x7F */
3466 "f17", /* VK_F17 0x80 */
3467 "f18", /* VK_F18 0x81 */
3468 "f19", /* VK_F19 0x82 */
3469 "f20", /* VK_F20 0x83 */
3470 "f21", /* VK_F21 0x84 */
3471 "f22", /* VK_F22 0x85 */
3472 "f23", /* VK_F23 0x86 */
3473 "f24", /* VK_F24 0x87 */
3475 0, 0, 0, 0, /* 0x88 .. 0x8B */
3476 0, 0, 0, 0, /* 0x8C .. 0x8F */
3478 "kp-numlock", /* VK_NUMLOCK 0x90 */
3479 "scroll", /* VK_SCROLL 0x91 */
3481 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3482 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3483 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3484 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3485 "kp-end", /* VK_NUMPAD_END 0x96 */
3486 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3487 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3488 "kp-up", /* VK_NUMPAD_UP 0x99 */
3489 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3490 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3491 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3492 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3494 0, 0, /* 0x9E .. 0x9F */
3497 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3498 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3499 * No other API or message will distinguish left and right keys this way.
3503 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3504 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3505 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3506 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3507 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3513 "attn", /* VK_ATTN 0xF6 */
3514 "crsel", /* VK_CRSEL 0xF7 */
3515 "exsel", /* VK_EXSEL 0xF8 */
3516 "ereof", /* VK_EREOF 0xF9 */
3517 "play", /* VK_PLAY 0xFA */
3518 "zoom", /* VK_ZOOM 0xFB */
3519 "noname", /* VK_NONAME 0xFC */
3520 "pa1", /* VK_PA1 0xFD */
3521 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3524 #else /* not HAVE_NTGUI */
3527 static char *lispy_kana_keys
[] =
3529 /* X Keysym value */
3530 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3531 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3532 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3533 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3534 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3535 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3536 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3537 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3538 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3539 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3540 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3541 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3542 "kana-i", "kana-u", "kana-e", "kana-o",
3543 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3544 "prolongedsound", "kana-A", "kana-I", "kana-U",
3545 "kana-E", "kana-O", "kana-KA", "kana-KI",
3546 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3547 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3548 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3549 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3550 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3551 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3552 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3553 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3554 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3555 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3556 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3557 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3559 #endif /* XK_kana_A */
3561 #define FUNCTION_KEY_OFFSET 0xff00
3563 /* You'll notice that this table is arranged to be conveniently
3564 indexed by X Windows keysym values. */
3565 static char *lispy_function_keys
[] =
3567 /* X Keysym value */
3569 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3577 0, 0, 0, /* 0xff10 */
3579 0, 0, 0, 0, 0, 0, 0,
3582 0, "kanji", "muhenkan",
3583 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3584 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3585 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3587 "home", /* 0xff50 */ /* IsCursorKey */
3598 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3609 "break", /* 0xff6b */
3611 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3613 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3614 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3615 0, 0, 0, 0, 0, 0, 0, 0,
3616 "kp-tab", /* 0xff89 */
3618 "kp-enter", /* 0xff8d */
3620 "kp-f1", /* 0xff91 */
3624 "kp-home", /* 0xff95 */
3629 "kp-prior", /* kp-page-up */
3630 "kp-next", /* kp-page-down */
3636 0, 0, 0, 0, 0, 0, 0, 0, 0,
3637 "kp-multiply", /* 0xffaa */
3642 "kp-divide", /* 0xffaf */
3643 "kp-0", /* 0xffb0 */
3644 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3647 "kp-equal", /* 0xffbd */
3648 "f1", /* 0xffbe */ /* IsFunctionKey */
3650 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3651 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3652 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3653 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3654 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3655 0, 0, 0, 0, 0, 0, 0, 0,
3656 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3657 0, 0, 0, 0, 0, 0, 0, "delete"
3660 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3661 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3663 static char *iso_lispy_function_keys
[] =
3665 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3666 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3667 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3668 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3669 "iso-lefttab", /* 0xfe20 */
3670 "iso-move-line-up", "iso-move-line-down",
3671 "iso-partial-line-up", "iso-partial-line-down",
3672 "iso-partial-space-left", "iso-partial-space-right",
3673 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3674 "iso-release-margin-left", "iso-release-margin-right",
3675 "iso-release-both-margins",
3676 "iso-fast-cursor-left", "iso-fast-cursor-right",
3677 "iso-fast-cursor-up", "iso-fast-cursor-down",
3678 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3679 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3682 #endif /* not HAVE_NTGUI */
3684 static char *lispy_mouse_names
[] =
3686 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3690 /* mouse-wheel events are generated by the wheel on devices such as
3691 the MS Intellimouse. The wheel sits in between the left and right
3692 mouse buttons, and is typically used to scroll or zoom the window
3693 underneath the pointer. mouse-wheel events specify the object on
3694 which they operate, and a delta corresponding to the amount and
3695 direction that the wheel is rotated. Clicking the mouse-wheel
3696 generates a mouse-2 event. */
3697 static char *lispy_mouse_wheel_names
[] =
3701 #endif /* WINDOWSNT */
3703 /* Scroll bar parts. */
3704 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3705 Lisp_Object Qup
, Qdown
;
3707 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3708 Lisp_Object
*scroll_bar_parts
[] = {
3709 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3714 /* A vector, indexed by button number, giving the down-going location
3715 of currently depressed buttons, both scroll bar and non-scroll bar.
3717 The elements have the form
3718 (BUTTON-NUMBER MODIFIER-MASK . REST)
3719 where REST is the cdr of a position as it would be reported in the event.
3721 The make_lispy_event function stores positions here to tell the
3722 difference between click and drag events, and to store the starting
3723 location to be included in drag events. */
3725 static Lisp_Object button_down_location
;
3727 /* Information about the most recent up-going button event: Which
3728 button, what location, and what time. */
3730 static int last_mouse_button
;
3731 static int last_mouse_x
;
3732 static int last_mouse_y
;
3733 static unsigned long button_down_time
;
3735 /* The maximum time between clicks to make a double-click,
3736 or Qnil to disable double-click detection,
3737 or Qt for no time limit. */
3738 Lisp_Object Vdouble_click_time
;
3740 /* The number of clicks in this multiple-click. */
3742 int double_click_count
;
3744 /* Given a struct input_event, build the lisp event which represents
3745 it. If EVENT is 0, build a mouse movement event from the mouse
3746 movement buffer, which should have a movement event in it.
3748 Note that events must be passed to this function in the order they
3749 are received; this function stores the location of button presses
3750 in order to build drag events when the button is released. */
3753 make_lispy_event (event
)
3754 struct input_event
*event
;
3758 switch (SWITCH_ENUM_CAST (event
->kind
))
3760 /* A simple keystroke. */
3761 case ascii_keystroke
:
3763 Lisp_Object lispy_c
;
3764 int c
= event
->code
& 0377;
3765 /* Turn ASCII characters into control characters
3767 if (event
->modifiers
& ctrl_modifier
)
3768 c
= make_ctrl_char (c
);
3770 /* Add in the other modifier bits. We took care of ctrl_modifier
3771 just above, and the shift key was taken care of by the X code,
3772 and applied to control characters by make_ctrl_char. */
3773 c
|= (event
->modifiers
3774 & (meta_modifier
| alt_modifier
3775 | hyper_modifier
| super_modifier
));
3776 /* Distinguish Shift-SPC from SPC. */
3777 if ((event
->code
& 0377) == 040
3778 && event
->modifiers
& shift_modifier
)
3779 c
|= shift_modifier
;
3780 button_down_time
= 0;
3781 XSETFASTINT (lispy_c
, c
);
3785 /* A function key. The symbol may need to have modifier prefixes
3787 case non_ascii_keystroke
:
3788 button_down_time
= 0;
3790 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3791 if (event
->code
== lispy_accent_codes
[i
])
3792 return modify_event_symbol (i
,
3794 Qfunction_key
, Qnil
,
3795 lispy_accent_keys
, &accent_key_syms
,
3796 (sizeof (lispy_accent_keys
)
3797 / sizeof (lispy_accent_keys
[0])));
3799 /* Handle system-specific keysyms. */
3800 if (event
->code
& (1 << 28))
3802 /* We need to use an alist rather than a vector as the cache
3803 since we can't make a vector long enuf. */
3804 if (NILP (current_kboard
->system_key_syms
))
3805 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3806 return modify_event_symbol (event
->code
,
3809 current_kboard
->Vsystem_key_alist
,
3810 0, ¤t_kboard
->system_key_syms
,
3815 if (event
->code
>= 0x400 && event
->code
< 0x500)
3816 return modify_event_symbol (event
->code
- 0x400,
3817 event
->modifiers
& ~shift_modifier
,
3818 Qfunction_key
, Qnil
,
3819 lispy_kana_keys
, &func_key_syms
,
3820 (sizeof (lispy_kana_keys
)
3821 / sizeof (lispy_kana_keys
[0])));
3822 #endif /* XK_kana_A */
3824 #ifdef ISO_FUNCTION_KEY_OFFSET
3825 if (event
->code
< FUNCTION_KEY_OFFSET
3826 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
3827 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
3829 Qfunction_key
, Qnil
,
3830 iso_lispy_function_keys
, &func_key_syms
,
3831 (sizeof (iso_lispy_function_keys
)
3832 / sizeof (iso_lispy_function_keys
[0])));
3835 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3837 Qfunction_key
, Qnil
,
3838 lispy_function_keys
, &func_key_syms
,
3839 (sizeof (lispy_function_keys
)
3840 / sizeof (lispy_function_keys
[0])));
3843 /* A mouse click. Figure out where it is, decide whether it's
3844 a press, click or drag, and build the appropriate structure. */
3846 case scroll_bar_click
:
3848 int button
= event
->code
;
3850 Lisp_Object position
;
3851 Lisp_Object
*start_pos_ptr
;
3852 Lisp_Object start_pos
;
3854 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3857 /* Build the position as appropriate for this mouse click. */
3858 if (event
->kind
== mouse_click
)
3861 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3866 /* Ignore mouse events that were made on frame that
3867 have been deleted. */
3868 if (! FRAME_LIVE_P (f
))
3871 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3872 &column
, &row
, NULL
, 1);
3874 #ifndef USE_X_TOOLKIT
3875 /* In the non-toolkit version, clicks on the menu bar
3876 are ordinary button events in the event buffer.
3877 Distinguish them, and invoke the menu.
3879 (In the toolkit version, the toolkit handles the menu bar
3880 and Emacs doesn't know about it until after the user
3881 makes a selection.) */
3882 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3883 && (event
->modifiers
& down_modifier
))
3885 Lisp_Object items
, item
;
3890 /* Activate the menu bar on the down event. If the
3891 up event comes in before the menu code can deal with it,
3893 if (! (event
->modifiers
& down_modifier
))
3898 items
= FRAME_MENU_BAR_ITEMS (f
);
3899 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3901 Lisp_Object pos
, string
;
3902 string
= XVECTOR (items
)->contents
[i
+ 1];
3903 pos
= XVECTOR (items
)->contents
[i
+ 3];
3906 if (column
>= XINT (pos
)
3907 && column
< XINT (pos
) + XSTRING (string
)->size
)
3909 item
= XVECTOR (items
)->contents
[i
];
3915 = Fcons (event
->frame_or_window
,
3917 Fcons (Fcons (event
->x
, event
->y
),
3918 Fcons (make_number (event
->timestamp
),
3921 return Fcons (item
, Fcons (position
, Qnil
));
3923 #endif /* not USE_X_TOOLKIT */
3925 window
= window_from_coordinates (f
, column
, row
, &part
);
3927 if (!WINDOWP (window
))
3929 window
= event
->frame_or_window
;
3934 int pixcolumn
, pixrow
;
3935 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3936 row
-= XINT (XWINDOW (window
)->top
);
3937 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3938 XSETINT (event
->x
, pixcolumn
);
3939 XSETINT (event
->y
, pixrow
);
3944 posn
= Qvertical_line
;
3947 buffer_posn_from_coords (XWINDOW (window
),
3954 Fcons (Fcons (event
->x
, event
->y
),
3955 Fcons (make_number (event
->timestamp
),
3961 Lisp_Object portion_whole
;
3964 window
= event
->frame_or_window
;
3965 portion_whole
= Fcons (event
->x
, event
->y
);
3966 part
= *scroll_bar_parts
[(int) event
->part
];
3970 Fcons (Qvertical_scroll_bar
,
3971 Fcons (portion_whole
,
3972 Fcons (make_number (event
->timestamp
),
3973 Fcons (part
, Qnil
)))));
3976 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3978 start_pos
= *start_pos_ptr
;
3979 *start_pos_ptr
= Qnil
;
3981 is_double
= (button
== last_mouse_button
3982 && XINT (event
->x
) == last_mouse_x
3983 && XINT (event
->y
) == last_mouse_y
3984 && button_down_time
!= 0
3985 && (EQ (Vdouble_click_time
, Qt
)
3986 || (INTEGERP (Vdouble_click_time
)
3987 && ((int)(event
->timestamp
- button_down_time
)
3988 < XINT (Vdouble_click_time
)))));
3989 last_mouse_button
= button
;
3990 last_mouse_x
= XINT (event
->x
);
3991 last_mouse_y
= XINT (event
->y
);
3993 /* If this is a button press, squirrel away the location, so
3994 we can decide later whether it was a click or a drag. */
3995 if (event
->modifiers
& down_modifier
)
3999 double_click_count
++;
4000 event
->modifiers
|= ((double_click_count
> 2)
4005 double_click_count
= 1;
4006 button_down_time
= event
->timestamp
;
4007 *start_pos_ptr
= Fcopy_alist (position
);
4010 /* Now we're releasing a button - check the co-ordinates to
4011 see if this was a click or a drag. */
4012 else if (event
->modifiers
& up_modifier
)
4014 /* If we did not see a down before this up,
4015 ignore the up. Probably this happened because
4016 the down event chose a menu item.
4017 It would be an annoyance to treat the release
4018 of the button that chose the menu item
4019 as a separate event. */
4021 if (!CONSP (start_pos
))
4024 event
->modifiers
&= ~up_modifier
;
4025 #if 0 /* Formerly we treated an up with no down as a click event. */
4026 if (!CONSP (start_pos
))
4027 event
->modifiers
|= click_modifier
;
4031 /* The third element of every position should be the (x,y)
4035 down
= Fnth (make_number (2), start_pos
);
4036 if (EQ (event
->x
, XCONS (down
)->car
)
4037 && EQ (event
->y
, XCONS (down
)->cdr
))
4039 event
->modifiers
|= click_modifier
;
4043 button_down_time
= 0;
4044 event
->modifiers
|= drag_modifier
;
4046 /* Don't check is_double; treat this as multiple
4047 if the down-event was multiple. */
4048 if (double_click_count
> 1)
4049 event
->modifiers
|= ((double_click_count
> 2)
4055 /* Every mouse event should either have the down_modifier or
4056 the up_modifier set. */
4060 /* Get the symbol we should use for the mouse click. */
4063 head
= modify_event_symbol (button
,
4066 lispy_mouse_names
, &mouse_syms
,
4067 (sizeof (lispy_mouse_names
)
4068 / sizeof (lispy_mouse_names
[0])));
4069 if (event
->modifiers
& drag_modifier
)
4074 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4077 Fcons (make_number (double_click_count
),
4087 case w32_scroll_bar_click
:
4089 int button
= event
->code
;
4091 Lisp_Object position
;
4092 Lisp_Object
*start_pos_ptr
;
4093 Lisp_Object start_pos
;
4095 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4100 Lisp_Object portion_whole
;
4103 window
= event
->frame_or_window
;
4104 portion_whole
= Fcons (event
->x
, event
->y
);
4105 part
= *scroll_bar_parts
[(int) event
->part
];
4109 Fcons (Qvertical_scroll_bar
,
4110 Fcons (portion_whole
,
4111 Fcons (make_number (event
->timestamp
),
4112 Fcons (part
, Qnil
)))));
4115 /* Always treat W32 scroll bar events as clicks. */
4116 event
->modifiers
|= click_modifier
;
4119 /* Get the symbol we should use for the mouse click. */
4122 head
= modify_event_symbol (button
,
4125 lispy_mouse_names
, &mouse_syms
,
4126 (sizeof (lispy_mouse_names
)
4127 / sizeof (lispy_mouse_names
[0])));
4136 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4139 Lisp_Object head
, position
;
4142 /* Ignore mouse events that were made on frame that
4143 have been deleted. */
4144 if (! FRAME_LIVE_P (f
))
4146 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4147 &column
, &row
, NULL
, 1);
4148 window
= window_from_coordinates (f
, column
, row
, &part
);
4150 if (!WINDOWP (window
))
4152 window
= event
->frame_or_window
;
4157 int pixcolumn
, pixrow
;
4158 column
-= XINT (XWINDOW (window
)->left
);
4159 row
-= XINT (XWINDOW (window
)->top
);
4160 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4161 XSETINT (event
->x
, pixcolumn
);
4162 XSETINT (event
->y
, pixrow
);
4167 posn
= Qvertical_line
;
4170 buffer_posn_from_coords (XWINDOW (window
),
4175 Lisp_Object head
, position
;
4180 Fcons (Fcons (event
->x
, event
->y
),
4181 Fcons (make_number (event
->timestamp
),
4184 head
= modify_event_symbol (0, event
->modifiers
,
4186 lispy_mouse_wheel_names
,
4187 &mouse_wheel_syms
, 1);
4190 Fcons (make_number (event
->code
),
4194 #endif /* WINDOWSNT */
4195 #endif /* HAVE_MOUSE */
4197 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4198 case menu_bar_event
:
4199 /* The event value is in the cdr of the frame_or_window slot. */
4200 if (!CONSP (event
->frame_or_window
))
4202 return XCONS (event
->frame_or_window
)->cdr
;
4205 /* The 'kind' field of the event is something we don't recognize. */
4214 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4216 Lisp_Object bar_window
;
4217 enum scroll_bar_part part
;
4221 /* Is it a scroll bar movement? */
4222 if (frame
&& ! NILP (bar_window
))
4224 Lisp_Object part_sym
;
4226 part_sym
= *scroll_bar_parts
[(int) part
];
4227 return Fcons (Qscroll_bar_movement
,
4228 (Fcons (Fcons (bar_window
,
4229 Fcons (Qvertical_scroll_bar
,
4230 Fcons (Fcons (x
, y
),
4231 Fcons (make_number (time
),
4237 /* Or is it an ordinary mouse movement? */
4247 /* It's in a frame; which window on that frame? */
4248 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4250 window
= window_from_coordinates (frame
, column
, row
, &area
);
4255 if (WINDOWP (window
))
4257 int pixcolumn
, pixrow
;
4258 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4259 row
-= XINT (XWINDOW (window
)->top
);
4260 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4261 XSETINT (x
, pixcolumn
);
4262 XSETINT (y
, pixrow
);
4267 posn
= Qvertical_line
;
4270 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4272 else if (frame
!= 0)
4274 XSETFRAME (window
, frame
);
4285 return Fcons (Qmouse_movement
,
4286 Fcons (Fcons (window
,
4288 Fcons (Fcons (x
, y
),
4289 Fcons (make_number (time
),
4295 #endif /* HAVE_MOUSE */
4297 /* Construct a switch frame event. */
4299 make_lispy_switch_frame (frame
)
4302 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4305 /* Manipulating modifiers. */
4307 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4309 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4310 SYMBOL's name of the end of the modifiers; the string from this
4311 position is the unmodified symbol name.
4313 This doesn't use any caches. */
4316 parse_modifiers_uncached (symbol
, modifier_end
)
4320 struct Lisp_String
*name
;
4324 CHECK_SYMBOL (symbol
, 1);
4327 name
= XSYMBOL (symbol
)->name
;
4329 for (i
= 0; i
+2 <= name
->size
; )
4331 int this_mod_end
= 0;
4334 /* See if the name continues with a modifier word.
4335 Check that the word appears, but don't check what follows it.
4336 Set this_mod and this_mod_end to record what we find. */
4338 switch (name
->data
[i
])
4340 #define SINGLE_LETTER_MOD(BIT) \
4341 (this_mod_end = i + 1, this_mod = BIT)
4344 SINGLE_LETTER_MOD (alt_modifier
);
4348 SINGLE_LETTER_MOD (ctrl_modifier
);
4352 SINGLE_LETTER_MOD (hyper_modifier
);
4356 SINGLE_LETTER_MOD (meta_modifier
);
4360 SINGLE_LETTER_MOD (shift_modifier
);
4364 SINGLE_LETTER_MOD (super_modifier
);
4367 #undef SINGLE_LETTER_MOD
4370 /* If we found no modifier, stop looking for them. */
4371 if (this_mod_end
== 0)
4374 /* Check there is a dash after the modifier, so that it
4375 really is a modifier. */
4376 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
4379 /* This modifier is real; look for another. */
4380 modifiers
|= this_mod
;
4381 i
= this_mod_end
+ 1;
4384 /* Should we include the `click' modifier? */
4385 if (! (modifiers
& (down_modifier
| drag_modifier
4386 | double_modifier
| triple_modifier
))
4387 && i
+ 7 == name
->size
4388 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4389 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4390 modifiers
|= click_modifier
;
4398 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4399 prepended to the string BASE[0..BASE_LEN-1].
4400 This doesn't use any caches. */
4402 apply_modifiers_uncached (modifiers
, base
, base_len
)
4407 /* Since BASE could contain nulls, we can't use intern here; we have
4408 to use Fintern, which expects a genuine Lisp_String, and keeps a
4411 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4417 /* Only the event queue may use the `up' modifier; it should always
4418 be turned into a click or drag event before presented to lisp code. */
4419 if (modifiers
& up_modifier
)
4422 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4423 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4424 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4425 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4426 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4427 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4428 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4429 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4430 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4431 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4432 /* The click modifier is denoted by the absence of other modifiers. */
4436 mod_len
= p
- new_mods
;
4440 Lisp_Object new_name
;
4442 new_name
= make_uninit_string (mod_len
+ base_len
);
4443 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4444 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
4446 return Fintern (new_name
, Qnil
);
4451 static char *modifier_names
[] =
4453 "up", "down", "drag", "click", "double", "triple", 0, 0,
4454 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4455 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4457 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4459 static Lisp_Object modifier_symbols
;
4461 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4463 lispy_modifier_list (modifiers
)
4466 Lisp_Object modifier_list
;
4469 modifier_list
= Qnil
;
4470 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4471 if (modifiers
& (1<<i
))
4472 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4475 return modifier_list
;
4479 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4480 where UNMODIFIED is the unmodified form of SYMBOL,
4481 MASK is the set of modifiers present in SYMBOL's name.
4482 This is similar to parse_modifiers_uncached, but uses the cache in
4483 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4484 Qevent_symbol_elements property. */
4487 parse_modifiers (symbol
)
4490 Lisp_Object elements
;
4492 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4493 if (CONSP (elements
))
4498 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4499 Lisp_Object unmodified
;
4502 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4503 XSYMBOL (symbol
)->name
->size
- end
),
4506 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4508 XSETFASTINT (mask
, modifiers
);
4509 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4511 /* Cache the parsing results on SYMBOL. */
4512 Fput (symbol
, Qevent_symbol_element_mask
,
4514 Fput (symbol
, Qevent_symbol_elements
,
4515 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4517 /* Since we know that SYMBOL is modifiers applied to unmodified,
4518 it would be nice to put that in unmodified's cache.
4519 But we can't, since we're not sure that parse_modifiers is
4526 /* Apply the modifiers MODIFIERS to the symbol BASE.
4527 BASE must be unmodified.
4529 This is like apply_modifiers_uncached, but uses BASE's
4530 Qmodifier_cache property, if present. It also builds
4531 Qevent_symbol_elements properties, since it has that info anyway.
4533 apply_modifiers copies the value of BASE's Qevent_kind property to
4534 the modified symbol. */
4536 apply_modifiers (modifiers
, base
)
4540 Lisp_Object cache
, index
, entry
, new_symbol
;
4542 /* Mask out upper bits. We don't know where this value's been. */
4543 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4545 /* The click modifier never figures into cache indices. */
4546 cache
= Fget (base
, Qmodifier_cache
);
4547 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4548 entry
= assq_no_quit (index
, cache
);
4551 new_symbol
= XCONS (entry
)->cdr
;
4554 /* We have to create the symbol ourselves. */
4555 new_symbol
= apply_modifiers_uncached (modifiers
,
4556 XSYMBOL (base
)->name
->data
,
4557 XSYMBOL (base
)->name
->size
);
4559 /* Add the new symbol to the base's cache. */
4560 entry
= Fcons (index
, new_symbol
);
4561 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4563 /* We have the parsing info now for free, so add it to the caches. */
4564 XSETFASTINT (index
, modifiers
);
4565 Fput (new_symbol
, Qevent_symbol_element_mask
,
4566 Fcons (base
, Fcons (index
, Qnil
)));
4567 Fput (new_symbol
, Qevent_symbol_elements
,
4568 Fcons (base
, lispy_modifier_list (modifiers
)));
4571 /* Make sure this symbol is of the same kind as BASE.
4573 You'd think we could just set this once and for all when we
4574 intern the symbol above, but reorder_modifiers may call us when
4575 BASE's property isn't set right; we can't assume that just
4576 because it has a Qmodifier_cache property it must have its
4577 Qevent_kind set right as well. */
4578 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4582 kind
= Fget (base
, Qevent_kind
);
4584 Fput (new_symbol
, Qevent_kind
, kind
);
4591 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4592 return a symbol with the modifiers placed in the canonical order.
4593 Canonical order is alphabetical, except for down and drag, which
4594 always come last. The 'click' modifier is never written out.
4596 Fdefine_key calls this to make sure that (for example) C-M-foo
4597 and M-C-foo end up being equivalent in the keymap. */
4600 reorder_modifiers (symbol
)
4603 /* It's hopefully okay to write the code this way, since everything
4604 will soon be in caches, and no consing will be done at all. */
4607 parsed
= parse_modifiers (symbol
);
4608 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4609 XCONS (parsed
)->car
);
4613 /* For handling events, we often want to produce a symbol whose name
4614 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4615 to some base, like the name of a function key or mouse button.
4616 modify_event_symbol produces symbols of this sort.
4618 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4619 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4622 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4623 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4625 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4626 persist between calls to modify_event_symbol that it can use to
4627 store a cache of the symbols it's generated for this NAME_TABLE
4628 before. The object stored there may be a vector or an alist.
4630 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4632 MODIFIERS is a set of modifier bits (as given in struct input_events)
4633 whose prefixes should be applied to the symbol name.
4635 SYMBOL_KIND is the value to be placed in the event_kind property of
4636 the returned symbol.
4638 The symbols we create are supposed to have an
4639 `event-symbol-elements' property, which lists the modifiers present
4640 in the symbol's name. */
4643 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4644 name_table
, symbol_table
, table_size
)
4647 Lisp_Object symbol_kind
;
4648 Lisp_Object name_alist
;
4650 Lisp_Object
*symbol_table
;
4651 unsigned int table_size
;
4654 Lisp_Object symbol_int
;
4656 /* Get rid of the "vendor-specific" bit here. */
4657 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4659 /* Is this a request for a valid symbol? */
4660 if (symbol_num
< 0 || symbol_num
>= table_size
)
4663 if (CONSP (*symbol_table
))
4664 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4666 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4667 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4668 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4669 we've never used that symbol before. */
4672 if (! VECTORP (*symbol_table
)
4673 || XVECTOR (*symbol_table
)->size
!= table_size
)
4677 XSETFASTINT (size
, table_size
);
4678 *symbol_table
= Fmake_vector (size
, Qnil
);
4681 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4684 /* Have we already used this symbol before? */
4687 /* No; let's create it. */
4688 if (!NILP (name_alist
))
4689 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4690 else if (name_table
!= 0 && name_table
[symbol_num
])
4691 value
= intern (name_table
[symbol_num
]);
4693 #ifdef HAVE_WINDOW_SYSTEM
4696 char *name
= x_get_keysym_name (symbol_num
);
4698 value
= intern (name
);
4705 sprintf (buf
, "key-%d", symbol_num
);
4706 value
= intern (buf
);
4709 if (CONSP (*symbol_table
))
4710 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4712 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4714 /* Fill in the cache entries for this symbol; this also
4715 builds the Qevent_symbol_elements property, which the user
4717 apply_modifiers (modifiers
& click_modifier
, value
);
4718 Fput (value
, Qevent_kind
, symbol_kind
);
4721 /* Apply modifiers to that symbol. */
4722 return apply_modifiers (modifiers
, value
);
4725 /* Convert a list that represents an event type,
4726 such as (ctrl meta backspace), into the usual representation of that
4727 event type as a number or a symbol. */
4729 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4730 "Convert the event description list EVENT-DESC to an event type.\n\
4731 EVENT-DESC should contain one base event type (a character or symbol)\n\
4732 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4733 drag, down, double or triple). The base must be last.\n\
4734 The return value is an event type (a character or symbol) which\n\
4735 has the same base event type and all the specified modifiers.")
4737 Lisp_Object event_desc
;
4745 while (CONSP (rest
))
4750 elt
= XCONS (rest
)->car
;
4751 rest
= XCONS (rest
)->cdr
;
4753 /* Given a symbol, see if it is a modifier name. */
4754 if (SYMBOLP (elt
) && CONSP (rest
))
4755 this = parse_solitary_modifier (elt
);
4759 else if (!NILP (base
))
4760 error ("Two bases given in one event");
4766 /* Let the symbol A refer to the character A. */
4767 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4768 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4770 if (INTEGERP (base
))
4772 /* Turn (shift a) into A. */
4773 if ((modifiers
& shift_modifier
) != 0
4774 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4776 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4777 modifiers
&= ~shift_modifier
;
4780 /* Turn (control a) into C-a. */
4781 if (modifiers
& ctrl_modifier
)
4782 return make_number ((modifiers
& ~ctrl_modifier
)
4783 | make_ctrl_char (XINT (base
)));
4785 return make_number (modifiers
| XINT (base
));
4787 else if (SYMBOLP (base
))
4788 return apply_modifiers (modifiers
, base
);
4790 error ("Invalid base event");
4793 /* Try to recognize SYMBOL as a modifier name.
4794 Return the modifier flag bit, or 0 if not recognized. */
4797 parse_solitary_modifier (symbol
)
4800 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4802 switch (name
->data
[0])
4804 #define SINGLE_LETTER_MOD(BIT) \
4805 if (name->size == 1) \
4808 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4809 if (LEN == name->size \
4810 && ! strncmp (name->data, NAME, LEN)) \
4814 SINGLE_LETTER_MOD (alt_modifier
);
4818 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4822 SINGLE_LETTER_MOD (ctrl_modifier
);
4826 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4827 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4831 SINGLE_LETTER_MOD (hyper_modifier
);
4835 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4839 SINGLE_LETTER_MOD (meta_modifier
);
4843 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4847 SINGLE_LETTER_MOD (shift_modifier
);
4851 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4852 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4853 SINGLE_LETTER_MOD (super_modifier
);
4857 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4858 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4859 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4863 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4866 #undef SINGLE_LETTER_MOD
4867 #undef MULTI_LETTER_MOD
4873 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4874 Such a list is not valid as an event,
4875 but it can be a Lucid-style event type list. */
4878 lucid_event_type_list_p (object
)
4883 if (! CONSP (object
))
4886 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4889 elt
= XCONS (tail
)->car
;
4890 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4897 /* Store into *addr a value nonzero if terminal input chars are available.
4898 Serves the purpose of ioctl (0, FIONREAD, addr)
4899 but works even if FIONREAD does not exist.
4900 (In fact, this may actually read some input.)
4902 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4905 get_input_pending (addr
, do_timers_now
)
4909 /* First of all, have we already counted some input? */
4910 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4912 /* If input is being read as it arrives, and we have none, there is none. */
4913 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4916 /* Try to read some input and see how much we get. */
4918 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4921 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4924 gobble_input (expected
)
4929 if (interrupt_input
)
4932 mask
= sigblock (sigmask (SIGIO
));
4933 read_avail_input (expected
);
4937 #ifdef POLL_FOR_INPUT
4938 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4941 mask
= sigblock (sigmask (SIGALRM
));
4942 read_avail_input (expected
);
4948 read_avail_input (expected
);
4952 /* Put a buffer_switch_event in the buffer
4953 so that read_key_sequence will notice the new current buffer. */
4956 record_asynch_buffer_change ()
4958 struct input_event event
;
4961 event
.kind
= buffer_switch_event
;
4962 event
.frame_or_window
= Qnil
;
4965 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4966 The purpose of the event is to make read_key_sequence look up the
4967 keymaps again. If we aren't in read_key_sequence, we don't need one,
4968 and the event could cause trouble by messing up (input-pending-p). */
4969 tem
= Fwaiting_for_user_input_p ();
4973 /* We never need these events if we have no asynchronous subprocesses. */
4977 /* Make sure no interrupt happens while storing the event. */
4979 if (interrupt_input
)
4982 mask
= sigblock (sigmask (SIGIO
));
4983 kbd_buffer_store_event (&event
);
4990 kbd_buffer_store_event (&event
);
4997 /* Read any terminal input already buffered up by the system
4998 into the kbd_buffer, but do not wait.
5000 EXPECTED should be nonzero if the caller knows there is some input.
5002 Except on VMS, all input is read by this function.
5003 If interrupt_input is nonzero, this function MUST be called
5004 only when SIGIO is blocked.
5006 Returns the number of keyboard chars read, or -1 meaning
5007 this is a bad time to try to read input. */
5010 read_avail_input (expected
)
5013 struct input_event buf
[KBD_BUFFER_SIZE
];
5017 if (read_socket_hook
)
5018 /* No need for FIONREAD or fcntl; just say don't wait. */
5019 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
5022 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
5023 the kbd_buffer can really hold. That may prevent loss
5024 of characters on some systems when input is stuffed at us. */
5025 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
5028 /* Determine how many characters we should *try* to read. */
5031 #else /* not WINDOWSNT */
5033 n_to_read
= dos_keysns ();
5036 #else /* not MSDOS */
5038 /* Find out how much input is available. */
5039 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
5040 /* Formerly simply reported no input, but that sometimes led to
5041 a failure of Emacs to terminate.
5042 SIGHUP seems appropriate if we can't reach the terminal. */
5043 /* ??? Is it really right to send the signal just to this process
5044 rather than to the whole process group?
5045 Perhaps on systems with FIONREAD Emacs is alone in its group. */
5046 kill (getpid (), SIGHUP
);
5049 if (n_to_read
> sizeof cbuf
)
5050 n_to_read
= sizeof cbuf
;
5051 #else /* no FIONREAD */
5052 #if defined (USG) || defined (DGUX)
5053 /* Read some input if available, but don't wait. */
5054 n_to_read
= sizeof cbuf
;
5055 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
5060 #endif /* not MSDOS */
5061 #endif /* not WINDOWSNT */
5063 /* Now read; for one reason or another, this will not block.
5064 NREAD is set to the number of chars read. */
5068 cbuf
[0] = dos_keyread ();
5071 nread
= read (input_fd
, cbuf
, n_to_read
);
5073 /* POSIX infers that processes which are not in the session leader's
5074 process group won't get SIGHUP's at logout time. BSDI adheres to
5075 this part standard and returns -1 from read(0) with errno==EIO
5076 when the control tty is taken away.
5077 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
5078 if (nread
== -1 && errno
== EIO
)
5080 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
5081 /* The kernel sometimes fails to deliver SIGHUP for ptys.
5082 This looks incorrect, but it isn't, because _BSD causes
5083 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
5084 and that causes a value other than 0 when there is no input. */
5090 /* We used to retry the read if it was interrupted.
5091 But this does the wrong thing when O_NDELAY causes
5092 an EAGAIN error. Does anybody know of a situation
5093 where a retry is actually needed? */
5095 nread
< 0 && (errno
== EAGAIN
5109 #if defined (USG) || defined (DGUX)
5110 fcntl (input_fd
, F_SETFL
, 0);
5111 #endif /* USG or DGUX */
5112 #endif /* no FIONREAD */
5113 for (i
= 0; i
< nread
; i
++)
5115 buf
[i
].kind
= ascii_keystroke
;
5116 buf
[i
].modifiers
= 0;
5117 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
5118 buf
[i
].modifiers
= meta_modifier
;
5122 buf
[i
].code
= cbuf
[i
];
5123 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
5127 /* Scan the chars for C-g and store them in kbd_buffer. */
5128 for (i
= 0; i
< nread
; i
++)
5130 kbd_buffer_store_event (&buf
[i
]);
5131 /* Don't look at input that follows a C-g too closely.
5132 This reduces lossage due to autorepeat on C-g. */
5133 if (buf
[i
].kind
== ascii_keystroke
5134 && buf
[i
].code
== quit_char
)
5140 #endif /* not VMS */
5142 #ifdef SIGIO /* for entire page */
5143 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5146 input_available_signal (signo
)
5149 /* Must preserve main program's value of errno. */
5150 int old_errno
= errno
;
5152 extern int select_alarmed
;
5155 #if defined (USG) && !defined (POSIX_SIGNALS)
5156 /* USG systems forget handlers when they are used;
5157 must reestablish each time */
5158 signal (signo
, input_available_signal
);
5165 if (input_available_clear_time
)
5166 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5171 nread
= read_avail_input (1);
5172 /* -1 means it's not ok to read the input now.
5173 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5174 0 means there was no keyboard input available. */
5179 select_alarmed
= 1; /* Force the select emulator back to life */
5190 /* Send ourselves a SIGIO.
5192 This function exists so that the UNBLOCK_INPUT macro in
5193 blockinput.h can have some way to take care of input we put off
5194 dealing with, without assuming that every file which uses
5195 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5197 reinvoke_input_signal ()
5200 kill (getpid (), SIGIO
);
5206 /* Return the prompt-string of a sparse keymap.
5207 This is the first element which is a string.
5208 Return nil if there is none. */
5216 register Lisp_Object tem
;
5225 static void menu_bar_item ();
5226 static void menu_bar_one_keymap ();
5228 /* These variables hold the vector under construction within
5229 menu_bar_items and its subroutines, and the current index
5230 for storing into that vector. */
5231 static Lisp_Object menu_bar_items_vector
;
5232 static int menu_bar_items_index
;
5234 /* Return a vector of menu items for a menu bar, appropriate
5235 to the current buffer. Each item has three elements in the vector:
5238 OLD is an old vector we can optionally reuse, or nil. */
5241 menu_bar_items (old
)
5244 /* The number of keymaps we're scanning right now, and the number of
5245 keymaps we have allocated space for. */
5248 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5249 in the current keymaps, or nil where it is not a prefix. */
5252 Lisp_Object def
, tem
, tail
;
5261 struct gcpro gcpro1
;
5263 /* In order to build the menus, we need to call the keymap
5264 accessors. They all call QUIT. But this function is called
5265 during redisplay, during which a quit is fatal. So inhibit
5266 quitting while building the menus.
5267 We do this instead of specbind because (1) errors will clear it anyway
5268 and (2) this avoids risk of specpdl overflow. */
5269 oquit
= Vinhibit_quit
;
5273 menu_bar_items_vector
= old
;
5275 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5276 menu_bar_items_index
= 0;
5278 GCPRO1 (menu_bar_items_vector
);
5280 /* Build our list of keymaps.
5281 If we recognize a function key and replace its escape sequence in
5282 keybuf with its symbol, or if the sequence starts with a mouse
5283 click and we need to switch buffers, we jump back here to rebuild
5284 the initial keymaps from the current buffer. */
5288 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5289 if (!NILP (Voverriding_local_map_menu_flag
))
5291 /* Yes, use them (if non-nil) as well as the global map. */
5292 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5294 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5295 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5296 if (!NILP (Voverriding_local_map
))
5297 maps
[nmaps
++] = Voverriding_local_map
;
5301 /* No, so use major and minor mode keymaps. */
5302 nmaps
= current_minor_maps (NULL
, &tmaps
);
5303 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5304 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5305 #ifdef USE_TEXT_PROPERTIES
5306 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5308 maps
[nmaps
++] = current_buffer
->keymap
;
5311 maps
[nmaps
++] = current_global_map
;
5314 /* Look up in each map the dummy prefix key `menu-bar'. */
5318 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5320 if (! NILP (maps
[mapno
]))
5321 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
5325 tem
= Fkeymapp (def
);
5327 menu_bar_one_keymap (def
);
5330 /* Move to the end those items that should be at the end. */
5332 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5335 int end
= menu_bar_items_index
;
5337 for (i
= 0; i
< end
; i
+= 4)
5338 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5340 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5341 /* Move the item at index I to the end,
5342 shifting all the others forward. */
5343 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5344 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5345 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5346 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5348 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5349 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5350 (end
- i
- 4) * sizeof (Lisp_Object
));
5351 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5352 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5353 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5354 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5359 /* Add nil, nil, nil, nil at the end. */
5360 i
= menu_bar_items_index
;
5361 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5364 int newsize
= 2 * i
;
5365 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5366 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5367 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5368 menu_bar_items_vector
= tem
;
5370 /* Add this item. */
5371 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5372 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5373 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5374 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5375 menu_bar_items_index
= i
;
5377 Vinhibit_quit
= oquit
;
5379 return menu_bar_items_vector
;
5382 /* Scan one map KEYMAP, accumulating any menu items it defines
5383 in menu_bar_items_vector. */
5386 menu_bar_one_keymap (keymap
)
5389 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
5391 /* Loop over all keymap entries that have menu strings. */
5392 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5394 item
= XCONS (tail
)->car
;
5397 key
= XCONS (item
)->car
;
5398 binding
= XCONS (item
)->cdr
;
5399 if (CONSP (binding
))
5401 item_string
= XCONS (binding
)->car
;
5402 if (STRINGP (item_string
))
5403 menu_bar_item (key
, item_string
, Fcdr (binding
));
5405 else if (EQ (binding
, Qundefined
))
5406 menu_bar_item (key
, Qnil
, binding
);
5408 else if (VECTORP (item
))
5410 /* Loop over the char values represented in the vector. */
5411 int len
= XVECTOR (item
)->size
;
5413 for (c
= 0; c
< len
; c
++)
5415 Lisp_Object character
;
5416 XSETFASTINT (character
, c
);
5417 binding
= XVECTOR (item
)->contents
[c
];
5418 if (CONSP (binding
))
5420 item_string
= XCONS (binding
)->car
;
5421 if (STRINGP (item_string
))
5422 menu_bar_item (key
, item_string
, Fcdr (binding
));
5424 else if (EQ (binding
, Qundefined
))
5425 menu_bar_item (key
, Qnil
, binding
);
5431 /* This is used as the handler when calling internal_condition_case_1. */
5434 menu_bar_item_1 (arg
)
5440 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5441 If there's already an item for KEY, add this DEF to it. */
5444 menu_bar_item (key
, item_string
, def
)
5445 Lisp_Object key
, item_string
, def
;
5448 Lisp_Object enabled
;
5451 /* Skip menu-bar equiv keys data. */
5452 if (CONSP (def
) && CONSP (XCONS (def
)->car
))
5453 def
= XCONS (def
)->cdr
;
5455 if (EQ (def
, Qundefined
))
5457 /* If a map has an explicit `undefined' as definition,
5458 discard any previously made menu bar item. */
5460 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5461 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5463 if (menu_bar_items_index
> i
+ 4)
5464 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5465 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5466 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5467 menu_bar_items_index
-= 4;
5471 /* If there's no definition for this key yet,
5472 just ignore `undefined'. */
5476 /* See if this entry is enabled. */
5481 /* No property, or nil, means enable.
5482 Otherwise, enable if value is not nil. */
5483 tem
= Fget (def
, Qmenu_enable
);
5485 /* (condition-case nil (eval tem)
5487 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5491 /* Ignore this item if it's not enabled. */
5495 /* Find any existing item for this KEY. */
5496 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5497 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5500 /* If we did not find this KEY, add it at the end. */
5501 if (i
== menu_bar_items_index
)
5503 /* If vector is too small, get a bigger one. */
5504 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5507 int newsize
= 2 * i
;
5508 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5509 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5510 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5511 menu_bar_items_vector
= tem
;
5513 /* Add this item. */
5514 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5515 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5516 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5517 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5518 menu_bar_items_index
= i
;
5520 /* We did find an item for this KEY. Add DEF to its list of maps. */
5524 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5525 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5529 /* Read a character using menus based on maps in the array MAPS.
5530 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5531 Return t if we displayed a menu but the user rejected it.
5533 PREV_EVENT is the previous input event, or nil if we are reading
5534 the first event of a key sequence.
5536 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5537 if we used a mouse menu to read the input, or zero otherwise. If
5538 USED_MOUSE_MENU is null, we don't dereference it.
5540 The prompting is done based on the prompt-string of the map
5541 and the strings associated with various map elements.
5543 This can be done with X menus or with menus put in the minibuf.
5544 These are done in different ways, depending on how the input will be read.
5545 Menus using X are done after auto-saving in read-char, getting the input
5546 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5547 and do auto-saving in the inner call of read_char. */
5550 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5553 Lisp_Object prev_event
;
5554 int *used_mouse_menu
;
5557 register Lisp_Object name
;
5558 Lisp_Object rest
, vector
;
5560 if (used_mouse_menu
)
5561 *used_mouse_menu
= 0;
5563 /* Use local over global Menu maps */
5565 if (! menu_prompting
)
5568 /* Optionally disregard all but the global map. */
5569 if (inhibit_local_menu_bar_menus
)
5571 maps
+= (nmaps
- 1);
5575 /* Get the menu name from the first map that has one (a prompt string). */
5576 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5578 name
= map_prompt (maps
[mapno
]);
5583 /* If we don't have any menus, just read a character normally. */
5588 /* If we got to this point via a mouse click,
5589 use a real menu for mouse selection. */
5590 if (EVENT_HAS_PARAMETERS (prev_event
)
5591 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5593 /* Display the menu and get the selection. */
5594 Lisp_Object
*realmaps
5595 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5599 /* Use the maps that are not nil. */
5600 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5601 if (!NILP (maps
[mapno
]))
5602 realmaps
[nmaps1
++] = maps
[mapno
];
5604 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5609 record_menu_key (XCONS (value
)->car
);
5611 /* If we got multiple events, unread all but
5613 There is no way to prevent those unread events
5614 from showing up later in last_nonmenu_event.
5615 So turn symbol and integer events into lists,
5616 to indicate that they came from a mouse menu,
5617 so that when present in last_nonmenu_event
5618 they won't confuse things. */
5619 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5620 tem
= XCONS (tem
)->cdr
)
5622 record_menu_key (XCONS (tem
)->car
);
5623 if (SYMBOLP (XCONS (tem
)->car
)
5624 || INTEGERP (XCONS (tem
)->car
))
5626 = Fcons (XCONS (tem
)->car
, Qnil
);
5629 /* If we got more than one event, put all but the first
5630 onto this list to be read later.
5631 Return just the first event now. */
5632 Vunread_command_events
5633 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5634 value
= XCONS (value
)->car
;
5636 else if (NILP (value
))
5638 if (used_mouse_menu
)
5639 *used_mouse_menu
= 1;
5642 #endif /* HAVE_MENUS */
5646 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5647 We make this bigger when necessary, and never free it. */
5648 static char *read_char_minibuf_menu_text
;
5649 /* Size of that buffer. */
5650 static int read_char_minibuf_menu_width
;
5653 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5659 register Lisp_Object name
;
5661 int width
= FRAME_WIDTH (selected_frame
) - 4;
5664 Lisp_Object rest
, vector
;
5667 if (! menu_prompting
)
5670 /* Make sure we have a big enough buffer for the menu text. */
5671 if (read_char_minibuf_menu_text
== 0)
5673 read_char_minibuf_menu_width
= width
+ 4;
5674 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5676 else if (width
+ 4 > read_char_minibuf_menu_width
)
5678 read_char_minibuf_menu_width
= width
+ 4;
5679 read_char_minibuf_menu_text
5680 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5682 menu
= read_char_minibuf_menu_text
;
5684 /* Get the menu name from the first map that has one (a prompt string). */
5685 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5687 name
= map_prompt (maps
[mapno
]);
5692 /* If we don't have any menus, just read a character normally. */
5696 /* Prompt string always starts with map's prompt, and a space. */
5697 strcpy (menu
, XSTRING (name
)->data
);
5698 nlength
= XSTRING (name
)->size
;
5699 menu
[nlength
++] = ':';
5700 menu
[nlength
++] = ' ';
5703 /* Start prompting at start of first map. */
5707 /* Present the documented bindings, a line at a time. */
5714 Lisp_Object orig_defn_macro
;
5716 /* Loop over elements of map. */
5721 /* If reached end of map, start at beginning of next map. */
5725 /* At end of last map, wrap around to first map if just starting,
5726 or end this line if already have something on it. */
5730 if (notfirst
|| nobindings
) break;
5735 /* Look at the next element of the map. */
5737 elt
= XVECTOR (vector
)->contents
[idx
];
5739 elt
= Fcar_safe (rest
);
5741 if (idx
< 0 && VECTORP (elt
))
5743 /* If we found a dense table in the keymap,
5744 advanced past it, but start scanning its contents. */
5745 rest
= Fcdr_safe (rest
);
5751 /* An ordinary element. */
5756 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5757 event
= Fcar_safe (elt
);
5761 s
= Fcar_safe (elt
); /* vector */
5762 XSETINT (event
, idx
);
5765 /* Ignore the element if it has no prompt string. */
5766 if (STRINGP (s
) && INTEGERP (event
))
5768 /* 1 if the char to type matches the string. */
5770 Lisp_Object upcased_event
, downcased_event
;
5773 upcased_event
= Fupcase (event
);
5774 downcased_event
= Fdowncase (event
);
5775 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5776 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5778 desc
= Fsingle_key_description (event
);
5780 /* If we have room for the prompt string, add it to this line.
5781 If this is the first on the line, always add it. */
5782 if ((XSTRING (s
)->size
+ i
+ 2
5783 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5789 /* Punctuate between strings. */
5792 strcpy (menu
+ i
, ", ");
5798 /* If the char to type doesn't match the string's
5799 first char, explicitly show what char to type. */
5802 /* Add as much of string as fits. */
5803 thiswidth
= XSTRING (desc
)->size
;
5804 if (thiswidth
+ i
> width
)
5805 thiswidth
= width
- i
;
5806 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5808 strcpy (menu
+ i
, " = ");
5812 /* Add as much of string as fits. */
5813 thiswidth
= XSTRING (s
)->size
;
5814 if (thiswidth
+ i
> width
)
5815 thiswidth
= width
- i
;
5816 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5822 /* If this element does not fit, end the line now,
5823 and save the element for the next line. */
5824 strcpy (menu
+ i
, "...");
5829 /* Move past this element. */
5830 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5831 /* Handle reaching end of dense table. */
5836 rest
= Fcdr_safe (rest
);
5840 /* Prompt with that and read response. */
5843 /* Make believe its not a keyboard macro in case the help char
5844 is pressed. Help characters are not recorded because menu prompting
5845 is not used on replay.
5847 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5848 current_kboard
->defining_kbd_macro
= Qnil
;
5850 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5851 while (BUFFERP (obj
));
5852 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5854 if (!INTEGERP (obj
))
5859 if (! EQ (obj
, menu_prompt_more_char
)
5860 && (!INTEGERP (menu_prompt_more_char
)
5861 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5863 if (!NILP (current_kboard
->defining_kbd_macro
))
5864 store_kbd_macro_char (obj
);
5867 /* Help char - go round again */
5871 /* Reading key sequences. */
5873 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5874 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5875 keymap, or nil otherwise. Return the index of the first keymap in
5876 which KEY has any binding, or NMAPS if no map has a binding.
5878 If KEY is a meta ASCII character, treat it like meta-prefix-char
5879 followed by the corresponding non-meta character. Keymaps in
5880 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5883 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5886 NEXT may be the same array as CURRENT. */
5889 follow_key (key
, nmaps
, current
, defs
, next
)
5891 Lisp_Object
*current
, *defs
, *next
;
5894 int i
, first_binding
;
5897 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5898 followed by the corresponding non-meta character.
5899 Put the results into DEFS, since we are going to alter that anyway.
5900 Do not alter CURRENT or NEXT. */
5901 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5903 for (i
= 0; i
< nmaps
; i
++)
5904 if (! NILP (current
[i
]))
5907 def
= get_keyelt (access_keymap (current
[i
],
5908 meta_prefix_char
, 1, 0), 0);
5910 /* Note that since we pass the resulting bindings through
5911 get_keymap_1, non-prefix bindings for meta-prefix-char
5913 defs
[i
] = get_keymap_1 (def
, 0, 1);
5919 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5922 first_binding
= nmaps
;
5923 for (i
= nmaps
- 1; i
>= 0; i
--)
5925 if (! NILP (current
[i
]))
5933 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
5934 if (! NILP (defs
[i
]))
5941 /* Given the set of bindings we've found, produce the next set of maps. */
5942 if (first_binding
< nmaps
)
5943 for (i
= 0; i
< nmaps
; i
++)
5944 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5946 return first_binding
;
5949 /* Read a sequence of keys that ends with a non prefix character,
5950 storing it in KEYBUF, a buffer of size BUFSIZE.
5952 Return the length of the key sequence stored.
5953 Return -1 if the user rejected a command menu.
5955 Echo starting immediately unless `prompt' is 0.
5957 Where a key sequence ends depends on the currently active keymaps.
5958 These include any minor mode keymaps active in the current buffer,
5959 the current buffer's local map, and the global map.
5961 If a key sequence has no other bindings, we check Vfunction_key_map
5962 to see if some trailing subsequence might be the beginning of a
5963 function key's sequence. If so, we try to read the whole function
5964 key, and substitute its symbolic name into the key sequence.
5966 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5967 `double-' events into similar click events, if that would make them
5968 bound. We try to turn `triple-' events first into `double-' events,
5971 If we get a mouse click in a mode line, vertical divider, or other
5972 non-text area, we treat the click as if it were prefixed by the
5973 symbol denoting that area - `mode-line', `vertical-line', or
5976 If the sequence starts with a mouse click, we read the key sequence
5977 with respect to the buffer clicked on, not the current buffer.
5979 If the user switches frames in the midst of a key sequence, we put
5980 off the switch-frame event until later; the next call to
5981 read_char will return it.
5983 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
5984 from the selected window's buffer. */
5987 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5988 can_return_switch_frame
, fix_current_buffer
)
5989 Lisp_Object
*keybuf
;
5992 int dont_downcase_last
;
5993 int can_return_switch_frame
;
5994 int fix_current_buffer
;
5996 int count
= specpdl_ptr
- specpdl
;
5998 /* How many keys there are in the current key sequence. */
6001 /* The length of the echo buffer when we started reading, and
6002 the length of this_command_keys when we started reading. */
6006 /* The number of keymaps we're scanning right now, and the number of
6007 keymaps we have allocated space for. */
6009 int nmaps_allocated
= 0;
6011 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
6012 the current keymaps. */
6015 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6016 in the current keymaps, or nil where it is not a prefix. */
6017 Lisp_Object
*submaps
;
6019 /* The local map to start out with at start of key sequence. */
6020 Lisp_Object orig_local_map
;
6022 /* 1 if we have already considered switching to the local-map property
6023 of the place where a mouse click occurred. */
6024 int localized_local_map
= 0;
6026 /* The index in defs[] of the first keymap that has a binding for
6027 this key sequence. In other words, the lowest i such that
6028 defs[i] is non-nil. */
6031 /* If t < mock_input, then KEYBUF[t] should be read as the next
6034 We use this to recover after recognizing a function key. Once we
6035 realize that a suffix of the current key sequence is actually a
6036 function key's escape sequence, we replace the suffix with the
6037 function key's binding from Vfunction_key_map. Now keybuf
6038 contains a new and different key sequence, so the echo area,
6039 this_command_keys, and the submaps and defs arrays are wrong. In
6040 this situation, we set mock_input to t, set t to 0, and jump to
6041 restart_sequence; the loop will read keys from keybuf up until
6042 mock_input, thus rebuilding the state; and then it will resume
6043 reading characters from the keyboard. */
6046 /* If the sequence is unbound in submaps[], then
6047 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
6048 and fkey_map is its binding.
6050 These might be > t, indicating that all function key scanning
6051 should hold off until t reaches them. We do this when we've just
6052 recognized a function key, to avoid searching for the function
6053 key's again in Vfunction_key_map. */
6054 int fkey_start
= 0, fkey_end
= 0;
6055 Lisp_Object fkey_map
;
6057 /* Likewise, for key_translation_map. */
6058 int keytran_start
= 0, keytran_end
= 0;
6059 Lisp_Object keytran_map
;
6061 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
6062 we put it off for later. While we're reading, we keep the event here. */
6063 Lisp_Object delayed_switch_frame
;
6065 /* See the comment below... */
6066 #if defined (GOBBLE_FIRST_EVENT)
6067 Lisp_Object first_event
;
6070 Lisp_Object original_uppercase
;
6071 int original_uppercase_position
= -1;
6073 /* Gets around Microsoft compiler limitations. */
6076 struct buffer
*starting_buffer
;
6078 /* Nonzero if we seem to have got the beginning of a binding
6079 in function_key_map. */
6080 int function_key_possible
= 0;
6081 int key_translation_possible
= 0;
6083 /* Save the status of key translation before each step,
6084 so that we can restore this after downcasing. */
6085 Lisp_Object prev_fkey_map
;
6086 int prev_fkey_start
;
6089 Lisp_Object prev_keytran_map
;
6090 int prev_keytran_start
;
6091 int prev_keytran_end
;
6095 last_nonmenu_event
= Qnil
;
6097 delayed_switch_frame
= Qnil
;
6098 fkey_map
= Vfunction_key_map
;
6099 keytran_map
= Vkey_translation_map
;
6101 /* If there is no function-key-map, turn off function key scanning. */
6102 if (NILP (Fkeymapp (Vfunction_key_map
)))
6103 fkey_start
= fkey_end
= bufsize
+ 1;
6105 /* If there is no key-translation-map, turn off scanning. */
6106 if (NILP (Fkeymapp (Vkey_translation_map
)))
6107 keytran_start
= keytran_end
= bufsize
+ 1;
6112 echo_prompt (XSTRING (prompt
)->data
);
6113 else if (cursor_in_echo_area
&& echo_keystrokes
)
6114 /* This doesn't put in a dash if the echo buffer is empty, so
6115 you don't always see a dash hanging out in the minibuffer. */
6119 /* Record the initial state of the echo area and this_command_keys;
6120 we will need to restore them if we replay a key sequence. */
6122 echo_start
= echo_length ();
6123 keys_start
= this_command_key_count
;
6124 this_single_command_key_start
= keys_start
;
6126 #if defined (GOBBLE_FIRST_EVENT)
6127 /* This doesn't quite work, because some of the things that read_char
6128 does cannot safely be bypassed. It seems too risky to try to make
6131 /* Read the first char of the sequence specially, before setting
6132 up any keymaps, in case a filter runs and switches buffers on us. */
6133 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
6135 #endif /* GOBBLE_FIRST_EVENT */
6137 orig_local_map
= get_local_map (PT
, current_buffer
);
6139 /* We jump here when the key sequence has been thoroughly changed, and
6140 we need to rescan it starting from the beginning. When we jump here,
6141 keybuf[0..mock_input] holds the sequence we should reread. */
6144 starting_buffer
= current_buffer
;
6145 function_key_possible
= 0;
6146 key_translation_possible
= 0;
6148 /* Build our list of keymaps.
6149 If we recognize a function key and replace its escape sequence in
6150 keybuf with its symbol, or if the sequence starts with a mouse
6151 click and we need to switch buffers, we jump back here to rebuild
6152 the initial keymaps from the current buffer. */
6156 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6157 || !NILP (Voverriding_local_map
))
6159 if (3 > nmaps_allocated
)
6161 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6162 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6163 nmaps_allocated
= 3;
6166 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6167 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6168 if (!NILP (Voverriding_local_map
))
6169 submaps
[nmaps
++] = Voverriding_local_map
;
6173 nmaps
= current_minor_maps (0, &maps
);
6174 if (nmaps
+ 2 > nmaps_allocated
)
6176 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6177 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6178 nmaps_allocated
= nmaps
+ 2;
6180 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6181 #ifdef USE_TEXT_PROPERTIES
6182 submaps
[nmaps
++] = orig_local_map
;
6184 submaps
[nmaps
++] = current_buffer
->keymap
;
6187 submaps
[nmaps
++] = current_global_map
;
6190 /* Find an accurate initial value for first_binding. */
6191 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6192 if (! NILP (submaps
[first_binding
]))
6195 /* Start from the beginning in keybuf. */
6198 /* These are no-ops the first time through, but if we restart, they
6199 revert the echo area and this_command_keys to their original state. */
6200 this_command_key_count
= keys_start
;
6201 if (INTERACTIVE
&& t
< mock_input
)
6202 echo_truncate (echo_start
);
6204 /* If the best binding for the current key sequence is a keymap, or
6205 we may be looking at a function key's escape sequence, keep on
6207 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6208 || (first_binding
>= nmaps
6210 /* mock input is never part of a function key's sequence. */
6211 && mock_input
<= fkey_start
)
6212 || (first_binding
>= nmaps
6213 && keytran_start
< t
&& key_translation_possible
)
6214 /* Don't return in the middle of a possible function key sequence,
6215 if the only bindings we found were via case conversion.
6216 Thus, if ESC O a has a function-key-map translation
6217 and ESC o has a binding, don't return after ESC O,
6218 so that we can translate ESC O plus the next character. */
6222 int used_mouse_menu
= 0;
6224 /* Where the last real key started. If we need to throw away a
6225 key that has expanded into more than one element of keybuf
6226 (say, a mouse click on the mode line which is being treated
6227 as [mode-line (mouse-...)], then we backtrack to this point
6229 int last_real_key_start
;
6231 /* These variables are analogous to echo_start and keys_start;
6232 while those allow us to restart the entire key sequence,
6233 echo_local_start and keys_local_start allow us to throw away
6235 int echo_local_start
, keys_local_start
, local_first_binding
;
6238 error ("Key sequence too long");
6241 echo_local_start
= echo_length ();
6242 keys_local_start
= this_command_key_count
;
6243 local_first_binding
= first_binding
;
6246 /* These are no-ops, unless we throw away a keystroke below and
6247 jumped back up to replay_key; in that case, these restore the
6248 variables to their original state, allowing us to replay the
6250 if (INTERACTIVE
&& t
< mock_input
)
6251 echo_truncate (echo_local_start
);
6252 this_command_key_count
= keys_local_start
;
6253 first_binding
= local_first_binding
;
6255 /* By default, assume each event is "real". */
6256 last_real_key_start
= t
;
6258 /* Does mock_input indicate that we are re-reading a key sequence? */
6262 add_command_key (key
);
6263 if (echo_keystrokes
)
6267 /* If not, we should actually read a character. */
6270 struct buffer
*buf
= current_buffer
;
6274 KBOARD
*interrupted_kboard
= current_kboard
;
6275 struct frame
*interrupted_frame
= selected_frame
;
6276 if (setjmp (wrong_kboard_jmpbuf
))
6278 if (!NILP (delayed_switch_frame
))
6280 interrupted_kboard
->kbd_queue
6281 = Fcons (delayed_switch_frame
,
6282 interrupted_kboard
->kbd_queue
);
6283 delayed_switch_frame
= Qnil
;
6286 interrupted_kboard
->kbd_queue
6287 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6289 /* If the side queue is non-empty, ensure it begins with a
6290 switch-frame, so we'll replay it in the right context. */
6291 if (CONSP (interrupted_kboard
->kbd_queue
)
6292 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6293 !(EVENT_HAS_PARAMETERS (key
)
6294 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6298 XSETFRAME (frame
, interrupted_frame
);
6299 interrupted_kboard
->kbd_queue
6300 = Fcons (make_lispy_switch_frame (frame
),
6301 interrupted_kboard
->kbd_queue
);
6304 orig_local_map
= get_local_map (PT
, current_buffer
);
6305 goto replay_sequence
;
6308 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6312 /* read_char returns t when it shows a menu and the user rejects it.
6317 /* read_char returns -1 at the end of a macro.
6318 Emacs 18 handles this by returning immediately with a
6319 zero, so that's what we'll do. */
6320 if (INTEGERP (key
) && XINT (key
) == -1)
6323 /* The Microsoft C compiler can't handle the goto that
6329 /* If the current buffer has been changed from under us, the
6330 keymap may have changed, so replay the sequence. */
6334 /* Reset the current buffer from the selected window
6335 in case something changed the former and not the latter.
6336 This is to be more consistent with the behavior
6337 of the command_loop_1. */
6338 if (fix_current_buffer
)
6339 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
6340 Fset_buffer (XWINDOW (selected_window
)->buffer
);
6342 orig_local_map
= get_local_map (PT
, current_buffer
);
6343 goto replay_sequence
;
6346 /* If we have a quit that was typed in another frame, and
6347 quit_throw_to_read_char switched buffers,
6348 replay to get the right keymap. */
6349 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6354 orig_local_map
= get_local_map (PT
, current_buffer
);
6355 goto replay_sequence
;
6361 /* Clicks in non-text areas get prefixed by the symbol
6362 in their CHAR-ADDRESS field. For example, a click on
6363 the mode line is prefixed by the symbol `mode-line'.
6365 Furthermore, key sequences beginning with mouse clicks
6366 are read using the keymaps of the buffer clicked on, not
6367 the current buffer. So we may have to switch the buffer
6370 When we turn one event into two events, we must make sure
6371 that neither of the two looks like the original--so that,
6372 if we replay the events, they won't be expanded again.
6373 If not for this, such reexpansion could happen either here
6374 or when user programs play with this-command-keys. */
6375 if (EVENT_HAS_PARAMETERS (key
))
6379 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6380 if (EQ (kind
, Qmouse_click
))
6382 Lisp_Object window
, posn
;
6384 window
= POSN_WINDOW (EVENT_START (key
));
6385 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6388 /* We're looking at the second event of a
6389 sequence which we expanded before. Set
6390 last_real_key_start appropriately. */
6392 last_real_key_start
= t
- 1;
6395 /* Key sequences beginning with mouse clicks are
6396 read using the keymaps in the buffer clicked on,
6397 not the current buffer. If we're at the
6398 beginning of a key sequence, switch buffers. */
6399 if (last_real_key_start
== 0
6401 && BUFFERP (XWINDOW (window
)->buffer
)
6402 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6407 /* Arrange to go back to the original buffer once we're
6408 done reading the key sequence. Note that we can't
6409 use save_excursion_{save,restore} here, because they
6410 save point as well as the current buffer; we don't
6411 want to save point, because redisplay may change it,
6412 to accommodate a Fset_window_start or something. We
6413 don't want to do this at the top of the function,
6414 because we may get input from a subprocess which
6415 wants to change the selected window and stuff (say,
6417 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6419 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6420 orig_local_map
= get_local_map (PT
, current_buffer
);
6421 goto replay_sequence
;
6423 /* For a mouse click, get the local text-property keymap
6424 of the place clicked on, rather than point. */
6425 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6426 && ! localized_local_map
)
6428 Lisp_Object map_here
, start
, pos
;
6430 localized_local_map
= 1;
6431 start
= EVENT_START (key
);
6432 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6434 pos
= POSN_BUFFER_POSN (start
);
6436 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6438 map_here
= get_local_map (XINT (pos
), current_buffer
);
6439 if (!EQ (map_here
, orig_local_map
))
6441 orig_local_map
= map_here
;
6445 goto replay_sequence
;
6451 /* Expand mode-line and scroll-bar events into two events:
6452 use posn as a fake prefix key. */
6455 if (t
+ 1 >= bufsize
)
6456 error ("Key sequence too long");
6461 /* Zap the position in key, so we know that we've
6462 expanded it, and don't try to do so again. */
6463 POSN_BUFFER_POSN (EVENT_START (key
))
6464 = Fcons (posn
, Qnil
);
6468 else if (EQ (kind
, Qswitch_frame
))
6470 /* If we're at the beginning of a key sequence, and the caller
6471 says it's okay, go ahead and return this event. If we're
6472 in the midst of a key sequence, delay it until the end. */
6473 if (t
> 0 || !can_return_switch_frame
)
6475 delayed_switch_frame
= key
;
6479 else if (CONSP (XCONS (key
)->cdr
)
6480 && CONSP (EVENT_START (key
))
6481 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6485 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6486 /* Handle menu-bar events:
6487 insert the dummy prefix event `menu-bar'. */
6488 if (EQ (posn
, Qmenu_bar
))
6490 if (t
+ 1 >= bufsize
)
6491 error ("Key sequence too long");
6495 /* Zap the position in key, so we know that we've
6496 expanded it, and don't try to do so again. */
6497 POSN_BUFFER_POSN (EVENT_START (key
))
6498 = Fcons (posn
, Qnil
);
6501 goto replay_sequence
;
6503 else if (CONSP (posn
))
6505 /* We're looking at the second event of a
6506 sequence which we expanded before. Set
6507 last_real_key_start appropriately. */
6508 if (last_real_key_start
== t
&& t
> 0)
6509 last_real_key_start
= t
- 1;
6514 /* We have finally decided that KEY is something we might want
6516 first_binding
= (follow_key (key
,
6517 nmaps
- first_binding
,
6518 submaps
+ first_binding
,
6519 defs
+ first_binding
,
6520 submaps
+ first_binding
)
6523 /* If KEY wasn't bound, we'll try some fallbacks. */
6524 if (first_binding
>= nmaps
)
6528 head
= EVENT_HEAD (key
);
6529 if (help_char_p (head
) && t
> 0)
6531 read_key_sequence_cmd
= Vprefix_help_command
;
6533 last_nonmenu_event
= key
;
6534 /* The Microsoft C compiler can't handle the goto that
6542 Lisp_Object breakdown
;
6545 breakdown
= parse_modifiers (head
);
6546 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6547 /* Attempt to reduce an unbound mouse event to a simpler
6548 event that is bound:
6549 Drags reduce to clicks.
6550 Double-clicks reduce to clicks.
6551 Triple-clicks reduce to double-clicks, then to clicks.
6552 Down-clicks are eliminated.
6553 Double-downs reduce to downs, then are eliminated.
6554 Triple-downs reduce to double-downs, then to downs,
6555 then are eliminated. */
6556 if (modifiers
& (down_modifier
| drag_modifier
6557 | double_modifier
| triple_modifier
))
6559 while (modifiers
& (down_modifier
| drag_modifier
6560 | double_modifier
| triple_modifier
))
6562 Lisp_Object new_head
, new_click
;
6563 if (modifiers
& triple_modifier
)
6564 modifiers
^= (double_modifier
| triple_modifier
);
6565 else if (modifiers
& double_modifier
)
6566 modifiers
&= ~double_modifier
;
6567 else if (modifiers
& drag_modifier
)
6568 modifiers
&= ~drag_modifier
;
6571 /* Dispose of this `down' event by simply jumping
6572 back to replay_key, to get another event.
6574 Note that if this event came from mock input,
6575 then just jumping back to replay_key will just
6576 hand it to us again. So we have to wipe out any
6579 We could delete keybuf[t] and shift everything
6580 after that to the left by one spot, but we'd also
6581 have to fix up any variable that points into
6582 keybuf, and shifting isn't really necessary
6585 Adding prefixes for non-textual mouse clicks
6586 creates two characters of mock input, and both
6587 must be thrown away. If we're only looking at
6588 the prefix now, we can just jump back to
6589 replay_key. On the other hand, if we've already
6590 processed the prefix, and now the actual click
6591 itself is giving us trouble, then we've lost the
6592 state of the keymaps we want to backtrack to, and
6593 we need to replay the whole sequence to rebuild
6596 Beyond that, only function key expansion could
6597 create more than two keys, but that should never
6598 generate mouse events, so it's okay to zero
6599 mock_input in that case too.
6601 Isn't this just the most wonderful code ever? */
6602 if (t
== last_real_key_start
)
6609 mock_input
= last_real_key_start
;
6610 goto replay_sequence
;
6615 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6617 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6619 /* Look for a binding for this new key. follow_key
6620 promises that it didn't munge submaps the
6621 last time we called it, since key was unbound. */
6623 = (follow_key (new_click
,
6624 nmaps
- local_first_binding
,
6625 submaps
+ local_first_binding
,
6626 defs
+ local_first_binding
,
6627 submaps
+ local_first_binding
)
6628 + local_first_binding
);
6630 /* If that click is bound, go for it. */
6631 if (first_binding
< nmaps
)
6636 /* Otherwise, we'll leave key set to the drag event. */
6643 /* Normally, last_nonmenu_event gets the previous key we read.
6644 But when a mouse popup menu is being used,
6645 we don't update last_nonmenu_event; it continues to hold the mouse
6646 event that preceded the first level of menu. */
6647 if (!used_mouse_menu
)
6648 last_nonmenu_event
= key
;
6650 /* Record what part of this_command_keys is the current key sequence. */
6651 this_single_command_key_start
= this_command_key_count
- t
;
6653 prev_fkey_map
= fkey_map
;
6654 prev_fkey_start
= fkey_start
;
6655 prev_fkey_end
= fkey_end
;
6657 prev_keytran_map
= keytran_map
;
6658 prev_keytran_start
= keytran_start
;
6659 prev_keytran_end
= keytran_end
;
6661 /* If the sequence is unbound, see if we can hang a function key
6662 off the end of it. We only want to scan real keyboard input
6663 for function key sequences, so if mock_input says that we're
6664 re-reading old events, don't examine it. */
6665 if (first_binding
>= nmaps
6668 Lisp_Object fkey_next
;
6670 /* Continue scan from fkey_end until we find a bound suffix.
6671 If we fail, increment fkey_start
6672 and start fkey_end from there. */
6673 while (fkey_end
< t
)
6677 key
= keybuf
[fkey_end
++];
6678 /* Look up meta-characters by prefixing them
6679 with meta_prefix_char. I hate this. */
6680 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6685 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
6687 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6690 fkey_next
= fkey_map
;
6693 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 0);
6695 #if 0 /* I didn't turn this on, because it might cause trouble
6696 for the mapping of return into C-m and tab into C-i. */
6697 /* Optionally don't map function keys into other things.
6698 This enables the user to redefine kp- keys easily. */
6699 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6703 /* If the function key map gives a function, not an
6704 array, then call the function with no args and use
6705 its value instead. */
6706 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6709 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6713 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6714 fkey_next
= call1 (fkey_next
, prompt
);
6716 /* If the function returned something invalid,
6717 barf--don't ignore it.
6718 (To ignore it safely, we would need to gcpro a bunch of
6719 other variables.) */
6720 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6721 error ("Function in key-translation-map returns invalid key sequence");
6724 function_key_possible
= ! NILP (fkey_next
);
6726 /* If keybuf[fkey_start..fkey_end] is bound in the
6727 function key map and it's a suffix of the current
6728 sequence (i.e. fkey_end == t), replace it with
6729 the binding and restart with fkey_start at the end. */
6730 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6733 int len
= XFASTINT (Flength (fkey_next
));
6735 t
= fkey_start
+ len
;
6737 error ("Key sequence too long");
6739 if (VECTORP (fkey_next
))
6740 bcopy (XVECTOR (fkey_next
)->contents
,
6741 keybuf
+ fkey_start
,
6742 (t
- fkey_start
) * sizeof (keybuf
[0]));
6743 else if (STRINGP (fkey_next
))
6747 for (i
= 0; i
< len
; i
++)
6748 XSETFASTINT (keybuf
[fkey_start
+ i
],
6749 XSTRING (fkey_next
)->data
[i
]);
6753 fkey_start
= fkey_end
= t
;
6754 fkey_map
= Vfunction_key_map
;
6756 /* Do pass the results through key-translation-map. */
6757 keytran_start
= keytran_end
= 0;
6758 keytran_map
= Vkey_translation_map
;
6760 goto replay_sequence
;
6763 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6765 /* If we no longer have a bound suffix, try a new positions for
6767 if (NILP (fkey_map
))
6769 fkey_end
= ++fkey_start
;
6770 fkey_map
= Vfunction_key_map
;
6771 function_key_possible
= 0;
6776 /* Look for this sequence in key-translation-map. */
6778 Lisp_Object keytran_next
;
6780 /* Scan from keytran_end until we find a bound suffix. */
6781 while (keytran_end
< t
)
6785 key
= keybuf
[keytran_end
++];
6786 /* Look up meta-characters by prefixing them
6787 with meta_prefix_char. I hate this. */
6788 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6793 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
6795 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6798 keytran_next
= keytran_map
;
6801 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 0);
6803 /* If the key translation map gives a function, not an
6804 array, then call the function with no args and use
6805 its value instead. */
6806 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6807 && keytran_end
== t
)
6809 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6813 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6814 keytran_next
= call1 (keytran_next
, prompt
);
6816 /* If the function returned something invalid,
6817 barf--don't ignore it.
6818 (To ignore it safely, we would need to gcpro a bunch of
6819 other variables.) */
6820 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6821 error ("Function in key-translation-map returns invalid key sequence");
6824 key_translation_possible
= ! NILP (keytran_next
);
6826 /* If keybuf[keytran_start..keytran_end] is bound in the
6827 key translation map and it's a suffix of the current
6828 sequence (i.e. keytran_end == t), replace it with
6829 the binding and restart with keytran_start at the end. */
6830 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6831 && keytran_end
== t
)
6833 int len
= XFASTINT (Flength (keytran_next
));
6835 t
= keytran_start
+ len
;
6837 error ("Key sequence too long");
6839 if (VECTORP (keytran_next
))
6840 bcopy (XVECTOR (keytran_next
)->contents
,
6841 keybuf
+ keytran_start
,
6842 (t
- keytran_start
) * sizeof (keybuf
[0]));
6843 else if (STRINGP (keytran_next
))
6847 for (i
= 0; i
< len
; i
++)
6848 XSETFASTINT (keybuf
[keytran_start
+ i
],
6849 XSTRING (keytran_next
)->data
[i
]);
6853 keytran_start
= keytran_end
= t
;
6854 keytran_map
= Vkey_translation_map
;
6856 /* Don't pass the results of key-translation-map
6857 through function-key-map. */
6858 fkey_start
= fkey_end
= t
;
6859 fkey_map
= Vkey_translation_map
;
6861 goto replay_sequence
;
6864 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6866 /* If we no longer have a bound suffix, try a new positions for
6868 if (NILP (keytran_map
))
6870 keytran_end
= ++keytran_start
;
6871 keytran_map
= Vkey_translation_map
;
6872 key_translation_possible
= 0;
6877 /* If KEY is not defined in any of the keymaps,
6878 and cannot be part of a function key or translation,
6879 and is an upper case letter
6880 use the corresponding lower-case letter instead. */
6881 if (first_binding
== nmaps
&& ! function_key_possible
6882 && ! key_translation_possible
6884 && ((((XINT (key
) & 0x3ffff)
6885 < XSTRING (current_buffer
->downcase_table
)->size
)
6886 && UPPERCASEP (XINT (key
) & 0x3ffff))
6887 || (XINT (key
) & shift_modifier
)))
6889 Lisp_Object new_key
;
6891 original_uppercase
= key
;
6892 original_uppercase_position
= t
- 1;
6894 if (XINT (key
) & shift_modifier
)
6895 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6897 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6898 | (XINT (key
) & ~0x3ffff)));
6900 /* We have to do this unconditionally, regardless of whether
6901 the lower-case char is defined in the keymaps, because they
6902 might get translated through function-key-map. */
6903 keybuf
[t
- 1] = new_key
;
6906 fkey_map
= prev_fkey_map
;
6907 fkey_start
= prev_fkey_start
;
6908 fkey_end
= prev_fkey_end
;
6910 keytran_map
= prev_keytran_map
;
6911 keytran_start
= prev_keytran_start
;
6912 keytran_end
= prev_keytran_end
;
6914 goto replay_sequence
;
6916 /* If KEY is not defined in any of the keymaps,
6917 and cannot be part of a function key or translation,
6918 and is a shifted function key,
6919 use the corresponding unshifted function key instead. */
6920 if (first_binding
== nmaps
&& ! function_key_possible
6921 && ! key_translation_possible
6924 Lisp_Object breakdown
;
6927 breakdown
= parse_modifiers (key
);
6928 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6929 if (modifiers
& shift_modifier
)
6931 Lisp_Object new_key
;
6933 original_uppercase
= key
;
6934 original_uppercase_position
= t
- 1;
6936 modifiers
&= ~shift_modifier
;
6937 new_key
= apply_modifiers (modifiers
,
6938 XCONS (breakdown
)->car
);
6940 keybuf
[t
- 1] = new_key
;
6943 fkey_map
= prev_fkey_map
;
6944 fkey_start
= prev_fkey_start
;
6945 fkey_end
= prev_fkey_end
;
6947 keytran_map
= prev_keytran_map
;
6948 keytran_start
= prev_keytran_start
;
6949 keytran_end
= prev_keytran_end
;
6951 goto replay_sequence
;
6957 read_key_sequence_cmd
= (first_binding
< nmaps
6958 ? defs
[first_binding
]
6961 unread_switch_frame
= delayed_switch_frame
;
6962 unbind_to (count
, Qnil
);
6964 /* Don't downcase the last character if the caller says don't.
6965 Don't downcase it if the result is undefined, either. */
6966 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6967 && t
- 1 == original_uppercase_position
)
6968 keybuf
[t
- 1] = original_uppercase
;
6970 /* Occasionally we fabricate events, perhaps by expanding something
6971 according to function-key-map, or by adding a prefix symbol to a
6972 mouse click in the scroll bar or modeline. In this cases, return
6973 the entire generated key sequence, even if we hit an unbound
6974 prefix or a definition before the end. This means that you will
6975 be able to push back the event properly, and also means that
6976 read-key-sequence will always return a logical unit.
6979 for (; t
< mock_input
; t
++)
6981 if (echo_keystrokes
)
6982 echo_char (keybuf
[t
]);
6983 add_command_key (keybuf
[t
]);
6989 #if 0 /* This doc string is too long for some compilers.
6990 This commented-out definition serves for DOC. */
6991 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6992 "Read a sequence of keystrokes and return as a string or vector.\n\
6993 The sequence is sufficient to specify a non-prefix command in the\n\
6994 current local and global maps.\n\
6996 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6997 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6998 as a continuation of the previous key.\n\
7000 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
7001 convert the last event to lower case. (Normally any upper case event\n\
7002 is converted to lower case if the original event is undefined and the lower\n\
7003 case equivalent is defined.) A non-nil value is appropriate for reading\n\
7004 a key sequence to be defined.\n\
7006 A C-g typed while in this function is treated like any other character,\n\
7007 and `quit-flag' is not set.\n\
7009 If the key sequence starts with a mouse click, then the sequence is read\n\
7010 using the keymaps of the buffer of the window clicked in, not the buffer\n\
7011 of the selected window as normal.\n\
7013 `read-key-sequence' drops unbound button-down events, since you normally\n\
7014 only care about the click or drag events which follow them. If a drag\n\
7015 or multi-click event is unbound, but the corresponding click event would\n\
7016 be bound, `read-key-sequence' turns the event into a click event at the\n\
7017 drag's starting position. This means that you don't have to distinguish\n\
7018 between click and drag, double, or triple events unless you want to.\n\
7020 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
7021 lines separating windows, and scroll bars with imaginary keys\n\
7022 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
7024 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
7025 function will process a switch-frame event if the user switches frames\n\
7026 before typing anything. If the user switches frames in the middle of a\n\
7027 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
7028 is nil, then the event will be put off until after the current key sequence.\n\
7030 `read-key-sequence' checks `function-key-map' for function key\n\
7031 sequences, where they wouldn't conflict with ordinary bindings. See\n\
7032 `function-key-map' for more details.")
7033 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7036 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7038 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7039 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7040 Lisp_Object can_return_switch_frame
;
7042 Lisp_Object keybuf
[30];
7044 struct gcpro gcpro1
, gcpro2
;
7047 CHECK_STRING (prompt
, 0);
7050 bzero (keybuf
, sizeof keybuf
);
7052 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7054 if (NILP (continue_echo
))
7056 this_command_key_count
= 0;
7057 this_single_command_key_start
= 0;
7060 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7061 prompt
, ! NILP (dont_downcase_last
),
7062 ! NILP (can_return_switch_frame
), 0);
7070 return make_event_array (i
, keybuf
);
7073 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
7074 "Execute CMD as an editor command.\n\
7075 CMD must be a symbol that satisfies the `commandp' predicate.\n\
7076 Optional second arg RECORD-FLAG non-nil\n\
7077 means unconditionally put this command in `command-history'.\n\
7078 Otherwise, that is done only if an arg is read using the minibuffer.\n\
7079 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
7080 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
7081 The argument SPECIAL, if non-nil, means that this command is executing\n\
7082 a special event, so ignore the prefix argument and don't clear it.")
7083 (cmd
, record_flag
, keys
, special
)
7084 Lisp_Object cmd
, record_flag
, keys
, special
;
7086 register Lisp_Object final
;
7087 register Lisp_Object tem
;
7088 Lisp_Object prefixarg
;
7089 struct backtrace backtrace
;
7090 extern int debug_on_next_call
;
7092 debug_on_next_call
= 0;
7096 prefixarg
= current_kboard
->Vprefix_arg
;
7097 Vcurrent_prefix_arg
= prefixarg
;
7098 current_kboard
->Vprefix_arg
= Qnil
;
7105 tem
= Fget (cmd
, Qdisabled
);
7106 if (!NILP (tem
) && !NILP (Vrun_hooks
))
7108 tem
= Fsymbol_value (Qdisabled_command_hook
);
7110 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
7116 final
= Findirect_function (cmd
);
7118 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
7120 struct gcpro gcpro1
, gcpro2
;
7122 GCPRO2 (cmd
, prefixarg
);
7123 do_autoload (final
, cmd
);
7130 if (STRINGP (final
) || VECTORP (final
))
7132 /* If requested, place the macro in the command history. For
7133 other sorts of commands, call-interactively takes care of
7135 if (!NILP (record_flag
))
7137 = Fcons (Fcons (Qexecute_kbd_macro
,
7138 Fcons (final
, Fcons (prefixarg
, Qnil
))),
7141 return Fexecute_kbd_macro (final
, prefixarg
);
7143 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
7145 backtrace
.next
= backtrace_list
;
7146 backtrace_list
= &backtrace
;
7147 backtrace
.function
= &Qcall_interactively
;
7148 backtrace
.args
= &cmd
;
7149 backtrace
.nargs
= 1;
7150 backtrace
.evalargs
= 0;
7152 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7154 backtrace_list
= backtrace
.next
;
7160 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7162 "Read function name, then read its arguments and call it.")
7164 Lisp_Object prefixarg
;
7166 Lisp_Object function
;
7168 Lisp_Object saved_keys
;
7169 Lisp_Object bindings
, value
;
7170 struct gcpro gcpro1
, gcpro2
;
7172 saved_keys
= Fvector (this_command_key_count
,
7173 XVECTOR (this_command_keys
)->contents
);
7175 GCPRO2 (saved_keys
, prefixarg
);
7177 if (EQ (prefixarg
, Qminus
))
7179 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7180 strcpy (buf
, "C-u ");
7181 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7183 if (sizeof (int) == sizeof (EMACS_INT
))
7184 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7185 else if (sizeof (long) == sizeof (EMACS_INT
))
7186 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7190 else if (INTEGERP (prefixarg
))
7192 if (sizeof (int) == sizeof (EMACS_INT
))
7193 sprintf (buf
, "%d ", XINT (prefixarg
));
7194 else if (sizeof (long) == sizeof (EMACS_INT
))
7195 sprintf (buf
, "%ld ", XINT (prefixarg
));
7200 /* This isn't strictly correct if execute-extended-command
7201 is bound to anything else. Perhaps it should use
7202 this_command_keys? */
7203 strcat (buf
, "M-x ");
7205 /* Prompt with buf, and then read a string, completing from and
7206 restricting to the set of all defined commands. Don't provide
7207 any initial input. Save the command read on the extended-command
7209 function
= Fcompleting_read (build_string (buf
),
7210 Vobarray
, Qcommandp
,
7211 Qt
, Qnil
, Qextended_command_history
, Qnil
,
7214 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7215 error ("No command name given");
7217 /* Set this_command_keys to the concatenation of saved_keys and
7218 function, followed by a RET. */
7220 struct Lisp_String
*str
;
7225 this_command_key_count
= 0;
7226 this_single_command_key_start
= 0;
7228 keys
= XVECTOR (saved_keys
)->contents
;
7229 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7230 add_command_key (keys
[i
]);
7232 str
= XSTRING (function
);
7233 for (i
= 0; i
< str
->size
; i
++)
7235 XSETFASTINT (tem
, str
->data
[i
]);
7236 add_command_key (tem
);
7239 XSETFASTINT (tem
, '\015');
7240 add_command_key (tem
);
7245 function
= Fintern (function
, Qnil
);
7246 current_kboard
->Vprefix_arg
= prefixarg
;
7247 this_command
= function
;
7249 /* If enabled, show which key runs this command. */
7250 if (!NILP (Vsuggest_key_bindings
)
7251 && NILP (Vexecuting_macro
)
7252 && SYMBOLP (function
))
7253 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7259 GCPRO2 (bindings
, value
);
7260 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7262 /* If the command has a key binding, print it now. */
7263 if (!NILP (bindings
)
7264 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
7267 /* But first wait, and skip the message if there is input. */
7268 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7269 ? Vsuggest_key_bindings
: make_number (2)),
7271 && ! CONSP (Vunread_command_events
))
7273 Lisp_Object binding
;
7275 char *oldmessage
= echo_area_glyphs
;
7276 int oldmessage_len
= echo_area_glyphs_length
;
7277 int oldmultibyte
= message_enable_multibyte
;
7279 binding
= Fkey_description (bindings
);
7282 = (char *) alloca (XSYMBOL (function
)->name
->size
7283 + XSTRING (binding
)->size
7285 sprintf (newmessage
, "You can run the command `%s' with %s",
7286 XSYMBOL (function
)->name
->data
,
7287 XSTRING (binding
)->data
);
7288 message1_nolog (newmessage
);
7289 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7290 ? Vsuggest_key_bindings
: make_number (2)),
7293 message_enable_multibyte
= oldmultibyte
;
7294 message2_nolog (oldmessage
, oldmessage_len
);
7299 RETURN_UNGCPRO (value
);
7302 /* Find the set of keymaps now active.
7303 Store into *MAPS_P a vector holding the various maps
7304 and return the number of them. The vector was malloc'd
7305 and the caller should free it. */
7308 current_active_maps (maps_p
)
7309 Lisp_Object
**maps_p
;
7311 Lisp_Object
*tmaps
, *maps
;
7314 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7315 if (!NILP (Voverriding_local_map_menu_flag
))
7317 /* Yes, use them (if non-nil) as well as the global map. */
7318 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7320 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7321 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7322 if (!NILP (Voverriding_local_map
))
7323 maps
[nmaps
++] = Voverriding_local_map
;
7327 /* No, so use major and minor mode keymaps. */
7328 nmaps
= current_minor_maps (NULL
, &tmaps
);
7329 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7330 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7331 #ifdef USE_TEXT_PROPERTIES
7332 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7334 maps
[nmaps
++] = current_buffer
->keymap
;
7337 maps
[nmaps
++] = current_global_map
;
7343 /* Return nonzero if input events are pending. */
7345 detect_input_pending ()
7348 get_input_pending (&input_pending
, 0);
7350 return input_pending
;
7353 /* Return nonzero if input events are pending, and run any pending timers. */
7355 detect_input_pending_run_timers (do_display
)
7358 int old_timers_run
= timers_run
;
7361 get_input_pending (&input_pending
, 1);
7363 if (old_timers_run
!= timers_run
&& do_display
)
7364 redisplay_preserve_echo_area ();
7366 return input_pending
;
7369 /* This is called in some cases before a possible quit.
7370 It cases the next call to detect_input_pending to recompute input_pending.
7371 So calling this function unnecessarily can't do any harm. */
7374 clear_input_pending ()
7379 /* Return nonzero if there are pending requeued events.
7380 This isn't used yet. The hope is to make wait_reading_process_input
7381 call it, and return return if it runs Lisp code that unreads something.
7382 The problem is, kbd_buffer_get_event needs to be fixed to know what
7383 to do in that case. It isn't trivial. */
7385 requeued_events_pending_p ()
7387 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7391 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7392 "T if command input is currently available with no waiting.\n\
7393 Actually, the value is nil only if we can be sure that no input is available.")
7396 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7399 get_input_pending (&input_pending
, 1);
7400 return input_pending
> 0 ? Qt
: Qnil
;
7403 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7404 "Return vector of last 100 events, not counting those from keyboard macros.")
7407 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7410 if (total_keys
< NUM_RECENT_KEYS
)
7411 return Fvector (total_keys
, keys
);
7414 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7415 bcopy (keys
+ recent_keys_index
,
7416 XVECTOR (val
)->contents
,
7417 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7419 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7420 recent_keys_index
* sizeof (Lisp_Object
));
7425 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7426 "Return the key sequence that invoked this command.\n\
7427 The value is a string or a vector.")
7430 return make_event_array (this_command_key_count
,
7431 XVECTOR (this_command_keys
)->contents
);
7434 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7435 Sthis_single_command_keys
, 0, 0, 0,
7436 "Return the key sequence that invoked this command.\n\
7437 Unlike `this-command-keys', this function's value\n\
7438 does not include prefix arguments.\n\
7439 The value is a string or a vector.")
7442 return make_event_array (this_command_key_count
7443 - this_single_command_key_start
,
7444 (XVECTOR (this_command_keys
)->contents
7445 + this_single_command_key_start
));
7448 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7449 Sreset_this_command_lengths
, 0, 0, 0,
7450 "Used for complicated reasons in `universal-argument-other-key'.\n\
7452 `universal-argument-other-key' rereads the event just typed.\n\
7453 It then gets translated through `function-key-map'.\n\
7454 The translated event gets included in the echo area and in\n\
7455 the value of `this-command-keys' in addition to the raw original event.\n\
7456 That is not right.\n\
7458 Calling this function directs the translated event to replace\n\
7459 the original event, so that only one version of the event actually\n\
7460 appears in the echo area and in the value of `this-command-keys.'.")
7463 before_command_restore_flag
= 1;
7464 before_command_key_count_1
= before_command_key_count
;
7465 before_command_echo_length_1
= before_command_echo_length
;
7468 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7469 "Return the current depth in recursive edits.")
7473 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
7477 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
7478 "FOpen dribble file: ",
7479 "Start writing all keyboard characters to a dribble file called FILE.\n\
7480 If FILE is nil, close any open dribble file.")
7491 file
= Fexpand_file_name (file
, Qnil
);
7492 dribble
= fopen (XSTRING (file
)->data
, "w");
7494 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
7499 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
7500 "Discard the contents of the terminal input buffer.\n\
7501 Also cancel any kbd macro being defined.")
7504 current_kboard
->defining_kbd_macro
= Qnil
;
7505 update_mode_lines
++;
7507 Vunread_command_events
= Qnil
;
7508 unread_command_char
= -1;
7510 discard_tty_input ();
7512 /* Without the cast, GCC complains that this assignment loses the
7513 volatile qualifier of kbd_store_ptr. Is there anything wrong
7515 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7516 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7522 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7523 "Stop Emacs and return to superior process. You can resume later.\n\
7524 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7525 control, run a subshell instead.\n\n\
7526 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7527 to be read as terminal input by Emacs's parent, after suspension.\n\
7529 Before suspending, run the normal hook `suspend-hook'.\n\
7530 After resumption run the normal hook `suspend-resume-hook'.\n\
7532 Some operating systems cannot stop the Emacs process and resume it later.\n\
7533 On such systems, Emacs starts a subshell instead of suspending.")
7535 Lisp_Object stuffstring
;
7538 int count
= specpdl_ptr
- specpdl
;
7539 int old_height
, old_width
;
7541 struct gcpro gcpro1
, gcpro2
;
7543 if (!NILP (stuffstring
))
7544 CHECK_STRING (stuffstring
, 0);
7546 /* Run the functions in suspend-hook. */
7547 if (!NILP (Vrun_hooks
))
7548 call1 (Vrun_hooks
, intern ("suspend-hook"));
7550 GCPRO1 (stuffstring
);
7551 get_frame_size (&old_width
, &old_height
);
7553 /* sys_suspend can get an error if it tries to fork a subshell
7554 and the system resources aren't available for that. */
7555 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
7557 stuff_buffered_input (stuffstring
);
7562 unbind_to (count
, Qnil
);
7564 /* Check if terminal/window size has changed.
7565 Note that this is not useful when we are running directly
7566 with a window system; but suspend should be disabled in that case. */
7567 get_frame_size (&width
, &height
);
7568 if (width
!= old_width
|| height
!= old_height
)
7569 change_frame_size (selected_frame
, height
, width
, 0, 0);
7571 /* Run suspend-resume-hook. */
7572 if (!NILP (Vrun_hooks
))
7573 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7579 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7580 Then in any case stuff anything Emacs has read ahead and not used. */
7583 stuff_buffered_input (stuffstring
)
7584 Lisp_Object stuffstring
;
7586 /* stuff_char works only in BSD, versions 4.2 and up. */
7589 register unsigned char *p
;
7591 if (STRINGP (stuffstring
))
7595 p
= XSTRING (stuffstring
)->data
;
7596 count
= XSTRING (stuffstring
)->size
;
7601 /* Anything we have read ahead, put back for the shell to read. */
7602 /* ?? What should this do when we have multiple keyboards??
7603 Should we ignore anything that was typed in at the "wrong" kboard? */
7604 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7606 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7607 kbd_fetch_ptr
= kbd_buffer
;
7608 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7609 stuff_char (kbd_fetch_ptr
->code
);
7610 kbd_fetch_ptr
->kind
= no_event
;
7611 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7617 #endif /* BSD_SYSTEM and not BSD4_1 */
7620 set_waiting_for_input (time_to_clear
)
7621 EMACS_TIME
*time_to_clear
;
7623 input_available_clear_time
= time_to_clear
;
7625 /* Tell interrupt_signal to throw back to read_char, */
7626 waiting_for_input
= 1;
7628 /* If interrupt_signal was called before and buffered a C-g,
7629 make it run again now, to avoid timing error. */
7630 if (!NILP (Vquit_flag
))
7631 quit_throw_to_read_char ();
7635 clear_waiting_for_input ()
7637 /* Tell interrupt_signal not to throw back to read_char, */
7638 waiting_for_input
= 0;
7639 input_available_clear_time
= 0;
7642 /* This routine is called at interrupt level in response to C-G.
7643 If interrupt_input, this is the handler for SIGINT.
7644 Otherwise, it is called from kbd_buffer_store_event,
7645 in handling SIGIO or SIGTINT.
7647 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7648 immediately throw back to read_char.
7650 Otherwise it sets the Lisp variable quit-flag not-nil.
7651 This causes eval to throw, when it gets a chance.
7652 If quit-flag is already non-nil, it stops the job right away. */
7655 interrupt_signal (signalnum
) /* If we don't have an argument, */
7656 int signalnum
; /* some compilers complain in signal calls. */
7659 /* Must preserve main program's value of errno. */
7660 int old_errno
= errno
;
7662 #if defined (USG) && !defined (POSIX_SIGNALS)
7663 if (!read_socket_hook
&& NILP (Vwindow_system
))
7665 /* USG systems forget handlers when they are used;
7666 must reestablish each time */
7667 signal (SIGINT
, interrupt_signal
);
7668 signal (SIGQUIT
, interrupt_signal
);
7674 if (!NILP (Vquit_flag
)
7675 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
7677 /* If SIGINT isn't blocked, don't let us be interrupted by
7678 another SIGINT, it might be harmful due to non-reentrancy
7679 in I/O functions. */
7680 sigblock (sigmask (SIGINT
));
7685 #ifdef SIGTSTP /* Support possible in later USG versions */
7687 * On systems which can suspend the current process and return to the original
7688 * shell, this command causes the user to end up back at the shell.
7689 * The "Auto-save" and "Abort" questions are not asked until
7690 * the user elects to return to emacs, at which point he can save the current
7691 * job and either dump core or continue.
7696 if (sys_suspend () == -1)
7698 printf ("Not running as a subprocess;\n");
7699 printf ("you can continue or abort.\n");
7702 /* Perhaps should really fork an inferior shell?
7703 But that would not provide any way to get back
7704 to the original shell, ever. */
7705 printf ("No support for stopping a process on this operating system;\n");
7706 printf ("you can continue or abort.\n");
7707 #endif /* not VMS */
7708 #endif /* not SIGTSTP */
7710 /* We must remain inside the screen area when the internal terminal
7711 is used. Note that [Enter] is not echoed by dos. */
7714 /* It doesn't work to autosave while GC is in progress;
7715 the code used for auto-saving doesn't cope with the mark bit. */
7716 if (!gc_in_progress
)
7718 printf ("Auto-save? (y or n) ");
7720 if (((c
= getchar ()) & ~040) == 'Y')
7722 Fdo_auto_save (Qt
, Qnil
);
7724 printf ("\r\nAuto-save done");
7725 #else /* not MSDOS */
7726 printf ("Auto-save done\n");
7727 #endif /* not MSDOS */
7729 while (c
!= '\n') c
= getchar ();
7733 /* During GC, it must be safe to reenable quitting again. */
7734 Vinhibit_quit
= Qnil
;
7737 #endif /* not MSDOS */
7738 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7739 printf ("but will instead do a real quit after garbage collection ends\r\n");
7744 printf ("\r\nAbort? (y or n) ");
7745 #else /* not MSDOS */
7747 printf ("Abort (and enter debugger)? (y or n) ");
7749 printf ("Abort (and dump core)? (y or n) ");
7750 #endif /* not VMS */
7751 #endif /* not MSDOS */
7753 if (((c
= getchar ()) & ~040) == 'Y')
7755 while (c
!= '\n') c
= getchar ();
7757 printf ("\r\nContinuing...\r\n");
7758 #else /* not MSDOS */
7759 printf ("Continuing...\n");
7760 #endif /* not MSDOS */
7767 /* If executing a function that wants to be interrupted out of
7768 and the user has not deferred quitting by binding `inhibit-quit'
7769 then quit right away. */
7770 if (immediate_quit
&& NILP (Vinhibit_quit
))
7774 Fsignal (Qquit
, Qnil
);
7777 /* Else request quit when it's safe */
7781 if (waiting_for_input
&& !echoing
)
7782 quit_throw_to_read_char ();
7787 /* Handle a C-g by making read_char return C-g. */
7790 quit_throw_to_read_char ()
7792 quit_error_check ();
7794 /* Prevent another signal from doing this before we finish. */
7795 clear_waiting_for_input ();
7798 Vunread_command_events
= Qnil
;
7799 unread_command_char
= -1;
7801 #if 0 /* Currently, sit_for is called from read_char without turning
7802 off polling. And that can call set_waiting_for_input.
7803 It seems to be harmless. */
7804 #ifdef POLL_FOR_INPUT
7805 /* May be > 1 if in recursive minibuffer. */
7806 if (poll_suppress_count
== 0)
7810 if (FRAMEP (internal_last_event_frame
)
7811 && XFRAME (internal_last_event_frame
) != selected_frame
)
7812 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7815 _longjmp (getcjmp
, 1);
7818 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7819 "Set mode of reading keyboard input.\n\
7820 First arg INTERRUPT non-nil means use input interrupts;\n\
7821 nil means use CBREAK mode.\n\
7822 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7823 (no effect except in CBREAK mode).\n\
7824 Third arg META t means accept 8-bit input (for a Meta key).\n\
7825 META nil means ignore the top bit, on the assumption it is parity.\n\
7826 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7827 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7828 See also `current-input-mode'.")
7829 (interrupt
, flow
, meta
, quit
)
7830 Lisp_Object interrupt
, flow
, meta
, quit
;
7833 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7834 error ("set-input-mode: QUIT must be an ASCII character");
7836 #ifdef POLL_FOR_INPUT
7841 /* this causes startup screen to be restored and messes with the mouse */
7846 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7847 if (read_socket_hook
)
7849 /* When using X, don't give the user a real choice,
7850 because we haven't implemented the mechanisms to support it. */
7851 #ifdef NO_SOCK_SIGIO
7852 interrupt_input
= 0;
7853 #else /* not NO_SOCK_SIGIO */
7854 interrupt_input
= 1;
7855 #endif /* NO_SOCK_SIGIO */
7858 interrupt_input
= !NILP (interrupt
);
7859 #else /* not SIGIO */
7860 interrupt_input
= 0;
7861 #endif /* not SIGIO */
7863 /* Our VMS input only works by interrupts, as of now. */
7865 interrupt_input
= 1;
7868 flow_control
= !NILP (flow
);
7871 else if (EQ (meta
, Qt
))
7876 /* Don't let this value be out of range. */
7877 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7883 #ifdef POLL_FOR_INPUT
7884 poll_suppress_count
= 1;
7890 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7891 "Return information about the way Emacs currently reads keyboard input.\n\
7892 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7893 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7894 nil, Emacs is using CBREAK mode.\n\
7895 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7896 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7897 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7898 META nil means ignoring the top bit, on the assumption it is parity.\n\
7899 META is neither t nor nil if accepting 8-bit input and using\n\
7900 all 8 bits as the character code.\n\
7901 QUIT is the character Emacs currently uses to quit.\n\
7902 The elements of this list correspond to the arguments of\n\
7908 val
[0] = interrupt_input
? Qt
: Qnil
;
7909 val
[1] = flow_control
? Qt
: Qnil
;
7910 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7911 XSETFASTINT (val
[3], quit_char
);
7913 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7918 * Set up a new kboard object with reasonable initial values.
7924 kb
->Voverriding_terminal_local_map
= Qnil
;
7925 kb
->Vlast_command
= Qnil
;
7926 kb
->Vprefix_arg
= Qnil
;
7927 kb
->kbd_queue
= Qnil
;
7928 kb
->kbd_queue_has_data
= 0;
7929 kb
->immediate_echo
= 0;
7930 kb
->echoptr
= kb
->echobuf
;
7931 kb
->echo_after_prompt
= -1;
7932 kb
->kbd_macro_buffer
= 0;
7933 kb
->kbd_macro_bufsize
= 0;
7934 kb
->defining_kbd_macro
= Qnil
;
7935 kb
->Vlast_kbd_macro
= Qnil
;
7936 kb
->reference_count
= 0;
7937 kb
->Vsystem_key_alist
= Qnil
;
7938 kb
->system_key_syms
= Qnil
;
7939 kb
->Vdefault_minibuffer_frame
= Qnil
;
7943 * Destroy the contents of a kboard object, but not the object itself.
7944 * We use this just before deleting it, or if we're going to initialize
7951 if (kb
->kbd_macro_buffer
)
7952 xfree (kb
->kbd_macro_buffer
);
7961 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7964 *kbp
= kb
->next_kboard
;
7972 /* This is correct before outermost invocation of the editor loop */
7973 command_loop_level
= -1;
7975 quit_char
= Ctl ('g');
7976 Vunread_command_events
= Qnil
;
7977 unread_command_char
= -1;
7978 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
7980 recent_keys_index
= 0;
7981 kbd_fetch_ptr
= kbd_buffer
;
7982 kbd_store_ptr
= kbd_buffer
;
7983 kbd_buffer_frame_or_window
7984 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7986 do_mouse_tracking
= Qnil
;
7990 /* This means that command_loop_1 won't try to select anything the first
7992 internal_last_event_frame
= Qnil
;
7993 Vlast_event_frame
= internal_last_event_frame
;
7996 current_kboard
= initial_kboard
;
7998 wipe_kboard (current_kboard
);
7999 init_kboard (current_kboard
);
8002 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8004 kbd_buffer_frame_or_window
8005 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8006 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
8008 signal (SIGINT
, interrupt_signal
);
8009 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
8010 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
8011 SIGQUIT and we can't tell which one it will give us. */
8012 signal (SIGQUIT
, interrupt_signal
);
8013 #endif /* HAVE_TERMIO */
8015 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8017 if (!noninteractive
)
8018 signal (SIGIO
, input_available_signal
);
8021 /* Use interrupt input by default, if it works and noninterrupt input
8022 has deficiencies. */
8024 #ifdef INTERRUPT_INPUT
8025 interrupt_input
= 1;
8027 interrupt_input
= 0;
8030 /* Our VMS input only works by interrupts, as of now. */
8032 interrupt_input
= 1;
8038 if (keyboard_init_hook
)
8039 (*keyboard_init_hook
) ();
8041 #ifdef POLL_FOR_INPUT
8042 poll_suppress_count
= 1;
8047 /* This type's only use is in syms_of_keyboard, to initialize the
8048 event header symbols and put properties on them. */
8055 struct event_head head_table
[] = {
8056 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
8057 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
8058 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
8059 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
8060 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
8061 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
8066 Qtimer_event_handler
= intern ("timer-event-handler");
8067 staticpro (&Qtimer_event_handler
);
8069 Qdisabled_command_hook
= intern ("disabled-command-hook");
8070 staticpro (&Qdisabled_command_hook
);
8072 Qself_insert_command
= intern ("self-insert-command");
8073 staticpro (&Qself_insert_command
);
8075 Qforward_char
= intern ("forward-char");
8076 staticpro (&Qforward_char
);
8078 Qbackward_char
= intern ("backward-char");
8079 staticpro (&Qbackward_char
);
8081 Qdisabled
= intern ("disabled");
8082 staticpro (&Qdisabled
);
8084 Qundefined
= intern ("undefined");
8085 staticpro (&Qundefined
);
8087 Qpre_command_hook
= intern ("pre-command-hook");
8088 staticpro (&Qpre_command_hook
);
8090 Qpost_command_hook
= intern ("post-command-hook");
8091 staticpro (&Qpost_command_hook
);
8093 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
8094 staticpro (&Qpost_command_idle_hook
);
8096 Qdeferred_action_function
= intern ("deferred-action-function");
8097 staticpro (&Qdeferred_action_function
);
8099 Qcommand_hook_internal
= intern ("command-hook-internal");
8100 staticpro (&Qcommand_hook_internal
);
8102 Qfunction_key
= intern ("function-key");
8103 staticpro (&Qfunction_key
);
8104 Qmouse_click
= intern ("mouse-click");
8105 staticpro (&Qmouse_click
);
8107 Qmouse_wheel
= intern ("mouse-wheel");
8108 staticpro (&Qmouse_wheel
);
8111 Qmenu_enable
= intern ("menu-enable");
8112 staticpro (&Qmenu_enable
);
8114 Qmode_line
= intern ("mode-line");
8115 staticpro (&Qmode_line
);
8116 Qvertical_line
= intern ("vertical-line");
8117 staticpro (&Qvertical_line
);
8118 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
8119 staticpro (&Qvertical_scroll_bar
);
8120 Qmenu_bar
= intern ("menu-bar");
8121 staticpro (&Qmenu_bar
);
8123 Qabove_handle
= intern ("above-handle");
8124 staticpro (&Qabove_handle
);
8125 Qhandle
= intern ("handle");
8126 staticpro (&Qhandle
);
8127 Qbelow_handle
= intern ("below-handle");
8128 staticpro (&Qbelow_handle
);
8129 Qup
= intern ("up");
8131 Qdown
= intern ("down");
8134 Qevent_kind
= intern ("event-kind");
8135 staticpro (&Qevent_kind
);
8136 Qevent_symbol_elements
= intern ("event-symbol-elements");
8137 staticpro (&Qevent_symbol_elements
);
8138 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
8139 staticpro (&Qevent_symbol_element_mask
);
8140 Qmodifier_cache
= intern ("modifier-cache");
8141 staticpro (&Qmodifier_cache
);
8143 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
8144 staticpro (&Qrecompute_lucid_menubar
);
8145 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
8146 staticpro (&Qactivate_menubar_hook
);
8148 Qpolling_period
= intern ("polling-period");
8149 staticpro (&Qpolling_period
);
8152 struct event_head
*p
;
8154 for (p
= head_table
;
8155 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
8158 *p
->var
= intern (p
->name
);
8160 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
8161 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
8165 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
8166 staticpro (&button_down_location
);
8170 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
8172 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
8173 for (i
= 0; i
< len
; i
++)
8174 if (modifier_names
[i
])
8175 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
8176 staticpro (&modifier_symbols
);
8179 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
8180 staticpro (&recent_keys
);
8182 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
8183 staticpro (&this_command_keys
);
8185 Qextended_command_history
= intern ("extended-command-history");
8186 Fset (Qextended_command_history
, Qnil
);
8187 staticpro (&Qextended_command_history
);
8189 kbd_buffer_frame_or_window
8190 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8191 staticpro (&kbd_buffer_frame_or_window
);
8193 accent_key_syms
= Qnil
;
8194 staticpro (&accent_key_syms
);
8196 func_key_syms
= Qnil
;
8197 staticpro (&func_key_syms
);
8200 staticpro (&mouse_syms
);
8203 mouse_wheel_syms
= Qnil
;
8204 staticpro (&mouse_wheel_syms
);
8207 unread_switch_frame
= Qnil
;
8208 staticpro (&unread_switch_frame
);
8210 internal_last_event_frame
= Qnil
;
8211 staticpro (&internal_last_event_frame
);
8213 read_key_sequence_cmd
= Qnil
;
8214 staticpro (&read_key_sequence_cmd
);
8216 defsubr (&Sevent_convert_list
);
8217 defsubr (&Sread_key_sequence
);
8218 defsubr (&Srecursive_edit
);
8220 defsubr (&Strack_mouse
);
8222 defsubr (&Sinput_pending_p
);
8223 defsubr (&Scommand_execute
);
8224 defsubr (&Srecent_keys
);
8225 defsubr (&Sthis_command_keys
);
8226 defsubr (&Sthis_single_command_keys
);
8227 defsubr (&Sreset_this_command_lengths
);
8228 defsubr (&Ssuspend_emacs
);
8229 defsubr (&Sabort_recursive_edit
);
8230 defsubr (&Sexit_recursive_edit
);
8231 defsubr (&Srecursion_depth
);
8232 defsubr (&Stop_level
);
8233 defsubr (&Sdiscard_input
);
8234 defsubr (&Sopen_dribble_file
);
8235 defsubr (&Sset_input_mode
);
8236 defsubr (&Scurrent_input_mode
);
8237 defsubr (&Sexecute_extended_command
);
8239 DEFVAR_LISP ("last-command-char", &last_command_char
,
8240 "Last input event that was part of a command.");
8242 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
8243 "Last input event that was part of a command.");
8245 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
8246 "Last input event in a command, except for mouse menu events.\n\
8247 Mouse menus give back keys that don't look like mouse events;\n\
8248 this variable holds the actual mouse event that led to the menu,\n\
8249 so that you can determine whether the command was run by mouse or not.");
8251 DEFVAR_LISP ("last-input-char", &last_input_char
,
8252 "Last input event.");
8254 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
8255 "Last input event.");
8257 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
8258 "List of objects to be read as next command input events.");
8260 DEFVAR_INT ("unread-command-char", &unread_command_char
,
8261 "If not -1, an object to be read as next command input event.");
8263 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
8264 "Meta-prefix character code. Meta-foo as command input\n\
8265 turns into this character followed by foo.");
8266 XSETINT (meta_prefix_char
, 033);
8268 DEFVAR_KBOARD ("last-command", Vlast_command
,
8269 "The last command executed. Normally a symbol with a function definition,\n\
8270 but can be whatever was found in the keymap, or whatever the variable\n\
8271 `this-command' was set to by that command.\n\
8273 The value `mode-exit' is special; it means that the previous command\n\
8274 read an event that told it to exit, and it did so and unread that event.\n\
8275 In other words, the present command is the event that made the previous\n\
8278 The value `kill-region' is special; it means that the previous command\n\
8279 was a kill command.");
8281 DEFVAR_LISP ("this-command", &this_command
,
8282 "The command now being executed.\n\
8283 The command can set this variable; whatever is put here\n\
8284 will be in `last-command' during the following command.");
8285 this_command
= Qnil
;
8287 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8288 "*Number of keyboard input characters between auto-saves.\n\
8289 Zero means disable autosaving due to number of characters typed.");
8290 auto_save_interval
= 300;
8292 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8293 "*Number of seconds idle time before auto-save.\n\
8294 Zero or nil means disable auto-saving due to idleness.\n\
8295 After auto-saving due to this many seconds of idle time,\n\
8296 Emacs also does a garbage collection if that seems to be warranted.");
8297 XSETFASTINT (Vauto_save_timeout
, 30);
8299 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8300 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8301 echo_keystrokes
= 1;
8303 DEFVAR_INT ("polling-period", &polling_period
,
8304 "*Interval between polling for input during Lisp execution.\n\
8305 The reason for polling is to make C-g work to stop a running program.\n\
8306 Polling is needed only when using X windows and SIGIO does not work.\n\
8307 Polling is automatically disabled in all other cases.");
8310 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8311 "*Maximum time between mouse clicks to make a double-click.\n\
8312 Measured in milliseconds. nil means disable double-click recognition;\n\
8313 t means double-clicks have no time limit and are detected\n\
8314 by position only.");
8315 Vdouble_click_time
= make_number (500);
8317 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8318 "*Non-nil means inhibit local map menu bar menus.");
8319 inhibit_local_menu_bar_menus
= 0;
8321 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8322 "Number of complete key sequences read as input so far.\n\
8323 This includes key sequences read from keyboard macros.\n\
8324 The number is effectively the number of interactive command invocations.");
8327 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
8328 "Number of input events read from the keyboard so far.\n\
8329 This does not include events generated by keyboard macros.");
8330 num_nonmacro_input_events
= 0;
8332 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8333 "The frame in which the most recently read event occurred.\n\
8334 If the last event came from a keyboard macro, this is set to `macro'.");
8335 Vlast_event_frame
= Qnil
;
8337 /* This variable is set up in sysdep.c. */
8338 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
8339 "The ERASE character as set by the user with stty.");
8341 DEFVAR_LISP ("help-char", &Vhelp_char
,
8342 "Character to recognize as meaning Help.\n\
8343 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8344 If the value of `help-form' is nil, this char can be read normally.");
8345 XSETINT (Vhelp_char
, Ctl ('H'));
8347 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8348 "List of input events to recognize as meaning Help.\n\
8349 These work just like the value of `help-char' (see that).");
8350 Vhelp_event_list
= Qnil
;
8352 DEFVAR_LISP ("help-form", &Vhelp_form
,
8353 "Form to execute when character `help-char' is read.\n\
8354 If the form returns a string, that string is displayed.\n\
8355 If `help-form' is nil, the help char is not recognized.");
8358 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8359 "Command to run when `help-char' character follows a prefix key.\n\
8360 This command is used only when there is no actual binding\n\
8361 for that character after that prefix key.");
8362 Vprefix_help_command
= Qnil
;
8364 DEFVAR_LISP ("top-level", &Vtop_level
,
8365 "Form to evaluate when Emacs starts up.\n\
8366 Useful to set before you dump a modified Emacs.");
8369 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8370 "Translate table for keyboard input, or nil.\n\
8371 Each character is looked up in this string and the contents used instead.\n\
8372 The value may be a string, a vector, or a char-table.\n\
8373 If it is a string or vector of length N,\n\
8374 character codes N and up are untranslated.\n\
8375 In a vector or a char-table, an element which is nil means \"no translation\".");
8376 Vkeyboard_translate_table
= Qnil
;
8378 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8379 "Non-nil means to always spawn a subshell instead of suspending,\n\
8380 even if the operating system has support for stopping a process.");
8383 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8384 "Non-nil means prompt with menus when appropriate.\n\
8385 This is done when reading from a keymap that has a prompt string,\n\
8386 for elements that have prompt strings.\n\
8387 The menu is displayed on the screen\n\
8388 if X menus were enabled at configuration\n\
8389 time and the previous event was a mouse click prefix key.\n\
8390 Otherwise, menu prompting uses the echo area.");
8393 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8394 "Character to see next line of menu prompt.\n\
8395 Type this character while in a menu prompt to rotate around the lines of it.");
8396 XSETINT (menu_prompt_more_char
, ' ');
8398 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8399 "A mask of additional modifier keys to use with every keyboard character.\n\
8400 Emacs applies the modifiers of the character stored here to each keyboard\n\
8401 character it reads. For example, after evaluating the expression\n\
8402 (setq extra-keyboard-modifiers ?\\C-x)\n\
8403 all input characters will have the control modifier applied to them.\n\
8405 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8406 not count as a control character; rather, it counts as a character\n\
8407 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8408 cancels any modification.");
8409 extra_keyboard_modifiers
= 0;
8411 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8412 "If an editing command sets this to t, deactivate the mark afterward.\n\
8413 The command loop sets this to nil before each command,\n\
8414 and tests the value when the command returns.\n\
8415 Buffer modification stores t in this variable.");
8416 Vdeactivate_mark
= Qnil
;
8418 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8419 "Temporary storage of pre-command-hook or post-command-hook.");
8420 Vcommand_hook_internal
= Qnil
;
8422 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8423 "Normal hook run before each command is executed.\n\
8424 Errors running the hook are caught and ignored.");
8425 Vpre_command_hook
= Qnil
;
8427 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8428 "Normal hook run after each command is executed.\n\
8429 Errors running the hook are caught and ignored.");
8430 Vpost_command_hook
= Qnil
;
8432 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8433 "Normal hook run after each command is executed, if idle.\n\
8434 Errors running the hook are caught and ignored.\n\
8435 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
8436 Vpost_command_idle_hook
= Qnil
;
8438 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
8439 "Delay time before running `post-command-idle-hook'.\n\
8440 This is measured in microseconds.");
8441 post_command_idle_delay
= 100000;
8444 DEFVAR_LISP ("echo-area-clear-hook", ...,
8445 "Normal hook run when clearing the echo area.");
8447 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
8448 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
8450 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
8451 "t means menu bar, specified Lucid style, needs to be recomputed.");
8452 Vlucid_menu_bar_dirty_flag
= Qnil
;
8454 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
8455 "List of menu bar items to move to the end of the menu bar.\n\
8456 The elements of the list are event types that may have menu bar bindings.");
8457 Vmenu_bar_final_items
= Qnil
;
8459 DEFVAR_KBOARD ("overriding-terminal-local-map",
8460 Voverriding_terminal_local_map
,
8461 "Per-terminal keymap that overrides all other local keymaps.\n\
8462 If this variable is non-nil, it is used as a keymap instead of the\n\
8463 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
8464 This variable is intended to let commands such as `universal-argumemnt'\n\
8465 set up a different keymap for reading the next command.");
8467 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
8468 "Keymap that overrides all other local keymaps.\n\
8469 If this variable is non-nil, it is used as a keymap instead of the\n\
8470 buffer's local map, and the minor mode keymaps and text property keymaps.");
8471 Voverriding_local_map
= Qnil
;
8473 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
8474 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8475 Otherwise, the menu bar continues to reflect the buffer's local map\n\
8476 and the minor mode maps regardless of `overriding-local-map'.");
8477 Voverriding_local_map_menu_flag
= Qnil
;
8479 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
8480 "Keymap defining bindings for special events to execute at low level.");
8481 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
8483 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
8484 "*Non-nil means generate motion events for mouse motion.");
8486 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
8487 "Alist of system-specific X windows key symbols.\n\
8488 Each element should have the form (N . SYMBOL) where N is the\n\
8489 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
8490 and SYMBOL is its name.");
8492 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
8493 "List of deferred actions to be performed at a later time.\n\
8494 The precise format isn't relevant here; we just check whether it is nil.");
8495 Vdeferred_action_list
= Qnil
;
8497 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
8498 "Function to call to handle deferred actions, after each command.\n\
8499 This function is called with no arguments after each command\n\
8500 whenever `deferred-action-list' is non-nil.");
8501 Vdeferred_action_function
= Qnil
;
8503 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
8504 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8505 The value can be a length of time to show the message for.\n\
8506 If the value is non-nil and not a number, we wait 2 seconds.");
8507 Vsuggest_key_bindings
= Qt
;
8509 DEFVAR_LISP ("timer-list", &Vtimer_list
,
8510 "List of active absolute time timers in order of increasing time");
8513 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
8514 "List of active idle-time timers in order of increasing time");
8515 Vtimer_idle_list
= Qnil
;
8520 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
8521 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
8522 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
8523 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
8524 initial_define_key (meta_map
, 'x', "execute-extended-command");
8526 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
8527 "handle-delete-frame");
8528 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
8530 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",