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 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
505 EMACS_TIME
*input_available_clear_time
;
507 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
508 Default is 1 if INTERRUPT_INPUT is defined. */
511 /* Nonzero while interrupts are temporarily deferred during redisplay. */
512 int interrupts_deferred
;
514 /* Nonzero means use ^S/^Q for flow control. */
517 /* Allow m- file to inhibit use of FIONREAD. */
518 #ifdef BROKEN_FIONREAD
522 /* We are unable to use interrupts if FIONREAD is not available,
523 so flush SIGIO so we won't try. */
530 /* If we support a window system, turn on the code to poll periodically
531 to detect C-g. It isn't actually used when doing interrupt input. */
532 #ifdef HAVE_WINDOW_SYSTEM
533 #define POLL_FOR_INPUT
536 /* Global variable declarations. */
538 /* Function for init_keyboard to call with no args (if nonzero). */
539 void (*keyboard_init_hook
) ();
541 static int read_avail_input ();
542 static void get_input_pending ();
543 static int readable_events ();
544 static Lisp_Object
read_char_x_menu_prompt ();
545 static Lisp_Object
read_char_minibuf_menu_prompt ();
546 static Lisp_Object
make_lispy_event ();
548 static Lisp_Object
make_lispy_movement ();
550 static Lisp_Object
modify_event_symbol ();
551 static Lisp_Object
make_lispy_switch_frame ();
552 static int parse_solitary_modifier ();
554 /* > 0 if we are to echo keystrokes. */
555 static int echo_keystrokes
;
557 /* Nonzero means don't try to suspend even if the operating system seems
559 static int cannot_suspend
;
561 #define min(a,b) ((a)<(b)?(a):(b))
562 #define max(a,b) ((a)>(b)?(a):(b))
564 /* Install the string STR as the beginning of the string of echoing,
565 so that it serves as a prompt for the next character.
566 Also start echoing. */
571 int len
= strlen (str
);
573 if (len
> ECHOBUFSIZE
- 4)
574 len
= ECHOBUFSIZE
- 4;
575 bcopy (str
, current_kboard
->echobuf
, len
);
576 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
577 *current_kboard
->echoptr
= '\0';
579 current_kboard
->echo_after_prompt
= len
;
584 /* Add C to the echo string, if echoing is going on.
585 C can be a character, which is printed prettily ("M-C-x" and all that
586 jazz), or a symbol, whose name is printed. */
591 extern char *push_key_description ();
593 if (current_kboard
->immediate_echo
)
595 char *ptr
= current_kboard
->echoptr
;
597 if (ptr
!= current_kboard
->echobuf
)
600 /* If someone has passed us a composite event, use its head symbol. */
605 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
608 ptr
= push_key_description (XINT (c
), ptr
);
610 else if (SYMBOLP (c
))
612 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
613 if ((ptr
- current_kboard
->echobuf
) + name
->size
+ 4 > ECHOBUFSIZE
)
615 bcopy (name
->data
, ptr
, name
->size
);
619 if (current_kboard
->echoptr
== current_kboard
->echobuf
622 strcpy (ptr
, " (Type ? for further options)");
627 current_kboard
->echoptr
= ptr
;
633 /* Temporarily add a dash to the end of the echo string if it's not
634 empty, so that it serves as a mini-prompt for the very next character. */
638 if (!current_kboard
->immediate_echo
639 && current_kboard
->echoptr
== current_kboard
->echobuf
)
641 /* Do nothing if we just printed a prompt. */
642 if (current_kboard
->echo_after_prompt
643 == current_kboard
->echoptr
- current_kboard
->echobuf
)
645 /* Do nothing if not echoing at all. */
646 if (current_kboard
->echoptr
== 0)
649 /* Put a dash at the end of the buffer temporarily,
650 but make it go away when the next character is added. */
651 current_kboard
->echoptr
[0] = '-';
652 current_kboard
->echoptr
[1] = 0;
657 /* Display the current echo string, and begin echoing if not already
662 if (!current_kboard
->immediate_echo
)
665 current_kboard
->immediate_echo
= 1;
667 for (i
= 0; i
< this_command_key_count
; i
++)
670 c
= XVECTOR (this_command_keys
)->contents
[i
];
671 if (! (EVENT_HAS_PARAMETERS (c
)
672 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
679 message1_nolog (current_kboard
->echobuf
);
682 if (waiting_for_input
&& !NILP (Vquit_flag
))
683 quit_throw_to_read_char ();
686 /* Turn off echoing, for the start of a new command. */
690 current_kboard
->immediate_echo
= 0;
691 current_kboard
->echoptr
= current_kboard
->echobuf
;
692 current_kboard
->echo_after_prompt
= -1;
693 ok_to_echo_at_next_pause
= 0;
696 /* Return the length of the current echo string. */
701 return current_kboard
->echoptr
- current_kboard
->echobuf
;
704 /* Truncate the current echo message to its first LEN chars.
705 This and echo_char get used by read_key_sequence when the user
706 switches frames while entering a key sequence. */
712 current_kboard
->echobuf
[len
] = '\0';
713 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
714 truncate_echo_area (len
);
718 /* Functions for manipulating this_command_keys. */
720 add_command_key (key
)
723 int size
= XVECTOR (this_command_keys
)->size
;
725 /* If reset-this-command-length was called recently, obey it now.
726 See the doc string of that function for an explanation of why. */
727 if (before_command_restore_flag
)
729 this_command_key_count
= before_command_key_count_1
;
730 if (this_command_key_count
< this_single_command_key_start
)
731 this_single_command_key_start
= this_command_key_count
;
732 echo_truncate (before_command_echo_length_1
);
733 before_command_restore_flag
= 0;
736 if (this_command_key_count
>= size
)
738 Lisp_Object new_keys
;
740 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
741 bcopy (XVECTOR (this_command_keys
)->contents
,
742 XVECTOR (new_keys
)->contents
,
743 size
* sizeof (Lisp_Object
));
745 this_command_keys
= new_keys
;
748 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
754 int count
= specpdl_ptr
- specpdl
;
757 if (command_loop_level
> 0)
759 specbind (Qstandard_output
, Qt
);
760 specbind (Qstandard_input
, Qt
);
763 val
= command_loop ();
765 Fsignal (Qquit
, Qnil
);
766 /* Handle throw from read_minibuf when using minibuffer
767 while it's active but we're in another window. */
769 Fsignal (Qerror
, Fcons (val
, Qnil
));
771 return unbind_to (count
, Qnil
);
774 /* When an auto-save happens, record the "time", and don't do again soon. */
778 last_auto_save
= num_nonmacro_input_events
;
781 /* Make an auto save happen as soon as possible at command level. */
783 force_auto_save_soon ()
785 last_auto_save
= - auto_save_interval
- 1;
787 record_asynch_buffer_change ();
790 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
791 "Invoke the editor command loop recursively.\n\
792 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
793 that tells this function to return.\n\
794 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
795 This function is called by the editor initialization to begin editing.")
798 int count
= specpdl_ptr
- specpdl
;
801 command_loop_level
++;
802 update_mode_lines
= 1;
804 record_unwind_protect (recursive_edit_unwind
,
806 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
810 return unbind_to (count
, Qnil
);
814 recursive_edit_unwind (buffer
)
818 Fset_buffer (buffer
);
820 command_loop_level
--;
821 update_mode_lines
= 1;
829 #if 0 /* Theory: if there's anything in Vunread_command_events,
830 it will right away be read by read_key_sequence,
831 and then if we do switch KBOARDS, it will go into the side
832 queue then. So we don't need to do anything special here -- rms. */
833 if (CONSP (Vunread_command_events
))
835 current_kboard
->kbd_queue
836 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
837 current_kboard
->kbd_queue_has_data
= 1;
839 Vunread_command_events
= Qnil
;
845 /* Switch to the single-kboard state, making current_kboard
846 the only KBOARD from which further input is accepted. */
849 single_kboard_state ()
856 /* Maintain a stack of kboards, so other parts of Emacs
857 can switch temporarily to the kboard of a given frame
858 and then revert to the previous status. */
863 struct kboard_stack
*next
;
866 static struct kboard_stack
*kboard_stack
;
869 push_frame_kboard (f
)
873 struct kboard_stack
*p
874 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
876 p
->next
= kboard_stack
;
877 p
->kboard
= current_kboard
;
880 current_kboard
= FRAME_KBOARD (f
);
888 struct kboard_stack
*p
= kboard_stack
;
889 current_kboard
= p
->kboard
;
890 kboard_stack
= p
->next
;
895 /* Handle errors that are not handled at inner levels
896 by printing an error message and returning to the editor command loop. */
902 Lisp_Object old_level
, old_length
;
905 if (!NILP (executing_macro
))
907 if (executing_macro_iterations
== 1)
908 sprintf (macroerror
, "After 1 kbd macro iteration: ");
910 sprintf (macroerror
, "After %d kbd macro iterations: ",
911 executing_macro_iterations
);
916 Vstandard_output
= Qt
;
917 Vstandard_input
= Qt
;
918 Vexecuting_macro
= Qnil
;
919 executing_macro
= Qnil
;
920 current_kboard
->Vprefix_arg
= Qnil
;
923 /* Avoid unquittable loop if data contains a circular list. */
924 old_level
= Vprint_level
;
925 old_length
= Vprint_length
;
926 XSETFASTINT (Vprint_level
, 10);
927 XSETFASTINT (Vprint_length
, 10);
928 cmd_error_internal (data
, macroerror
);
929 Vprint_level
= old_level
;
930 Vprint_length
= old_length
;
934 Vinhibit_quit
= Qnil
;
939 return make_number (0);
942 cmd_error_internal (data
, context
)
950 echo_area_glyphs
= 0;
952 /* If the window system or terminal frame hasn't been initialized
953 yet, or we're not interactive, it's best to dump this message out
954 to stderr and exit. */
955 if (! FRAME_MESSAGE_BUF (selected_frame
)
957 stream
= Qexternal_debugging_output
;
966 write_string_1 (context
, -1, stream
);
968 print_error_message (data
, stream
);
970 /* If the window system or terminal frame hasn't been initialized
971 yet, or we're in -batch mode, this error should cause Emacs to exit. */
972 if (! FRAME_MESSAGE_BUF (selected_frame
)
976 Fkill_emacs (make_number (-1));
980 Lisp_Object
command_loop_1 ();
981 Lisp_Object
command_loop_2 ();
982 Lisp_Object
top_level_1 ();
984 /* Entry to editor-command-loop.
985 This level has the catches for exiting/returning to editor command loop.
986 It returns nil to exit recursive edit, t to abort it. */
991 if (command_loop_level
> 0 || minibuf_level
> 0)
993 return internal_catch (Qexit
, command_loop_2
, Qnil
);
998 internal_catch (Qtop_level
, top_level_1
, Qnil
);
999 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1001 /* End of file in -batch run causes exit here. */
1007 /* Here we catch errors in execution of commands within the
1008 editing loop, and reenter the editing loop.
1009 When there is an error, cmd_error runs and returns a non-nil
1010 value to us. A value of nil means that cmd_loop_1 itself
1011 returned due to end of file (or end of kbd macro). */
1016 register Lisp_Object val
;
1019 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1020 while (!NILP (val
));
1028 return Feval (Vtop_level
);
1034 /* On entry to the outer level, run the startup file */
1035 if (!NILP (Vtop_level
))
1036 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1037 else if (!NILP (Vpurify_flag
))
1038 message ("Bare impure Emacs (standard Lisp code not loaded)");
1040 message ("Bare Emacs (standard Lisp code not loaded)");
1044 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1045 "Exit all recursive editing levels.")
1048 Fthrow (Qtop_level
, Qnil
);
1051 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1052 "Exit from the innermost recursive edit or minibuffer.")
1055 if (command_loop_level
> 0 || minibuf_level
> 0)
1056 Fthrow (Qexit
, Qnil
);
1058 error ("No recursive edit is in progress");
1061 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1062 "Abort the command that requested this recursive edit or minibuffer input.")
1065 if (command_loop_level
> 0 || minibuf_level
> 0)
1068 error ("No recursive edit is in progress");
1071 /* This is the actual command reading loop,
1072 sans error-handling encapsulation. */
1074 Lisp_Object
Fcommand_execute ();
1075 static int read_key_sequence ();
1076 void safe_run_hooks ();
1081 Lisp_Object cmd
, tem
;
1084 Lisp_Object keybuf
[30];
1089 struct buffer
*prev_buffer
;
1091 int was_locked
= single_kboard
;
1094 current_kboard
->Vprefix_arg
= Qnil
;
1095 Vdeactivate_mark
= Qnil
;
1096 waiting_for_input
= 0;
1101 this_command_key_count
= 0;
1102 this_single_command_key_start
= 0;
1104 /* Make sure this hook runs after commands that get errors and
1105 throw to top level. */
1106 /* Note that the value cell will never directly contain nil
1107 if the symbol is a local variable. */
1108 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1109 safe_run_hooks (Qpost_command_hook
);
1111 if (!NILP (Vdeferred_action_list
))
1112 call0 (Vdeferred_action_function
);
1114 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1116 if (NILP (Vunread_command_events
)
1117 && NILP (Vexecuting_macro
)
1118 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1119 safe_run_hooks (Qpost_command_idle_hook
);
1122 /* Do this after running Vpost_command_hook, for consistency. */
1123 current_kboard
->Vlast_command
= this_command
;
1127 /* Make sure the current window's buffer is selected. */
1128 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1129 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1131 /* Display any malloc warning that just came out. Use while because
1132 displaying one warning can cause another. */
1134 while (pending_malloc_warning
)
1135 display_malloc_warning ();
1139 Vdeactivate_mark
= Qnil
;
1141 /* If minibuffer on and echo area in use,
1142 wait 2 sec and redraw minibuffer. */
1144 if (minibuf_level
&& echo_area_glyphs
1145 && EQ (minibuf_window
, echo_area_window
))
1147 /* Bind inhibit-quit to t so that C-g gets read in
1148 rather than quitting back to the minibuffer. */
1149 int count
= specpdl_ptr
- specpdl
;
1150 specbind (Qinhibit_quit
, Qt
);
1152 Fsit_for (make_number (2), Qnil
, Qnil
);
1153 /* Clear the echo area. */
1155 safe_run_hooks (Qecho_area_clear_hook
);
1157 unbind_to (count
, Qnil
);
1159 /* If a C-g came in before, treat it as input now. */
1160 if (!NILP (Vquit_flag
))
1163 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1168 alloca (0); /* Cause a garbage collection now */
1169 /* Since we can free the most stuff here. */
1170 #endif /* C_ALLOCA */
1173 /* Select the frame that the last event came from. Usually,
1174 switch-frame events will take care of this, but if some lisp
1175 code swallows a switch-frame event, we'll fix things up here.
1176 Is this a good idea? */
1177 if (FRAMEP (internal_last_event_frame
)
1178 && XFRAME (internal_last_event_frame
) != selected_frame
)
1179 Fselect_frame (internal_last_event_frame
, Qnil
);
1181 /* If it has changed current-menubar from previous value,
1182 really recompute the menubar from the value. */
1183 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1184 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1185 call0 (Qrecompute_lucid_menubar
);
1187 before_command_key_count
= this_command_key_count
;
1188 before_command_echo_length
= echo_length ();
1190 this_command
= Qnil
;
1192 /* Read next key sequence; i gets its length. */
1193 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1196 /* A filter may have run while we were reading the input. */
1197 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1198 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1202 /* Now we have read a key sequence of length I,
1203 or else I is 0 and we found end of file. */
1205 if (i
== 0) /* End of file -- happens only in */
1206 return Qnil
; /* a kbd macro, at the end. */
1207 /* -1 means read_key_sequence got a menu that was rejected.
1208 Just loop around and read another command. */
1212 this_command_key_count
= 0;
1213 this_single_command_key_start
= 0;
1217 last_command_char
= keybuf
[i
- 1];
1219 /* If the previous command tried to force a specific window-start,
1220 forget about that, in case this command moves point far away
1221 from that position. But also throw away beg_unchanged and
1222 end_unchanged information in that case, so that redisplay will
1223 update the whole window properly. */
1224 if (!NILP (XWINDOW (selected_window
)->force_start
))
1226 XWINDOW (selected_window
)->force_start
= Qnil
;
1227 beg_unchanged
= end_unchanged
= 0;
1230 cmd
= read_key_sequence_cmd
;
1231 if (!NILP (Vexecuting_macro
))
1233 if (!NILP (Vquit_flag
))
1235 Vexecuting_macro
= Qt
;
1236 QUIT
; /* Make some noise. */
1237 /* Will return since macro now empty. */
1241 /* Do redisplay processing after this command except in special
1242 cases identified below that set no_redisplay to 1.
1243 (actually, there's currently no way to prevent the redisplay,
1244 and no_redisplay is ignored.
1245 Perhaps someday we will really implement it.) */
1248 prev_buffer
= current_buffer
;
1249 prev_modiff
= MODIFF
;
1250 last_point_position
= PT
;
1251 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1253 /* Execute the command. */
1256 /* Note that the value cell will never directly contain nil
1257 if the symbol is a local variable. */
1258 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1259 safe_run_hooks (Qpre_command_hook
);
1261 if (NILP (this_command
))
1263 /* nil means key is undefined. */
1265 current_kboard
->defining_kbd_macro
= Qnil
;
1266 update_mode_lines
= 1;
1267 current_kboard
->Vprefix_arg
= Qnil
;
1271 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1273 /* Recognize some common commands in common situations and
1274 do them directly. */
1275 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1277 struct Lisp_Char_Table
*dp
1278 = window_display_table (XWINDOW (selected_window
));
1279 lose
= FETCH_BYTE (PT
);
1280 SET_PT (forward_point (1));
1282 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1283 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1284 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1285 && (lose
>= 0x20 && lose
< 0x7f)))
1286 : (lose
>= 0x20 && lose
< 0x7f))
1287 /* To extract the case of continuation on
1288 wide-column characters. */
1289 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT
)) == 1)
1290 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1292 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1294 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1296 && !windows_or_buffers_changed
1297 && EQ (current_buffer
->selective_display
, Qnil
)
1298 && !detect_input_pending ()
1299 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1300 && NILP (Vexecuting_macro
))
1301 no_redisplay
= direct_output_forward_char (1);
1304 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1306 struct Lisp_Char_Table
*dp
1307 = window_display_table (XWINDOW (selected_window
));
1308 SET_PT (forward_point (-1));
1309 lose
= FETCH_BYTE (PT
);
1311 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1312 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1313 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1314 && (lose
>= 0x20 && lose
< 0x7f)))
1315 : (lose
>= 0x20 && lose
< 0x7f))
1316 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1318 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1320 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1322 && !windows_or_buffers_changed
1323 && EQ (current_buffer
->selective_display
, Qnil
)
1324 && !detect_input_pending ()
1325 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1326 && NILP (Vexecuting_macro
))
1327 no_redisplay
= direct_output_forward_char (-1);
1330 else if (EQ (this_command
, Qself_insert_command
)
1331 /* Try this optimization only on ascii keystrokes. */
1332 && INTEGERP (last_command_char
))
1334 unsigned int c
= XINT (last_command_char
);
1337 if (NILP (Vexecuting_macro
)
1338 && !EQ (minibuf_window
, selected_window
))
1340 if (!nonundocount
|| nonundocount
>= 20)
1347 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1349 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1351 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1353 || MODIFF
<= SAVE_MODIFF
1354 || windows_or_buffers_changed
1355 || !EQ (current_buffer
->selective_display
, Qnil
)
1356 || detect_input_pending ()
1357 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1358 || !NILP (Vexecuting_macro
));
1359 value
= internal_self_insert (c
, 0);
1366 && (PT
== ZV
|| FETCH_BYTE (PT
) == '\n'))
1368 struct Lisp_Char_Table
*dp
1369 = window_display_table (XWINDOW (selected_window
));
1376 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1379 /* Do it only for char codes
1380 that by default display as themselves. */
1381 if (lose
>= 0x20 && lose
<= 0x7e)
1382 no_redisplay
= direct_output_for_insert (lose
);
1384 else if (VECTORP (obj
)
1385 && XVECTOR (obj
)->size
== 1
1386 && (obj
= XVECTOR (obj
)->contents
[0],
1388 /* Insist face not specified in glyph. */
1389 && (XINT (obj
) & ((-1) << 8)) == 0)
1391 = direct_output_for_insert (XINT (obj
));
1395 if (lose
>= 0x20 && lose
<= 0x7e)
1396 no_redisplay
= direct_output_for_insert (lose
);
1403 /* Here for a command that isn't executed directly */
1406 if (NILP (current_kboard
->Vprefix_arg
))
1408 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1413 /* If there is a prefix argument,
1414 1) We don't want Vlast_command to be ``universal-argument''
1415 (that would be dumb), so don't set Vlast_command,
1416 2) we want to leave echoing on so that the prefix will be
1417 echoed as part of this key sequence, so don't call
1419 3) we want to leave this_command_key_count non-zero, so that
1420 read_char will realize that it is re-reading a character, and
1421 not echo it a second time.
1423 If the command didn't actually create a prefix arg,
1424 but is merely a frame event that is transparent to prefix args,
1425 then the above doesn't apply. */
1426 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1428 current_kboard
->Vlast_command
= this_command
;
1430 this_command_key_count
= 0;
1431 this_single_command_key_start
= 0;
1434 /* Note that the value cell will never directly contain nil
1435 if the symbol is a local variable. */
1436 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1437 safe_run_hooks (Qpost_command_hook
);
1439 if (!NILP (Vdeferred_action_list
))
1440 safe_run_hooks (Qdeferred_action_function
);
1442 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1444 if (NILP (Vunread_command_events
)
1445 && NILP (Vexecuting_macro
)
1446 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1447 safe_run_hooks (Qpost_command_idle_hook
);
1450 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1452 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1454 current_buffer
->mark_active
= Qnil
;
1455 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1457 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1458 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1462 /* Install chars successfully executed in kbd macro. */
1464 if (!NILP (current_kboard
->defining_kbd_macro
)
1465 && NILP (current_kboard
->Vprefix_arg
))
1466 finalize_kbd_macro_chars ();
1470 any_kboard_state ();
1475 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1478 safe_run_hooks_1 (hook
)
1481 return call1 (Vrun_hooks
, Vinhibit_quit
);
1484 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1487 safe_run_hooks_error (data
)
1490 Fset (Vinhibit_quit
, Qnil
);
1493 /* If we get an error while running the hook, cause the hook variable
1494 to be nil. Also inhibit quits, so that C-g won't cause the hook
1495 to mysteriously evaporate. */
1498 safe_run_hooks (hook
)
1502 int count
= specpdl_ptr
- specpdl
;
1503 specbind (Qinhibit_quit
, hook
);
1505 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1507 unbind_to (count
, Qnil
);
1510 /* Number of seconds between polling for input. */
1513 /* Nonzero means polling for input is temporarily suppressed. */
1514 int poll_suppress_count
;
1516 /* Nonzero if polling_for_input is actually being used. */
1517 int polling_for_input
;
1519 #ifdef POLL_FOR_INPUT
1521 /* Handle an alarm once each second and read pending input
1522 so as to handle a C-g if it comces in. */
1525 input_poll_signal (signalnum
) /* If we don't have an argument, */
1526 int signalnum
; /* some compilers complain in signal calls. */
1528 /* This causes the call to start_polling at the end
1529 to do its job. It also arranges for a quit or error
1530 from within read_avail_input to resume polling. */
1531 poll_suppress_count
++;
1532 if (interrupt_input_blocked
== 0
1533 && !waiting_for_input
)
1534 read_avail_input (0);
1535 /* Turn on the SIGALRM handler and request another alarm. */
1541 /* Begin signals to poll for input, if they are appropriate.
1542 This function is called unconditionally from various places. */
1546 #ifdef POLL_FOR_INPUT
1547 if (read_socket_hook
&& !interrupt_input
)
1549 poll_suppress_count
--;
1550 if (poll_suppress_count
== 0)
1552 signal (SIGALRM
, input_poll_signal
);
1553 polling_for_input
= 1;
1554 alarm (polling_period
);
1560 /* Nonzero if we are using polling to handle input asynchronously. */
1563 input_polling_used ()
1565 #ifdef POLL_FOR_INPUT
1566 return read_socket_hook
&& !interrupt_input
;
1572 /* Turn off polling. */
1576 #ifdef POLL_FOR_INPUT
1577 if (read_socket_hook
&& !interrupt_input
)
1579 if (poll_suppress_count
== 0)
1581 polling_for_input
= 0;
1584 poll_suppress_count
++;
1589 /* Set the value of poll_suppress_count to COUNT
1590 and start or stop polling accordingly. */
1593 set_poll_suppress_count (count
)
1596 #ifdef POLL_FOR_INPUT
1597 if (count
== 0 && poll_suppress_count
!= 0)
1599 poll_suppress_count
= 1;
1602 else if (count
!= 0 && poll_suppress_count
== 0)
1606 poll_suppress_count
= count
;
1610 /* Bind polling_period to a value at least N.
1611 But don't decrease it. */
1613 bind_polling_period (n
)
1616 #ifdef POLL_FOR_INPUT
1617 int new = polling_period
;
1623 specbind (Qpolling_period
, make_number (new));
1624 /* Start a new alarm with the new period. */
1629 /* Apply the control modifier to CHARACTER. */
1635 /* Save the upper bits here. */
1636 int upper
= c
& ~0177;
1640 /* Everything in the columns containing the upper-case letters
1641 denotes a control character. */
1642 if (c
>= 0100 && c
< 0140)
1646 /* Set the shift modifier for a control char
1647 made from a shifted letter. But only for letters! */
1648 if (oc
>= 'A' && oc
<= 'Z')
1649 c
|= shift_modifier
;
1652 /* The lower-case letters denote control characters too. */
1653 else if (c
>= 'a' && c
<= 'z')
1656 /* Include the bits for control and shift
1657 only if the basic ASCII code can't indicate them. */
1661 /* Replace the high bits. */
1662 c
|= (upper
& ~ctrl_modifier
);
1669 /* Input of single characters from keyboard */
1671 Lisp_Object
print_help ();
1672 static Lisp_Object
kbd_buffer_get_event ();
1673 static void record_char ();
1676 static jmp_buf wrong_kboard_jmpbuf
;
1679 /* read a character from the keyboard; call the redisplay if needed */
1680 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1681 -1 means do not do redisplay, but do do autosaving.
1684 /* The arguments MAPS and NMAPS are for menu prompting.
1685 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1687 PREV_EVENT is the previous input event, or nil if we are reading
1688 the first event of a key sequence.
1690 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1691 if we used a mouse menu to read the input, or zero otherwise. If
1692 USED_MOUSE_MENU is null, we don't dereference it.
1694 Value is t if we showed a menu and the user rejected it. */
1697 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1701 Lisp_Object prev_event
;
1702 int *used_mouse_menu
;
1706 jmp_buf local_getcjmp
;
1708 int key_already_recorded
= 0;
1709 Lisp_Object tem
, save
;
1710 Lisp_Object also_record
;
1711 struct gcpro gcpro1
;
1715 before_command_key_count
= this_command_key_count
;
1716 before_command_echo_length
= echo_length ();
1723 if (CONSP (Vunread_command_events
))
1725 c
= XCONS (Vunread_command_events
)->car
;
1726 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1728 /* Undo what read_char_x_menu_prompt did when it unread
1729 additional keys returned by Fx_popup_menu. */
1731 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1732 && NILP (XCONS (c
)->cdr
))
1735 if (this_command_key_count
== 0)
1741 if (unread_command_char
!= -1)
1743 XSETINT (c
, unread_command_char
);
1744 unread_command_char
= -1;
1746 if (this_command_key_count
== 0)
1752 /* If there is no function key translated before
1753 reset-this-command-lengths takes effect, forget about it. */
1754 before_command_restore_flag
= 0;
1756 if (!NILP (Vexecuting_macro
))
1758 /* We set this to Qmacro; since that's not a frame, nobody will
1759 try to switch frames on us, and the selected window will
1762 Since this event came from a macro, it would be misleading to
1763 leave internal_last_event_frame set to wherever the last
1764 real event came from. Normally, a switch-frame event selects
1765 internal_last_event_frame after each command is read, but
1766 events read from a macro should never cause a new frame to be
1768 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1770 /* Exit the macro if we are at the end.
1771 Also, some things replace the macro with t
1772 to force an early exit. */
1773 if (EQ (Vexecuting_macro
, Qt
)
1774 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1780 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1781 if (STRINGP (Vexecuting_macro
)
1782 && (XINT (c
) & 0x80))
1783 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1785 executing_macro_index
++;
1790 if (!NILP (unread_switch_frame
))
1792 c
= unread_switch_frame
;
1793 unread_switch_frame
= Qnil
;
1795 /* This event should make it into this_command_keys, and get echoed
1796 again, so we go to reread_first, rather than reread. */
1800 if (commandflag
>= 0)
1803 || detect_input_pending_run_timers (0))
1810 /* Message turns off echoing unless more keystrokes turn it on again. */
1811 if (echo_area_glyphs
&& *echo_area_glyphs
1812 && echo_area_glyphs
!= current_kboard
->echobuf
1813 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1816 /* If already echoing, continue. */
1819 /* Try reading a character via menu prompting in the minibuf.
1820 Try this before the sit-for, because the sit-for
1821 would do the wrong thing if we are supposed to do
1822 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1823 after a mouse event so don't try a minibuf menu. */
1825 if (nmaps
> 0 && INTERACTIVE
1826 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1827 /* Don't bring up a menu if we already have another event. */
1828 && NILP (Vunread_command_events
)
1829 && unread_command_char
< 0
1830 && !detect_input_pending_run_timers (0))
1832 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1835 key_already_recorded
= 1;
1840 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1841 We will do that below, temporarily for short sections of code,
1842 when appropriate. local_getcjmp must be in effect
1843 around any call to sit_for or kbd_buffer_get_event;
1844 it *must not* be in effect when we call redisplay. */
1846 if (_setjmp (local_getcjmp
))
1848 XSETINT (c
, quit_char
);
1849 XSETFRAME (internal_last_event_frame
, selected_frame
);
1850 Vlast_event_frame
= internal_last_event_frame
;
1851 /* If we report the quit char as an event,
1852 don't do so more than once. */
1853 if (!NILP (Vinhibit_quit
))
1858 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1859 if (kb
!= current_kboard
)
1861 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1862 /* We shouldn't get here if we were in single-kboard mode! */
1865 while (CONSP (*tailp
))
1866 tailp
= &XCONS (*tailp
)->cdr
;
1869 *tailp
= Fcons (c
, Qnil
);
1870 kb
->kbd_queue_has_data
= 1;
1871 current_kboard
= kb
;
1872 /* This is going to exit from read_char
1873 so we had better get rid of this frame's stuff. */
1875 longjmp (wrong_kboard_jmpbuf
, 1);
1882 timer_start_idle ();
1884 /* If in middle of key sequence and minibuffer not active,
1885 start echoing if enough time elapses. */
1887 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1888 && this_command_key_count
> 0
1890 && echo_keystrokes
> 0
1891 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1892 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1896 /* After a mouse event, start echoing right away.
1897 This is because we are probably about to display a menu,
1898 and we don't want to delay before doing so. */
1899 if (EVENT_HAS_PARAMETERS (prev_event
))
1903 save_getcjmp (save_jump
);
1904 restore_getcjmp (local_getcjmp
);
1905 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
1906 restore_getcjmp (save_jump
);
1908 && ! CONSP (Vunread_command_events
))
1913 /* Maybe auto save due to number of keystrokes. */
1915 if (commandflag
!= 0
1916 && auto_save_interval
> 0
1917 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
1918 && !detect_input_pending_run_timers (0))
1920 Fdo_auto_save (Qnil
, Qnil
);
1921 /* Hooks can actually change some buffers in auto save. */
1925 /* Try reading using an X menu.
1926 This is never confused with reading using the minibuf
1927 because the recursive call of read_char in read_char_minibuf_menu_prompt
1928 does not pass on any keymaps. */
1930 if (nmaps
> 0 && INTERACTIVE
1931 && !NILP (prev_event
)
1932 && EVENT_HAS_PARAMETERS (prev_event
)
1933 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1934 /* Don't bring up a menu if we already have another event. */
1935 && NILP (Vunread_command_events
)
1936 && unread_command_char
< 0)
1938 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1940 /* Now that we have read an event, Emacs is not idle. */
1946 /* Maybe autosave and/or garbage collect due to idleness. */
1948 if (INTERACTIVE
&& NILP (c
))
1950 int delay_level
, buffer_size
;
1952 /* Slow down auto saves logarithmically in size of current buffer,
1953 and garbage collect while we're at it. */
1954 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1955 last_non_minibuf_size
= Z
- BEG
;
1956 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1958 while (buffer_size
> 64)
1959 delay_level
++, buffer_size
-= buffer_size
>> 2;
1960 if (delay_level
< 4) delay_level
= 4;
1961 /* delay_level is 4 for files under around 50k, 7 at 100k,
1962 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1964 /* Auto save if enough time goes by without input. */
1965 if (commandflag
!= 0
1966 && num_nonmacro_input_events
> last_auto_save
1967 && INTEGERP (Vauto_save_timeout
)
1968 && XINT (Vauto_save_timeout
) > 0)
1972 save_getcjmp (save_jump
);
1973 restore_getcjmp (local_getcjmp
);
1974 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
1976 restore_getcjmp (save_jump
);
1979 && ! CONSP (Vunread_command_events
))
1981 Fdo_auto_save (Qnil
, Qnil
);
1983 /* If we have auto-saved and there is still no input
1984 available, garbage collect if there has been enough
1985 consing going on to make it worthwhile. */
1986 if (!detect_input_pending_run_timers (0)
1987 && consing_since_gc
> gc_cons_threshold
/ 2)
1988 Fgarbage_collect ();
1995 /* If this has become non-nil here, it has been set by a timer
1996 or sentinel or filter. */
1997 if (CONSP (Vunread_command_events
))
1999 c
= XCONS (Vunread_command_events
)->car
;
2000 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2003 /* Read something from current KBOARD's side queue, if possible. */
2007 if (current_kboard
->kbd_queue_has_data
)
2009 if (!CONSP (current_kboard
->kbd_queue
))
2011 c
= XCONS (current_kboard
->kbd_queue
)->car
;
2012 current_kboard
->kbd_queue
2013 = XCONS (current_kboard
->kbd_queue
)->cdr
;
2014 if (NILP (current_kboard
->kbd_queue
))
2015 current_kboard
->kbd_queue_has_data
= 0;
2016 input_pending
= readable_events (0);
2017 if (EVENT_HAS_PARAMETERS (c
)
2018 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2019 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2020 Vlast_event_frame
= internal_last_event_frame
;
2025 /* If current_kboard's side queue is empty check the other kboards.
2026 If one of them has data that we have not yet seen here,
2027 switch to it and process the data waiting for it.
2029 Note: if the events queued up for another kboard
2030 have already been seen here, and therefore are not a complete command,
2031 the kbd_queue_has_data field is 0, so we skip that kboard here.
2032 That's to avoid an infinite loop switching between kboards here. */
2033 if (NILP (c
) && !single_kboard
)
2036 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2037 if (kb
->kbd_queue_has_data
)
2039 current_kboard
= kb
;
2040 /* This is going to exit from read_char
2041 so we had better get rid of this frame's stuff. */
2043 longjmp (wrong_kboard_jmpbuf
, 1);
2052 /* Finally, we read from the main queue,
2053 and if that gives us something we can't use yet, we put it on the
2054 appropriate side queue and try again. */
2060 /* Actually read a character, waiting if necessary. */
2061 save_getcjmp (save_jump
);
2062 restore_getcjmp (local_getcjmp
);
2063 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2064 restore_getcjmp (save_jump
);
2067 if (! NILP (c
) && (kb
!= current_kboard
))
2069 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2070 while (CONSP (*tailp
))
2071 tailp
= &XCONS (*tailp
)->cdr
;
2074 *tailp
= Fcons (c
, Qnil
);
2075 kb
->kbd_queue_has_data
= 1;
2079 current_kboard
= kb
;
2080 /* This is going to exit from read_char
2081 so we had better get rid of this frame's stuff. */
2083 longjmp (wrong_kboard_jmpbuf
, 1);
2088 /* Terminate Emacs in batch mode if at eof. */
2089 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2090 Fkill_emacs (make_number (1));
2094 /* Add in any extra modifiers, where appropriate. */
2095 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2096 || ((extra_keyboard_modifiers
& 0177) < ' '
2097 && (extra_keyboard_modifiers
& 0177) != 0))
2098 XSETINT (c
, make_ctrl_char (XINT (c
)));
2100 /* Transfer any other modifier bits directly from
2101 extra_keyboard_modifiers to c. Ignore the actual character code
2102 in the low 16 bits of extra_keyboard_modifiers. */
2103 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2114 if (commandflag
>= 0
2115 && !input_pending
&& !detect_input_pending_run_timers (0))
2123 /* Buffer switch events are only for internal wakeups
2124 so don't show them to the user.
2125 Also, don't record a key if we already did. */
2126 if (BUFFERP (c
) || key_already_recorded
)
2129 /* Process special events within read_char
2130 and loop around to read another event. */
2133 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2139 int was_locked
= single_kboard
;
2141 last_input_char
= c
;
2142 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2144 /* Resume allowing input from any kboard, if that was true before. */
2146 any_kboard_state ();
2151 /* Wipe the echo area. */
2152 if (echo_area_glyphs
)
2153 safe_run_hooks (Qecho_area_clear_hook
);
2154 echo_area_glyphs
= 0;
2156 /* Handle things that only apply to characters. */
2159 /* If kbd_buffer_get_event gave us an EOF, return that. */
2163 if (STRINGP (Vkeyboard_translate_table
)
2164 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2165 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2166 else if ((VECTORP (Vkeyboard_translate_table
)
2167 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2168 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2169 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2172 d
= Faref (Vkeyboard_translate_table
, c
);
2173 /* nil in keyboard-translate-table means no translation. */
2179 /* If this event is a mouse click in the menu bar,
2180 return just menu-bar for now. Modify the mouse click event
2181 so we won't do this twice, then queue it up. */
2182 if (EVENT_HAS_PARAMETERS (c
)
2183 && CONSP (XCONS (c
)->cdr
)
2184 && CONSP (EVENT_START (c
))
2185 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2189 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2190 /* Handle menu-bar events:
2191 insert the dummy prefix event `menu-bar'. */
2192 if (EQ (posn
, Qmenu_bar
))
2194 /* Change menu-bar to (menu-bar) as the event "position". */
2195 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2198 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2204 if (! NILP (also_record
))
2205 record_char (also_record
);
2210 before_command_key_count
= this_command_key_count
;
2211 before_command_echo_length
= echo_length ();
2213 /* Don't echo mouse motion events. */
2215 && ! (EVENT_HAS_PARAMETERS (c
)
2216 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2219 if (! NILP (also_record
))
2220 echo_char (also_record
);
2221 /* Once we reread a character, echoing can happen
2222 the next time we pause to read a new one. */
2223 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2226 /* Record this character as part of the current key. */
2227 add_command_key (c
);
2228 if (! NILP (also_record
))
2229 add_command_key (also_record
);
2231 /* Re-reading in the middle of a command */
2233 last_input_char
= c
;
2236 /* Process the help character specially if enabled */
2237 if (!NILP (Vhelp_form
) && help_char_p (c
))
2240 count
= specpdl_ptr
- specpdl
;
2242 record_unwind_protect (Fset_window_configuration
,
2243 Fcurrent_window_configuration (Qnil
));
2245 tem0
= Feval (Vhelp_form
);
2247 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2251 c
= read_char (0, 0, 0, Qnil
, 0);
2252 while (BUFFERP (c
));
2253 /* Remove the help from the frame */
2254 unbind_to (count
, Qnil
);
2257 if (EQ (c
, make_number (040)))
2261 c
= read_char (0, 0, 0, Qnil
, 0);
2262 while (BUFFERP (c
));
2269 /* Record a key that came from a mouse menu.
2270 Record it for echoing, for this-command-keys, and so on. */
2276 /* Wipe the echo area. */
2277 echo_area_glyphs
= 0;
2281 before_command_key_count
= this_command_key_count
;
2282 before_command_echo_length
= echo_length ();
2284 /* Don't echo mouse motion events. */
2285 if (echo_keystrokes
)
2289 /* Once we reread a character, echoing can happen
2290 the next time we pause to read a new one. */
2291 ok_to_echo_at_next_pause
= 0;
2294 /* Record this character as part of the current key. */
2295 add_command_key (c
);
2297 /* Re-reading in the middle of a command */
2298 last_input_char
= c
;
2302 /* Return 1 if should recognize C as "the help character". */
2310 if (EQ (c
, Vhelp_char
))
2312 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2313 if (EQ (c
, XCONS (tail
)->car
))
2318 /* Record the input event C in various ways. */
2325 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2326 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2327 recent_keys_index
= 0;
2329 /* Write c to the dribble file. If c is a lispy event, write
2330 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2331 If you, dear reader, have a better idea, you've got the source. :-) */
2336 if (XUINT (c
) < 0x100)
2337 putc (XINT (c
), dribble
);
2339 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2343 Lisp_Object dribblee
;
2345 /* If it's a structured event, take the event header. */
2346 dribblee
= EVENT_HEAD (c
);
2348 if (SYMBOLP (dribblee
))
2350 putc ('<', dribble
);
2351 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2352 XSYMBOL (dribblee
)->name
->size
,
2354 putc ('>', dribble
);
2361 store_kbd_macro_char (c
);
2363 num_nonmacro_input_events
++;
2370 struct buffer
*old
= current_buffer
;
2371 Fprinc (object
, Qnil
);
2372 set_buffer_internal (XBUFFER (Vstandard_output
));
2373 call0 (intern ("help-mode"));
2374 set_buffer_internal (old
);
2378 /* Copy out or in the info on where C-g should throw to.
2379 This is used when running Lisp code from within get_char,
2380 in case get_char is called recursively.
2381 See read_process_output. */
2386 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2389 restore_getcjmp (temp
)
2392 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2397 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2398 of this function. */
2401 tracking_off (old_value
)
2402 Lisp_Object old_value
;
2404 do_mouse_tracking
= old_value
;
2405 if (NILP (old_value
))
2407 /* Redisplay may have been preempted because there was input
2408 available, and it assumes it will be called again after the
2409 input has been processed. If the only input available was
2410 the sort that we have just disabled, then we need to call
2412 if (!readable_events (1))
2414 redisplay_preserve_echo_area ();
2415 get_input_pending (&input_pending
, 1);
2420 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2421 "Evaluate BODY with mouse movement events enabled.\n\
2422 Within a `track-mouse' form, mouse motion generates input events that\n\
2423 you can read with `read-event'.\n\
2424 Normally, mouse motion is ignored.")
2428 int count
= specpdl_ptr
- specpdl
;
2431 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2433 do_mouse_tracking
= Qt
;
2435 val
= Fprogn (args
);
2436 return unbind_to (count
, val
);
2439 /* If mouse has moved on some frame, return one of those frames.
2440 Return 0 otherwise. */
2445 Lisp_Object tail
, frame
;
2447 FOR_EACH_FRAME (tail
, frame
)
2449 if (XFRAME (frame
)->mouse_moved
)
2450 return XFRAME (frame
);
2456 #endif /* HAVE_MOUSE */
2458 /* Low level keyboard/mouse input.
2459 kbd_buffer_store_event places events in kbd_buffer, and
2460 kbd_buffer_get_event retrieves them. */
2462 /* Return true iff there are any events in the queue that read-char
2463 would return. If this returns false, a read-char would block. */
2465 readable_events (do_timers_now
)
2469 timer_check (do_timers_now
);
2471 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2474 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2479 if (current_kboard
->kbd_queue_has_data
)
2485 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2486 if (kb
->kbd_queue_has_data
)
2492 /* Set this for debugging, to have a way to get out */
2497 event_to_kboard (event
)
2498 struct input_event
*event
;
2501 frame
= event
->frame_or_window
;
2503 frame
= XCONS (frame
)->car
;
2504 else if (WINDOWP (frame
))
2505 frame
= WINDOW_FRAME (XWINDOW (frame
));
2507 /* There are still some events that don't set this field.
2508 For now, just ignore the problem.
2509 Also ignore dead frames here. */
2510 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2513 return FRAME_KBOARD (XFRAME (frame
));
2517 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2520 kbd_buffer_store_event (event
)
2521 register struct input_event
*event
;
2523 if (event
->kind
== no_event
)
2526 if (event
->kind
== ascii_keystroke
)
2528 register int c
= event
->code
& 0377;
2530 if (event
->modifiers
& ctrl_modifier
)
2531 c
= make_ctrl_char (c
);
2533 c
|= (event
->modifiers
2534 & (meta_modifier
| alt_modifier
2535 | hyper_modifier
| super_modifier
));
2539 extern SIGTYPE
interrupt_signal ();
2542 struct input_event
*sp
;
2545 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2546 kb
!= current_kboard
))
2549 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2550 Fcons (make_number (c
), Qnil
));
2551 kb
->kbd_queue_has_data
= 1;
2552 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2554 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2557 if (event_to_kboard (sp
) == kb
)
2559 sp
->kind
= no_event
;
2560 sp
->frame_or_window
= Qnil
;
2567 /* If this results in a quit_char being returned to Emacs as
2568 input, set Vlast_event_frame properly. If this doesn't
2569 get returned to Emacs as an event, the next event read
2570 will set Vlast_event_frame again, so this is safe to do. */
2574 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2576 focus
= event
->frame_or_window
;
2577 internal_last_event_frame
= focus
;
2578 Vlast_event_frame
= focus
;
2581 last_event_timestamp
= event
->timestamp
;
2582 interrupt_signal ();
2586 if (c
&& c
== stop_character
)
2592 /* Don't insert two buffer_switch_event's in a row.
2593 Just ignore the second one. */
2594 else if (event
->kind
== buffer_switch_event
2595 && kbd_fetch_ptr
!= kbd_store_ptr
2596 && kbd_store_ptr
->kind
== buffer_switch_event
)
2599 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2600 kbd_store_ptr
= kbd_buffer
;
2602 /* Don't let the very last slot in the buffer become full,
2603 since that would make the two pointers equal,
2604 and that is indistinguishable from an empty buffer.
2605 Discard the event if it would fill the last slot. */
2606 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2608 volatile struct input_event
*sp
= kbd_store_ptr
;
2609 sp
->kind
= event
->kind
;
2610 if (event
->kind
== selection_request_event
)
2612 /* We must not use the ordinary copying code for this case,
2613 since `part' is an enum and copying it might not copy enough
2615 bcopy (event
, (char *) sp
, sizeof (*event
));
2619 sp
->code
= event
->code
;
2620 sp
->part
= event
->part
;
2621 sp
->frame_or_window
= event
->frame_or_window
;
2622 sp
->modifiers
= event
->modifiers
;
2625 sp
->timestamp
= event
->timestamp
;
2627 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2629 = event
->frame_or_window
);
2635 /* Discard any mouse events in the event buffer by setting them to
2638 discard_mouse_events ()
2640 struct input_event
*sp
;
2641 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2643 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2646 if (sp
->kind
== mouse_click
2648 || sp
->kind
== w32_scroll_bar_click
2650 || sp
->kind
== scroll_bar_click
)
2652 sp
->kind
= no_event
;
2657 /* Read one event from the event buffer, waiting if necessary.
2658 The value is a Lisp object representing the event.
2659 The value is nil for an event that should be ignored,
2660 or that was handled here.
2661 We always read and discard one event. */
2664 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2666 int *used_mouse_menu
;
2670 EMACS_TIME next_timer_delay
;
2676 *kbp
= current_kboard
;
2680 /* Wait until there is input available. */
2683 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2686 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2690 /* If the quit flag is set, then read_char will return
2691 quit_char, so that counts as "available input." */
2692 if (!NILP (Vquit_flag
))
2693 quit_throw_to_read_char ();
2695 /* One way or another, wait until input is available; then, if
2696 interrupt handlers have not read it, read it now. */
2699 wait_for_kbd_input ();
2701 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2705 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2708 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2712 Lisp_Object minus_one
;
2714 XSETINT (minus_one
, -1);
2715 wait_reading_process_input (0, 0, minus_one
, 1);
2717 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2718 /* Pass 1 for EXPECT since we just waited to have input. */
2719 read_avail_input (1);
2721 #endif /* not VMS */
2724 if (CONSP (Vunread_command_events
))
2727 first
= XCONS (Vunread_command_events
)->car
;
2728 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2729 *kbp
= current_kboard
;
2733 /* At this point, we know that there is a readable event available
2734 somewhere. If the event queue is empty, then there must be a
2735 mouse movement enabled and available. */
2736 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2738 struct input_event
*event
;
2740 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2744 last_event_timestamp
= event
->timestamp
;
2747 *kbp
= event_to_kboard (event
);
2749 *kbp
= current_kboard
; /* Better than returning null ptr? */
2751 *kbp
= &the_only_kboard
;
2756 /* These two kinds of events get special handling
2757 and don't actually appear to the command loop.
2758 We return nil for them. */
2759 if (event
->kind
== selection_request_event
)
2762 struct input_event copy
;
2764 /* Remove it from the buffer before processing it,
2765 since otherwise swallow_events will see it
2766 and process it again. */
2768 kbd_fetch_ptr
= event
+ 1;
2769 input_pending
= readable_events (0);
2770 x_handle_selection_request (©
);
2772 /* We're getting selection request events, but we don't have
2778 else if (event
->kind
== selection_clear_event
)
2781 struct input_event copy
;
2783 /* Remove it from the buffer before processing it. */
2785 kbd_fetch_ptr
= event
+ 1;
2786 input_pending
= readable_events (0);
2787 x_handle_selection_clear (©
);
2789 /* We're getting selection request events, but we don't have
2794 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2795 else if (event
->kind
== delete_window_event
)
2797 /* Make an event (delete-frame (FRAME)). */
2798 obj
= Fcons (event
->frame_or_window
, Qnil
);
2799 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2800 kbd_fetch_ptr
= event
+ 1;
2802 else if (event
->kind
== iconify_event
)
2804 /* Make an event (iconify-frame (FRAME)). */
2805 obj
= Fcons (event
->frame_or_window
, Qnil
);
2806 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2807 kbd_fetch_ptr
= event
+ 1;
2809 else if (event
->kind
== deiconify_event
)
2811 /* Make an event (make-frame-visible (FRAME)). */
2812 obj
= Fcons (event
->frame_or_window
, Qnil
);
2813 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2814 kbd_fetch_ptr
= event
+ 1;
2817 else if (event
->kind
== buffer_switch_event
)
2819 /* The value doesn't matter here; only the type is tested. */
2820 XSETBUFFER (obj
, current_buffer
);
2821 kbd_fetch_ptr
= event
+ 1;
2823 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2824 else if (event
->kind
== menu_bar_activate_event
)
2826 kbd_fetch_ptr
= event
+ 1;
2827 input_pending
= readable_events (0);
2828 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2829 x_activate_menubar (XFRAME (event
->frame_or_window
));
2832 /* Just discard these, by returning nil.
2833 With MULTI_KBOARD, these events are used as placeholders
2834 when we need to randomly delete events from the queue.
2835 (They shouldn't otherwise be found in the buffer,
2836 but on some machines it appears they do show up
2837 even without MULTI_KBOARD.) */
2838 /* On Windows NT/9X, no_event is used to delete extraneous
2839 mouse events during a popup-menu call. */
2840 else if (event
->kind
== no_event
)
2841 kbd_fetch_ptr
= event
+ 1;
2843 /* If this event is on a different frame, return a switch-frame this
2844 time, and leave the event in the queue for next time. */
2850 frame
= event
->frame_or_window
;
2852 frame
= XCONS (frame
)->car
;
2853 else if (WINDOWP (frame
))
2854 frame
= WINDOW_FRAME (XWINDOW (frame
));
2856 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2860 if (! EQ (frame
, internal_last_event_frame
)
2861 && XFRAME (frame
) != selected_frame
)
2862 obj
= make_lispy_switch_frame (frame
);
2863 internal_last_event_frame
= frame
;
2865 /* If we didn't decide to make a switch-frame event, go ahead
2866 and build a real event from the queue entry. */
2870 obj
= make_lispy_event (event
);
2871 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2872 /* If this was a menu selection, then set the flag to inhibit
2873 writing to last_nonmenu_event. Don't do this if the event
2874 we're returning is (menu-bar), though; that indicates the
2875 beginning of the menu sequence, and we might as well leave
2876 that as the `event with parameters' for this selection. */
2877 if (event
->kind
== menu_bar_event
2878 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2880 *used_mouse_menu
= 1;
2883 /* Wipe out this event, to catch bugs. */
2884 event
->kind
= no_event
;
2885 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2887 kbd_fetch_ptr
= event
+ 1;
2892 /* Try generating a mouse motion event. */
2893 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2895 FRAME_PTR f
= some_mouse_moved ();
2896 Lisp_Object bar_window
;
2897 enum scroll_bar_part part
;
2901 *kbp
= current_kboard
;
2902 /* Note that this uses F to determine which display to look at.
2903 If there is no valid info, it does not store anything
2904 so x remains nil. */
2906 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2910 /* Decide if we should generate a switch-frame event. Don't
2911 generate switch-frame events for motion outside of all Emacs
2917 frame
= FRAME_FOCUS_FRAME (f
);
2919 XSETFRAME (frame
, f
);
2921 if (! EQ (frame
, internal_last_event_frame
)
2922 && XFRAME (frame
) != selected_frame
)
2923 obj
= make_lispy_switch_frame (frame
);
2924 internal_last_event_frame
= frame
;
2927 /* If we didn't decide to make a switch-frame event, go ahead and
2928 return a mouse-motion event. */
2929 if (!NILP (x
) && NILP (obj
))
2930 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2932 #endif /* HAVE_MOUSE */
2934 /* We were promised by the above while loop that there was
2935 something for us to read! */
2938 input_pending
= readable_events (0);
2940 Vlast_event_frame
= internal_last_event_frame
;
2945 /* Process any events that are not user-visible,
2946 then return, without reading any user-visible events. */
2949 swallow_events (do_display
)
2954 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2956 struct input_event
*event
;
2958 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2962 last_event_timestamp
= event
->timestamp
;
2964 /* These two kinds of events get special handling
2965 and don't actually appear to the command loop. */
2966 if (event
->kind
== selection_request_event
)
2969 struct input_event copy
;
2971 /* Remove it from the buffer before processing it,
2972 since otherwise swallow_events called recursively could see it
2973 and process it again. */
2975 kbd_fetch_ptr
= event
+ 1;
2976 input_pending
= readable_events (0);
2977 x_handle_selection_request (©
);
2979 /* We're getting selection request events, but we don't have
2985 else if (event
->kind
== selection_clear_event
)
2988 struct input_event copy
;
2990 /* Remove it from the buffer before processing it, */
2993 kbd_fetch_ptr
= event
+ 1;
2994 input_pending
= readable_events (0);
2995 x_handle_selection_clear (©
);
2997 /* We're getting selection request events, but we don't have
3006 old_timers_run
= timers_run
;
3007 get_input_pending (&input_pending
, 1);
3009 if (timers_run
!= old_timers_run
&& do_display
)
3010 redisplay_preserve_echo_area ();
3013 static EMACS_TIME timer_idleness_start_time
;
3015 /* Record the start of when Emacs is idle,
3016 for the sake of running idle-time timers. */
3022 /* If we are already in the idle state, do nothing. */
3023 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3026 EMACS_GET_TIME (timer_idleness_start_time
);
3028 /* Mark all idle-time timers as once again candidates for running. */
3029 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
3033 timer
= XCONS (timers
)->car
;
3035 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3037 XVECTOR (timer
)->contents
[0] = Qnil
;
3041 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3045 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3048 /* This is only for debugging. */
3049 struct input_event last_timer_event
;
3051 /* Check whether a timer has fired. To prevent larger problems we simply
3052 disregard elements that are not proper timers. Do not make a circular
3053 timer list for the time being.
3055 Returns the number of seconds to wait until the next timer fires. If a
3056 timer is triggering now, return zero seconds.
3057 If no timer is active, return -1 seconds.
3059 If a timer is ripe, we run it, with quitting turned off.
3061 DO_IT_NOW is now ignored. It used to mean that we should
3062 run the timer directly instead of queueing a timer-event.
3063 Now we always run timers directly. */
3066 timer_check (do_it_now
)
3069 EMACS_TIME nexttime
;
3070 EMACS_TIME now
, idleness_now
;
3071 Lisp_Object timers
, idle_timers
, chosen_timer
;
3072 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3074 EMACS_SET_SECS (nexttime
, -1);
3075 EMACS_SET_USECS (nexttime
, -1);
3077 /* Always consider the ordinary timers. */
3078 timers
= Vtimer_list
;
3079 /* Consider the idle timers only if Emacs is idle. */
3080 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3081 idle_timers
= Vtimer_idle_list
;
3084 chosen_timer
= Qnil
;
3085 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3087 if (CONSP (timers
) || CONSP (idle_timers
))
3089 EMACS_GET_TIME (now
);
3090 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3091 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3094 while (CONSP (timers
) || CONSP (idle_timers
))
3096 int triggertime
= EMACS_SECS (now
);
3097 Lisp_Object
*vector
;
3098 Lisp_Object timer
, idle_timer
;
3099 EMACS_TIME timer_time
, idle_timer_time
;
3100 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3102 /* Skip past invalid timers and timers already handled. */
3105 timer
= XCONS (timers
)->car
;
3106 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3108 timers
= XCONS (timers
)->cdr
;
3111 vector
= XVECTOR (timer
)->contents
;
3113 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3114 || !INTEGERP (vector
[3])
3115 || ! NILP (vector
[0]))
3117 timers
= XCONS (timers
)->cdr
;
3121 if (!NILP (idle_timers
))
3123 timer
= XCONS (idle_timers
)->car
;
3124 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3126 idle_timers
= XCONS (idle_timers
)->cdr
;
3129 vector
= XVECTOR (timer
)->contents
;
3131 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3132 || !INTEGERP (vector
[3])
3133 || ! NILP (vector
[0]))
3135 idle_timers
= XCONS (idle_timers
)->cdr
;
3140 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3141 based on the next ordinary timer.
3142 TIMER_DIFFERENCE is the distance in time from NOW to when
3143 this timer becomes ripe (negative if it's already ripe). */
3146 timer
= XCONS (timers
)->car
;
3147 vector
= XVECTOR (timer
)->contents
;
3148 EMACS_SET_SECS (timer_time
,
3149 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3150 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3151 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3154 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3155 based on the next idle timer. */
3156 if (!NILP (idle_timers
))
3158 idle_timer
= XCONS (idle_timers
)->car
;
3159 vector
= XVECTOR (idle_timer
)->contents
;
3160 EMACS_SET_SECS (idle_timer_time
,
3161 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3162 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3163 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3166 /* Decide which timer is the next timer,
3167 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3168 Also step down the list where we found that timer. */
3170 if (! NILP (timers
) && ! NILP (idle_timers
))
3173 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3174 if (EMACS_TIME_NEG_P (temp
))
3176 chosen_timer
= timer
;
3177 timers
= XCONS (timers
)->cdr
;
3178 difference
= timer_difference
;
3182 chosen_timer
= idle_timer
;
3183 idle_timers
= XCONS (idle_timers
)->cdr
;
3184 difference
= idle_timer_difference
;
3187 else if (! NILP (timers
))
3189 chosen_timer
= timer
;
3190 timers
= XCONS (timers
)->cdr
;
3191 difference
= timer_difference
;
3195 chosen_timer
= idle_timer
;
3196 idle_timers
= XCONS (idle_timers
)->cdr
;
3197 difference
= idle_timer_difference
;
3199 vector
= XVECTOR (chosen_timer
)->contents
;
3201 /* If timer is rupe, run it if it hasn't been run. */
3202 if (EMACS_TIME_NEG_P (difference
)
3203 || (EMACS_SECS (difference
) == 0
3204 && EMACS_USECS (difference
) == 0))
3206 if (NILP (vector
[0]))
3209 int was_locked
= single_kboard
;
3210 int count
= specpdl_ptr
- specpdl
;
3212 /* Mark the timer as triggered to prevent problems if the lisp
3213 code fails to reschedule it right. */
3216 specbind (Qinhibit_quit
, Qt
);
3218 call1 (Qtimer_event_handler
, chosen_timer
);
3221 unbind_to (count
, Qnil
);
3223 /* Resume allowing input from any kboard, if that was true before. */
3225 any_kboard_state ();
3227 /* Since we have handled the event,
3228 we don't need to tell the caller to wake up and do it. */
3232 /* When we encounter a timer that is still waiting,
3233 return the amount of time to wait before it is ripe. */
3240 /* No timers are pending in the future. */
3241 /* Return 0 if we generated an event, and -1 if not. */
3246 /* Caches for modify_event_symbol. */
3247 static Lisp_Object accent_key_syms
;
3248 static Lisp_Object func_key_syms
;
3249 static Lisp_Object mouse_syms
;
3251 static Lisp_Object mouse_wheel_syms
;
3254 /* This is a list of keysym codes for special "accent" characters.
3255 It parallels lispy_accent_keys. */
3257 static int lispy_accent_codes
[] =
3259 #ifdef XK_dead_circumflex
3264 #ifdef XK_dead_grave
3269 #ifdef XK_dead_tilde
3274 #ifdef XK_dead_diaeresis
3279 #ifdef XK_dead_macron
3284 #ifdef XK_dead_degree
3289 #ifdef XK_dead_acute
3294 #ifdef XK_dead_cedilla
3299 #ifdef XK_dead_breve
3304 #ifdef XK_dead_ogonek
3309 #ifdef XK_dead_caron
3314 #ifdef XK_dead_doubleacute
3315 XK_dead_doubleacute
,
3319 #ifdef XK_dead_abovedot
3326 /* This is a list of Lisp names for special "accent" characters.
3327 It parallels lispy_accent_codes. */
3329 static char *lispy_accent_keys
[] =
3347 #define FUNCTION_KEY_OFFSET 0x0
3349 char *lispy_function_keys
[] =
3353 0, /* VK_LBUTTON 0x01 */
3354 0, /* VK_RBUTTON 0x02 */
3355 "cancel", /* VK_CANCEL 0x03 */
3356 0, /* VK_MBUTTON 0x04 */
3358 0, 0, 0, /* 0x05 .. 0x07 */
3360 "backspace", /* VK_BACK 0x08 */
3361 "tab", /* VK_TAB 0x09 */
3363 0, 0, /* 0x0A .. 0x0B */
3365 "clear", /* VK_CLEAR 0x0C */
3366 "return", /* VK_RETURN 0x0D */
3368 0, 0, /* 0x0E .. 0x0F */
3370 "shift", /* VK_SHIFT 0x10 */
3371 "control", /* VK_CONTROL 0x11 */
3372 "menu", /* VK_MENU 0x12 */
3373 "pause", /* VK_PAUSE 0x13 */
3374 "capital", /* VK_CAPITAL 0x14 */
3376 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3378 0, /* VK_ESCAPE 0x1B */
3380 0, 0, 0, 0, /* 0x1C .. 0x1F */
3382 0, /* VK_SPACE 0x20 */
3383 "prior", /* VK_PRIOR 0x21 */
3384 "next", /* VK_NEXT 0x22 */
3385 "end", /* VK_END 0x23 */
3386 "home", /* VK_HOME 0x24 */
3387 "left", /* VK_LEFT 0x25 */
3388 "up", /* VK_UP 0x26 */
3389 "right", /* VK_RIGHT 0x27 */
3390 "down", /* VK_DOWN 0x28 */
3391 "select", /* VK_SELECT 0x29 */
3392 "print", /* VK_PRINT 0x2A */
3393 "execute", /* VK_EXECUTE 0x2B */
3394 "snapshot", /* VK_SNAPSHOT 0x2C */
3395 "insert", /* VK_INSERT 0x2D */
3396 "delete", /* VK_DELETE 0x2E */
3397 "help", /* VK_HELP 0x2F */
3399 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3401 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3403 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3405 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3407 0, 0, 0, 0, 0, 0, 0, 0, 0,
3408 0, 0, 0, 0, 0, 0, 0, 0, 0,
3409 0, 0, 0, 0, 0, 0, 0, 0,
3411 "lwindow", /* VK_LWIN 0x5B */
3412 "rwindow", /* VK_RWIN 0x5C */
3413 "apps", /* VK_APPS 0x5D */
3415 0, 0, /* 0x5E .. 0x5F */
3417 "kp-0", /* VK_NUMPAD0 0x60 */
3418 "kp-1", /* VK_NUMPAD1 0x61 */
3419 "kp-2", /* VK_NUMPAD2 0x62 */
3420 "kp-3", /* VK_NUMPAD3 0x63 */
3421 "kp-4", /* VK_NUMPAD4 0x64 */
3422 "kp-5", /* VK_NUMPAD5 0x65 */
3423 "kp-6", /* VK_NUMPAD6 0x66 */
3424 "kp-7", /* VK_NUMPAD7 0x67 */
3425 "kp-8", /* VK_NUMPAD8 0x68 */
3426 "kp-9", /* VK_NUMPAD9 0x69 */
3427 "kp-multiply", /* VK_MULTIPLY 0x6A */
3428 "kp-add", /* VK_ADD 0x6B */
3429 "kp-separator", /* VK_SEPARATOR 0x6C */
3430 "kp-subtract", /* VK_SUBTRACT 0x6D */
3431 "kp-decimal", /* VK_DECIMAL 0x6E */
3432 "kp-divide", /* VK_DIVIDE 0x6F */
3433 "f1", /* VK_F1 0x70 */
3434 "f2", /* VK_F2 0x71 */
3435 "f3", /* VK_F3 0x72 */
3436 "f4", /* VK_F4 0x73 */
3437 "f5", /* VK_F5 0x74 */
3438 "f6", /* VK_F6 0x75 */
3439 "f7", /* VK_F7 0x76 */
3440 "f8", /* VK_F8 0x77 */
3441 "f9", /* VK_F9 0x78 */
3442 "f10", /* VK_F10 0x79 */
3443 "f11", /* VK_F11 0x7A */
3444 "f12", /* VK_F12 0x7B */
3445 "f13", /* VK_F13 0x7C */
3446 "f14", /* VK_F14 0x7D */
3447 "f15", /* VK_F15 0x7E */
3448 "f16", /* VK_F16 0x7F */
3449 "f17", /* VK_F17 0x80 */
3450 "f18", /* VK_F18 0x81 */
3451 "f19", /* VK_F19 0x82 */
3452 "f20", /* VK_F20 0x83 */
3453 "f21", /* VK_F21 0x84 */
3454 "f22", /* VK_F22 0x85 */
3455 "f23", /* VK_F23 0x86 */
3456 "f24", /* VK_F24 0x87 */
3458 0, 0, 0, 0, /* 0x88 .. 0x8B */
3459 0, 0, 0, 0, /* 0x8C .. 0x8F */
3461 "kp-numlock", /* VK_NUMLOCK 0x90 */
3462 "scroll", /* VK_SCROLL 0x91 */
3464 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3465 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3466 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3467 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3468 "kp-end", /* VK_NUMPAD_END 0x96 */
3469 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3470 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3471 "kp-up", /* VK_NUMPAD_UP 0x99 */
3472 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3473 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3474 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3475 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3477 0, 0, /* 0x9E .. 0x9F */
3480 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3481 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3482 * No other API or message will distinguish left and right keys this way.
3486 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3487 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3488 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3489 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3490 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3496 "attn", /* VK_ATTN 0xF6 */
3497 "crsel", /* VK_CRSEL 0xF7 */
3498 "exsel", /* VK_EXSEL 0xF8 */
3499 "ereof", /* VK_EREOF 0xF9 */
3500 "play", /* VK_PLAY 0xFA */
3501 "zoom", /* VK_ZOOM 0xFB */
3502 "noname", /* VK_NONAME 0xFC */
3503 "pa1", /* VK_PA1 0xFD */
3504 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3507 #else /* not HAVE_NTGUI */
3510 static char *lispy_kana_keys
[] =
3512 /* X Keysym value */
3513 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3514 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3515 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3516 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3517 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3518 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3519 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3520 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3521 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3522 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3523 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3524 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3525 "kana-i", "kana-u", "kana-e", "kana-o",
3526 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3527 "prolongedsound", "kana-A", "kana-I", "kana-U",
3528 "kana-E", "kana-O", "kana-KA", "kana-KI",
3529 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3530 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3531 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3532 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3533 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3534 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3535 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3536 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3537 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3538 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3539 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3540 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3542 #endif /* XK_kana_A */
3544 #define FUNCTION_KEY_OFFSET 0xff00
3546 /* You'll notice that this table is arranged to be conveniently
3547 indexed by X Windows keysym values. */
3548 static char *lispy_function_keys
[] =
3550 /* X Keysym value */
3552 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3560 0, 0, 0, /* 0xff10 */
3562 0, 0, 0, 0, 0, 0, 0,
3565 0, "kanji", "muhenkan",
3566 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3567 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3568 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3570 "home", /* 0xff50 */ /* IsCursorKey */
3581 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3592 "break", /* 0xff6b */
3594 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3596 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3597 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3598 0, 0, 0, 0, 0, 0, 0, 0,
3599 "kp-tab", /* 0xff89 */
3601 "kp-enter", /* 0xff8d */
3603 "kp-f1", /* 0xff91 */
3607 "kp-home", /* 0xff95 */
3612 "kp-prior", /* kp-page-up */
3613 "kp-next", /* kp-page-down */
3619 0, 0, 0, 0, 0, 0, 0, 0, 0,
3620 "kp-multiply", /* 0xffaa */
3625 "kp-divide", /* 0xffaf */
3626 "kp-0", /* 0xffb0 */
3627 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3630 "kp-equal", /* 0xffbd */
3631 "f1", /* 0xffbe */ /* IsFunctionKey */
3633 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3634 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3635 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3636 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3637 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3638 0, 0, 0, 0, 0, 0, 0, 0,
3639 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3640 0, 0, 0, 0, 0, 0, 0, "delete"
3643 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3644 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3646 static char *iso_lispy_function_keys
[] =
3648 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3649 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3650 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3651 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3652 "iso-lefttab", /* 0xfe20 */
3653 "iso-move-line-up", "iso-move-line-down",
3654 "iso-partial-line-up", "iso-partial-line-down",
3655 "iso-partial-space-left", "iso-partial-space-right",
3656 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3657 "iso-release-margin-left", "iso-release-margin-right",
3658 "iso-release-both-margins",
3659 "iso-fast-cursor-left", "iso-fast-cursor-right",
3660 "iso-fast-cursor-up", "iso-fast-cursor-down",
3661 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3662 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3665 #endif /* not HAVE_NTGUI */
3667 static char *lispy_mouse_names
[] =
3669 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3673 /* mouse-wheel events are generated by the wheel on devices such as
3674 the MS Intellimouse. The wheel sits in between the left and right
3675 mouse buttons, and is typically used to scroll or zoom the window
3676 underneath the pointer. mouse-wheel events specify the object on
3677 which they operate, and a delta corresponding to the amount and
3678 direction that the wheel is rotated. Clicking the mouse-wheel
3679 generates a mouse-2 event. */
3680 static char *lispy_mouse_wheel_names
[] =
3684 #endif /* WINDOWSNT */
3686 /* Scroll bar parts. */
3687 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3688 Lisp_Object Qup
, Qdown
;
3690 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3691 Lisp_Object
*scroll_bar_parts
[] = {
3692 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3697 /* A vector, indexed by button number, giving the down-going location
3698 of currently depressed buttons, both scroll bar and non-scroll bar.
3700 The elements have the form
3701 (BUTTON-NUMBER MODIFIER-MASK . REST)
3702 where REST is the cdr of a position as it would be reported in the event.
3704 The make_lispy_event function stores positions here to tell the
3705 difference between click and drag events, and to store the starting
3706 location to be included in drag events. */
3708 static Lisp_Object button_down_location
;
3710 /* Information about the most recent up-going button event: Which
3711 button, what location, and what time. */
3713 static int last_mouse_button
;
3714 static int last_mouse_x
;
3715 static int last_mouse_y
;
3716 static unsigned long button_down_time
;
3718 /* The maximum time between clicks to make a double-click,
3719 or Qnil to disable double-click detection,
3720 or Qt for no time limit. */
3721 Lisp_Object Vdouble_click_time
;
3723 /* The number of clicks in this multiple-click. */
3725 int double_click_count
;
3727 /* Given a struct input_event, build the lisp event which represents
3728 it. If EVENT is 0, build a mouse movement event from the mouse
3729 movement buffer, which should have a movement event in it.
3731 Note that events must be passed to this function in the order they
3732 are received; this function stores the location of button presses
3733 in order to build drag events when the button is released. */
3736 make_lispy_event (event
)
3737 struct input_event
*event
;
3741 switch (SWITCH_ENUM_CAST (event
->kind
))
3743 /* A simple keystroke. */
3744 case ascii_keystroke
:
3746 Lisp_Object lispy_c
;
3747 int c
= event
->code
& 0377;
3748 /* Turn ASCII characters into control characters
3750 if (event
->modifiers
& ctrl_modifier
)
3751 c
= make_ctrl_char (c
);
3753 /* Add in the other modifier bits. We took care of ctrl_modifier
3754 just above, and the shift key was taken care of by the X code,
3755 and applied to control characters by make_ctrl_char. */
3756 c
|= (event
->modifiers
3757 & (meta_modifier
| alt_modifier
3758 | hyper_modifier
| super_modifier
));
3759 /* Distinguish Shift-SPC from SPC. */
3760 if ((event
->code
& 0377) == 040
3761 && event
->modifiers
& shift_modifier
)
3762 c
|= shift_modifier
;
3763 button_down_time
= 0;
3764 XSETFASTINT (lispy_c
, c
);
3768 /* A function key. The symbol may need to have modifier prefixes
3770 case non_ascii_keystroke
:
3771 button_down_time
= 0;
3773 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3774 if (event
->code
== lispy_accent_codes
[i
])
3775 return modify_event_symbol (i
,
3777 Qfunction_key
, Qnil
,
3778 lispy_accent_keys
, &accent_key_syms
,
3779 (sizeof (lispy_accent_keys
)
3780 / sizeof (lispy_accent_keys
[0])));
3782 /* Handle system-specific keysyms. */
3783 if (event
->code
& (1 << 28))
3785 /* We need to use an alist rather than a vector as the cache
3786 since we can't make a vector long enuf. */
3787 if (NILP (current_kboard
->system_key_syms
))
3788 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3789 return modify_event_symbol (event
->code
,
3792 current_kboard
->Vsystem_key_alist
,
3793 0, ¤t_kboard
->system_key_syms
,
3798 if (event
->code
>= 0x400 && event
->code
< 0x500)
3799 return modify_event_symbol (event
->code
- 0x400,
3800 event
->modifiers
& ~shift_modifier
,
3801 Qfunction_key
, Qnil
,
3802 lispy_kana_keys
, &func_key_syms
,
3803 (sizeof (lispy_kana_keys
)
3804 / sizeof (lispy_kana_keys
[0])));
3805 #endif /* XK_kana_A */
3807 #ifdef ISO_FUNCTION_KEY_OFFSET
3808 if (event
->code
< FUNCTION_KEY_OFFSET
3809 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
3810 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
3812 Qfunction_key
, Qnil
,
3813 iso_lispy_function_keys
, &func_key_syms
,
3814 (sizeof (iso_lispy_function_keys
)
3815 / sizeof (iso_lispy_function_keys
[0])));
3818 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3820 Qfunction_key
, Qnil
,
3821 lispy_function_keys
, &func_key_syms
,
3822 (sizeof (lispy_function_keys
)
3823 / sizeof (lispy_function_keys
[0])));
3826 /* A mouse click. Figure out where it is, decide whether it's
3827 a press, click or drag, and build the appropriate structure. */
3829 case scroll_bar_click
:
3831 int button
= event
->code
;
3833 Lisp_Object position
;
3834 Lisp_Object
*start_pos_ptr
;
3835 Lisp_Object start_pos
;
3837 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3840 /* Build the position as appropriate for this mouse click. */
3841 if (event
->kind
== mouse_click
)
3844 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3849 /* Ignore mouse events that were made on frame that
3850 have been deleted. */
3851 if (! FRAME_LIVE_P (f
))
3854 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3855 &column
, &row
, NULL
, 1);
3857 #ifndef USE_X_TOOLKIT
3858 /* In the non-toolkit version, clicks on the menu bar
3859 are ordinary button events in the event buffer.
3860 Distinguish them, and invoke the menu.
3862 (In the toolkit version, the toolkit handles the menu bar
3863 and Emacs doesn't know about it until after the user
3864 makes a selection.) */
3865 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3866 && (event
->modifiers
& down_modifier
))
3868 Lisp_Object items
, item
;
3873 /* Activate the menu bar on the down event. If the
3874 up event comes in before the menu code can deal with it,
3876 if (! (event
->modifiers
& down_modifier
))
3881 items
= FRAME_MENU_BAR_ITEMS (f
);
3882 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3884 Lisp_Object pos
, string
;
3885 string
= XVECTOR (items
)->contents
[i
+ 1];
3886 pos
= XVECTOR (items
)->contents
[i
+ 3];
3889 if (column
>= XINT (pos
)
3890 && column
< XINT (pos
) + XSTRING (string
)->size
)
3892 item
= XVECTOR (items
)->contents
[i
];
3898 = Fcons (event
->frame_or_window
,
3900 Fcons (Fcons (event
->x
, event
->y
),
3901 Fcons (make_number (event
->timestamp
),
3904 return Fcons (item
, Fcons (position
, Qnil
));
3906 #endif /* not USE_X_TOOLKIT */
3908 window
= window_from_coordinates (f
, column
, row
, &part
);
3910 if (!WINDOWP (window
))
3912 window
= event
->frame_or_window
;
3917 int pixcolumn
, pixrow
;
3918 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3919 row
-= XINT (XWINDOW (window
)->top
);
3920 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3921 XSETINT (event
->x
, pixcolumn
);
3922 XSETINT (event
->y
, pixrow
);
3927 posn
= Qvertical_line
;
3930 buffer_posn_from_coords (XWINDOW (window
),
3937 Fcons (Fcons (event
->x
, event
->y
),
3938 Fcons (make_number (event
->timestamp
),
3944 Lisp_Object portion_whole
;
3947 window
= event
->frame_or_window
;
3948 portion_whole
= Fcons (event
->x
, event
->y
);
3949 part
= *scroll_bar_parts
[(int) event
->part
];
3953 Fcons (Qvertical_scroll_bar
,
3954 Fcons (portion_whole
,
3955 Fcons (make_number (event
->timestamp
),
3956 Fcons (part
, Qnil
)))));
3959 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3961 start_pos
= *start_pos_ptr
;
3962 *start_pos_ptr
= Qnil
;
3964 is_double
= (button
== last_mouse_button
3965 && XINT (event
->x
) == last_mouse_x
3966 && XINT (event
->y
) == last_mouse_y
3967 && button_down_time
!= 0
3968 && (EQ (Vdouble_click_time
, Qt
)
3969 || (INTEGERP (Vdouble_click_time
)
3970 && ((int)(event
->timestamp
- button_down_time
)
3971 < XINT (Vdouble_click_time
)))));
3972 last_mouse_button
= button
;
3973 last_mouse_x
= XINT (event
->x
);
3974 last_mouse_y
= XINT (event
->y
);
3976 /* If this is a button press, squirrel away the location, so
3977 we can decide later whether it was a click or a drag. */
3978 if (event
->modifiers
& down_modifier
)
3982 double_click_count
++;
3983 event
->modifiers
|= ((double_click_count
> 2)
3988 double_click_count
= 1;
3989 button_down_time
= event
->timestamp
;
3990 *start_pos_ptr
= Fcopy_alist (position
);
3993 /* Now we're releasing a button - check the co-ordinates to
3994 see if this was a click or a drag. */
3995 else if (event
->modifiers
& up_modifier
)
3997 /* If we did not see a down before this up,
3998 ignore the up. Probably this happened because
3999 the down event chose a menu item.
4000 It would be an annoyance to treat the release
4001 of the button that chose the menu item
4002 as a separate event. */
4004 if (!CONSP (start_pos
))
4007 event
->modifiers
&= ~up_modifier
;
4008 #if 0 /* Formerly we treated an up with no down as a click event. */
4009 if (!CONSP (start_pos
))
4010 event
->modifiers
|= click_modifier
;
4014 /* The third element of every position should be the (x,y)
4018 down
= Fnth (make_number (2), start_pos
);
4019 if (EQ (event
->x
, XCONS (down
)->car
)
4020 && EQ (event
->y
, XCONS (down
)->cdr
))
4022 event
->modifiers
|= click_modifier
;
4026 button_down_time
= 0;
4027 event
->modifiers
|= drag_modifier
;
4029 /* Don't check is_double; treat this as multiple
4030 if the down-event was multiple. */
4031 if (double_click_count
> 1)
4032 event
->modifiers
|= ((double_click_count
> 2)
4038 /* Every mouse event should either have the down_modifier or
4039 the up_modifier set. */
4043 /* Get the symbol we should use for the mouse click. */
4046 head
= modify_event_symbol (button
,
4049 lispy_mouse_names
, &mouse_syms
,
4050 (sizeof (lispy_mouse_names
)
4051 / sizeof (lispy_mouse_names
[0])));
4052 if (event
->modifiers
& drag_modifier
)
4057 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4060 Fcons (make_number (double_click_count
),
4070 case w32_scroll_bar_click
:
4072 int button
= event
->code
;
4074 Lisp_Object position
;
4075 Lisp_Object
*start_pos_ptr
;
4076 Lisp_Object start_pos
;
4078 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4083 Lisp_Object portion_whole
;
4086 window
= event
->frame_or_window
;
4087 portion_whole
= Fcons (event
->x
, event
->y
);
4088 part
= *scroll_bar_parts
[(int) event
->part
];
4092 Fcons (Qvertical_scroll_bar
,
4093 Fcons (portion_whole
,
4094 Fcons (make_number (event
->timestamp
),
4095 Fcons (part
, Qnil
)))));
4098 /* Always treat W32 scroll bar events as clicks. */
4099 event
->modifiers
|= click_modifier
;
4102 /* Get the symbol we should use for the mouse click. */
4105 head
= modify_event_symbol (button
,
4108 lispy_mouse_names
, &mouse_syms
,
4109 (sizeof (lispy_mouse_names
)
4110 / sizeof (lispy_mouse_names
[0])));
4119 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4122 Lisp_Object head
, position
;
4125 /* Ignore mouse events that were made on frame that
4126 have been deleted. */
4127 if (! FRAME_LIVE_P (f
))
4129 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4130 &column
, &row
, NULL
, 1);
4131 window
= window_from_coordinates (f
, column
, row
, &part
);
4133 if (!WINDOWP (window
))
4135 window
= event
->frame_or_window
;
4140 int pixcolumn
, pixrow
;
4141 column
-= XINT (XWINDOW (window
)->left
);
4142 row
-= XINT (XWINDOW (window
)->top
);
4143 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4144 XSETINT (event
->x
, pixcolumn
);
4145 XSETINT (event
->y
, pixrow
);
4150 posn
= Qvertical_line
;
4153 buffer_posn_from_coords (XWINDOW (window
),
4158 Lisp_Object head
, position
;
4163 Fcons (Fcons (event
->x
, event
->y
),
4164 Fcons (make_number (event
->timestamp
),
4167 head
= modify_event_symbol (0, event
->modifiers
,
4169 lispy_mouse_wheel_names
,
4170 &mouse_wheel_syms
, 1);
4173 Fcons (make_number (event
->code
),
4177 #endif /* WINDOWSNT */
4178 #endif /* HAVE_MOUSE */
4180 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4181 case menu_bar_event
:
4182 /* The event value is in the cdr of the frame_or_window slot. */
4183 if (!CONSP (event
->frame_or_window
))
4185 return XCONS (event
->frame_or_window
)->cdr
;
4188 /* The 'kind' field of the event is something we don't recognize. */
4197 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4199 Lisp_Object bar_window
;
4200 enum scroll_bar_part part
;
4204 /* Is it a scroll bar movement? */
4205 if (frame
&& ! NILP (bar_window
))
4207 Lisp_Object part_sym
;
4209 part_sym
= *scroll_bar_parts
[(int) part
];
4210 return Fcons (Qscroll_bar_movement
,
4211 (Fcons (Fcons (bar_window
,
4212 Fcons (Qvertical_scroll_bar
,
4213 Fcons (Fcons (x
, y
),
4214 Fcons (make_number (time
),
4220 /* Or is it an ordinary mouse movement? */
4230 /* It's in a frame; which window on that frame? */
4231 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4233 window
= window_from_coordinates (frame
, column
, row
, &area
);
4238 if (WINDOWP (window
))
4240 int pixcolumn
, pixrow
;
4241 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4242 row
-= XINT (XWINDOW (window
)->top
);
4243 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4244 XSETINT (x
, pixcolumn
);
4245 XSETINT (y
, pixrow
);
4250 posn
= Qvertical_line
;
4253 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4255 else if (frame
!= 0)
4257 XSETFRAME (window
, frame
);
4268 return Fcons (Qmouse_movement
,
4269 Fcons (Fcons (window
,
4271 Fcons (Fcons (x
, y
),
4272 Fcons (make_number (time
),
4278 #endif /* HAVE_MOUSE */
4280 /* Construct a switch frame event. */
4282 make_lispy_switch_frame (frame
)
4285 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4288 /* Manipulating modifiers. */
4290 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4292 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4293 SYMBOL's name of the end of the modifiers; the string from this
4294 position is the unmodified symbol name.
4296 This doesn't use any caches. */
4299 parse_modifiers_uncached (symbol
, modifier_end
)
4303 struct Lisp_String
*name
;
4307 CHECK_SYMBOL (symbol
, 1);
4310 name
= XSYMBOL (symbol
)->name
;
4312 for (i
= 0; i
+2 <= name
->size
; )
4314 int this_mod_end
= 0;
4317 /* See if the name continues with a modifier word.
4318 Check that the word appears, but don't check what follows it.
4319 Set this_mod and this_mod_end to record what we find. */
4321 switch (name
->data
[i
])
4323 #define SINGLE_LETTER_MOD(BIT) \
4324 (this_mod_end = i + 1, this_mod = BIT)
4327 SINGLE_LETTER_MOD (alt_modifier
);
4331 SINGLE_LETTER_MOD (ctrl_modifier
);
4335 SINGLE_LETTER_MOD (hyper_modifier
);
4339 SINGLE_LETTER_MOD (meta_modifier
);
4343 SINGLE_LETTER_MOD (shift_modifier
);
4347 SINGLE_LETTER_MOD (super_modifier
);
4350 #undef SINGLE_LETTER_MOD
4353 /* If we found no modifier, stop looking for them. */
4354 if (this_mod_end
== 0)
4357 /* Check there is a dash after the modifier, so that it
4358 really is a modifier. */
4359 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
4362 /* This modifier is real; look for another. */
4363 modifiers
|= this_mod
;
4364 i
= this_mod_end
+ 1;
4367 /* Should we include the `click' modifier? */
4368 if (! (modifiers
& (down_modifier
| drag_modifier
4369 | double_modifier
| triple_modifier
))
4370 && i
+ 7 == name
->size
4371 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4372 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4373 modifiers
|= click_modifier
;
4381 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4382 prepended to the string BASE[0..BASE_LEN-1].
4383 This doesn't use any caches. */
4385 apply_modifiers_uncached (modifiers
, base
, base_len
)
4390 /* Since BASE could contain nulls, we can't use intern here; we have
4391 to use Fintern, which expects a genuine Lisp_String, and keeps a
4394 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4400 /* Only the event queue may use the `up' modifier; it should always
4401 be turned into a click or drag event before presented to lisp code. */
4402 if (modifiers
& up_modifier
)
4405 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4406 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4407 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4408 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4409 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4410 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4411 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4412 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4413 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4414 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4415 /* The click modifier is denoted by the absence of other modifiers. */
4419 mod_len
= p
- new_mods
;
4423 Lisp_Object new_name
;
4425 new_name
= make_uninit_string (mod_len
+ base_len
);
4426 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4427 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
4429 return Fintern (new_name
, Qnil
);
4434 static char *modifier_names
[] =
4436 "up", "down", "drag", "click", "double", "triple", 0, 0,
4437 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4438 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4440 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4442 static Lisp_Object modifier_symbols
;
4444 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4446 lispy_modifier_list (modifiers
)
4449 Lisp_Object modifier_list
;
4452 modifier_list
= Qnil
;
4453 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4454 if (modifiers
& (1<<i
))
4455 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4458 return modifier_list
;
4462 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4463 where UNMODIFIED is the unmodified form of SYMBOL,
4464 MASK is the set of modifiers present in SYMBOL's name.
4465 This is similar to parse_modifiers_uncached, but uses the cache in
4466 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4467 Qevent_symbol_elements property. */
4470 parse_modifiers (symbol
)
4473 Lisp_Object elements
;
4475 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4476 if (CONSP (elements
))
4481 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4482 Lisp_Object unmodified
;
4485 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4486 XSYMBOL (symbol
)->name
->size
- end
),
4489 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4491 XSETFASTINT (mask
, modifiers
);
4492 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4494 /* Cache the parsing results on SYMBOL. */
4495 Fput (symbol
, Qevent_symbol_element_mask
,
4497 Fput (symbol
, Qevent_symbol_elements
,
4498 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4500 /* Since we know that SYMBOL is modifiers applied to unmodified,
4501 it would be nice to put that in unmodified's cache.
4502 But we can't, since we're not sure that parse_modifiers is
4509 /* Apply the modifiers MODIFIERS to the symbol BASE.
4510 BASE must be unmodified.
4512 This is like apply_modifiers_uncached, but uses BASE's
4513 Qmodifier_cache property, if present. It also builds
4514 Qevent_symbol_elements properties, since it has that info anyway.
4516 apply_modifiers copies the value of BASE's Qevent_kind property to
4517 the modified symbol. */
4519 apply_modifiers (modifiers
, base
)
4523 Lisp_Object cache
, index
, entry
, new_symbol
;
4525 /* Mask out upper bits. We don't know where this value's been. */
4526 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4528 /* The click modifier never figures into cache indices. */
4529 cache
= Fget (base
, Qmodifier_cache
);
4530 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4531 entry
= assq_no_quit (index
, cache
);
4534 new_symbol
= XCONS (entry
)->cdr
;
4537 /* We have to create the symbol ourselves. */
4538 new_symbol
= apply_modifiers_uncached (modifiers
,
4539 XSYMBOL (base
)->name
->data
,
4540 XSYMBOL (base
)->name
->size
);
4542 /* Add the new symbol to the base's cache. */
4543 entry
= Fcons (index
, new_symbol
);
4544 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4546 /* We have the parsing info now for free, so add it to the caches. */
4547 XSETFASTINT (index
, modifiers
);
4548 Fput (new_symbol
, Qevent_symbol_element_mask
,
4549 Fcons (base
, Fcons (index
, Qnil
)));
4550 Fput (new_symbol
, Qevent_symbol_elements
,
4551 Fcons (base
, lispy_modifier_list (modifiers
)));
4554 /* Make sure this symbol is of the same kind as BASE.
4556 You'd think we could just set this once and for all when we
4557 intern the symbol above, but reorder_modifiers may call us when
4558 BASE's property isn't set right; we can't assume that just
4559 because it has a Qmodifier_cache property it must have its
4560 Qevent_kind set right as well. */
4561 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4565 kind
= Fget (base
, Qevent_kind
);
4567 Fput (new_symbol
, Qevent_kind
, kind
);
4574 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4575 return a symbol with the modifiers placed in the canonical order.
4576 Canonical order is alphabetical, except for down and drag, which
4577 always come last. The 'click' modifier is never written out.
4579 Fdefine_key calls this to make sure that (for example) C-M-foo
4580 and M-C-foo end up being equivalent in the keymap. */
4583 reorder_modifiers (symbol
)
4586 /* It's hopefully okay to write the code this way, since everything
4587 will soon be in caches, and no consing will be done at all. */
4590 parsed
= parse_modifiers (symbol
);
4591 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4592 XCONS (parsed
)->car
);
4596 /* For handling events, we often want to produce a symbol whose name
4597 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4598 to some base, like the name of a function key or mouse button.
4599 modify_event_symbol produces symbols of this sort.
4601 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4602 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4605 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4606 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4608 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4609 persist between calls to modify_event_symbol that it can use to
4610 store a cache of the symbols it's generated for this NAME_TABLE
4611 before. The object stored there may be a vector or an alist.
4613 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4615 MODIFIERS is a set of modifier bits (as given in struct input_events)
4616 whose prefixes should be applied to the symbol name.
4618 SYMBOL_KIND is the value to be placed in the event_kind property of
4619 the returned symbol.
4621 The symbols we create are supposed to have an
4622 `event-symbol-elements' property, which lists the modifiers present
4623 in the symbol's name. */
4626 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4627 name_table
, symbol_table
, table_size
)
4630 Lisp_Object symbol_kind
;
4631 Lisp_Object name_alist
;
4633 Lisp_Object
*symbol_table
;
4634 unsigned int table_size
;
4637 Lisp_Object symbol_int
;
4639 /* Get rid of the "vendor-specific" bit here. */
4640 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4642 /* Is this a request for a valid symbol? */
4643 if (symbol_num
< 0 || symbol_num
>= table_size
)
4646 if (CONSP (*symbol_table
))
4647 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4649 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4650 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4651 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4652 we've never used that symbol before. */
4655 if (! VECTORP (*symbol_table
)
4656 || XVECTOR (*symbol_table
)->size
!= table_size
)
4660 XSETFASTINT (size
, table_size
);
4661 *symbol_table
= Fmake_vector (size
, Qnil
);
4664 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4667 /* Have we already used this symbol before? */
4670 /* No; let's create it. */
4671 if (!NILP (name_alist
))
4672 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4673 else if (name_table
!= 0 && name_table
[symbol_num
])
4674 value
= intern (name_table
[symbol_num
]);
4676 #ifdef HAVE_WINDOW_SYSTEM
4679 char *name
= x_get_keysym_name (symbol_num
);
4681 value
= intern (name
);
4688 sprintf (buf
, "key-%d", symbol_num
);
4689 value
= intern (buf
);
4692 if (CONSP (*symbol_table
))
4693 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4695 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4697 /* Fill in the cache entries for this symbol; this also
4698 builds the Qevent_symbol_elements property, which the user
4700 apply_modifiers (modifiers
& click_modifier
, value
);
4701 Fput (value
, Qevent_kind
, symbol_kind
);
4704 /* Apply modifiers to that symbol. */
4705 return apply_modifiers (modifiers
, value
);
4708 /* Convert a list that represents an event type,
4709 such as (ctrl meta backspace), into the usual representation of that
4710 event type as a number or a symbol. */
4712 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4713 "Convert the event description list EVENT-DESC to an event type.\n\
4714 EVENT-DESC should contain one base event type (a character or symbol)\n\
4715 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4716 drag, down, double or triple). The base must be last.\n\
4717 The return value is an event type (a character or symbol) which\n\
4718 has the same base event type and all the specified modifiers.")
4720 Lisp_Object event_desc
;
4728 while (CONSP (rest
))
4733 elt
= XCONS (rest
)->car
;
4734 rest
= XCONS (rest
)->cdr
;
4736 /* Given a symbol, see if it is a modifier name. */
4737 if (SYMBOLP (elt
) && CONSP (rest
))
4738 this = parse_solitary_modifier (elt
);
4742 else if (!NILP (base
))
4743 error ("Two bases given in one event");
4749 /* Let the symbol A refer to the character A. */
4750 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4751 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4753 if (INTEGERP (base
))
4755 /* Turn (shift a) into A. */
4756 if ((modifiers
& shift_modifier
) != 0
4757 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4759 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4760 modifiers
&= ~shift_modifier
;
4763 /* Turn (control a) into C-a. */
4764 if (modifiers
& ctrl_modifier
)
4765 return make_number ((modifiers
& ~ctrl_modifier
)
4766 | make_ctrl_char (XINT (base
)));
4768 return make_number (modifiers
| XINT (base
));
4770 else if (SYMBOLP (base
))
4771 return apply_modifiers (modifiers
, base
);
4773 error ("Invalid base event");
4776 /* Try to recognize SYMBOL as a modifier name.
4777 Return the modifier flag bit, or 0 if not recognized. */
4780 parse_solitary_modifier (symbol
)
4783 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4785 switch (name
->data
[0])
4787 #define SINGLE_LETTER_MOD(BIT) \
4788 if (name->size == 1) \
4791 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4792 if (LEN == name->size \
4793 && ! strncmp (name->data, NAME, LEN)) \
4797 SINGLE_LETTER_MOD (alt_modifier
);
4801 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4805 SINGLE_LETTER_MOD (ctrl_modifier
);
4809 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4810 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4814 SINGLE_LETTER_MOD (hyper_modifier
);
4818 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4822 SINGLE_LETTER_MOD (meta_modifier
);
4826 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4830 SINGLE_LETTER_MOD (shift_modifier
);
4834 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4835 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4836 SINGLE_LETTER_MOD (super_modifier
);
4840 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4841 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4842 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4846 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4849 #undef SINGLE_LETTER_MOD
4850 #undef MULTI_LETTER_MOD
4856 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4857 Such a list is not valid as an event,
4858 but it can be a Lucid-style event type list. */
4861 lucid_event_type_list_p (object
)
4866 if (! CONSP (object
))
4869 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4872 elt
= XCONS (tail
)->car
;
4873 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4880 /* Store into *addr a value nonzero if terminal input chars are available.
4881 Serves the purpose of ioctl (0, FIONREAD, addr)
4882 but works even if FIONREAD does not exist.
4883 (In fact, this may actually read some input.)
4885 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4888 get_input_pending (addr
, do_timers_now
)
4892 /* First of all, have we already counted some input? */
4893 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4895 /* If input is being read as it arrives, and we have none, there is none. */
4896 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4899 /* Try to read some input and see how much we get. */
4901 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4904 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4907 gobble_input (expected
)
4912 if (interrupt_input
)
4915 mask
= sigblock (sigmask (SIGIO
));
4916 read_avail_input (expected
);
4920 #ifdef POLL_FOR_INPUT
4921 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4924 mask
= sigblock (sigmask (SIGALRM
));
4925 read_avail_input (expected
);
4931 read_avail_input (expected
);
4935 /* Put a buffer_switch_event in the buffer
4936 so that read_key_sequence will notice the new current buffer. */
4938 record_asynch_buffer_change ()
4940 struct input_event event
;
4943 event
.kind
= buffer_switch_event
;
4944 event
.frame_or_window
= Qnil
;
4947 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4948 The purpose of the event is to make read_key_sequence look up the
4949 keymaps again. If we aren't in read_key_sequence, we don't need one,
4950 and the event could cause trouble by messing up (input-pending-p). */
4951 tem
= Fwaiting_for_user_input_p ();
4955 /* We never need these events if we have no asynchronous subprocesses. */
4959 /* Make sure no interrupt happens while storing the event. */
4961 if (interrupt_input
)
4964 mask
= sigblock (sigmask (SIGIO
));
4965 kbd_buffer_store_event (&event
);
4972 kbd_buffer_store_event (&event
);
4979 /* Read any terminal input already buffered up by the system
4980 into the kbd_buffer, but do not wait.
4982 EXPECTED should be nonzero if the caller knows there is some input.
4984 Except on VMS, all input is read by this function.
4985 If interrupt_input is nonzero, this function MUST be called
4986 only when SIGIO is blocked.
4988 Returns the number of keyboard chars read, or -1 meaning
4989 this is a bad time to try to read input. */
4992 read_avail_input (expected
)
4995 struct input_event buf
[KBD_BUFFER_SIZE
];
4999 if (read_socket_hook
)
5000 /* No need for FIONREAD or fcntl; just say don't wait. */
5001 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
5004 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
5005 the kbd_buffer can really hold. That may prevent loss
5006 of characters on some systems when input is stuffed at us. */
5007 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
5010 /* Determine how many characters we should *try* to read. */
5013 #else /* not WINDOWSNT */
5015 n_to_read
= dos_keysns ();
5018 #else /* not MSDOS */
5020 /* Find out how much input is available. */
5021 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
5022 /* Formerly simply reported no input, but that sometimes led to
5023 a failure of Emacs to terminate.
5024 SIGHUP seems appropriate if we can't reach the terminal. */
5025 /* ??? Is it really right to send the signal just to this process
5026 rather than to the whole process group?
5027 Perhaps on systems with FIONREAD Emacs is alone in its group. */
5028 kill (getpid (), SIGHUP
);
5031 if (n_to_read
> sizeof cbuf
)
5032 n_to_read
= sizeof cbuf
;
5033 #else /* no FIONREAD */
5034 #if defined (USG) || defined (DGUX)
5035 /* Read some input if available, but don't wait. */
5036 n_to_read
= sizeof cbuf
;
5037 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
5042 #endif /* not MSDOS */
5043 #endif /* not WINDOWSNT */
5045 /* Now read; for one reason or another, this will not block.
5046 NREAD is set to the number of chars read. */
5050 cbuf
[0] = dos_keyread ();
5053 nread
= read (input_fd
, cbuf
, n_to_read
);
5055 /* POSIX infers that processes which are not in the session leader's
5056 process group won't get SIGHUP's at logout time. BSDI adheres to
5057 this part standard and returns -1 from read(0) with errno==EIO
5058 when the control tty is taken away.
5059 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
5060 if (nread
== -1 && errno
== EIO
)
5062 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
5063 /* The kernel sometimes fails to deliver SIGHUP for ptys.
5064 This looks incorrect, but it isn't, because _BSD causes
5065 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
5066 and that causes a value other than 0 when there is no input. */
5072 /* We used to retry the read if it was interrupted.
5073 But this does the wrong thing when O_NDELAY causes
5074 an EAGAIN error. Does anybody know of a situation
5075 where a retry is actually needed? */
5077 nread
< 0 && (errno
== EAGAIN
5091 #if defined (USG) || defined (DGUX)
5092 fcntl (input_fd
, F_SETFL
, 0);
5093 #endif /* USG or DGUX */
5094 #endif /* no FIONREAD */
5095 for (i
= 0; i
< nread
; i
++)
5097 buf
[i
].kind
= ascii_keystroke
;
5098 buf
[i
].modifiers
= 0;
5099 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
5100 buf
[i
].modifiers
= meta_modifier
;
5104 buf
[i
].code
= cbuf
[i
];
5105 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
5109 /* Scan the chars for C-g and store them in kbd_buffer. */
5110 for (i
= 0; i
< nread
; i
++)
5112 kbd_buffer_store_event (&buf
[i
]);
5113 /* Don't look at input that follows a C-g too closely.
5114 This reduces lossage due to autorepeat on C-g. */
5115 if (buf
[i
].kind
== ascii_keystroke
5116 && buf
[i
].code
== quit_char
)
5122 #endif /* not VMS */
5124 #ifdef SIGIO /* for entire page */
5125 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5128 input_available_signal (signo
)
5131 /* Must preserve main program's value of errno. */
5132 int old_errno
= errno
;
5134 extern int select_alarmed
;
5137 #if defined (USG) && !defined (POSIX_SIGNALS)
5138 /* USG systems forget handlers when they are used;
5139 must reestablish each time */
5140 signal (signo
, input_available_signal
);
5147 if (input_available_clear_time
)
5148 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5153 nread
= read_avail_input (1);
5154 /* -1 means it's not ok to read the input now.
5155 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5156 0 means there was no keyboard input available. */
5161 select_alarmed
= 1; /* Force the select emulator back to life */
5172 /* Send ourselves a SIGIO.
5174 This function exists so that the UNBLOCK_INPUT macro in
5175 blockinput.h can have some way to take care of input we put off
5176 dealing with, without assuming that every file which uses
5177 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5179 reinvoke_input_signal ()
5182 kill (getpid (), SIGIO
);
5188 /* Return the prompt-string of a sparse keymap.
5189 This is the first element which is a string.
5190 Return nil if there is none. */
5198 register Lisp_Object tem
;
5207 static void menu_bar_item ();
5208 static void menu_bar_one_keymap ();
5210 /* These variables hold the vector under construction within
5211 menu_bar_items and its subroutines, and the current index
5212 for storing into that vector. */
5213 static Lisp_Object menu_bar_items_vector
;
5214 static int menu_bar_items_index
;
5216 /* Return a vector of menu items for a menu bar, appropriate
5217 to the current buffer. Each item has three elements in the vector:
5220 OLD is an old vector we can optionally reuse, or nil. */
5223 menu_bar_items (old
)
5226 /* The number of keymaps we're scanning right now, and the number of
5227 keymaps we have allocated space for. */
5230 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5231 in the current keymaps, or nil where it is not a prefix. */
5234 Lisp_Object def
, tem
, tail
;
5243 struct gcpro gcpro1
;
5245 /* In order to build the menus, we need to call the keymap
5246 accessors. They all call QUIT. But this function is called
5247 during redisplay, during which a quit is fatal. So inhibit
5248 quitting while building the menus.
5249 We do this instead of specbind because (1) errors will clear it anyway
5250 and (2) this avoids risk of specpdl overflow. */
5251 oquit
= Vinhibit_quit
;
5255 menu_bar_items_vector
= old
;
5257 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5258 menu_bar_items_index
= 0;
5260 GCPRO1 (menu_bar_items_vector
);
5262 /* Build our list of keymaps.
5263 If we recognize a function key and replace its escape sequence in
5264 keybuf with its symbol, or if the sequence starts with a mouse
5265 click and we need to switch buffers, we jump back here to rebuild
5266 the initial keymaps from the current buffer. */
5270 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5271 if (!NILP (Voverriding_local_map_menu_flag
))
5273 /* Yes, use them (if non-nil) as well as the global map. */
5274 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5276 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5277 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5278 if (!NILP (Voverriding_local_map
))
5279 maps
[nmaps
++] = Voverriding_local_map
;
5283 /* No, so use major and minor mode keymaps. */
5284 nmaps
= current_minor_maps (NULL
, &tmaps
);
5285 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5286 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5287 #ifdef USE_TEXT_PROPERTIES
5288 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5290 maps
[nmaps
++] = current_buffer
->keymap
;
5293 maps
[nmaps
++] = current_global_map
;
5296 /* Look up in each map the dummy prefix key `menu-bar'. */
5300 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5302 if (! NILP (maps
[mapno
]))
5303 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
5307 tem
= Fkeymapp (def
);
5309 menu_bar_one_keymap (def
);
5312 /* Move to the end those items that should be at the end. */
5314 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5317 int end
= menu_bar_items_index
;
5319 for (i
= 0; i
< end
; i
+= 4)
5320 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5322 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5323 /* Move the item at index I to the end,
5324 shifting all the others forward. */
5325 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5326 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5327 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5328 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5330 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5331 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5332 (end
- i
- 4) * sizeof (Lisp_Object
));
5333 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5334 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5335 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5336 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5341 /* Add nil, nil, nil, nil at the end. */
5342 i
= menu_bar_items_index
;
5343 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5346 int newsize
= 2 * i
;
5347 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5348 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5349 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5350 menu_bar_items_vector
= tem
;
5352 /* Add this item. */
5353 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5354 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5355 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5356 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5357 menu_bar_items_index
= i
;
5359 Vinhibit_quit
= oquit
;
5361 return menu_bar_items_vector
;
5364 /* Scan one map KEYMAP, accumulating any menu items it defines
5365 in menu_bar_items_vector. */
5368 menu_bar_one_keymap (keymap
)
5371 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
5373 /* Loop over all keymap entries that have menu strings. */
5374 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5376 item
= XCONS (tail
)->car
;
5379 key
= XCONS (item
)->car
;
5380 binding
= XCONS (item
)->cdr
;
5381 if (CONSP (binding
))
5383 item_string
= XCONS (binding
)->car
;
5384 if (STRINGP (item_string
))
5385 menu_bar_item (key
, item_string
, Fcdr (binding
));
5387 else if (EQ (binding
, Qundefined
))
5388 menu_bar_item (key
, Qnil
, binding
);
5390 else if (VECTORP (item
))
5392 /* Loop over the char values represented in the vector. */
5393 int len
= XVECTOR (item
)->size
;
5395 for (c
= 0; c
< len
; c
++)
5397 Lisp_Object character
;
5398 XSETFASTINT (character
, c
);
5399 binding
= XVECTOR (item
)->contents
[c
];
5400 if (CONSP (binding
))
5402 item_string
= XCONS (binding
)->car
;
5403 if (STRINGP (item_string
))
5404 menu_bar_item (key
, item_string
, Fcdr (binding
));
5406 else if (EQ (binding
, Qundefined
))
5407 menu_bar_item (key
, Qnil
, binding
);
5413 /* This is used as the handler when calling internal_condition_case_1. */
5416 menu_bar_item_1 (arg
)
5422 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5423 If there's already an item for KEY, add this DEF to it. */
5426 menu_bar_item (key
, item_string
, def
)
5427 Lisp_Object key
, item_string
, def
;
5430 Lisp_Object enabled
;
5433 /* Skip menu-bar equiv keys data. */
5434 if (CONSP (def
) && CONSP (XCONS (def
)->car
))
5435 def
= XCONS (def
)->cdr
;
5437 if (EQ (def
, Qundefined
))
5439 /* If a map has an explicit `undefined' as definition,
5440 discard any previously made menu bar item. */
5442 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5443 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5445 if (menu_bar_items_index
> i
+ 4)
5446 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5447 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5448 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5449 menu_bar_items_index
-= 4;
5453 /* If there's no definition for this key yet,
5454 just ignore `undefined'. */
5458 /* See if this entry is enabled. */
5463 /* No property, or nil, means enable.
5464 Otherwise, enable if value is not nil. */
5465 tem
= Fget (def
, Qmenu_enable
);
5467 /* (condition-case nil (eval tem)
5469 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5473 /* Ignore this item if it's not enabled. */
5477 /* Find any existing item for this KEY. */
5478 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5479 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5482 /* If we did not find this KEY, add it at the end. */
5483 if (i
== menu_bar_items_index
)
5485 /* If vector is too small, get a bigger one. */
5486 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5489 int newsize
= 2 * i
;
5490 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5491 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5492 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5493 menu_bar_items_vector
= tem
;
5495 /* Add this item. */
5496 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5497 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5498 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5499 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5500 menu_bar_items_index
= i
;
5502 /* We did find an item for this KEY. Add DEF to its list of maps. */
5506 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5507 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5511 /* Read a character using menus based on maps in the array MAPS.
5512 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5513 Return t if we displayed a menu but the user rejected it.
5515 PREV_EVENT is the previous input event, or nil if we are reading
5516 the first event of a key sequence.
5518 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5519 if we used a mouse menu to read the input, or zero otherwise. If
5520 USED_MOUSE_MENU is null, we don't dereference it.
5522 The prompting is done based on the prompt-string of the map
5523 and the strings associated with various map elements.
5525 This can be done with X menus or with menus put in the minibuf.
5526 These are done in different ways, depending on how the input will be read.
5527 Menus using X are done after auto-saving in read-char, getting the input
5528 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5529 and do auto-saving in the inner call of read_char. */
5532 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5535 Lisp_Object prev_event
;
5536 int *used_mouse_menu
;
5539 register Lisp_Object name
;
5540 Lisp_Object rest
, vector
;
5542 if (used_mouse_menu
)
5543 *used_mouse_menu
= 0;
5545 /* Use local over global Menu maps */
5547 if (! menu_prompting
)
5550 /* Optionally disregard all but the global map. */
5551 if (inhibit_local_menu_bar_menus
)
5553 maps
+= (nmaps
- 1);
5557 /* Get the menu name from the first map that has one (a prompt string). */
5558 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5560 name
= map_prompt (maps
[mapno
]);
5565 /* If we don't have any menus, just read a character normally. */
5570 /* If we got to this point via a mouse click,
5571 use a real menu for mouse selection. */
5572 if (EVENT_HAS_PARAMETERS (prev_event
)
5573 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5575 /* Display the menu and get the selection. */
5576 Lisp_Object
*realmaps
5577 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5581 /* Use the maps that are not nil. */
5582 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5583 if (!NILP (maps
[mapno
]))
5584 realmaps
[nmaps1
++] = maps
[mapno
];
5586 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5591 record_menu_key (XCONS (value
)->car
);
5593 /* If we got multiple events, unread all but
5595 There is no way to prevent those unread events
5596 from showing up later in last_nonmenu_event.
5597 So turn symbol and integer events into lists,
5598 to indicate that they came from a mouse menu,
5599 so that when present in last_nonmenu_event
5600 they won't confuse things. */
5601 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5602 tem
= XCONS (tem
)->cdr
)
5604 record_menu_key (XCONS (tem
)->car
);
5605 if (SYMBOLP (XCONS (tem
)->car
)
5606 || INTEGERP (XCONS (tem
)->car
))
5608 = Fcons (XCONS (tem
)->car
, Qnil
);
5611 /* If we got more than one event, put all but the first
5612 onto this list to be read later.
5613 Return just the first event now. */
5614 Vunread_command_events
5615 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5616 value
= XCONS (value
)->car
;
5618 else if (NILP (value
))
5620 if (used_mouse_menu
)
5621 *used_mouse_menu
= 1;
5624 #endif /* HAVE_MENUS */
5628 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5629 We make this bigger when necessary, and never free it. */
5630 static char *read_char_minibuf_menu_text
;
5631 /* Size of that buffer. */
5632 static int read_char_minibuf_menu_width
;
5635 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5641 register Lisp_Object name
;
5643 int width
= FRAME_WIDTH (selected_frame
) - 4;
5646 Lisp_Object rest
, vector
;
5649 if (! menu_prompting
)
5652 /* Make sure we have a big enough buffer for the menu text. */
5653 if (read_char_minibuf_menu_text
== 0)
5655 read_char_minibuf_menu_width
= width
+ 4;
5656 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5658 else if (width
+ 4 > read_char_minibuf_menu_width
)
5660 read_char_minibuf_menu_width
= width
+ 4;
5661 read_char_minibuf_menu_text
5662 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5664 menu
= read_char_minibuf_menu_text
;
5666 /* Get the menu name from the first map that has one (a prompt string). */
5667 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5669 name
= map_prompt (maps
[mapno
]);
5674 /* If we don't have any menus, just read a character normally. */
5678 /* Prompt string always starts with map's prompt, and a space. */
5679 strcpy (menu
, XSTRING (name
)->data
);
5680 nlength
= XSTRING (name
)->size
;
5681 menu
[nlength
++] = ':';
5682 menu
[nlength
++] = ' ';
5685 /* Start prompting at start of first map. */
5689 /* Present the documented bindings, a line at a time. */
5696 Lisp_Object orig_defn_macro
;
5698 /* Loop over elements of map. */
5703 /* If reached end of map, start at beginning of next map. */
5707 /* At end of last map, wrap around to first map if just starting,
5708 or end this line if already have something on it. */
5712 if (notfirst
|| nobindings
) break;
5717 /* Look at the next element of the map. */
5719 elt
= XVECTOR (vector
)->contents
[idx
];
5721 elt
= Fcar_safe (rest
);
5723 if (idx
< 0 && VECTORP (elt
))
5725 /* If we found a dense table in the keymap,
5726 advanced past it, but start scanning its contents. */
5727 rest
= Fcdr_safe (rest
);
5733 /* An ordinary element. */
5738 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5739 event
= Fcar_safe (elt
);
5743 s
= Fcar_safe (elt
); /* vector */
5744 XSETINT (event
, idx
);
5747 /* Ignore the element if it has no prompt string. */
5748 if (STRINGP (s
) && INTEGERP (event
))
5750 /* 1 if the char to type matches the string. */
5752 Lisp_Object upcased_event
, downcased_event
;
5755 upcased_event
= Fupcase (event
);
5756 downcased_event
= Fdowncase (event
);
5757 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5758 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5760 desc
= Fsingle_key_description (event
);
5762 /* If we have room for the prompt string, add it to this line.
5763 If this is the first on the line, always add it. */
5764 if ((XSTRING (s
)->size
+ i
+ 2
5765 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5771 /* Punctuate between strings. */
5774 strcpy (menu
+ i
, ", ");
5780 /* If the char to type doesn't match the string's
5781 first char, explicitly show what char to type. */
5784 /* Add as much of string as fits. */
5785 thiswidth
= XSTRING (desc
)->size
;
5786 if (thiswidth
+ i
> width
)
5787 thiswidth
= width
- i
;
5788 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5790 strcpy (menu
+ i
, " = ");
5794 /* Add as much of string as fits. */
5795 thiswidth
= XSTRING (s
)->size
;
5796 if (thiswidth
+ i
> width
)
5797 thiswidth
= width
- i
;
5798 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5804 /* If this element does not fit, end the line now,
5805 and save the element for the next line. */
5806 strcpy (menu
+ i
, "...");
5811 /* Move past this element. */
5812 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5813 /* Handle reaching end of dense table. */
5818 rest
= Fcdr_safe (rest
);
5822 /* Prompt with that and read response. */
5825 /* Make believe its not a keyboard macro in case the help char
5826 is pressed. Help characters are not recorded because menu prompting
5827 is not used on replay.
5829 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5830 current_kboard
->defining_kbd_macro
= Qnil
;
5832 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5833 while (BUFFERP (obj
));
5834 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5836 if (!INTEGERP (obj
))
5841 if (! EQ (obj
, menu_prompt_more_char
)
5842 && (!INTEGERP (menu_prompt_more_char
)
5843 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5845 if (!NILP (current_kboard
->defining_kbd_macro
))
5846 store_kbd_macro_char (obj
);
5849 /* Help char - go round again */
5853 /* Reading key sequences. */
5855 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5856 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5857 keymap, or nil otherwise. Return the index of the first keymap in
5858 which KEY has any binding, or NMAPS if no map has a binding.
5860 If KEY is a meta ASCII character, treat it like meta-prefix-char
5861 followed by the corresponding non-meta character. Keymaps in
5862 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5865 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5868 NEXT may be the same array as CURRENT. */
5871 follow_key (key
, nmaps
, current
, defs
, next
)
5873 Lisp_Object
*current
, *defs
, *next
;
5876 int i
, first_binding
;
5879 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5880 followed by the corresponding non-meta character.
5881 Put the results into DEFS, since we are going to alter that anyway.
5882 Do not alter CURRENT or NEXT. */
5883 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5885 for (i
= 0; i
< nmaps
; i
++)
5886 if (! NILP (current
[i
]))
5889 def
= get_keyelt (access_keymap (current
[i
],
5890 meta_prefix_char
, 1, 0), 0);
5892 /* Note that since we pass the resulting bindings through
5893 get_keymap_1, non-prefix bindings for meta-prefix-char
5895 defs
[i
] = get_keymap_1 (def
, 0, 1);
5901 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5904 first_binding
= nmaps
;
5905 for (i
= nmaps
- 1; i
>= 0; i
--)
5907 if (! NILP (current
[i
]))
5915 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
5916 if (! NILP (defs
[i
]))
5923 /* Given the set of bindings we've found, produce the next set of maps. */
5924 if (first_binding
< nmaps
)
5925 for (i
= 0; i
< nmaps
; i
++)
5926 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5928 return first_binding
;
5931 /* Read a sequence of keys that ends with a non prefix character,
5932 storing it in KEYBUF, a buffer of size BUFSIZE.
5934 Return the length of the key sequence stored.
5935 Return -1 if the user rejected a command menu.
5937 Echo starting immediately unless `prompt' is 0.
5939 Where a key sequence ends depends on the currently active keymaps.
5940 These include any minor mode keymaps active in the current buffer,
5941 the current buffer's local map, and the global map.
5943 If a key sequence has no other bindings, we check Vfunction_key_map
5944 to see if some trailing subsequence might be the beginning of a
5945 function key's sequence. If so, we try to read the whole function
5946 key, and substitute its symbolic name into the key sequence.
5948 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5949 `double-' events into similar click events, if that would make them
5950 bound. We try to turn `triple-' events first into `double-' events,
5953 If we get a mouse click in a mode line, vertical divider, or other
5954 non-text area, we treat the click as if it were prefixed by the
5955 symbol denoting that area - `mode-line', `vertical-line', or
5958 If the sequence starts with a mouse click, we read the key sequence
5959 with respect to the buffer clicked on, not the current buffer.
5961 If the user switches frames in the midst of a key sequence, we put
5962 off the switch-frame event until later; the next call to
5963 read_char will return it.
5965 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
5966 from the selected window's buffer. */
5969 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5970 can_return_switch_frame
, fix_current_buffer
)
5971 Lisp_Object
*keybuf
;
5974 int dont_downcase_last
;
5975 int can_return_switch_frame
;
5976 int fix_current_buffer
;
5978 int count
= specpdl_ptr
- specpdl
;
5980 /* How many keys there are in the current key sequence. */
5983 /* The length of the echo buffer when we started reading, and
5984 the length of this_command_keys when we started reading. */
5988 /* The number of keymaps we're scanning right now, and the number of
5989 keymaps we have allocated space for. */
5991 int nmaps_allocated
= 0;
5993 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5994 the current keymaps. */
5997 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5998 in the current keymaps, or nil where it is not a prefix. */
5999 Lisp_Object
*submaps
;
6001 /* The local map to start out with at start of key sequence. */
6002 Lisp_Object orig_local_map
;
6004 /* 1 if we have already considered switching to the local-map property
6005 of the place where a mouse click occurred. */
6006 int localized_local_map
= 0;
6008 /* The index in defs[] of the first keymap that has a binding for
6009 this key sequence. In other words, the lowest i such that
6010 defs[i] is non-nil. */
6013 /* If t < mock_input, then KEYBUF[t] should be read as the next
6016 We use this to recover after recognizing a function key. Once we
6017 realize that a suffix of the current key sequence is actually a
6018 function key's escape sequence, we replace the suffix with the
6019 function key's binding from Vfunction_key_map. Now keybuf
6020 contains a new and different key sequence, so the echo area,
6021 this_command_keys, and the submaps and defs arrays are wrong. In
6022 this situation, we set mock_input to t, set t to 0, and jump to
6023 restart_sequence; the loop will read keys from keybuf up until
6024 mock_input, thus rebuilding the state; and then it will resume
6025 reading characters from the keyboard. */
6028 /* If the sequence is unbound in submaps[], then
6029 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
6030 and fkey_map is its binding.
6032 These might be > t, indicating that all function key scanning
6033 should hold off until t reaches them. We do this when we've just
6034 recognized a function key, to avoid searching for the function
6035 key's again in Vfunction_key_map. */
6036 int fkey_start
= 0, fkey_end
= 0;
6037 Lisp_Object fkey_map
;
6039 /* Likewise, for key_translation_map. */
6040 int keytran_start
= 0, keytran_end
= 0;
6041 Lisp_Object keytran_map
;
6043 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
6044 we put it off for later. While we're reading, we keep the event here. */
6045 Lisp_Object delayed_switch_frame
;
6047 /* See the comment below... */
6048 #if defined (GOBBLE_FIRST_EVENT)
6049 Lisp_Object first_event
;
6052 Lisp_Object original_uppercase
;
6053 int original_uppercase_position
= -1;
6055 /* Gets around Microsoft compiler limitations. */
6058 struct buffer
*starting_buffer
;
6060 /* Nonzero if we seem to have got the beginning of a binding
6061 in function_key_map. */
6062 int function_key_possible
= 0;
6063 int key_translation_possible
= 0;
6065 /* Save the status of key translation before each step,
6066 so that we can restore this after downcasing. */
6067 Lisp_Object prev_fkey_map
;
6068 int prev_fkey_start
;
6071 Lisp_Object prev_keytran_map
;
6072 int prev_keytran_start
;
6073 int prev_keytran_end
;
6077 last_nonmenu_event
= Qnil
;
6079 delayed_switch_frame
= Qnil
;
6080 fkey_map
= Vfunction_key_map
;
6081 keytran_map
= Vkey_translation_map
;
6083 /* If there is no function-key-map, turn off function key scanning. */
6084 if (NILP (Fkeymapp (Vfunction_key_map
)))
6085 fkey_start
= fkey_end
= bufsize
+ 1;
6087 /* If there is no key-translation-map, turn off scanning. */
6088 if (NILP (Fkeymapp (Vkey_translation_map
)))
6089 keytran_start
= keytran_end
= bufsize
+ 1;
6094 echo_prompt (XSTRING (prompt
)->data
);
6095 else if (cursor_in_echo_area
&& echo_keystrokes
)
6096 /* This doesn't put in a dash if the echo buffer is empty, so
6097 you don't always see a dash hanging out in the minibuffer. */
6101 /* Record the initial state of the echo area and this_command_keys;
6102 we will need to restore them if we replay a key sequence. */
6104 echo_start
= echo_length ();
6105 keys_start
= this_command_key_count
;
6106 this_single_command_key_start
= keys_start
;
6108 #if defined (GOBBLE_FIRST_EVENT)
6109 /* This doesn't quite work, because some of the things that read_char
6110 does cannot safely be bypassed. It seems too risky to try to make
6113 /* Read the first char of the sequence specially, before setting
6114 up any keymaps, in case a filter runs and switches buffers on us. */
6115 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
6117 #endif /* GOBBLE_FIRST_EVENT */
6119 orig_local_map
= get_local_map (PT
, current_buffer
);
6121 /* We jump here when the key sequence has been thoroughly changed, and
6122 we need to rescan it starting from the beginning. When we jump here,
6123 keybuf[0..mock_input] holds the sequence we should reread. */
6126 starting_buffer
= current_buffer
;
6127 function_key_possible
= 0;
6128 key_translation_possible
= 0;
6130 /* Build our list of keymaps.
6131 If we recognize a function key and replace its escape sequence in
6132 keybuf with its symbol, or if the sequence starts with a mouse
6133 click and we need to switch buffers, we jump back here to rebuild
6134 the initial keymaps from the current buffer. */
6138 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6139 || !NILP (Voverriding_local_map
))
6141 if (3 > nmaps_allocated
)
6143 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6144 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6145 nmaps_allocated
= 3;
6148 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6149 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6150 if (!NILP (Voverriding_local_map
))
6151 submaps
[nmaps
++] = Voverriding_local_map
;
6155 nmaps
= current_minor_maps (0, &maps
);
6156 if (nmaps
+ 2 > nmaps_allocated
)
6158 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6159 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6160 nmaps_allocated
= nmaps
+ 2;
6162 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6163 #ifdef USE_TEXT_PROPERTIES
6164 submaps
[nmaps
++] = orig_local_map
;
6166 submaps
[nmaps
++] = current_buffer
->keymap
;
6169 submaps
[nmaps
++] = current_global_map
;
6172 /* Find an accurate initial value for first_binding. */
6173 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6174 if (! NILP (submaps
[first_binding
]))
6177 /* Start from the beginning in keybuf. */
6180 /* These are no-ops the first time through, but if we restart, they
6181 revert the echo area and this_command_keys to their original state. */
6182 this_command_key_count
= keys_start
;
6183 if (INTERACTIVE
&& t
< mock_input
)
6184 echo_truncate (echo_start
);
6186 /* If the best binding for the current key sequence is a keymap, or
6187 we may be looking at a function key's escape sequence, keep on
6189 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6190 || (first_binding
>= nmaps
6192 /* mock input is never part of a function key's sequence. */
6193 && mock_input
<= fkey_start
)
6194 || (first_binding
>= nmaps
6195 && keytran_start
< t
&& key_translation_possible
)
6196 /* Don't return in the middle of a possible function key sequence,
6197 if the only bindings we found were via case conversion.
6198 Thus, if ESC O a has a function-key-map translation
6199 and ESC o has a binding, don't return after ESC O,
6200 so that we can translate ESC O plus the next character. */
6204 int used_mouse_menu
= 0;
6206 /* Where the last real key started. If we need to throw away a
6207 key that has expanded into more than one element of keybuf
6208 (say, a mouse click on the mode line which is being treated
6209 as [mode-line (mouse-...)], then we backtrack to this point
6211 int last_real_key_start
;
6213 /* These variables are analogous to echo_start and keys_start;
6214 while those allow us to restart the entire key sequence,
6215 echo_local_start and keys_local_start allow us to throw away
6217 int echo_local_start
, keys_local_start
, local_first_binding
;
6220 error ("Key sequence too long");
6223 echo_local_start
= echo_length ();
6224 keys_local_start
= this_command_key_count
;
6225 local_first_binding
= first_binding
;
6228 /* These are no-ops, unless we throw away a keystroke below and
6229 jumped back up to replay_key; in that case, these restore the
6230 variables to their original state, allowing us to replay the
6232 if (INTERACTIVE
&& t
< mock_input
)
6233 echo_truncate (echo_local_start
);
6234 this_command_key_count
= keys_local_start
;
6235 first_binding
= local_first_binding
;
6237 /* By default, assume each event is "real". */
6238 last_real_key_start
= t
;
6240 /* Does mock_input indicate that we are re-reading a key sequence? */
6244 add_command_key (key
);
6245 if (echo_keystrokes
)
6249 /* If not, we should actually read a character. */
6252 struct buffer
*buf
= current_buffer
;
6256 KBOARD
*interrupted_kboard
= current_kboard
;
6257 struct frame
*interrupted_frame
= selected_frame
;
6258 if (setjmp (wrong_kboard_jmpbuf
))
6260 if (!NILP (delayed_switch_frame
))
6262 interrupted_kboard
->kbd_queue
6263 = Fcons (delayed_switch_frame
,
6264 interrupted_kboard
->kbd_queue
);
6265 delayed_switch_frame
= Qnil
;
6268 interrupted_kboard
->kbd_queue
6269 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6271 /* If the side queue is non-empty, ensure it begins with a
6272 switch-frame, so we'll replay it in the right context. */
6273 if (CONSP (interrupted_kboard
->kbd_queue
)
6274 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6275 !(EVENT_HAS_PARAMETERS (key
)
6276 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6280 XSETFRAME (frame
, interrupted_frame
);
6281 interrupted_kboard
->kbd_queue
6282 = Fcons (make_lispy_switch_frame (frame
),
6283 interrupted_kboard
->kbd_queue
);
6286 orig_local_map
= get_local_map (PT
, current_buffer
);
6287 goto replay_sequence
;
6290 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6294 /* read_char returns t when it shows a menu and the user rejects it.
6299 /* read_char returns -1 at the end of a macro.
6300 Emacs 18 handles this by returning immediately with a
6301 zero, so that's what we'll do. */
6302 if (INTEGERP (key
) && XINT (key
) == -1)
6305 /* The Microsoft C compiler can't handle the goto that
6311 /* If the current buffer has been changed from under us, the
6312 keymap may have changed, so replay the sequence. */
6316 /* Reset the current buffer from the selected window
6317 in case something changed the former and not the latter.
6318 This is to be more consistent with the behavior
6319 of the command_loop_1. */
6320 if (fix_current_buffer
)
6321 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
6322 Fset_buffer (XWINDOW (selected_window
)->buffer
);
6324 orig_local_map
= get_local_map (PT
, current_buffer
);
6325 goto replay_sequence
;
6328 /* If we have a quit that was typed in another frame, and
6329 quit_throw_to_read_char switched buffers,
6330 replay to get the right keymap. */
6331 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6336 orig_local_map
= get_local_map (PT
, current_buffer
);
6337 goto replay_sequence
;
6343 /* Clicks in non-text areas get prefixed by the symbol
6344 in their CHAR-ADDRESS field. For example, a click on
6345 the mode line is prefixed by the symbol `mode-line'.
6347 Furthermore, key sequences beginning with mouse clicks
6348 are read using the keymaps of the buffer clicked on, not
6349 the current buffer. So we may have to switch the buffer
6352 When we turn one event into two events, we must make sure
6353 that neither of the two looks like the original--so that,
6354 if we replay the events, they won't be expanded again.
6355 If not for this, such reexpansion could happen either here
6356 or when user programs play with this-command-keys. */
6357 if (EVENT_HAS_PARAMETERS (key
))
6361 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6362 if (EQ (kind
, Qmouse_click
))
6364 Lisp_Object window
, posn
;
6366 window
= POSN_WINDOW (EVENT_START (key
));
6367 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6370 /* We're looking at the second event of a
6371 sequence which we expanded before. Set
6372 last_real_key_start appropriately. */
6374 last_real_key_start
= t
- 1;
6377 /* Key sequences beginning with mouse clicks are
6378 read using the keymaps in the buffer clicked on,
6379 not the current buffer. If we're at the
6380 beginning of a key sequence, switch buffers. */
6381 if (last_real_key_start
== 0
6383 && BUFFERP (XWINDOW (window
)->buffer
)
6384 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6389 /* Arrange to go back to the original buffer once we're
6390 done reading the key sequence. Note that we can't
6391 use save_excursion_{save,restore} here, because they
6392 save point as well as the current buffer; we don't
6393 want to save point, because redisplay may change it,
6394 to accommodate a Fset_window_start or something. We
6395 don't want to do this at the top of the function,
6396 because we may get input from a subprocess which
6397 wants to change the selected window and stuff (say,
6399 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6401 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6402 orig_local_map
= get_local_map (PT
, current_buffer
);
6403 goto replay_sequence
;
6405 /* For a mouse click, get the local text-property keymap
6406 of the place clicked on, rather than point. */
6407 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6408 && ! localized_local_map
)
6410 Lisp_Object map_here
, start
, pos
;
6412 localized_local_map
= 1;
6413 start
= EVENT_START (key
);
6414 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6416 pos
= POSN_BUFFER_POSN (start
);
6418 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6420 map_here
= get_local_map (XINT (pos
), current_buffer
);
6421 if (!EQ (map_here
, orig_local_map
))
6423 orig_local_map
= map_here
;
6427 goto replay_sequence
;
6433 /* Expand mode-line and scroll-bar events into two events:
6434 use posn as a fake prefix key. */
6437 if (t
+ 1 >= bufsize
)
6438 error ("Key sequence too long");
6443 /* Zap the position in key, so we know that we've
6444 expanded it, and don't try to do so again. */
6445 POSN_BUFFER_POSN (EVENT_START (key
))
6446 = Fcons (posn
, Qnil
);
6450 else if (EQ (kind
, Qswitch_frame
))
6452 /* If we're at the beginning of a key sequence, and the caller
6453 says it's okay, go ahead and return this event. If we're
6454 in the midst of a key sequence, delay it until the end. */
6455 if (t
> 0 || !can_return_switch_frame
)
6457 delayed_switch_frame
= key
;
6461 else if (CONSP (XCONS (key
)->cdr
)
6462 && CONSP (EVENT_START (key
))
6463 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6467 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6468 /* Handle menu-bar events:
6469 insert the dummy prefix event `menu-bar'. */
6470 if (EQ (posn
, Qmenu_bar
))
6472 if (t
+ 1 >= bufsize
)
6473 error ("Key sequence too long");
6477 /* Zap the position in key, so we know that we've
6478 expanded it, and don't try to do so again. */
6479 POSN_BUFFER_POSN (EVENT_START (key
))
6480 = Fcons (posn
, Qnil
);
6483 goto replay_sequence
;
6485 else if (CONSP (posn
))
6487 /* We're looking at the second event of a
6488 sequence which we expanded before. Set
6489 last_real_key_start appropriately. */
6490 if (last_real_key_start
== t
&& t
> 0)
6491 last_real_key_start
= t
- 1;
6496 /* We have finally decided that KEY is something we might want
6498 first_binding
= (follow_key (key
,
6499 nmaps
- first_binding
,
6500 submaps
+ first_binding
,
6501 defs
+ first_binding
,
6502 submaps
+ first_binding
)
6505 /* If KEY wasn't bound, we'll try some fallbacks. */
6506 if (first_binding
>= nmaps
)
6510 head
= EVENT_HEAD (key
);
6511 if (help_char_p (head
) && t
> 0)
6513 read_key_sequence_cmd
= Vprefix_help_command
;
6515 last_nonmenu_event
= key
;
6516 /* The Microsoft C compiler can't handle the goto that
6524 Lisp_Object breakdown
;
6527 breakdown
= parse_modifiers (head
);
6528 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6529 /* Attempt to reduce an unbound mouse event to a simpler
6530 event that is bound:
6531 Drags reduce to clicks.
6532 Double-clicks reduce to clicks.
6533 Triple-clicks reduce to double-clicks, then to clicks.
6534 Down-clicks are eliminated.
6535 Double-downs reduce to downs, then are eliminated.
6536 Triple-downs reduce to double-downs, then to downs,
6537 then are eliminated. */
6538 if (modifiers
& (down_modifier
| drag_modifier
6539 | double_modifier
| triple_modifier
))
6541 while (modifiers
& (down_modifier
| drag_modifier
6542 | double_modifier
| triple_modifier
))
6544 Lisp_Object new_head
, new_click
;
6545 if (modifiers
& triple_modifier
)
6546 modifiers
^= (double_modifier
| triple_modifier
);
6547 else if (modifiers
& double_modifier
)
6548 modifiers
&= ~double_modifier
;
6549 else if (modifiers
& drag_modifier
)
6550 modifiers
&= ~drag_modifier
;
6553 /* Dispose of this `down' event by simply jumping
6554 back to replay_key, to get another event.
6556 Note that if this event came from mock input,
6557 then just jumping back to replay_key will just
6558 hand it to us again. So we have to wipe out any
6561 We could delete keybuf[t] and shift everything
6562 after that to the left by one spot, but we'd also
6563 have to fix up any variable that points into
6564 keybuf, and shifting isn't really necessary
6567 Adding prefixes for non-textual mouse clicks
6568 creates two characters of mock input, and both
6569 must be thrown away. If we're only looking at
6570 the prefix now, we can just jump back to
6571 replay_key. On the other hand, if we've already
6572 processed the prefix, and now the actual click
6573 itself is giving us trouble, then we've lost the
6574 state of the keymaps we want to backtrack to, and
6575 we need to replay the whole sequence to rebuild
6578 Beyond that, only function key expansion could
6579 create more than two keys, but that should never
6580 generate mouse events, so it's okay to zero
6581 mock_input in that case too.
6583 Isn't this just the most wonderful code ever? */
6584 if (t
== last_real_key_start
)
6591 mock_input
= last_real_key_start
;
6592 goto replay_sequence
;
6597 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6599 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6601 /* Look for a binding for this new key. follow_key
6602 promises that it didn't munge submaps the
6603 last time we called it, since key was unbound. */
6605 = (follow_key (new_click
,
6606 nmaps
- local_first_binding
,
6607 submaps
+ local_first_binding
,
6608 defs
+ local_first_binding
,
6609 submaps
+ local_first_binding
)
6610 + local_first_binding
);
6612 /* If that click is bound, go for it. */
6613 if (first_binding
< nmaps
)
6618 /* Otherwise, we'll leave key set to the drag event. */
6625 /* Normally, last_nonmenu_event gets the previous key we read.
6626 But when a mouse popup menu is being used,
6627 we don't update last_nonmenu_event; it continues to hold the mouse
6628 event that preceded the first level of menu. */
6629 if (!used_mouse_menu
)
6630 last_nonmenu_event
= key
;
6632 /* Record what part of this_command_keys is the current key sequence. */
6633 this_single_command_key_start
= this_command_key_count
- t
;
6635 prev_fkey_map
= fkey_map
;
6636 prev_fkey_start
= fkey_start
;
6637 prev_fkey_end
= fkey_end
;
6639 prev_keytran_map
= keytran_map
;
6640 prev_keytran_start
= keytran_start
;
6641 prev_keytran_end
= keytran_end
;
6643 /* If the sequence is unbound, see if we can hang a function key
6644 off the end of it. We only want to scan real keyboard input
6645 for function key sequences, so if mock_input says that we're
6646 re-reading old events, don't examine it. */
6647 if (first_binding
>= nmaps
6650 Lisp_Object fkey_next
;
6652 /* Continue scan from fkey_end until we find a bound suffix.
6653 If we fail, increment fkey_start
6654 and start fkey_end from there. */
6655 while (fkey_end
< t
)
6659 key
= keybuf
[fkey_end
++];
6660 /* Look up meta-characters by prefixing them
6661 with meta_prefix_char. I hate this. */
6662 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6667 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
6669 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6672 fkey_next
= fkey_map
;
6675 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 0);
6677 #if 0 /* I didn't turn this on, because it might cause trouble
6678 for the mapping of return into C-m and tab into C-i. */
6679 /* Optionally don't map function keys into other things.
6680 This enables the user to redefine kp- keys easily. */
6681 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6685 /* If the function key map gives a function, not an
6686 array, then call the function with no args and use
6687 its value instead. */
6688 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6691 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6695 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6696 fkey_next
= call1 (fkey_next
, prompt
);
6698 /* If the function returned something invalid,
6699 barf--don't ignore it.
6700 (To ignore it safely, we would need to gcpro a bunch of
6701 other variables.) */
6702 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6703 error ("Function in key-translation-map returns invalid key sequence");
6706 function_key_possible
= ! NILP (fkey_next
);
6708 /* If keybuf[fkey_start..fkey_end] is bound in the
6709 function key map and it's a suffix of the current
6710 sequence (i.e. fkey_end == t), replace it with
6711 the binding and restart with fkey_start at the end. */
6712 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6715 int len
= XFASTINT (Flength (fkey_next
));
6717 t
= fkey_start
+ len
;
6719 error ("Key sequence too long");
6721 if (VECTORP (fkey_next
))
6722 bcopy (XVECTOR (fkey_next
)->contents
,
6723 keybuf
+ fkey_start
,
6724 (t
- fkey_start
) * sizeof (keybuf
[0]));
6725 else if (STRINGP (fkey_next
))
6729 for (i
= 0; i
< len
; i
++)
6730 XSETFASTINT (keybuf
[fkey_start
+ i
],
6731 XSTRING (fkey_next
)->data
[i
]);
6735 fkey_start
= fkey_end
= t
;
6736 fkey_map
= Vfunction_key_map
;
6738 /* Do pass the results through key-translation-map. */
6739 keytran_start
= keytran_end
= 0;
6740 keytran_map
= Vkey_translation_map
;
6742 goto replay_sequence
;
6745 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6747 /* If we no longer have a bound suffix, try a new positions for
6749 if (NILP (fkey_map
))
6751 fkey_end
= ++fkey_start
;
6752 fkey_map
= Vfunction_key_map
;
6753 function_key_possible
= 0;
6758 /* Look for this sequence in key-translation-map. */
6760 Lisp_Object keytran_next
;
6762 /* Scan from keytran_end until we find a bound suffix. */
6763 while (keytran_end
< t
)
6767 key
= keybuf
[keytran_end
++];
6768 /* Look up meta-characters by prefixing them
6769 with meta_prefix_char. I hate this. */
6770 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6775 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
6777 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6780 keytran_next
= keytran_map
;
6783 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 0);
6785 /* If the key translation map gives a function, not an
6786 array, then call the function with no args and use
6787 its value instead. */
6788 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6789 && keytran_end
== t
)
6791 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6795 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6796 keytran_next
= call1 (keytran_next
, prompt
);
6798 /* If the function returned something invalid,
6799 barf--don't ignore it.
6800 (To ignore it safely, we would need to gcpro a bunch of
6801 other variables.) */
6802 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6803 error ("Function in key-translation-map returns invalid key sequence");
6806 key_translation_possible
= ! NILP (keytran_next
);
6808 /* If keybuf[keytran_start..keytran_end] is bound in the
6809 key translation map and it's a suffix of the current
6810 sequence (i.e. keytran_end == t), replace it with
6811 the binding and restart with keytran_start at the end. */
6812 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6813 && keytran_end
== t
)
6815 int len
= XFASTINT (Flength (keytran_next
));
6817 t
= keytran_start
+ len
;
6819 error ("Key sequence too long");
6821 if (VECTORP (keytran_next
))
6822 bcopy (XVECTOR (keytran_next
)->contents
,
6823 keybuf
+ keytran_start
,
6824 (t
- keytran_start
) * sizeof (keybuf
[0]));
6825 else if (STRINGP (keytran_next
))
6829 for (i
= 0; i
< len
; i
++)
6830 XSETFASTINT (keybuf
[keytran_start
+ i
],
6831 XSTRING (keytran_next
)->data
[i
]);
6835 keytran_start
= keytran_end
= t
;
6836 keytran_map
= Vkey_translation_map
;
6838 /* Don't pass the results of key-translation-map
6839 through function-key-map. */
6840 fkey_start
= fkey_end
= t
;
6841 fkey_map
= Vkey_translation_map
;
6843 goto replay_sequence
;
6846 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6848 /* If we no longer have a bound suffix, try a new positions for
6850 if (NILP (keytran_map
))
6852 keytran_end
= ++keytran_start
;
6853 keytran_map
= Vkey_translation_map
;
6854 key_translation_possible
= 0;
6859 /* If KEY is not defined in any of the keymaps,
6860 and cannot be part of a function key or translation,
6861 and is an upper case letter
6862 use the corresponding lower-case letter instead. */
6863 if (first_binding
== nmaps
&& ! function_key_possible
6864 && ! key_translation_possible
6866 && ((((XINT (key
) & 0x3ffff)
6867 < XSTRING (current_buffer
->downcase_table
)->size
)
6868 && UPPERCASEP (XINT (key
) & 0x3ffff))
6869 || (XINT (key
) & shift_modifier
)))
6871 Lisp_Object new_key
;
6873 original_uppercase
= key
;
6874 original_uppercase_position
= t
- 1;
6876 if (XINT (key
) & shift_modifier
)
6877 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6879 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6880 | (XINT (key
) & ~0x3ffff)));
6882 /* We have to do this unconditionally, regardless of whether
6883 the lower-case char is defined in the keymaps, because they
6884 might get translated through function-key-map. */
6885 keybuf
[t
- 1] = new_key
;
6888 fkey_map
= prev_fkey_map
;
6889 fkey_start
= prev_fkey_start
;
6890 fkey_end
= prev_fkey_end
;
6892 keytran_map
= prev_keytran_map
;
6893 keytran_start
= prev_keytran_start
;
6894 keytran_end
= prev_keytran_end
;
6896 goto replay_sequence
;
6898 /* If KEY is not defined in any of the keymaps,
6899 and cannot be part of a function key or translation,
6900 and is a shifted function key,
6901 use the corresponding unshifted function key instead. */
6902 if (first_binding
== nmaps
&& ! function_key_possible
6903 && ! key_translation_possible
6906 Lisp_Object breakdown
;
6909 breakdown
= parse_modifiers (key
);
6910 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6911 if (modifiers
& shift_modifier
)
6913 Lisp_Object new_key
;
6915 original_uppercase
= key
;
6916 original_uppercase_position
= t
- 1;
6918 modifiers
&= ~shift_modifier
;
6919 new_key
= apply_modifiers (modifiers
,
6920 XCONS (breakdown
)->car
);
6922 keybuf
[t
- 1] = new_key
;
6925 fkey_map
= prev_fkey_map
;
6926 fkey_start
= prev_fkey_start
;
6927 fkey_end
= prev_fkey_end
;
6929 keytran_map
= prev_keytran_map
;
6930 keytran_start
= prev_keytran_start
;
6931 keytran_end
= prev_keytran_end
;
6933 goto replay_sequence
;
6939 read_key_sequence_cmd
= (first_binding
< nmaps
6940 ? defs
[first_binding
]
6943 unread_switch_frame
= delayed_switch_frame
;
6944 unbind_to (count
, Qnil
);
6946 /* Don't downcase the last character if the caller says don't.
6947 Don't downcase it if the result is undefined, either. */
6948 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6949 && t
- 1 == original_uppercase_position
)
6950 keybuf
[t
- 1] = original_uppercase
;
6952 /* Occasionally we fabricate events, perhaps by expanding something
6953 according to function-key-map, or by adding a prefix symbol to a
6954 mouse click in the scroll bar or modeline. In this cases, return
6955 the entire generated key sequence, even if we hit an unbound
6956 prefix or a definition before the end. This means that you will
6957 be able to push back the event properly, and also means that
6958 read-key-sequence will always return a logical unit.
6961 for (; t
< mock_input
; t
++)
6963 if (echo_keystrokes
)
6964 echo_char (keybuf
[t
]);
6965 add_command_key (keybuf
[t
]);
6971 #if 0 /* This doc string is too long for some compilers.
6972 This commented-out definition serves for DOC. */
6973 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6974 "Read a sequence of keystrokes and return as a string or vector.\n\
6975 The sequence is sufficient to specify a non-prefix command in the\n\
6976 current local and global maps.\n\
6978 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6979 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6980 as a continuation of the previous key.\n\
6982 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6983 convert the last event to lower case. (Normally any upper case event\n\
6984 is converted to lower case if the original event is undefined and the lower\n\
6985 case equivalent is defined.) A non-nil value is appropriate for reading\n\
6986 a key sequence to be defined.\n\
6988 A C-g typed while in this function is treated like any other character,\n\
6989 and `quit-flag' is not set.\n\
6991 If the key sequence starts with a mouse click, then the sequence is read\n\
6992 using the keymaps of the buffer of the window clicked in, not the buffer\n\
6993 of the selected window as normal.\n\
6995 `read-key-sequence' drops unbound button-down events, since you normally\n\
6996 only care about the click or drag events which follow them. If a drag\n\
6997 or multi-click event is unbound, but the corresponding click event would\n\
6998 be bound, `read-key-sequence' turns the event into a click event at the\n\
6999 drag's starting position. This means that you don't have to distinguish\n\
7000 between click and drag, double, or triple events unless you want to.\n\
7002 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
7003 lines separating windows, and scroll bars with imaginary keys\n\
7004 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
7006 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
7007 function will process a switch-frame event if the user switches frames\n\
7008 before typing anything. If the user switches frames in the middle of a\n\
7009 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
7010 is nil, then the event will be put off until after the current key sequence.\n\
7012 `read-key-sequence' checks `function-key-map' for function key\n\
7013 sequences, where they wouldn't conflict with ordinary bindings. See\n\
7014 `function-key-map' for more details.")
7015 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7018 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7020 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7021 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7022 Lisp_Object can_return_switch_frame
;
7024 Lisp_Object keybuf
[30];
7026 struct gcpro gcpro1
, gcpro2
;
7029 CHECK_STRING (prompt
, 0);
7032 bzero (keybuf
, sizeof keybuf
);
7034 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7036 if (NILP (continue_echo
))
7038 this_command_key_count
= 0;
7039 this_single_command_key_start
= 0;
7042 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7043 prompt
, ! NILP (dont_downcase_last
),
7044 ! NILP (can_return_switch_frame
), 0);
7052 return make_event_array (i
, keybuf
);
7055 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
7056 "Execute CMD as an editor command.\n\
7057 CMD must be a symbol that satisfies the `commandp' predicate.\n\
7058 Optional second arg RECORD-FLAG non-nil\n\
7059 means unconditionally put this command in `command-history'.\n\
7060 Otherwise, that is done only if an arg is read using the minibuffer.\n\
7061 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
7062 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
7063 The argument SPECIAL, if non-nil, means that this command is executing\n\
7064 a special event, so ignore the prefix argument and don't clear it.")
7065 (cmd
, record_flag
, keys
, special
)
7066 Lisp_Object cmd
, record_flag
, keys
, special
;
7068 register Lisp_Object final
;
7069 register Lisp_Object tem
;
7070 Lisp_Object prefixarg
;
7071 struct backtrace backtrace
;
7072 extern int debug_on_next_call
;
7074 debug_on_next_call
= 0;
7078 prefixarg
= current_kboard
->Vprefix_arg
;
7079 Vcurrent_prefix_arg
= prefixarg
;
7080 current_kboard
->Vprefix_arg
= Qnil
;
7087 tem
= Fget (cmd
, Qdisabled
);
7088 if (!NILP (tem
) && !NILP (Vrun_hooks
))
7090 tem
= Fsymbol_value (Qdisabled_command_hook
);
7092 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
7098 final
= Findirect_function (cmd
);
7100 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
7102 struct gcpro gcpro1
, gcpro2
;
7104 GCPRO2 (cmd
, prefixarg
);
7105 do_autoload (final
, cmd
);
7112 if (STRINGP (final
) || VECTORP (final
))
7114 /* If requested, place the macro in the command history. For
7115 other sorts of commands, call-interactively takes care of
7117 if (!NILP (record_flag
))
7119 = Fcons (Fcons (Qexecute_kbd_macro
,
7120 Fcons (final
, Fcons (prefixarg
, Qnil
))),
7123 return Fexecute_kbd_macro (final
, prefixarg
);
7125 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
7127 backtrace
.next
= backtrace_list
;
7128 backtrace_list
= &backtrace
;
7129 backtrace
.function
= &Qcall_interactively
;
7130 backtrace
.args
= &cmd
;
7131 backtrace
.nargs
= 1;
7132 backtrace
.evalargs
= 0;
7134 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7136 backtrace_list
= backtrace
.next
;
7142 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7144 "Read function name, then read its arguments and call it.")
7146 Lisp_Object prefixarg
;
7148 Lisp_Object function
;
7150 Lisp_Object saved_keys
;
7151 Lisp_Object bindings
, value
;
7152 struct gcpro gcpro1
, gcpro2
;
7154 saved_keys
= Fvector (this_command_key_count
,
7155 XVECTOR (this_command_keys
)->contents
);
7157 GCPRO2 (saved_keys
, prefixarg
);
7159 if (EQ (prefixarg
, Qminus
))
7161 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7162 strcpy (buf
, "C-u ");
7163 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7165 if (sizeof (int) == sizeof (EMACS_INT
))
7166 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7167 else if (sizeof (long) == sizeof (EMACS_INT
))
7168 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7172 else if (INTEGERP (prefixarg
))
7174 if (sizeof (int) == sizeof (EMACS_INT
))
7175 sprintf (buf
, "%d ", XINT (prefixarg
));
7176 else if (sizeof (long) == sizeof (EMACS_INT
))
7177 sprintf (buf
, "%ld ", XINT (prefixarg
));
7182 /* This isn't strictly correct if execute-extended-command
7183 is bound to anything else. Perhaps it should use
7184 this_command_keys? */
7185 strcat (buf
, "M-x ");
7187 /* Prompt with buf, and then read a string, completing from and
7188 restricting to the set of all defined commands. Don't provide
7189 any initial input. Save the command read on the extended-command
7191 function
= Fcompleting_read (build_string (buf
),
7192 Vobarray
, Qcommandp
,
7193 Qt
, Qnil
, Qextended_command_history
, Qnil
,
7196 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7197 error ("No command name given");
7199 /* Set this_command_keys to the concatenation of saved_keys and
7200 function, followed by a RET. */
7202 struct Lisp_String
*str
;
7207 this_command_key_count
= 0;
7208 this_single_command_key_start
= 0;
7210 keys
= XVECTOR (saved_keys
)->contents
;
7211 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7212 add_command_key (keys
[i
]);
7214 str
= XSTRING (function
);
7215 for (i
= 0; i
< str
->size
; i
++)
7217 XSETFASTINT (tem
, str
->data
[i
]);
7218 add_command_key (tem
);
7221 XSETFASTINT (tem
, '\015');
7222 add_command_key (tem
);
7227 function
= Fintern (function
, Qnil
);
7228 current_kboard
->Vprefix_arg
= prefixarg
;
7229 this_command
= function
;
7231 /* If enabled, show which key runs this command. */
7232 if (!NILP (Vsuggest_key_bindings
)
7233 && NILP (Vexecuting_macro
)
7234 && SYMBOLP (function
))
7235 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7241 GCPRO2 (bindings
, value
);
7242 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7244 /* If the command has a key binding, print it now. */
7245 if (!NILP (bindings
))
7247 /* But first wait, and skip the message if there is input. */
7248 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7249 ? Vsuggest_key_bindings
: make_number (2)),
7251 && ! CONSP (Vunread_command_events
))
7253 Lisp_Object binding
;
7255 char *oldmessage
= echo_area_glyphs
;
7256 int oldmessage_len
= echo_area_glyphs_length
;
7258 binding
= Fkey_description (bindings
);
7261 = (char *) alloca (XSYMBOL (function
)->name
->size
7262 + XSTRING (binding
)->size
7264 sprintf (newmessage
, "You can run the command `%s' by typing %s",
7265 XSYMBOL (function
)->name
->data
,
7266 XSTRING (binding
)->data
);
7267 message1_nolog (newmessage
);
7268 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7269 ? Vsuggest_key_bindings
: make_number (2)),
7271 message2_nolog (oldmessage
, oldmessage_len
);
7275 RETURN_UNGCPRO (value
);
7278 /* Find the set of keymaps now active.
7279 Store into *MAPS_P a vector holding the various maps
7280 and return the number of them. The vector was malloc'd
7281 and the caller should free it. */
7284 current_active_maps (maps_p
)
7285 Lisp_Object
**maps_p
;
7287 Lisp_Object
*tmaps
, *maps
;
7290 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7291 if (!NILP (Voverriding_local_map_menu_flag
))
7293 /* Yes, use them (if non-nil) as well as the global map. */
7294 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7296 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7297 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7298 if (!NILP (Voverriding_local_map
))
7299 maps
[nmaps
++] = Voverriding_local_map
;
7303 /* No, so use major and minor mode keymaps. */
7304 nmaps
= current_minor_maps (NULL
, &tmaps
);
7305 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7306 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7307 #ifdef USE_TEXT_PROPERTIES
7308 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7310 maps
[nmaps
++] = current_buffer
->keymap
;
7313 maps
[nmaps
++] = current_global_map
;
7319 /* Return nonzero if input events are pending. */
7321 detect_input_pending ()
7324 get_input_pending (&input_pending
, 0);
7326 return input_pending
;
7329 /* Return nonzero if input events are pending, and run any pending timers. */
7331 detect_input_pending_run_timers (do_display
)
7334 int old_timers_run
= timers_run
;
7337 get_input_pending (&input_pending
, 1);
7339 if (old_timers_run
!= timers_run
&& do_display
)
7340 redisplay_preserve_echo_area ();
7342 return input_pending
;
7345 /* This is called in some cases before a possible quit.
7346 It cases the next call to detect_input_pending to recompute input_pending.
7347 So calling this function unnecessarily can't do any harm. */
7348 clear_input_pending ()
7353 /* Return nonzero if there are pending requeued events.
7354 This isn't used yet. The hope is to make wait_reading_process_input
7355 call it, and return return if it runs Lisp code that unreads something.
7356 The problem is, kbd_buffer_get_event needs to be fixed to know what
7357 to do in that case. It isn't trivial. */
7359 requeued_events_pending_p ()
7361 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7365 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7366 "T if command input is currently available with no waiting.\n\
7367 Actually, the value is nil only if we can be sure that no input is available.")
7370 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7373 get_input_pending (&input_pending
, 1);
7374 return input_pending
> 0 ? Qt
: Qnil
;
7377 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7378 "Return vector of last 100 events, not counting those from keyboard macros.")
7381 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7384 if (total_keys
< NUM_RECENT_KEYS
)
7385 return Fvector (total_keys
, keys
);
7388 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7389 bcopy (keys
+ recent_keys_index
,
7390 XVECTOR (val
)->contents
,
7391 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7393 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7394 recent_keys_index
* sizeof (Lisp_Object
));
7399 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7400 "Return the key sequence that invoked this command.\n\
7401 The value is a string or a vector.")
7404 return make_event_array (this_command_key_count
,
7405 XVECTOR (this_command_keys
)->contents
);
7408 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7409 Sthis_single_command_keys
, 0, 0, 0,
7410 "Return the key sequence that invoked this command.\n\
7411 Unlike `this-command-keys', this function's value\n\
7412 does not include prefix arguments.\n\
7413 The value is a string or a vector.")
7416 return make_event_array (this_command_key_count
7417 - this_single_command_key_start
,
7418 (XVECTOR (this_command_keys
)->contents
7419 + this_single_command_key_start
));
7422 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7423 Sreset_this_command_lengths
, 0, 0, 0,
7424 "Used for complicated reasons in `universal-argument-other-key'.\n\
7426 `universal-argument-other-key' rereads the event just typed.\n\
7427 It then gets translated through `function-key-map'.\n\
7428 The translated event gets included in the echo area and in\n\
7429 the value of `this-command-keys' in addition to the raw original event.\n\
7430 That is not right.\n\
7432 Calling this function directs the translated event to replace\n\
7433 the original event, so that only one version of the event actually\n\
7434 appears in the echo area and in the value of `this-command-keys.'.")
7437 before_command_restore_flag
= 1;
7438 before_command_key_count_1
= before_command_key_count
;
7439 before_command_echo_length_1
= before_command_echo_length
;
7442 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7443 "Return the current depth in recursive edits.")
7447 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
7451 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
7452 "FOpen dribble file: ",
7453 "Start writing all keyboard characters to a dribble file called FILE.\n\
7454 If FILE is nil, close any open dribble file.")
7465 file
= Fexpand_file_name (file
, Qnil
);
7466 dribble
= fopen (XSTRING (file
)->data
, "w");
7468 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
7473 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
7474 "Discard the contents of the terminal input buffer.\n\
7475 Also cancel any kbd macro being defined.")
7478 current_kboard
->defining_kbd_macro
= Qnil
;
7479 update_mode_lines
++;
7481 Vunread_command_events
= Qnil
;
7482 unread_command_char
= -1;
7484 discard_tty_input ();
7486 /* Without the cast, GCC complains that this assignment loses the
7487 volatile qualifier of kbd_store_ptr. Is there anything wrong
7489 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7490 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7496 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7497 "Stop Emacs and return to superior process. You can resume later.\n\
7498 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7499 control, run a subshell instead.\n\n\
7500 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7501 to be read as terminal input by Emacs's parent, after suspension.\n\
7503 Before suspending, run the normal hook `suspend-hook'.\n\
7504 After resumption run the normal hook `suspend-resume-hook'.\n\
7506 Some operating systems cannot stop the Emacs process and resume it later.\n\
7507 On such systems, Emacs starts a subshell instead of suspending.")
7509 Lisp_Object stuffstring
;
7512 int count
= specpdl_ptr
- specpdl
;
7513 int old_height
, old_width
;
7515 struct gcpro gcpro1
, gcpro2
;
7516 extern init_sys_modes ();
7518 if (!NILP (stuffstring
))
7519 CHECK_STRING (stuffstring
, 0);
7521 /* Run the functions in suspend-hook. */
7522 if (!NILP (Vrun_hooks
))
7523 call1 (Vrun_hooks
, intern ("suspend-hook"));
7525 GCPRO1 (stuffstring
);
7526 get_frame_size (&old_width
, &old_height
);
7528 /* sys_suspend can get an error if it tries to fork a subshell
7529 and the system resources aren't available for that. */
7530 record_unwind_protect (init_sys_modes
, 0);
7531 stuff_buffered_input (stuffstring
);
7536 unbind_to (count
, Qnil
);
7538 /* Check if terminal/window size has changed.
7539 Note that this is not useful when we are running directly
7540 with a window system; but suspend should be disabled in that case. */
7541 get_frame_size (&width
, &height
);
7542 if (width
!= old_width
|| height
!= old_height
)
7543 change_frame_size (selected_frame
, height
, width
, 0, 0);
7545 /* Run suspend-resume-hook. */
7546 if (!NILP (Vrun_hooks
))
7547 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7553 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7554 Then in any case stuff anything Emacs has read ahead and not used. */
7556 stuff_buffered_input (stuffstring
)
7557 Lisp_Object stuffstring
;
7559 /* stuff_char works only in BSD, versions 4.2 and up. */
7562 register unsigned char *p
;
7564 if (STRINGP (stuffstring
))
7568 p
= XSTRING (stuffstring
)->data
;
7569 count
= XSTRING (stuffstring
)->size
;
7574 /* Anything we have read ahead, put back for the shell to read. */
7575 /* ?? What should this do when we have multiple keyboards??
7576 Should we ignore anything that was typed in at the "wrong" kboard? */
7577 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7579 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7580 kbd_fetch_ptr
= kbd_buffer
;
7581 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7582 stuff_char (kbd_fetch_ptr
->code
);
7583 kbd_fetch_ptr
->kind
= no_event
;
7584 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7590 #endif /* BSD_SYSTEM and not BSD4_1 */
7593 set_waiting_for_input (time_to_clear
)
7594 EMACS_TIME
*time_to_clear
;
7596 input_available_clear_time
= time_to_clear
;
7598 /* Tell interrupt_signal to throw back to read_char, */
7599 waiting_for_input
= 1;
7601 /* If interrupt_signal was called before and buffered a C-g,
7602 make it run again now, to avoid timing error. */
7603 if (!NILP (Vquit_flag
))
7604 quit_throw_to_read_char ();
7607 clear_waiting_for_input ()
7609 /* Tell interrupt_signal not to throw back to read_char, */
7610 waiting_for_input
= 0;
7611 input_available_clear_time
= 0;
7614 /* This routine is called at interrupt level in response to C-G.
7615 If interrupt_input, this is the handler for SIGINT.
7616 Otherwise, it is called from kbd_buffer_store_event,
7617 in handling SIGIO or SIGTINT.
7619 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7620 immediately throw back to read_char.
7622 Otherwise it sets the Lisp variable quit-flag not-nil.
7623 This causes eval to throw, when it gets a chance.
7624 If quit-flag is already non-nil, it stops the job right away. */
7627 interrupt_signal (signalnum
) /* If we don't have an argument, */
7628 int signalnum
; /* some compilers complain in signal calls. */
7631 /* Must preserve main program's value of errno. */
7632 int old_errno
= errno
;
7634 #if defined (USG) && !defined (POSIX_SIGNALS)
7635 if (!read_socket_hook
&& NILP (Vwindow_system
))
7637 /* USG systems forget handlers when they are used;
7638 must reestablish each time */
7639 signal (SIGINT
, interrupt_signal
);
7640 signal (SIGQUIT
, interrupt_signal
);
7646 if (!NILP (Vquit_flag
)
7647 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
7649 /* If SIGINT isn't blocked, don't let us be interrupted by
7650 another SIGINT, it might be harmful due to non-reentrancy
7651 in I/O functions. */
7652 sigblock (sigmask (SIGINT
));
7657 #ifdef SIGTSTP /* Support possible in later USG versions */
7659 * On systems which can suspend the current process and return to the original
7660 * shell, this command causes the user to end up back at the shell.
7661 * The "Auto-save" and "Abort" questions are not asked until
7662 * the user elects to return to emacs, at which point he can save the current
7663 * job and either dump core or continue.
7668 if (sys_suspend () == -1)
7670 printf ("Not running as a subprocess;\n");
7671 printf ("you can continue or abort.\n");
7674 /* Perhaps should really fork an inferior shell?
7675 But that would not provide any way to get back
7676 to the original shell, ever. */
7677 printf ("No support for stopping a process on this operating system;\n");
7678 printf ("you can continue or abort.\n");
7679 #endif /* not VMS */
7680 #endif /* not SIGTSTP */
7682 /* We must remain inside the screen area when the internal terminal
7683 is used. Note that [Enter] is not echoed by dos. */
7686 /* It doesn't work to autosave while GC is in progress;
7687 the code used for auto-saving doesn't cope with the mark bit. */
7688 if (!gc_in_progress
)
7690 printf ("Auto-save? (y or n) ");
7692 if (((c
= getchar ()) & ~040) == 'Y')
7694 Fdo_auto_save (Qt
, Qnil
);
7696 printf ("\r\nAuto-save done");
7697 #else /* not MSDOS */
7698 printf ("Auto-save done\n");
7699 #endif /* not MSDOS */
7701 while (c
!= '\n') c
= getchar ();
7705 /* During GC, it must be safe to reenable quitting again. */
7706 Vinhibit_quit
= Qnil
;
7709 #endif /* not MSDOS */
7710 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7711 printf ("but will instead do a real quit after garbage collection ends\r\n");
7716 printf ("\r\nAbort? (y or n) ");
7717 #else /* not MSDOS */
7719 printf ("Abort (and enter debugger)? (y or n) ");
7721 printf ("Abort (and dump core)? (y or n) ");
7722 #endif /* not VMS */
7723 #endif /* not MSDOS */
7725 if (((c
= getchar ()) & ~040) == 'Y')
7727 while (c
!= '\n') c
= getchar ();
7729 printf ("\r\nContinuing...\r\n");
7730 #else /* not MSDOS */
7731 printf ("Continuing...\n");
7732 #endif /* not MSDOS */
7739 /* If executing a function that wants to be interrupted out of
7740 and the user has not deferred quitting by binding `inhibit-quit'
7741 then quit right away. */
7742 if (immediate_quit
&& NILP (Vinhibit_quit
))
7746 Fsignal (Qquit
, Qnil
);
7749 /* Else request quit when it's safe */
7753 if (waiting_for_input
&& !echoing
)
7754 quit_throw_to_read_char ();
7759 /* Handle a C-g by making read_char return C-g. */
7761 quit_throw_to_read_char ()
7763 quit_error_check ();
7765 /* Prevent another signal from doing this before we finish. */
7766 clear_waiting_for_input ();
7769 Vunread_command_events
= Qnil
;
7770 unread_command_char
= -1;
7772 #if 0 /* Currently, sit_for is called from read_char without turning
7773 off polling. And that can call set_waiting_for_input.
7774 It seems to be harmless. */
7775 #ifdef POLL_FOR_INPUT
7776 /* May be > 1 if in recursive minibuffer. */
7777 if (poll_suppress_count
== 0)
7781 if (FRAMEP (internal_last_event_frame
)
7782 && XFRAME (internal_last_event_frame
) != selected_frame
)
7783 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7786 _longjmp (getcjmp
, 1);
7789 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7790 "Set mode of reading keyboard input.\n\
7791 First arg INTERRUPT non-nil means use input interrupts;\n\
7792 nil means use CBREAK mode.\n\
7793 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7794 (no effect except in CBREAK mode).\n\
7795 Third arg META t means accept 8-bit input (for a Meta key).\n\
7796 META nil means ignore the top bit, on the assumption it is parity.\n\
7797 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7798 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7799 See also `current-input-mode'.")
7800 (interrupt
, flow
, meta
, quit
)
7801 Lisp_Object interrupt
, flow
, meta
, quit
;
7804 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7805 error ("set-input-mode: QUIT must be an ASCII character");
7807 #ifdef POLL_FOR_INPUT
7812 /* this causes startup screen to be restored and messes with the mouse */
7817 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7818 if (read_socket_hook
)
7820 /* When using X, don't give the user a real choice,
7821 because we haven't implemented the mechanisms to support it. */
7822 #ifdef NO_SOCK_SIGIO
7823 interrupt_input
= 0;
7824 #else /* not NO_SOCK_SIGIO */
7825 interrupt_input
= 1;
7826 #endif /* NO_SOCK_SIGIO */
7829 interrupt_input
= !NILP (interrupt
);
7830 #else /* not SIGIO */
7831 interrupt_input
= 0;
7832 #endif /* not SIGIO */
7834 /* Our VMS input only works by interrupts, as of now. */
7836 interrupt_input
= 1;
7839 flow_control
= !NILP (flow
);
7842 else if (EQ (meta
, Qt
))
7847 /* Don't let this value be out of range. */
7848 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7854 #ifdef POLL_FOR_INPUT
7855 poll_suppress_count
= 1;
7861 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7862 "Return information about the way Emacs currently reads keyboard input.\n\
7863 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7864 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7865 nil, Emacs is using CBREAK mode.\n\
7866 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7867 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7868 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7869 META nil means ignoring the top bit, on the assumption it is parity.\n\
7870 META is neither t nor nil if accepting 8-bit input and using\n\
7871 all 8 bits as the character code.\n\
7872 QUIT is the character Emacs currently uses to quit.\n\
7873 The elements of this list correspond to the arguments of\n\
7879 val
[0] = interrupt_input
? Qt
: Qnil
;
7880 val
[1] = flow_control
? Qt
: Qnil
;
7881 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7882 XSETFASTINT (val
[3], quit_char
);
7884 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7889 * Set up a new kboard object with reasonable initial values.
7895 kb
->Voverriding_terminal_local_map
= Qnil
;
7896 kb
->Vlast_command
= Qnil
;
7897 kb
->Vprefix_arg
= Qnil
;
7898 kb
->kbd_queue
= Qnil
;
7899 kb
->kbd_queue_has_data
= 0;
7900 kb
->immediate_echo
= 0;
7901 kb
->echoptr
= kb
->echobuf
;
7902 kb
->echo_after_prompt
= -1;
7903 kb
->kbd_macro_buffer
= 0;
7904 kb
->kbd_macro_bufsize
= 0;
7905 kb
->defining_kbd_macro
= Qnil
;
7906 kb
->Vlast_kbd_macro
= Qnil
;
7907 kb
->reference_count
= 0;
7908 kb
->Vsystem_key_alist
= Qnil
;
7909 kb
->system_key_syms
= Qnil
;
7910 kb
->Vdefault_minibuffer_frame
= Qnil
;
7914 * Destroy the contents of a kboard object, but not the object itself.
7915 * We use this just before deleting it, or if we're going to initialize
7922 if (kb
->kbd_macro_buffer
)
7923 xfree (kb
->kbd_macro_buffer
);
7932 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7935 *kbp
= kb
->next_kboard
;
7943 /* This is correct before outermost invocation of the editor loop */
7944 command_loop_level
= -1;
7946 quit_char
= Ctl ('g');
7947 Vunread_command_events
= Qnil
;
7948 unread_command_char
= -1;
7949 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
7951 recent_keys_index
= 0;
7952 kbd_fetch_ptr
= kbd_buffer
;
7953 kbd_store_ptr
= kbd_buffer
;
7954 kbd_buffer_frame_or_window
7955 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7957 do_mouse_tracking
= Qnil
;
7961 /* This means that command_loop_1 won't try to select anything the first
7963 internal_last_event_frame
= Qnil
;
7964 Vlast_event_frame
= internal_last_event_frame
;
7967 current_kboard
= initial_kboard
;
7969 wipe_kboard (current_kboard
);
7970 init_kboard (current_kboard
);
7973 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7975 kbd_buffer_frame_or_window
7976 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7977 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
7979 signal (SIGINT
, interrupt_signal
);
7980 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
7981 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7982 SIGQUIT and we can't tell which one it will give us. */
7983 signal (SIGQUIT
, interrupt_signal
);
7984 #endif /* HAVE_TERMIO */
7986 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7988 if (!noninteractive
)
7989 signal (SIGIO
, input_available_signal
);
7992 /* Use interrupt input by default, if it works and noninterrupt input
7993 has deficiencies. */
7995 #ifdef INTERRUPT_INPUT
7996 interrupt_input
= 1;
7998 interrupt_input
= 0;
8001 /* Our VMS input only works by interrupts, as of now. */
8003 interrupt_input
= 1;
8009 if (keyboard_init_hook
)
8010 (*keyboard_init_hook
) ();
8012 #ifdef POLL_FOR_INPUT
8013 poll_suppress_count
= 1;
8018 /* This type's only use is in syms_of_keyboard, to initialize the
8019 event header symbols and put properties on them. */
8026 struct event_head head_table
[] = {
8027 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
8028 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
8029 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
8030 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
8031 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
8032 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
8037 Qtimer_event_handler
= intern ("timer-event-handler");
8038 staticpro (&Qtimer_event_handler
);
8040 Qdisabled_command_hook
= intern ("disabled-command-hook");
8041 staticpro (&Qdisabled_command_hook
);
8043 Qself_insert_command
= intern ("self-insert-command");
8044 staticpro (&Qself_insert_command
);
8046 Qforward_char
= intern ("forward-char");
8047 staticpro (&Qforward_char
);
8049 Qbackward_char
= intern ("backward-char");
8050 staticpro (&Qbackward_char
);
8052 Qdisabled
= intern ("disabled");
8053 staticpro (&Qdisabled
);
8055 Qundefined
= intern ("undefined");
8056 staticpro (&Qundefined
);
8058 Qpre_command_hook
= intern ("pre-command-hook");
8059 staticpro (&Qpre_command_hook
);
8061 Qpost_command_hook
= intern ("post-command-hook");
8062 staticpro (&Qpost_command_hook
);
8064 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
8065 staticpro (&Qpost_command_idle_hook
);
8067 Qdeferred_action_function
= intern ("deferred-action-function");
8068 staticpro (&Qdeferred_action_function
);
8070 Qcommand_hook_internal
= intern ("command-hook-internal");
8071 staticpro (&Qcommand_hook_internal
);
8073 Qfunction_key
= intern ("function-key");
8074 staticpro (&Qfunction_key
);
8075 Qmouse_click
= intern ("mouse-click");
8076 staticpro (&Qmouse_click
);
8078 Qmouse_wheel
= intern ("mouse-wheel");
8079 staticpro (&Qmouse_wheel
);
8082 Qmenu_enable
= intern ("menu-enable");
8083 staticpro (&Qmenu_enable
);
8085 Qmode_line
= intern ("mode-line");
8086 staticpro (&Qmode_line
);
8087 Qvertical_line
= intern ("vertical-line");
8088 staticpro (&Qvertical_line
);
8089 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
8090 staticpro (&Qvertical_scroll_bar
);
8091 Qmenu_bar
= intern ("menu-bar");
8092 staticpro (&Qmenu_bar
);
8094 Qabove_handle
= intern ("above-handle");
8095 staticpro (&Qabove_handle
);
8096 Qhandle
= intern ("handle");
8097 staticpro (&Qhandle
);
8098 Qbelow_handle
= intern ("below-handle");
8099 staticpro (&Qbelow_handle
);
8100 Qup
= intern ("up");
8102 Qdown
= intern ("down");
8105 Qevent_kind
= intern ("event-kind");
8106 staticpro (&Qevent_kind
);
8107 Qevent_symbol_elements
= intern ("event-symbol-elements");
8108 staticpro (&Qevent_symbol_elements
);
8109 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
8110 staticpro (&Qevent_symbol_element_mask
);
8111 Qmodifier_cache
= intern ("modifier-cache");
8112 staticpro (&Qmodifier_cache
);
8114 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
8115 staticpro (&Qrecompute_lucid_menubar
);
8116 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
8117 staticpro (&Qactivate_menubar_hook
);
8119 Qpolling_period
= intern ("polling-period");
8120 staticpro (&Qpolling_period
);
8123 struct event_head
*p
;
8125 for (p
= head_table
;
8126 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
8129 *p
->var
= intern (p
->name
);
8131 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
8132 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
8136 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
8137 staticpro (&button_down_location
);
8141 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
8143 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
8144 for (i
= 0; i
< len
; i
++)
8145 if (modifier_names
[i
])
8146 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
8147 staticpro (&modifier_symbols
);
8150 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
8151 staticpro (&recent_keys
);
8153 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
8154 staticpro (&this_command_keys
);
8156 Qextended_command_history
= intern ("extended-command-history");
8157 Fset (Qextended_command_history
, Qnil
);
8158 staticpro (&Qextended_command_history
);
8160 kbd_buffer_frame_or_window
8161 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8162 staticpro (&kbd_buffer_frame_or_window
);
8164 accent_key_syms
= Qnil
;
8165 staticpro (&accent_key_syms
);
8167 func_key_syms
= Qnil
;
8168 staticpro (&func_key_syms
);
8171 staticpro (&mouse_syms
);
8174 mouse_wheel_syms
= Qnil
;
8175 staticpro (&mouse_wheel_syms
);
8178 unread_switch_frame
= Qnil
;
8179 staticpro (&unread_switch_frame
);
8181 internal_last_event_frame
= Qnil
;
8182 staticpro (&internal_last_event_frame
);
8184 read_key_sequence_cmd
= Qnil
;
8185 staticpro (&read_key_sequence_cmd
);
8187 defsubr (&Sevent_convert_list
);
8188 defsubr (&Sread_key_sequence
);
8189 defsubr (&Srecursive_edit
);
8191 defsubr (&Strack_mouse
);
8193 defsubr (&Sinput_pending_p
);
8194 defsubr (&Scommand_execute
);
8195 defsubr (&Srecent_keys
);
8196 defsubr (&Sthis_command_keys
);
8197 defsubr (&Sthis_single_command_keys
);
8198 defsubr (&Sreset_this_command_lengths
);
8199 defsubr (&Ssuspend_emacs
);
8200 defsubr (&Sabort_recursive_edit
);
8201 defsubr (&Sexit_recursive_edit
);
8202 defsubr (&Srecursion_depth
);
8203 defsubr (&Stop_level
);
8204 defsubr (&Sdiscard_input
);
8205 defsubr (&Sopen_dribble_file
);
8206 defsubr (&Sset_input_mode
);
8207 defsubr (&Scurrent_input_mode
);
8208 defsubr (&Sexecute_extended_command
);
8210 DEFVAR_LISP ("last-command-char", &last_command_char
,
8211 "Last input event that was part of a command.");
8213 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
8214 "Last input event that was part of a command.");
8216 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
8217 "Last input event in a command, except for mouse menu events.\n\
8218 Mouse menus give back keys that don't look like mouse events;\n\
8219 this variable holds the actual mouse event that led to the menu,\n\
8220 so that you can determine whether the command was run by mouse or not.");
8222 DEFVAR_LISP ("last-input-char", &last_input_char
,
8223 "Last input event.");
8225 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
8226 "Last input event.");
8228 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
8229 "List of objects to be read as next command input events.");
8231 DEFVAR_INT ("unread-command-char", &unread_command_char
,
8232 "If not -1, an object to be read as next command input event.");
8234 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
8235 "Meta-prefix character code. Meta-foo as command input\n\
8236 turns into this character followed by foo.");
8237 XSETINT (meta_prefix_char
, 033);
8239 DEFVAR_KBOARD ("last-command", Vlast_command
,
8240 "The last command executed. Normally a symbol with a function definition,\n\
8241 but can be whatever was found in the keymap, or whatever the variable\n\
8242 `this-command' was set to by that command.\n\
8244 The value `mode-exit' is special; it means that the previous command\n\
8245 read an event that told it to exit, and it did so and unread that event.\n\
8246 In other words, the present command is the event that made the previous\n\
8249 The value `kill-region' is special; it means that the previous command\n\
8250 was a kill command.");
8252 DEFVAR_LISP ("this-command", &this_command
,
8253 "The command now being executed.\n\
8254 The command can set this variable; whatever is put here\n\
8255 will be in `last-command' during the following command.");
8256 this_command
= Qnil
;
8258 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8259 "*Number of keyboard input characters between auto-saves.\n\
8260 Zero means disable autosaving due to number of characters typed.");
8261 auto_save_interval
= 300;
8263 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8264 "*Number of seconds idle time before auto-save.\n\
8265 Zero or nil means disable auto-saving due to idleness.\n\
8266 After auto-saving due to this many seconds of idle time,\n\
8267 Emacs also does a garbage collection if that seems to be warranted.");
8268 XSETFASTINT (Vauto_save_timeout
, 30);
8270 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8271 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8272 echo_keystrokes
= 1;
8274 DEFVAR_INT ("polling-period", &polling_period
,
8275 "*Interval between polling for input during Lisp execution.\n\
8276 The reason for polling is to make C-g work to stop a running program.\n\
8277 Polling is needed only when using X windows and SIGIO does not work.\n\
8278 Polling is automatically disabled in all other cases.");
8281 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8282 "*Maximum time between mouse clicks to make a double-click.\n\
8283 Measured in milliseconds. nil means disable double-click recognition;\n\
8284 t means double-clicks have no time limit and are detected\n\
8285 by position only.");
8286 Vdouble_click_time
= make_number (500);
8288 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8289 "*Non-nil means inhibit local map menu bar menus.");
8290 inhibit_local_menu_bar_menus
= 0;
8292 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8293 "Number of complete key sequences read as input so far.\n\
8294 This includes key sequences read from keyboard macros.\n\
8295 The number is effectively the number of interactive command invocations.");
8298 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
8299 "Number of input events read from the keyboard so far.\n\
8300 This does not include events generated by keyboard macros.");
8301 num_nonmacro_input_events
= 0;
8303 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8304 "The frame in which the most recently read event occurred.\n\
8305 If the last event came from a keyboard macro, this is set to `macro'.");
8306 Vlast_event_frame
= Qnil
;
8308 /* This variable is set up in sysdep.c. */
8309 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
8310 "The ERASE character as set by the user with stty.");
8312 DEFVAR_LISP ("help-char", &Vhelp_char
,
8313 "Character to recognize as meaning Help.\n\
8314 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8315 If the value of `help-form' is nil, this char can be read normally.");
8316 XSETINT (Vhelp_char
, Ctl ('H'));
8318 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8319 "List of input events to recognize as meaning Help.\n\
8320 These work just like the value of `help-char' (see that).");
8321 Vhelp_event_list
= Qnil
;
8323 DEFVAR_LISP ("help-form", &Vhelp_form
,
8324 "Form to execute when character `help-char' is read.\n\
8325 If the form returns a string, that string is displayed.\n\
8326 If `help-form' is nil, the help char is not recognized.");
8329 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8330 "Command to run when `help-char' character follows a prefix key.\n\
8331 This command is used only when there is no actual binding\n\
8332 for that character after that prefix key.");
8333 Vprefix_help_command
= Qnil
;
8335 DEFVAR_LISP ("top-level", &Vtop_level
,
8336 "Form to evaluate when Emacs starts up.\n\
8337 Useful to set before you dump a modified Emacs.");
8340 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8341 "Translate table for keyboard input, or nil.\n\
8342 Each character is looked up in this string and the contents used instead.\n\
8343 The value may be a string, a vector, or a char-table.\n\
8344 If it is a string or vector of length N,\n\
8345 character codes N and up are untranslated.\n\
8346 In a vector or a char-table, an element which is nil means \"no translation\".");
8347 Vkeyboard_translate_table
= Qnil
;
8349 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8350 "Non-nil means to always spawn a subshell instead of suspending,\n\
8351 even if the operating system has support for stopping a process.");
8354 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8355 "Non-nil means prompt with menus when appropriate.\n\
8356 This is done when reading from a keymap that has a prompt string,\n\
8357 for elements that have prompt strings.\n\
8358 The menu is displayed on the screen\n\
8359 if X menus were enabled at configuration\n\
8360 time and the previous event was a mouse click prefix key.\n\
8361 Otherwise, menu prompting uses the echo area.");
8364 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8365 "Character to see next line of menu prompt.\n\
8366 Type this character while in a menu prompt to rotate around the lines of it.");
8367 XSETINT (menu_prompt_more_char
, ' ');
8369 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8370 "A mask of additional modifier keys to use with every keyboard character.\n\
8371 Emacs applies the modifiers of the character stored here to each keyboard\n\
8372 character it reads. For example, after evaluating the expression\n\
8373 (setq extra-keyboard-modifiers ?\\C-x)\n\
8374 all input characters will have the control modifier applied to them.\n\
8376 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8377 not count as a control character; rather, it counts as a character\n\
8378 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8379 cancels any modification.");
8380 extra_keyboard_modifiers
= 0;
8382 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8383 "If an editing command sets this to t, deactivate the mark afterward.\n\
8384 The command loop sets this to nil before each command,\n\
8385 and tests the value when the command returns.\n\
8386 Buffer modification stores t in this variable.");
8387 Vdeactivate_mark
= Qnil
;
8389 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8390 "Temporary storage of pre-command-hook or post-command-hook.");
8391 Vcommand_hook_internal
= Qnil
;
8393 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8394 "Normal hook run before each command is executed.\n\
8395 Errors running the hook are caught and ignored.");
8396 Vpre_command_hook
= Qnil
;
8398 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8399 "Normal hook run after each command is executed.\n\
8400 Errors running the hook are caught and ignored.");
8401 Vpost_command_hook
= Qnil
;
8403 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8404 "Normal hook run after each command is executed, if idle.\n\
8405 Errors running the hook are caught and ignored.\n\
8406 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
8407 Vpost_command_idle_hook
= Qnil
;
8409 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
8410 "Delay time before running `post-command-idle-hook'.\n\
8411 This is measured in microseconds.");
8412 post_command_idle_delay
= 100000;
8415 DEFVAR_LISP ("echo-area-clear-hook", ...,
8416 "Normal hook run when clearing the echo area.");
8418 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
8419 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
8421 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
8422 "t means menu bar, specified Lucid style, needs to be recomputed.");
8423 Vlucid_menu_bar_dirty_flag
= Qnil
;
8425 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
8426 "List of menu bar items to move to the end of the menu bar.\n\
8427 The elements of the list are event types that may have menu bar bindings.");
8428 Vmenu_bar_final_items
= Qnil
;
8430 DEFVAR_KBOARD ("overriding-terminal-local-map",
8431 Voverriding_terminal_local_map
,
8432 "Per-terminal keymap that overrides all other local keymaps.\n\
8433 If this variable is non-nil, it is used as a keymap instead of the\n\
8434 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
8435 This variable is intended to let commands such as `universal-argumemnt'\n\
8436 set up a different keymap for reading the next command.");
8438 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
8439 "Keymap that overrides all other local keymaps.\n\
8440 If this variable is non-nil, it is used as a keymap instead of the\n\
8441 buffer's local map, and the minor mode keymaps and text property keymaps.");
8442 Voverriding_local_map
= Qnil
;
8444 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
8445 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8446 Otherwise, the menu bar continues to reflect the buffer's local map\n\
8447 and the minor mode maps regardless of `overriding-local-map'.");
8448 Voverriding_local_map_menu_flag
= Qnil
;
8450 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
8451 "Keymap defining bindings for special events to execute at low level.");
8452 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
8454 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
8455 "*Non-nil means generate motion events for mouse motion.");
8457 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
8458 "Alist of system-specific X windows key symbols.\n\
8459 Each element should have the form (N . SYMBOL) where N is the\n\
8460 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
8461 and SYMBOL is its name.");
8463 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
8464 "List of deferred actions to be performed at a later time.\n\
8465 The precise format isn't relevant here; we just check whether it is nil.");
8466 Vdeferred_action_list
= Qnil
;
8468 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
8469 "Function to call to handle deferred actions, after each command.\n\
8470 This function is called with no arguments after each command\n\
8471 whenever `deferred-action-list' is non-nil.");
8472 Vdeferred_action_function
= Qnil
;
8474 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
8475 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8476 The value can be a length of time to show the message for.\n\
8477 If the value is non-nil and not a number, we wait 2 seconds.");
8478 Vsuggest_key_bindings
= Qt
;
8480 DEFVAR_LISP ("timer-list", &Vtimer_list
,
8481 "List of active absolute time timers in order of increasing time");
8484 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
8485 "List of active idle-time timers in order of increasing time");
8486 Vtimer_idle_list
= Qnil
;
8491 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
8492 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
8493 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
8494 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
8495 initial_define_key (meta_map
, 'x', "execute-extended-command");
8497 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
8498 "handle-delete-frame");
8499 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
8501 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",