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"
40 #include "intervals.h"
41 #include "blockinput.h"
50 #include <sys/ioctl.h>
52 #endif /* not MSDOS */
54 #include "syssignal.h"
57 /* This is to get the definitions of the XK_ symbols. */
64 #endif /* HAVE_NTGUI */
66 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
71 /* Variables for blockinput.h: */
73 /* Non-zero if interrupt input is blocked right now. */
74 int interrupt_input_blocked
;
76 /* Nonzero means an input interrupt has arrived
77 during the current critical section. */
78 int interrupt_input_pending
;
81 /* File descriptor to use for input. */
84 #ifdef HAVE_WINDOW_SYSTEM
85 /* Make all keyboard buffers much bigger when using X windows. */
86 #define KBD_BUFFER_SIZE 4096
87 #else /* No X-windows, character input */
88 #define KBD_BUFFER_SIZE 256
89 #endif /* No X-windows */
91 /* Following definition copied from eval.c */
95 struct backtrace
*next
;
96 Lisp_Object
*function
;
97 Lisp_Object
*args
; /* Points to vector of args. */
98 int nargs
; /* length of vector. If nargs is UNEVALLED,
99 args points to slot holding list of
105 KBOARD
*initial_kboard
;
106 KBOARD
*current_kboard
;
110 KBOARD the_only_kboard
;
113 /* Non-nil disable property on a command means
114 do not execute it; call disabled-command-hook's value instead. */
115 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
117 #define NUM_RECENT_KEYS (100)
118 int recent_keys_index
; /* Index for storing next element into recent_keys */
119 int total_keys
; /* Total number of elements stored into recent_keys */
120 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
122 /* Vector holding the key sequence that invoked the current command.
123 It is reused for each command, and it may be longer than the current
124 sequence; this_command_key_count indicates how many elements
125 actually mean something.
126 It's easier to staticpro a single Lisp_Object than an array. */
127 Lisp_Object this_command_keys
;
128 int this_command_key_count
;
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 int this_single_command_key_start
;
134 /* Record values of this_command_key_count and echo_length ()
135 before this command was read. */
136 static int before_command_key_count
;
137 static int before_command_echo_length
;
138 /* Values of before_command_key_count and before_command_echo_length
139 saved by reset-this-command-lengths. */
140 static int before_command_key_count_1
;
141 static int before_command_echo_length_1
;
142 /* Flag set by reset-this-command-lengths,
143 saying to reset the lengths when add_command_key is called. */
144 static int before_command_restore_flag
;
146 extern int minbuf_level
;
148 extern int message_enable_multibyte
;
150 extern struct backtrace
*backtrace_list
;
152 /* Nonzero means do menu prompting. */
153 static int menu_prompting
;
155 /* Character to see next line of menu prompt. */
156 static Lisp_Object menu_prompt_more_char
;
158 /* For longjmp to where kbd input is being done. */
159 static jmp_buf getcjmp
;
161 /* True while doing kbd input. */
162 int waiting_for_input
;
164 /* True while displaying for echoing. Delays C-g throwing. */
167 /* True means we can start echoing at the next input pause
168 even though there is something in the echo area. */
169 static char *ok_to_echo_at_next_pause
;
171 /* Nonzero means disregard local maps for the menu bar. */
172 static int inhibit_local_menu_bar_menus
;
174 /* Nonzero means C-g should cause immediate error-signal. */
177 /* The user's ERASE setting. */
178 Lisp_Object Vtty_erase_char
;
180 /* Character to recognize as the help char. */
181 Lisp_Object Vhelp_char
;
183 /* List of other event types to recognize as meaning "help". */
184 Lisp_Object Vhelp_event_list
;
186 /* Form to execute when help char is typed. */
187 Lisp_Object Vhelp_form
;
189 /* Command to run when the help character follows a prefix key. */
190 Lisp_Object Vprefix_help_command
;
192 /* List of items that should move to the end of the menu bar. */
193 Lisp_Object Vmenu_bar_final_items
;
195 /* Non-nil means show the equivalent key-binding for
196 any M-x command that has one.
197 The value can be a length of time to show the message for.
198 If the value is non-nil and not a number, we wait 2 seconds. */
199 Lisp_Object Vsuggest_key_bindings
;
201 /* Character that causes a quit. Normally C-g.
203 If we are running on an ordinary terminal, this must be an ordinary
204 ASCII char, since we want to make it our interrupt character.
206 If we are not running on an ordinary terminal, it still needs to be
207 an ordinary ASCII char. This character needs to be recognized in
208 the input interrupt handler. At this point, the keystroke is
209 represented as a struct input_event, while the desired quit
210 character is specified as a lispy event. The mapping from struct
211 input_events to lispy events cannot run in an interrupt handler,
212 and the reverse mapping is difficult for anything but ASCII
215 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
219 extern Lisp_Object current_global_map
;
220 extern int minibuf_level
;
222 /* If non-nil, this is a map that overrides all other local maps. */
223 Lisp_Object Voverriding_local_map
;
225 /* If non-nil, Voverriding_local_map applies to the menu bar. */
226 Lisp_Object Voverriding_local_map_menu_flag
;
228 /* Keymap that defines special misc events that should
229 be processed immediately at a low level. */
230 Lisp_Object Vspecial_event_map
;
232 /* Current depth in recursive edits. */
233 int command_loop_level
;
235 /* Total number of times command_loop has read a key sequence. */
238 /* Last input character read as a command. */
239 Lisp_Object last_command_char
;
241 /* Last input character read as a command, not counting menus
242 reached by the mouse. */
243 Lisp_Object last_nonmenu_event
;
245 /* Last input character read for any purpose. */
246 Lisp_Object last_input_char
;
248 /* If not Qnil, a list of objects to be read as subsequent command input. */
249 Lisp_Object Vunread_command_events
;
251 /* If not -1, an event to be read as subsequent command input. */
252 int unread_command_char
;
254 /* If not Qnil, this is a switch-frame event which we decided to put
255 off until the end of a key sequence. This should be read as the
256 next command input, after any unread_command_events.
258 read_key_sequence uses this to delay switch-frame events until the
259 end of the key sequence; Fread_char uses it to put off switch-frame
260 events until a non-ASCII event is acceptable as input. */
261 Lisp_Object unread_switch_frame
;
263 /* A mask of extra modifier bits to put into every keyboard char. */
264 int extra_keyboard_modifiers
;
266 /* Char to use as prefix when a meta character is typed in.
267 This is bound on entry to minibuffer in case ESC is changed there. */
269 Lisp_Object meta_prefix_char
;
271 /* Last size recorded for a current buffer which is not a minibuffer. */
272 static int last_non_minibuf_size
;
274 /* Number of idle seconds before an auto-save and garbage collection. */
275 static Lisp_Object Vauto_save_timeout
;
277 /* Total number of times read_char has returned. */
278 int num_input_events
;
280 /* Total number of times read_char has returned, outside of macros. */
281 int num_nonmacro_input_events
;
283 /* Auto-save automatically when this many characters have been typed
284 since the last time. */
286 static int auto_save_interval
;
288 /* Value of num_nonmacro_input_events as of last auto save. */
292 /* The command being executed by the command loop.
293 Commands may set this, and the value set will be copied into
294 current_kboard->Vlast_command instead of the actual command. */
295 Lisp_Object this_command
;
297 /* The value of point when the last command was executed. */
298 int last_point_position
;
300 /* The buffer that was current when the last command was started. */
301 Lisp_Object last_point_position_buffer
;
303 /* The frame in which the last input event occurred, or Qmacro if the
304 last event came from a macro. We use this to determine when to
305 generate switch-frame events. This may be cleared by functions
306 like Fselect_frame, to make sure that a switch-frame event is
307 generated by the next character. */
308 Lisp_Object internal_last_event_frame
;
310 /* A user-visible version of the above, intended to allow users to
311 figure out where the last event came from, if the event doesn't
312 carry that information itself (i.e. if it was a character). */
313 Lisp_Object Vlast_event_frame
;
315 /* The timestamp of the last input event we received from the X server.
316 X Windows wants this for selection ownership. */
317 unsigned long last_event_timestamp
;
319 Lisp_Object Qself_insert_command
;
320 Lisp_Object Qforward_char
;
321 Lisp_Object Qbackward_char
;
322 Lisp_Object Qundefined
;
323 Lisp_Object Qtimer_event_handler
;
325 /* read_key_sequence stores here the command definition of the
326 key sequence that it reads. */
327 Lisp_Object read_key_sequence_cmd
;
329 /* Form to evaluate (if non-nil) when Emacs is started. */
330 Lisp_Object Vtop_level
;
332 /* User-supplied string to translate input characters through. */
333 Lisp_Object Vkeyboard_translate_table
;
335 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
336 extern Lisp_Object Vfunction_key_map
;
338 /* Another keymap that maps key sequences into key sequences.
339 This one takes precedence over ordinary definitions. */
340 extern Lisp_Object Vkey_translation_map
;
342 /* Non-nil means deactivate the mark at end of this command. */
343 Lisp_Object Vdeactivate_mark
;
345 /* Menu bar specified in Lucid Emacs fashion. */
347 Lisp_Object Vlucid_menu_bar_dirty_flag
;
348 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
350 Lisp_Object Qecho_area_clear_hook
;
352 /* Hooks to run before and after each command. */
353 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
354 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
355 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
356 /* Hook run after a command if there's no more input soon. */
357 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
359 /* Delay time in microseconds before running post-command-idle-hook. */
360 int post_command_idle_delay
;
362 /* List of deferred actions to be performed at a later time.
363 The precise format isn't relevant here; we just check whether it is nil. */
364 Lisp_Object Vdeferred_action_list
;
366 /* Function to call to handle deferred actions, when there are any. */
367 Lisp_Object Vdeferred_action_function
;
368 Lisp_Object Qdeferred_action_function
;
370 /* File in which we write all commands we read. */
373 /* Nonzero if input is available. */
376 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
377 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
381 extern char *pending_malloc_warning
;
383 /* Circular buffer for pre-read keyboard input. */
384 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
386 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
388 The interrupt-level event handlers will never enqueue an event on a
389 frame which is not in Vframe_list, and once an event is dequeued,
390 internal_last_event_frame or the event itself points to the frame.
393 But while the event is sitting in the queue, it's completely
394 unprotected. Suppose the user types one command which will run for
395 a while and then delete a frame, and then types another event at
396 the frame that will be deleted, before the command gets around to
397 it. Suppose there are no references to this frame elsewhere in
398 Emacs, and a GC occurs before the second event is dequeued. Now we
399 have an event referring to a freed frame, which will crash Emacs
402 Similar things happen when an event on a scroll bar is enqueued; the
403 window may be deleted while the event is in the queue.
405 So, we use this vector to protect the frame_or_window field in the
406 event queue. That way, they'll be dequeued as dead frames or
407 windows, but still valid lisp objects.
409 If kbd_buffer[i].kind != no_event, then
410 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
411 == kbd_buffer[i].frame_or_window. */
412 static Lisp_Object kbd_buffer_frame_or_window
;
414 /* Pointer to next available character in kbd_buffer.
415 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
416 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
417 next available char is in kbd_buffer[0]. */
418 static struct input_event
*kbd_fetch_ptr
;
420 /* Pointer to next place to store character in kbd_buffer. This
421 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
422 character should go in kbd_buffer[0]. */
423 static volatile struct input_event
*kbd_store_ptr
;
425 /* The above pair of variables forms a "queue empty" flag. When we
426 enqueue a non-hook event, we increment kbd_store_ptr. When we
427 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
428 there is input available iff the two pointers are not equal.
430 Why not just have a flag set and cleared by the enqueuing and
431 dequeuing functions? Such a flag could be screwed up by interrupts
432 at inopportune times. */
434 /* If this flag is non-nil, we check mouse_moved to see when the
435 mouse moves, and motion events will appear in the input stream.
436 Otherwise, mouse motion is ignored. */
437 static Lisp_Object do_mouse_tracking
;
439 /* Symbols to head events. */
440 Lisp_Object Qmouse_movement
;
441 Lisp_Object Qscroll_bar_movement
;
442 Lisp_Object Qswitch_frame
;
443 Lisp_Object Qdelete_frame
;
444 Lisp_Object Qiconify_frame
;
445 Lisp_Object Qmake_frame_visible
;
447 /* Symbols to denote kinds of events. */
448 Lisp_Object Qfunction_key
;
449 Lisp_Object Qmouse_click
;
451 Lisp_Object Qmouse_wheel
;
453 /* Lisp_Object Qmouse_movement; - also an event header */
455 /* Properties of event headers. */
456 Lisp_Object Qevent_kind
;
457 Lisp_Object Qevent_symbol_elements
;
459 Lisp_Object Qmenu_enable
;
461 /* An event header symbol HEAD may have a property named
462 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
463 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
464 mask of modifiers applied to it. If present, this is used to help
465 speed up parse_modifiers. */
466 Lisp_Object Qevent_symbol_element_mask
;
468 /* An unmodified event header BASE may have a property named
469 Qmodifier_cache, which is an alist mapping modifier masks onto
470 modified versions of BASE. If present, this helps speed up
472 Lisp_Object Qmodifier_cache
;
474 /* Symbols to use for parts of windows. */
475 Lisp_Object Qmode_line
;
476 Lisp_Object Qvertical_line
;
477 Lisp_Object Qvertical_scroll_bar
;
478 Lisp_Object Qmenu_bar
;
480 extern Lisp_Object Qmenu_enable
;
482 Lisp_Object
recursive_edit_unwind (), command_loop ();
483 Lisp_Object
Fthis_command_keys ();
484 Lisp_Object Qextended_command_history
;
485 EMACS_TIME
timer_check ();
487 extern char *x_get_keysym_name ();
489 static void record_menu_key ();
491 void swallow_events ();
493 Lisp_Object Qpolling_period
;
495 /* List of absolute timers. Appears in order of next scheduled event. */
496 Lisp_Object Vtimer_list
;
498 /* List of idle time timers. Appears in order of next scheduled event. */
499 Lisp_Object Vtimer_idle_list
;
501 /* Incremented whenever a timer is run. */
504 extern Lisp_Object Vprint_level
, Vprint_length
;
506 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
508 EMACS_TIME
*input_available_clear_time
;
510 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
511 Default is 1 if INTERRUPT_INPUT is defined. */
514 /* Nonzero while interrupts are temporarily deferred during redisplay. */
515 int interrupts_deferred
;
517 /* Nonzero means use ^S/^Q for flow control. */
520 /* Allow m- file to inhibit use of FIONREAD. */
521 #ifdef BROKEN_FIONREAD
525 /* We are unable to use interrupts if FIONREAD is not available,
526 so flush SIGIO so we won't try. */
533 /* If we support a window system, turn on the code to poll periodically
534 to detect C-g. It isn't actually used when doing interrupt input. */
535 #ifdef HAVE_WINDOW_SYSTEM
536 #define POLL_FOR_INPUT
539 /* Global variable declarations. */
541 /* Function for init_keyboard to call with no args (if nonzero). */
542 void (*keyboard_init_hook
) ();
544 static int read_avail_input ();
545 static void get_input_pending ();
546 static int readable_events ();
547 static Lisp_Object
read_char_x_menu_prompt ();
548 static Lisp_Object
read_char_minibuf_menu_prompt ();
549 static Lisp_Object
make_lispy_event ();
551 static Lisp_Object
make_lispy_movement ();
553 static Lisp_Object
modify_event_symbol ();
554 static Lisp_Object
make_lispy_switch_frame ();
555 static int parse_solitary_modifier ();
557 /* > 0 if we are to echo keystrokes. */
558 static int echo_keystrokes
;
560 /* Nonzero means don't try to suspend even if the operating system seems
562 static int cannot_suspend
;
564 #define min(a,b) ((a)<(b)?(a):(b))
565 #define max(a,b) ((a)>(b)?(a):(b))
567 /* Install the string STR as the beginning of the string of echoing,
568 so that it serves as a prompt for the next character.
569 Also start echoing. */
574 int len
= strlen (str
);
576 if (len
> ECHOBUFSIZE
- 4)
577 len
= ECHOBUFSIZE
- 4;
578 bcopy (str
, current_kboard
->echobuf
, len
);
579 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
580 *current_kboard
->echoptr
= '\0';
582 current_kboard
->echo_after_prompt
= len
;
587 /* Add C to the echo string, if echoing is going on.
588 C can be a character, which is printed prettily ("M-C-x" and all that
589 jazz), or a symbol, whose name is printed. */
594 extern char *push_key_description ();
596 if (current_kboard
->immediate_echo
)
598 char *ptr
= current_kboard
->echoptr
;
600 if (ptr
!= current_kboard
->echobuf
)
603 /* If someone has passed us a composite event, use its head symbol. */
608 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
611 ptr
= push_key_description (XINT (c
), ptr
);
613 else if (SYMBOLP (c
))
615 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
616 if ((ptr
- current_kboard
->echobuf
) + name
->size_byte
+ 4
619 bcopy (name
->data
, ptr
, name
->size_byte
);
620 ptr
+= name
->size_byte
;
623 if (current_kboard
->echoptr
== current_kboard
->echobuf
626 strcpy (ptr
, " (Type ? for further options)");
631 current_kboard
->echoptr
= ptr
;
637 /* Temporarily add a dash to the end of the echo string if it's not
638 empty, so that it serves as a mini-prompt for the very next character. */
642 if (!current_kboard
->immediate_echo
643 && current_kboard
->echoptr
== current_kboard
->echobuf
)
645 /* Do nothing if we just printed a prompt. */
646 if (current_kboard
->echo_after_prompt
647 == current_kboard
->echoptr
- current_kboard
->echobuf
)
649 /* Do nothing if not echoing at all. */
650 if (current_kboard
->echoptr
== 0)
653 /* Put a dash at the end of the buffer temporarily,
654 but make it go away when the next character is added. */
655 current_kboard
->echoptr
[0] = '-';
656 current_kboard
->echoptr
[1] = 0;
661 /* Display the current echo string, and begin echoing if not already
667 if (!current_kboard
->immediate_echo
)
670 current_kboard
->immediate_echo
= 1;
672 for (i
= 0; i
< this_command_key_count
; i
++)
675 c
= XVECTOR (this_command_keys
)->contents
[i
];
676 if (! (EVENT_HAS_PARAMETERS (c
)
677 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
684 message2_nolog (current_kboard
->echobuf
, strlen (current_kboard
->echobuf
),
685 ! NILP (current_buffer
->enable_multibyte_characters
));
689 if (waiting_for_input
&& !NILP (Vquit_flag
))
690 quit_throw_to_read_char ();
693 /* Turn off echoing, for the start of a new command. */
697 current_kboard
->immediate_echo
= 0;
698 current_kboard
->echoptr
= current_kboard
->echobuf
;
699 current_kboard
->echo_after_prompt
= -1;
700 ok_to_echo_at_next_pause
= 0;
703 /* Return the length of the current echo string. */
708 return current_kboard
->echoptr
- current_kboard
->echobuf
;
711 /* Truncate the current echo message to its first LEN chars.
712 This and echo_char get used by read_key_sequence when the user
713 switches frames while entering a key sequence. */
719 current_kboard
->echobuf
[len
] = '\0';
720 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
721 truncate_echo_area (len
);
725 /* Functions for manipulating this_command_keys. */
727 add_command_key (key
)
730 int size
= XVECTOR (this_command_keys
)->size
;
732 /* If reset-this-command-length was called recently, obey it now.
733 See the doc string of that function for an explanation of why. */
734 if (before_command_restore_flag
)
736 this_command_key_count
= before_command_key_count_1
;
737 if (this_command_key_count
< this_single_command_key_start
)
738 this_single_command_key_start
= this_command_key_count
;
739 echo_truncate (before_command_echo_length_1
);
740 before_command_restore_flag
= 0;
743 if (this_command_key_count
>= size
)
745 Lisp_Object new_keys
;
747 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
748 bcopy (XVECTOR (this_command_keys
)->contents
,
749 XVECTOR (new_keys
)->contents
,
750 size
* sizeof (Lisp_Object
));
752 this_command_keys
= new_keys
;
755 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
761 int count
= specpdl_ptr
- specpdl
;
764 if (command_loop_level
> 0)
766 specbind (Qstandard_output
, Qt
);
767 specbind (Qstandard_input
, Qt
);
770 val
= command_loop ();
772 Fsignal (Qquit
, Qnil
);
773 /* Handle throw from read_minibuf when using minibuffer
774 while it's active but we're in another window. */
776 Fsignal (Qerror
, Fcons (val
, Qnil
));
778 return unbind_to (count
, Qnil
);
781 /* When an auto-save happens, record the "time", and don't do again soon. */
786 last_auto_save
= num_nonmacro_input_events
;
789 /* Make an auto save happen as soon as possible at command level. */
791 force_auto_save_soon ()
793 last_auto_save
= - auto_save_interval
- 1;
795 record_asynch_buffer_change ();
798 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
799 "Invoke the editor command loop recursively.\n\
800 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
801 that tells this function to return.\n\
802 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
803 This function is called by the editor initialization to begin editing.")
806 int count
= specpdl_ptr
- specpdl
;
809 command_loop_level
++;
810 update_mode_lines
= 1;
812 record_unwind_protect (recursive_edit_unwind
,
814 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
818 return unbind_to (count
, Qnil
);
822 recursive_edit_unwind (buffer
)
826 Fset_buffer (buffer
);
828 command_loop_level
--;
829 update_mode_lines
= 1;
837 #if 0 /* Theory: if there's anything in Vunread_command_events,
838 it will right away be read by read_key_sequence,
839 and then if we do switch KBOARDS, it will go into the side
840 queue then. So we don't need to do anything special here -- rms. */
841 if (CONSP (Vunread_command_events
))
843 current_kboard
->kbd_queue
844 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
845 current_kboard
->kbd_queue_has_data
= 1;
847 Vunread_command_events
= Qnil
;
853 /* Switch to the single-kboard state, making current_kboard
854 the only KBOARD from which further input is accepted. */
857 single_kboard_state ()
864 /* Maintain a stack of kboards, so other parts of Emacs
865 can switch temporarily to the kboard of a given frame
866 and then revert to the previous status. */
871 struct kboard_stack
*next
;
874 static struct kboard_stack
*kboard_stack
;
877 push_frame_kboard (f
)
881 struct kboard_stack
*p
882 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
884 p
->next
= kboard_stack
;
885 p
->kboard
= current_kboard
;
888 current_kboard
= FRAME_KBOARD (f
);
896 struct kboard_stack
*p
= kboard_stack
;
897 current_kboard
= p
->kboard
;
898 kboard_stack
= p
->next
;
903 /* Handle errors that are not handled at inner levels
904 by printing an error message and returning to the editor command loop. */
910 Lisp_Object old_level
, old_length
;
913 if (!NILP (executing_macro
))
915 if (executing_macro_iterations
== 1)
916 sprintf (macroerror
, "After 1 kbd macro iteration: ");
918 sprintf (macroerror
, "After %d kbd macro iterations: ",
919 executing_macro_iterations
);
924 Vstandard_output
= Qt
;
925 Vstandard_input
= Qt
;
926 Vexecuting_macro
= Qnil
;
927 executing_macro
= Qnil
;
928 current_kboard
->Vprefix_arg
= Qnil
;
931 /* Avoid unquittable loop if data contains a circular list. */
932 old_level
= Vprint_level
;
933 old_length
= Vprint_length
;
934 XSETFASTINT (Vprint_level
, 10);
935 XSETFASTINT (Vprint_length
, 10);
936 cmd_error_internal (data
, macroerror
);
937 Vprint_level
= old_level
;
938 Vprint_length
= old_length
;
942 Vinhibit_quit
= Qnil
;
947 return make_number (0);
950 /* Take actions on handling an error. DATA is the data that describes
953 CONTEXT is a C-string containing ASCII characters only which
954 describes the context in which the error happened. If we need to
955 generalize CONTEXT to allow multibyte characters, make it a Lisp
959 cmd_error_internal (data
, context
)
967 echo_area_glyphs
= 0;
969 /* If the window system or terminal frame hasn't been initialized
970 yet, or we're not interactive, it's best to dump this message out
971 to stderr and exit. */
972 if (! FRAME_MESSAGE_BUF (selected_frame
)
974 stream
= Qexternal_debugging_output
;
983 write_string_1 (context
, -1, stream
);
985 print_error_message (data
, stream
);
987 /* If the window system or terminal frame hasn't been initialized
988 yet, or we're in -batch mode, this error should cause Emacs to exit. */
989 if (! FRAME_MESSAGE_BUF (selected_frame
)
993 Fkill_emacs (make_number (-1));
997 Lisp_Object
command_loop_1 ();
998 Lisp_Object
command_loop_2 ();
999 Lisp_Object
top_level_1 ();
1001 /* Entry to editor-command-loop.
1002 This level has the catches for exiting/returning to editor command loop.
1003 It returns nil to exit recursive edit, t to abort it. */
1008 if (command_loop_level
> 0 || minibuf_level
> 0)
1010 return internal_catch (Qexit
, command_loop_2
, Qnil
);
1015 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1016 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1018 /* End of file in -batch run causes exit here. */
1024 /* Here we catch errors in execution of commands within the
1025 editing loop, and reenter the editing loop.
1026 When there is an error, cmd_error runs and returns a non-nil
1027 value to us. A value of nil means that cmd_loop_1 itself
1028 returned due to end of file (or end of kbd macro). */
1033 register Lisp_Object val
;
1036 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1037 while (!NILP (val
));
1045 return Feval (Vtop_level
);
1051 /* On entry to the outer level, run the startup file */
1052 if (!NILP (Vtop_level
))
1053 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1054 else if (!NILP (Vpurify_flag
))
1055 message ("Bare impure Emacs (standard Lisp code not loaded)");
1057 message ("Bare Emacs (standard Lisp code not loaded)");
1061 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1062 "Exit all recursive editing levels.")
1065 Fthrow (Qtop_level
, Qnil
);
1068 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1069 "Exit from the innermost recursive edit or minibuffer.")
1072 if (command_loop_level
> 0 || minibuf_level
> 0)
1073 Fthrow (Qexit
, Qnil
);
1075 error ("No recursive edit is in progress");
1078 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1079 "Abort the command that requested this recursive edit or minibuffer input.")
1082 if (command_loop_level
> 0 || minibuf_level
> 0)
1085 error ("No recursive edit is in progress");
1088 /* This is the actual command reading loop,
1089 sans error-handling encapsulation. */
1091 Lisp_Object
Fcommand_execute ();
1092 static int read_key_sequence ();
1093 void safe_run_hooks ();
1098 Lisp_Object cmd
, tem
;
1101 Lisp_Object keybuf
[30];
1106 struct buffer
*prev_buffer
;
1108 int was_locked
= single_kboard
;
1111 current_kboard
->Vprefix_arg
= Qnil
;
1112 Vdeactivate_mark
= Qnil
;
1113 waiting_for_input
= 0;
1118 this_command_key_count
= 0;
1119 this_single_command_key_start
= 0;
1121 /* Make sure this hook runs after commands that get errors and
1122 throw to top level. */
1123 /* Note that the value cell will never directly contain nil
1124 if the symbol is a local variable. */
1125 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1126 safe_run_hooks (Qpost_command_hook
);
1128 if (!NILP (Vdeferred_action_list
))
1129 call0 (Vdeferred_action_function
);
1131 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1133 if (NILP (Vunread_command_events
)
1134 && NILP (Vexecuting_macro
)
1135 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1136 safe_run_hooks (Qpost_command_idle_hook
);
1139 /* Do this after running Vpost_command_hook, for consistency. */
1140 current_kboard
->Vlast_command
= this_command
;
1144 /* Make sure the current window's buffer is selected. */
1145 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1146 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1148 /* Display any malloc warning that just came out. Use while because
1149 displaying one warning can cause another. */
1151 while (pending_malloc_warning
)
1152 display_malloc_warning ();
1156 Vdeactivate_mark
= Qnil
;
1158 /* If minibuffer on and echo area in use,
1159 wait 2 sec and redraw minibuffer. */
1161 if (minibuf_level
&& echo_area_glyphs
1162 && EQ (minibuf_window
, echo_area_window
))
1164 /* Bind inhibit-quit to t so that C-g gets read in
1165 rather than quitting back to the minibuffer. */
1166 int count
= specpdl_ptr
- specpdl
;
1167 specbind (Qinhibit_quit
, Qt
);
1169 Fsit_for (make_number (2), Qnil
, Qnil
);
1170 /* Clear the echo area. */
1172 safe_run_hooks (Qecho_area_clear_hook
);
1174 unbind_to (count
, Qnil
);
1176 /* If a C-g came in before, treat it as input now. */
1177 if (!NILP (Vquit_flag
))
1180 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1185 alloca (0); /* Cause a garbage collection now */
1186 /* Since we can free the most stuff here. */
1187 #endif /* C_ALLOCA */
1190 /* Select the frame that the last event came from. Usually,
1191 switch-frame events will take care of this, but if some lisp
1192 code swallows a switch-frame event, we'll fix things up here.
1193 Is this a good idea? */
1194 if (FRAMEP (internal_last_event_frame
)
1195 && XFRAME (internal_last_event_frame
) != selected_frame
)
1196 Fselect_frame (internal_last_event_frame
, Qnil
);
1198 /* If it has changed current-menubar from previous value,
1199 really recompute the menubar from the value. */
1200 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1201 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1202 call0 (Qrecompute_lucid_menubar
);
1204 before_command_key_count
= this_command_key_count
;
1205 before_command_echo_length
= echo_length ();
1207 this_command
= Qnil
;
1209 /* Read next key sequence; i gets its length. */
1210 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1213 /* A filter may have run while we were reading the input. */
1214 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1215 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1219 /* Now we have read a key sequence of length I,
1220 or else I is 0 and we found end of file. */
1222 if (i
== 0) /* End of file -- happens only in */
1223 return Qnil
; /* a kbd macro, at the end. */
1224 /* -1 means read_key_sequence got a menu that was rejected.
1225 Just loop around and read another command. */
1229 this_command_key_count
= 0;
1230 this_single_command_key_start
= 0;
1234 last_command_char
= keybuf
[i
- 1];
1236 /* If the previous command tried to force a specific window-start,
1237 forget about that, in case this command moves point far away
1238 from that position. But also throw away beg_unchanged and
1239 end_unchanged information in that case, so that redisplay will
1240 update the whole window properly. */
1241 if (!NILP (XWINDOW (selected_window
)->force_start
))
1243 XWINDOW (selected_window
)->force_start
= Qnil
;
1244 beg_unchanged
= end_unchanged
= 0;
1247 cmd
= read_key_sequence_cmd
;
1248 if (!NILP (Vexecuting_macro
))
1250 if (!NILP (Vquit_flag
))
1252 Vexecuting_macro
= Qt
;
1253 QUIT
; /* Make some noise. */
1254 /* Will return since macro now empty. */
1258 /* Do redisplay processing after this command except in special
1259 cases identified below that set no_redisplay to 1.
1260 (actually, there's currently no way to prevent the redisplay,
1261 and no_redisplay is ignored.
1262 Perhaps someday we will really implement it.) */
1265 prev_buffer
= current_buffer
;
1266 prev_modiff
= MODIFF
;
1267 last_point_position
= PT
;
1268 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1270 /* Execute the command. */
1273 /* Note that the value cell will never directly contain nil
1274 if the symbol is a local variable. */
1275 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1276 safe_run_hooks (Qpre_command_hook
);
1278 if (NILP (this_command
))
1280 /* nil means key is undefined. */
1282 current_kboard
->defining_kbd_macro
= Qnil
;
1283 update_mode_lines
= 1;
1284 current_kboard
->Vprefix_arg
= Qnil
;
1288 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1290 /* Recognize some common commands in common situations and
1291 do them directly. */
1292 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1294 struct Lisp_Char_Table
*dp
1295 = window_display_table (XWINDOW (selected_window
));
1296 lose
= FETCH_BYTE (PT_BYTE
);
1299 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1300 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1301 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1302 && (lose
>= 0x20 && lose
< 0x7f)))
1303 : (lose
>= 0x20 && lose
< 0x7f))
1304 /* To extract the case of continuation on
1305 wide-column characters. */
1306 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1307 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1309 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1311 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1313 && !windows_or_buffers_changed
1314 && EQ (current_buffer
->selective_display
, Qnil
)
1315 && !detect_input_pending ()
1316 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1317 && NILP (Vexecuting_macro
))
1318 no_redisplay
= direct_output_forward_char (1);
1321 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1323 struct Lisp_Char_Table
*dp
1324 = window_display_table (XWINDOW (selected_window
));
1326 lose
= FETCH_BYTE (PT_BYTE
);
1328 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1329 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1330 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1331 && (lose
>= 0x20 && lose
< 0x7f)))
1332 : (lose
>= 0x20 && lose
< 0x7f))
1333 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1335 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1337 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1339 && !windows_or_buffers_changed
1340 && EQ (current_buffer
->selective_display
, Qnil
)
1341 && !detect_input_pending ()
1342 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1343 && NILP (Vexecuting_macro
))
1344 no_redisplay
= direct_output_forward_char (-1);
1347 else if (EQ (this_command
, Qself_insert_command
)
1348 /* Try this optimization only on ascii keystrokes. */
1349 && INTEGERP (last_command_char
))
1351 unsigned int c
= XINT (last_command_char
);
1354 if (NILP (Vexecuting_macro
)
1355 && !EQ (minibuf_window
, selected_window
))
1357 if (!nonundocount
|| nonundocount
>= 20)
1364 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1366 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1368 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1370 || MODIFF
<= SAVE_MODIFF
1371 || windows_or_buffers_changed
1372 || !EQ (current_buffer
->selective_display
, Qnil
)
1373 || detect_input_pending ()
1374 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1375 || !NILP (Vexecuting_macro
));
1376 value
= internal_self_insert (c
, 0);
1383 && (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
1385 struct Lisp_Char_Table
*dp
1386 = window_display_table (XWINDOW (selected_window
));
1389 /* Add the offset to the character, for Finsert_char.
1390 We pass internal_self_insert the unmodified character
1391 because it itself does this offsetting. */
1392 if (! NILP (current_buffer
->enable_multibyte_characters
))
1393 lose
= unibyte_char_to_multibyte (lose
);
1399 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1402 /* Do it only for char codes
1403 that by default display as themselves. */
1404 if (lose
>= 0x20 && lose
<= 0x7e)
1405 no_redisplay
= direct_output_for_insert (lose
);
1407 else if (VECTORP (obj
)
1408 && XVECTOR (obj
)->size
== 1
1409 && (obj
= XVECTOR (obj
)->contents
[0],
1411 /* Insist face not specified in glyph. */
1412 && (XINT (obj
) & ((-1) << 8)) == 0)
1414 = direct_output_for_insert (XINT (obj
));
1418 if (lose
>= 0x20 && lose
<= 0x7e)
1419 no_redisplay
= direct_output_for_insert (lose
);
1426 /* Here for a command that isn't executed directly */
1429 if (NILP (current_kboard
->Vprefix_arg
))
1431 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1436 /* Note that the value cell will never directly contain nil
1437 if the symbol is a local variable. */
1438 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1439 safe_run_hooks (Qpost_command_hook
);
1441 if (!NILP (Vdeferred_action_list
))
1442 safe_run_hooks (Qdeferred_action_function
);
1444 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1446 if (NILP (Vunread_command_events
)
1447 && NILP (Vexecuting_macro
)
1448 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1449 safe_run_hooks (Qpost_command_idle_hook
);
1452 /* If there is a prefix argument,
1453 1) We don't want Vlast_command to be ``universal-argument''
1454 (that would be dumb), so don't set Vlast_command,
1455 2) we want to leave echoing on so that the prefix will be
1456 echoed as part of this key sequence, so don't call
1458 3) we want to leave this_command_key_count non-zero, so that
1459 read_char will realize that it is re-reading a character, and
1460 not echo it a second time.
1462 If the command didn't actually create a prefix arg,
1463 but is merely a frame event that is transparent to prefix args,
1464 then the above doesn't apply. */
1465 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1467 current_kboard
->Vlast_command
= this_command
;
1469 this_command_key_count
= 0;
1470 this_single_command_key_start
= 0;
1473 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1475 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1477 current_buffer
->mark_active
= Qnil
;
1478 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1480 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1481 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1485 /* Install chars successfully executed in kbd macro. */
1487 if (!NILP (current_kboard
->defining_kbd_macro
)
1488 && NILP (current_kboard
->Vprefix_arg
))
1489 finalize_kbd_macro_chars ();
1493 any_kboard_state ();
1498 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1501 safe_run_hooks_1 (hook
)
1504 return call1 (Vrun_hooks
, Vinhibit_quit
);
1507 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1510 safe_run_hooks_error (data
)
1513 Fset (Vinhibit_quit
, Qnil
);
1516 /* If we get an error while running the hook, cause the hook variable
1517 to be nil. Also inhibit quits, so that C-g won't cause the hook
1518 to mysteriously evaporate. */
1521 safe_run_hooks (hook
)
1525 int count
= specpdl_ptr
- specpdl
;
1526 specbind (Qinhibit_quit
, hook
);
1528 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1530 unbind_to (count
, Qnil
);
1533 /* Number of seconds between polling for input. */
1536 /* Nonzero means polling for input is temporarily suppressed. */
1537 int poll_suppress_count
;
1539 /* Nonzero if polling_for_input is actually being used. */
1540 int polling_for_input
;
1542 #ifdef POLL_FOR_INPUT
1544 /* Handle an alarm once each second and read pending input
1545 so as to handle a C-g if it comces in. */
1548 input_poll_signal (signalnum
) /* If we don't have an argument, */
1549 int signalnum
; /* some compilers complain in signal calls. */
1551 /* This causes the call to start_polling at the end
1552 to do its job. It also arranges for a quit or error
1553 from within read_avail_input to resume polling. */
1554 poll_suppress_count
++;
1555 if (interrupt_input_blocked
== 0
1556 && !waiting_for_input
)
1557 read_avail_input (0);
1558 /* Turn on the SIGALRM handler and request another alarm. */
1564 /* Begin signals to poll for input, if they are appropriate.
1565 This function is called unconditionally from various places. */
1570 #ifdef POLL_FOR_INPUT
1571 if (read_socket_hook
&& !interrupt_input
)
1573 poll_suppress_count
--;
1574 if (poll_suppress_count
== 0)
1576 signal (SIGALRM
, input_poll_signal
);
1577 polling_for_input
= 1;
1578 alarm (polling_period
);
1584 /* Nonzero if we are using polling to handle input asynchronously. */
1587 input_polling_used ()
1589 #ifdef POLL_FOR_INPUT
1590 return read_socket_hook
&& !interrupt_input
;
1596 /* Turn off polling. */
1601 #ifdef POLL_FOR_INPUT
1602 if (read_socket_hook
&& !interrupt_input
)
1604 if (poll_suppress_count
== 0)
1606 polling_for_input
= 0;
1609 poll_suppress_count
++;
1614 /* Set the value of poll_suppress_count to COUNT
1615 and start or stop polling accordingly. */
1618 set_poll_suppress_count (count
)
1621 #ifdef POLL_FOR_INPUT
1622 if (count
== 0 && poll_suppress_count
!= 0)
1624 poll_suppress_count
= 1;
1627 else if (count
!= 0 && poll_suppress_count
== 0)
1631 poll_suppress_count
= count
;
1635 /* Bind polling_period to a value at least N.
1636 But don't decrease it. */
1639 bind_polling_period (n
)
1642 #ifdef POLL_FOR_INPUT
1643 int new = polling_period
;
1649 specbind (Qpolling_period
, make_number (new));
1650 /* Start a new alarm with the new period. */
1655 /* Apply the control modifier to CHARACTER. */
1661 /* Save the upper bits here. */
1662 int upper
= c
& ~0177;
1666 /* Everything in the columns containing the upper-case letters
1667 denotes a control character. */
1668 if (c
>= 0100 && c
< 0140)
1672 /* Set the shift modifier for a control char
1673 made from a shifted letter. But only for letters! */
1674 if (oc
>= 'A' && oc
<= 'Z')
1675 c
|= shift_modifier
;
1678 /* The lower-case letters denote control characters too. */
1679 else if (c
>= 'a' && c
<= 'z')
1682 /* Include the bits for control and shift
1683 only if the basic ASCII code can't indicate them. */
1687 /* Replace the high bits. */
1688 c
|= (upper
& ~ctrl_modifier
);
1695 /* Input of single characters from keyboard */
1697 Lisp_Object
print_help ();
1698 static Lisp_Object
kbd_buffer_get_event ();
1699 static void record_char ();
1702 static jmp_buf wrong_kboard_jmpbuf
;
1705 /* read a character from the keyboard; call the redisplay if needed */
1706 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1707 -1 means do not do redisplay, but do do autosaving.
1710 /* The arguments MAPS and NMAPS are for menu prompting.
1711 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1713 PREV_EVENT is the previous input event, or nil if we are reading
1714 the first event of a key sequence.
1716 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1717 if we used a mouse menu to read the input, or zero otherwise. If
1718 USED_MOUSE_MENU is null, we don't dereference it.
1720 Value is t if we showed a menu and the user rejected it. */
1723 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1727 Lisp_Object prev_event
;
1728 int *used_mouse_menu
;
1732 jmp_buf local_getcjmp
;
1734 int key_already_recorded
= 0;
1735 Lisp_Object tem
, save
;
1736 Lisp_Object also_record
;
1737 struct gcpro gcpro1
;
1741 before_command_key_count
= this_command_key_count
;
1742 before_command_echo_length
= echo_length ();
1749 if (CONSP (Vunread_command_events
))
1751 c
= XCONS (Vunread_command_events
)->car
;
1752 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1754 /* Undo what read_char_x_menu_prompt did when it unread
1755 additional keys returned by Fx_popup_menu. */
1757 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1758 && NILP (XCONS (c
)->cdr
))
1761 if (this_command_key_count
== 0)
1767 if (unread_command_char
!= -1)
1769 XSETINT (c
, unread_command_char
);
1770 unread_command_char
= -1;
1772 if (this_command_key_count
== 0)
1778 /* If there is no function key translated before
1779 reset-this-command-lengths takes effect, forget about it. */
1780 before_command_restore_flag
= 0;
1782 if (!NILP (Vexecuting_macro
))
1784 /* We set this to Qmacro; since that's not a frame, nobody will
1785 try to switch frames on us, and the selected window will
1788 Since this event came from a macro, it would be misleading to
1789 leave internal_last_event_frame set to wherever the last
1790 real event came from. Normally, a switch-frame event selects
1791 internal_last_event_frame after each command is read, but
1792 events read from a macro should never cause a new frame to be
1794 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1796 /* Exit the macro if we are at the end.
1797 Also, some things replace the macro with t
1798 to force an early exit. */
1799 if (EQ (Vexecuting_macro
, Qt
)
1800 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1806 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1807 if (STRINGP (Vexecuting_macro
)
1808 && (XINT (c
) & 0x80))
1809 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1811 executing_macro_index
++;
1816 if (!NILP (unread_switch_frame
))
1818 c
= unread_switch_frame
;
1819 unread_switch_frame
= Qnil
;
1821 /* This event should make it into this_command_keys, and get echoed
1822 again, so we go to reread_first, rather than reread. */
1826 if (commandflag
>= 0)
1829 || detect_input_pending_run_timers (0))
1836 /* Message turns off echoing unless more keystrokes turn it on again. */
1837 if (echo_area_glyphs
&& *echo_area_glyphs
1838 && echo_area_glyphs
!= current_kboard
->echobuf
1839 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1842 /* If already echoing, continue. */
1845 /* Try reading a character via menu prompting in the minibuf.
1846 Try this before the sit-for, because the sit-for
1847 would do the wrong thing if we are supposed to do
1848 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1849 after a mouse event so don't try a minibuf menu. */
1851 if (nmaps
> 0 && INTERACTIVE
1852 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1853 /* Don't bring up a menu if we already have another event. */
1854 && NILP (Vunread_command_events
)
1855 && unread_command_char
< 0
1856 && !detect_input_pending_run_timers (0))
1858 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1861 key_already_recorded
= 1;
1866 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1867 We will do that below, temporarily for short sections of code,
1868 when appropriate. local_getcjmp must be in effect
1869 around any call to sit_for or kbd_buffer_get_event;
1870 it *must not* be in effect when we call redisplay. */
1872 if (_setjmp (local_getcjmp
))
1874 XSETINT (c
, quit_char
);
1875 XSETFRAME (internal_last_event_frame
, selected_frame
);
1876 Vlast_event_frame
= internal_last_event_frame
;
1877 /* If we report the quit char as an event,
1878 don't do so more than once. */
1879 if (!NILP (Vinhibit_quit
))
1884 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1885 if (kb
!= current_kboard
)
1887 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1888 /* We shouldn't get here if we were in single-kboard mode! */
1891 while (CONSP (*tailp
))
1892 tailp
= &XCONS (*tailp
)->cdr
;
1895 *tailp
= Fcons (c
, Qnil
);
1896 kb
->kbd_queue_has_data
= 1;
1897 current_kboard
= kb
;
1898 /* This is going to exit from read_char
1899 so we had better get rid of this frame's stuff. */
1901 longjmp (wrong_kboard_jmpbuf
, 1);
1908 timer_start_idle ();
1910 /* If in middle of key sequence and minibuffer not active,
1911 start echoing if enough time elapses. */
1913 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1914 && this_command_key_count
> 0
1916 && echo_keystrokes
> 0
1917 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1918 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1922 /* After a mouse event, start echoing right away.
1923 This is because we are probably about to display a menu,
1924 and we don't want to delay before doing so. */
1925 if (EVENT_HAS_PARAMETERS (prev_event
))
1929 save_getcjmp (save_jump
);
1930 restore_getcjmp (local_getcjmp
);
1931 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
1932 restore_getcjmp (save_jump
);
1934 && ! CONSP (Vunread_command_events
))
1939 /* Maybe auto save due to number of keystrokes. */
1941 if (commandflag
!= 0
1942 && auto_save_interval
> 0
1943 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
1944 && !detect_input_pending_run_timers (0))
1946 Fdo_auto_save (Qnil
, Qnil
);
1947 /* Hooks can actually change some buffers in auto save. */
1951 /* Try reading using an X menu.
1952 This is never confused with reading using the minibuf
1953 because the recursive call of read_char in read_char_minibuf_menu_prompt
1954 does not pass on any keymaps. */
1956 if (nmaps
> 0 && INTERACTIVE
1957 && !NILP (prev_event
)
1958 && EVENT_HAS_PARAMETERS (prev_event
)
1959 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1960 /* Don't bring up a menu if we already have another event. */
1961 && NILP (Vunread_command_events
)
1962 && unread_command_char
< 0)
1964 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1966 /* Now that we have read an event, Emacs is not idle. */
1972 /* Maybe autosave and/or garbage collect due to idleness. */
1974 if (INTERACTIVE
&& NILP (c
))
1976 int delay_level
, buffer_size
;
1978 /* Slow down auto saves logarithmically in size of current buffer,
1979 and garbage collect while we're at it. */
1980 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1981 last_non_minibuf_size
= Z
- BEG
;
1982 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1984 while (buffer_size
> 64)
1985 delay_level
++, buffer_size
-= buffer_size
>> 2;
1986 if (delay_level
< 4) delay_level
= 4;
1987 /* delay_level is 4 for files under around 50k, 7 at 100k,
1988 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1990 /* Auto save if enough time goes by without input. */
1991 if (commandflag
!= 0
1992 && num_nonmacro_input_events
> last_auto_save
1993 && INTEGERP (Vauto_save_timeout
)
1994 && XINT (Vauto_save_timeout
) > 0)
1998 save_getcjmp (save_jump
);
1999 restore_getcjmp (local_getcjmp
);
2000 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2002 restore_getcjmp (save_jump
);
2005 && ! CONSP (Vunread_command_events
))
2007 Fdo_auto_save (Qnil
, Qnil
);
2009 /* If we have auto-saved and there is still no input
2010 available, garbage collect if there has been enough
2011 consing going on to make it worthwhile. */
2012 if (!detect_input_pending_run_timers (0)
2013 && consing_since_gc
> gc_cons_threshold
/ 2)
2014 Fgarbage_collect ();
2021 /* If this has become non-nil here, it has been set by a timer
2022 or sentinel or filter. */
2023 if (CONSP (Vunread_command_events
))
2025 c
= XCONS (Vunread_command_events
)->car
;
2026 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2029 /* Read something from current KBOARD's side queue, if possible. */
2033 if (current_kboard
->kbd_queue_has_data
)
2035 if (!CONSP (current_kboard
->kbd_queue
))
2037 c
= XCONS (current_kboard
->kbd_queue
)->car
;
2038 current_kboard
->kbd_queue
2039 = XCONS (current_kboard
->kbd_queue
)->cdr
;
2040 if (NILP (current_kboard
->kbd_queue
))
2041 current_kboard
->kbd_queue_has_data
= 0;
2042 input_pending
= readable_events (0);
2043 if (EVENT_HAS_PARAMETERS (c
)
2044 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2045 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2046 Vlast_event_frame
= internal_last_event_frame
;
2051 /* If current_kboard's side queue is empty check the other kboards.
2052 If one of them has data that we have not yet seen here,
2053 switch to it and process the data waiting for it.
2055 Note: if the events queued up for another kboard
2056 have already been seen here, and therefore are not a complete command,
2057 the kbd_queue_has_data field is 0, so we skip that kboard here.
2058 That's to avoid an infinite loop switching between kboards here. */
2059 if (NILP (c
) && !single_kboard
)
2062 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2063 if (kb
->kbd_queue_has_data
)
2065 current_kboard
= kb
;
2066 /* This is going to exit from read_char
2067 so we had better get rid of this frame's stuff. */
2069 longjmp (wrong_kboard_jmpbuf
, 1);
2078 /* Finally, we read from the main queue,
2079 and if that gives us something we can't use yet, we put it on the
2080 appropriate side queue and try again. */
2086 /* Actually read a character, waiting if necessary. */
2087 save_getcjmp (save_jump
);
2088 restore_getcjmp (local_getcjmp
);
2089 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2090 restore_getcjmp (save_jump
);
2093 if (! NILP (c
) && (kb
!= current_kboard
))
2095 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2096 while (CONSP (*tailp
))
2097 tailp
= &XCONS (*tailp
)->cdr
;
2100 *tailp
= Fcons (c
, Qnil
);
2101 kb
->kbd_queue_has_data
= 1;
2105 current_kboard
= kb
;
2106 /* This is going to exit from read_char
2107 so we had better get rid of this frame's stuff. */
2109 longjmp (wrong_kboard_jmpbuf
, 1);
2114 /* Terminate Emacs in batch mode if at eof. */
2115 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2116 Fkill_emacs (make_number (1));
2120 /* Add in any extra modifiers, where appropriate. */
2121 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2122 || ((extra_keyboard_modifiers
& 0177) < ' '
2123 && (extra_keyboard_modifiers
& 0177) != 0))
2124 XSETINT (c
, make_ctrl_char (XINT (c
)));
2126 /* Transfer any other modifier bits directly from
2127 extra_keyboard_modifiers to c. Ignore the actual character code
2128 in the low 16 bits of extra_keyboard_modifiers. */
2129 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2140 if (commandflag
>= 0
2141 && !input_pending
&& !detect_input_pending_run_timers (0))
2149 /* Buffer switch events are only for internal wakeups
2150 so don't show them to the user.
2151 Also, don't record a key if we already did. */
2152 if (BUFFERP (c
) || key_already_recorded
)
2155 /* Process special events within read_char
2156 and loop around to read another event. */
2159 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2165 int was_locked
= single_kboard
;
2167 last_input_char
= c
;
2168 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2170 /* Resume allowing input from any kboard, if that was true before. */
2172 any_kboard_state ();
2177 /* Wipe the echo area. */
2178 if (echo_area_glyphs
)
2179 safe_run_hooks (Qecho_area_clear_hook
);
2180 echo_area_glyphs
= 0;
2182 /* Handle things that only apply to characters. */
2185 /* If kbd_buffer_get_event gave us an EOF, return that. */
2189 if ((STRINGP (Vkeyboard_translate_table
)
2190 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2191 || (VECTORP (Vkeyboard_translate_table
)
2192 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2193 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2194 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2197 d
= Faref (Vkeyboard_translate_table
, c
);
2198 /* nil in keyboard-translate-table means no translation. */
2204 /* If this event is a mouse click in the menu bar,
2205 return just menu-bar for now. Modify the mouse click event
2206 so we won't do this twice, then queue it up. */
2207 if (EVENT_HAS_PARAMETERS (c
)
2208 && CONSP (XCONS (c
)->cdr
)
2209 && CONSP (EVENT_START (c
))
2210 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2214 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2215 /* Handle menu-bar events:
2216 insert the dummy prefix event `menu-bar'. */
2217 if (EQ (posn
, Qmenu_bar
))
2219 /* Change menu-bar to (menu-bar) as the event "position". */
2220 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2223 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2229 if (! NILP (also_record
))
2230 record_char (also_record
);
2235 before_command_key_count
= this_command_key_count
;
2236 before_command_echo_length
= echo_length ();
2238 /* Don't echo mouse motion events. */
2240 && ! (EVENT_HAS_PARAMETERS (c
)
2241 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2244 if (! NILP (also_record
))
2245 echo_char (also_record
);
2246 /* Once we reread a character, echoing can happen
2247 the next time we pause to read a new one. */
2248 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2251 /* Record this character as part of the current key. */
2252 add_command_key (c
);
2253 if (! NILP (also_record
))
2254 add_command_key (also_record
);
2256 /* Re-reading in the middle of a command */
2258 last_input_char
= c
;
2261 /* Process the help character specially if enabled */
2262 if (!NILP (Vhelp_form
) && help_char_p (c
))
2265 count
= specpdl_ptr
- specpdl
;
2267 record_unwind_protect (Fset_window_configuration
,
2268 Fcurrent_window_configuration (Qnil
));
2270 tem0
= Feval (Vhelp_form
);
2272 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2276 c
= read_char (0, 0, 0, Qnil
, 0);
2277 while (BUFFERP (c
));
2278 /* Remove the help from the frame */
2279 unbind_to (count
, Qnil
);
2282 if (EQ (c
, make_number (040)))
2286 c
= read_char (0, 0, 0, Qnil
, 0);
2287 while (BUFFERP (c
));
2294 /* Record a key that came from a mouse menu.
2295 Record it for echoing, for this-command-keys, and so on. */
2301 /* Wipe the echo area. */
2302 echo_area_glyphs
= 0;
2306 before_command_key_count
= this_command_key_count
;
2307 before_command_echo_length
= echo_length ();
2309 /* Don't echo mouse motion events. */
2310 if (echo_keystrokes
)
2314 /* Once we reread a character, echoing can happen
2315 the next time we pause to read a new one. */
2316 ok_to_echo_at_next_pause
= 0;
2319 /* Record this character as part of the current key. */
2320 add_command_key (c
);
2322 /* Re-reading in the middle of a command */
2323 last_input_char
= c
;
2327 /* Return 1 if should recognize C as "the help character". */
2335 if (EQ (c
, Vhelp_char
))
2337 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2338 if (EQ (c
, XCONS (tail
)->car
))
2343 /* Record the input event C in various ways. */
2350 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2351 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2352 recent_keys_index
= 0;
2354 /* Write c to the dribble file. If c is a lispy event, write
2355 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2356 If you, dear reader, have a better idea, you've got the source. :-) */
2361 if (XUINT (c
) < 0x100)
2362 putc (XINT (c
), dribble
);
2364 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2368 Lisp_Object dribblee
;
2370 /* If it's a structured event, take the event header. */
2371 dribblee
= EVENT_HEAD (c
);
2373 if (SYMBOLP (dribblee
))
2375 putc ('<', dribble
);
2376 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2377 XSYMBOL (dribblee
)->name
->size_byte
,
2379 putc ('>', dribble
);
2386 store_kbd_macro_char (c
);
2388 num_nonmacro_input_events
++;
2395 struct buffer
*old
= current_buffer
;
2396 Fprinc (object
, Qnil
);
2397 set_buffer_internal (XBUFFER (Vstandard_output
));
2398 call0 (intern ("help-mode"));
2399 set_buffer_internal (old
);
2403 /* Copy out or in the info on where C-g should throw to.
2404 This is used when running Lisp code from within get_char,
2405 in case get_char is called recursively.
2406 See read_process_output. */
2411 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2414 restore_getcjmp (temp
)
2417 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2422 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2423 of this function. */
2426 tracking_off (old_value
)
2427 Lisp_Object old_value
;
2429 do_mouse_tracking
= old_value
;
2430 if (NILP (old_value
))
2432 /* Redisplay may have been preempted because there was input
2433 available, and it assumes it will be called again after the
2434 input has been processed. If the only input available was
2435 the sort that we have just disabled, then we need to call
2437 if (!readable_events (1))
2439 redisplay_preserve_echo_area ();
2440 get_input_pending (&input_pending
, 1);
2445 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2446 "Evaluate BODY with mouse movement events enabled.\n\
2447 Within a `track-mouse' form, mouse motion generates input events that\n\
2448 you can read with `read-event'.\n\
2449 Normally, mouse motion is ignored.")
2453 int count
= specpdl_ptr
- specpdl
;
2456 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2458 do_mouse_tracking
= Qt
;
2460 val
= Fprogn (args
);
2461 return unbind_to (count
, val
);
2464 /* If mouse has moved on some frame, return one of those frames.
2465 Return 0 otherwise. */
2470 Lisp_Object tail
, frame
;
2472 FOR_EACH_FRAME (tail
, frame
)
2474 if (XFRAME (frame
)->mouse_moved
)
2475 return XFRAME (frame
);
2481 #endif /* HAVE_MOUSE */
2483 /* Low level keyboard/mouse input.
2484 kbd_buffer_store_event places events in kbd_buffer, and
2485 kbd_buffer_get_event retrieves them. */
2487 /* Return true iff there are any events in the queue that read-char
2488 would return. If this returns false, a read-char would block. */
2490 readable_events (do_timers_now
)
2494 timer_check (do_timers_now
);
2496 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2499 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2504 if (current_kboard
->kbd_queue_has_data
)
2510 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2511 if (kb
->kbd_queue_has_data
)
2517 /* Set this for debugging, to have a way to get out */
2522 event_to_kboard (event
)
2523 struct input_event
*event
;
2526 frame
= event
->frame_or_window
;
2528 frame
= XCONS (frame
)->car
;
2529 else if (WINDOWP (frame
))
2530 frame
= WINDOW_FRAME (XWINDOW (frame
));
2532 /* There are still some events that don't set this field.
2533 For now, just ignore the problem.
2534 Also ignore dead frames here. */
2535 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2538 return FRAME_KBOARD (XFRAME (frame
));
2542 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2545 kbd_buffer_store_event (event
)
2546 register struct input_event
*event
;
2548 if (event
->kind
== no_event
)
2551 if (event
->kind
== ascii_keystroke
)
2553 register int c
= event
->code
& 0377;
2555 if (event
->modifiers
& ctrl_modifier
)
2556 c
= make_ctrl_char (c
);
2558 c
|= (event
->modifiers
2559 & (meta_modifier
| alt_modifier
2560 | hyper_modifier
| super_modifier
));
2564 extern SIGTYPE
interrupt_signal ();
2567 struct input_event
*sp
;
2570 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2571 kb
!= current_kboard
))
2574 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2575 Fcons (make_number (c
), Qnil
));
2576 kb
->kbd_queue_has_data
= 1;
2577 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2579 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2582 if (event_to_kboard (sp
) == kb
)
2584 sp
->kind
= no_event
;
2585 sp
->frame_or_window
= Qnil
;
2592 /* If this results in a quit_char being returned to Emacs as
2593 input, set Vlast_event_frame properly. If this doesn't
2594 get returned to Emacs as an event, the next event read
2595 will set Vlast_event_frame again, so this is safe to do. */
2599 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2601 focus
= event
->frame_or_window
;
2602 internal_last_event_frame
= focus
;
2603 Vlast_event_frame
= focus
;
2606 last_event_timestamp
= event
->timestamp
;
2607 interrupt_signal ();
2611 if (c
&& c
== stop_character
)
2617 /* Don't insert two buffer_switch_event's in a row.
2618 Just ignore the second one. */
2619 else if (event
->kind
== buffer_switch_event
2620 && kbd_fetch_ptr
!= kbd_store_ptr
2621 && kbd_store_ptr
->kind
== buffer_switch_event
)
2624 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2625 kbd_store_ptr
= kbd_buffer
;
2627 /* Don't let the very last slot in the buffer become full,
2628 since that would make the two pointers equal,
2629 and that is indistinguishable from an empty buffer.
2630 Discard the event if it would fill the last slot. */
2631 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2633 volatile struct input_event
*sp
= kbd_store_ptr
;
2634 sp
->kind
= event
->kind
;
2635 if (event
->kind
== selection_request_event
)
2637 /* We must not use the ordinary copying code for this case,
2638 since `part' is an enum and copying it might not copy enough
2640 bcopy (event
, (char *) sp
, sizeof (*event
));
2644 sp
->code
= event
->code
;
2645 sp
->part
= event
->part
;
2646 sp
->frame_or_window
= event
->frame_or_window
;
2647 sp
->modifiers
= event
->modifiers
;
2650 sp
->timestamp
= event
->timestamp
;
2652 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2654 = event
->frame_or_window
);
2660 /* Discard any mouse events in the event buffer by setting them to
2663 discard_mouse_events ()
2665 struct input_event
*sp
;
2666 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2668 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2671 if (sp
->kind
== mouse_click
2673 || sp
->kind
== w32_scroll_bar_click
2675 || sp
->kind
== scroll_bar_click
)
2677 sp
->kind
= no_event
;
2682 /* Read one event from the event buffer, waiting if necessary.
2683 The value is a Lisp object representing the event.
2684 The value is nil for an event that should be ignored,
2685 or that was handled here.
2686 We always read and discard one event. */
2689 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2691 int *used_mouse_menu
;
2695 EMACS_TIME next_timer_delay
;
2701 *kbp
= current_kboard
;
2705 /* Wait until there is input available. */
2708 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2711 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2715 /* If the quit flag is set, then read_char will return
2716 quit_char, so that counts as "available input." */
2717 if (!NILP (Vquit_flag
))
2718 quit_throw_to_read_char ();
2720 /* One way or another, wait until input is available; then, if
2721 interrupt handlers have not read it, read it now. */
2724 wait_for_kbd_input ();
2726 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2730 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2733 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2737 Lisp_Object minus_one
;
2739 XSETINT (minus_one
, -1);
2740 wait_reading_process_input (0, 0, minus_one
, 1);
2742 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2743 /* Pass 1 for EXPECT since we just waited to have input. */
2744 read_avail_input (1);
2746 #endif /* not VMS */
2749 if (CONSP (Vunread_command_events
))
2752 first
= XCONS (Vunread_command_events
)->car
;
2753 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2754 *kbp
= current_kboard
;
2758 /* At this point, we know that there is a readable event available
2759 somewhere. If the event queue is empty, then there must be a
2760 mouse movement enabled and available. */
2761 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2763 struct input_event
*event
;
2765 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2769 last_event_timestamp
= event
->timestamp
;
2772 *kbp
= event_to_kboard (event
);
2774 *kbp
= current_kboard
; /* Better than returning null ptr? */
2776 *kbp
= &the_only_kboard
;
2781 /* These two kinds of events get special handling
2782 and don't actually appear to the command loop.
2783 We return nil for them. */
2784 if (event
->kind
== selection_request_event
)
2787 struct input_event copy
;
2789 /* Remove it from the buffer before processing it,
2790 since otherwise swallow_events will see it
2791 and process it again. */
2793 kbd_fetch_ptr
= event
+ 1;
2794 input_pending
= readable_events (0);
2795 x_handle_selection_request (©
);
2797 /* We're getting selection request events, but we don't have
2803 else if (event
->kind
== selection_clear_event
)
2806 struct input_event copy
;
2808 /* Remove it from the buffer before processing it. */
2810 kbd_fetch_ptr
= event
+ 1;
2811 input_pending
= readable_events (0);
2812 x_handle_selection_clear (©
);
2814 /* We're getting selection request events, but we don't have
2819 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2820 else if (event
->kind
== delete_window_event
)
2822 /* Make an event (delete-frame (FRAME)). */
2823 obj
= Fcons (event
->frame_or_window
, Qnil
);
2824 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2825 kbd_fetch_ptr
= event
+ 1;
2827 else if (event
->kind
== iconify_event
)
2829 /* Make an event (iconify-frame (FRAME)). */
2830 obj
= Fcons (event
->frame_or_window
, Qnil
);
2831 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2832 kbd_fetch_ptr
= event
+ 1;
2834 else if (event
->kind
== deiconify_event
)
2836 /* Make an event (make-frame-visible (FRAME)). */
2837 obj
= Fcons (event
->frame_or_window
, Qnil
);
2838 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2839 kbd_fetch_ptr
= event
+ 1;
2842 else if (event
->kind
== buffer_switch_event
)
2844 /* The value doesn't matter here; only the type is tested. */
2845 XSETBUFFER (obj
, current_buffer
);
2846 kbd_fetch_ptr
= event
+ 1;
2848 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2849 else if (event
->kind
== menu_bar_activate_event
)
2851 kbd_fetch_ptr
= event
+ 1;
2852 input_pending
= readable_events (0);
2853 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2854 x_activate_menubar (XFRAME (event
->frame_or_window
));
2857 /* Just discard these, by returning nil.
2858 With MULTI_KBOARD, these events are used as placeholders
2859 when we need to randomly delete events from the queue.
2860 (They shouldn't otherwise be found in the buffer,
2861 but on some machines it appears they do show up
2862 even without MULTI_KBOARD.) */
2863 /* On Windows NT/9X, no_event is used to delete extraneous
2864 mouse events during a popup-menu call. */
2865 else if (event
->kind
== no_event
)
2866 kbd_fetch_ptr
= event
+ 1;
2868 /* If this event is on a different frame, return a switch-frame this
2869 time, and leave the event in the queue for next time. */
2875 frame
= event
->frame_or_window
;
2877 frame
= XCONS (frame
)->car
;
2878 else if (WINDOWP (frame
))
2879 frame
= WINDOW_FRAME (XWINDOW (frame
));
2881 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2885 if (! EQ (frame
, internal_last_event_frame
)
2886 && XFRAME (frame
) != selected_frame
)
2887 obj
= make_lispy_switch_frame (frame
);
2888 internal_last_event_frame
= frame
;
2890 /* If we didn't decide to make a switch-frame event, go ahead
2891 and build a real event from the queue entry. */
2895 obj
= make_lispy_event (event
);
2896 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2897 /* If this was a menu selection, then set the flag to inhibit
2898 writing to last_nonmenu_event. Don't do this if the event
2899 we're returning is (menu-bar), though; that indicates the
2900 beginning of the menu sequence, and we might as well leave
2901 that as the `event with parameters' for this selection. */
2902 if (event
->kind
== menu_bar_event
2903 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2905 *used_mouse_menu
= 1;
2908 /* Wipe out this event, to catch bugs. */
2909 event
->kind
= no_event
;
2910 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2912 kbd_fetch_ptr
= event
+ 1;
2917 /* Try generating a mouse motion event. */
2918 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2920 FRAME_PTR f
= some_mouse_moved ();
2921 Lisp_Object bar_window
;
2922 enum scroll_bar_part part
;
2926 *kbp
= current_kboard
;
2927 /* Note that this uses F to determine which display to look at.
2928 If there is no valid info, it does not store anything
2929 so x remains nil. */
2931 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2935 /* Decide if we should generate a switch-frame event. Don't
2936 generate switch-frame events for motion outside of all Emacs
2942 frame
= FRAME_FOCUS_FRAME (f
);
2944 XSETFRAME (frame
, f
);
2946 if (! EQ (frame
, internal_last_event_frame
)
2947 && XFRAME (frame
) != selected_frame
)
2948 obj
= make_lispy_switch_frame (frame
);
2949 internal_last_event_frame
= frame
;
2952 /* If we didn't decide to make a switch-frame event, go ahead and
2953 return a mouse-motion event. */
2954 if (!NILP (x
) && NILP (obj
))
2955 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2957 #endif /* HAVE_MOUSE */
2959 /* We were promised by the above while loop that there was
2960 something for us to read! */
2963 input_pending
= readable_events (0);
2965 Vlast_event_frame
= internal_last_event_frame
;
2970 /* Process any events that are not user-visible,
2971 then return, without reading any user-visible events. */
2974 swallow_events (do_display
)
2979 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2981 struct input_event
*event
;
2983 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2987 last_event_timestamp
= event
->timestamp
;
2989 /* These two kinds of events get special handling
2990 and don't actually appear to the command loop. */
2991 if (event
->kind
== selection_request_event
)
2994 struct input_event copy
;
2996 /* Remove it from the buffer before processing it,
2997 since otherwise swallow_events called recursively could see it
2998 and process it again. */
3000 kbd_fetch_ptr
= event
+ 1;
3001 input_pending
= readable_events (0);
3002 x_handle_selection_request (©
);
3004 /* We're getting selection request events, but we don't have
3010 else if (event
->kind
== selection_clear_event
)
3013 struct input_event copy
;
3015 /* Remove it from the buffer before processing it, */
3018 kbd_fetch_ptr
= event
+ 1;
3019 input_pending
= readable_events (0);
3020 x_handle_selection_clear (©
);
3022 /* We're getting selection request events, but we don't have
3031 old_timers_run
= timers_run
;
3032 get_input_pending (&input_pending
, 1);
3034 if (timers_run
!= old_timers_run
&& do_display
)
3035 redisplay_preserve_echo_area ();
3038 static EMACS_TIME timer_idleness_start_time
;
3040 /* Record the start of when Emacs is idle,
3041 for the sake of running idle-time timers. */
3048 /* If we are already in the idle state, do nothing. */
3049 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3052 EMACS_GET_TIME (timer_idleness_start_time
);
3054 /* Mark all idle-time timers as once again candidates for running. */
3055 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
3059 timer
= XCONS (timers
)->car
;
3061 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3063 XVECTOR (timer
)->contents
[0] = Qnil
;
3067 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3072 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3075 /* This is only for debugging. */
3076 struct input_event last_timer_event
;
3078 /* Check whether a timer has fired. To prevent larger problems we simply
3079 disregard elements that are not proper timers. Do not make a circular
3080 timer list for the time being.
3082 Returns the number of seconds to wait until the next timer fires. If a
3083 timer is triggering now, return zero seconds.
3084 If no timer is active, return -1 seconds.
3086 If a timer is ripe, we run it, with quitting turned off.
3088 DO_IT_NOW is now ignored. It used to mean that we should
3089 run the timer directly instead of queueing a timer-event.
3090 Now we always run timers directly. */
3093 timer_check (do_it_now
)
3096 EMACS_TIME nexttime
;
3097 EMACS_TIME now
, idleness_now
;
3098 Lisp_Object timers
, idle_timers
, chosen_timer
;
3099 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3101 EMACS_SET_SECS (nexttime
, -1);
3102 EMACS_SET_USECS (nexttime
, -1);
3104 /* Always consider the ordinary timers. */
3105 timers
= Vtimer_list
;
3106 /* Consider the idle timers only if Emacs is idle. */
3107 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3108 idle_timers
= Vtimer_idle_list
;
3111 chosen_timer
= Qnil
;
3112 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3114 if (CONSP (timers
) || CONSP (idle_timers
))
3116 EMACS_GET_TIME (now
);
3117 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3118 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3121 while (CONSP (timers
) || CONSP (idle_timers
))
3123 int triggertime
= EMACS_SECS (now
);
3124 Lisp_Object
*vector
;
3125 Lisp_Object timer
, idle_timer
;
3126 EMACS_TIME timer_time
, idle_timer_time
;
3127 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3129 /* Skip past invalid timers and timers already handled. */
3132 timer
= XCONS (timers
)->car
;
3133 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3135 timers
= XCONS (timers
)->cdr
;
3138 vector
= XVECTOR (timer
)->contents
;
3140 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3141 || !INTEGERP (vector
[3])
3142 || ! NILP (vector
[0]))
3144 timers
= XCONS (timers
)->cdr
;
3148 if (!NILP (idle_timers
))
3150 timer
= XCONS (idle_timers
)->car
;
3151 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3153 idle_timers
= XCONS (idle_timers
)->cdr
;
3156 vector
= XVECTOR (timer
)->contents
;
3158 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3159 || !INTEGERP (vector
[3])
3160 || ! NILP (vector
[0]))
3162 idle_timers
= XCONS (idle_timers
)->cdr
;
3167 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3168 based on the next ordinary timer.
3169 TIMER_DIFFERENCE is the distance in time from NOW to when
3170 this timer becomes ripe (negative if it's already ripe). */
3173 timer
= XCONS (timers
)->car
;
3174 vector
= XVECTOR (timer
)->contents
;
3175 EMACS_SET_SECS (timer_time
,
3176 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3177 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3178 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3181 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3182 based on the next idle timer. */
3183 if (!NILP (idle_timers
))
3185 idle_timer
= XCONS (idle_timers
)->car
;
3186 vector
= XVECTOR (idle_timer
)->contents
;
3187 EMACS_SET_SECS (idle_timer_time
,
3188 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3189 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3190 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3193 /* Decide which timer is the next timer,
3194 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3195 Also step down the list where we found that timer. */
3197 if (! NILP (timers
) && ! NILP (idle_timers
))
3200 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3201 if (EMACS_TIME_NEG_P (temp
))
3203 chosen_timer
= timer
;
3204 timers
= XCONS (timers
)->cdr
;
3205 difference
= timer_difference
;
3209 chosen_timer
= idle_timer
;
3210 idle_timers
= XCONS (idle_timers
)->cdr
;
3211 difference
= idle_timer_difference
;
3214 else if (! NILP (timers
))
3216 chosen_timer
= timer
;
3217 timers
= XCONS (timers
)->cdr
;
3218 difference
= timer_difference
;
3222 chosen_timer
= idle_timer
;
3223 idle_timers
= XCONS (idle_timers
)->cdr
;
3224 difference
= idle_timer_difference
;
3226 vector
= XVECTOR (chosen_timer
)->contents
;
3228 /* If timer is rupe, run it if it hasn't been run. */
3229 if (EMACS_TIME_NEG_P (difference
)
3230 || (EMACS_SECS (difference
) == 0
3231 && EMACS_USECS (difference
) == 0))
3233 if (NILP (vector
[0]))
3236 int was_locked
= single_kboard
;
3237 int count
= specpdl_ptr
- specpdl
;
3239 /* Mark the timer as triggered to prevent problems if the lisp
3240 code fails to reschedule it right. */
3243 specbind (Qinhibit_quit
, Qt
);
3245 call1 (Qtimer_event_handler
, chosen_timer
);
3248 unbind_to (count
, Qnil
);
3250 /* Resume allowing input from any kboard, if that was true before. */
3252 any_kboard_state ();
3254 /* Since we have handled the event,
3255 we don't need to tell the caller to wake up and do it. */
3259 /* When we encounter a timer that is still waiting,
3260 return the amount of time to wait before it is ripe. */
3267 /* No timers are pending in the future. */
3268 /* Return 0 if we generated an event, and -1 if not. */
3273 /* Caches for modify_event_symbol. */
3274 static Lisp_Object accent_key_syms
;
3275 static Lisp_Object func_key_syms
;
3276 static Lisp_Object mouse_syms
;
3278 static Lisp_Object mouse_wheel_syms
;
3281 /* This is a list of keysym codes for special "accent" characters.
3282 It parallels lispy_accent_keys. */
3284 static int lispy_accent_codes
[] =
3286 #ifdef XK_dead_circumflex
3291 #ifdef XK_dead_grave
3296 #ifdef XK_dead_tilde
3301 #ifdef XK_dead_diaeresis
3306 #ifdef XK_dead_macron
3311 #ifdef XK_dead_degree
3316 #ifdef XK_dead_acute
3321 #ifdef XK_dead_cedilla
3326 #ifdef XK_dead_breve
3331 #ifdef XK_dead_ogonek
3336 #ifdef XK_dead_caron
3341 #ifdef XK_dead_doubleacute
3342 XK_dead_doubleacute
,
3346 #ifdef XK_dead_abovedot
3353 /* This is a list of Lisp names for special "accent" characters.
3354 It parallels lispy_accent_codes. */
3356 static char *lispy_accent_keys
[] =
3374 #define FUNCTION_KEY_OFFSET 0x0
3376 char *lispy_function_keys
[] =
3380 0, /* VK_LBUTTON 0x01 */
3381 0, /* VK_RBUTTON 0x02 */
3382 "cancel", /* VK_CANCEL 0x03 */
3383 0, /* VK_MBUTTON 0x04 */
3385 0, 0, 0, /* 0x05 .. 0x07 */
3387 "backspace", /* VK_BACK 0x08 */
3388 "tab", /* VK_TAB 0x09 */
3390 0, 0, /* 0x0A .. 0x0B */
3392 "clear", /* VK_CLEAR 0x0C */
3393 "return", /* VK_RETURN 0x0D */
3395 0, 0, /* 0x0E .. 0x0F */
3397 "shift", /* VK_SHIFT 0x10 */
3398 "control", /* VK_CONTROL 0x11 */
3399 "menu", /* VK_MENU 0x12 */
3400 "pause", /* VK_PAUSE 0x13 */
3401 "capital", /* VK_CAPITAL 0x14 */
3403 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3405 0, /* VK_ESCAPE 0x1B */
3407 0, 0, 0, 0, /* 0x1C .. 0x1F */
3409 0, /* VK_SPACE 0x20 */
3410 "prior", /* VK_PRIOR 0x21 */
3411 "next", /* VK_NEXT 0x22 */
3412 "end", /* VK_END 0x23 */
3413 "home", /* VK_HOME 0x24 */
3414 "left", /* VK_LEFT 0x25 */
3415 "up", /* VK_UP 0x26 */
3416 "right", /* VK_RIGHT 0x27 */
3417 "down", /* VK_DOWN 0x28 */
3418 "select", /* VK_SELECT 0x29 */
3419 "print", /* VK_PRINT 0x2A */
3420 "execute", /* VK_EXECUTE 0x2B */
3421 "snapshot", /* VK_SNAPSHOT 0x2C */
3422 "insert", /* VK_INSERT 0x2D */
3423 "delete", /* VK_DELETE 0x2E */
3424 "help", /* VK_HELP 0x2F */
3426 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3428 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3430 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3432 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3434 0, 0, 0, 0, 0, 0, 0, 0, 0,
3435 0, 0, 0, 0, 0, 0, 0, 0, 0,
3436 0, 0, 0, 0, 0, 0, 0, 0,
3438 "lwindow", /* VK_LWIN 0x5B */
3439 "rwindow", /* VK_RWIN 0x5C */
3440 "apps", /* VK_APPS 0x5D */
3442 0, 0, /* 0x5E .. 0x5F */
3444 "kp-0", /* VK_NUMPAD0 0x60 */
3445 "kp-1", /* VK_NUMPAD1 0x61 */
3446 "kp-2", /* VK_NUMPAD2 0x62 */
3447 "kp-3", /* VK_NUMPAD3 0x63 */
3448 "kp-4", /* VK_NUMPAD4 0x64 */
3449 "kp-5", /* VK_NUMPAD5 0x65 */
3450 "kp-6", /* VK_NUMPAD6 0x66 */
3451 "kp-7", /* VK_NUMPAD7 0x67 */
3452 "kp-8", /* VK_NUMPAD8 0x68 */
3453 "kp-9", /* VK_NUMPAD9 0x69 */
3454 "kp-multiply", /* VK_MULTIPLY 0x6A */
3455 "kp-add", /* VK_ADD 0x6B */
3456 "kp-separator", /* VK_SEPARATOR 0x6C */
3457 "kp-subtract", /* VK_SUBTRACT 0x6D */
3458 "kp-decimal", /* VK_DECIMAL 0x6E */
3459 "kp-divide", /* VK_DIVIDE 0x6F */
3460 "f1", /* VK_F1 0x70 */
3461 "f2", /* VK_F2 0x71 */
3462 "f3", /* VK_F3 0x72 */
3463 "f4", /* VK_F4 0x73 */
3464 "f5", /* VK_F5 0x74 */
3465 "f6", /* VK_F6 0x75 */
3466 "f7", /* VK_F7 0x76 */
3467 "f8", /* VK_F8 0x77 */
3468 "f9", /* VK_F9 0x78 */
3469 "f10", /* VK_F10 0x79 */
3470 "f11", /* VK_F11 0x7A */
3471 "f12", /* VK_F12 0x7B */
3472 "f13", /* VK_F13 0x7C */
3473 "f14", /* VK_F14 0x7D */
3474 "f15", /* VK_F15 0x7E */
3475 "f16", /* VK_F16 0x7F */
3476 "f17", /* VK_F17 0x80 */
3477 "f18", /* VK_F18 0x81 */
3478 "f19", /* VK_F19 0x82 */
3479 "f20", /* VK_F20 0x83 */
3480 "f21", /* VK_F21 0x84 */
3481 "f22", /* VK_F22 0x85 */
3482 "f23", /* VK_F23 0x86 */
3483 "f24", /* VK_F24 0x87 */
3485 0, 0, 0, 0, /* 0x88 .. 0x8B */
3486 0, 0, 0, 0, /* 0x8C .. 0x8F */
3488 "kp-numlock", /* VK_NUMLOCK 0x90 */
3489 "scroll", /* VK_SCROLL 0x91 */
3491 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3492 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3493 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3494 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3495 "kp-end", /* VK_NUMPAD_END 0x96 */
3496 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3497 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3498 "kp-up", /* VK_NUMPAD_UP 0x99 */
3499 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3500 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3501 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3502 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3504 0, 0, /* 0x9E .. 0x9F */
3507 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3508 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3509 * No other API or message will distinguish left and right keys this way.
3513 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3514 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3515 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3516 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3517 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3523 "attn", /* VK_ATTN 0xF6 */
3524 "crsel", /* VK_CRSEL 0xF7 */
3525 "exsel", /* VK_EXSEL 0xF8 */
3526 "ereof", /* VK_EREOF 0xF9 */
3527 "play", /* VK_PLAY 0xFA */
3528 "zoom", /* VK_ZOOM 0xFB */
3529 "noname", /* VK_NONAME 0xFC */
3530 "pa1", /* VK_PA1 0xFD */
3531 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3534 #else /* not HAVE_NTGUI */
3537 static char *lispy_kana_keys
[] =
3539 /* X Keysym value */
3540 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3541 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3542 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3543 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3544 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3545 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3546 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3547 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3548 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3549 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3550 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3551 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3552 "kana-i", "kana-u", "kana-e", "kana-o",
3553 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3554 "prolongedsound", "kana-A", "kana-I", "kana-U",
3555 "kana-E", "kana-O", "kana-KA", "kana-KI",
3556 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3557 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3558 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3559 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3560 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3561 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3562 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3563 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3564 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3565 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3566 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3567 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3569 #endif /* XK_kana_A */
3571 #define FUNCTION_KEY_OFFSET 0xff00
3573 /* You'll notice that this table is arranged to be conveniently
3574 indexed by X Windows keysym values. */
3575 static char *lispy_function_keys
[] =
3577 /* X Keysym value */
3579 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3587 0, 0, 0, /* 0xff10 */
3589 0, 0, 0, 0, 0, 0, 0,
3592 0, "kanji", "muhenkan",
3593 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3594 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3595 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3597 "home", /* 0xff50 */ /* IsCursorKey */
3608 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3619 "break", /* 0xff6b */
3621 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3623 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3624 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3625 0, 0, 0, 0, 0, 0, 0, 0,
3626 "kp-tab", /* 0xff89 */
3628 "kp-enter", /* 0xff8d */
3630 "kp-f1", /* 0xff91 */
3634 "kp-home", /* 0xff95 */
3639 "kp-prior", /* kp-page-up */
3640 "kp-next", /* kp-page-down */
3646 0, 0, 0, 0, 0, 0, 0, 0, 0,
3647 "kp-multiply", /* 0xffaa */
3652 "kp-divide", /* 0xffaf */
3653 "kp-0", /* 0xffb0 */
3654 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3657 "kp-equal", /* 0xffbd */
3658 "f1", /* 0xffbe */ /* IsFunctionKey */
3660 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3661 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3662 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3663 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3664 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3665 0, 0, 0, 0, 0, 0, 0, 0,
3666 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3667 0, 0, 0, 0, 0, 0, 0, "delete"
3670 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3671 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3673 static char *iso_lispy_function_keys
[] =
3675 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3676 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3677 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3678 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3679 "iso-lefttab", /* 0xfe20 */
3680 "iso-move-line-up", "iso-move-line-down",
3681 "iso-partial-line-up", "iso-partial-line-down",
3682 "iso-partial-space-left", "iso-partial-space-right",
3683 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3684 "iso-release-margin-left", "iso-release-margin-right",
3685 "iso-release-both-margins",
3686 "iso-fast-cursor-left", "iso-fast-cursor-right",
3687 "iso-fast-cursor-up", "iso-fast-cursor-down",
3688 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3689 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3692 #endif /* not HAVE_NTGUI */
3694 static char *lispy_mouse_names
[] =
3696 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3700 /* mouse-wheel events are generated by the wheel on devices such as
3701 the MS Intellimouse. The wheel sits in between the left and right
3702 mouse buttons, and is typically used to scroll or zoom the window
3703 underneath the pointer. mouse-wheel events specify the object on
3704 which they operate, and a delta corresponding to the amount and
3705 direction that the wheel is rotated. Clicking the mouse-wheel
3706 generates a mouse-2 event. */
3707 static char *lispy_mouse_wheel_names
[] =
3711 #endif /* WINDOWSNT */
3713 /* Scroll bar parts. */
3714 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3715 Lisp_Object Qup
, Qdown
;
3717 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3718 Lisp_Object
*scroll_bar_parts
[] = {
3719 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3724 /* A vector, indexed by button number, giving the down-going location
3725 of currently depressed buttons, both scroll bar and non-scroll bar.
3727 The elements have the form
3728 (BUTTON-NUMBER MODIFIER-MASK . REST)
3729 where REST is the cdr of a position as it would be reported in the event.
3731 The make_lispy_event function stores positions here to tell the
3732 difference between click and drag events, and to store the starting
3733 location to be included in drag events. */
3735 static Lisp_Object button_down_location
;
3737 /* Information about the most recent up-going button event: Which
3738 button, what location, and what time. */
3740 static int last_mouse_button
;
3741 static int last_mouse_x
;
3742 static int last_mouse_y
;
3743 static unsigned long button_down_time
;
3745 /* The maximum time between clicks to make a double-click,
3746 or Qnil to disable double-click detection,
3747 or Qt for no time limit. */
3748 Lisp_Object Vdouble_click_time
;
3750 /* The number of clicks in this multiple-click. */
3752 int double_click_count
;
3754 /* Given a struct input_event, build the lisp event which represents
3755 it. If EVENT is 0, build a mouse movement event from the mouse
3756 movement buffer, which should have a movement event in it.
3758 Note that events must be passed to this function in the order they
3759 are received; this function stores the location of button presses
3760 in order to build drag events when the button is released. */
3763 make_lispy_event (event
)
3764 struct input_event
*event
;
3768 switch (SWITCH_ENUM_CAST (event
->kind
))
3770 /* A simple keystroke. */
3771 case ascii_keystroke
:
3773 Lisp_Object lispy_c
;
3774 int c
= event
->code
& 0377;
3775 /* Turn ASCII characters into control characters
3777 if (event
->modifiers
& ctrl_modifier
)
3778 c
= make_ctrl_char (c
);
3780 /* Add in the other modifier bits. We took care of ctrl_modifier
3781 just above, and the shift key was taken care of by the X code,
3782 and applied to control characters by make_ctrl_char. */
3783 c
|= (event
->modifiers
3784 & (meta_modifier
| alt_modifier
3785 | hyper_modifier
| super_modifier
));
3786 /* Distinguish Shift-SPC from SPC. */
3787 if ((event
->code
& 0377) == 040
3788 && event
->modifiers
& shift_modifier
)
3789 c
|= shift_modifier
;
3790 button_down_time
= 0;
3791 XSETFASTINT (lispy_c
, c
);
3795 /* A function key. The symbol may need to have modifier prefixes
3797 case non_ascii_keystroke
:
3798 button_down_time
= 0;
3800 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3801 if (event
->code
== lispy_accent_codes
[i
])
3802 return modify_event_symbol (i
,
3804 Qfunction_key
, Qnil
,
3805 lispy_accent_keys
, &accent_key_syms
,
3806 (sizeof (lispy_accent_keys
)
3807 / sizeof (lispy_accent_keys
[0])));
3809 /* Handle system-specific keysyms. */
3810 if (event
->code
& (1 << 28))
3812 /* We need to use an alist rather than a vector as the cache
3813 since we can't make a vector long enuf. */
3814 if (NILP (current_kboard
->system_key_syms
))
3815 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3816 return modify_event_symbol (event
->code
,
3819 current_kboard
->Vsystem_key_alist
,
3820 0, ¤t_kboard
->system_key_syms
,
3825 if (event
->code
>= 0x400 && event
->code
< 0x500)
3826 return modify_event_symbol (event
->code
- 0x400,
3827 event
->modifiers
& ~shift_modifier
,
3828 Qfunction_key
, Qnil
,
3829 lispy_kana_keys
, &func_key_syms
,
3830 (sizeof (lispy_kana_keys
)
3831 / sizeof (lispy_kana_keys
[0])));
3832 #endif /* XK_kana_A */
3834 #ifdef ISO_FUNCTION_KEY_OFFSET
3835 if (event
->code
< FUNCTION_KEY_OFFSET
3836 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
3837 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
3839 Qfunction_key
, Qnil
,
3840 iso_lispy_function_keys
, &func_key_syms
,
3841 (sizeof (iso_lispy_function_keys
)
3842 / sizeof (iso_lispy_function_keys
[0])));
3845 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3847 Qfunction_key
, Qnil
,
3848 lispy_function_keys
, &func_key_syms
,
3849 (sizeof (lispy_function_keys
)
3850 / sizeof (lispy_function_keys
[0])));
3853 /* A mouse click. Figure out where it is, decide whether it's
3854 a press, click or drag, and build the appropriate structure. */
3856 case scroll_bar_click
:
3858 int button
= event
->code
;
3860 Lisp_Object position
;
3861 Lisp_Object
*start_pos_ptr
;
3862 Lisp_Object start_pos
;
3864 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3867 /* Build the position as appropriate for this mouse click. */
3868 if (event
->kind
== mouse_click
)
3871 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3876 /* Ignore mouse events that were made on frame that
3877 have been deleted. */
3878 if (! FRAME_LIVE_P (f
))
3881 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3882 &column
, &row
, NULL
, 1);
3884 #ifndef USE_X_TOOLKIT
3885 /* In the non-toolkit version, clicks on the menu bar
3886 are ordinary button events in the event buffer.
3887 Distinguish them, and invoke the menu.
3889 (In the toolkit version, the toolkit handles the menu bar
3890 and Emacs doesn't know about it until after the user
3891 makes a selection.) */
3892 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3893 && (event
->modifiers
& down_modifier
))
3895 Lisp_Object items
, item
;
3900 /* Activate the menu bar on the down event. If the
3901 up event comes in before the menu code can deal with it,
3903 if (! (event
->modifiers
& down_modifier
))
3908 items
= FRAME_MENU_BAR_ITEMS (f
);
3909 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3911 Lisp_Object pos
, string
;
3912 string
= XVECTOR (items
)->contents
[i
+ 1];
3913 pos
= XVECTOR (items
)->contents
[i
+ 3];
3916 if (column
>= XINT (pos
)
3917 && column
< XINT (pos
) + XSTRING (string
)->size
)
3919 item
= XVECTOR (items
)->contents
[i
];
3925 = Fcons (event
->frame_or_window
,
3927 Fcons (Fcons (event
->x
, event
->y
),
3928 Fcons (make_number (event
->timestamp
),
3931 return Fcons (item
, Fcons (position
, Qnil
));
3933 #endif /* not USE_X_TOOLKIT */
3935 window
= window_from_coordinates (f
, column
, row
, &part
);
3937 if (!WINDOWP (window
))
3939 window
= event
->frame_or_window
;
3944 int pixcolumn
, pixrow
;
3945 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3946 row
-= XINT (XWINDOW (window
)->top
);
3947 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3948 XSETINT (event
->x
, pixcolumn
);
3949 XSETINT (event
->y
, pixrow
);
3954 posn
= Qvertical_line
;
3957 buffer_posn_from_coords (XWINDOW (window
),
3964 Fcons (Fcons (event
->x
, event
->y
),
3965 Fcons (make_number (event
->timestamp
),
3971 Lisp_Object portion_whole
;
3974 window
= event
->frame_or_window
;
3975 portion_whole
= Fcons (event
->x
, event
->y
);
3976 part
= *scroll_bar_parts
[(int) event
->part
];
3980 Fcons (Qvertical_scroll_bar
,
3981 Fcons (portion_whole
,
3982 Fcons (make_number (event
->timestamp
),
3983 Fcons (part
, Qnil
)))));
3986 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3988 start_pos
= *start_pos_ptr
;
3989 *start_pos_ptr
= Qnil
;
3991 is_double
= (button
== last_mouse_button
3992 && XINT (event
->x
) == last_mouse_x
3993 && XINT (event
->y
) == last_mouse_y
3994 && button_down_time
!= 0
3995 && (EQ (Vdouble_click_time
, Qt
)
3996 || (INTEGERP (Vdouble_click_time
)
3997 && ((int)(event
->timestamp
- button_down_time
)
3998 < XINT (Vdouble_click_time
)))));
3999 last_mouse_button
= button
;
4000 last_mouse_x
= XINT (event
->x
);
4001 last_mouse_y
= XINT (event
->y
);
4003 /* If this is a button press, squirrel away the location, so
4004 we can decide later whether it was a click or a drag. */
4005 if (event
->modifiers
& down_modifier
)
4009 double_click_count
++;
4010 event
->modifiers
|= ((double_click_count
> 2)
4015 double_click_count
= 1;
4016 button_down_time
= event
->timestamp
;
4017 *start_pos_ptr
= Fcopy_alist (position
);
4020 /* Now we're releasing a button - check the co-ordinates to
4021 see if this was a click or a drag. */
4022 else if (event
->modifiers
& up_modifier
)
4024 /* If we did not see a down before this up,
4025 ignore the up. Probably this happened because
4026 the down event chose a menu item.
4027 It would be an annoyance to treat the release
4028 of the button that chose the menu item
4029 as a separate event. */
4031 if (!CONSP (start_pos
))
4034 event
->modifiers
&= ~up_modifier
;
4035 #if 0 /* Formerly we treated an up with no down as a click event. */
4036 if (!CONSP (start_pos
))
4037 event
->modifiers
|= click_modifier
;
4041 /* The third element of every position should be the (x,y)
4045 down
= Fnth (make_number (2), start_pos
);
4046 if (EQ (event
->x
, XCONS (down
)->car
)
4047 && EQ (event
->y
, XCONS (down
)->cdr
))
4049 event
->modifiers
|= click_modifier
;
4053 button_down_time
= 0;
4054 event
->modifiers
|= drag_modifier
;
4056 /* Don't check is_double; treat this as multiple
4057 if the down-event was multiple. */
4058 if (double_click_count
> 1)
4059 event
->modifiers
|= ((double_click_count
> 2)
4065 /* Every mouse event should either have the down_modifier or
4066 the up_modifier set. */
4070 /* Get the symbol we should use for the mouse click. */
4073 head
= modify_event_symbol (button
,
4076 lispy_mouse_names
, &mouse_syms
,
4077 (sizeof (lispy_mouse_names
)
4078 / sizeof (lispy_mouse_names
[0])));
4079 if (event
->modifiers
& drag_modifier
)
4084 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4087 Fcons (make_number (double_click_count
),
4097 case w32_scroll_bar_click
:
4099 int button
= event
->code
;
4101 Lisp_Object position
;
4102 Lisp_Object
*start_pos_ptr
;
4103 Lisp_Object start_pos
;
4105 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4110 Lisp_Object portion_whole
;
4113 window
= event
->frame_or_window
;
4114 portion_whole
= Fcons (event
->x
, event
->y
);
4115 part
= *scroll_bar_parts
[(int) event
->part
];
4119 Fcons (Qvertical_scroll_bar
,
4120 Fcons (portion_whole
,
4121 Fcons (make_number (event
->timestamp
),
4122 Fcons (part
, Qnil
)))));
4125 /* Always treat W32 scroll bar events as clicks. */
4126 event
->modifiers
|= click_modifier
;
4129 /* Get the symbol we should use for the mouse click. */
4132 head
= modify_event_symbol (button
,
4135 lispy_mouse_names
, &mouse_syms
,
4136 (sizeof (lispy_mouse_names
)
4137 / sizeof (lispy_mouse_names
[0])));
4146 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4149 Lisp_Object head
, position
;
4152 /* Ignore mouse events that were made on frame that
4153 have been deleted. */
4154 if (! FRAME_LIVE_P (f
))
4156 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4157 &column
, &row
, NULL
, 1);
4158 window
= window_from_coordinates (f
, column
, row
, &part
);
4160 if (!WINDOWP (window
))
4162 window
= event
->frame_or_window
;
4167 int pixcolumn
, pixrow
;
4168 column
-= XINT (XWINDOW (window
)->left
);
4169 row
-= XINT (XWINDOW (window
)->top
);
4170 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4171 XSETINT (event
->x
, pixcolumn
);
4172 XSETINT (event
->y
, pixrow
);
4177 posn
= Qvertical_line
;
4180 buffer_posn_from_coords (XWINDOW (window
),
4185 Lisp_Object head
, position
;
4190 Fcons (Fcons (event
->x
, event
->y
),
4191 Fcons (make_number (event
->timestamp
),
4194 head
= modify_event_symbol (0, event
->modifiers
,
4196 lispy_mouse_wheel_names
,
4197 &mouse_wheel_syms
, 1);
4200 Fcons (make_number (event
->code
),
4204 #endif /* WINDOWSNT */
4205 #endif /* HAVE_MOUSE */
4207 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4208 case menu_bar_event
:
4209 /* The event value is in the cdr of the frame_or_window slot. */
4210 if (!CONSP (event
->frame_or_window
))
4212 return XCONS (event
->frame_or_window
)->cdr
;
4215 /* The 'kind' field of the event is something we don't recognize. */
4224 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4226 Lisp_Object bar_window
;
4227 enum scroll_bar_part part
;
4231 /* Is it a scroll bar movement? */
4232 if (frame
&& ! NILP (bar_window
))
4234 Lisp_Object part_sym
;
4236 part_sym
= *scroll_bar_parts
[(int) part
];
4237 return Fcons (Qscroll_bar_movement
,
4238 (Fcons (Fcons (bar_window
,
4239 Fcons (Qvertical_scroll_bar
,
4240 Fcons (Fcons (x
, y
),
4241 Fcons (make_number (time
),
4247 /* Or is it an ordinary mouse movement? */
4257 /* It's in a frame; which window on that frame? */
4258 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4260 window
= window_from_coordinates (frame
, column
, row
, &area
);
4265 if (WINDOWP (window
))
4267 int pixcolumn
, pixrow
;
4268 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4269 row
-= XINT (XWINDOW (window
)->top
);
4270 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4271 XSETINT (x
, pixcolumn
);
4272 XSETINT (y
, pixrow
);
4277 posn
= Qvertical_line
;
4280 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4282 else if (frame
!= 0)
4284 XSETFRAME (window
, frame
);
4295 return Fcons (Qmouse_movement
,
4296 Fcons (Fcons (window
,
4298 Fcons (Fcons (x
, y
),
4299 Fcons (make_number (time
),
4305 #endif /* HAVE_MOUSE */
4307 /* Construct a switch frame event. */
4309 make_lispy_switch_frame (frame
)
4312 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4315 /* Manipulating modifiers. */
4317 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4319 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4320 SYMBOL's name of the end of the modifiers; the string from this
4321 position is the unmodified symbol name.
4323 This doesn't use any caches. */
4326 parse_modifiers_uncached (symbol
, modifier_end
)
4330 struct Lisp_String
*name
;
4334 CHECK_SYMBOL (symbol
, 1);
4337 name
= XSYMBOL (symbol
)->name
;
4339 for (i
= 0; i
+2 <= name
->size_byte
; )
4341 int this_mod_end
= 0;
4344 /* See if the name continues with a modifier word.
4345 Check that the word appears, but don't check what follows it.
4346 Set this_mod and this_mod_end to record what we find. */
4348 switch (name
->data
[i
])
4350 #define SINGLE_LETTER_MOD(BIT) \
4351 (this_mod_end = i + 1, this_mod = BIT)
4354 SINGLE_LETTER_MOD (alt_modifier
);
4358 SINGLE_LETTER_MOD (ctrl_modifier
);
4362 SINGLE_LETTER_MOD (hyper_modifier
);
4366 SINGLE_LETTER_MOD (meta_modifier
);
4370 SINGLE_LETTER_MOD (shift_modifier
);
4374 SINGLE_LETTER_MOD (super_modifier
);
4377 #undef SINGLE_LETTER_MOD
4380 /* If we found no modifier, stop looking for them. */
4381 if (this_mod_end
== 0)
4384 /* Check there is a dash after the modifier, so that it
4385 really is a modifier. */
4386 if (this_mod_end
>= name
->size_byte
|| name
->data
[this_mod_end
] != '-')
4389 /* This modifier is real; look for another. */
4390 modifiers
|= this_mod
;
4391 i
= this_mod_end
+ 1;
4394 /* Should we include the `click' modifier? */
4395 if (! (modifiers
& (down_modifier
| drag_modifier
4396 | double_modifier
| triple_modifier
))
4397 && i
+ 7 == name
->size_byte
4398 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4399 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4400 modifiers
|= click_modifier
;
4408 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4409 prepended to the string BASE[0..BASE_LEN-1].
4410 This doesn't use any caches. */
4412 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
4415 int base_len
, base_len_byte
;
4417 /* Since BASE could contain nulls, we can't use intern here; we have
4418 to use Fintern, which expects a genuine Lisp_String, and keeps a
4421 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4427 /* Only the event queue may use the `up' modifier; it should always
4428 be turned into a click or drag event before presented to lisp code. */
4429 if (modifiers
& up_modifier
)
4432 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4433 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4434 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4435 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4436 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4437 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4438 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4439 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4440 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4441 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4442 /* The click modifier is denoted by the absence of other modifiers. */
4446 mod_len
= p
- new_mods
;
4450 Lisp_Object new_name
;
4452 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
4453 mod_len
+ base_len_byte
);
4454 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4455 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
4457 return Fintern (new_name
, Qnil
);
4462 static char *modifier_names
[] =
4464 "up", "down", "drag", "click", "double", "triple", 0, 0,
4465 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4466 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4468 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4470 static Lisp_Object modifier_symbols
;
4472 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4474 lispy_modifier_list (modifiers
)
4477 Lisp_Object modifier_list
;
4480 modifier_list
= Qnil
;
4481 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4482 if (modifiers
& (1<<i
))
4483 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4486 return modifier_list
;
4490 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4491 where UNMODIFIED is the unmodified form of SYMBOL,
4492 MASK is the set of modifiers present in SYMBOL's name.
4493 This is similar to parse_modifiers_uncached, but uses the cache in
4494 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4495 Qevent_symbol_elements property. */
4498 parse_modifiers (symbol
)
4501 Lisp_Object elements
;
4503 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4504 if (CONSP (elements
))
4509 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4510 Lisp_Object unmodified
;
4513 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4514 XSYMBOL (symbol
)->name
->size_byte
- end
),
4517 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4519 XSETFASTINT (mask
, modifiers
);
4520 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4522 /* Cache the parsing results on SYMBOL. */
4523 Fput (symbol
, Qevent_symbol_element_mask
,
4525 Fput (symbol
, Qevent_symbol_elements
,
4526 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4528 /* Since we know that SYMBOL is modifiers applied to unmodified,
4529 it would be nice to put that in unmodified's cache.
4530 But we can't, since we're not sure that parse_modifiers is
4537 /* Apply the modifiers MODIFIERS to the symbol BASE.
4538 BASE must be unmodified.
4540 This is like apply_modifiers_uncached, but uses BASE's
4541 Qmodifier_cache property, if present. It also builds
4542 Qevent_symbol_elements properties, since it has that info anyway.
4544 apply_modifiers copies the value of BASE's Qevent_kind property to
4545 the modified symbol. */
4547 apply_modifiers (modifiers
, base
)
4551 Lisp_Object cache
, index
, entry
, new_symbol
;
4553 /* Mask out upper bits. We don't know where this value's been. */
4554 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4556 /* The click modifier never figures into cache indices. */
4557 cache
= Fget (base
, Qmodifier_cache
);
4558 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4559 entry
= assq_no_quit (index
, cache
);
4562 new_symbol
= XCONS (entry
)->cdr
;
4565 /* We have to create the symbol ourselves. */
4566 new_symbol
= apply_modifiers_uncached (modifiers
,
4567 XSYMBOL (base
)->name
->data
,
4568 XSYMBOL (base
)->name
->size
,
4569 XSYMBOL (base
)->name
->size_byte
);
4571 /* Add the new symbol to the base's cache. */
4572 entry
= Fcons (index
, new_symbol
);
4573 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4575 /* We have the parsing info now for free, so add it to the caches. */
4576 XSETFASTINT (index
, modifiers
);
4577 Fput (new_symbol
, Qevent_symbol_element_mask
,
4578 Fcons (base
, Fcons (index
, Qnil
)));
4579 Fput (new_symbol
, Qevent_symbol_elements
,
4580 Fcons (base
, lispy_modifier_list (modifiers
)));
4583 /* Make sure this symbol is of the same kind as BASE.
4585 You'd think we could just set this once and for all when we
4586 intern the symbol above, but reorder_modifiers may call us when
4587 BASE's property isn't set right; we can't assume that just
4588 because it has a Qmodifier_cache property it must have its
4589 Qevent_kind set right as well. */
4590 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4594 kind
= Fget (base
, Qevent_kind
);
4596 Fput (new_symbol
, Qevent_kind
, kind
);
4603 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4604 return a symbol with the modifiers placed in the canonical order.
4605 Canonical order is alphabetical, except for down and drag, which
4606 always come last. The 'click' modifier is never written out.
4608 Fdefine_key calls this to make sure that (for example) C-M-foo
4609 and M-C-foo end up being equivalent in the keymap. */
4612 reorder_modifiers (symbol
)
4615 /* It's hopefully okay to write the code this way, since everything
4616 will soon be in caches, and no consing will be done at all. */
4619 parsed
= parse_modifiers (symbol
);
4620 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4621 XCONS (parsed
)->car
);
4625 /* For handling events, we often want to produce a symbol whose name
4626 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4627 to some base, like the name of a function key or mouse button.
4628 modify_event_symbol produces symbols of this sort.
4630 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4631 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4634 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4635 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4637 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4638 persist between calls to modify_event_symbol that it can use to
4639 store a cache of the symbols it's generated for this NAME_TABLE
4640 before. The object stored there may be a vector or an alist.
4642 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4644 MODIFIERS is a set of modifier bits (as given in struct input_events)
4645 whose prefixes should be applied to the symbol name.
4647 SYMBOL_KIND is the value to be placed in the event_kind property of
4648 the returned symbol.
4650 The symbols we create are supposed to have an
4651 `event-symbol-elements' property, which lists the modifiers present
4652 in the symbol's name. */
4655 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4656 name_table
, symbol_table
, table_size
)
4659 Lisp_Object symbol_kind
;
4660 Lisp_Object name_alist
;
4662 Lisp_Object
*symbol_table
;
4663 unsigned int table_size
;
4666 Lisp_Object symbol_int
;
4668 /* Get rid of the "vendor-specific" bit here. */
4669 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4671 /* Is this a request for a valid symbol? */
4672 if (symbol_num
< 0 || symbol_num
>= table_size
)
4675 if (CONSP (*symbol_table
))
4676 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4678 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4679 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4680 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4681 we've never used that symbol before. */
4684 if (! VECTORP (*symbol_table
)
4685 || XVECTOR (*symbol_table
)->size
!= table_size
)
4689 XSETFASTINT (size
, table_size
);
4690 *symbol_table
= Fmake_vector (size
, Qnil
);
4693 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4696 /* Have we already used this symbol before? */
4699 /* No; let's create it. */
4700 if (!NILP (name_alist
))
4701 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4702 else if (name_table
!= 0 && name_table
[symbol_num
])
4703 value
= intern (name_table
[symbol_num
]);
4705 #ifdef HAVE_WINDOW_SYSTEM
4708 char *name
= x_get_keysym_name (symbol_num
);
4710 value
= intern (name
);
4717 sprintf (buf
, "key-%d", symbol_num
);
4718 value
= intern (buf
);
4721 if (CONSP (*symbol_table
))
4722 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4724 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4726 /* Fill in the cache entries for this symbol; this also
4727 builds the Qevent_symbol_elements property, which the user
4729 apply_modifiers (modifiers
& click_modifier
, value
);
4730 Fput (value
, Qevent_kind
, symbol_kind
);
4733 /* Apply modifiers to that symbol. */
4734 return apply_modifiers (modifiers
, value
);
4737 /* Convert a list that represents an event type,
4738 such as (ctrl meta backspace), into the usual representation of that
4739 event type as a number or a symbol. */
4741 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4742 "Convert the event description list EVENT-DESC to an event type.\n\
4743 EVENT-DESC should contain one base event type (a character or symbol)\n\
4744 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4745 drag, down, double or triple). The base must be last.\n\
4746 The return value is an event type (a character or symbol) which\n\
4747 has the same base event type and all the specified modifiers.")
4749 Lisp_Object event_desc
;
4757 while (CONSP (rest
))
4762 elt
= XCONS (rest
)->car
;
4763 rest
= XCONS (rest
)->cdr
;
4765 /* Given a symbol, see if it is a modifier name. */
4766 if (SYMBOLP (elt
) && CONSP (rest
))
4767 this = parse_solitary_modifier (elt
);
4771 else if (!NILP (base
))
4772 error ("Two bases given in one event");
4778 /* Let the symbol A refer to the character A. */
4779 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4780 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4782 if (INTEGERP (base
))
4784 /* Turn (shift a) into A. */
4785 if ((modifiers
& shift_modifier
) != 0
4786 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4788 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4789 modifiers
&= ~shift_modifier
;
4792 /* Turn (control a) into C-a. */
4793 if (modifiers
& ctrl_modifier
)
4794 return make_number ((modifiers
& ~ctrl_modifier
)
4795 | make_ctrl_char (XINT (base
)));
4797 return make_number (modifiers
| XINT (base
));
4799 else if (SYMBOLP (base
))
4800 return apply_modifiers (modifiers
, base
);
4802 error ("Invalid base event");
4805 /* Try to recognize SYMBOL as a modifier name.
4806 Return the modifier flag bit, or 0 if not recognized. */
4809 parse_solitary_modifier (symbol
)
4812 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4814 switch (name
->data
[0])
4816 #define SINGLE_LETTER_MOD(BIT) \
4817 if (name->size_byte == 1) \
4820 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4821 if (LEN == name->size_byte \
4822 && ! strncmp (name->data, NAME, LEN)) \
4826 SINGLE_LETTER_MOD (alt_modifier
);
4830 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4834 SINGLE_LETTER_MOD (ctrl_modifier
);
4838 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4839 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4843 SINGLE_LETTER_MOD (hyper_modifier
);
4847 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4851 SINGLE_LETTER_MOD (meta_modifier
);
4855 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4859 SINGLE_LETTER_MOD (shift_modifier
);
4863 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4864 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4865 SINGLE_LETTER_MOD (super_modifier
);
4869 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4870 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4871 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4875 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4878 #undef SINGLE_LETTER_MOD
4879 #undef MULTI_LETTER_MOD
4885 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4886 Such a list is not valid as an event,
4887 but it can be a Lucid-style event type list. */
4890 lucid_event_type_list_p (object
)
4895 if (! CONSP (object
))
4898 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4901 elt
= XCONS (tail
)->car
;
4902 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4909 /* Store into *addr a value nonzero if terminal input chars are available.
4910 Serves the purpose of ioctl (0, FIONREAD, addr)
4911 but works even if FIONREAD does not exist.
4912 (In fact, this may actually read some input.)
4914 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4917 get_input_pending (addr
, do_timers_now
)
4921 /* First of all, have we already counted some input? */
4922 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4924 /* If input is being read as it arrives, and we have none, there is none. */
4925 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4928 /* Try to read some input and see how much we get. */
4930 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4933 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4936 gobble_input (expected
)
4941 if (interrupt_input
)
4944 mask
= sigblock (sigmask (SIGIO
));
4945 read_avail_input (expected
);
4949 #ifdef POLL_FOR_INPUT
4950 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4953 mask
= sigblock (sigmask (SIGALRM
));
4954 read_avail_input (expected
);
4960 read_avail_input (expected
);
4964 /* Put a buffer_switch_event in the buffer
4965 so that read_key_sequence will notice the new current buffer. */
4968 record_asynch_buffer_change ()
4970 struct input_event event
;
4973 event
.kind
= buffer_switch_event
;
4974 event
.frame_or_window
= Qnil
;
4977 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4978 The purpose of the event is to make read_key_sequence look up the
4979 keymaps again. If we aren't in read_key_sequence, we don't need one,
4980 and the event could cause trouble by messing up (input-pending-p). */
4981 tem
= Fwaiting_for_user_input_p ();
4985 /* We never need these events if we have no asynchronous subprocesses. */
4989 /* Make sure no interrupt happens while storing the event. */
4991 if (interrupt_input
)
4994 mask
= sigblock (sigmask (SIGIO
));
4995 kbd_buffer_store_event (&event
);
5002 kbd_buffer_store_event (&event
);
5009 /* Read any terminal input already buffered up by the system
5010 into the kbd_buffer, but do not wait.
5012 EXPECTED should be nonzero if the caller knows there is some input.
5014 Except on VMS, all input is read by this function.
5015 If interrupt_input is nonzero, this function MUST be called
5016 only when SIGIO is blocked.
5018 Returns the number of keyboard chars read, or -1 meaning
5019 this is a bad time to try to read input. */
5022 read_avail_input (expected
)
5025 struct input_event buf
[KBD_BUFFER_SIZE
];
5029 if (read_socket_hook
)
5030 /* No need for FIONREAD or fcntl; just say don't wait. */
5031 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
5034 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
5035 the kbd_buffer can really hold. That may prevent loss
5036 of characters on some systems when input is stuffed at us. */
5037 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
5040 /* Determine how many characters we should *try* to read. */
5043 #else /* not WINDOWSNT */
5045 n_to_read
= dos_keysns ();
5048 #else /* not MSDOS */
5050 /* Find out how much input is available. */
5051 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
5052 /* Formerly simply reported no input, but that sometimes led to
5053 a failure of Emacs to terminate.
5054 SIGHUP seems appropriate if we can't reach the terminal. */
5055 /* ??? Is it really right to send the signal just to this process
5056 rather than to the whole process group?
5057 Perhaps on systems with FIONREAD Emacs is alone in its group. */
5058 kill (getpid (), SIGHUP
);
5061 if (n_to_read
> sizeof cbuf
)
5062 n_to_read
= sizeof cbuf
;
5063 #else /* no FIONREAD */
5064 #if defined (USG) || defined (DGUX)
5065 /* Read some input if available, but don't wait. */
5066 n_to_read
= sizeof cbuf
;
5067 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
5072 #endif /* not MSDOS */
5073 #endif /* not WINDOWSNT */
5075 /* Now read; for one reason or another, this will not block.
5076 NREAD is set to the number of chars read. */
5080 cbuf
[0] = dos_keyread ();
5083 nread
= read (input_fd
, cbuf
, n_to_read
);
5085 /* POSIX infers that processes which are not in the session leader's
5086 process group won't get SIGHUP's at logout time. BSDI adheres to
5087 this part standard and returns -1 from read(0) with errno==EIO
5088 when the control tty is taken away.
5089 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
5090 if (nread
== -1 && errno
== EIO
)
5092 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
5093 /* The kernel sometimes fails to deliver SIGHUP for ptys.
5094 This looks incorrect, but it isn't, because _BSD causes
5095 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
5096 and that causes a value other than 0 when there is no input. */
5102 /* We used to retry the read if it was interrupted.
5103 But this does the wrong thing when O_NDELAY causes
5104 an EAGAIN error. Does anybody know of a situation
5105 where a retry is actually needed? */
5107 nread
< 0 && (errno
== EAGAIN
5121 #if defined (USG) || defined (DGUX)
5122 fcntl (input_fd
, F_SETFL
, 0);
5123 #endif /* USG or DGUX */
5124 #endif /* no FIONREAD */
5125 for (i
= 0; i
< nread
; i
++)
5127 buf
[i
].kind
= ascii_keystroke
;
5128 buf
[i
].modifiers
= 0;
5129 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
5130 buf
[i
].modifiers
= meta_modifier
;
5134 buf
[i
].code
= cbuf
[i
];
5135 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
5139 /* Scan the chars for C-g and store them in kbd_buffer. */
5140 for (i
= 0; i
< nread
; i
++)
5142 kbd_buffer_store_event (&buf
[i
]);
5143 /* Don't look at input that follows a C-g too closely.
5144 This reduces lossage due to autorepeat on C-g. */
5145 if (buf
[i
].kind
== ascii_keystroke
5146 && buf
[i
].code
== quit_char
)
5152 #endif /* not VMS */
5154 #ifdef SIGIO /* for entire page */
5155 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5158 input_available_signal (signo
)
5161 /* Must preserve main program's value of errno. */
5162 int old_errno
= errno
;
5164 extern int select_alarmed
;
5167 #if defined (USG) && !defined (POSIX_SIGNALS)
5168 /* USG systems forget handlers when they are used;
5169 must reestablish each time */
5170 signal (signo
, input_available_signal
);
5177 if (input_available_clear_time
)
5178 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5183 nread
= read_avail_input (1);
5184 /* -1 means it's not ok to read the input now.
5185 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5186 0 means there was no keyboard input available. */
5191 select_alarmed
= 1; /* Force the select emulator back to life */
5202 /* Send ourselves a SIGIO.
5204 This function exists so that the UNBLOCK_INPUT macro in
5205 blockinput.h can have some way to take care of input we put off
5206 dealing with, without assuming that every file which uses
5207 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5209 reinvoke_input_signal ()
5212 kill (getpid (), SIGIO
);
5218 /* Return the prompt-string of a sparse keymap.
5219 This is the first element which is a string.
5220 Return nil if there is none. */
5228 register Lisp_Object tem
;
5237 static void menu_bar_item ();
5238 static void menu_bar_one_keymap ();
5240 /* These variables hold the vector under construction within
5241 menu_bar_items and its subroutines, and the current index
5242 for storing into that vector. */
5243 static Lisp_Object menu_bar_items_vector
;
5244 static int menu_bar_items_index
;
5246 /* Return a vector of menu items for a menu bar, appropriate
5247 to the current buffer. Each item has three elements in the vector:
5250 OLD is an old vector we can optionally reuse, or nil. */
5253 menu_bar_items (old
)
5256 /* The number of keymaps we're scanning right now, and the number of
5257 keymaps we have allocated space for. */
5260 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5261 in the current keymaps, or nil where it is not a prefix. */
5264 Lisp_Object def
, tem
, tail
;
5273 struct gcpro gcpro1
;
5275 /* In order to build the menus, we need to call the keymap
5276 accessors. They all call QUIT. But this function is called
5277 during redisplay, during which a quit is fatal. So inhibit
5278 quitting while building the menus.
5279 We do this instead of specbind because (1) errors will clear it anyway
5280 and (2) this avoids risk of specpdl overflow. */
5281 oquit
= Vinhibit_quit
;
5285 menu_bar_items_vector
= old
;
5287 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5288 menu_bar_items_index
= 0;
5290 GCPRO1 (menu_bar_items_vector
);
5292 /* Build our list of keymaps.
5293 If we recognize a function key and replace its escape sequence in
5294 keybuf with its symbol, or if the sequence starts with a mouse
5295 click and we need to switch buffers, we jump back here to rebuild
5296 the initial keymaps from the current buffer. */
5300 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5301 if (!NILP (Voverriding_local_map_menu_flag
))
5303 /* Yes, use them (if non-nil) as well as the global map. */
5304 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5306 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5307 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5308 if (!NILP (Voverriding_local_map
))
5309 maps
[nmaps
++] = Voverriding_local_map
;
5313 /* No, so use major and minor mode keymaps. */
5314 nmaps
= current_minor_maps (NULL
, &tmaps
);
5315 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5316 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5317 #ifdef USE_TEXT_PROPERTIES
5318 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5320 maps
[nmaps
++] = current_buffer
->keymap
;
5323 maps
[nmaps
++] = current_global_map
;
5326 /* Look up in each map the dummy prefix key `menu-bar'. */
5330 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5332 if (! NILP (maps
[mapno
]))
5333 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
5337 tem
= Fkeymapp (def
);
5339 menu_bar_one_keymap (def
);
5342 /* Move to the end those items that should be at the end. */
5344 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5347 int end
= menu_bar_items_index
;
5349 for (i
= 0; i
< end
; i
+= 4)
5350 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5352 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5353 /* Move the item at index I to the end,
5354 shifting all the others forward. */
5355 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5356 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5357 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5358 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5360 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5361 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5362 (end
- i
- 4) * sizeof (Lisp_Object
));
5363 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5364 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5365 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5366 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5371 /* Add nil, nil, nil, nil at the end. */
5372 i
= menu_bar_items_index
;
5373 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5376 int newsize
= 2 * i
;
5377 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5378 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5379 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5380 menu_bar_items_vector
= tem
;
5382 /* Add this item. */
5383 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5384 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5385 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5386 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5387 menu_bar_items_index
= i
;
5389 Vinhibit_quit
= oquit
;
5391 return menu_bar_items_vector
;
5394 /* Scan one map KEYMAP, accumulating any menu items it defines
5395 in menu_bar_items_vector. */
5398 menu_bar_one_keymap (keymap
)
5401 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
5403 /* Loop over all keymap entries that have menu strings. */
5404 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5406 item
= XCONS (tail
)->car
;
5409 key
= XCONS (item
)->car
;
5410 binding
= XCONS (item
)->cdr
;
5411 if (CONSP (binding
))
5413 item_string
= XCONS (binding
)->car
;
5414 if (STRINGP (item_string
))
5415 menu_bar_item (key
, item_string
, Fcdr (binding
));
5417 else if (EQ (binding
, Qundefined
))
5418 menu_bar_item (key
, Qnil
, binding
);
5420 else if (VECTORP (item
))
5422 /* Loop over the char values represented in the vector. */
5423 int len
= XVECTOR (item
)->size
;
5425 for (c
= 0; c
< len
; c
++)
5427 Lisp_Object character
;
5428 XSETFASTINT (character
, c
);
5429 binding
= XVECTOR (item
)->contents
[c
];
5430 if (CONSP (binding
))
5432 item_string
= XCONS (binding
)->car
;
5433 if (STRINGP (item_string
))
5434 menu_bar_item (key
, item_string
, Fcdr (binding
));
5436 else if (EQ (binding
, Qundefined
))
5437 menu_bar_item (key
, Qnil
, binding
);
5443 /* This is used as the handler when calling internal_condition_case_1. */
5446 menu_bar_item_1 (arg
)
5452 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5453 If there's already an item for KEY, add this DEF to it. */
5456 menu_bar_item (key
, item_string
, def
)
5457 Lisp_Object key
, item_string
, def
;
5460 Lisp_Object enabled
;
5463 /* Skip menu-bar equiv keys data. */
5464 if (CONSP (def
) && CONSP (XCONS (def
)->car
))
5465 def
= XCONS (def
)->cdr
;
5467 if (EQ (def
, Qundefined
))
5469 /* If a map has an explicit `undefined' as definition,
5470 discard any previously made menu bar item. */
5472 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5473 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5475 if (menu_bar_items_index
> i
+ 4)
5476 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5477 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5478 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5479 menu_bar_items_index
-= 4;
5483 /* If there's no definition for this key yet,
5484 just ignore `undefined'. */
5488 /* See if this entry is enabled. */
5493 /* No property, or nil, means enable.
5494 Otherwise, enable if value is not nil. */
5495 tem
= Fget (def
, Qmenu_enable
);
5497 /* (condition-case nil (eval tem)
5499 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5503 /* Ignore this item if it's not enabled. */
5507 /* Find any existing item for this KEY. */
5508 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5509 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5512 /* If we did not find this KEY, add it at the end. */
5513 if (i
== menu_bar_items_index
)
5515 /* If vector is too small, get a bigger one. */
5516 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5519 int newsize
= 2 * i
;
5520 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5521 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5522 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5523 menu_bar_items_vector
= tem
;
5525 /* Add this item. */
5526 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5527 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5528 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5529 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5530 menu_bar_items_index
= i
;
5532 /* We did find an item for this KEY. Add DEF to its list of maps. */
5536 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5537 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5541 /* Read a character using menus based on maps in the array MAPS.
5542 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5543 Return t if we displayed a menu but the user rejected it.
5545 PREV_EVENT is the previous input event, or nil if we are reading
5546 the first event of a key sequence.
5548 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5549 if we used a mouse menu to read the input, or zero otherwise. If
5550 USED_MOUSE_MENU is null, we don't dereference it.
5552 The prompting is done based on the prompt-string of the map
5553 and the strings associated with various map elements.
5555 This can be done with X menus or with menus put in the minibuf.
5556 These are done in different ways, depending on how the input will be read.
5557 Menus using X are done after auto-saving in read-char, getting the input
5558 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5559 and do auto-saving in the inner call of read_char. */
5562 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5565 Lisp_Object prev_event
;
5566 int *used_mouse_menu
;
5569 register Lisp_Object name
;
5570 Lisp_Object rest
, vector
;
5572 if (used_mouse_menu
)
5573 *used_mouse_menu
= 0;
5575 /* Use local over global Menu maps */
5577 if (! menu_prompting
)
5580 /* Optionally disregard all but the global map. */
5581 if (inhibit_local_menu_bar_menus
)
5583 maps
+= (nmaps
- 1);
5587 /* Get the menu name from the first map that has one (a prompt string). */
5588 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5590 name
= map_prompt (maps
[mapno
]);
5595 /* If we don't have any menus, just read a character normally. */
5600 /* If we got to this point via a mouse click,
5601 use a real menu for mouse selection. */
5602 if (EVENT_HAS_PARAMETERS (prev_event
)
5603 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5605 /* Display the menu and get the selection. */
5606 Lisp_Object
*realmaps
5607 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5611 /* Use the maps that are not nil. */
5612 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5613 if (!NILP (maps
[mapno
]))
5614 realmaps
[nmaps1
++] = maps
[mapno
];
5616 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5621 record_menu_key (XCONS (value
)->car
);
5623 /* If we got multiple events, unread all but
5625 There is no way to prevent those unread events
5626 from showing up later in last_nonmenu_event.
5627 So turn symbol and integer events into lists,
5628 to indicate that they came from a mouse menu,
5629 so that when present in last_nonmenu_event
5630 they won't confuse things. */
5631 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5632 tem
= XCONS (tem
)->cdr
)
5634 record_menu_key (XCONS (tem
)->car
);
5635 if (SYMBOLP (XCONS (tem
)->car
)
5636 || INTEGERP (XCONS (tem
)->car
))
5638 = Fcons (XCONS (tem
)->car
, Qnil
);
5641 /* If we got more than one event, put all but the first
5642 onto this list to be read later.
5643 Return just the first event now. */
5644 Vunread_command_events
5645 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5646 value
= XCONS (value
)->car
;
5648 else if (NILP (value
))
5650 if (used_mouse_menu
)
5651 *used_mouse_menu
= 1;
5654 #endif /* HAVE_MENUS */
5658 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5659 We make this bigger when necessary, and never free it. */
5660 static char *read_char_minibuf_menu_text
;
5661 /* Size of that buffer. */
5662 static int read_char_minibuf_menu_width
;
5665 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5671 register Lisp_Object name
;
5673 int width
= FRAME_WIDTH (selected_frame
) - 4;
5676 Lisp_Object rest
, vector
;
5679 if (! menu_prompting
)
5682 /* Make sure we have a big enough buffer for the menu text. */
5683 if (read_char_minibuf_menu_text
== 0)
5685 read_char_minibuf_menu_width
= width
+ 4;
5686 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5688 else if (width
+ 4 > read_char_minibuf_menu_width
)
5690 read_char_minibuf_menu_width
= width
+ 4;
5691 read_char_minibuf_menu_text
5692 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5694 menu
= read_char_minibuf_menu_text
;
5696 /* Get the menu name from the first map that has one (a prompt string). */
5697 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5699 name
= map_prompt (maps
[mapno
]);
5704 /* If we don't have any menus, just read a character normally. */
5708 /* Prompt string always starts with map's prompt, and a space. */
5709 strcpy (menu
, XSTRING (name
)->data
);
5710 nlength
= XSTRING (name
)->size_byte
;
5711 menu
[nlength
++] = ':';
5712 menu
[nlength
++] = ' ';
5715 /* Start prompting at start of first map. */
5719 /* Present the documented bindings, a line at a time. */
5726 Lisp_Object orig_defn_macro
;
5728 /* Loop over elements of map. */
5733 /* If reached end of map, start at beginning of next map. */
5737 /* At end of last map, wrap around to first map if just starting,
5738 or end this line if already have something on it. */
5742 if (notfirst
|| nobindings
) break;
5747 /* Look at the next element of the map. */
5749 elt
= XVECTOR (vector
)->contents
[idx
];
5751 elt
= Fcar_safe (rest
);
5753 if (idx
< 0 && VECTORP (elt
))
5755 /* If we found a dense table in the keymap,
5756 advanced past it, but start scanning its contents. */
5757 rest
= Fcdr_safe (rest
);
5763 /* An ordinary element. */
5768 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5769 event
= Fcar_safe (elt
);
5773 s
= Fcar_safe (elt
); /* vector */
5774 XSETINT (event
, idx
);
5777 /* Ignore the element if it has no prompt string. */
5778 if (STRINGP (s
) && INTEGERP (event
))
5780 /* 1 if the char to type matches the string. */
5782 Lisp_Object upcased_event
, downcased_event
;
5785 upcased_event
= Fupcase (event
);
5786 downcased_event
= Fdowncase (event
);
5787 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5788 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5790 desc
= Fsingle_key_description (event
);
5792 /* If we have room for the prompt string, add it to this line.
5793 If this is the first on the line, always add it. */
5794 if ((XSTRING (s
)->size
+ i
+ 2
5795 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5801 /* Punctuate between strings. */
5804 strcpy (menu
+ i
, ", ");
5810 /* If the char to type doesn't match the string's
5811 first char, explicitly show what char to type. */
5814 /* Add as much of string as fits. */
5815 thiswidth
= XSTRING (desc
)->size
;
5816 if (thiswidth
+ i
> width
)
5817 thiswidth
= width
- i
;
5818 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5820 strcpy (menu
+ i
, " = ");
5824 /* Add as much of string as fits. */
5825 thiswidth
= XSTRING (s
)->size
;
5826 if (thiswidth
+ i
> width
)
5827 thiswidth
= width
- i
;
5828 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5834 /* If this element does not fit, end the line now,
5835 and save the element for the next line. */
5836 strcpy (menu
+ i
, "...");
5841 /* Move past this element. */
5842 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5843 /* Handle reaching end of dense table. */
5848 rest
= Fcdr_safe (rest
);
5852 /* Prompt with that and read response. */
5853 message2_nolog (menu
, strlen (menu
),
5854 ! NILP (current_buffer
->enable_multibyte_characters
));
5856 /* Make believe its not a keyboard macro in case the help char
5857 is pressed. Help characters are not recorded because menu prompting
5858 is not used on replay.
5860 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5861 current_kboard
->defining_kbd_macro
= Qnil
;
5863 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5864 while (BUFFERP (obj
));
5865 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5867 if (!INTEGERP (obj
))
5872 if (! EQ (obj
, menu_prompt_more_char
)
5873 && (!INTEGERP (menu_prompt_more_char
)
5874 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5876 if (!NILP (current_kboard
->defining_kbd_macro
))
5877 store_kbd_macro_char (obj
);
5880 /* Help char - go round again */
5884 /* Reading key sequences. */
5886 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5887 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5888 keymap, or nil otherwise. Return the index of the first keymap in
5889 which KEY has any binding, or NMAPS if no map has a binding.
5891 If KEY is a meta ASCII character, treat it like meta-prefix-char
5892 followed by the corresponding non-meta character. Keymaps in
5893 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5896 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5899 NEXT may be the same array as CURRENT. */
5902 follow_key (key
, nmaps
, current
, defs
, next
)
5904 Lisp_Object
*current
, *defs
, *next
;
5907 int i
, first_binding
;
5910 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5911 followed by the corresponding non-meta character.
5912 Put the results into DEFS, since we are going to alter that anyway.
5913 Do not alter CURRENT or NEXT. */
5914 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5916 for (i
= 0; i
< nmaps
; i
++)
5917 if (! NILP (current
[i
]))
5920 def
= get_keyelt (access_keymap (current
[i
],
5921 meta_prefix_char
, 1, 0), 0);
5923 /* Note that since we pass the resulting bindings through
5924 get_keymap_1, non-prefix bindings for meta-prefix-char
5926 defs
[i
] = get_keymap_1 (def
, 0, 1);
5932 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5935 first_binding
= nmaps
;
5936 for (i
= nmaps
- 1; i
>= 0; i
--)
5938 if (! NILP (current
[i
]))
5946 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
5947 if (! NILP (defs
[i
]))
5954 /* Given the set of bindings we've found, produce the next set of maps. */
5955 if (first_binding
< nmaps
)
5956 for (i
= 0; i
< nmaps
; i
++)
5957 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5959 return first_binding
;
5962 /* Read a sequence of keys that ends with a non prefix character,
5963 storing it in KEYBUF, a buffer of size BUFSIZE.
5965 Return the length of the key sequence stored.
5966 Return -1 if the user rejected a command menu.
5968 Echo starting immediately unless `prompt' is 0.
5970 Where a key sequence ends depends on the currently active keymaps.
5971 These include any minor mode keymaps active in the current buffer,
5972 the current buffer's local map, and the global map.
5974 If a key sequence has no other bindings, we check Vfunction_key_map
5975 to see if some trailing subsequence might be the beginning of a
5976 function key's sequence. If so, we try to read the whole function
5977 key, and substitute its symbolic name into the key sequence.
5979 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5980 `double-' events into similar click events, if that would make them
5981 bound. We try to turn `triple-' events first into `double-' events,
5984 If we get a mouse click in a mode line, vertical divider, or other
5985 non-text area, we treat the click as if it were prefixed by the
5986 symbol denoting that area - `mode-line', `vertical-line', or
5989 If the sequence starts with a mouse click, we read the key sequence
5990 with respect to the buffer clicked on, not the current buffer.
5992 If the user switches frames in the midst of a key sequence, we put
5993 off the switch-frame event until later; the next call to
5994 read_char will return it.
5996 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
5997 from the selected window's buffer. */
6000 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
6001 can_return_switch_frame
, fix_current_buffer
)
6002 Lisp_Object
*keybuf
;
6005 int dont_downcase_last
;
6006 int can_return_switch_frame
;
6007 int fix_current_buffer
;
6009 int count
= specpdl_ptr
- specpdl
;
6011 /* How many keys there are in the current key sequence. */
6014 /* The length of the echo buffer when we started reading, and
6015 the length of this_command_keys when we started reading. */
6019 /* The number of keymaps we're scanning right now, and the number of
6020 keymaps we have allocated space for. */
6022 int nmaps_allocated
= 0;
6024 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
6025 the current keymaps. */
6028 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6029 in the current keymaps, or nil where it is not a prefix. */
6030 Lisp_Object
*submaps
;
6032 /* The local map to start out with at start of key sequence. */
6033 Lisp_Object orig_local_map
;
6035 /* 1 if we have already considered switching to the local-map property
6036 of the place where a mouse click occurred. */
6037 int localized_local_map
= 0;
6039 /* The index in defs[] of the first keymap that has a binding for
6040 this key sequence. In other words, the lowest i such that
6041 defs[i] is non-nil. */
6044 /* If t < mock_input, then KEYBUF[t] should be read as the next
6047 We use this to recover after recognizing a function key. Once we
6048 realize that a suffix of the current key sequence is actually a
6049 function key's escape sequence, we replace the suffix with the
6050 function key's binding from Vfunction_key_map. Now keybuf
6051 contains a new and different key sequence, so the echo area,
6052 this_command_keys, and the submaps and defs arrays are wrong. In
6053 this situation, we set mock_input to t, set t to 0, and jump to
6054 restart_sequence; the loop will read keys from keybuf up until
6055 mock_input, thus rebuilding the state; and then it will resume
6056 reading characters from the keyboard. */
6059 /* If the sequence is unbound in submaps[], then
6060 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
6061 and fkey_map is its binding.
6063 These might be > t, indicating that all function key scanning
6064 should hold off until t reaches them. We do this when we've just
6065 recognized a function key, to avoid searching for the function
6066 key's again in Vfunction_key_map. */
6067 int fkey_start
= 0, fkey_end
= 0;
6068 Lisp_Object fkey_map
;
6070 /* Likewise, for key_translation_map. */
6071 int keytran_start
= 0, keytran_end
= 0;
6072 Lisp_Object keytran_map
;
6074 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
6075 we put it off for later. While we're reading, we keep the event here. */
6076 Lisp_Object delayed_switch_frame
;
6078 /* See the comment below... */
6079 #if defined (GOBBLE_FIRST_EVENT)
6080 Lisp_Object first_event
;
6083 Lisp_Object original_uppercase
;
6084 int original_uppercase_position
= -1;
6086 /* Gets around Microsoft compiler limitations. */
6089 struct buffer
*starting_buffer
;
6091 /* Nonzero if we seem to have got the beginning of a binding
6092 in function_key_map. */
6093 int function_key_possible
= 0;
6094 int key_translation_possible
= 0;
6096 /* Save the status of key translation before each step,
6097 so that we can restore this after downcasing. */
6098 Lisp_Object prev_fkey_map
;
6099 int prev_fkey_start
;
6102 Lisp_Object prev_keytran_map
;
6103 int prev_keytran_start
;
6104 int prev_keytran_end
;
6108 last_nonmenu_event
= Qnil
;
6110 delayed_switch_frame
= Qnil
;
6111 fkey_map
= Vfunction_key_map
;
6112 keytran_map
= Vkey_translation_map
;
6114 /* If there is no function-key-map, turn off function key scanning. */
6115 if (NILP (Fkeymapp (Vfunction_key_map
)))
6116 fkey_start
= fkey_end
= bufsize
+ 1;
6118 /* If there is no key-translation-map, turn off scanning. */
6119 if (NILP (Fkeymapp (Vkey_translation_map
)))
6120 keytran_start
= keytran_end
= bufsize
+ 1;
6125 echo_prompt (XSTRING (prompt
)->data
);
6126 else if (cursor_in_echo_area
&& echo_keystrokes
)
6127 /* This doesn't put in a dash if the echo buffer is empty, so
6128 you don't always see a dash hanging out in the minibuffer. */
6132 /* Record the initial state of the echo area and this_command_keys;
6133 we will need to restore them if we replay a key sequence. */
6135 echo_start
= echo_length ();
6136 keys_start
= this_command_key_count
;
6137 this_single_command_key_start
= keys_start
;
6139 #if defined (GOBBLE_FIRST_EVENT)
6140 /* This doesn't quite work, because some of the things that read_char
6141 does cannot safely be bypassed. It seems too risky to try to make
6144 /* Read the first char of the sequence specially, before setting
6145 up any keymaps, in case a filter runs and switches buffers on us. */
6146 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
6148 #endif /* GOBBLE_FIRST_EVENT */
6150 orig_local_map
= get_local_map (PT
, current_buffer
);
6152 /* We jump here when the key sequence has been thoroughly changed, and
6153 we need to rescan it starting from the beginning. When we jump here,
6154 keybuf[0..mock_input] holds the sequence we should reread. */
6157 starting_buffer
= current_buffer
;
6158 function_key_possible
= 0;
6159 key_translation_possible
= 0;
6161 /* Build our list of keymaps.
6162 If we recognize a function key and replace its escape sequence in
6163 keybuf with its symbol, or if the sequence starts with a mouse
6164 click and we need to switch buffers, we jump back here to rebuild
6165 the initial keymaps from the current buffer. */
6169 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6170 || !NILP (Voverriding_local_map
))
6172 if (3 > nmaps_allocated
)
6174 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6175 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6176 nmaps_allocated
= 3;
6179 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6180 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6181 if (!NILP (Voverriding_local_map
))
6182 submaps
[nmaps
++] = Voverriding_local_map
;
6186 nmaps
= current_minor_maps (0, &maps
);
6187 if (nmaps
+ 2 > nmaps_allocated
)
6189 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6190 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6191 nmaps_allocated
= nmaps
+ 2;
6193 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6194 #ifdef USE_TEXT_PROPERTIES
6195 submaps
[nmaps
++] = orig_local_map
;
6197 submaps
[nmaps
++] = current_buffer
->keymap
;
6200 submaps
[nmaps
++] = current_global_map
;
6203 /* Find an accurate initial value for first_binding. */
6204 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6205 if (! NILP (submaps
[first_binding
]))
6208 /* Start from the beginning in keybuf. */
6211 /* These are no-ops the first time through, but if we restart, they
6212 revert the echo area and this_command_keys to their original state. */
6213 this_command_key_count
= keys_start
;
6214 if (INTERACTIVE
&& t
< mock_input
)
6215 echo_truncate (echo_start
);
6217 /* If the best binding for the current key sequence is a keymap, or
6218 we may be looking at a function key's escape sequence, keep on
6220 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6221 || (first_binding
>= nmaps
6223 /* mock input is never part of a function key's sequence. */
6224 && mock_input
<= fkey_start
)
6225 || (first_binding
>= nmaps
6226 && keytran_start
< t
&& key_translation_possible
)
6227 /* Don't return in the middle of a possible function key sequence,
6228 if the only bindings we found were via case conversion.
6229 Thus, if ESC O a has a function-key-map translation
6230 and ESC o has a binding, don't return after ESC O,
6231 so that we can translate ESC O plus the next character. */
6235 int used_mouse_menu
= 0;
6237 /* Where the last real key started. If we need to throw away a
6238 key that has expanded into more than one element of keybuf
6239 (say, a mouse click on the mode line which is being treated
6240 as [mode-line (mouse-...)], then we backtrack to this point
6242 int last_real_key_start
;
6244 /* These variables are analogous to echo_start and keys_start;
6245 while those allow us to restart the entire key sequence,
6246 echo_local_start and keys_local_start allow us to throw away
6248 int echo_local_start
, keys_local_start
, local_first_binding
;
6251 error ("Key sequence too long");
6254 echo_local_start
= echo_length ();
6255 keys_local_start
= this_command_key_count
;
6256 local_first_binding
= first_binding
;
6259 /* These are no-ops, unless we throw away a keystroke below and
6260 jumped back up to replay_key; in that case, these restore the
6261 variables to their original state, allowing us to replay the
6263 if (INTERACTIVE
&& t
< mock_input
)
6264 echo_truncate (echo_local_start
);
6265 this_command_key_count
= keys_local_start
;
6266 first_binding
= local_first_binding
;
6268 /* By default, assume each event is "real". */
6269 last_real_key_start
= t
;
6271 /* Does mock_input indicate that we are re-reading a key sequence? */
6275 add_command_key (key
);
6276 if (echo_keystrokes
)
6280 /* If not, we should actually read a character. */
6283 struct buffer
*buf
= current_buffer
;
6287 KBOARD
*interrupted_kboard
= current_kboard
;
6288 struct frame
*interrupted_frame
= selected_frame
;
6289 if (setjmp (wrong_kboard_jmpbuf
))
6291 if (!NILP (delayed_switch_frame
))
6293 interrupted_kboard
->kbd_queue
6294 = Fcons (delayed_switch_frame
,
6295 interrupted_kboard
->kbd_queue
);
6296 delayed_switch_frame
= Qnil
;
6299 interrupted_kboard
->kbd_queue
6300 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6302 /* If the side queue is non-empty, ensure it begins with a
6303 switch-frame, so we'll replay it in the right context. */
6304 if (CONSP (interrupted_kboard
->kbd_queue
)
6305 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6306 !(EVENT_HAS_PARAMETERS (key
)
6307 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6311 XSETFRAME (frame
, interrupted_frame
);
6312 interrupted_kboard
->kbd_queue
6313 = Fcons (make_lispy_switch_frame (frame
),
6314 interrupted_kboard
->kbd_queue
);
6317 orig_local_map
= get_local_map (PT
, current_buffer
);
6318 goto replay_sequence
;
6321 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6325 /* read_char returns t when it shows a menu and the user rejects it.
6330 /* read_char returns -1 at the end of a macro.
6331 Emacs 18 handles this by returning immediately with a
6332 zero, so that's what we'll do. */
6333 if (INTEGERP (key
) && XINT (key
) == -1)
6336 /* The Microsoft C compiler can't handle the goto that
6342 /* If the current buffer has been changed from under us, the
6343 keymap may have changed, so replay the sequence. */
6347 /* Reset the current buffer from the selected window
6348 in case something changed the former and not the latter.
6349 This is to be more consistent with the behavior
6350 of the command_loop_1. */
6351 if (fix_current_buffer
)
6352 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
6353 Fset_buffer (XWINDOW (selected_window
)->buffer
);
6355 orig_local_map
= get_local_map (PT
, current_buffer
);
6356 goto replay_sequence
;
6359 /* If we have a quit that was typed in another frame, and
6360 quit_throw_to_read_char switched buffers,
6361 replay to get the right keymap. */
6362 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6367 orig_local_map
= get_local_map (PT
, current_buffer
);
6368 goto replay_sequence
;
6374 /* Clicks in non-text areas get prefixed by the symbol
6375 in their CHAR-ADDRESS field. For example, a click on
6376 the mode line is prefixed by the symbol `mode-line'.
6378 Furthermore, key sequences beginning with mouse clicks
6379 are read using the keymaps of the buffer clicked on, not
6380 the current buffer. So we may have to switch the buffer
6383 When we turn one event into two events, we must make sure
6384 that neither of the two looks like the original--so that,
6385 if we replay the events, they won't be expanded again.
6386 If not for this, such reexpansion could happen either here
6387 or when user programs play with this-command-keys. */
6388 if (EVENT_HAS_PARAMETERS (key
))
6392 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6393 if (EQ (kind
, Qmouse_click
))
6395 Lisp_Object window
, posn
;
6397 window
= POSN_WINDOW (EVENT_START (key
));
6398 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6401 /* We're looking at the second event of a
6402 sequence which we expanded before. Set
6403 last_real_key_start appropriately. */
6405 last_real_key_start
= t
- 1;
6408 /* Key sequences beginning with mouse clicks are
6409 read using the keymaps in the buffer clicked on,
6410 not the current buffer. If we're at the
6411 beginning of a key sequence, switch buffers. */
6412 if (last_real_key_start
== 0
6414 && BUFFERP (XWINDOW (window
)->buffer
)
6415 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6420 /* Arrange to go back to the original buffer once we're
6421 done reading the key sequence. Note that we can't
6422 use save_excursion_{save,restore} here, because they
6423 save point as well as the current buffer; we don't
6424 want to save point, because redisplay may change it,
6425 to accommodate a Fset_window_start or something. We
6426 don't want to do this at the top of the function,
6427 because we may get input from a subprocess which
6428 wants to change the selected window and stuff (say,
6430 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6432 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6433 orig_local_map
= get_local_map (PT
, current_buffer
);
6434 goto replay_sequence
;
6436 /* For a mouse click, get the local text-property keymap
6437 of the place clicked on, rather than point. */
6438 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6439 && ! localized_local_map
)
6441 Lisp_Object map_here
, start
, pos
;
6443 localized_local_map
= 1;
6444 start
= EVENT_START (key
);
6445 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6447 pos
= POSN_BUFFER_POSN (start
);
6449 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6451 map_here
= get_local_map (XINT (pos
), current_buffer
);
6452 if (!EQ (map_here
, orig_local_map
))
6454 orig_local_map
= map_here
;
6458 goto replay_sequence
;
6464 /* Expand mode-line and scroll-bar events into two events:
6465 use posn as a fake prefix key. */
6468 if (t
+ 1 >= bufsize
)
6469 error ("Key sequence too long");
6474 /* Zap the position in key, so we know that we've
6475 expanded it, and don't try to do so again. */
6476 POSN_BUFFER_POSN (EVENT_START (key
))
6477 = Fcons (posn
, Qnil
);
6481 else if (EQ (kind
, Qswitch_frame
))
6483 /* If we're at the beginning of a key sequence, and the caller
6484 says it's okay, go ahead and return this event. If we're
6485 in the midst of a key sequence, delay it until the end. */
6486 if (t
> 0 || !can_return_switch_frame
)
6488 delayed_switch_frame
= key
;
6492 else if (CONSP (XCONS (key
)->cdr
)
6493 && CONSP (EVENT_START (key
))
6494 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6498 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6499 /* Handle menu-bar events:
6500 insert the dummy prefix event `menu-bar'. */
6501 if (EQ (posn
, Qmenu_bar
))
6503 if (t
+ 1 >= bufsize
)
6504 error ("Key sequence too long");
6508 /* Zap the position in key, so we know that we've
6509 expanded it, and don't try to do so again. */
6510 POSN_BUFFER_POSN (EVENT_START (key
))
6511 = Fcons (posn
, Qnil
);
6514 goto replay_sequence
;
6516 else if (CONSP (posn
))
6518 /* We're looking at the second event of a
6519 sequence which we expanded before. Set
6520 last_real_key_start appropriately. */
6521 if (last_real_key_start
== t
&& t
> 0)
6522 last_real_key_start
= t
- 1;
6527 /* We have finally decided that KEY is something we might want
6529 first_binding
= (follow_key (key
,
6530 nmaps
- first_binding
,
6531 submaps
+ first_binding
,
6532 defs
+ first_binding
,
6533 submaps
+ first_binding
)
6536 /* If KEY wasn't bound, we'll try some fallbacks. */
6537 if (first_binding
>= nmaps
)
6541 head
= EVENT_HEAD (key
);
6542 if (help_char_p (head
) && t
> 0)
6544 read_key_sequence_cmd
= Vprefix_help_command
;
6546 last_nonmenu_event
= key
;
6547 /* The Microsoft C compiler can't handle the goto that
6555 Lisp_Object breakdown
;
6558 breakdown
= parse_modifiers (head
);
6559 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6560 /* Attempt to reduce an unbound mouse event to a simpler
6561 event that is bound:
6562 Drags reduce to clicks.
6563 Double-clicks reduce to clicks.
6564 Triple-clicks reduce to double-clicks, then to clicks.
6565 Down-clicks are eliminated.
6566 Double-downs reduce to downs, then are eliminated.
6567 Triple-downs reduce to double-downs, then to downs,
6568 then are eliminated. */
6569 if (modifiers
& (down_modifier
| drag_modifier
6570 | double_modifier
| triple_modifier
))
6572 while (modifiers
& (down_modifier
| drag_modifier
6573 | double_modifier
| triple_modifier
))
6575 Lisp_Object new_head
, new_click
;
6576 if (modifiers
& triple_modifier
)
6577 modifiers
^= (double_modifier
| triple_modifier
);
6578 else if (modifiers
& double_modifier
)
6579 modifiers
&= ~double_modifier
;
6580 else if (modifiers
& drag_modifier
)
6581 modifiers
&= ~drag_modifier
;
6584 /* Dispose of this `down' event by simply jumping
6585 back to replay_key, to get another event.
6587 Note that if this event came from mock input,
6588 then just jumping back to replay_key will just
6589 hand it to us again. So we have to wipe out any
6592 We could delete keybuf[t] and shift everything
6593 after that to the left by one spot, but we'd also
6594 have to fix up any variable that points into
6595 keybuf, and shifting isn't really necessary
6598 Adding prefixes for non-textual mouse clicks
6599 creates two characters of mock input, and both
6600 must be thrown away. If we're only looking at
6601 the prefix now, we can just jump back to
6602 replay_key. On the other hand, if we've already
6603 processed the prefix, and now the actual click
6604 itself is giving us trouble, then we've lost the
6605 state of the keymaps we want to backtrack to, and
6606 we need to replay the whole sequence to rebuild
6609 Beyond that, only function key expansion could
6610 create more than two keys, but that should never
6611 generate mouse events, so it's okay to zero
6612 mock_input in that case too.
6614 Isn't this just the most wonderful code ever? */
6615 if (t
== last_real_key_start
)
6622 mock_input
= last_real_key_start
;
6623 goto replay_sequence
;
6628 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6630 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6632 /* Look for a binding for this new key. follow_key
6633 promises that it didn't munge submaps the
6634 last time we called it, since key was unbound. */
6636 = (follow_key (new_click
,
6637 nmaps
- local_first_binding
,
6638 submaps
+ local_first_binding
,
6639 defs
+ local_first_binding
,
6640 submaps
+ local_first_binding
)
6641 + local_first_binding
);
6643 /* If that click is bound, go for it. */
6644 if (first_binding
< nmaps
)
6649 /* Otherwise, we'll leave key set to the drag event. */
6656 /* Normally, last_nonmenu_event gets the previous key we read.
6657 But when a mouse popup menu is being used,
6658 we don't update last_nonmenu_event; it continues to hold the mouse
6659 event that preceded the first level of menu. */
6660 if (!used_mouse_menu
)
6661 last_nonmenu_event
= key
;
6663 /* Record what part of this_command_keys is the current key sequence. */
6664 this_single_command_key_start
= this_command_key_count
- t
;
6666 prev_fkey_map
= fkey_map
;
6667 prev_fkey_start
= fkey_start
;
6668 prev_fkey_end
= fkey_end
;
6670 prev_keytran_map
= keytran_map
;
6671 prev_keytran_start
= keytran_start
;
6672 prev_keytran_end
= keytran_end
;
6674 /* If the sequence is unbound, see if we can hang a function key
6675 off the end of it. We only want to scan real keyboard input
6676 for function key sequences, so if mock_input says that we're
6677 re-reading old events, don't examine it. */
6678 if (first_binding
>= nmaps
6681 Lisp_Object fkey_next
;
6683 /* Continue scan from fkey_end until we find a bound suffix.
6684 If we fail, increment fkey_start
6685 and start fkey_end from there. */
6686 while (fkey_end
< t
)
6690 key
= keybuf
[fkey_end
++];
6691 /* Look up meta-characters by prefixing them
6692 with meta_prefix_char. I hate this. */
6693 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6698 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
6700 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6703 fkey_next
= fkey_map
;
6706 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 0);
6708 #if 0 /* I didn't turn this on, because it might cause trouble
6709 for the mapping of return into C-m and tab into C-i. */
6710 /* Optionally don't map function keys into other things.
6711 This enables the user to redefine kp- keys easily. */
6712 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6716 /* If the function key map gives a function, not an
6717 array, then call the function with no args and use
6718 its value instead. */
6719 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6722 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6726 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6727 fkey_next
= call1 (fkey_next
, prompt
);
6729 /* If the function returned something invalid,
6730 barf--don't ignore it.
6731 (To ignore it safely, we would need to gcpro a bunch of
6732 other variables.) */
6733 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6734 error ("Function in key-translation-map returns invalid key sequence");
6737 function_key_possible
= ! NILP (fkey_next
);
6739 /* If keybuf[fkey_start..fkey_end] is bound in the
6740 function key map and it's a suffix of the current
6741 sequence (i.e. fkey_end == t), replace it with
6742 the binding and restart with fkey_start at the end. */
6743 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6746 int len
= XFASTINT (Flength (fkey_next
));
6748 t
= fkey_start
+ len
;
6750 error ("Key sequence too long");
6752 if (VECTORP (fkey_next
))
6753 bcopy (XVECTOR (fkey_next
)->contents
,
6754 keybuf
+ fkey_start
,
6755 (t
- fkey_start
) * sizeof (keybuf
[0]));
6756 else if (STRINGP (fkey_next
))
6760 for (i
= 0; i
< len
; i
++)
6761 XSETFASTINT (keybuf
[fkey_start
+ i
],
6762 XSTRING (fkey_next
)->data
[i
]);
6766 fkey_start
= fkey_end
= t
;
6767 fkey_map
= Vfunction_key_map
;
6769 /* Do pass the results through key-translation-map. */
6770 keytran_start
= keytran_end
= 0;
6771 keytran_map
= Vkey_translation_map
;
6773 goto replay_sequence
;
6776 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6778 /* If we no longer have a bound suffix, try a new positions for
6780 if (NILP (fkey_map
))
6782 fkey_end
= ++fkey_start
;
6783 fkey_map
= Vfunction_key_map
;
6784 function_key_possible
= 0;
6789 /* Look for this sequence in key-translation-map. */
6791 Lisp_Object keytran_next
;
6793 /* Scan from keytran_end until we find a bound suffix. */
6794 while (keytran_end
< t
)
6798 key
= keybuf
[keytran_end
++];
6799 /* Look up meta-characters by prefixing them
6800 with meta_prefix_char. I hate this. */
6801 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6806 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
6808 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6811 keytran_next
= keytran_map
;
6814 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 0);
6816 /* If the key translation map gives a function, not an
6817 array, then call the function with no args and use
6818 its value instead. */
6819 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6820 && keytran_end
== t
)
6822 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6826 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6827 keytran_next
= call1 (keytran_next
, prompt
);
6829 /* If the function returned something invalid,
6830 barf--don't ignore it.
6831 (To ignore it safely, we would need to gcpro a bunch of
6832 other variables.) */
6833 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6834 error ("Function in key-translation-map returns invalid key sequence");
6837 key_translation_possible
= ! NILP (keytran_next
);
6839 /* If keybuf[keytran_start..keytran_end] is bound in the
6840 key translation map and it's a suffix of the current
6841 sequence (i.e. keytran_end == t), replace it with
6842 the binding and restart with keytran_start at the end. */
6843 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6844 && keytran_end
== t
)
6846 int len
= XFASTINT (Flength (keytran_next
));
6848 t
= keytran_start
+ len
;
6850 error ("Key sequence too long");
6852 if (VECTORP (keytran_next
))
6853 bcopy (XVECTOR (keytran_next
)->contents
,
6854 keybuf
+ keytran_start
,
6855 (t
- keytran_start
) * sizeof (keybuf
[0]));
6856 else if (STRINGP (keytran_next
))
6860 for (i
= 0; i
< len
; i
++)
6861 XSETFASTINT (keybuf
[keytran_start
+ i
],
6862 XSTRING (keytran_next
)->data
[i
]);
6866 keytran_start
= keytran_end
= t
;
6867 keytran_map
= Vkey_translation_map
;
6869 /* Don't pass the results of key-translation-map
6870 through function-key-map. */
6871 fkey_start
= fkey_end
= t
;
6872 fkey_map
= Vkey_translation_map
;
6874 goto replay_sequence
;
6877 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6879 /* If we no longer have a bound suffix, try a new positions for
6881 if (NILP (keytran_map
))
6883 keytran_end
= ++keytran_start
;
6884 keytran_map
= Vkey_translation_map
;
6885 key_translation_possible
= 0;
6890 /* If KEY is not defined in any of the keymaps,
6891 and cannot be part of a function key or translation,
6892 and is an upper case letter
6893 use the corresponding lower-case letter instead. */
6894 if (first_binding
== nmaps
&& ! function_key_possible
6895 && ! key_translation_possible
6897 && ((((XINT (key
) & 0x3ffff)
6898 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
6899 && UPPERCASEP (XINT (key
) & 0x3ffff))
6900 || (XINT (key
) & shift_modifier
)))
6902 Lisp_Object new_key
;
6904 original_uppercase
= key
;
6905 original_uppercase_position
= t
- 1;
6907 if (XINT (key
) & shift_modifier
)
6908 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6910 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6911 | (XINT (key
) & ~0x3ffff)));
6913 /* We have to do this unconditionally, regardless of whether
6914 the lower-case char is defined in the keymaps, because they
6915 might get translated through function-key-map. */
6916 keybuf
[t
- 1] = new_key
;
6919 fkey_map
= prev_fkey_map
;
6920 fkey_start
= prev_fkey_start
;
6921 fkey_end
= prev_fkey_end
;
6923 keytran_map
= prev_keytran_map
;
6924 keytran_start
= prev_keytran_start
;
6925 keytran_end
= prev_keytran_end
;
6927 goto replay_sequence
;
6929 /* If KEY is not defined in any of the keymaps,
6930 and cannot be part of a function key or translation,
6931 and is a shifted function key,
6932 use the corresponding unshifted function key instead. */
6933 if (first_binding
== nmaps
&& ! function_key_possible
6934 && ! key_translation_possible
6937 Lisp_Object breakdown
;
6940 breakdown
= parse_modifiers (key
);
6941 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6942 if (modifiers
& shift_modifier
)
6944 Lisp_Object new_key
;
6946 original_uppercase
= key
;
6947 original_uppercase_position
= t
- 1;
6949 modifiers
&= ~shift_modifier
;
6950 new_key
= apply_modifiers (modifiers
,
6951 XCONS (breakdown
)->car
);
6953 keybuf
[t
- 1] = new_key
;
6956 fkey_map
= prev_fkey_map
;
6957 fkey_start
= prev_fkey_start
;
6958 fkey_end
= prev_fkey_end
;
6960 keytran_map
= prev_keytran_map
;
6961 keytran_start
= prev_keytran_start
;
6962 keytran_end
= prev_keytran_end
;
6964 goto replay_sequence
;
6970 read_key_sequence_cmd
= (first_binding
< nmaps
6971 ? defs
[first_binding
]
6974 unread_switch_frame
= delayed_switch_frame
;
6975 unbind_to (count
, Qnil
);
6977 /* Don't downcase the last character if the caller says don't.
6978 Don't downcase it if the result is undefined, either. */
6979 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6980 && t
- 1 == original_uppercase_position
)
6981 keybuf
[t
- 1] = original_uppercase
;
6983 /* Occasionally we fabricate events, perhaps by expanding something
6984 according to function-key-map, or by adding a prefix symbol to a
6985 mouse click in the scroll bar or modeline. In this cases, return
6986 the entire generated key sequence, even if we hit an unbound
6987 prefix or a definition before the end. This means that you will
6988 be able to push back the event properly, and also means that
6989 read-key-sequence will always return a logical unit.
6992 for (; t
< mock_input
; t
++)
6994 if (echo_keystrokes
)
6995 echo_char (keybuf
[t
]);
6996 add_command_key (keybuf
[t
]);
7002 #if 0 /* This doc string is too long for some compilers.
7003 This commented-out definition serves for DOC. */
7004 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7005 "Read a sequence of keystrokes and return as a string or vector.\n\
7006 The sequence is sufficient to specify a non-prefix command in the\n\
7007 current local and global maps.\n\
7009 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
7010 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
7011 as a continuation of the previous key.\n\
7013 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
7014 convert the last event to lower case. (Normally any upper case event\n\
7015 is converted to lower case if the original event is undefined and the lower\n\
7016 case equivalent is defined.) A non-nil value is appropriate for reading\n\
7017 a key sequence to be defined.\n\
7019 A C-g typed while in this function is treated like any other character,\n\
7020 and `quit-flag' is not set.\n\
7022 If the key sequence starts with a mouse click, then the sequence is read\n\
7023 using the keymaps of the buffer of the window clicked in, not the buffer\n\
7024 of the selected window as normal.\n\
7026 `read-key-sequence' drops unbound button-down events, since you normally\n\
7027 only care about the click or drag events which follow them. If a drag\n\
7028 or multi-click event is unbound, but the corresponding click event would\n\
7029 be bound, `read-key-sequence' turns the event into a click event at the\n\
7030 drag's starting position. This means that you don't have to distinguish\n\
7031 between click and drag, double, or triple events unless you want to.\n\
7033 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
7034 lines separating windows, and scroll bars with imaginary keys\n\
7035 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
7037 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
7038 function will process a switch-frame event if the user switches frames\n\
7039 before typing anything. If the user switches frames in the middle of a\n\
7040 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
7041 is nil, then the event will be put off until after the current key sequence.\n\
7043 `read-key-sequence' checks `function-key-map' for function key\n\
7044 sequences, where they wouldn't conflict with ordinary bindings. See\n\
7045 `function-key-map' for more details.")
7046 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7049 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7051 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7052 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7053 Lisp_Object can_return_switch_frame
;
7055 Lisp_Object keybuf
[30];
7057 struct gcpro gcpro1
, gcpro2
;
7060 CHECK_STRING (prompt
, 0);
7063 bzero (keybuf
, sizeof keybuf
);
7065 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7067 if (NILP (continue_echo
))
7069 this_command_key_count
= 0;
7070 this_single_command_key_start
= 0;
7073 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7074 prompt
, ! NILP (dont_downcase_last
),
7075 ! NILP (can_return_switch_frame
), 0);
7083 return make_event_array (i
, keybuf
);
7086 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
7087 Sread_key_sequence_vector
, 1, 4, 0,
7088 "Like `read-key-sequence' but always return a vector.")
7089 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7090 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7091 Lisp_Object can_return_switch_frame
;
7093 Lisp_Object keybuf
[30];
7095 struct gcpro gcpro1
, gcpro2
;
7098 CHECK_STRING (prompt
, 0);
7101 bzero (keybuf
, sizeof keybuf
);
7103 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7105 if (NILP (continue_echo
))
7107 this_command_key_count
= 0;
7108 this_single_command_key_start
= 0;
7111 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7112 prompt
, ! NILP (dont_downcase_last
),
7113 ! NILP (can_return_switch_frame
), 0);
7121 return Fvector (i
, keybuf
);
7124 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
7125 "Execute CMD as an editor command.\n\
7126 CMD must be a symbol that satisfies the `commandp' predicate.\n\
7127 Optional second arg RECORD-FLAG non-nil\n\
7128 means unconditionally put this command in `command-history'.\n\
7129 Otherwise, that is done only if an arg is read using the minibuffer.\n\
7130 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
7131 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
7132 The argument SPECIAL, if non-nil, means that this command is executing\n\
7133 a special event, so ignore the prefix argument and don't clear it.")
7134 (cmd
, record_flag
, keys
, special
)
7135 Lisp_Object cmd
, record_flag
, keys
, special
;
7137 register Lisp_Object final
;
7138 register Lisp_Object tem
;
7139 Lisp_Object prefixarg
;
7140 struct backtrace backtrace
;
7141 extern int debug_on_next_call
;
7143 debug_on_next_call
= 0;
7147 prefixarg
= current_kboard
->Vprefix_arg
;
7148 Vcurrent_prefix_arg
= prefixarg
;
7149 current_kboard
->Vprefix_arg
= Qnil
;
7156 tem
= Fget (cmd
, Qdisabled
);
7157 if (!NILP (tem
) && !NILP (Vrun_hooks
))
7159 tem
= Fsymbol_value (Qdisabled_command_hook
);
7161 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
7167 final
= Findirect_function (cmd
);
7169 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
7171 struct gcpro gcpro1
, gcpro2
;
7173 GCPRO2 (cmd
, prefixarg
);
7174 do_autoload (final
, cmd
);
7181 if (STRINGP (final
) || VECTORP (final
))
7183 /* If requested, place the macro in the command history. For
7184 other sorts of commands, call-interactively takes care of
7186 if (!NILP (record_flag
))
7188 = Fcons (Fcons (Qexecute_kbd_macro
,
7189 Fcons (final
, Fcons (prefixarg
, Qnil
))),
7192 return Fexecute_kbd_macro (final
, prefixarg
);
7194 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
7196 backtrace
.next
= backtrace_list
;
7197 backtrace_list
= &backtrace
;
7198 backtrace
.function
= &Qcall_interactively
;
7199 backtrace
.args
= &cmd
;
7200 backtrace
.nargs
= 1;
7201 backtrace
.evalargs
= 0;
7203 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7205 backtrace_list
= backtrace
.next
;
7211 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7213 "Read function name, then read its arguments and call it.")
7215 Lisp_Object prefixarg
;
7217 Lisp_Object function
;
7219 Lisp_Object saved_keys
;
7220 Lisp_Object bindings
, value
;
7221 struct gcpro gcpro1
, gcpro2
;
7223 saved_keys
= Fvector (this_command_key_count
,
7224 XVECTOR (this_command_keys
)->contents
);
7226 GCPRO2 (saved_keys
, prefixarg
);
7228 if (EQ (prefixarg
, Qminus
))
7230 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7231 strcpy (buf
, "C-u ");
7232 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7234 if (sizeof (int) == sizeof (EMACS_INT
))
7235 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7236 else if (sizeof (long) == sizeof (EMACS_INT
))
7237 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7241 else if (INTEGERP (prefixarg
))
7243 if (sizeof (int) == sizeof (EMACS_INT
))
7244 sprintf (buf
, "%d ", XINT (prefixarg
));
7245 else if (sizeof (long) == sizeof (EMACS_INT
))
7246 sprintf (buf
, "%ld ", XINT (prefixarg
));
7251 /* This isn't strictly correct if execute-extended-command
7252 is bound to anything else. Perhaps it should use
7253 this_command_keys? */
7254 strcat (buf
, "M-x ");
7256 /* Prompt with buf, and then read a string, completing from and
7257 restricting to the set of all defined commands. Don't provide
7258 any initial input. Save the command read on the extended-command
7260 function
= Fcompleting_read (build_string (buf
),
7261 Vobarray
, Qcommandp
,
7262 Qt
, Qnil
, Qextended_command_history
, Qnil
,
7265 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7266 error ("No command name given");
7268 /* Set this_command_keys to the concatenation of saved_keys and
7269 function, followed by a RET. */
7271 struct Lisp_String
*str
;
7275 this_command_key_count
= 0;
7276 this_single_command_key_start
= 0;
7278 keys
= XVECTOR (saved_keys
)->contents
;
7279 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7280 add_command_key (keys
[i
]);
7282 str
= XSTRING (function
);
7283 for (i
= 0; i
< str
->size
; i
++)
7284 add_command_key (Faref (function
, make_number (i
)));
7286 add_command_key (make_number ('\015'));
7291 function
= Fintern (function
, Qnil
);
7292 current_kboard
->Vprefix_arg
= prefixarg
;
7293 this_command
= function
;
7295 /* If enabled, show which key runs this command. */
7296 if (!NILP (Vsuggest_key_bindings
)
7297 && NILP (Vexecuting_macro
)
7298 && SYMBOLP (function
))
7299 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7305 GCPRO2 (bindings
, value
);
7306 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7308 /* If the command has a key binding, print it now. */
7309 if (!NILP (bindings
)
7310 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
7313 /* But first wait, and skip the message if there is input. */
7314 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7315 ? Vsuggest_key_bindings
: make_number (2)),
7317 && ! CONSP (Vunread_command_events
))
7319 Lisp_Object binding
;
7321 char *oldmessage
= echo_area_glyphs
;
7322 int oldmessage_len
= echo_area_glyphs_length
;
7323 int oldmultibyte
= message_enable_multibyte
;
7325 binding
= Fkey_description (bindings
);
7328 = (char *) alloca (XSYMBOL (function
)->name
->size
7329 + XSTRING (binding
)->size_byte
7331 sprintf (newmessage
, "You can run the command `%s' with %s",
7332 XSYMBOL (function
)->name
->data
,
7333 XSTRING (binding
)->data
);
7334 message2_nolog (newmessage
,
7335 strlen (newmessage
),
7336 STRING_MULTIBYTE (binding
));
7337 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7338 ? Vsuggest_key_bindings
: make_number (2)),
7340 message2_nolog (oldmessage
, oldmessage_len
, oldmultibyte
);
7344 RETURN_UNGCPRO (value
);
7347 /* Find the set of keymaps now active.
7348 Store into *MAPS_P a vector holding the various maps
7349 and return the number of them. The vector was malloc'd
7350 and the caller should free it. */
7353 current_active_maps (maps_p
)
7354 Lisp_Object
**maps_p
;
7356 Lisp_Object
*tmaps
, *maps
;
7359 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7360 if (!NILP (Voverriding_local_map_menu_flag
))
7362 /* Yes, use them (if non-nil) as well as the global map. */
7363 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7365 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7366 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7367 if (!NILP (Voverriding_local_map
))
7368 maps
[nmaps
++] = Voverriding_local_map
;
7372 /* No, so use major and minor mode keymaps. */
7373 nmaps
= current_minor_maps (NULL
, &tmaps
);
7374 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7375 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7376 #ifdef USE_TEXT_PROPERTIES
7377 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7379 maps
[nmaps
++] = current_buffer
->keymap
;
7382 maps
[nmaps
++] = current_global_map
;
7388 /* Return nonzero if input events are pending. */
7390 detect_input_pending ()
7393 get_input_pending (&input_pending
, 0);
7395 return input_pending
;
7398 /* Return nonzero if input events are pending, and run any pending timers. */
7400 detect_input_pending_run_timers (do_display
)
7403 int old_timers_run
= timers_run
;
7406 get_input_pending (&input_pending
, 1);
7408 if (old_timers_run
!= timers_run
&& do_display
)
7409 redisplay_preserve_echo_area ();
7411 return input_pending
;
7414 /* This is called in some cases before a possible quit.
7415 It cases the next call to detect_input_pending to recompute input_pending.
7416 So calling this function unnecessarily can't do any harm. */
7419 clear_input_pending ()
7424 /* Return nonzero if there are pending requeued events.
7425 This isn't used yet. The hope is to make wait_reading_process_input
7426 call it, and return return if it runs Lisp code that unreads something.
7427 The problem is, kbd_buffer_get_event needs to be fixed to know what
7428 to do in that case. It isn't trivial. */
7430 requeued_events_pending_p ()
7432 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7436 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7437 "T if command input is currently available with no waiting.\n\
7438 Actually, the value is nil only if we can be sure that no input is available.")
7441 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7444 get_input_pending (&input_pending
, 1);
7445 return input_pending
> 0 ? Qt
: Qnil
;
7448 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7449 "Return vector of last 100 events, not counting those from keyboard macros.")
7452 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7455 if (total_keys
< NUM_RECENT_KEYS
)
7456 return Fvector (total_keys
, keys
);
7459 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7460 bcopy (keys
+ recent_keys_index
,
7461 XVECTOR (val
)->contents
,
7462 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7464 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7465 recent_keys_index
* sizeof (Lisp_Object
));
7470 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7471 "Return the key sequence that invoked this command.\n\
7472 The value is a string or a vector.")
7475 return make_event_array (this_command_key_count
,
7476 XVECTOR (this_command_keys
)->contents
);
7479 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
7480 "Return the key sequence that invoked this command, as a vector.")
7483 return Fvector (this_command_key_count
,
7484 XVECTOR (this_command_keys
)->contents
);
7487 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7488 Sthis_single_command_keys
, 0, 0, 0,
7489 "Return the key sequence that invoked this command.\n\
7490 Unlike `this-command-keys', this function's value\n\
7491 does not include prefix arguments.\n\
7492 The value is always a vector.")
7495 return Fvector (this_command_key_count
7496 - this_single_command_key_start
,
7497 (XVECTOR (this_command_keys
)->contents
7498 + this_single_command_key_start
));
7501 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7502 Sreset_this_command_lengths
, 0, 0, 0,
7503 "Used for complicated reasons in `universal-argument-other-key'.\n\
7505 `universal-argument-other-key' rereads the event just typed.\n\
7506 It then gets translated through `function-key-map'.\n\
7507 The translated event gets included in the echo area and in\n\
7508 the value of `this-command-keys' in addition to the raw original event.\n\
7509 That is not right.\n\
7511 Calling this function directs the translated event to replace\n\
7512 the original event, so that only one version of the event actually\n\
7513 appears in the echo area and in the value of `this-command-keys.'.")
7516 before_command_restore_flag
= 1;
7517 before_command_key_count_1
= before_command_key_count
;
7518 before_command_echo_length_1
= before_command_echo_length
;
7521 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7522 "Return the current depth in recursive edits.")
7526 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
7530 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
7531 "FOpen dribble file: ",
7532 "Start writing all keyboard characters to a dribble file called FILE.\n\
7533 If FILE is nil, close any open dribble file.")
7544 file
= Fexpand_file_name (file
, Qnil
);
7545 dribble
= fopen (XSTRING (file
)->data
, "w");
7547 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
7552 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
7553 "Discard the contents of the terminal input buffer.\n\
7554 Also cancel any kbd macro being defined.")
7557 current_kboard
->defining_kbd_macro
= Qnil
;
7558 update_mode_lines
++;
7560 Vunread_command_events
= Qnil
;
7561 unread_command_char
= -1;
7563 discard_tty_input ();
7565 /* Without the cast, GCC complains that this assignment loses the
7566 volatile qualifier of kbd_store_ptr. Is there anything wrong
7568 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7569 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7575 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7576 "Stop Emacs and return to superior process. You can resume later.\n\
7577 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7578 control, run a subshell instead.\n\n\
7579 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7580 to be read as terminal input by Emacs's parent, after suspension.\n\
7582 Before suspending, run the normal hook `suspend-hook'.\n\
7583 After resumption run the normal hook `suspend-resume-hook'.\n\
7585 Some operating systems cannot stop the Emacs process and resume it later.\n\
7586 On such systems, Emacs starts a subshell instead of suspending.")
7588 Lisp_Object stuffstring
;
7591 int count
= specpdl_ptr
- specpdl
;
7592 int old_height
, old_width
;
7594 struct gcpro gcpro1
, gcpro2
;
7596 if (!NILP (stuffstring
))
7597 CHECK_STRING (stuffstring
, 0);
7599 /* Run the functions in suspend-hook. */
7600 if (!NILP (Vrun_hooks
))
7601 call1 (Vrun_hooks
, intern ("suspend-hook"));
7603 GCPRO1 (stuffstring
);
7604 get_frame_size (&old_width
, &old_height
);
7606 /* sys_suspend can get an error if it tries to fork a subshell
7607 and the system resources aren't available for that. */
7608 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
7610 stuff_buffered_input (stuffstring
);
7615 unbind_to (count
, Qnil
);
7617 /* Check if terminal/window size has changed.
7618 Note that this is not useful when we are running directly
7619 with a window system; but suspend should be disabled in that case. */
7620 get_frame_size (&width
, &height
);
7621 if (width
!= old_width
|| height
!= old_height
)
7622 change_frame_size (selected_frame
, height
, width
, 0, 0);
7624 /* Run suspend-resume-hook. */
7625 if (!NILP (Vrun_hooks
))
7626 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7632 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7633 Then in any case stuff anything Emacs has read ahead and not used. */
7636 stuff_buffered_input (stuffstring
)
7637 Lisp_Object stuffstring
;
7639 /* stuff_char works only in BSD, versions 4.2 and up. */
7642 register unsigned char *p
;
7644 if (STRINGP (stuffstring
))
7648 p
= XSTRING (stuffstring
)->data
;
7649 count
= XSTRING (stuffstring
)->size_byte
;
7654 /* Anything we have read ahead, put back for the shell to read. */
7655 /* ?? What should this do when we have multiple keyboards??
7656 Should we ignore anything that was typed in at the "wrong" kboard? */
7657 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7659 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7660 kbd_fetch_ptr
= kbd_buffer
;
7661 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7662 stuff_char (kbd_fetch_ptr
->code
);
7663 kbd_fetch_ptr
->kind
= no_event
;
7664 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7670 #endif /* BSD_SYSTEM and not BSD4_1 */
7673 set_waiting_for_input (time_to_clear
)
7674 EMACS_TIME
*time_to_clear
;
7676 input_available_clear_time
= time_to_clear
;
7678 /* Tell interrupt_signal to throw back to read_char, */
7679 waiting_for_input
= 1;
7681 /* If interrupt_signal was called before and buffered a C-g,
7682 make it run again now, to avoid timing error. */
7683 if (!NILP (Vquit_flag
))
7684 quit_throw_to_read_char ();
7688 clear_waiting_for_input ()
7690 /* Tell interrupt_signal not to throw back to read_char, */
7691 waiting_for_input
= 0;
7692 input_available_clear_time
= 0;
7695 /* This routine is called at interrupt level in response to C-G.
7696 If interrupt_input, this is the handler for SIGINT.
7697 Otherwise, it is called from kbd_buffer_store_event,
7698 in handling SIGIO or SIGTINT.
7700 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7701 immediately throw back to read_char.
7703 Otherwise it sets the Lisp variable quit-flag not-nil.
7704 This causes eval to throw, when it gets a chance.
7705 If quit-flag is already non-nil, it stops the job right away. */
7708 interrupt_signal (signalnum
) /* If we don't have an argument, */
7709 int signalnum
; /* some compilers complain in signal calls. */
7712 /* Must preserve main program's value of errno. */
7713 int old_errno
= errno
;
7715 #if defined (USG) && !defined (POSIX_SIGNALS)
7716 if (!read_socket_hook
&& NILP (Vwindow_system
))
7718 /* USG systems forget handlers when they are used;
7719 must reestablish each time */
7720 signal (SIGINT
, interrupt_signal
);
7721 signal (SIGQUIT
, interrupt_signal
);
7727 if (!NILP (Vquit_flag
)
7728 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
7730 /* If SIGINT isn't blocked, don't let us be interrupted by
7731 another SIGINT, it might be harmful due to non-reentrancy
7732 in I/O functions. */
7733 sigblock (sigmask (SIGINT
));
7738 #ifdef SIGTSTP /* Support possible in later USG versions */
7740 * On systems which can suspend the current process and return to the original
7741 * shell, this command causes the user to end up back at the shell.
7742 * The "Auto-save" and "Abort" questions are not asked until
7743 * the user elects to return to emacs, at which point he can save the current
7744 * job and either dump core or continue.
7749 if (sys_suspend () == -1)
7751 printf ("Not running as a subprocess;\n");
7752 printf ("you can continue or abort.\n");
7755 /* Perhaps should really fork an inferior shell?
7756 But that would not provide any way to get back
7757 to the original shell, ever. */
7758 printf ("No support for stopping a process on this operating system;\n");
7759 printf ("you can continue or abort.\n");
7760 #endif /* not VMS */
7761 #endif /* not SIGTSTP */
7763 /* We must remain inside the screen area when the internal terminal
7764 is used. Note that [Enter] is not echoed by dos. */
7767 /* It doesn't work to autosave while GC is in progress;
7768 the code used for auto-saving doesn't cope with the mark bit. */
7769 if (!gc_in_progress
)
7771 printf ("Auto-save? (y or n) ");
7773 if (((c
= getchar ()) & ~040) == 'Y')
7775 Fdo_auto_save (Qt
, Qnil
);
7777 printf ("\r\nAuto-save done");
7778 #else /* not MSDOS */
7779 printf ("Auto-save done\n");
7780 #endif /* not MSDOS */
7782 while (c
!= '\n') c
= getchar ();
7786 /* During GC, it must be safe to reenable quitting again. */
7787 Vinhibit_quit
= Qnil
;
7790 #endif /* not MSDOS */
7791 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7792 printf ("but will instead do a real quit after garbage collection ends\r\n");
7797 printf ("\r\nAbort? (y or n) ");
7798 #else /* not MSDOS */
7800 printf ("Abort (and enter debugger)? (y or n) ");
7802 printf ("Abort (and dump core)? (y or n) ");
7803 #endif /* not VMS */
7804 #endif /* not MSDOS */
7806 if (((c
= getchar ()) & ~040) == 'Y')
7808 while (c
!= '\n') c
= getchar ();
7810 printf ("\r\nContinuing...\r\n");
7811 #else /* not MSDOS */
7812 printf ("Continuing...\n");
7813 #endif /* not MSDOS */
7820 /* If executing a function that wants to be interrupted out of
7821 and the user has not deferred quitting by binding `inhibit-quit'
7822 then quit right away. */
7823 if (immediate_quit
&& NILP (Vinhibit_quit
))
7825 struct gl_state_s saved
;
7826 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7831 GCPRO4 (saved
.object
, saved
.global_code
,
7832 saved
.current_syntax_table
, saved
.old_prop
);
7833 Fsignal (Qquit
, Qnil
);
7838 /* Else request quit when it's safe */
7842 if (waiting_for_input
&& !echoing
)
7843 quit_throw_to_read_char ();
7848 /* Handle a C-g by making read_char return C-g. */
7851 quit_throw_to_read_char ()
7853 quit_error_check ();
7855 /* Prevent another signal from doing this before we finish. */
7856 clear_waiting_for_input ();
7859 Vunread_command_events
= Qnil
;
7860 unread_command_char
= -1;
7862 #if 0 /* Currently, sit_for is called from read_char without turning
7863 off polling. And that can call set_waiting_for_input.
7864 It seems to be harmless. */
7865 #ifdef POLL_FOR_INPUT
7866 /* May be > 1 if in recursive minibuffer. */
7867 if (poll_suppress_count
== 0)
7871 if (FRAMEP (internal_last_event_frame
)
7872 && XFRAME (internal_last_event_frame
) != selected_frame
)
7873 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7876 _longjmp (getcjmp
, 1);
7879 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7880 "Set mode of reading keyboard input.\n\
7881 First arg INTERRUPT non-nil means use input interrupts;\n\
7882 nil means use CBREAK mode.\n\
7883 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7884 (no effect except in CBREAK mode).\n\
7885 Third arg META t means accept 8-bit input (for a Meta key).\n\
7886 META nil means ignore the top bit, on the assumption it is parity.\n\
7887 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7888 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7889 See also `current-input-mode'.")
7890 (interrupt
, flow
, meta
, quit
)
7891 Lisp_Object interrupt
, flow
, meta
, quit
;
7894 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7895 error ("set-input-mode: QUIT must be an ASCII character");
7897 #ifdef POLL_FOR_INPUT
7902 /* this causes startup screen to be restored and messes with the mouse */
7907 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7908 if (read_socket_hook
)
7910 /* When using X, don't give the user a real choice,
7911 because we haven't implemented the mechanisms to support it. */
7912 #ifdef NO_SOCK_SIGIO
7913 interrupt_input
= 0;
7914 #else /* not NO_SOCK_SIGIO */
7915 interrupt_input
= 1;
7916 #endif /* NO_SOCK_SIGIO */
7919 interrupt_input
= !NILP (interrupt
);
7920 #else /* not SIGIO */
7921 interrupt_input
= 0;
7922 #endif /* not SIGIO */
7924 /* Our VMS input only works by interrupts, as of now. */
7926 interrupt_input
= 1;
7929 flow_control
= !NILP (flow
);
7932 else if (EQ (meta
, Qt
))
7937 /* Don't let this value be out of range. */
7938 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7944 #ifdef POLL_FOR_INPUT
7945 poll_suppress_count
= 1;
7951 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7952 "Return information about the way Emacs currently reads keyboard input.\n\
7953 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7954 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7955 nil, Emacs is using CBREAK mode.\n\
7956 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7957 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7958 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7959 META nil means ignoring the top bit, on the assumption it is parity.\n\
7960 META is neither t nor nil if accepting 8-bit input and using\n\
7961 all 8 bits as the character code.\n\
7962 QUIT is the character Emacs currently uses to quit.\n\
7963 The elements of this list correspond to the arguments of\n\
7969 val
[0] = interrupt_input
? Qt
: Qnil
;
7970 val
[1] = flow_control
? Qt
: Qnil
;
7971 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7972 XSETFASTINT (val
[3], quit_char
);
7974 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7979 * Set up a new kboard object with reasonable initial values.
7985 kb
->Voverriding_terminal_local_map
= Qnil
;
7986 kb
->Vlast_command
= Qnil
;
7987 kb
->Vprefix_arg
= Qnil
;
7988 kb
->kbd_queue
= Qnil
;
7989 kb
->kbd_queue_has_data
= 0;
7990 kb
->immediate_echo
= 0;
7991 kb
->echoptr
= kb
->echobuf
;
7992 kb
->echo_after_prompt
= -1;
7993 kb
->kbd_macro_buffer
= 0;
7994 kb
->kbd_macro_bufsize
= 0;
7995 kb
->defining_kbd_macro
= Qnil
;
7996 kb
->Vlast_kbd_macro
= Qnil
;
7997 kb
->reference_count
= 0;
7998 kb
->Vsystem_key_alist
= Qnil
;
7999 kb
->system_key_syms
= Qnil
;
8000 kb
->Vdefault_minibuffer_frame
= Qnil
;
8004 * Destroy the contents of a kboard object, but not the object itself.
8005 * We use this just before deleting it, or if we're going to initialize
8012 if (kb
->kbd_macro_buffer
)
8013 xfree (kb
->kbd_macro_buffer
);
8022 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
8025 *kbp
= kb
->next_kboard
;
8033 /* This is correct before outermost invocation of the editor loop */
8034 command_loop_level
= -1;
8036 quit_char
= Ctl ('g');
8037 Vunread_command_events
= Qnil
;
8038 unread_command_char
= -1;
8039 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
8041 recent_keys_index
= 0;
8042 kbd_fetch_ptr
= kbd_buffer
;
8043 kbd_store_ptr
= kbd_buffer
;
8044 kbd_buffer_frame_or_window
8045 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8047 do_mouse_tracking
= Qnil
;
8051 /* This means that command_loop_1 won't try to select anything the first
8053 internal_last_event_frame
= Qnil
;
8054 Vlast_event_frame
= internal_last_event_frame
;
8057 current_kboard
= initial_kboard
;
8059 wipe_kboard (current_kboard
);
8060 init_kboard (current_kboard
);
8063 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8065 kbd_buffer_frame_or_window
8066 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8067 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
8069 signal (SIGINT
, interrupt_signal
);
8070 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
8071 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
8072 SIGQUIT and we can't tell which one it will give us. */
8073 signal (SIGQUIT
, interrupt_signal
);
8074 #endif /* HAVE_TERMIO */
8076 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8078 if (!noninteractive
)
8079 signal (SIGIO
, input_available_signal
);
8082 /* Use interrupt input by default, if it works and noninterrupt input
8083 has deficiencies. */
8085 #ifdef INTERRUPT_INPUT
8086 interrupt_input
= 1;
8088 interrupt_input
= 0;
8091 /* Our VMS input only works by interrupts, as of now. */
8093 interrupt_input
= 1;
8099 if (keyboard_init_hook
)
8100 (*keyboard_init_hook
) ();
8102 #ifdef POLL_FOR_INPUT
8103 poll_suppress_count
= 1;
8108 /* This type's only use is in syms_of_keyboard, to initialize the
8109 event header symbols and put properties on them. */
8116 struct event_head head_table
[] = {
8117 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
8118 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
8119 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
8120 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
8121 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
8122 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
8127 Qtimer_event_handler
= intern ("timer-event-handler");
8128 staticpro (&Qtimer_event_handler
);
8130 Qdisabled_command_hook
= intern ("disabled-command-hook");
8131 staticpro (&Qdisabled_command_hook
);
8133 Qself_insert_command
= intern ("self-insert-command");
8134 staticpro (&Qself_insert_command
);
8136 Qforward_char
= intern ("forward-char");
8137 staticpro (&Qforward_char
);
8139 Qbackward_char
= intern ("backward-char");
8140 staticpro (&Qbackward_char
);
8142 Qdisabled
= intern ("disabled");
8143 staticpro (&Qdisabled
);
8145 Qundefined
= intern ("undefined");
8146 staticpro (&Qundefined
);
8148 Qpre_command_hook
= intern ("pre-command-hook");
8149 staticpro (&Qpre_command_hook
);
8151 Qpost_command_hook
= intern ("post-command-hook");
8152 staticpro (&Qpost_command_hook
);
8154 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
8155 staticpro (&Qpost_command_idle_hook
);
8157 Qdeferred_action_function
= intern ("deferred-action-function");
8158 staticpro (&Qdeferred_action_function
);
8160 Qcommand_hook_internal
= intern ("command-hook-internal");
8161 staticpro (&Qcommand_hook_internal
);
8163 Qfunction_key
= intern ("function-key");
8164 staticpro (&Qfunction_key
);
8165 Qmouse_click
= intern ("mouse-click");
8166 staticpro (&Qmouse_click
);
8168 Qmouse_wheel
= intern ("mouse-wheel");
8169 staticpro (&Qmouse_wheel
);
8172 Qmenu_enable
= intern ("menu-enable");
8173 staticpro (&Qmenu_enable
);
8175 Qmode_line
= intern ("mode-line");
8176 staticpro (&Qmode_line
);
8177 Qvertical_line
= intern ("vertical-line");
8178 staticpro (&Qvertical_line
);
8179 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
8180 staticpro (&Qvertical_scroll_bar
);
8181 Qmenu_bar
= intern ("menu-bar");
8182 staticpro (&Qmenu_bar
);
8184 Qabove_handle
= intern ("above-handle");
8185 staticpro (&Qabove_handle
);
8186 Qhandle
= intern ("handle");
8187 staticpro (&Qhandle
);
8188 Qbelow_handle
= intern ("below-handle");
8189 staticpro (&Qbelow_handle
);
8190 Qup
= intern ("up");
8192 Qdown
= intern ("down");
8195 Qevent_kind
= intern ("event-kind");
8196 staticpro (&Qevent_kind
);
8197 Qevent_symbol_elements
= intern ("event-symbol-elements");
8198 staticpro (&Qevent_symbol_elements
);
8199 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
8200 staticpro (&Qevent_symbol_element_mask
);
8201 Qmodifier_cache
= intern ("modifier-cache");
8202 staticpro (&Qmodifier_cache
);
8204 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
8205 staticpro (&Qrecompute_lucid_menubar
);
8206 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
8207 staticpro (&Qactivate_menubar_hook
);
8209 Qpolling_period
= intern ("polling-period");
8210 staticpro (&Qpolling_period
);
8213 struct event_head
*p
;
8215 for (p
= head_table
;
8216 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
8219 *p
->var
= intern (p
->name
);
8221 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
8222 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
8226 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
8227 staticpro (&button_down_location
);
8231 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
8233 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
8234 for (i
= 0; i
< len
; i
++)
8235 if (modifier_names
[i
])
8236 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
8237 staticpro (&modifier_symbols
);
8240 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
8241 staticpro (&recent_keys
);
8243 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
8244 staticpro (&this_command_keys
);
8246 Qextended_command_history
= intern ("extended-command-history");
8247 Fset (Qextended_command_history
, Qnil
);
8248 staticpro (&Qextended_command_history
);
8250 kbd_buffer_frame_or_window
8251 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8252 staticpro (&kbd_buffer_frame_or_window
);
8254 accent_key_syms
= Qnil
;
8255 staticpro (&accent_key_syms
);
8257 func_key_syms
= Qnil
;
8258 staticpro (&func_key_syms
);
8261 staticpro (&mouse_syms
);
8264 mouse_wheel_syms
= Qnil
;
8265 staticpro (&mouse_wheel_syms
);
8268 unread_switch_frame
= Qnil
;
8269 staticpro (&unread_switch_frame
);
8271 internal_last_event_frame
= Qnil
;
8272 staticpro (&internal_last_event_frame
);
8274 read_key_sequence_cmd
= Qnil
;
8275 staticpro (&read_key_sequence_cmd
);
8277 defsubr (&Sevent_convert_list
);
8278 defsubr (&Sread_key_sequence
);
8279 defsubr (&Sread_key_sequence_vector
);
8280 defsubr (&Srecursive_edit
);
8282 defsubr (&Strack_mouse
);
8284 defsubr (&Sinput_pending_p
);
8285 defsubr (&Scommand_execute
);
8286 defsubr (&Srecent_keys
);
8287 defsubr (&Sthis_command_keys
);
8288 defsubr (&Sthis_command_keys_vector
);
8289 defsubr (&Sthis_single_command_keys
);
8290 defsubr (&Sreset_this_command_lengths
);
8291 defsubr (&Ssuspend_emacs
);
8292 defsubr (&Sabort_recursive_edit
);
8293 defsubr (&Sexit_recursive_edit
);
8294 defsubr (&Srecursion_depth
);
8295 defsubr (&Stop_level
);
8296 defsubr (&Sdiscard_input
);
8297 defsubr (&Sopen_dribble_file
);
8298 defsubr (&Sset_input_mode
);
8299 defsubr (&Scurrent_input_mode
);
8300 defsubr (&Sexecute_extended_command
);
8302 DEFVAR_LISP ("last-command-char", &last_command_char
,
8303 "Last input event that was part of a command.");
8305 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
8306 "Last input event that was part of a command.");
8308 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
8309 "Last input event in a command, except for mouse menu events.\n\
8310 Mouse menus give back keys that don't look like mouse events;\n\
8311 this variable holds the actual mouse event that led to the menu,\n\
8312 so that you can determine whether the command was run by mouse or not.");
8314 DEFVAR_LISP ("last-input-char", &last_input_char
,
8315 "Last input event.");
8317 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
8318 "Last input event.");
8320 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
8321 "List of objects to be read as next command input events.");
8323 DEFVAR_INT ("unread-command-char", &unread_command_char
,
8324 "If not -1, an object to be read as next command input event.");
8326 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
8327 "Meta-prefix character code. Meta-foo as command input\n\
8328 turns into this character followed by foo.");
8329 XSETINT (meta_prefix_char
, 033);
8331 DEFVAR_KBOARD ("last-command", Vlast_command
,
8332 "The last command executed. Normally a symbol with a function definition,\n\
8333 but can be whatever was found in the keymap, or whatever the variable\n\
8334 `this-command' was set to by that command.\n\
8336 The value `mode-exit' is special; it means that the previous command\n\
8337 read an event that told it to exit, and it did so and unread that event.\n\
8338 In other words, the present command is the event that made the previous\n\
8341 The value `kill-region' is special; it means that the previous command\n\
8342 was a kill command.");
8344 DEFVAR_LISP ("this-command", &this_command
,
8345 "The command now being executed.\n\
8346 The command can set this variable; whatever is put here\n\
8347 will be in `last-command' during the following command.");
8348 this_command
= Qnil
;
8350 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8351 "*Number of keyboard input characters between auto-saves.\n\
8352 Zero means disable autosaving due to number of characters typed.");
8353 auto_save_interval
= 300;
8355 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8356 "*Number of seconds idle time before auto-save.\n\
8357 Zero or nil means disable auto-saving due to idleness.\n\
8358 After auto-saving due to this many seconds of idle time,\n\
8359 Emacs also does a garbage collection if that seems to be warranted.");
8360 XSETFASTINT (Vauto_save_timeout
, 30);
8362 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8363 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8364 echo_keystrokes
= 1;
8366 DEFVAR_INT ("polling-period", &polling_period
,
8367 "*Interval between polling for input during Lisp execution.\n\
8368 The reason for polling is to make C-g work to stop a running program.\n\
8369 Polling is needed only when using X windows and SIGIO does not work.\n\
8370 Polling is automatically disabled in all other cases.");
8373 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8374 "*Maximum time between mouse clicks to make a double-click.\n\
8375 Measured in milliseconds. nil means disable double-click recognition;\n\
8376 t means double-clicks have no time limit and are detected\n\
8377 by position only.");
8378 Vdouble_click_time
= make_number (500);
8380 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8381 "*Non-nil means inhibit local map menu bar menus.");
8382 inhibit_local_menu_bar_menus
= 0;
8384 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8385 "Number of complete key sequences read as input so far.\n\
8386 This includes key sequences read from keyboard macros.\n\
8387 The number is effectively the number of interactive command invocations.");
8390 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
8391 "Number of input events read from the keyboard so far.\n\
8392 This does not include events generated by keyboard macros.");
8393 num_nonmacro_input_events
= 0;
8395 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8396 "The frame in which the most recently read event occurred.\n\
8397 If the last event came from a keyboard macro, this is set to `macro'.");
8398 Vlast_event_frame
= Qnil
;
8400 /* This variable is set up in sysdep.c. */
8401 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
8402 "The ERASE character as set by the user with stty.");
8404 DEFVAR_LISP ("help-char", &Vhelp_char
,
8405 "Character to recognize as meaning Help.\n\
8406 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8407 If the value of `help-form' is nil, this char can be read normally.");
8408 XSETINT (Vhelp_char
, Ctl ('H'));
8410 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8411 "List of input events to recognize as meaning Help.\n\
8412 These work just like the value of `help-char' (see that).");
8413 Vhelp_event_list
= Qnil
;
8415 DEFVAR_LISP ("help-form", &Vhelp_form
,
8416 "Form to execute when character `help-char' is read.\n\
8417 If the form returns a string, that string is displayed.\n\
8418 If `help-form' is nil, the help char is not recognized.");
8421 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8422 "Command to run when `help-char' character follows a prefix key.\n\
8423 This command is used only when there is no actual binding\n\
8424 for that character after that prefix key.");
8425 Vprefix_help_command
= Qnil
;
8427 DEFVAR_LISP ("top-level", &Vtop_level
,
8428 "Form to evaluate when Emacs starts up.\n\
8429 Useful to set before you dump a modified Emacs.");
8432 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8433 "Translate table for keyboard input, or nil.\n\
8434 Each character is looked up in this string and the contents used instead.\n\
8435 The value may be a string, a vector, or a char-table.\n\
8436 If it is a string or vector of length N,\n\
8437 character codes N and up are untranslated.\n\
8438 In a vector or a char-table, an element which is nil means \"no translation\".");
8439 Vkeyboard_translate_table
= Qnil
;
8441 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8442 "Non-nil means to always spawn a subshell instead of suspending,\n\
8443 even if the operating system has support for stopping a process.");
8446 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8447 "Non-nil means prompt with menus when appropriate.\n\
8448 This is done when reading from a keymap that has a prompt string,\n\
8449 for elements that have prompt strings.\n\
8450 The menu is displayed on the screen\n\
8451 if X menus were enabled at configuration\n\
8452 time and the previous event was a mouse click prefix key.\n\
8453 Otherwise, menu prompting uses the echo area.");
8456 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8457 "Character to see next line of menu prompt.\n\
8458 Type this character while in a menu prompt to rotate around the lines of it.");
8459 XSETINT (menu_prompt_more_char
, ' ');
8461 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8462 "A mask of additional modifier keys to use with every keyboard character.\n\
8463 Emacs applies the modifiers of the character stored here to each keyboard\n\
8464 character it reads. For example, after evaluating the expression\n\
8465 (setq extra-keyboard-modifiers ?\\C-x)\n\
8466 all input characters will have the control modifier applied to them.\n\
8468 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8469 not count as a control character; rather, it counts as a character\n\
8470 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8471 cancels any modification.");
8472 extra_keyboard_modifiers
= 0;
8474 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8475 "If an editing command sets this to t, deactivate the mark afterward.\n\
8476 The command loop sets this to nil before each command,\n\
8477 and tests the value when the command returns.\n\
8478 Buffer modification stores t in this variable.");
8479 Vdeactivate_mark
= Qnil
;
8481 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8482 "Temporary storage of pre-command-hook or post-command-hook.");
8483 Vcommand_hook_internal
= Qnil
;
8485 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8486 "Normal hook run before each command is executed.\n\
8487 Errors running the hook are caught and ignored.");
8488 Vpre_command_hook
= Qnil
;
8490 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8491 "Normal hook run after each command is executed.\n\
8492 Errors running the hook are caught and ignored.");
8493 Vpost_command_hook
= Qnil
;
8495 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8496 "Normal hook run after each command is executed, if idle.\n\
8497 Errors running the hook are caught and ignored.\n\
8498 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
8499 Vpost_command_idle_hook
= Qnil
;
8501 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
8502 "Delay time before running `post-command-idle-hook'.\n\
8503 This is measured in microseconds.");
8504 post_command_idle_delay
= 100000;
8507 DEFVAR_LISP ("echo-area-clear-hook", ...,
8508 "Normal hook run when clearing the echo area.");
8510 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
8511 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
8513 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
8514 "t means menu bar, specified Lucid style, needs to be recomputed.");
8515 Vlucid_menu_bar_dirty_flag
= Qnil
;
8517 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
8518 "List of menu bar items to move to the end of the menu bar.\n\
8519 The elements of the list are event types that may have menu bar bindings.");
8520 Vmenu_bar_final_items
= Qnil
;
8522 DEFVAR_KBOARD ("overriding-terminal-local-map",
8523 Voverriding_terminal_local_map
,
8524 "Per-terminal keymap that overrides all other local keymaps.\n\
8525 If this variable is non-nil, it is used as a keymap instead of the\n\
8526 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
8527 This variable is intended to let commands such as `universal-argumemnt'\n\
8528 set up a different keymap for reading the next command.");
8530 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
8531 "Keymap that overrides all other local keymaps.\n\
8532 If this variable is non-nil, it is used as a keymap instead of the\n\
8533 buffer's local map, and the minor mode keymaps and text property keymaps.");
8534 Voverriding_local_map
= Qnil
;
8536 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
8537 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8538 Otherwise, the menu bar continues to reflect the buffer's local map\n\
8539 and the minor mode maps regardless of `overriding-local-map'.");
8540 Voverriding_local_map_menu_flag
= Qnil
;
8542 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
8543 "Keymap defining bindings for special events to execute at low level.");
8544 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
8546 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
8547 "*Non-nil means generate motion events for mouse motion.");
8549 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
8550 "Alist of system-specific X windows key symbols.\n\
8551 Each element should have the form (N . SYMBOL) where N is the\n\
8552 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
8553 and SYMBOL is its name.");
8555 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
8556 "List of deferred actions to be performed at a later time.\n\
8557 The precise format isn't relevant here; we just check whether it is nil.");
8558 Vdeferred_action_list
= Qnil
;
8560 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
8561 "Function to call to handle deferred actions, after each command.\n\
8562 This function is called with no arguments after each command\n\
8563 whenever `deferred-action-list' is non-nil.");
8564 Vdeferred_action_function
= Qnil
;
8566 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
8567 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8568 The value can be a length of time to show the message for.\n\
8569 If the value is non-nil and not a number, we wait 2 seconds.");
8570 Vsuggest_key_bindings
= Qt
;
8572 DEFVAR_LISP ("timer-list", &Vtimer_list
,
8573 "List of active absolute time timers in order of increasing time");
8576 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
8577 "List of active idle-time timers in order of increasing time");
8578 Vtimer_idle_list
= Qnil
;
8583 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
8584 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
8585 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
8586 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
8587 initial_define_key (meta_map
, 'x', "execute-extended-command");
8589 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
8590 "handle-delete-frame");
8591 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
8593 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",